Class: Typhoeus::Request
- Inherits:
-
Object
- Object
- Typhoeus::Request
- Extended by:
- Actions
- Includes:
- Before, BlockConnection, Cacheable, Callbacks, Callbacks::Types, Marshal, Memoizable, Operations, Responseable, Stubbable
- Defined in:
- lib/typhoeus/request.rb,
lib/typhoeus/request/before.rb,
lib/typhoeus/request/actions.rb,
lib/typhoeus/request/marshal.rb,
lib/typhoeus/request/cacheable.rb,
lib/typhoeus/request/callbacks.rb,
lib/typhoeus/request/stubbable.rb,
lib/typhoeus/request/memoizable.rb,
lib/typhoeus/request/operations.rb,
lib/typhoeus/request/responseable.rb,
lib/typhoeus/request/block_connection.rb
Overview
This class represents a request.
Defined Under Namespace
Modules: Actions, Before, BlockConnection, Cacheable, Callbacks, Marshal, Memoizable, Operations, Responseable, Stubbable
Instance Attribute Summary collapse
-
#base_url ⇒ String
Returns the provided base url.
- #block_connection ⇒ Boolean private
-
#hydra ⇒ Typhoeus::Hydra
private
Returns the hydra in which the request ran, if any.
-
#options ⇒ Hash
Returns options, which includes default parameters.
-
#original_options ⇒ Hash
private
Returns the original options provided.
Instance Method Summary collapse
-
#eql?(other) ⇒ Boolean
private
Returns whether other is equal to self.
-
#hash ⇒ Integer
private
Overrides Object#hash.
-
#initialize(base_url, options = {}) ⇒ Typhoeus::Request
constructor
Creates a new request.
-
#url ⇒ Object
Return the url.
Methods included from Actions
delete, get, head, patch, post, put
Methods included from Before
Methods included from Stubbable
Methods included from BlockConnection
Methods included from Cacheable
#cache_ttl, #cacheable?, #response=, #run
Methods included from Memoizable
Methods included from Responseable
Methods included from Operations
Methods included from Marshal
Methods included from Callbacks
Methods included from Callbacks::Types
#on_complete, #on_failure, #on_success
Constructor Details
#initialize(base_url, options = {}) ⇒ Typhoeus::Request
See Ethon::Easy::Options for more options.
Creates a new request.
110 111 112 113 114 115 116 |
# File 'lib/typhoeus/request.rb', line 110 def initialize(base_url, = {}) @base_url = base_url @original_options = @options = .dup set_defaults end |
Instance Attribute Details
#base_url ⇒ String
Returns the provided base url.
39 40 41 |
# File 'lib/typhoeus/request.rb', line 39 def base_url @base_url end |
#block_connection ⇒ Boolean
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
63 64 65 |
# File 'lib/typhoeus/request.rb', line 63 def block_connection @block_connection end |
#hydra ⇒ Typhoeus::Hydra
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
Returns the hydra in which the request ran, if any.
51 52 53 |
# File 'lib/typhoeus/request.rb', line 51 def hydra @hydra end |
#options ⇒ Hash
Returns options, which includes default parameters.
44 45 46 |
# File 'lib/typhoeus/request.rb', line 44 def @options end |
#original_options ⇒ Hash
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
Returns the original options provided.
58 59 60 |
# File 'lib/typhoeus/request.rb', line 58 def @original_options end |
Instance Method Details
#eql?(other) ⇒ Boolean
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
Returns whether other is equal to self.
143 144 145 146 147 |
# File 'lib/typhoeus/request.rb', line 143 def eql?(other) self.class == other.class && self.base_url == other.base_url && fuzzy_hash_eql?(self., other.) end |
#hash ⇒ Integer
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
Overrides Object#hash.
154 155 156 |
# File 'lib/typhoeus/request.rb', line 154 def hash Zlib.crc32 "#{self.class.name}#{base_url}#{}" end |
#url ⇒ Object
Return the url. In contrast to base_url which returns the value you specified, url returns the full url including the parameters.
126 127 128 129 130 131 |
# File 'lib/typhoeus/request.rb', line 126 def url easy = EasyFactory.new(self).get url = easy.url Typhoeus::Pool.release(easy) url end |