octokit 4.24.0 → 5.0.0

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
@@ -63,7 +63,6 @@ module Octokit
         opts = ensure_api_media_type(:traffic, options)
         get "#{Repository.path repo}/traffic/clones", opts
       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,14 @@ 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
@@ -84,7 +84,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 +96,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 +109,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 +174,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 +227,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 +253,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 +297,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 +309,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 +325,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 +335,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.
       #
@@ -354,7 +354,7 @@ module Octokit
       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.
@@ -365,7 +365,7 @@ module Octokit
       # @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.
@@ -429,6 +429,7 @@ module Octokit
     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?

data/lib/octokit/client.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'octokit/connection'
 require 'octokit/warnable'
 require 'octokit/arguments'
@@ -64,12 +66,10 @@ require 'octokit/client/users'
 require 'ext/sawyer/relation'
 
 module Octokit
-
   # Client for the GitHub API
   #
   # @see https://developer.github.com
   class Client
-
     include Octokit::Authentication
     include Octokit::Configurable
     include Octokit::Connection
@@ -128,11 +128,18 @@ module Octokit
     include Octokit::Client::Users
 
     # Header keys that can be passed in options hash to {#get},{#head}
-    CONVENIENCE_HEADERS = Set.new([:accept, :content_type])
+    CONVENIENCE_HEADERS = Set.new(%i[accept content_type])
 
     def initialize(options = {})
       # Use options passed in, but fall back to module defaults
+      #
+      # rubocop:disable Style/HashEachMethods
+      #
+      # This may look like a `.keys.each` which should be replaced with `#each_key`, but
+      # this doesn't actually work, since `#keys` is just a method we've defined ourselves.
+      # The class doesn't fulfill the whole `Enumerable` contract.
       Octokit::Configurable.keys.each do |key|
+        # rubocop:enable Style/HashEachMethods
         value = options[key].nil? ? Octokit.instance_variable_get(:"@#{key}") : options[key]
         instance_variable_set(:"@#{key}", value)
       end
@@ -148,11 +155,17 @@ module Octokit
 
       # mask password
       inspected.gsub! @password, '*******' if @password
-      inspected.gsub! @management_console_password, '*******' if @management_console_password
+      if @management_console_password
+        inspected.gsub! @management_console_password, '*******'
+      end
       inspected.gsub! @bearer_token, '********' if @bearer_token
       # Only show last 4 of token, secret
-      inspected.gsub! @access_token, "#{'*'*36}#{@access_token[36..-1]}" if @access_token
-      inspected.gsub! @client_secret, "#{'*'*36}#{@client_secret[36..-1]}" if @client_secret
+      if @access_token
+        inspected.gsub! @access_token, "#{'*' * 36}#{@access_token[36..-1]}"
+      end
+      if @client_secret
+        inspected.gsub! @client_secret, "#{'*' * 36}#{@client_secret[36..-1]}"
+      end
 
       inspected
     end
@@ -170,11 +183,12 @@ module Octokit
     #     # GET https://foo:bar@api.github.com/
     #     client.get "/"
     #   end
-    def as_app(key = client_id, secret = client_secret, &block)
+    def as_app(key = client_id, secret = client_secret)
       if key.to_s.empty? || secret.to_s.empty?
-        raise ApplicationCredentialsRequired, "client_id and client_secret required"
+        raise ApplicationCredentialsRequired, 'client_id and client_secret required'
       end
-      app_client = self.dup
+
+      app_client = dup
       app_client.client_id = app_client.client_secret = nil
       app_client.login    = key
       app_client.password = secret
@@ -235,10 +249,10 @@ module Octokit
       conn_opts[:url] = @api_endpoint
       conn_opts[:builder] = @middleware.dup if @middleware
       conn_opts[:proxy] = @proxy if @proxy
-      conn_opts[:ssl] = { :verify_mode => @ssl_verify_mode } if @ssl_verify_mode
+      conn_opts[:ssl] = { verify_mode: @ssl_verify_mode } if @ssl_verify_mode
       conn = Faraday.new(conn_opts) do |http|
         if basic_authenticated?
-          http.request *FARADAY_BASIC_AUTH_KEYS, @login, @password
+          http.request(*FARADAY_BASIC_AUTH_KEYS, @login, @password)
         elsif token_authenticated?
           http.request :authorization, 'token', @access_token
         elsif bearer_authenticated?

data/lib/octokit/configurable.rb

@@ -1,5 +1,6 @@
-module Octokit
+# frozen_string_literal: true
 
+module Octokit
   # Configuration options for {Client}, defaulting to values
   # in {Default}
   module Configurable
@@ -61,31 +62,30 @@ module Octokit
                 :management_console_endpoint, :management_console_password
 
     class << self
-
       # List of configurable keys for {Octokit::Client}
       # @return [Array] of option keys
       def keys
-        @keys ||= [
-          :access_token,
-          :api_endpoint,
-          :auto_paginate,
-          :bearer_token,
-          :client_id,
-          :client_secret,
-          :connection_options,
-          :default_media_type,
-          :login,
-          :management_console_endpoint,
-          :management_console_password,
-          :middleware,
-          :netrc,
-          :netrc_file,
-          :per_page,
-          :password,
-          :proxy,
-          :ssl_verify_mode,
-          :user_agent,
-          :web_endpoint
+        @keys ||= %i[
+          access_token
+          api_endpoint
+          auto_paginate
+          bearer_token
+          client_id
+          client_secret
+          connection_options
+          default_media_type
+          login
+          management_console_endpoint
+          management_console_password
+          middleware
+          netrc
+          netrc_file
+          per_page
+          password
+          proxy
+          ssl_verify_mode
+          user_agent
+          web_endpoint
         ]
       end
     end
@@ -97,7 +97,13 @@ module Octokit
 
     # Reset configuration options to default values
     def reset!
+      # rubocop:disable Style/HashEachMethods
+      #
+      # This may look like a `.keys.each` which should be replaced with `#each_key`, but
+      # this doesn't actually work, since `#keys` is just a method we've defined ourselves.
+      # The class doesn't fulfill the whole `Enumerable` contract.
       Octokit::Configurable.keys.each do |key|
+        # rubocop:enable Style/HashEachMethods
         instance_variable_set(:"@#{key}", Octokit::Default.options[key])
       end
       self
@@ -113,18 +119,18 @@ module Octokit
     end
 
     def api_endpoint
-      File.join(@api_endpoint, "")
+      File.join(@api_endpoint, '')
     end
 
     def management_console_endpoint
-      File.join(@management_console_endpoint, "")
+      File.join(@management_console_endpoint, '')
     end
 
     # Base URL for generated web URLs
     #
     # @return [String] Default: https://github.com/
     def web_endpoint
-      File.join(@web_endpoint, "")
+      File.join(@web_endpoint, '')
     end
 
     def login
@@ -140,7 +146,7 @@ module Octokit
     private
 
     def options
-      Hash[Octokit::Configurable.keys.map{|key| [key, instance_variable_get(:"@#{key}")]}]
+      Hash[Octokit::Configurable.keys.map { |key| [key, instance_variable_get(:"@#{key}")] }]
     end
 
     def fetch_client_id_and_secret(overrides = {})

data/lib/octokit/connection.rb

@@ -1,14 +1,14 @@
+# frozen_string_literal: true
+
 require 'sawyer'
 require 'octokit/authentication'
 module Octokit
-
   # Network layer for API clients.
   module Connection
-
     include Octokit::Authentication
 
     # Header keys that can be passed in options hash to {#get},{#head}
-    CONVENIENCE_HEADERS = Set.new([:accept, :content_type])
+    CONVENIENCE_HEADERS = Set.new(%i[accept content_type])
 
     # Make a HTTP GET request
     #
@@ -75,17 +75,17 @@ module Octokit
     #   contains the contents of the requests so far and the second parameter
     #   contains the latest response.
     # @return [Sawyer::Resource]
-    def paginate(url, options = {}, &block)
+    def paginate(url, options = {})
       opts = parse_query_and_convenience_headers(options)
       if @auto_paginate || @per_page
-        opts[:query][:per_page] ||=  @per_page || (@auto_paginate ? 100 : nil)
+        opts[:query][:per_page] ||= @per_page || (@auto_paginate ? 100 : nil)
       end
 
       data = request(:get, url, opts.dup)
 
       if @auto_paginate
         while @last_response.rels[:next] && rate_limit.remaining > 0
-          @last_response = @last_response.rels[:next].get(:headers => opts[:headers])
+          @last_response = @last_response.rels[:next].get(headers: opts[:headers])
           if block_given?
             yield(data, @last_response)
           else
@@ -104,16 +104,16 @@ module Octokit
     def agent
       @agent ||= Sawyer::Agent.new(endpoint, sawyer_options) do |http|
         http.headers[:accept] = default_media_type
-        http.headers[:content_type] = "application/json"
+        http.headers[:content_type] = 'application/json'
         http.headers[:user_agent] = user_agent
         if basic_authenticated?
-          http.request *FARADAY_BASIC_AUTH_KEYS, @login, @password
+          http.request(*FARADAY_BASIC_AUTH_KEYS, @login, @password)
         elsif token_authenticated?
           http.request :authorization, 'token', @access_token
         elsif bearer_authenticated?
           http.request :authorization, 'Bearer', @bearer_token
         elsif application_authenticated?
-          http.request *FARADAY_BASIC_AUTH_KEYS, @client_id, @client_secret
+          http.request(*FARADAY_BASIC_AUTH_KEYS, @client_id, @client_secret)
         end
       end
     end
@@ -122,7 +122,7 @@ module Octokit
     #
     # @return [Sawyer::Resource]
     def root
-      get "/"
+      get '/'
     end
 
     # Response for last HTTP request
@@ -155,9 +155,9 @@ module Octokit
 
       @last_response = response = agent.call(method, Addressable::URI.parse(path.to_s).normalize.to_s, data, options)
       response.data
-    rescue Octokit::Error => error
+    rescue Octokit::Error => e
       @last_response = nil
-      raise error
+      raise e
     end
 
     # Executes the request, checking if it was successful
@@ -170,21 +170,20 @@ module Octokit
       false
     end
 
-
     def sawyer_options
       opts = {
-        :links_parser => Sawyer::LinkParsers::Simple.new
+        links_parser: Sawyer::LinkParsers::Simple.new
       }
       conn_opts = @connection_options
       conn_opts[:builder] = @middleware.dup if @middleware
       conn_opts[:proxy] = @proxy if @proxy
       if conn_opts[:ssl].nil?
-        conn_opts[:ssl] = { :verify_mode => @ssl_verify_mode } if @ssl_verify_mode
+        conn_opts[:ssl] = { verify_mode: @ssl_verify_mode } if @ssl_verify_mode
       else
         verify = @connection_options[:ssl][:verify]
         conn_opts[:ssl] = {
-          :verify => verify,
-          :verify_mode => verify == false ? 0 : @ssl_verify_mode
+          verify: verify,
+          verify_mode: verify == false ? 0 : @ssl_verify_mode
         }
       end
       opts[:faraday] = Faraday.new(conn_opts)
@@ -194,15 +193,15 @@ module Octokit
 
     def parse_query_and_convenience_headers(options)
       options = options.dup
-      headers = options.delete(:headers) { Hash.new }
+      headers = options.delete(:headers) { {} }
       CONVENIENCE_HEADERS.each do |h|
         if header = options.delete(h)
           headers[h] = header
         end
       end
       query = options.delete(:query)
-      opts = {:query => options}
-      opts[:query].merge!(query) if query && query.is_a?(Hash)
+      opts = { query: options }
+      opts[:query].merge!(query) if query&.is_a?(Hash)
       opts[:headers] = headers unless headers.empty?
 
       opts

data/lib/octokit/default.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'octokit/middleware/follow_redirects'
 require 'octokit/response/raise_error'
 require 'octokit/response/feed_parser'
@@ -13,28 +15,29 @@ if Gem::Version.new(Faraday::VERSION) >= Gem::Version.new('2.0')
 end
 
 module Octokit
-
   # Default configuration options for {Client}
   module Default
-
     # Default API endpoint
-    API_ENDPOINT = "https://api.github.com".freeze
+    API_ENDPOINT = 'https://api.github.com'
 
     # Default User Agent header string
-    USER_AGENT   = "Octokit Ruby Gem #{Octokit::VERSION}".freeze
+    USER_AGENT   = "Octokit Ruby Gem #{Octokit::VERSION}"
 
     # Default media type
-    MEDIA_TYPE   = "application/vnd.github.v3+json".freeze
+    MEDIA_TYPE   = 'application/vnd.github.v3+json'
 
     # Default WEB endpoint
-    WEB_ENDPOINT = "https://github.com".freeze
+    WEB_ENDPOINT = 'https://github.com'
 
     # Default Faraday middleware stack
     MIDDLEWARE = Faraday::RackBuilder.new do |builder|
       # In Faraday 2.x, Faraday::Request::Retry was moved to a separate gem
       # so we use it only when it's available.
-      builder.use Faraday::Request::Retry, exceptions: [Octokit::ServerError] if defined?(Faraday::Request::Retry)
-      builder.use Faraday::Retry::Middleware, exceptions: [Octokit::ServerError] if defined?(Faraday::Retry::Middleware)
+      if defined?(Faraday::Request::Retry)
+        builder.use Faraday::Request::Retry, exceptions: [Octokit::ServerError]
+      elsif defined?(Faraday::Retry::Middleware)
+        builder.use Faraday::Retry::Middleware, exceptions: [Octokit::ServerError]
+      end
 
       builder.use Octokit::Middleware::FollowRedirects
       builder.use Octokit::Response::RaiseError
@@ -43,11 +46,10 @@ module Octokit
     end
 
     class << self
-
       # Configuration options
       # @return [Hash]
       def options
-        Hash[Octokit::Configurable.keys.map{|key| [key, send(key)]}]
+        Hash[Octokit::Configurable.keys.map { |key| [key, send(key)] }]
       end
 
       # Default access token from ENV
@@ -102,9 +104,9 @@ module Octokit
       # @return [Hash]
       def connection_options
         {
-          :headers => {
-            :accept => default_media_type,
-            :user_agent => user_agent
+          headers: {
+            accept: default_media_type,
+            user_agent: user_agent
           }
         }
       end
@@ -139,7 +141,7 @@ module Octokit
       def per_page
         page_size = ENV['OCTOKIT_PER_PAGE']
 
-        page_size.to_i if page_size
+        page_size&.to_i
       end
 
       # Default proxy server URI for Faraday connection from ENV
@@ -180,7 +182,6 @@ module Octokit
       def netrc_file
         ENV['OCTOKIT_NETRC_FILE'] || File.join(ENV['HOME'].to_s, '.netrc')
       end
-
     end
   end
 end