faraday_middleware 0.10.1 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 19207ab27ddadf4621b943f32e3ee0a54ebbe0f4
-  data.tar.gz: 17df1b80453f02f7218052cdac77f477efe3f99d
+  metadata.gz: 5d8c7e371a69bb82054c6d04c347395f191bc994
+  data.tar.gz: 2a06c40d062986727564b0ef21c284a163d1ef48
 SHA512:
-  metadata.gz: e4b8edf32f496c1c52b139390c1fe0ae9908891e2dda234958a5cb40efed32a75bebebacc275f44ba075f8d78ae342950272006c1ddf16db0bb8ea78bef04398
-  data.tar.gz: f024bdcfb98632eaed13da4dc6206ba4389e31c5d569b3ec67f7f10b51729b7a7a69504ca0be4ab38b6d551344810d18ccf29c9b2df5c24420f9d00e3c05bdbf
+  metadata.gz: 7e7427a5ff50a3a5231d578d072787dc9f1391b7dd89a4bd57cda4675c30bc888c3a9a996f6133666ba1858b0103bca7f7d3c011ca3a5982287d71be07bbc71f
+  data.tar.gz: e807d97ea850b2f27d1e413d19607349672d5f386353a88d9e86d6e8c524713b1bc0dff9ad29337e5926122aad20e09c820586ad575c90ea7fe2c33c556e9f9b

data/lib/faraday_middleware/gzip.rb

@@ -48,7 +48,17 @@ module FaradayMiddleware
     end
 
     def inflate(body)
+      # Inflate as a DEFLATE (RFC 1950+RFC 1951) stream
       Zlib::Inflate.inflate(body)
+    rescue Zlib::DataError
+      # Fall back to inflating as a "raw" deflate stream which
+      # Microsoft servers return
+      inflate = Zlib::Inflate.new(-Zlib::MAX_WBITS)
+      begin
+        inflate.inflate(body)
+      ensure
+        inflate.close
+      end
     end
   end
 end

data/lib/faraday_middleware/request/encode_json.rb

@@ -9,8 +9,9 @@ module FaradayMiddleware
   #
   # Doesn't try to encode bodies that already are in string form.
   class EncodeJson < Faraday::Middleware
-    CONTENT_TYPE = 'Content-Type'.freeze
-    MIME_TYPE    = 'application/json'.freeze
+    CONTENT_TYPE    = 'Content-Type'.freeze
+    MIME_TYPE       = 'application/json'.freeze
+    MIME_TYPE_REGEX = /^application\/(vnd\..+\+)?json$/
 
     dependency do
       require 'json' unless defined?(::JSON)
@@ -36,7 +37,7 @@ module FaradayMiddleware
 
     def process_request?(env)
       type = request_type(env)
-      has_body?(env) and (type.empty? or type == MIME_TYPE)
+      has_body?(env) and (type.empty? or MIME_TYPE_REGEX =~ type)
     end
 
     def has_body?(env)

data/lib/faraday_middleware/request/oauth2.rb

@@ -4,10 +4,11 @@ require 'forwardable'
 module FaradayMiddleware
   # Public: A simple middleware that adds an access token to each request.
   #
-  # The token is added as both "access_token" query parameter and the
-  # "Authorization" HTTP request header. However, an explicit "access_token"
-  # parameter or "Authorization" header for the current request are not
-  # overriden.
+  # By default, the token is added as both "access_token" query parameter and the
+  # "Authorization" HTTP request header. It can alternatively be added exclusively
+  # as a bearer token "Authorization" header by specifying a "token_type" option
+  # of "bearer". However, an explicit "access_token" parameter or "Authorization"
+  # header for the current request are not overriden.
   #
   # Examples
   #
@@ -17,14 +18,18 @@ module FaradayMiddleware
   #   # configure query parameter name:
   #   OAuth2.new(app, 'abc123', :param_name => 'my_oauth_token')
   #
+  #   # use bearer token authorization header only
+  #   OAuth2.new(app, 'abc123', :token_type => 'bearer')
+  #
   #   # default token value is optional:
   #   OAuth2.new(app, :param_name => 'my_oauth_token')
   class OAuth2 < Faraday::Middleware
 
     PARAM_NAME  = 'access_token'.freeze
+    TOKEN_TYPE  = 'param'.freeze
     AUTH_HEADER = 'Authorization'.freeze
 
-    attr_reader :param_name
+    attr_reader :param_name, :token_type
 
     extend Forwardable
     def_delegators :'Faraday::Utils', :parse_query, :build_query
@@ -34,8 +39,13 @@ module FaradayMiddleware
       token = params[param_name]
 
       if token.respond_to?(:empty?) && !token.empty?
-        env[:url].query = build_query params
-        env[:request_headers][AUTH_HEADER] ||= %(Token token="#{token}")
+        case @token_type.downcase
+        when 'param'
+          env[:url].query = build_query params
+          env[:request_headers][AUTH_HEADER] ||= %(Token token="#{token}")
+        when 'bearer'
+          env[:request_headers][AUTH_HEADER] ||= %(Bearer #{token})
+        end
       end
 
       @app.call env
@@ -46,7 +56,19 @@ module FaradayMiddleware
       options, token = token, nil if token.is_a? Hash
       @token = token && token.to_s
       @param_name = options.fetch(:param_name, PARAM_NAME).to_s
-      raise ArgumentError, ":param_name can't be blank" if @param_name.empty?
+      @token_type = options.fetch(:token_type, TOKEN_TYPE).to_s
+
+      if @token_type == 'param' && @param_name.empty?
+        raise ArgumentError, ":param_name can't be blank"
+      end
+
+      if options[:token_type].nil?
+        warn "\nWarning: FaradayMiddleware::OAuth2 initialized with default "\
+             "token_type - token will be added as both a query string parameter "\
+             "and an Authorization header. In the next major release, tokens will "\
+             "be added exclusively as an Authorization header by default. Please "\
+             "visit https://github.com/lostisland/faraday_middleware/wiki for more information."
+      end
     end
 
     def query_params(url)

data/lib/faraday_middleware/response/caching.rb

@@ -79,11 +79,11 @@ module FaradayMiddleware
         finalize_response(cached_response, env)
       else
         # response.status is nil at this point, any checks need to be done inside on_complete block
-        @app.call(env).on_complete do |response|
-          if CACHEABLE_STATUS_CODES.include?(response.status)
-            cache.write(key, response)
+        @app.call(env).on_complete do |response_env|
+          if CACHEABLE_STATUS_CODES.include?(response_env.status)
+            cache.write(key, response_env.response)
           end
-          response
+          response_env
         end
       end
     end

data/lib/faraday_middleware/response/follow_redirects.rb

@@ -12,7 +12,7 @@ module FaradayMiddleware
     end
   end
 
-  # Public: Follow HTTP 301, 302, 303, and 307 redirects.
+  # 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`,
@@ -34,7 +34,7 @@ module FaradayMiddleware
     # 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]
+    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]
 
@@ -52,6 +52,8 @@ module FaradayMiddleware
     #           :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
@@ -78,7 +80,8 @@ module FaradayMiddleware
       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, request_body, response)
+          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
@@ -113,11 +116,16 @@ module FaradayMiddleware
       @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
       }

data/lib/faraday_middleware/response_middleware.rb

@@ -37,6 +37,8 @@ module FaradayMiddleware
     def process_response(env)
       env[:raw_body] = env[:body] if preserve_raw?(env)
       env[:body] = parse(env[:body])
+    rescue Faraday::Error::ParsingError => err
+      raise Faraday::Error::ParsingError.new(err, env[:response])
     end
 
     # Parse the response body.

data/lib/faraday_middleware/version.rb

@@ -1,3 +1,3 @@
 module FaradayMiddleware
-  VERSION = "0.10.1" unless defined?(FaradayMiddleware::VERSION)
+  VERSION = "0.11.0" unless defined?(FaradayMiddleware::VERSION)
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: faraday_middleware
 version: !ruby/object:Gem::Version
-  version: 0.10.1
+  version: 0.11.0
 platform: ruby
 authors:
 - Erik Michaels-Ober
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-11 00:00:00.000000000 Z
+date: 2017-01-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday