faraday 1.0.0 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9d3d650c5d465a0862cddd7ab2ed27fbfb4a6e5f2cfcbb54ba753bcc1ce9e40e
-  data.tar.gz: 953336deeb3dd2e0228368209bdffc7815b376772269c439e21374bc22b70484
+  metadata.gz: f9d5c03389960019760f7f65d5546b799c93d2fcc810ed26c3c6a859a0716586
+  data.tar.gz: faf33941683ee46c907dad01243f5be4ca60fe46336bbfcf9e534afa7bfc74e3
 SHA512:
-  metadata.gz: b80c084a8714d995dec61c918891a63720dbcdddf2eb3ecb7106f40a03bb341c4f03ffe976365c5450b2dcffd0b1f52c1cd4320ea24591dfaef7d5fdbbe12562
-  data.tar.gz: 67f8134fae885d3bb2e621afa701d6d535409bbb0141ad699f4d290059d61bf856915f622e214251f05e8b893a69bf68439118074712a22e75e3705b249dbb85
+  metadata.gz: 67bea3c978d5e531a47513b81f56f144ccd696ee0adf67ea14b2198ed29ea809cf0dd1223c400feef67688af10db8b9a8abd239cb284c111300a420190aef9a4
+  data.tar.gz: a520bc7078beb472b43f963921040230ab29d14b7df138a85bc3fce77f1cbfc5c74f2d41a380ad9821b7d0cffa9f3d3c03448a258ecaa7c6dfbb993df02ac3e9

data/CHANGELOG.md

@@ -1,5 +1,109 @@
 # 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
+
+* 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/LICENSE.md

@@ -1,4 +1,4 @@
-Copyright (c) 2009-2019 Rick Olson, Zack Hobson
+Copyright (c) 2009-2020 Rick Olson, Zack Hobson
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,8 +1,7 @@
-# ![Faraday](./docs/assets/img/repo-card-slim.png)
+# [![Faraday](./docs/assets/img/repo-card-slim.png)][website]
 
 [![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)
-[![Test Coverage](https://api.codeclimate.com/v1/badges/f869daab091ceef1da73/test_coverage)](https://codeclimate.com/github/lostisland/faraday/test_coverage)
+[![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)
 
@@ -43,12 +42,12 @@ Open the issues page and check for the `help wanted` label!
 But before you start coding, please read our [Contributing Guide][contributing]
 
 ## Copyright
-© 2009 - 2019, the [Faraday Team][faraday_team]. Website and branding design by [Elena Lo Piccolo](https://elelopic.design).
+© 2009 - 2020, the [Faraday Team][faraday_team]. Website and branding design by [Elena Lo Piccolo](https://elelopic.design).
 
 [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/examples/client_spec.rb

@@ -19,7 +19,7 @@ class Client
   end
 end
 
-Rspec.describe Client do
+RSpec.describe Client do
   let(:stubs)  { Faraday::Adapter::Test::Stubs.new }
   let(:conn)   { Faraday.new { |b| b.adapter(:test, stubs) } }
   let(:client) { Client.new(conn) }

data/lib/faraday.rb

@@ -1,11 +1,34 @@
 # 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'
+  ::Faraday::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'
+
+require 'faraday/net_http'
+
 # This is the main namespace for Faraday.
 #
 # It provides methods to create {Connection} objects, and HTTP-related
@@ -19,10 +42,6 @@ require 'faraday/dependency_loader'
 #   conn.get '/'
 #
 module Faraday
-  VERSION = '1.0.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 +126,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 +172,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 const_defined? :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.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'
@@ -27,6 +26,7 @@ module Faraday
     # This module marks an Adapter as supporting parallel requests.
     module Parallelism
       attr_writer :supports_parallel
+
       def supports_parallel?
         @supports_parallel
       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
 
@@ -142,7 +156,8 @@ module Faraday
 
         raise Faraday::ConnectionFailed, e
       rescue StandardError => e
-        if defined?(OpenSSL) && e.is_a?(OpenSSL::SSL::SSLError)
+        if defined?(::OpenSSL::SSL::SSLError) && \
+           e.is_a?(::OpenSSL::SSL::SSLError)
           raise Faraday::SSLError, e
         end
 
@@ -230,7 +245,7 @@ module Faraday
 
         def add(&block)
           if running?
-            perform_request { yield }
+            perform_request(&block)
           else
             @registered_procs << block
           end
@@ -272,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/excon.rb

@@ -34,9 +34,9 @@ module Faraday
 
         @app.call(env)
       rescue ::Excon::Errors::SocketError => e
-        raise Faraday::TimeoutError, e if e.message =~ /\btimeout\b/
+        raise Faraday::TimeoutError, e if e.message.match?(/\btimeout\b/)
 
-        raise Faraday::SSLError, e if e.message =~ /\bcertificate\b/
+        raise Faraday::SSLError, e if e.message.match?(/\bcertificate\b/)
 
         raise Faraday::ConnectionFailed, e
       rescue ::Excon::Errors::Timeout => e

data/lib/faraday/adapter/httpclient.rb

@@ -66,7 +66,8 @@ module Faraday
       rescue Errno::EADDRNOTAVAIL, Errno::ECONNREFUSED, IOError, SocketError
         raise Faraday::ConnectionFailed, $ERROR_INFO
       rescue StandardError => e
-        if defined?(OpenSSL) && e.is_a?(OpenSSL::SSL::SSLError)
+        if defined?(::OpenSSL::SSL::SSLError) && \
+           e.is_a?(::OpenSSL::SSL::SSLError)
           raise Faraday::SSLError, e
         end
 

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/adapter/typhoeus.rb

@@ -3,7 +3,7 @@
 module Faraday
   class Adapter
     # Typhoeus adapter. This class is just a stub, the real adapter is in
-    # https://github.com/philsturgeon/typhoeus/blob/master/lib/typhoeus/adapters/faraday.rb
+    # https://github.com/typhoeus/typhoeus/blob/master/lib/typhoeus/adapters/faraday.rb
     class Typhoeus < Faraday::Adapter
       # Needs to define this method in order to support Typhoeus <= 1.3.0
       def call; end