RubyGems - faraday - Versions diffs - 0.15.4 → 1.6.0 - Mend

faraday 0.15.4 → 1.6.0

Files changed (104) hide show

checksums.yaml +4 -4
data/CHANGELOG.md +380 -0
data/LICENSE.md +1 -1
data/README.md +16 -344
data/Rakefile +7 -0
data/examples/client_spec.rb +65 -0
data/examples/client_test.rb +79 -0
data/lib/faraday.rb +127 -190
data/lib/faraday/adapter.rb +72 -22
data/lib/faraday/adapter/test.rb +86 -53
data/lib/faraday/adapter/typhoeus.rb +4 -1
data/lib/faraday/adapter_registry.rb +30 -0
data/lib/faraday/autoload.rb +39 -36
data/lib/faraday/connection.rb +320 -183
data/lib/faraday/dependency_loader.rb +37 -0
data/lib/faraday/encoders/flat_params_encoder.rb +105 -0
data/lib/faraday/encoders/nested_params_encoder.rb +176 -0
data/lib/faraday/error.rb +123 -37
data/lib/faraday/file_part.rb +128 -0
data/lib/faraday/logging/formatter.rb +105 -0
data/lib/faraday/methods.rb +6 -0
data/lib/faraday/middleware.rb +19 -25
data/lib/faraday/middleware_registry.rb +129 -0
data/lib/faraday/options.rb +39 -194
data/lib/faraday/options/connection_options.rb +22 -0
data/lib/faraday/options/env.rb +181 -0
data/lib/faraday/options/proxy_options.rb +32 -0
data/lib/faraday/options/request_options.rb +22 -0
data/lib/faraday/options/ssl_options.rb +59 -0
data/lib/faraday/param_part.rb +53 -0
data/lib/faraday/parameters.rb +4 -197
data/lib/faraday/rack_builder.rb +77 -65
data/lib/faraday/request.rb +86 -44
data/lib/faraday/request/authorization.rb +44 -30
data/lib/faraday/request/basic_authentication.rb +14 -7
data/lib/faraday/request/instrumentation.rb +45 -27
data/lib/faraday/request/multipart.rb +86 -48
data/lib/faraday/request/retry.rb +198 -169
data/lib/faraday/request/token_authentication.rb +15 -10
data/lib/faraday/request/url_encoded.rb +43 -23
data/lib/faraday/response.rb +27 -23
data/lib/faraday/response/logger.rb +22 -69
data/lib/faraday/response/raise_error.rb +49 -14
data/lib/faraday/utils.rb +38 -247
data/lib/faraday/utils/headers.rb +139 -0
data/lib/faraday/utils/params_hash.rb +61 -0
data/lib/faraday/version.rb +5 -0
data/spec/external_adapters/faraday_specs_setup.rb +14 -0
data/spec/faraday/adapter/em_http_spec.rb +49 -0
data/spec/faraday/adapter/em_synchrony_spec.rb +18 -0
data/spec/faraday/adapter/excon_spec.rb +49 -0
data/spec/faraday/adapter/httpclient_spec.rb +73 -0
data/spec/faraday/adapter/net_http_spec.rb +64 -0
data/spec/faraday/adapter/patron_spec.rb +18 -0
data/spec/faraday/adapter/rack_spec.rb +8 -0
data/spec/faraday/adapter/test_spec.rb +260 -0
data/spec/faraday/adapter/typhoeus_spec.rb +7 -0
data/spec/faraday/adapter_registry_spec.rb +28 -0
data/spec/faraday/adapter_spec.rb +55 -0
data/spec/faraday/composite_read_io_spec.rb +80 -0
data/spec/faraday/connection_spec.rb +736 -0
data/spec/faraday/error_spec.rb +60 -0
data/spec/faraday/middleware_spec.rb +52 -0
data/spec/faraday/options/env_spec.rb +70 -0
data/spec/faraday/options/options_spec.rb +297 -0
data/spec/faraday/options/proxy_options_spec.rb +44 -0
data/spec/faraday/options/request_options_spec.rb +19 -0
data/spec/faraday/params_encoders/flat_spec.rb +42 -0
data/spec/faraday/params_encoders/nested_spec.rb +142 -0
data/spec/faraday/rack_builder_spec.rb +345 -0
data/spec/faraday/request/authorization_spec.rb +88 -0
data/spec/faraday/request/instrumentation_spec.rb +76 -0
data/spec/faraday/request/multipart_spec.rb +302 -0
data/spec/faraday/request/retry_spec.rb +242 -0
data/spec/faraday/request/url_encoded_spec.rb +83 -0
data/spec/faraday/request_spec.rb +120 -0
data/spec/faraday/response/logger_spec.rb +220 -0
data/spec/faraday/response/middleware_spec.rb +68 -0
data/spec/faraday/response/raise_error_spec.rb +169 -0
data/spec/faraday/response_spec.rb +75 -0
data/spec/faraday/utils/headers_spec.rb +82 -0
data/spec/faraday/utils_spec.rb +56 -0
data/spec/faraday_spec.rb +37 -0
data/spec/spec_helper.rb +132 -0
data/spec/support/disabling_stub.rb +14 -0
data/spec/support/fake_safe_buffer.rb +15 -0
data/spec/support/helper_methods.rb +133 -0
data/spec/support/shared_examples/adapter.rb +105 -0
data/spec/support/shared_examples/params_encoder.rb +18 -0
data/spec/support/shared_examples/request_method.rb +262 -0
data/spec/support/streaming_response_checker.rb +35 -0
data/spec/support/webmock_rack_app.rb +68 -0
metadata +206 -19
data/lib/faraday/adapter/em_http.rb +0 -243
data/lib/faraday/adapter/em_http_ssl_patch.rb +0 -56
data/lib/faraday/adapter/em_synchrony.rb +0 -106
data/lib/faraday/adapter/em_synchrony/parallel_manager.rb +0 -66
data/lib/faraday/adapter/excon.rb +0 -82
data/lib/faraday/adapter/httpclient.rb +0 -128
data/lib/faraday/adapter/net_http.rb +0 -152
data/lib/faraday/adapter/net_http_persistent.rb +0 -68
data/lib/faraday/adapter/patron.rb +0 -95
data/lib/faraday/adapter/rack.rb +0 -58
data/lib/faraday/upload_io.rb +0 -67

data/spec/faraday/response/middleware_spec.rb ADDED Viewed

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+RSpec.describe Faraday::Response::Middleware do
+  let(:conn) do
+    Faraday.new do |b|
+      b.use custom_middleware
+      b.adapter :test do |stub|
+        stub.get('ok') { [200, { 'Content-Type' => 'text/html' }, '<body></body>'] }
+        stub.get('not_modified') { [304, nil, nil] }
+        stub.get('no_content') { [204, nil, nil] }
+      end
+    end
+  end
+  context 'with a custom ResponseMiddleware' do
+    let(:custom_middleware) do
+      Class.new(Faraday::Response::Middleware) do
+        def parse(body)
+          body.upcase
+        end
+      end
+    end
+    it 'parses the response' do
+      expect(conn.get('ok').body).to eq('<BODY></BODY>')
+    end
+  end
+  context 'with a custom ResponseMiddleware and private parse' do
+    let(:custom_middleware) do
+      Class.new(Faraday::Response::Middleware) do
+        private
+        def parse(body)
+          body.upcase
+        end
+      end
+    end
+    it 'parses the response' do
+      expect(conn.get('ok').body).to eq('<BODY></BODY>')
+    end
+  end
+  context 'with a custom ResponseMiddleware but empty response' do
+    let(:custom_middleware) do
+      Class.new(Faraday::Response::Middleware) do
+        def parse(_body)
+          raise 'this should not be called'
+        end
+      end
+    end
+    it 'raises exception for 200 responses' do
+      expect { conn.get('ok') }.to raise_error(StandardError)
+    end
+    it 'doesn\'t call the middleware for 204 responses' do
+      expect_any_instance_of(custom_middleware).not_to receive(:parse)
+      expect(conn.get('no_content').body).to be_nil
+    end
+    it 'doesn\'t call the middleware for 304 responses' do
+      expect_any_instance_of(custom_middleware).not_to receive(:parse)
+      expect(conn.get('not_modified').body).to be_nil
+    end
+  end
+end

data/spec/faraday/response/raise_error_spec.rb ADDED Viewed

@@ -0,0 +1,169 @@
+# frozen_string_literal: true
+RSpec.describe Faraday::Response::RaiseError do
+  let(:conn) do
+    Faraday.new do |b|
+      b.response :raise_error
+      b.adapter :test do |stub|
+        stub.get('ok') { [200, { 'Content-Type' => 'text/html' }, '<body></body>'] }
+        stub.get('bad-request') { [400, { 'X-Reason' => 'because' }, 'keep looking'] }
+        stub.get('unauthorized') { [401, { 'X-Reason' => 'because' }, 'keep looking'] }
+        stub.get('forbidden') { [403, { 'X-Reason' => 'because' }, 'keep looking'] }
+        stub.get('not-found') { [404, { 'X-Reason' => 'because' }, 'keep looking'] }
+        stub.get('proxy-error') { [407, { 'X-Reason' => 'because' }, 'keep looking'] }
+        stub.get('conflict') { [409, { 'X-Reason' => 'because' }, 'keep looking'] }
+        stub.get('unprocessable-entity') { [422, { 'X-Reason' => 'because' }, 'keep looking'] }
+        stub.get('4xx') { [499, { 'X-Reason' => 'because' }, 'keep looking'] }
+        stub.get('nil-status') { [nil, { 'X-Reason' => 'nil' }, 'fail'] }
+        stub.get('server-error') { [500, { 'X-Error' => 'bailout' }, 'fail'] }
+      end
+    end
+  end
+  it 'raises no exception for 200 responses' do
+    expect { conn.get('ok') }.not_to raise_error
+  end
+  it 'raises Faraday::BadRequestError for 400 responses' do
+    expect { conn.get('bad-request') }.to raise_error(Faraday::BadRequestError) do |ex|
+      expect(ex.message).to eq('the server responded with status 400')
+      expect(ex.response[:headers]['X-Reason']).to eq('because')
+      expect(ex.response[:status]).to eq(400)
+      expect(ex.response_status).to eq(400)
+      expect(ex.response_body).to eq('keep looking')
+      expect(ex.response_headers['X-Reason']).to eq('because')
+    end
+  end
+  it 'raises Faraday::UnauthorizedError for 401 responses' do
+    expect { conn.get('unauthorized') }.to raise_error(Faraday::UnauthorizedError) do |ex|
+      expect(ex.message).to eq('the server responded with status 401')
+      expect(ex.response[:headers]['X-Reason']).to eq('because')
+      expect(ex.response[:status]).to eq(401)
+      expect(ex.response_status).to eq(401)
+      expect(ex.response_body).to eq('keep looking')
+      expect(ex.response_headers['X-Reason']).to eq('because')
+    end
+  end
+  it 'raises Faraday::ForbiddenError for 403 responses' do
+    expect { conn.get('forbidden') }.to raise_error(Faraday::ForbiddenError) do |ex|
+      expect(ex.message).to eq('the server responded with status 403')
+      expect(ex.response[:headers]['X-Reason']).to eq('because')
+      expect(ex.response[:status]).to eq(403)
+      expect(ex.response_status).to eq(403)
+      expect(ex.response_body).to eq('keep looking')
+      expect(ex.response_headers['X-Reason']).to eq('because')
+    end
+  end
+  it 'raises Faraday::ResourceNotFound for 404 responses' do
+    expect { conn.get('not-found') }.to raise_error(Faraday::ResourceNotFound) do |ex|
+      expect(ex.message).to eq('the server responded with status 404')
+      expect(ex.response[:headers]['X-Reason']).to eq('because')
+      expect(ex.response[:status]).to eq(404)
+      expect(ex.response_status).to eq(404)
+      expect(ex.response_body).to eq('keep looking')
+      expect(ex.response_headers['X-Reason']).to eq('because')
+    end
+  end
+  it 'raises Faraday::ProxyAuthError for 407 responses' do
+    expect { conn.get('proxy-error') }.to raise_error(Faraday::ProxyAuthError) do |ex|
+      expect(ex.message).to eq('407 "Proxy Authentication Required"')
+      expect(ex.response[:headers]['X-Reason']).to eq('because')
+      expect(ex.response[:status]).to eq(407)
+      expect(ex.response_status).to eq(407)
+      expect(ex.response_body).to eq('keep looking')
+      expect(ex.response_headers['X-Reason']).to eq('because')
+    end
+  end
+  it 'raises Faraday::ConflictError for 409 responses' do
+    expect { conn.get('conflict') }.to raise_error(Faraday::ConflictError) do |ex|
+      expect(ex.message).to eq('the server responded with status 409')
+      expect(ex.response[:headers]['X-Reason']).to eq('because')
+      expect(ex.response[:status]).to eq(409)
+      expect(ex.response_status).to eq(409)
+      expect(ex.response_body).to eq('keep looking')
+      expect(ex.response_headers['X-Reason']).to eq('because')
+    end
+  end
+  it 'raises Faraday::UnprocessableEntityError for 422 responses' do
+    expect { conn.get('unprocessable-entity') }.to raise_error(Faraday::UnprocessableEntityError) do |ex|
+      expect(ex.message).to eq('the server responded with status 422')
+      expect(ex.response[:headers]['X-Reason']).to eq('because')
+      expect(ex.response[:status]).to eq(422)
+      expect(ex.response_status).to eq(422)
+      expect(ex.response_body).to eq('keep looking')
+      expect(ex.response_headers['X-Reason']).to eq('because')
+    end
+  end
+  it 'raises Faraday::NilStatusError for nil status in response' do
+    expect { conn.get('nil-status') }.to raise_error(Faraday::NilStatusError) do |ex|
+      expect(ex.message).to eq('http status could not be derived from the server response')
+      expect(ex.response[:headers]['X-Reason']).to eq('nil')
+      expect(ex.response[:status]).to be_nil
+      expect(ex.response_status).to be_nil
+      expect(ex.response_body).to eq('fail')
+      expect(ex.response_headers['X-Reason']).to eq('nil')
+    end
+  end
+  it 'raises Faraday::ClientError for other 4xx responses' do
+    expect { conn.get('4xx') }.to raise_error(Faraday::ClientError) do |ex|
+      expect(ex.message).to eq('the server responded with status 499')
+      expect(ex.response[:headers]['X-Reason']).to eq('because')
+      expect(ex.response[:status]).to eq(499)
+      expect(ex.response_status).to eq(499)
+      expect(ex.response_body).to eq('keep looking')
+      expect(ex.response_headers['X-Reason']).to eq('because')
+    end
+  end
+  it 'raises Faraday::ServerError for 500 responses' do
+    expect { conn.get('server-error') }.to raise_error(Faraday::ServerError) do |ex|
+      expect(ex.message).to eq('the server responded with status 500')
+      expect(ex.response[:headers]['X-Error']).to eq('bailout')
+      expect(ex.response[:status]).to eq(500)
+      expect(ex.response_status).to eq(500)
+      expect(ex.response_body).to eq('fail')
+      expect(ex.response_headers['X-Error']).to eq('bailout')
+    end
+  end
+  describe 'request info' do
+    let(:conn) do
+      Faraday.new do |b|
+        b.response :raise_error
+        b.adapter :test do |stub|
+          stub.post('request?full=true', request_body, request_headers) do
+            [400, { 'X-Reason' => 'because' }, 'keep looking']
+          end
+        end
+      end
+    end
+    let(:request_body) { JSON.generate({ 'item' => 'sth' }) }
+    let(:request_headers) { { 'Authorization' => 'Basic 123' } }
+    subject(:perform_request) do
+      conn.post 'request' do |req|
+        req.headers['Authorization'] = 'Basic 123'
+        req.params[:full] = true
+        req.body = request_body
+      end
+    end
+    it 'returns the request info in the exception' do
+      expect { perform_request }.to raise_error(Faraday::BadRequestError) do |ex|
+        expect(ex.response[:request][:method]).to eq(:post)
+        expect(ex.response[:request][:url_path]).to eq('/request')
+        expect(ex.response[:request][:params]).to eq({ 'full' => 'true' })
+        expect(ex.response[:request][:headers]).to match(a_hash_including(request_headers))
+        expect(ex.response[:request][:body]).to eq(request_body)
+      end
+    end
+  end
+end

data/spec/faraday/response_spec.rb ADDED Viewed

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+RSpec.describe Faraday::Response do
+  subject { Faraday::Response.new(env) }
+  let(:env) do
+    Faraday::Env.from(status: 404, body: 'yikes',
+                      response_headers: { 'Content-Type' => 'text/plain' })
+  end
+  it { expect(subject.finished?).to be_truthy }
+  it { expect { subject.finish({}) }.to raise_error(RuntimeError) }
+  it { expect(subject.success?).to be_falsey }
+  it { expect(subject.status).to eq(404) }
+  it { expect(subject.body).to eq('yikes') }
+  it { expect(subject.headers['Content-Type']).to eq('text/plain') }
+  it { expect(subject['content-type']).to eq('text/plain') }
+  describe '#apply_request' do
+    before { subject.apply_request(body: 'a=b', method: :post) }
+    it { expect(subject.body).to eq('yikes') }
+    it { expect(subject.env[:method]).to eq(:post) }
+  end
+  describe '#to_hash' do
+    let(:hash) { subject.to_hash }
+    it { expect(hash).to be_a(Hash) }
+    it { expect(hash[:status]).to eq(subject.status) }
+    it { expect(hash[:response_headers]).to eq(subject.headers) }
+    it { expect(hash[:body]).to eq(subject.body) }
+  end
+  describe 'marshal serialization support' do
+    subject { Faraday::Response.new }
+    let(:loaded) { Marshal.load(Marshal.dump(subject)) }
+    before do
+      subject.on_complete {}
+      subject.finish(env.merge(params: 'moo'))
+    end
+    it { expect(loaded.env[:params]).to be_nil }
+    it { expect(loaded.env[:body]).to eq(env[:body]) }
+    it { expect(loaded.env[:response_headers]).to eq(env[:response_headers]) }
+    it { expect(loaded.env[:status]).to eq(env[:status]) }
+  end
+  describe '#on_complete' do
+    subject { Faraday::Response.new }
+    it 'parse body on finish' do
+      subject.on_complete { |env| env[:body] = env[:body].upcase }
+      subject.finish(env)
+      expect(subject.body).to eq('YIKES')
+    end
+    it 'can access response body in on_complete callback' do
+      subject.on_complete { |env| env[:body] = subject.body.upcase }
+      subject.finish(env)
+      expect(subject.body).to eq('YIKES')
+    end
+    it 'can access response body in on_complete callback' do
+      callback_env = nil
+      subject.on_complete { |env| callback_env = env }
+      subject.finish({})
+      expect(subject.env).to eq(callback_env)
+    end
+  end
+end

data/spec/faraday/utils/headers_spec.rb ADDED Viewed

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+RSpec.describe Faraday::Utils::Headers do
+  subject { Faraday::Utils::Headers.new }
+  context 'when Content-Type is set to application/json' do
+    before { subject['Content-Type'] = 'application/json' }
+    it { expect(subject.keys).to eq(['Content-Type']) }
+    it { expect(subject['Content-Type']).to eq('application/json') }
+    it { expect(subject['CONTENT-TYPE']).to eq('application/json') }
+    it { expect(subject['content-type']).to eq('application/json') }
+    it { is_expected.to include('content-type') }
+  end
+  context 'when Content-Type is set to application/xml' do
+    before { subject['Content-Type'] = 'application/xml' }
+    it { expect(subject.keys).to eq(['Content-Type']) }
+    it { expect(subject['Content-Type']).to eq('application/xml') }
+    it { expect(subject['CONTENT-TYPE']).to eq('application/xml') }
+    it { expect(subject['content-type']).to eq('application/xml') }
+    it { is_expected.to include('content-type') }
+  end
+  describe '#fetch' do
+    before { subject['Content-Type'] = 'application/json' }
+    it { expect(subject.fetch('Content-Type')).to eq('application/json') }
+    it { expect(subject.fetch('CONTENT-TYPE')).to eq('application/json') }
+    it { expect(subject.fetch(:content_type)).to eq('application/json') }
+    it { expect(subject.fetch('invalid', 'default')).to eq('default') }
+    it { expect(subject.fetch('invalid', false)).to eq(false) }
+    it { expect(subject.fetch('invalid', nil)).to be_nil }
+    it { expect(subject.fetch('Invalid') { |key| "#{key} key" }).to eq('Invalid key') }
+    it 'calls a block when provided' do
+      block_called = false
+      expect(subject.fetch('content-type') { block_called = true }).to eq('application/json')
+      expect(block_called).to be_falsey
+    end
+    it 'raises an error if key not found' do
+      expected_error = defined?(KeyError) ? KeyError : IndexError
+      expect { subject.fetch('invalid') }.to raise_error(expected_error)
+    end
+  end
+  describe '#delete' do
+    before do
+      subject['Content-Type'] = 'application/json'
+      @deleted = subject.delete('content-type')
+    end
+    it { expect(@deleted).to eq('application/json') }
+    it { expect(subject.size).to eq(0) }
+    it { is_expected.not_to include('content-type') }
+    it { expect(subject.delete('content-type')).to be_nil }
+  end
+  describe '#parse' do
+    before { subject.parse(headers) }
+    context 'when response headers leave http status line out' do
+      let(:headers) { "HTTP/1.1 200 OK\r\nContent-Type: text/html\r\n\r\n" }
+      it { expect(subject.keys).to eq(%w[Content-Type]) }
+      it { expect(subject['Content-Type']).to eq('text/html') }
+      it { expect(subject['content-type']).to eq('text/html') }
+    end
+    context 'when response headers values include a colon' do
+      let(:headers) { "HTTP/1.1 200 OK\r\nContent-Type: text/html\r\nLocation: http://sushi.com/\r\n\r\n" }
+      it { expect(subject['location']).to eq('http://sushi.com/') }
+    end
+    context 'when response headers include a blank line' do
+      let(:headers) { "HTTP/1.1 200 OK\r\n\r\nContent-Type: text/html\r\n\r\n" }
+      it { expect(subject['content-type']).to eq('text/html') }
+    end
+  end
+end

data/spec/faraday/utils_spec.rb ADDED Viewed

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+RSpec.describe Faraday::Utils do
+  describe 'headers parsing' do
+    let(:multi_response_headers) do
+      "HTTP/1.x 500 OK\r\nContent-Type: text/html; charset=UTF-8\r\n" \
+      "HTTP/1.x 200 OK\r\nContent-Type: application/json; charset=UTF-8\r\n\r\n"
+    end
+    it 'parse headers for aggregated responses' do
+      headers = Faraday::Utils::Headers.new
+      headers.parse(multi_response_headers)
+      result = headers.to_hash
+      expect(result['Content-Type']).to eq('application/json; charset=UTF-8')
+    end
+  end
+  describe 'URI parsing' do
+    let(:url) { 'http://example.com/abc' }
+    it 'escapes safe buffer' do
+      str = FakeSafeBuffer.new('$32,000.00')
+      expect(Faraday::Utils.escape(str)).to eq('%2432%2C000.00')
+    end
+    it 'parses with default parser' do
+      with_default_uri_parser(nil) do
+        uri = normalize(url)
+        expect(uri.host).to eq('example.com')
+      end
+    end
+    it 'parses with URI' do
+      with_default_uri_parser(::URI) do
+        uri = normalize(url)
+        expect(uri.host).to eq('example.com')
+      end
+    end
+    it 'parses with block' do
+      with_default_uri_parser(->(u) { "booya#{'!' * u.size}" }) do
+        expect(normalize(url)).to eq('booya!!!!!!!!!!!!!!!!!!!!!!')
+      end
+    end
+    it 'replaces headers hash' do
+      headers = Faraday::Utils::Headers.new('authorization' => 't0ps3cr3t!')
+      expect(headers).to have_key('authorization')
+      headers.replace('content-type' => 'text/plain')
+      expect(headers).not_to have_key('authorization')
+    end
+  end
+end