octokit 4.22.0 → 9.2.0

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

data/lib/octokit/client/users.rb

@@ -1,11 +1,11 @@
+# frozen_string_literal: true
+
 module Octokit
   class Client
-
     # Methods for the Users API
     #
     # @see https://developer.github.com/v3/users/
     module Users
-
       # List all GitHub users
       #
       # This provides a list of every user, in the order that they signed up
@@ -19,7 +19,7 @@ module Octokit
       #
       # @return [Array<Sawyer::Resource>] List of GitHub users.
       def all_users(options = {})
-        paginate "users", options
+        paginate 'users', options
       end
 
       # Get a single user
@@ -30,7 +30,7 @@ module Octokit
       # @see https://developer.github.com/v3/users/#get-the-authenticated-user
       # @example
       #   Octokit.user("sferik")
-      def user(user=nil, options = {})
+      def user(user = nil, options = {})
         get User.path(user), options
       end
 
@@ -45,14 +45,41 @@ module Octokit
       #   Octokit.exchange_code_for_token('aaaa', 'xxxx', 'yyyy', {:accept => 'application/json'})
       def exchange_code_for_token(code, app_id = client_id, app_secret = client_secret, options = {})
         options = options.merge({
-          :code => code,
-          :client_id => app_id,
-          :client_secret => app_secret,
-          :headers => {
-            :content_type => 'application/json',
-            :accept       => 'application/json'
-          }
-        })
+                                  code: code,
+                                  client_id: app_id,
+                                  client_secret: app_secret,
+                                  headers: {
+                                    content_type: 'application/json',
+                                    accept: 'application/json'
+                                  }
+                                })
+
+        post "#{web_endpoint}login/oauth/access_token", options
+      end
+
+      # Refresh a user's access token with a refresh token.
+      #
+      # Applications can refresh an access token without requiring a user to re-authorize using refresh access token.
+      #
+      # @param code [String] 40 character GitHub OAuth refresh access token
+      #
+      # @return [Sawyer::Resource]
+      # @see https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/refreshing-user-access-tokens#refreshing-a-user-access-token-with-a-refresh-token
+      #
+      # @example
+      #  client = Octokit::Client.new(:client_id => 'abcdefg12345', :client_secret => 'secret')
+      #  client.refresh_access_token('40-character-refresh-token')
+      def refresh_access_token(code, app_id = client_id, app_secret = client_secret, options = {})
+        options = options.merge({
+                                  refresh_token: code,
+                                  client_id: app_id,
+                                  client_secret: app_secret,
+                                  grant_type: 'refresh_token',
+                                  headers: {
+                                    content_type: 'application/json',
+                                    accept: 'application/json'
+                                  }
+                                })
 
         post "#{web_endpoint}login/oauth/access_token", options
       end
@@ -84,7 +111,7 @@ module Octokit
       # @example
       #   Octokit.update_user(:name => "Erik Michaels-Ober", :email => "sferik@gmail.com", :company => "Code for America", :location => "San Francisco", :hireable => false)
       def update_user(options)
-        patch "user", options
+        patch 'user', options
       end
 
       # Get a user's followers.
@@ -96,7 +123,7 @@ module Octokit
       # @see https://developer.github.com/v3/users/followers/#list-followers-of-a-user
       # @example
       #   Octokit.followers('pengwynn')
-      def followers(user=login, options = {})
+      def followers(user = login, options = {})
         paginate "#{User.path user}/followers", options
       end
 
@@ -109,7 +136,7 @@ module Octokit
       # @see https://developer.github.com/v3/users/followers/#list-users-followed-by-another-user
       # @example
       #   Octokit.following('pengwynn')
-      def following(user=login, options = {})
+      def following(user = login, options = {})
         paginate "#{User.path user}/following", options
       end
 
@@ -174,7 +201,7 @@ module Octokit
       # @see https://developer.github.com/v3/activity/starring/#list-repositories-being-starred
       # @example
       #   Octokit.starred('pengwynn')
-      def starred(user=login, options = {})
+      def starred(user = login, options = {})
         paginate user_path(user, 'starred'), options
       end
 
@@ -227,7 +254,7 @@ module Octokit
       # @example
       #   @client.keys
       def keys(options = {})
-        paginate "user/keys", options
+        paginate 'user/keys', options
       end
 
       # Get list of public keys for user.
@@ -253,7 +280,7 @@ module Octokit
       # @example
       #   @client.add_key('Personal projects key', 'ssh-rsa AAA...')
       def add_key(title, key, options = {})
-        post "user/keys", options.merge({:title => title, :key => key})
+        post 'user/keys', options.merge({ title: title, key: key })
       end
 
       # Update a public key
@@ -297,7 +324,7 @@ module Octokit
       # @example
       #   @client.emails
       def emails(options = {})
-        paginate "user/emails", options
+        paginate 'user/emails', options
       end
 
       # Add email address to user.
@@ -309,9 +336,9 @@ module Octokit
       # @see https://developer.github.com/v3/users/emails/#add-email-addresses
       # @example
       #   @client.add_email('new_email@user.com')
-      def add_email(email, options = {})
+      def add_email(email, _options = {})
         email = Array(email)
-        post "user/emails", email
+        post 'user/emails', email
       end
 
       # Remove email from user.
@@ -325,7 +352,7 @@ module Octokit
       #   @client.remove_email('old_email@user.com')
       def remove_email(email)
         email = Array(email)
-        boolean_from_response :delete, "user/emails", email
+        boolean_from_response :delete, 'user/emails', email
       end
 
       # List repositories being watched by a user.
@@ -335,10 +362,10 @@ module Octokit
       # @see https://developer.github.com/v3/activity/watching/#list-repositories-being-watched
       # @example
       #   @client.subscriptions("pengwynn")
-      def subscriptions(user=login, options = {})
+      def subscriptions(user = login, options = {})
         paginate user_path(user, 'subscriptions'), options
       end
-      alias :watched :subscriptions
+      alias watched subscriptions
 
       # Initiates the generation of a migration archive.
       #
@@ -352,9 +379,8 @@ module Octokit
       #   @client.start_migration(['octocat/hello-world'])
       # @see https://docs.github.com/en/rest/reference/migrations#start-a-user-migration
       def start_user_migration(repositories, options = {})
-        options = ensure_api_media_type(:migrations, options)
         options[:repositories] = repositories
-        post "user/migrations", options
+        post 'user/migrations', options
       end
 
       # Lists the most recent migrations.
@@ -364,8 +390,7 @@ module Octokit
       # @return [Array<Sawyer::Resource>] Array of migration resources.
       # @see https://docs.github.com/en/rest/reference/migrations#list-user-migrations
       def user_migrations(options = {})
-        options = ensure_api_media_type(:migrations, options)
-        paginate "user/migrations", options
+        paginate 'user/migrations', options
       end
 
       # Fetches the status of a migration.
@@ -375,7 +400,6 @@ module Octokit
       # @param id [Integer] ID number of the migration.
       # @see https://docs.github.com/en/rest/reference/migrations#get-a-user-migration-status
       def user_migration_status(id, options = {})
-        options = ensure_api_media_type(:migrations, options)
         get "user/migrations/#{id}", options
       end
 
@@ -386,7 +410,6 @@ module Octokit
       # @param id [Integer] ID number of the migration.
       # @see https://docs.github.com/en/rest/reference/migrations#download-a-user-migration-archive
       def user_migration_archive_url(id, options = {})
-        options = ensure_api_media_type(:migrations, options)
         url = "user/migrations/#{id}/archive"
 
         response = client_without_redirects(options).get(url)
@@ -400,7 +423,6 @@ module Octokit
       # @param id [Integer] ID number of the migration.
       # @see https://docs.github.com/en/rest/reference/migrations#delete-a-user-migration-archive
       def delete_user_migration_archive(id, options = {})
-        options = ensure_api_media_type(:migrations, options)
         delete "user/migrations/#{id}/archive", options
       end
 
@@ -411,7 +433,6 @@ module Octokit
       # @param id [Integer] ID number of the migration.
       # @see https://docs.github.com/en/rest/reference/migrations#list-repositories-for-a-user-migration
       def user_migration_repositories(id, options = {})
-        options = ensure_api_media_type(:migrations, options)
         get "user/migrations/#{id}/repositories", options
       end
 
@@ -423,12 +444,12 @@ module Octokit
       # @param repo [String] Name of the repository.
       # @see https://docs.github.com/en/rest/reference/migrations#unlock-a-user-repository
       def unlock_user_repository(id, repo, options = {})
-        options = ensure_api_media_type(:migrations, options)
         delete "user/migrations/#{id}/repos/#{repo}/lock", options
       end
     end
 
     private
+
     # convenience method for constructing a user specific path, if the user is logged in
     def user_path(user, path)
       if user == login && user_authenticated?