Class: Typhoeus::Request

Inherits:
Object
  • Object
show all
Defined in:
lib/typhoeus/request.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(url, options = {}) ⇒ Request

Initialize a new Request

Options:

  • url : Endpoint (URL) of the request

  • options : A hash containing options among :

** :method : :get (default) / :post / :put ** :params : params as a Hash ** :body ** :timeout : timeout (ms) ** :connect_timeout : connect timeout (ms) ** :headers : headers as Hash ** :user_agent : user agent (string) ** :cache_timeout : cache timeout (ms) ** :follow_location ** :max_redirects ** :proxy ** :disable_ssl_peer_verification ** :ssl_cert ** :ssl_cert_type ** :ssl_key ** :ssl_key_type ** :ssl_key_password ** :ssl_cacert ** :ssl_capath ** :verbose ** :username ** :password ** +:auth_method



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/typhoeus/request.rb', line 41

def initialize(url, options = {})
  @method           = options[:method] || :get
  @params           = options[:params]
  @body             = options[:body]
  @timeout          = options[:timeout]
  @connect_timeout  = options[:connect_timeout]
  @headers          = options[:headers] || {}
  @user_agent       = options[:user_agent] || Typhoeus::USER_AGENT
  @cache_timeout    = options[:cache_timeout]
  @follow_location  = options[:follow_location]
  @enable_cookies   = options[:enable_cookies]
  @max_redirects    = options[:max_redirects]
  @proxy            = options[:proxy]
  @disable_ssl_peer_verification = options[:disable_ssl_peer_verification]
  @ssl_cert         = options[:ssl_cert]
  @ssl_cert_type    = options[:ssl_cert_type]
  @ssl_key          = options[:ssl_key]
  @ssl_key_type     = options[:ssl_key_type]
  @ssl_key_password = options[:ssl_key_password]
  @ssl_cacert       = options[:ssl_cacert]
  @ssl_capath       = options[:ssl_capath]
  @verbose          = options[:verbose]
  @username         = options[:username]
  @password         = options[:password]
  @auth_method      = options[:auth_method]

  if @method == :post
    @url = url
  else
    @url = @params ? "#{url}?#{params_string}" : url
  end
  @on_complete      = nil
  @after_complete   = nil
  @handled_response = nil
end

Instance Attribute Details

#auth_method ⇒ Object

Returns the value of attribute auth_method.



5
6
7
 
# File 'lib/typhoeus/request.rb', line 5

def auth_method
  @auth_method
end

#body ⇒ Object

Returns the value of attribute body.



5
6
7
 
# File 'lib/typhoeus/request.rb', line 5

def body
  @body
end

#cache_timeout ⇒ Object

Returns the value of attribute cache_timeout.



5
6
7
 
# File 'lib/typhoeus/request.rb', line 5

def cache_timeout
  @cache_timeout
end

#connect_timeout ⇒ Object

Returns the value of attribute connect_timeout.



5
6
7
 
# File 'lib/typhoeus/request.rb', line 5

def connect_timeout
  @connect_timeout
end

#disable_ssl_peer_verification ⇒ Object

Returns the value of attribute disable_ssl_peer_verification.



5
6
7
 
# File 'lib/typhoeus/request.rb', line 5

def disable_ssl_peer_verification
  @disable_ssl_peer_verification
end

#enable_cookies ⇒ Object

Returns the value of attribute enable_cookies.



5
6
7
 
# File 'lib/typhoeus/request.rb', line 5

def enable_cookies
  @enable_cookies
end

#follow_location ⇒ Object

Returns the value of attribute follow_location.



5
6
7
 
# File 'lib/typhoeus/request.rb', line 5

def follow_location
  @follow_location
end

#headers ⇒ Object 



87
88
89
90
 
# File 'lib/typhoeus/request.rb', line 87

def headers
  @headers["User-Agent"] = @user_agent
  @headers
end

#max_redirects ⇒ Object

Returns the value of attribute max_redirects.



5
6
7
 
# File 'lib/typhoeus/request.rb', line 5

def max_redirects
  @max_redirects
end

#method ⇒ Object

Returns the value of attribute method.



5
6
7
 
# File 'lib/typhoeus/request.rb', line 5

def method
  @method
end

#params ⇒ Object

Returns the value of attribute params.



5
6
7
 
# File 'lib/typhoeus/request.rb', line 5

def params
  @params
end

#password ⇒ Object

Returns the value of attribute password.



5
6
7
 
# File 'lib/typhoeus/request.rb', line 5

def password
  @password
end

#proxy ⇒ Object

Returns the value of attribute proxy.



5
6
7
 
# File 'lib/typhoeus/request.rb', line 5

def proxy
  @proxy
end

#response ⇒ Object

Returns the value of attribute response.



5
6
7
 
# File 'lib/typhoeus/request.rb', line 5

def response
  @response
end

#ssl_cacert ⇒ Object

Returns the value of attribute ssl_cacert.



5
6
7
 
# File 'lib/typhoeus/request.rb', line 5

def ssl_cacert
  @ssl_cacert
end

#ssl_capath ⇒ Object

Returns the value of attribute ssl_capath.



5
6
7
 
# File 'lib/typhoeus/request.rb', line 5

def ssl_capath
  @ssl_capath
end

#ssl_cert ⇒ Object

Returns the value of attribute ssl_cert.



5
6
7
 
# File 'lib/typhoeus/request.rb', line 5

def ssl_cert
  @ssl_cert
end

#ssl_cert_type ⇒ Object

Returns the value of attribute ssl_cert_type.



5
6
7
 
# File 'lib/typhoeus/request.rb', line 5

def ssl_cert_type
  @ssl_cert_type
end

#ssl_key ⇒ Object

Returns the value of attribute ssl_key.



5
6
7
 
# File 'lib/typhoeus/request.rb', line 5

def ssl_key
  @ssl_key
end

#ssl_key_password ⇒ Object

Returns the value of attribute ssl_key_password.



5
6
7
 
# File 'lib/typhoeus/request.rb', line 5

def ssl_key_password
  @ssl_key_password
end

#ssl_key_type ⇒ Object

Returns the value of attribute ssl_key_type.



5
6
7
 
# File 'lib/typhoeus/request.rb', line 5

def ssl_key_type
  @ssl_key_type
end

#timeout ⇒ Object

Returns the value of attribute timeout.



5
6
7
 
# File 'lib/typhoeus/request.rb', line 5

def timeout
  @timeout
end

#url ⇒ Object (readonly)

Returns the value of attribute url.



3
4
5
 
# File 'lib/typhoeus/request.rb', line 3

def url
  @url
end

#user_agent ⇒ Object

Returns the value of attribute user_agent.



5
6
7
 
# File 'lib/typhoeus/request.rb', line 5

def user_agent
  @user_agent
end

#username ⇒ Object

Returns the value of attribute username.



5
6
7
 
# File 'lib/typhoeus/request.rb', line 5

def username
  @username
end

#verbose ⇒ Object

Returns the value of attribute verbose.



5
6
7
 
# File 'lib/typhoeus/request.rb', line 5

def verbose
  @verbose
end

Class Method Details

.delete(url, params = {}) ⇒ Object 



164
165
166
 
# File 'lib/typhoeus/request.rb', line 164

def self.delete(url, params = {})
  run(url, params.merge(:method => :delete))
end

.get(url, params = {}) ⇒ Object 



152
153
154
 
# File 'lib/typhoeus/request.rb', line 152

def self.get(url, params = {})
  run(url, params.merge(:method => :get))
end

.head(url, params = {}) ⇒ Object 



168
169
170
 
# File 'lib/typhoeus/request.rb', line 168

def self.head(url, params = {})
  run(url, params.merge(:method => :head))
end

.post(url, params = {}) ⇒ Object 



156
157
158
 
# File 'lib/typhoeus/request.rb', line 156

def self.post(url, params = {})
  run(url, params.merge(:method => :post))
end

.put(url, params = {}) ⇒ Object 



160
161
162
 
# File 'lib/typhoeus/request.rb', line 160

def self.put(url, params = {})
  run(url, params.merge(:method => :put))
end

.run(url, params) ⇒ Object 



145
146
147
148
149
150
 
# File 'lib/typhoeus/request.rb', line 145

def self.run(url, params)
  r = new(url, params)
  Typhoeus::Hydra.hydra.queue r
  Typhoeus::Hydra.hydra.run
  r.response
end

Instance Method Details

#after_complete(&block) ⇒ Object 



114
115
116
 
# File 'lib/typhoeus/request.rb', line 114

def after_complete(&block)
  @after_complete = block
end

#after_complete=(proc) ⇒ Object 



118
119
120
 
# File 'lib/typhoeus/request.rb', line 118

def after_complete=(proc)
  @after_complete = proc
end

#cache_key ⇒ Object 



141
142
143
 
# File 'lib/typhoeus/request.rb', line 141

def cache_key
  Digest::SHA1.hexdigest(url)
end

#call_after_complete ⇒ Object 



129
130
131
 
# File 'lib/typhoeus/request.rb', line 129

def call_after_complete
   @after_complete.call(@handled_response) if @after_complete
end

#call_handlers ⇒ Object 



122
123
124
125
126
127
 
# File 'lib/typhoeus/request.rb', line 122

def call_handlers
  if @on_complete
    @handled_response = @on_complete.call(response)
    call_after_complete
  end
end

#handled_response ⇒ Object 



137
138
139
 
# File 'lib/typhoeus/request.rb', line 137

def handled_response
  @handled_response || response
end

#handled_response=(val) ⇒ Object 



133
134
135
 
# File 'lib/typhoeus/request.rb', line 133

def handled_response=(val)
  @handled_response = val
end

#host ⇒ Object 



77
78
79
80
81
82
83
84
85
 
# File 'lib/typhoeus/request.rb', line 77

def host
  slash_location = @url.index('/', 8)
  if slash_location
    @url.slice(0, slash_location)
  else
    query_string_location = @url.index('?')
    return query_string_location ? @url.slice(0, query_string_location) : @url
  end
end

#on_complete(&block) ⇒ Object 



106
107
108
 
# File 'lib/typhoeus/request.rb', line 106

def on_complete(&block)
  @on_complete = block
end

#on_complete=(proc) ⇒ Object 



110
111
112
 
# File 'lib/typhoeus/request.rb', line 110

def on_complete=(proc)
  @on_complete = proc
end

#params_string ⇒ Object 



92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/typhoeus/request.rb', line 92

def params_string
  params.keys.sort { |a, b| a.to_s <=> b.to_s }.collect do |k|
    value = params[k]
    if value.is_a? Hash
      value.keys.collect {|sk| Rack::Utils.escape("#{k}[#{sk}]") + "=" + Rack::Utils.escape(value[sk].to_s)}
    elsif value.is_a? Array
      key = Rack::Utils.escape(k.to_s)
      value.collect { |v| "#{key}=#{Rack::Utils.escape(v.to_s)}" }.join('&')
    else
      "#{Rack::Utils.escape(k.to_s)}=#{Rack::Utils.escape(params[k].to_s)}"
    end
  end.flatten.join("&")
end