faraday_middleware 0.9.1 → 1.2.0

data/lib/faraday_middleware/response_middleware.rb

@@ -1,42 +1,48 @@
+# frozen_string_literal: true
+
 require 'faraday'
 
+# Main FaradayMiddleware module.
 module FaradayMiddleware
   # Internal: The base class for middleware that parses responses.
   class ResponseMiddleware < Faraday::Middleware
-    CONTENT_TYPE = 'Content-Type'.freeze
+    CONTENT_TYPE = 'Content-Type'
 
     class << self
       attr_accessor :parser
     end
 
     # Store a Proc that receives the body and returns the parsed result.
-    def self.define_parser(parser = nil)
-      @parser = parser || Proc.new
+    def self.define_parser(parser = nil, &block)
+      @parser = parser ||
+                block  ||
+                raise(ArgumentError, 'Define parser with a block')
     end
 
     def self.inherited(subclass)
       super
-      subclass.load_error = self.load_error if subclass.respond_to? :load_error=
-      subclass.parser = self.parser
+      subclass.load_error = load_error if subclass.respond_to? :load_error=
+      subclass.parser = parser
     end
 
     def initialize(app = nil, options = {})
       super(app)
       @options = options
+      @parser_options = options[:parser_options]
       @content_types = Array(options[:content_type])
     end
 
     def call(environment)
       @app.call(environment).on_complete do |env|
-        if process_response_type?(response_type(env)) and parse_response?(env)
-          process_response(env)
-        end
+        process_response(env) if process_response_type?(response_type(env)) && parse_response?(env)
       end
     end
 
     def process_response(env)
       env[:raw_body] = env[:body] if preserve_raw?(env)
       env[:body] = parse(env[:body])
+    rescue Faraday::ParsingError => e
+      raise Faraday::ParsingError.new(e.wrapped_exception, env[:response])
     end
 
     # Parse the response body.
@@ -45,10 +51,12 @@ module FaradayMiddleware
     def parse(body)
       if self.class.parser
         begin
-          self.class.parser.call(body)
-        rescue StandardError, SyntaxError => err
-          raise err if err.is_a? SyntaxError and err.class.name != 'Psych::SyntaxError'
-          raise Faraday::Error::ParsingError, err
+          self.class.parser.call(body, @parser_options)
+        rescue StandardError, SyntaxError => e
+          raise e if e.is_a?(SyntaxError) &&
+                     e.class.name != 'Psych::SyntaxError'
+
+          raise Faraday::ParsingError, e
         end
       else
         body
@@ -62,9 +70,9 @@ module FaradayMiddleware
     end
 
     def process_response_type?(type)
-      @content_types.empty? or @content_types.any? { |pattern|
+      @content_types.empty? || @content_types.any? do |pattern|
         pattern.is_a?(Regexp) ? type =~ pattern : type == pattern
-      }
+      end
     end
 
     def parse_response?(env)
@@ -81,17 +89,18 @@ module FaradayMiddleware
     attr_accessor :preserve_raw
 
     def to_hash
-      super.update(:preserve_raw => preserve_raw)
+      super.update(preserve_raw: preserve_raw)
     end
 
     def each
       return to_enum(:each) unless block_given?
+
       super
       yield :preserve_raw, preserve_raw
     end
 
     def fetch(key, *args)
-      if :preserve_raw == key
+      if key == :preserve_raw
         value = __send__(key)
         value.nil? ? args.fetch(0) : value
       else
@@ -102,9 +111,9 @@ module FaradayMiddleware
 
   if defined?(Faraday::RequestOptions)
     begin
-      Faraday::RequestOptions.from(:preserve_raw => true)
+      Faraday::RequestOptions.from(preserve_raw: true)
     rescue NoMethodError
-      Faraday::RequestOptions.send(:include, OptionsExtension)
+      Faraday::RequestOptions.include OptionsExtension
     end
   end
 end

data/lib/faraday_middleware/version.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+
+# Main FaradayMiddleware module.
 module FaradayMiddleware
-  VERSION = "0.9.1" unless defined?(FaradayMiddleware::VERSION)
+  VERSION = '1.2.0' unless defined?(FaradayMiddleware::VERSION)
 end

data/lib/faraday_middleware.rb

@@ -1,5 +1,8 @@
+# frozen_string_literal: true
+
 require 'faraday'
 
+# Main FaradayMiddleware module.
 module FaradayMiddleware
   autoload :OAuth,           'faraday_middleware/request/oauth'
   autoload :OAuth2,          'faraday_middleware/request/oauth2'
@@ -15,31 +18,34 @@ module FaradayMiddleware
   autoload :Caching,         'faraday_middleware/response/caching'
   autoload :Chunked,         'faraday_middleware/response/chunked'
   autoload :RackCompatible,  'faraday_middleware/rack_compatible'
+  autoload :RedirectLimitReached, 'faraday_middleware/redirect_limit_reached'
   autoload :FollowRedirects, 'faraday_middleware/response/follow_redirects'
   autoload :Instrumentation, 'faraday_middleware/instrumentation'
+  autoload :Gzip, 'faraday_middleware/gzip'
 
   if Faraday::Middleware.respond_to? :register_middleware
     Faraday::Request.register_middleware \
-      :oauth    => lambda { OAuth },
-      :oauth2   => lambda { OAuth2 },
-      :json     => lambda { EncodeJson },
-      :method_override => lambda { MethodOverride }
+      oauth: -> { OAuth },
+      oauth2: -> { OAuth2 },
+      json: -> { EncodeJson },
+      method_override: -> { MethodOverride }
 
     Faraday::Response.register_middleware \
-      :mashify  => lambda { Mashify },
-      :rashify  => lambda { Rashify },
-      :json     => lambda { ParseJson },
-      :json_fix => lambda { ParseJson::MimeTypeFix },
-      :xml      => lambda { ParseXml },
-      :marshal  => lambda { ParseMarshal },
-      :yaml     => lambda { ParseYaml },
-      :dates    => lambda { ParseDates },
-      :caching  => lambda { Caching },
-      :follow_redirects => lambda { FollowRedirects },
-      :chunked => lambda { Chunked }
+      mashify: -> { Mashify },
+      rashify: -> { Rashify },
+      json: -> { ParseJson },
+      json_fix: -> { ParseJson::MimeTypeFix },
+      xml: -> { ParseXml },
+      marshal: -> { ParseMarshal },
+      yaml: -> { ParseYaml },
+      dates: -> { ParseDates },
+      caching: -> { Caching },
+      follow_redirects: -> { FollowRedirects },
+      chunked: -> { Chunked }
 
     Faraday::Middleware.register_middleware \
-      :instrumentation  => lambda { Instrumentation }
+      instrumentation: -> { Instrumentation },
+      gzip: -> { Gzip }
   end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: faraday_middleware
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Erik Michaels-Ober
@@ -9,43 +9,23 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-19 00:00:00.000000000 Z
+date: 2021-10-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.7.4
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '0.10'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.7.4
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '0.10'
-- !ruby/object:Gem::Dependency
-  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
-description: Various middleware for Faraday
+description: 
 email:
 - sferik@gmail.com
 - wynn.netherland@gmail.com
@@ -53,17 +33,14 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- CHANGELOG.md
-- CONTRIBUTING.md
 - LICENSE.md
 - README.md
-- Rakefile
-- faraday_middleware.gemspec
 - lib/faraday_middleware.rb
-- lib/faraday_middleware/addressable_patch.rb
 - lib/faraday_middleware/backwards_compatibility.rb
+- lib/faraday_middleware/gzip.rb
 - lib/faraday_middleware/instrumentation.rb
 - lib/faraday_middleware/rack_compatible.rb
+- lib/faraday_middleware/redirect_limit_reached.rb
 - lib/faraday_middleware/request/encode_json.rb
 - lib/faraday_middleware/request/method_override.rb
 - lib/faraday_middleware/request/oauth.rb
@@ -80,21 +57,6 @@ files:
 - lib/faraday_middleware/response/rashify.rb
 - lib/faraday_middleware/response_middleware.rb
 - lib/faraday_middleware/version.rb
-- spec/caching_spec.rb
-- spec/chunked_spec.rb
-- spec/encode_json_spec.rb
-- spec/follow_redirects_spec.rb
-- spec/helper.rb
-- spec/mashify_spec.rb
-- spec/method_override_spec.rb
-- spec/oauth2_spec.rb
-- spec/oauth_spec.rb
-- spec/parse_dates_spec.rb
-- spec/parse_json_spec.rb
-- spec/parse_marshal_spec.rb
-- spec/parse_xml_spec.rb
-- spec/parse_yaml_spec.rb
-- spec/rashify_spec.rb
 homepage: https://github.com/lostisland/faraday_middleware
 licenses:
 - MIT
@@ -107,32 +69,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.5
+      version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.0
+rubygems_version: 3.0.3.1
 signing_key: 
 specification_version: 4
 summary: Various middleware for Faraday
-test_files:
-- spec/caching_spec.rb
-- spec/chunked_spec.rb
-- spec/encode_json_spec.rb
-- spec/follow_redirects_spec.rb
-- spec/helper.rb
-- spec/mashify_spec.rb
-- spec/method_override_spec.rb
-- spec/oauth2_spec.rb
-- spec/oauth_spec.rb
-- spec/parse_dates_spec.rb
-- spec/parse_json_spec.rb
-- spec/parse_marshal_spec.rb
-- spec/parse_xml_spec.rb
-- spec/parse_yaml_spec.rb
-- spec/rashify_spec.rb
-has_rdoc: 
+test_files: []

data/CHANGELOG.md

@@ -1,10 +0,0 @@
-# Changelog
-
-### 0.0.2 September 25, 2010
-
-* Mashify now handles arrays of non-hashes
-
-### 0.0.1 June 27, 2010
-
-* MultiJSON
-* Mashify

data/CONTRIBUTING.md

@@ -1,46 +0,0 @@
-## Contributing
-In the spirit of [free software][free-sw], **everyone** is encouraged to help
-improve this project.
-
-[free-sw]: http://www.fsf.org/licensing/essays/free-sw.html
-
-Here are some ways *you* can contribute:
-
-* by using alpha, beta, and prerelease versions
-* by reporting bugs
-* by suggesting new features
-* by writing or editing documentation
-* by writing specifications
-* by writing code (**no patch is too small**: fix typos, add comments, clean up
-  inconsistent whitespace)
-* by refactoring code
-* by fixing [issues][]
-* by reviewing patches
-
-[issues]: https://github.com/lostisland/faraday_middleware/issues
-
-## Submitting an Issue
-We use the [GitHub issue tracker][issues] to track bugs and features. Before
-submitting a bug report or feature request, check to make sure it hasn't
-already been submitted. When submitting a bug report, please include a [Gist][]
-that includes a stack trace and any details that may be necessary to reproduce
-the bug, including your gem version, Ruby version, and operating system.
-Ideally, a bug report should include a pull request with failing specs.
-
-[gist]: https://gist.github.com/
-
-## Submitting a Pull Request
-1. [Fork the repository.][fork]
-2. [Create a topic branch.][branch]
-3. Add specs for your unimplemented feature or bug fix.
-4. Run `bundle exec rake spec`. If your specs pass, return to step 3.
-5. Implement your feature or bug fix.
-6. Run `bundle exec rake spec`. If your specs fail, return to step 5.
-7. Run `open coverage/index.html`. If your changes are not completely covered
-   by your tests, return to step 3.
-8. Add, commit, and push your changes.
-9. [Submit a pull request.][pr]
-
-[fork]: http://help.github.com/fork-a-repo/
-[branch]: http://learn.github.com/p/branching.html
-[pr]: http://help.github.com/send-pull-requests/

data/Rakefile

@@ -1,28 +0,0 @@
-ruby_19 = RUBY_VERSION > '1.9'
-ruby_mri = !defined?(RUBY_ENGINE) || 'ruby' == RUBY_ENGINE
-default_gemfile = ENV['BUNDLE_GEMFILE'] =~ /Gemfile$/
-
-if ruby_19 && ruby_mri && default_gemfile
-  task :default => [:enable_coverage, :spec, :quality]
-else
-  task :default => [:spec]
-end
-
-require 'bundler'
-Bundler::GemHelper.install_tasks
-
-require 'rspec/core/rake_task'
-RSpec::Core::RakeTask.new(:spec)
-
-task :enable_coverage do
-  ENV['COVERAGE'] = 'yes'
-end
-
-desc %(Check code quality metrics with Cane)
-task :quality do
-  sh 'cane',
-    '--abc-max=15',
-    '--style-measure=110',
-    '--gte=coverage/covered_percent,98.9',
-    '--max-violations=0'
-end

data/faraday_middleware.gemspec

@@ -1,23 +0,0 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'faraday_middleware/version'
-
-Gem::Specification.new do |spec|
-  spec.add_dependency 'faraday', ['>= 0.7.4', '< 0.10']
-  spec.add_development_dependency 'bundler', '~> 1.0'
-  spec.authors = ["Erik Michaels-Ober", "Wynn Netherland"]
-  spec.description = %q{Various middleware for Faraday}
-  spec.email = ['sferik@gmail.com', 'wynn.netherland@gmail.com']
-  spec.files = %w(CHANGELOG.md CONTRIBUTING.md LICENSE.md README.md Rakefile faraday_middleware.gemspec)
-  spec.files += Dir.glob("lib/**/*.rb")
-  spec.files += Dir.glob("spec/**/*")
-  spec.homepage = 'https://github.com/lostisland/faraday_middleware'
-  spec.licenses = ['MIT']
-  spec.name = 'faraday_middleware'
-  spec.require_paths = ['lib']
-  spec.required_rubygems_version = '>= 1.3.5'
-  spec.summary = spec.description
-  spec.test_files += Dir.glob("spec/**/*")
-  spec.version = FaradayMiddleware::VERSION
-end

data/lib/faraday_middleware/addressable_patch.rb

@@ -1,20 +0,0 @@
-require 'addressable/uri'
-
-# feature-detect the bug
-unless Addressable::URI.parse('/?a=1&b=2') === '/?b=2&a=1'
-  # fix `normalized_query` by sorting query key-value pairs
-  # (rejected: https://github.com/sporkmonger/addressable/issues/28)
-  class Addressable::URI
-    alias normalized_query_without_ordering_fix normalized_query
-
-    def normalized_query
-      fresh = @normalized_query.nil?
-      query = normalized_query_without_ordering_fix
-      if query && fresh
-        @normalized_query = query.split('&', -1).sort_by {|q| q[0..(q.index('=')||-1)] }.join('&')
-      else
-        query
-      end
-    end
-  end
-end

data/spec/caching_spec.rb

@@ -1,170 +0,0 @@
-require 'helper'
-require 'forwardable'
-require 'fileutils'
-require 'rack/cache'
-require 'faraday'
-require 'faraday_middleware/response/caching'
-require 'faraday_middleware/rack_compatible'
-
-describe FaradayMiddleware::Caching do
-  before do
-    @cache = TestCache.new
-    request_count = 0
-    response = lambda { |env|
-      [200, {'Content-Type' => 'text/plain'}, "request:#{request_count+=1}"]
-    }
-
-    @conn = Faraday.new do |b|
-      b.use CachingLint
-      b.use FaradayMiddleware::Caching, @cache, options
-      b.adapter :test do |stub|
-        stub.get('/', &response)
-        stub.get('/?foo=bar', &response)
-        stub.post('/', &response)
-        stub.get('/other', &response)
-      end
-    end
-  end
-
-  let(:options) { {} }
-
-  extend Forwardable
-  def_delegators :@conn, :get, :post
-
-  it 'caches get requests' do
-    expect(get('/').body).to eq('request:1')
-    expect(get('/').body).to eq('request:1')
-    expect(get('/other').body).to eq('request:2')
-    expect(get('/other').body).to eq('request:2')
-  end
-
-  it 'includes request params in the response' do
-    get('/') # make cache
-    response = get('/')
-    expect(response.env[:method]).to eq(:get)
-    expect(response.env[:url].request_uri).to eq('/')
-  end
-
-  it 'caches requests with query params' do
-    expect(get('/').body).to eq('request:1')
-    expect(get('/?foo=bar').body).to eq('request:2')
-    expect(get('/?foo=bar').body).to eq('request:2')
-    expect(get('/').body).to eq('request:1')
-  end
-
-  it 'does not cache post requests' do
-    expect(post('/').body).to eq('request:1')
-    expect(post('/').body).to eq('request:2')
-    expect(post('/').body).to eq('request:3')
-  end
-
-  context ":ignore_params" do
-    let(:options) { {:ignore_params => %w[ utm_source utm_term ]} }
-
-    it "strips ignored parameters from cache_key" do
-      expect(get('/').body).to eq('request:1')
-      expect(get('/?utm_source=a').body).to eq('request:1')
-      expect(get('/?utm_source=a&utm_term=b').body).to eq('request:1')
-      expect(get('/?utm_source=a&utm_term=b&foo=bar').body).to eq('request:2')
-      expect(get('/?foo=bar').body).to eq('request:2')
-    end
-  end
-
-  class TestCache < Hash
-    def read(key)
-      if cached = self[key]
-        Marshal.load(cached)
-      end
-    end
-
-    def write(key, data)
-      self[key] = Marshal.dump(data)
-    end
-
-    def fetch(key)
-      read(key) || yield.tap { |data| write(key, data) }
-    end
-  end
-
-  class CachingLint < Struct.new(:app)
-    def call(env)
-      app.call(env).on_complete do
-        raise "no headers" unless env[:response_headers].is_a? Hash
-        raise "no response" unless env[:response].is_a? Faraday::Response
-        # raise "env not identical" unless env[:response].env.object_id == env.object_id
-      end
-    end
-  end
-end
-
-# RackCompatible + Rack::Cache
-describe FaradayMiddleware::RackCompatible, 'caching' do
-  include FileUtils
-
-  CACHE_DIR = File.expand_path('../../tmp/cache', __FILE__)
-
-  before do
-    rm_r CACHE_DIR if File.exists? CACHE_DIR
-    # force reinitializing cache dirs
-    Rack::Cache::Storage.instance.clear
-
-    request_count = 0
-    response = lambda { |env|
-      [200, { 'Content-Type' => 'text/plain',
-              'Cache-Control' => 'public, max-age=900',
-            },
-            "request:#{request_count+=1}"]
-    }
-
-    @conn = Faraday.new do |b|
-      b.use RackErrorsComplainer
-
-      b.use FaradayMiddleware::RackCompatible, Rack::Cache::Context,
-        :metastore   => "file:#{CACHE_DIR}/rack/meta",
-        :entitystore => "file:#{CACHE_DIR}/rack/body",
-        :verbose     => true
-
-      b.adapter :test do |stub|
-        stub.get('/', &response)
-        stub.post('/', &response)
-      end
-    end
-  end
-
-  extend Forwardable
-  def_delegators :@conn, :get, :post
-
-  it 'caches get requests' do
-    response = get('/', :user_agent => 'test')
-    expect(response.body).to eq('request:1')
-    expect(response.env[:method]).to eq(:get)
-    expect(response.status).to eq(200)
-
-    response = get('/', :user_agent => 'test')
-    expect(response.body).to eq('request:1')
-    expect(response['content-type']).to eq('text/plain')
-    expect(response.env[:method]).to eq(:get)
-    expect(response.env[:request].respond_to?(:fetch)).to be_true
-    expect(response.status). to eq(200)
-
-    expect(post('/').body).to eq('request:2')
-  end
-
-  it 'does not cache post requests' do
-    expect(get('/').body).to eq('request:1')
-    expect(post('/').body).to eq('request:2')
-    expect(post('/').body).to eq('request:3')
-  end
-
-  # middleware to check whether "rack.errors" is free of error reports
-  class RackErrorsComplainer < Struct.new(:app)
-    def call(env)
-      response = app.call(env)
-      error_stream = env[:rack_errors]
-      if error_stream.respond_to?(:string) && error_stream.string.include?('error')
-        raise %(unexpected error in 'rack.errors': %p) % error_stream.string
-      end
-      response
-    end
-  end
-end