oauth2: Fixing docs and styling issues

oauth2: Fixing docs and styling issues

[jbd, 2014-08-13 20:44:59]

Fixing the following issues:

https://github.com/golang/oauth2/issues/26
https://github.com/golang/oauth2/issues/25 (excluding on-disk PEM file read)

[bradfitz, 2014-08-13 20:54:03]

LGTM



On Wed, Aug 13, 2014 at 1:44 PM, <jbd@google.com> wrote:

> Reviewers: bradfitz,
>
> Message:
> Fixing the following issues:
>
> https://github.com/golang/oauth2/issues/26
> https://github.com/golang/oauth2/issues/25 (excluding on-disk PEM file
> read)
>
> Description:
> oauth2: Fixing docs and styling issues
>
> Please review this at https://codereview.appspot.com/125280043/
>
> Affected files (+12, -12 lines):
>   M example_test.go
>   M google/example_test.go
>   M jwt.go
>   M oauth2.go
>
>
> Index: example_test.go
> diff --git a/example_test.go b/example_test.go
> index d69477ee624ce5be9dd8bffecfb218105902bb81..
> d7afa385b1353cffec42c62cc8d0ddf0854aa584 100644
> --- a/example_test.go
> +++ b/example_test.go
> @@ -56,7 +56,7 @@ func Example_jWTConfig() {
>                 // The path to the pem file. If you have a p12 file
> instead, you
>                 // can use `openssl` to export the private key into a pem
> file.
>                 // $ openssl pkcs12 -in key.p12 -out key.pem -nodes
> -               PemFilename: "/path/to/pem/file.pem",
> +               PEMFilename: "/path/to/pem/file.pem",
>                 Scopes:      []string{"SCOPE1", "SCOPE2"},
>         },
>                 "https://provider.com/o/oauth2/token")
> Index: google/example_test.go
> diff --git a/google/example_test.go b/google/example_test.go
> index 2df6d6fc926fbc063dcb1bdd7915f666dc487d1f..
> e492507036b31a96599dc22a993dcf5ec70a4bb1 100644
> --- a/google/example_test.go
> +++ b/google/example_test.go
> @@ -49,10 +49,10 @@ func Example_serviceAccounts() {
>         // Developer Console (https://console.developers.google.com).
>         config, err := google.NewServiceAccountConfig(&oauth2.JWTOptions{
>                 Email: "xxx@developer.gserviceaccount.com",
> -               // The path to the pem file. If you have a p12 file
> instead, you
> +               // PEMFilename. If you have a p12 file instead, you
>                 // can use `openssl` to export the private key into a pem
> file.
>                 // $ openssl pkcs12 -in key.p12 -out key.pem -nodes
> -               PemFilename: "/path/to/pem/file.pem",
> +               PEMFilename: "/path/to/pem/file.pem",
>                 Scopes: []string{
>                         "https://www.googleapis.com/auth/bigquery",
>                 },
> Index: jwt.go
> diff --git a/jwt.go b/jwt.go
> index d1ea222b88befbd093a72ffcbab7624e530266d8..
> 82f41c7cf33e1ff7d4de656b0706b295fc9199e9 100644
> --- a/jwt.go
> +++ b/jwt.go
> @@ -27,21 +27,21 @@ var (
>  // JWTOptions represents a OAuth2 client's crendentials to retrieve a
>  // Bearer JWT token.
>  type JWTOptions struct {
> -       // ClientID is the OAuth client identifier used when communicating
> with
> +       // Email is the OAuth client identifier used when communicating
> with
>         // the configured OAuth provider.
>         Email string `json:"email"`
>
> -       // Private key to sign JWS payloads.
> +       // PrivateKey is an RSA private key to sign JWS payloads.
>         PrivateKey *rsa.PrivateKey `json:"-"`
>
> -       // The path to a pem container that includes your private key.
> +       // The path to a PEM container that includes your private key.
>         // If PrivateKey is set, this field is ignored.
>         //
>         // If you have a p12 file instead, you
> -       // can use `openssl` to export the private key into a pem file.
> +       // can use `openssl` to export the private key into a PEM file.
>         // $ openssl pkcs12 -in key.p12 -out key.pem -nodes
> -       // Pem file should contain your private key.
> -       PemFilename string `json:"pemfilename"`
> +       // PEM file should contain your private key.
> +       PEMFilename string `json:"pemfilename"`
>
>         // Scopes identify the level of access being requested.
>         Scopes []string `json:"scopes"`
> @@ -57,7 +57,7 @@ func NewJWTConfig(opts *JWTOptions, aud string)
> (*JWTConfig, error) {
>         if opts.PrivateKey != nil {
>                 return &JWTConfig{opts: opts, aud: audURL, key:
> opts.PrivateKey}, nil
>         }
> -       contents, err := ioutil.ReadFile(opts.PemFilename)
> +       contents, err := ioutil.ReadFile(opts.PEMFilename)
>         if err != nil {
>                 return nil, err
>         }
> Index: oauth2.go
> diff --git a/oauth2.go b/oauth2.go
> index 8813e22b7ad70d8efc1032e61aff384e2f03386b..
> 6850f3b83f93af35fa5fb3859984fea1e7ca28cb 100644
> --- a/oauth2.go
> +++ b/oauth2.go
> @@ -61,8 +61,8 @@ type Options struct {
>         // granting (or denying) access.
>         RedirectURL string `json:"redirect_url"`
>
> -       // Optional, identifies the level of access being requested.
> -       Scopes []string `json:"scopes"`
> +       // Scopes optionally specifies a list of requested permission
> scopes.
> +       Scopes []string `json:"scopes,omitempty"`
>
>         // AccessType is an OAuth extension that gets sent as the
>         // "access_type" field in the URL from AuthCodeURL.
>
>
>

[jbd, 2014-08-13 21:06:57]

Submitted as b2a1756f9852171510e06ac5727cbb4b6faae471.