patron 0.3.2 → 0.4.0

data/Rakefile

@@ -26,6 +26,7 @@ require 'rake/clean'
 require 'rake/rdoctask'
 require 'spec/rake/spectask'
 require 'jeweler'
+require 'yard'
 
 require 'rbconfig'
 include Config
@@ -101,6 +102,11 @@ Rake::RDocTask.new do |rdoc|
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
+YARD::Rake::YardocTask.new do |t|
+  t.files   = ['lib/**/*.rb']
+  t.options = ['--readme', 'README.txt']
+end
+
 desc "Run specs"
 Spec::Rake::SpecTask.new(:spec) do |t|
   t.spec_opts = ['--options', "spec/spec.opts"]
@@ -137,7 +143,7 @@ begin
 
         host = "#{config['username']}@rubyforge.org"
         remote_dir = "/var/www/gforge-projects/patron/"
-        local_dir = 'rdoc'
+        local_dir = 'doc'
 
         Rake::SshDirPublisher.new(host, remote_dir, local_dir).upload
       end

data/ext/patron/session_ext.c

@@ -40,6 +40,8 @@ static VALUE eTooManyRedirects = Qnil;
 struct curl_state {
   CURL* handle;
   char* upload_buf;
+  FILE* download_file;
+  FILE* upload_file;
   char error_buf[CURL_ERROR_SIZE];
   struct curl_slist* headers;
 };
@@ -156,43 +158,86 @@ static VALUE each_http_header(VALUE header, VALUE self) {
   return Qnil;
 }
 
+static void set_chunked_encoding(struct curl_state *state) {
+  state->headers = curl_slist_append(state->headers, "Transfer-Encoding: chunked");
+}
+
+static FILE* open_file(VALUE filename, char* perms) {
+  FILE* handle = fopen(StringValuePtr(filename), perms);
+  if (!handle) {
+    rb_raise(rb_eArgError, "Unable to open specified file.");
+  }
+
+  return handle;
+}
+
 // Set the options on the Curl handle from a Request object. Takes each field
 // in the Request object and uses it to set the appropriate option on the Curl
 // handle.
-void set_options_from_request(VALUE self, VALUE request) {
+static void set_options_from_request(VALUE self, VALUE request) {
   struct curl_state *state;
   Data_Get_Struct(self, struct curl_state, state);
 
   CURL* curl = state->handle;
 
+  VALUE headers = rb_iv_get(request, "@headers");
+  if (!NIL_P(headers)) {
+    if (rb_type(headers) != T_HASH) {
+      rb_raise(rb_eArgError, "Headers must be passed in a hash.");
+    }
+
+    rb_iterate(rb_each, 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);
-  } else if (action == rb_intern("post")) {
-    VALUE data = rb_iv_get(request, "@upload_data");
-
-    state->upload_buf = StringValuePtr(data);
-    int len = RSTRING_LEN(data);
 
-    curl_easy_setopt(curl, CURLOPT_POST, 1);
-    curl_easy_setopt(curl, CURLOPT_POSTFIELDS, state->upload_buf);
-    curl_easy_setopt(curl, CURLOPT_POSTFIELDSIZE, len);
-  } else if (action == rb_intern("put")) {
+    VALUE download_file = rb_iv_get(request, "@file_name");
+    if (!NIL_P(download_file)) {
+      state->download_file = open_file(download_file, "w");
+      curl_easy_setopt(curl, CURLOPT_WRITEDATA, state->download_file);
+    } else {
+      state->download_file = NULL;
+    }
+  } else if (action == rb_intern("post") || action == rb_intern("put")) {
     VALUE data = rb_iv_get(request, "@upload_data");
-
-    state->upload_buf = StringValuePtr(data);
-    int len = RSTRING_LEN(data);
-
-    curl_easy_setopt(curl, CURLOPT_UPLOAD, 1);
-    curl_easy_setopt(curl, CURLOPT_READFUNCTION, &session_read_handler);
-    curl_easy_setopt(curl, CURLOPT_READDATA, &state->upload_buf);
-    curl_easy_setopt(curl, CURLOPT_INFILESIZE, len);
-  } else if (action == rb_intern("delete")) {
-    curl_easy_setopt(curl, CURLOPT_CUSTOMREQUEST, "DELETE");
+    VALUE filename = rb_iv_get(request, "@file_name");
+
+    if (!NIL_P(data)) {
+      state->upload_buf = StringValuePtr(data);
+      int len = RSTRING_LEN(data);
+
+      if (action == rb_intern("post")) {
+        curl_easy_setopt(curl, CURLOPT_POST, 1);
+        curl_easy_setopt(curl, CURLOPT_POSTFIELDS, state->upload_buf);
+        curl_easy_setopt(curl, CURLOPT_POSTFIELDSIZE, len);
+      } else {
+        curl_easy_setopt(curl, CURLOPT_UPLOAD, 1);
+        curl_easy_setopt(curl, CURLOPT_READFUNCTION, &session_read_handler);
+        curl_easy_setopt(curl, CURLOPT_READDATA, &state->upload_buf);
+        curl_easy_setopt(curl, CURLOPT_INFILESIZE, len);
+      }
+    } else if (!NIL_P(filename)) {
+      set_chunked_encoding(state);
+
+      curl_easy_setopt(curl, CURLOPT_UPLOAD, 1);
+
+      if (action == rb_intern("post")) {
+        curl_easy_setopt(curl, CURLOPT_CUSTOMREQUEST, "POST");
+      }
+
+      state->upload_file = open_file(filename, "r");
+      curl_easy_setopt(curl, CURLOPT_READDATA, state->upload_file);
+    }
   } else if (action == rb_intern("head")) {
     curl_easy_setopt(curl, CURLOPT_NOBODY, 1);
+  } else {
+    VALUE action_name = rb_funcall(request, rb_intern("action_name"), 0);
+    curl_easy_setopt(curl, CURLOPT_CUSTOMREQUEST, StringValuePtr(action_name));
   }
 
+  curl_easy_setopt(curl, CURLOPT_HTTPHEADER, state->headers);
   curl_easy_setopt(curl, CURLOPT_ERRORBUFFER, state->error_buf);
 
   VALUE url = rb_iv_get(request, "@url");
@@ -218,17 +263,11 @@ void set_options_from_request(VALUE self, VALUE request) {
     curl_easy_setopt(curl, CURLOPT_MAXREDIRS, r);
   }
 
-  VALUE headers = rb_iv_get(request, "@headers");
-  if (!NIL_P(headers)) {
-    if (rb_type(headers) != T_HASH) {
-      rb_raise(rb_eArgError, "Headers must be passed in a hash.");
-    }
-
-    rb_iterate(rb_each, headers, each_http_header, self);
+  VALUE proxy = rb_iv_get(request, "@proxy");
+  if (!NIL_P(proxy)) {
+      curl_easy_setopt(curl, CURLOPT_PROXY, StringValuePtr(proxy));
   }
 
-  curl_easy_setopt(curl, CURLOPT_HTTPHEADER, state->headers);
-
   VALUE credentials = rb_funcall(request, rb_intern("credentials"), 0);
   if (!NIL_P(credentials)) {
     curl_easy_setopt(curl, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
@@ -237,7 +276,7 @@ void set_options_from_request(VALUE self, VALUE request) {
 }
 
 // Use the info in a Curl handle to create a new Response object.
-VALUE create_response(CURL* curl) {
+static VALUE create_response(CURL* curl) {
   VALUE response = rb_class_new_instance(0, 0,
                       rb_const_get(mPatron, rb_intern("Response")));
 
@@ -257,7 +296,7 @@ VALUE create_response(CURL* curl) {
 }
 
 // Raise an exception based on the Curl error code.
-VALUE select_error(CURLcode code) {
+static VALUE select_error(CURLcode code) {
   VALUE error = Qnil;
   switch (code) {
     case CURLE_UNSUPPORTED_PROTOCOL:  error = eUnsupportedProtocol; break;
@@ -287,14 +326,19 @@ static VALUE perform_request(VALUE self) {
   curl_easy_setopt(curl, CURLOPT_HEADERDATA, header_buffer);
 
   // body
-  VALUE body_buffer = rb_str_buf_new(32768);
-  curl_easy_setopt(curl, CURLOPT_WRITEFUNCTION, &session_write_handler);
-  curl_easy_setopt(curl, CURLOPT_WRITEDATA, body_buffer);
+  VALUE body_buffer = Qnil;
+  if (!state->download_file) {
+    body_buffer = rb_str_buf_new(32768);
+    curl_easy_setopt(curl, CURLOPT_WRITEFUNCTION, &session_write_handler);
+    curl_easy_setopt(curl, CURLOPT_WRITEDATA, body_buffer);
+  }
 
   CURLcode ret = curl_easy_perform(curl);
   if (CURLE_OK == ret) {
     VALUE response = create_response(curl);
-    rb_iv_set(response, "@body", body_buffer);
+    if (!NIL_P(body_buffer)) {
+      rb_iv_set(response, "@body", body_buffer);
+    }
     rb_funcall(response, rb_intern("parse_headers"), 1, header_buffer);
     return response;
   } else {
@@ -315,6 +359,16 @@ static VALUE cleanup(VALUE self) {
     state->headers = NULL;
   }
 
+  if (state->download_file) {
+    fclose(state->download_file);
+    state->download_file = NULL;
+  }
+
+  if (state->upload_file) {
+    fclose(state->upload_file);
+    state->upload_file = NULL;
+  }
+
   state->upload_buf = NULL;
 
   return Qnil;
@@ -330,7 +384,7 @@ VALUE session_handle_request(VALUE self, VALUE request) {
 //
 
 void Init_session_ext() {
-  curl_global_init(CURL_GLOBAL_NOTHING);
+  curl_global_init(CURL_GLOBAL_ALL);
   rb_require("patron/error");
 
   mPatron = rb_define_module("Patron");

data/lib/patron.rb

@@ -34,9 +34,10 @@ module Patron #:nodoc:
   # Returns the version number of the Patron library as a string
   def self.version
     cwd = Pathname(__FILE__).dirname
-    yaml = YAML.load_file(cwd.expand_path / '../VERSION.yml')
+    yaml = YAML.load_file(cwd.expand_path + '../VERSION.yml')
     major = (yaml['major'] || yaml[:major]).to_i
     minor = (yaml['minor'] || yaml[:minor]).to_i
-    "#{major}.#{minor}"
+    patch = (yaml['patch'] || yaml[:patch]).to_i
+    "#{major}.#{minor}.#{patch}"
   end
 end

data/lib/patron/request.rb

@@ -30,6 +30,8 @@ module Patron
   # used in every request.
   class Request
 
+    VALID_ACTIONS = [:get, :put, :post, :delete, :head, :copy]
+
     def initialize
       @action = :get
       @headers = {}
@@ -38,12 +40,12 @@ module Patron
       @max_redirects = -1
     end
 
-    attr_accessor :url, :username, :password, :upload_data
+    attr_accessor :url, :username, :password, :upload_data, :file_name, :proxy
     attr_reader :action, :timeout, :connect_timeout, :max_redirects, :headers
 
     def action=(new_action)
-      if ![:get, :put, :post, :delete, :head].include?(new_action)
-        raise ArgumentError, "Action must be one of :get, :put, :post, :delete or :head"
+      if !VALID_ACTIONS.include?(new_action)
+        raise ArgumentError, "Action must be one of #{VALID_ACTIONS.join(', ')}"
       end
 
       @action = new_action
@@ -81,6 +83,10 @@ module Patron
       @headers = new_headers
     end
 
+    def action_name
+      @action.to_s.upcase
+    end
+
     def credentials
       return nil if username.nil? || password.nil?
       "#{username}:#{password}"

data/lib/patron/response.rb

@@ -48,6 +48,7 @@ module Patron
           @status_line = header.strip
         else
           parts = header.split(':', 2)
+          parts[1].strip! unless parts[1].nil?
           @headers[parts[0]] = parts[1]
         end
       end

data/lib/patron/session.rb

@@ -50,12 +50,15 @@ module Patron
     # Username and password for http authentication
     attr_accessor :username, :password
 
+    # HTTP proxy URL
+    attr_accessor :proxy
+
     # Standard set of headers that are used in all requests.
     attr_reader :headers
 
     private :ext_initialize, :handle_request
 
-    # Create an instance of the Session class.
+    # Create a new Session object.
     def initialize
       ext_initialize
       @headers = {}
@@ -64,36 +67,73 @@ module Patron
       @max_redirects = -1
     end
 
+    ###################################################################
+    ### Standard HTTP methods
+    ###
+
     # 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.
     def get(url, headers = {})
-      do_request(:get, url, headers)
+      request(:get, url, headers)
+    end
+
+    # Retrieve the contents of the specified +url+ as with #get, but the
+    # content at the URL is downloaded directly into the specified file.
+    def get_file(url, filename, headers = {})
+      request(:get, url, headers, :file => filename)
     end
 
     # As #get but sends an HTTP HEAD request.
     def head(url, headers = {})
-      do_request(:head, url, headers)
+      request(:head, url, headers)
     end
 
+    # As #get but sends an HTTP DELETE request.
     def delete(url, headers = {})
-      do_request(:delete, url, headers)
+      request(:delete, url, headers)
     end
 
+    # Uploads the passed +data+ to the specified +url+ using HTTP PUT. +data+
+    # must be a string.
     def put(url, data, headers = {})
-      do_request(:put, url, headers, data)
+      request(:put, url, headers, :data => data)
+    end
+
+    # Uploads the contents of a file to the specified +url+ using HTTP PUT.
+    def put_file(url, filename, headers = {})
+      request(:put, url, headers, :file => filename)
     end
 
+    # Uploads the passed +data+ to the specified +url+ using HTTP POST. +data+
+    # must be a string.
     def post(url, data, headers = {})
-      do_request(:post, url, headers, data)
+      request(:post, url, headers, :data => data)
+    end
+
+    # Uploads the contents of a file to the specified +url+ using HTTP POST.
+    def post_file(url, filename, headers = {})
+      request(:post, url, headers, :file => filename)
+    end
+
+    ###################################################################
+    ### WebDAV methods
+    ###
+
+    # Sends a WebDAV COPY request to the specified +url+.
+    def copy(url, dest, headers = {})
+      headers['Destination'] = dest
+      request(:copy, url, headers)
     end
 
-  private
+    ###################################################################
+    ### Basic API methods
+    ###
 
-    # Creates a new Request object from the parameters and instance variables.
-    def do_request(action, url, headers, data = nil)
+    # Send an HTTP request to the specified +url+.
+    def request(action, url, headers, options = {})
       req = Request.new
       req.action = action
       req.timeout = self.timeout
@@ -102,7 +142,9 @@ module Patron
       req.headers = self.headers.merge(headers)
       req.username = self.username
       req.password = self.password
-      req.upload_data = data
+      req.upload_data = options[:data]
+      req.file_name = options[:file]
+      req.proxy = proxy
 
       req.url = self.base_url.to_s + url.to_s
       raise ArgumentError, "Empty URL" if req.url.empty?

data/spec/request_spec.rb

@@ -33,7 +33,7 @@ describe Patron::Request do
   describe :action do
 
     it "should accept :get, :put, :post, :delete and :head" do
-      [:get, :put, :post, :delete, :head].each do |action|
+      [:get, :put, :post, :delete, :head, :copy].each do |action|
         lambda {@request.action = action}.should_not raise_error
       end
     end
@@ -51,7 +51,7 @@ describe Patron::Request do
     end
 
     it "should raise an exception when assigned 0" do
-      lambda {@request.timeout = -1}.should raise_error(ArgumentError)
+      lambda {@request.timeout = 0}.should raise_error(ArgumentError)
     end
 
   end

data/spec/response_spec.rb

@@ -0,0 +1,40 @@
+## -------------------------------------------------------------------
+##
+## Copyright (c) 2009 Phillip Toland <phil.toland@gmail.com>
+##
+## Permission is hereby granted, free of charge, to any person obtaining a copy
+## of this software and associated documentation files (the "Software"), to deal
+## in the Software without restriction, including without limitation the rights
+## to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+## copies of the Software, and to permit persons to whom the Software is
+## furnished to do so, subject to the following conditions:
+##
+## The above copyright notice and this permission notice shall be included in
+## all copies or substantial portions of the Software.
+##
+## THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+## IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+## FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+## AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+## LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+## OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+## THE SOFTWARE.
+##
+## -------------------------------------------------------------------
+require File.dirname(__FILE__) + '/spec_helper.rb'
+require 'webrick'
+require 'base64'
+require 'fileutils'
+
+describe Patron::Response do
+  before(:each) do
+    @session = Patron::Session.new
+    @session.base_url = "http://localhost:9001"
+  end
+
+  it "should strip extra spaces from header values" do
+    response = @session.get("/test")
+    # All digits, no spaces
+    response.headers['Content-Length'].should match(/^\d+$/)
+  end
+end

data/spec/session_spec.rb

@@ -24,6 +24,7 @@
 require File.dirname(__FILE__) + '/spec_helper.rb'
 require 'webrick'
 require 'base64'
+require 'fileutils'
 
 describe Patron::Session do
 
@@ -39,6 +40,10 @@ describe Patron::Session do
     unescaped.should == string
   end
 
+  it "should raise an error when passed an invalid action" do
+    lambda { @session.request(:bogus, "/test", {}) }.should raise_error(ArgumentError)
+  end
+
   it "should raise an error when no URL is provided" do
     @session.base_url = nil
     lambda {@session.get(nil)}.should raise_error(ArgumentError)
@@ -50,6 +55,15 @@ describe Patron::Session do
     body.request_method.should == "GET"
   end
 
+  it "should download content with :get and a file path" do
+    tmpfile = "/tmp/patron_test.yaml"
+    response = @session.get_file "/test", tmpfile
+    response.body.should be_nil
+    body = YAML::load_file(tmpfile)
+    body.request_method.should == "GET"
+    FileUtils.rm tmpfile
+  end
+
   it "should include custom headers in a request" do
     response = @session.get("/test", {"User-Agent" => "PatronTest"})
     body = YAML::load(response.body)
@@ -103,6 +117,18 @@ describe Patron::Session do
     body.request_method.should == "DELETE"
   end
 
+  it "should send a COPY request with :copy" do
+    response = @session.copy("/test", "/test2")
+    body = YAML::load(response.body)
+    body.request_method.should == "COPY"
+  end
+
+  it "should include a Destination header in COPY requests" do
+    response = @session.copy("/test", "/test2")
+    body = YAML::load(response.body)
+    body.header['destination'].first.should == "/test2"
+  end
+
   it "should upload data with :put" do
     data = "upload data"
     response = @session.put("/test", data)
@@ -111,6 +137,18 @@ describe Patron::Session do
     body.header['content-length'].should == [data.size.to_s]
   end
 
+  it "should upload a file with :put" do
+    response = @session.put_file("/test", "VERSION.yml")
+    body = YAML::load(response.body)
+    body.request_method.should == "PUT"
+  end
+
+  it "should use chunked encoding when uploading a file with :put" do
+    response = @session.put_file("/test", "VERSION.yml")
+    body = YAML::load(response.body)
+    body.header['transfer-encoding'].first.should == "chunked"
+  end
+
   it "should upload data with :post" do
     data = "upload data"
     response = @session.post("/test", data)
@@ -119,6 +157,18 @@ describe Patron::Session do
     body.header['content-length'].should == [data.size.to_s]
   end
 
+  it "should upload a file with :post" do
+    response = @session.post_file("/test", "VERSION.yml")
+    body = YAML::load(response.body)
+    body.request_method.should == "POST"
+  end
+
+  it "should use chunked encoding when uploading a file with :post" do
+    response = @session.post_file("/test", "VERSION.yml")
+    body = YAML::load(response.body)
+    body.header['transfer-encoding'].first.should == "chunked"
+  end
+
   it "should pass credentials as http basic auth" do
     @session.username = "foo"
     @session.password = "bar"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: patron
 version: !ruby/object:Gem::Version 
-  version: 0.3.2
+  version: 0.4.0
 platform: ruby
 authors: 
 - Phillip Toland
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-07-03 00:00:00 -05:00
+date: 2009-07-20 00:00:00 -05:00
 default_executable: 
 dependencies: []
 
@@ -34,6 +34,7 @@ files:
 - lib/patron/session.rb
 - spec/patron_spec.rb
 - spec/request_spec.rb
+- spec/response_spec.rb
 - spec/session_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
@@ -77,5 +78,6 @@ summary: Patron HTTP client
 test_files: 
 - spec/patron_spec.rb
 - spec/request_spec.rb
+- spec/response_spec.rb
 - spec/session_spec.rb
 - spec/spec_helper.rb