brianmario-streamly 0.1.1

data/.gitignore

@@ -0,0 +1,3 @@
+*.bundle
+*.o
+Makefile

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# Changelog
+
+## 0.1.1 (July 27th, 2009)
+* Version bump for Github's gem builder
+
+## 0.1.0 (July 27th, 2009)
+* Initial release

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008-2009 Brian Lopez - http://github.com/brianmario
+ 
+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.rdoc

@@ -0,0 +1,62 @@
+= A streaming REST client for Ruby that uses libcurl
+
+== Features
+* rest-client like API
+* Streaming API allows the caller to be handed chunks of the response while it's being received
+
+== How to install
+
+Install it like any other gem hosted at the Githubs like so:
+
+(more instructions here: http://gems.github.com)
+
+ sudo gem install brianmario-streamly
+
+== Example of use
+
+=== A basic GET request
+
+ Streamly.get('www.somehost.com')
+
+=== A streaming GET request
+
+ Streamly.get('www.somehost.com') do |chunk|
+   # do something with _chunk_
+ end
+
+=== A basic POST request
+
+ Streamly.post('www.somehost.com', 'blah=foo')
+
+=== A streaming POST request
+
+ Streamly.post('www.somehost.com', 'blah=foo') do |chunk|
+   # do something with _chunk_
+ end
+
+== Benchmarks
+
+Fetching 2,405,005 bytes of JSON from a local lighttpd server
+
+* Streamly: 0.011s
+* Shell out to curl: 0.046s
+* rest-client: 0.205s
+
+Streaming, and parsing 2,405,005 bytes of JSON from a local lighttpd server
+
+* Streamly: 0.231s
+* Shell out to curl: 0.341s
+* rest-client: 0.447s
+
+== Special Thanks
+
+There are quite a few *extremely* nice REST client libraries out there for Ruby today. I especially owe thanks
+to the following projects. Without them I probably would have never had the inspiration to even take the time
+to write this library. In Streamly, you'll find snippets of code, API patterns and examples from all 3 of these projects.
+I'll do my best to make sure I give credit where it's due *in* the source. Please let me know if I've missed something!
+
+* rest-client - https://github.com/adamwiggins/rest-client
+* curb - https://github.com/taf2/curb
+* patron - https://github.com/toland/patron
+
+And again, the Github crew for this amazing service!

data/Rakefile

@@ -0,0 +1,35 @@
+# encoding: UTF-8
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "streamly"
+    gem.summary = "A streaming REST client for Ruby, in C."
+    gem.email = "seniorlopez@gmail.com"
+    gem.homepage = "http://github.com/brianmario/streamly"
+    gem.authors = ["Brian Lopez"]
+    gem.require_paths = ["lib", "ext"]
+    gem.extra_rdoc_files = `git ls-files *.rdoc`.split("\n")
+    gem.files = `git ls-files`.split("\n")
+    gem.extensions = ["ext/extconf.rb"]
+    gem.files.include %w(lib/jeweler/templates/.document lib/jeweler/templates/.gitignore)
+    gem.rubyforge_project = "streamly"
+  end
+rescue LoadError
+  puts "Jeweler, or one of its dependencies, is not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+require 'rake'
+require 'spec/rake/spectask'
+
+desc "Run all examples with RCov"
+Spec::Rake::SpecTask.new('spec:rcov') do |t|
+  t.spec_files = FileList['spec/']
+  t.rcov = true
+  t.rcov_opts = lambda do
+    IO.readlines("spec/rcov.opts").map {|l| l.chomp.split " "}.flatten
+  end
+end
+Spec::Rake::SpecTask.new('spec') do |t|
+  t.spec_files = FileList['spec/']
+  t.spec_opts << '--options' << 'spec/spec.opts'
+end

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:minor: 1
+:patch: 1
+:major: 0

data/benchmark/basic_request.rb

@@ -0,0 +1,33 @@
+# encoding: UTF-8
+$LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__) + '/../lib')
+
+require 'rubygems'
+require 'net/http'
+require 'rest_client'
+require 'streamly'
+require 'benchmark'
+
+url = ARGV[0]
+
+Benchmark.bm do |x|
+  puts "Shell out to curl"
+  x.report do
+    (ARGV[1] || 1).to_i.times do
+      `curl -s --compressed #{url}`
+    end
+  end
+  
+  puts "Streamly"
+  x.report do
+    (ARGV[1] || 1).to_i.times do
+      Streamly.get(url)
+    end
+  end
+  
+  puts "rest-client"
+  x.report do
+    (ARGV[1] || 1).to_i.times do
+      RestClient.get(url, {"Accept-Encoding" => "identity, deflate, gzip"})
+    end
+  end
+end

data/benchmark/streaming_json_request.rb

@@ -0,0 +1,40 @@
+# encoding: UTF-8
+$LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__) + '/../lib')
+
+require 'rubygems'
+require 'net/http'
+require 'rest_client'
+require 'streamly'
+require 'yajl'
+require 'benchmark'
+
+url = ARGV[0]
+
+Benchmark.bm do |x|
+  puts "Shell out to curl"
+  parser = Yajl::Parser.new
+  x.report do
+    (ARGV[1] || 1).to_i.times do
+      parser.parse `curl -s --compressed #{url}`
+    end
+  end
+  
+  puts "Streamly"
+  parser = Yajl::Parser.new
+  parser.on_parse_complete = lambda {|obj| }
+  x.report do
+    (ARGV[1] || 1).to_i.times do
+      Streamly.get(url) do |chunk|
+        parser << chunk
+      end
+    end
+  end
+  
+  puts "rest-client"
+  parser = Yajl::Parser.new
+  x.report do
+    (ARGV[1] || 1).to_i.times do
+      parser.parse RestClient.get(url, {"Accept-Encoding" => "identity, deflate, gzip"})
+    end
+  end
+end

data/examples/basic/delete.rb

@@ -0,0 +1,9 @@
+# encoding: UTF-8
+$LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__) + '/../../lib')
+
+require 'streamly'
+
+raise Exception, "You must pass a URL to request" if ARGV[0].nil?
+
+url = ARGV[0]
+puts Streamly.delete(url)

data/examples/basic/get.rb

@@ -0,0 +1,9 @@
+# encoding: UTF-8
+$LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__) + '/../../lib')
+
+require 'streamly'
+
+raise Exception, "You must pass a URL to request" if ARGV[0].nil?
+
+url = ARGV[0]
+puts Streamly.get(url)

data/examples/basic/head.rb

@@ -0,0 +1,9 @@
+# encoding: UTF-8
+$LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__) + '/../../lib')
+
+require 'streamly'
+
+raise Exception, "You must pass a URL to request" if ARGV[0].nil?
+
+url = ARGV[0]
+puts Streamly.head(url)

data/examples/basic/post.rb

@@ -0,0 +1,11 @@
+# encoding: UTF-8
+$LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__) + '/../../lib')
+
+require 'streamly'
+
+raise Exception, "You must pass a URL to request" if ARGV[0].nil?
+raise Exception, "You must pass a payload to POST" if ARGV[1].nil?
+
+url = ARGV[0]
+payload = ARGV[1]
+puts Streamly.post(url, payload)

data/examples/basic/put.rb

@@ -0,0 +1,11 @@
+# encoding: UTF-8
+$LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__) + '/../../lib')
+
+require 'streamly'
+
+raise Exception, "You must pass a URL to request" if ARGV[0].nil?
+raise Exception, "You must pass a payload to PUT" if ARGV[1].nil?
+
+url = ARGV[0]
+payload = ARGV[1]
+puts Streamly.put(url, payload)

data/examples/streaming/delete.rb

@@ -0,0 +1,13 @@
+# encoding: UTF-8
+$LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__) + '/../../lib')
+
+require 'streamly'
+
+raise Exception, "You must pass a URL to request" if ARGV[0].nil?
+
+url = ARGV[0]
+Streamly.delete(url) do |chunk|
+  STDOUT.write chunk
+  STDOUT.flush
+end
+puts

data/examples/streaming/get.rb

@@ -0,0 +1,13 @@
+# encoding: UTF-8
+$LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__) + '/../../lib')
+
+require 'streamly'
+
+raise Exception, "You must pass a URL to request" if ARGV[0].nil?
+
+url = ARGV[0]
+Streamly.get(url) do |chunk|
+  STDOUT.write chunk
+  STDOUT.flush
+end
+puts

data/examples/streaming/head.rb

@@ -0,0 +1,13 @@
+# encoding: UTF-8
+$LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__) + '/../../lib')
+
+require 'streamly'
+
+raise Exception, "You must pass a URL to request" if ARGV[0].nil?
+
+url = ARGV[0]
+Streamly.head(url) do |chunk|
+  STDOUT.write chunk
+  STDOUT.flush
+end
+puts

data/examples/streaming/post.rb

@@ -0,0 +1,15 @@
+# encoding: UTF-8
+$LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__) + '/../../lib')
+
+require 'streamly'
+
+raise Exception, "You must pass a URL to request" if ARGV[0].nil?
+raise Exception, "You must pass a payload to POST" if ARGV[1].nil?
+
+url = ARGV[0]
+payload = ARGV[1]
+Streamly.post(url, payload) do |chunk|
+  STDOUT.write chunk
+  STDOUT.flush
+end
+puts

data/examples/streaming/put.rb

@@ -0,0 +1,16 @@
+# encoding: UTF-8
+$LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__) + '/../../lib')
+
+require 'streamly'
+
+raise Exception, "You must pass a URL to request" if ARGV[0].nil?
+raise Exception, "You must pass a payload to PUT" if ARGV[1].nil?
+
+url = ARGV[0]
+payload = ARGV[1]
+resp = ''
+Streamly.put(url, payload) do |chunk|
+  STDOUT.write chunk
+  STDOUT.flush
+end
+puts

data/ext/extconf.rb

@@ -0,0 +1,25 @@
+# encoding: UTF-8
+require 'mkmf'
+require 'rbconfig'
+
+$CFLAGS << ' -DHAVE_RBTRAP' if have_var('rb_trap_immediate', ['ruby.h', 'rubysig.h'])
+# add_define 'HAVE_RBTRAP' if have_var('rb_trap_immediate', ['ruby.h', 'rubysig.h'])
+
+# Borrowed from taf2-curb
+dir_config('curl')
+if find_executable('curl-config')
+  $CFLAGS << " #{`curl-config --cflags`.strip}"
+  $LIBS << " #{`curl-config --libs`.strip}"
+elsif !have_library('curl') or !have_header('curl/curl.h')
+  fail <<-EOM
+  Can't find libcurl or curl/curl.h
+
+  Try passing --with-curl-dir or --with-curl-lib and --with-curl-include
+  options to extconf.
+  EOM
+end
+
+$CFLAGS << ' -Wall'
+# $CFLAGS << ' -O0 -ggdb'
+
+create_makefile("streamly_ext")

data/ext/streamly.c

@@ -0,0 +1,349 @@
+// static size_t put_data_handler(char * stream, size_t size, size_t nmemb, VALUE upload_stream) {
+//     size_t result = 0;
+//     
+//     // TODO
+//     // Change upload_stream back to a VALUE
+//     // if TYPE(upload_stream) == T_STRING - read at most "len" continuously
+//     // if upload_stream is IO-like, read chunks of it
+//     // OR
+//     // if upload_stream responds to "each", use that?
+//     
+//     TRAP_BEG;
+//     // if (upload_stream != NULL && *upload_stream != NULL) {
+//     //     int len = size * nmemb;
+//     //     char *s1 = strncpy(stream, *upload_stream, len);
+//     //     result = strlen(s1);
+//     //     *upload_stream += result;
+//     // }
+//     TRAP_END;
+//     
+//     return result;
+// }
+
+#include "streamly.h"
+
+static size_t header_handler(char * stream, size_t size, size_t nmemb, VALUE handler) {
+    TRAP_BEG;
+    if(TYPE(handler) == T_STRING) {
+        rb_str_buf_cat(handler, stream, size * nmemb);
+    } else {
+        rb_funcall(handler, rb_intern("call"), 1, rb_str_new(stream, size * nmemb));
+    }
+    TRAP_END;
+    return size * nmemb;
+}
+
+static size_t data_handler(char * stream, size_t size, size_t nmemb, VALUE handler) {
+    TRAP_BEG;
+    if(TYPE(handler) == T_STRING) {
+        rb_str_buf_cat(handler, stream, size * nmemb);
+    } else {
+        rb_funcall(handler, rb_intern("call"), 1, rb_str_new(stream, size * nmemb));
+    }
+    TRAP_END;
+    return size * nmemb;
+}
+
+void streamly_instance_mark(struct curl_instance * instance) {
+    rb_gc_mark(instance->request_method);
+    rb_gc_mark(instance->request_payload_handler);
+    rb_gc_mark(instance->response_header_handler);
+    rb_gc_mark(instance->response_body_handler);
+    rb_gc_mark(instance->options);
+}
+
+void streamly_instance_free(struct curl_instance * instance) {
+    curl_easy_cleanup(instance->handle);
+    free(instance);
+}
+
+// Initially borrowed from Patron - http://github.com/toland/patron
+// slightly modified for Streamly
+static VALUE each_http_header(VALUE header, VALUE self) {
+    struct curl_instance * instance;
+    GetInstance(self, instance);
+    VALUE name, value, header_str = Qnil;
+
+    name = rb_obj_as_string(rb_ary_entry(header, 0));
+    value = rb_obj_as_string(rb_ary_entry(header, 1));
+
+    header_str = rb_str_plus(name, rb_str_new2(": "));
+    header_str = rb_str_plus(header_str, value);
+
+    instance->request_headers = curl_slist_append(instance->request_headers, RSTRING_PTR(header_str));
+    rb_gc_mark(name);
+    rb_gc_mark(value);
+    rb_gc_mark(header_str);
+    return Qnil;
+}
+
+// Initially borrowed from Patron - http://github.com/toland/patron
+// slightly modified for Streamly
+static VALUE select_error(CURLcode code) {
+    VALUE error = Qnil;
+    
+    switch (code) {
+        case CURLE_UNSUPPORTED_PROTOCOL:
+            error = eUnsupportedProtocol;
+            break;
+        case CURLE_URL_MALFORMAT:
+            error = eURLFormatError;
+            break;
+        case CURLE_COULDNT_RESOLVE_HOST:
+            error = eHostResolutionError;
+            break;
+        case CURLE_COULDNT_CONNECT:
+            error = eConnectionFailed;
+            break;
+        case CURLE_PARTIAL_FILE:
+            error = ePartialFileError;
+            break;
+        case CURLE_OPERATION_TIMEDOUT:
+            error = eTimeoutError;
+            break;
+        case CURLE_TOO_MANY_REDIRECTS:
+            error = eTooManyRedirects;
+            break;
+        default:
+            error = eStreamlyError;
+    }
+
+    return error;
+}
+
+/*
+ * Document-class: Streamly::Request
+ *
+ * A streaming REST client for Ruby that uses libcurl to do the heavy lifting.
+ * The API is almost exactly like rest-client, so users of that library should find it very familiar.
+ */
+/*
+ * Document-method: new
+ *
+ * call-seq: new(args)
+ *
+ * +args+ should be a Hash and is required
+ *  This Hash should at least contain +:url+ and +:method+ keys.
+ *  You may also provide the following optional keys:
+ *    +:headers+ - should be a Hash of name/value pairs
+ *    +:response_header_handler+ - can be a string or object that responds to #call
+ *      If an object was passed, it's #call method will be called and passed the current chunk of data
+ *    +:response_body_handler+ - can be a string or object that responds to #call
+ *      If an object was passed, it's #call method will be called and passed the current chunk of data
+ *    +:payload+ - If +:method+ is either +:post+ or +:put+ this will be used as the request body
+ *
+ */
+VALUE rb_streamly_new(int argc, VALUE * argv, VALUE klass) {
+    struct curl_instance * instance;
+    VALUE obj = Data_Make_Struct(klass, struct curl_instance, streamly_instance_mark, streamly_instance_free, instance);
+    rb_obj_call_init(obj, argc, argv);
+    return obj;
+}
+
+/*
+ * Document-method: initialize
+ *
+ * call-seq: initialize(args)
+ *
+ * +args+ should be a Hash and is required
+ *  This Hash should at least contain +:url+ and +:method+ keys.
+ *  You may also provide the following optional keys:
+ *    +:headers+ - should be a Hash of name/value pairs
+ *    +:response_header_handler+ - can be a string or object that responds to #call
+ *      If an object was passed, it's #call method will be called and passed the current chunk of data
+ *    +:response_body_handler+ - can be a string or object that responds to #call
+ *      If an object was passed, it's #call method will be called and passed the current chunk of data
+ *    +:payload+ - If +:method+ is either +:post+ or +:put+ this will be used as the request body
+ *
+ */
+VALUE rb_streamly_init(int argc, VALUE * argv, VALUE self) {
+    struct curl_instance * instance;
+    char * credential_sep = ":";
+    VALUE args, url, payload, headers, username, password, credentials;
+    
+    GetInstance(self, instance);
+    instance->handle = curl_easy_init();
+    instance->request_headers = NULL;
+    instance->request_method = Qnil;
+    instance->request_payload_handler = Qnil;
+    instance->response_header_handler = Qnil;
+    instance->response_body_handler = Qnil;
+    instance->options = Qnil;
+    
+    rb_scan_args(argc, argv, "10", &args);
+    
+    // Ensure our args parameter is a hash
+    Check_Type(args, T_HASH);
+    
+    instance->request_method = rb_hash_aref(args, sym_method);
+    url = rb_hash_aref(args, sym_url);
+    payload = rb_hash_aref(args, sym_payload);
+    headers = rb_hash_aref(args, sym_headers);
+    username = rb_hash_aref(args, sym_username);
+    password = rb_hash_aref(args, sym_password);
+    instance->response_header_handler = rb_hash_aref(args, sym_response_header_handler);
+    instance->response_body_handler = rb_hash_aref(args, sym_response_body_handler);
+    
+    // First lets verify we have a :method key
+    if (NIL_P(instance->request_method)) {
+        rb_raise(eStreamlyError, "You must specify a :method");
+    } else {
+        // OK, a :method was specified, but if it's POST or PUT we require a :payload
+        if (instance->request_method == sym_post || instance->request_method == sym_put) {
+            if (NIL_P(payload)) {
+                rb_raise(eStreamlyError, "You must specify a :payload for POST and PUT requests");
+            }
+        }
+    }
+    
+    // Now verify a :url was provided
+    if (NIL_P(url)) {
+        rb_raise(eStreamlyError, "You must specify a :url to request");
+    }
+    
+    if (NIL_P(instance->response_header_handler)) {
+        instance->response_header_handler = rb_str_new2("");
+    }
+    if (instance->request_method != sym_head && NIL_P(instance->response_body_handler)) {
+        instance->response_body_handler = rb_str_new2("");
+    }
+    
+    if (!NIL_P(headers)) {
+        Check_Type(headers, T_HASH);
+        rb_iterate(rb_each, headers, each_http_header, self);
+        curl_easy_setopt(instance->handle, CURLOPT_HTTPHEADER, instance->request_headers);
+    }
+    
+    // So far so good, lets start setting up our request
+    
+    // Set the type of request
+    if (instance->request_method == sym_head) {
+        curl_easy_setopt(instance->handle, CURLOPT_NOBODY, 1);
+    } else if (instance->request_method == sym_get) {
+        curl_easy_setopt(instance->handle, CURLOPT_HTTPGET, 1);
+    } else if (instance->request_method == sym_post) {
+        curl_easy_setopt(instance->handle, CURLOPT_POST, 1);
+        curl_easy_setopt(instance->handle, CURLOPT_POSTFIELDS, RSTRING_PTR(payload));
+        curl_easy_setopt(instance->handle, CURLOPT_POSTFIELDSIZE, RSTRING_LEN(payload));
+        
+        // (multipart)
+        // curl_easy_setopt(instance->handle, CURLOPT_HTTPPOST, 1);
+        
+        // TODO: get streaming upload working
+        // curl_easy_setopt(instance->handle, CURLOPT_READFUNCTION, &put_data_handler);
+        // curl_easy_setopt(instance->handle, CURLOPT_READDATA, &instance->upload_stream);
+        // curl_easy_setopt(instance->handle, CURLOPT_INFILESIZE, len);
+    } else if (instance->request_method == sym_put) {
+        curl_easy_setopt(instance->handle, CURLOPT_CUSTOMREQUEST, "PUT");
+        curl_easy_setopt(instance->handle, CURLOPT_POSTFIELDS, RSTRING_PTR(payload));
+        curl_easy_setopt(instance->handle, CURLOPT_POSTFIELDSIZE, RSTRING_LEN(payload));
+        
+        // TODO: get streaming upload working
+        // curl_easy_setopt(instance->handle, CURLOPT_UPLOAD, 1);
+        // curl_easy_setopt(instance->handle, CURLOPT_READFUNCTION, &put_data_handler);
+        // curl_easy_setopt(instance->handle, CURLOPT_READDATA, &instance->upload_stream);
+        // curl_easy_setopt(instance->handle, CURLOPT_INFILESIZE, len);
+    } else if (instance->request_method == sym_delete) {
+        curl_easy_setopt(instance->handle, CURLOPT_CUSTOMREQUEST, "DELETE");
+    }
+    
+    // Other common options
+    curl_easy_setopt(instance->handle, CURLOPT_URL, RSTRING_PTR(url));
+    curl_easy_setopt(instance->handle, CURLOPT_FOLLOWLOCATION, 1);
+    curl_easy_setopt(instance->handle, CURLOPT_MAXREDIRS, 3);
+    
+    // Response header handling
+    curl_easy_setopt(instance->handle, CURLOPT_HEADERFUNCTION, &header_handler);
+    curl_easy_setopt(instance->handle, CURLOPT_HEADERDATA, instance->response_header_handler);
+    
+    // Response body handling
+    if (instance->request_method != sym_head) {
+        curl_easy_setopt(instance->handle, CURLOPT_ENCODING, "identity, deflate, gzip");
+        curl_easy_setopt(instance->handle, CURLOPT_WRITEFUNCTION, &data_handler);
+        curl_easy_setopt(instance->handle, CURLOPT_WRITEDATA, instance->response_body_handler);
+    }
+    
+    curl_easy_setopt(instance, CURLOPT_USERPWD, NULL);
+    if (!NIL_P(username) || !NIL_P(password)) {
+        credentials = rb_str_new2("");
+        rb_str_buf_cat(credentials, RSTRING_PTR(username), RSTRING_LEN(username));
+        rb_str_buf_cat(credentials, credential_sep, 1);
+        rb_str_buf_cat(credentials, RSTRING_PTR(password), RSTRING_LEN(password));
+        curl_easy_setopt(instance->handle, CURLOPT_HTTPAUTH, CURLAUTH_BASIC | CURLAUTH_DIGEST);
+        curl_easy_setopt(instance->handle, CURLOPT_USERPWD, RSTRING_PTR(credentials));
+        rb_gc_mark(credentials);
+    }
+    
+    curl_easy_setopt(instance->handle, CURLOPT_SSL_VERIFYPEER, 0);
+    curl_easy_setopt(instance->handle, CURLOPT_SSL_VERIFYHOST, 0);
+    
+    curl_easy_setopt(instance->handle, CURLOPT_ERRORBUFFER, instance->error_buffer);
+    
+    return self;
+}
+
+/*
+ * Document-method: rb_streamly_execute
+ *
+ * call-seq: rb_streamly_execute
+ */
+VALUE rb_streamly_execute(int argc, VALUE * argv, VALUE self) {
+    CURLcode res;
+    struct curl_instance * instance;
+    GetInstance(self, instance);
+
+    // Done setting up, lets do this!
+    res = curl_easy_perform(instance->handle);
+    if (CURLE_OK != res) {
+        rb_raise(select_error(res), instance->error_buffer);
+    }
+    
+    // Cleanup
+    if (instance->request_headers != NULL) {
+        curl_slist_free_all(instance->request_headers);
+        instance->request_headers = NULL;
+    }
+    curl_easy_reset(instance->handle);
+    instance->request_payload_handler = Qnil;
+
+    if (instance->request_method == sym_head && TYPE(instance->response_header_handler) == T_STRING) {
+        return instance->response_header_handler;
+    } else if (TYPE(instance->response_body_handler) == T_STRING) {
+        return instance->response_body_handler;
+    } else {
+        return Qnil;
+    }
+}
+
+// Ruby Extension initializer
+void Init_streamly_ext() {
+    mStreamly = rb_define_module("Streamly");
+    
+    cRequest = rb_define_class_under(mStreamly, "Request", rb_cObject);
+    rb_define_singleton_method(cRequest, "new", rb_streamly_new, -1);
+    rb_define_method(cRequest, "initialize", rb_streamly_init, -1);
+    rb_define_method(cRequest, "execute", rb_streamly_execute, -1);
+    
+    eStreamlyError = rb_define_class_under(mStreamly, "Error", rb_eStandardError);
+    eUnsupportedProtocol = rb_define_class_under(mStreamly, "UnsupportedProtocol", rb_eStandardError);
+    eURLFormatError = rb_define_class_under(mStreamly, "URLFormatError", rb_eStandardError);
+    eHostResolutionError = rb_define_class_under(mStreamly, "HostResolutionError", rb_eStandardError);
+    eConnectionFailed = rb_define_class_under(mStreamly, "ConnectionFailed", rb_eStandardError);
+    ePartialFileError = rb_define_class_under(mStreamly, "PartialFileError", rb_eStandardError);
+    eTimeoutError = rb_define_class_under(mStreamly, "TimeoutError", rb_eStandardError);
+    eTooManyRedirects = rb_define_class_under(mStreamly, "TooManyRedirects", rb_eStandardError);
+    
+    sym_method = ID2SYM(rb_intern("method"));
+    sym_url = ID2SYM(rb_intern("url"));
+    sym_payload = ID2SYM(rb_intern("payload"));
+    sym_headers = ID2SYM(rb_intern("headers"));
+    sym_head = ID2SYM(rb_intern("head"));
+    sym_get = ID2SYM(rb_intern("get"));
+    sym_post = ID2SYM(rb_intern("post"));
+    sym_put = ID2SYM(rb_intern("put"));
+    sym_delete = ID2SYM(rb_intern("delete"));
+    sym_username = ID2SYM(rb_intern("username"));
+    sym_password = ID2SYM(rb_intern("password"));
+    sym_response_header_handler = ID2SYM(rb_intern("response_header_handler"));
+    sym_response_body_handler = ID2SYM(rb_intern("response_body_handler"));
+}

data/ext/streamly.h

@@ -0,0 +1,43 @@
+#include <curl/curl.h>
+#include <ruby.h>
+
+VALUE mStreamly, cRequest, eStreamlyError, eUnsupportedProtocol, eURLFormatError, eHostResolutionError;
+VALUE eConnectionFailed, ePartialFileError, eTimeoutError, eTooManyRedirects;
+VALUE sym_method, sym_url, sym_payload, sym_headers, sym_head, sym_get, sym_post, sym_put, sym_delete;
+VALUE sym_response_header_handler, sym_response_body_handler, sym_username, sym_password;
+
+#define GetInstance(obj, sval) (sval = (struct curl_instance*)DATA_PTR(obj));
+
+#ifdef HAVE_RBTRAP
+    #include <rubysig.h>
+#else
+    void rb_enable_interrupt(void);
+    void rb_disable_interrupt(void);
+
+    #define TRAP_BEG rb_enable_interrupt();
+    #define TRAP_END do { rb_disable_interrupt(); rb_thread_check_ints(); } while(0);
+#endif
+
+struct curl_instance {
+    CURL* handle;
+    char error_buffer[CURL_ERROR_SIZE];
+    struct curl_slist* request_headers;
+    VALUE request_payload_handler;
+    VALUE response_header_handler;
+    VALUE response_body_handler;
+    VALUE request_method;
+    VALUE options;
+};
+
+// libcurl callbacks
+static size_t header_handler(char * stream, size_t size, size_t nmemb, VALUE handler);
+static size_t data_handler(char * stream, size_t size, size_t nmemb, VALUE handler);
+// static size_t put_data_handler(char * stream, size_t size, size_t nmemb, VALUE upload_stream);
+// 
+static VALUE select_error(CURLcode code);
+static VALUE each_http_header(VALUE header, VALUE header_array);
+void streamly_instance_mark(struct curl_instance * instance);
+void streamly_instance_free(struct curl_instance * instance);
+
+VALUE rb_streamly_new(int argc, VALUE * argv, VALUE klass);
+VALUE rb_streamly_new(int argc, VALUE * argv, VALUE self);

data/lib/streamly.rb

@@ -0,0 +1,127 @@
+# encoding: UTF-8
+require 'streamly_ext'
+
+module Streamly
+  VERSION = "0.1.1"
+  
+  class Request
+    # A helper method to make your fire-and-forget requests easier
+    #
+    # Parameters:
+    # +args+ should be a Hash and is required
+    #   This Hash should at least contain +:url+ and +:method+ keys.
+    #   You may also provide the following optional keys:
+    #     +:headers+ - should be a Hash of name/value pairs
+    #     +:response_header_handler+ - can be a string or object that responds to #call
+    #       If an object was passed, it's #call method will be called and passed the current chunk of data
+    #     +:response_body_handler+ - can be a string or object that responds to #call
+    #       If an object was passed, it's #call method will be called and passed the current chunk of data
+    #     +:payload+ - If +:method+ is either +:post+ or +:put+ this will be used as the request body
+    #
+    def self.execute(args)
+      new(args).execute
+    end
+  end
+  
+  # A helper method to make HEAD requests a dead-simple one-liner
+  #
+  # Example:
+  #   Streamly.head("www.somehost.com/some_resource/1")
+  #
+  #   Streamly.head("www.somehost.com/some_resource/1") do |header_chunk|
+  #     # do something with _header_chunk_
+  #   end
+  #
+  # Parameters:
+  # +url+ should be a String, the url to request
+  # +headers+ should be a Hash and is optional
+  # 
+  # This method also accepts a block, which will stream the response headers in chunks to the caller
+  def self.head(url, headers=nil, &block)
+    opts = {:method => :head, :url => url, :headers => headers}
+    opts.merge!({:response_header_handler => block}) if block_given?
+    Request.execute(opts)
+  end
+  
+  # A helper method to make HEAD requests a dead-simple one-liner
+  #
+  # Example:
+  #   Streamly.get("www.somehost.com/some_resource/1")
+  #
+  #   Streamly.get("www.somehost.com/some_resource/1") do |chunk|
+  #     # do something with _chunk_
+  #   end
+  #
+  # Parameters:
+  # +url+ should be a String, the url to request
+  # +headers+ should be a Hash and is optional
+  # 
+  # This method also accepts a block, which will stream the response body in chunks to the caller
+  def self.get(url, headers=nil, &block)
+    opts = {:method => :get, :url => url, :headers => headers}
+    opts.merge!({:response_body_handler => block}) if block_given?
+    Request.execute(opts)
+  end
+  
+  # A helper method to make HEAD requests a dead-simple one-liner
+  #
+  # Example:
+  #   Streamly.post("www.somehost.com/some_resource", "asset[id]=2&asset[name]=bar")
+  #
+  #   Streamly.post("www.somehost.com/some_resource", "asset[id]=2&asset[name]=bar") do |chunk|
+  #     # do something with _chunk_
+  #   end
+  #
+  # Parameters:
+  # +url+ should be a String (the url to request) and is required
+  # +payload+ should be a String and is required
+  # +headers+ should be a Hash and is optional
+  # 
+  # This method also accepts a block, which will stream the response body in chunks to the caller
+  def self.post(url, payload, headers=nil, &block)
+    opts = {:method => :post, :url => url, :payload => payload, :headers => headers}
+    opts.merge!({:response_body_handler => block}) if block_given?
+    Request.execute(opts)
+  end
+  
+  # A helper method to make HEAD requests a dead-simple one-liner
+  #
+  # Example:
+  #   Streamly.put("www.somehost.com/some_resource/1", "asset[name]=foo")
+  #
+  #   Streamly.put("www.somehost.com/some_resource/1", "asset[name]=foo") do |chunk|
+  #     # do something with _chunk_
+  #   end
+  #
+  # Parameters:
+  # +url+ should be a String (the url to request) and is required
+  # +payload+ should be a String and is required
+  # +headers+ should be a Hash and is optional
+  # 
+  # This method also accepts a block, which will stream the response body in chunks to the caller
+  def self.put(url, payload, headers=nil, &block)
+    opts = {:method => :put, :url => url, :payload => payload, :headers => headers}
+    opts.merge!({:response_body_handler => block}) if block_given?
+    Request.execute(opts)
+  end
+  
+  # A helper method to make HEAD requests a dead-simple one-liner
+  #
+  # Example:
+  #   Streamly.delete("www.somehost.com/some_resource/1")
+  #
+  #   Streamly.delete("www.somehost.com/some_resource/1") do |chunk|
+  #     # do something with _chunk_
+  #   end
+  #
+  # Parameters:
+  # +url+ should be a String, the url to request
+  # +headers+ should be a Hash and is optional
+  # 
+  # This method also accepts a block, which will stream the response body in chunks to the caller
+  def self.delete(url, headers={}, &block)
+    opts = {:method => :delete, :url => url, :headers => headers}
+    opts.merge!({:response_body_handler => block}) if block_given?
+    Request.execute(opts)
+  end
+end

data/spec/rcov.opts

@@ -0,0 +1,4 @@
+--exclude spec,gem
+--text-summary
+--spec-only
+--sort coverage --sort-reverse

data/spec/requests/request_spec.rb

@@ -0,0 +1,93 @@
+# encoding: UTF-8
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper.rb')
+
+describe "Streamly's REST API" do
+  
+  before(:all) do
+    @response = "Hello, brian".strip
+  end
+  
+  context "HEAD" do
+    it "should perform a basic request" do
+      resp = Streamly.head('localhost:4567')
+      resp.should_not be_empty
+    end
+    
+    it "should perform a basic request and stream the response to the caller" do
+      streamed_response = ''
+      resp = Streamly.head('localhost:4567') do |chunk|
+        chunk.should_not be_empty
+        streamed_response << chunk
+      end
+      resp.should be_nil
+      streamed_response.should_not be_nil
+    end
+  end
+  
+  context "GET" do
+    it "should perform a basic request" do
+      resp = Streamly.get('localhost:4567/?name=brian')
+      resp.should eql(@response)
+    end
+    
+    it "should perform a basic request and stream the response to the caller" do
+      streamed_response = ''
+      resp = Streamly.get('localhost:4567/?name=brian') do |chunk|
+        chunk.should_not be_empty
+        streamed_response << chunk
+      end
+      resp.should be_nil
+      streamed_response.should eql(@response)
+    end
+  end
+  
+  context "POST" do
+    it "should perform a basic request" do
+      resp = Streamly.post('localhost:4567', 'name=brian')
+      resp.should eql(@response)
+    end
+    
+    it "should perform a basic request and stream the response to the caller" do
+      streamed_response = ''
+      resp = Streamly.post('localhost:4567', 'name=brian') do |chunk|
+        chunk.should_not be_empty
+        streamed_response << chunk
+      end
+      resp.should be_nil
+      streamed_response.should eql(@response)
+    end
+  end
+  
+  context "PUT" do
+    it "should perform a basic request" do
+      resp = Streamly.put('localhost:4567', 'name=brian')
+      resp.should eql(@response)
+    end
+    
+    it "should perform a basic request and stream the response to the caller" do
+      streamed_response = ''
+      resp = Streamly.put('localhost:4567', 'name=brian') do |chunk|
+        chunk.should_not be_empty
+        streamed_response << chunk
+      end
+      resp.should be_nil
+      streamed_response.should eql(@response)
+    end
+  end
+  
+  context "DELETE" do
+    it "should perform a basic request" do
+      resp = Streamly.delete('localhost:4567/?name=brian').should eql(@response)
+    end
+    
+    it "should perform a basic request and stream the response to the caller" do
+      streamed_response = ''
+      resp = Streamly.delete('localhost:4567/?name=brian') do |chunk|
+        chunk.should_not be_empty
+        streamed_response << chunk
+      end
+      resp.should be_nil
+      streamed_response.should eql(@response)
+    end
+  end
+end

data/spec/sinatra.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'sinatra'
+
+get '/' do
+  "Hello, #{params[:name]}".strip
+end
+
+post '/' do
+  "Hello, #{params[:name]}".strip
+end
+
+put '/' do
+  "Hello, #{params[:name]}".strip
+end
+
+delete '/' do
+  "Hello, #{params[:name]}".strip
+end

data/spec/spec.opts

@@ -0,0 +1,2 @@
+--format specdoc
+--colour

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+# encoding: UTF-8
+$LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__) + '/../lib')
+
+require 'rubygems'
+require 'streamly'

data/streamly.gemspec

@@ -0,0 +1,76 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{streamly}
+  s.version = "0.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Brian Lopez"]
+  s.date = %q{2009-07-27}
+  s.email = %q{seniorlopez@gmail.com}
+  s.extensions = ["ext/extconf.rb"]
+  s.extra_rdoc_files = [
+    "README.rdoc"
+  ]
+  s.files = [
+    ".gitignore",
+     "CHANGELOG.md",
+     "MIT-LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION.yml",
+     "benchmark/basic_request.rb",
+     "benchmark/streaming_json_request.rb",
+     "examples/basic/delete.rb",
+     "examples/basic/get.rb",
+     "examples/basic/head.rb",
+     "examples/basic/post.rb",
+     "examples/basic/put.rb",
+     "examples/streaming/delete.rb",
+     "examples/streaming/get.rb",
+     "examples/streaming/head.rb",
+     "examples/streaming/post.rb",
+     "examples/streaming/put.rb",
+     "ext/extconf.rb",
+     "ext/streamly.c",
+     "ext/streamly.h",
+     "lib/streamly.rb",
+     "spec/rcov.opts",
+     "spec/requests/request_spec.rb",
+     "spec/sinatra.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb",
+     "streamly.gemspec"
+  ]
+  s.homepage = %q{http://github.com/brianmario/streamly}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib", "ext"]
+  s.rubyforge_project = %q{streamly}
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{A streaming REST client for Ruby, in C.}
+  s.test_files = [
+    "spec/requests/request_spec.rb",
+     "spec/sinatra.rb",
+     "spec/spec_helper.rb",
+     "examples/basic/delete.rb",
+     "examples/basic/get.rb",
+     "examples/basic/head.rb",
+     "examples/basic/post.rb",
+     "examples/basic/put.rb",
+     "examples/streaming/delete.rb",
+     "examples/streaming/get.rb",
+     "examples/streaming/head.rb",
+     "examples/streaming/post.rb",
+     "examples/streaming/put.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification 
+name: brianmario-streamly
+version: !ruby/object:Gem::Version 
+  version: 0.1.1
+platform: ruby
+authors: 
+- Brian Lopez
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-07-27 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: 
+email: seniorlopez@gmail.com
+executables: []
+
+extensions: 
+- ext/extconf.rb
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- .gitignore
+- CHANGELOG.md
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- VERSION.yml
+- benchmark/basic_request.rb
+- benchmark/streaming_json_request.rb
+- examples/basic/delete.rb
+- examples/basic/get.rb
+- examples/basic/head.rb
+- examples/basic/post.rb
+- examples/basic/put.rb
+- examples/streaming/delete.rb
+- examples/streaming/get.rb
+- examples/streaming/head.rb
+- examples/streaming/post.rb
+- examples/streaming/put.rb
+- ext/extconf.rb
+- ext/streamly.c
+- ext/streamly.h
+- lib/streamly.rb
+- spec/rcov.opts
+- spec/requests/request_spec.rb
+- spec/sinatra.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- streamly.gemspec
+has_rdoc: false
+homepage: http://github.com/brianmario/streamly
+licenses: 
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+- ext
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: streamly
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: A streaming REST client for Ruby, in C.
+test_files: 
+- spec/requests/request_spec.rb
+- spec/sinatra.rb
+- spec/spec_helper.rb
+- examples/basic/delete.rb
+- examples/basic/get.rb
+- examples/basic/head.rb
+- examples/basic/post.rb
+- examples/basic/put.rb
+- examples/streaming/delete.rb
+- examples/streaming/get.rb
+- examples/streaming/head.rb
+- examples/streaming/post.rb
+- examples/streaming/put.rb