faraday 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 47236f354f9fda55254c8bd2b9e3552de12e8894fcecea0035ffbeb3ccc46b9c
-  data.tar.gz: f6eb36d3da02314fe799368c1ff4c17c5841f0badd18c5a89772e00bae43065c
+  metadata.gz: a36c97856713ca2198c7ec0d6599136ecbf2033f4a192aab2f075135403e240c
+  data.tar.gz: '092c756c000f6650280080e92446aae63bea6db4603153512f78c5e748ba543a'
 SHA512:
-  metadata.gz: 300153861873b2a5b3a3a9f552c47a2b70dd083ffd5478d8eca2c4c2005e5a74d09d962b51fb9a780ea90bb1ac87bdfa902639e86b2147d5b4d4374791789bd1
-  data.tar.gz: 3628d85508cdd669111ae6175b6b5a191380d0d405f345612f6342e487aec0f3cc9d2e1726a2cdde7d82ee86fae82aa41f4a62ea330343598383ae3f644b5a85
+  metadata.gz: 00c58868dc1a050bfed2f55c20543477aff2841f67665cffe3a4f736414934024c1c6c162ef1022e4d8cb8691f7abf2a756062a792988438748317f5edd7bcae
+  data.tar.gz: 61090e76494671608acac5c406f7505bc3f01eef822dbc48739fecb7fc28b80dd43f54a3af4b5696e6bd29769440b4cae0d2c07a91c601e9c320e5061c4f32a5

data/lib/faraday.rb

@@ -1,11 +1,32 @@
 # frozen_string_literal: true
 
 require 'cgi'
+require 'date'
 require 'set'
 require 'forwardable'
 require 'faraday/middleware_registry'
 require 'faraday/dependency_loader'
 
+unless defined?(::Faraday::Timer)
+  require 'timeout'
+  Timer = Timeout
+end
+
+require 'faraday/version'
+require 'faraday/methods'
+require 'faraday/utils'
+require 'faraday/options'
+require 'faraday/connection'
+require 'faraday/rack_builder'
+require 'faraday/parameters'
+require 'faraday/middleware'
+require 'faraday/adapter'
+require 'faraday/request'
+require 'faraday/response'
+require 'faraday/error'
+require 'faraday/file_part'
+require 'faraday/param_part'
+
 # This is the main namespace for Faraday.
 #
 # It provides methods to create {Connection} objects, and HTTP-related
@@ -19,10 +40,6 @@ require 'faraday/dependency_loader'
 #   conn.get '/'
 #
 module Faraday
-  VERSION = '1.1.0'
-  METHODS_WITH_QUERY = %w[get head delete trace].freeze
-  METHODS_WITH_BODY = %w[post put patch].freeze
-
   class << self
     # The root path that Faraday is being loaded from.
     #
@@ -107,6 +124,34 @@ module Faraday
       default_connection.respond_to?(symbol, include_private) || super
     end
 
+    # @overload default_connection
+    #   Gets the default connection used for simple scripts.
+    #   @return [Faraday::Connection] a connection configured with
+    #   the default_adapter.
+    # @overload default_connection=(connection)
+    #   @param connection [Faraday::Connection]
+    #   Sets the default {Faraday::Connection} for simple scripts that
+    #   access the Faraday constant directly, such as
+    #   <code>Faraday.get "https://faraday.com"</code>.
+    def default_connection
+      @default_connection ||= Connection.new(default_connection_options)
+    end
+
+    # Gets the default connection options used when calling {Faraday#new}.
+    #
+    # @return [Faraday::ConnectionOptions]
+    def default_connection_options
+      @default_connection_options ||= ConnectionOptions.new
+    end
+
+    # Sets the default options used when calling {Faraday#new}.
+    #
+    # @param options [Hash, Faraday::ConnectionOptions]
+    def default_connection_options=(options)
+      @default_connection = nil
+      @default_connection_options = ConnectionOptions.from(options)
+    end
+
     private
 
     # Internal: Proxies method calls on the Faraday constant to
@@ -125,42 +170,5 @@ module Faraday
   self.lib_path = File.expand_path 'faraday', __dir__
   self.default_adapter = :net_http
 
-  # @overload default_connection
-  #   Gets the default connection used for simple scripts.
-  #   @return [Faraday::Connection] a connection configured with
-  #   the default_adapter.
-  # @overload default_connection=(connection)
-  #   @param connection [Faraday::Connection]
-  #   Sets the default {Faraday::Connection} for simple scripts that
-  #   access the Faraday constant directly, such as
-  #   <code>Faraday.get "https://faraday.com"</code>.
-  def self.default_connection
-    @default_connection ||= Connection.new(default_connection_options)
-  end
-
-  # Gets the default connection options used when calling {Faraday#new}.
-  #
-  # @return [Faraday::ConnectionOptions]
-  def self.default_connection_options
-    @default_connection_options ||= ConnectionOptions.new
-  end
-
-  # Sets the default options used when calling {Faraday#new}.
-  #
-  # @param options [Hash, Faraday::ConnectionOptions]
-  def self.default_connection_options=(options)
-    @default_connection = nil
-    @default_connection_options = ConnectionOptions.from(options)
-  end
-
-  unless defined?(::Faraday::Timer)
-    require 'timeout'
-    Timer = Timeout
-  end
-
-  require_libs 'utils', 'options', 'connection', 'rack_builder', 'parameters',
-               'middleware', 'adapter', 'request', 'response', 'error',
-               'file_part', 'param_part'
-
   require_lib 'autoload' unless ENV['FARADAY_NO_AUTOLOAD']
 end

data/lib/faraday/adapter/em_http.rb

@@ -90,7 +90,21 @@ module Faraday
 
       include Options
 
-      dependency 'em-http'
+      dependency do
+        require 'em-http'
+
+        begin
+          require 'openssl'
+        rescue LoadError
+          warn 'Warning: no such file to load -- openssl. ' \
+            'Make sure it is installed if you want HTTPS support'
+        else
+          require 'em-http/version'
+          if EventMachine::HttpRequest::VERSION < '1.1.6'
+            require 'faraday/adapter/em_http_ssl_patch'
+          end
+        end
+      end
 
       self.supports_parallel = true
 
@@ -273,14 +287,3 @@ module Faraday
     end
   end
 end
-
-if Faraday::Adapter::EMHttp.loaded?
-  begin
-    require 'openssl'
-  rescue LoadError
-    warn 'Warning: no such file to load -- openssl. ' \
-      'Make sure it is installed if you want HTTPS support'
-  else
-    require 'faraday/adapter/em_http_ssl_patch'
-  end
-end

data/lib/faraday/adapter/em_synchrony.rb

@@ -12,6 +12,22 @@ module Faraday
         require 'em-synchrony/em-http'
         require 'em-synchrony/em-multi'
         require 'fiber'
+
+        require 'faraday/adapter/em_synchrony/parallel_manager'
+
+        if Faraday::Adapter::EMSynchrony.loaded?
+          begin
+            require 'openssl'
+          rescue LoadError
+            warn 'Warning: no such file to load -- openssl. ' \
+              'Make sure it is installed if you want HTTPS support'
+          else
+            require 'em-http/version'
+            if EventMachine::HttpRequest::VERSION < '1.1.6'
+              require 'faraday/adapter/em_http_ssl_patch'
+            end
+          end
+        end
       end
 
       self.supports_parallel = true
@@ -135,16 +151,3 @@ module Faraday
     end
   end
 end
-
-require 'faraday/adapter/em_synchrony/parallel_manager'
-
-if Faraday::Adapter::EMSynchrony.loaded?
-  begin
-    require 'openssl'
-  rescue LoadError
-    warn 'Warning: no such file to load -- openssl. ' \
-      'Make sure it is installed if you want HTTPS support'
-  else
-    require 'faraday/adapter/em_http_ssl_patch'
-  end
-end

data/lib/faraday/adapter/net_http.rb

@@ -53,14 +53,15 @@ module Faraday
       end
 
       def net_http_connection(env)
-        klass = if (proxy = env[:request][:proxy])
-                  Net::HTTP::Proxy(proxy[:uri].hostname, proxy[:uri].port,
-                                   proxy[:user], proxy[:password])
-                else
-                  Net::HTTP
-                end
+        proxy = env[:request][:proxy]
         port = env[:url].port || (env[:url].scheme == 'https' ? 443 : 80)
-        klass.new(env[:url].hostname, port)
+        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)
@@ -182,7 +183,7 @@ module Faraday
         end
 
         if (sec = http.respond_to?(:write_timeout=) &&
-                  request_timeout(:write, req))
+          request_timeout(:write, req))
           http.write_timeout = sec
         end
 
@@ -200,19 +201,19 @@ module Faraday
         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
+                              # 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
+                               if ssl.fetch(:verify, true)
+                                 OpenSSL::SSL::VERIFY_PEER
+                               else
+                                 OpenSSL::SSL::VERIFY_NONE
+                               end
+                             end
       end
     end
   end

data/lib/faraday/dependency_loader.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'ruby2_keywords'
-
 module Faraday
   # DependencyLoader helps Faraday adapters and middleware load dependencies.
   module DependencyLoader
@@ -15,7 +13,7 @@ module Faraday
       self.load_error = e
     end
 
-    ruby2_keywords def new(*)
+    def new(*)
       unless loaded?
         raise "missing dependency for #{self}: #{load_error.message}"
       end

data/lib/faraday/methods.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Faraday
+  METHODS_WITH_QUERY = %w[get head delete trace].freeze
+  METHODS_WITH_BODY = %w[post put patch].freeze
+end

data/lib/faraday/middleware.rb

@@ -6,15 +6,25 @@ module Faraday
     extend MiddlewareRegistry
     extend DependencyLoader
 
-    def initialize(app = nil)
+    attr_reader :app, :options
+
+    def initialize(app = nil, options = {})
       @app = app
+      @options = options
+    end
+
+    def call(env)
+      on_request(env) if respond_to?(:on_request)
+      app.call(env).on_complete do |environment|
+        on_complete(environment) if respond_to?(:on_complete)
+      end
     end
 
     def close
-      if @app.respond_to?(:close)
-        @app.close
+      if app.respond_to?(:close)
+        app.close
       else
-        warn "#{@app} does not implement \#close!"
+        warn "#{app} does not implement \#close!"
       end
     end
   end

data/lib/faraday/request/retry.rb

@@ -21,7 +21,7 @@ module Faraday
     #   end
     #
     # This example will result in a first interval that is random between 0.05
-    # and 0.075 and a second interval that is random between 0.1 and 0.15.
+    # and 0.075 and a second interval that is random between 0.1 and 0.125.
     class Retry < Faraday::Middleware
       DEFAULT_EXCEPTIONS = [
         Errno::ETIMEDOUT, 'Timeout::Error',

data/lib/faraday/response.rb

@@ -7,12 +7,6 @@ module Faraday
   class Response
     # Used for simple response middleware.
     class Middleware < Faraday::Middleware
-      def call(env)
-        @app.call(env).on_complete do |environment|
-          on_complete(environment)
-        end
-      end
-
       # Override this to modify the environment after the response has finished.
       # Calls the `parse` method if defined
       # `parse` method can be defined as private, public and protected

data/lib/faraday/version.rb

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

data/spec/faraday/middleware_spec.rb

@@ -2,23 +2,49 @@
 
 RSpec.describe Faraday::Middleware do
   subject { described_class.new(app) }
+  let(:app) { double }
+
+  describe 'options' do
+    context 'when options are passed to the middleware' do
+      subject { described_class.new(app, options) }
+      let(:options) { { field: 'value' } }
+
+      it 'accepts options when initialized' do
+        expect(subject.options[:field]).to eq('value')
+      end
+    end
+  end
+
+  describe '#on_request' do
+    subject do
+      Class.new(described_class) do
+        def on_request(env)
+          # do nothing
+        end
+      end.new(app)
+    end
+
+    it 'is called by #call' do
+      expect(app).to receive(:call).and_return(app)
+      expect(app).to receive(:on_complete)
+      is_expected.to receive(:call).and_call_original
+      is_expected.to receive(:on_request)
+      subject.call(double)
+    end
+  end
 
   describe '#close' do
     context "with app that doesn't support \#close" do
-      let(:app) { double }
-
       it 'should issue warning' do
-        expect(subject).to receive(:warn)
+        is_expected.to receive(:warn)
         subject.close
       end
     end
 
     context "with app that supports \#close" do
-      let(:app) { double }
-
       it 'should issue warning' do
         expect(app).to receive(:close)
-        expect(subject).to_not receive(:warn)
+        is_expected.to_not receive(:warn)
         subject.close
       end
     end

data/spec/faraday/request/retry_spec.rb

@@ -117,7 +117,7 @@ RSpec.describe Faraday::Request::Retry do
       let(:options) { { max: 2, interval: 0.1, interval_randomness: 0.05 } }
       let(:middleware) { Faraday::Request::Retry.new(nil, options) }
 
-      it { expect(middleware.send(:calculate_retry_interval, 2)).to be_between(0.1, 0.15) }
+      it { expect(middleware.send(:calculate_retry_interval, 2)).to be_between(0.1, 0.105) }
     end
   end
 

data/spec/support/shared_examples/adapter.rb

@@ -33,6 +33,7 @@ shared_examples 'adapter examples' do |**options|
 
   let(:protocol) { ssl_mode? ? 'https' : 'http' }
   let(:remote) { "#{protocol}://example.com" }
+  let(:stub_remote) { remote }
 
   let(:conn) do
     conn_options[:ssl] ||= {}
@@ -46,7 +47,7 @@ shared_examples 'adapter examples' do |**options|
     end
   end
 
-  let!(:request_stub) { stub_request(http_method, remote) }
+  let!(:request_stub) { stub_request(http_method, stub_remote) }
 
   after do
     expect(request_stub).to have_been_requested unless request_stub.disabled?

data/spec/support/shared_examples/request_method.rb

@@ -1,5 +1,19 @@
 # frozen_string_literal: true
 
+shared_examples 'proxy examples' do
+  it 'handles requests with proxy' do
+    res = conn.public_send(http_method, '/')
+
+    expect(res.status).to eq(200)
+  end
+
+  it 'handles proxy failures' do
+    request_stub.to_return(status: 407)
+
+    expect { conn.public_send(http_method, '/') }.to raise_error(Faraday::ProxyAuthError)
+  end
+end
+
 shared_examples 'a request method' do |http_method|
   let(:query_or_body) { method_with_body?(http_method) ? :body : :query }
   let(:response) { conn.public_send(http_method, '/') }
@@ -218,17 +232,31 @@ shared_examples 'a request method' do |http_method|
     end
   end
 
-  it 'handles requests with proxy' do
-    conn_options[:proxy] = 'http://google.co.uk'
+  context 'when a proxy is provided as option' do
+    before do
+      conn_options[:proxy] = 'http://env-proxy.com:80'
+    end
 
-    res = conn.public_send(http_method, '/')
-    expect(res.status).to eq(200)
+    include_examples 'proxy examples'
   end
 
-  it 'handles proxy failures' do
-    conn_options[:proxy] = 'http://google.co.uk'
-    request_stub.to_return(status: 407)
+  context 'when http_proxy env variable is set' do
+    let(:proxy_url) { 'http://env-proxy.com:80' }
 
-    expect { conn.public_send(http_method, '/') }.to raise_error(Faraday::ProxyAuthError)
+    around do |example|
+      with_env 'http_proxy' => proxy_url do
+        example.run
+      end
+    end
+
+    include_examples 'proxy examples'
+
+    context 'when the env proxy is ignored' do
+      around do |example|
+        with_env_proxy_disabled(&example)
+      end
+
+      include_examples 'proxy examples'
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: faraday
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - "@technoweenie"
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-17 00:00:00.000000000 Z
+date: 2020-12-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multipart-post
@@ -81,6 +81,7 @@ files:
 - lib/faraday/error.rb
 - lib/faraday/file_part.rb
 - lib/faraday/logging/formatter.rb
+- lib/faraday/methods.rb
 - lib/faraday/middleware.rb
 - lib/faraday/middleware_registry.rb
 - lib/faraday/options.rb
@@ -106,6 +107,7 @@ files:
 - lib/faraday/utils.rb
 - lib/faraday/utils/headers.rb
 - lib/faraday/utils/params_hash.rb
+- lib/faraday/version.rb
 - spec/external_adapters/faraday_specs_setup.rb
 - spec/faraday/adapter/em_http_spec.rb
 - spec/faraday/adapter/em_synchrony_spec.rb
@@ -157,7 +159,7 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://lostisland.github.io/faraday
-  changelog_uri: https://github.com/lostisland/faraday/releases/tag/v1.1.0
+  changelog_uri: https://github.com/lostisland/faraday/releases/tag/v1.2.0
   source_code_uri: https://github.com/lostisland/faraday
   bug_tracker_uri: https://github.com/lostisland/faraday/issues
 post_install_message: