Change to make :note to be required parameter, document in readme and close piotrmurach#248

piotrmurach · piotrmurach · commit 87b1fa07ef91 · 2015-11-21T18:17:26.000Z
diff --git a/README.md b/README.md
@@ -411,7 +411,7 @@ To create an access token through the GitHub Authorizations API, you are require
 
 ```ruby
 github = Github.new basic_auth: 'login:password'
-github.oauth.create scopes: ['repo']
+github.oauth.create scopes: ['repo'], note: 'admin script'
 ```
 
 You can add more than one scope from the `user`, `public_repo`, `repo`, `gist` or leave the scopes parameter out, in which case, the default read-only access will be assumed (includes public user profile info, public repo info, and gists).
diff --git a/lib/github_api/client/authorizations.rb b/lib/github_api/client/authorizations.rb
@@ -6,16 +6,6 @@ class Client::Authorizations < API
 
     require_all 'github_api/client/authorizations', 'app'
 
-    VALID_AUTH_PARAM_NAMES = %w[
-      scopes
-      add_scopes
-      remove_scopes
-      note
-      note_url
-      client_id
-      client_secret
-    ].freeze
-
     # Access to Authorizations::App API
     namespace :app
 
@@ -24,9 +14,9 @@ class Client::Authorizations < API
     # @see https://developer.github.com/v3/oauth_authorizations/#list-your-authorizations
     #
     # @example
-    #  github = Github.new basic_auth: 'login:password'
-    #  github.oauth.list
-    #  github.oauth.list { |auth| ... }
+    #   github = Github.new basic_auth: 'login:password'
+    #   github.oauth.list
+    #   github.oauth.list { |auth| ... }
     #
     # @api public
     def list(*args)
@@ -37,7 +27,7 @@ def list(*args)
       return response unless block_given?
       response.each { |el| yield el }
     end
-    alias :all :list
+    alias_method :all, :list
 
     # Get a single authorization
     #
@@ -56,39 +46,45 @@ def get(*args)
 
       get_request("/authorizations/#{arguments.id}", arguments.params)
     end
-    alias :find :get
+    alias_method :find, :get
 
     # Create a new authorization
     #
+    # @see https://developer.github.com/v3/oauth_authorizations/#create-a-new-authorization
+    #
     # @param [Hash] params
     # @option params [Array[String]] :scopes
     #   A list of scopes that this authorization is in.
     # @option params [String] :note
-    #   A note to remind you what the OAuth token is for.
+    #   Required. A note to remind you what the OAuth token is for.
     # @option params [String] :note_url
     #   A URL to remind you what the OAuth token is for.
     # @option params [String] :client_id
     #   The 20 character OAuth app client key for which to create the token.
     # @option params [String] :client_secret
     #   The 40 character OAuth app client secret for which to create the token.
+    # @option params [String] :fingerprint
+    #   A unique string to distinguish an authorization from others
+    #   created for the same client ID and user.
     #
     # @example
-    #  github = Github.new basic_auth: 'login:password'
-    #  github.oauth.create
-    #    "scopes" => ["public_repo"]
+    #   github = Github.new basic_auth: 'login:password'
+    #   github.oauth.create scopes: ["public_repo"], note: 'amdmin script'
     #
     # @api public
     def create(*args)
       raise_authentication_error unless authenticated?
       arguments(args) do
-        permit VALID_AUTH_PARAM_NAMES
+        assert_required :note, :scopes
       end
 
       post_request('/authorizations', arguments.params)
     end
 
     # Update an existing authorization
     #
+    # @see https://developer.github.com/v3/oauth_authorizations/#update-an-existing-authorization
+    #
     # @param [Hash] inputs
     # @option inputs [Array] :scopes
     #   Optional array - A list of scopes that this authorization is in.
@@ -100,28 +96,30 @@ def create(*args)
     #   Optional string - A note to remind you what the OAuth token is for.
     # @optoin inputs [String] :note_url
     #   Optional string - A URL to remind you what the OAuth token is for.
+    # @option params [String] :fingerprint
+    #   A unique string to distinguish an authorization from others
+    #   created for the same client ID and user.
     #
     # @example
-    #  github = Github.new basic_auth: 'login:password'
-    #  github.oauth.update "authorization-id", add_scopes: ["repo"]
+    #   github = Github.new basic_auth: 'login:password'
+    #   github.oauth.update "authorization-id", add_scopes: ["repo"]
     #
     # @api public
     def update(*args)
       raise_authentication_error unless authenticated?
-      arguments(args, required: [:id]) do
-        permit VALID_AUTH_PARAM_NAMES
-      end
+      arguments(args, required: [:id])
 
       patch_request("/authorizations/#{arguments.id}", arguments.params)
     end
-    alias :edit :update
+    alias_method :edit, :update
 
     # Delete an authorization
     #
     # @see https://developer.github.com/v3/oauth_authorizations/#delete-an-authorization
     #
     # @example
-    #  github.oauth.delete 'authorization-id'
+    #   github = Github.new
+    #   github.oauth.delete 'authorization-id'
     #
     # @api public
     def delete(*args)
@@ -130,14 +128,13 @@ def delete(*args)
 
       delete_request("/authorizations/#{arguments.id}", arguments.params)
     end
-    alias :remove :delete
+    alias_method :remove, :delete
 
     protected
 
     def raise_authentication_error
-      raise ArgumentError, 'You can only access your own tokens' +
-        ' via Basic Authentication'
+      raise ArgumentError, 'You can only access your own tokens' \
+                           ' via Basic Authentication'
     end
-
   end # Client::Authorizations
 end # Github
diff --git a/spec/github/client/authorizations/create_spec.rb b/spec/github/client/authorizations/create_spec.rb
@@ -5,7 +5,7 @@
 describe Github::Client::Authorizations, '#create' do
   let(:basic_auth)   { 'login:password' }
   let(:host)         { "https://#{basic_auth}@api.github.com" }
-  let(:inputs)       { { :scopes => ['repo'] } }
+  let(:inputs)       { {scopes: ['repo'], note: 'admin script' } }
   let(:request_path) { "/authorizations" }
 
   before {
@@ -21,7 +21,6 @@
     let(:body) { fixture('auths/authorization.json') }
     let(:status) { 201 }
 
-
     it "fails to get resource without basic authentication" do
       reset_authentication_for subject
       expect { subject.create }.to raise_error(ArgumentError)
@@ -37,6 +36,13 @@
       authorization.should be_a Github::ResponseWrapper
     end
 
+    it "fails without a note parameter" do
+      expect {
+        subject.create scopes: ['repos']
+      }.to raise_error(Github::Error::RequiredParams,
+                       /Required parameters are: note/)
+    end
+
     it "gets the authorization information" do
       authorization = subject.create inputs
       authorization.token.should == 'abc123'
