easy = Curl::Easy.new
click to toggle source
autoreferer=true
static VALUE ruby_curl_easy_autoreferer_set(VALUE self, VALUE autoreferer) {
ruby_curl_easy *rbce;
Data_Get_Struct(self, ruby_curl_easy, rbce);
if (Qtrue == autoreferer) {
curl_easy_setopt(rbce->curl, CURLOPT_AUTOREFERER, 1);
}
else {
curl_easy_setopt(rbce->curl, CURLOPT_AUTOREFERER, 0);
}
return autoreferer;
}
body_str => "response body"
click to toggle source
Return the response body from the previous call to perform. This
is populated by the default on_body handler - if you supply your
own body handler, this string will be empty.
static VALUE ruby_curl_easy_body_str_get(VALUE self) {
CURB_OBJECT_HGETTER(ruby_curl_easy, body_data);
}
cacert => string
click to toggle source
Obtain the cacert file to use for this Curl::Easy
instance.
static VALUE ruby_curl_easy_cacert_get(VALUE self) {
CURB_OBJECT_HGETTER(ruby_curl_easy, cacert);
}
cacert = string => ""
click to toggle source
Set a cacert bundle to use for this Curl::Easy
instance. This file will be used to validate SSL certificates.
static VALUE ruby_curl_easy_cacert_set(VALUE self, VALUE cacert) {
CURB_OBJECT_HSETTER(ruby_curl_easy, cacert);
}
cert => string
click to toggle source
Obtain the cert file to use for this Curl::Easy
instance.
static VALUE ruby_curl_easy_cert_get(VALUE self) {
CURB_OBJECT_HGETTER(ruby_curl_easy, cert);
}
cert=(cert_file)
click to toggle source
Set a cert file to use for this Curl::Easy
instance. This file will be used to validate SSL connections.
def cert=(cert_file)
pos = cert_file.rindex(':')
if pos && pos > 1
self.native_cert= cert_file[0..pos-1]
self.certpassword= cert_file[pos+1..-1]
else
self.native_cert= cert_file
end
self.cert
end
cert_key => "cert_key.file"
click to toggle source
Obtain the cert key file to use for this Curl::Easy
instance.
static VALUE ruby_curl_easy_cert_key_get(VALUE self) {
CURB_OBJECT_HGETTER(ruby_curl_easy, cert_key);
}
cert_key = "cert_key.file" => ""
click to toggle source
Set a cert key to use for this Curl::Easy instance.
This file will be used to validate SSL certificates.
static VALUE ruby_curl_easy_cert_key_set(VALUE self, VALUE cert_key) {
CURB_OBJECT_HSETTER(ruby_curl_easy, cert_key);
}
certpassword = string => ""
click to toggle source
Set a password used to open the specified cert
static VALUE ruby_curl_easy_certpassword_set(VALUE self, VALUE certpassword) {
CURB_OBJECT_HSETTER(ruby_curl_easy, certpassword);
}
certtype => string
click to toggle source
Obtain the cert type used for this Curl::Easy
instance
static VALUE ruby_curl_easy_certtype_get(VALUE self) {
CURB_OBJECT_HGETTER(ruby_curl_easy, certtype);
}
certtype = "PEM|DER" => ""
click to toggle source
Set a cert type to use for this Curl::Easy
instance. Default is PEM
static VALUE ruby_curl_easy_certtype_set(VALUE self, VALUE certtype) {
CURB_OBJECT_HSETTER(ruby_curl_easy, certtype);
}
clone => #<easy clone>
click to toggle source
dup => #<easy clone>
Clone this Curl::Easy instance, creating a new
instance. This method duplicates the underlying CURL* handle.
static VALUE ruby_curl_easy_clone(VALUE self) {
ruby_curl_easy *rbce, *newrbce;
Data_Get_Struct(self, ruby_curl_easy, rbce);
newrbce = ALLOC(ruby_curl_easy);
memcpy(newrbce, rbce, sizeof(ruby_curl_easy));
newrbce->curl = curl_easy_duphandle(rbce->curl);
newrbce->curl_headers = NULL;
newrbce->curl_ftp_commands = NULL;
return Data_Wrap_Struct(cCurlEasy, curl_easy_mark, curl_easy_free, newrbce);
}
close => nil
click to toggle source
Close the Curl::Easy instance. Any open connections
are closed The easy handle is reinitialized. If a previous multi handle
was open it is set to nil and will be cleared after a GC.
static VALUE ruby_curl_easy_close(VALUE self) {
CURLcode ecode;
ruby_curl_easy *rbce;
Data_Get_Struct(self, ruby_curl_easy, rbce);
ruby_curl_easy_free(rbce);
/* reinit the handle */
rbce->curl = curl_easy_init();
if (!rbce->curl) {
rb_raise(eCurlErrFailedInit, "Failed to initialize easy handle");
}
rbce->multi = Qnil;
ruby_curl_easy_zero(rbce);
/* give the new curl handle a reference back to the ruby object */
ecode = curl_easy_setopt(rbce->curl, CURLOPT_PRIVATE, (void*)self);
if (ecode != CURLE_OK) {
raise_curl_easy_error_exception(ecode);
}
return Qnil;
}
connect_time => float
click to toggle source
Retrieve the time, in seconds, it took from the start until the connect to
the remote host (or proxy) was completed.
static VALUE ruby_curl_easy_connect_time_get(VALUE self) {
ruby_curl_easy *rbce;
double time;
Data_Get_Struct(self, ruby_curl_easy, rbce);
curl_easy_getinfo(rbce->curl, CURLINFO_CONNECT_TIME, &time);
return rb_float_new(time);
}
connect_timeout => fixnum or nil
click to toggle source
Obtain the maximum time in seconds that you allow the connection to the
server to take.
static VALUE ruby_curl_easy_connect_timeout_get(VALUE self, VALUE connect_timeout) {
CURB_IMMED_GETTER(ruby_curl_easy, connect_timeout, 0);
}
connect_timeout = fixnum or nil => fixnum or nil
click to toggle source
Set the maximum time in seconds that you allow the connection to the server
to take. This only limits the connection phase, once it has connected, this
option is of no more use.
Set to nil (or zero) to disable connection timeout (it will then only
timeout on the system's internal timeouts).
static VALUE ruby_curl_easy_connect_timeout_set(VALUE self, VALUE connect_timeout) {
CURB_IMMED_SETTER(ruby_curl_easy, connect_timeout, 0);
}
content_type => "content/type" or nil
click to toggle source
Retrieve the content-type of the downloaded object. This is the value read
from the Content-Type: field. If you get nil, it means that the
server didn't send a valid Content-Type header or that the protocol used
doesn't support this.
static VALUE ruby_curl_easy_content_type_get(VALUE self) {
ruby_curl_easy *rbce;
char* type;
Data_Get_Struct(self, ruby_curl_easy, rbce);
curl_easy_getinfo(rbce->curl, CURLINFO_CONTENT_TYPE, &type);
if (type && type[0]) { // curl returns empty string if none
return rb_str_new2(type);
} else {
return Qnil;
}
}
cookiefile => string
click to toggle source
Obtain the cookiefile file for this Curl::Easy
instance.
static VALUE ruby_curl_easy_cookiefile_get(VALUE self) {
CURB_OBJECT_HGETTER(ruby_curl_easy, cookiefile);
}
cookiefile = string => string
click to toggle source
Set a file that contains cookies to be sent in subsequent requests by this
Curl::Easy instance.
Note that you must set enable_cookies true to enable the cookie
engine, or this option will be ignored.
static VALUE ruby_curl_easy_cookiefile_set(VALUE self, VALUE cookiefile) {
CURB_OBJECT_HSETTER(ruby_curl_easy, cookiefile);
}
cookiejar => string
click to toggle source
Obtain the cookiejar file to use for this Curl::Easy instance.
static VALUE ruby_curl_easy_cookiejar_get(VALUE self) {
CURB_OBJECT_HGETTER(ruby_curl_easy, cookiejar);
}
cookiejar = string => string
click to toggle source
Set a cookiejar file to use for this Curl::Easy
instance. Cookies from the response will be written into this file.
Note that you must set enable_cookies true to enable the cookie
engine, or this option will be ignored.
static VALUE ruby_curl_easy_cookiejar_set(VALUE self, VALUE cookiejar) {
CURB_OBJECT_HSETTER(ruby_curl_easy, cookiejar);
}
cookies => "name1=content1; name2=content2;"
click to toggle source
Obtain the cookies for this Curl::Easy instance.
static VALUE ruby_curl_easy_cookies_get(VALUE self) {
CURB_OBJECT_HGETTER(ruby_curl_easy, cookies);
}
cookies = "name1=content1; name2=content2;" => string
click to toggle source
Set cookies to be sent by this Curl::Easy instance.
The format of the string should be NAME=CONTENTS, where NAME is the cookie
name and CONTENTS is what the cookie should contain. Set multiple cookies
in one string like this: "name1=content1; name2=content2;" etc.
static VALUE ruby_curl_easy_cookies_set(VALUE self, VALUE cookies) {
CURB_OBJECT_HSETTER(ruby_curl_easy, cookies);
}
easy = Curl::Easy.new("url") do|c|
click to toggle source
delete = true
end
perform
static VALUE ruby_curl_easy_set_delete_option(VALUE self, VALUE onoff) {
ruby_curl_easy *rbce;
Data_Get_Struct(self, ruby_curl_easy, rbce);
if( onoff == Qtrue ) {
curl_easy_setopt(rbce->curl, CURLOPT_CUSTOMREQUEST, "DELETE");
}
else {
curl_easy_setopt(rbce->curl, CURLOPT_CUSTOMREQUEST, NULL);
}
return onoff;
}
dns_cache_timeout => fixnum or nil
click to toggle source
Obtain the dns cache timeout in seconds.
static VALUE ruby_curl_easy_dns_cache_timeout_get(VALUE self, VALUE dns_cache_timeout) {
CURB_IMMED_GETTER(ruby_curl_easy, dns_cache_timeout, -1);
}
dns_cache_timeout = fixnum or nil => fixnum or nil
click to toggle source
Set the dns cache timeout in seconds. Name resolves will be kept in memory
for this number of seconds. Set to zero (0) to completely disable caching,
or set to nil (or -1) to make the cached entries remain forever. By
default, libcurl caches this info for 60 seconds.
static VALUE ruby_curl_easy_dns_cache_timeout_set(VALUE self, VALUE dns_cache_timeout) {
CURB_IMMED_SETTER(ruby_curl_easy, dns_cache_timeout, -1);
}
download_speed => float
click to toggle source
Retrieve the average download speed that curl measured for the preceeding
complete download.
static VALUE ruby_curl_easy_download_speed_get(VALUE self) {
ruby_curl_easy *rbce;
double bytes;
Data_Get_Struct(self, ruby_curl_easy, rbce);
curl_easy_getinfo(rbce->curl, CURLINFO_SPEED_DOWNLOAD, &bytes);
return rb_float_new(bytes);
}
downloaded_bytes => float
click to toggle source
Retrieve the total amount of bytes that were downloaded in the preceeding
transfer.
static VALUE ruby_curl_easy_downloaded_bytes_get(VALUE self) {
ruby_curl_easy *rbce;
double bytes;
Data_Get_Struct(self, ruby_curl_easy, rbce);
curl_easy_getinfo(rbce->curl, CURLINFO_SIZE_DOWNLOAD, &bytes);
return rb_float_new(bytes);
}
downloaded_content_length => float
click to toggle source
Retrieve the content-length of the download. This is the value read from
the Content-Length: field.
static VALUE ruby_curl_easy_downloaded_content_length_get(VALUE self) {
ruby_curl_easy *rbce;
double bytes;
Data_Get_Struct(self, ruby_curl_easy, rbce);
curl_easy_getinfo(rbce->curl, CURLINFO_CONTENT_LENGTH_DOWNLOAD, &bytes);
return rb_float_new(bytes);
}
dup()
click to toggle source
enable_cookies = boolean => boolean
click to toggle source
Configure whether the libcurl cookie engine is enabled for this Curl::Easy instance.
static VALUE ruby_curl_easy_enable_cookies_set(VALUE self, VALUE enable_cookies)
{
CURB_BOOLEAN_SETTER(ruby_curl_easy, enable_cookies);
}
enable_cookies? => boolean
click to toggle source
Determine whether the libcurl cookie engine is enabled for this Curl::Easy instance.
static VALUE ruby_curl_easy_enable_cookies_q(VALUE self) {
CURB_BOOLEAN_GETTER(ruby_curl_easy, enable_cookies);
}
encoding => string
click to toggle source
Get the set encoding types
static VALUE ruby_curl_easy_encoding_get(VALUE self) {
CURB_OBJECT_HGETTER(ruby_curl_easy, encoding);
}
encoding = string => string
click to toggle source
Set the accepted encoding types, curl will handle all of the decompression
static VALUE ruby_curl_easy_encoding_set(VALUE self, VALUE encoding) {
CURB_OBJECT_HSETTER(ruby_curl_easy, encoding);
}
escape("some text") => "some%20text"
click to toggle source
Convert the given input string to a URL encoded string and return the
result. All input characters that are not a-z, A-Z or 0-9 are converted to
their "URL escaped" version (%NN where NN is a two-digit hexadecimal
number).
static VALUE ruby_curl_easy_escape(VALUE self, VALUE svalue) {
ruby_curl_easy *rbce;
char *result;
VALUE rresult;
VALUE str = svalue;
Data_Get_Struct(self, ruby_curl_easy, rbce);
/* NOTE: make sure the value is a string, if not call to_s */
if( rb_type(str) != T_STRING ) { str = rb_funcall(str,rb_intern("to_s"),0); }
#if (LIBCURL_VERSION_NUM >= 0x070f04)
result = (char*)curl_easy_escape(rbce->curl, StringValuePtr(str), (int)RSTRING_LEN(str));
#else
result = (char*)curl_escape(StringValuePtr(str), (int)RSTRING_LEN(str));
#endif
rresult = rb_str_new2(result);
curl_free(result);
return rresult;
}
fetch_file_time = boolean => boolean
click to toggle source
Configure whether this Curl instance will fetch
remote file times, if available.
static VALUE ruby_curl_easy_fetch_file_time_set(VALUE self, VALUE fetch_file_time) {
CURB_BOOLEAN_SETTER(ruby_curl_easy, fetch_file_time);
}
fetch_file_time? => boolean
click to toggle source
Determine whether this Curl instance will fetch
remote file times, if available.
static VALUE ruby_curl_easy_fetch_file_time_q(VALUE self) {
CURB_BOOLEAN_GETTER(ruby_curl_easy, fetch_file_time);
}
file_time => fixnum
click to toggle source
Retrieve the remote time of the retrieved document (in number of seconds
since 1 jan 1970 in the GMT/UTC time zone). If you get -1, it can be
because of many reasons (unknown, the server hides it or the server doesn't
support the command that tells document time etc) and the time of the
document is unknown.
Note that you must tell the server to collect this information before the
transfer is made, by setting fetch_file_time? to true, or you will
unconditionally get a -1 back.
This requires libcurl 7.5 or higher - otherwise -1 is unconditionally
returned.
static VALUE ruby_curl_easy_file_time_get(VALUE self) {
#ifdef HAVE_CURLINFO_FILETIME
ruby_curl_easy *rbce;
long time;
Data_Get_Struct(self, ruby_curl_easy, rbce);
curl_easy_getinfo(rbce->curl, CURLINFO_FILETIME, &time);
return LONG2NUM(time);
#else
rb_warn("Installed libcurl is too old to support file_time");
return INT2FIX(0);
#endif
}
follow_location = boolean => boolean
click to toggle source
Configure whether this Curl instance will follow
Location: headers in HTTP responses. Redirects will only be followed to the
extent specified by max_redirects.
static VALUE ruby_curl_easy_follow_location_set(VALUE self, VALUE follow_location) {
CURB_BOOLEAN_SETTER(ruby_curl_easy, follow_location);
}
follow_location? => boolean
click to toggle source
Determine whether this Curl instance will follow
Location: headers in HTTP responses.
static VALUE ruby_curl_easy_follow_location_q(VALUE self) {
CURB_BOOLEAN_GETTER(ruby_curl_easy, follow_location);
}
ftp_commands()
click to toggle source
call-seq
easy.ftp_commands => array or nil
static VALUE ruby_curl_easy_ftp_commands_get(VALUE self) {
CURB_OBJECT_HGETTER(ruby_curl_easy, ftp_commands);
}
ftp_commands = ["CWD /", "MKD directory"] => ["CWD /", ...]
click to toggle source
Explicitly sets the list of commands to execute on the FTP server when
calling perform
static VALUE ruby_curl_easy_ftp_commands_set(VALUE self, VALUE ftp_commands) {
CURB_OBJECT_HSETTER(ruby_curl_easy, ftp_commands);
}
ftp_entry_path => "C:\ftp\root\" or nil
click to toggle source
Retrieve the path of the entry path. That is the initial path libcurl ended
up in when logging on to the remote FTP server. This returns nil
if something is wrong.
(requires libcurl 7.15.4 or higher, otherwise nil is always
returned).
static VALUE ruby_curl_easy_ftp_entry_path_get(VALUE self) {
#ifdef HAVE_CURLINFO_FTP_ENTRY_PATH
ruby_curl_easy *rbce;
char* path = NULL;
Data_Get_Struct(self, ruby_curl_easy, rbce);
curl_easy_getinfo(rbce->curl, CURLINFO_FTP_ENTRY_PATH, &path);
if (path && path[0]) { // curl returns NULL or empty string if none
return rb_str_new2(path);
} else {
return Qnil;
}
#else
rb_warn("Installed libcurl is too old to support num_connects");
return Qnil;
#endif
}
ftp_filemethod()
click to toggle source
call-seq
easy.ftp_filemethod => fixnum
Get the configuration for how libcurl will reach files on the server.
static VALUE ruby_curl_easy_ftp_filemethod_get(VALUE self, VALUE ftp_filemethod) {
CURB_IMMED_GETTER(ruby_curl_easy, ftp_filemethod, -1);
}
ftp_filemethod = value => fixnum or nil
click to toggle source
Controls how libcurl reaches files on the server. Valid options are
Curl::CURL_MULTICWD, Curl::CURL_NOCWD, and Curl::CURL_SINGLECWD (see
libcurl docs for CURLOPT_FTP_METHOD).
static VALUE ruby_curl_easy_ftp_filemethod_set(VALUE self, VALUE ftp_filemethod) {
CURB_IMMED_SETTER(ruby_curl_easy, ftp_filemethod, -1);
}
ftp_response_timeout => fixnum or nil
click to toggle source
Obtain the maximum time that libcurl will wait for FTP command responses.
static VALUE ruby_curl_easy_ftp_response_timeout_get(VALUE self, VALUE ftp_response_timeout) {
CURB_IMMED_GETTER(ruby_curl_easy, ftp_response_timeout, 0);
}
ftp_response_timeout = fixnum or nil => fixnum or nil
click to toggle source
Set a timeout period (in seconds) on the amount of time that the server is
allowed to take in order to generate a response message for a command
before the session is considered hung. While curl is waiting for a
response, this value overrides timeout. It is recommended that if
used in conjunction with timeout, you set
ftp_response_timeout to a value smaller than timeout.
Ignored if libcurl version is < 7.10.8.
static VALUE ruby_curl_easy_ftp_response_timeout_set(VALUE self, VALUE ftp_response_timeout) {
CURB_IMMED_SETTER(ruby_curl_easy, ftp_response_timeout, 0);
}
easy = Curl::Easy.new("url") do|c|
click to toggle source
head = true
end
perform
static VALUE ruby_curl_easy_set_head_option(VALUE self, VALUE onoff) {
ruby_curl_easy *rbce;
Data_Get_Struct(self, ruby_curl_easy, rbce);
if( onoff == Qtrue ) {
curl_easy_setopt(rbce->curl, CURLOPT_NOBODY, 1);
}
else {
curl_easy_setopt(rbce->curl, CURLOPT_NOBODY, 0);
}
return onoff;
}
header_in_body = boolean => boolean
click to toggle source
Configure whether this Curl instance will return
HTTP headers combined with body data. If this option is set true, both
header and body data will go to body_str (or the configured
on_body handler).
static VALUE ruby_curl_easy_header_in_body_set(VALUE self, VALUE header_in_body) {
CURB_BOOLEAN_SETTER(ruby_curl_easy, header_in_body);
}
header_in_body? => boolean
click to toggle source
Determine whether this Curl instance will return
HTTP headers combined with body data.
static VALUE ruby_curl_easy_header_in_body_q(VALUE self) {
CURB_BOOLEAN_GETTER(ruby_curl_easy, header_in_body);
}
http(verb)
click to toggle source
Send an HTTP request with method set to verb, using the current options set
for this Curl::Easy instance. This method always
returns true or raises an exception (defined under Curl::Err) on error.
static VALUE ruby_curl_easy_perform_verb(VALUE self, VALUE verb) {
VALUE str_verb;
if (rb_type(verb) == T_STRING) {
return ruby_curl_easy_perform_verb_str(self, RSTRING_PTR(verb));
}
else if (rb_respond_to(verb,rb_intern("to_s"))) {
str_verb = rb_funcall(verb, rb_intern("to_s"), 0);
return ruby_curl_easy_perform_verb_str(self, RSTRING_PTR(str_verb));
}
else {
rb_raise(rb_eRuntimeError, "Invalid HTTP VERB, must response to 'to_s'");
}
}
http_auth_types => fixnum or nil
click to toggle source
Obtain the HTTP authentication types that may be used for the following
perform calls.
static VALUE ruby_curl_easy_http_auth_types_get(VALUE self) {
CURB_IMMED_GETTER(ruby_curl_easy, http_auth_types, 0);
}
http_auth_types = fixnum or nil => fixnum or nil
click to toggle source
http_auth_types = [:basic,:digest,:digest_ie,:gssnegotiate, :ntlm, :any, :anysafe]
Set the HTTP authentication types that may be used for the following
perform calls. This is a bitmap made by ORing together the
Curl::CURLAUTH constants.
static VALUE ruby_curl_easy_http_auth_types_set(int argc, VALUE *argv, VALUE self) {//VALUE self, VALUE http_auth_types) {
ruby_curl_easy *rbce;
VALUE args_ary;
int i, len;
char* node = NULL;
long mask = 0x000000;
rb_scan_args(argc, argv, "*", &args_ary);
Data_Get_Struct(self, ruby_curl_easy, rbce);
len = (int)RARRAY_LEN(args_ary);
if (len == 1 && (TYPE(rb_ary_entry(args_ary,0)) == T_FIXNUM || rb_ary_entry(args_ary,0) == Qnil)) {
if (rb_ary_entry(args_ary,0) == Qnil) {
rbce->http_auth_types = 0;
}
else {
rbce->http_auth_types = NUM2INT(rb_ary_entry(args_ary,0));
}
}
else {
// we could have multiple values, but they should be symbols
node = RSTRING_PTR(rb_funcall(rb_ary_entry(args_ary,0),rb_intern("to_s"),0));
mask = CURL_HTTPAUTH_STR_TO_NUM(node);
for( i = 1; i < len; ++i ) {
node = RSTRING_PTR(rb_funcall(rb_ary_entry(args_ary,i),rb_intern("to_s"),0));
mask |= CURL_HTTPAUTH_STR_TO_NUM(node);
}
rbce->http_auth_types = mask;
}
return INT2NUM(rbce->http_auth_types);
}
http_connect_code => fixnum
click to toggle source
Retrieve the last received proxy response code to a CONNECT request.
static VALUE ruby_curl_easy_http_connect_code_get(VALUE self) {
ruby_curl_easy *rbce;
long code;
Data_Get_Struct(self, ruby_curl_easy, rbce);
curl_easy_getinfo(rbce->curl, CURLINFO_HTTP_CONNECTCODE, &code);
return LONG2NUM(code);
}
http_delete
click to toggle source
DELETE the currently configured URL using the current options set for this
Curl::Easy instance. This method always returns
true, or raises an exception (defined under Curl::Err) on error.
static VALUE ruby_curl_easy_perform_delete(VALUE self) {
return ruby_curl_easy_perform_verb_str(self, "DELETE");
}
http_get => true
click to toggle source
GET the currently configured URL using the current options set for this Curl::Easy instance. This method always returns true,
or raises an exception (defined under Curl::Err) on
error.
static VALUE ruby_curl_easy_perform_get(VALUE self) {
ruby_curl_easy *rbce;
CURL *curl;
Data_Get_Struct(self, ruby_curl_easy, rbce);
curl = rbce->curl;
curl_easy_setopt(curl, CURLOPT_CUSTOMREQUEST, NULL);
curl_easy_setopt(curl, CURLOPT_HTTPGET, 1);
return handle_perform(self,rbce);
}
http_head => true
click to toggle source
Request headers from the currently configured URL using the HEAD method and
current options set for this Curl::Easy instance.
This method always returns true, or raises an exception (defined under Curl::Err) on error.
static VALUE ruby_curl_easy_perform_head(VALUE self) {
ruby_curl_easy *rbce;
CURL *curl;
VALUE ret;
Data_Get_Struct(self, ruby_curl_easy, rbce);
curl = rbce->curl;
curl_easy_setopt(curl, CURLOPT_NOBODY, 1);
ret = handle_perform(self,rbce);
curl_easy_setopt(curl, CURLOPT_NOBODY, 0);
return ret;
}
http_post("url=encoded%20form%20data;and=so%20on") => true
click to toggle source
http_post("url=encoded%20form%20data", "and=so%20on", ...) => true
http_post("url=encoded%20form%20data", Curl::PostField, "and=so%20on", ...) => true
http_post(Curl::PostField, Curl::PostField ..., Curl::PostField) => true
POST the specified formdata to the currently configured URL using the
current options set for this Curl::Easy instance.
This method always returns true, or raises an exception (defined under Curl::Err) on error.
The Content-type of the POST is determined by the current setting of
multipart_form_post? , according to the following rules:
-
When false (the default): the form will be POSTed with a content-type of
'application/x-www-form-urlencoded', and any of the four calling forms may
be used.
-
When true: the form will be POSTed with a content-type of
'multipart/formdata'. Only the last calling form may be used, i.e. only PostField instances may be POSTed. In this mode,
individual fields' content-types are recognised, and file upload fields are
supported.
static VALUE ruby_curl_easy_perform_post(int argc, VALUE *argv, VALUE self) {
ruby_curl_easy *rbce;
CURL *curl;
int i;
VALUE args_ary;
rb_scan_args(argc, argv, "*", &args_ary);
Data_Get_Struct(self, ruby_curl_easy, rbce);
curl = rbce->curl;
curl_easy_setopt(curl, CURLOPT_CUSTOMREQUEST, NULL);
if (rbce->multipart_form_post) {
VALUE ret;
struct curl_httppost *first = NULL, *last = NULL;
// Make the multipart form
for (i = 0; i < argc; i++) {
if (rb_obj_is_instance_of(argv[i], cCurlPostField)) {
append_to_form(argv[i], &first, &last);
} else {
rb_raise(eCurlErrInvalidPostField, "You must use PostFields only with multipart form posts");
return Qnil;
}
}
curl_easy_setopt(curl, CURLOPT_POST, 0);
curl_easy_setopt(curl, CURLOPT_HTTPPOST, first);
ret = handle_perform(self,rbce);
curl_formfree(first);
return ret;
} else {
VALUE post_body = Qnil;
/* TODO: check for PostField.file and raise error before to_s fails */
if ((post_body = rb_funcall(args_ary, idJoin, 1, rbstrAmp)) == Qnil) {
rb_raise(eCurlErrError, "Failed to join arguments");
return Qnil;
} else {
/* if the function call above returns an empty string because no additional arguments were passed this makes sure
a previously set easy.post_body = "arg=foo&bar=bin" will be honored */
if( post_body != Qnil && rb_type(post_body) == T_STRING && RSTRING_LEN(post_body) > 0 ) {
ruby_curl_easy_post_body_set(self, post_body);
}
/* if post body is not defined, set it so we enable POST header, even though the request body is empty */
if( rb_easy_nil("postdata_buffer") ) {
ruby_curl_easy_post_body_set(self, post_body);
}
return handle_perform(self,rbce);
}
}
}
http_put(data) => true
click to toggle source
PUT the supplied data to the currently configured URL using the current
options set for this Curl::Easy instance. This
method always returns true, or raises an exception (defined under Curl::Err) on error.
static VALUE ruby_curl_easy_perform_put(VALUE self, VALUE data) {
ruby_curl_easy *rbce;
CURL *curl;
Data_Get_Struct(self, ruby_curl_easy, rbce);
curl = rbce->curl;
curl_easy_setopt(curl, CURLOPT_CUSTOMREQUEST, NULL);
ruby_curl_easy_put_data_set(self, data);
return handle_perform(self, rbce);
}
ignore_content_length = boolean
click to toggle source
Configure whether this Curl::Easy instance should
ignore the content length header.
static VALUE ruby_curl_easy_ignore_content_length_set(VALUE self, VALUE ignore_content_length)
{
CURB_BOOLEAN_SETTER(ruby_curl_easy, ignore_content_length);
}
ignore_content_length? => boolean
click to toggle source
Determine whether this Curl::Easy instance ignores
the content length header.
static VALUE ruby_curl_easy_ignore_content_length_q(VALUE self) {
CURB_BOOLEAN_GETTER(ruby_curl_easy, ignore_content_length);
}
inspect => "#"
click to toggle source
static VALUE ruby_curl_easy_inspect(VALUE self) {
char buf[64];
ruby_curl_easy *rbce;
Data_Get_Struct(self, ruby_curl_easy, rbce);
/* if we don't have a url set... we'll crash... */
if( !rb_easy_nil("url") && rb_easy_type_check("url", T_STRING)) {
VALUE url = rb_easy_get("url");
size_t len = 13+((RSTRING_LEN(url) > 50) ? 50 : RSTRING_LEN(url));
/* "#<Net::HTTP http://www.google.com/:80 open=false>" */
memcpy(buf,"#<Curl::Easy ", 13);
memcpy(buf+13,RSTRING_PTR(url), (len - 13));
buf[len++] = '>';
return rb_str_new(buf,len);
}
return rb_str_new2("#<Curl::Easy>");
}
interface => string
click to toggle source
Obtain the interface name that is used as the outgoing network interface.
The name can be an interface name, an IP address or a host name.
static VALUE ruby_curl_easy_interface_get(VALUE self) {
CURB_OBJECT_HGETTER(ruby_curl_easy, interface_hm);
}
interface = string => string
click to toggle source
Set the interface name to use as the outgoing network interface. The name
can be an interface name, an IP address or a host name.
static VALUE ruby_curl_easy_interface_set(VALUE self, VALUE interface_hm) {
CURB_OBJECT_HSETTER(ruby_curl_easy, interface_hm);
}
last_effective_url => "http://some.url" or nil
click to toggle source
Retrieve the last effective URL used by this instance. This is the URL used
in the last perform call, and may differ from the value of
easy.url.
static VALUE ruby_curl_easy_last_effective_url_get(VALUE self) {
ruby_curl_easy *rbce;
char* url;
Data_Get_Struct(self, ruby_curl_easy, rbce);
curl_easy_getinfo(rbce->curl, CURLINFO_EFFECTIVE_URL, &url);
if (url && url[0]) { // curl returns empty string if none
return rb_str_new2(url);
} else {
return Qnil;
}
}
local_port => fixnum or nil
click to toggle source
Obtain the local port that will be used for the following perform
calls.
This option is ignored if compiled against libcurl < 7.15.2.
static VALUE ruby_curl_easy_local_port_get(VALUE self) {
CURB_IMMED_PORT_GETTER(ruby_curl_easy, local_port);
}
local_port = fixnum or nil => fixnum or nil
click to toggle source
Set the local port that will be used for the following perform
calls.
Passing nil will return to the default behaviour (no local port
preference).
This option is ignored if compiled against libcurl < 7.15.2.
static VALUE ruby_curl_easy_local_port_set(VALUE self, VALUE local_port) {
CURB_IMMED_PORT_SETTER(ruby_curl_easy, local_port, "port");
}
local_port_range => fixnum or nil
click to toggle source
Obtain the local port range that will be used for the following
perform calls.
This option is ignored if compiled against libcurl < 7.15.2.
static VALUE ruby_curl_easy_local_port_range_get(VALUE self) {
CURB_IMMED_PORT_GETTER(ruby_curl_easy, local_port_range);
}
local_port_range = fixnum or nil => fixnum or nil
click to toggle source
Set the local port range that will be used for the following
perform calls. This is a number (between 0 and 65535) that
determines how far libcurl may deviate from the supplied
local_port in order to find an available port.
If you set local_port it's also recommended that you set this,
since it is fairly likely that your specified port will be unavailable.
This option is ignored if compiled against libcurl < 7.15.2.
static VALUE ruby_curl_easy_local_port_range_set(VALUE self, VALUE local_port_range) {
CURB_IMMED_PORT_SETTER(ruby_curl_easy, local_port_range, "port range");
}
low_speed_limit => fixnum or nil
click to toggle source
Obtain the minimum transfer speed over +low_speed+time+ below which the
transfer will be aborted.
static VALUE ruby_curl_easy_low_speed_limit_get(VALUE self, VALUE low_speed_limit) {
CURB_IMMED_GETTER(ruby_curl_easy, low_speed_limit, 0);
}
low_speed_limit = fixnum or nil => fixnum or nil
click to toggle source
Set the transfer speed (in bytes per second) that the transfer should be
below during low_speed_time seconds for the library to consider it
too slow and abort.
static VALUE ruby_curl_easy_low_speed_limit_set(VALUE self, VALUE low_speed_limit) {
CURB_IMMED_SETTER(ruby_curl_easy, low_speed_limit, 0);
}
low_speed_time => fixnum or nil
click to toggle source
Obtain the time that the transfer should be below low_speed_limit
for the library to abort it.
static VALUE ruby_curl_easy_low_speed_time_get(VALUE self, VALUE low_speed_time) {
CURB_IMMED_GETTER(ruby_curl_easy, low_speed_time, 0);
}
low_speed_time = fixnum or nil => fixnum or nil
click to toggle source
Set the time (in seconds) that the transfer should be below the
low_speed_limit for the library to consider it too slow and abort.
static VALUE ruby_curl_easy_low_speed_time_set(VALUE self, VALUE low_speed_time) {
CURB_IMMED_SETTER(ruby_curl_easy, low_speed_time, 0);
}
max_redirects => fixnum or nil
click to toggle source
Obtain the maximum number of redirections to follow in the following
perform calls.
static VALUE ruby_curl_easy_max_redirects_get(VALUE self) {
CURB_IMMED_GETTER(ruby_curl_easy, max_redirs, -1);
}
max_redirects = fixnum or nil => fixnum or nil
click to toggle source
Set the maximum number of redirections to follow in the following
perform calls. Set to nil or -1 allow an infinite number (the
default). Setting this option only makes sense if follow_location
is also set true.
With libcurl >= 7.15.1, setting this to 0 will cause libcurl to refuse
any redirect.
static VALUE ruby_curl_easy_max_redirects_set(VALUE self, VALUE max_redirs) {
CURB_IMMED_SETTER(ruby_curl_easy, max_redirs, -1);
}
multipart_form_post = boolean => boolean
click to toggle source
Configure whether this Curl instance uses
multipart/formdata content type for HTTP POST requests. If this is false
(the default), then the application/x-www-form-urlencoded content type is
used for the form data.
If this is set true, you must pass one or more PostField instances to the http_post method - no support for
posting multipart forms from a string is provided.
static VALUE ruby_curl_easy_multipart_form_post_set(VALUE self, VALUE multipart_form_post)
{
CURB_BOOLEAN_SETTER(ruby_curl_easy, multipart_form_post);
}
multipart_form_post? => boolean
click to toggle source
Determine whether this Curl instance uses
multipart/formdata content type for HTTP POST requests.
static VALUE ruby_curl_easy_multipart_form_post_q(VALUE self) {
CURB_BOOLEAN_GETTER(ruby_curl_easy, multipart_form_post);
}
name_lookup_time => float
click to toggle source
Retrieve the time, in seconds, it took from the start until the name
resolving was completed.
static VALUE ruby_curl_easy_name_lookup_time_get(VALUE self) {
ruby_curl_easy *rbce;
double time;
Data_Get_Struct(self, ruby_curl_easy, rbce);
curl_easy_getinfo(rbce->curl, CURLINFO_NAMELOOKUP_TIME, &time);
return rb_float_new(time);
}
native_cert=(cert_file)
click to toggle source
Allow the incoming cert string to be file:password but be careful to not
use a colon from a windows file path as the split point. Mimic what curl's
main does
easy = Curl::Easy.new
click to toggle source
nosignal = true
static VALUE ruby_curl_easy_set_nosignal(VALUE self, VALUE onoff) {
ruby_curl_easy *rbce;
Data_Get_Struct(self, ruby_curl_easy, rbce);
curl_easy_setopt(rbce->curl, CURLOPT_NOSIGNAL, (Qtrue == onoff) ? 1 : 0);
return onoff;
}
num_connects => integer
click to toggle source
Retrieve the number of new connections libcurl had to create to achieve the
previous transfer (only the successful connects are counted). Combined with
redirect_count you are able to know how many times libcurl
successfully reused existing connection(s) or not.
See the Connection Options of curl_easy_setopt(3) to see how libcurl tries
to make persistent connections to save time.
(requires libcurl 7.12.3 or higher, otherwise -1 is always returned).
static VALUE ruby_curl_easy_num_connects_get(VALUE self) {
#ifdef HAVE_CURLINFO_NUM_CONNECTS
ruby_curl_easy *rbce;
long result;
Data_Get_Struct(self, ruby_curl_easy, rbce);
curl_easy_getinfo(rbce->curl, CURLINFO_NUM_CONNECTS, &result);
return LONG2NUM(result);
#else
rb_warn("Installed libcurl is too old to support num_connects");
return INT2FIX(-1);
#endif
}
on_body { |body_data| ... } => <old handler>
click to toggle source
Assign or remove the on_body handler for this Curl::Easy instance. To remove a previously-supplied
handler, call this method with no attached block.
The on_body handler is called for each chunk of response body
passed back by libcurl during perform. It should perform any
processing necessary, and return the actual number of bytes handled.
Normally, this will equal the length of the data string, and CURL will
continue processing. If the returned length does not equal the input
length, CURL will abort the processing with a Curl::Err::AbortedByCallbackError.
static VALUE ruby_curl_easy_on_body_set(int argc, VALUE *argv, VALUE self) {
CURB_HANDLER_PROC_HSETTER(ruby_curl_easy, body_proc);
}
on_complete {|easy| ... } => <old handler>
click to toggle source
Assign or remove the on_complete handler for this Curl::Easy instance. To remove a previously-supplied
handler, call this method with no attached block.
The on_complete handler is called when the request is finished.
static VALUE ruby_curl_easy_on_complete_set(int argc, VALUE *argv, VALUE self) {
CURB_HANDLER_PROC_HSETTER(ruby_curl_easy, complete_proc);
}
on_debug { |type, data| ... } => <old handler>
click to toggle source
Assign or remove the on_debug handler for this Curl::Easy instance. To remove a previously-supplied
handler, call this method with no attached block.
The on_debug handler, if configured, will receive detailed
information from libcurl during the perform call. This can be useful for
debugging. Setting a debug handler overrides libcurl's internal handler,
disabling any output from verbose, if set.
The type argument will match one of the Curl::Easy::CURLINFO_XXXX
constants, and specifies the kind of information contained in the data. The
data is passed as a String.
static VALUE ruby_curl_easy_on_debug_set(int argc, VALUE *argv, VALUE self) {
CURB_HANDLER_PROC_HSETTER(ruby_curl_easy, debug_proc);
}
on_failure {|easy,code| ... } => <old handler>
click to toggle source
Assign or remove the on_failure handler for this Curl::Easy instance. To remove a previously-supplied
handler, call this method with no attached block.
The on_failure handler is called when the request is finished with
a status of 50x
static VALUE ruby_curl_easy_on_failure_set(int argc, VALUE *argv, VALUE self) {
CURB_HANDLER_PROC_HSETTER(ruby_curl_easy, failure_proc);
}
on_progress { |dl_total, dl_now, ul_total, ul_now| ... } => <old handler>
click to toggle source
Assign or remove the on_progress handler for this Curl::Easy instance. To remove a previously-supplied
handler, call this method with no attached block.
The on_progress handler is called regularly by libcurl
(approximately once per second) during transfers to allow the application
to receive progress information. There is no guarantee that the reported
progress will change between calls.
The result of the block call determines whether libcurl continues the
transfer. Returning a non-true value (i.e. nil or false) will cause the
transfer to abort, throwing a Curl::Err::AbortedByCallbackError.
static VALUE ruby_curl_easy_on_progress_set(int argc, VALUE *argv, VALUE self) {
CURB_HANDLER_PROC_HSETTER(ruby_curl_easy, progress_proc);
}
on_success { |easy| ... } => <old handler>
click to toggle source
Assign or remove the on_success handler for this Curl::Easy instance. To remove a previously-supplied
handler, call this method with no attached block.
The on_success handler is called when the request is finished with
a status of 20x
static VALUE ruby_curl_easy_on_success_set(int argc, VALUE *argv, VALUE self) {
CURB_HANDLER_PROC_HSETTER(ruby_curl_easy, success_proc);
}
os_errno => integer
click to toggle source
Retrieve the errno variable from a connect failure (requires libcurl 7.12.2
or higher, otherwise 0 is always returned).
static VALUE ruby_curl_easy_os_errno_get(VALUE self) {
#ifdef HAVE_CURLINFO_OS_ERRNO
ruby_curl_easy *rbce;
long result;
Data_Get_Struct(self, ruby_curl_easy, rbce);
curl_easy_getinfo(rbce->curl, CURLINFO_OS_ERRNO, &result);
return LONG2NUM(result);
#else
rb_warn("Installed libcurl is too old to support os_errno");
return INT2FIX(0);
#endif
}
password => string
click to toggle source
Get the current password
static VALUE ruby_curl_easy_password_get(VALUE self, VALUE password) {
#if HAVE_CURLOPT_PASSWORD
CURB_OBJECT_HGETTER(ruby_curl_easy, password);
#else
return Qnil;
#endif
}
password = string => string
click to toggle source
Set the HTTP Authentication password.
static VALUE ruby_curl_easy_password_set(VALUE self, VALUE password) {
#if HAVE_CURLOPT_PASSWORD
CURB_OBJECT_HSETTER(ruby_curl_easy, password);
#else
return Qnil;
#endif
}
post_body => string or nil
click to toggle source
Obtain the POST body used in this Curl::Easy
instance.
static VALUE ruby_curl_easy_post_body_get(VALUE self) {
CURB_OBJECT_HGETTER(ruby_curl_easy, postdata_buffer);
}
post_body = "some=form%20data&to=send" => string or nil
click to toggle source
Sets the POST body of this Curl::Easy instance.
This is expected to be URL encoded; no additional processing or encoding is
done on the string. The content-type header will be set to
application/x-www-form-urlencoded.
This is handy if you want to perform a POST against a Curl::Multi instance.
static VALUE ruby_curl_easy_post_body_set(VALUE self, VALUE post_body) {
ruby_curl_easy *rbce;
CURL *curl;
char *data;
long len;
Data_Get_Struct(self, ruby_curl_easy, rbce);
curl = rbce->curl;
if ( post_body == Qnil ) {
//rbce->postdata_buffer = Qnil;
rb_easy_del("postdata_buffer");
} else {
if (rb_type(post_body) == T_STRING) {
data = StringValuePtr(post_body);
len = RSTRING_LEN(post_body);
}
else if (rb_respond_to(post_body, rb_intern("to_s"))) {
VALUE str_body = rb_funcall(post_body, rb_intern("to_s"), 0);
data = StringValuePtr(str_body);
len = RSTRING_LEN(post_body);
}
else {
rb_raise(rb_eRuntimeError, "post data must respond_to .to_s");
}
// Store the string, since it has to hang around for the duration of the
// request. See CURLOPT_POSTFIELDS in the libcurl docs.
//rbce->postdata_buffer = post_body;
rb_easy_set("postdata_buffer", post_body);
curl_easy_setopt(curl, CURLOPT_POST, 1);
curl_easy_setopt(curl, CURLOPT_POSTFIELDS, data);
curl_easy_setopt(curl, CURLOPT_POSTFIELDSIZE, len);
return post_body;
}
return Qnil;
}
pre_transfer_time => float
click to toggle source
Retrieve the time, in seconds, it took from the start until the file
transfer is just about to begin. This includes all pre-transfer commands
and negotiations that are specific to the particular protocol(s) involved.
static VALUE ruby_curl_easy_pre_transfer_time_get(VALUE self) {
ruby_curl_easy *rbce;
double time;
Data_Get_Struct(self, ruby_curl_easy, rbce);
curl_easy_getinfo(rbce->curl, CURLINFO_PRETRANSFER_TIME, &time);
return rb_float_new(time);
}
primary_ip => "xx.xx.xx.xx" or nil
click to toggle source
Retrieve the resolved IP of the most recent connection done with this curl
handle. This string may be IPv6 if that's enabled. This feature requires
curl 7.19.x and above
static VALUE ruby_curl_easy_primary_ip_get(VALUE self) {
ruby_curl_easy *rbce;
char* ip;
Data_Get_Struct(self, ruby_curl_easy, rbce);
curl_easy_getinfo(rbce->curl, CURLINFO_PRIMARY_IP, &ip);
if (ip && ip[0]) { // curl returns empty string if none
return rb_str_new2(ip);
} else {
return Qnil;
}
}
proxy_auth_types => fixnum or nil
click to toggle source
Obtain the proxy authentication types that may be used for the following
perform calls.
static VALUE ruby_curl_easy_proxy_auth_types_get(VALUE self) {
CURB_IMMED_GETTER(ruby_curl_easy, proxy_auth_types, 0);
}
proxy_auth_types = fixnum or nil => fixnum or nil
click to toggle source
Set the proxy authentication types that may be used for the following
perform calls. This is a bitmap made by ORing together the
Curl::CURLAUTH constants.
static VALUE ruby_curl_easy_proxy_auth_types_set(VALUE self, VALUE proxy_auth_types) {
CURB_IMMED_SETTER(ruby_curl_easy, proxy_auth_types, 0);
}
proxy_port => fixnum or nil
click to toggle source
Obtain the proxy port that will be used for the following perform
calls.
static VALUE ruby_curl_easy_proxy_port_get(VALUE self) {
CURB_IMMED_PORT_GETTER(ruby_curl_easy, proxy_port);
}
proxy_port = fixnum or nil => fixnum or nil
click to toggle source
Set the proxy port that will be used for the following perform
calls.
static VALUE ruby_curl_easy_proxy_port_set(VALUE self, VALUE proxy_port) {
CURB_IMMED_PORT_SETTER(ruby_curl_easy, proxy_port, "port");
}
proxy_tunnel = boolean => boolean
click to toggle source
Configure whether this Curl instance will use
proxy tunneling.
static VALUE ruby_curl_easy_proxy_tunnel_set(VALUE self, VALUE proxy_tunnel) {
CURB_BOOLEAN_SETTER(ruby_curl_easy, proxy_tunnel);
}
proxy_tunnel? => boolean
click to toggle source
Determine whether this Curl instance will use
proxy tunneling.
static VALUE ruby_curl_easy_proxy_tunnel_q(VALUE self) {
CURB_BOOLEAN_GETTER(ruby_curl_easy, proxy_tunnel);
}
proxy_type => fixnum or nil
click to toggle source
Obtain the proxy type that will be used for the following perform
calls.
static VALUE ruby_curl_easy_proxy_type_get(VALUE self) {
CURB_IMMED_GETTER(ruby_curl_easy, proxy_type, -1);
}
proxy_type = fixnum or nil => fixnum or nil
click to toggle source
Set the proxy type that will be used for the following perform
calls. This should be one of the Curl::CURLPROXY constants.
static VALUE ruby_curl_easy_proxy_type_set(VALUE self, VALUE proxy_type) {
CURB_IMMED_SETTER(ruby_curl_easy, proxy_type, -1);
}
proxy_url => string
click to toggle source
Obtain the HTTP Proxy URL that will be used by subsequent calls to
perform.
static VALUE ruby_curl_easy_proxy_url_get(VALUE self) {
CURB_OBJECT_HGETTER(ruby_curl_easy, proxy_url);
}
proxy_url = string => string
click to toggle source
Set the URL of the HTTP proxy to use for subsequent calls to
perform. The URL should specify the the host name or dotted IP
address. To specify port number in this string, append :[port] to the end
of the host name. The proxy string may be prefixed with [protocol]:// since
any such prefix will be ignored. The proxy's port number may optionally be
specified with the separate option proxy_port .
When you tell the library to use an HTTP proxy, libcurl will transparently
convert operations to HTTP even if you specify an FTP URL etc. This may
have an impact on what other features of the library you can use, such as
FTP specifics that don't work unless you tunnel through the HTTP proxy.
Such tunneling is activated with proxy_tunnel = true.
libcurl respects the environment variables http_proxy,
ftp_proxy, all_proxy etc, if any of those is set. The proxy_url option does however
override any possibly set environment variables.
Starting with libcurl 7.14.1, the proxy host string given in environment
variables can be specified the exact same way as the proxy can be set with
proxy_url, including protocol
prefix (http://) and embedded user + password.
static VALUE ruby_curl_easy_proxy_url_set(VALUE self, VALUE proxy_url) {
CURB_OBJECT_HSETTER(ruby_curl_easy, proxy_url);
}
proxypwd => string
click to toggle source
Obtain the username/password string that will be used for proxy connection
during subsequent calls to perform. The supplied string should
have the form "username:password"
static VALUE ruby_curl_easy_proxypwd_get(VALUE self) {
CURB_OBJECT_HGETTER(ruby_curl_easy, proxypwd);
}
proxypwd = string => string
click to toggle source
Set the username/password string to use for proxy connection during
subsequent calls to perform. The supplied string should have the
form "username:password"
static VALUE ruby_curl_easy_proxypwd_set(VALUE self, VALUE proxypwd) {
CURB_OBJECT_HSETTER(ruby_curl_easy, proxypwd);
}
put_data = data => ""
click to toggle source
Points this Curl::Easy instance to data to be
uploaded via PUT. This sets the request to a PUT type request - useful if
you want to PUT via a multi handle.
static VALUE ruby_curl_easy_put_data_set(VALUE self, VALUE data) {
ruby_curl_easy *rbce;
CURL *curl;
VALUE upload;
VALUE headers;
Data_Get_Struct(self, ruby_curl_easy, rbce);
upload = ruby_curl_upload_new(cCurlUpload);
ruby_curl_upload_stream_set(upload,data);
curl = rbce->curl;
rb_easy_set("upload", upload); /* keep the upload object alive as long as
the easy handle is active or until the upload
is complete or terminated... */
curl_easy_setopt(curl, CURLOPT_NOBODY,0);
curl_easy_setopt(curl, CURLOPT_UPLOAD, 1);
curl_easy_setopt(curl, CURLOPT_READFUNCTION, (curl_read_callback)read_data_handler);
curl_easy_setopt(curl, CURLOPT_READDATA, rbce);
/*
* we need to set specific headers for the PUT to work... so
* convert the internal headers structure to a HASH if one is set
*/
if (!rb_easy_nil("headers")) {
if (rb_easy_type_check("headers", T_ARRAY) || rb_easy_type_check("headers", T_STRING)) {
rb_raise(rb_eRuntimeError, "Must set headers as a HASH to modify the headers in an PUT request");
}
}
// exit fast if the payload is empty
if (NIL_P(data)) { return data; }
headers = rb_easy_get("headers");
if( headers == Qnil ) {
headers = rb_hash_new();
}
if (rb_respond_to(data, rb_intern("read"))) {
VALUE stat = rb_funcall(data, rb_intern("stat"), 0);
if( stat ) {
VALUE size;
if( rb_hash_aref(headers, rb_str_new2("Expect")) == Qnil ) {
rb_hash_aset(headers, rb_str_new2("Expect"), rb_str_new2(""));
}
size = rb_funcall(stat, rb_intern("size"), 0);
curl_easy_setopt(curl, CURLOPT_INFILESIZE, FIX2LONG(size));
}
else if( rb_hash_aref(headers, rb_str_new2("Transfer-Encoding")) == Qnil ) {
rb_hash_aset(headers, rb_str_new2("Transfer-Encoding"), rb_str_new2("chunked"));
}
}
else if (rb_respond_to(data, rb_intern("to_s"))) {
curl_easy_setopt(curl, CURLOPT_INFILESIZE, RSTRING_LEN(data));
if( rb_hash_aref(headers, rb_str_new2("Expect")) == Qnil ) {
rb_hash_aset(headers, rb_str_new2("Expect"), rb_str_new2(""));
}
}
else {
rb_raise(rb_eRuntimeError, "PUT data must respond to read or to_s");
}
rb_easy_set("headers",headers);
// if we made it this far, all should be well.
return data;
}
redirect_count => integer
click to toggle source
Retrieve the total number of redirections that were actually followed.
Requires libcurl 7.9.7 or higher, otherwise -1 is always returned.
static VALUE ruby_curl_easy_redirect_count_get(VALUE self) {
#ifdef HAVE_CURLINFO_REDIRECT_COUNT
ruby_curl_easy *rbce;
long count;
Data_Get_Struct(self, ruby_curl_easy, rbce);
curl_easy_getinfo(rbce->curl, CURLINFO_REDIRECT_COUNT, &count);
return LONG2NUM(count);
#else
rb_warn("Installed libcurl is too old to support redirect_count");
return INT2FIX(-1);
#endif
}
redirect_time => float
click to toggle source
Retrieve the total time, in seconds, it took for all redirection steps
include name lookup, connect, pretransfer and transfer before final
transaction was started. redirect_time contains the complete
execution time for multiple redirections.
Requires libcurl 7.9.7 or higher, otherwise -1 is always returned.
static VALUE ruby_curl_easy_redirect_time_get(VALUE self) {
#ifdef HAVE_CURLINFO_REDIRECT_TIME
ruby_curl_easy *rbce;
double time;
Data_Get_Struct(self, ruby_curl_easy, rbce);
curl_easy_getinfo(rbce->curl, CURLINFO_REDIRECT_TIME, &time);
return rb_float_new(time);
#else
rb_warn("Installed libcurl is too old to support redirect_time");
return rb_float_new(-1);
#endif
}
request_size => fixnum
click to toggle source
Retrieve the total size of the issued requests. This is so far only for
HTTP requests. Note that this may be more than one request if
follow_location? is true.
static VALUE ruby_curl_easy_request_size_get(VALUE self) {
ruby_curl_easy *rbce;
long size;
Data_Get_Struct(self, ruby_curl_easy, rbce);
curl_easy_getinfo(rbce->curl, CURLINFO_REQUEST_SIZE, &size);
return LONG2NUM(size);
}
reset => Hash
click to toggle source
Reset the Curl::Easy instance, clears out all
settings.
from curl.haxx.se/libcurl/c/curl_easy_reset.html
Re-initializes all options previously set on a specified CURL handle to the
default values. This puts back the handle to the same state as it was in
when it was just created with curl_easy_init(3). It does not change the
following information kept in the handle: live connections, the Session ID
cache, the DNS cache, the cookies and shares.
The return value contains all settings stored.
static VALUE ruby_curl_easy_reset(VALUE self) {
CURLcode ecode;
ruby_curl_easy *rbce;
VALUE opts_dup;
Data_Get_Struct(self, ruby_curl_easy, rbce);
opts_dup = rb_funcall(rbce->opts, rb_intern("dup"), 0);
curl_easy_reset(rbce->curl);
ruby_curl_easy_zero(rbce);
/* rest clobbers the private setting, so reset it to self */
ecode = curl_easy_setopt(rbce->curl, CURLOPT_PRIVATE, (void*)self);
if (ecode != CURLE_OK) {
raise_curl_easy_error_exception(ecode);
}
/* Free everything up */
if (rbce->curl_headers) {
curl_slist_free_all(rbce->curl_headers);
rbce->curl_headers = NULL;
}
return opts_dup;
}
response_code => fixnum
click to toggle source
Retrieve the last received HTTP or FTP code. This will be zero if no server
response code has been received. Note that a proxy's CONNECT response
should be read with http_connect_code and not this method.
static VALUE ruby_curl_easy_response_code_get(VALUE self) {
ruby_curl_easy *rbce;
long code;
Data_Get_Struct(self, ruby_curl_easy, rbce);
#ifdef HAVE_CURLINFO_RESPONSE_CODE
curl_easy_getinfo(rbce->curl, CURLINFO_RESPONSE_CODE, &code);
#else
// old libcurl
curl_easy_getinfo(rbce->curl, CURLINFO_HTTP_CODE, &code);
#endif
return LONG2NUM(code);
}
ssl_verify_host = boolean => boolean
click to toggle source
Configure whether this Curl instance will verify
that the server cert is for the server it is known as. When true (the
default) the server certificate must indicate that the server is the server
to which you meant to connect, or the connection fails. When false, the
connection will succeed regardless of the names in the certificate.
this option controls is of the identity that the server claims. The server
could be lying. To control lying, see ssl_verify_peer? .
static VALUE ruby_curl_easy_ssl_verify_host_set(VALUE self, VALUE ssl_verify_host) {
CURB_BOOLEAN_SETTER(ruby_curl_easy, ssl_verify_host);
}
ssl_verify_host? => boolean
click to toggle source
Determine whether this Curl instance will verify
that the server cert is for the server it is known as.
static VALUE ruby_curl_easy_ssl_verify_host_q(VALUE self) {
CURB_BOOLEAN_GETTER(ruby_curl_easy, ssl_verify_host);
}
ssl_verify_peer = boolean => boolean
click to toggle source
Configure whether this Curl instance will verify
the SSL peer certificate. When true (the default), and the verification
fails to prove that the certificate is authentic, the connection fails.
When false, the connection succeeds regardless.
Authenticating the certificate is not by itself very useful. You typically
want to ensure that the server, as authentically identified by its
certificate, is the server you mean to be talking to. The ssl_verify_host?
options controls that.
static VALUE ruby_curl_easy_ssl_verify_peer_set(VALUE self, VALUE ssl_verify_peer) {
CURB_BOOLEAN_SETTER(ruby_curl_easy, ssl_verify_peer);
}
ssl_verify_peer? => boolean
click to toggle source
Determine whether this Curl instance will verify
the SSL peer certificate.
static VALUE ruby_curl_easy_ssl_verify_peer_q(VALUE self) {
CURB_BOOLEAN_GETTER(ruby_curl_easy, ssl_verify_peer);
}
ssl_verify_result => integer
click to toggle source
Retrieve the result of the certification verification that was requested
(by setting ssl_verify_peer? to true).
static VALUE ruby_curl_easy_ssl_verify_result_get(VALUE self) {
ruby_curl_easy *rbce;
long result;
Data_Get_Struct(self, ruby_curl_easy, rbce);
curl_easy_getinfo(rbce->curl, CURLINFO_SSL_VERIFYRESULT, &result);
return LONG2NUM(result);
}
ssl_version => fixnum
click to toggle source
Get the version of SSL/TLS that libcurl will attempt to use.
static VALUE ruby_curl_easy_ssl_version_get(VALUE self, VALUE ssl_version) {
CURB_IMMED_GETTER(ruby_curl_easy, ssl_version, -1);
}
ssl_version = value => fixnum or nil
click to toggle source
Sets the version of SSL/TLS that libcurl will attempt to use. Valid options
are Curl::CURL_SSLVERSION_TLSv1, Curl::CURL_SSLVERSION::SSLv2,
Curl::CURL_SSLVERSION_SSLv3 and Curl::CURL_SSLVERSION_DEFAULT
static VALUE ruby_curl_easy_ssl_version_set(VALUE self, VALUE ssl_version) {
CURB_IMMED_SETTER(ruby_curl_easy, ssl_version, -1);
}
start_transfer_time => float
click to toggle source
Retrieve the time, in seconds, it took from the start until the first byte
is just about to be transferred. This includes the
pre_transfer_time and also the time the server needs to calculate
the result.
static VALUE ruby_curl_easy_start_transfer_time_get(VALUE self) {
ruby_curl_easy *rbce;
double time;
Data_Get_Struct(self, ruby_curl_easy, rbce);
curl_easy_getinfo(rbce->curl, CURLINFO_STARTTRANSFER_TIME, &time);
return rb_float_new(time);
}
timeout => fixnum or nil
click to toggle source
Obtain the maximum time in seconds that you allow the libcurl transfer
operation to take.
static VALUE ruby_curl_easy_timeout_get(VALUE self, VALUE timeout) {
CURB_IMMED_GETTER(ruby_curl_easy, timeout, 0);
}
timeout = fixnum or nil => fixnum or nil
click to toggle source
Set the maximum time in seconds that you allow the libcurl transfer
operation to take. Normally, name lookups can take a considerable time and
limiting operations to less than a few minutes risk aborting perfectly
normal operations.
Set to nil (or zero) to disable timeout (it will then only timeout on the
system's internal timeouts).
static VALUE ruby_curl_easy_timeout_set(VALUE self, VALUE timeout) {
CURB_IMMED_SETTER(ruby_curl_easy, timeout, 0);
}
total_time => float
click to toggle source
Retrieve the total time in seconds for the previous transfer, including
name resolving, TCP connect etc.
static VALUE ruby_curl_easy_total_time_get(VALUE self) {
ruby_curl_easy *rbce;
double time;
Data_Get_Struct(self, ruby_curl_easy, rbce);
curl_easy_getinfo(rbce->curl, CURLINFO_TOTAL_TIME, &time);
return rb_float_new(time);
}
unescape("some%20text") => "some text"
click to toggle source
Convert the given URL encoded input string to a "plain string" and return
the result. All input characters that are URL encoded (%XX where XX is a
two-digit hexadecimal number) are converted to their binary versions.
static VALUE ruby_curl_easy_unescape(VALUE self, VALUE str) {
ruby_curl_easy *rbce;
int rlen;
char *result;
VALUE rresult;
Data_Get_Struct(self, ruby_curl_easy, rbce);
#if (LIBCURL_VERSION_NUM >= 0x070f04)
result = (char*)curl_easy_unescape(rbce->curl, StringValuePtr(str), (int)RSTRING_LEN(str), &rlen);
#else
result = (char*)curl_unescape(StringValuePtr(str), RSTRING_LEN(str));
rlen = strlen(result);
#endif
rresult = rb_str_new(result, rlen);
curl_free(result);
return rresult;
}
unrestricted_auth = boolean => boolean
click to toggle source
Configure whether this Curl instance may use any
HTTP authentication method available when necessary.
static VALUE ruby_curl_easy_unrestricted_auth_set(VALUE self, VALUE unrestricted_auth) {
CURB_BOOLEAN_SETTER(ruby_curl_easy, unrestricted_auth);
}
unrestricted_auth? => boolean
click to toggle source
Determine whether this Curl instance may use any
HTTP authentication method available when necessary.
static VALUE ruby_curl_easy_unrestricted_auth_q(VALUE self) {
CURB_BOOLEAN_GETTER(ruby_curl_easy, unrestricted_auth);
}
upload_speed => float
click to toggle source
Retrieve the average upload speed that curl measured for the preceeding
complete upload.
static VALUE ruby_curl_easy_upload_speed_get(VALUE self) {
ruby_curl_easy *rbce;
double bytes;
Data_Get_Struct(self, ruby_curl_easy, rbce);
curl_easy_getinfo(rbce->curl, CURLINFO_SPEED_UPLOAD, &bytes);
return rb_float_new(bytes);
}
uploaded_bytes => float
click to toggle source
Retrieve the total amount of bytes that were uploaded in the preceeding
transfer.
static VALUE ruby_curl_easy_uploaded_bytes_get(VALUE self) {
ruby_curl_easy *rbce;
double bytes;
Data_Get_Struct(self, ruby_curl_easy, rbce);
curl_easy_getinfo(rbce->curl, CURLINFO_SIZE_UPLOAD, &bytes);
return rb_float_new(bytes);
}
uploaded_content_length => float
click to toggle source
Retrieve the content-length of the upload.
static VALUE ruby_curl_easy_uploaded_content_length_get(VALUE self) {
ruby_curl_easy *rbce;
double bytes;
Data_Get_Struct(self, ruby_curl_easy, rbce);
curl_easy_getinfo(rbce->curl, CURLINFO_CONTENT_LENGTH_UPLOAD, &bytes);
return rb_float_new(bytes);
}
url => string
click to toggle source
Obtain the URL that will be used by subsequent calls to perform.
static VALUE ruby_curl_easy_url_get(VALUE self) {
CURB_OBJECT_HGETTER(ruby_curl_easy, url);
}
url = "http://some.url/" => "http://some.url/"
click to toggle source
Set the URL for subsequent calls to perform. It is acceptable (and
even recommended) to reuse Curl::Easy instances by
reassigning the URL between calls to perform.
static VALUE ruby_curl_easy_url_set(VALUE self, VALUE url) {
CURB_OBJECT_HSETTER(ruby_curl_easy, url);
}
use_netrc = boolean => boolean
click to toggle source
Configure whether this Curl instance will use
data from the user's .netrc file for FTP connections.
static VALUE ruby_curl_easy_use_netrc_set(VALUE self, VALUE use_netrc) {
CURB_BOOLEAN_SETTER(ruby_curl_easy, use_netrc);
}
use_netrc? => boolean
click to toggle source
Determine whether this Curl instance will use
data from the user's .netrc file for FTP connections.
static VALUE ruby_curl_easy_use_netrc_q(VALUE self) {
CURB_BOOLEAN_GETTER(ruby_curl_easy, use_netrc);
}
use_ssl => fixnum
click to toggle source
Get the desired level for using SSL on FTP connections.
static VALUE ruby_curl_easy_use_ssl_get(VALUE self, VALUE use_ssl) {
CURB_IMMED_GETTER(ruby_curl_easy, use_ssl, -1);
}
use_ssl = value => fixnum or nil
click to toggle source
Ensure libcurl uses SSL for FTP connections. Valid options are
Curl::CURL_USESSL_NONE, Curl::CURL_USESSL_TRY, Curl::CURL_USESSL_CONTROL,
and Curl::CURL_USESSL_ALL.
static VALUE ruby_curl_easy_use_ssl_set(VALUE self, VALUE use_ssl) {
CURB_IMMED_SETTER(ruby_curl_easy, use_ssl, -1);
}
useragent => "Ruby/Curb"
click to toggle source
Obtain the user agent string used for this Curl::Easy instance
static VALUE ruby_curl_easy_useragent_get(VALUE self) {
CURB_OBJECT_HGETTER(ruby_curl_easy, useragent);
}
useragent = "Ruby/Curb" => ""
click to toggle source
Set the user agent string for this Curl::Easy
instance
static VALUE ruby_curl_easy_useragent_set(VALUE self, VALUE useragent) {
CURB_OBJECT_HSETTER(ruby_curl_easy, useragent);
}
username => string
click to toggle source
Get the current username
static VALUE ruby_curl_easy_username_get(VALUE self, VALUE username) {
#if HAVE_CURLOPT_USERNAME
CURB_OBJECT_HGETTER(ruby_curl_easy, username);
#else
return Qnil;
#endif
}
username = string => string
click to toggle source
Set the HTTP Authentication username.
static VALUE ruby_curl_easy_username_set(VALUE self, VALUE username) {
#if HAVE_CURLOPT_USERNAME
CURB_OBJECT_HSETTER(ruby_curl_easy, username);
#else
return Qnil;
#endif
}
userpwd => string
click to toggle source
Obtain the username/password string that will be used for subsequent calls
to perform.
static VALUE ruby_curl_easy_userpwd_get(VALUE self) {
CURB_OBJECT_HGETTER(ruby_curl_easy, userpwd);
}
userpwd = string => string
click to toggle source
Set the username/password string to use for subsequent calls to
perform. The supplied string should have the form
"username:password"
static VALUE ruby_curl_easy_userpwd_set(VALUE self, VALUE userpwd) {
CURB_OBJECT_HSETTER(ruby_curl_easy, userpwd);
}
verbose = boolean => boolean
click to toggle source
Configure whether this Curl instance gives
verbose output to STDERR during transfers. Ignored if this instance has an
on_debug handler.
static VALUE ruby_curl_easy_verbose_set(VALUE self, VALUE verbose) {
CURB_BOOLEAN_SETTER(ruby_curl_easy, verbose);
}
verbose? => boolean
click to toggle source
Determine whether this Curl instance gives
verbose output to STDERR during transfers.
static VALUE ruby_curl_easy_verbose_q(VALUE self) {
CURB_BOOLEAN_GETTER(ruby_curl_easy, verbose);
}
easy = Curl::Easy.new("url")
click to toggle source
version = Curl::HTTP_1_1
version = Curl::HTTP_1_0
version = Curl::HTTP_NONE
static VALUE ruby_curl_easy_set_version(VALUE self, VALUE version) {
ruby_curl_easy *rbce;
//fprintf(stderr,"CURL_HTTP_VERSION_1_1: %d, CURL_HTTP_VERSION_1_0: %d, CURL_HTTP_VERSION_NONE: %d\n", CURL_HTTP_VERSION_1_1, CURL_HTTP_VERSION_1_0, CURL_HTTP_VERSION_NONE);
Data_Get_Struct(self, ruby_curl_easy, rbce);
curl_easy_setopt(rbce->curl, CURLOPT_HTTP_VERSION, FIX2INT(version));
return version;
}