igrigorik-em-http-request 0.1.7 → 0.1.8

data/README.rdoc

@@ -6,6 +6,9 @@ EventMachine based HTTP Request interface. Supports streaming response processin
 - Basic-Auth support
 - Custom timeouts 
 
+Screencast / Demo of using EM-HTTP-Request: 
+ - http://everburning.com/news/eventmachine-screencast-em-http-request/
+
 == Simple client example
 
   EventMachine.run {
@@ -61,9 +64,8 @@ EventMachine based HTTP Request interface. Supports streaming response processin
 
 == Streaming body processing
   EventMachine.run {
-    body = ''
-    on_body = lambda { |chunk| body += chunk }
-    http = EventMachine::HttpRequest.new('http://www.website.com/').get :on_response => on_body
+    http = EventMachine::HttpRequest.new('http://www.website.com/').get
+    http.stream { |chunk| print chunk }
 
     # ...
   }

data/Rakefile

@@ -34,6 +34,10 @@ task :ragel do
   end
 end
 
+task :spec do
+	sh 'spec test/test_*.rb'
+end
+
 def make(makedir)
   Dir.chdir(makedir) { sh MAKE }
 end

data/em-http-request.gemspec

@@ -1,6 +1,6 @@
 spec = Gem::Specification.new do |s|
   s.name = 'em-http-request'
-  s.version = '0.1.7'
+  s.version = '0.1.8'
   s.date = '2009-03-20'
   s.summary = 'EventMachine based HTTP Request interface'
   s.description = s.summary
@@ -34,7 +34,7 @@ spec = Gem::Specification.new do |s|
  "lib/em-http/decoders.rb",
  "lib/em-http/multi.rb",
  "lib/em-http/request.rb",
- "test/hash.rb",
+ "test/test_hash.rb",
  "test/helper.rb",
  "test/stallion.rb",
  "test/test_multi.rb",

data/lib/em-http/client.rb

@@ -1,4 +1,3 @@
-# -*- coding: undecided -*-
 # #--
 # Copyright (C)2008 Ilya Grigorik
 #
@@ -21,6 +20,16 @@ module EventMachine
 
     # The status code (as a string!)
     attr_accessor :http_status
+    
+    # E-Tag
+    def etag
+      self["ETag"]
+    end
+    
+    def last_modified
+      time = self["Last-Modified"]
+      Time.parse(time) if time
+    end
 
     # HTTP response status as an integer
     def status
@@ -32,6 +41,11 @@ module EventMachine
       Integer(self[HttpClient::CONTENT_LENGTH]) rescue nil
     end
 
+    # Cookie header from the server
+    def cookie
+      self[HttpClient::SET_COOKIE]
+    end
+
     # Is the transfer encoding chunked?
     def chunked_encoding?
       /chunked/i === self[HttpClient::TRANSFER_ENCODING]
@@ -94,12 +108,16 @@ module EventMachine
     end
 
     def encode_query(path, query)
-      return path unless query
-      if query.kind_of? String
-        return "#{path}?#{query}"
+      encoded_query = if query.kind_of?(Hash)
+        query.map { |k, v| encode_param(k, v) }.join('&')
       else
-        return path + "?" + query.map { |k, v| encode_param(k, v) }.join('&')
+        query.to_s
+      end
+      if !@uri.query.to_s.empty?
+        encoded_query = [encoded_query, @uri.query].reject {|part| part.empty?}.join("&")
       end
+      return path if encoded_query.to_s.empty?
+      "#{path}?#{encoded_query}"
     end
 
     # URL encodes query parameters:
@@ -134,8 +152,12 @@ module EventMachine
       end
     end
 
-    def encode_cookies(cookies)
-      cookies.inject('') { |result, (k, v)| result << encode_field('Cookie', encode_param(k, v)) }
+    def encode_cookie(cookie)
+      if cookie.is_a? Hash
+        cookie.inject('') { |result, (k, v)| result <<  encode_param(k, v) + ";" }
+      else
+        cookie
+      end
     end
   end
 
@@ -167,6 +189,7 @@ module EventMachine
       @inflate = []
       @errors = ''
       @content_decoder = nil
+      @stream = nil
     end
 
     # start HTTP request once we establish connection to host
@@ -177,7 +200,7 @@ module EventMachine
       send_request_header
       send_request_body
     end
-
+    
     # request is done, invoke the callback
     def on_request_complete
       begin
@@ -187,11 +210,19 @@ module EventMachine
       end
       unbind
     end
-
+    
     # request failed, invoke errback
-    def on_error(msg)
+    def on_error(msg, dns_error = false)
       @errors = msg
-      unbind
+      
+      # no connection signature on DNS failures
+      # fail the connection directly
+      dns_error == true ? fail : unbind
+    end
+
+    # assign a stream processing block
+    def stream(&blk)
+      @stream = blk
     end
 
     def normalize_body
@@ -221,6 +252,11 @@ module EventMachine
         @inflate = head['accept-encoding'].split(',').map {|t| t.strip}
       end
 
+      # Set the cookie header if provided
+      if cookie = head.delete('cookie')
+        head['cookie'] = encode_cookie(cookie)
+      end
+
       # Build the request
       request_header = encode_request(@method, @uri.path, query)
       request_header << encode_headers(head)
@@ -254,15 +290,19 @@ module EventMachine
     end
 
     def on_decoded_body_data(data)
-      if (on_response = @options[:on_response])
-        on_response.call(data)
+      if @stream
+        @stream.call(data)
       else
         @response << data
       end
     end
 
     def unbind
-      (@state == :finished) ? succeed(self) : fail
+      if @state == :finished
+        succeed(self) 
+      else
+        fail(self)
+      end
       close_connection
     end
 
@@ -320,11 +360,22 @@ module EventMachine
         return false
       end
 
+      # shortcircuit on HEAD requests 
+      if @method == "HEAD"
+        @state = :finished
+        on_request_complete
+      end
+
       if @response_header.chunked_encoding?
         @state = :chunk_header
       else
-        @state = :body
-        @bytes_remaining = @response_header.content_length
+        if @response_header.content_length > 0
+          @state = :body
+          @bytes_remaining = @response_header.content_length 
+        else
+          @state = :finished
+          on_request_complete
+        end
       end
 
       if @inflate.include?(response_header[CONTENT_ENCODING]) &&

data/lib/em-http/request.rb

@@ -47,13 +47,14 @@ module EventMachine
     #
 
     def get  options = {};    send_request(:get,  options);    end
+    def head options = {};    send_request(:head, options);    end
     def post options = {};    send_request(:post, options);    end
 
     protected
 
     def send_request(method, options)
       raise ArgumentError, "invalid request path" unless /^\// === @uri.path
-
+      
       method = method.to_s.upcase
       begin
        EventMachine.connect(@uri.host, @uri.port, EventMachine::HttpClient) { |c|
@@ -65,7 +66,7 @@ module EventMachine
       rescue RuntimeError => e 
         raise e unless e.message == "no connection"
         conn = EventMachine::HttpClient.new("")
-        conn.on_error("no connection")
+        conn.on_error("no connection", true)
         conn
       end
     end

data/test/stallion.rb

@@ -83,9 +83,19 @@ Stallion.saddle :spec do |stable|
     elsif stable.request.path_info == '/echo_content_length'
       stable.response.write stable.request.content_length
 
+    elsif stable.request.head?
+      stable.response.status = 200
+
     elsif stable.request.post?
       stable.response.write stable.request.body.read
 
+    elsif stable.request.path_info == '/set_cookie'
+      stable.response["Set-Cookie"] = "id=1; expires=Tue, 09-Aug-2011 17:53:39 GMT; path=/;"
+      stable.response.write "cookie set"
+
+    elsif stable.request.path_info == '/echo_cookie'
+      stable.response.write stable.request.env["HTTP_COOKIE"]
+
     elsif stable.request.path_info == '/timeout'
       sleep(10)
       stable.response.write 'timeout'
@@ -124,7 +134,11 @@ Stallion.saddle :spec do |stable|
 end
 
 Thread.new do
-  Stallion.run :Host => '127.0.0.1', :Port => 8080
+  begin
+    Stallion.run :Host => '127.0.0.1', :Port => 8080  
+  rescue Exception => e
+    print e
+  end
 end
 
-sleep(2)
+sleep(1)

data/test/{hash.rb → test_hash.rb}

@@ -1,6 +1,7 @@
 require 'test/helper'
 
 describe Hash do
+  
   describe ".to_params" do
     it "should transform a basic hash into HTTP POST Params" do
       {:a => "alpha", :b => "beta"}.to_params.should == "a=alpha&b=beta"
@@ -9,9 +10,10 @@ describe Hash do
     it "should transform a more complex hash into HTTP POST Params" do
       {:a => "a", :b => ["c", "d", "e"]}.to_params.should == "a=a&b[0]=c&b[1]=d&b[2]=e"
     end
-    
-    it "should transform a very complex hash into HTTP POST Params" do
-      {:a => "a", :b => [{:c => "c", :d => "d"}, {:e => "e", :f => "f"}]}.to_params.should == "a=a&b[0][d]=d&b[0][c]=c&b[1][e]=e&b[1][f]=f"
-    end
+
+    # Ruby 1.8 Hash is not sorted, so this test breaks randomly. Maybe once we're all on 1.9. ;-)
+    # it "should transform a very complex hash into HTTP POST Params" do
+    #    {:a => "a", :b => [{:c => "c", :d => "d"}, {:e => "e", :f => "f"}]}.to_params.should == "a=a&b[0][d]=d&b[0][c]=c&b[1][f]=f&b[1][e]=e"
+    # end
   end
 end

data/test/test_multi.rb

@@ -3,11 +3,6 @@ require 'test/stallion'
 
 describe EventMachine::MultiRequest do
 
-  def failed
-    EventMachine.stop
-    fail
-  end
-
   it "should submit multiple requests in parallel and return once all of them are complete" do
     EventMachine.run {
       
@@ -16,7 +11,7 @@ describe EventMachine::MultiRequest do
       
       # add multiple requests to the multi-handler
       multi.add(EventMachine::HttpRequest.new('http://127.0.0.1:8080/').get(:query => {:q => 'test'}))
-      multi.add(EventMachine::HttpRequest.new('http://169.169.169.169/').get)
+      multi.add(EventMachine::HttpRequest.new('http://0.0.0.0/').get(:timeout => 1))
       
       multi.callback  {
         # verify successfull request

data/test/test_request.rb

@@ -1,13 +1,13 @@
 require 'test/helper'
 require 'test/stallion'
-
+ 
 describe EventMachine::HttpRequest do
 
   def failed
     EventMachine.stop
     fail
   end
-
+  
   it "should fail GET on DNS timeout" do
     EventMachine.run {
       http = EventMachine::HttpRequest.new('http://127.1.1.1/').get
@@ -68,12 +68,26 @@ describe EventMachine::HttpRequest do
     }    
   end
 
+  it "should perform successfull HEAD with a URI passed as argument" do
+    EventMachine.run {
+      uri = URI.parse('http://127.0.0.1:8080/')
+      http = EventMachine::HttpRequest.new(uri).head
+
+      http.errback { failed }
+      http.callback {
+        http.response_header.status.should == 200
+        http.response.should == ""
+        EventMachine.stop
+      }
+    }    
+  end
+
   it "should return 404 on invalid path" do
     EventMachine.run {
       http = EventMachine::HttpRequest.new('http://127.0.0.1:8080/fail').get
 
       http.errback { failed }
-      http.callback {
+      http.callback { 
         http.response_header.status.should == 404
         EventMachine.stop
       }
@@ -247,10 +261,10 @@ describe EventMachine::HttpRequest do
   it "should timeout after 10 seconds" do
     EventMachine.run {
       t = Time.now.to_i
-      http = EventMachine::HttpRequest.new('http://127.0.0.1:8080/timeout').get :timeout => 2
+      http = EventMachine::HttpRequest.new('http://127.0.0.1:8080/timeout').get :timeout => 1
 
       http.errback {
-        (Time.now.to_i - t).should == 2
+        (Time.now.to_i - t).should >= 2
         EventMachine.stop
       }
       http.callback { failed }
@@ -260,10 +274,11 @@ describe EventMachine::HttpRequest do
   it "should optionally pass the response body progressively" do
     EventMachine.run {
       body = ''
-      on_body = lambda { |chunk| body += chunk }
-      http = EventMachine::HttpRequest.new('http://127.0.0.1:8080/').get :on_response => on_body
+      http = EventMachine::HttpRequest.new('http://127.0.0.1:8080/').get 
 
       http.errback { failed }
+      http.stream { |chunk| body += chunk }
+
       http.callback {
         http.response_header.status.should == 200
         http.response.should == ''
@@ -276,11 +291,11 @@ describe EventMachine::HttpRequest do
   it "should optionally pass the deflate-encoded response body progressively" do
     EventMachine.run {
       body = ''
-      on_body = lambda { |chunk| body += chunk }
-      http = EventMachine::HttpRequest.new('http://127.0.0.1:8080/deflate').get :head => {"accept-encoding" => "deflate, compressed"},
-      :on_response => on_body
+      http = EventMachine::HttpRequest.new('http://127.0.0.1:8080/deflate').get :head => {"accept-encoding" => "deflate, compressed"}
 
       http.errback { failed }
+      http.stream { |chunk| body += chunk }
+
       http.callback {
         http.response_header.status.should == 200
         http.response_header["CONTENT_ENCODING"].should == "deflate"
@@ -303,4 +318,41 @@ describe EventMachine::HttpRequest do
     }
   end
 
-end
+  it "should accept & return cookie header to user" do
+    EventMachine.run {
+      http = EventMachine::HttpRequest.new('http://127.0.0.1:8080/set_cookie').get
+
+      http.errback { failed }
+      http.callback {
+        http.response_header.status.should == 200
+        http.response_header.cookie.should == "id=1; expires=Tue, 09-Aug-2011 17:53:39 GMT; path=/;"
+        EventMachine.stop
+      }
+    }
+  end
+
+  it "should pass cookie header to server from string" do
+    EventMachine.run {
+      http = EventMachine::HttpRequest.new('http://127.0.0.1:8080/echo_cookie').get :head => {'cookie' => 'id=2;'}
+
+      http.errback { failed }
+      http.callback {
+        http.response.should == "id=2;"
+        EventMachine.stop
+      }
+    }
+  end
+
+  it "should pass cookie header to server from Hash" do
+    EventMachine.run {
+      http = EventMachine::HttpRequest.new('http://127.0.0.1:8080/echo_cookie').get :head => {'cookie' => {'id' => 2}}
+
+      http.errback { failed }
+      http.callback {
+        http.response.should == "id=2;"
+        EventMachine.stop
+      }
+    }
+  end
+  
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: igrigorik-em-http-request
 version: !ruby/object:Gem::Version 
-  version: 0.1.7
+  version: 0.1.8
 platform: ruby
 authors: 
 - Ilya Grigorik
@@ -52,13 +52,14 @@ files:
 - lib/em-http/decoders.rb
 - lib/em-http/multi.rb
 - lib/em-http/request.rb
-- test/hash.rb
+- test/test_hash.rb
 - test/helper.rb
 - test/stallion.rb
 - test/test_multi.rb
 - test/test_request.rb
 has_rdoc: true
 homepage: http://github.com/igrigorik/em-http-request
+licenses: 
 post_install_message: 
 rdoc_options: []
 
@@ -79,7 +80,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: em-http-request
-rubygems_version: 1.2.0
+rubygems_version: 1.3.5
 signing_key: 
 specification_version: 2
 summary: EventMachine based HTTP Request interface