github_api 0.15.0 → 0.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9312a6593c2f32bcc8b408beca9259a0747a70be
-  data.tar.gz: 9d5e113c5690642ef9fb0d9269ccc42d54421bd1
+  metadata.gz: 26afc4d14a19b64a2afdb606f617a8adb4feca39
+  data.tar.gz: d8dc7404e573e3795fc614f419161b5a741fca79
 SHA512:
-  metadata.gz: 15f1895fc1e726e678f67298e0489c681da59b2e0737c4baba47baa74dfe998ac8d76e0bd02f6f9bdf304fb8043694f70c15e77b670427d1cafa2cb2db4c35cb
-  data.tar.gz: e4e76f0e15c2ad51905fca1d8072072c689f8a80758e3f86b26bf8004e66fb58bea975393345dc8852d9bcfca495ae2bd195261f075b6cbbd5188087f2124c72
+  metadata.gz: e9aee22020a61cb8f71d7ef5906d30a06781e94106ccdc609fc6587114b051f3cbab67d70c3d9ed0bc9b2a7a4d02b63755833aa63305f468f6a081a4378e2b7d
+  data.tar.gz: ae1f3c5346bb2f6c231c5a2e950ee5ed966c1a3cff3d9f2ab8d4401a27e746cbc701a0149b8f681d1dca040d905d4db789b3f9610ddb8b33ecde5715f89d7113

data/README.md

@@ -719,4 +719,4 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/piotrm
 
 ## Copyright
 
-Copyright (c) 2011-2016 Piotr Murach. See LICENSE.txt for further details.
+Copyright (c) 2011-2017 Piotr Murach. See LICENSE.txt for further details.

data/lib/github_api/api.rb

@@ -79,6 +79,16 @@ module Github
       end
     end
 
+    # Disable following redirects inside a block
+    #
+    # @api public
+    def disable_redirects
+      self.follow_redirects = false
+      yield
+    ensure
+      self.follow_redirects = true
+    end
+
     # List of before callbacks
     #
     # @api public

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

@@ -235,7 +235,10 @@ module Github
       archive_format = params.delete('archive_format') || 'tarball'
       ref            = params.delete('ref') || 'master'
 
-      get_request("/repos/#{arguments.user}/#{arguments.repo}/#{archive_format}/#{ref}", params)
+      disable_redirects do
+        response = get_request("/repos/#{arguments.user}/#{arguments.repo}/#{archive_format}/#{ref}", params)
+        response.headers.location
+      end
     end
   end # Client::Repos::Contents
 end # Github

data/lib/github_api/configuration.rb

@@ -12,6 +12,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/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

@@ -6,6 +6,7 @@ require 'github_api/response/jsonize'
 require 'github_api/response/atom_parser'
 require 'github_api/response/raise_error'
 require 'github_api/response/header'
+require 'github_api/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/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::Error::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

@@ -13,6 +13,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 +80,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/version.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
 
 module Github
-  VERSION = "0.15.0"
+  VERSION = "0.16.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.16.0
 platform: ruby
 authors:
 - Piotr Murach
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-25 00:00:00.000000000 Z
+date: 2017-04-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -228,6 +228,7 @@ files:
 - 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
@@ -248,6 +249,7 @@ files:
 - 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