streamly_ffi 0.1.5

data/.gitignore

@@ -0,0 +1,5 @@
+*.bundle
+*.o
+Makefile
+*.tmproj
+

data/.rspec

@@ -0,0 +1 @@
+--colour

data/CHANGELOG.md

@@ -0,0 +1,18 @@
+# Changelog
+
+## 0.1.4 (September 2nd, 2010)
+* Streamly now respects Encoding.default_internal on 1.9
+* fixed a random segfault when applying a NULL auth field
+* take advantage of rb_thread_blocking_region on 1.9 and emulate it's behavior on 1.8 for Ruby-aware thread-saftey
+
+## 0.1.3 (August 19th, 2009)
+* Fixed a bug where a username or password was specified, but not both
+
+## 0.1.2 (July 28th, 2009)
+* removing call to set CURLOPT_USERPWD to NULL as it would crash in linux
+
+## 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,115 @@
+= 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
+* uses Encoding.default_internal (otherwise falls back to utf-8) for strings it hands back in 1.9
+
+== How to install
+
+Nothing special about it, just:
+
+ sudo gem install streamly
+
+== Example of use
+
+=== A basic HEAD request
+
+ Streamly.head 'www.somehost.com'
+
+Or streaming
+
+ Streamly.head 'www.somehost.com' do |header_chunk|
+   # do something with header_chunk
+ end
+
+You can also pass a Hash of headers
+
+ Streamly.head 'www.somehost.com', {"User-Agent" => "Your Mom"}
+
+=== A basic GET request
+
+ Streamly.get 'www.somehost.com'
+
+Or streaming
+
+ Streamly.get 'www.somehost.com' do |body_chunk|
+   # do something with body_chunk
+ end
+
+You can also pass a Hash of headers
+
+ Streamly.get 'www.somehost.com', {"User-Agent" => "Your Mom"}
+
+=== A basic POST request
+
+ Streamly.post 'www.somehost.com', 'blah=foo'
+
+Or streaming
+
+ Streamly.post 'www.somehost.com', 'blah=foo' do |body_chunk|
+   # do something with body_chunk
+ end
+
+You can also pass a Hash of headers
+
+ Streamly.post 'www.somehost.com', 'blah=foo', {"User-Agent" => "Your Mom"}
+
+=== A basic PUT request
+
+ Streamly.put 'www.somehost.com', 'blah=foo'
+
+Or streaming
+
+ Streamly.put 'www.somehost.com', 'blah=foo' do |body_chunk|
+   # do something with body_chunk
+ end
+
+You can also pass a Hash of headers
+
+ Streamly.put 'www.somehost.com', 'blah=foo', {"User-Agent" => "Your Mom"}
+
+=== A basic DELETE request
+
+ Streamly.delete 'www.somehost.com'
+
+Or streaming
+
+ Streamly.delete 'www.somehost.com' do |body_chunk|
+   # do something with body_chunk
+ end
+
+You can also pass a Hash of headers
+
+ Streamly.delete 'www.somehost.com', {"User-Agent" => "Your Mom"}
+
+== 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
+
+== Other Notes
+
+This library was basically an exercise in dealing with libcurl in C.
+
+== 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,43 @@
+# encoding: UTF-8
+
+require 'rake/gempackagetask'
+
+gemspec = eval File.read('streamly_ffi.gemspec')
+
+# Gem packaging tasks
+Rake::GemPackageTask.new(gemspec) do |pkg|
+  pkg.need_zip = false
+  pkg.need_tar = false
+end
+
+task :gem => :gemspec
+
+desc %{Build the gemspec file.}
+task :gemspec do
+  gemspec.validate
+end
+
+desc %{Release the gem to RubyGems.org}
+task :release => :gem do
+  system "gem push pkg/#{gemspec.name}-#{gemspec.version}.gem"
+end
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+desc "Run all examples with RCov"
+Rspec::Core::RakeTask.new('spec:rcov') do |t|
+#Spec::Rake::SpecTask.new('spec:rcov') do |t|
+  t.pattern   = "spec/requests/**/*_spec.rb"
+  t.rcov      = true
+  t.rcov_opts = lambda do
+    IO.readlines("spec/rcov.opts").map {|line|
+      line.chomp.split " "
+    }.flatten
+  end
+end
+Rspec::Core::RakeTask.new(:spec) do |t|
+#Spec::Rake::SpecTask.new('spec') do |t|
+  t.pattern   = "spec/streamly_ffi/**/*_spec.rb"
+#  t.opts  << '--options' << 'spec/spec.opts'
+end

data/VERSION.yml

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

data/benchmark/basic_request.rb

@@ -0,0 +1,34 @@
+# encoding: UTF-8
+$LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__) + '/..')
+$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.bmbm do |x|
+  x.report do
+    puts "Streamly"
+    (ARGV[1] || 1).to_i.times do
+      Streamly.get(url)
+    end
+  end
+
+  x.report do
+    puts "Shell out to curl"
+    (ARGV[1] || 1).to_i.times do
+      `curl -s --compressed #{url}`
+    end
+  end
+
+  x.report do
+    puts "rest-client"
+    (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,43 @@
+# encoding: UTF-8
+$LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__) + '/..')
+$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.bmbm do |x|
+  parser = Yajl::Parser.new
+  parser.on_parse_complete = lambda {|obj| }
+  x.report do
+    puts "Streamly"
+    (ARGV[1] || 1).to_i.times do
+      Streamly.get(url) do |chunk|
+        parser << chunk
+      end
+    end
+  end
+
+  parser = Yajl::Parser.new
+  parser.on_parse_complete = lambda {|obj| }
+  x.report do
+    puts "Shell out to curl"
+    (ARGV[1] || 1).to_i.times do
+      parser.parse `curl -s --compressed #{url}`
+    end
+  end
+
+  parser = Yajl::Parser.new
+  parser.on_parse_complete = lambda {|obj| }
+  x.report do
+    puts "rest-client"
+    (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,28 @@
+# encoding: UTF-8
+require 'mkmf'
+require 'rbconfig'
+
+# 1.9-only
+have_func('rb_thread_blocking_region')
+
+$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 -Wextra -funroll-loops'
+# $CFLAGS << ' -O0 -ggdb'
+
+create_makefile("streamly_ext")