curb 0.6.9 → 0.7.0

data/ext/curb.c

@@ -255,6 +255,10 @@ void Init_curb_core() {
   /* Passed to on_debug handler to indicate that the data is protocol data sent to the peer. */
   rb_define_const(mCurl, "CURLINFO_DATA_OUT", INT2FIX(CURLINFO_DATA_OUT));
 
+  rb_define_const(mCurl, "CURL_MULTICWD",  INT2FIX(CURLFTPMETHOD_MULTICWD));
+  rb_define_const(mCurl, "CURL_NOCWD",     INT2FIX(CURLFTPMETHOD_NOCWD));
+  rb_define_const(mCurl, "CURL_SINGLECWD", INT2FIX(CURLFTPMETHOD_SINGLECWD));
+
   /* When passed to Curl::Easy#proxy_type , indicates that the proxy is an HTTP proxy. (libcurl >= 7.10) */
 #ifdef HAVE_CURLPROXY_HTTP
   rb_define_const(mCurl, "CURLPROXY_HTTP", INT2FIX(CURLPROXY_HTTP));
@@ -262,6 +266,28 @@ void Init_curb_core() {
   rb_define_const(mCurl, "CURLPROXY_HTTP", INT2FIX(-1));
 #endif
 
+#ifdef CURL_VERSION_SSL
+  rb_define_const(mCurl, "CURL_SSLVERSION_DEFAULT", INT2FIX(CURL_SSLVERSION_DEFAULT));
+  rb_define_const(mCurl, "CURL_SSLVERSION_TLSv1",   INT2FIX(CURL_SSLVERSION_TLSv1));
+  rb_define_const(mCurl, "CURL_SSLVERSION_SSLv2",   INT2FIX(CURL_SSLVERSION_SSLv2));
+  rb_define_const(mCurl, "CURL_SSLVERSION_SSLv3",   INT2FIX(CURL_SSLVERSION_SSLv3));
+
+  rb_define_const(mCurl, "CURL_USESSL_CONTROL", INT2FIX(CURB_FTPSSL_CONTROL));
+  rb_define_const(mCurl, "CURL_USESSL_NONE", INT2FIX(CURB_FTPSSL_NONE));
+  rb_define_const(mCurl, "CURL_USESSL_TRY", INT2FIX(CURB_FTPSSL_TRY));
+  rb_define_const(mCurl, "CURL_USESSL_ALL", INT2FIX(CURB_FTPSSL_ALL));
+#else
+  rb_define_const(mCurl, "CURL_SSLVERSION_DEFAULT", INT2FIX(-1));
+  rb_define_const(mCurl, "CURL_SSLVERSION_TLSv1",   INT2FIX(-1));
+  rb_define_const(mCurl, "CURL_SSLVERSION_SSLv2",   INT2FIX(-1));
+  rb_define_const(mCurl, "CURL_SSLVERSION_SSLv3",   INT2FIX(-1));
+
+  rb_define_const(mCurl, "CURL_USESSL_CONTROL", INT2FIX(-1));
+  rb_define_const(mCurl, "CURL_USESSL_NONE", INT2FIX(-1));
+  rb_define_const(mCurl, "CURL_USESSL_TRY", INT2FIX(-1));
+  rb_define_const(mCurl, "CURL_USESSL_ALL", INT2FIX(-1));
+#endif
+
   /* When passed to Curl::Easy#proxy_type , indicates that the proxy is a SOCKS4 proxy. (libcurl >= 7.15.2) */
 #ifdef HAVE_CURLPROXY_SOCKS4
   rb_define_const(mCurl, "CURLPROXY_SOCKS4", INT2FIX(CURLPROXY_SOCKS4));

data/ext/curb.h

@@ -20,11 +20,11 @@
 #include "curb_macros.h"
 
 // These should be managed from the Rake 'release' task.
-#define CURB_VERSION   "0.6.9"
-#define CURB_VER_NUM   690
+#define CURB_VERSION   "0.7.0"
+#define CURB_VER_NUM   700
 #define CURB_VER_MAJ   0
-#define CURB_VER_MIN   6
-#define CURB_VER_MIC   9
+#define CURB_VER_MIN   7
+#define CURB_VER_MIC   0
 #define CURB_VER_PATCH 0
 
 

data/ext/curb_easy.c

@@ -141,6 +141,11 @@ void curl_easy_free(ruby_curl_easy *rbce) {
   if (rbce->curl_headers) {
     curl_slist_free_all(rbce->curl_headers);
   }
+
+  if (rbce->curl_ftp_commands) {
+    curl_slist_free_all(rbce->curl_ftp_commands);
+  }
+
   curl_easy_cleanup(rbce->curl);
   free(rbce);
 }
@@ -176,6 +181,7 @@ static VALUE ruby_curl_easy_new(int argc, VALUE *argv, VALUE klass) {
   rb_easy_set("url", url);
 
   rbce->curl_headers = NULL;
+  rbce->curl_ftp_commands = NULL;
 
   /* various-typed opts */
   rbce->local_port = 0;
@@ -189,6 +195,9 @@ static VALUE ruby_curl_easy_new(int argc, VALUE *argv, VALUE klass) {
   rbce->connect_timeout = 0;
   rbce->dns_cache_timeout = 60;
   rbce->ftp_response_timeout = 0;
+  rbce->ssl_version = -1;
+  rbce->use_ssl = -1;
+  rbce->ftp_filemethod = -1;
 
   /* bool opts */
   rbce->proxy_tunnel = 0;
@@ -235,6 +244,7 @@ static VALUE ruby_curl_easy_clone(VALUE self) {
   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);
 }
@@ -256,7 +266,7 @@ static VALUE ruby_curl_easy_url_set(VALUE self, VALUE url) {
 
 /*
  * call-seq:
- *   easy.url                                         => "http://some.url/"
+ *   easy.url                                         => string
  *
  * Obtain the URL that will be used by subsequent calls to +perform+.
  */
@@ -266,7 +276,7 @@ static VALUE ruby_curl_easy_url_get(VALUE self) {
 
 /*
  * call-seq:
- *   easy.proxy_url = "some.url"                      => "some.url"
+ *   easy.proxy_url = string                          => string
  *
  * 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
@@ -295,7 +305,7 @@ static VALUE ruby_curl_easy_proxy_url_set(VALUE self, VALUE proxy_url) {
 
 /*
  * call-seq:
- *   easy.proxy_url                                   => "some.url"
+ *   easy.proxy_url                                   => string
  *
  * Obtain the HTTP Proxy URL that will be used by subsequent calls to +perform+.
  */
@@ -305,8 +315,8 @@ static VALUE ruby_curl_easy_proxy_url_get(VALUE self) {
 
 /*
  * call-seq:
- *   easy.headers = "Header: val"                              => ["Header: val", ...]
- *   easy.headers = {"Header" => "val" ..., "Header" => "val"} => ["Header: val", ...]
+ *   easy.headers = "Header: val"                              => "Header: val"
+ *   easy.headers = {"Header" => "val" ..., "Header" => "val"} => {"Header: val", ...}
  *   easy.headers = ["Header: val" ..., "Header: val"]         => ["Header: val", ...]
  *
  * Set custom HTTP headers for following requests. This can be used to add
@@ -331,7 +341,7 @@ static VALUE ruby_curl_easy_headers_set(VALUE self, VALUE headers) {
 
 /*
  * call-seq:
- *   easy.headers                                              => Hash, Array or Str
+ *   easy.headers                                     => Hash, Array or Str
  *
  * Obtain the custom HTTP headers for following requests.
  */
@@ -346,7 +356,7 @@ static VALUE ruby_curl_easy_headers_get(VALUE self) {
 
 /*
  * call-seq:
- *   easy.interface = "interface"                     => "interface"
+ *   easy.interface = string                          => string
  *
  * 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.
@@ -357,7 +367,7 @@ static VALUE ruby_curl_easy_interface_set(VALUE self, VALUE interface_hm) {
 
 /*
  * call-seq:
- *   easy.interface                                   => "interface"
+ *   easy.interface                                   => string
  *
  * 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.
@@ -368,7 +378,7 @@ static VALUE ruby_curl_easy_interface_get(VALUE self) {
 
 /*
  * call-seq:
- *   easy.userpwd = "pwd string"                      => "pwd string"
+ *   easy.userpwd = string                            => string
  *
  * Set the username/password string to use for subsequent calls to +perform+.
  * The supplied string should have the form "username:password"
@@ -379,7 +389,7 @@ static VALUE ruby_curl_easy_userpwd_set(VALUE self, VALUE userpwd) {
 
 /*
  * call-seq:
- *   easy.userpwd                                     => "pwd string"
+ *   easy.userpwd                                     => string
  *
  * Obtain the username/password string that will be used for subsequent
  * calls to +perform+.
@@ -390,7 +400,7 @@ static VALUE ruby_curl_easy_userpwd_get(VALUE self) {
 
 /*
  * call-seq:
- *   easy.proxypwd = "pwd string"                     => "pwd string"
+ *   easy.proxypwd = string                           => string
  *
  * Set the username/password string to use for proxy connection during
  * subsequent calls to +perform+. The supplied string should have the
@@ -402,7 +412,7 @@ static VALUE ruby_curl_easy_proxypwd_set(VALUE self, VALUE proxypwd) {
 
 /*
  * call-seq:
- *   easy.proxypwd                                    => "pwd string"
+ *   easy.proxypwd                                    => string
  *
  * Obtain the username/password string that will be used for proxy
  * connection during subsequent calls to +perform+. The supplied string
@@ -415,7 +425,7 @@ static VALUE ruby_curl_easy_proxypwd_get(VALUE self) {
 
 /*
  * call-seq:
- *   easy.cookies = "name1=content1; name2=content2;"                => "pwd string"
+ *   easy.cookies = "name1=content1; name2=content2;" => string
  *
  * 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.
@@ -427,7 +437,7 @@ static VALUE ruby_curl_easy_cookies_set(VALUE self, VALUE cookies) {
 
 /*
  * call-seq:
- *   easy.cookies                                   => "name1=content1; name2=content2;"
+ *   easy.cookies                                     => "name1=content1; name2=content2;"
  *
  * Obtain the cookies for this Curl::Easy instance.
  */
@@ -437,7 +447,7 @@ static VALUE ruby_curl_easy_cookies_get(VALUE self) {
 
 /*
  * call-seq:
- *   easy.cookiefile = "cookies.txt"                => "pwd string"
+ *   easy.cookiefile = string                         => string
  *
  * Set a file that contains cookies to be sent in subsequent requests by this Curl::Easy instance.
  *
@@ -450,7 +460,7 @@ static VALUE ruby_curl_easy_cookiefile_set(VALUE self, VALUE cookiefile) {
 
 /*
  * call-seq:
- *   easy.cookiefile                                   => "cookies.txt"
+ *   easy.cookiefile                                  => string
  *
  * Obtain the cookiefile file for this Curl::Easy instance.
  */
@@ -460,7 +470,7 @@ static VALUE ruby_curl_easy_cookiefile_get(VALUE self) {
 
 /*
  * call-seq:
- *   easy.cookiejar = "cookiejar.file"                => "pwd string"
+ *   easy.cookiejar = string                          => string
  *
  * Set a cookiejar file to use for this Curl::Easy instance.
  * Cookies from the response will be written into this file.
@@ -474,7 +484,7 @@ static VALUE ruby_curl_easy_cookiejar_set(VALUE self, VALUE cookiejar) {
 
 /*
  * call-seq:
- *   easy.cookiejar                                   => "cookiejar.file"
+ *   easy.cookiejar                                   => string
  *
  * Obtain the cookiejar file to use for this Curl::Easy instance.
  */
@@ -484,7 +494,7 @@ static VALUE ruby_curl_easy_cookiejar_get(VALUE self) {
 
 /*
  * call-seq:
- *   easy.cert = "cert.file"                          => ""
+ *   easy.cert = string                               => ""
  *
  * Set a cert file to use for this Curl::Easy instance. This file
  * will be used to validate SSL connections.
@@ -496,7 +506,7 @@ static VALUE ruby_curl_easy_cert_set(VALUE self, VALUE cert) {
 
 /*
  * call-seq:
- *   easy.cert                                        => "cert.file"
+ *   easy.cert                                        => string
  *
  * Obtain the cert file to use for this Curl::Easy instance.
  */
@@ -528,7 +538,7 @@ static VALUE ruby_curl_easy_cert_key_get(VALUE self) {
 
 /*
  * call-seq:
- *   easy.cacert = "cacert.file"                      => ""
+ *   easy.cacert = string                             => ""
  *
  * Set a cacert bundle to use for this Curl::Easy instance. This file
  * will be used to validate SSL certificates.
@@ -540,7 +550,7 @@ static VALUE ruby_curl_easy_cacert_set(VALUE self, VALUE cacert) {
 
 /*
  * call-seq:
- *   easy.cacert                                      => "cacert.file"
+ *   easy.cacert                                      => string
  *
  * Obtain the cacert file to use for this Curl::Easy instance.
  */
@@ -550,7 +560,7 @@ static VALUE ruby_curl_easy_cacert_get(VALUE self) {
 
 /*
  * call-seq:
- *   easy.certpassword = "cert password"                   => ""
+ *   easy.certpassword = string                       => ""
  *
  * Set a password used to open the specified cert
  */
@@ -572,7 +582,7 @@ static VALUE ruby_curl_easy_certtype_set(VALUE self, VALUE certtype) {
 
 /*
  * call-seq:
- *   easy.certtype                                  => "cert.type"
+ *   easy.certtype                                    => string
  *
  * Obtain the cert type used for this Curl::Easy instance
  */
@@ -582,7 +592,7 @@ static VALUE ruby_curl_easy_certtype_get(VALUE self) {
 
 /*
  * call-seq:
- *   easy.encoding=                                     => "string"
+ *   easy.encoding = string                           => string
  *
  * Set the accepted encoding types, curl will handle all of the decompression
  *
@@ -592,7 +602,7 @@ static VALUE ruby_curl_easy_encoding_set(VALUE self, VALUE encoding) {
 }
 /*
  * call-seq:
- *   easy.encoding                                     => "string"
+ *   easy.encoding                                    => string
  *
  * Get the set encoding types
  *
@@ -603,7 +613,7 @@ static VALUE ruby_curl_easy_encoding_get(VALUE self) {
 
 /*
  * call-seq:
- *   easy.useragent = "Ruby/Curb"                      => ""
+ *   easy.useragent = "Ruby/Curb"                     => ""
  *
  * Set the user agent string for this Curl::Easy instance
  *
@@ -624,7 +634,7 @@ static VALUE ruby_curl_easy_useragent_get(VALUE self) {
 
 /*
  * call-seq:
- *   easy.post_body = "some=form%20data&to=send" => string or nil
+ *   easy.post_body = "some=form%20data&to=send"      => string or nil
  * 
  * 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.
@@ -668,7 +678,7 @@ static VALUE ruby_curl_easy_post_body_set(VALUE self, VALUE post_body) {
 
 /*
  * call-seq:
- *   easy.post_body                                  => "string" or nil
+ *   easy.post_body                                  => string or nil
  *
  * Obtain the POST body used in this Curl::Easy instance.
  */
@@ -748,6 +758,24 @@ static VALUE ruby_curl_easy_put_data_set(VALUE self, VALUE data) {
   return data;
 }
 
+/*
+ * call-seq:
+ *   easy.ftp_commands = ["CWD /", "MKD directory"]   => ["CWD /", ...]
+ *
+ * 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);
+}
+
+/*
+ * 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);
+}
+
 /* ================== IMMED ATTRS ==================*/
 
 /*
@@ -1073,7 +1101,7 @@ static VALUE ruby_curl_easy_ftp_response_timeout_get(VALUE self, VALUE ftp_respo
 
 /*
  * call-seq:
- *   easy.username = "foo"  => String
+ *   easy.username = string                           => string
  *
  * Set the HTTP Authentication username.
  */
@@ -1087,7 +1115,7 @@ static VALUE ruby_curl_easy_username_set(VALUE self, VALUE username) {
 
 /*
  * call-seq:
- *   easy.username   => String
+ *   easy.username                                    => string
  * 
  * Get the current username
  */
@@ -1101,7 +1129,7 @@ static VALUE ruby_curl_easy_username_get(VALUE self, VALUE username) {
 
 /*
  * call-seq:
- *   easy.password = "foo"  => String
+ *   easy.password = string                           => string
  *
  * Set the HTTP Authentication password.
  */
@@ -1115,7 +1143,7 @@ static VALUE ruby_curl_easy_password_set(VALUE self, VALUE password) {
 
 /*
  * call-seq:
- *   easy.password   => String
+ *   easy.password                                    => string
  * 
  * Get the current password
  */
@@ -1127,11 +1155,75 @@ static VALUE ruby_curl_easy_password_get(VALUE self, VALUE password) {
 #endif
 }
 
+/*
+ * call-seq:
+ *   easy.ssl_version = value                         => fixnum or nil
+ *
+ * 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);
+}
+
+/*
+ * call-seq:
+ *   easy.ssl_version                                 => fixnum
+ *
+ * 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);
+}
+
+/*
+ * call-seq:
+ *   easy.use_ssl = value                             => fixnum or nil
+ * 
+ * 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);
+}
+
+/*
+ * call-seq:
+ *   easy.use_ssl                                     => fixnum
+ *
+ * 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);
+}
+
+/*
+ * call-seq:
+ *   easy.ftp_filemethod = value                      => fixnum or nil
+ *
+ * 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);
+}
+
+/*
+ * 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);
+}
+
 /* ================== BOOL ATTRS ===================*/
 
 /*
  * call-seq:
- *   proxy_tunnel = boolean                           => boolean
+ *   easy.proxy_tunnel = boolean                      => boolean
  *
  * Configure whether this Curl instance will use proxy tunneling.
  */
@@ -1141,7 +1233,7 @@ static VALUE ruby_curl_easy_proxy_tunnel_set(VALUE self, VALUE proxy_tunnel) {
 
 /*
  * call-seq:
- *   proxy_tunnel?                                    => boolean
+ *   easy.proxy_tunnel?                               => boolean
  *
  * Determine whether this Curl instance will use proxy tunneling.
  */
@@ -1151,7 +1243,7 @@ static VALUE ruby_curl_easy_proxy_tunnel_q(VALUE self) {
 
 /*
  * call-seq:
- *   fetch_file_time = boolean                        => boolean
+ *   easy.fetch_file_time = boolean                   => boolean
  *
  * Configure whether this Curl instance will fetch remote file
  * times, if available.
@@ -1162,7 +1254,7 @@ static VALUE ruby_curl_easy_fetch_file_time_set(VALUE self, VALUE fetch_file_tim
 
 /*
  * call-seq:
- *   fetch_file_time?                                 => boolean
+ *   easy.fetch_file_time?                            => boolean
  *
  * Determine whether this Curl instance will fetch remote file
  * times, if available.
@@ -1173,7 +1265,7 @@ static VALUE ruby_curl_easy_fetch_file_time_q(VALUE self) {
 
 /*
  * call-seq:
- *   ssl_verify_peer = boolean                        => boolean
+ *   easy.ssl_verify_peer = boolean                   => boolean
  *
  * Configure whether this Curl instance will verify the SSL peer
  * certificate. When true (the default), and the verification fails to
@@ -1191,7 +1283,7 @@ static VALUE ruby_curl_easy_ssl_verify_peer_set(VALUE self, VALUE ssl_verify_pee
 
 /*
  * call-seq:
- *   ssl_verify_peer?                                 => boolean
+ *   easy.ssl_verify_peer?                            => boolean
  *
  * Determine whether this Curl instance will verify the SSL peer
  * certificate.
@@ -1202,7 +1294,7 @@ static VALUE ruby_curl_easy_ssl_verify_peer_q(VALUE self) {
 
 /*
  * call-seq:
- *   ssl_verify_host = boolean                        => boolean
+ *   easy.ssl_verify_host = boolean                   => boolean
  *
  * 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
@@ -1219,7 +1311,7 @@ static VALUE ruby_curl_easy_ssl_verify_host_set(VALUE self, VALUE ssl_verify_hos
 
 /*
  * call-seq:
- *   ssl_verify_host?                                 => boolean
+ *   easy.ssl_verify_host?                            => boolean
  *
  * Determine whether this Curl instance will verify that the server cert
  * is for the server it is known as.
@@ -1230,7 +1322,7 @@ static VALUE ruby_curl_easy_ssl_verify_host_q(VALUE self) {
 
 /*
  * call-seq:
- *   header_in_body = boolean                         => boolean
+ *   easy.header_in_body = boolean                    => boolean
  *
  * Configure whether this Curl instance will return HTTP headers
  * combined with body data. If this option is set true, both header
@@ -1242,7 +1334,7 @@ static VALUE ruby_curl_easy_header_in_body_set(VALUE self, VALUE header_in_body)
 
 /*
  * call-seq:
- *   header_in_body?                                  => boolean
+ *   easy.header_in_body?                             => boolean
  *
  * Determine whether this Curl instance will verify the SSL peer
  * certificate.
@@ -1253,7 +1345,7 @@ static VALUE ruby_curl_easy_header_in_body_q(VALUE self) {
 
 /*
  * call-seq:
- *   use_netrc = boolean                              => boolean
+ *   easy.use_netrc = boolean                         => boolean
  *
  * Configure whether this Curl instance will use data from the user's
  * .netrc file for FTP connections.
@@ -1264,7 +1356,7 @@ static VALUE ruby_curl_easy_use_netrc_set(VALUE self, VALUE use_netrc) {
 
 /*
  * call-seq:
- *   use_netrc?                                       => boolean
+ *   easy.use_netrc?                                  => boolean
  *
  * Determine whether this Curl instance will use data from the user's
  * .netrc file for FTP connections.
@@ -1275,7 +1367,7 @@ static VALUE ruby_curl_easy_use_netrc_q(VALUE self) {
 
 /*
  * call-seq:
- *   follow_location = boolean                        => boolean
+ *   easy.follow_location = boolean                   => boolean
  *
  * Configure whether this Curl instance will follow Location: headers
  * in HTTP responses. Redirects will only be followed to the extent
@@ -1287,7 +1379,7 @@ static VALUE ruby_curl_easy_follow_location_set(VALUE self, VALUE follow_locatio
 
 /*
  * call-seq:
- *   follow_location?                                 => boolean
+ *   easy.follow_location?                            => boolean
  *
  * Determine whether this Curl instance will follow Location: headers
  * in HTTP responses.
@@ -1298,7 +1390,7 @@ static VALUE ruby_curl_easy_follow_location_q(VALUE self) {
 
 /*
  * call-seq:
- *   unrestricted_auth = boolean                      => boolean
+ *   easy.unrestricted_auth = boolean                 => boolean
  *
  * Configure whether this Curl instance may use any HTTP authentication
  * method available when necessary.
@@ -1309,7 +1401,7 @@ static VALUE ruby_curl_easy_unrestricted_auth_set(VALUE self, VALUE unrestricted
 
 /*
  * call-seq:
- *   unrestricted_auth?                               => boolean
+ *   easy.unrestricted_auth?                          => boolean
  *
  * Determine whether this Curl instance may use any HTTP authentication
  * method available when necessary.
@@ -1383,7 +1475,7 @@ static VALUE ruby_curl_easy_enable_cookies_set(VALUE self, VALUE enable_cookies)
 
 /*
  * call-seq:
- *   easy.enable_cookies?                        => boolean
+ *   easy.enable_cookies?                             => boolean
  *
  * Determine whether the libcurl cookie engine is enabled for this
  * Curl::Easy instance.
@@ -1415,7 +1507,7 @@ static VALUE ruby_curl_easy_on_body_set(int argc, VALUE *argv, VALUE self) {
 
 /*
  * call-seq:
- *   easy.on_success { |easy| ... }                 => <old handler>
+ *   easy.on_success { |easy| ... }                   => <old handler>
  *
  * Assign or remove the +on_success+ handler for this Curl::Easy instance.
  * To remove a previously-supplied handler, call this method with no
@@ -1430,7 +1522,7 @@ static VALUE ruby_curl_easy_on_success_set(int argc, VALUE *argv, VALUE self) {
 
 /*
  * call-seq:
- *   easy.on_failure {|easy,code| ... }                 => <old handler>
+ *   easy.on_failure {|easy,code| ... }               => <old handler>
  *
  * Assign or remove the +on_failure+ handler for this Curl::Easy instance.
  * To remove a previously-supplied handler, call this method with no
@@ -1445,7 +1537,7 @@ static VALUE ruby_curl_easy_on_failure_set(int argc, VALUE *argv, VALUE self) {
 
 /*
  * call-seq:
- *   easy.on_complete {|easy| ... }                 => <old handler>
+ *   easy.on_complete {|easy| ... }                   => <old handler>
  *
  * Assign or remove the +on_complete+ handler for this Curl::Easy instance.
  * To remove a previously-supplied handler, call this method with no
@@ -1547,6 +1639,16 @@ static VALUE cb_each_http_header(VALUE header, struct curl_slist **list) {
   return header_str;
 }
 
+/***********************************************
+ * This is an rb_iterate callback used to set up ftp commands.
+ */
+static VALUE cb_each_ftp_command(VALUE ftp_command, struct curl_slist **list) {
+  VALUE ftp_command_string = rb_obj_as_string(ftp_command);
+  *list = curl_slist_append(*list, StringValuePtr(ftp_command));
+
+  return ftp_command_string;
+}
+
 /***********************************************
  *
  * Setup a connection
@@ -1558,6 +1660,7 @@ VALUE ruby_curl_easy_setup( ruby_curl_easy *rbce ) {
   CURL *curl;
   VALUE url, _url = rb_easy_get("url");
   struct curl_slist **hdrs = &(rbce->curl_headers);
+  struct curl_slist **cmds = &(rbce->curl_ftp_commands);
 
   curl = rbce->curl;
 
@@ -1782,7 +1885,25 @@ VALUE ruby_curl_easy_setup( ruby_curl_easy *rbce ) {
     curl_easy_setopt(curl, CURLOPT_CAINFO, "/usr/local/share/curl/curl-ca-bundle.crt");
 #endif
   }
+
+#ifdef CURL_VERSION_SSL
+  if (rbce->ssl_version > 0) {
+    curl_easy_setopt(curl, CURLOPT_SSLVERSION, rbce->ssl_version);
+  }
+
+  if (rbce->use_ssl > 0) {
+    curl_easy_setopt(curl, CURB_FTPSSL, rbce->use_ssl);
+  }
+#else
+  if (rbce->ssl_version > 0 || rbce->use_ssl > 0) {
+    rb_warn("libcurl is not configured with SSL support");
+  }
+#endif
   
+  if (rbce->ftp_filemethod > 0) {
+    curl_easy_setopt(curl, CURLOPT_FTP_FILEMETHOD, rbce->ftp_filemethod);
+  }
+
   /* Set the user-agent string if specified */
   if (!rb_easy_nil("useragent")) {
     curl_easy_setopt(curl, CURLOPT_USERAGENT, rb_easy_get_str("useragent"));
@@ -1804,6 +1925,17 @@ VALUE ruby_curl_easy_setup( ruby_curl_easy *rbce ) {
     }
   }
 
+  /* Setup FTP commands if necessary */
+  if (!rb_easy_nil("ftp_commands")) {
+    if (rb_easy_type_check("ftp_commands", T_ARRAY)) {
+      rb_iterate(rb_each, rb_easy_get("ftp_commands"), cb_each_ftp_command, (VALUE)cmds);
+    }
+
+    if (*cmds) {
+      curl_easy_setopt(curl, CURLOPT_QUOTE, *cmds);
+    }
+  }
+
   return Qnil;
 }
 /***********************************************
@@ -1822,6 +1954,12 @@ VALUE ruby_curl_easy_cleanup( VALUE self, ruby_curl_easy *rbce ) {
     rbce->curl_headers = NULL;
   }
 
+  struct curl_slist *ftp_commands = rbce->curl_ftp_commands;
+  if (ftp_commands) {
+    curl_slist_free_all(ftp_commands);
+    rbce->curl_ftp_commands = NULL;
+  }
+
   // clean up a PUT request's curl options.
   if (!rb_easy_nil("upload")) {
     rb_easy_del("upload"); // set the upload object to Qnil to let the GC clean up
@@ -2192,6 +2330,28 @@ static VALUE ruby_curl_easy_response_code_get(VALUE self) {
   return LONG2NUM(code);
 }
 
+/*
+ * call-seq:
+ *   easy.primary_ip                                  => "xx.xx.xx.xx" or nil
+ *
+ *   Retrieve the resolved IP of the most recent connection
+ *   done with this curl handle. This string may be  IPv6 if
+ *   that's enabled.
+ */
+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;
+  }
+}
+
 /*
  * call-seq:
  *   easy.http_connect_code                           => fixnum
@@ -2356,7 +2516,7 @@ static VALUE ruby_curl_easy_redirect_time_get(VALUE self) {
 
 /*
  * call-seq:
- *   easy.redirect_count                           => integer
+ *   easy.redirect_count                            => integer
  *
  * Retrieve the total number of redirections that were actually followed.
  *
@@ -2604,7 +2764,7 @@ static VALUE ruby_curl_easy_os_errno_get(VALUE self) {
 
 /*
  * call-seq:
- *   easy.num_connects                                    => integer
+ *   easy.num_connects                                => integer
  *
  * Retrieve the number of new connections libcurl had to create to achieve
  * the previous transfer (only the successful connects are counted).
@@ -2649,7 +2809,7 @@ Pass a pointer to a long to receive the last socket used by this curl session. I
 
 /*
  * call-seq:
- *   easy.content_type                                => "content/type" or nil
+ *   easy.ftp_entry_path                                => "C:\ftp\root\" or nil
  *
  * 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
@@ -2678,7 +2838,7 @@ static VALUE ruby_curl_easy_ftp_entry_path_get(VALUE self) {
 
 /*
  * call-seq:
- *   easy.inspect                                => "#<Curl::Easy http://google.com/>"
+ *   easy.inspect                                     => "#<Curl::Easy http://google.com/>"
  */
 static VALUE ruby_curl_easy_inspect(VALUE self) {
   char buf[64];
@@ -2734,7 +2894,7 @@ static VALUE ruby_curl_easy_escape(VALUE self, VALUE svalue) {
 
 /*
  * call-seq:
- *   easy.unescape("some%20text")                       => "some text"
+ *   easy.unescape("some%20text")                     => "some text"
  *
  * 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
@@ -2805,7 +2965,7 @@ static VALUE ruby_curl_easy_class_perform_get(int argc, VALUE *argv, VALUE klass
 
 /*
  * call-seq:
- *   Curl::Easy.http_delete(url) { |easy| ... }          => #&lt;Curl::Easy...&gt;
+ *   Curl::Easy.http_delete(url) { |easy| ... }       => #&lt;Curl::Easy...&gt;
  *
  * Convenience method that creates a new Curl::Easy instance with
  * the specified URL and calls +http_delete+, before returning the new instance.
@@ -2822,7 +2982,7 @@ static VALUE ruby_curl_easy_class_perform_delete(int argc, VALUE *argv, VALUE kl
 
 /*
  * call-seq:
- *   Curl::Easy.http_head(url) { |easy| ... }          => #&lt;Curl::Easy...&gt;
+ *   Curl::Easy.http_head(url) { |easy| ... }         => #&lt;Curl::Easy...&gt;
  *
  * Convenience method that creates a new Curl::Easy instance with
  * the specified URL and calls +http_head+, before returning the new instance.
@@ -2928,6 +3088,8 @@ void init_curb_easy() {
   rb_define_method(cCurlEasy, "post_body=", ruby_curl_easy_post_body_set, 1);
   rb_define_method(cCurlEasy, "post_body", ruby_curl_easy_post_body_get, 0);
   rb_define_method(cCurlEasy, "put_data=", ruby_curl_easy_put_data_set, 1);
+  rb_define_method(cCurlEasy, "ftp_commands=", ruby_curl_easy_ftp_commands_set, 1);
+  rb_define_method(cCurlEasy, "ftp_commands", ruby_curl_easy_ftp_commands_get, 0);
 
   rb_define_method(cCurlEasy, "local_port=", ruby_curl_easy_local_port_set, 1);
   rb_define_method(cCurlEasy, "local_port", ruby_curl_easy_local_port_get, 0);
@@ -2951,6 +3113,12 @@ void init_curb_easy() {
   rb_define_method(cCurlEasy, "dns_cache_timeout", ruby_curl_easy_dns_cache_timeout_get, 0);
   rb_define_method(cCurlEasy, "ftp_response_timeout=", ruby_curl_easy_ftp_response_timeout_set, 1);
   rb_define_method(cCurlEasy, "ftp_response_timeout", ruby_curl_easy_ftp_response_timeout_get, 0);
+  rb_define_method(cCurlEasy, "ssl_version=", ruby_curl_easy_ssl_version_set, 1);
+  rb_define_method(cCurlEasy, "ssl_version", ruby_curl_easy_ssl_version_get, 0);
+  rb_define_method(cCurlEasy, "use_ssl=", ruby_curl_easy_use_ssl_set, 1);
+  rb_define_method(cCurlEasy, "use_ssl", ruby_curl_easy_use_ssl_get, 0);
+  rb_define_method(cCurlEasy, "ftp_filemethod=", ruby_curl_easy_ftp_filemethod_set, 1);
+  rb_define_method(cCurlEasy, "ftp_filemethod", ruby_curl_easy_ftp_filemethod_get, 0);
 
   rb_define_method(cCurlEasy, "username=", ruby_curl_easy_username_set, 1);
   rb_define_method(cCurlEasy, "username", ruby_curl_easy_username_get, 0);
@@ -3004,6 +3172,7 @@ void init_curb_easy() {
 
   rb_define_method(cCurlEasy, "last_effective_url", ruby_curl_easy_last_effective_url_get, 0);
   rb_define_method(cCurlEasy, "response_code", ruby_curl_easy_response_code_get, 0);
+  rb_define_method(cCurlEasy, "primary_ip", ruby_curl_easy_primary_ip_get, 0);
   rb_define_method(cCurlEasy, "http_connect_code", ruby_curl_easy_http_connect_code_get, 0);
   rb_define_method(cCurlEasy, "file_time", ruby_curl_easy_file_time_get, 0);
   rb_define_method(cCurlEasy, "total_time", ruby_curl_easy_total_time_get, 0);

data/ext/curb_easy.h

@@ -11,6 +11,24 @@
 
 #include <curl/easy.h>
 
+#ifdef CURL_VERSION_SSL
+#if LIBCURL_VERSION_NUM >= 0x070b00
+#  if LIBCURL_VERSION_NUM <= 0x071004
+#    define CURB_FTPSSL         CURLOPT_FTP_SSL
+#    define CURB_FTPSSL_ALL     CURLFTPSSL_ALL
+#    define CURB_FTPSSL_TRY     CURLFTPSSL_TRY
+#    define CURB_FTPSSL_CONTROL CURLFTPSSL_CONTROL
+#    define CURB_FTPSSL_NONE    CURLFTPSSL_NONE
+#  else
+#    define CURB_FTPSSL         CURLOPT_USE_SSL
+#    define CURB_FTPSSL_ALL     CURLUSESSL_ALL
+#    define CURB_FTPSSL_TRY     CURLUSESSL_TRY
+#    define CURB_FTPSSL_CONTROL CURLUSESSL_CONTROL
+#    define CURB_FTPSSL_NONE    CURLUSESSL_NONE
+#  endif
+#endif
+#endif
+
 /* a lot of this *could* be kept in the handler itself,
  * but then we lose the ability to query it's status.
  */
@@ -32,6 +50,9 @@ typedef struct {
   unsigned long connect_timeout;
   long dns_cache_timeout;
   unsigned long ftp_response_timeout;
+  long ssl_version;
+  long use_ssl;
+  long ftp_filemethod;
 
   /* bool flags */
   char proxy_tunnel;
@@ -46,6 +67,7 @@ typedef struct {
   char multipart_form_post;
   char enable_cookies;
   struct curl_slist *curl_headers;
+  struct curl_slist *curl_ftp_commands;
 
   int last_result; /* last result code from multi loop */
 

data/lib/curb.rb

@@ -142,6 +142,7 @@ module Curl
         m = Curl::Multi.new
         # configure the multi handle
         multi_options.each { |k,v| m.send("#{k}=", v) }
+        callbacks = [:on_progress,:on_debug,:on_failure,:on_success,:on_body,:on_header]
 
         urls_with_config.each do|conf|
           c = conf.dup # avoid being destructive to input
@@ -151,6 +152,12 @@ module Curl
 
           easy    = Curl::Easy.new(url)
 
+          # assign callbacks
+          callbacks.each do |cb|
+            cbproc = c.delete(cb)
+            easy.send(cb,&cbproc) if cbproc
+          end
+
           case method
           when :post
             fields = c.delete(:post_fields)
@@ -181,6 +188,64 @@ module Curl
         end
         m.perform
       end
+
+      # call-seq:
+      #
+      # Curl::Multi.download(['http://example.com/p/a/t/h/file1.txt','http://example.com/p/a/t/h/file2.txt'])
+      #
+      # will create 2 new files file1.txt and file2.txt
+      # 
+      # 2 files will be opened, and remain open until the call completes
+      #
+      # when using the :post or :put method, urls should be a hash, including the individual post fields per post
+      #
+      def download(urls,easy_options={},multi_options={},download_paths=nil,&blk)
+        procs = []
+        files = []
+        urls_with_config = []
+        url_to_download_paths = {}
+
+        urls.each_with_index do|urlcfg,i|
+          if urlcfg.is_a?(Hash)
+            url = url[:url]
+          else
+            url = urlcfg
+          end
+
+          if download_paths and download_paths[i]
+            download_path = download_paths[i]
+          else
+            download_path = File.basename(url)
+          end
+
+          lambda do|dp|
+            file = File.open(dp,"wb")
+            procs << (lambda {|data| file.write data; data.size })
+            files << file
+          end.call(download_path)
+
+          if urlcfg.is_a?(Hash)
+            urls_with_config << urlcfg.merge({:on_body => procs.last}.merge(easy_options))
+          else
+            urls_with_config << {:url => url, :on_body => procs.last, :method => :get}.merge(easy_options)
+          end
+          url_to_download_paths[url] = download_path # store for later
+        end
+
+        Curl::Multi.http(urls_with_config, multi_options) {|c,code,method| blk.call(c,url_to_download_paths[c.url]) }
+
+      ensure
+        errors = []
+        files.each {|f|
+          begin
+            f.close
+          rescue => e
+            errors << e
+          end
+        }
+        raise errors unless errors.empty?
+      end
+
     end
   end
 end

data/tests/tc_curl_multi.rb

@@ -308,6 +308,27 @@ class TestCurbCurlMulti < Test::Unit::TestCase
     end
   end
 
+  def test_multi_easy_download_01
+    # test collecting response buffers to file e.g. on_body
+    root_uri = 'http://127.0.0.1:9129/ext/'
+    urls = []
+    downloads = []
+    file_info = {}
+    FileUtils.mkdir("tmp/")
+    Dir[File.dirname(__FILE__) + "/../ext/*.c"].each do|path|
+      urls << (root_uri + File.basename(path))
+      downloads << "tmp/" + File.basename(path)
+      file_info[File.basename(path)] = {:size => File.size(path)}
+    end
+    Curl::Multi.download(urls,{},{},downloads) do|curl,download_path|
+      assert_equal 200, curl.response_code
+      assert File.exist?(download_path)
+      assert file_info[File.basename(download_path)][:size], File.size(download_path)
+    end
+  ensure
+    FileUtils.rm_rf("tmp/")
+  end
+
   def test_multi_easy_post_01
     urls = [
       { :url => TestServlet.url + '?q=1', :post_fields => {'field1' => 'value1', 'k' => 'j'}},

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 6
-  - 9
-  version: 0.6.9
+  - 7
+  - 0
+  version: 0.7.0
 platform: ruby
 authors: 
 - Ross Bamford
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-14 00:00:00 -04:00
+date: 2010-04-18 00:00:00 -04:00
 default_executable: 
 dependencies: []