faraday 1.7.1 → 2.2.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +193 -3
- data/README.md +11 -9
- data/examples/client_spec.rb +19 -19
- data/examples/client_test.rb +22 -22
- data/lib/faraday/adapter/test.rb +10 -4
- data/lib/faraday/adapter.rb +2 -5
- data/lib/faraday/connection.rb +17 -93
- data/lib/faraday/encoders/nested_params_encoder.rb +2 -2
- data/lib/faraday/error.rb +3 -8
- data/lib/faraday/logging/formatter.rb +1 -0
- data/lib/faraday/middleware.rb +0 -1
- data/lib/faraday/middleware_registry.rb +17 -63
- data/lib/faraday/options.rb +3 -3
- data/lib/faraday/rack_builder.rb +23 -20
- data/lib/faraday/request/authorization.rb +32 -38
- data/lib/faraday/request/instrumentation.rb +2 -0
- data/lib/faraday/request/json.rb +55 -0
- data/lib/faraday/request/url_encoded.rb +2 -0
- data/lib/faraday/request.rb +11 -31
- data/lib/faraday/response/json.rb +54 -0
- data/lib/faraday/response/logger.rb +4 -4
- data/lib/faraday/response/raise_error.rb +9 -1
- data/lib/faraday/response.rb +8 -19
- data/lib/faraday/utils/headers.rb +1 -1
- data/lib/faraday/utils.rb +10 -5
- data/lib/faraday/version.rb +1 -1
- data/lib/faraday.rb +11 -39
- data/spec/faraday/connection_spec.rb +136 -85
- data/spec/faraday/middleware_registry_spec.rb +31 -0
- data/spec/faraday/options/env_spec.rb +2 -2
- data/spec/faraday/rack_builder_spec.rb +26 -54
- data/spec/faraday/request/authorization_spec.rb +19 -24
- data/spec/faraday/request/instrumentation_spec.rb +5 -7
- data/spec/faraday/request/json_spec.rb +111 -0
- data/spec/faraday/request/url_encoded_spec.rb +0 -1
- data/spec/faraday/request_spec.rb +4 -15
- data/spec/faraday/response/json_spec.rb +117 -0
- data/spec/faraday/response/raise_error_spec.rb +7 -4
- data/spec/faraday/utils/headers_spec.rb +2 -2
- data/spec/faraday/utils_spec.rb +62 -1
- data/spec/support/fake_safe_buffer.rb +1 -1
- data/spec/support/helper_methods.rb +0 -37
- data/spec/support/shared_examples/adapter.rb +0 -1
- data/spec/support/shared_examples/request_method.rb +5 -18
- metadata +12 -147
- data/lib/faraday/adapter/typhoeus.rb +0 -15
- data/lib/faraday/autoload.rb +0 -87
- data/lib/faraday/dependency_loader.rb +0 -37
- data/lib/faraday/file_part.rb +0 -128
- data/lib/faraday/param_part.rb +0 -53
- data/lib/faraday/request/basic_authentication.rb +0 -20
- data/lib/faraday/request/multipart.rb +0 -106
- data/lib/faraday/request/retry.rb +0 -239
- data/lib/faraday/request/token_authentication.rb +0 -20
- data/spec/faraday/adapter/em_http_spec.rb +0 -49
- data/spec/faraday/adapter/em_synchrony_spec.rb +0 -18
- data/spec/faraday/adapter/excon_spec.rb +0 -49
- data/spec/faraday/adapter/httpclient_spec.rb +0 -73
- data/spec/faraday/adapter/net_http_spec.rb +0 -64
- data/spec/faraday/adapter/patron_spec.rb +0 -18
- data/spec/faraday/adapter/rack_spec.rb +0 -8
- data/spec/faraday/adapter/typhoeus_spec.rb +0 -7
- data/spec/faraday/composite_read_io_spec.rb +0 -80
- data/spec/faraday/request/multipart_spec.rb +0 -302
- data/spec/faraday/request/retry_spec.rb +0 -242
- data/spec/faraday/response/middleware_spec.rb +0 -68
- data/spec/support/webmock_rack_app.rb +0 -68
data/lib/faraday/request.rb
CHANGED
@@ -26,28 +26,11 @@ module Faraday
|
|
26
26
|
# @return [RequestOptions] options
|
27
27
|
#
|
28
28
|
# rubocop:disable Style/StructInheritance
|
29
|
-
class Request < Struct.new(
|
30
|
-
:http_method, :path, :params, :headers, :body, :options
|
31
|
-
)
|
29
|
+
class Request < Struct.new(:http_method, :path, :params, :headers, :body, :options)
|
32
30
|
# rubocop:enable Style/StructInheritance
|
33
31
|
|
34
32
|
extend MiddlewareRegistry
|
35
33
|
|
36
|
-
register_middleware File.expand_path('request', __dir__),
|
37
|
-
url_encoded: [:UrlEncoded, 'url_encoded'],
|
38
|
-
multipart: [:Multipart, 'multipart'],
|
39
|
-
retry: [:Retry, 'retry'],
|
40
|
-
authorization: [:Authorization, 'authorization'],
|
41
|
-
basic_auth: [
|
42
|
-
:BasicAuthentication,
|
43
|
-
'basic_authentication'
|
44
|
-
],
|
45
|
-
token_auth: [
|
46
|
-
:TokenAuthentication,
|
47
|
-
'token_authentication'
|
48
|
-
],
|
49
|
-
instrumentation: [:Instrumentation, 'instrumentation']
|
50
|
-
|
51
34
|
# @param request_method [String]
|
52
35
|
# @yield [request] for block customization, if block given
|
53
36
|
# @yieldparam request [Request]
|
@@ -58,14 +41,6 @@ module Faraday
|
|
58
41
|
end
|
59
42
|
end
|
60
43
|
|
61
|
-
def method
|
62
|
-
warn <<~TEXT
|
63
|
-
WARNING: `Faraday::Request##{__method__}` is deprecated; use `#http_method` instead. It will be removed in or after version 2.0.
|
64
|
-
`Faraday::Request##{__method__}` called from #{caller_locations(1..1).first}
|
65
|
-
TEXT
|
66
|
-
http_method
|
67
|
-
end
|
68
|
-
|
69
44
|
# Replace params, preserving the existing hash type.
|
70
45
|
#
|
71
46
|
# @param hash [Hash] new params
|
@@ -140,11 +115,11 @@ module Faraday
|
|
140
115
|
# @param serialised [Hash] the serialised object.
|
141
116
|
def marshal_load(serialised)
|
142
117
|
self.http_method = serialised[:http_method]
|
143
|
-
self.body
|
144
|
-
self.headers
|
145
|
-
self.path
|
146
|
-
self.params
|
147
|
-
self.options
|
118
|
+
self.body = serialised[:body]
|
119
|
+
self.headers = serialised[:headers]
|
120
|
+
self.path = serialised[:path]
|
121
|
+
self.params = serialised[:params]
|
122
|
+
self.options = serialised[:options]
|
148
123
|
end
|
149
124
|
|
150
125
|
# @return [Env] the Env for this Request
|
@@ -154,3 +129,8 @@ module Faraday
|
|
154
129
|
end
|
155
130
|
end
|
156
131
|
end
|
132
|
+
|
133
|
+
require 'faraday/request/authorization'
|
134
|
+
require 'faraday/request/instrumentation'
|
135
|
+
require 'faraday/request/json'
|
136
|
+
require 'faraday/request/url_encoded'
|
@@ -0,0 +1,54 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
require 'json'
|
4
|
+
|
5
|
+
module Faraday
|
6
|
+
class Response
|
7
|
+
# Parse response bodies as JSON.
|
8
|
+
class Json < Middleware
|
9
|
+
def initialize(app = nil, parser_options: nil, content_type: /\bjson$/, preserve_raw: false)
|
10
|
+
super(app)
|
11
|
+
@parser_options = parser_options
|
12
|
+
@content_types = Array(content_type)
|
13
|
+
@preserve_raw = preserve_raw
|
14
|
+
end
|
15
|
+
|
16
|
+
def on_complete(env)
|
17
|
+
process_response(env) if parse_response?(env)
|
18
|
+
end
|
19
|
+
|
20
|
+
private
|
21
|
+
|
22
|
+
def process_response(env)
|
23
|
+
env[:raw_body] = env[:body] if @preserve_raw
|
24
|
+
env[:body] = parse(env[:body])
|
25
|
+
rescue StandardError, SyntaxError => e
|
26
|
+
raise Faraday::ParsingError.new(e, env[:response])
|
27
|
+
end
|
28
|
+
|
29
|
+
def parse(body)
|
30
|
+
::JSON.parse(body, @parser_options || {}) unless body.strip.empty?
|
31
|
+
end
|
32
|
+
|
33
|
+
def parse_response?(env)
|
34
|
+
process_response_type?(env) &&
|
35
|
+
env[:body].respond_to?(:to_str)
|
36
|
+
end
|
37
|
+
|
38
|
+
def process_response_type?(env)
|
39
|
+
type = response_type(env)
|
40
|
+
@content_types.empty? || @content_types.any? do |pattern|
|
41
|
+
pattern.is_a?(Regexp) ? type.match?(pattern) : type == pattern
|
42
|
+
end
|
43
|
+
end
|
44
|
+
|
45
|
+
def response_type(env)
|
46
|
+
type = env[:response_headers][CONTENT_TYPE].to_s
|
47
|
+
type = type.split(';', 2).first if type.index(';')
|
48
|
+
type
|
49
|
+
end
|
50
|
+
end
|
51
|
+
end
|
52
|
+
end
|
53
|
+
|
54
|
+
Faraday::Response.register_middleware(json: Faraday::Response::Json)
|
@@ -1,6 +1,7 @@
|
|
1
1
|
# frozen_string_literal: true
|
2
2
|
|
3
3
|
require 'forwardable'
|
4
|
+
require 'logger'
|
4
5
|
require 'faraday/logging/formatter'
|
5
6
|
|
6
7
|
module Faraday
|
@@ -11,10 +12,7 @@ module Faraday
|
|
11
12
|
class Logger < Middleware
|
12
13
|
def initialize(app, logger = nil, options = {})
|
13
14
|
super(app)
|
14
|
-
logger ||=
|
15
|
-
require 'logger'
|
16
|
-
::Logger.new($stdout)
|
17
|
-
end
|
15
|
+
logger ||= ::Logger.new($stdout)
|
18
16
|
formatter_class = options.delete(:formatter) || Logging::Formatter
|
19
17
|
@formatter = formatter_class.new(logger: logger, options: options)
|
20
18
|
yield @formatter if block_given?
|
@@ -31,3 +29,5 @@ module Faraday
|
|
31
29
|
end
|
32
30
|
end
|
33
31
|
end
|
32
|
+
|
33
|
+
Faraday::Response.register_middleware(logger: Faraday::Response::Logger)
|
@@ -44,13 +44,21 @@ module Faraday
|
|
44
44
|
body: env.body,
|
45
45
|
request: {
|
46
46
|
method: env.method,
|
47
|
+
url: env.url,
|
47
48
|
url_path: env.url.path,
|
48
|
-
params: env
|
49
|
+
params: query_params(env),
|
49
50
|
headers: env.request_headers,
|
50
51
|
body: env.request_body
|
51
52
|
}
|
52
53
|
}
|
53
54
|
end
|
55
|
+
|
56
|
+
def query_params(env)
|
57
|
+
env.request.params_encoder ||= Faraday::Utils.default_params_encoder
|
58
|
+
env.params_encoder.decode(env.url.query)
|
59
|
+
end
|
54
60
|
end
|
55
61
|
end
|
56
62
|
end
|
63
|
+
|
64
|
+
Faraday::Response.register_middleware(raise_error: Faraday::Response::RaiseError)
|
data/lib/faraday/response.rb
CHANGED
@@ -5,25 +5,9 @@ require 'forwardable'
|
|
5
5
|
module Faraday
|
6
6
|
# Response represents an HTTP response from making an HTTP request.
|
7
7
|
class Response
|
8
|
-
# Used for simple response middleware.
|
9
|
-
class Middleware < Faraday::Middleware
|
10
|
-
# Override this to modify the environment after the response has finished.
|
11
|
-
# Calls the `parse` method if defined
|
12
|
-
# `parse` method can be defined as private, public and protected
|
13
|
-
def on_complete(env)
|
14
|
-
return unless respond_to?(:parse, true) && env.parse_body?
|
15
|
-
|
16
|
-
env.body = parse(env.body)
|
17
|
-
end
|
18
|
-
end
|
19
|
-
|
20
8
|
extend Forwardable
|
21
9
|
extend MiddlewareRegistry
|
22
10
|
|
23
|
-
register_middleware File.expand_path('response', __dir__),
|
24
|
-
raise_error: [:RaiseError, 'raise_error'],
|
25
|
-
logger: [:Logger, 'logger']
|
26
|
-
|
27
11
|
def initialize(env = nil)
|
28
12
|
@env = Env.from(env) if env
|
29
13
|
@on_complete_callbacks = []
|
@@ -42,6 +26,7 @@ module Faraday
|
|
42
26
|
def headers
|
43
27
|
finished? ? env.response_headers : {}
|
44
28
|
end
|
29
|
+
|
45
30
|
def_delegator :headers, :[]
|
46
31
|
|
47
32
|
def body
|
@@ -53,10 +38,10 @@ module Faraday
|
|
53
38
|
end
|
54
39
|
|
55
40
|
def on_complete(&block)
|
56
|
-
if
|
57
|
-
@on_complete_callbacks << block
|
58
|
-
else
|
41
|
+
if finished?
|
59
42
|
yield(env)
|
43
|
+
else
|
44
|
+
@on_complete_callbacks << block
|
60
45
|
end
|
61
46
|
self
|
62
47
|
end
|
@@ -99,3 +84,7 @@ module Faraday
|
|
99
84
|
end
|
100
85
|
end
|
101
86
|
end
|
87
|
+
|
88
|
+
require 'faraday/response/json'
|
89
|
+
require 'faraday/response/logger'
|
90
|
+
require 'faraday/response/raise_error'
|
@@ -111,7 +111,7 @@ module Faraday
|
|
111
111
|
def parse(header_string)
|
112
112
|
return unless header_string && !header_string.empty?
|
113
113
|
|
114
|
-
headers = header_string.split(
|
114
|
+
headers = header_string.split("\r\n")
|
115
115
|
|
116
116
|
# Find the last set of response headers.
|
117
117
|
start_index = headers.rindex { |x| x.start_with?('HTTP/') } || 0
|
data/lib/faraday/utils.rb
CHANGED
@@ -1,5 +1,7 @@
|
|
1
1
|
# frozen_string_literal: true
|
2
2
|
|
3
|
+
require 'base64'
|
4
|
+
require 'uri'
|
3
5
|
require 'faraday/utils/headers'
|
4
6
|
require 'faraday/utils/params_hash'
|
5
7
|
|
@@ -51,6 +53,12 @@ module Faraday
|
|
51
53
|
@default_params_encoder ||= NestedParamsEncoder
|
52
54
|
end
|
53
55
|
|
56
|
+
def basic_header_from(login, pass)
|
57
|
+
value = Base64.encode64("#{login}:#{pass}")
|
58
|
+
value.delete!("\n")
|
59
|
+
"Basic #{value}"
|
60
|
+
end
|
61
|
+
|
54
62
|
class << self
|
55
63
|
attr_writer :default_params_encoder
|
56
64
|
end
|
@@ -71,10 +79,7 @@ module Faraday
|
|
71
79
|
end
|
72
80
|
|
73
81
|
def default_uri_parser
|
74
|
-
@default_uri_parser ||=
|
75
|
-
require 'uri'
|
76
|
-
Kernel.method(:URI)
|
77
|
-
end
|
82
|
+
@default_uri_parser ||= Kernel.method(:URI)
|
78
83
|
end
|
79
84
|
|
80
85
|
def default_uri_parser=(parser)
|
@@ -96,7 +101,7 @@ module Faraday
|
|
96
101
|
# Recursive hash update
|
97
102
|
def deep_merge!(target, hash)
|
98
103
|
hash.each do |key, value|
|
99
|
-
target[key] = if value.is_a?(Hash) && target[key].is_a?(Hash)
|
104
|
+
target[key] = if value.is_a?(Hash) && (target[key].is_a?(Hash) || target[key].is_a?(Options))
|
100
105
|
deep_merge(target[key], value)
|
101
106
|
else
|
102
107
|
value
|
data/lib/faraday/version.rb
CHANGED
data/lib/faraday.rb
CHANGED
@@ -4,16 +4,10 @@ require 'cgi'
|
|
4
4
|
require 'date'
|
5
5
|
require 'set'
|
6
6
|
require 'forwardable'
|
7
|
-
require 'faraday/middleware_registry'
|
8
|
-
require 'faraday/dependency_loader'
|
9
|
-
|
10
|
-
unless defined?(::Faraday::Timer)
|
11
|
-
require 'timeout'
|
12
|
-
::Faraday::Timer = Timeout
|
13
|
-
end
|
14
|
-
|
15
7
|
require 'faraday/version'
|
16
8
|
require 'faraday/methods'
|
9
|
+
require 'faraday/error'
|
10
|
+
require 'faraday/middleware_registry'
|
17
11
|
require 'faraday/utils'
|
18
12
|
require 'faraday/options'
|
19
13
|
require 'faraday/connection'
|
@@ -23,21 +17,7 @@ require 'faraday/middleware'
|
|
23
17
|
require 'faraday/adapter'
|
24
18
|
require 'faraday/request'
|
25
19
|
require 'faraday/response'
|
26
|
-
require 'faraday/error'
|
27
|
-
require 'faraday/file_part'
|
28
|
-
require 'faraday/param_part'
|
29
|
-
|
30
|
-
unless defined?(JRUBY_VERSION)
|
31
|
-
require 'faraday/em_http'
|
32
|
-
require 'faraday/em_synchrony'
|
33
|
-
end
|
34
|
-
require 'faraday/excon'
|
35
|
-
require 'faraday/httpclient'
|
36
20
|
require 'faraday/net_http'
|
37
|
-
require 'faraday/net_http_persistent'
|
38
|
-
require 'faraday/patron'
|
39
|
-
require 'faraday/rack'
|
40
|
-
|
41
21
|
# This is the main namespace for Faraday.
|
42
22
|
#
|
43
23
|
# It provides methods to create {Connection} objects, and HTTP-related
|
@@ -51,6 +31,8 @@ require 'faraday/rack'
|
|
51
31
|
# conn.get '/'
|
52
32
|
#
|
53
33
|
module Faraday
|
34
|
+
CONTENT_TYPE = 'Content-Type'
|
35
|
+
|
54
36
|
class << self
|
55
37
|
# The root path that Faraday is being loaded from.
|
56
38
|
#
|
@@ -65,13 +47,17 @@ module Faraday
|
|
65
47
|
|
66
48
|
# @overload default_adapter
|
67
49
|
# Gets the Symbol key identifying a default Adapter to use
|
68
|
-
# for the default {Faraday::Connection}. Defaults to `:
|
50
|
+
# for the default {Faraday::Connection}. Defaults to `:test`.
|
69
51
|
# @return [Symbol] the default adapter
|
70
52
|
# @overload default_adapter=(adapter)
|
71
53
|
# Updates default adapter while resetting {.default_connection}.
|
72
54
|
# @return [Symbol] the new default_adapter.
|
73
55
|
attr_reader :default_adapter
|
74
56
|
|
57
|
+
# Option for the default_adapter
|
58
|
+
# @return [Hash] default_adapter options
|
59
|
+
attr_accessor :default_adapter_options
|
60
|
+
|
75
61
|
# Documented below, see default_connection
|
76
62
|
attr_writer :default_connection
|
77
63
|
|
@@ -108,23 +94,10 @@ module Faraday
|
|
108
94
|
# params: { page: 1 }
|
109
95
|
# # => Faraday::Connection to http://faraday.com?page=1
|
110
96
|
def new(url = nil, options = {}, &block)
|
111
|
-
options =
|
97
|
+
options = Utils.deep_merge(default_connection_options, options)
|
112
98
|
Faraday::Connection.new(url, options, &block)
|
113
99
|
end
|
114
100
|
|
115
|
-
# @private
|
116
|
-
# Internal: Requires internal Faraday libraries.
|
117
|
-
#
|
118
|
-
# @param libs [Array] one or more relative String names to Faraday classes.
|
119
|
-
# @return [void]
|
120
|
-
def require_libs(*libs)
|
121
|
-
libs.each do |lib|
|
122
|
-
require "#{lib_path}/#{lib}"
|
123
|
-
end
|
124
|
-
end
|
125
|
-
|
126
|
-
alias require_lib require_libs
|
127
|
-
|
128
101
|
# Documented elsewhere, see default_adapter reader
|
129
102
|
def default_adapter=(adapter)
|
130
103
|
@default_connection = nil
|
@@ -180,6 +153,5 @@ module Faraday
|
|
180
153
|
self.root_path = File.expand_path __dir__
|
181
154
|
self.lib_path = File.expand_path 'faraday', __dir__
|
182
155
|
self.default_adapter = :net_http
|
183
|
-
|
184
|
-
require_lib 'autoload' unless ENV['FARADAY_NO_AUTOLOAD']
|
156
|
+
self.default_adapter_options = {}
|
185
157
|
end
|