em-http-request 0.2.7 → 0.2.9

data/README.rdoc

@@ -1,14 +1,15 @@
 = EM-HTTP-Client
 
-EventMachine based HTTP Request interface. Supports streaming response processing, uses Ragel HTTP parser. 
+EventMachine based HTTP Request interface. Supports streaming response processing, uses Ragel HTTP parser.
 - Simple interface for single & parallel requests via deferred callbacks
 - Automatic gzip & deflate decoding
 - Basic-Auth & OAuth support
 - Custom timeouts
 - Proxy support (with SSL Tunneling)
+- Auto-follow 3xx redirects with max depth
 - Bi-directional communication with web-socket services
 
-Screencast / Demo of using EM-HTTP-Request: 
+Screencast / Demo of using EM-HTTP-Request:
 - http://everburning.com/news/eventmachine-screencast-em-http-request/
 
 == Getting started
@@ -26,12 +27,12 @@ Screencast / Demo of using EM-HTTP-Request:
 
   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
     }
   }
@@ -41,15 +42,15 @@ Fire and wait for multiple requess 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
     }
   }
@@ -59,7 +60,7 @@ 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
@@ -72,7 +73,7 @@ Full basic author support. For OAuth, check examples/oauth-tweet.rb file.
   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"
-      
+
     # ...
   }
 
@@ -83,8 +84,14 @@ 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 file 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
@@ -97,6 +104,15 @@ Full transparent proxy support with support for SSL tunneling.
       :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 :redirect => 1
+    http.callback { p http.last_effective_url }
+  }
+
+
 == WebSocket example
 Bi-directional communication with WebSockets: simply pass in a ws:// resource and the client will
 negotiate the connection upgrade for you. On successfull handshake the callback is invoked, and
@@ -106,7 +122,7 @@ 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!"
@@ -117,4 +133,6 @@ server at will by calling the "send" method!
       puts "Recieved: #{msg}"
       http.send "Pong: #{msg}"
     }
+
+    http.disconnect { puts "oops, dropped connection?" }
   }

data/Rakefile

@@ -35,7 +35,7 @@ task :ragel do
 end
 
 task :spec do
-	sh 'spec spec/*_spec.rb'
+  sh 'spec spec/*_spec.rb'
 end
 
 def make(makedir)
@@ -55,8 +55,8 @@ def setup_extension(dir, extension)
     "#{ext}/extconf.rb",
     "#{ext}/Makefile",
     "lib"
-  ] 
-  
+  ]
+
   task "lib" do
     directory "lib"
   end
@@ -92,13 +92,14 @@ begin
     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"

data/VERSION

@@ -1 +1 @@
-0.2.7
+0.2.9

data/em-http-request.gemspec

@@ -0,0 +1,97 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{em-http-request}
+  s.version = "0.2.9"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Ilya Grigorik"]
+  s.date = %q{2010-07-07}
+  s.description = %q{EventMachine based, async HTTP Request interface}
+  s.email = %q{ilya@igvita.com}
+  s.extensions = ["ext/buffer/extconf.rb", "ext/http11_client/extconf.rb"]
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "em-http-request.gemspec",
+     "examples/fetch.rb",
+     "examples/fibered-http.rb",
+     "examples/oauth-tweet.rb",
+     "examples/websocket-handler.rb",
+     "examples/websocket-server.rb",
+     "ext/buffer/em_buffer.c",
+     "ext/buffer/extconf.rb",
+     "ext/http11_client/ext_help.h",
+     "ext/http11_client/extconf.rb",
+     "ext/http11_client/http11_client.c",
+     "ext/http11_client/http11_parser.c",
+     "ext/http11_client/http11_parser.h",
+     "ext/http11_client/http11_parser.rl",
+     "lib/em-http-request.rb",
+     "lib/em-http.rb",
+     "lib/em-http/client.rb",
+     "lib/em-http/core_ext/bytesize.rb",
+     "lib/em-http/core_ext/hash.rb",
+     "lib/em-http/decoders.rb",
+     "lib/em-http/http_options.rb",
+     "lib/em-http/mock.rb",
+     "lib/em-http/multi.rb",
+     "lib/em-http/request.rb",
+     "spec/fixtures/google.ca",
+     "spec/hash_spec.rb",
+     "spec/helper.rb",
+     "spec/mock_spec.rb",
+     "spec/multi_spec.rb",
+     "spec/request_spec.rb",
+     "spec/stallion.rb",
+     "spec/stub_server.rb"
+  ]
+  s.homepage = %q{http://github.com/igrigorik/em-http-request}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.required_ruby_version = Gem::Requirement.new(">= 1.8.6")
+  s.rubyforge_project = %q{em-http-request}
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{EventMachine based, async HTTP Request interface}
+  s.test_files = [
+    "spec/hash_spec.rb",
+     "spec/helper.rb",
+     "spec/mock_spec.rb",
+     "spec/multi_spec.rb",
+     "spec/request_spec.rb",
+     "spec/stallion.rb",
+     "spec/stub_server.rb",
+     "examples/fetch.rb",
+     "examples/fibered-http.rb",
+     "examples/oauth-tweet.rb",
+     "examples/websocket-handler.rb",
+     "examples/websocket-server.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
+      s.add_runtime_dependency(%q<eventmachine>, [">= 0.12.9"])
+      s.add_runtime_dependency(%q<addressable>, [">= 2.0.0"])
+    else
+      s.add_dependency(%q<eventmachine>, [">= 0.12.9"])
+      s.add_dependency(%q<addressable>, [">= 2.0.0"])
+    end
+  else
+    s.add_dependency(%q<eventmachine>, [">= 0.12.9"])
+    s.add_dependency(%q<addressable>, [">= 2.0.0"])
+  end
+end
+

data/examples/fetch.rb

@@ -21,7 +21,7 @@ EM.run do
       EM.stop if pending < 1
     }
     http.errback {
-      puts "#{url}\n" + http.errors.join("\n")
+      puts "#{url}\n" + http.error
 
       pending -= 1
       EM.stop if pending < 1

data/examples/websocket-handler.rb

@@ -0,0 +1,28 @@
+require 'rubygems'
+require 'lib/em-http'
+
+module KBHandler
+  include EM::Protocols::LineText2
+
+  def receive_line(data)
+    p "Want to send: #{data}"
+    p "Error status: #{$http.error?}"
+    $http.send(data)
+    p "After send"
+  end
+end
+
+EventMachine.run {
+  $http = EventMachine::HttpRequest.new("ws://localhost:8080/").get :timeout => 0
+
+  $http.disconnect { puts 'oops' }
+  $http.callback {
+    puts "WebSocket connected!"
+  }
+
+  $http.stream { |msg|
+    puts "Recieved: #{msg}"
+  }
+
+  EM.open_keyboard(KBHandler)
+}

data/examples/websocket-server.rb

@@ -0,0 +1,8 @@
+require 'rubygems'
+require 'em-websocket'
+
+EventMachine::WebSocket.start(:host => "0.0.0.0", :port => 8080) do |ws|
+  ws.onopen    { ws.send "Hello Client!"}
+  ws.onmessage { |msg| p "got: #{msg}"; ws.send "Pong: #{msg}" }
+  ws.onclose   { puts "WebSocket closed" }
+end

data/ext/buffer/em_buffer.c

@@ -29,15 +29,15 @@
 #define PURGE_INTERVAL 10
 
 struct buffer {
-	time_t last_purged_at;
+  time_t last_purged_at;
   unsigned size, node_size;
   struct buffer_node *head, *tail;
   struct buffer_node *pool_head, *pool_tail;
-	
+
 };
 
 struct buffer_node {
-	time_t last_used_at;
+  time_t last_used_at;
   unsigned start, end;
   struct buffer_node *next;
   unsigned char data[0];
@@ -72,7 +72,7 @@ static void buffer_copy(struct buffer *buf, char *str, unsigned len);
 static int buffer_read_from(struct buffer *buf, int fd);
 static int buffer_write_to(struct buffer *buf, int fd);
 
-/* 
+/*
  * High speed buffering geared towards non-blocking I/O.
  *
  * Data is stored in a byte queue implemented as a linked list of equal size
@@ -94,8 +94,8 @@ void Init_em_buffer()
   rb_define_method(cEm_Buffer, "append", Em_Buffer_append, 1);
   rb_define_method(cEm_Buffer, "prepend", Em_Buffer_prepend, 1);
   rb_define_method(cEm_Buffer, "read", Em_Buffer_read, -1);
-	rb_define_method(cEm_Buffer, "to_str", Em_Buffer_to_str, 0);
-	rb_define_method(cEm_Buffer, "read_from", Em_Buffer_read_from, 1);
+  rb_define_method(cEm_Buffer, "to_str", Em_Buffer_to_str, 0);
+  rb_define_method(cEm_Buffer, "read_from", Em_Buffer_read_from, 1);
   rb_define_method(cEm_Buffer, "write_to", Em_Buffer_write_to, 1);
 }
 
@@ -118,7 +118,7 @@ static void Em_Buffer_free(struct buffer *buf)
 /**
  *  call-seq:
  *    EventMachine::Buffer.new(size = DEFAULT_NODE_SIZE) -> EventMachine::Buffer
- * 
+ *
  * Create a new EventMachine::Buffer with linked segments of the given size
  */
 static VALUE Em_Buffer_initialize(int argc, VALUE *argv, VALUE self)
@@ -147,7 +147,7 @@ static VALUE Em_Buffer_initialize(int argc, VALUE *argv, VALUE self)
 /**
  *  call-seq:
  *    EventMachine::Buffer#clear -> nil
- * 
+ *
  * Clear all data from the EventMachine::Buffer
  */
 static VALUE Em_Buffer_clear(VALUE self)
@@ -163,10 +163,10 @@ static VALUE Em_Buffer_clear(VALUE self)
 /**
  *  call-seq:
  *    EventMachine::Buffer#size -> Integer
- * 
+ *
  * Return the size of the buffer in bytes
  */
-static VALUE Em_Buffer_size(VALUE self) 
+static VALUE Em_Buffer_size(VALUE self)
 {
   struct buffer *buf;
   Data_Get_Struct(self, struct buffer, buf);
@@ -177,21 +177,21 @@ static VALUE Em_Buffer_size(VALUE self)
 /**
  *  call-seq:
  *    EventMachine::Buffer#empty? -> Boolean
- * 
+ *
  * Is the buffer empty?
  */
-static VALUE Em_Buffer_empty(VALUE self) 
+static VALUE Em_Buffer_empty(VALUE self)
 {
   struct buffer *buf;
   Data_Get_Struct(self, struct buffer, buf);
 
-  return buf->size > 0 ? Qfalse : Qtrue;	
+  return buf->size > 0 ? Qfalse : Qtrue;
 }
 
 /**
  *  call-seq:
  *    EventMachine::Buffer#append(data) -> String
- * 
+ *
  * Append the given data to the end of the buffer
  */
 static VALUE Em_Buffer_append(VALUE self, VALUE data)
@@ -209,7 +209,7 @@ static VALUE Em_Buffer_append(VALUE self, VALUE data)
 /**
  *  call-seq:
  *    EventMachine::Buffer#prepend(data) -> String
- * 
+ *
  * Prepend the given data to the beginning of the buffer
  */
 static VALUE Em_Buffer_prepend(VALUE self, VALUE data)
@@ -226,7 +226,7 @@ static VALUE Em_Buffer_prepend(VALUE self, VALUE data)
 /**
  *  call-seq:
  *    EventMachine::Buffer#read(length = nil) -> String
- * 
+ *
  * Read the specified abount of data from the buffer.  If no value
  * is given the entire contents of the buffer are returned.  Any data
  * read from the buffer is cleared.
@@ -263,31 +263,31 @@ static VALUE Em_Buffer_read(int argc, VALUE *argv, VALUE self)
 /**
  *  call-seq:
  *    EventMachine::Buffer#to_str -> String
- * 
+ *
  * Convert the Buffer to a String.  The original buffer is unmodified.
  */
 static VALUE Em_Buffer_to_str(VALUE self) {
-	VALUE str;
-	struct buffer *buf;
-	
-	Data_Get_Struct(self, struct buffer, buf);
-	
-	str = rb_str_new(0, buf->size);
-	buffer_copy(buf, RSTRING_PTR(str), buf->size);
-  
+  VALUE str;
+  struct buffer *buf;
+
+  Data_Get_Struct(self, struct buffer, buf);
+
+  str = rb_str_new(0, buf->size);
+  buffer_copy(buf, RSTRING_PTR(str), buf->size);
+
   return str;
 }
 
 /**
  *  call-seq:
  *    EventMachine::Buffer#read_from(io) -> Integer
- * 
+ *
  * Perform a nonblocking read of the the given IO object and fill
  * the buffer with any data received.  The call will read as much
  * data as it can until the read would block.
  */
 static VALUE Em_Buffer_read_from(VALUE self, VALUE io) {
-	struct buffer *buf;
+  struct buffer *buf;
 #if HAVE_RB_IO_T
   rb_io_t *fptr;
 #else
@@ -298,20 +298,24 @@ static VALUE Em_Buffer_read_from(VALUE self, VALUE io) {
   GetOpenFile(rb_convert_type(io, T_FILE, "IO", "to_io"), fptr);
   rb_io_set_nonblock(fptr);
 
+#ifdef HAVE_RB_IO_FD
+  return INT2NUM(buffer_read_from(buf, rb_io_fd(io)));
+#else
   return INT2NUM(buffer_read_from(buf, FPTR_TO_FD(fptr)));
+#endif
 }
 
 /**
  *  call-seq:
  *    EventMachine::Buffer#write_to(io) -> Integer
- * 
+ *
  * Perform a nonblocking write of the buffer to the given IO object.
  * As much data as possible is written until the call would block.
  * Any data which is written is removed from the buffer.
  */
 static VALUE Em_Buffer_write_to(VALUE self, VALUE io) {
   struct buffer *buf;
-#if HAVE_RB_IO_T 
+#if HAVE_RB_IO_T
   rb_io_t *fptr;
 #else
   OpenFile *fptr;
@@ -321,11 +325,16 @@ static VALUE Em_Buffer_write_to(VALUE self, VALUE io) {
   GetOpenFile(rb_convert_type(io, T_FILE, "IO", "to_io"), fptr);
   rb_io_set_nonblock(fptr);
 
-  return INT2NUM(buffer_write_to(buf, FPTR_TO_FD(fptr)));
+#ifdef HAVE_RB_IO_FD
+  return INT2NUM(buffer_read_from(buf, rb_io_fd(io)));
+#else
+  return INT2NUM(buffer_read_from(buf, FPTR_TO_FD(fptr)));
+#endif
+
 }
 
 /*
- * Ruby bindings end here.  Below is the actual implementation of 
+ * Ruby bindings end here.  Below is the actual implementation of
  * the underlying data structures.
  */
 
@@ -338,8 +347,8 @@ static struct buffer *buffer_new(void)
   buf->head = buf->tail = buf->pool_head = buf->pool_tail = 0;
   buf->size = 0;
   buf->node_size = DEFAULT_NODE_SIZE;
-	time(&buf->last_purged_at);
-	
+  time(&buf->last_purged_at);
+
   return buf;
 }
 
@@ -359,7 +368,7 @@ static void buffer_clear(struct buffer *buf)
 }
 
 /* Free a buffer */
-static void buffer_free(struct buffer *buf) 
+static void buffer_free(struct buffer *buf)
 {
   struct buffer_node *tmp;
 
@@ -381,11 +390,11 @@ static void buffer_gc(struct buffer *buf)
   time_t now;
   time(&now);
 
-	/* Only purge if we've passed the purge interval */
-	if(now - buf->last_purged_at < PURGE_INTERVAL)
-		return;
-		
-	buf->last_purged_at = now;
+  /* Only purge if we've passed the purge interval */
+  if(now - buf->last_purged_at < PURGE_INTERVAL)
+    return;
+
+  buf->last_purged_at = now;
 
   while(buf->pool_head && now - buf->pool_head->last_used_at >= MAX_AGE) {
     tmp = buf->pool_head;
@@ -394,7 +403,7 @@ static void buffer_gc(struct buffer *buf)
   }
 
   if(!buf->pool_head)
-		buf->pool_tail = 0;
+    buf->pool_tail = 0;
 }
 
 /* Create a new buffer_node (or pull one from the memory pool) */
@@ -494,11 +503,11 @@ static void buffer_append(struct buffer *buf, char *str, unsigned len)
   while(len > 0) {
     nbytes = buf->node_size - buf->tail->end;
     if(len < nbytes) nbytes = len;
-    
+
     memcpy(buf->tail->data + buf->tail->end, str, nbytes);
-    str += nbytes;    
+    str += nbytes;
     len -= nbytes;
-    
+
     buf->tail->end += nbytes;
 
     if(len > 0) {
@@ -541,7 +550,7 @@ static void buffer_copy(struct buffer *buf, char *str, unsigned len)
   unsigned nbytes;
   struct buffer_node *node;
 
-	node = buf->head;
+  node = buf->head;
   while(node && len > 0) {
     nbytes = node->end - node->start;
     if(len < nbytes) nbytes = len;
@@ -551,7 +560,7 @@ static void buffer_copy(struct buffer *buf, char *str, unsigned len)
     len -= nbytes;
 
     if(node->start + nbytes == node->end)
-			node = node->next;
+      node = node->next;
   }
 }
 
@@ -596,7 +605,7 @@ static int buffer_write_to(struct buffer *buf, int fd)
 /* Append data to the front of the buffer */
 static int buffer_read_from(struct buffer *buf, int fd)
 {
-	int bytes_read, total_bytes_read = 0;
+  int bytes_read, total_bytes_read = 0;
   unsigned nbytes;
 
   /* Empty list needs initialized */
@@ -605,26 +614,26 @@ static int buffer_read_from(struct buffer *buf, int fd)
     buf->tail = buf->head;
   }
 
-	do {
-	  nbytes = buf->node_size - buf->tail->end;
-		bytes_read = read(fd, buf->tail->data + buf->tail->end, nbytes);
-	
-		if(bytes_read < 1) {
-			if(errno != EAGAIN)
+  do {
+    nbytes = buf->node_size - buf->tail->end;
+    bytes_read = read(fd, buf->tail->data + buf->tail->end, nbytes);
+
+    if(bytes_read < 1) {
+      if(errno != EAGAIN)
         rb_sys_fail("read");
-			
-			return total_bytes_read;
-		}
-		
-		total_bytes_read += bytes_read; 
-		buf->tail->end += nbytes;
-		buf->size += nbytes;
-		
-		if(buf->tail->end == buf->node_size) {
+
+      return total_bytes_read;
+    }
+
+    total_bytes_read += bytes_read;
+    buf->tail->end += nbytes;
+    buf->size += nbytes;
+
+    if(buf->tail->end == buf->node_size) {
       buf->tail->next = buffer_node_new(buf);
       buf->tail = buf->tail->next;
-		}
-	} while(bytes_read == nbytes);
-	
-	return total_bytes_read;
+    }
+  } while(bytes_read == nbytes);
+
+  return total_bytes_read;
 }