faraday 0.14.0 → 0.17.6

data/test/adapters/integration.rb

@@ -0,0 +1,263 @@
+require 'forwardable'
+require File.expand_path("../../helper", __FILE__)
+Faraday.require_lib 'autoload'
+
+module Adapters
+  # Adapter integration tests. To use, implement two methods:
+  #
+  # `#adapter` required. returns a symbol for the adapter middleware name
+  # `#adapter_options` optional. extra arguments for building an adapter
+  module Integration
+    def self.apply(base, *extra_features)
+      if base.live_server
+        features = [:Common]
+        features.concat extra_features
+        features << :SSL if base.ssl_mode?
+        features.each {|name| base.send(:include, self.const_get(name)) }
+        yield if block_given?
+      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
+
+    module Parallel
+      def test_in_parallel
+        resp1, resp2 = nil, nil
+
+        connection = create_connection
+        connection.in_parallel do
+          resp1 = connection.get('echo?a=1')
+          resp2 = connection.get('echo?b=2')
+          assert connection.in_parallel?
+          assert_nil resp1.body
+          assert_nil resp2.body
+        end
+        assert !connection.in_parallel?
+        assert_equal 'get ?{"a"=>"1"}', resp1.body
+        assert_equal 'get ?{"b"=>"2"}', resp2.body
+      end
+    end
+
+    module NonParallel
+      def test_no_parallel_support
+        connection = create_connection
+        response = nil
+
+        err = capture_warnings do
+          connection.in_parallel do
+            response = connection.get('echo').body
+          end
+        end
+        assert response
+        assert_match "no parallel-capable adapter on Faraday stack", err
+        assert_match __FILE__, err
+      end
+    end
+
+    module Compression
+      def test_GET_handles_compression
+        res = get('echo_header', :name => 'accept-encoding')
+        assert_match(/\bgzip\b/, res.body)
+        assert_match(/\bdeflate\b/, res.body)
+      end
+    end
+
+    module SSL
+      def test_GET_ssl_fails_with_bad_cert
+        ca_file = 'tmp/faraday-different-ca-cert.crt'
+        conn = create_connection(:ssl => {:ca_file => ca_file})
+        err = assert_raises Faraday::SSLError do
+          conn.get('/ssl')
+        end
+        assert_includes err.message, "certificate"
+      end
+    end
+
+    module Common
+      extend Forwardable
+      def_delegators :create_connection, :get, :head, :put, :post, :patch, :delete, :run_request
+
+      def test_GET_retrieves_the_response_body
+        assert_equal 'get', get('echo').body
+      end
+
+      def test_GET_send_url_encoded_params
+        assert_equal %(get ?{"name"=>"zack"}), get('echo', :name => 'zack').body
+      end
+
+      def test_GET_retrieves_the_response_headers
+        response = get('echo')
+        assert_match(/text\/plain/, response.headers['Content-Type'], 'original case fail')
+        assert_match(/text\/plain/, response.headers['content-type'], 'lowercase fail')
+      end
+
+      def test_GET_handles_headers_with_multiple_values
+        assert_equal 'one, two', get('multi').headers['set-cookie']
+      end
+
+      def test_GET_with_body
+        response = get('echo') do |req|
+          req.body = {'bodyrock' => true}
+        end
+        assert_equal %(get {"bodyrock"=>"true"}), response.body
+      end
+
+      def test_GET_sends_user_agent
+        response = get('echo_header', {:name => 'user-agent'}, :user_agent => 'Agent Faraday')
+        assert_equal 'Agent Faraday', response.body
+      end
+
+      def test_GET_ssl
+        expected = self.class.ssl_mode?.to_s
+        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
+
+      def test_POST_send_url_encoded_nested_params
+        resp = post('echo', 'name' => {'first' => 'zack'})
+        assert_equal %(post {"name"=>{"first"=>"zack"}}), resp.body
+      end
+
+      def test_POST_retrieves_the_response_headers
+        assert_match(/text\/plain/, post('echo').headers['content-type'])
+      end
+
+      def test_POST_sends_files
+        resp = post('file') do |req|
+          req.body = {'uploaded_file' => Faraday::UploadIO.new(__FILE__, 'text/x-ruby')}
+        end
+        assert_equal "file integration.rb text/x-ruby #{File.size(__FILE__)}", resp.body
+      end
+
+      def test_PUT_send_url_encoded_params
+        assert_equal %(put {"name"=>"zack"}), put('echo', :name => 'zack').body
+      end
+
+      def test_PUT_send_url_encoded_nested_params
+        resp = put('echo', 'name' => {'first' => 'zack'})
+        assert_equal %(put {"name"=>{"first"=>"zack"}}), resp.body
+      end
+
+      def test_PUT_retrieves_the_response_headers
+        assert_match(/text\/plain/, put('echo').headers['content-type'])
+      end
+
+      def test_PATCH_send_url_encoded_params
+        assert_equal %(patch {"name"=>"zack"}), patch('echo', :name => 'zack').body
+      end
+
+      def test_OPTIONS
+        resp = run_request(:options, 'echo', nil, {})
+        assert_equal 'options', resp.body
+      end
+
+      def test_HEAD_retrieves_no_response_body
+        assert_equal '', head('echo').body
+      end
+
+      def test_HEAD_retrieves_the_response_headers
+        assert_match(/text\/plain/, head('echo').headers['content-type'])
+      end
+
+      def test_DELETE_retrieves_the_response_headers
+        assert_match(/text\/plain/, delete('echo').headers['content-type'])
+      end
+
+      def test_DELETE_retrieves_the_body
+        assert_equal %(delete), delete('echo').body
+      end
+
+      def test_timeout
+        conn = create_connection(:request => {:timeout => 1, :open_timeout => 1})
+        assert_raises Faraday::TimeoutError do
+          conn.get '/slow'
+        end
+      end
+
+      def test_connection_error
+        assert_raises Faraday::ConnectionFailed do
+          get 'http://localhost:4'
+        end
+      end
+
+      def test_proxy
+        proxy_uri = URI(ENV['LIVE_PROXY'])
+        conn = create_connection(:proxy => proxy_uri)
+
+        res = conn.get '/echo'
+        assert_equal 'get', res.body
+
+        unless self.class.ssl_mode?
+          # proxy can't append "Via" header for HTTPS responses
+          assert_match(/:#{proxy_uri.port}$/, res['via'])
+        end
+      end
+
+      def test_proxy_auth_fail
+        proxy_uri = URI(ENV['LIVE_PROXY'])
+        proxy_uri.password = 'WRONG'
+        conn = create_connection(:proxy => proxy_uri)
+
+        err = assert_raises Faraday::ConnectionFailed do
+          conn.get '/echo'
+        end
+
+        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
+
+      def test_empty_body_response_represented_as_blank_string
+        response = get('204')
+        assert_equal '', response.body
+      end
+
+      def adapter
+        raise NotImplementedError.new("Need to override #adapter")
+      end
+
+      # extra options to pass when building the adapter
+      def adapter_options
+        []
+      end
+
+      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, &optional_connection_config_blk
+          end
+        end
+
+        server = self.class.live_server
+        url = '%s://%s:%d' % [server.scheme, server.host, server.port]
+
+        options[:ssl] ||= {}
+        options[:ssl][:ca_file] ||= ENV['SSL_FILE']
+
+        Faraday::Connection.new(url, options, &builder_block).tap do |conn|
+          conn.headers['X-Faraday-Adapter'] = adapter.to_s
+          adapter_handler = conn.builder.handlers.last
+          conn.builder.insert_before adapter_handler, Faraday::Response::RaiseError
+        end
+      end
+    end
+  end
+end

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