octokit 3.0.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3127ed71ac877e994dfeaae2386caba2cfe91d38
-  data.tar.gz: aeb738769c892c656de0d0971e18763de18f8e3a
+  metadata.gz: fe2687efdf727fedcb991105d4a5c9e7eb60d0d1
+  data.tar.gz: 16621b1aea7885ca2b4d1f7b508c815bcbaa717e
 SHA512:
-  metadata.gz: d14f5d8127f946870995ff7a92ccb31945ef90da7b82fce8878f921bf53c8a1ce8e285c2dc13eeae12189d7416673136b98bba1813b77b1a8cabc647323a3d9b
-  data.tar.gz: 69f7d0a715685c0506a25b44bc44533fb7baff7a815db31587a8ce260f9b7445a4d9a13995a64667d05afc538a4636deec7bb2a4d588921c06592951e520ae3a
+  metadata.gz: dba5add3cb06441c097b1e02f74cecc55d0502d6a9d726680e3d61fb95d5a13d1d41f82203454abb2b42df7cf6588f26917c45d6a2b7d370e467df223f7a4d1d
+  data.tar.gz: aed860c22d4e46ed8b24c721231cd087d0ff497c36f91182091fa2145730e2c4b56504fd27a06abe83d1503fe7b7c44cb1a767f127690339706bad84c4ee3f05

data/lib/octokit/authentication.rb

@@ -6,7 +6,7 @@ module Octokit
     # Indicates if the client was supplied  Basic Auth
     # username and password
     #
-    # @see http://developer.github.com/v3/#authentication
+    # @see https://developer.github.com/v3/#authentication
     # @return [Boolean]
     def basic_authenticated?
       !!(@login && @password)
@@ -15,7 +15,7 @@ module Octokit
     # Indicates if the client was supplied an OAuth
     # access token
     #
-    # @see http://developer.github.com/v3/#authentication
+    # @see https://developer.github.com/v3/#authentication
     # @return [Boolean]
     def token_authenticated?
       !!@access_token
@@ -24,7 +24,7 @@ module Octokit
     # Indicates if the client was supplied an OAuth
     # access token or Basic Auth username and password
     #
-    # @see http://developer.github.com/v3/#authentication
+    # @see https://developer.github.com/v3/#authentication
     # @return [Boolean]
     def user_authenticated?
       basic_authenticated? || token_authenticated?
@@ -34,7 +34,7 @@ module Octokit
     # client_id and secret credentials to make anonymous
     # requests at a higher rate limit
     #
-    # @see http://developer.github.com/v3/#unauthenticated-rate-limited-requests
+    # @see https://developer.github.com/v3/#unauthenticated-rate-limited-requests
     # @return Boolean
     def application_authenticated?
       !!application_authentication

data/lib/octokit/client.rb

@@ -45,7 +45,7 @@ module Octokit
 
   # Client for the GitHub API
   #
-  # @see http://developer.github.com
+  # @see https://developer.github.com
   class Client
 
     include Octokit::Authentication
@@ -243,8 +243,77 @@ module Octokit
       @last_response if defined? @last_response
     end
 
+    # Duplicate client using client_id and client_secret as
+    # Basic Authentication credentials.
+    # @example
+    #   Octokit.client_id = "foo"
+    #   Octokit.client_secret = "bar"
+    #
+    #   # GET https://api.github.com/?client_id=foo&client_secret=bar
+    #   Octokit.get "/"
+    #
+    #   Octokit.client.as_app do |client|
+    #     # GET https://foo:bar@api.github.com/
+    #     client.get "/"
+    #   end
+    def as_app(key = client_id, secret = client_secret, &block)
+      if key.to_s.empty? || secret.to_s.empty?
+        raise ApplicationCredentialsRequired, "client_id and client_secret required"
+      end
+      app_client = self.dup
+      app_client.client_id = app_client.client_secret = nil
+      app_client.login    = key
+      app_client.password = secret
+
+      yield app_client if block_given?
+    end
+
+    # Set username for authentication
+    #
+    # @param value [String] GitHub username
+    def login=(value)
+      reset_agent
+      @login = value
+    end
+
+    # Set password for authentication
+    #
+    # @param value [String] GitHub password
+    def password=(value)
+      reset_agent
+      @password = value
+    end
+
+    # Set OAuth access token for authentication
+    #
+    # @param value [String] 40 character GitHub OAuth access token
+    def access_token=(value)
+      reset_agent
+      @access_token = value
+    end
+
+    # Set OAuth app client_id
+    #
+    # @param value [String] 20 character GitHub OAuth app client_id
+    def client_id=(value)
+      reset_agent
+      @client_id = value
+    end
+
+    # Set OAuth app client_secret
+    #
+    # @param value [String] 40 character GitHub OAuth app client_secret
+    def client_secret=(value)
+      reset_agent
+      @client_secret = value
+    end
+
     private
 
+    def reset_agent
+      @agent = nil
+    end
+
     def request(method, path, data, options = {})
       if data.is_a?(Hash)
         options[:query]   = data.delete(:query) || {}
@@ -254,10 +323,6 @@ module Octokit
         end
       end
 
-      if application_authenticated?
-        options[:query].merge! application_authentication
-      end
-
       @last_response = response = agent.call(method, URI::Parser.new.escape(path.to_s), data, options)
       response.data
     end

data/lib/octokit/client/authorizations.rb

@@ -3,7 +3,7 @@ module Octokit
 
     # Methods for the Authorizations API
     #
-    # @see http://developer.github.com/v3/oauth_authorizations/#oauth-authorizations-api
+    # @see https://developer.github.com/v3/oauth_authorizations/#oauth-authorizations-api
     module Authorizations
 
       # List the authenticated user's authorizations
@@ -13,7 +13,7 @@ module Octokit
       # Basic Authentication.
       #
       # @return [Array<Sawyer::Resource>] A list of authorizations for the authenticated user
-      # @see http://developer.github.com/v3/oauth_authorizations/#list-your-authorizations
+      # @see https://developer.github.com/v3/oauth_authorizations/#list-your-authorizations
       # @example List authorizations for user ctshryock
       #  client = Octokit::Client.new(:login => 'ctshryock', :password => 'secret')
       #  client.authorizations
@@ -27,7 +27,7 @@ module Octokit
       # Basic Authentication.
       #
       # @return [Sawyer::Resource] A single authorization for the authenticated user
-      # @see http://developer.github.com/v3/oauth_authorizations/#get-a-single-authorization
+      # @see https://developer.github.com/v3/oauth_authorizations/#get-a-single-authorization
       # @example Show authorization for user ctshryock's Travis auth
       #  client = Octokit::Client.new(:login => 'ctshryock', :password => 'secret')
       #  client.authorization(999999)
@@ -49,9 +49,9 @@ module Octokit
       # @option options [String] :client_secret  Client Secret we received when our application was registered with GitHub.
       #
       # @return [Sawyer::Resource] A single authorization for the authenticated user
-      # @see http://developer.github.com/v3/oauth/#scopes Available scopes
-      # @see http://developer.github.com/v3/oauth_authorizations/#create-a-new-authorization
-      # @see http://developer.github.com/v3/oauth_authorizations/#get-or-create-an-authorization-for-a-specific-app
+      # @see https://developer.github.com/v3/oauth/#scopes Available scopes
+      # @see https://developer.github.com/v3/oauth_authorizations/#create-a-new-authorization
+      # @see https://developer.github.com/v3/oauth_authorizations/#get-or-create-an-authorization-for-a-specific-app
       # @example Create a new authorization for user ctshryock's project Zoidberg
       #  client = Octokit::Client.new(:login => 'ctshryock', :password => 'secret')
       #  client.create_authorization({:scopes => ["public_repo","gist"], :note => "Why not Zoidberg?", :note_url=> "https://en.wikipedia.org/wiki/Zoidberg"})
@@ -85,8 +85,8 @@ module Octokit
       # @option options [String] :note_url A URL to remind you what app the OAuth token is for.
       #
       # @return [Sawyer::Resource] A single (updated) authorization for the authenticated user
-      # @see http://developer.github.com/v3/oauth_authorizations/#update-an-existing-authorization
-      # @see http://developer.github.com/v3/oauth/#scopes for available scopes
+      # @see https://developer.github.com/v3/oauth_authorizations/#update-an-existing-authorization
+      # @see https://developer.github.com/v3/oauth/#scopes for available scopes
       # @example Update the authorization for user ctshryock's project Zoidberg
       #  client = Octokit::Client.new(:login => 'ctshryock', :password => 'secret')
       #  client.update_authorization(999999, {:add_scopes => ["gist", "repo"], :note => "Why not Zoidberg possibly?"})
@@ -102,7 +102,7 @@ module Octokit
       # @param number [Number] An existing Authorization ID
       #
       # @return [Boolean] Success
-      # @see http://developer.github.com/v3/oauth_authorizations/#delete-an-authorization
+      # @see https://developer.github.com/v3/oauth_authorizations/#delete-an-authorization
       # @example Delete an authorization
       #  client = Octokit::Client.new(:login => 'ctshryock', :password => 'secret')
       #  client.delete_authorization(999999)
@@ -114,7 +114,7 @@ module Octokit
       #
       # @param token [String] GitHub OAuth token
       # @return [Array<String>] OAuth scopes
-      # @see http://developer.github.com/v3/oauth/#scopes
+      # @see https://developer.github.com/v3/oauth/#scopes
       def scopes(token = @access_token)
         raise ArgumentError.new("Access token required") if token.nil?
 
@@ -126,28 +126,122 @@ module Octokit
           sort
       end
 
-    end
+      # Check if a token is valid.
+      #
+      # Applications can check if a token is valid without rate limits.
+      #
+      # @param token [String] 40 character GitHub OAuth access token
+      #
+      # @return [Sawyer::Resource] A single authorization for the authenticated user
+      # @see https://developer.github.com/v3/oauth_authorizations/#check-an-authorization
+      # @example
+      #  client = Octokit::Client.new(:client_id => 'abcdefg12345', :client_secret => 'secret')
+      #  client.check_application_authorization('deadbeef1234567890deadbeef987654321')
+      def check_application_authorization(token, options = {})
+        opts = options.dup
+        key    = opts.delete(:client_id)     || client_id
+        secret = opts.delete(:client_secret) || client_secret
 
-    # Get the URL to authorize a user for an application via the web flow
-    #
-    # @param app_id [String] Client Id we received when our application was registered with GitHub.
-    # @option options [String] :redirect_uri The url to redirect to after authorizing.
-    # @option options [String] :scope The scopes to request from the user.
-    # @option options [String] :state A random string to protect against CSRF.
-    # @return [String] The url to redirect the user to authorize.
-    # @see Octokit::Client
-    # @see http://developer.github.com/v3/oauth/#web-application-flow
-    # @example
-    #   @client.authorize_url('xxxx')
-    def authorize_url(app_id = client_id, options = {})
-      authorize_url = options.delete(:endpoint) || Octokit.web_endpoint
-      authorize_url += "login/oauth/authorize?client_id=" + app_id
-
-      options.each do |key, value|
-        authorize_url += "&" + key.to_s + "=" + value
+        as_app(key, secret) do |app_client|
+          app_client.get "/applications/#{client_id}/tokens/#{token}", opts
+        end
+      end
+
+      # Reset a token
+      #
+      # Applications can reset a token without requiring a user to re-authorize.
+      #
+      # @param token [String] 40 character GitHub OAuth access token
+      #
+      # @return [Sawyer::Resource] A single authorization for the authenticated user
+      # @see https://developer.github.com/v3/oauth_authorizations/#reset-an-authorization
+      # @example
+      #  client = Octokit::Client.new(:client_id => 'abcdefg12345', :client_secret => 'secret')
+      #  client.reset_application_authorization('deadbeef1234567890deadbeef987654321')
+      def reset_application_authorization(token, options = {})
+        opts = options.dup
+        key    = opts.delete(:client_id)     || client_id
+        secret = opts.delete(:client_secret) || client_secret
+
+        as_app(key, secret) do |app_client|
+          app_client.post "/applications/#{client_id}/tokens/#{token}", opts
+        end
+      end
+
+      # Revoke a token
+      #
+      # Applications can revoke (delete) a token
+      #
+      # @param token [String] 40 character GitHub OAuth access token
+      #
+      # @return [Boolean] Result
+      # @see https://developer.github.com/v3/oauth_authorizations/#revoke-an-authorization-for-an-application
+      # @example
+      #  client = Octokit::Client.new(:client_id => 'abcdefg12345', :client_secret => 'secret')
+      #  client.revoke_application_authorization('deadbeef1234567890deadbeef987654321')
+      def revoke_application_authorization(token, options = {})
+        opts = options.dup
+        key    = opts.delete(:client_id)     || client_id
+        secret = opts.delete(:client_secret) || client_secret
+
+        as_app(key, secret) do |app_client|
+          app_client.delete "/applications/#{client_id}/tokens/#{token}", opts
+
+          app_client.last_response.status == 204
+        end
+      rescue Octokit::NotFound
+        false
+      end
+      alias :delete_application_authorization :revoke_application_authorization
+
+      # Revoke all tokens for an app
+      #
+      # Applications can revoke all of their tokens in a single request
+      #
+      # @return [Boolean] Result
+      # @see https://developer.github.com/v3/oauth_authorizations/#revoke-all-authorizations-for-an-application
+      # @example
+      #  client = Octokit::Client.new(:client_id => 'abcdefg12345', :client_secret => 'secret')
+      #  client.revoke_all_application_authorizations
+      def revoke_all_application_authorizations(options = {})
+        opts = options.dup
+        key    = opts.delete(:client_id)     || client_id
+        secret = opts.delete(:client_secret) || client_secret
+
+        as_app(key, secret) do |app_client|
+          app_client.delete "/applications/#{client_id}/tokens", opts
+
+          app_client.last_response.status == 204
+        end
+      rescue Octokit::NotFound
+        false
       end
+      alias :delete_application_authorization :revoke_application_authorization
 
-      authorize_url
+      # Get the URL to authorize a user for an application via the web flow
+      #
+      # @param app_id [String] Client Id we received when our application was registered with GitHub.
+      # @option options [String] :redirect_uri The url to redirect to after authorizing.
+      # @option options [String] :scope The scopes to request from the user.
+      # @option options [String] :state A random string to protect against CSRF.
+      # @return [String] The url to redirect the user to authorize.
+      # @see Octokit::Client
+      # @see https://developer.github.com/v3/oauth/#web-application-flow
+      # @example
+      #   @client.authorize_url('xxxx')
+      def authorize_url(app_id = client_id, options = {})
+        if app_id.to_s.empty?
+          raise Octokit::ApplicationCredentialsRequired.new "client_id required"
+        end
+        authorize_url = options.delete(:endpoint) || Octokit.web_endpoint
+        authorize_url += "login/oauth/authorize?client_id=" + app_id
+
+        options.each do |key, value|
+          authorize_url += "&" + key.to_s + "=" + value
+        end
+
+        authorize_url
+      end
     end
   end
 end

data/lib/octokit/client/commit_comments.rb

@@ -3,14 +3,14 @@ module Octokit
 
     # Methods for the Commit Comments API
     #
-    # @see http://developer.github.com/v3/repos/comments/
+    # @see https://developer.github.com/v3/repos/comments/
     module CommitComments
 
       # List all commit comments
       #
       # @param repo [String, Hash, Repository] A GitHub repository
       # @return [Array] List of commit comments
-      # @see http://developer.github.com/v3/repos/comments/#list-commit-comments-for-a-repository
+      # @see https://developer.github.com/v3/repos/comments/#list-commit-comments-for-a-repository
       def list_commit_comments(repo, options = {})
         get "repos/#{Repository.new(repo)}/comments", options
       end
@@ -20,7 +20,7 @@ module Octokit
       # @param repo [String, Hash, Repository] A GitHub repository
       # @param sha [String] The SHA of the commit whose comments will be fetched
       # @return [Array]  List of commit comments
-      # @see http://developer.github.com/v3/repos/comments/#list-comments-for-a-single-commit
+      # @see https://developer.github.com/v3/repos/comments/#list-comments-for-a-single-commit
       def commit_comments(repo, sha, options = {})
         get "repos/#{Repository.new(repo)}/commits/#{sha}/comments", options
       end
@@ -30,7 +30,7 @@ module Octokit
       # @param repo [String, Hash, Repository] A GitHub repository
       # @param id [String] The ID of the comment to fetch
       # @return [Sawyer::Resource] Commit comment
-      # @see http://developer.github.com/v3/repos/comments/#get-a-single-commit-comment
+      # @see https://developer.github.com/v3/repos/comments/#get-a-single-commit-comment
       def commit_comment(repo, id, options = {})
         get "repos/#{Repository.new(repo)}/comments/#{id}", options
       end
@@ -44,7 +44,7 @@ module Octokit
       # @param line [Integer] Line number in the file to comment on
       # @param position [Integer] Line index in the diff to comment on
       # @return [Sawyer::Resource] Commit comment
-      # @see http://developer.github.com/v3/repos/comments/#create-a-commit-comment
+      # @see https://developer.github.com/v3/repos/comments/#create-a-commit-comment
       # @example Create a commit comment
       #   comment = Octokit.create_commit_comment("octocat/Hello-World", "827efc6d56897b048c772eb4087f854f46256132", "My comment message", "README.md", 10, 1)
       #   comment.commit_id # => "827efc6d56897b048c772eb4087f854f46256132"
@@ -69,7 +69,7 @@ module Octokit
       # @param id [String] The ID of the comment to update
       # @param body [String] Message
       # @return [Sawyer::Resource] Updated commit comment
-      # @see http://developer.github.com/v3/repos/comments/#update-a-commit-comment
+      # @see https://developer.github.com/v3/repos/comments/#update-a-commit-comment
       # @example Update a commit comment
       #   comment = Octokit.update_commit_comment("octocat/Hello-World", "860296", "Updated commit comment")
       #   comment.id # => 860296
@@ -86,7 +86,7 @@ module Octokit
       # @param repo [String, Hash, Repository] A GitHub repository
       # @param id [String] The ID of the comment to delete
       # @return [Boolean] Success
-      # @see http://developer.github.com/v3/repos/comments/#delete-a-commit-comment
+      # @see https://developer.github.com/v3/repos/comments/#delete-a-commit-comment
       def delete_commit_comment(repo, id, options = {})
         boolean_from_response :delete, "repos/#{Repository.new(repo)}/comments/#{id}", options
       end

data/lib/octokit/client/commits.rb

@@ -5,7 +5,7 @@ module Octokit
 
     # Methods for the Commits API
     #
-    # @see http://developer.github.com/v3/repos/commits/
+    # @see https://developer.github.com/v3/repos/commits/
     module Commits
 
       # List commits
@@ -19,7 +19,7 @@ module Octokit
       #   @param repo [String, Hash, Repository] A GitHub repository
       #   @param options [String] :sha Commit SHA or branch name from which to start the list
       # @return [Array<Sawyer::Resource>] An array of hashes representing commits
-      # @see http://developer.github.com/v3/repos/commits/#list-commits-on-a-repository
+      # @see https://developer.github.com/v3/repos/commits/#list-commits-on-a-repository
       def commits(*args)
         arguments = Octokit::RepoArguments.new(args)
         sha_or_branch = arguments.pop
@@ -43,7 +43,7 @@ module Octokit
       #   @param sha_or_branch [String] A commit SHA or branch name
       #   @param options [String] :sha Commit SHA or branch name from which to start the list
       # @return [Array<Sawyer::Resource>] An array of hashes representing commits
-      # @see http://developer.github.com/v3/repos/commits/#list-commits-on-a-repository
+      # @see https://developer.github.com/v3/repos/commits/#list-commits-on-a-repository
       # @example
       #   Octokit.commits_since('octokit/octokit.rb', '2012-10-01')
       def commits_since(*args)
@@ -69,7 +69,7 @@ module Octokit
       #   @param date [String] Date on which we want to compare
       #   @param sha_or_branch [String] Commit SHA or branch name from which to start the list
       # @return [Array<Sawyer::Resource>] An array of hashes representing commits
-      # @see http://developer.github.com/v3/repos/commits/#list-commits-on-a-repository
+      # @see https://developer.github.com/v3/repos/commits/#list-commits-on-a-repository
       # @example
       #   Octokit.commits_before('octokit/octokit.rb', '2012-10-01')
       def commits_before(*args)
@@ -95,7 +95,7 @@ module Octokit
       #   @param date [String] Date on which we want to compare
       #   @param sha_or_branch [String] Commit SHA or branch name from which to start the list
       # @return [Array<Sawyer::Resource>] An array of hashes representing commits
-      # @see http://developer.github.com/v3/repos/commits/#list-commits-on-a-repository
+      # @see https://developer.github.com/v3/repos/commits/#list-commits-on-a-repository
       # @example
       #   Octokit.commits_on('octokit/octokit.rb', '2012-10-01')
       def commits_on(*args)
@@ -124,7 +124,7 @@ module Octokit
       #   @param end_date [String] End Date on which we want to compare
       #   @param sha_or_branch [String] Commit SHA or branch name from which to start the list
       # @return [Array<Sawyer::Resource>] An array of hashes representing commits
-      # @see http://developer.github.com/v3/repos/commits/#list-commits-on-a-repository
+      # @see https://developer.github.com/v3/repos/commits/#list-commits-on-a-repository
       # @example
       #   Octokit.commits_on('octokit/octokit.rb', '2012-10-01', '2012-11-01')
       def commits_between(*args)
@@ -147,7 +147,7 @@ module Octokit
       # @param repo [String, Hash, Repository] A GitHub repository
       # @param sha [String] The SHA of the commit to fetch
       # @return [Sawyer::Resource] A hash representing the commit
-      # @see http://developer.github.com/v3/repos/commits/#get-a-single-commit
+      # @see https://developer.github.com/v3/repos/commits/#get-a-single-commit
       def commit(repo, sha, options = {})
         get "repos/#{Repository.new(repo)}/commits/#{sha}", options
       end
@@ -157,7 +157,7 @@ module Octokit
       # @param repo [String, Hash, Repository] A GitHub repository
       # @param sha [String] The SHA of the commit to fetch
       # @return [Sawyer::Resource] A hash representing the commit
-      # @see http://developer.github.com/v3/git/commits/#get-a-commit
+      # @see https://developer.github.com/v3/git/commits/#get-a-commit
       def git_commit(repo, sha, options = {})
         get "repos/#{Repository.new(repo)}/git/commits/#{sha}", options
       end
@@ -174,7 +174,7 @@ module Octokit
       # @param tree [String] The SHA of the tree object the new commit will point to
       # @param parents [String, Array] One SHA (for a normal commit) or an array of SHAs (for a merge) of the new commit's parent commits. If ommitted or empty, a root commit will be created
       # @return [Sawyer::Resource] A hash representing the new commit
-      # @see http://developer.github.com/v3/git/commits/#create-a-commit
+      # @see https://developer.github.com/v3/git/commits/#create-a-commit
       # @example Create a commit
       #   commit = Octokit.create_commit("octocat/Hello-World", "My commit message", "827efc6d56897b048c772eb4087f854f46256132", "7d1b31e74ee336d15cbd21741bc88a537ed063a0")
       #   commit.sha # => "7638417db6d59f3c431d3e1f261cc637155684cd"
@@ -193,7 +193,7 @@ module Octokit
       # @param start [String] The sha of the starting commit
       # @param endd [String] The sha of the ending commit
       # @return [Sawyer::Resource] A hash representing the comparison
-      # @see http://developer.github.com/v3/repos/commits/#compare-two-commits
+      # @see https://developer.github.com/v3/repos/commits/#compare-two-commits
       def compare(repo, start, endd, options = {})
         get "repos/#{Repository.new(repo)}/compare/#{start}...#{endd}", options
       end
@@ -205,7 +205,7 @@ module Octokit
       # @param head [String] The branch or SHA1 to merge
       # @option options [String] :commit_message The commit message for the merge
       # @return [Sawyer::Resource] A hash representing the comparison
-      # @see http://developer.github.com/v3/repos/merging/#perform-a-merge
+      # @see https://developer.github.com/v3/repos/merging/#perform-a-merge
       def merge(repo, base, head, options = {})
         params = {
           :base => base,