faraday 0.17.0 → 0.17.1

data/test/adapters/logger_test.rb

@@ -0,0 +1,136 @@
+require File.expand_path('../../helper', __FILE__)
+require 'stringio'
+require 'logger'
+
+module Adapters
+  class LoggerTest < Faraday::TestCase
+    def conn(logger, logger_options={})
+      rubbles = ['Barney', 'Betty', 'Bam Bam']
+
+      Faraday.new do |b|
+        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.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
+
+    def setup
+      @io     = StringIO.new
+      @logger = Logger.new(@io)
+      @logger.level = Logger::DEBUG
+
+      @conn = conn(@logger)
+    end
+
+    def test_still_returns_output
+      resp = @conn.get '/hello', nil, :accept => 'text/html'
+      assert_equal 'hello', resp.body
+    end
+
+    def test_logs_method_and_url
+      @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_by_default
+      @conn.get '/hello', nil, :accept => 'text/html'
+      assert_match %(Accept: "text/html), @io.string
+    end
+
+    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
+    end
+
+    def test_does_not_log_response_body_by_default
+      @conn.post '/ohai', 'name=Toro', :accept => 'text/html'
+      refute_match %(fred), @io.string
+    end
+
+    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_only_response_body
+      app = conn(@logger, :bodies => { :response => true })
+      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
+      app = conn(@logger, :bodies => true)
+      app.post '/ohyes', 'name=Ebi', :accept => 'text/html'
+      assert_match %(name=Ebi), @io.string
+      assert_match %(pebbles), @io.string
+    end
+
+    def test_log_response_body_object
+      app = conn(@logger, :bodies => true)
+      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

@@ -0,0 +1,114 @@
+require File.expand_path('../integration', __FILE__)
+
+module Adapters
+  class NetHttpPersistentTest < Faraday::TestCase
+
+    def adapter() :net_http_persistent end
+
+    Integration.apply(self, :NonParallel) do
+      def setup
+        if defined?(Net::HTTP::Persistent)
+          # work around problems with mixed SSL certificates
+          # https://github.com/drbrain/net-http-persistent/issues/45
+          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

@@ -0,0 +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, :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

@@ -0,0 +1,40 @@
+require File.expand_path('../integration', __FILE__)
+
+module Adapters
+  class Patron < Faraday::TestCase
+
+    def adapter() :patron end
+
+    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
+
+        # 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

@@ -0,0 +1,38 @@
+require File.expand_path("../integration", __FILE__)
+require File.expand_path('../../live_server', __FILE__)
+
+module Adapters
+  class RackTest < Faraday::TestCase
+
+    def adapter() :rack end
+
+    def adapter_options
+      [Faraday::LiveServer]
+    end
+
+    # no Integration.apply because this doesn't require a server as a separate process
+    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::TimeoutError
+      end
+    end
+
+    # test not applicable
+    undef test_connection_error
+    undef test_proxy
+    undef test_proxy_auth_fail
+  end
+end

data/test/adapters/test_middleware_test.rb

@@ -0,0 +1,157 @@
+require File.expand_path('../../helper', __FILE__)
+
+module Adapters
+  class TestMiddleware < Faraday::TestCase
+    Stubs = Faraday::Adapter.lookup_middleware(:test)::Stubs
+    def setup
+      @stubs = Stubs.new do |stub|
+        stub.get('/hello') do
+          [200, {'Content-Type' => 'text/html'}, 'hello']
+        end
+        stub.get('/method-echo') do |env|
+          [200, {'Content-Type' => 'text/html'}, env[:method].to_s]
+        end
+        stub.get(/\A\/resources\/\d+(?:\?|\z)/) do
+          [200, {'Content-Type' => 'text/html'}, 'show']
+        end
+        stub.get(/\A\/resources\/(specified)\z/) do |env, meta|
+          [200, {'Content-Type' => 'text/html'}, "show #{meta[:match_data][1]}"]
+        end
+        stub.get('http://domain.test/hello') do
+          [200, {'Content-Type' => 'text/html'}, 'domain: hello']
+        end
+        stub.get('http://wrong.test/hello') do
+          [200, {'Content-Type' => 'text/html'}, 'wrong: hello']
+        end
+        stub.get('http://wrong.test/bait') do
+          [404, {'Content-Type' => 'text/html'}]
+        end
+      end
+      @conn  = Faraday.new do |builder|
+        builder.adapter :test, @stubs
+      end
+      @resp = @conn.get('/hello')
+    end
+
+    def test_middleware_with_simple_path_sets_status
+      assert_equal 200, @resp.status
+    end
+
+    def test_middleware_with_simple_path_sets_headers
+      assert_equal 'text/html', @resp.headers['Content-Type']
+    end
+
+    def test_middleware_with_simple_path_sets_body
+      assert_equal 'hello', @resp.body
+    end
+
+    def test_middleware_with_host_points_to_the_right_stub
+      assert_equal 'domain: hello', @conn.get('http://domain.test/hello').body
+    end
+
+    def test_middleware_can_be_called_several_times
+      assert_equal 'hello', @conn.get('/hello').body
+    end
+
+    def test_middleware_can_handle_regular_expression_path
+      assert_equal 'show', @conn.get('/resources/1').body
+    end
+
+    def test_middleware_can_handle_single_parameter_block
+      assert_equal 'get', @conn.get('/method-echo').body
+    end
+
+    def test_middleware_can_handle_regular_expression_path_with_captured_result
+      assert_equal 'show specified', @conn.get('/resources/specified').body
+    end
+
+    def test_middleware_with_get_params
+      @stubs.get('/param?a=1') { [200, {}, 'a'] }
+      assert_equal 'a', @conn.get('/param?a=1').body
+    end
+
+    def test_middleware_ignores_unspecified_get_params
+      @stubs.get('/optional?a=1') { [200, {}, 'a'] }
+      assert_equal 'a', @conn.get('/optional?a=1&b=1').body
+      assert_equal 'a', @conn.get('/optional?a=1').body
+      assert_raises Faraday::Adapter::Test::Stubs::NotFound do
+        @conn.get('/optional')
+      end
+    end
+
+    def test_middleware_with_http_headers
+      @stubs.get('/yo', { 'X-HELLO' => 'hello' }) { [200, {}, 'a'] }
+      @stubs.get('/yo') { [200, {}, 'b'] }
+      assert_equal 'a', @conn.get('/yo') { |env| env.headers['X-HELLO'] = 'hello' }.body
+      assert_equal 'b', @conn.get('/yo').body
+    end
+
+    def test_middleware_allow_different_outcomes_for_the_same_request
+      @stubs.get('/hello') { [200, {'Content-Type' => 'text/html'}, 'hello'] }
+      @stubs.get('/hello') { [200, {'Content-Type' => 'text/html'}, 'world'] }
+      assert_equal 'hello', @conn.get("/hello").body
+      assert_equal 'world', @conn.get("/hello").body
+    end
+
+    def test_yields_env_to_stubs
+      @stubs.get '/hello' do |env|
+        assert_equal '/hello',     env[:url].path
+        assert_equal 'foo.com',    env[:url].host
+        assert_equal '1',          env[:params]['a']
+        assert_equal 'text/plain', env[:request_headers]['Accept']
+        [200, {}, 'a']
+      end
+
+      @conn.headers['Accept'] = 'text/plain'
+      assert_equal 'a', @conn.get('http://foo.com/hello?a=1').body
+    end
+
+    def test_parses_params_with_default_encoder
+      @stubs.get '/hello' do |env|
+        assert_equal '1', env[:params]['a']['b']
+        [200, {}, 'a']
+      end
+
+      assert_equal 'a', @conn.get('http://foo.com/hello?a[b]=1').body
+    end
+
+    def test_parses_params_with_nested_encoder
+      @stubs.get '/hello' do |env|
+        assert_equal '1', env[:params]['a']['b']
+        [200, {}, 'a']
+      end
+
+      @conn.options.params_encoder = Faraday::NestedParamsEncoder
+      assert_equal 'a', @conn.get('http://foo.com/hello?a[b]=1').body
+    end
+
+    def test_parses_params_with_flat_encoder
+      @stubs.get '/hello' do |env|
+        assert_equal '1', env[:params]['a[b]']
+        [200, {}, 'a']
+      end
+
+      @conn.options.params_encoder = Faraday::FlatParamsEncoder
+      assert_equal 'a', @conn.get('http://foo.com/hello?a[b]=1').body
+    end
+
+    def test_raises_an_error_if_no_stub_is_found_for_request
+      assert_raises Stubs::NotFound do
+        @conn.get('/invalid'){ [200, {}, []] }
+      end
+    end
+
+    def test_raises_an_error_if_no_stub_is_found_for_specified_host
+      assert_raises Stubs::NotFound do
+        @conn.get('http://domain.test/bait')
+      end
+    end
+
+    def test_raises_an_error_if_no_stub_is_found_for_request_without_this_header
+      @stubs.get('/yo', { 'X-HELLO' => 'hello' }) { [200, {}, 'a'] }
+      assert_raises Faraday::Adapter::Test::Stubs::NotFound do
+        @conn.get('/yo')
+      end
+    end
+  end
+end