Class: Typhoeus::Easy
- Inherits:
-
Object
- Object
- Typhoeus::Easy
- 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_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
-
#headers ⇒ Object
Returns the value of attribute headers.
-
#method ⇒ Object
Returns the value of attribute method.
-
#params ⇒ Object
Returns the value of attribute params.
-
#response_body ⇒ Object
readonly
Returns the value of attribute response_body.
-
#response_header ⇒ Object
readonly
Returns the value of attribute response_header.
-
#start_time ⇒ Object
Returns the value of attribute start_time.
-
#url ⇒ Object
Returns the value of attribute url.
Instance Method Summary collapse
- #auth=(authinfo) ⇒ Object
- #auth_methods ⇒ Object
- #connect_timeout=(milliseconds) ⇒ Object
- #curl_version ⇒ Object
- #disable_ssl_peer_verification ⇒ Object
- #effective_url ⇒ Object
-
#failure ⇒ Object
gets called when finished and response code is 300-599.
- #follow_location=(boolean) ⇒ Object
- #get_info_double(option) ⇒ Object
- #get_info_long(option) ⇒ Object
- #get_info_string(option) ⇒ Object
- #increment_retries ⇒ Object
-
#initialize ⇒ Easy
constructor
A new instance of Easy.
- #max_redirects=(redirects) ⇒ Object
- #max_retries ⇒ Object
- #max_retries? ⇒ Boolean
- #on_failure(&block) ⇒ Object
- #on_failure=(block) ⇒ Object
- #on_success(&block) ⇒ Object
- #on_success=(block) ⇒ Object
- #perform ⇒ Object
- #post_data=(data) ⇒ Object
- #proxy=(proxy) ⇒ Object
- #request_body=(request_body) ⇒ Object
- #reset ⇒ Object
- #response_code ⇒ Object
- #retries ⇒ Object
- #set_headers ⇒ Object
- #set_option(option, value) ⇒ Object
-
#ssl_cacert=(cacert) ⇒ Object
Set SSL CACERT “ File holding one or more certificates to verify the peer with.
-
#ssl_capath=(capath) ⇒ Object
Set CAPATH “ directory holding multiple CA certificates to verify the peer with.
-
#ssl_cert=(cert) ⇒ Object
Set SSL certificate “ The string should be the file name of your certificate.
-
#ssl_cert_type=(cert_type) ⇒ Object
Set SSL certificate type “ The string should be the format of your certificate.
-
#ssl_key=(key) ⇒ Object
Set SSL Key file “ The string should be the file name of your private key.
- #ssl_key_password=(key_password) ⇒ Object
-
#ssl_key_type=(key_type) ⇒ Object
Set SSL Key type “ The string should be the format of your private key.
-
#success ⇒ Object
gets called when finished and response code is 200-299.
- #supports_zlib? ⇒ Boolean
- #timed_out? ⇒ Boolean
- #timeout=(milliseconds) ⇒ Object
- #total_time_taken ⇒ Object
- #user_agent=(user_agent) ⇒ Object
- #verbose=(boolean) ⇒ Object
Constructor Details
#initialize ⇒ Easy
Returns a new instance of Easy.
57 58 59 60 61 62 63 |
# File 'lib/typhoeus/easy.rb', line 57 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
73 74 75 76 |
# File 'lib/typhoeus/easy.rb', line 73 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
78 79 80 |
# File 'lib/typhoeus/easy.rb', line 78 def auth_methods get_info_long(INFO_VALUES[:CURLINFO_HTTPAUTH_AVAIL]) end |
#connect_timeout=(milliseconds) ⇒ Object
110 111 112 113 114 |
# File 'lib/typhoeus/easy.rb', line 110 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
336 337 338 |
# File 'lib/typhoeus/easy.rb', line 336 def curl_version version end |
#disable_ssl_peer_verification ⇒ Object
150 151 152 |
# File 'lib/typhoeus/easy.rb', line 150 def disable_ssl_peer_verification set_option(OPTION_VALUES[:CURLOPT_VERIFYPEER], 0) end |
#effective_url ⇒ Object
90 91 92 |
# File 'lib/typhoeus/easy.rb', line 90 def effective_url get_info_string(INFO_VALUES[:CURLINFO_EFFECTIVE_URL]) end |
#failure ⇒ Object
gets called when finished and response code is 300-599
287 288 289 |
# File 'lib/typhoeus/easy.rb', line 287 def failure @failure.call(self) if @failure end |
#follow_location=(boolean) ⇒ Object
98 99 100 101 102 103 104 |
# File 'lib/typhoeus/easy.rb', line 98 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
332 333 334 |
# File 'lib/typhoeus/easy.rb', line 332 def get_info_double(option) easy_getinfo_double(option) end |
#get_info_long(option) ⇒ Object
328 329 330 |
# File 'lib/typhoeus/easy.rb', line 328 def get_info_long(option) easy_getinfo_long(option) end |
#get_info_string(option) ⇒ Object
324 325 326 |
# File 'lib/typhoeus/easy.rb', line 324 def get_info_string(option) easy_getinfo_string(option) end |
#increment_retries ⇒ Object
303 304 305 306 |
# File 'lib/typhoeus/easy.rb', line 303 def increment_retries @retries ||= 0 @retries += 1 end |
#max_redirects=(redirects) ⇒ Object
106 107 108 |
# File 'lib/typhoeus/easy.rb', line 106 def max_redirects=(redirects) set_option(OPTION_VALUES[:CURLOPT_MAXREDIRS], redirects) end |
#max_retries ⇒ Object
308 309 310 |
# File 'lib/typhoeus/easy.rb', line 308 def max_retries @max_retries ||= 40 end |
#max_retries? ⇒ Boolean
312 313 314 |
# File 'lib/typhoeus/easy.rb', line 312 def max_retries? retries >= max_retries end |
#on_failure(&block) ⇒ Object
291 292 293 |
# File 'lib/typhoeus/easy.rb', line 291 def on_failure(&block) @failure = block end |
#on_failure=(block) ⇒ Object
295 296 297 |
# File 'lib/typhoeus/easy.rb', line 295 def on_failure=(block) @failure = block end |
#on_success(&block) ⇒ Object
278 279 280 |
# File 'lib/typhoeus/easy.rb', line 278 def on_success(&block) @success = block end |
#on_success=(block) ⇒ Object
282 283 284 |
# File 'lib/typhoeus/easy.rb', line 282 def on_success=(block) @success = block end |
#perform ⇒ Object
254 255 256 257 258 259 260 261 262 263 264 |
# File 'lib/typhoeus/easy.rb', line 254 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
171 172 173 174 175 |
# File 'lib/typhoeus/easy.rb', line 171 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
69 70 71 |
# File 'lib/typhoeus/easy.rb', line 69 def proxy=(proxy) set_option(OPTION_VALUES[:CURLOPT_PROXY], proxy) end |
#request_body=(request_body) ⇒ Object
130 131 132 133 134 135 136 137 138 139 |
# File 'lib/typhoeus/easy.rb', line 130 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
316 317 318 319 320 321 322 |
# File 'lib/typhoeus/easy.rb', line 316 def reset @retries = 0 @response_code = 0 @response_header = "" @response_body = "" easy_reset() end |
#response_code ⇒ Object
94 95 96 |
# File 'lib/typhoeus/easy.rb', line 94 def response_code get_info_long(INFO_VALUES[:CURLINFO_RESPONSE_CODE]) end |
#retries ⇒ Object
299 300 301 |
# File 'lib/typhoeus/easy.rb', line 299 def retries @retries ||= 0 end |
#set_headers ⇒ Object
266 267 268 269 270 271 |
# File 'lib/typhoeus/easy.rb', line 266 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
246 247 248 249 250 251 252 |
# File 'lib/typhoeus/easy.rb', line 246 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. ”
235 236 237 |
# File 'lib/typhoeus/easy.rb', line 235 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. ”
242 243 244 |
# File 'lib/typhoeus/easy.rb', line 242 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=
201 202 203 |
# File 'lib/typhoeus/easy.rb', line 201 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“ ”
207 208 209 210 |
# File 'lib/typhoeus/easy.rb', line 207 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=
216 217 218 |
# File 'lib/typhoeus/easy.rb', line 216 def ssl_key=(key) set_option(OPTION_VALUES[:CURLOPT_SSLKEY], key) end |
#ssl_key_password=(key_password) ⇒ Object
228 229 230 |
# File 'lib/typhoeus/easy.rb', line 228 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“. ”
223 224 225 226 |
# File 'lib/typhoeus/easy.rb', line 223 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
274 275 276 |
# File 'lib/typhoeus/easy.rb', line 274 def success @success.call(self) if @success end |
#supports_zlib? ⇒ Boolean
126 127 128 |
# File 'lib/typhoeus/easy.rb', line 126 def supports_zlib? !!(curl_version.match(/zlib/)) end |
#timed_out? ⇒ Boolean
122 123 124 |
# File 'lib/typhoeus/easy.rb', line 122 def timed_out? @timeout && total_time_taken > @timeout && response_code == 0 end |
#timeout=(milliseconds) ⇒ Object
116 117 118 119 120 |
# File 'lib/typhoeus/easy.rb', line 116 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
86 87 88 |
# File 'lib/typhoeus/easy.rb', line 86 def total_time_taken get_info_double(INFO_VALUES[:CURLINFO_TOTAL_TIME]) end |
#user_agent=(user_agent) ⇒ Object
141 142 143 |
# File 'lib/typhoeus/easy.rb', line 141 def user_agent=(user_agent) set_option(OPTION_VALUES[:CURLOPT_USERAGENT], user_agent) end |
#verbose=(boolean) ⇒ Object
82 83 84 |
# File 'lib/typhoeus/easy.rb', line 82 def verbose=(boolean) set_option(OPTION_VALUES[:CURLOPT_VERBOSE], !!boolean ? 1 : 0) end |