faraday 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9d3d650c5d465a0862cddd7ab2ed27fbfb4a6e5f2cfcbb54ba753bcc1ce9e40e
-  data.tar.gz: 953336deeb3dd2e0228368209bdffc7815b376772269c439e21374bc22b70484
+  metadata.gz: 1d23ec0aefc40d23ccc4410db08092bd29e477309fb8aa6794b3c8401961de10
+  data.tar.gz: c33ca7313dcccbf148266a80aa4e12d4cba96a4feb96ecfc3e8ff50fa06756c5
 SHA512:
-  metadata.gz: b80c084a8714d995dec61c918891a63720dbcdddf2eb3ecb7106f40a03bb341c4f03ffe976365c5450b2dcffd0b1f52c1cd4320ea24591dfaef7d5fdbbe12562
-  data.tar.gz: 67f8134fae885d3bb2e621afa701d6d535409bbb0141ad699f4d290059d61bf856915f622e214251f05e8b893a69bf68439118074712a22e75e3705b249dbb85
+  metadata.gz: 8058c22dc6e78bc3d46a9c8a22c458656a1380a4aed62b31e11b9b054fc6791373dd103276fc018148daed3934a724bcb39390bbe88e2762281ff810b61b408d
+  data.tar.gz: 341f3b44148f666bb03f8e7b232fd92e26b8c34d758090e6e82f1276af29ff17d4f62bdb58871254ba48b2232ab58269c71db08df7a4b0c35c53f2c7e9bbe7e8

data/README.md

@@ -1,4 +1,4 @@
-# ![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)

data/lib/faraday.rb

@@ -19,7 +19,7 @@ require 'faraday/dependency_loader'
 #   conn.get '/'
 #
 module Faraday
-  VERSION = '1.0.0'
+  VERSION = '1.0.1'
   METHODS_WITH_QUERY = %w[get head delete trace].freeze
   METHODS_WITH_BODY = %w[post put patch].freeze
 
@@ -153,7 +153,7 @@ module Faraday
     @default_connection_options = ConnectionOptions.from(options)
   end
 
-  unless const_defined? :Timer
+  unless defined?(::Faraday::Timer)
     require 'timeout'
     Timer = Timeout
   end

data/lib/faraday/adapter/em_http.rb

@@ -142,7 +142,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
 

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.rb

@@ -30,8 +30,10 @@ module Faraday
         Zlib::GzipFile::Error
       ]
 
-      exceptions << OpenSSL::SSL::SSLError if defined?(OpenSSL)
-      exceptions << Net::OpenTimeout if defined?(Net::OpenTimeout)
+      if defined?(::OpenSSL::SSL::SSLError)
+        exceptions << ::OpenSSL::SSL::SSLError
+      end
+      exceptions << ::Net::OpenTimeout if defined?(::Net::OpenTimeout)
 
       NET_HTTP_EXCEPTIONS = exceptions.freeze
 
@@ -137,16 +139,24 @@ module Faraday
       end
 
       def request_via_get_method(http, env, &block)
-        http.get env[:url].request_uri, env[:request_headers], &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)
-        if block_given?
-          http.request create_request(env) do |response|
-            response.read_body(&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
-        else
-          http.request create_request(env)
         end
       end
 

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

data/lib/faraday/adapter_registry.rb

@@ -12,7 +12,9 @@ module Faraday
     end
 
     def get(name)
-      klass = @constants[name]
+      klass = @lock.synchronize do
+        @constants[name]
+      end
       return klass if klass
 
       Object.const_get(name).tap { |c| set(c, name) }

data/lib/faraday/request/authorization.rb

@@ -4,7 +4,9 @@ module Faraday
   class Request
     # Request middleware for the Authorization HTTP header
     class Authorization < Faraday::Middleware
-      KEY = 'Authorization' unless defined? KEY
+      unless defined?(::Faraday::Request::Authorization::KEY)
+        KEY = 'Authorization'
+      end
 
       # @param type [String, Symbol]
       # @param token [String, Symbol, Hash]

data/lib/faraday/request/multipart.rb

@@ -8,7 +8,7 @@ module Faraday
     # Middleware for supporting multi-part requests.
     class Multipart < UrlEncoded
       self.mime_type = 'multipart/form-data'
-      unless defined? DEFAULT_BOUNDARY_PREFIX
+      unless defined?(::Faraday::Request::Multipart::DEFAULT_BOUNDARY_PREFIX)
         DEFAULT_BOUNDARY_PREFIX = '-----------RubyMultipartPost'
       end
 

data/lib/faraday/request/url_encoded.rb

@@ -4,7 +4,9 @@ module Faraday
   class Request
     # Middleware for supporting urlencoded requests.
     class UrlEncoded < Faraday::Middleware
-      CONTENT_TYPE = 'Content-Type' unless defined? CONTENT_TYPE
+      unless defined?(::Faraday::Request::UrlEncoded::CONTENT_TYPE)
+        CONTENT_TYPE = 'Content-Type'
+      end
 
       class << self
         attr_accessor :mime_type

data/lib/faraday/response.rb

@@ -15,8 +15,11 @@ module Faraday
 
       # 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
       def on_complete(env)
-        env.body = parse(env.body) if respond_to?(:parse) && env.parse_body?
+        return unless respond_to?(:parse, true) && env.parse_body?
+
+        env.body = parse(env.body)
       end
     end
 

data/lib/faraday/utils.rb

@@ -16,12 +16,20 @@ module Faraday
       NestedParamsEncoder.encode(params)
     end
 
+    def default_space_encoding
+      @default_space_encoding ||= '+'
+    end
+
+    class << self
+      attr_writer :default_space_encoding
+    end
+
     ESCAPE_RE = /[^a-zA-Z0-9 .~_-]/.freeze
 
     def escape(str)
       str.to_s.gsub(ESCAPE_RE) do |match|
         '%' + match.unpack('H2' * match.bytesize).join('%').upcase
-      end.tr(' ', '+')
+      end.gsub(' ', default_space_encoding)
     end
 
     def unescape(str)

data/spec/faraday/adapter/em_http_spec.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-RSpec.describe Faraday::Adapter::EMHttp do
+RSpec.describe Faraday::Adapter::EMHttp, unless: defined?(JRUBY_VERSION) do
   features :request_body_on_query_methods, :reason_phrase_parse, :trace_method,
            :skip_response_body_on_head, :parallel, :local_socket_binding
 

data/spec/faraday/adapter/em_synchrony_spec.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-RSpec.describe Faraday::Adapter::EMSynchrony do
+RSpec.describe Faraday::Adapter::EMSynchrony, unless: defined?(JRUBY_VERSION) do
   features :request_body_on_query_methods, :reason_phrase_parse,
            :skip_response_body_on_head, :parallel, :local_socket_binding
 

data/spec/faraday/adapter/patron_spec.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-RSpec.describe Faraday::Adapter::Patron do
+RSpec.describe Faraday::Adapter::Patron, unless: defined?(JRUBY_VERSION) do
   features :reason_phrase_parse
 
   it_behaves_like 'an adapter'

data/spec/faraday/rack_builder_spec.rb

@@ -189,7 +189,7 @@ RSpec.describe Faraday::RackBuilder do
 
     it 'raises an error while making a request' do
       expect { conn.get('/') }.to raise_error(RuntimeError) do |err|
-        expect(err.message).to eq('missing dependency for Broken: cannot load such file -- zomg/i_dont/exist')
+        expect(err.message).to match(%r{missing dependency for Broken: .+ -- zomg/i_dont/exist})
       end
     end
   end

data/spec/faraday/request/url_encoded_spec.rb

@@ -67,4 +67,17 @@ RSpec.describe Faraday::Request::UrlEncoded do
     response = conn.post('/echo', 'a' => { 'b' => { 'c' => ['d'] } })
     expect(response.body).to eq('a%5Bb%5D%5Bc%5D%5B%5D=d')
   end
+
+  context 'customising default_space_encoding' do
+    around do |example|
+      Faraday::Utils.default_space_encoding = '%20'
+      example.run
+      Faraday::Utils.default_space_encoding = nil
+    end
+
+    it 'uses the custom character to encode spaces' do
+      response = conn.post('/echo', str: 'apple banana')
+      expect(response.body).to eq('str=apple%20banana')
+    end
+  end
 end

data/spec/faraday/response/middleware_spec.rb

@@ -26,6 +26,22 @@ RSpec.describe Faraday::Response::Middleware do
     end
   end
 
+  context 'with a custom ResponseMiddleware and private parse' do
+    let(:custom_middleware) do
+      Class.new(Faraday::Response::Middleware) do
+        private
+
+        def parse(body)
+          body.upcase
+        end
+      end
+    end
+
+    it 'parses the response' do
+      expect(conn.get('ok').body).to eq('<BODY></BODY>')
+    end
+  end
+
   context 'with a custom ResponseMiddleware but empty response' do
     let(:custom_middleware) do
       Class.new(Faraday::Response::Middleware) do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: faraday
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - "@technoweenie"
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-01 00:00:00.000000000 Z
+date: 2020-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multipart-post
@@ -42,7 +42,6 @@ files:
 - LICENSE.md
 - README.md
 - Rakefile
-- UPGRADING.md
 - examples/client_spec.rb
 - examples/client_test.rb
 - lib/faraday.rb
@@ -143,13 +142,14 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://lostisland.github.io/faraday
-  changelog_uri: https://github.com/lostisland/faraday/releases/tag/v1.0.0
+  changelog_uri: https://github.com/lostisland/faraday/releases/tag/v1.0.1
   source_code_uri: https://github.com/lostisland/faraday
   bug_tracker_uri: https://github.com/lostisland/faraday/issues
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
+- spec/external_adapters
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -161,7 +161,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: HTTP/REST API client library.

data/UPGRADING.md

@@ -1,55 +0,0 @@
-## Faraday 1.0
-
-### Errors
-* Removes sub-class constants definition from `Faraday::Error`. A sub-class (e.g. `ClientError`) was previously accessible
-either through the `Faraday` module (e.g. `Faraday::ClientError`) or through the `Faraday::Error` class (e.g. `Faraday::Error::ClientError`).
-The latter is no longer available and the former should be used instead, so check your `rescue`s.
-* Introduces a new `Faraday::ServerError` (5xx status codes) alongside the existing `Faraday::ClientError` (4xx status codes).
-Please note `Faraday::ClientError` was previously used for both.
-* Introduces new Errors that describe the most common REST status codes:
-  * Faraday::BadRequestError (400)
-  * Faraday::UnauthorizedError (401)
-  * Faraday::ForbiddenError (403)
-  * Faraday::ProxyAuthError (407). Please note this raised a `Faraday::ConnectionFailed` before.
-  * Faraday::ConflictError (409)
-  * Faraday::UnprocessableEntityError (422)
-* The following error classes have changed the hierarchy to better mirror their real-world usage and semantic meaning:
-  * TimeoutError < ServerError (was < ClientError)
-  * ConnectionFailed < Error (was < ClientError)
-  * SSLError < Error (was < ClientError)
-  * ParsingError < Error (was < ClientError)
-  * RetriableResponse < Error (was < ClientError)
-
-### Custom adapters
-If you have written a custom adapter, please be aware that `env.body` is now an alias to the two new properties `request_body` and `response_body`.
-This should work without you noticing if your adapter inherits from `Faraday::Adapter` and calls `save_response`, but if it doesn't, then please ensure you set the `status` BEFORE the `body` while processing the response.
-
-### Others
-* Dropped support for jruby and Rubinius.
-* Officially supports Ruby 2.4+
-* In order to specify the adapter you now MUST use the `#adapter` method on the connection builder. If you don't do so and your adapter inherits from `Faraday::Adapter` then Faraday will raise an exception. Otherwise, Faraday will automatically push the default adapter at the end of the stack causing your request to be executed twice.
-```ruby
-class OfficialAdapter < Faraday::Adapter
-  ...
-end
-
-class MyAdapter
-  ...
-end
-
-# This will raise an exception
-conn = Faraday.new(...) do |f|
-  f.use OfficialAdapter
-end
-
-# This will cause Faraday inserting the default adapter at the end of the stack
-conn = Faraday.new(...) do |f|
-  f.use MyAdapter
-end
-
-# You MUST use `adapter` method
-conn = Faraday.new(...) do |f|
-  f.adapter AnyAdapter
-end
-```
-