faraday_middleware 0.9.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 281f479ebac151c76b6f622d3e2d919fcba90d3e
-  data.tar.gz: b536b23c23f5980b7d1645b5907a0bd8401369c3
+SHA256:
+  metadata.gz: b9533a5d53e299a95e8b2aa19d277ac32ed800930c0abd4d92c67f025c98101d
+  data.tar.gz: 7261d4f25c4e0edeaaba0718947af74439d2fef8a114278a74f8de63f0f6c575
 SHA512:
-  metadata.gz: cb1e56ae090cdf939b3b9a74b366a7d6abb787486b019cbe8f9803295bfb600f78a276d47360af69e54138d601ea2d02c02e78fe7143e1b3a0bbb5158e709cff
-  data.tar.gz: ba124f9959f87f44128b8b7ab782360932d068077311a2ab15de90e37b784cb71350d1d2e47df0f660051e850ea6fbcd5917c741e36bbfdf50ab4295db02b255
+  metadata.gz: 9ae2e4ea996bb4a2ad2762a7c0812c8734879205adb05eb88aed062f0be24b26fa18de82e6cc33c7c86dfc8f7c4fa8694522732c457643c8a4d3991e50ac095a
+  data.tar.gz: 512f5e9888e8adf5ac0d93c501470028079b463e407697353d55ef603b3a2590f46b9a6530a0a688a54e391fe9033302551f133b6d216281bf01c451e1a73f85

data/README.md

@@ -1,5 +1,7 @@
 Faraday Middleware
 ==================
+[![Gem Version](https://badge.fury.io/rb/faraday_middleware.svg)](https://rubygems.org/gems/faraday_middleware)
+![GitHub Actions CI](https://github.com/lostisland/faraday_middleware/workflows/CI/badge.svg)
 
 A collection of useful [Faraday][] middleware. [See the documentation][docs].
 
@@ -8,15 +10,20 @@ A collection of useful [Faraday][] middleware. [See the documentation][docs].
 Dependencies
 ------------
 
+Ruby >= 2.3.0
+
+#### As of v0.16.0, `faraday` and `faraday_middleware` no longer officially support JRuby or Rubinius.
+
 Some dependent libraries are needed only when using specific middleware:
 
-* FaradayMiddleware::EncodeJson & FaradayMiddleware::ParseJson: "json"
-  for ruby older than 1.9
-* FaradayMiddleware::ParseXml: "multi_xml"
-* FaradayMiddleware::OAuth: "simple_oauth"
-* FaradayMiddleware::Mashify: "hashie"
-* FaradayMiddleware::Rashify: "rash"
-* FaradayMiddleware::Instrumentation: "activesupport"
+| Middleware                  | Library        | Notes |
+| --------------------------- | -------------- | ----- |
+| [FaradayMiddleware::Instrumentation](https://github.com/lostisland/faraday_middleware/blob/main/lib/faraday_middleware/instrumentation.rb) | [`activesupport`](https://rubygems.org/gems/activesupport) |       |
+| [FaradayMiddleware::OAuth](https://github.com/lostisland/faraday_middleware/blob/main/lib/faraday_middleware/request/oauth.rb)    | [`simple_oauth`](https://rubygems.org/gems/simple_oauth) |       |
+| [FaradayMiddleware::ParseXml](https://github.com/lostisland/faraday_middleware/blob/main/lib/faraday_middleware/response/parse_xml.rb) | [`multi_xml`](https://rubygems.org/gems/multi_xml)    |       |
+| [FaradayMiddleware::ParseYaml](https://github.com/lostisland/faraday_middleware/blob/main/lib/faraday_middleware/response/parse_yaml.rb)  | [`safe_yaml`](https://rubygems.org/gems/safe_yaml)     | Not backwards compatible with versions of this middleware prior to `faraday_middleware` v0.12. See code comments for alternatives. |
+| [FaradayMiddleware::Mashify](https://github.com/lostisland/faraday_middleware/blob/main/lib/faraday_middleware/response/mashify.rb)  | [`hashie`](https://rubygems.org/gems/hashie)       |       |
+| [FaradayMiddleware::Rashify](https://github.com/lostisland/faraday_middleware/blob/main/lib/faraday_middleware/response/rashify.rb)  | [`rash_alt`](https://rubygems.org/gems/rash_alt)     | Make sure to uninstall original `rash` gem to avoid conflict. |
 
 Examples
 --------
@@ -24,29 +31,16 @@ Examples
 ``` rb
 require 'faraday_middleware'
 
-## in Faraday 0.8 or above:
 connection = Faraday.new 'http://example.com/api' do |conn|
   conn.request :oauth2, 'TOKEN'
   conn.request :json
 
-  conn.response :xml,  :content_type => /\bxml$/
-  conn.response :json, :content_type => /\bjson$/
+  conn.response :xml,  content_type: /\bxml$/
+  conn.response :json, content_type: /\bjson$/
 
   conn.use :instrumentation
   conn.adapter Faraday.default_adapter
 end
-
-## with Faraday 0.7:
-connection = Faraday.new 'http://example.com/api' do |builder|
-  builder.use FaradayMiddleware::OAuth2, 'TOKEN'
-  builder.use FaradayMiddleware::EncodeJson
-
-  builder.use FaradayMiddleware::ParseXml,  :content_type => /\bxml$/
-  builder.use FaradayMiddleware::ParseJson, :content_type => /\bjson$/
-
-  builder.use FaradayMiddleware::Instrumentation
-  builder.adapter Faraday.default_adapter
-end
 ```
 
 

data/lib/faraday_middleware/backwards_compatibility.rb

@@ -1,15 +1,19 @@
-# deprecated constants
+# frozen_string_literal: true
 
-Faraday::Request.class_eval do
-  autoload :OAuth,        'faraday_middleware/request/oauth'
-  autoload :OAuth2,       'faraday_middleware/request/oauth2'
-end
+module Faraday
+  # Autoload classes for Faraday::Request.
+  class Request
+    autoload :OAuth,        'faraday_middleware/request/oauth'
+    autoload :OAuth2,       'faraday_middleware/request/oauth2'
+  end
 
-Faraday::Response.class_eval do
-  autoload :Mashify,      'faraday_middleware/response/mashify'
-  autoload :Rashify,      'faraday_middleware/response/rashify'
-  autoload :ParseJson,    'faraday_middleware/response/parse_json'
-  autoload :ParseXml,     'faraday_middleware/response/parse_xml'
-  autoload :ParseMarshal, 'faraday_middleware/response/parse_marshal'
-  autoload :ParseYaml,    'faraday_middleware/response/parse_yaml'
+  # Autoload classes for Faraday::Request.
+  class Response
+    autoload :Mashify,      'faraday_middleware/response/mashify'
+    autoload :Rashify,      'faraday_middleware/response/rashify'
+    autoload :ParseJson,    'faraday_middleware/response/parse_json'
+    autoload :ParseXml,     'faraday_middleware/response/parse_xml'
+    autoload :ParseMarshal, 'faraday_middleware/response/parse_marshal'
+    autoload :ParseYaml,    'faraday_middleware/response/parse_yaml'
+  end
 end

data/lib/faraday_middleware/gzip.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+require 'faraday'
+
+module FaradayMiddleware
+  # Middleware to automatically decompress response bodies. If the
+  # "Accept-Encoding" header wasn't set in the request, this sets it to
+  # "gzip,deflate" and appropriately handles the compressed response from the
+  # server. This resembles what Ruby 1.9+ does internally in Net::HTTP#get.
+  #
+  # This middleware is NOT necessary when these adapters are used:
+  # - net_http on Ruby 1.9+
+  # - net_http_persistent on Ruby 2.0+
+  # - em_http
+  class Gzip < Faraday::Middleware
+    dependency 'zlib'
+
+    def self.optional_dependency(lib = nil)
+      lib ? require(lib) : yield
+      true
+    rescue LoadError, NameError
+      false
+    end
+
+    BROTLI_SUPPORTED = optional_dependency 'brotli'
+
+    def self.supported_encodings
+      encodings = %w[gzip deflate]
+      encodings << 'br' if BROTLI_SUPPORTED
+      encodings
+    end
+
+    ACCEPT_ENCODING = 'Accept-Encoding'
+    CONTENT_ENCODING = 'Content-Encoding'
+    CONTENT_LENGTH = 'Content-Length'
+    SUPPORTED_ENCODINGS = supported_encodings.join(',').freeze
+
+    def call(env)
+      env[:request_headers][ACCEPT_ENCODING] ||= SUPPORTED_ENCODINGS
+      @app.call(env).on_complete do |response_env|
+        if response_env[:body].empty?
+          reset_body(response_env, &method(:raw_body))
+        else
+          case response_env[:response_headers][CONTENT_ENCODING]
+          when 'gzip'
+            reset_body(response_env, &method(:uncompress_gzip))
+          when 'deflate'
+            reset_body(response_env, &method(:inflate))
+          when 'br'
+            reset_body(response_env, &method(:brotli_inflate))
+          end
+        end
+      end
+    end
+
+    def reset_body(env)
+      env[:body] = yield(env[:body])
+      env[:response_headers].delete(CONTENT_ENCODING)
+      env[:response_headers][CONTENT_LENGTH] = env[:body].length
+    end
+
+    def uncompress_gzip(body)
+      io = StringIO.new(body)
+      gzip_reader = Zlib::GzipReader.new(io, encoding: 'ASCII-8BIT')
+      gzip_reader.read
+    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
+
+    def brotli_inflate(body)
+      Brotli.inflate(body)
+    end
+
+    def raw_body(body)
+      body
+    end
+  end
+end

data/lib/faraday_middleware/instrumentation.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'faraday'
 
 module FaradayMiddleware
@@ -7,11 +9,15 @@ module FaradayMiddleware
   #
   # Examples
   #
-  #   ActiveSupport::Notifications.subscribe('request.faraday') do |name, starts, ends, _, env|
+  #   ActiveSupport::Notifications.
+  #     subscribe('request.faraday') do |name, starts, ends, _, env|
   #     url = env[:url]
   #     http_method = env[:method].to_s.upcase
   #     duration = ends - starts
-  #     $stderr.puts '[%s] %s %s (%.3f s)' % [url.host, http_method, url.request_uri, duration]
+  #     $stderr.puts '[%s] %s %s (%.3f s)' % [url.host,
+  #                                           http_method,
+  #                                           url.request_uri,
+  #                                           duration]
   #   end
   class Instrumentation < Faraday::Middleware
     dependency 'active_support/notifications'
@@ -22,7 +28,7 @@ module FaradayMiddleware
     end
 
     def call(env)
-      ActiveSupport::Notifications.instrument(@name, env) do
+      ::ActiveSupport::Notifications.instrument(@name, env) do
         @app.call(env)
       end
     end

data/lib/faraday_middleware/rack_compatible.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 require 'stringio'
 
 module FaradayMiddleware
-  # Wraps a handler originally written for Rack to make it compatible with Faraday.
+  # Wraps a handler originally written for Rack for Faraday compatibility.
   #
   # Experimental. Only handles changes in request headers.
   class RackCompatible
@@ -22,7 +24,7 @@ module FaradayMiddleware
       finalize_response(env, rack_response)
     end
 
-    NonPrefixedHeaders = %w[CONTENT_LENGTH CONTENT_TYPE]
+    NON_PREFIXED_HEADERS = %w[CONTENT_LENGTH CONTENT_TYPE].freeze
 
     # faraday to rack-compatible
     def prepare_env(faraday_env)
@@ -31,7 +33,11 @@ module FaradayMiddleware
       url = faraday_env[:url]
       env['rack.url_scheme'] = url.scheme
       env['PATH_INFO'] = url.path
-      env['SERVER_PORT'] = url.respond_to?(:inferred_port) ? url.inferred_port : url.port
+      env['SERVER_PORT'] = if url.respond_to?(:inferred_port)
+                             url.inferred_port
+                           else
+                             url.port
+                           end
       env['QUERY_STRING'] = url.query
       env['REQUEST_METHOD'] = faraday_env[:method].to_s.upcase
 
@@ -45,7 +51,7 @@ module FaradayMiddleware
       rack_env = {}
       env[:request_headers].each do |name, value|
         name = name.upcase.tr('-', '_')
-        name = "HTTP_#{name}" unless NonPrefixedHeaders.include? name
+        name = "HTTP_#{name}" unless NON_PREFIXED_HEADERS.include? name
         rack_env[name] = value
       end
       rack_env
@@ -58,8 +64,9 @@ module FaradayMiddleware
       headers.clear
 
       rack_env.each do |name, value|
-        next unless String === name
-        if NonPrefixedHeaders.include? name or name.index('HTTP_') == 0
+        next unless name.is_a?(String) && value.is_a?(String)
+
+        if NON_PREFIXED_HEADERS.include?(name) || name.start_with?('HTTP_')
           name = name.sub(/^HTTP_/, '').downcase.tr('_', '-')
           headers[name] = value
         end
@@ -72,12 +79,12 @@ module FaradayMiddleware
 
     def finalize_response(env, rack_response)
       status, headers, body = rack_response
-      body = body.inject() { |str, part| str << part }
-      headers = Faraday::Utils::Headers.new(headers) unless Faraday::Utils::Headers === headers
+      body = body.inject { |str, part| str << part }
+      headers = Faraday::Utils::Headers.new(headers) unless headers.is_a?(Faraday::Utils::Headers)
 
-      env.update :status => status.to_i,
-                 :body => body,
-                 :response_headers => headers
+      env.update status: status.to_i,
+                 body: body,
+                 response_headers: headers
 
       env[:response] ||= Faraday::Response.new(env)
       env[:response]

data/lib/faraday_middleware/redirect_limit_reached.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'faraday'
+
+module FaradayMiddleware
+  # 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
+end

data/lib/faraday_middleware/request/encode_json.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'faraday'
 
 module FaradayMiddleware
@@ -9,8 +11,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'
+    MIME_TYPE       = 'application/json'
+    MIME_TYPE_REGEX = %r{^application/(vnd\..+\+)?json$}.freeze
 
     dependency do
       require 'json' unless defined?(::JSON)
@@ -24,23 +27,23 @@ module FaradayMiddleware
     end
 
     def encode(data)
-      ::JSON.dump data
+      ::JSON.generate data
     end
 
     def match_content_type(env)
-      if process_request?(env)
-        env[:request_headers][CONTENT_TYPE] ||= MIME_TYPE
-        yield env[:body] unless env[:body].respond_to?(:to_str)
-      end
+      return unless process_request?(env)
+
+      env[:request_headers][CONTENT_TYPE] ||= MIME_TYPE
+      yield env[:body] unless env[:body].respond_to?(:to_str)
     end
 
     def process_request?(env)
       type = request_type(env)
-      has_body?(env) and (type.empty? or type == MIME_TYPE)
+      has_body?(env) && (type.empty? || MIME_TYPE_REGEX =~ type)
     end
 
     def has_body?(env)
-      body = env[:body] and !(body.respond_to?(:to_str) and body.empty?)
+      (body = env[:body]) && !(body.respond_to?(:to_str) && body.empty?)
     end
 
     def request_type(env)

data/lib/faraday_middleware/request/method_override.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'faraday'
 
 module FaradayMiddleware
@@ -11,8 +13,7 @@ module FaradayMiddleware
   # Rack::MethodOverride module. See
   # http://rack.rubyforge.org/doc/classes/Rack/MethodOverride.html
   class MethodOverride < Faraday::Middleware
-
-    HEADER = "X-Http-Method-Override".freeze
+    HEADER = 'X-Http-Method-Override'
 
     # Public: Initialize the middleware.
     #
@@ -22,10 +23,10 @@ module FaradayMiddleware
     #                      (default: all but GET and POST)
     def initialize(app, options = nil)
       super(app)
-      @methods = options && options.fetch(:rewrite).map { |method|
+      @methods = options&.fetch(:rewrite)&.map do |method|
         method = method.downcase if method.respond_to? :downcase
         method.to_sym
-      }
+      end
     end
 
     def call(env)
@@ -35,8 +36,8 @@ module FaradayMiddleware
     end
 
     def rewrite_request?(method)
-      if @methods.nil? or @methods.empty?
-        method != :get and method != :post
+      if @methods.nil? || @methods.empty?
+        (method != :get) && (method != :post)
       else
         @methods.include? method
       end

data/lib/faraday_middleware/request/oauth.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'faraday'
 require 'forwardable'
 
@@ -23,14 +25,12 @@ module FaradayMiddleware
   class OAuth < Faraday::Middleware
     dependency 'simple_oauth'
 
-    AUTH_HEADER = 'Authorization'.freeze
-    CONTENT_TYPE = 'Content-Type'.freeze
-    TYPE_URLENCODED = 'application/x-www-form-urlencoded'.freeze
+    AUTH_HEADER = 'Authorization'
+    CONTENT_TYPE = 'Content-Type'
+    TYPE_URLENCODED = 'application/x-www-form-urlencoded'
 
     extend Forwardable
-    parser_method = :parse_nested_query
-    parser_module = ::Faraday::Utils.respond_to?(parser_method) ? 'Faraday::Utils' : 'Rack::Utils'
-    def_delegator parser_module, parser_method
+    def_delegator :'Faraday::Utils', :parse_nested_query
 
     def initialize(app, options)
       super(app)
@@ -54,7 +54,7 @@ module FaradayMiddleware
     end
 
     def oauth_options(env)
-      if extra = env[:request][:oauth] and extra.is_a? Hash and !extra.empty?
+      if (extra = env[:request][:oauth]) && extra.is_a?(Hash) && !extra.empty?
         @options.merge extra
       else
         @options
@@ -73,12 +73,15 @@ module FaradayMiddleware
 
     def include_body_params?(env)
       # see RFC 5849, section 3.4.1.3.1 for details
-      !(type = env[:request_headers][CONTENT_TYPE]) or type == TYPE_URLENCODED
+      !(type = env[:request_headers][CONTENT_TYPE]) || (type == TYPE_URLENCODED)
     end
 
     def signature_params(params)
-      params.empty? ? params :
-        params.reject {|k,v| v.respond_to?(:content_type) }
+      if params.empty?
+        params
+      else
+        params.reject { |_k, v| v.respond_to?(:content_type) }
+      end
     end
   end
 end

data/lib/faraday_middleware/request/oauth2.rb

@@ -1,11 +1,15 @@
+# frozen_string_literal: true
+
 require 'faraday'
 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"
+  # 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.
   #
@@ -17,14 +21,17 @@ 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'
+    TOKEN_TYPE  = 'param'
+    AUTH_HEADER = 'Authorization'
 
-    PARAM_NAME  = 'access_token'.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 +41,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
@@ -43,14 +55,27 @@ module FaradayMiddleware
 
     def initialize(app, token = nil, options = {})
       super(app)
-      options, token = token, nil if token.is_a? Hash
-      @token = token && token.to_s
+      if token.is_a? Hash
+        options = token
+        token = nil
+      end
+      @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
+
+      raise ArgumentError, ":param_name can't be blank" if @token_type == 'param' && @param_name.empty?
+
+      return unless 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 '\
+        'see https://github.com/lostisland/faraday_middleware/wiki.'
     end
 
     def query_params(url)
-      if url.query.nil? or url.query.empty?
+      if url.query.nil? || url.query.empty?
         {}
       else
         parse_query url.query