github_api 0.15.0 → 0.19.0

data/lib/github_api/request.rb

@@ -1,10 +1,10 @@
 # encoding: utf-8
 
-require 'github_api/request/oauth2'
-require 'github_api/request/basic_auth'
-require 'github_api/request/jsonize'
-
-require 'github_api/connection'
+require_relative 'connection'
+require_relative 'response_wrapper'
+require_relative 'request/oauth2'
+require_relative 'request/basic_auth'
+require_relative 'request/jsonize'
 
 module Github
   # A class responsible for dispatching http requests
@@ -43,8 +43,7 @@ module Github
 
     # Performs a request
     #
-    # @param [Symbol] method - The Symbol the HTTP verb
-    # @param [String] path   - String relative URL to access
+    # @param current_options [Hash]
     # @param [ParamsHash] params - ParamsHash to configure the request API
     #
     # @return [Github::ResponseWrapper]
@@ -52,10 +51,10 @@ module Github
     # @api private
     def call(current_options, params)
       unless HTTP_METHODS.include?(action)
-        raise ArgumentError, "unknown http method: #{method}"
+        raise ArgumentError, "unknown http method: #{action}"
       end
 
-      puts "EXECUTED: #{action} - #{path} with PARAMS: #{params}" if ENV['DEBUG']
+      puts "EXECUTED: #{action} - #{path} with PARAMS: #{params.request_params}" if ENV['DEBUG']
 
       request_options    = params.options
       connection_options = current_options.merge(request_options)

data/lib/github_api/request/basic_auth.rb

@@ -26,7 +26,7 @@ module Github
       # @api private
       def call(env)
         if @auth
-          env[:request_headers].merge!('Authorization' => "Basic #{@auth}\"")
+          env[:request_headers].merge!('Authorization' => "Basic #{@auth}")
         end
 
         @app.call(env)

data/lib/github_api/request/jsonize.rb

@@ -32,7 +32,6 @@ module Github
     end
 
     def request_with_body?(env)
-      type = request_type(env)
       has_body?(env) and safe_to_modify?(env)
     end
 

data/lib/github_api/request/oauth2.rb

@@ -2,6 +2,8 @@
 
 require 'faraday'
 
+require_relative '../utils/url'
+
 module Github
   class Request
     class OAuth2 < Faraday::Middleware

data/lib/github_api/request/verbs.rb

@@ -1,5 +1,8 @@
 # encoding: utf-8
 
+require_relative '../request'
+require_relative '../params_hash'
+
 module Github
   # A class responsible for dispatching http requests
   class Request

data/lib/github_api/response/follow_redirects.rb

@@ -0,0 +1,140 @@
+require 'faraday'
+require 'set'
+
+# First saw on octokit, then copied from lostisland/faraday_middleware
+# and adapted for this library.
+#
+# faraday_middleware/lib/faraday_middleware/response/follow_redirects.rb
+
+module Github
+  # Public: Exception thrown when the maximum amount of requests is exceeded.
+  class RedirectLimitReached < Faraday::ClientError
+    attr_reader :response
+
+    def initialize(response)
+      super "too many redirects; last one to: #{response['location']}"
+      @response = response
+    end
+  end
+
+  # Public: Follow HTTP 301, 302, 303, 307, and 308 redirects.
+  #
+  # For HTTP 301, 302, and 303, the original GET, POST, PUT, DELETE, or PATCH
+  # request gets converted into a GET. With `:standards_compliant => true`,
+  # however, the HTTP method after 301/302 remains unchanged. This allows you
+  # to opt into HTTP/1.1 compliance and act unlike the major web browsers.
+  #
+  # This middleware currently only works with synchronous requests; i.e. it
+  # doesn't support parallelism.
+  #
+  # If you wish to persist cookies across redirects, you could use
+  # the faraday-cookie_jar gem:
+  #
+  #   Faraday.new(:url => url) do |faraday|
+  #     faraday.use FaradayMiddleware::FollowRedirects
+  #     faraday.use :cookie_jar
+  #     faraday.adapter Faraday.default_adapter
+  #   end
+
+  class Response::FollowRedirects < Faraday::Middleware
+    # HTTP methods for which 30x redirects can be followed
+    ALLOWED_METHODS = Set.new [:head, :options, :get, :post, :put, :patch, :delete]
+    # HTTP redirect status codes that this middleware implements
+    REDIRECT_CODES  = Set.new [301, 302, 303, 307, 308]
+    # Keys in env hash which will get cleared between requests
+    ENV_TO_CLEAR    = Set.new [:status, :response, :response_headers]
+
+    # Default value for max redirects followed
+    FOLLOW_LIMIT = 3
+
+    # Regex that matches characters that need to be escaped in URLs, sans
+    # the "%" character which we assume already represents an escaped sequence.
+    URI_UNSAFE = /[^\-_.!~*'()a-zA-Z\d;\/?:@&=+$,\[\]%]/
+
+    # Public: Initialize the middleware.
+    #
+    # options - An options Hash (default: {}):
+    #           :limit               - A Numeric redirect limit (default: 3)
+    #           :standards_compliant - A Boolean indicating whether to respect
+    #                                  the HTTP spec when following 301/302
+    #                                  (default: false)
+    #           :callback            - A callable that will be called on redirects
+    #                                  with the old and new envs
+    def initialize(app, options = {})
+      super(app)
+      @options = options
+
+      @convert_to_get = Set.new [303]
+      @convert_to_get << 301 << 302 unless standards_compliant?
+    end
+
+    def call(env)
+      perform_with_redirection(env, follow_limit)
+    end
+
+    private
+
+    def convert_to_get?(response)
+      ![:head, :options].include?(response.env[:method]) &&
+        @convert_to_get.include?(response.status)
+    end
+
+    def perform_with_redirection(env, follows)
+      request_body = env[:body]
+      response = @app.call(env)
+
+      response.on_complete do |response_env|
+        if follow_redirect?(response_env, response)
+          raise RedirectLimitReached, response if follows.zero?
+          new_request_env = update_env(response_env.dup, request_body, response)
+          callback.call(response_env, new_request_env) if callback
+          response = perform_with_redirection(new_request_env, follows - 1)
+        end
+      end
+      response
+    end
+
+    def update_env(env, request_body, response)
+      env[:url] += safe_escape(response['location'])
+
+      if convert_to_get?(response)
+        env[:method] = :get
+        env[:body] = nil
+      else
+        env[:body] = request_body
+      end
+
+      ENV_TO_CLEAR.each {|key| env.delete key }
+
+      env
+    end
+
+    def follow_redirect?(env, response)
+      ALLOWED_METHODS.include? env[:method] and
+        REDIRECT_CODES.include? response.status
+    end
+
+    def follow_limit
+      @options.fetch(:limit, FOLLOW_LIMIT)
+    end
+
+    def standards_compliant?
+      @options.fetch(:standards_compliant, false)
+    end
+
+    def callback
+      @options[:callback]
+    end
+
+    # Internal: escapes unsafe characters from an URL which might be a path
+    # component only or a fully qualified URI so that it can be joined onto an
+    # URI:HTTP using the `+` operator. Doesn't escape "%" characters so to not
+    # risk double-escaping.
+    def safe_escape(uri)
+      uri = uri.split('#')[0] # we want to remove the fragment if present
+      uri.to_s.gsub(URI_UNSAFE) { |match|
+        '%' + match.unpack('H2' * match.bytesize).join('%').upcase
+      }
+    end
+  end
+end

data/lib/github_api/response/header.rb

@@ -1,5 +1,7 @@
 # encoding: utf-8
 
+require_relative '../constants'
+
 module Github
   class Response
 
@@ -13,6 +15,10 @@ module Github
         !!env
       end
 
+      def [](property)
+        loaded? ? env[:response_headers][property] : nil
+      end
+
       def oauth_scopes
         loaded? ? env[:response_headers][OAUTH_SCOPES] : nil
       end
@@ -76,7 +82,6 @@ module Github
       def body
         loaded? ? env[:body] : nil
       end
-
     end # Header
   end # Response
 end # Github

data/lib/github_api/response/mashify.rb

@@ -2,13 +2,12 @@
 
 require 'faraday'
 require 'hashie'
+require 'github_api/mash'
 
 module Github
   class Response::Mashify < Response
-    dependency 'hashie/mash'
-
     define_parser do |body|
-      ::Hashie::Mash.new body
+      ::Github::Mash.new body
     end
 
     def parse(body)

data/lib/github_api/response/raise_error.rb

@@ -1,7 +1,8 @@
 # encoding: utf-8
 
 require 'faraday'
-require 'github_api/error'
+
+require_relative '../error/service_error'
 
 module Github
   class Response::RaiseError < Faraday::Response::Middleware

data/lib/github_api/response_wrapper.rb

@@ -1,5 +1,9 @@
 # encoding: utf-8
 
+require 'forwardable'
+
+require_relative 'pagination'
+
 module Github
   # A class responsible for proxing to faraday response
   class ResponseWrapper
@@ -19,6 +23,7 @@ module Github
       @response    = response
       @current_api = current_api
       @env         = response.env
+      @body        = nil
     end
 
     # Overwrite methods to hash keys

data/lib/github_api/utils/url.rb

@@ -1,3 +1,5 @@
+# encoding:utf-8
+
 require 'cgi'
 require 'addressable/uri'
 

data/lib/github_api/validations.rb

@@ -1,14 +1,12 @@
 # encoding: utf-8
 
+require_relative 'validations/format'
+require_relative 'validations/presence'
+require_relative 'validations/required'
+require_relative 'validations/token'
+
 module Github
   module Validations
-
-    Github::require_all 'github_api/validations',
-      'presence',
-      'token',
-      'format',
-      'required'
-
     include Presence
     include Format
     include Token
@@ -20,6 +18,5 @@ module Github
       'auto_pagination',
       'jsonp_callback'
     ]
-
   end # Validation
 end # Github

data/lib/github_api/validations/format.rb

@@ -1,5 +1,7 @@
 # encoding: utf-8
 
+require_relative '../error/client_error'
+
 module Github
   module Validations
     module Format

data/lib/github_api/validations/presence.rb

@@ -1,11 +1,13 @@
 # encoding: utf-8
 
+require_relative '../error/client_error'
+
 module Github
   module Validations
     # A mixin to help validate presence of non-empty values
     module Presence
 
-      # Ensure that esential arguments are present before request is made.
+      # Ensure that essential arguments are present before request is made.
       #
       # == Parameters
       #  Hash/Array of arguments to be checked against nil and empty string

data/lib/github_api/validations/required.rb

@@ -1,5 +1,7 @@
 # encoding: utf-8
 
+require_relative '../error/client_error'
+
 module Github
   module Validations
     module Required

data/lib/github_api/version.rb

@@ -1,5 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module Github
-  VERSION = "0.15.0"
+  VERSION = "0.19.0"
 end # Github

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: github_api
 version: !ruby/object:Gem::Version
-  version: 0.15.0
+  version: 0.19.0
 platform: ruby
 authors:
 - Piotr Murach
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-25 00:00:00.000000000 Z
+date: 2020-06-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -16,48 +16,54 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.4.0
+        version: '2.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.4.0
+        version: '2.4'
 - !ruby/object:Gem::Dependency
   name: hashie
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: 3.5.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: 3.5.2
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.8'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.8'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: oauth2
   requirement: !ruby/object:Gem::Requirement
@@ -87,27 +93,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.0.4
 - !ruby/object:Gem::Dependency
-  name: mime-types
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.16'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :runtime
+        version: 1.5.0
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.16'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 1.5.0
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -121,30 +121,89 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: cucumber
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.0'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.3
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.0'
-description: " Ruby client that supports all of the GitHub API methods. It's build
+        version: '3.8'
+description: ' Ruby client that supports all of the GitHub API methods. It"s build
   in a modular way, that is, you can either instantiate the whole api wrapper Github.new
   or use parts of it e.i. Github::Client::Repos.new if working solely with repositories
-  is your main concern. Intuitive query methods allow you easily call API endpoints. "
-email: ''
+  is your main concern. Intuitive query methods allow you easily call API endpoints. '
+email:
+- piotr@piotrmurach.com
 executables: []
 extensions: []
 extra_rdoc_files:
 - LICENSE.txt
 - README.md
+- CHANGELOG.md
 files:
+- CHANGELOG.md
 - LICENSE.txt
 - README.md
 - lib/github_api.rb
@@ -187,11 +246,17 @@ files:
 - lib/github_api/client/orgs/hooks.rb
 - lib/github_api/client/orgs/members.rb
 - lib/github_api/client/orgs/memberships.rb
+- lib/github_api/client/orgs/projects.rb
 - lib/github_api/client/orgs/teams.rb
+- lib/github_api/client/projects.rb
+- lib/github_api/client/projects/cards.rb
+- lib/github_api/client/projects/columns.rb
 - lib/github_api/client/pull_requests.rb
 - lib/github_api/client/pull_requests/comments.rb
 - lib/github_api/client/pull_requests/reviews.rb
 - lib/github_api/client/repos.rb
+- lib/github_api/client/repos/branches.rb
+- lib/github_api/client/repos/branches/protections.rb
 - lib/github_api/client/repos/collaborators.rb
 - lib/github_api/client/repos/comments.rb
 - lib/github_api/client/repos/commits.rb
@@ -200,9 +265,11 @@ files:
 - lib/github_api/client/repos/downloads.rb
 - lib/github_api/client/repos/forks.rb
 - lib/github_api/client/repos/hooks.rb
+- lib/github_api/client/repos/invitations.rb
 - lib/github_api/client/repos/keys.rb
 - lib/github_api/client/repos/merging.rb
 - lib/github_api/client/repos/pages.rb
+- lib/github_api/client/repos/projects.rb
 - lib/github_api/client/repos/pub_sub_hubbub.rb
 - lib/github_api/client/repos/releases.rb
 - lib/github_api/client/repos/releases/assets.rb
@@ -222,12 +289,12 @@ files:
 - lib/github_api/constants.rb
 - lib/github_api/core_ext/array.rb
 - lib/github_api/core_ext/hash.rb
-- lib/github_api/core_ext/ordered_hash.rb
 - lib/github_api/deprecation.rb
 - lib/github_api/error.rb
 - lib/github_api/error/client_error.rb
 - lib/github_api/error/service_error.rb
 - lib/github_api/ext/faraday.rb
+- lib/github_api/mash.rb
 - lib/github_api/middleware.rb
 - lib/github_api/mime_type.rb
 - lib/github_api/normalizer.rb
@@ -244,10 +311,9 @@ files:
 - lib/github_api/request/jsonize.rb
 - lib/github_api/request/oauth2.rb
 - lib/github_api/request/verbs.rb
-- lib/github_api/requestable.rb
-- lib/github_api/resource.rb
 - lib/github_api/response.rb
 - lib/github_api/response/atom_parser.rb
+- lib/github_api/response/follow_redirects.rb
 - lib/github_api/response/header.rb
 - lib/github_api/response/jsonize.rb
 - lib/github_api/response/mashify.rb
@@ -274,17 +340,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.2
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Ruby client for the official GitHub API
 test_files: []
-has_rdoc: