Class: Patron::Session
- Inherits:
-
Object
- Object
- Patron::Session
- Defined in:
- lib/patron/session.rb,
ext/patron/session_ext.c
Overview
This class represents multiple request/response transactions with an HTTP server. This is the primary API for Patron.
Instance Attribute Summary collapse
-
#auth_type ⇒ Symbol
The authentication type for the request (
:basic
,:digest
or:token
). -
#automatic_content_encoding ⇒ Boolean
Support automatic Content-Encoding decompression and set liberal Accept-Encoding headers.
-
#base_url ⇒ String
The URL to prepend to all requests.
-
#buffer_size ⇒ Integer?
Set the buffer size for this request.
-
#cacert ⇒ String
Path to the CA file used for certificate verification, or
nil
if CURL default is used. -
#connect_timeout ⇒ Integer
HTTP connection timeout in seconds.
-
#default_response_charset ⇒ String?
Sets the name of the charset to assume for the response.
-
#download_byte_limit ⇒ Fixnum?
The amount of bytes downloaded.
-
#force_ipv4 ⇒ Boolean
Force curl to use IPv4.
-
#headers ⇒ Hash
Headers used in all requests.
-
#http_version ⇒ String
The supported values are "None", "HTTPv1_0", "HTTPv1_1", "HTTPv2_0", "HTTPv2_TLS", and "HTTPv2_PRIOR".
-
#ignore_content_length ⇒ Boolean
Whether Content-Range and Content-Length headers should be ignored.
-
#insecure ⇒ Boolean
Please consider twice before using this option..
-
#low_speed_limit ⇒ Integer?
The average transfer speed in bytes per second that the transfer should be below during
low_speed_time
seconds for libcurl to consider it to be too slow and abort. -
#low_speed_time ⇒ Integer?
The time in number seconds that the transfer speed should be below the
low_speed_limit
for the library to consider it too slow and abort. -
#max_redirects ⇒ Integer
Maximum number of redirects to follow Set to 0 to disable and -1 to follow all redirects.
-
#password ⇒ String?
Password for http authentication.
-
#progress_callback ⇒ #call?
Callable object that will be called with 4 arguments during request/response execution -
dltotal
,dlnow
,ultotal
,ulnow
. -
#proxy ⇒ String
Proxy URL in cURL format ('hostname:8080').
-
#proxy_type ⇒ Integer
Proxy type (default is HTTP).
-
#ssl_version ⇒ String
The supported values are nil, "SSLv2", "SSLv3", and "TLSv1".
-
#timeout ⇒ Integer
HTTP transaction timeout in seconds.
-
#username ⇒ String?
Username for http authentication.
WebDAV methods collapse
-
#copy(url, dest, headers = {}) ⇒ Patron::Response
Sends a WebDAV COPY request to the specified +url+.
Basic API methods collapse
-
#build_request(action, url, headers, options = {}) ⇒ Patron::Request
Builds a request object that can be used by ++handle_request++ Note that internally, ++handle_request++ uses instance variables of the Request object, and not it's public methods.
-
#request(action, url, headers, options = {}) ⇒ Patron::Response
Send an HTTP request to the specified
url
. -
#response_class ⇒ #new
Returns the class that will be used to build a Response from a Curl call.
Class Method Summary collapse
-
.escape(value) ⇒ Object
Escapes the provided string using libCURL URL escaping functions.
-
.unescape(value) ⇒ Object
Unescapes the provided string using libCURL URL escaping functions.
Instance Method Summary collapse
-
#add_cookie_file(file) ⇒ Object
Turn on cookie handling for this session, storing them in memory by default or in +file+ if specified.
-
#delete(url, headers = {}) ⇒ Patron::Response
Same as #get but performs a DELETE request.
-
#enable_debug(file = nil) ⇒ Object
Enable debug output to stderr or to specified
file
. -
#escape(value) ⇒ Object
(also: #urlencode)
Escapes the provided string using libCURL URL escaping functions.
-
#get(url, headers = {}) ⇒ Patron::Response
Retrieve the contents of the specified
url
optionally sending the specified headers. -
#get_file(url, filename, headers = {}) ⇒ Patron::Response
Retrieve the contents of the specified +url+ as with #get, but the content at the URL is downloaded directly into the specified file.
-
#handle_cookies(file_path = nil) ⇒ Object
Turn on cookie handling for this session, storing them in memory by default or in +file+ if specified.
-
#handle_request(request) ⇒ Patron::Response
Peform the actual HTTP request by calling libcurl.
-
#head(url, headers = {}) ⇒ Patron::Response
Same as #get but performs a HEAD request.
-
#initialize(args = {}) { ... } ⇒ Session
constructor
Create a new Session object for performing requests.
-
#interrupt ⇒ void
Interrupt any currently executing request.
-
#patch(url, data, headers = {}) ⇒ Patron::Response
Uploads the passed
data
to the specifiedurl
using an HTTP PATCH. -
#post(url, data, headers = {}) ⇒ Patron::Response
Uploads the passed
data
to the specifiedurl
using an HTTP POST. -
#post_file(url, filename, headers = {}) ⇒ Patron::Response
Uploads the contents of
file
to the specifiedurl
using an HTTP POST. -
#post_multipart(url, data, filename, headers = {}) ⇒ Patron::Response
Uploads the contents of
filename
to the specifiedurl
using an HTTP POST, in combination with given form fields passed indata
. -
#put(url, data, headers = {}) ⇒ Patron::Response
Uploads the passed
data
to the specifiedurl
using an HTTP PUT. -
#put_file(url, filename, headers = {}) ⇒ Patron::Response
Uploads the contents of
file
to the specifiedurl
using an HTTP PUT. -
#reset ⇒ Object
FIXME: figure out how this method should be used at all given Session is not multithreaded.
-
#set_debug_file(file) ⇒ Object
Enable debug output to stderr or to specified +file+.
-
#unescape(value) ⇒ Object
(also: #urldecode)
Unescapes the provided string using libCURL URL escaping functions.
Constructor Details
#initialize(args = {}) { ... } ⇒ Session
Create a new Session object for performing requests.
114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 |
# File 'lib/patron/session.rb', line 114 def initialize(args = {}, &block) # Allows accessors to be set via constructor hash. Ex: {:base_url => 'www.home.com'} args.each do |attribute, value| send("#{attribute}=", value) end # Allows accessors to be set via block. if block_given? yield self end @headers ||= {} @headers['User-Agent'] ||= Patron.user_agent_string @timeout ||= 5 @connect_timeout ||= 1 @max_redirects ||= 5 @auth_type ||= :basic @force_ipv4 ||= false end |
Instance Attribute Details
#auth_type ⇒ Symbol
Returns the authentication type for the request (:basic
, :digest
or :token
).
50 51 52 |
# File 'lib/patron/session.rb', line 50 def auth_type @auth_type end |
#automatic_content_encoding ⇒ Boolean
Returns Support automatic Content-Encoding decompression and set liberal Accept-Encoding headers.
86 87 88 |
# File 'lib/patron/session.rb', line 86 def automatic_content_encoding @automatic_content_encoding end |
#base_url ⇒ String
Returns The URL to prepend to all requests.
28 29 30 |
# File 'lib/patron/session.rb', line 28 def base_url @base_url end |
#buffer_size ⇒ Integer?
Set the buffer size for this request. This option will only be set if buffer_size is non-nil
73 74 75 |
# File 'lib/patron/session.rb', line 73 def buffer_size @buffer_size end |
#cacert ⇒ String
Returns path to the CA file used for certificate verification, or nil
if CURL default is used.
65 66 67 |
# File 'lib/patron/session.rb', line 65 def cacert @cacert end |
#connect_timeout ⇒ Integer
Returns HTTP connection timeout in seconds. Defaults to 1 second.
17 18 19 |
# File 'lib/patron/session.rb', line 17 def connect_timeout @connect_timeout end |
#default_response_charset ⇒ String?
Sets the name of the charset to assume for the response. The argument should be a String that
is an acceptable argument for Encoding.find()
in Ruby. The variable will only be used if the
response does not specify a charset in it's Content-Type
header already, if it does that charset
will take precedence.
80 81 82 |
# File 'lib/patron/session.rb', line 80 def default_response_charset @default_response_charset end |
#download_byte_limit ⇒ Fixnum?
Returns the amount of bytes downloaded. If it is set to nil (default) no limit will be applied. Note that this only works on libCURL 7.34 and newer.
91 92 93 |
# File 'lib/patron/session.rb', line 91 def download_byte_limit @download_byte_limit end |
#force_ipv4 ⇒ Boolean
Returns Force curl to use IPv4.
83 84 85 |
# File 'lib/patron/session.rb', line 83 def force_ipv4 @force_ipv4 end |
#headers ⇒ Hash
Returns headers used in all requests.
46 47 48 |
# File 'lib/patron/session.rb', line 46 def headers @headers end |
#http_version ⇒ String
The supported values are "None", "HTTPv1_0", "HTTPv1_1", "HTTPv2_0", "HTTPv2_TLS", and "HTTPv2_PRIOR".
62 63 64 |
# File 'lib/patron/session.rb', line 62 def http_version @http_version end |
#ignore_content_length ⇒ Boolean
Returns whether Content-Range and Content-Length headers should be ignored.
68 69 70 |
# File 'lib/patron/session.rb', line 68 def ignore_content_length @ignore_content_length end |
#insecure ⇒ Boolean
Please consider twice before using this option..
54 55 56 |
# File 'lib/patron/session.rb', line 54 def insecure @insecure end |
#low_speed_limit ⇒ Integer?
Returns the average transfer speed in bytes per second that the transfer should be below
during low_speed_time
seconds for libcurl to consider it to be too slow and abort.
101 102 103 |
# File 'lib/patron/session.rb', line 101 def low_speed_limit @low_speed_limit end |
#low_speed_time ⇒ Integer?
Returns the time in number seconds that the transfer speed should be below the
low_speed_limit
for the library to consider it too slow and abort.
96 97 98 |
# File 'lib/patron/session.rb', line 96 def low_speed_time @low_speed_time end |
#max_redirects ⇒ Integer
Maximum number of redirects to follow Set to 0 to disable and -1 to follow all redirects. Defaults to 5.
25 26 27 |
# File 'lib/patron/session.rb', line 25 def max_redirects @max_redirects end |
#password ⇒ String?
Password for http authentication
36 37 38 |
# File 'lib/patron/session.rb', line 36 def password @password end |
#progress_callback ⇒ #call?
Returns callable object that will be called with 4 arguments
during request/response execution - dltotal
, dlnow
, ultotal
, ulnow
.
All these arguments are in bytes.
108 109 110 |
# File 'lib/patron/session.rb', line 108 def progress_callback @progress_callback end |
#proxy ⇒ String
Returns Proxy URL in cURL format ('hostname:8080').
39 40 41 |
# File 'lib/patron/session.rb', line 39 def proxy @proxy end |
#proxy_type ⇒ Integer
Returns Proxy type (default is HTTP).
43 44 45 |
# File 'lib/patron/session.rb', line 43 def proxy_type @proxy_type end |
#ssl_version ⇒ String
The supported values are nil, "SSLv2", "SSLv3", and "TLSv1".
58 59 60 |
# File 'lib/patron/session.rb', line 58 def ssl_version @ssl_version end |
#timeout ⇒ Integer
Returns HTTP transaction timeout in seconds. Defaults to 5 seconds.
20 21 22 |
# File 'lib/patron/session.rb', line 20 def timeout @timeout end |
#username ⇒ String?
Username for http authentication
32 33 34 |
# File 'lib/patron/session.rb', line 32 def username @username end |
Class Method Details
.escape(value) ⇒ Object
Escapes the provided string using libCURL URL escaping functions.
271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 |
# File 'ext/patron/session_ext.c', line 271
static VALUE session_escape(VALUE self, VALUE value) {
VALUE string = StringValue(value);
char* escaped = NULL;
VALUE retval = Qnil;
struct patron_curl_state* state = curl_easy_init();
escaped = curl_easy_escape(state->handle,
RSTRING_PTR(string),
(int) RSTRING_LEN(string));
retval = rb_str_new2(escaped);
curl_easy_cleanup(state);
curl_free(escaped);
return retval;
}
|
.unescape(value) ⇒ Object
Unescapes the provided string using libCURL URL escaping functions.
295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 |
# File 'ext/patron/session_ext.c', line 295
static VALUE session_unescape(VALUE self, VALUE value) {
VALUE string = StringValue(value);
char* unescaped = NULL;
VALUE retval = Qnil;
struct patron_curl_state* state = curl_easy_init();
unescaped = curl_easy_unescape(state->handle,
RSTRING_PTR(string),
(int) RSTRING_LEN(string),
NULL);
retval = rb_str_new2(unescaped);
curl_free(unescaped);
curl_easy_cleanup(state);
return retval;
}
|
Instance Method Details
#add_cookie_file(file) ⇒ Object
Turn on cookie handling for this session, storing them in memory by
default or in +file+ if specified. The file
must be readable and
writable. Calling multiple times will add more files.
FIXME: what does the empty string actually do here?
924 925 926 927 928 929 930 931 932 933 934 935 936 937 |
# File 'ext/patron/session_ext.c', line 924
static VALUE add_cookie_file(VALUE self, VALUE file) {
struct patron_curl_state *state = get_patron_curl_state(self);
CURL* curl = state->handle;
char* file_path = NULL;
// FIXME: http://websystemsengineering.blogspot.nl/2013/03/curloptcookiefile-vs-curloptcookiejar.html
file_path = RSTRING_PTR(file);
if (file_path != NULL && strlen(file_path) != 0) {
curl_easy_setopt(curl, CURLOPT_COOKIEJAR, file_path);
}
curl_easy_setopt(curl, CURLOPT_COOKIEFILE, file_path);
return self;
}
|
#build_request(action, url, headers, options = {}) ⇒ Patron::Request
Builds a request object that can be used by ++handle_request++ Note that internally, ++handle_request++ uses instance variables of the Request object, and not it's public methods.
354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 |
# File 'lib/patron/session.rb', line 354 def build_request(action, url, headers, = {}) # If the Expect header isn't set uploads are really slow headers['Expect'] ||= '' Request.new.tap do |req| req.action = action req.headers = self.headers.merge headers req.automatic_content_encoding = .fetch :automatic_content_encoding, self.automatic_content_encoding req.timeout = .fetch :timeout, self.timeout req.connect_timeout = .fetch :connect_timeout, self.connect_timeout req.low_speed_time = .fetch :low_speed_time, self.low_speed_time req.low_speed_limit = .fetch :low_speed_limit, self.low_speed_limit req.force_ipv4 = .fetch :force_ipv4, self.force_ipv4 req.max_redirects = .fetch :max_redirects, self.max_redirects req.username = .fetch :username, self.username req.password = .fetch :password, self.password req.proxy = .fetch :proxy, self.proxy req.proxy_type = .fetch :proxy_type, self.proxy_type req.auth_type = .fetch :auth_type, self.auth_type req.insecure = .fetch :insecure, self.insecure req.ssl_version = .fetch :ssl_version, self.ssl_version req.http_version = .fetch :http_version, self.http_version req.cacert = .fetch :cacert, self.cacert req.ignore_content_length = .fetch :ignore_content_length, self.ignore_content_length req.buffer_size = .fetch :buffer_size, self.buffer_size req.download_byte_limit = .fetch :download_byte_limit, self.download_byte_limit req.progress_callback = .fetch :progress_callback, self.progress_callback req.multipart = [:multipart] req.upload_data = [:data] req.file_name = [:file] base_url = self.base_url.to_s url = url.to_s raise ArgumentError, "Empty URL" if base_url.empty? && url.empty? uri = URI.parse(base_url.empty? ? url : File.join(base_url, url)) query = uri.query.to_s.split('&') query += [:query].is_a?(Hash) ? Util.build_query_pairs_from_hash([:query]) : [:query].to_s.split('&') uri.query = query.join('&') uri.query = nil if uri.query.empty? url = uri.to_s req.url = url end end |
#copy(url, dest, headers = {}) ⇒ Patron::Response
Sends a WebDAV COPY request to the specified +url+.
310 311 312 313 |
# File 'lib/patron/session.rb', line 310 def copy(url, dest, headers = {}) headers['Destination'] = dest request(:copy, url, headers) end |
#delete(url, headers = {}) ⇒ Patron::Response
Same as #get but performs a DELETE request.
Notice: this method doesn't accept any data
argument: if you need to send data with
a delete request (as might be needed for ElasticSearch), please, use the #request method.
220 221 222 |
# File 'lib/patron/session.rb', line 220 def delete(url, headers = {}) request(:delete, url, headers) end |
#enable_debug(file = nil) ⇒ Object
Change to an assignment of an IO object
Enable debug output to stderr or to specified file
.
168 169 170 171 |
# File 'lib/patron/session.rb', line 168 def enable_debug(file = nil) set_debug_file(file.to_s) self end |
#escape(value) ⇒ Object Also known as: urlencode
Escapes the provided string using libCURL URL escaping functions.
271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 |
# File 'ext/patron/session_ext.c', line 271
static VALUE session_escape(VALUE self, VALUE value) {
VALUE string = StringValue(value);
char* escaped = NULL;
VALUE retval = Qnil;
struct patron_curl_state* state = curl_easy_init();
escaped = curl_easy_escape(state->handle,
RSTRING_PTR(string),
(int) RSTRING_LEN(string));
retval = rb_str_new2(escaped);
curl_easy_cleanup(state);
curl_free(escaped);
return retval;
}
|
#get(url, headers = {}) ⇒ Patron::Response
Retrieve the contents of the specified url
optionally sending the
specified headers. If the +base_url+ varaible is set then it is prepended
to the +url+ parameter. Any custom headers are merged with the contents
of the +headers+ instance variable. The results are returned in a
Response object.
Notice: this method doesn't accept any data
argument: if you need to send a request body
with a GET request, when using ElasticSearch for example, please, use the #request method.
184 185 186 |
# File 'lib/patron/session.rb', line 184 def get(url, headers = {}) request(:get, url, headers) end |
#get_file(url, filename, headers = {}) ⇒ Patron::Response
Retrieve the contents of the specified +url+ as with #get, but the content at the URL is downloaded directly into the specified file. The file will be accessed by libCURL bypassing the Ruby runtime entirely.
Note that when using this option, the Response object will have ++nil++ as the body, and you will need to read your target file for access to the body string).
198 199 200 |
# File 'lib/patron/session.rb', line 198 def get_file(url, filename, headers = {}) request(:get, url, headers, :file => filename) end |
#handle_cookies(file_path = nil) ⇒ Object
the cookie jar and cookie file path options should be split
Turn on cookie handling for this session, storing them in memory by
default or in +file+ if specified. The file
must be readable and
writable. Calling multiple times will add more files.
142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 |
# File 'lib/patron/session.rb', line 142 def (file_path = nil) if file_path path = Pathname(file_path). if !File.exists?(file_path) && !File.writable?(path.dirname) raise ArgumentError, "Can't create file #{path} (permission error)" elsif File.exists?(file_path) && !File.writable?(file_path) raise ArgumentError, "Can't read or write file #{path} (permission error)" end else path = nil end # Apparently calling this with an empty string sets the cookie file, # but calling it with a path to a writable file sets that file to be # the cookie jar (new cookies are written there) (path.to_s) self end |
#handle_request(request) ⇒ Patron::Response
Peform the actual HTTP request by calling libcurl. Each filed in the +request+ object will be used to set the appropriate option on the libcurl library. After the request completes, a Response object will be created and returned.
In the event of an error in the libcurl library, a Ruby exception will be created and raised. The exception will return the libcurl error code and error message.
874 875 876 877 |
# File 'ext/patron/session_ext.c', line 874
static VALUE session_handle_request(VALUE self, VALUE request) {
set_options_from_request(self, request);
return rb_ensure(&perform_request, self, &cleanup, self);
}
|
#head(url, headers = {}) ⇒ Patron::Response
Same as #get but performs a HEAD request.
208 209 210 |
# File 'lib/patron/session.rb', line 208 def head(url, headers = {}) request(:head, url, headers) end |
#interrupt ⇒ void
This method returns an undefined value.
Interrupt any currently executing request. This will cause the current request to error and raise an exception.
909 910 911 912 913 |
# File 'ext/patron/session_ext.c', line 909
static VALUE session_interrupt(VALUE self) {
struct patron_curl_state *state = get_patron_curl_state(self);
state->interrupt = INTERRUPT_ABORT;
return self;
}
|
#patch(url, data, headers = {}) ⇒ Patron::Response
inconsistency with "post" - Hash not accepted
Uploads the passed data
to the specified url
using an HTTP PATCH. Note that
unline ++post++, a Hash is not accepted as the ++data++ argument.
248 249 250 |
# File 'lib/patron/session.rb', line 248 def patch(url, data, headers = {}) request(:patch, url, headers, :data => data) end |
#post(url, data, headers = {}) ⇒ Patron::Response
Uploads the passed data
to the specified url
using an HTTP POST.
272 273 274 275 276 277 278 |
# File 'lib/patron/session.rb', line 272 def post(url, data, headers = {}) if data.is_a?(Hash) data = data.map {|k,v| urlencode(k.to_s) + '=' + urlencode(v.to_s) }.join('&') headers['Content-Type'] = 'application/x-www-form-urlencoded' end request(:post, url, headers, :data => data) end |
#post_file(url, filename, headers = {}) ⇒ Patron::Response
Uploads the contents of file
to the specified url
using an HTTP POST.
The file will be sent "as-is" without any multipart encoding.
287 288 289 |
# File 'lib/patron/session.rb', line 287 def post_file(url, filename, headers = {}) request(:post, url, headers, :file => filename) end |
#post_multipart(url, data, filename, headers = {}) ⇒ Patron::Response
Uploads the contents of filename
to the specified url
using an HTTP POST,
in combination with given form fields passed in data
.
299 300 301 |
# File 'lib/patron/session.rb', line 299 def post_multipart(url, data, filename, headers = {}) request(:post, url, headers, {:data => data, :file => filename, :multipart => true}) end |
#put(url, data, headers = {}) ⇒ Patron::Response
inconsistency with "post" - Hash not accepted
Uploads the passed data
to the specified url
using an HTTP PUT. Note that
unline ++post++, a Hash is not accepted as the ++data++ argument.
234 235 236 |
# File 'lib/patron/session.rb', line 234 def put(url, data, headers = {}) request(:put, url, headers, :data => data) end |
#put_file(url, filename, headers = {}) ⇒ Patron::Response
Uploads the contents of file
to the specified url
using an HTTP PUT. The file will be
sent "as-is" without any multipart encoding.
259 260 261 |
# File 'lib/patron/session.rb', line 259 def put_file(url, filename, headers = {}) request(:put, url, headers, :file => filename) end |
#request(action, url, headers, options = {}) ⇒ Patron::Response
Send an HTTP request to the specified url
.
325 326 327 328 |
# File 'lib/patron/session.rb', line 325 def request(action, url, headers, = {}) req = build_request(action, url, headers, ) handle_request(req) end |
#reset ⇒ Object
FIXME: figure out how this method should be used at all given Session is not multithreaded.
FIXME: also: what is the difference with interrupt()
and also relationship with cleanup()
?
Reset the underlying cURL session. This effectively closes all open
connections and disables debug output. There is no need to call this method
manually after performing a request, since cleanup is performed automatically
but the method can be used from another thread
to abort a request currently in progress.
890 891 892 893 894 895 896 897 898 899 900 901 902 |
# File 'ext/patron/session_ext.c', line 890
static VALUE session_reset(VALUE self) {
struct patron_curl_state *state;
Data_Get_Struct(self, struct patron_curl_state, state);
if (NULL != state->handle) {
cleanup(self);
curl_easy_cleanup(state->handle);
state->handle = NULL;
session_close_debug_file(state);
}
return self;
}
|
#response_class ⇒ #new
Returns the class that will be used to build a Response from a Curl call.
Primarily useful if you need a very lightweight Response object that does not have to perform all the parsing of various headers/status codes. The method must return a module that supports the same interface for +new+ as ++Patron::Response++
341 342 343 |
# File 'lib/patron/session.rb', line 341 def response_class ::Patron::Response end |
#set_debug_file(file) ⇒ Object
Enable debug output to stderr or to specified +file+.
945 946 947 948 949 950 951 952 953 954 955 956 957 958 |
# File 'ext/patron/session_ext.c', line 945
static VALUE set_debug_file(VALUE self, VALUE file) {
struct patron_curl_state *state = get_patron_curl_state(self);
char* file_path = RSTRING_PTR(file);
session_close_debug_file(state);
if(file_path != NULL && strlen(file_path) != 0) {
state->debug_file = open_file(file, "wb");
} else {
state->debug_file = stderr;
}
return self;
}
|
#unescape(value) ⇒ Object Also known as: urldecode
Unescapes the provided string using libCURL URL escaping functions.
295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 |
# File 'ext/patron/session_ext.c', line 295
static VALUE session_unescape(VALUE self, VALUE value) {
VALUE string = StringValue(value);
char* unescaped = NULL;
VALUE retval = Qnil;
struct patron_curl_state* state = curl_easy_init();
unescaped = curl_easy_unescape(state->handle,
RSTRING_PTR(string),
(int) RSTRING_LEN(string),
NULL);
retval = rb_str_new2(unescaped);
curl_free(unescaped);
curl_easy_cleanup(state);
return retval;
}
|