oauth2: rename SetParam to SetAuthURLParam

SetParam is quite vague to represent an Option that sets the auth
URL query parameters. Renaming it for explicitness.

Fixes #108.

Change-Id: Ic9f0181097820ee83404c9432451d71658dd8c67
Reviewed-on: https://go-review.googlesource.com/8491
Reviewed-by: Brad Fitzpatrick <bradfitz@golang.org>
This commit is contained in:
Burcu Dogan 2015-04-06 09:53:19 -04:00
parent d2a4aec992
commit ce5ea7da93
2 changed files with 6 additions and 6 deletions

View File

@ -79,13 +79,13 @@ var (
// result in your application obtaining a refresh token the // result in your application obtaining a refresh token the
// first time your application exchanges an authorization // first time your application exchanges an authorization
// code for a user. // code for a user.
AccessTypeOnline AuthCodeOption = SetParam("access_type", "online") AccessTypeOnline AuthCodeOption = SetAuthURLParam("access_type", "online")
AccessTypeOffline AuthCodeOption = SetParam("access_type", "offline") AccessTypeOffline AuthCodeOption = SetAuthURLParam("access_type", "offline")
// ApprovalForce forces the users to view the consent dialog // ApprovalForce forces the users to view the consent dialog
// and confirm the permissions request at the URL returned // and confirm the permissions request at the URL returned
// from AuthCodeURL, even if they've already done so. // from AuthCodeURL, even if they've already done so.
ApprovalForce AuthCodeOption = SetParam("approval_prompt", "force") ApprovalForce AuthCodeOption = SetAuthURLParam("approval_prompt", "force")
) )
// An AuthCodeOption is passed to Config.AuthCodeURL. // An AuthCodeOption is passed to Config.AuthCodeURL.
@ -97,9 +97,9 @@ type setParam struct{ k, v string }
func (p setParam) setValue(m url.Values) { m.Set(p.k, p.v) } func (p setParam) setValue(m url.Values) { m.Set(p.k, p.v) }
// SetParam builds an AuthCodeOption which passes key/value parameters // SetAuthURLParam builds an AuthCodeOption which passes key/value parameters
// to a provider's authorization endpoint. // to a provider's authorization endpoint.
func SetParam(key, value string) AuthCodeOption { func SetAuthURLParam(key, value string) AuthCodeOption {
return setParam{key, value} return setParam{key, value}
} }

View File

@ -63,7 +63,7 @@ func TestAuthCodeURL(t *testing.T) {
func TestAuthCodeURL_CustomParam(t *testing.T) { func TestAuthCodeURL_CustomParam(t *testing.T) {
conf := newConf("server") conf := newConf("server")
param := SetParam("foo", "bar") param := SetAuthURLParam("foo", "bar")
url := conf.AuthCodeURL("baz", param) url := conf.AuthCodeURL("baz", param)
if url != "server/auth?client_id=CLIENT_ID&foo=bar&redirect_uri=REDIRECT_URL&response_type=code&scope=scope1+scope2&state=baz" { if url != "server/auth?client_id=CLIENT_ID&foo=bar&redirect_uri=REDIRECT_URL&response_type=code&scope=scope1+scope2&state=baz" {
t.Errorf("Auth code URL doesn't match the expected, found: %v", url) t.Errorf("Auth code URL doesn't match the expected, found: %v", url)