patron 0.5.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 018a03fb6977a92e0dbf70f4e8473ef273d7576c
-  data.tar.gz: 611bde5b709c9f24007fa8805b369310baa8ed6d
+  metadata.gz: c0a3e8dc6975392e43cac53cb03387ef07c3cab3
+  data.tar.gz: c58f5c72242c526bd2b8a9a70f13fa53248512e4
 SHA512:
-  metadata.gz: a2e176e3648ab4293bc69cbaca8e048ba7effb544ebf49de0cd3647b99cd1105e0b52f1afaef32e3c9ab899ff5c41cc01e8fa2d97861de0f3064c405d0af4865
-  data.tar.gz: a1525278695ce34f891f3d06f2bb352e841d97fba8b4f50b71a21b6fe960964cd4f8f9e39ca5dab1d65ac8d30e8fd97dd80b8d3c9ff8cc63d78eb331756c35df
+  metadata.gz: d4e0312f0cf82ed1db7d980bd93771016e710e7d2b1c6c3b7d7eaf965ff654eba61199eaa6a54df44e9c9ece0f610a8b16eb4bde37fce15b84fb733abf61f531
+  data.tar.gz: 28e92d83ad9d9e7e173c327c7797b6d11240e41c1fceadb4e3cfdbc9a35abe0597150c2ab32626d183992ec835d5bfd1a6c771df506e10b2fe44c9ca3ada15d1

data/ext/patron/session_ext.c

@@ -223,16 +223,18 @@ static VALUE libcurl_version(VALUE klass) {
  * URL escapes the provided string.
  */
 static VALUE session_escape(VALUE self, VALUE value) {
-  struct curl_state *state = get_curl_state(self);
+  
   VALUE string = StringValue(value);
   char* escaped = NULL;
   VALUE retval = Qnil;
 
+  struct 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;
@@ -244,11 +246,11 @@ static VALUE session_escape(VALUE self, VALUE value) {
  * Unescapes the provided string.
  */
 static VALUE session_unescape(VALUE self, VALUE value) {
-  struct curl_state *state = get_curl_state(self);
   VALUE string = StringValue(value);
   char* unescaped = NULL;
   VALUE retval = Qnil;
 
+  struct curl_state* state = curl_easy_init();
   unescaped = curl_easy_unescape(state->handle,
                                  RSTRING_PTR(string),
                                  (int) RSTRING_LEN(string),
@@ -256,6 +258,7 @@ static VALUE session_unescape(VALUE self, VALUE value) {
 
   retval = rb_str_new2(unescaped);
   curl_free(unescaped);
+  curl_easy_cleanup(state);
 
   return retval;
 }
@@ -347,6 +350,7 @@ static void set_options_from_request(VALUE self, VALUE request) {
   VALUE ssl_version           = Qnil;
   VALUE buffer_size           = Qnil;
   VALUE action_name           = rb_iv_get(request, "@action");
+  VALUE a_c_encoding          = rb_iv_get(request, "@automatic_content_encoding");
 
   headers = rb_iv_get(request, "@headers");
   if (!NIL_P(headers)) {
@@ -454,6 +458,12 @@ static void set_options_from_request(VALUE self, VALUE request) {
   curl_easy_setopt(curl, CURLOPT_HTTPHEADER, state->headers);
   curl_easy_setopt(curl, CURLOPT_ERRORBUFFER, state->error_buf);
 
+  // Enable automatic content-encoding support via gzip/deflate if set in the request,
+  // see https://curl.haxx.se/libcurl/c/CURLOPT_ACCEPT_ENCODING.html
+  if(RTEST(a_c_encoding)) {
+    curl_easy_setopt(curl, CURLOPT_ACCEPT_ENCODING, "");
+  }
+  
   url = rb_iv_get(request, "@url");
   if (NIL_P(url)) {
     rb_raise(rb_eArgError, "Must provide a URL");
@@ -777,8 +787,14 @@ void Init_session_ext() {
   cRequest = rb_define_class_under(mPatron, "Request", rb_cObject);
   rb_define_alloc_func(cSession, session_alloc);
 
+  // Make "escape" available both as a class method and as an instance method,
+  // to make it usable to the Util module which does not have access to
+  // the Session object internally
+  rb_define_singleton_method(cSession, "escape",   session_escape,         1);
   rb_define_method(cSession, "escape",         session_escape,         1);
+  rb_define_singleton_method(cSession, "unescape",   session_unescape,         1);
   rb_define_method(cSession, "unescape",       session_unescape,       1);
+
   rb_define_method(cSession, "handle_request", session_handle_request, 1);
   rb_define_method(cSession, "reset",          session_reset,          0);
   rb_define_method(cSession, "interrupt",      session_interrupt,      0);

data/lib/patron/request.rb

@@ -46,12 +46,12 @@ module Patron
       :url, :username, :password, :file_name, :proxy, :proxy_type, :insecure,
       :ignore_content_length, :multipart, :action, :timeout, :connect_timeout,
       :max_redirects, :headers, :auth_type, :upload_data, :buffer_size, :cacert,
-      :ssl_version, :force_ipv4
+      :ssl_version, :automatic_content_encoding, :force_ipv4
     ]
 
     WRITER_VARS = [
       :url, :username, :password, :file_name, :proxy, :proxy_type, :insecure,
-      :ignore_content_length, :multipart, :cacert, :ssl_version, :force_ipv4
+      :ignore_content_length, :multipart, :cacert, :ssl_version, :automatic_content_encoding, :force_ipv4
     ]
 
     attr_reader *READER_VARS

data/lib/patron/session.rb

@@ -87,6 +87,9 @@ module Patron
     # Force curl to use IPv4
     attr_accessor :force_ipv4
 
+    # Support automatic Content-Encoding decompression and set liberal Accept-Encoding headers
+    attr_accessor :automatic_content_encoding
+    
     private :handle_request, :enable_cookie_session, :set_debug_file
 
     # Create a new Session object.
@@ -236,6 +239,7 @@ module Patron
       Request.new.tap do |req|
         req.action                 = action
         req.headers                = self.headers.merge headers
+        req.automatic_content_encoding = options.fetch :automatic_content_encoding, self.automatic_content_encoding
         req.timeout                = options.fetch :timeout,               self.timeout
         req.connect_timeout        = options.fetch :connect_timeout,       self.connect_timeout
         req.force_ipv4             = options.fetch :force_ipv4,            self.force_ipv4

data/lib/patron/util.rb

@@ -23,8 +23,6 @@
 ##
 ## -------------------------------------------------------------------
 
-require 'cgi'
-
 module Patron
   module Util
     extend self
@@ -34,7 +32,7 @@ module Patron
       recursive = Proc.new do |h, prefix|
         h.each_pair do |k,v|
           key = prefix == '' ? k : "#{prefix}[#{k}]"
-          v = CGI::escape(v.to_s) if escape_values
+          v = Patron::Session.escape(v.to_s) if escape_values
           v.is_a?(Hash) ? recursive.call(v, key) : pairs << "#{key}=#{v}"
         end
       end

data/lib/patron/version.rb

@@ -1,3 +1,3 @@
 module Patron
-  VERSION = "0.5.1"
+  VERSION = "0.6.0"
 end

data/spec/session_spec.rb

@@ -38,14 +38,30 @@ describe Patron::Session do
     @session.force_ipv4 = true
     expect { @session.get("/test") }.to_not raise_error
   end
-
-  it "should escape and unescape strings symetrically" do
-    string = "foo~bar baz/"
-    escaped = @session.escape(string)
-    unescaped = @session.unescape(escaped)
-    expect(unescaped).to be == string
+  
+  describe '.escape and #escape' do
+    it 'makes escape() and unescape() available on the class' do
+      string = "foo~bar baz/"
+      escaped = described_class.escape(string)
+      unescaped = described_class.unescape(escaped)
+      expect(unescaped).to be == string
+    end
+    
+    it "should escape and unescape strings symetrically" do
+      string = "foo~bar baz/"
+      escaped = @session.escape(string)
+      unescaped = @session.unescape(escaped)
+      expect(unescaped).to be == string
+    end
+  
+    it "should make e and unescape strings symetrically" do
+      string = "foo~bar baz/"
+      escaped = @session.escape(string)
+      unescaped = @session.unescape(escaped)
+      expect(unescaped).to be == string
+    end
   end
-
+  
   it "should raise an error when passed an invalid action" do
     expect { @session.request(:bogus, "/test", {}) }.to raise_error(ArgumentError)
   end
@@ -329,6 +345,17 @@ describe Patron::Session do
     expect(body.request_method).to be == "GET"
   end
 
+  it "should automatically decompress using Content-Encoding if requested" do
+    @session.automatic_content_encoding = true
+    response = @session.get('/gzip-compressed')
+    
+    expect(response.headers['Content-Length']).to eq('125')
+    
+    body = response.body
+    expect(body).to match(/Some highly compressible data/)
+    expect(body.bytesize).to eq(29696)
+  end
+  
   it "should serialize query params and append them to the url" do
     response = @session.request(:get, "/test", {}, :query => {:foo => "bar"})
     request = YAML::load(response.body)

data/spec/support/test_server.rb

@@ -70,6 +70,29 @@ class TestServlet < HTTPServlet::AbstractServlet
   end
 end
 
+class GzipServlet < HTTPServlet::AbstractServlet
+
+  def do_GET(req,res)
+    raise "Need to have the right Accept-Encoding: header" unless req.header['Accept-Encoding']
+    
+    out = StringIO.new
+    z = Zlib::Deflate.new(Zlib::DEFAULT_COMPRESSION)
+    1024.times { 
+      out << z.deflate('Some highly compressible data')
+    }
+    out << z.finish
+    z.close
+    
+    content_length = out.size
+    # Content-Length gets set automatically by WEBrick, and if we do it manually
+    # here then two headers will be set.
+    # res.header['Content-Length'] = content_length
+    res.header['Content-Encoding'] = 'deflate'
+    res.header['Vary'] = 'Accept-Encoding'
+    res.body = out.string
+  end
+end
+
 class TimeoutServlet < HTTPServlet::AbstractServlet
   def do_GET(req,res)
     sleep(1.1)
@@ -83,7 +106,6 @@ class RedirectServlet < HTTPServlet::AbstractServlet
   end
 end
 
-
 class TestPostBodyServlet < HTTPServlet::AbstractServlet
   include RespondWith
   def do_POST(req, res)
@@ -91,8 +113,6 @@ class TestPostBodyServlet < HTTPServlet::AbstractServlet
   end
 end
 
-
-
 class SetCookieServlet < HTTPServlet::AbstractServlet
   def do_GET(req, res)
     res['Set-Cookie'] = "session_id=foo123"
@@ -162,6 +182,7 @@ class PatronTestServer
     @server.mount("/setcookie", SetCookieServlet)
     @server.mount("/repetitiveheader", RepetitiveHeaderServlet)
     @server.mount("/wrongcontentlength", WrongContentLengthServlet)
+    @server.mount("/gzip-compressed", GzipServlet)
 
   end
 

data/spec/util_spec.rb

@@ -26,6 +26,7 @@ require File.expand_path("./spec") + '/spec_helper.rb'
 describe Patron::Util do
 
   describe :build_query_pairs_from_hash do
+    
     it "correctly serializes a simple hash" do
       hash = {:foo => "bar", "baz" => 42}
       array = Patron::Util.build_query_pairs_from_hash(hash)
@@ -33,6 +34,7 @@ describe Patron::Util do
       expect(array).to include("foo=bar")
       expect(array).to include("baz=42")
     end
+    
     it "correctly serializes a more complex hash" do
       hash = {
         :foo => "bar",

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: patron
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Phillip Toland
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-14 00:00:00.000000000 Z
+date: 2016-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler