github_api 0.15.0 → 0.19.0

data/lib/github_api/client/repos/releases.rb

@@ -1,5 +1,7 @@
 # encoding: utf-8
 
+require_relative '../../api'
+
 module Github
   # The Releases API
   class Client::Repos::Releases < API

data/lib/github_api/client/repos/releases/assets.rb

@@ -1,5 +1,7 @@
 # encoding: utf-8
 
+require_relative '../../../api'
+
 module Github
   # The Release Assets API
   class Client::Repos::Releases::Assets < API
@@ -35,7 +37,7 @@ module Github
     #
     # @api public
     def get(*args)
-      params = arguments(args, required: [:owner, :repo, :id]).params
+      arguments(args, required: [:owner, :repo, :id]).params
 
       get_request("/repos/#{arguments.owner}/#{arguments.repo}/releases/assets/#{arguments.id}" , arguments.params)
     end

data/lib/github_api/client/repos/releases/tags.rb

@@ -1,5 +1,7 @@
 # encoding: utf-8
 
+require_relative '../../../api'
+
 module Github
   # The Releases API
   class Client::Repos::Releases::Tags < API

data/lib/github_api/client/repos/statistics.rb

@@ -1,5 +1,7 @@
 # encoding: utf-8
 
+require_relative '../../api'
+
 module Github
   # The Repository Statistics API allows you to fetch the data that GitHub uses
   # for visualizing different types of repository activity.

data/lib/github_api/client/repos/statuses.rb

@@ -1,5 +1,7 @@
 # encoding: utf-8
 
+require_relative '../../api'
+
 module Github
   # The Status API allows external services to mark commits with a success,
   # failure, error, or pending state, which is then reflected in pull requests

data/lib/github_api/client/say.rb

@@ -1,5 +1,7 @@
 # encoding: utf-8
 
+require_relative '../api'
+
 module Github
   class Client::Say < API
 

data/lib/github_api/client/scopes.rb

@@ -1,5 +1,7 @@
 # encoding: utf-8
 
+require_relative '../api'
+
 module Github
   class Client::Scopes < API
     # Check what OAuth scopes you have.

data/lib/github_api/client/search.rb

@@ -1,5 +1,8 @@
 # encoding: utf-8
 
+require_relative '../api'
+require_relative '../utils/url'
+
 module Github
   # The Search API is optimized to help you find the specific item
   # you're looking for (e.g., a specific user, a specific file

data/lib/github_api/client/search/legacy.rb

@@ -1,5 +1,7 @@
 # encoding: utf-8
 
+require_relative '../../api'
+
 module Github
   class Client::Search::Legacy < API
     include Github::Utils::Url

data/lib/github_api/client/users.rb

@@ -1,5 +1,7 @@
 # encoding: utf-8
 
+require_relative '../api'
+
 module Github
   class Client::Users < API
     # Load all the modules after initializing Repos to avoid superclass mismatch

data/lib/github_api/client/users/emails.rb

@@ -1,6 +1,9 @@
 # encoding: utf-8
+
 require 'cgi'
 
+require_relative '../../api'
+
 module Github
   class Client::Users::Emails < API
 

data/lib/github_api/client/users/followers.rb

@@ -1,11 +1,13 @@
 # encoding: utf-8
 
+require_relative '../../api'
+
 module Github
   class Client::Users::Followers < API
 
     # List a user's followers
     #
-    # @xample
+    # @example
     #  github = Github.new
     #  github.users.followers.list 'user-name'
     #  github.users.followers.list 'user-name' { |user| ... }

data/lib/github_api/client/users/keys.rb

@@ -1,5 +1,7 @@
 # encoding: utf-8
 
+require_relative '../../api'
+
 module Github
   class Client::Users::Keys < API
 

data/lib/github_api/configuration.rb

@@ -1,6 +1,7 @@
 # encoding: utf-8
 
-require 'github_api/api/config'
+require_relative 'api/config'
+require_relative 'version'
 
 module Github
   # Stores the configuration
@@ -12,6 +13,8 @@ module Github
     # By default, don't traverse the page links
     property :auto_pagination, default: false
 
+    property :follow_redirects, default: true
+
     # Basic authentication
     property :basic_auth
 

data/lib/github_api/connection.rb

@@ -1,5 +1,9 @@
 # encoding: utf-8
 
+require 'faraday'
+
+require_relative 'constants'
+
 module Github
   # Specifies Http connection options
   module Connection
@@ -61,7 +65,7 @@ module Github
 
     # Creates http connection
     #
-    # Returns a Fraday::Connection object
+    # Returns a Faraday::Connection object
     def connection(api, options = {})
       connection_options = default_options(options)
       connection_options.merge!(builder: stack(options.merge!(api: api)))

data/lib/github_api/error.rb

@@ -21,7 +21,7 @@ module Github
       end
 
       def backtrace
-        if @response_message && @response_message.respond_to?(:backtrace)
+        if @response_message.respond_to?(:backtrace)
           @response_message.backtrace
         else
           super
@@ -30,6 +30,3 @@ module Github
     end # GithubError
   end # Error
 end # Github
-
-require 'github_api/error/service_error'
-require 'github_api/error/client_error'

data/lib/github_api/error/client_error.rb

@@ -1,5 +1,7 @@
 # encoding: utf-8
 
+require_relative '../error'
+
 module Github #:nodoc
   # Raised when Github returns the HTTP status code 404
   module Error
@@ -26,7 +28,7 @@ module Github #:nodoc
         super(
           generate_message(
             problem: "Invalid option #{invalid.keys.join(', ')} provided for this request.",
-            summary: "Github gem checks the request parameters passed to ensure that github api is not hit unnecessairly and to fail fast.",
+            summary: "Github gem checks the request parameters passed to ensure that github api is not hit unnecessarily and to fail fast.",
             resolution: "Valid options are: #{valid.join(', ')}, make sure these are the ones you are using"
           )
         )
@@ -39,7 +41,7 @@ module Github #:nodoc
         super(
           generate_message(
             problem: "Missing required parameters: #{provided.keys.join(', ')} provided for this request.",
-            summary: "Github gem checks the request parameters passed to ensure that github api is not hit unnecessairly and to fail fast.",
+            summary: "Github gem checks the request parameters passed to ensure that github api is not hit unnecessarily and to fail fast.",
             resolution: "Required parameters are: #{required.join(', ')}, make sure these are the ones you are using"
           )
         )

data/lib/github_api/error/service_error.rb

@@ -2,6 +2,8 @@
 
 require 'json'
 
+require_relative '../error'
+
 module Github
   # Raised when GitHub returns any of the HTTP status codes
   module Error
@@ -31,7 +33,7 @@ module Github
 
       MIN_BODY_LENGTH = 2
 
-      # Crate a ServiceError
+      # Create a ServiceError
       #
       # @param [Hash[Symbol]] response
       #
@@ -137,7 +139,12 @@ module Github
         elsif data[:errors]
           message = "\nErrors:\n"
           message << data[:errors].map do |error|
-            "Error: #{error.map { |k, v| "#{k}: #{v}" }.join(', ')}"
+            case error
+            when Hash
+              "Error: #{error.map { |k, v| "#{k}: #{v}" }.join(', ')}"
+            else
+              "Error: #{error}"
+            end
           end.join("\n")
         end
       end

data/lib/github_api/ext/faraday.rb

@@ -7,7 +7,7 @@ module Faraday
       def params_encoder(encoder = nil)
         if encoder
           @encoder = encoder
-        else
+        elsif defined?(@encoder)
           @encoder
         end
       end
@@ -17,6 +17,8 @@ module Faraday
       end
     end
 
+    module_function
+
     def build_nested_query(value, prefix = nil, encoder = nil)
       case value
       when Array

data/lib/github_api/mash.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Github
+  class Mash < ::Hashie::Mash
+    disable_warnings
+  end
+end

data/lib/github_api/middleware.rb

@@ -1,11 +1,12 @@
 # encoding: utf-8
 
-require 'github_api/response'
-require 'github_api/response/mashify'
-require 'github_api/response/jsonize'
-require 'github_api/response/atom_parser'
-require 'github_api/response/raise_error'
-require 'github_api/response/header'
+require_relative 'response'
+require_relative 'response/mashify'
+require_relative 'response/jsonize'
+require_relative 'response/atom_parser'
+require_relative 'response/raise_error'
+require_relative 'response/header'
+require_relative 'response/follow_redirects'
 
 module Github
   class Middleware
@@ -18,6 +19,7 @@ module Github
         builder.use Github::Request::OAuth2, api.oauth_token if api.oauth_token?
         builder.use Github::Request::BasicAuth, api.authentication if api.basic_authed?
 
+        builder.use Github::Response::FollowRedirects if api.follow_redirects
         builder.use Faraday::Response::Logger if ENV['DEBUG']
         unless options[:raw]
           builder.use Github::Response::Mashify

data/lib/github_api/normalizer.rb

@@ -1,10 +1,10 @@
+# frozen_string_literal: true
 # encoding: utf-8
 
 module Github
-  # Deals with normalazing client supplied parameter keys.
+  # Normalize client-supplied parameter keys.
   module Normalizer
     # Turns any keys from nested hashes including nested arrays into strings
-    #
     def normalize!(params)
       case params
       when Hash
@@ -16,10 +16,8 @@ module Github
         params.map! do |el|
           normalize!(el)
         end
-      else
-        params.to_s
       end
-      return params
+      params
     end
   end # Normalizer
 end # Github

data/lib/github_api/page_iterator.rb

@@ -1,8 +1,11 @@
 # encoding: utf-8
 
-require 'github_api/utils/url'
 require 'uri'
 
+require_relative 'constants'
+require_relative 'paged_request'
+require_relative 'utils/url'
+
 module Github
   # A class responsible for requesting resources through page links
   #

data/lib/github_api/page_links.rb

@@ -1,3 +1,7 @@
+# encoding: utf-8
+
+require_relative 'constants'
+
 module Github
   # Determines the links in the current response link header to be used
   # to find the links to other pages of request responses. These will

data/lib/github_api/paged_request.rb

@@ -1,5 +1,7 @@
 # encoding: utf-8
 
+require_relative 'constants'
+
 module Github
 
   # A module that adds http get request to response pagination

data/lib/github_api/pagination.rb

@@ -1,7 +1,10 @@
 # encoding: utf-8
 
-module Github
+require_relative 'constants'
+require_relative 'page_links'
+require_relative 'page_iterator'
 
+module Github
   # A module that decorates response with pagination helpers
   module Pagination
     include Github::Constants
@@ -11,7 +14,7 @@ module Github
       @links = Github::PageLinks.new(env[:response_headers])
     end
 
-    # Retrive number of total pages base on current :per_page parameter
+    # Retrieve number of total pages base on current :per_page parameter
     def count_pages
       page_iterator.count.to_i
     end
@@ -40,7 +43,7 @@ module Github
       end
     end
 
-    # Retrives the result of the first page. Returns <tt>nil</tt> if there is
+    # Retrieves the result of the first page. Returns <tt>nil</tt> if there is
     # no first page - either because you are already on the first page
     # or there are no pages at all in the result.
     def first_page
@@ -49,7 +52,7 @@ module Github
       first_request
     end
 
-    # Retrives the result of the next page. Returns <tt>nil</tt> if there is
+    # Retrieves the result of the next page. Returns <tt>nil</tt> if there is
     # no next page or no pages at all.
     def next_page
       next_request = page_iterator.next
@@ -57,7 +60,7 @@ module Github
       next_request
     end
 
-    # Retrives the result of the previous page. Returns <tt>nil</tt> if there is
+    # Retrieves the result of the previous page. Returns <tt>nil</tt> if there is
     # no previous page or no pages at all.
     def prev_page
       prev_request = page_iterator.prev
@@ -66,7 +69,7 @@ module Github
     end
     alias :previous_page :prev_page
 
-    # Retrives the result of the last page. Returns <tt>nil</tt> if there is
+    # Retrieves the result of the last page. Returns <tt>nil</tt> if there is
     # no last page - either because you are already on the last page,
     # there is only one page or there are no pages at all in the result.
     def last_page
@@ -75,7 +78,7 @@ module Github
       last_request
     end
 
-    # Retrives a specific result for a page given page number.
+    # Retrieves a specific result for a page given page number.
     # The <tt>page_number</tt> parameter is not validate, hitting a page
     # that does not exist will return Github API error. Consequently, if
     # there is only one page, this method returns nil

data/lib/github_api/parameter_filter.rb

@@ -1,4 +1,7 @@
-# -*- encoding: utf-8 -*-
+# encoding: utf-8
+
+require_relative 'params_hash'
+require_relative 'validations'
 
 module Github
   # Allows you to specify parameters keys which will be preserved

data/lib/github_api/params_hash.rb

@@ -3,13 +3,16 @@
 require 'delegate'
 require 'base64'
 
+require_relative 'normalizer'
+require_relative 'mime_type'
+
 module Github
   # Class responsible for holding request parameters
   class ParamsHash < DelegateClass(Hash)
     include Normalizer
     include MimeType
 
-    REQUEST_PARAMS = [:accept, :media, :data, :raw, :content_type, :headers]
+    REQUEST_PARAMS = [:accept, :media, :data, :raw, :headers]
 
     def initialize(hash)
       super(normalize!(Hash[hash]))
@@ -71,9 +74,6 @@ module Github
       if value = accept
         headers[:accept] = value
       end
-      if self['content_type']
-        headers[:content_type] = self['content_type']
-      end
       opts[:raw]     = key?('raw') ? self['raw'] : false
       opts[:headers] = headers unless headers.empty?
       opts