faraday 0.17.3 → 1.0.0

data/lib/faraday/deprecate.rb

@@ -1,107 +0,0 @@
-# frozen_string_literal: true
-
-module Faraday
-  # @param new_klass [Class] new Klass to use
-  #
-  # @return [Class] A modified version of new_klass that warns on
-  #   usage about deprecation.
-  # @see Faraday::Deprecate
-  module DeprecatedClass
-    def self.proxy_class(origclass, ver = '1.0')
-      proxy = Class.new(origclass) do
-        class << self
-          extend Faraday::Deprecate
-
-          def ===(other)
-            other.is_a?(superclass) || super
-          end
-        end
-      end
-      proxy.singleton_class.send(:deprecate, :new, "#{origclass}.new", ver)
-      proxy.singleton_class.send(:deprecate, :inherited, origclass.name, ver)
-      proxy
-    end
-  end
-
-  # Deprecation using semver instead of date, based on Gem::Deprecate
-  # Provides a single method +deprecate+ to be used to declare when
-  # something is going away.
-  #
-  #     class Legacy
-  #       def self.klass_method
-  #         # ...
-  #       end
-  #
-  #       def instance_method
-  #         # ...
-  #       end
-  #
-  #       extend Faraday::Deprecate
-  #       deprecate :instance_method, "X.z", '1.0'
-  #
-  #       class << self
-  #         extend Faraday::Deprecate
-  #         deprecate :klass_method, :none, '1.0'
-  #       end
-  #     end
-  module Deprecate
-    def self.skip # :nodoc:
-      @skip ||= begin
-        case ENV['FARADAY_DEPRECATE'].to_s.downcase
-        when '1', 'warn' then :warn
-        else :skip
-        end
-      end
-      @skip == :skip
-    end
-
-    def self.skip=(value) # :nodoc:
-      @skip = value ? :skip : :warn
-    end
-
-    # Temporarily turn off warnings. Intended for tests only.
-    def skip_during
-      original = Faraday::Deprecate.skip
-      Faraday::Deprecate.skip, = true
-      yield
-    ensure
-      Faraday::Deprecate.skip = original
-    end
-
-    # Simple deprecation method that deprecates +name+ by wrapping it up
-    # in a dummy method. It warns on each call to the dummy method
-    # telling the user of +repl+ (unless +repl+ is :none) and the
-    # semver that it is planned to go away.
-    # @param name [Symbol] the method symbol to deprecate
-    # @param repl [#to_s, :none] the replacement to use, when `:none` it will
-    #   alert the user that no replacemtent is present.
-    # @param ver [String] the semver the method will be removed.
-    def deprecate(name, repl, ver)
-      class_eval do
-        gem_ver = Gem::Version.new(ver)
-        old = "_deprecated_#{name}"
-        alias_method old, name
-        define_method name do |*args, &block|
-          mod = is_a? Module
-          target = mod ? "#{self}." : "#{self.class}#"
-          target_message = if name == :inherited
-                             "Inheriting #{self}"
-                           else
-                             "#{target}#{name}"
-                           end
-
-          msg = [
-            "NOTE: #{target_message} is deprecated",
-            repl == :none ? ' with no replacement' : "; use #{repl} instead. ",
-            "It will be removed in or after version #{gem_ver}",
-            "\n#{target}#{name} called from #{Gem.location_of_caller.join(':')}"
-          ]
-          warn "#{msg.join}." unless Faraday::Deprecate.skip
-          send old, *args, &block
-        end
-      end
-    end
-
-    module_function :deprecate, :skip_during
-  end
-end

data/lib/faraday/upload_io.rb

@@ -1,67 +0,0 @@
-begin
-  require 'composite_io'
-  require 'parts'
-  require 'stringio'
-rescue LoadError
-  $stderr.puts "Install the multipart-post gem."
-  raise
-end
-
-module Faraday
-  # Similar but not compatible with ::CompositeReadIO provided by multipart-post.
-  class CompositeReadIO
-    def initialize(*parts)
-      @parts = parts.flatten
-      @ios = @parts.map { |part| part.to_io }
-      @index = 0
-    end
-
-    def length
-      @parts.inject(0) { |sum, part| sum + part.length }
-    end
-
-    def rewind
-      @ios.each { |io| io.rewind }
-      @index = 0
-    end
-
-    # Read from IOs in order until `length` bytes have been received.
-    def read(length = nil, outbuf = nil)
-      got_result = false
-      outbuf = outbuf ? outbuf.replace("") : ""
-
-      while io = current_io
-        if result = io.read(length)
-          got_result ||= !result.nil?
-          result.force_encoding("BINARY") if result.respond_to?(:force_encoding)
-          outbuf << result
-          length -= result.length if length
-          break if length == 0
-        end
-        advance_io
-      end
-      (!got_result && length) ? nil : outbuf
-    end
-
-    def close
-      @ios.each { |io| io.close }
-    end
-
-    def ensure_open_and_readable
-      # Rubinius compatibility
-    end
-
-    private
-
-    def current_io
-      @ios[@index]
-    end
-
-    def advance_io
-      @index += 1
-    end
-  end
-
-  UploadIO = ::UploadIO
-  Parts = ::Parts
-end

data/spec/faraday/deprecate_spec.rb

@@ -1,69 +0,0 @@
-# frozen_string_literal: true
-
-RSpec.describe Faraday::DeprecatedClass do
-  class SampleClass < StandardError
-    attr_accessor :foo
-
-    def initialize(foo = nil)
-      @foo = foo || :foo
-    end
-  end
-
-  SampleDeprecatedClass = Faraday::DeprecatedClass.proxy_class(SampleClass)
-
-  it 'does not raise error for deprecated classes but prints an error message' do
-    error_message, foobar = with_warn_squelching { SampleDeprecatedClass.new(:foo_bar) }
-    expect(foobar).to be_a(SampleClass)
-    expect(foobar.foo).to eq(:foo_bar)
-    expect(error_message).to match(
-      Regexp.new(
-        'NOTE: SampleDeprecatedClass.new is deprecated; '\
-        'use SampleClass.new instead. It will be removed in or after version 1.0'
-      )
-    )
-  end
-
-  it 'does not raise an error for inherited error-namespaced classes but prints an error message' do
-    error_message, = with_warn_squelching { Class.new(SampleDeprecatedClass) }
-
-    expect(error_message).to match(
-      Regexp.new(
-        'NOTE: Inheriting SampleDeprecatedClass is deprecated; '\
-        'use SampleClass instead. It will be removed in or after version 1.0'
-      )
-    )
-  end
-
-  it 'allows backward-compatible class to be subclassed' do
-    expect {
-      with_warn_squelching { Class.new(SampleDeprecatedClass) }
-    }.not_to raise_error
-  end
-
-  it 'allows rescuing of a current error with a deprecated error' do
-    expect { raise SampleClass, nil }.to raise_error(SampleDeprecatedClass)
-  end
-
-  it 'allows rescuing of a current error with a current error' do
-    expect { raise SampleClass, nil }.to raise_error(SampleClass)
-  end
-
-  it 'allows rescuing of a deprecated error with a deprecated error' do
-    expect { raise SampleDeprecatedClass, nil }.to raise_error(SampleDeprecatedClass)
-  end
-
-  it 'allows rescuing of a deprecated error with a current error' do
-    expect { raise SampleDeprecatedClass, nil }.to raise_error(SampleClass)
-  end
-
-
-  def with_warn_squelching
-    stderr_catcher = StringIO.new
-    original_stderr = $stderr
-    $stderr = stderr_catcher
-    result = yield if block_given?
-    [stderr_catcher.tap(&:rewind).string, result]
-  ensure
-    $stderr = original_stderr
-  end
-end

data/test/adapters/default_test.rb

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

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

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

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

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

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