typhoeus 0.2.0 → 0.2.4

data/spec/typhoeus/easy_spec.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/../spec_helper'
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 
 describe Typhoeus::Easy do
   describe "#supports_zlib" do
@@ -17,6 +17,42 @@ describe Typhoeus::Easy do
     end
   end
 
+  describe "curl errors" do
+    it "should provide the CURLE_OPERATION_TIMEDOUT return code when a request times out" do
+      e = Typhoeus::Easy.new
+      e.url = "http://localhost:3001/?delay=1"
+      e.method = :get
+      e.timeout = 100
+      e.perform
+      e.curl_return_code.should == 28
+      e.curl_error_message.should == "Timeout was reached"
+      e.response_code.should == 0
+    end
+
+    it "should provide the CURLE_COULDNT_CONNECT return code when trying to connect to a non existent port" do
+      e = Typhoeus::Easy.new
+      e.url = "http://localhost:3999"
+      e.method = :get
+      e.connect_timeout = 100
+      e.perform
+      e.curl_return_code.should == 7
+      e.curl_error_message.should == "Couldn't connect to server"
+      e.response_code.should == 0
+    end
+
+    it "should not return an error message on a successful easy operation" do
+      easy = Typhoeus::Easy.new
+      easy.url    = "http://localhost:3002"
+      easy.method = :get
+      easy.curl_error_message.should == nil
+      easy.perform
+      easy.response_code.should == 200
+      easy.curl_return_code.should == 0
+      easy.curl_error_message.should == "No error"
+    end
+
+  end
+
   describe "options" do
     it "should not follow redirects if not instructed to" do
       e = Typhoeus::Easy.new
@@ -48,12 +84,11 @@ describe Typhoeus::Easy do
 
     it "should provide a timeout in milliseconds" do
       e = Typhoeus::Easy.new
-      e.url = "http://localhost:3001"
+      e.url = "http://localhost:3001/?delay=1"
       e.method = :get
-      e.timeout = 50
+      e.timeout = 10
       e.perform
-      # this doesn't work on a mac for some reason
-#      e.timed_out?.should == true
+      e.timed_out?.should == true
     end
 
     it "should allow the setting of the max redirects to follow" do
@@ -156,7 +191,7 @@ describe Typhoeus::Easy do
         :username => ['dbalatero', 'dbalatero2']
       }
       
-      easy.url.should =~ /\?.*username=dbalatero&username=dbalatero2/
+      easy.url.should =~ /\?.*username%5B%5D=dbalatero&username%5B%5D=dbalatero2/
     end
   end
 
@@ -209,7 +244,39 @@ describe Typhoeus::Easy do
       easy.params = {:foo => "bar"}
       easy.perform
       easy.response_code.should == 200
-      easy.response_body.should include("foo=bar")
+      easy.response_body.should =~ /foo=bar/
+    end
+
+    it "should use Content-Type: application/x-www-form-urlencoded for normal posts" do
+      easy = Typhoeus::Easy.new
+      easy.url = "http://localhost:3002/normal_post"
+      easy.method = :post
+      easy.params = { :a => 'b', :c => 'd',
+                      :e => { :f => { :g => 'h' } } }
+      easy.perform
+
+      request = JSON.parse(easy.response_body)
+      request['CONTENT_TYPE'].should == 'application/x-www-form-urlencoded' 
+      request['rack.request.form_vars'].should == 'a=b&c=d&e%5Bf%5D%5Bg%5D=h'
+    end
+
+    it "should handle a file upload, as multipart" do
+      easy = Typhoeus::Easy.new
+      easy.url    = "http://localhost:3002/file"
+      easy.method = :post
+      easy.params = {:file => File.open(File.expand_path(File.dirname(__FILE__) + "/../fixtures/placeholder.txt"), "r")}
+      easy.perform
+      easy.response_code.should == 200
+      result = JSON.parse(easy.response_body)
+      
+      { 'content-type' => 'text/plain',
+        'filename' => 'placeholder.txt',
+        'content' => 'This file is used to test uploading.'
+      }.each do |key, val|
+        result[key].should == val
+      end
+
+      result['request-content-type'].should =~ /multipart/
     end
   end
   

data/spec/typhoeus/filter_spec.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/../spec_helper'
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 
 describe Typhoeus::Filter do
   it "should take a method name and optionally take options" do
@@ -32,4 +32,4 @@ describe Typhoeus::Filter do
       filter.apply_filter?(:foo).should be_false
     end
   end
-end
+end

data/spec/typhoeus/form_spec.rb

@@ -0,0 +1,107 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Typhoeus::Form do
+  describe "#process!" do
+    it "should generate a valid form object" do
+      form = Typhoeus::Form.new({
+        :name => "John Smith",
+        :age => "29"
+      })
+      form.should_receive(:formadd_param).with("name", "John Smith")
+      form.should_receive(:formadd_param).with("age", "29")
+      form.process!
+    end
+
+    it "should handle params that are a hash" do
+      form = Typhoeus::Form.new({
+        :attributes => {
+          :eyes => "brown",
+          :hair => "green",
+          :teeth => "white"
+        },
+        :name => "John Smith",
+        :age => "29"
+      })
+      form.should_receive(:formadd_param).with("attributes[eyes]", "brown")
+      form.should_receive(:formadd_param).with("attributes[hair]", "green")
+      form.should_receive(:formadd_param).with("attributes[teeth]", "white")
+      form.should_receive(:formadd_param).with("name", "John Smith")
+      form.should_receive(:formadd_param).with("age", "29")
+      form.process!
+    end
+
+    it "should params that have mutliple values" do
+      form = Typhoeus::Form.new({
+        :colors => ["brown", "green", "white"],
+        :name => "John Smith",
+        :age => "29"
+      })
+      form.should_receive(:formadd_param).with("colors[]", "brown")
+      form.should_receive(:formadd_param).with("colors[]", "green")
+      form.should_receive(:formadd_param).with("colors[]", "white")
+      form.should_receive(:formadd_param).with("name", "John Smith")
+      form.should_receive(:formadd_param).with("age", "29")
+      form.process!
+    end
+
+    context "when a File object is a param" do
+      it "should handle one file" do
+        form = Typhoeus::Form.new(
+          :file => File.open(File.expand_path(File.dirname(__FILE__) + "/../fixtures/placeholder.txt"), "r")
+        )
+        form.should_receive(:formadd_file).with("file", "placeholder.txt", "text/plain", anything)
+        form.process!
+      end
+
+      it "should handle more than one file" do
+        form = Typhoeus::Form.new(
+          :text_file => File.open(File.expand_path(File.dirname(__FILE__) + "/../fixtures/placeholder.txt"), "r"),
+          :gif_file => File.open(File.expand_path(File.dirname(__FILE__) + "/../fixtures/placeholder.gif"), "r")
+        )
+        form.should_receive(:formadd_file).with("gif_file", "placeholder.gif", "image/gif", anything)
+        form.should_receive(:formadd_file).with("text_file", "placeholder.txt", "text/plain", anything)
+        form.process!
+      end
+      it "should default to 'application/octet-stream' if no content type can be determined" do
+        pending
+        form = Typhoeus::Form.new(
+          :file => File.open(File.expand_path(File.dirname(__FILE__) + "/../fixtures/placeholder.txt"), "r")
+        )
+        form.should_receive(:formadd_file).with("file", "placeholder.ukn", "application/octet-stream", anything)
+        form.process!
+      end
+    end
+  end
+
+  describe "#to_s" do
+    it "should generate a valid query string" do
+      form = Typhoeus::Form.new({
+        :name => "John Smith",
+        :age => "29"
+      })
+      form.to_s.should == "age=29&name=John+Smith"
+    end
+
+    it "should handle params that are a hash" do
+      form = Typhoeus::Form.new({
+        :attributes => {
+          :eyes => "brown",
+          :hair => "green",
+          :teeth => "white"
+        },
+        :name => "John Smith",
+        :age => "29"
+      })
+      form.to_s.should == "age=29&attributes%5Beyes%5D=brown&attributes%5Bhair%5D=green&attributes%5Bteeth%5D=white&name=John+Smith"
+    end
+
+    it "should params that have mutliple values" do
+      form = Typhoeus::Form.new({
+        :colors => ["brown", "green", "white"],
+        :name => "John Smith",
+        :age => "29"
+      })
+      form.to_s.should == "age=29&colors%5B%5D=brown&colors%5B%5D=green&colors%5B%5D=white&name=John+Smith"
+    end
+  end
+end

data/spec/typhoeus/hydra_mock_spec.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + "/../spec_helper"
+require File.expand_path(File.dirname(__FILE__) + "/../spec_helper")
 
 describe Typhoeus::HydraMock do
   it "should mark all responses as mocks" do

data/spec/typhoeus/hydra_spec.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/../spec_helper'
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 
 # some of these tests assume that you have some local services running.
 # ruby spec/servers/app.rb -p 3000
@@ -46,6 +46,47 @@ describe Typhoeus::Hydra do
     second.response.body.should include("second")
   end
 
+  it "should store the curl return codes on the reponses" do
+    hydra  = Typhoeus::Hydra.new
+    first  = Typhoeus::Request.new("http://localhost:3001/?delay=1", :timeout => 100)
+    second = Typhoeus::Request.new("http://localhost:3999", :connect_timout => 100)
+    hydra.queue first
+    hydra.queue second
+    hydra.run
+    first.response.curl_return_code == 28
+    second.response.curl_return_code == 7
+  end
+
+  it "aborts a batch of requests" do
+    urls = [
+        'http://localhost:3000',
+        'http://localhost:3001',
+        'http://localhost:3002'
+    ]
+
+    # this will make testing easier
+    hydra     = Typhoeus::Hydra.new( :max_concurrency => 1 )
+    completed = 0
+
+    10.times {
+        |i|
+
+        req = Typhoeus::Request.new( urls[ i % urls.size], :params => { :cnt => i } )
+        req.on_complete {
+            |res|
+            completed += 1
+            hydra.abort if completed == 5
+        }
+
+        hydra.queue( req )
+    }
+
+    hydra.run
+
+    # technically this should be '== 6' but I don't trust it...
+    completed.should < 10
+  end
+
   it "has a cache_setter proc" do
     hydra = Typhoeus::Hydra.new
     hydra.cache_setter do |request|
@@ -390,37 +431,77 @@ describe Typhoeus::Hydra::ConnectOptions do
     @klass = Typhoeus::Hydra
   end
 
+  let!(:old_net_connect) { @klass.allow_net_connect }
+  let!(:old_ignore_localhost) { @klass.ignore_localhost }
+  let(:hydra) { @klass.new }
+
+  after(:each) do
+    @klass.allow_net_connect = old_net_connect
+    @klass.ignore_localhost = old_ignore_localhost
+  end
+
+  def request_for(host)
+    Typhoeus::Request.new("http://#{host}:3000")
+  end
+
   describe "#ignore_localhost" do
-    it "should allow localhost requests over the wire if true" do
-      begin
-        old_net_connect = @klass.allow_net_connect
-        old_ignore_localhost = @klass.ignore_localhost
+    context "when set to true" do
+      before(:each) { @klass.ignore_localhost = true }
+
+      [true, false].each do |val|
+        it "allows localhost requests when allow_net_connect is #{val}" do
+          @klass.allow_net_connect = val
+          expect { hydra.queue(request_for('localhost')) }.to_not raise_error
+        end
+      end
+    end
+
+    context "when set to false" do
+      before(:each) { @klass.ignore_localhost = false }
+
+      it "allows localhost requests when allow_net_connect is true" do
+        @klass.allow_net_connect = true
+        expect { hydra.queue(request_for('localhost')) }.to_not raise_error
+      end
+
+      it "does not allow localhost requests when allow_net_connect is false" do
         @klass.allow_net_connect = false
-        @klass.ignore_localhost = true
+        expect { hydra.queue(request_for('localhost')) }.to raise_error(Typhoeus::Hydra::NetConnectNotAllowedError)
+      end
+    end
+  end
 
-        req = Typhoeus::Request.new("http://localhost:3000")
-        hydra = @klass.new
+  describe "#ignore_hosts" do
+    context 'when allow_net_connect is set to false' do
+      before(:each) do
+        @klass.ignore_localhost = false
+        @klass.allow_net_connect = false
+      end
 
-        lambda {
-          hydra.queue(req)
-        }.should_not raise_error
-      ensure
-        @klass.allow_net_connect = old_net_connect
-        @klass.ignore_localhost = old_ignore_localhost
+      Typhoeus::Request::LOCALHOST_ALIASES.each do |disallowed_host|
+        ignore_hosts = Typhoeus::Request::LOCALHOST_ALIASES - [disallowed_host]
+
+        context "when set to #{ignore_hosts.join(' and ')}" do
+          before(:each) { @klass.ignore_hosts = ignore_hosts }
+
+          it "does not allow a request to #{disallowed_host}" do
+            expect { hydra.queue(request_for(disallowed_host)) }.to raise_error(Typhoeus::Hydra::NetConnectNotAllowedError)
+          end
+
+          ignore_hosts.each do |host|
+            it "allows a request to #{host}" do
+              expect { hydra.queue(request_for(host)) }.to_not raise_error
+            end
+          end
+        end
       end
     end
   end
 
   describe "#allow_net_connect" do
     it "should be settable" do
-      begin
-        # make sure to not mess up other specs.
-        old = @klass.allow_net_connect
-        @klass.allow_net_connect = true
-        @klass.allow_net_connect.should be_true
-      ensure
-        @klass.allow_net_connect = old
-      end
+      @klass.allow_net_connect = true
+      @klass.allow_net_connect.should be_true
     end
 
     it "should default to true" do
@@ -428,23 +509,12 @@ describe Typhoeus::Hydra::ConnectOptions do
     end
 
     it "should raise an error if we queue a request while its false" do
-      begin
-        request = Typhoeus::Request.new("http://localhost:3000")
-        old_net_connect = @klass.allow_net_connect
-        old_ignore_localhost = @klass.ignore_localhost
+      @klass.allow_net_connect = false
+      @klass.ignore_localhost = false
 
-        @klass.allow_net_connect = false
-        @klass.ignore_localhost = false
-
-        hydra = Typhoeus::Hydra.new
-
-        lambda {
-          hydra.queue(request)
-        }.should raise_error(Typhoeus::Hydra::NetConnectNotAllowedError)
-      ensure
-        @klass.allow_net_connect = old_net_connect
-        @klass.ignore_localhost = old_ignore_localhost
-      end
+      expect {
+        hydra.queue(request_for('example.com'))
+      }.to raise_error(Typhoeus::Hydra::NetConnectNotAllowedError)
     end
   end
 

data/spec/typhoeus/multi_spec.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/../spec_helper'
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 
 describe Typhoeus::Easy do
   it "should save easy handles that get added" do

data/spec/typhoeus/normalized_header_hash_spec.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + "/../spec_helper"
+require File.expand_path(File.dirname(__FILE__) + "/../spec_helper")
 
 describe Typhoeus::NormalizedHeaderHash do
   before(:all) do

data/spec/typhoeus/remote_method_spec.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/../spec_helper'
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 
 describe Typhoeus::RemoteMethod do
   it "should take options" do
@@ -138,4 +138,4 @@ describe Typhoeus::RemoteMethod do
       Typhoeus::RemoteMethod.new(:cache_responses => 30).cache_ttl.should == 30
     end
   end
-end
+end

data/spec/typhoeus/remote_proxy_object_spec.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/../spec_helper'
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 
 describe Typhoeus::RemoteProxyObject do
   before(:each) do

data/spec/typhoeus/remote_spec.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/../spec_helper'
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 
 describe Typhoeus do
   it "should be deprecated" do

data/spec/typhoeus/request_spec.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/../spec_helper'
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 
 describe Typhoeus::Request do
   describe "#inspect" do
@@ -25,7 +25,7 @@ describe Typhoeus::Request do
     it "should dump the method" do
       @request.inspect.should =~ /:get/
     end
-    
+
     it "should dump out headers" do
       @request.inspect.should =~ /"Content-Type"\s*=>\s*"text\/html"/
     end
@@ -74,7 +74,23 @@ describe Typhoeus::Request do
                                       :params => {
                                         :a => ['789','2434']
                                       })
-      request.params_string.should == "a[]=789&a[]=2434"
+      request.params_string.should == "a%5B%5D=789&a%5B%5D=2434"
+    end
+
+    it "should nest arrays in hashes" do
+      request = Typhoeus::Request.new('http://google.com',
+                                      :params => {
+                                        :a => { :b => { :c => ['d','e'] } }
+                                      })
+      request.params_string.should == "a%5Bb%5D%5Bc%5D%5B%5D=d&a%5Bb%5D%5Bc%5D%5B%5D=e"
+    end
+
+    it "should translate nested params correctly" do
+      request = Typhoeus::Request.new('http://google.com',
+                                      :params => {
+                                        :a => { :b => { :c => 'd' } }
+                                      })
+      request.params_string.should == "a%5Bb%5D%5Bc%5D=d"
     end
   end
 
@@ -86,11 +102,11 @@ describe Typhoeus::Request do
     end
 
     it "can run a POST synchronously" do
-      response = Typhoeus::Request.post("http://localhost:3000", :params => {:q => "hi"}, :headers => {:foo => "bar"})
+      response = Typhoeus::Request.post("http://localhost:3000", :params => {:q => { :a => "hi" } }, :headers => {:foo => "bar"})
       response.code.should == 200
       json = JSON.parse(response.body)
       json["REQUEST_METHOD"].should == "POST"
-      json["rack.request.query_hash"]["q"].should == "hi"
+      json["rack.request.query_hash"]["q"]["a"].should == "hi"
     end
 
     it "can run a PUT synchronously" do
@@ -213,6 +229,35 @@ describe Typhoeus::Request do
     good.should be_true
   end
 
+  describe "time info" do
+    it "should have time" do
+      response = Typhoeus::Request.get("http://localhost:3000")
+      response.time.should > 0
+    end
+
+    it "should have connect time" do
+      response = Typhoeus::Request.get("http://localhost:3000")
+      response.connect_time.should > 0
+    end
+
+    it "should have app connect time" do
+      response = Typhoeus::Request.get("http://localhost:3000")
+      response.app_connect_time.should  > 0
+    end
+
+    it "should have start transfer time" do
+      response = Typhoeus::Request.get("http://localhost:3000")
+      response.start_transfer_time.should  > 0
+    end
+
+    it "should have pre-transfer time" do
+      response = Typhoeus::Request.get("http://localhost:3000")
+      response.pretransfer_time.should  > 0
+    end
+
+  end
+
+
   describe "authentication" do
 
     it "should allow to set username and password" do

data/spec/typhoeus/response_spec.rb

@@ -1,6 +1,18 @@
-require File.dirname(__FILE__) + '/../spec_helper'
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 
 describe Typhoeus::Response do
+  describe "timed_out?" do
+    it "should return true if curl return code is 28" do
+      response = Typhoeus::Response.new(:curl_return_code => 28)
+      response.should be_timed_out
+    end
+
+    it "should return false for not 28" do
+      response = Typhoeus::Response.new(:curl_return_code => 14)
+      response.should_not be_timed_out
+    end
+  end
+
   describe "initialize" do
     it "should store headers_hash" do
       response = Typhoeus::Response.new(:headers_hash => {})

data/spec/typhoeus/utils_spec.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + "/../spec_helper"
+require File.expand_path(File.dirname(__FILE__) + "/../spec_helper")
 
 describe Typhoeus::Utils do
   # Taken from Rack 1.2.1