patron 0.6.5 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a7318f9bed9b99f36570d83e3c0de4fe77e9fa93
-  data.tar.gz: 15cf5d9064bb24ce550e31e15c87feacb6d9e2a5
+  metadata.gz: f76646171763f7fa4dfc31e84faa095603d0a436
+  data.tar.gz: 1afb07a23dac44e8a082049cd5e5c4500a3ae6f8
 SHA512:
-  metadata.gz: 07b6971951e179505a4df277951b57c5b509679fb7e1515f400fdd954e897a9b191c879ba467e409d5ef310b6fee44b7608c26cbf80d0629e1c3574be25a0487
-  data.tar.gz: aee56e977fce8e5e629df192aa83a5a27d69dd66a767adac38adb5786e36d93186162bd6166a6292a0826e15dc4c466fc6e0e2e1c7de885fe59e40c53f3235fc
+  metadata.gz: e082c9ffc4a0fca0384aa00393761ca50dbbece9745b13e66c8e5776b195c2865ea03ccc79849907ab3c084a40570fff1bdd38b5e690e327a8d268e93e6058fc
+  data.tar.gz: eaa0104eddc56283dd2561a5aae9c4736dd5e24c433cc2a08d360900173a6ac18c1c2dd7731881a339fadf7f802a8224d22476120c01ac884746983d7bd2895f

data/CHANGELOG.md

@@ -1,3 +1,5 @@
+* Allow Ruby File objects to be passed as `data` to `Session#put`, `Sesion#post` etc.
+
 ### 0.6.5
 
 * Prevent libCURL from doing requests to non-HTTP/HTTPS URLs, and from following redirects to such URLs

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    patron (0.6.5)
+    patron (0.7.0)
 
 GEM
   remote: https://rubygems.org/

data/ext/patron/session_ext.c

@@ -26,6 +26,7 @@
 #if defined(USE_TBR) && defined(HAVE_THREAD_H)
 #include <ruby/thread.h>
 #endif
+#include <sys/stat.h>
 #include <curl/curl.h>
 #include "membuffer.h"
 #include "sglib.h"  /* Simple Generic Library -> http://sglib.sourceforge.net */
@@ -51,8 +52,8 @@ struct curl_state {
   CURL* handle;
   char* upload_buf;
   FILE* download_file;
-  FILE* upload_file;
   FILE* debug_file;
+  FILE* request_body_file;
   char error_buf[CURL_ERROR_SIZE];
   struct curl_slist* headers;
   struct curl_httppost* post;
@@ -329,12 +330,47 @@ static FILE* open_file(VALUE filename, const char* perms) {
   return handle;
 }
 
+static void set_request_body_file(struct curl_state* state, VALUE r_path_str) {
+  CURL* curl = state->handle;
+  
+  state->request_body_file = open_file(r_path_str, "rb");
+  curl_easy_setopt(curl, CURLOPT_UPLOAD, 1);
+  curl_easy_setopt(curl, CURLOPT_READDATA, state->request_body_file);
+  #ifdef CURLOPT_INFILESIZE_LARGE
+    struct stat stat_info;
+    fstat(fileno(state->request_body_file), &stat_info);
+    curl_easy_setopt(curl, CURLOPT_INFILESIZE, stat_info.st_size);
+  #else
+    struct stat stat_info;
+    fstat(fileno(state->request_body_file), &stat_info);
+    curl_easy_setopt(curl, CURLOPT_INFILESIZE_LARGE, stat_info.st_size);
+  #endif
+}
+
+static void set_request_body(struct curl_state* state, VALUE stringable_or_file) {
+  CURL* curl = state->handle;
+  if(rb_respond_to(stringable_or_file, rb_intern("to_path"))) {
+    // Set up a file read callback (read the entire request body from a file).
+    // Instead of using the Ruby file reads, use #to_path to obtain the
+    // file path on the file system and open a file pointer to it
+    VALUE r_path_str = rb_funcall(stringable_or_file, rb_intern("to_path"), 0);
+    r_path_str = rb_funcall(r_path_str, rb_intern("to_s"), 0);
+    set_request_body_file(state, r_path_str);
+  } else {
+    // Set the request body from a String
+    VALUE data = rb_funcall(stringable_or_file, rb_intern("to_s"), 0);
+    long len = RSTRING_LEN(data);
+    state->upload_buf = StringValuePtr(data);
+    set_curl_request_body(curl, state->upload_buf, len);
+  }
+}
+
 /* 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.
  */
 static void set_options_from_request(VALUE self, VALUE request) {
-  struct curl_state *state = get_curl_state(self);
+  struct curl_state* state = get_curl_state(self);
   CURL* curl = state->handle;
 
   ID    action                = Qnil;
@@ -372,10 +408,7 @@ static void set_options_from_request(VALUE self, VALUE request) {
 
     curl_easy_setopt(curl, CURLOPT_HTTPGET, 1);
     if (RTEST(data)) {
-      data = rb_funcall(data, rb_intern("to_s"), 0);
-      long len = RSTRING_LEN(data);
-      state->upload_buf = StringValuePtr(data);
-      set_curl_request_body(curl, state->upload_buf, len);
+      set_request_body(state, data);
       curl_easy_setopt(curl, CURLOPT_CUSTOMREQUEST, "GET");
     }
     if (RTEST(download_file)) {
@@ -398,30 +431,24 @@ static void set_options_from_request(VALUE self, VALUE request) {
     }
     
     if (RTEST(data) && !RTEST(multipart)) {
-      data = rb_funcall(data, rb_intern("to_s"), 0);
       if (action == rb_intern("post")) {
         curl_easy_setopt(curl, CURLOPT_POST, 1);
       }
-      long len = RSTRING_LEN(data);
-      state->upload_buf = StringValuePtr(data);
-      set_curl_request_body(curl, state->upload_buf, len);
+      set_request_body(state, data);
     } else if (RTEST(filename) && !RTEST(multipart)) {
       set_chunked_encoding(state);
-
-      curl_easy_setopt(curl, CURLOPT_UPLOAD, 1);
-
-      state->upload_file = open_file(filename, "rb");
-      curl_easy_setopt(curl, CURLOPT_READDATA, state->upload_file);
+      set_request_body_file(state, filename);
     } else if (RTEST(multipart)) {
       if (action == rb_intern("post")) {
         if(RTEST(data) && RTEST(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.");}
+          } 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");
       }
@@ -670,11 +697,11 @@ static VALUE cleanup(VALUE self) {
     state->download_file = NULL;
   }
 
-  if (state->upload_file) {
-    fclose(state->upload_file);
-    state->upload_file = NULL;
+  if (state->request_body_file) {
+    fclose(state->request_body_file);
+    state->request_body_file = NULL;
   }
-
+  
   if (state->post) {
     curl_formfree(state->post);
     state->post = NULL;

data/lib/patron/session.rb

@@ -226,7 +226,9 @@ module Patron
     #
     # @todo inconsistency with "post" - Hash not accepted
     # @param url[String] the URL to fetch
-    # @param data[#to_s] an object that can be converted to a String to create the request body
+    # @param data[#to_s, #to_path] an object that can be converted to a String
+    #   to create the request body, or that responds to #to_path to upload the
+    #   entire request body from that file
     # @param headers[Hash] the hash of header keys to values
     # @return [Patron::Response]
     def put(url, data, headers = {})
@@ -238,7 +240,9 @@ module Patron
     #
     # @todo inconsistency with "post" - Hash not accepted
     # @param url[String] the URL to fetch
-    # @param data[#to_s] an object that can be converted to a String to create the request body
+    # @param data[#to_s, #to_path] an object that can be converted to a String
+    #   to create the request body, or that responds to #to_path to upload the
+    #   entire request body from that file
     # @param headers[Hash] the hash of header keys to values
     # @return [Patron::Response]
     def patch(url, data, headers = {})
@@ -259,7 +263,10 @@ module Patron
     # Uploads the passed `data` to the specified `url` using an HTTP POST.
     #
     # @param url[String] the URL to fetch
-    # @param data[Hash, #to_s] a Hash of form fields/values, or an object that can be converted to a String to create the request body
+    # @param data[Hash, #to_s, #to_path] a Hash of form fields/values,
+    #   or an object that can be converted to a String
+    #   to create the request body, or an object that responds to #to_path to upload the
+    #   entire request body from that file
     # @param headers[Hash] the hash of header keys to values
     # @return [Patron::Response]
     def post(url, data, headers = {})
@@ -293,7 +300,6 @@ module Patron
       request(:post, url, headers, {:data => data, :file => filename, :multipart => true})
     end
 
-
     # @!group WebDAV methods
     # Sends a WebDAV COPY request to the specified +url+.
     #

data/lib/patron/version.rb

@@ -1,3 +1,3 @@
 module Patron
-  VERSION = "0.6.5"
+  VERSION = "0.7.0"
 end

data/spec/session_spec.rb

@@ -248,6 +248,17 @@ describe Patron::Session do
     expect(body.header['content-length']).to be == [data.size.to_s]
   end
 
+  it "should upload a Tempfile with :put" do
+    data = Tempfile.new 'data-buffer'
+    data << Random.new.bytes(1024 * 64)
+    data.flush; data.rewind
+    
+    response = @session.put("/test", data, {'Expect' => ''})
+    body = YAML::load(response.body)
+    expect(body.request_method).to be == "PUT"
+    expect(body.header['content-length']).to be == [data.size.to_s]
+  end
+  
   it "should upload data with :patch" do
     data = "upload data"
     response = @session.patch("/testpatch", data)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: patron
 version: !ruby/object:Gem::Version
-  version: 0.6.5
+  version: 0.7.0
 platform: ruby
 authors:
 - Phillip Toland
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-07 00:00:00.000000000 Z
+date: 2016-07-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler