octokit 4.22.0 → 7.0.0

data/lib/octokit/client/reviews.rb

@@ -1,11 +1,11 @@
+# frozen_string_literal: true
+
 module Octokit
   class Client
-
     # Methods for the Reviews API
     #
     # @see https://developer.github.com/v3/pulls/reviews/
     module Reviews
-
       # List reviews on a pull request
       #
       # @param repo [Integer, String, Hash, Repository] A GitHub repository
@@ -151,7 +151,7 @@ module Octokit
       # @param number [Integer] Number ID of the pull request
       # @param reviewers [Hash] :reviewers [Array<String>] An array of user logins
       # @param options [Hash] :team_reviewers [Array<String>] An array of team slugs
-      # @see https://developer.github.com/v3/pulls/review_requests/#create-a-review-request
+      # @see https://developer.github.com/v3/pulls/review_requests/#request-reviewers-for-a-pull-request
       #
       # @example
       #   @client.request_pull_request_review('octokit/octokit.rb', 2, reviewers: ['soudy'])
@@ -161,9 +161,9 @@ module Octokit
         # TODO(5.0): remove deprecated behavior
         if reviewers.is_a?(Array)
           octokit_warn(
-            "Deprecated: Octokit::Client#request_pull_request_review "\
+            'Deprecated: Octokit::Client#request_pull_request_review ' \
             "no longer takes a separate :reviewers argument.\n" \
-            "Please update your call to pass :reviewers and :team_reviewers as part of the options hash."
+            'Please update your call to pass :reviewers and :team_reviewers as part of the options hash.'
           )
           options = options.merge(reviewers: reviewers)
         else
@@ -190,13 +190,13 @@ module Octokit
       #   @client.delete_pull_request_review_request('octokit/octokit.rb', 2, options)
       #
       # @return [Sawyer::Resource>] Hash representing the pull request
-      def delete_pull_request_review_request(repo, id, reviewers={}, options = {})
+      def delete_pull_request_review_request(repo, id, reviewers = {}, options = {})
         # TODO(5.0): remove deprecated behavior
         if !reviewers.empty? && !options.empty?
           octokit_warn(
-            "Deprecated: Octokit::Client#delete_pull_request_review_request "\
+            'Deprecated: Octokit::Client#delete_pull_request_review_request ' \
             "no longer takes a separate :reviewers argument.\n" \
-            "Please update your call to pass :reviewers and :team_reviewers as part of the options hash."
+            'Please update your call to pass :reviewers and :team_reviewers as part of the options hash.'
           )
         end
         # For backwards compatibility, this endpoint can be called with a separate reviewers hash.

data/lib/octokit/client/say.rb

@@ -1,19 +1,18 @@
+# frozen_string_literal: true
+
 module Octokit
   class Client
-
     # Methods for the unpublished Octocat API
     module Say
-
       # Return a nifty ASCII Octocat with GitHub wisdom
       # or your own
       #
       # @return [String]
       def say(text = nil, options = {})
         options[:s] = text if text
-        get "octocat", options
+        get 'octocat', options
       end
-      alias :octocat :say
-
+      alias octocat say
     end
   end
 end

data/lib/octokit/client/search.rb

@@ -1,11 +1,11 @@
+# frozen_string_literal: true
+
 module Octokit
   class Client
-
     # Methods for the Search API
     #
     # @see https://developer.github.com/v3/search/
     module Search
-
       # Search code
       #
       # @param query [String] Search term and qualifiers
@@ -17,7 +17,7 @@ module Octokit
       # @return [Sawyer::Resource] Search results object
       # @see https://developer.github.com/v3/search/#search-code
       def search_code(query, options = {})
-        search "search/code", query, options
+        search 'search/code', query, options
       end
 
       # Search commits
@@ -31,8 +31,7 @@ module Octokit
       # @return [Sawyer::Resource] Search results object
       # @see https://developer.github.com/v3/search/#search-commits
       def search_commits(query, options = {})
-        options = ensure_api_media_type(:commit_search, options)
-        search "search/commits", query, options
+        search 'search/commits', query, options
       end
 
       # Search issues
@@ -45,8 +44,9 @@ module Octokit
       # @option options [Integer] :per_page Number of items per page
       # @return [Sawyer::Resource] Search results object
       # @see https://developer.github.com/v3/search/#search-issues-and-pull-requests
+      # @see https://docs.github.com/en/rest/search#limitations-on-query-length
       def search_issues(query, options = {})
-        search "search/issues", query, options
+        search 'search/issues', query, options
       end
 
       # Search repositories
@@ -60,9 +60,23 @@ module Octokit
       # @return [Sawyer::Resource] Search results object
       # @see https://developer.github.com/v3/search/#search-repositories
       def search_repositories(query, options = {})
-        search "search/repositories", query, options
+        search 'search/repositories', query, options
+      end
+      alias search_repos search_repositories
+
+      # Search topics
+      #
+      # @param query [String] Search term and qualifiers
+      # @param options [Hash] Sort and pagination options
+      # @option options [String] :sort Sort field
+      # @option options [String] :order Sort order (asc or desc)
+      # @option options [Integer] :page Page of paginated results
+      # @option options [Integer] :per_page Number of items per page
+      # @return [Sawyer::Resource] Search results object
+      # @see https://developer.github.com/v3/search/#search-topics
+      def search_topics(query, options = {})
+        search 'search/topics', query, options
       end
-      alias :search_repos :search_repositories
 
       # Search users
       #
@@ -75,13 +89,13 @@ module Octokit
       # @return [Sawyer::Resource] Search results object
       # @see https://developer.github.com/v3/search/#search-users
       def search_users(query, options = {})
-        search "search/users", query, options
+        search 'search/users', query, options
       end
 
       private
 
       def search(path, query, options = {})
-        opts = options.merge(:q => query)
+        opts = options.merge(q: query)
         paginate(path, opts) do |data, last_response|
           data.items.concat last_response.data.items
         end

data/lib/octokit/client/service_status.rb

@@ -1,37 +1,47 @@
+# frozen_string_literal: true
+
 module Octokit
   class Client
-
     # Methods for the GitHub Status API
     #
     # @see https://status.github.com/api
     module ServiceStatus
-
       # Root for status API
       # @private
-      STATUS_ROOT = 'https://status.github.com/api.json'
+      SUMMARY_ROOT    = 'https://www.githubstatus.com/api/v2/summary.json'
+      STATUS_ROOT     = 'https://www.githubstatus.com/api/v2/status.json'
+      COMPONENTS_ROOT = 'https://www.githubstatus.com/api/v2/components.json'
+
+      # Returns a summary with the current status and the last status messages.
+      #
+      # @return [<Sawyer::Resource>] GitHub status summary
+      # @see https://www.githubstatus.com/api#summory
+      def github_status_summary
+        get(SUMMARY_ROOT)
+      end
 
       # Returns the current system status
       #
       # @return [Sawyer::Resource] GitHub status
-      # @see https://status.github.com/api#api-current-status
+      # @see https://www.githubstatus.com/api#status
       def github_status
-        get(STATUS_ROOT).rels[:status].get.data
+        get(STATUS_ROOT)
       end
 
       # Returns the last human communication, status, and timestamp.
       #
       # @return [Sawyer::Resource] GitHub status last message
-      # @see https://status.github.com/api#api-last-message
+      # @see https://www.githubstatus.com/api/#components
       def github_status_last_message
-        get(STATUS_ROOT).rels[:last_message].get.data
+        get(COMPONENTS_ROOT).components.first
       end
 
       # Returns the most recent human communications with status and timestamp.
       #
       # @return [Array<Sawyer::Resource>] GitHub status messages
-      # @see https://status.github.com/api#api-recent-messages
+      # @see https://www.githubstatus.com/api#components
       def github_status_messages
-        get(STATUS_ROOT).rels[:messages].get.data
+        get(COMPONENTS_ROOT).components
       end
     end
   end

data/lib/octokit/client/source_import.rb

@@ -1,11 +1,11 @@
+# frozen_string_literal: true
+
 module Octokit
   class Client
-
     # Methods for the Source Import API
     #
     # @see https://developer.github.com/v3/migration/source_imports
     module SourceImport
-
       # Start a source import to a GitHub repository using GitHub Importer.
       #
       # @overload start_source_import(repo, vcs, vcs_url, options = {})
@@ -39,10 +39,10 @@ module Octokit
         vcs_url = arguments.pop
         vcs = arguments.pop
         if vcs
-          octokit_warn "Octokit#start_source_import vcs parameter is now an option, please update your call before the next major Octokit version update."
-          arguments.options.merge!(:vcs => vcs)
+          octokit_warn 'Octokit#start_source_import vcs parameter is now an option, please update your call before the next major Octokit version update.'
+          arguments.options.merge!(vcs: vcs)
         end
-        options = ensure_api_media_type(:source_imports, arguments.options.merge(:vcs_url => vcs_url))
+        options = arguments.options.merge(vcs_url: vcs_url)
         put "#{Repository.path arguments.repo}/import", options
       end
 
@@ -55,7 +55,6 @@ module Octokit
       # @example
       #   @client.source_import_progress("octokit/octokit.rb")
       def source_import_progress(repo, options = {})
-        options = ensure_api_media_type(:source_imports, options)
         get "#{Repository.path repo}/import", options
       end
 
@@ -76,7 +75,6 @@ module Octokit
       #    :vcs_password  => "secret"
       #   })
       def update_source_import(repo, options = {})
-        options = ensure_api_media_type(:source_imports, options)
         patch "#{Repository.path repo}/import", options
       end
 
@@ -91,7 +89,6 @@ module Octokit
       # @example
       #   @client.source_import_commit_authors("octokit/octokit.rb")
       def source_import_commit_authors(repo, options = {})
-        options = ensure_api_media_type(:source_imports, options)
         get "#{Repository.path repo}/import/authors", options
       end
 
@@ -111,7 +108,7 @@ module Octokit
       #     :name => "Hubot the Robot"
       #   })
       def map_source_import_commit_author(author_url, values, options = {})
-        options = ensure_api_media_type(:source_imports, options.merge(values))
+        options = options.merge(values)
         patch author_url, options
       end
 
@@ -124,7 +121,6 @@ module Octokit
       # @example
       #   @client.cancel_source_import("octokit/octokit.rb")
       def cancel_source_import(repo, options = {})
-        options = ensure_api_media_type(:source_imports, options)
         boolean_from_response :delete, "#{Repository.path repo}/import", options
       end
 
@@ -139,7 +135,6 @@ module Octokit
       # @example
       #   @client.source_import_large_files("octokit/octokit.rb")
       def source_import_large_files(repo, options = {})
-        options = ensure_api_media_type(:source_imports, options)
         get "#{Repository.path repo}/import/large_files", options
       end
 
@@ -153,7 +148,7 @@ module Octokit
       # @example
       #   @client.opt_in_source_import_lfs("octokit/octokit.rb", "opt_in")
       def set_source_import_lfs_preference(repo, use_lfs, options = {})
-        options = ensure_api_media_type(:source_imports, options.merge(:use_lfs => use_lfs))
+        options = options.merge(use_lfs: use_lfs)
         patch "#{Repository.path repo}/import/lfs", options
       end
     end

data/lib/octokit/client/stats.rb

@@ -1,11 +1,11 @@
+# frozen_string_literal: true
+
 module Octokit
   class Client
-
     # Methods for the Repository Statistics API
     #
     # @see https://developer.github.com/v3/repos/statistics/
     module Stats
-
       # Get contributors list with additions, deletions, and commit counts
       #
       # @param repo [Integer, String, Hash, Repository] A GitHub repository
@@ -16,9 +16,9 @@ module Octokit
       # @example Get contributor stats for octokit
       #   @client.contributors_stats('octokit/octokit.rb')
       def contributors_stats(repo, options = {})
-        get_stats(repo, "contributors", options)
+        get_stats(repo, 'contributors', options)
       end
-      alias :contributor_stats :contributors_stats
+      alias contributor_stats contributors_stats
 
       # Get the last year of commit activity data
       #
@@ -31,7 +31,7 @@ module Octokit
       # @example Get commit activity for octokit
       #   @client.commit_activity_stats('octokit/octokit.rb')
       def commit_activity_stats(repo, options = {})
-        get_stats(repo, "commit_activity", options)
+        get_stats(repo, 'commit_activity', options)
       end
 
       # Get the number of additions and deletions per week
@@ -45,7 +45,7 @@ module Octokit
       # @example Get code frequency stats for octokit
       #   @client.code_frequency_stats('octokit/octokit.rb')
       def code_frequency_stats(repo, options = {})
-        get_stats(repo, "code_frequency", options)
+        get_stats(repo, 'code_frequency', options)
       end
 
       # Get the weekly commit count for the repo owner and everyone else
@@ -61,7 +61,7 @@ module Octokit
       # @example Get weekly commit counts for octokit
       #   @client.participation_stats("octokit/octokit.rb")
       def participation_stats(repo, options = {})
-        get_stats(repo, "participation", options)
+        get_stats(repo, 'participation', options)
       end
 
       # Get the number of commits per hour in each day
@@ -75,9 +75,9 @@ module Octokit
       # @example Get octokit punch card
       #   @octokit.punch_card_stats
       def punch_card_stats(repo, options = {})
-        get_stats(repo, "punch_card", options)
+        get_stats(repo, 'punch_card', options)
       end
-      alias :punch_card :punch_card_stats
+      alias punch_card punch_card_stats
 
       private
 
@@ -99,6 +99,7 @@ module Octokit
           return [] if last_response.status == 204
           return nil unless retry_timeout
           return nil if Time.now >= timeout
+
           sleep retry_wait if retry_wait
         end
       end

data/lib/octokit/client/statuses.rb

@@ -1,11 +1,11 @@
+# frozen_string_literal: true
+
 module Octokit
   class Client
-
     # Methods for the Commit Statuses API
     #
     # @see https://developer.github.com/v3/repos/statuses/
     module Statuses
-
       # List all statuses for a given commit
       #
       # @param repo [Integer, String, Repository, Hash] A GitHub repository
@@ -15,7 +15,7 @@ module Octokit
       def statuses(repo, sha, options = {})
         paginate "#{Repository.path repo}/statuses/#{sha}", options
       end
-      alias :list_statuses :statuses
+      alias list_statuses statuses
 
       # Get the combined status for a ref
       #
@@ -26,7 +26,7 @@ module Octokit
       def combined_status(repo, ref, options = {})
         get "#{Repository.path repo}/commits/#{ref}/status", options
       end
-      alias :status :combined_status
+      alias status combined_status
 
       # Create status for a commit
       #
@@ -39,7 +39,7 @@ module Octokit
       # @return [Sawyer::Resource] A status
       # @see https://developer.github.com/v3/repos/statuses/#create-a-status
       def create_status(repo, sha, state, options = {})
-        options = options.merge(:state => state)
+        options = options.merge(state: state)
         post "#{Repository.path repo}/statuses/#{sha}", options
       end
     end

data/lib/octokit/client/tokens.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Octokit
+  class Client
+    # Method to check scopes
+    #
+    # @see https://developer.github.com/v3/oauth_authorizations/#oauth-authorizations-api
+    module Tokens
+      # Check scopes for a token
+      #
+      # @param token [String] GitHub OAuth token
+      # @param options [Hash] Header params for request
+      # @return [Array<String>] OAuth scopes
+      # @see https://developer.github.com/v3/oauth/#scopes
+      def scopes(token = @access_token, options = {})
+        options = options.dup
+        raise ArgumentError, 'Access token required' if token.nil?
+
+        auth = { 'Authorization' => "token #{token}" }
+        headers = (options.delete(:headers) || {}).merge(auth)
+
+        agent.call(:get, 'user', headers: headers)
+             .headers['X-OAuth-Scopes']
+             .to_s
+             .split(',')
+             .map(&:strip)
+             .sort
+      end
+    end
+  end
+end

data/lib/octokit/client/traffic.rb

@@ -1,11 +1,11 @@
+# frozen_string_literal: true
+
 module Octokit
   class Client
-
     # Methods for the Traffic API
     #
     # @see https://developer.github.com/v3/repos/traffic/
     module Traffic
-
       # Get the top 10 referrers over the last 14 days
       #
       # @param repo [Integer, String, Repository, Hash] A GitHub repository
@@ -14,8 +14,7 @@ module Octokit
       # @example
       #   @client.top_referrers('octokit/octokit.rb')
       def top_referrers(repo, options = {})
-        opts = ensure_api_media_type(:traffic, options)
-        get "#{Repository.path repo}/traffic/popular/referrers", opts
+        get "#{Repository.path repo}/traffic/popular/referrers", options
       end
 
       # Get the top 10 popular contents over the last 14 days
@@ -26,8 +25,7 @@ module Octokit
       # @example
       #   @client.top_paths('octokit/octokit.rb')
       def top_paths(repo, options = {})
-        opts = ensure_api_media_type(:traffic, options)
-        get "#{Repository.path repo}/traffic/popular/paths", opts
+        get "#{Repository.path repo}/traffic/popular/paths", options
       end
 
       # Get the total number of views and breakdown per day or week for the
@@ -43,8 +41,7 @@ module Octokit
       # @example Views per week
       #   @client.views('octokit/octokit.rb', per: 'week')
       def views(repo, options = {})
-        opts = ensure_api_media_type(:traffic, options)
-        get "#{Repository.path repo}/traffic/views", opts
+        get "#{Repository.path repo}/traffic/views", options
       end
 
       # Get the total number of clones and breakdown per day or week for the
@@ -60,10 +57,8 @@ module Octokit
       # @example Clones per week
       #   @client.clones('octokit/octokit.rb', per: 'week')
       def clones(repo, options = {})
-        opts = ensure_api_media_type(:traffic, options)
-        get "#{Repository.path repo}/traffic/clones", opts
+        get "#{Repository.path repo}/traffic/clones", options
       end
-
     end
   end
 end