patron 0.4.9 → 0.4.10

data/README.txt

@@ -17,6 +17,7 @@ requests:
     sess.timeout = 10
     sess.base_url = "http://myserver.com:9900"
     sess.headers['User-Agent'] = 'myapp/1.0'
+    sess.enable_debug "/tmp/patron.debug"
 
 The Session is used to make HTTP requests.
 

data/VERSION.yml

@@ -1,5 +1,5 @@
 --- 
 :major: 0
 :minor: 4
-:patch: 9
+:patch: 10
 :build: 

data/ext/patron/extconf.rb

@@ -23,7 +23,7 @@
 ## -------------------------------------------------------------------
 
 if RUBY_PLATFORM =~ /darwin10\.0/
-  ENV['ARCHFLAGS'] = '-arch x86_64'
+  ENV['ARCHFLAGS'] = '-force_cpusubtype_ALL -mmacosx-version-min=10.4 -arch i386 -arch ppc -arch x86_64'
 end
 
 require 'mkmf'

data/ext/patron/session_ext.c

@@ -26,6 +26,7 @@
 #include <curl/curl.h>
 
 static VALUE mPatron = Qnil;
+static VALUE mProxyType = Qnil;
 static VALUE cSession = Qnil;
 static VALUE cRequest = Qnil;
 static VALUE ePatronError = Qnil;
@@ -43,11 +44,13 @@ struct curl_state {
   char* upload_buf;
   FILE* download_file;
   FILE* upload_file;
+  FILE* debug_file;
   char error_buf[CURL_ERROR_SIZE];
   struct curl_slist* headers;
+  struct curl_httppost* post;
+  struct curl_httppost* last;
 };
 
-
 //------------------------------------------------------------------------------
 // Curl Callbacks
 //
@@ -78,6 +81,12 @@ static size_t session_read_handler(char* stream, size_t size, size_t nmemb, char
 // Cleans up the Curl handle when the Session object is garbage collected.
 void session_free(struct curl_state *curl) {
   curl_easy_cleanup(curl->handle);
+
+  if (curl->debug_file) {
+    fclose(curl->debug_file);
+    curl->debug_file = NULL;
+  }
+
   free(curl);
 }
 
@@ -106,6 +115,8 @@ VALUE session_ext_initialize(VALUE self) {
   Data_Get_Struct(self, struct curl_state, state);
 
   state->handle = curl_easy_init();
+  state->post   = NULL;
+  state->last   = NULL;
 
   return self;
 }
@@ -159,6 +170,31 @@ static int each_http_header(VALUE header_key, VALUE header_value, VALUE self) {
   return 0;
 }
 
+static int formadd_values(VALUE data_key, VALUE data_value, VALUE self) {
+  struct curl_state *state;
+  Data_Get_Struct(self, struct curl_state, state);
+
+  VALUE name = rb_obj_as_string(data_key);
+  VALUE value = rb_obj_as_string(data_value);
+
+  curl_formadd(&state->post, &state->last, CURLFORM_PTRNAME, RSTRING_PTR(name),
+                CURLFORM_PTRCONTENTS, RSTRING_PTR(value), CURLFORM_END);  
+  return 0;
+}
+
+static int formadd_files(VALUE data_key, VALUE data_value, VALUE self) {
+  struct curl_state *state;
+  Data_Get_Struct(self, struct curl_state, state);
+
+  VALUE name = rb_obj_as_string(data_key);
+  VALUE value = rb_obj_as_string(data_value);
+
+  curl_formadd(&state->post, &state->last, CURLFORM_PTRNAME, RSTRING_PTR(name),
+                CURLFORM_FILE, RSTRING_PTR(value), CURLFORM_END); 
+                
+  return 0;
+}
+
 static void set_chunked_encoding(struct curl_state *state) {
   state->headers = curl_slist_append(state->headers, "Transfer-Encoding: chunked");
 }
@@ -189,7 +225,6 @@ static void set_options_from_request(VALUE self, VALUE request) {
 
     rb_hash_foreach(headers, each_http_header, self);
   }
-
   ID action = SYM2ID(rb_iv_get(request, "@action"));
   if (action == rb_intern("get")) {
     curl_easy_setopt(curl, CURLOPT_HTTPGET, 1);
@@ -204,8 +239,9 @@ static void set_options_from_request(VALUE self, VALUE request) {
   } else if (action == rb_intern("post") || action == rb_intern("put")) {
     VALUE data = rb_iv_get(request, "@upload_data");
     VALUE filename = rb_iv_get(request, "@file_name");
+    VALUE multipart = rb_iv_get(request, "@multipart");
 
-    if (!NIL_P(data)) {
+    if (!NIL_P(data) && NIL_P(multipart)) {
       state->upload_buf = StringValuePtr(data);
       int len = RSTRING_LEN(data);
 
@@ -219,7 +255,7 @@ static void set_options_from_request(VALUE self, VALUE request) {
         curl_easy_setopt(curl, CURLOPT_READDATA, &state->upload_buf);
         curl_easy_setopt(curl, CURLOPT_INFILESIZE, len);
       }
-    } else if (!NIL_P(filename)) {
+    } else if (!NIL_P(filename) && NIL_P(multipart)) {
       set_chunked_encoding(state);
 
       curl_easy_setopt(curl, CURLOPT_UPLOAD, 1);
@@ -230,6 +266,20 @@ static void set_options_from_request(VALUE self, VALUE request) {
 
       state->upload_file = open_file(filename, "r");
       curl_easy_setopt(curl, CURLOPT_READDATA, state->upload_file);
+    } else if (!NIL_P(multipart)) {
+      if (action == rb_intern("post")) {
+        if(!NIL_P(data) && !NIL_P(filename)) {
+          if (rb_type(data) == T_HASH && rb_type(filename) == T_HASH) {
+            rb_hash_foreach(data, formadd_values, self);
+            rb_hash_foreach(filename, formadd_files, self);
+        } else {   rb_raise(rb_eArgError, "Data and Filename must be passed in a hash.");}
+        }
+        curl_easy_setopt(curl, CURLOPT_HTTPPOST, state->post);
+        
+      } else {
+         rb_raise(rb_eArgError, "Multipart PUT not supported");
+      }
+    
     } else {
       rb_raise(rb_eArgError, "Must provide either data or a filename when doing a PUT or POST");
     }
@@ -271,6 +321,11 @@ static void set_options_from_request(VALUE self, VALUE request) {
       curl_easy_setopt(curl, CURLOPT_PROXY, StringValuePtr(proxy));
   }
 
+  VALUE proxy_type = rb_iv_get(request, "@proxy_type");
+  if (!NIL_P(proxy_type)) {
+    curl_easy_setopt(curl, CURLOPT_PROXYTYPE, FIX2INT(proxy_type));
+  }
+
   VALUE credentials = rb_funcall(request, rb_intern("credentials"), 0);
   if (!NIL_P(credentials)) {
     curl_easy_setopt(curl, CURLOPT_HTTPAUTH, FIX2INT(rb_iv_get(request, "@auth_type")));
@@ -282,6 +337,16 @@ static void set_options_from_request(VALUE self, VALUE request) {
     curl_easy_setopt(curl, CURLOPT_SSL_VERIFYPEER, 0);
     curl_easy_setopt(curl, CURLOPT_SSL_VERIFYHOST, 1);
   }
+
+  VALUE buffer_size = rb_iv_get(request, "@buffer_size");
+  if (!NIL_P(buffer_size)) {
+     curl_easy_setopt(curl, CURLOPT_BUFFERSIZE, FIX2INT(buffer_size));
+  }
+
+  if(state->debug_file) {
+    curl_easy_setopt(curl, CURLOPT_VERBOSE, 1);
+    curl_easy_setopt(curl, CURLOPT_STDERR, state->debug_file);
+  }
 }
 
 // Use the info in a Curl handle to create a new Response object.
@@ -405,6 +470,25 @@ VALUE enable_cookie_session(VALUE self, VALUE file) {
   return Qnil;
 }
 
+VALUE set_debug_file(VALUE self, VALUE file) {
+  struct curl_state *state;
+  Data_Get_Struct(self, struct curl_state, state);
+  char* file_path = RSTRING_PTR(file);
+
+  if(state->debug_file){
+    fclose(state->debug_file);
+    state->debug_file = NULL;
+  }
+
+  if(file_path != NULL && strlen(file_path) != 0) {
+    state->debug_file = open_file(file, "w");
+  } else {
+    state->debug_file = stderr;
+  }
+
+  return Qnil;
+}
+
 //------------------------------------------------------------------------------
 // Extension initialization
 //
@@ -436,8 +520,18 @@ void Init_session_ext() {
   rb_define_method(cSession, "unescape",       session_unescape,       1);
   rb_define_method(cSession, "handle_request", session_handle_request, 1);
   rb_define_method(cSession, "enable_cookie_session", enable_cookie_session, 1);
+  rb_define_method(cSession, "set_debug_file", set_debug_file, 1);
 
   rb_define_const(cRequest, "AuthBasic",  INT2FIX(CURLAUTH_BASIC));
   rb_define_const(cRequest, "AuthDigest", INT2FIX(CURLAUTH_DIGEST));
   rb_define_const(cRequest, "AuthAny",    INT2FIX(CURLAUTH_ANY));
+
+  mProxyType = rb_define_module_under(mPatron, "ProxyType");
+  rb_define_const(mProxyType, "HTTP", INT2FIX(CURLPROXY_HTTP));
+  rb_define_const(mProxyType, "HTTP_1_0", INT2FIX(CURLPROXY_HTTP_1_0));
+  rb_define_const(mProxyType, "SOCKS4", INT2FIX(CURLPROXY_SOCKS4));
+  rb_define_const(mProxyType, "SOCKS5", INT2FIX(CURLPROXY_SOCKS5));
+  rb_define_const(mProxyType, "SOCKS4A", INT2FIX(CURLPROXY_SOCKS4A));
+  rb_define_const(mProxyType, "SOCKS5_HOSTNAME", INT2FIX(CURLPROXY_SOCKS5_HOSTNAME));
 }
+

data/lib/patron/proxy_type.rb

@@ -0,0 +1,10 @@
+module Patron
+  module ProxyType
+    HTTP
+    HTTP_1_0
+    SOCKS4
+    SOCKS5
+    SOCKS4A
+    SOCKS5_HOSTNAME
+  end
+end

data/lib/patron/request.rb

@@ -40,8 +40,8 @@ module Patron
       @max_redirects = -1
     end
 
-    attr_accessor :url, :username, :password, :file_name, :proxy, :auth_type, :insecure
-    attr_reader :action, :timeout, :connect_timeout, :max_redirects, :headers
+    attr_accessor :url, :username, :password, :file_name, :proxy, :proxy_type, :auth_type, :insecure, :multipart
+    attr_reader :action, :timeout, :connect_timeout, :max_redirects, :headers, :buffer_size
     attr_reader :auth_type
 
     # Set the type of authentication to use for this request.
@@ -69,7 +69,7 @@ module Patron
     def upload_data=(data)
       @upload_data = case data
       when Hash
-        hash_to_string(data)
+        self.multipart ? data : hash_to_string(data)
       else
         data
       end
@@ -119,6 +119,14 @@ module Patron
       @headers = new_headers
     end
 
+    def buffer_size=(buffer_size)
+      if buffer_size != nil && buffer_size.to_i < 1
+        raise ArgumentError, "Buffer size must be a positive integer greater than 0 or nil"
+      end
+
+      @buffer_size = buffer_size != nil ? buffer_size.to_i : nil
+    end
+
     def action_name
       @action.to_s.upcase
     end

data/lib/patron/session.rb

@@ -50,9 +50,12 @@ module Patron
     # Username and password for http authentication
     attr_accessor :username, :password
 
-    # HTTP proxy URL
+    # Proxy URL in cURL format ('hostname:8080')
     attr_accessor :proxy
 
+    # Proxy type (default is HTTP), see constants under ProxyType for supported types.
+    attr_accessor :proxy_type
+
     # Standard set of headers that are used in all requests.
     attr_reader :headers
 
@@ -63,7 +66,11 @@ module Patron
     # Does this session stricly verify SSL certificates?
     attr_accessor :insecure
 
-    private :ext_initialize, :handle_request, :enable_cookie_session
+    # Set the buffer size for this request. This option will
+    # only be set if buffer_size is non-nil
+    attr_accessor :buffer_size
+
+    private :ext_initialize, :handle_request, :enable_cookie_session, :set_debug_file
 
     # Create a new Session object.
     def initialize
@@ -75,9 +82,9 @@ module Patron
       @auth_type = :basic
     end
 
-    # Makes this session handle cookies and store them in in +file+.
-    # If file is nil they will be stored in memory. Otherwise the +file+
-    # must be readable and writable. Calling multiple times will add more files.
+    # 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.
     def handle_cookies(file = nil)
       if file
         path = Pathname(file).expand_path
@@ -85,13 +92,18 @@ module Patron
           raise ArgumentError, "Can't create file #{path} (permission error)"
         end
         unless File.readable?(file) or File.writable?(path)
-          raise ArgumentError, "Cant read or write file #{path} (permission error)"
+          raise ArgumentError, "Can't read or write file #{path} (permission error)"
         end
       end
       enable_cookie_session(path.to_s)
       self
     end
 
+    # Enable debug output to stderr or to specified +file+.
+    def enable_debug(file = nil)
+      set_debug_file(file.to_s)
+    end
+
     ###################################################################
     ### Standard HTTP methods
     ###
@@ -143,6 +155,11 @@ module Patron
       request(:post, url, headers, :file => filename)
     end
 
+    # Uploads the contents of a file and data to the specified +url+ using HTTP POST.
+    def post_multipart(url, data, filename, headers = {})
+      request(:post, url, headers, {:data => data, :file => filename, :multipart => true})
+    end
+
     ###################################################################
     ### WebDAV methods
     ###
@@ -170,11 +187,14 @@ module Patron
       req.headers = self.headers.merge(headers)
       req.username = self.username
       req.password = self.password
+      req.multipart = options[:multipart]
       req.upload_data = options[:data]
       req.file_name = options[:file]
       req.proxy = proxy
+      req.proxy_type = proxy_type
       req.auth_type = auth_type
       req.insecure = insecure
+      req.buffer_size = buffer_size
 
       req.url = self.base_url.to_s + url.to_s
       raise ArgumentError, "Empty URL" if req.url.empty?

data/spec/patron_spec.rb

@@ -21,7 +21,7 @@
 ## THE SOFTWARE.
 ##
 ## -------------------------------------------------------------------
-require File.dirname(__FILE__) + '/spec_helper.rb'
+require File.expand_path("./spec") + '/spec_helper.rb'
 
 describe Patron do
 

data/spec/request_spec.rb

@@ -21,7 +21,7 @@
 ## THE SOFTWARE.
 ##
 ## -------------------------------------------------------------------
-require File.dirname(__FILE__) + '/spec_helper.rb'
+require File.expand_path("./spec") + '/spec_helper.rb'
 
 
 describe Patron::Request do
@@ -72,4 +72,15 @@ describe Patron::Request do
 
   end
 
+  describe :buffer_size do
+
+    it "should raise an exception when assigned a negative number" do
+      lambda {@request.buffer_size = -1}.should raise_error(ArgumentError)
+    end
+
+    it "should raise an exception when assigned 0" do
+      lambda {@request.buffer_size = 0}.should raise_error(ArgumentError)
+    end
+
+  end
 end

data/spec/response_spec.rb

@@ -21,7 +21,7 @@
 ## THE SOFTWARE.
 ##
 ## -------------------------------------------------------------------
-require File.dirname(__FILE__) + '/spec_helper.rb'
+require File.expand_path("./spec") + '/spec_helper.rb'
 require 'webrick'
 require 'base64'
 require 'fileutils'

data/spec/session_spec.rb

@@ -21,7 +21,7 @@
 ## THE SOFTWARE.
 ##
 ## -------------------------------------------------------------------
-require File.dirname(__FILE__) + '/spec_helper.rb'
+require File.expand_path("./spec") + '/spec_helper.rb'
 require 'webrick'
 require 'base64'
 require 'fileutils'
@@ -174,6 +174,12 @@ describe Patron::Session do
     body = YAML::load(response.body)
     body.request_method.should == "POST"
   end
+  
+  it "should upload a multipart with :post" do
+    response = @session.post_multipart("/test", { :test_data => "123" }, { :test_file => "VERSION.yml" } )
+    body = YAML::load(response.body)
+    body.request_method.should == "POST"    
+  end
 
   it "should raise when no file is provided to :post" do
     lambda { @session.post_file("/test", nil) }.should raise_error(ArgumentError)
@@ -220,6 +226,24 @@ describe Patron::Session do
     threads.each {|t| t.join }
   end
 
+  it "should limit the buffer_size" do
+    # Buffer size is tricky to test, as it only affects the buffer size for each 
+    # read and it's not really visible at this, higher level. It's also only a 
+    # suggestion rather than a command so it may not even take affect. Currently 
+    # we just test that the response completes without any issues, it would be nice 
+    # to have a more robust test here.
+    @session.buffer_size = 1
+
+    body = nil
+
+    lambda {
+      response = @session.get("/test")
+      body = YAML::load(response.body)
+    }.should_not raise_error
+
+    body.request_method.should == "GET"
+  end
+
   def encode_authz(user, passwd)
     "Basic " + Base64.encode64("#{user}:#{passwd}").strip
   end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: patron
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: false
   segments: 
   - 0
   - 4
-  - 9
-  version: 0.4.9
+  - 10
+  version: 0.4.10
 platform: ruby
 authors: 
 - Phillip Toland
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-14 00:00:00 -05:00
+date: 2010-11-06 00:00:00 -05:00
 default_executable: 
 dependencies: []
 
@@ -37,6 +37,7 @@ files:
 - ext/patron/session_ext.c
 - lib/patron.rb
 - lib/patron/error.rb
+- lib/patron/proxy_type.rb
 - lib/patron/request.rb
 - lib/patron/response.rb
 - lib/patron/session.rb