faraday 0.17.0 → 0.17.4

data/spec/spec_helper.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+require 'faraday'
+Faraday::Deprecate.skip = false
+
+# 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/default_test.rb

@@ -0,0 +1,14 @@
+require File.expand_path('../integration', __FILE__)
+
+module Adapters
+  class DefaultTest < Faraday::TestCase
+
+    def adapter() :default end
+
+    Integration.apply(self, :NonParallel) do
+      # default stack is not configured with Multipart
+      undef :test_POST_sends_files
+    end
+
+  end
+end

data/test/adapters/em_http_test.rb

@@ -0,0 +1,30 @@
+require File.expand_path('../integration', __FILE__)
+
+module Adapters
+  class EMHttpTest < Faraday::TestCase
+
+    def adapter() :em_http 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 } }
+        assert_equal host, conn.options[:bind][:host]
+      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

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

@@ -0,0 +1,30 @@
+require File.expand_path('../integration', __FILE__)
+
+module Adapters
+  class ExconTest < Faraday::TestCase
+
+    def adapter() :excon end
+
+    Integration.apply(self, :NonParallel) do
+      # https://github.com/geemus/excon/issues/126 ?
+      undef :test_timeout if ssl_mode?
+
+      # Excon lets OpenSSL::SSL::SSLError be raised without any way to
+      # distinguish whether it happened because of a 407 proxy response
+      undef :test_proxy_auth_fail if ssl_mode?
+
+      # 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

@@ -0,0 +1,34 @@
+require File.expand_path('../integration', __FILE__)
+
+module Adapters
+  class HttpclientTest < Faraday::TestCase
+
+    def adapter() :httpclient end
+
+    Integration.apply(self, :NonParallel, :Compression) do
+      def setup
+        require 'httpclient' unless defined?(HTTPClient)
+        HTTPClient::NO_PROXY_HOSTS.delete('localhost')
+      end
+
+      def test_binds_local_socket
+        host = '1.2.3.4'
+        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

@@ -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