typhoeus 0.2.0 → 0.2.1

data/.gitignore

@@ -1,3 +1,4 @@
 .*.sw?
 *.gem
 .bundle
+.idea

data/CHANGELOG.markdown

@@ -1,5 +1,18 @@
+Current Master
+--------------
+* Added extended proxy support [Zapotek, GH-46]
+* eliminated compile time warnings by using proper type declarations [skaes, GH-54]
+* fixed broken calls to rb_raise [skaes, GH-54]
+* prevent leaking of curl easy handles when exceptions are raised (either from typhoeus itself or user callbacks) [skaes, GH-54]
+* fixed Easy#timed_out? using curl return codes [skaes, GH-54]
+* provide curl return codes and corresponding curl error messages on classes Easy and Request [skaes, GH-54]
+* allow VCR to whitelist hosts in Typhoeus stubbing/mocking [myronmarston, GH-57]
+* added timed_out? documentation, method to Response [dbalatero, GH-34]
+* added abort to Hydra to prematurely stop a hydra.run [Zapotek]
+* added file upload support for POST requests [jtarchie, GH-59]
+
 0.2.0
-------------
+------
 * Fix warning in Request#headers from attr_accessor
 * Params with array values were not parsing into the format that rack expects
 [GH-39, smartocci]

data/Gemfile

@@ -1,5 +1,7 @@
 source :rubygems
 
+gem "mime-types"
+
 group :test do
   gem 'rspec', '1.3.1'
   gem 'jeweler'

data/Gemfile.lock

@@ -10,6 +10,7 @@ GEM
       rubyforge (>= 2.0.0)
     json (1.4.6)
     json_pure (1.4.6)
+    mime-types (1.16)
     rack (1.2.1)
     rspec (1.3.1)
     rubyforge (2.0.4)
@@ -26,5 +27,6 @@ DEPENDENCIES
   diff-lcs
   jeweler
   json
+  mime-types
   rspec (= 1.3.1)
   sinatra

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 David Balatero
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.textile

@@ -18,7 +18,7 @@ h2. Installation
 
 Typhoeus requires you to have a current version of libcurl installed. I've tested this with 7.19.4 and higher.
 <pre>
-gem install typhoeus --source http://gemcutter.org
+gem install typhoeus
 </pre>
 If you're on Debian or Ubuntu and getting errors while trying to install, it could be because you don't have the latest version of libcurl installed. Do this to fix:
 <pre>
@@ -29,7 +29,7 @@ There's also something built in so that if you have a super old version of curl
 gem install typhoeus --source http://gemcutter.org -- --with-curl=/usr/local/curl/7.19.7/
 </pre>
 
-Another problem could be if you are running Mac Ports and you have libcurl installed through there. You need to uninstall it for Typhoeus to work! The version in Mac Ports is old and doesn't play nice. You should "download curl":http://curl.haxx.se/download.html and build from source. Then you'll have to install the gem again.
+-Another problem could be if you are running Mac Ports and you have libcurl installed through there. You need to uninstall it for Typhoeus to work! The version in Mac Ports is old and doesn't play nice. You should "download curl":http://curl.haxx.se/download.html and build from source. Then you'll have to install the gem again.- The current version of Mac Ports (7.21.2) works just fine.
 
 If you're still having issues, please let me know on "the mailing list":http://groups.google.com/group/typhoeus.
 
@@ -79,6 +79,18 @@ response = Typhoeus::Request.post("http://localhost:3000/posts", :params => {:ti
 response = Typhoeus::Request.delete("http://localhost:3000/posts/1")
 </pre>
 
+*Handling file uploads*
+A File object can be passed as a param for a POST request to handle uploading files to the server. Typhoeus will upload the file as the original file name and use Mime::Types to set the content type.
+
+<pre>
+response = Typhoeus::Request.post("http://localhost:3000/posts",
+  :params => {
+    :title => "test post", :content => "this is my test",
+    :file => File.open("thesis.txt","r")
+  }
+)
+</pre>
+
 *Making Parallel Requests*
 
 <pre>
@@ -149,7 +161,7 @@ hydra.cache_getter do |request|
 end
 </pre>
 
-*Stubbing*
+*Direct Stubbing*
 Hydra allows you to stub out specific urls and patters to avoid hitting remote servers while testing.
 
 <pre>
@@ -180,6 +192,15 @@ hydra = Typhoeus::Hydra.hydra
 hydra.stub(:get, "http://localhost:3000/users")
 </pre>
 
+*Timeouts*
+
+No exceptions are raised on HTTP timeouts. You can check whether a request timed out with the following methods:
+
+<pre>
+easy.timed_out?  # for a raw Easy handle
+response.timed_out?  # for a Response handle
+</pre>
+
 *Basic Authentication*
 
 <pre>
@@ -203,7 +224,9 @@ Typhoeus::Request.get("https://mail.google.com/mail", :disable_ssl_peer_verifica
 *LibCurl*
 Typhoeus also has a more raw libcurl interface. These are the Easy and Multi objects. If you're into accessing just the raw libcurl style, those are your best bet.
 
-SSL Certs can be provided to the Easy interface :
+However, by using this raw interface, you do not get access to Hydra-specific features, such as stubbing/mocking.
+
+SSL Certs can be provided to the Easy interface:
 
 <pre>
 e = Typhoeus::Easy.new
@@ -262,7 +285,7 @@ There's also an easy way to perform any kind of authentication via the quick req
 e = Typhoeus::Request.get("http://example.com",
   :username => 'username',
   :password => 'password',
-  :method => :ntlm)
+  :auth_method => :ntlm)
 </pre>
 
 All methods listed above is available in a shorter form - :basic, :digest, :gssnegotiate, :ntlm, :digest_ie, :auto.
@@ -300,6 +323,17 @@ I set up a benchmark to test how the parallel performance works vs Ruby's built
 
 We can see from this that NET::HTTP performs as expected, taking 10 seconds to run 20 500ms requests. Typhoeus only takes 500ms (the time of the response that took the longest.) One other thing to note is that Typhoeus keeps a pool of libcurl Easy handles to use. For this benchmark I warmed the pool first. So if you test this out it may be a bit slower until the Easy handle pool has enough in it to run all the simultaneous requests. For some reason the easy handles can take quite some time to allocate.
 
+h2. Running the specs
+
+Running the specs requires a couple of Sinatra servers to be booted. Do this:
+
+<pre>
+  ruby spec/servers/app.rb -p 3000
+  ruby spec/servers/app.rb -p 3001
+  ruby spec/servers/app.rb -p 3002
+  rake spec
+</pre>
+
 h2. Next Steps
 
 * Add in ability to keep-alive requests and reuse them within hydra.

data/Rakefile

@@ -1,6 +1,8 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
 require "spec"
 require "spec/rake/spectask"
-require 'lib/typhoeus.rb'
+require 'lib/typhoeus'
 
 begin
   require 'jeweler'
@@ -8,9 +10,10 @@ begin
     gemspec.name = "typhoeus"
     gemspec.summary = "A library for interacting with web services (and building SOAs) at blinding speed."
     gemspec.description = "Like a modern code version of the mythical beast with 100 serpent heads, Typhoeus runs HTTP requests in parallel while cleanly encapsulating handling logic."
-    gemspec.email = "paul@pauldix.net"
-    gemspec.homepage = "http://github.com/pauldix/typhoeus"
-    gemspec.authors = ["Paul Dix"]
+    gemspec.email = "dbalatero@gmail.com"
+    gemspec.homepage = "http://github.com/dbalatero/typhoeus"
+    gemspec.authors = ["Paul Dix", "David Balatero"]
+    gemspec.add_dependency "mime-types"
     gemspec.add_development_dependency "rspec"
     gemspec.add_development_dependency "jeweler"
     gemspec.add_development_dependency "diff-lcs"
@@ -31,7 +34,7 @@ end
 task :install do
   rm_rf "*.gem"
   puts `gem build typhoeus.gemspec`
-  puts `sudo gem install typhoeus-#{Typhoeus::VERSION}.gem`
+  puts `gem install typhoeus-#{Typhoeus::VERSION}.gem`
 end
 
 desc "Run all the tests"

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.2.1

data/examples/file.rb

@@ -0,0 +1,12 @@
+require 'rubygems'
+require File.dirname(__FILE__) + '/../lib/typhoeus.rb'
+
+
+response = Typhoeus::Request.post(
+  "http://video-feed.local",
+  :params => {
+    :file => File.new("file.rb")
+  }
+)
+
+puts response.inspect

data/examples/times.rb

@@ -0,0 +1,40 @@
+require File.dirname(__FILE__) + '/../lib/typhoeus.rb'
+
+hydra = Typhoeus::Hydra.new
+hydra.disable_memoization
+
+urls = [
+    'http://google.com',
+    'http://testphp.vulnweb.com',
+    'http://demo.testfire.net',
+    'http://example.net',
+]
+
+10.times {
+    |i|
+
+    req = Typhoeus::Request.new( urls[ i % urls.size] )
+    req.on_complete {
+        |res|
+        puts 'URL:     ' + res.effective_url
+        puts 'Time:    ' + res.time.to_s
+        puts 'Connect time: ' + res.connect_time.to_s
+        puts 'App connect time:    ' + res.app_connect_time.to_s
+        puts 'Start transfer time: ' + res.start_transfer_time.to_s
+        puts 'Pre transfer time:   ' + res.pretransfer_time.to_s
+        puts '-------------'
+    }
+
+    hydra.queue( req )
+    puts 'Queued: ' + req.url
+}
+
+puts
+puts 'Harvesting responses...'
+puts
+
+hydra.run
+
+puts
+puts 'Done.'
+puts

data/ext/typhoeus/.gitignore

@@ -2,5 +2,6 @@ conftest.dSYM/*
 conftest.dSYM
 mkmf.log
 *.o
-native.bundleMakefile
+native.bundle
+Makefile
 *.bundle

data/ext/typhoeus/native.c

@@ -8,4 +8,5 @@ void Init_native()
 
   init_typhoeus_easy();
   init_typhoeus_multi();
+  init_typhoeus_form();
 }

data/ext/typhoeus/native.h

@@ -10,6 +10,7 @@ void Init_native();
 extern VALUE mTyphoeus;
 extern void init_typhoeus_easy();
 extern void init_typhoeus_multi();
+extern void init_typhoeus_form();
 
 #endif
 

data/ext/typhoeus/typhoeus_easy.c

@@ -21,16 +21,27 @@ static VALUE easy_setopt_string(VALUE self, VALUE opt_name, VALUE parameter) {
   CurlEasy *curl_easy;
   Data_Get_Struct(self, CurlEasy, curl_easy);
 
-  long opt = NUM2LONG(opt_name);
+  CURLoption opt = NUM2LONG(opt_name);
   curl_easy_setopt(curl_easy->curl, opt, StringValuePtr(parameter));
   return opt_name;
 }
 
+static VALUE easy_setopt_form(VALUE self, VALUE opt_name, VALUE parameter) {
+  CurlEasy *curl_easy;
+  CurlForm *curl_form;
+  Data_Get_Struct(self, CurlEasy, curl_easy);
+  Data_Get_Struct(parameter, CurlForm, curl_form);
+
+  CURLoption opt = NUM2LONG(opt_name);
+  curl_easy_setopt(curl_easy->curl, opt, curl_form->first);
+  return opt_name;
+}
+
 static VALUE easy_setopt_long(VALUE self, VALUE opt_name, VALUE parameter) {
   CurlEasy *curl_easy;
   Data_Get_Struct(self, CurlEasy, curl_easy);
 
-  long opt = NUM2LONG(opt_name);
+  CURLoption opt = NUM2LONG(opt_name);
   curl_easy_setopt(curl_easy->curl, opt, NUM2LONG(parameter));
   return opt_name;
 }
@@ -40,7 +51,7 @@ static VALUE easy_getinfo_string(VALUE self, VALUE info) {
   CurlEasy *curl_easy;
   Data_Get_Struct(self, CurlEasy, curl_easy);
 
-  long opt = NUM2LONG(info);
+  CURLoption opt = NUM2LONG(info);
   curl_easy_getinfo(curl_easy->curl, opt, &info_string);
 
   return rb_str_new2(info_string);
@@ -51,7 +62,7 @@ static VALUE easy_getinfo_long(VALUE self, VALUE info) {
   CurlEasy *curl_easy;
   Data_Get_Struct(self, CurlEasy, curl_easy);
 
-  long opt = NUM2LONG(info);
+  CURLoption opt = NUM2LONG(info);
   curl_easy_getinfo(curl_easy->curl, opt, &info_long);
 
   return LONG2NUM(info_long);
@@ -62,7 +73,7 @@ static VALUE easy_getinfo_double(VALUE self, VALUE info) {
   CurlEasy *curl_easy;
   Data_Get_Struct(self, CurlEasy, curl_easy);
 
-  long opt = NUM2LONG(info);
+  CURLoption opt = NUM2LONG(info);
   curl_easy_getinfo(curl_easy->curl, opt, &info_double);
 
   return rb_float_new(info_double);
@@ -70,8 +81,10 @@ static VALUE easy_getinfo_double(VALUE self, VALUE info) {
 
 static VALUE easy_perform(VALUE self) {
   CurlEasy *curl_easy;
+  CURLcode return_code;
   Data_Get_Struct(self, CurlEasy, curl_easy);
-  curl_easy_perform(curl_easy->curl);
+  return_code = curl_easy_perform(curl_easy->curl);
+  rb_iv_set(self, "@curl_return_code", INT2FIX(return_code));
 
   return Qnil;
 }
@@ -166,7 +179,7 @@ static VALUE easy_escape(VALUE self, VALUE data, VALUE length) {
   CurlEasy *curl_easy;
   Data_Get_Struct(self, CurlEasy, curl_easy);
 
-  return rb_str_new2(curl_easy_escape(curl_easy->curl, StringValuePtr(data), NUM2INT(length)));
+  return rb_str_new2(curl_easy_escape(curl_easy->curl, StringValuePtr(data), (int)NUM2INT(length)));
 }
 
 static VALUE version(VALUE self) {
@@ -188,11 +201,23 @@ static VALUE new(int argc, VALUE *argv, VALUE klass) {
   return easy;
 }
 
+static VALUE curl_error_message(VALUE self) {
+  VALUE return_code = rb_iv_get(self, "@curl_return_code");
+  if (return_code == Qnil)
+    return Qnil;
+  else {
+    CURLcode rc = (CURLcode)FIX2INT(return_code);
+    return rb_str_new2(curl_easy_strerror(rc));
+  }
+}
+
 void init_typhoeus_easy() {
   VALUE klass = cTyphoeusEasy = rb_define_class_under(mTyphoeus, "Easy", rb_cObject);
   idAppend = rb_intern("<<");
   rb_define_singleton_method(klass, "new", new, -1);
+  rb_define_method(klass, "curl_error_message", curl_error_message, 0);
   rb_define_private_method(klass, "easy_setopt_string", easy_setopt_string, 2);
+  rb_define_private_method(klass, "easy_setopt_form", easy_setopt_form, 2);
   rb_define_private_method(klass, "easy_setopt_long", easy_setopt_long, 2);
   rb_define_private_method(klass, "easy_getinfo_string", easy_getinfo_string, 1);
   rb_define_private_method(klass, "easy_getinfo_long", easy_getinfo_long, 1);

data/ext/typhoeus/typhoeus_easy.h

@@ -2,6 +2,7 @@
 #define TYPHOEUS_EASY
 
 #include <native.h>
+#include <typhoeus_form.h>
 
 void init_typhoeus_easy();
 typedef struct {

data/ext/typhoeus/typhoeus_form.c

@@ -0,0 +1,59 @@
+#include <typhoeus_form.h>
+
+VALUE cTyphoeusForm;
+
+static void dealloc(CurlForm *curl_form) {
+  curl_formfree(curl_form->first);
+  free(curl_form);
+}
+
+static VALUE formadd_file(VALUE self,
+                         VALUE name,
+                         VALUE filename,
+                         VALUE content_type,
+                         VALUE path) {
+  CurlForm *curl_form;
+  Data_Get_Struct(self, CurlForm, curl_form);
+
+  return INT2NUM((long) curl_formadd(&curl_form->first, &curl_form->last,
+    CURLFORM_COPYNAME, RSTRING_PTR(name),
+    CURLFORM_NAMELENGTH, (long)RSTRING_LEN(name),
+    CURLFORM_FILENAME, RSTRING_PTR(filename),
+    CURLFORM_CONTENTTYPE, RSTRING_PTR(content_type),
+    CURLFORM_FILE, RSTRING_PTR(path),
+    CURLFORM_END
+  ));
+}
+
+static VALUE formadd_param(VALUE self, VALUE name, VALUE value) {
+  CurlForm *curl_form;
+  Data_Get_Struct(self, CurlForm, curl_form);
+
+  return INT2NUM((long)curl_formadd(&curl_form->first, &curl_form->last,
+    CURLFORM_COPYNAME, RSTRING_PTR(name),
+    CURLFORM_NAMELENGTH, (long)RSTRING_LEN(name),
+    CURLFORM_COPYCONTENTS, RSTRING_PTR(value),
+    CURLFORM_CONTENTSLENGTH, (long)RSTRING_LEN(value),
+    CURLFORM_END
+  ));
+}
+
+static VALUE new(int argc, VALUE *argv, VALUE klass) {
+  CurlForm *curl_form = ALLOC(CurlForm);
+  curl_form->first = NULL;
+  curl_form->last = NULL;
+
+  VALUE form = Data_Wrap_Struct(cTyphoeusForm, 0, dealloc, curl_form);
+
+  rb_obj_call_init(form, argc, argv);
+
+  return form;
+}
+
+void init_typhoeus_form() {
+  VALUE klass = cTyphoeusForm = rb_define_class_under(mTyphoeus, "Form", rb_cObject);
+
+  rb_define_singleton_method(klass, "new", new, -1);
+  rb_define_private_method(klass, "formadd_file", formadd_file, 4);
+  rb_define_private_method(klass, "formadd_param", formadd_param, 2);
+}