faraday 1.3.0 → 1.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f907e999805c78e8c2e77cb4d6b29a0a6f8fd8fe1a7df9930f02be7ec113a630
-  data.tar.gz: 1ceac7f2b44d41d11d1ad3f7642daea9198ba3ac2f71a4932cf7d6b7b867f704
+  metadata.gz: 78d94069f3e1d41648f0b2c82872d305bf2c829667526d2c95f39f3a2609792e
+  data.tar.gz: 91e952182291cfc3311db77776811323980e00008966c8000259161c7a7e5294
 SHA512:
-  metadata.gz: 2eaf54d743ed3d7554fb2be17003e81b08c060582f140b06fb55e8aceb7dfcf2428e898f47f3760eddcdb4ad64aeaacc93916672b9ed10fa4a004d0ea1a20e1a
-  data.tar.gz: a700f0bc8999e9a0152843bbfbd23001fa23931614ae9573b13ff839e7af01f38ca2adbb01c82e4b387688496b3caff87357e3946d7500595a2f807313e177d7
+  metadata.gz: cfa2dc1f4c6d8a869f381a59c80babeadeb83b5201078eac30560f7b7bc6940464625c264db0c7ea2486d461edb6b197b07d37bf7b7bf7e517ff546332f1106e
+  data.tar.gz: bd4677f959813e83cb7f3f38369293ffd153b674c5dee1e45c8fe32e7796a84f047304e72c6b3b43fb90051ed91fd491bf5fb68344c729c07589eaf3b7513b2b

data/CHANGELOG.md

@@ -1,5 +1,35 @@
 # Faraday Changelog
 
+## [v1.3.0](https://github.com/lostisland/faraday/releases/tag/v1.3.0) (2020-12-31)
+
+### Highlights
+Faraday v1.3.0 is the first release to officially support Ruby 3.0 in the CI pipeline 🎉 🍾! 
+
+This is also the first release with a previously "included" adapter (Net::HTTP) being isolated into a [separate gem](https://github.com/lostisland/faraday-net_http) 🎊!
+The new adapter is added to Faraday as a dependency for now, so that means full backwards-compatibility, but just to be safe be careful when upgrading!
+
+This is a huge step towards are Faraday v2.0 objective of pushing adapters and middleware into separate gems.
+Many thanks to the Faraday Team, @JanDintel and everyone who attended the [ROSS Conf remote event](https://www.rossconf.io/event/remote/)
+
+### Features
+
+* Improves consistency with Faraday::Error and Faraday::RaiseError (#1229, @qsona, @iMacTia)
+
+### Fixes
+
+* Don't assign to global ::Timer (#1227, @bpo)
+
+### Documentation
+
+* CHANGELOG: add releases after 1.0 (#1225, @olleolleolle)
+* Improves retry middleware documentation. (#1228, @iMacTia)
+
+### Misc
+
+* Move out Net::HTTP adapter (#1222, @JanDintel, @iMacTia)
+* Adds Ruby 3.0 to CI Matrix (#1226, @iMacTia)
+
+
 ## [v1.2.0](https://github.com/lostisland/faraday/releases/tag/v1.2.0) (2020-12-23)
 
 ### Features

data/README.md

@@ -2,7 +2,6 @@
 
 [![Gem Version](https://badge.fury.io/rb/faraday.svg)](https://rubygems.org/gems/faraday)
 [![GitHub Actions CI](https://github.com/lostisland/faraday/workflows/CI/badge.svg)](https://github.com/lostisland/faraday/actions?query=workflow%3ACI)
-[![Maintainability](https://api.codeclimate.com/v1/badges/f869daab091ceef1da73/maintainability)](https://codeclimate.com/github/lostisland/faraday/maintainability)
 [![Gitter](https://badges.gitter.im/lostisland/faraday.svg)](https://gitter.im/lostisland/faraday?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
 
 
@@ -47,7 +46,7 @@ But before you start coding, please read our [Contributing Guide][contributing]
 [website]:      https://lostisland.github.io/faraday
 [faraday_team]: https://lostisland.github.io/faraday/team
 [contributing]: https://github.com/lostisland/faraday/blob/master/.github/CONTRIBUTING.md
-[apidoc]:       http://www.rubydoc.info/gems/faraday
+[apidoc]:       https://www.rubydoc.info/github/lostisland/faraday
 [actions]:      https://github.com/lostisland/faraday/actions
 [jruby]:        http://jruby.org/
 [rubinius]:     http://rubini.us/

data/lib/faraday.rb

@@ -28,6 +28,8 @@ require 'faraday/file_part'
 require 'faraday/param_part'
 
 require 'faraday/net_http'
+require 'faraday/net_http_persistent'
+require 'faraday/excon'
 
 # This is the main namespace for Faraday.
 #

data/lib/faraday/adapter.rb

@@ -11,15 +11,10 @@ module Faraday
 
     register_middleware File.expand_path('adapter', __dir__),
                         test: [:Test, 'test'],
-                        net_http_persistent: [
-                          :NetHttpPersistent,
-                          'net_http_persistent'
-                        ],
                         typhoeus: [:Typhoeus, 'typhoeus'],
                         patron: [:Patron, 'patron'],
                         em_synchrony: [:EMSynchrony, 'em_synchrony'],
                         em_http: [:EMHttp, 'em_http'],
-                        excon: [:Excon, 'excon'],
                         rack: [:Rack, 'rack'],
                         httpclient: [:HTTPClient, 'httpclient']
 

data/lib/faraday/autoload.rb

@@ -58,12 +58,10 @@ module Faraday
   class Adapter
     extend AutoloadHelper
     autoload_all 'faraday/adapter',
-                 NetHttpPersistent: 'net_http_persistent',
                  EMSynchrony: 'em_synchrony',
                  EMHttp: 'em_http',
                  Typhoeus: 'typhoeus',
                  Patron: 'patron',
-                 Excon: 'excon',
                  Test: 'test',
                  Rack: 'rack',
                  HTTPClient: 'httpclient'

data/lib/faraday/connection.rb

@@ -522,6 +522,7 @@ module Faraday
         base = base.dup
         base.path = "#{base.path}/" # ensure trailing slash
       end
+      url = url && URI.parse(url.to_s).opaque ? url.to_s.gsub(':', '%3A') : url
       uri = url ? base + url : base
       if params
         uri.query = params.to_query(params_encoder || options.params_encoder)
@@ -576,7 +577,7 @@ module Faraday
         case url
         when String
           uri = Utils.URI(url)
-          uri = URI.parse("#{uri.scheme}://#{uri.hostname}").find_proxy
+          uri = URI.parse("#{uri.scheme}://#{uri.host}").find_proxy
         when URI
           uri = url.find_proxy
         when nil

data/lib/faraday/version.rb

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

data/spec/faraday/connection_spec.rb

@@ -18,6 +18,13 @@ shared_examples 'initializer with url' do
     it { expect(subject.path_prefix).to eq('/fish') }
     it { expect(subject.params).to eq('a' => '1') }
   end
+
+  context 'with IPv6 address' do
+    let(:address) { 'http://[::1]:85/' }
+
+    it { expect(subject.host).to eq('[::1]') }
+    it { expect(subject.port).to eq(85) }
+  end
 end
 
 shared_examples 'default connection options' do
@@ -270,6 +277,29 @@ RSpec.describe Faraday::Connection do
         expect(uri.to_s).to eq('http://sushi.com/sake/')
       end
     end
+
+    context 'with colon in path' do
+      let(:url) { 'http://service.com' }
+
+      it 'joins url to base when used absolute path' do
+        conn = Faraday.new(url: url)
+        uri = conn.build_exclusive_url('/service:search?limit=400')
+        expect(uri.to_s).to eq('http://service.com/service:search?limit=400')
+      end
+
+      it 'joins url to base when used relative path' do
+        conn = Faraday.new(url: url)
+        uri = conn.build_exclusive_url('service:search?limit=400')
+        expect(uri.to_s).to eq('http://service.com/service%3Asearch?limit=400')
+      end
+
+      it 'joins url to base when used with path prefix' do
+        conn = Faraday.new(url: url)
+        conn.path_prefix = '/api'
+        uri = conn.build_exclusive_url('service:search?limit=400')
+        expect(uri.to_s).to eq('http://service.com/api/service%3Asearch?limit=400')
+      end
+    end
   end
 
   describe '#build_url' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: faraday
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.1
 platform: ruby
 authors:
 - "@technoweenie"
@@ -10,8 +10,22 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-12-31 00:00:00.000000000 Z
+date: 2021-04-18 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday-excon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: faraday-net_http
   requirement: !ruby/object:Gem::Requirement
@@ -26,6 +40,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: faraday-net_http_persistent
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: multipart-post
   requirement: !ruby/object:Gem::Requirement
@@ -52,14 +80,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.0.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.0.4
 description: 
 email: technoweenie@gmail.com
 executables: []
@@ -78,9 +106,7 @@ files:
 - lib/faraday/adapter/em_http_ssl_patch.rb
 - lib/faraday/adapter/em_synchrony.rb
 - lib/faraday/adapter/em_synchrony/parallel_manager.rb
-- lib/faraday/adapter/excon.rb
 - lib/faraday/adapter/httpclient.rb
-- lib/faraday/adapter/net_http_persistent.rb
 - lib/faraday/adapter/patron.rb
 - lib/faraday/adapter/rack.rb
 - lib/faraday/adapter/test.rb
@@ -126,7 +152,6 @@ files:
 - spec/faraday/adapter/em_synchrony_spec.rb
 - spec/faraday/adapter/excon_spec.rb
 - spec/faraday/adapter/httpclient_spec.rb
-- spec/faraday/adapter/net_http_persistent_spec.rb
 - spec/faraday/adapter/net_http_spec.rb
 - spec/faraday/adapter/patron_spec.rb
 - spec/faraday/adapter/rack_spec.rb
@@ -172,7 +197,7 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://lostisland.github.io/faraday
-  changelog_uri: https://github.com/lostisland/faraday/releases/tag/v1.3.0
+  changelog_uri: https://github.com/lostisland/faraday/releases/tag/v1.4.1
   source_code_uri: https://github.com/lostisland/faraday
   bug_tracker_uri: https://github.com/lostisland/faraday/issues
 post_install_message: 
@@ -191,7 +216,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.3.1
 signing_key: 
 specification_version: 4
 summary: HTTP/REST API client library.

data/lib/faraday/adapter/excon.rb

@@ -1,124 +0,0 @@
-# frozen_string_literal: true
-
-module Faraday
-  class Adapter
-    # Excon adapter.
-    class Excon < Faraday::Adapter
-      dependency 'excon'
-
-      def build_connection(env)
-        opts = opts_from_env(env)
-        ::Excon.new(env[:url].to_s, opts.merge(@connection_options))
-      end
-
-      def call(env)
-        super
-
-        req_opts = {
-          method: env[:method].to_s.upcase,
-          headers: env[:request_headers],
-          body: read_body(env)
-        }
-
-        req = env[:request]
-        if req&.stream_response?
-          total = 0
-          req_opts[:response_block] = lambda do |chunk, _remain, _total|
-            req.on_data.call(chunk, total += chunk.size)
-          end
-        end
-
-        resp = connection(env) { |http| http.request(req_opts) }
-        save_response(env, resp.status.to_i, resp.body, resp.headers,
-                      resp.reason_phrase)
-
-        @app.call(env)
-      rescue ::Excon::Errors::SocketError => e
-        raise Faraday::TimeoutError, e if e.message.match?(/\btimeout\b/)
-
-        raise Faraday::SSLError, e if e.message.match?(/\bcertificate\b/)
-
-        raise Faraday::ConnectionFailed, e
-      rescue ::Excon::Errors::Timeout => e
-        raise Faraday::TimeoutError, e
-      end
-
-      # TODO: support streaming requests
-      def read_body(env)
-        env[:body].respond_to?(:read) ? env[:body].read : env[:body]
-      end
-
-      private
-
-      def opts_from_env(env)
-        opts = {}
-        amend_opts_with_ssl!(opts, env[:ssl]) if needs_ssl_settings?(env)
-
-        if (req = env[:request])
-          amend_opts_with_timeouts!(opts, req)
-          amend_opts_with_proxy_settings!(opts, req)
-        end
-
-        opts
-      end
-
-      def needs_ssl_settings?(env)
-        env[:url].scheme == 'https' && env[:ssl]
-      end
-
-      OPTS_KEYS = [
-        %i[client_cert client_cert],
-        %i[client_key client_key],
-        %i[certificate certificate],
-        %i[private_key private_key],
-        %i[ssl_ca_path ca_path],
-        %i[ssl_ca_file ca_file],
-        %i[ssl_version version],
-        %i[ssl_min_version min_version],
-        %i[ssl_max_version max_version]
-      ].freeze
-
-      def amend_opts_with_ssl!(opts, ssl)
-        opts[:ssl_verify_peer] = !!ssl.fetch(:verify, true)
-        # https://github.com/geemus/excon/issues/106
-        # https://github.com/jruby/jruby-ossl/issues/19
-        opts[:nonblock] = false
-
-        OPTS_KEYS.each do |(key_in_opts, key_in_ssl)|
-          next unless ssl[key_in_ssl]
-
-          opts[key_in_opts] = ssl[key_in_ssl]
-        end
-      end
-
-      def amend_opts_with_timeouts!(opts, req)
-        if (sec = request_timeout(:read, req))
-          opts[:read_timeout] = sec
-        end
-
-        if (sec = request_timeout(:write, req))
-          opts[:write_timeout] = sec
-        end
-
-        return unless (sec = request_timeout(:open, req))
-
-        opts[:connect_timeout] = sec
-      end
-
-      def amend_opts_with_proxy_settings!(opts, req)
-        opts[:proxy] = proxy_settings_for_opts(req[:proxy]) if req[:proxy]
-      end
-
-      def proxy_settings_for_opts(proxy)
-        {
-          host: proxy[:uri].host,
-          hostname: proxy[:uri].hostname,
-          port: proxy[:uri].port,
-          scheme: proxy[:uri].scheme,
-          user: proxy[:user],
-          password: proxy[:password]
-        }
-      end
-    end
-  end
-end

data/lib/faraday/adapter/net_http_persistent.rb

@@ -1,91 +0,0 @@
-# frozen_string_literal: true
-
-module Faraday
-  class Adapter
-    # Net::HTTP::Persistent adapter.
-    class NetHttpPersistent < NetHttp
-      dependency 'net/http/persistent'
-
-      private
-
-      def net_http_connection(env)
-        @cached_connection ||=
-          if Net::HTTP::Persistent.instance_method(:initialize)
-                                  .parameters.first == %i[key name]
-            options = { name: 'Faraday' }
-            if @connection_options.key?(:pool_size)
-              options[:pool_size] = @connection_options[:pool_size]
-            end
-            Net::HTTP::Persistent.new(**options)
-          else
-            Net::HTTP::Persistent.new('Faraday')
-          end
-
-        proxy_uri = proxy_uri(env)
-        if @cached_connection.proxy_uri != proxy_uri
-          @cached_connection.proxy = proxy_uri
-        end
-        @cached_connection
-      end
-
-      def proxy_uri(env)
-        proxy_uri = nil
-        if (proxy = env[:request][:proxy])
-          proxy_uri = if proxy[:uri].is_a?(::URI::HTTP)
-                        proxy[:uri].dup
-                      else
-                        ::URI.parse(proxy[:uri].to_s)
-                      end
-          proxy_uri.user = proxy_uri.password = nil
-          # awful patch for net-http-persistent 2.8
-          # not unescaping user/password
-          if proxy[:user]
-            (class << proxy_uri; self; end).class_eval do
-              define_method(:user) { proxy[:user] }
-              define_method(:password) { proxy[:password] }
-            end
-          end
-        end
-        proxy_uri
-      end
-
-      def perform_request(http, env)
-        http.request env[:url], create_request(env)
-      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'
-
-        if e.message.include? 'connection refused'
-          raise Faraday::ConnectionFailed, e
-        end
-
-        raise
-      end
-
-      SSL_CONFIGURATIONS = {
-        certificate: :client_cert,
-        private_key: :client_key,
-        ca_file: :ca_file,
-        ssl_version: :version,
-        min_version: :min_version,
-        max_version: :max_version
-      }.freeze
-
-      def configure_ssl(http, ssl)
-        return unless ssl
-
-        http_set(http, :verify_mode, ssl_verify_mode(ssl))
-        http_set(http, :cert_store, ssl_cert_store(ssl))
-
-        SSL_CONFIGURATIONS
-          .select { |_, key| ssl[key] }
-          .each { |target, key| http_set(http, target, ssl[key]) }
-      end
-
-      def http_set(http, attr, value)
-        http.send("#{attr}=", value) if http.send(attr) != value
-      end
-    end
-  end
-end

data/spec/faraday/adapter/net_http_persistent_spec.rb

@@ -1,57 +0,0 @@
-# frozen_string_literal: true
-
-RSpec.describe Faraday::Adapter::NetHttpPersistent do
-  features :request_body_on_query_methods, :reason_phrase_parse, :compression, :trace_method
-
-  it_behaves_like 'an adapter'
-
-  it 'allows to provide adapter specific configs' do
-    url = URI('https://example.com')
-
-    adapter = described_class.new do |http|
-      http.idle_timeout = 123
-    end
-
-    http = adapter.send(:connection, url: url, request: {})
-    adapter.send(:configure_request, http, {})
-
-    expect(http.idle_timeout).to eq(123)
-  end
-
-  it 'sets max_retries to 0' do
-    url = URI('http://example.com')
-
-    adapter = described_class.new
-
-    http = adapter.send(:connection, url: url, request: {})
-    adapter.send(:configure_request, http, {})
-
-    # `max_retries=` is only present in Ruby 2.5
-    expect(http.max_retries).to eq(0) if http.respond_to?(:max_retries=)
-  end
-
-  it 'allows to set pool_size on initialize' do
-    url = URI('https://example.com')
-
-    adapter = described_class.new(nil, pool_size: 5)
-
-    http = adapter.send(:connection, url: url, request: {})
-
-    # `pool` is only present in net_http_persistent >= 3.0
-    expect(http.pool.size).to eq(5) if http.respond_to?(:pool)
-  end
-
-  context 'min_version' do
-    it 'allows to set min_version in SSL settings' do
-      url = URI('https://example.com')
-
-      adapter = described_class.new(nil)
-
-      http = adapter.send(:connection, url: url, request: {})
-      adapter.send(:configure_ssl, http, min_version: :TLS1_2)
-
-      # `min_version` is only present in net_http_persistent >= 3.1 (UNRELEASED)
-      expect(http.min_version).to eq(:TLS1_2) if http.respond_to?(:min_version)
-    end
-  end
-end