em-http-request 0.2.10 → 0.2.11

data/LICENSE

@@ -1,58 +1,58 @@
-Ruby is copyrighted free software by Yukihiro Matsumoto <matz@netlab.co.jp>.
-You can redistribute it and/or modify it under either the terms of the GPL
-(see COPYING.txt file), or the conditions below:
-
-  1. You may make and give away verbatim copies of the source form of the
-     software without restriction, provided that you duplicate all of the
-     original copyright notices and associated disclaimers.
-
-  2. You may modify your copy of the software in any way, provided that
-     you do at least ONE of the following:
-
-       a) place your modifications in the Public Domain or otherwise
-          make them Freely Available, such as by posting said
-	  modifications to Usenet or an equivalent medium, or by allowing
-	  the author to include your modifications in the software.
-
-       b) use the modified software only within your corporation or
-          organization.
-
-       c) rename any non-standard executables so the names do not conflict
-	  with standard executables, which must also be provided.
-
-       d) make other distribution arrangements with the author.
-
-  3. You may distribute the software in object code or executable
-     form, provided that you do at least ONE of the following:
-
-       a) distribute the executables and library files of the software,
-	  together with instructions (in the manual page or equivalent)
-	  on where to get the original distribution.
-
-       b) accompany the distribution with the machine-readable source of
-	  the software.
-
-       c) give non-standard executables non-standard names, with
-          instructions on where to get the original software distribution.
-
-       d) make other distribution arrangements with the author.
-
-  4. You may modify and include the part of the software into any other
-     software (possibly commercial).  But some files in the distribution
-     are not written by the author, so that they are not under this terms.
-
-     They are gc.c(partly), utils.c(partly), regex.[ch], st.[ch] and some
-     files under the ./missing directory.  See each file for the copying
-     condition.
-
-  5. The scripts and library files supplied as input to or produced as 
-     output from the software do not automatically fall under the
-     copyright of the software, but belong to whomever generated them, 
-     and may be sold commercially, and may be aggregated with this
-     software.
-
-  6. THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR
-     IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
-     WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
-     PURPOSE.
-
+Ruby is copyrighted free software by Yukihiro Matsumoto <matz@netlab.co.jp>.
+You can redistribute it and/or modify it under either the terms of the GPL
+(see COPYING.txt file), or the conditions below:
+
+  1. You may make and give away verbatim copies of the source form of the
+     software without restriction, provided that you duplicate all of the
+     original copyright notices and associated disclaimers.
+
+  2. You may modify your copy of the software in any way, provided that
+     you do at least ONE of the following:
+
+       a) place your modifications in the Public Domain or otherwise
+          make them Freely Available, such as by posting said
+	  modifications to Usenet or an equivalent medium, or by allowing
+	  the author to include your modifications in the software.
+
+       b) use the modified software only within your corporation or
+          organization.
+
+       c) rename any non-standard executables so the names do not conflict
+	  with standard executables, which must also be provided.
+
+       d) make other distribution arrangements with the author.
+
+  3. You may distribute the software in object code or executable
+     form, provided that you do at least ONE of the following:
+
+       a) distribute the executables and library files of the software,
+	  together with instructions (in the manual page or equivalent)
+	  on where to get the original distribution.
+
+       b) accompany the distribution with the machine-readable source of
+	  the software.
+
+       c) give non-standard executables non-standard names, with
+          instructions on where to get the original software distribution.
+
+       d) make other distribution arrangements with the author.
+
+  4. You may modify and include the part of the software into any other
+     software (possibly commercial).  But some files in the distribution
+     are not written by the author, so that they are not under this terms.
+
+     They are gc.c(partly), utils.c(partly), regex.[ch], st.[ch] and some
+     files under the ./missing directory.  See each file for the copying
+     condition.
+
+  5. The scripts and library files supplied as input to or produced as 
+     output from the software do not automatically fall under the
+     copyright of the software, but belong to whomever generated them, 
+     and may be sold commercially, and may be aggregated with this
+     software.
+
+  6. THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR
+     IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
+     WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+     PURPOSE.
+

data/README.md

@@ -0,0 +1,157 @@
+EM-HTTP-Request
+===============
+
+Asynchronous HTTP client for Ruby, based on EventMachine runtime.
+
+- Ragel HTTP parser for speed & performance
+- Simple interface for single & parallel requests via deferred callbacks
+- Automatic gzip & deflate decoding
+- Basic-Auth & OAuth support
+- Custom timeout support
+- Stream response processing
+- Proxy support (with SSL Tunneling)
+- Auto-follow 3xx redirects with custom max depth
+- Bi-directional communication with web-socket services
+- [Native mocking support](http://wiki.github.com/igrigorik/em-http-request/mocking-httprequest) and through [Webmock](http://github.com/bblimke/webmock)
+
+Getting started
+---------------
+
+      gem install em-http-request
+      irb:0> require 'em-http'
+
+Or checkout [screencast / demo](http://everburning.com/news/eventmachine-screencast-em-http-request/) of using EM-HTTP-Request.
+
+Libraries & Applications using em-http
+--------------------------------------
+
+- [chirpstream](http://github.com/joshbuddy/chirpstream) - EM client for Twitters Chirpstream API
+- [RDaneel](http://github.com/hasmanydevelopers/RDaneel) - Ruby crawler which respects robots.txt
+- [rsolr-async](http://github.com/mwmitchell/rsolr-async) - An asynchronus connection adapter for RSolr
+- [PubSubHubbub](http://github.com/igrigorik/PubSubHubbub) - Asynchronous PubSubHubbub ruby client
+- and many others.. drop me a link if you want yours included!
+
+Simple client example
+---------------------
+
+      EventMachine.run {
+        http = EventMachine::HttpRequest.new('http://127.0.0.1/').get :query => {'keyname' => 'value'}, :timeout => 10
+
+        http.callback {
+          p http.response_header.status
+          p http.response_header
+          p http.response
+
+          EventMachine.stop
+        }
+      }
+
+Multi-request example
+---------------------
+
+Fire and wait for multiple requests to complete via the MultiRequest interface.
+
+      EventMachine.run {
+        multi = EventMachine::MultiRequest.new
+
+        # add multiple requests to the multi-handler
+        multi.add(EventMachine::HttpRequest.new('http://www.google.com/').get)
+        multi.add(EventMachine::HttpRequest.new('http://www.yahoo.com/').get)
+
+        multi.callback  {
+          p multi.responses[:succeeded]
+          p multi.responses[:failed]
+
+          EventMachine.stop
+        }
+      }
+
+Basic-Auth example
+------------------
+
+Full basic author support. For OAuth, check examples/oauth-tweet.rb file.
+
+      EventMachine.run {
+        http = EventMachine::HttpRequest.new('http://www.website.com/').get :head => {'authorization' => ['user', 'pass']}
+
+        http.errback { failed }
+        http.callback {
+          p http.response_header
+          EventMachine.stop
+        }
+      }
+
+
+POSTing data example
+--------------------
+
+      EventMachine.run {
+        http1 = EventMachine::HttpRequest.new('http://www.website.com/').post :body => {"key1" => 1, "key2" => [2,3]}
+        http2 = EventMachine::HttpRequest.new('http://www.website.com/').post :body => "some data"
+
+        # ...
+      }
+
+Streaming body processing
+-------------------------
+
+Allows you to consume an HTTP stream of content in real-time. Each time a new piece of content is pushed
+to the client, it is passed to the stream callback for you to operate on.
+
+      EventMachine.run {
+        http = EventMachine::HttpRequest.new('http://www.website.com/').get
+        http.stream { |chunk| print chunk }
+      }
+
+Streaming files from disk
+-------------------------
+Allows you to efficiently stream a (large) file from disk via EventMachine's FileStream interface.
+
+      EventMachine.run {
+        http = EventMachine::HttpRequest.new('http://www.website.com/').post :file => 'largefile.txt'
+        http.callback { |chunk| puts "Upload finished!" }
+      }
+
+Proxy example
+-------------
+
+Full transparent proxy support with support for SSL tunneling.
+
+      EventMachine.run {
+        http = EventMachine::HttpRequest.new('http://www.website.com/').get :proxy => {
+          :host => 'www.myproxy.com',
+          :port => 8080,
+          :authorization => ['username', 'password'] # authorization is optional
+      }
+
+Auto-follow 3xx redirects
+-------------------------
+
+Specify the max depth of redirects to follow, default is 0.
+
+      EventMachine.run {
+        http = EventMachine::HttpRequest.new('http://www.google.com/').get :redirects => 1
+        http.callback { p http.last_effective_url }
+      }
+
+WebSocket example
+-----------------
+
+[Bi-directional communication with WebSockets](http://www.igvita.com/2009/12/22/ruby-websockets-tcp-for-the-browser/): simply pass in a ws:// resource and the client will negotiate the connection upgrade for you. On successful handshake the callback is invoked, and any incoming messages will be passed to the stream callback. The client can also send data to the server at will by calling the "send" method!
+
+      EventMachine.run {
+        http = EventMachine::HttpRequest.new("ws://yourservice.com/websocket").get :timeout => 0
+
+        http.errback { puts "oops" }
+        http.callback {
+          puts "WebSocket connected!"
+          http.send("Hello client")
+        }
+
+        http.stream { |msg|
+          puts "Recieved: #{msg}"
+          http.send "Pong: #{msg}"
+        }
+
+        http.disconnect { puts "oops, dropped connection?" }
+      }

data/Rakefile

@@ -1,106 +1,110 @@
-require 'rake'
-require 'rake/clean'
-require 'rake/rdoctask'
-require 'rake/gempackagetask'
-require 'fileutils'
-include FileUtils
-
-# copied from EventMachine.
-MAKE = ENV['MAKE'] || if RUBY_PLATFORM =~ /mswin/ # mingw uses make.
-  'nmake'
-else
-  'make'
-end
-
-# Default Rake task is compile
-task :default => :compile
-
-# RDoc
-Rake::RDocTask.new(:rdoc) do |task|
-  task.rdoc_dir = 'doc'
-  task.title    = 'EventMachine::HttpRequest'
-  task.options = %w(--title HttpRequest --main README --line-numbers)
-  task.rdoc_files.include(['lib/**/*.rb'])
-  task.rdoc_files.include(['README', 'LICENSE'])
-end
-
-# Rebuild parser Ragel
-task :ragel do
-  Dir.chdir "ext/http11_client" do
-    target = "http11_parser.c"
-    File.unlink target if File.exist? target
-    sh "ragel http11_parser.rl | rlgen-cd -G2 -o #{target}"
-    raise "Failed to build C source" unless File.exist? target
-  end
-end
-
-task :spec do
-  sh 'spec spec/*_spec.rb'
-end
-
-def make(makedir)
-  Dir.chdir(makedir) { sh MAKE }
-end
-
-def extconf(dir)
-  Dir.chdir(dir) { ruby "extconf.rb" }
-end
-
-def setup_extension(dir, extension)
-  ext = "ext/#{dir}"
-  ext_so = "#{ext}/#{extension}.#{Config::CONFIG['DLEXT']}"
-  ext_files = FileList[
-    "#{ext}/*.c",
-    "#{ext}/*.h",
-    "#{ext}/extconf.rb",
-    "#{ext}/Makefile",
-    "lib"
-  ]
-
-  task "lib" do
-    directory "lib"
-  end
-
-  desc "Builds just the #{extension} extension"
-
-  mf = (extension + '_makefile').to_sym
-
-  task mf do |t|
-    extconf "#{ext}"
-  end
-
-  task extension.to_sym => [mf] do
-    make "#{ext}"
-    cp ext_so, "lib"
-  end
-end
-
-setup_extension("buffer", "em_buffer")
-setup_extension("http11_client", "http11_client")
-
-task :compile => [:em_buffer, :http11_client]
-
-CLEAN.include ['build/*', '**/*.o', '**/*.so', '**/*.a', '**/*.log', 'pkg']
-CLEAN.include ['ext/buffer/Makefile', 'lib/em_buffer.*', 'lib/http11_client.*']
-
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gemspec|
-    gemspec.name = "em-http-request"
-    gemspec.summary = "EventMachine based, async HTTP Request interface"
-    gemspec.description = gemspec.summary
-    gemspec.email = "ilya@igvita.com"
-    gemspec.homepage = "http://github.com/igrigorik/em-http-request"
-    gemspec.authors = ["Ilya Grigorik"]
-    gemspec.required_ruby_version = ">= 1.8.6"
-    gemspec.extensions = ["ext/buffer/extconf.rb" , "ext/http11_client/extconf.rb"]
-    gemspec.add_dependency('eventmachine', '>= 0.12.9')
-    gemspec.add_dependency('addressable', '>= 2.0.0')
-    gemspec.rubyforge_project = "em-http-request"
-    gemspec.files = FileList[`git ls-files`.split]
-  end
-
-  Jeweler::GemcutterTasks.new
-rescue LoadError
-  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
-end
+require 'rake'
+require 'rake/clean'
+require 'rake/rdoctask'
+require 'rake/gempackagetask'
+require 'fileutils'
+include FileUtils
+
+# copied from EventMachine.
+MAKE = ENV['MAKE'] || if RUBY_PLATFORM =~ /mswin/ # mingw uses make.
+  'nmake'
+else
+  'make'
+end
+
+# Default Rake task is compile
+task :default => :compile
+
+# RDoc
+Rake::RDocTask.new(:rdoc) do |task|
+  task.rdoc_dir = 'doc'
+  task.title    = 'EventMachine::HttpRequest'
+  task.options = %w(--title HttpRequest --main README --line-numbers)
+  task.rdoc_files.include(['lib/**/*.rb'])
+  task.rdoc_files.include(['README', 'LICENSE'])
+end
+
+# Rebuild parser Ragel
+task :ragel do
+  Dir.chdir "ext/http11_client" do
+    target = "http11_parser.c"
+    File.unlink target if File.exist? target
+    sh "ragel http11_parser.rl | rlgen-cd -G2 -o #{target}"
+    raise "Failed to build C source" unless File.exist? target
+  end
+end
+
+require 'spec'
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.spec_opts ||= []
+  t.spec_opts << "--options" << "spec/spec.opts"
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+def make(makedir)
+  Dir.chdir(makedir) { sh MAKE }
+end
+
+def extconf(dir)
+  Dir.chdir(dir) { ruby "extconf.rb" }
+end
+
+def setup_extension(dir, extension)
+  ext = "ext/#{dir}"
+  ext_so = "#{ext}/#{extension}.#{Config::CONFIG['DLEXT']}"
+  ext_files = FileList[
+    "#{ext}/*.c",
+    "#{ext}/*.h",
+    "#{ext}/extconf.rb",
+    "#{ext}/Makefile",
+    "lib"
+  ]
+
+  task "lib" do
+    directory "lib"
+  end
+
+  desc "Builds just the #{extension} extension"
+
+  mf = (extension + '_makefile').to_sym
+
+  task mf do |t|
+    extconf "#{ext}"
+  end
+
+  task extension.to_sym => [mf] do
+    make "#{ext}"
+    cp ext_so, "lib"
+  end
+end
+
+setup_extension("buffer", "em_buffer")
+setup_extension("http11_client", "http11_client")
+
+task :compile => [:em_buffer, :http11_client]
+
+CLEAN.include ['build/*', '**/*.o', '**/*.so', '**/*.a', '**/*.log', 'pkg']
+CLEAN.include ['ext/buffer/Makefile', 'lib/em_buffer.*', 'lib/http11_client.*']
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "em-http-request"
+    gemspec.summary = "EventMachine based, async HTTP Request interface"
+    gemspec.description = gemspec.summary
+    gemspec.email = "ilya@igvita.com"
+    gemspec.homepage = "http://github.com/igrigorik/em-http-request"
+    gemspec.authors = ["Ilya Grigorik"]
+    gemspec.required_ruby_version = ">= 1.8.6"
+    gemspec.extensions = ["ext/buffer/extconf.rb" , "ext/http11_client/extconf.rb"]
+    gemspec.add_dependency('eventmachine', '>= 0.12.9')
+    gemspec.add_dependency('addressable', '>= 2.0.0')
+    gemspec.rubyforge_project = "em-http-request"
+    gemspec.files = FileList[`git ls-files`.split]
+  end
+
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end