ethon 0.5.12 → 0.6.0

data/profile/support/ruby_object_leak_tracker.rb

@@ -0,0 +1,48 @@
+class RubyObjectLeakTracker
+  attr_reader :previous_count_hash, :current_count_hash
+
+  def initialize
+    @previous_count_hash = @current_count_hash = {}    
+  end
+
+  def difference_between_runs(basis=@previous_count_hash)
+    @difference_between_runs ||= Hash[@current_count_hash.map do |object_class, count|
+      [object_class, count - (basis[object_class] || 0)]
+    end]
+  end
+
+  def total_difference_between_runs
+    difference_between_runs(@initial_count_hash).values.inject(0) { |sum, count| sum + count }
+  end
+
+  def capture_initial_memory_usage
+    capture_memory_usage
+    @initial_count_hash = @current_count_hash
+  end
+
+  def capture_memory_usage
+    @difference_between_runs = nil
+    @previous_count_hash = @current_count_hash
+
+    class_to_count = Hash.new { |hash, key| hash[key] = 0 }
+    ObjectSpace.each_object { |obj| class_to_count[obj.class] += 1 }
+
+    sorted_class_to_count = class_to_count.sort_by { |k, v| -v }
+    @current_count_hash = Hash[sorted_class_to_count]
+  end
+
+  def dump_status(logger)
+    diff = difference_between_runs
+    most_used_objects = current_count_hash.to_a.sort_by(&:last).reverse[0, 20]
+
+    most_used_objects.each do |object_class, count|
+      delta = diff[object_class]
+      logger.add(log_level(delta), sprintf("\t%s: %d (%+d)", object_class, count, delta))
+    end
+  end
+
+  private
+  def log_level(delta)
+    delta > 0 ? Logger::WARN : Logger::DEBUG
+  end
+end

data/spec/ethon/curl_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe Ethon::Curl do
+  describe ".init" do
+    before { Ethon::Curl.send(:class_variable_set, :@@initialized, false) }
+
+    context "when global_init fails" do
+      it "raises global init error" do
+        Ethon::Curl.should_receive(:global_init).and_return(1)
+        expect{ Ethon::Curl.init }.to raise_error(Ethon::Errors::GlobalInit)
+      end
+    end
+
+    context "when global_init works" do
+      before { Ethon::Curl.should_receive(:global_init).and_return(0) }
+
+      it "doesn't raises global init error" do
+        expect{ Ethon::Curl.init }.to_not raise_error(Ethon::Errors::GlobalInit)
+      end
+
+      it "logs" do
+        Ethon.logger.should_receive(:debug)
+        Ethon::Curl.init
+      end
+    end
+  end
+end

data/spec/ethon/easy/callbacks_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe Ethon::Easy::Callbacks do
+  let!(:easy) { Ethon::Easy.new }
+
+  describe "#set_callbacks" do
+    before do
+      Ethon::Curl.should_receive(:set_option).exactly(3).times
+    end
+
+    it "sets write- and headerfunction" do
+      easy.set_callbacks
+    end
+
+    it "resets @response_body" do
+      easy.set_callbacks
+      expect(easy.instance_variable_get(:@response_body)).to eq("")
+    end
+
+    it "resets @response_headers" do
+      easy.set_callbacks
+      expect(easy.instance_variable_get(:@response_headers)).to eq("")
+    end
+
+    it "resets @debug_info" do
+      easy.set_callbacks
+      expect(easy.instance_variable_get(:@debug_info).to_a).to eq([])
+    end
+
+  end
+end

data/spec/ethon/easy/debug_info_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+
+describe Ethon::Easy::DebugInfo do
+  let(:easy) { Ethon::Easy.new }
+
+  before do
+    easy.url = "http://localhost:3001/"
+    easy.perform
+  end
+
+  describe "#debug_info" do
+    context "when verbose is not set to true" do
+      it "does not save any debug info after a request" do
+        expect(easy.debug_info.to_a.length).to eq(0)
+        expect(easy.debug_info.to_h.values.flatten.length).to eq(0)
+      end
+    end
+
+    context "when verbose is set to true" do
+      before do
+        easy.verbose = true
+        easy.perform
+      end
+
+      after do
+        easy.reset
+      end
+
+      it "saves debug info after a request" do
+        expect(easy.debug_info.to_a.length).to be > 0
+      end
+
+      it "saves request headers" do
+        expect(easy.debug_info.header_out.join).to include('GET / HTTP/1.1')
+      end
+
+      it "saves response headers" do
+        expect(easy.debug_info.header_in.length).to be > 0
+        expect(easy.response_headers).to include(easy.debug_info.header_in.join)
+      end
+
+      it "saves incoming data" do
+        expect(easy.debug_info.data_in.length).to be > 0
+        expect(easy.response_body).to include(easy.debug_info.data_in.join)
+      end
+
+      it "saves debug text" do
+        expect(easy.debug_info.text.length).to be > 0
+      end
+    end
+  end
+end

data/spec/ethon/easy/form_spec.rb

@@ -0,0 +1,76 @@
+require 'spec_helper'
+
+describe Ethon::Easy::Form do
+  let(:hash) { {} }
+  let!(:easy) { Ethon::Easy.new }
+  let(:form) { Ethon::Easy::Form.new(easy, hash) }
+
+  describe ".new" do
+    it "assigns attribute to @params" do
+      expect(form.instance_variable_get(:@params)).to eq(hash)
+    end
+  end
+
+  describe "#first" do
+    it "returns a pointer" do
+      expect(form.first).to be_a(FFI::Pointer)
+    end
+  end
+
+  describe "#last" do
+    it "returns a pointer" do
+      expect(form.first).to be_a(FFI::Pointer)
+    end
+  end
+
+  describe "#multipart?" do
+    before { form.instance_variable_set(:@query_pairs, pairs) }
+
+    context "when query_pairs contains string values" do
+      let(:pairs) { [['a', '1'], ['b', '2']] }
+
+      it "returns false" do
+        expect(form.multipart?).to be_false
+      end
+    end
+
+    context "when query_pairs contains file" do
+      let(:pairs) { [['a', '1'], ['b', ['path', 'encoding', 'abs_path']]] }
+
+      it "returns true" do
+        expect(form.multipart?).to be_true
+      end
+    end
+  end
+
+  describe "#materialize" do
+    before { form.instance_variable_set(:@query_pairs, pairs) }
+
+    context "when query_pairs contains string values" do
+      let(:pairs) { [['a', '1']] }
+
+      it "adds params to form" do
+        Ethon::Curl.should_receive(:formadd)
+        form.materialize
+      end
+    end
+
+    context "when query_pairs contains nil" do
+      let(:pairs) { [['a', nil]] }
+
+      it "adds params to form" do
+        Ethon::Curl.should_receive(:formadd)
+        form.materialize
+      end
+    end
+
+    context "when query_pairs contains file" do
+      let(:pairs) { [['a', ["file", "type", "path/file"]]] }
+
+      it "adds file to form" do
+        Ethon::Curl.should_receive(:formadd)
+        form.materialize
+      end
+    end
+  end
+end

data/spec/ethon/easy/header_spec.rb

@@ -0,0 +1,78 @@
+require 'spec_helper'
+
+describe Ethon::Easy::Header do
+  let(:easy) { Ethon::Easy.new }
+
+  describe "#headers=" do
+    let(:headers) { { 'User-Agent' => 'Ethon' } }
+
+    it "sets header" do
+      Ethon::Easy.any_instance.should_receive(:set_callbacks)
+      Ethon::Curl.should_receive(:set_option)
+      easy.headers = headers
+    end
+
+    context "when requesting" do
+      before do
+        easy.headers = headers
+        easy.url = "http://localhost:3001"
+        easy.perform
+      end
+
+      it "sends" do
+        expect(easy.response_body).to include('"HTTP_USER_AGENT":"Ethon"')
+      end
+
+      context "when header value contains null byte" do
+        let(:headers) { { 'User-Agent' => "Ethon\0" } }
+
+        it "escapes" do
+          expect(easy.response_body).to include('"HTTP_USER_AGENT":"Ethon\\\\0"')
+        end
+      end
+
+      context "when header value has leading whitespace" do
+        let(:headers) { { 'User-Agent' => " Ethon" } }
+
+        it "removes" do
+          expect(easy.response_body).to include('"HTTP_USER_AGENT":"Ethon"')
+        end
+      end
+
+      context "when header value has traiing whitespace" do
+        let(:headers) { { 'User-Agent' => "Ethon " } }
+
+        it "removes" do
+          expect(easy.response_body).to include('"HTTP_USER_AGENT":"Ethon"')
+        end
+      end
+    end
+  end
+
+  describe "#compose_header" do
+    it "has space in between" do
+      expect(easy.compose_header('a', 'b')).to eq('a: b')
+    end
+
+    context "when value is a symbol" do
+      it "works" do
+        expect{ easy.compose_header('a', :b) }.to_not raise_error
+      end
+    end
+  end
+
+  describe "#header_list" do
+    context "when no set_headers" do
+      it "returns nil" do
+        expect(easy.header_list).to eq(nil)
+      end
+    end
+
+    context "when set_headers" do
+      it "returns pointer to header list" do
+        easy.headers = {'User-Agent' => 'Custom'}
+        expect(easy.header_list).to be_a(FFI::Pointer)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,176 @@
+require 'spec_helper'
+
+describe Ethon::Easy::Http::Custom do
+  let(:easy) { Ethon::Easy.new }
+  let(:url) { "http://localhost:3001/" }
+  let(:params) { nil }
+  let(:form) { nil }
+  let(:custom) { described_class.new("PURGE", url, {:params => params, :body => form}) }
+
+  describe "#setup" do
+    context "when nothing" do
+      it "sets url" do
+        custom.setup(easy)
+        expect(easy.url).to eq(url)
+      end
+
+      it "makes a custom request" do
+        custom.setup(easy)
+        easy.perform
+        expect(easy.response_body).to include('"REQUEST_METHOD":"PURGE"')
+      end
+    end
+
+    context "when params" do
+      let(:params) { {:a => "1&"} }
+
+      it "attaches escaped to url" do
+        custom.setup(easy)
+        expect(easy.url).to eq("#{url}?a=1%26")
+      end
+
+      context "when requesting" do
+        before do
+          easy.headers = { 'Expect' => '' }
+          custom.setup(easy)
+          easy.perform
+        end
+
+        it "is a custom verb" do
+          expect(easy.response_body).to include('"REQUEST_METHOD":"PURGE"')
+        end
+
+        it "does not use application/x-www-form-urlencoded content type" do
+          expect(easy.response_body).to_not include('"CONTENT_TYPE":"application/x-www-form-urlencoded"')
+        end
+
+        it "requests parameterized url" do
+          expect(easy.response_body).to include('"REQUEST_URI":"http://localhost:3001/?a=1%26"')
+        end
+      end
+    end
+
+    context "when body" do
+      context "when multipart" do
+        let(:form) { {:a => File.open(__FILE__, 'r')} }
+
+        it "sets httppost" do
+          easy.should_receive(:httppost=)
+          custom.setup(easy)
+        end
+
+        context "when requesting" do
+          before do
+            easy.headers = { 'Expect' => '' }
+            custom.setup(easy)
+            easy.perform
+          end
+
+          it "returns ok" do
+            expect(easy.return_code).to eq(:ok)
+          end
+
+          it "is a custom verb" do
+            expect(easy.response_body).to include('"REQUEST_METHOD":"PURGE"')
+          end
+
+          it "uses multipart/form-data content type" do
+            expect(easy.response_body).to include('"CONTENT_TYPE":"multipart/form-data')
+          end
+
+          it "submits a body" do
+            expect(easy.response_body).to match('"body":".+"')
+          end
+
+          it "submits the data" do
+            expect(easy.response_body).to include('"filename":"custom_spec.rb"')
+          end
+        end
+      end
+
+      context "when not multipart" do
+        let(:form) { {:a => "1&b=2"} }
+        let(:encoded) { "a=1%26b%3D2" }
+
+        it "sets escaped copypostfields" do
+          easy.should_receive(:copypostfields=).with(encoded)
+          custom.setup(easy)
+        end
+
+        it "sets postfieldsize" do
+          easy.should_receive(:postfieldsize=).with{ |value| expect(value).to be(encoded.bytesize) }
+          custom.setup(easy)
+        end
+
+        context "when requesting" do
+          before do
+            easy.headers = { 'Expect' => '' }
+            custom.setup(easy)
+            easy.perform
+          end
+
+          it "returns ok" do
+            expect(easy.return_code).to eq(:ok)
+          end
+
+          it "is a custom verb" do
+            expect(easy.response_body).to include('"REQUEST_METHOD":"PURGE"')
+          end
+
+          it "uses multipart/form-data content type" do
+            expect(easy.response_body).to include('"CONTENT_TYPE":"application/x-www-form-urlencoded')
+          end
+
+          it "submits a body" do
+            expect(easy.response_body).to match('"body":"a=1%26b%3D2"')
+          end
+
+          it "submits the data" do
+            expect(easy.response_body).to include('"rack.request.form_hash":{"a":"1&b=2"}')
+          end
+        end
+      end
+
+      context "when string" do
+        let(:form) { "{a: 1}" }
+
+        context "when requesting" do
+          before do
+            easy.headers = { 'Expect' => '' }
+            custom.setup(easy)
+            easy.perform
+          end
+
+          it "returns ok" do
+            expect(easy.return_code).to eq(:ok)
+          end
+
+          it "sends string" do
+            expect(easy.response_body).to include('"body":"{a: 1}"')
+          end
+        end
+      end
+    end
+
+    context "when params and body" do
+      let(:form) { {:a => "1"} }
+      let(:params) { {:b => "2"} }
+
+      context "when requesting" do
+        before do
+          easy.headers = { 'Expect' => '' }
+          custom.setup(easy)
+          easy.perform
+        end
+
+        it "url contains params" do
+          expect(easy.response_body).to include('"REQUEST_URI":"http://localhost:3001/?b=2"')
+        end
+
+        it "body contains form" do
+          expect(easy.response_body).to include('"body":"a=1"')
+        end
+      end
+    end
+  end
+end