Class: Typhoeus::Easy

Inherits:
Object
  • Object
show all
Defined in:
lib/typhoeus/easy.rb,
ext/typhoeus/typhoeus_easy.c

Constant Summary collapse

CURLINFO_STRING =

These integer codes are available in curl/curl.h

1048576
OPTION_VALUES = 
{
  :CURLOPT_URL            => 10002,
  :CURLOPT_HTTPGET        => 80,
  :CURLOPT_HTTPPOST       => 10024,
  :CURLOPT_UPLOAD         => 46,
  :CURLOPT_CUSTOMREQUEST  => 10036,
  :CURLOPT_POSTFIELDS     => 10015,
  :CURLOPT_COPYPOSTFIELDS     => 10165,
  :CURLOPT_POSTFIELDSIZE  => 60,
  :CURLOPT_USERAGENT      => 10018,
  :CURLOPT_TIMEOUT_MS     => 155,
  # Time-out connect operations after this amount of milliseconds.
  # [Only works on unix-style/SIGALRM operating systems. IOW, does
  # not work on Windows.
  :CURLOPT_CONNECTTIMEOUT_MS  => 156,
  :CURLOPT_NOSIGNAL       => 99,
  :CURLOPT_HTTPHEADER     => 10023,
  :CURLOPT_FOLLOWLOCATION => 52,
  :CURLOPT_MAXREDIRS      => 68,
  :CURLOPT_HTTPAUTH       => 107,
  :CURLOPT_USERPWD        => 10000 + 5,
  :CURLOPT_VERBOSE        => 41,
  :CURLOPT_COOKIEFILE     => 10000 + 31,
  :CURLOPT_PROXY          => 10004,
  :CURLOPT_VERIFYPEER     => 64,
  :CURLOPT_NOBODY         => 44,
  :CURLOPT_ENCODING       => 10000 + 102,
  :CURLOPT_SSLCERT        => 10025,
  :CURLOPT_SSLCERTTYPE    => 10086,
  :CURLOPT_SSLKEY         => 10087,
  :CURLOPT_SSLKEYTYPE     => 10088,
  :CURLOPT_KEYPASSWD      => 10026,
  :CURLOPT_CAINFO         => 10065,
  :CURLOPT_CAPATH         => 10097
}
INFO_VALUES = 
{
  :CURLINFO_RESPONSE_CODE => 2097154,
  :CURLINFO_TOTAL_TIME    => 3145731,
  :CURLINFO_HTTPAUTH_AVAIL => 0x200000 + 23,
  :CURLINFO_EFFECTIVE_URL => 0x100000 + 1
}
AUTH_TYPES = 
{
  :CURLAUTH_BASIC         => 1,
  :CURLAUTH_DIGEST        => 2,
  :CURLAUTH_GSSNEGOTIATE  => 4,
  :CURLAUTH_NTLM          => 8,
  :CURLAUTH_DIGEST_IE     => 16,
  :CURLAUTH_AUTO          => 16 | 8 | 4 | 2 | 1
}

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Easy

Returns a new instance of Easy.



58
59
60
61
62
63
64
 
# File 'lib/typhoeus/easy.rb', line 58

def initialize
  @method = :get
  @headers = {}

  # Enable encoding/compression support
  set_option(OPTION_VALUES[:CURLOPT_ENCODING], '')
end

Instance Attribute Details

#headers ⇒ Object

Returns the value of attribute headers.



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

def headers
  @headers
end

#method ⇒ Object

Returns the value of attribute method.



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

def method
  @method
end

#params ⇒ Object

Returns the value of attribute params.



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

def params
  @params
end

#response_body ⇒ Object (readonly)

Returns the value of attribute response_body.



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

def response_body
  @response_body
end

#response_header ⇒ Object (readonly)

Returns the value of attribute response_header.



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

def response_header
  @response_header
end

#start_time ⇒ Object

Returns the value of attribute start_time.



4
5
6
 
# File 'lib/typhoeus/easy.rb', line 4

def start_time
  @start_time
end

#url ⇒ Object

Returns the value of attribute url.



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

def url
  @url
end

Instance Method Details

#auth=(authinfo) ⇒ Object 



74
75
76
77
 
# File 'lib/typhoeus/easy.rb', line 74

def auth=(authinfo)
  set_option(OPTION_VALUES[:CURLOPT_USERPWD], "#{authinfo[:username]}:#{authinfo[:password]}")
  set_option(OPTION_VALUES[:CURLOPT_HTTPAUTH], authinfo[:method]) if authinfo[:method]
end

#auth_methods ⇒ Object 



79
80
81
 
# File 'lib/typhoeus/easy.rb', line 79

def auth_methods
  get_info_long(INFO_VALUES[:CURLINFO_HTTPAUTH_AVAIL])
end

#connect_timeout=(milliseconds) ⇒ Object 



117
118
119
120
121
 
# File 'lib/typhoeus/easy.rb', line 117

def connect_timeout=(milliseconds)
  @connect_timeout = milliseconds
  set_option(OPTION_VALUES[:CURLOPT_NOSIGNAL], 1)
  set_option(OPTION_VALUES[:CURLOPT_CONNECTTIMEOUT_MS], milliseconds)
end

#curl_version ⇒ Object 



343
344
345
 
# File 'lib/typhoeus/easy.rb', line 343

def curl_version
  version
end

#disable_ssl_peer_verification ⇒ Object 



157
158
159
 
# File 'lib/typhoeus/easy.rb', line 157

def disable_ssl_peer_verification
  set_option(OPTION_VALUES[:CURLOPT_VERIFYPEER], 0)
end

#effective_url ⇒ Object 



91
92
93
 
# File 'lib/typhoeus/easy.rb', line 91

def effective_url
  get_info_string(INFO_VALUES[:CURLINFO_EFFECTIVE_URL])
end

#enable_cookies=(boolean) ⇒ Object 



107
108
109
110
111
 
# File 'lib/typhoeus/easy.rb', line 107

def enable_cookies=(boolean)
  if boolean
    set_option(OPTION_VALUES[:CURLOPT_COOKIEFILE], '')            
  end
end

#failure ⇒ Object

gets called when finished and response code is 300-599



294
295
296
 
# File 'lib/typhoeus/easy.rb', line 294

def failure
  @failure.call(self) if @failure
end

#follow_location=(boolean) ⇒ Object 



99
100
101
102
103
104
105
 
# File 'lib/typhoeus/easy.rb', line 99

def follow_location=(boolean)
  if boolean
    set_option(OPTION_VALUES[:CURLOPT_FOLLOWLOCATION], 1)
  else
    set_option(OPTION_VALUES[:CURLOPT_FOLLOWLOCATION], 0)
  end
end

#get_info_double(option) ⇒ Object 



339
340
341
 
# File 'lib/typhoeus/easy.rb', line 339

def get_info_double(option)
  easy_getinfo_double(option)
end

#get_info_long(option) ⇒ Object 



335
336
337
 
# File 'lib/typhoeus/easy.rb', line 335

def get_info_long(option)
  easy_getinfo_long(option)
end

#get_info_string(option) ⇒ Object 



331
332
333
 
# File 'lib/typhoeus/easy.rb', line 331

def get_info_string(option)
  easy_getinfo_string(option)
end

#increment_retries ⇒ Object 



310
311
312
313
 
# File 'lib/typhoeus/easy.rb', line 310

def increment_retries
  @retries ||= 0
  @retries += 1
end

#max_redirects=(redirects) ⇒ Object 



113
114
115
 
# File 'lib/typhoeus/easy.rb', line 113

def max_redirects=(redirects)
  set_option(OPTION_VALUES[:CURLOPT_MAXREDIRS], redirects)
end

#max_retries ⇒ Object 



315
316
317
 
# File 'lib/typhoeus/easy.rb', line 315

def max_retries
  @max_retries ||= 40
end

#max_retries? ⇒ Boolean

Returns:

  • (Boolean) 


319
320
321
 
# File 'lib/typhoeus/easy.rb', line 319

def max_retries?
  retries >= max_retries
end

#on_failure(&block) ⇒ Object 



298
299
300
 
# File 'lib/typhoeus/easy.rb', line 298

def on_failure(&block)
  @failure = block
end

#on_failure=(block) ⇒ Object 



302
303
304
 
# File 'lib/typhoeus/easy.rb', line 302

def on_failure=(block)
  @failure = block
end

#on_success(&block) ⇒ Object 



285
286
287
 
# File 'lib/typhoeus/easy.rb', line 285

def on_success(&block)
  @success = block
end

#on_success=(block) ⇒ Object 



289
290
291
 
# File 'lib/typhoeus/easy.rb', line 289

def on_success=(block)
  @success = block
end

#perform ⇒ Object 



261
262
263
264
265
266
267
268
269
270
271
 
# File 'lib/typhoeus/easy.rb', line 261

def perform
  set_headers()
  easy_perform()
  resp_code = response_code() 
  if resp_code >= 200 && resp_code <= 299
    success
  else
    failure
  end
  resp_code
end

#post_data=(data) ⇒ Object 



178
179
180
181
182
 
# File 'lib/typhoeus/easy.rb', line 178

def post_data=(data)
  @post_data_set = true
  set_option(OPTION_VALUES[:CURLOPT_POSTFIELDSIZE], data.length)
  set_option(OPTION_VALUES[:CURLOPT_COPYPOSTFIELDS], data)
end

#proxy=(proxy) ⇒ Object 



70
71
72
 
# File 'lib/typhoeus/easy.rb', line 70

def proxy=(proxy)
  set_option(OPTION_VALUES[:CURLOPT_PROXY], proxy)
end

#request_body=(request_body) ⇒ Object 



137
138
139
140
141
142
143
144
145
146
 
# File 'lib/typhoeus/easy.rb', line 137

def request_body=(request_body)
  @request_body = request_body
  if @method == :put
    easy_set_request_body(@request_body)
    headers["Transfer-Encoding"] = ""
    headers["Expect"] = ""
  else
    self.post_data = request_body
  end
end

#reset ⇒ Object 



323
324
325
326
327
328
329
 
# File 'lib/typhoeus/easy.rb', line 323

def reset
  @retries = 0
  @response_code = 0
  @response_header = ""
  @response_body = ""
  easy_reset()
end

#response_code ⇒ Object 



95
96
97
 
# File 'lib/typhoeus/easy.rb', line 95

def response_code
  get_info_long(INFO_VALUES[:CURLINFO_RESPONSE_CODE])
end

#retries ⇒ Object 



306
307
308
 
# File 'lib/typhoeus/easy.rb', line 306

def retries
  @retries ||= 0
end

#set_headers ⇒ Object 



273
274
275
276
277
278
 
# File 'lib/typhoeus/easy.rb', line 273

def set_headers
  headers.each_pair do |key, value|
    easy_add_header("#{key}: #{value}")
  end
  easy_set_headers() unless headers.empty?
end

#set_option(option, value) ⇒ Object 



253
254
255
256
257
258
259
 
# File 'lib/typhoeus/easy.rb', line 253

def set_option(option, value)
  if value.class == String
    easy_setopt_string(option, value)
  elsif value
    easy_setopt_long(option, value)
  end
end

#ssl_cacert=(cacert) ⇒ Object

Set SSL CACERT “ File holding one or more certificates to verify the peer with. ”



242
243
244
 
# File 'lib/typhoeus/easy.rb', line 242

def ssl_cacert=(cacert)
  set_option(OPTION_VALUES[:CURLOPT_CAINFO], cacert)
end

#ssl_capath=(capath) ⇒ Object

Set CAPATH “ directory holding multiple CA certificates to verify the peer with. The certificate directory must be prepared using the openssl c_rehash utility. ”



249
250
251
 
# File 'lib/typhoeus/easy.rb', line 249

def ssl_capath=(capath)
  set_option(OPTION_VALUES[:CURLOPT_CAPATH], capath)
end

#ssl_cert=(cert) ⇒ Object

Set SSL certificate “ The string should be the file name of your certificate. ” The default format is “PEM” and can be changed with ssl_cert_type=



208
209
210
 
# File 'lib/typhoeus/easy.rb', line 208

def ssl_cert=(cert)
  set_option(OPTION_VALUES[:CURLOPT_SSLCERT], cert)
end

#ssl_cert_type=(cert_type) ⇒ Object

Set SSL certificate type “ The string should be the format of your certificate. Supported formats are ”PEM“ and ”DER“ ”



214
215
216
217
 
# File 'lib/typhoeus/easy.rb', line 214

def ssl_cert_type=(cert_type)
  raise "Invalid ssl cert type : '#{cert_type}'..." if cert_type and !%w(PEM DER).include?(cert_type) 
  set_option(OPTION_VALUES[:CURLOPT_SSLCERTTYPE], cert_type)
end

#ssl_key=(key) ⇒ Object

Set SSL Key file “ The string should be the file name of your private key. ” The default format is “PEM” and can be changed with ssl_key_type=



223
224
225
 
# File 'lib/typhoeus/easy.rb', line 223

def ssl_key=(key)
  set_option(OPTION_VALUES[:CURLOPT_SSLKEY], key)
end

#ssl_key_password=(key_password) ⇒ Object 



235
236
237
 
# File 'lib/typhoeus/easy.rb', line 235

def ssl_key_password=(key_password)
  set_option(OPTION_VALUES[:CURLOPT_KEYPASSWD], key_password)
end

#ssl_key_type=(key_type) ⇒ Object

Set SSL Key type “ The string should be the format of your private key. Supported formats are ”PEM“, ”DER“ and ”ENG“. ”



230
231
232
233
 
# File 'lib/typhoeus/easy.rb', line 230

def ssl_key_type=(key_type)
  raise "Invalid ssl key type : '#{key_type}'..." if key_type and !%w(PEM DER ENG).include?(key_type)
  set_option(OPTION_VALUES[:CURLOPT_SSLKEYTYPE], key_type)
end

#success ⇒ Object

gets called when finished and response code is 200-299



281
282
283
 
# File 'lib/typhoeus/easy.rb', line 281

def success
  @success.call(self) if @success
end

#supports_zlib? ⇒ Boolean

Returns:

  • (Boolean) 


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

def supports_zlib?
  !!(curl_version.match(/zlib/))
end

#timed_out? ⇒ Boolean

Returns:

  • (Boolean) 


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

def timed_out?
  @timeout && total_time_taken > @timeout && response_code == 0
end

#timeout=(milliseconds) ⇒ Object 



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

def timeout=(milliseconds)
  @timeout = milliseconds
  set_option(OPTION_VALUES[:CURLOPT_NOSIGNAL], 1)
  set_option(OPTION_VALUES[:CURLOPT_TIMEOUT_MS], milliseconds)
end

#total_time_taken ⇒ Object 



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

def total_time_taken
  get_info_double(INFO_VALUES[:CURLINFO_TOTAL_TIME])
end

#user_agent=(user_agent) ⇒ Object 



148
149
150
 
# File 'lib/typhoeus/easy.rb', line 148

def user_agent=(user_agent)
  set_option(OPTION_VALUES[:CURLOPT_USERAGENT], user_agent)
end

#verbose=(boolean) ⇒ Object 



83
84
85
 
# File 'lib/typhoeus/easy.rb', line 83

def verbose=(boolean)
  set_option(OPTION_VALUES[:CURLOPT_VERBOSE], !!boolean ? 1 : 0)
end