faraday 0.17.6 → 1.0.0.pre.rc1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (88) hide show
  1. checksums.yaml +4 -4
  2. data/LICENSE.md +1 -1
  3. data/README.md +18 -358
  4. data/lib/faraday/adapter/em_http.rb +142 -99
  5. data/lib/faraday/adapter/em_http_ssl_patch.rb +23 -17
  6. data/lib/faraday/adapter/em_synchrony/parallel_manager.rb +18 -15
  7. data/lib/faraday/adapter/em_synchrony.rb +104 -60
  8. data/lib/faraday/adapter/excon.rb +97 -57
  9. data/lib/faraday/adapter/httpclient.rb +61 -39
  10. data/lib/faraday/adapter/net_http.rb +103 -51
  11. data/lib/faraday/adapter/net_http_persistent.rb +49 -28
  12. data/lib/faraday/adapter/patron.rb +54 -35
  13. data/lib/faraday/adapter/rack.rb +28 -12
  14. data/lib/faraday/adapter/test.rb +86 -53
  15. data/lib/faraday/adapter/typhoeus.rb +4 -1
  16. data/lib/faraday/adapter.rb +36 -22
  17. data/lib/faraday/adapter_registry.rb +28 -0
  18. data/lib/faraday/autoload.rb +47 -36
  19. data/lib/faraday/connection.rb +321 -179
  20. data/lib/faraday/dependency_loader.rb +37 -0
  21. data/lib/faraday/encoders/flat_params_encoder.rb +94 -0
  22. data/lib/faraday/encoders/nested_params_encoder.rb +171 -0
  23. data/lib/faraday/error.rb +21 -79
  24. data/lib/faraday/logging/formatter.rb +92 -0
  25. data/lib/faraday/middleware.rb +4 -28
  26. data/lib/faraday/middleware_registry.rb +129 -0
  27. data/lib/faraday/options/connection_options.rb +22 -0
  28. data/lib/faraday/options/env.rb +181 -0
  29. data/lib/faraday/options/proxy_options.rb +28 -0
  30. data/lib/faraday/options/request_options.rb +21 -0
  31. data/lib/faraday/options/ssl_options.rb +59 -0
  32. data/lib/faraday/options.rb +33 -184
  33. data/lib/faraday/parameters.rb +4 -197
  34. data/lib/faraday/rack_builder.rb +66 -55
  35. data/lib/faraday/request/authorization.rb +42 -30
  36. data/lib/faraday/request/basic_authentication.rb +14 -7
  37. data/lib/faraday/request/instrumentation.rb +45 -27
  38. data/lib/faraday/request/multipart.rb +72 -49
  39. data/lib/faraday/request/retry.rb +197 -171
  40. data/lib/faraday/request/token_authentication.rb +15 -10
  41. data/lib/faraday/request/url_encoded.rb +41 -23
  42. data/lib/faraday/request.rb +68 -38
  43. data/lib/faraday/response/logger.rb +22 -69
  44. data/lib/faraday/response/raise_error.rb +36 -18
  45. data/lib/faraday/response.rb +22 -15
  46. data/lib/faraday/upload_io.rb +31 -30
  47. data/lib/faraday/utils/headers.rb +139 -0
  48. data/lib/faraday/utils/params_hash.rb +61 -0
  49. data/lib/faraday/utils.rb +28 -245
  50. data/lib/faraday.rb +93 -174
  51. data/spec/external_adapters/faraday_specs_setup.rb +14 -0
  52. metadata +25 -51
  53. data/CHANGELOG.md +0 -232
  54. data/Rakefile +0 -13
  55. data/lib/faraday/deprecate.rb +0 -109
  56. data/spec/faraday/deprecate_spec.rb +0 -147
  57. data/spec/faraday/error_spec.rb +0 -102
  58. data/spec/faraday/response/raise_error_spec.rb +0 -106
  59. data/spec/spec_helper.rb +0 -105
  60. data/test/adapters/default_test.rb +0 -14
  61. data/test/adapters/em_http_test.rb +0 -30
  62. data/test/adapters/em_synchrony_test.rb +0 -32
  63. data/test/adapters/excon_test.rb +0 -30
  64. data/test/adapters/httpclient_test.rb +0 -34
  65. data/test/adapters/integration.rb +0 -263
  66. data/test/adapters/logger_test.rb +0 -136
  67. data/test/adapters/net_http_persistent_test.rb +0 -114
  68. data/test/adapters/net_http_test.rb +0 -79
  69. data/test/adapters/patron_test.rb +0 -40
  70. data/test/adapters/rack_test.rb +0 -38
  71. data/test/adapters/test_middleware_test.rb +0 -157
  72. data/test/adapters/typhoeus_test.rb +0 -38
  73. data/test/authentication_middleware_test.rb +0 -65
  74. data/test/composite_read_io_test.rb +0 -109
  75. data/test/connection_test.rb +0 -738
  76. data/test/env_test.rb +0 -268
  77. data/test/helper.rb +0 -75
  78. data/test/live_server.rb +0 -67
  79. data/test/middleware/instrumentation_test.rb +0 -88
  80. data/test/middleware/retry_test.rb +0 -282
  81. data/test/middleware_stack_test.rb +0 -260
  82. data/test/multibyte.txt +0 -1
  83. data/test/options_test.rb +0 -333
  84. data/test/parameters_test.rb +0 -157
  85. data/test/request_middleware_test.rb +0 -126
  86. data/test/response_middleware_test.rb +0 -72
  87. data/test/strawberry.rb +0 -2
  88. data/test/utils_test.rb +0 -98
data/lib/faraday.rb CHANGED
@@ -1,128 +1,153 @@
1
- require 'thread'
1
+ # frozen_string_literal: true
2
+
2
3
  require 'cgi'
3
4
  require 'set'
4
5
  require 'forwardable'
6
+ require 'faraday/middleware_registry'
7
+ require 'faraday/dependency_loader'
5
8
 
6
- # Public: This is the main namespace for Faraday. You can either use it to
7
- # create Faraday::Connection objects, or access it directly.
9
+ # This is the main namespace for Faraday.
8
10
  #
9
- # Examples
11
+ # It provides methods to create {Connection} objects, and HTTP-related
12
+ # methods to use directly.
10
13
  #
14
+ # @example Helpful class methods for easy usage
11
15
  # Faraday.get "http://faraday.com"
12
16
  #
17
+ # @example Helpful class method `.new` to create {Connection} objects.
13
18
  # conn = Faraday.new "http://faraday.com"
14
19
  # conn.get '/'
15
20
  #
16
21
  module Faraday
17
- VERSION = "0.17.6"
22
+ VERSION = '1.0.0-rc1'
23
+ METHODS_WITH_QUERY = %w[get head delete connect trace].freeze
24
+ METHODS_WITH_BODY = %w[post put patch].freeze
18
25
 
19
26
  class << self
20
- # Public: Gets or sets the root path that Faraday is being loaded from.
21
- # This is the root from where the libraries are auto-loaded from.
27
+ # The root path that Faraday is being loaded from.
28
+ #
29
+ # This is the root from where the libraries are auto-loaded.
30
+ #
31
+ # @return [String]
22
32
  attr_accessor :root_path
23
33
 
24
- # Public: Gets or sets the path that the Faraday libs are loaded from.
34
+ # Gets or sets the path that the Faraday libs are loaded from.
35
+ # @return [String]
25
36
  attr_accessor :lib_path
26
37
 
27
- # Public: Gets or sets the Symbol key identifying a default Adapter to use
28
- # for the default Faraday::Connection.
38
+ # @overload default_adapter
39
+ # Gets the Symbol key identifying a default Adapter to use
40
+ # for the default {Faraday::Connection}. Defaults to `:net_http`.
41
+ # @return [Symbol] the default adapter
42
+ # @overload default_adapter=(adapter)
43
+ # Updates default adapter while resetting {.default_connection}.
44
+ # @return [Symbol] the new default_adapter.
29
45
  attr_reader :default_adapter
30
46
 
31
- # Public: Sets the default Faraday::Connection for simple scripts that
32
- # access the Faraday constant directly.
33
- #
34
- # Faraday.get "https://faraday.com"
47
+ # Documented below, see default_connection
35
48
  attr_writer :default_connection
36
49
 
37
- # Public: Tells faraday to ignore the environment proxy (http_proxy).
50
+ # Tells Faraday to ignore the environment proxy (http_proxy).
51
+ # Defaults to `false`.
52
+ # @return [Boolean]
38
53
  attr_accessor :ignore_env_proxy
39
54
 
40
- # Public: Initializes a new Faraday::Connection.
41
- #
42
- # url - The optional String base URL to use as a prefix for all
43
- # requests. Can also be the options Hash.
44
- # options - The optional Hash used to configure this Faraday::Connection.
45
- # Any of these values will be set on every request made, unless
46
- # overridden for a specific request.
47
- # :url - String base URL.
48
- # :params - Hash of URI query unencoded key/value pairs.
49
- # :headers - Hash of unencoded HTTP header key/value pairs.
50
- # :request - Hash of request options.
51
- # :ssl - Hash of SSL options.
52
- # :proxy - Hash of Proxy options.
53
- #
54
- # Examples
55
- #
55
+ # Initializes a new {Connection}.
56
+ #
57
+ # @param url [String,Hash] The optional String base URL to use as a prefix
58
+ # for all requests. Can also be the options Hash. Any of these
59
+ # values will be set on every request made, unless overridden
60
+ # for a specific request.
61
+ # @param options [Hash]
62
+ # @option options [String] :url Base URL
63
+ # @option options [Hash] :params Hash of unencoded URI query params.
64
+ # @option options [Hash] :headers Hash of unencoded HTTP headers.
65
+ # @option options [Hash] :request Hash of request options.
66
+ # @option options [Hash] :ssl Hash of SSL options.
67
+ # @option options [Hash] :proxy Hash of Proxy options.
68
+ # @return [Faraday::Connection]
69
+ #
70
+ # @example With an URL argument
56
71
  # Faraday.new 'http://faraday.com'
57
- #
58
- # # http://faraday.com?page=1
59
- # Faraday.new 'http://faraday.com', :params => {:page => 1}
60
- #
61
- # # same
62
- #
63
- # Faraday.new :url => 'http://faraday.com',
64
- # :params => {:page => 1}
65
- #
66
- # Returns a Faraday::Connection.
67
- def new(url = nil, options = nil, &block)
68
- options = options ? default_connection_options.merge(options) : default_connection_options
72
+ # # => Faraday::Connection to http://faraday.com
73
+ #
74
+ # @example With an URL argument and an options hash
75
+ # Faraday.new 'http://faraday.com', params: { page: 1 }
76
+ # # => Faraday::Connection to http://faraday.com?page=1
77
+ #
78
+ # @example With everything in an options hash
79
+ # Faraday.new url: 'http://faraday.com',
80
+ # params: { page: 1 }
81
+ # # => Faraday::Connection to http://faraday.com?page=1
82
+ def new(url = nil, options = {}, &block)
83
+ options = default_connection_options.merge(options)
69
84
  Faraday::Connection.new(url, options, &block)
70
85
  end
71
86
 
87
+ # @private
72
88
  # Internal: Requires internal Faraday libraries.
73
89
  #
74
- # *libs - One or more relative String names to Faraday classes.
75
- #
76
- # Returns nothing.
90
+ # @param libs [Array] one or more relative String names to Faraday classes.
91
+ # @return [void]
77
92
  def require_libs(*libs)
78
93
  libs.each do |lib|
79
94
  require "#{lib_path}/#{lib}"
80
95
  end
81
96
  end
82
97
 
83
- # Public: Updates default adapter while resetting
84
- # #default_connection.
85
- #
86
- # Returns the new default_adapter.
98
+ alias require_lib require_libs
99
+
100
+ # Documented elsewhere, see default_adapter reader
87
101
  def default_adapter=(adapter)
88
102
  @default_connection = nil
89
103
  @default_adapter = adapter
90
104
  end
91
105
 
92
- alias require_lib require_libs
93
-
94
- def respond_to?(symbol, include_private = false)
106
+ def respond_to_missing?(symbol, include_private = false)
95
107
  default_connection.respond_to?(symbol, include_private) || super
96
108
  end
97
109
 
98
- private
110
+ private
111
+
99
112
  # Internal: Proxies method calls on the Faraday constant to
100
- # #default_connection.
113
+ # .default_connection.
101
114
  def method_missing(name, *args, &block)
102
- default_connection.send(name, *args, &block)
115
+ if default_connection.respond_to?(name)
116
+ default_connection.send(name, *args, &block)
117
+ else
118
+ super
119
+ end
103
120
  end
104
121
  end
105
122
 
106
123
  self.ignore_env_proxy = false
107
- self.root_path = File.expand_path "..", __FILE__
108
- self.lib_path = File.expand_path "../faraday", __FILE__
124
+ self.root_path = File.expand_path __dir__
125
+ self.lib_path = File.expand_path 'faraday', __dir__
109
126
  self.default_adapter = :net_http
110
127
 
111
- # Gets the default connection used for simple scripts.
112
- #
113
- # Returns a Faraday::Connection, configured with the #default_adapter.
128
+ # @overload default_connection
129
+ # Gets the default connection used for simple scripts.
130
+ # @return [Faraday::Connection] a connection configured with
131
+ # the default_adapter.
132
+ # @overload default_connection=(connection)
133
+ # @param connection [Faraday::Connection]
134
+ # Sets the default {Faraday::Connection} for simple scripts that
135
+ # access the Faraday constant directly, such as
136
+ # <code>Faraday.get "https://faraday.com"</code>.
114
137
  def self.default_connection
115
138
  @default_connection ||= Connection.new(default_connection_options)
116
139
  end
117
140
 
118
- # Gets the default connection options used when calling Faraday#new.
141
+ # Gets the default connection options used when calling {Faraday#new}.
119
142
  #
120
- # Returns a Faraday::ConnectionOptions.
143
+ # @return [Faraday::ConnectionOptions]
121
144
  def self.default_connection_options
122
145
  @default_connection_options ||= ConnectionOptions.new
123
146
  end
124
147
 
125
- # Public: Sets the default options used when calling Faraday#new.
148
+ # Sets the default options used when calling {Faraday#new}.
149
+ #
150
+ # @param options [Hash, Faraday::ConnectionOptions]
126
151
  def self.default_connection_options=(options)
127
152
  @default_connection = nil
128
153
  @default_connection_options = ConnectionOptions.from(options)
@@ -133,115 +158,9 @@ module Faraday
133
158
  Timer = Timeout
134
159
  end
135
160
 
136
- # Public: Adds the ability for other modules to register and lookup
137
- # middleware classes.
138
- module MiddlewareRegistry
139
- # Public: Register middleware class(es) on the current module.
140
- #
141
- # mapping - A Hash mapping Symbol keys to classes. Classes can be expressed
142
- # as fully qualified constant, or a Proc that will be lazily
143
- # called to return the former.
144
- #
145
- # Examples
146
- #
147
- # module Faraday
148
- # class Whatever
149
- # # Middleware looked up by :foo returns Faraday::Whatever::Foo.
150
- # register_middleware :foo => Foo
151
- #
152
- # # Middleware looked up by :bar returns Faraday::Whatever.const_get(:Bar)
153
- # register_middleware :bar => :Bar
154
- #
155
- # # Middleware looked up by :baz requires 'baz' and returns Faraday::Whatever.const_get(:Baz)
156
- # register_middleware :baz => [:Baz, 'baz']
157
- # end
158
- # end
159
- #
160
- # Returns nothing.
161
- def register_middleware(autoload_path = nil, mapping = nil)
162
- if mapping.nil?
163
- mapping = autoload_path
164
- autoload_path = nil
165
- end
166
- middleware_mutex do
167
- @middleware_autoload_path = autoload_path if autoload_path
168
- (@registered_middleware ||= {}).update(mapping)
169
- end
170
- end
161
+ require_libs 'utils', 'options', 'connection', 'rack_builder', 'parameters',
162
+ 'middleware', 'adapter', 'request', 'response', 'upload_io',
163
+ 'error'
171
164
 
172
- # Public: Lookup middleware class with a registered Symbol shortcut.
173
- #
174
- # key - The Symbol key for the registered middleware.
175
- #
176
- # Examples
177
- #
178
- # module Faraday
179
- # class Whatever
180
- # register_middleware :foo => Foo
181
- # end
182
- # end
183
- #
184
- # Faraday::Whatever.lookup_middleware(:foo)
185
- # # => Faraday::Whatever::Foo
186
- #
187
- # Returns a middleware Class.
188
- def lookup_middleware(key)
189
- load_middleware(key) ||
190
- raise(Faraday::Error.new("#{key.inspect} is not registered on #{self}"))
191
- end
192
-
193
- def middleware_mutex(&block)
194
- @middleware_mutex ||= begin
195
- require 'monitor'
196
- Monitor.new
197
- end
198
- @middleware_mutex.synchronize(&block)
199
- end
200
-
201
- def fetch_middleware(key)
202
- defined?(@registered_middleware) && @registered_middleware[key]
203
- end
204
-
205
- def load_middleware(key)
206
- value = fetch_middleware(key)
207
- case value
208
- when Module
209
- value
210
- when Symbol, String
211
- middleware_mutex do
212
- @registered_middleware[key] = const_get(value)
213
- end
214
- when Proc
215
- middleware_mutex do
216
- @registered_middleware[key] = value.call
217
- end
218
- when Array
219
- middleware_mutex do
220
- const, path = value
221
- if root = @middleware_autoload_path
222
- path = "#{root}/#{path}"
223
- end
224
- require(path)
225
- @registered_middleware[key] = const
226
- end
227
- load_middleware(key)
228
- end
229
- end
230
- end
231
-
232
- def self.const_missing(name)
233
- if name.to_sym == :Builder
234
- warn "Faraday::Builder is now Faraday::RackBuilder."
235
- const_set name, RackBuilder
236
- else
237
- super
238
- end
239
- end
240
-
241
- require_libs "utils", "options", "connection", "rack_builder", "parameters",
242
- "middleware", "adapter", "request", "response", "upload_io", "error"
243
-
244
- if !ENV["FARADAY_NO_AUTOLOAD"]
245
- require_lib 'autoload'
246
- end
165
+ require_lib 'autoload' unless ENV['FARADAY_NO_AUTOLOAD']
247
166
  end
@@ -0,0 +1,14 @@
1
+ # frozen_string_literal: true
2
+
3
+ require 'webmock/rspec'
4
+ WebMock.disable_net_connect!(allow_localhost: true)
5
+
6
+ require_relative '../support/helper_methods'
7
+ require_relative '../support/disabling_stub'
8
+ require_relative '../support/streaming_response_checker'
9
+ require_relative '../support/shared_examples/adapter'
10
+ require_relative '../support/shared_examples/request_method'
11
+
12
+ RSpec.configure do |config|
13
+ config.include Faraday::HelperMethods
14
+ end
metadata CHANGED
@@ -1,16 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: faraday
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.17.6
4
+ version: 1.0.0.pre.rc1
5
5
  platform: ruby
6
6
  authors:
7
- - "@technoweenie"
8
- - "@iMacTia"
9
- - "@olleolleolle"
7
+ - Rick Olson
10
8
  autorequire:
11
9
  bindir: bin
12
10
  cert_chain: []
13
- date: 2022-11-04 00:00:00.000000000 Z
11
+ date: 2019-07-08 00:00:00.000000000 Z
14
12
  dependencies:
15
13
  - !ruby/object:Gem::Dependency
16
14
  name: multipart-post
@@ -38,10 +36,8 @@ executables: []
38
36
  extensions: []
39
37
  extra_rdoc_files: []
40
38
  files:
41
- - CHANGELOG.md
42
39
  - LICENSE.md
43
40
  - README.md
44
- - Rakefile
45
41
  - lib/faraday.rb
46
42
  - lib/faraday/adapter.rb
47
43
  - lib/faraday/adapter/em_http.rb
@@ -56,12 +52,22 @@ files:
56
52
  - lib/faraday/adapter/rack.rb
57
53
  - lib/faraday/adapter/test.rb
58
54
  - lib/faraday/adapter/typhoeus.rb
55
+ - lib/faraday/adapter_registry.rb
59
56
  - lib/faraday/autoload.rb
60
57
  - lib/faraday/connection.rb
61
- - lib/faraday/deprecate.rb
58
+ - lib/faraday/dependency_loader.rb
59
+ - lib/faraday/encoders/flat_params_encoder.rb
60
+ - lib/faraday/encoders/nested_params_encoder.rb
62
61
  - lib/faraday/error.rb
62
+ - lib/faraday/logging/formatter.rb
63
63
  - lib/faraday/middleware.rb
64
+ - lib/faraday/middleware_registry.rb
64
65
  - lib/faraday/options.rb
66
+ - lib/faraday/options/connection_options.rb
67
+ - lib/faraday/options/env.rb
68
+ - lib/faraday/options/proxy_options.rb
69
+ - lib/faraday/options/request_options.rb
70
+ - lib/faraday/options/ssl_options.rb
65
71
  - lib/faraday/parameters.rb
66
72
  - lib/faraday/rack_builder.rb
67
73
  - lib/faraday/request.rb
@@ -77,63 +83,31 @@ files:
77
83
  - lib/faraday/response/raise_error.rb
78
84
  - lib/faraday/upload_io.rb
79
85
  - lib/faraday/utils.rb
80
- - spec/faraday/deprecate_spec.rb
81
- - spec/faraday/error_spec.rb
82
- - spec/faraday/response/raise_error_spec.rb
83
- - spec/spec_helper.rb
84
- - test/adapters/default_test.rb
85
- - test/adapters/em_http_test.rb
86
- - test/adapters/em_synchrony_test.rb
87
- - test/adapters/excon_test.rb
88
- - test/adapters/httpclient_test.rb
89
- - test/adapters/integration.rb
90
- - test/adapters/logger_test.rb
91
- - test/adapters/net_http_persistent_test.rb
92
- - test/adapters/net_http_test.rb
93
- - test/adapters/patron_test.rb
94
- - test/adapters/rack_test.rb
95
- - test/adapters/test_middleware_test.rb
96
- - test/adapters/typhoeus_test.rb
97
- - test/authentication_middleware_test.rb
98
- - test/composite_read_io_test.rb
99
- - test/connection_test.rb
100
- - test/env_test.rb
101
- - test/helper.rb
102
- - test/live_server.rb
103
- - test/middleware/instrumentation_test.rb
104
- - test/middleware/retry_test.rb
105
- - test/middleware_stack_test.rb
106
- - test/multibyte.txt
107
- - test/options_test.rb
108
- - test/parameters_test.rb
109
- - test/request_middleware_test.rb
110
- - test/response_middleware_test.rb
111
- - test/strawberry.rb
112
- - test/utils_test.rb
113
- homepage: https://lostisland.github.io/faraday
86
+ - lib/faraday/utils/headers.rb
87
+ - lib/faraday/utils/params_hash.rb
88
+ - spec/external_adapters/faraday_specs_setup.rb
89
+ homepage: https://github.com/lostisland/faraday
114
90
  licenses:
115
91
  - MIT
116
- metadata:
117
- homepage_uri: https://lostisland.github.io/faraday
118
- changelog_uri: https://github.com/lostisland/faraday/blob/master/CHANGELOG.md
119
- source_code_uri: https://github.com/lostisland/faraday/
120
- bug_tracker_uri: https://github.com/lostisland/faraday/issues
92
+ metadata: {}
121
93
  post_install_message:
122
94
  rdoc_options: []
123
95
  require_paths:
124
96
  - lib
97
+ - spec/external_adapters
125
98
  required_ruby_version: !ruby/object:Gem::Requirement
126
99
  requirements:
127
100
  - - ">="
128
101
  - !ruby/object:Gem::Version
129
- version: '1.9'
102
+ version: '2.3'
130
103
  required_rubygems_version: !ruby/object:Gem::Requirement
131
104
  requirements:
132
- - - ">="
105
+ - - ">"
133
106
  - !ruby/object:Gem::Version
134
- version: '0'
107
+ version: 1.3.1
135
108
  requirements: []
136
- rubygems_version: 3.3.7
109
+ rubyforge_project:
110
+ rubygems_version: 2.7.6
137
111
  signing_key:
138
112
  specification_version: 4
139
113
  summary: HTTP/REST API client library.