ethon 0.8.0 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2f2d076d0f8210b0e2ac4f9a798b6f7091bc72e1
-  data.tar.gz: e4e029697e2da2f8f0ff32eeae74dbe52b37342c
+  metadata.gz: 7a8e3e2daabb0f28d13cfec209027f4a3dfb588f
+  data.tar.gz: b5dc230d462c0972fa15bb811906e70ca4b6d8a7
 SHA512:
-  metadata.gz: 44c3c55ce791f04ab8c0722b91473a0f16b897da96312b3f660e20929dfcaef3d961dedcb21b08cee0a08b152f597883cf6f02de23d912379237a3cf7b14e1dc
-  data.tar.gz: 87306062771ee5c5fe442bb041b1b03aa55ae200fff87e65fe00ecf390b6e41212dc961973b71560d74c769ab5fb3c639a42182b41d6576822cde797c219e68b
+  metadata.gz: ba31326c9c9dd60a8635a32edde9b4936307e602097b2ca696333410aea60746fbda37b7c2d179ac2be01a46ccee66debfdd014deb073f87ffeb1fdeae00540b
+  data.tar.gz: 9f2b01584a1f175f9032febbd0fbc1b80a56dcda094a2825746e6e7ccca8254f07fc3ae7bf5c5249e7b75f52914a9229201dfb1a0e26fb17af457a6cfae5efe9

data/.travis.yml

@@ -1,4 +1,5 @@
 script: "bundle exec rake"
+sudo: false
 bundler_args: --without perf
 rvm:
   - 1.8.7

data/CHANGELOG.md

@@ -2,7 +2,16 @@
 
 ## Master
 
-[Full Changelog](https://github.com/typhoeus/ethon/compare/v0.7.4...master)
+[Full Changelog](https://github.com/typhoeus/ethon/compare/v0.8.1...master)
+
+## 0.8.1
+
+* Support optional escaping of params.
+  ([Tasos Laskos](https://github.com/zapotek)
+* `Easy::Mirror`: Reduced object allocations and method calls during info handling.
+  ([Tasos Laskos](https://github.com/zapotek)
+
+## 0.8.0
 
 ## 0.7.4
 

data/lib/ethon.rb

@@ -2,8 +2,12 @@ require 'logger'
 require 'ffi'
 require 'thread'
 begin
-  require 'mime/types'
+  require 'mime/types/columnar'
 rescue LoadError
+  begin
+    require 'mime/types'
+  rescue LoadError
+  end
 end
 require 'tempfile'
 

data/lib/ethon/easy.rb

@@ -248,6 +248,7 @@ module Ethon
     #   easy.reset
     def reset
       @url = nil
+      @escape = nil
       @hash = nil
       @on_complete = nil
       @on_headers = nil

data/lib/ethon/easy/http/actionable.rb

@@ -93,13 +93,18 @@ module Ethon
         def setup(easy)
           @easy = easy
 
+          # Order is important, @easy will be used to provide access to options
+          # relevant to the following operations (like whether or not to escape
+          # values).
+          easy.set_attributes(options)
+
+          set_form(easy) unless form.empty?
+
           if params.empty?
             easy.url = url
           else
             set_params(easy)
           end
-          set_form(easy) unless form.empty?
-          easy.set_attributes(options)
         end
 
         # Setup request with params.
@@ -109,12 +114,16 @@ module Ethon
         #
         # @param [ Easy ] easy The easy to setup.
         def set_params(easy)
-          params.escape = true
+          params.escape = easy.escape?
           params.params_encoding = params_encoding
 
-          base_url, base_params = url.split("?")
-          base_params += "&" if base_params
-          easy.url = "#{base_url}?#{base_params}#{params.to_s}"
+          base_url, base_params = url.split('?')
+          base_url << '?'
+          base_url << base_params.to_s
+          base_url << '&' if base_params
+          base_url << params.to_s
+
+          easy.url = base_url
         end
 
         # Setup request with form.

data/lib/ethon/easy/http/postable.rb

@@ -20,7 +20,7 @@ module Ethon
             form.materialize
             easy.httppost = form.first.read_pointer
           else
-            form.escape = true
+            form.escape = easy.escape?
             easy.postfieldsize = form.to_s.bytesize
             easy.copypostfields = form.to_s
           end

data/lib/ethon/easy/mirror.rb

@@ -4,18 +4,14 @@ module Ethon
       attr_reader :options
       alias_method :to_hash, :options
 
-      def self.informations_to_mirror
-        Informations::AVAILABLE_INFORMATIONS.keys +
+      INFORMATIONS_TO_MIRROR = Informations::AVAILABLE_INFORMATIONS.keys +
           [:return_code, :response_headers, :response_body, :debug_info]
-      end
 
-      def self.informations_to_log
-        [:effective_url, :response_code, :return_code, :total_time]
-      end
+      INFORMATIONS_TO_LOG = [:effective_url, :response_code, :return_code, :total_time]
 
       def self.from_easy(easy)
         options = {}
-        informations_to_mirror.each do |info|
+        INFORMATIONS_TO_MIRROR.each do |info|
           options[info] = easy.send(info)
         end
         new(options)
@@ -26,12 +22,12 @@ module Ethon
       end
 
       def log_informations
-        Hash[*self.class.informations_to_log.map do |info|
+        Hash[*INFORMATIONS_TO_LOG.map do |info|
           [info, options[info]]
         end.flatten]
       end
 
-      informations_to_mirror.each do |info|
+      INFORMATIONS_TO_MIRROR.each do |info|
         eval %Q|def #{info}; options[#{info}]; end|
       end
     end

data/lib/ethon/easy/options.rb

@@ -10,7 +10,16 @@ module Ethon
         @url = value
         Curl.set_option(:url, value, handle)
       end
-      
+
+      def escape=( b )
+        @escape = b
+      end
+
+      def escape?
+        return true if @escape
+        @escape.nil? ? true : false
+      end
+
       Curl.easy_options.each do |opt,props|
         eval %Q<
           def #{opt}=(value)

data/lib/ethon/easy/queryable.rb

@@ -100,6 +100,8 @@ module Ethon
         when Array
           if params_encoding == :rack
             encode_rack_array_pairs(h, prefix, pairs)
+          elsif params_encoding == :multi
+            encode_multi_array_pairs(h, prefix, pairs)
           else
             encode_indexed_array_pairs(h, prefix, pairs)
           end
@@ -126,6 +128,13 @@ module Ethon
           pairs_for(v, key, pairs)
         end
       end
+      
+    def encode_multi_array_pairs(h, prefix, pairs)
+      h.each_with_index do |v, i|
+        key = prefix
+        pairs_for(v, key, pairs)
+      end
+    end
 
       def pairs_for(v, key, pairs)
         case v

data/lib/ethon/version.rb

@@ -1,5 +1,5 @@
 module Ethon
 
   # Ethon version.
-  VERSION = '0.8.0'
+  VERSION = '0.8.1'
 end

data/spec/ethon/easy/http/get_spec.rb

@@ -5,7 +5,8 @@ describe Ethon::Easy::Http::Get do
   let(:url) { "http://localhost:3001/" }
   let(:params) { nil }
   let(:form) { nil }
-  let(:get) { described_class.new(url, {:params => params, :body => form}) }
+  let(:options) { {} }
+  let(:get) { described_class.new(url, {:params => params, :body => form}.merge(options)) }
 
   describe "#setup" do
     it "sets url" do
@@ -84,6 +85,41 @@ describe Ethon::Easy::Http::Get do
           expect(easy.effective_url).to eq("http://localhost:3001/?a=1%26b%3D2")
         end
       end
+
+      context "with :escape" do
+        let(:params) { {:a => "1&b=2"} }
+
+        context 'missing' do
+          it "escapes values" do
+            expect(easy.url).to eq("#{url}?a=1%26b%3D2")
+          end
+        end
+
+        context 'nil' do
+          let(:options) { {:escape => nil} }
+
+          it "escapes values" do
+            expect(easy.url).to eq("#{url}?a=1%26b%3D2")
+          end
+        end
+
+        context 'true' do
+          let(:options) { {:escape => true} }
+
+          it "escapes values" do
+            expect(easy.url).to eq("#{url}?a=1%26b%3D2")
+          end
+        end
+
+        context 'false' do
+          let(:options) { {:escape => false} }
+
+          it "sends raw values" do
+            expect(easy.url).to eq("#{url}?a=1&b=2")
+          end
+        end
+      end
+
     end
   end
 end

data/spec/ethon/easy/http/post_spec.rb

@@ -59,6 +59,42 @@ describe Ethon::Easy::Http::Post do
         end
       end
 
+      context "with :escape" do
+        context 'missing' do
+          it "escapes values" do
+            post.setup(easy)
+            expect(easy.url).to eq("#{url}?a=1%26")
+          end
+        end
+
+        context 'nil' do
+          let(:options) { {:escape => nil} }
+
+          it "escapes values" do
+            post.setup(easy)
+            expect(easy.url).to eq("#{url}?a=1%26")
+          end
+        end
+
+        context 'true' do
+          let(:options) { {:escape => true} }
+
+          it "escapes values" do
+            post.setup(easy)
+            expect(easy.url).to eq("#{url}?a=1%26")
+          end
+        end
+
+        context 'false' do
+          let(:options) { {:escape => false} }
+
+          it "sends raw values" do
+            post.setup(easy)
+            expect(easy.url).to eq("#{url}?a=1&")
+          end
+        end
+      end
+
       it "sets postfieldsize" do
         expect(easy).to receive(:postfieldsize=).with(0)
         post.setup(easy)

data/spec/ethon/easy/mirror_spec.rb

@@ -4,7 +4,7 @@ describe Ethon::Easy::Mirror do
   let(:options) { nil }
   let(:mirror) { described_class.new(options) }
 
-  describe ".informations_to_mirror" do
+  describe "::INFORMATIONS_TO_LOG" do
     [
       :return_code, :response_code, :response_body, :response_headers,
       :total_time, :starttransfer_time, :appconnect_time,
@@ -12,7 +12,7 @@ describe Ethon::Easy::Mirror do
       :effective_url, :primary_ip, :redirect_count, :debug_info
     ].each do |name|
       it "contains #{name}" do
-        expect(described_class.informations_to_mirror).to include(name)
+        expect(described_class::INFORMATIONS_TO_MIRROR).to include(name)
       end
     end
   end
@@ -33,7 +33,7 @@ describe Ethon::Easy::Mirror do
     end
 
     it "only calls methods that exist" do
-      described_class.informations_to_log.each do |method_name|
+      described_class::INFORMATIONS_TO_LOG.each do |method_name|
         expect(mirror.respond_to? method_name).to eql(true)
       end
     end

data/spec/ethon/easy/options_spec.rb

@@ -45,6 +45,35 @@ describe Ethon::Easy::Options do
     end
   end
 
+  describe '#escape?' do
+    context 'by default' do
+      it 'returns true' do
+        expect(easy.escape?).to be_truthy
+      end
+    end
+
+    context 'when #escape=nil' do
+      it 'returns true' do
+        easy.escape = nil
+        expect(easy.escape?).to be_truthy
+      end
+    end
+
+    context 'when #escape=true' do
+      it 'returns true' do
+        easy.escape = true
+        expect(easy.escape?).to be_truthy
+      end
+    end
+
+    context 'when #escape=false' do
+      it 'returns true' do
+        easy.escape = false
+        expect(easy.escape?).to be_falsey
+      end
+    end
+  end
+
   describe "#httppost=" do
     it "raises unless given a FFI::Pointer" do
       expect{ easy.httppost = 1 }.to raise_error(Ethon::Errors::InvalidValue)

data/spec/ethon/easy/queryable_spec.rb

@@ -162,13 +162,14 @@ describe Ethon::Easy::Queryable do
             let(:file) { Tempfile.new("fubar") }
 
             it "sets mime type to default application/octet-stream" do
-              Object.send(:remove_const, :MIME)
               expect(mime_type).to eq("application/octet-stream")
             end
           end
         end
 
         context "when no MIME" do
+          before { hide_const("MIME") }
+
           it "sets mime type to default application/octet-stream" do
             expect(mime_type).to eq("application/octet-stream")
           end

data/spec/ethon/easy_spec.rb

@@ -64,6 +64,12 @@ describe Ethon::Easy do
       expect(easy.url).to be_nil
     end
 
+    it "resets escape?" do
+      easy.escape = false
+      easy.reset
+      expect(easy.escape?).to be_truthy
+    end
+
     it "resets hash" do
       easy.reset
       expect(easy.instance_variable_get(:@hash)).to be_nil

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ethon
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.8.1
 platform: ruby
 authors:
 - Hans Hasselberg
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-17 00:00:00.000000000 Z
+date: 2016-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi