git.iko.soy/typeable/oauth2-proxy
on master help sign in
Drop Session suffix from SessionStore methods
commit1d29a0d09458ccc456d9c6d677038786a82592a5 authorJoel Speed <Joel.speed@hotmail.co.uk> dateWed 8 May 2019, 16:36 (7 years ago) parent455e000
3 files changed+16−16
pkg/apis/sessions/interfaces.go+3−3 pkg/sessions/cookie/session_store.go+6−6 pkg/sessions/session_store_test.go+7−7
pkg/apis/sessions/interfaces.go+3−3
@@ -6,7 +6,7 @@ import (
66
77// SessionStore is an interface to storing user sessions in the proxy
88type SessionStore interface {
9− SaveSession(rw http.ResponseWriter, req *http.Request, s *SessionState) error
10− LoadSession(req *http.Request) (*SessionState, error)
11− ClearSession(rw http.ResponseWriter, req *http.Request) error
9+ Save(rw http.ResponseWriter, req *http.Request, s *SessionState) error
10+ Load(req *http.Request) (*SessionState, error)
11+ Clear(rw http.ResponseWriter, req *http.Request) error
1212}
pkg/sessions/cookie/session_store.go+6−6
@@ -37,9 +37,9 @@ type SessionStore struct {
3737 CookieSecure bool
3838}
3939
40−// SaveSession takes a sessions.SessionState and stores the information from it
40+// Save takes a sessions.SessionState and stores the information from it
4141// within Cookies set on the HTTP response writer
42−func (s *SessionStore) SaveSession(rw http.ResponseWriter, req *http.Request, ss *sessions.SessionState) error {
42+func (s *SessionStore) Save(rw http.ResponseWriter, req *http.Request, ss *sessions.SessionState) error {
4343 value, err := utils.CookieForSession(ss, s.CookieCipher)
4444 if err != nil {
4545 return err
@@ -48,9 +48,9 @@ func (s *SessionStore) SaveSession(rw http.ResponseWriter, req *http.Request, ss
4848 return nil
4949}
5050
51−// LoadSession reads sessions.SessionState information from Cookies within the
51+// Load reads sessions.SessionState information from Cookies within the
5252// HTTP request object
53−func (s *SessionStore) LoadSession(req *http.Request) (*sessions.SessionState, error) {
53+func (s *SessionStore) Load(req *http.Request) (*sessions.SessionState, error) {
5454 c, err := loadCookie(req, s.CookieName)
5555 if err != nil {
5656 // always http.ErrNoCookie
@@ -68,9 +68,9 @@ func (s *SessionStore) LoadSession(req *http.Request) (*sessions.SessionState, e
6868 return session, nil
6969}
7070
71−// ClearSession clears any saved session information by writing a cookie to
71+// Clear clears any saved session information by writing a cookie to
7272// clear the session
73−func (s *SessionStore) ClearSession(rw http.ResponseWriter, req *http.Request) error {
73+func (s *SessionStore) Clear(rw http.ResponseWriter, req *http.Request) error {
7474 var cookies []*http.Cookie
7575
7676 // matches CookieName, CookieName_<number>
pkg/sessions/session_store_test.go+7−7
@@ -76,9 +76,9 @@ var _ = Describe("NewSessionStore", func() {
7676 }
7777
7878 SessionStoreInterfaceTests := func() {
79− Context("when SaveSession is called", func() {
79+ Context("when Save is called", func() {
8080 BeforeEach(func() {
81− err := ss.SaveSession(response, request, session)
81+ err := ss.Save(response, request, session)
8282 Expect(err).ToNot(HaveOccurred())
8383 })
8484
@@ -89,7 +89,7 @@ var _ = Describe("NewSessionStore", func() {
8989 CheckCookieOptions()
9090 })
9191
92− Context("when ClearSession is called", func() {
92+ Context("when Clear is called", func() {
9393 BeforeEach(func() {
9494 cookie := cookies.MakeCookie(request,
9595 cookieOpts.CookieName,
@@ -102,7 +102,7 @@ var _ = Describe("NewSessionStore", func() {
102102 time.Now(),
103103 )
104104 request.AddCookie(cookie)
105− err := ss.ClearSession(response, request)
105+ err := ss.Clear(response, request)
106106 Expect(err).ToNot(HaveOccurred())
107107 })
108108
@@ -113,18 +113,18 @@ var _ = Describe("NewSessionStore", func() {
113113 CheckCookieOptions()
114114 })
115115
116− Context("when LoadSession is called", func() {
116+ Context("when Load is called", func() {
117117 var loadedSession *sessionsapi.SessionState
118118 BeforeEach(func() {
119119 req := httptest.NewRequest("GET", "http://example.com/", nil)
120120 resp := httptest.NewRecorder()
121− err := ss.SaveSession(resp, req, session)
121+ err := ss.Save(resp, req, session)
122122 Expect(err).ToNot(HaveOccurred())
123123
124124 for _, cookie := range resp.Result().Cookies() {
125125 request.AddCookie(cookie)
126126 }
127− loadedSession, err = ss.LoadSession(request)
127+ loadedSession, err = ss.Load(request)
128128 Expect(err).ToNot(HaveOccurred())
129129 })
130130