faraday 0.9.1 → 0.17.1

data/spec/spec_helper.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+require 'faraday'
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
+  # have no way to turn it off -- the option exists only for backwards
+  # compatibility in RSpec 3). It causes shared context metadata to be
+  # inherited by the metadata hash of host groups and examples, rather than
+  # triggering implicit auto-inclusion in groups with matching metadata.
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  config.disable_monkey_patching!
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # This allows you to limit a spec run to individual examples or groups
+  # you care about by tagging them with `:focus` metadata. When nothing
+  # is tagged with `:focus`, all examples get run. RSpec also provides
+  # aliases for `it`, `describe`, and `context` that include `:focus`
+  # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
+  config.filter_run_when_matching :focus
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = "doc"
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+=end
+end

data/test/adapters/em_http_test.rb

@@ -16,5 +16,15 @@ module Adapters
       end
     end unless jruby? and ssl_mode?
     # https://github.com/eventmachine/eventmachine/issues/180
+
+    def test_custom_adapter_config
+      url = URI('https://example.com:1234')
+
+      adapter = Faraday::Adapter::EMHttp.new nil, inactivity_timeout: 20
+
+      req = adapter.create_request(url: url, request: {})
+
+      assert_equal 20, req.connopts.inactivity_timeout
+    end
   end
 end

data/test/adapters/em_synchrony_test.rb

@@ -5,16 +5,28 @@ module Adapters
 
     def adapter() :em_synchrony end
 
-    Integration.apply(self, :Parallel) do
-      # https://github.com/eventmachine/eventmachine/pull/289
-      undef :test_timeout
-
-      def test_binds_local_socket
-        host = '1.2.3.4'
-        conn = create_connection :request => { :bind => { :host => host } }
-        #put conn.get('/who-am-i').body
-        assert_equal host, conn.options[:bind][:host]
+    unless jruby?
+      Integration.apply(self, :Parallel) do
+        # https://github.com/eventmachine/eventmachine/pull/289
+        undef :test_timeout
+
+        def test_binds_local_socket
+          host = '1.2.3.4'
+          conn = create_connection :request => { :bind => { :host => host } }
+          #put conn.get('/who-am-i').body
+          assert_equal host, conn.options[:bind][:host]
+        end
       end
-    end unless RUBY_VERSION < '1.9' or jruby?
+    end
+
+    def test_custom_adapter_config
+      url = URI('https://example.com:1234')
+
+      adapter = Faraday::Adapter::EMSynchrony.new nil, inactivity_timeout: 20
+
+      req = adapter.create_request(url: url, request: {})
+
+      assert_equal 20, req.connopts.inactivity_timeout
+    end
   end
 end

data/test/adapters/excon_test.rb

@@ -16,5 +16,15 @@ module Adapters
       # https://github.com/geemus/excon/issues/358
       undef :test_connection_error if RUBY_VERSION >= '2.1.0'
     end
+
+    def test_custom_adapter_config
+      url = URI('https://example.com:1234')
+
+      adapter = Faraday::Adapter::Excon.new nil, debug_request: true
+
+      conn = adapter.create_connection({url: url}, {})
+
+      assert_equal true, conn.data[:debug_request]
+    end
   end
 end

data/test/adapters/httpclient_test.rb

@@ -5,7 +5,7 @@ module Adapters
 
     def adapter() :httpclient end
 
-    Integration.apply(self, :NonParallel) do
+    Integration.apply(self, :NonParallel, :Compression) do
       def setup
         require 'httpclient' unless defined?(HTTPClient)
         HTTPClient::NO_PROXY_HOSTS.delete('localhost')
@@ -16,6 +16,19 @@ module Adapters
         conn = create_connection :request => { :bind => { :host => host } }
         assert_equal host, conn.options[:bind][:host]
       end
+
+      def test_custom_adapter_config
+        adapter = Faraday::Adapter::HTTPClient.new do |client|
+          client.keep_alive_timeout = 20
+          client.ssl_config.timeout = 25
+        end
+
+        client = adapter.client
+        adapter.configure_client
+
+        assert_equal 20, client.keep_alive_timeout
+        assert_equal 25, client.ssl_config.timeout
+      end
     end
   end
 end

data/test/adapters/integration.rb

@@ -9,7 +9,7 @@ module Adapters
   # `#adapter_options` optional. extra arguments for building an adapter
   module Integration
     def self.apply(base, *extra_features)
-      if base.live_server?
+      if base.live_server
         features = [:Common]
         features.concat extra_features
         features << :SSL if base.ssl_mode?
@@ -18,6 +18,7 @@ module Adapters
       elsif !defined? @warned
         warn "Warning: Not running integration tests against a live server."
         warn "Start the server `ruby test/live_server.rb` and set the LIVE=1 env variable."
+        warn "See CONTRIBUTING for usage."
         @warned = true
       end
     end
@@ -59,7 +60,8 @@ module Adapters
     module Compression
       def test_GET_handles_compression
         res = get('echo_header', :name => 'accept-encoding')
-        assert_match(/gzip;.+\bdeflate\b/, res.body)
+        assert_match(/\bgzip\b/, res.body)
+        assert_match(/\bdeflate\b/, res.body)
       end
     end
 
@@ -113,6 +115,11 @@ module Adapters
         assert_equal expected, get('ssl').body
       end
 
+      def test_GET_reason_phrase
+        response = get('echo')
+        assert_equal "OK", response.reason_phrase
+      end
+
       def test_POST_send_url_encoded_params
         assert_equal %(post {"name"=>"zack"}), post('echo', :name => 'zack').body
       end
@@ -173,13 +180,13 @@ module Adapters
 
       def test_timeout
         conn = create_connection(:request => {:timeout => 1, :open_timeout => 1})
-        assert_raises Faraday::Error::TimeoutError do
+        assert_raises Faraday::TimeoutError do
           conn.get '/slow'
         end
       end
 
       def test_connection_error
-        assert_raises Faraday::Error::ConnectionFailed do
+        assert_raises Faraday::ConnectionFailed do
           get 'http://localhost:4'
         end
       end
@@ -202,12 +209,14 @@ module Adapters
         proxy_uri.password = 'WRONG'
         conn = create_connection(:proxy => proxy_uri)
 
-        err = assert_raises Faraday::Error::ConnectionFailed do
+        err = assert_raises Faraday::ConnectionFailed do
           conn.get '/echo'
         end
 
-        unless self.class.ssl_mode? && self.class.jruby?
+        unless self.class.ssl_mode? && (self.class.jruby? ||
+            adapter == :em_http || adapter == :em_synchrony)
           # JRuby raises "End of file reached" which cannot be distinguished from a 407
+          # EM raises "connection closed by server" due to https://github.com/igrigorik/em-socksify/pull/19
           assert_equal %{407 "Proxy Authentication Required "}, err.message
         end
       end
@@ -226,14 +235,14 @@ module Adapters
         []
       end
 
-      def create_connection(options = {})
+      def create_connection(options = {}, &optional_connection_config_blk)
         if adapter == :default
           builder_block = nil
         else
           builder_block = Proc.new do |b|
             b.request :multipart
             b.request :url_encoded
-            b.adapter adapter, *adapter_options
+            b.adapter adapter, *adapter_options, &optional_connection_config_blk
           end
         end
 

data/test/adapters/logger_test.rb

@@ -8,13 +8,20 @@ module Adapters
       rubbles = ['Barney', 'Betty', 'Bam Bam']
 
       Faraday.new do |b|
-        b.response :logger, logger, logger_options
+        b.response :logger, @logger, logger_options do | logger |
+          logger.filter(/(soylent green is) (.+)/,'\1 tasty')
+          logger.filter(/(api_key:).*"(.+)."/,'\1[API_KEY]')
+          logger.filter(/(password)=(.+)/,'\1=[HIDDEN]')
+        end
         b.adapter :test do |stubs|
           stubs.get('/hello') { [200, {'Content-Type' => 'text/html'}, 'hello'] }
           stubs.post('/ohai') { [200, {'Content-Type' => 'text/html'}, 'fred'] }
-          stubs.get('/ohno') { [200, {'Content-Type' => 'text/html'}, 'wilma'] }
           stubs.post('/ohyes') { [200, {'Content-Type' => 'text/html'}, 'pebbles'] }
           stubs.get('/rubbles') { [200, {'Content-Type' => 'application/json'}, rubbles] }
+          stubs.get('/filtered_body') { [200, {'Content-Type' => 'text/html'}, 'soylent green is people'] }
+          stubs.get('/filtered_headers') { [200, {'Content-Type' => 'text/html'}, 'headers response'] }
+          stubs.get('/filtered_params') { [200, {'Content-Type' => 'text/html'}, 'params response'] }
+          stubs.get('/filtered_url') { [200, {'Content-Type' => 'text/html'}, 'url response'] }
         end
       end
     end
@@ -25,25 +32,45 @@ module Adapters
       @logger.level = Logger::DEBUG
 
       @conn = conn(@logger)
-      @resp = @conn.get '/hello', nil, :accept => 'text/html'
     end
 
     def test_still_returns_output
-      assert_equal 'hello', @resp.body
+      resp = @conn.get '/hello', nil, :accept => 'text/html'
+      assert_equal 'hello', resp.body
     end
 
     def test_logs_method_and_url
-      assert_match "get http:/hello", @io.string
+      @conn.get '/hello', nil, :accept => 'text/html'
+      assert_match 'request: GET http:/hello', @io.string
+    end
+
+    def test_logs_status_code
+      @conn.get '/hello', nil, :accept => 'text/html'
+      assert_match 'response: Status 200', @io.string
     end
 
-    def test_logs_request_headers
+    def test_logs_request_headers_by_default
+      @conn.get '/hello', nil, :accept => 'text/html'
       assert_match %(Accept: "text/html), @io.string
     end
 
-    def test_logs_response_headers
+    def test_logs_response_headers_by_default
+      @conn.get '/hello', nil, :accept => 'text/html'
       assert_match %(Content-Type: "text/html), @io.string
     end
 
+    def test_does_not_log_request_headers_if_option_is_false
+      app = conn(@logger, :headers => { :request => false })
+      app.get '/hello', nil, :accept => 'text/html'
+      refute_match %(Accept: "text/html), @io.string
+    end
+
+    def test_does_log_response_headers_if_option_is_false
+      app = conn(@logger, :headers => { :response => false })
+      app.get '/hello', nil, :accept => 'text/html'
+      refute_match %(Content-Type: "text/html), @io.string
+    end
+
     def test_does_not_log_request_body_by_default
       @conn.post '/ohai', 'name=Unagi', :accept => 'text/html'
       refute_match %(name=Unagi), @io.string
@@ -54,16 +81,18 @@ module Adapters
       refute_match %(fred), @io.string
     end
 
-    def test_log_request_body
+    def test_log_only_request_body
       app = conn(@logger, :bodies => { :request => true })
       app.post '/ohyes', 'name=Tamago', :accept => 'text/html'
       assert_match %(name=Tamago), @io.string
+      refute_match %(pebbles), @io.string
     end
 
-    def test_log_response_body
+    def test_log_only_response_body
       app = conn(@logger, :bodies => { :response => true })
-      app.get '/ohno', :accept => 'text/html'
-      assert_match %(wilma), @io.string
+      app.post '/ohyes', 'name=Hamachi', :accept => 'text/html'
+      assert_match %(pebbles), @io.string
+      refute_match %(name=Hamachi), @io.string
     end
 
     def test_log_request_and_response_body
@@ -78,5 +107,30 @@ module Adapters
       app.get '/rubbles', nil, :accept => 'text/html'
       assert_match %([\"Barney\", \"Betty\", \"Bam Bam\"]\n), @io.string
     end
+
+    def test_logs_filter_body
+      app = conn(@logger, :bodies => true)
+      app.get '/filtered_body', nil, :accept => 'text/html'
+      assert_match %(soylent green is), @io.string
+      assert_match %(tasty), @io.string
+      refute_match %(people), @io.string
+    end
+
+    def test_logs_filter_headers
+      app = conn(@logger)
+      app.headers = {'api_key' => 'ABC123'}
+      app.get '/filtered_headers', nil, :accept => 'text/html'
+      assert_match %(api_key:), @io.string
+      assert_match %([API_KEY]), @io.string
+      refute_match %(ABC123), @io.string
+    end
+
+    def test_logs_filter_url
+      app = conn(@logger)
+      app.get '/filtered_url?password=hunter2', nil, :accept => 'text/html'
+      assert_match %(password=[HIDDEN]), @io.string
+      refute_match %(hunter2), @io.string
+    end
+
   end
 end

data/test/adapters/net_http_persistent_test.rb

@@ -10,11 +10,105 @@ module Adapters
         if defined?(Net::HTTP::Persistent)
           # work around problems with mixed SSL certificates
           # https://github.com/drbrain/net-http-persistent/issues/45
-          http = Net::HTTP::Persistent.new('Faraday')
-          http.ssl_cleanup(4)
+          if Net::HTTP::Persistent.instance_method(:initialize).parameters.first == [:key, :name]
+            Net::HTTP::Persistent.new(name: 'Faraday').reconnect_ssl
+          else
+            Net::HTTP::Persistent.new('Faraday').ssl_cleanup(4)
+          end
         end
       end if ssl_mode?
+
+      def test_reuses_tcp_sockets
+        # Ensure that requests are not reused from previous tests
+        Thread.current.keys
+          .select { |key| key.to_s =~ /\Anet_http_persistent_Faraday_/ }
+          .each { |key| Thread.current[key] = nil }
+
+        sockets = []
+        tcp_socket_open_wrapped = Proc.new do |*args, &block|
+          socket = TCPSocket.__minitest_stub__open(*args, &block)
+          sockets << socket
+          socket
+        end
+
+        TCPSocket.stub :open, tcp_socket_open_wrapped do
+          conn = create_connection
+          conn.post("/echo", :foo => "bar")
+          conn.post("/echo", :foo => "baz")
+        end
+
+        assert_equal 1, sockets.count
+      end
+
+      def test_does_not_reuse_tcp_sockets_when_proxy_changes
+        # Ensure that requests are not reused from previous tests
+        Thread.current.keys
+          .select { |key| key.to_s =~ /\Anet_http_persistent_Faraday_/ }
+          .each { |key| Thread.current[key] = nil }
+
+        sockets = []
+        tcp_socket_open_wrapped = Proc.new do |*args, &block|
+          socket = TCPSocket.__minitest_stub__open(*args, &block)
+          sockets << socket
+          socket
+        end
+
+        TCPSocket.stub :open, tcp_socket_open_wrapped do
+          conn = create_connection
+          conn.post("/echo", :foo => "bar")
+          conn.proxy = URI(ENV["LIVE_PROXY"])
+          conn.post("/echo", :foo => "bar")
+        end
+
+        assert_equal 2, sockets.count
+      end
     end
 
+    def test_without_custom_connection_config
+      url = URI('https://example.com:1234')
+
+      adapter = Faraday::Adapter::NetHttpPersistent.new
+
+      http = adapter.send(:net_http_connection, :url => url, :request => {})
+
+      # `pool` is only present in net_http_persistent >= 3.0
+      assert http.pool.size != nil if http.respond_to?(:pool)
+    end
+
+    def test_custom_connection_config
+      url = URI('https://example.com:1234')
+
+      adapter = Faraday::Adapter::NetHttpPersistent.new(nil, {pool_size: 5})
+
+      http = adapter.send(:net_http_connection, :url => url, :request => {})
+
+      # `pool` is only present in net_http_persistent >= 3.0
+      assert_equal 5, http.pool.size if http.respond_to?(:pool)
+    end
+
+    def test_custom_adapter_config
+      url = URI('https://example.com:1234')
+
+      adapter = Faraday::Adapter::NetHttpPersistent.new do |http|
+        http.idle_timeout = 123
+      end
+
+      http = adapter.send(:net_http_connection, :url => url, :request => {})
+      adapter.send(:configure_request, http, {})
+
+      assert_equal 123, http.idle_timeout
+    end
+
+    def test_max_retries
+      url = URI('http://example.com')
+
+      adapter = Faraday::Adapter::NetHttpPersistent.new
+
+      http = adapter.send(:net_http_connection, :url => url, :request => {})
+      adapter.send(:configure_request, http, {})
+
+      # `max_retries=` is only present in Ruby 2.5
+      assert_equal 0, http.max_retries if http.respond_to?(:max_retries=)
+    end
   end
 end

data/test/adapters/net_http_test.rb

@@ -1,14 +1,79 @@
 require File.expand_path('../integration', __FILE__)
+require 'ostruct'
+require 'uri'
 
 module Adapters
   class NetHttpTest < Faraday::TestCase
 
     def adapter() :net_http end
 
-    behaviors = [:NonParallel]
-    behaviors << :Compression if RUBY_VERSION >= '1.9'
+    behaviors = [:NonParallel, :Compression]
 
     Integration.apply(self, *behaviors)
 
+    def test_no_explicit_http_port_number
+      url = URI('http://example.com')
+      url.port = nil
+
+      adapter = Faraday::Adapter::NetHttp.new
+      http = adapter.send(:net_http_connection, :url => url, :request => {})
+
+      assert_equal 80, http.port
+    end
+
+    def test_no_explicit_https_port_number
+      url = URI('https://example.com')
+      url.port = nil
+
+      adapter = Faraday::Adapter::NetHttp.new
+      http = adapter.send(:net_http_connection, :url => url, :request => {})
+
+      assert_equal 443, http.port
+    end
+
+    def test_explicit_port_number
+      url = URI('https://example.com:1234')
+
+      adapter = Faraday::Adapter::NetHttp.new
+      http = adapter.send(:net_http_connection, :url => url, :request => {})
+
+      assert_equal 1234, http.port
+    end
+
+    def test_custom_adapter_config
+      url = URI('https://example.com:1234')
+
+      adapter = Faraday::Adapter::NetHttp.new do |http|
+        http.continue_timeout = 123
+      end
+
+      http = adapter.send(:net_http_connection, :url => url, :request => {})
+      adapter.send(:configure_request, http, {})
+
+      assert_equal 123, http.continue_timeout
+    end
+
+    def test_no_retries
+      url = URI('http://example.com')
+
+      adapter = Faraday::Adapter::NetHttp.new
+
+      http = adapter.send(:net_http_connection, :url => url, :request => {})
+      adapter.send(:configure_request, http, {})
+
+      # `max_retries=` is only present in Ruby 2.5
+      assert_equal 0, http.max_retries if http.respond_to?(:max_retries=)
+    end
+
+    def test_write_timeout
+      url = URI('http://example.com')
+
+      adapter = Faraday::Adapter::NetHttp.new
+
+      http = adapter.send(:net_http_connection, :url => url, :request => {})
+      adapter.send(:configure_request, http, { write_timeout: 10 })
+
+      assert_equal 10, http.write_timeout if http.respond_to?(:write_timeout=)
+    end
   end
 end

data/test/adapters/patron_test.rb

@@ -5,16 +5,36 @@ module Adapters
 
     def adapter() :patron end
 
-    Integration.apply(self, :NonParallel) do
-      # https://github.com/toland/patron/issues/34
-      undef :test_PATCH_send_url_encoded_params
+    unless jruby?
+      Integration.apply(self, :NonParallel) do
+        # https://github.com/toland/patron/issues/34
+        undef :test_PATCH_send_url_encoded_params
 
-      # https://github.com/toland/patron/issues/52
-      undef :test_GET_with_body
+        # https://github.com/toland/patron/issues/52
+        undef :test_GET_with_body
 
-      # no support for SSL peer verification
-      undef :test_GET_ssl_fails_with_bad_cert if ssl_mode?
-    end unless jruby?
+        # no support for SSL peer verification
+        undef :test_GET_ssl_fails_with_bad_cert if ssl_mode?
+      end
 
+      def test_custom_adapter_config
+        conn = create_connection do |session|
+          assert_kind_of ::Patron::Session, session
+          session.max_redirects = 10
+          throw :config_block_called
+        end
+
+        assert_throws(:config_block_called) do
+          conn.get 'http://8.8.8.8:88'
+        end
+      end
+
+      def test_connection_timeout
+        conn = create_connection(:request => {:timeout => 10, :open_timeout => 1})
+        assert_raises Faraday::ConnectionFailed do
+          conn.get 'http://8.8.8.8:88'
+        end
+      end
+    end
   end
 end

data/test/adapters/rack_test.rb

@@ -14,12 +14,19 @@ module Adapters
     include Integration::Common
     include Integration::NonParallel
 
+    # Rack::MockResponse doesn't provide any way to access the reason phrase,
+    # so override the shared test from Common.
+    def test_GET_reason_phrase
+      response = get('echo')
+      assert_nil response.reason_phrase
+    end
+
     # not using shared test because error is swallowed by Sinatra
     def test_timeout
       conn = create_connection(:request => {:timeout => 1, :open_timeout => 1})
       begin
         conn.get '/slow'
-      rescue Faraday::Error::ClientError
+      rescue Faraday::TimeoutError
       end
     end