faraday 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a36c97856713ca2198c7ec0d6599136ecbf2033f4a192aab2f075135403e240c
-  data.tar.gz: '092c756c000f6650280080e92446aae63bea6db4603153512f78c5e748ba543a'
+  metadata.gz: f907e999805c78e8c2e77cb4d6b29a0a6f8fd8fe1a7df9930f02be7ec113a630
+  data.tar.gz: 1ceac7f2b44d41d11d1ad3f7642daea9198ba3ac2f71a4932cf7d6b7b867f704
 SHA512:
-  metadata.gz: 00c58868dc1a050bfed2f55c20543477aff2841f67665cffe3a4f736414934024c1c6c162ef1022e4d8cb8691f7abf2a756062a792988438748317f5edd7bcae
-  data.tar.gz: 61090e76494671608acac5c406f7505bc3f01eef822dbc48739fecb7fc28b80dd43f54a3af4b5696e6bd29769440b4cae0d2c07a91c601e9c320e5061c4f32a5
+  metadata.gz: 2eaf54d743ed3d7554fb2be17003e81b08c060582f140b06fb55e8aceb7dfcf2428e898f47f3760eddcdb4ad64aeaacc93916672b9ed10fa4a004d0ea1a20e1a
+  data.tar.gz: a700f0bc8999e9a0152843bbfbd23001fa23931614ae9573b13ff839e7af01f38ca2adbb01c82e4b387688496b3caff87357e3946d7500595a2f807313e177d7

data/CHANGELOG.md

@@ -1,5 +1,79 @@
 # Faraday Changelog
 
+## [v1.2.0](https://github.com/lostisland/faraday/releases/tag/v1.2.0) (2020-12-23)
+
+### Features
+
+* Introduces `on_request` and `on_complete` methods in `Faraday::Middleware`. (#1194, @iMacTia)
+
+### Fixes
+
+* Require 'date' to avoid retry exception (#1206, @rustygeldmacher)
+* Fix rdebug recursion issue (#1205, @native-api)
+* Update call to `em_http_ssl_patch` (#1202, @kylekeesling)
+* `EmHttp` adapter: drop superfluous loaded? check (#1213, @olleolleolle)
+* Avoid 1 use of keyword hackery (#1211, @grosser)
+* Fix #1219 `Net::HTTP` still uses env proxy (#1221, @iMacTia)
+
+### Documentation
+
+* Add comment in gemspec to explain exposure of `examples` and `spec` folders. (#1192, @iMacTia)
+* Adapters, how to create them (#1193, @olleolleolle)
+* Update documentation on using the logger (#1196, @tijmenb)
+* Adjust the retry documentation and spec to align with implementation (#1198, @nbeyer)
+
+### Misc
+
+* Test against ruby head (#1208, @grosser)
+
+## [v1.1.0](https://github.com/lostisland/faraday/releases/tag/v1.1.0) (2020-10-17)
+
+### Features
+
+* Makes parameters sorting configurable (#1162 @wishdev)
+* Introduces `flat_encode` option for multipart adapter. (#1163 @iMacTia)
+* Include request info in exceptions raised by RaiseError Middleware (#1181 @SandroDamilano)
+
+### Fixes
+
+* Avoid `last arg as keyword param` warning when building user middleware on Ruby 2.7 (#1153 @dgholz)
+* Limits net-http-persistent version to < 4.0 (#1156 @iMacTia)
+* Update `typhoeus` to new stable version (`1.4`) (#1159 @AlexWayfer)
+* Properly fix test failure with Rack 2.1+. (#1171 @voxik)
+
+### Documentation
+
+* Improves documentation on how to contribute to the site by using Docker. (#1175 @iMacTia)
+* Remove retry_change_requests from documentation (#1185 @stim371)
+
+### Misc
+
+* Link from GitHub Actions badge to CI workflow (#1141 @olleolleolle)
+* Return tests of `Test` adapter (#1147 @AlexWayfer)
+* Add 1.0 release to wording in CONTRIBUTING (#1155 @olleolleolle)
+* Fix linting bumping Rubocop to 0.90.0 (#1182 @iMacTia)
+* Drop `git ls-files` in gemspec (#1183 @utkarsh2102)
+* Upgrade CI to ruby/setup-ruby (#1187 @gogainda)
+
+## [v1.0.1](https://github.com/lostisland/faraday/releases/tag/v1.0.1) (2020-03-29)
+
+### Fixes
+
+* Use Net::HTTP#start(&block) to ensure closed TCP connections (#1117)
+* Fully qualify constants to be checked (#1122)
+* Allows `parse` method to be private/protected in response middleware (#1123)
+* Encode Spaces in Query Strings as '%20' Instead of '+' (#1125)
+* Limits rack to v2.0.x (#1127)
+* Adapter Registry reads also use mutex (#1136) 
+
+### Documentation
+
+* Retry middleware documentation fix (#1109)
+* Docs(retry): precise usage of retry-after (#1111)
+* README: Link the logo to the website (#1112)
+* Website: add search bar (#1116)
+* Fix request/response mix-up in docs text (#1132)
+
 ## v1.0
 
 Features:

data/lib/faraday.rb

@@ -9,7 +9,7 @@ require 'faraday/dependency_loader'
 
 unless defined?(::Faraday::Timer)
   require 'timeout'
-  Timer = Timeout
+  ::Faraday::Timer = Timeout
 end
 
 require 'faraday/version'
@@ -27,6 +27,8 @@ require 'faraday/error'
 require 'faraday/file_part'
 require 'faraday/param_part'
 
+require 'faraday/net_http'
+
 # This is the main namespace for Faraday.
 #
 # It provides methods to create {Connection} objects, and HTTP-related

data/lib/faraday/adapter.rb

@@ -11,7 +11,6 @@ module Faraday
 
     register_middleware File.expand_path('adapter', __dir__),
                         test: [:Test, 'test'],
-                        net_http: [:NetHttp, 'net_http'],
                         net_http_persistent: [
                           :NetHttpPersistent,
                           'net_http_persistent'

data/lib/faraday/adapter/net_http_persistent.rb

@@ -51,7 +51,7 @@ module Faraday
 
       def perform_request(http, env)
         http.request env[:url], create_request(env)
-      rescue Errno::ETIMEDOUT => e
+      rescue Errno::ETIMEDOUT, Net::OpenTimeout => e
         raise Faraday::TimeoutError, e
       rescue Net::HTTP::Persistent::Error => e
         raise Faraday::TimeoutError, e if e.message.include? 'Timeout'

data/lib/faraday/autoload.rb

@@ -58,7 +58,6 @@ module Faraday
   class Adapter
     extend AutoloadHelper
     autoload_all 'faraday/adapter',
-                 NetHttp: 'net_http',
                  NetHttpPersistent: 'net_http_persistent',
                  EMSynchrony: 'em_synchrony',
                  EMHttp: 'em_http',

data/lib/faraday/error.rb

@@ -28,6 +28,18 @@ module Faraday
       %(#<#{self.class}#{inner}>)
     end
 
+    def response_status
+      @response[:status] if @response
+    end
+
+    def response_headers
+      @response[:headers] if @response
+    end
+
+    def response_body
+      @response[:body] if @response
+    end
+
     protected
 
     # Pulls out potential parent exception and response hash, storing them in

data/lib/faraday/request/retry.rb

@@ -112,7 +112,7 @@ module Faraday
       #   not independent of the retry count. This would be useful
       #   if the exception produced is non-recoverable or if the
       #   the HTTP method called is not idempotent.
-      # @option options [Block] :retry_block block that is executed after
+      # @option options [Block] :retry_block block that is executed before
       #   every retry. Request environment, middleware options, current number
       #   of retries and the exception is passed to the block as parameters.
       # @option options [Array] :retry_statuses Array of Integer HTTP status

data/lib/faraday/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Faraday
-  VERSION = '1.2.0'
+  VERSION = '1.3.0'
 end

data/spec/faraday/error_spec.rb

@@ -13,6 +13,7 @@ RSpec.describe Faraday::ClientError do
       it { expect(subject.message).to eq(exception.message) }
       it { expect(subject.backtrace).to eq(exception.backtrace) }
       it { expect(subject.inspect).to eq('#<Faraday::ClientError wrapped=#<RuntimeError: test>>') }
+      it { expect(subject.response_status).to be_nil }
     end
 
     context 'with response hash' do
@@ -22,6 +23,7 @@ RSpec.describe Faraday::ClientError do
       it { expect(subject.response).to eq(exception) }
       it { expect(subject.message).to eq('the server responded with status 400') }
       it { expect(subject.inspect).to eq('#<Faraday::ClientError response={:status=>400}>') }
+      it { expect(subject.response_status).to eq(400) }
     end
 
     context 'with string' do
@@ -31,6 +33,7 @@ RSpec.describe Faraday::ClientError do
       it { expect(subject.response).to be_nil }
       it { expect(subject.message).to eq('custom message') }
       it { expect(subject.inspect).to eq('#<Faraday::ClientError #<Faraday::ClientError: custom message>>') }
+      it { expect(subject.response_status).to be_nil }
     end
 
     context 'with anything else #to_s' do
@@ -40,6 +43,18 @@ RSpec.describe Faraday::ClientError do
       it { expect(subject.response).to be_nil }
       it { expect(subject.message).to eq('["error1", "error2"]') }
       it { expect(subject.inspect).to eq('#<Faraday::ClientError #<Faraday::ClientError: ["error1", "error2"]>>') }
+      it { expect(subject.response_status).to be_nil }
+    end
+
+    context 'with exception string and response hash' do
+      let(:exception) { 'custom message' }
+      let(:response) { { status: 400 } }
+
+      it { expect(subject.wrapped_exception).to be_nil }
+      it { expect(subject.response).to eq(response) }
+      it { expect(subject.message).to eq('custom message') }
+      it { expect(subject.inspect).to eq('#<Faraday::ClientError response={:status=>400}>') }
+      it { expect(subject.response_status).to eq(400) }
     end
   end
 end

data/spec/faraday/response/raise_error_spec.rb

@@ -29,6 +29,9 @@ RSpec.describe Faraday::Response::RaiseError do
       expect(ex.message).to eq('the server responded with status 400')
       expect(ex.response[:headers]['X-Reason']).to eq('because')
       expect(ex.response[:status]).to eq(400)
+      expect(ex.response_status).to eq(400)
+      expect(ex.response_body).to eq('keep looking')
+      expect(ex.response_headers['X-Reason']).to eq('because')
     end
   end
 
@@ -37,6 +40,9 @@ RSpec.describe Faraday::Response::RaiseError do
       expect(ex.message).to eq('the server responded with status 401')
       expect(ex.response[:headers]['X-Reason']).to eq('because')
       expect(ex.response[:status]).to eq(401)
+      expect(ex.response_status).to eq(401)
+      expect(ex.response_body).to eq('keep looking')
+      expect(ex.response_headers['X-Reason']).to eq('because')
     end
   end
 
@@ -45,6 +51,9 @@ RSpec.describe Faraday::Response::RaiseError do
       expect(ex.message).to eq('the server responded with status 403')
       expect(ex.response[:headers]['X-Reason']).to eq('because')
       expect(ex.response[:status]).to eq(403)
+      expect(ex.response_status).to eq(403)
+      expect(ex.response_body).to eq('keep looking')
+      expect(ex.response_headers['X-Reason']).to eq('because')
     end
   end
 
@@ -53,6 +62,9 @@ RSpec.describe Faraday::Response::RaiseError do
       expect(ex.message).to eq('the server responded with status 404')
       expect(ex.response[:headers]['X-Reason']).to eq('because')
       expect(ex.response[:status]).to eq(404)
+      expect(ex.response_status).to eq(404)
+      expect(ex.response_body).to eq('keep looking')
+      expect(ex.response_headers['X-Reason']).to eq('because')
     end
   end
 
@@ -61,6 +73,9 @@ RSpec.describe Faraday::Response::RaiseError do
       expect(ex.message).to eq('407 "Proxy Authentication Required"')
       expect(ex.response[:headers]['X-Reason']).to eq('because')
       expect(ex.response[:status]).to eq(407)
+      expect(ex.response_status).to eq(407)
+      expect(ex.response_body).to eq('keep looking')
+      expect(ex.response_headers['X-Reason']).to eq('because')
     end
   end
 
@@ -69,6 +84,9 @@ RSpec.describe Faraday::Response::RaiseError do
       expect(ex.message).to eq('the server responded with status 409')
       expect(ex.response[:headers]['X-Reason']).to eq('because')
       expect(ex.response[:status]).to eq(409)
+      expect(ex.response_status).to eq(409)
+      expect(ex.response_body).to eq('keep looking')
+      expect(ex.response_headers['X-Reason']).to eq('because')
     end
   end
 
@@ -77,6 +95,9 @@ RSpec.describe Faraday::Response::RaiseError do
       expect(ex.message).to eq('the server responded with status 422')
       expect(ex.response[:headers]['X-Reason']).to eq('because')
       expect(ex.response[:status]).to eq(422)
+      expect(ex.response_status).to eq(422)
+      expect(ex.response_body).to eq('keep looking')
+      expect(ex.response_headers['X-Reason']).to eq('because')
     end
   end
 
@@ -85,6 +106,9 @@ RSpec.describe Faraday::Response::RaiseError do
       expect(ex.message).to eq('http status could not be derived from the server response')
       expect(ex.response[:headers]['X-Reason']).to eq('nil')
       expect(ex.response[:status]).to be_nil
+      expect(ex.response_status).to be_nil
+      expect(ex.response_body).to eq('fail')
+      expect(ex.response_headers['X-Reason']).to eq('nil')
     end
   end
 
@@ -93,6 +117,9 @@ RSpec.describe Faraday::Response::RaiseError do
       expect(ex.message).to eq('the server responded with status 499')
       expect(ex.response[:headers]['X-Reason']).to eq('because')
       expect(ex.response[:status]).to eq(499)
+      expect(ex.response_status).to eq(499)
+      expect(ex.response_body).to eq('keep looking')
+      expect(ex.response_headers['X-Reason']).to eq('because')
     end
   end
 
@@ -101,6 +128,9 @@ RSpec.describe Faraday::Response::RaiseError do
       expect(ex.message).to eq('the server responded with status 500')
       expect(ex.response[:headers]['X-Error']).to eq('bailout')
       expect(ex.response[:status]).to eq(500)
+      expect(ex.response_status).to eq(500)
+      expect(ex.response_body).to eq('fail')
+      expect(ex.response_headers['X-Error']).to eq('bailout')
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: faraday
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - "@technoweenie"
@@ -10,8 +10,22 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-12-23 00:00:00.000000000 Z
+date: 2020-12-31 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday-net_http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: multipart-post
   requirement: !ruby/object:Gem::Requirement
@@ -66,7 +80,6 @@ files:
 - lib/faraday/adapter/em_synchrony/parallel_manager.rb
 - lib/faraday/adapter/excon.rb
 - lib/faraday/adapter/httpclient.rb
-- lib/faraday/adapter/net_http.rb
 - lib/faraday/adapter/net_http_persistent.rb
 - lib/faraday/adapter/patron.rb
 - lib/faraday/adapter/rack.rb
@@ -159,7 +172,7 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://lostisland.github.io/faraday
-  changelog_uri: https://github.com/lostisland/faraday/releases/tag/v1.2.0
+  changelog_uri: https://github.com/lostisland/faraday/releases/tag/v1.3.0
   source_code_uri: https://github.com/lostisland/faraday
   bug_tracker_uri: https://github.com/lostisland/faraday/issues
 post_install_message: 

data/lib/faraday/adapter/net_http.rb

@@ -1,220 +0,0 @@
-# frozen_string_literal: true
-
-begin
-  require 'net/https'
-rescue LoadError
-  warn 'Warning: no such file to load -- net/https. ' \
-    'Make sure openssl is installed if you want ssl support'
-  require 'net/http'
-end
-require 'zlib'
-
-module Faraday
-  class Adapter
-    # Net::HTTP adapter.
-    class NetHttp < Faraday::Adapter
-      exceptions = [
-        IOError,
-        Errno::EADDRNOTAVAIL,
-        Errno::ECONNABORTED,
-        Errno::ECONNREFUSED,
-        Errno::ECONNRESET,
-        Errno::EHOSTUNREACH,
-        Errno::EINVAL,
-        Errno::ENETUNREACH,
-        Errno::EPIPE,
-        Net::HTTPBadResponse,
-        Net::HTTPHeaderSyntaxError,
-        Net::ProtocolError,
-        SocketError,
-        Zlib::GzipFile::Error
-      ]
-
-      if defined?(::OpenSSL::SSL::SSLError)
-        exceptions << ::OpenSSL::SSL::SSLError
-      end
-      exceptions << ::Net::OpenTimeout if defined?(::Net::OpenTimeout)
-
-      NET_HTTP_EXCEPTIONS = exceptions.freeze
-
-      def initialize(app = nil, opts = {}, &block)
-        @ssl_cert_store = nil
-        super(app, opts, &block)
-      end
-
-      def build_connection(env)
-        net_http_connection(env).tap do |http|
-          if http.respond_to?(:use_ssl=)
-            http.use_ssl = env[:url].scheme == 'https'
-          end
-          configure_ssl(http, env[:ssl])
-          configure_request(http, env[:request])
-        end
-      end
-
-      def net_http_connection(env)
-        proxy = env[:request][:proxy]
-        port = env[:url].port || (env[:url].scheme == 'https' ? 443 : 80)
-        if proxy
-          Net::HTTP.new(env[:url].hostname, port,
-                        proxy[:uri].hostname, proxy[:uri].port,
-                        proxy[:user], proxy[:password])
-        else
-          Net::HTTP.new(env[:url].hostname, port, nil)
-        end
-      end
-
-      def call(env)
-        super
-        http_response = connection(env) do |http|
-          begin
-            perform_request(http, env)
-          rescue *NET_HTTP_EXCEPTIONS => e
-            if defined?(OpenSSL) && e.is_a?(OpenSSL::SSL::SSLError)
-              raise Faraday::SSLError, e
-            end
-
-            raise Faraday::ConnectionFailed, e
-          end
-        end
-
-        save_response(env, http_response.code.to_i,
-                      http_response.body || +'', nil,
-                      http_response.message) do |response_headers|
-          http_response.each_header do |key, value|
-            response_headers[key] = value
-          end
-        end
-
-        @app.call env
-      rescue Timeout::Error, Errno::ETIMEDOUT => e
-        raise Faraday::TimeoutError, e
-      end
-
-      private
-
-      def create_request(env)
-        request = Net::HTTPGenericRequest.new \
-          env[:method].to_s.upcase, # request method
-          !!env[:body], # is there request body
-          env[:method] != :head, # is there response body
-          env[:url].request_uri, # request uri path
-          env[:request_headers] # request headers
-
-        if env[:body].respond_to?(:read)
-          request.body_stream = env[:body]
-        else
-          request.body = env[:body]
-        end
-        request
-      end
-
-      def perform_request(http, env)
-        if env[:request].stream_response?
-          size = 0
-          yielded = false
-          http_response = request_with_wrapped_block(http, env) do |chunk|
-            if chunk.bytesize.positive? || size.positive?
-              yielded = true
-              size += chunk.bytesize
-              env[:request].on_data.call(chunk, size)
-            end
-          end
-          env[:request].on_data.call(+'', 0) unless yielded
-          # Net::HTTP returns something,
-          # but it's not meaningful according to the docs.
-          http_response.body = nil
-          http_response
-        else
-          request_with_wrapped_block(http, env)
-        end
-      end
-
-      def request_with_wrapped_block(http, env, &block)
-        if (env[:method] == :get) && !env[:body]
-          # prefer `get` to `request` because the former handles gzip (ruby 1.9)
-          request_via_get_method(http, env, &block)
-        else
-          request_via_request_method(http, env, &block)
-        end
-      end
-
-      def request_via_get_method(http, env, &block)
-        # Must use Net::HTTP#start and pass it a block otherwise the server's
-        # TCP socket does not close correctly.
-        http.start do |opened_http|
-          opened_http.get env[:url].request_uri, env[:request_headers], &block
-        end
-      end
-
-      def request_via_request_method(http, env, &block)
-        # Must use Net::HTTP#start and pass it a block otherwise the server's
-        # TCP socket does not close correctly.
-        http.start do |opened_http|
-          if block_given?
-            opened_http.request create_request(env) do |response|
-              response.read_body(&block)
-            end
-          else
-            opened_http.request create_request(env)
-          end
-        end
-      end
-
-      def configure_ssl(http, ssl)
-        return unless ssl
-
-        http.verify_mode = ssl_verify_mode(ssl)
-        http.cert_store = ssl_cert_store(ssl)
-
-        http.cert = ssl[:client_cert] if ssl[:client_cert]
-        http.key = ssl[:client_key] if ssl[:client_key]
-        http.ca_file = ssl[:ca_file] if ssl[:ca_file]
-        http.ca_path = ssl[:ca_path] if ssl[:ca_path]
-        http.verify_depth = ssl[:verify_depth] if ssl[:verify_depth]
-        http.ssl_version = ssl[:version] if ssl[:version]
-        http.min_version = ssl[:min_version] if ssl[:min_version]
-        http.max_version = ssl[:max_version] if ssl[:max_version]
-      end
-
-      def configure_request(http, req)
-        if (sec = request_timeout(:read, req))
-          http.read_timeout = sec
-        end
-
-        if (sec = http.respond_to?(:write_timeout=) &&
-          request_timeout(:write, req))
-          http.write_timeout = sec
-        end
-
-        if (sec = request_timeout(:open, req))
-          http.open_timeout = sec
-        end
-
-        # Only set if Net::Http supports it, since Ruby 2.5.
-        http.max_retries = 0 if http.respond_to?(:max_retries=)
-
-        @config_block&.call(http)
-      end
-
-      def ssl_cert_store(ssl)
-        return ssl[:cert_store] if ssl[:cert_store]
-
-        @ssl_cert_store ||= begin
-                              # Use the default cert store by default, i.e. system ca certs
-                              OpenSSL::X509::Store.new.tap(&:set_default_paths)
-                            end
-      end
-
-      def ssl_verify_mode(ssl)
-        ssl[:verify_mode] || begin
-                               if ssl.fetch(:verify, true)
-                                 OpenSSL::SSL::VERIFY_PEER
-                               else
-                                 OpenSSL::SSL::VERIFY_NONE
-                               end
-                             end
-      end
-    end
-  end
-end