octokit 4.2.0 → 9.2.0

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)
-      opts = parse_query_and_convenience_headers(options.dup)
+    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,15 +104,19 @@ 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
+        http_cache_middleware = http.builder.handlers.delete(Faraday::HttpCache) if Faraday.const_defined?(:HttpCache)
         if basic_authenticated?
-          http.basic_auth(@login, @password)
+          http.request(*FARADAY_BASIC_AUTH_KEYS, @login, @password)
         elsif token_authenticated?
-          http.authorization 'token', @access_token
+          http.request :authorization, 'token', @access_token
+        elsif bearer_authenticated?
+          http.request :authorization, 'Bearer', @bearer_token
         elsif application_authenticated?
-          http.params = http.params.merge application_authentication
+          http.request(*FARADAY_BASIC_AUTH_KEYS, @client_id, @client_secret)
         end
+        http.builder.handlers.push(http_cache_middleware) unless http_cache_middleware.nil?
       end
     end
 
@@ -120,7 +124,7 @@ module Octokit
     #
     # @return [Sawyer::Resource]
     def root
-      get "/"
+      get '/'
     end
 
     # Response for last HTTP request
@@ -151,8 +155,11 @@ module Octokit
         end
       end
 
-      @last_response = response = agent.call(method, URI::Parser.new.escape(path.to_s), data, options)
-      response.data
+      @last_response = response = agent.call(method, Addressable::URI.parse(path.to_s).normalize.to_s, data, options)
+      response_data_correctly_encoded(response)
+    rescue Octokit::Error => e
+      @last_response = nil
+      raise e
     end
 
     # Executes the request, checking if it was successful
@@ -160,37 +167,54 @@ module Octokit
     # @return [Boolean] True on success, false otherwise
     def boolean_from_response(method, path, options = {})
       request(method, path, options)
-      @last_response.status == 204
+      [201, 202, 204].include? @last_response.status
     rescue Octokit::NotFound
       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 if @middleware
+      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
+      else
+        verify = @connection_options[:ssl][:verify]
+        conn_opts[:ssl] = {
+          verify: verify,
+          verify_mode: verify == false ? 0 : @ssl_verify_mode
+        }
+      end
       opts[:faraday] = Faraday.new(conn_opts)
 
       opts
     end
 
     def parse_query_and_convenience_headers(options)
-      headers = options.delete(:headers) { Hash.new }
+      options = options.dup
+      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
     end
+
+    def response_data_correctly_encoded(response)
+      content_type = response.headers.fetch('content-type', '')
+      return response.data unless content_type.include?('charset') && response.data.is_a?(String)
+
+      reported_encoding = content_type.match(/charset=([^ ]+)/)[1]
+      response.data.force_encoding(reported_encoding)
+    end
   end
 end

data/lib/octokit/default.rb

@@ -1,30 +1,46 @@
+# frozen_string_literal: true
+
 require 'octokit/middleware/follow_redirects'
 require 'octokit/response/raise_error'
 require 'octokit/response/feed_parser'
 require 'octokit/version'
+require 'octokit/warnable'
 
-module Octokit
+if Gem::Version.new(Faraday::VERSION) >= Gem::Version.new('2.0')
+  begin
+    require 'faraday/retry'
+  rescue LoadError
+    Octokit::Warnable.octokit_warn 'To use retry middleware with Faraday v2.0+, install `faraday-retry` gem'
+  end
+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
-
-    # In Faraday 0.9, Faraday::Builder was renamed to Faraday::RackBuilder
-    RACK_BUILDER_CLASS = defined?(Faraday::RackBuilder) ? Faraday::RackBuilder : Faraday::Builder
+    WEB_ENDPOINT = 'https://github.com'
 
     # Default Faraday middleware stack
-    MIDDLEWARE = RACK_BUILDER_CLASS.new do |builder|
+    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.
+      if defined?(Faraday::Request::Retry)
+        retry_exceptions = Faraday::Request::Retry::DEFAULT_EXCEPTIONS + [Octokit::ServerError]
+        builder.use Faraday::Request::Retry, exceptions: retry_exceptions
+      elsif defined?(Faraday::Retry::Middleware)
+        retry_exceptions = Faraday::Retry::Middleware::DEFAULT_EXCEPTIONS + [Octokit::ServerError]
+        builder.use Faraday::Retry::Middleware, exceptions: retry_exceptions
+      end
+
       builder.use Octokit::Middleware::FollowRedirects
       builder.use Octokit::Response::RaiseError
       builder.use Octokit::Response::FeedParser
@@ -32,62 +48,85 @@ module Octokit
     end
 
     class << self
-
       # Configuration options
       # @return [Hash]
       def options
-        Hash[Octokit::Configurable.keys.map{|key| [key, send(key)]}]
+        Octokit::Configurable.keys.to_h { |key| [key, send(key)] }
       end
 
       # Default access token from ENV
       # @return [String]
       def access_token
-        ENV['OCTOKIT_ACCESS_TOKEN']
+        ENV.fetch('OCTOKIT_ACCESS_TOKEN', nil)
       end
 
       # Default API endpoint from ENV or {API_ENDPOINT}
       # @return [String]
       def api_endpoint
-        ENV['OCTOKIT_API_ENDPOINT'] || API_ENDPOINT
+        ENV.fetch('OCTOKIT_API_ENDPOINT') { API_ENDPOINT }
       end
 
       # Default pagination preference from ENV
       # @return [String]
       def auto_paginate
-        ENV['OCTOKIT_AUTO_PAGINATE']
+        ENV.fetch('OCTOKIT_AUTO_PAGINATE', nil)
+      end
+
+      # Default bearer token from ENV
+      # @return [String]
+      def bearer_token
+        ENV.fetch('OCTOKIT_BEARER_TOKEN', nil)
       end
 
       # Default OAuth app key from ENV
       # @return [String]
       def client_id
-        ENV['OCTOKIT_CLIENT_ID']
+        ENV.fetch('OCTOKIT_CLIENT_ID', nil)
       end
 
       # Default OAuth app secret from ENV
       # @return [String]
       def client_secret
-        ENV['OCTOKIT_SECRET']
+        ENV.fetch('OCTOKIT_SECRET', nil)
       end
 
       # Default management console password from ENV
       # @return [String]
       def management_console_password
-        ENV['OCTOKIT_ENTERPRISE_MANAGEMENT_CONSOLE_PASSWORD']
+        ENV.fetch('OCTOKIT_ENTERPRISE_MANAGEMENT_CONSOLE_PASSWORD', nil)
       end
 
       # Default management console endpoint from ENV
       # @return [String]
       def management_console_endpoint
-        ENV['OCTOKIT_ENTERPRISE_MANAGEMENT_CONSOLE_ENDPOINT']
+        ENV.fetch('OCTOKIT_ENTERPRISE_MANAGEMENT_CONSOLE_ENDPOINT', nil)
+      end
+
+      # Default GHES Manage API endpoint from ENV
+      # @return [String]
+      def manage_ghes_endpoint
+        ENV.fetch('OCTOKIT_MANAGE_GHES_ENDPOINT', nil)
+      end
+
+      # Default GHES Manage API username from ENV
+      # @return [String]
+      def manage_ghes_username
+        ENV.fetch('OCTOKIT_MANAGE_GHES_USERNAME', nil)
+      end
+
+      # Default GHES Manage API password from ENV
+      # @return [String]
+      def manage_ghes_password
+        ENV.fetch('OCTOKIT_MANAGE_GHES_PASSWORD', nil)
       end
 
       # Default options for Faraday::Connection
       # @return [Hash]
       def connection_options
         {
-          :headers => {
-            :accept => default_media_type,
-            :user_agent => user_agent
+          headers: {
+            accept: default_media_type,
+            user_agent: user_agent
           }
         }
       end
@@ -95,18 +134,18 @@ module Octokit
       # Default media type from ENV or {MEDIA_TYPE}
       # @return [String]
       def default_media_type
-        ENV['OCTOKIT_DEFAULT_MEDIA_TYPE'] || MEDIA_TYPE
+        ENV.fetch('OCTOKIT_DEFAULT_MEDIA_TYPE') { MEDIA_TYPE }
       end
 
       # Default GitHub username for Basic Auth from ENV
       # @return [String]
       def login
-        ENV['OCTOKIT_LOGIN']
+        ENV.fetch('OCTOKIT_LOGIN', nil)
       end
 
       # Default middleware stack for Faraday::Connection
       # from {MIDDLEWARE}
-      # @return [String]
+      # @return [Faraday::RackBuilder or Faraday::Builder]
       def middleware
         MIDDLEWARE
       end
@@ -114,47 +153,55 @@ module Octokit
       # Default GitHub password for Basic Auth from ENV
       # @return [String]
       def password
-        ENV['OCTOKIT_PASSWORD']
+        ENV.fetch('OCTOKIT_PASSWORD', nil)
       end
 
       # Default pagination page size from ENV
-      # @return [Fixnum] Page size
+      # @return [Integer] Page size
       def per_page
-        page_size = ENV['OCTOKIT_PER_PAGE']
+        page_size = ENV.fetch('OCTOKIT_PER_PAGE', nil)
 
-        page_size.to_i if page_size
+        page_size&.to_i
       end
 
       # Default proxy server URI for Faraday connection from ENV
       # @return [String]
       def proxy
-        ENV['OCTOKIT_PROXY']
+        ENV.fetch('OCTOKIT_PROXY', nil)
+      end
+
+      # Default SSL verify mode from ENV
+      # @return [Integer]
+      def ssl_verify_mode
+        # 0 is OpenSSL::SSL::VERIFY_NONE
+        # 1 is OpenSSL::SSL::SSL_VERIFY_PEER
+        # the standard default for SSL is SSL_VERIFY_PEER which requires a server certificate check on the client
+        ENV.fetch('OCTOKIT_SSL_VERIFY_MODE', 1).to_i
       end
 
       # Default User-Agent header string from ENV or {USER_AGENT}
       # @return [String]
       def user_agent
-        ENV['OCTOKIT_USER_AGENT'] || USER_AGENT
+        ENV.fetch('OCTOKIT_USER_AGENT') { USER_AGENT }
       end
 
       # Default web endpoint from ENV or {WEB_ENDPOINT}
       # @return [String]
       def web_endpoint
-        ENV['OCTOKIT_WEB_ENDPOINT'] || WEB_ENDPOINT
+        ENV.fetch('OCTOKIT_WEB_ENDPOINT') { WEB_ENDPOINT }
       end
 
       # Default behavior for reading .netrc file
       # @return [Boolean]
       def netrc
-        ENV['OCTOKIT_NETRC'] || false
+        ENV.fetch('OCTOKIT_NETRC', false)
       end
 
       # Default path for .netrc file
       # @return [String]
       def netrc_file
-        ENV['OCTOKIT_NETRC_FILE'] || File.join(ENV['HOME'].to_s, '.netrc')
+        ENV.fetch('OCTOKIT_NETRC_FILE') { File.join(Dir.home.to_s, '.netrc') }
       end
-
     end
   end
 end

data/lib/octokit/enterprise_admin_client/admin_stats.rb

@@ -1,18 +1,18 @@
+# frozen_string_literal: true
+
 module Octokit
   class EnterpriseAdminClient
-
     # Methods for the Enterprise Admin Stats API
     #
-    # @see https://developer.github.com/v3/enterprise/admin_stats/
+    # @see https://developer.github.com/v3/enterprise-admin/admin_stats/
     module AdminStats
-
       # Get all available stats
       #
       # @return [Sawyer::Resource] All available stats
       # @example Get all available stats
       #   @client.admin_stats
       def admin_stats
-        get_admin_stats "all"
+        get_admin_stats 'all'
       end
 
       # Get only repository-related stats
@@ -21,7 +21,7 @@ module Octokit
       # @example Get only repository-related stats
       #   @client.admin_repository_stats
       def admin_repository_stats
-        get_admin_stats "repos"
+        get_admin_stats 'repos'
       end
 
       # Get only hooks-related stats
@@ -30,7 +30,7 @@ module Octokit
       # @example Get only hooks-related stats
       #   @client.admin_hooks_stats
       def admin_hooks_stats
-        get_admin_stats "hooks"
+        get_admin_stats 'hooks'
       end
 
       # Get only pages-related stats
@@ -39,7 +39,7 @@ module Octokit
       # @example Get only pages-related stats
       #   @client.admin_pages_stats
       def admin_pages_stats
-        get_admin_stats "pages"
+        get_admin_stats 'pages'
       end
 
       # Get only organization-related stats
@@ -48,7 +48,7 @@ module Octokit
       # @example Get only organization-related stats
       #   @client.admin_organization_stats
       def admin_organization_stats
-        get_admin_stats "orgs"
+        get_admin_stats 'orgs'
       end
 
       # Get only user-related stats
@@ -57,7 +57,7 @@ module Octokit
       # @example Get only user-related stats
       #   @client.admin_users_stats
       def admin_users_stats
-        get_admin_stats "users"
+        get_admin_stats 'users'
       end
 
       # Get only pull request-related stats
@@ -66,7 +66,7 @@ module Octokit
       # @example Get only pull request-related stats
       #   @client.admin_pull_requests_stats
       def admin_pull_requests_stats
-        get_admin_stats "pulls"
+        get_admin_stats 'pulls'
       end
 
       # Get only issue-related stats
@@ -75,7 +75,7 @@ module Octokit
       # @example Get only issue-related stats
       #   @client.admin_issues_stats
       def admin_issues_stats
-        get_admin_stats "issues"
+        get_admin_stats 'issues'
       end
 
       # Get only milestone-related stats
@@ -84,7 +84,7 @@ module Octokit
       # @example Get only milestone-related stats
       #   @client.admin_milestones_stats
       def admin_milestones_stats
-        get_admin_stats "milestones"
+        get_admin_stats 'milestones'
       end
 
       # Get only gist-related stats
@@ -93,7 +93,7 @@ module Octokit
       # @example Get only gist-related stats
       #   @client.admin_gits_stats
       def admin_gists_stats
-        get_admin_stats "gists"
+        get_admin_stats 'gists'
       end
 
       # Get only comment-related stats
@@ -102,7 +102,7 @@ module Octokit
       # @example Get only comment-related stats
       #   @client.admin_comments_stats
       def admin_comments_stats
-        get_admin_stats "comments"
+        get_admin_stats 'comments'
       end
 
       private
@@ -115,6 +115,5 @@ module Octokit
         get "enterprise/stats/#{metric}"
       end
     end
-
   end
 end

data/lib/octokit/enterprise_admin_client/license.rb

@@ -1,18 +1,17 @@
+# frozen_string_literal: true
+
 module Octokit
   class EnterpriseAdminClient
-
     # Methods for the Enterprise License API
     #
-    # @see https://developer.github.com/v3/enterprise/license/
+    # @see https://developer.github.com/v3/enterprise-admin/license/
     module License
-
       # Get information about the Enterprise license
       #
       # @return [Sawyer::Resource] The license information
       def license_info
-        get "enterprise/settings/license"
+        get 'enterprise/settings/license'
       end
-
     end
   end
 end

data/lib/octokit/enterprise_admin_client/orgs.rb

@@ -1,11 +1,11 @@
+# frozen_string_literal: true
+
 module Octokit
   class EnterpriseAdminClient
-
     # Methods for the Enterprise Orgs API
     #
-    # @see https://developer.github.com/v3/enterprise/orgs/
+    # @see https://developer.github.com/v3/enterprise-admin/orgs/
     module Orgs
-
       # Create a new organization on the instance.
       #
       # @param login [String] The organization's username.
@@ -13,13 +13,14 @@ module Octokit
       # @param options [Hash] A set of options.
       # @option options [String] :profile_name The organization's display name.
       # @return [nil]
-      # @see https://developer.github.com/v3/enterprise/orgs/#create-an-organization
+      # @see https://developer.github.com/v3/enterprise-admin/orgs/#create-an-organization
       # @example
       #   @admin_client.create_organization('SuchAGreatOrg', 'gjtorikian')
       def create_organization(login, admin, options = {})
-        post "admin/organizations", options
+        options[:login] = login
+        options[:admin] = admin
+        post 'admin/organizations', options
       end
-
     end
   end
 end

data/lib/octokit/enterprise_admin_client/search_indexing.rb

@@ -1,11 +1,11 @@
+# frozen_string_literal: true
+
 module Octokit
   class EnterpriseAdminClient
-
     # Methods for the Enterprise Search Indexing API
     #
-    # @see https://developer.github.com/v3/enterprise/search_indexing/
+    # @see https://developer.github.com/v3/enterprise-admin/search_indexing/
     module SearchIndexing
-
       # Queue a User or Organization to be indexed
       #
       # @param user [String] A GitHub Enterprise user or organization
@@ -13,7 +13,7 @@ module Octokit
       def index_user(user)
         queue_index user
       end
-      alias :index_organization :index_user
+      alias index_organization index_user
 
       # Queue a Repository to be indexed
       #
@@ -46,7 +46,7 @@ module Octokit
       def index_users_repositories(user)
         queue_index "#{user}/*"
       end
-      alias :index_organizations_repositories :index_users_repositories
+      alias index_organizations_repositories index_users_repositories
 
       # Queue an index of all the issues across all of a user's or
       # organization's repositories
@@ -56,7 +56,7 @@ module Octokit
       def index_users_repositories_issues(user)
         queue_index "#{user}/*/issues"
       end
-      alias :index_organizations_repositories_issues :index_users_repositories_issues
+      alias index_organizations_repositories_issues index_users_repositories_issues
 
       # Queue an index of all the code contained in all of a user's or
       # organization's repositories
@@ -66,7 +66,7 @@ module Octokit
       def index_users_repositories_code(user)
         queue_index "#{user}/*/code"
       end
-      alias :index_organizations_repositories_code :index_users_repositories_code
+      alias index_organizations_repositories_code index_users_repositories_code
 
       private
 
@@ -75,9 +75,8 @@ module Octokit
       # @param target [String] Target to index
       # @return [Sawyer:Resource] Result of the queuing containing `:message`
       def queue_index(target)
-        post "staff/indexing_jobs", :target => target
+        post 'staff/indexing_jobs', target: target
       end
     end
-
   end
 end