Class: Faraday::Env
- Inherits:
-
Object
- Object
- Faraday::Env
- Extended by:
- Forwardable
- Defined in:
- lib/faraday/options.rb
Constant Summary collapse
- ContentLength =
'Content-Length'.freeze
- StatusesWithoutBody =
Set.new [204, 304]
- SuccessfulStatuses =
200..299
- MethodsWithBodies =
A Set of HTTP verbs that typically send a body. If no body is set for these requests, the Content-Length header is set to 0.
Set.new [:post, :put, :patch, :options]
Class Method Summary collapse
-
.from(value) ⇒ Object
Public.
-
.member_set ⇒ Object
Internal.
Instance Method Summary collapse
-
#[](key) ⇒ Object
Public.
-
#[]=(key, value) ⇒ Object
Public.
-
#clear_body ⇒ Object
Public.
-
#custom_members ⇒ Object
Internal.
- #in_member_set?(key) ⇒ Boolean
- #inspect ⇒ Object
-
#needs_body? ⇒ Boolean
Public.
-
#parallel? ⇒ Boolean
Public.
-
#parse_body? ⇒ Boolean
Public.
-
#success? ⇒ Boolean
Public.
Class Method Details
.from(value) ⇒ Object
Public
286 287 288 289 290 291 292 |
# File 'lib/faraday/options.rb', line 286 def self.from(value) env = super(value) if value.respond_to?(:custom_members) env.custom_members.update(value.custom_members) end env end |
.member_set ⇒ Object
Internal
368 369 370 |
# File 'lib/faraday/options.rb', line 368 def self.member_set @member_set ||= Set.new(members) end |
Instance Method Details
#[](key) ⇒ Object
Public
295 296 297 298 299 300 301 |
# File 'lib/faraday/options.rb', line 295 def [](key) if in_member_set?(key) super(key) else custom_members[key] end end |
#[]=(key, value) ⇒ Object
Public
304 305 306 307 308 309 310 |
# File 'lib/faraday/options.rb', line 304 def []=(key, value) if in_member_set?(key) super(key, value) else custom_members[key] = value end end |
#clear_body ⇒ Object
Public
323 324 325 326 |
# File 'lib/faraday/options.rb', line 323 def clear_body request_headers[ContentLength] = '0' self.body = '' end |
#custom_members ⇒ Object
Internal
352 353 354 |
# File 'lib/faraday/options.rb', line 352 def custom_members @custom_members ||= {} end |
#in_member_set?(key) ⇒ Boolean
358 359 360 |
# File 'lib/faraday/options.rb', line 358 def in_member_set?(key) self.class.member_set.include?(key.to_sym) end |
#inspect ⇒ Object
338 339 340 341 342 343 344 345 346 347 348 349 |
# File 'lib/faraday/options.rb', line 338 def inspect attrs = [nil] members.each do |mem| if value = send(mem) attrs << "@#{mem}=#{value.inspect}" end end if !custom_members.empty? attrs << "@custom=#{custom_members.inspect}" end %(#<#{self.class}#{attrs.join(" ")}>) end |
#needs_body? ⇒ Boolean
Public
318 319 320 |
# File 'lib/faraday/options.rb', line 318 def needs_body? !body && MethodsWithBodies.include?(method) end |
#parallel? ⇒ Boolean
Public
334 335 336 |
# File 'lib/faraday/options.rb', line 334 def parallel? !!parallel_manager end |
#parse_body? ⇒ Boolean
Public
329 330 331 |
# File 'lib/faraday/options.rb', line 329 def parse_body? !StatusesWithoutBody.include?(status) end |
#success? ⇒ Boolean
Public
313 314 315 |
# File 'lib/faraday/options.rb', line 313 def success? SuccessfulStatuses.include?(status) end |