faraday 0.17.3 → 1.0.0.pre.rc1

data/lib/faraday/utils/headers.rb

@@ -0,0 +1,139 @@
+# frozen_string_literal: true
+
+module Faraday
+  module Utils
+    # A case-insensitive Hash that preserves the original case of a header
+    # when set.
+    #
+    # Adapted from Rack::Utils::HeaderHash
+    class Headers < ::Hash
+      def self.from(value)
+        new(value)
+      end
+
+      def self.allocate
+        new_self = super
+        new_self.initialize_names
+        new_self
+      end
+
+      def initialize(hash = nil)
+        super()
+        @names = {}
+        update(hash || {})
+      end
+
+      def initialize_names
+        @names = {}
+      end
+
+      # on dup/clone, we need to duplicate @names hash
+      def initialize_copy(other)
+        super
+        @names = other.names.dup
+      end
+
+      # need to synchronize concurrent writes to the shared KeyMap
+      keymap_mutex = Mutex.new
+
+      # symbol -> string mapper + cache
+      KeyMap = Hash.new do |map, key|
+        value = if key.respond_to?(:to_str)
+                  key
+                else
+                  key.to_s.split('_') # user_agent: %w(user agent)
+                     .each(&:capitalize!) # => %w(User Agent)
+                     .join('-') # => "User-Agent"
+                end
+        keymap_mutex.synchronize { map[key] = value }
+      end
+      KeyMap[:etag] = 'ETag'
+
+      def [](key)
+        key = KeyMap[key]
+        super(key) || super(@names[key.downcase])
+      end
+
+      def []=(key, val)
+        key = KeyMap[key]
+        key = (@names[key.downcase] ||= key)
+        # join multiple values with a comma
+        val = val.to_ary.join(', ') if val.respond_to?(:to_ary)
+        super(key, val)
+      end
+
+      def fetch(key, *args, &block)
+        key = KeyMap[key]
+        key = @names.fetch(key.downcase, key)
+        super(key, *args, &block)
+      end
+
+      def delete(key)
+        key = KeyMap[key]
+        key = @names[key.downcase]
+        return unless key
+
+        @names.delete key.downcase
+        super(key)
+      end
+
+      def include?(key)
+        @names.include? key.downcase
+      end
+
+      alias has_key? include?
+      alias member? include?
+      alias key? include?
+
+      def merge!(other)
+        other.each { |k, v| self[k] = v }
+        self
+      end
+
+      alias update merge!
+
+      def merge(other)
+        hash = dup
+        hash.merge! other
+      end
+
+      def replace(other)
+        clear
+        @names.clear
+        update other
+        self
+      end
+
+      def to_hash
+        ::Hash.new.update(self)
+      end
+
+      def parse(header_string)
+        return unless header_string && !header_string.empty?
+
+        headers = header_string.split(/\r\n/)
+
+        # Find the last set of response headers.
+        start_index = headers.rindex { |x| x.match(%r{^HTTP/}) } || 0
+        last_response = headers.slice(start_index, headers.size)
+
+        last_response
+          .tap { |a| a.shift if a.first.start_with?('HTTP/') }
+          .map { |h| h.split(/:\s*/, 2) } # split key and value
+          .reject { |p| p[0].nil? } # ignore blank lines
+          .each { |key, value| add_parsed(key, value) }
+      end
+
+      protected
+
+      attr_reader :names
+
+      private
+
+      # Join multiple values with a comma.
+      def add_parsed(key, value)
+        self[key] ? self[key] << ', ' << value : self[key] = value
+      end
+    end
+  end
+end

data/lib/faraday/utils/params_hash.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module Faraday
+  module Utils
+    # A hash with stringified keys.
+    class ParamsHash < Hash
+      def [](key)
+        super(convert_key(key))
+      end
+
+      def []=(key, value)
+        super(convert_key(key), value)
+      end
+
+      def delete(key)
+        super(convert_key(key))
+      end
+
+      def include?(key)
+        super(convert_key(key))
+      end
+
+      alias has_key? include?
+      alias member? include?
+      alias key? include?
+
+      def update(params)
+        params.each do |key, value|
+          self[key] = value
+        end
+        self
+      end
+      alias merge! update
+
+      def merge(params)
+        dup.update(params)
+      end
+
+      def replace(other)
+        clear
+        update(other)
+      end
+
+      def merge_query(query, encoder = nil)
+        return self unless query && !query.empty?
+
+        update((encoder || Utils.default_params_encoder).decode(query))
+      end
+
+      def to_query(encoder = nil)
+        (encoder || Utils.default_params_encoder).encode(self)
+      end
+
+      private
+
+      def convert_key(key)
+        key.to_s
+      end
+    end
+  end
+end

data/spec/external_adapters/faraday_specs_setup.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'webmock/rspec'
+WebMock.disable_net_connect!(allow_localhost: true)
+
+require_relative '../support/helper_methods'
+require_relative '../support/disabling_stub'
+require_relative '../support/streaming_response_checker'
+require_relative '../support/shared_examples/adapter'
+require_relative '../support/shared_examples/request_method'
+
+RSpec.configure do |config|
+  config.include Faraday::HelperMethods
+end

metadata

@@ -1,16 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: faraday
 version: !ruby/object:Gem::Version
-  version: 0.17.3
+  version: 1.0.0.pre.rc1
 platform: ruby
 authors:
-- "@technoweenie"
-- "@iMacTia"
-- "@olleolleolle"
+- Rick Olson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-31 00:00:00.000000000 Z
+date: 2019-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multipart-post
@@ -38,10 +36,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- CHANGELOG.md
 - LICENSE.md
 - README.md
-- Rakefile
 - lib/faraday.rb
 - lib/faraday/adapter.rb
 - lib/faraday/adapter/em_http.rb
@@ -56,12 +52,22 @@ files:
 - lib/faraday/adapter/rack.rb
 - lib/faraday/adapter/test.rb
 - lib/faraday/adapter/typhoeus.rb
+- lib/faraday/adapter_registry.rb
 - lib/faraday/autoload.rb
 - lib/faraday/connection.rb
-- lib/faraday/deprecate.rb
+- lib/faraday/dependency_loader.rb
+- lib/faraday/encoders/flat_params_encoder.rb
+- lib/faraday/encoders/nested_params_encoder.rb
 - lib/faraday/error.rb
+- lib/faraday/logging/formatter.rb
 - lib/faraday/middleware.rb
+- lib/faraday/middleware_registry.rb
 - lib/faraday/options.rb
+- lib/faraday/options/connection_options.rb
+- lib/faraday/options/env.rb
+- lib/faraday/options/proxy_options.rb
+- lib/faraday/options/request_options.rb
+- lib/faraday/options/ssl_options.rb
 - lib/faraday/parameters.rb
 - lib/faraday/rack_builder.rb
 - lib/faraday/request.rb
@@ -77,63 +83,31 @@ files:
 - lib/faraday/response/raise_error.rb
 - lib/faraday/upload_io.rb
 - lib/faraday/utils.rb
-- spec/faraday/deprecate_spec.rb
-- spec/faraday/error_spec.rb
-- spec/faraday/response/raise_error_spec.rb
-- spec/spec_helper.rb
-- test/adapters/default_test.rb
-- test/adapters/em_http_test.rb
-- test/adapters/em_synchrony_test.rb
-- test/adapters/excon_test.rb
-- test/adapters/httpclient_test.rb
-- test/adapters/integration.rb
-- test/adapters/logger_test.rb
-- test/adapters/net_http_persistent_test.rb
-- test/adapters/net_http_test.rb
-- test/adapters/patron_test.rb
-- test/adapters/rack_test.rb
-- test/adapters/test_middleware_test.rb
-- test/adapters/typhoeus_test.rb
-- test/authentication_middleware_test.rb
-- test/composite_read_io_test.rb
-- test/connection_test.rb
-- test/env_test.rb
-- test/helper.rb
-- test/live_server.rb
-- test/middleware/instrumentation_test.rb
-- test/middleware/retry_test.rb
-- test/middleware_stack_test.rb
-- test/multibyte.txt
-- test/options_test.rb
-- test/parameters_test.rb
-- test/request_middleware_test.rb
-- test/response_middleware_test.rb
-- test/strawberry.rb
-- test/utils_test.rb
-homepage: https://lostisland.github.io/faraday
+- lib/faraday/utils/headers.rb
+- lib/faraday/utils/params_hash.rb
+- spec/external_adapters/faraday_specs_setup.rb
+homepage: https://github.com/lostisland/faraday
 licenses:
 - MIT
-metadata:
-  homepage_uri: https://lostisland.github.io/faraday
-  changelog_uri: https://github.com/lostisland/faraday/blob/master/CHANGELOG.md
-  source_code_uri: https://github.com/lostisland/faraday/
-  bug_tracker_uri: https://github.com/lostisland/faraday/issues
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
+- spec/external_adapters
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '1.9'
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubygems_version: 3.1.2
+rubyforge_project: 
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: HTTP/REST API client library.

data/CHANGELOG.md

@@ -1,232 +0,0 @@
-# Faraday Changelog
-
-## v0.17.3
-
-Fixes:
-
-* Reverts changes in error classes hierarchy. #1092 (@iMacTia)
-* Fix Ruby 1.9 syntax errors and improve Error class testing #1094 (@BanzaiMan,
-  @mrexox, @technoweenie)
-
-Misc:
-
-* Stops using `&Proc.new` for block forwarding. #1083 (@olleolleolle)
-* Update CI to test against ruby 2.0-2.7 #1087, #1099 (@iMacTia, @olleolleolle,
-  @technoweenie)
-* require FARADAY_DEPRECATE=warn to show Faraday v1.0 deprecation warnings
-  #1098 (@technoweenie)
-
-## v0.17.1
-
-Final release before Faraday v1.0, with important fixes for Ruby 2.7.
-
-Fixes:
-
-* RaiseError response middleware raises exception if HTTP client returns a nil
-  status. #1042 (@jonnyom, @BobbyMcWho)
-
-Misc:
-
-* Fix Ruby 2.7 warnings (#1009)
-* Add `Faraday::Deprecate` to warn about upcoming v1.0 changes. (#1054, #1059,
-    #1076, #1077)
-* Add release notes up to current in CHANGELOG.md (#1066)
-* Port minimal rspec suite from main branch to run backported tests. (#1058)
-
-## v0.17.0
-
-This release is the same as v0.15.4. It was pushed to cover up releases
-v0.16.0-v0.16.2.
-
-## v0.15.4
-
-* Expose `pool_size` as a option for the NetHttpPersistent adapter (#834)
-
-## v0.15.3
-
-* Make Faraday::Request serialisable with Marshal. (#803)
-* Add DEFAULT_EXCEPTIONS constant to Request::Retry (#814)
-* Add support for Ruby 2.6 Net::HTTP write_timeout (#824)
-
-## v0.15.2
-
-* Prevents `Net::HTTP` adapters to retry request internally by setting `max_retries` to 0 if available (Ruby 2.5+). (#799)
-* Fixes `NestedParamsEncoder` handling of empty array values (#801)
-
-## v0.15.1
-
-* NetHttpPersistent adapter better reuse of SSL connections (#793)
-* Refactor: inline cached_connection (#797)
-* Logger middleware: use $stdout instead of STDOUT (#794)
-* Fix: do not memoize/reuse Patron session (#796)
-
-Also in this release:
-
-* Allow setting min/max ssl version for Net::HTTP (#792)
-* Allow setting min/max ssl version for Excon (#795)
-
-## v0.15.0
-
-Features:
-
-* Added retry block option to retry middleware. (#770)
-* Retry middleware improvements (honour Retry-After header, retry statuses) (#773)
-* Improve response logger middleware output (#784)
-
-Fixes:
-
-* Remove unused class error (#767)
-* Fix minor typo in README (#760)
-* Reuse persistent connections when using net-http-persistent (#778)
-* Fix Retry middleware documentation (#781)
-* Returns the http response when giving up on retrying by status (#783)
-
-## v0.14.0
-
-Features:
-
-* Allow overriding env proxy (#754)
-* Remove legacy Typhoeus adapter (#715)
-* External Typhoeus Adapter Compatibility (#748)
-* Warn about missing adapter when making a request (#743)
-* Faraday::Adapter::Test stubs now support entire urls (with host) (#741)
-
-Fixes:
-
-* If proxy is manually provided, this takes priority over `find_proxy` (#724)
-* Fixes the behaviour for Excon's open_timeout (not setting write_timeout anymore) (#731)
-* Handle all connection timeout messages in Patron (#687)
-
-## v0.13.1
-
-* Fixes an incompatibility with Addressable::URI being used as uri_parser
-
-## v0.13.0
-
-Features:
-
-* Dynamically reloads the proxy when performing a request on an absolute domain (#701)
-* Adapter support for Net::HTTP::Persistent v3.0.0 (#619)
-
-Fixes:
-
-* Prefer #hostname over #host. (#714)
-* Fixes an edge-case issue with response headers parsing (missing HTTP header) (#719)
-
-## v0.12.2
-
-* Parse headers from aggregated proxy requests/responses (#681)
-* Guard against invalid middleware configuration with warning (#685)
-* Do not use :insecure option by default in Patron (#691)
-* Fixes an issue with HTTPClient not raising a `Faraday::ConnectionFailed` (#702)
-* Fixes YAML serialization/deserialization for `Faraday::Utils::Headers` (#690)
-* Fixes an issue with Options having a nil value (#694)
-* Fixes an issue with Faraday.default_connection not using Faraday.default_connection_options (#698)
-* Fixes an issue with Options.merge! and Faraday instrumentation middleware (#710)
-
-## v0.12.1
-
-* Fix an issue with Patron tests failing on jruby
-* Fix an issue with new `rewind_files` feature that was causing an exception when the body was not an Hash
-* Expose wrapped_exception in all client errors
-* Add Authentication Section to the ReadMe
-
-## v0.12.0.1
-
-* Hotfix release to address an issue with TravisCI deploy on Rubygems
-
-## v0.12.0
-
-Features:
-
-* Proxy feature now relies on Ruby `URI::Generic#find_proxy` and can use `no_proxy` ENV variable (not compatible with ruby < 2.0)
-* Adds support for `context` request option to pass arbitrary information to middlewares
-
-Fixes:
-
-* Fix an issue with options that was causing new options to override defaults ones unexpectedly
-* Rewind `UploadIO`s on retry to fix a compatibility issue
-* Make multipart boundary unique
-* Improvements in `README.md`
-
-## v0.11.0
-
-Features:
-
-* Add `filter` method to Logger middleware
-* Add support for Ruby2.4 and Minitest 6
-* Introduce block syntax to customise the adapter
-
-Fixes:
-
-* Fix an issue that was allowing to override `default_connection_options` from a connection instance
-* Fix a bug that was causing newline escape characters ("\n") to be used when building the Authorization header
-
-## v0.10.1
-
-- Fix an issue with HTTPClient adapter that was causing the SSL to be reset on every request
-- Rescue `IOError` instead of specific subclass
-- `Faraday::Utils::Headers` can now be successfully serialised in YAML
-- Handle `default_connection_options` set with hash
-
-## v0.10.0
-
-Breaking changes:
-- Drop support for Ruby 1.8
-
-Features:
-- Include wrapped exception/reponse in ClientErrors
-- Add `response.reason_phrase`
-- Provide option to selectively skip logging request/response headers
-- Add regex support for pattern matching in `test` adapter
-
-Fixes:
-- Add `Faraday.respond_to?` to find methods managed by `method_missing`
-- em-http: `request.host` instead of `connection.host` should be taken for SSL validations
-- Allow `default_connection_options` to be merged when options are passed as url parameter
-- Improve splitting key-value pairs in raw HTTP headers
-
-## v0.9.2
-
-Adapters:
-- Enable gzip compression for httpclient
-- Fixes default certificate store for httpclient not having default paths.
-- Make excon adapter compatible with 0.44 excon version
-- Add compatibility with Patron 0.4.20
-- Determine default port numbers in Net::HTTP adapters (Addressable compatibility)
-- em-http: wrap "connection closed by server" as ConnectionFailed type
-- Wrap Errno::ETIMEDOUT in Faraday::Error::TimeoutError
-
-Utils:
-- Add Rack-compatible support for parsing `a[][b]=c` nested queries
-- Encode nil values in queries different than empty strings. Before: `a=`; now: `a`.
-- Have `Faraday::Utils::Headers#replace` clear internal key cache
-- Dup the internal key cache when a Headers hash is copied
-
-Env and middleware:
-- Ensure `env` stored on middleware response has reference to the response
-- Ensure that Response properties are initialized during `on_complete` (VCR compatibility)
-- Copy request options in Faraday::Connection#dup
-- Env custom members should be copied by Env.from(env)
-- Honour per-request `request.options.params_encoder`
-- Fix `interval_randomness` data type for Retry middleware
-- Add maximum interval option for Retry middleware
-
-## v0.9.1
-
-* Refactor Net:HTTP adapter so that with_net_http_connection can be overridden to allow pooled connections. (@Ben-M)
-* Add configurable methods that bypass `retry_if` in the Retry request middleware.  (@mike-bourgeous)
-
-## v0.9.0
-
-* Add HTTPClient adapter (@hakanensari)
-* Improve Retry handler (@mislav)
-* Remove autoloading by default (@technoweenie)
-* Improve internal docs (@technoweenie, @mislav)
-* Respect user/password in http proxy string (@mislav)
-* Adapter options are structs.  Reinforces consistent options across adapters
-  (@technoweenie)
-* Stop stripping trailing / off base URLs in a Faraday::Connection. (@technoweenie)
-* Add a configurable URI parser. (@technoweenie)
-* Remove need to manually autoload when using the authorization header helpers on `Faraday::Connection`. (@technoweenie)
-* `Faraday::Adapter::Test` respects the `Faraday::RequestOptions#params_encoder` option. (@technoweenie)