ethon 0.5.12 → 0.6.0

data/spec/ethon/easy/options_spec.rb

@@ -0,0 +1,135 @@
+require 'spec_helper'
+
+describe Ethon::Easy::Options do
+  let(:easy) { Ethon::Easy.new }
+
+  [
+    :accept_encoding, :cainfo, :capath, :connecttimeout, :connecttimeout_ms, :cookie,
+    :cookiejar, :cookiefile, :copypostfields, :customrequest, :dns_cache_timeout,
+    :followlocation, :forbid_reuse, :http_version, :httpauth, :httpget, :httppost,
+    :infilesize, :interface, :keypasswd, :maxredirs, :nobody, :nosignal,
+    :postfieldsize, :postredir, :protocols, :proxy, :proxyauth, :proxyport, :proxytype,
+    :proxyuserpwd, :readdata, :readfunction, :redir_protocols, :ssl_verifyhost,
+    :ssl_verifypeer, :sslcert, :sslcerttype, :sslkey, :sslkeytype, :sslversion,
+    :timeout, :timeout_ms, :unrestricted_auth, :upload, :url, :useragent,
+    :userpwd, :verbose
+  ].each do |name|
+    describe "#{name}=" do
+      it "responds_to" do
+        expect(easy).to respond_to("#{name}=")
+      end
+
+      it "sets option" do
+        Ethon::Easy.any_instance.should_receive(:set_callbacks)
+        Ethon::Curl.should_receive(:set_option).with do |option, _, _|
+          expect(option).to be(name)
+        end
+        value = case name
+        when :http_version
+          :httpv1_0
+        when :httpauth
+          :basic
+        when :protocols, :redir_protocols
+          :http
+        when :postredir
+          :post_301
+        when :proxytype
+          :http
+        when :sslversion
+          :default
+        when :httppost
+          FFI::Pointer::NULL
+        else
+          1
+        end
+        easy.method("#{name}=").call(value)
+      end
+    end
+  end
+
+  describe "#httppost=" do
+    it "raises unless given a FFI::Pointer" do
+      expect{ easy.httppost = 1 }.to raise_error(Ethon::Errors::InvalidValue)
+    end
+  end
+
+  context "when requesting" do
+    let(:url) { "localhost:3001" }
+    let(:timeout) { nil }
+    let(:timeout_ms) { nil }
+    let(:connecttimeout) { nil }
+    let(:connecttimeout_ms) { nil }
+    let(:userpwd) { nil }
+
+    before do
+      easy.url = url
+      easy.timeout = timeout
+      easy.timeout_ms = timeout_ms
+      easy.connecttimeout = connecttimeout
+      easy.connecttimeout_ms = connecttimeout_ms
+      easy.userpwd = userpwd
+      easy.perform
+    end
+
+    context "when userpwd" do
+      context "when contains /" do
+        let(:url) { "localhost:3001/auth_basic/test/te%2Fst" }
+        let(:userpwd) { "test:te/st" }
+
+        it "works" do
+          expect(easy.response_code).to eq(200)
+        end
+      end
+    end
+
+    context "when timeout" do
+      let(:timeout) { 1 }
+
+      context "when request takes longer" do
+        let(:url) { "localhost:3001?delay=2" }
+
+        it "times out" do
+          expect(easy.return_code).to eq(:operation_timedout)
+        end
+      end
+    end
+
+    context "when connecttimeout" do
+      let(:connecttimeout) { 1 }
+
+      context "when cannot connect" do
+        let(:url) { "localhost:3002" }
+
+        it "times out" do
+          expect(easy.return_code).to eq(:couldnt_connect)
+        end
+      end
+    end
+
+    if Ethon::Curl.version.match("c-ares")
+      context "when timeout_ms" do
+        let(:timeout_ms) { 900 }
+
+        context "when request takes longer" do
+          let(:url) { "localhost:3001?delay=1" }
+
+          it "times out" do
+            expect(easy.return_code).to eq(:operation_timedout)
+          end
+        end
+      end
+
+      context "when connecttimeout_ms" do
+        let(:connecttimeout_ms) { 1 }
+
+        context "when cannot connect" do
+          let(:url) { "localhost:3002" }
+
+          it "times out" do
+            expect(easy.return_code).to eq(:couldnt_connect)
+          end
+        end
+      end
+    end
+  end
+end

data/spec/ethon/easy/queryable_spec.rb

@@ -0,0 +1,188 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe Ethon::Easy::Queryable do
+  let(:hash) { {} }
+  let!(:easy) { Ethon::Easy.new }
+  let(:params) { Ethon::Easy::Params.new(easy, hash) }
+
+  describe "#to_s" do
+    context "when query_pairs empty" do
+      before { params.instance_variable_set(:@query_pairs, []) }
+
+      it "returns empty string" do
+        expect(params.to_s).to eq("")
+      end
+    end
+
+    context "when query_pairs not empty" do
+      context "when escape" do
+        before do
+          params.escape = true
+        end
+
+        {
+          '!' => '%21', '*' => '%2A', "'" => '%27', '(' => '%28',
+          ')'  => '%29', ';' => '%3B', ':' => '%3A', '@' => '%40',
+          '&' => '%26', '=' => '%3D', '+' => '%2B', '$' => '%24',
+          ',' => '%2C', '/' => '%2F', '?' => '%3F', '#' => '%23',
+          '[' => '%5B', ']' => '%5D',
+
+          '<' => '%3C', '>' => '%3E', '"' => '%22', '{' => '%7B',
+          '}' => '%7D', '|' => '%7C', '\\' => '%5C', '`' => '%60',
+          '^' => '%5E', '%' => '%25', ' ' => '%20', "\0" => '%00',
+
+          'まつもと' => '%E3%81%BE%E3%81%A4%E3%82%82%E3%81%A8',
+        }.each do |value, percent|
+          it "turns #{value.inspect} into #{percent}" do
+            params.instance_variable_set(:@query_pairs, [[:a, value]])
+            expect(params.to_s).to eq("a=#{percent}")
+          end
+        end
+
+        {
+          '.' => '%2E', '-' => '%2D', '_' => '%5F', '~' => '%7E',
+        }.each do |value, percent|
+          it "leaves #{value.inspect} instead of turning into #{percent}" do
+            params.instance_variable_set(:@query_pairs, [[:a, value]])
+            expect(params.to_s).to eq("a=#{value}")
+          end
+        end
+      end
+
+      context "when no escape" do
+        before { params.instance_variable_set(:@query_pairs, [[:a, 1], [:b, 2]]) }
+
+        it "returns concatenated query string" do
+          expect(params.to_s).to eq("a=1&b=2")
+        end
+      end
+    end
+
+    context "when query_pairs contains a string" do
+      before { params.instance_variable_set(:@query_pairs, ["{a: 1}"]) }
+
+      it "returns correct string" do
+        expect(params.to_s).to eq("{a: 1}")
+      end
+    end
+  end
+
+  describe "#build_query_pairs" do
+    let(:pairs) { params.method(:build_query_pairs).call(hash) }
+
+    context "when params is empty" do
+      it "returns empty array" do
+        expect(pairs).to eq([])
+      end
+    end
+
+    context "when params is string" do
+      let(:hash) { "{a: 1}" }
+
+      it "wraps it in an array" do
+        expect(pairs).to eq([hash])
+      end
+    end
+
+    context "when params is simple hash" do
+      let(:hash) { {:a => 1, :b => 2} }
+
+      it "transforms" do
+        expect(pairs).to include([:a, 1])
+        expect(pairs).to include([:b, 2])
+      end
+    end
+
+    context "when params is a nested hash" do
+      let(:hash) { {:a => 1, :b => {:c => 2}} }
+
+      it "transforms" do
+        expect(pairs).to include([:a, 1])
+        expect(pairs).to include(["b[c]", 2])
+      end
+    end
+
+    context "when params contains an array" do
+      let(:hash) { {:a => 1, :b => [2, 3]} }
+
+      it "transforms" do
+        expect(pairs).to include([:a, 1])
+        expect(pairs).to include(["b[0]", 2])
+        expect(pairs).to include(["b[1]", 3])
+      end
+    end
+
+    context "when params contains something nested in an array" do
+      context "when string" do
+        let(:hash) { {:a => {:b => ["hello", "world"]}} }
+
+        it "transforms" do
+          expect(pairs).to eq([["a[b][0]", "hello"], ["a[b][1]", "world"]])
+        end
+      end
+
+      context "when hash" do
+        let(:hash) { {:a => {:b => [{:c =>1}, {:d => 2}]}} }
+
+        it "transforms" do
+          expect(pairs).to eq([["a[b][0][c]", 1], ["a[b][1][d]", 2]])
+        end
+      end
+
+      context "when file" do
+        let(:file) { Tempfile.new("fubar") }
+        let(:file_info) { params.method(:file_info).call(file) }
+        let(:hash) { {:a => {:b => [file]}} }
+
+        it "transforms" do
+          expect(pairs).to eq([["a[b][0]", file_info]])
+        end
+      end
+    end
+
+
+    context "when params contains file" do
+      let(:file) { Tempfile.new("fubar") }
+      let(:file_info) { params.method(:file_info).call(file) }
+      let(:hash) { {:a => 1, :b => file} }
+
+      it "transforms" do
+        expect(pairs).to include([:a, 1])
+        expect(pairs).to include([:b, file_info])
+      end
+    end
+
+    context "when params key contains a null byte" do
+      let(:hash) { {:a => "1\0" } }
+
+      it "preserves" do
+        expect(pairs).to eq([[:a, "1\0"]])
+      end
+    end
+
+    context "when params value contains a null byte" do
+      let(:hash) { {"a\0" => 1 } }
+
+      it "preserves" do
+        expect(pairs).to eq([["a\0", 1]])
+      end
+    end
+  end
+
+  describe "#empty?" do
+    context "when params empty" do
+      it "returns true" do
+        expect(params.empty?).to be_true
+      end
+    end
+
+    context "when params not empty" do
+      let(:hash) { {:a => 1} }
+
+      it "returns false" do
+        expect(params.empty?).to be_false
+      end
+    end
+  end
+end

data/spec/ethon/easy/response_callbacks_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+
+describe Ethon::Easy::ResponseCallbacks do
+  let(:easy) { Ethon::Easy.new }
+
+  describe "#on_complete" do
+    it "responds" do
+      expect(easy).to respond_to(:on_complete)
+    end
+
+    context "when no block given" do
+      it "returns @on_complete" do
+        expect(easy.on_complete).to eq([])
+      end
+    end
+
+    context "when block given" do
+      it "stores" do
+        easy.on_complete { p 1 }
+        expect(easy.instance_variable_get(:@on_complete)).to have(1).items
+      end
+    end
+
+    context "when multiple blocks given" do
+      it "stores" do
+        easy.on_complete { p 1 }
+        easy.on_complete { p 2 }
+        expect(easy.instance_variable_get(:@on_complete)).to have(2).items
+      end
+    end
+  end
+
+  describe "#complete" do
+    before do
+      easy.on_complete {|r| String.new(r.url) }
+    end
+
+    it "executes blocks and passes self" do
+      String.should_receive(:new).with(easy.url)
+      easy.complete
+    end
+
+    context "when @on_complete nil" do
+      it "doesn't raise" do
+        easy.instance_variable_set(:@on_complete, nil)
+        expect{ easy.complete }.to_not raise_error(NoMethodError)
+      end
+    end
+  end
+end

data/spec/ethon/easy/util_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe Ethon::Easy::Util do
+  class Dummy
+    include Ethon::Easy::Util
+  end
+
+  let(:klass) { Dummy.new }
+
+  describe "escape_zero_byte" do
+    context "when value has no zero byte" do
+      let(:value) { "hello world" }
+
+      it "returns same value" do
+        expect(klass.escape_zero_byte(value)).to be(value)
+      end
+    end
+
+    context "when value has zero byte" do
+      let(:value) { "hello \0world" }
+
+      it "returns escaped" do
+        expect(klass.escape_zero_byte(value)).to eq("hello \\0world")
+      end
+    end
+  end
+end

data/spec/ethon/easy_spec.rb

@@ -0,0 +1,105 @@
+require 'spec_helper'
+
+describe Ethon::Easy do
+  let(:easy) { Ethon::Easy.new }
+
+  describe ".new" do
+    it "inits curl" do
+      Ethon::Curl.should_receive(:init)
+      easy
+    end
+
+    context "when options are empty" do
+      it "sets only callbacks" do
+        Ethon::Easy.any_instance.should_receive(:set_callbacks)
+        Ethon::Easy.should_receive(:set_option).never
+        easy
+      end
+    end
+
+    context "when options not empty" do
+      context "when followlocation is set" do
+        let(:options) { { :followlocation => true } }
+        let(:easy) { Ethon::Easy.new(options) }
+
+        it "sets followlocation" do
+          Ethon::Easy.any_instance.should_receive(:set_callbacks)
+          Ethon::Curl.should_receive(:set_option).with do |option, value, _|
+            expect(option).to be(:followlocation)
+            expect(value).to be(true)
+          end
+          easy
+        end
+      end
+    end
+  end
+
+  describe "#set_attributes" do
+    context "when options are empty" do
+      it "sets only callbacks" do
+        Ethon::Easy.any_instance.should_receive(:set_callbacks)
+        Ethon::Easy.should_receive(:set_option).never
+        easy
+      end
+    end
+
+    context "when options aren't empty" do
+      context "when valid key" do
+        it "sets" do
+          easy.should_receive(:verbose=).with(true)
+          easy.set_attributes({:verbose => true})
+        end
+      end
+
+      context "when invalid key" do
+        it "raises invalid option error" do
+          expect{ easy.set_attributes({:fubar => 1}) }.to raise_error(Ethon::Errors::InvalidOption)
+        end
+      end
+    end
+  end
+
+  describe "#reset" do
+    before { easy.url = "www.example.com" }
+
+    it "resets url" do
+      easy.reset
+      expect(easy.url).to be_nil
+    end
+
+    it "resets hash" do
+      easy.reset
+      expect(easy.instance_variable_get(:@hash)).to be_nil
+    end
+
+    it "resets easy handle" do
+      Ethon::Curl.should_receive(:easy_reset)
+      easy.reset
+    end
+
+    it "resets on_complete" do
+      easy.on_complete { p 1 }
+      easy.reset
+      expect(easy.on_complete).to be_empty
+    end
+  end
+
+  describe "#mirror" do
+    it "returns a Mirror" do
+      expect(easy.mirror).to be_a(Ethon::Easy::Mirror)
+    end
+
+    it "builds from easy" do
+      Ethon::Easy::Mirror.should_receive(:from_easy).with(easy)
+      easy.mirror
+    end
+  end
+
+  describe "#log_inspect" do
+    [ :url, :response_code, :return_code, :total_time ].each do |name|
+      it "contains #{name}" do
+        expect(easy.log_inspect).to match name.to_s
+      end
+    end
+  end
+end