em-http-request 0.2.13 → 0.2.14

data/Changelog.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 0.2.14 / 2010-10-06
+
+- bugfix: form-encode keys/values of ruby objects passed in as body
+
 ## 0.2.13 / 2010-09-25
 
 - added SOCKS5 proxy support

data/README.md

@@ -29,6 +29,7 @@ Libraries & Applications using em-http
 - [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
+- [Firering](http://github.com/EmmanuelOga/firering) - Eventmachine powered Campfire API
 - and many others.. drop me a link if you want yours included!
 
 Simple client example

data/Rakefile

@@ -19,9 +19,9 @@ task :default => :compile
 Rake::RDocTask.new(:rdoc) do |task|
   task.rdoc_dir = 'doc'
   task.title    = 'EventMachine::HttpRequest'
-  task.options = %w(--title HttpRequest --main README --line-numbers)
+  task.options = %w(--title HttpRequest --main README.md --line-numbers)
   task.rdoc_files.include(['lib/**/*.rb'])
-  task.rdoc_files.include(['README', 'LICENSE'])
+  task.rdoc_files.include(['README.md', 'LICENSE'])
 end
 
 # Rebuild parser Ragel

data/VERSION

@@ -1 +1 @@
-0.2.13
+0.2.14

data/em-http-request.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{em-http-request}
-  s.version = "0.2.13"
+  s.version = "0.2.14"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Ilya Grigorik"]
-  s.date = %q{2010-09-25}
+  s.date = %q{2010-10-06}
   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"]
@@ -43,14 +43,13 @@ Gem::Specification.new do |s|
      "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/encoding_spec.rb",
      "spec/fixtures/google.ca",
-     "spec/hash_spec.rb",
      "spec/helper.rb",
      "spec/mock_spec.rb",
      "spec/multi_spec.rb",
@@ -67,7 +66,7 @@ Gem::Specification.new do |s|
   s.rubygems_version = %q{1.3.7}
   s.summary = %q{EventMachine based, async HTTP Request interface}
   s.test_files = [
-    "spec/hash_spec.rb",
+    "spec/encoding_spec.rb",
      "spec/helper.rb",
      "spec/mock_spec.rb",
      "spec/multi_spec.rb",

data/lib/em-http-request.rb

@@ -1 +1 @@
-require 'em-http'
+require 'em-http'

data/lib/em-http.rb

@@ -10,7 +10,6 @@ require 'socket'
 require File.dirname(__FILE__) + '/http11_client'
 require File.dirname(__FILE__) + '/em_buffer'
 
-require File.dirname(__FILE__) + '/em-http/core_ext/hash'
 require File.dirname(__FILE__) + '/em-http/core_ext/bytesize'
 
 require File.dirname(__FILE__) + '/em-http/client'

data/lib/em-http/client.rb

@@ -82,9 +82,9 @@ module EventMachine
 
     # Escapes a URI.
     def escape(s)
-      s.to_s.gsub(/([^ a-zA-Z0-9_.-]+)/n) {
+      s.to_s.gsub(/([^a-zA-Z0-9_.-]+)/n) {
         '%'+$1.unpack('H2'*bytesize($1)).join('%').upcase
-      }.tr(' ', '+')
+      }
     end
 
     # Unescapes a URI escaped string.
@@ -153,6 +153,29 @@ module EventMachine
       end
     end
 
+    def form_encode_body(obj)
+      pairs = []
+      recursive = Proc.new do |h, prefix|
+        h.each do |k,v|
+          key = prefix == '' ? escape(k) : "#{prefix}[#{escape(k)}]"
+
+          if v.is_a? Array
+            nh = Hash.new
+            v.size.times { |t| nh[t] = v[t] }
+            recursive.call(nh, key)
+
+          elsif v.is_a? Hash
+            recursive.call(v, key)
+          else
+            pairs << "#{key}=#{escape(v)}"
+          end
+        end
+      end
+
+      recursive.call(obj, '')
+      return pairs.join('&')
+    end
+
     # Encode a field in an HTTP header
     def encode_field(k, v)
       FIELD_ENCODING % [k, v]
@@ -236,8 +259,8 @@ module EventMachine
         @state = :connect_socks_proxy
         send_socks_handshake
 
-      # if we need to negotiate the proxy connection first, then
-      # issue a CONNECT query and wait for 200 response
+        # if we need to negotiate the proxy connection first, then
+        # issue a CONNECT query and wait for 200 response
       elsif connect_proxy? and @state == :response_header
         @state = :connect_http_proxy
         send_request_header
@@ -308,7 +331,7 @@ module EventMachine
     def normalize_body
       @normalized_body ||= begin
         if @options[:body].is_a? Hash
-          @options[:body].to_params
+          form_encode_body(@options[:body])
         else
           @options[:body]
         end
@@ -845,4 +868,3 @@ module EventMachine
   end
 
 end
-

data/lib/em-http/decoders.rb

@@ -1,122 +1,122 @@
-require 'zlib'
-require 'stringio'
-
-##
-# Provides a unified callback interface to decompression libraries.
-module EventMachine::HttpDecoders
-
-  class DecoderError < StandardError
-  end
-
-  class << self
-    def accepted_encodings
-      DECODERS.inject([]) { |r,d| r + d.encoding_names }
-    end
-
-    def decoder_for_encoding(encoding)
-      DECODERS.each { |d|
-        return d if d.encoding_names.include? encoding
-      }
-      nil
-    end
-  end
-
-  class Base
-    def self.encoding_names
-      name = to_s.split('::').last.downcase
-      [name]
-    end
-
-    ##
-    # chunk_callback:: [Block] To handle a decompressed chunk
-    def initialize(&chunk_callback)
-      @chunk_callback = chunk_callback
-    end
-
-    def <<(compressed)
-      return unless compressed && compressed.size > 0
-
-      decompressed = decompress(compressed)
-      receive_decompressed decompressed
-    end
-
-    def finalize!
-      decompressed = finalize
-      receive_decompressed decompressed
-    end
-    
-    private
-
-    def receive_decompressed(decompressed)
-      if decompressed && decompressed.size > 0
-        @chunk_callback.call(decompressed)
-      end
-    end
-
-    protected
-
-    ##
-    # Must return a part of decompressed
-    def decompress(compressed)
-      nil
-    end
-
-    ##
-    # May return last part
-    def finalize
-      nil
-    end
-  end
-
-  class Deflate < Base
-    def decompress(compressed)
-      begin
-        @zstream ||= Zlib::Inflate.new(nil)
-        @zstream.inflate(compressed)
-      rescue Zlib::Error
-        raise DecoderError
-      end
-    end
-
-    def finalize
-      return nil unless @zstream
-
-      begin
-        r = @zstream.inflate(nil)
-        @zstream.close
-        r
-      rescue Zlib::Error
-        raise DecoderError
-      end
-    end
-  end
-
-  ##
-  # Oneshot decompressor, due to lack of a streaming Gzip reader
-  # implementation. We may steal code from Zliby to improve this.
-  #
-  # For now, do not put `gzip' or `compressed' in your accept-encoding
-  # header if you expect much data through the :on_response interface.
-  class GZip < Base
-    def self.encoding_names
-      %w(gzip compressed)
-    end
-
-    def decompress(compressed)
-      @buf ||= ''
-      @buf += compressed
-      nil
-    end
-
-    def finalize
-      begin
-        Zlib::GzipReader.new(StringIO.new(@buf.to_s)).read
-      rescue Zlib::Error
-        raise DecoderError
-      end
-    end
-  end
-
-  DECODERS = [Deflate, GZip]
-
-end
+require 'zlib'
+require 'stringio'
+
+##
+# Provides a unified callback interface to decompression libraries.
+module EventMachine::HttpDecoders
+
+  class DecoderError < StandardError
+  end
+
+  class << self
+    def accepted_encodings
+      DECODERS.inject([]) { |r,d| r + d.encoding_names }
+    end
+
+    def decoder_for_encoding(encoding)
+      DECODERS.each { |d|
+        return d if d.encoding_names.include? encoding
+      }
+      nil
+    end
+  end
+
+  class Base
+    def self.encoding_names
+      name = to_s.split('::').last.downcase
+      [name]
+    end
+
+    ##
+    # chunk_callback:: [Block] To handle a decompressed chunk
+    def initialize(&chunk_callback)
+      @chunk_callback = chunk_callback
+    end
+
+    def <<(compressed)
+      return unless compressed && compressed.size > 0
+
+      decompressed = decompress(compressed)
+      receive_decompressed decompressed
+    end
+
+    def finalize!
+      decompressed = finalize
+      receive_decompressed decompressed
+    end
+    
+    private
+
+    def receive_decompressed(decompressed)
+      if decompressed && decompressed.size > 0
+        @chunk_callback.call(decompressed)
+      end
+    end
+
+    protected
+
+    ##
+    # Must return a part of decompressed
+    def decompress(compressed)
+      nil
+    end
+
+    ##
+    # May return last part
+    def finalize
+      nil
+    end
+  end
+
+  class Deflate < Base
+    def decompress(compressed)
+      begin
+        @zstream ||= Zlib::Inflate.new(nil)
+        @zstream.inflate(compressed)
+      rescue Zlib::Error
+        raise DecoderError
+      end
+    end
+
+    def finalize
+      return nil unless @zstream
+
+      begin
+        r = @zstream.inflate(nil)
+        @zstream.close
+        r
+      rescue Zlib::Error
+        raise DecoderError
+      end
+    end
+  end
+
+  ##
+  # Oneshot decompressor, due to lack of a streaming Gzip reader
+  # implementation. We may steal code from Zliby to improve this.
+  #
+  # For now, do not put `gzip' or `compressed' in your accept-encoding
+  # header if you expect much data through the :on_response interface.
+  class GZip < Base
+    def self.encoding_names
+      %w(gzip compressed)
+    end
+
+    def decompress(compressed)
+      @buf ||= ''
+      @buf += compressed
+      nil
+    end
+
+    def finalize
+      begin
+        Zlib::GzipReader.new(StringIO.new(@buf.to_s)).read
+      rescue Zlib::Error
+        raise DecoderError
+      end
+    end
+  end
+
+  DECODERS = [Deflate, GZip]
+
+end

data/spec/encoding_spec.rb

@@ -0,0 +1,34 @@
+require 'spec/helper'
+
+describe EventMachine::HttpEncoding do
+  include EventMachine::HttpEncoding
+
+  it "should transform a basic hash into HTTP POST Params" do
+    form_encode_body({:a => "alpha", :b => "beta"}).should == "a=alpha&b=beta"
+  end
+
+  it "should transform a more complex hash into HTTP POST Params" do
+    form_encode_body({:a => "a", :b => ["c", "d", "e"]}).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
+    params = form_encode_body({:a => "a", :b => [{:c => "c", :d => "d"}, {:e => "e", :f => "f"}]})
+    params.should == "a=a&b[0][c]=c&b[0][d]=d&b[1][e]=e&b[1][f]=f"
+  end
+
+  it "should escape values" do
+    params = form_encode_body({:stuff => 'string&string'})
+    params.should == "stuff=string%26string"
+  end
+
+  it "should escape keys" do
+    params = form_encode_body({'bad&str'=> {'key&key' => [:a, :b]}})
+    params.should == 'bad%26str[key%26key][0]=a&bad%26str[key%26key][1]=b'
+  end
+
+  it "should escape keys and values" do
+    params = form_encode_body({'bad&str'=> {'key&key' => ['bad+&stuff', '[test]']}})
+    params.should == "bad%26str[key%26key][0]=bad%2B%26stuff&bad%26str[key%26key][1]=%5Btest%5D"
+  end
+
+end

data/spec/request_spec.rb

@@ -247,6 +247,19 @@ describe EventMachine::HttpRequest do
     }
   end
 
+  it "should escape body on POST" do
+    EventMachine.run {
+      http = EventMachine::HttpRequest.new('http://127.0.0.1:8080/').post :body => {:stuff => 'string&string'}
+
+      http.errback { failed }
+      http.callback {
+        http.response_header.status.should == 200
+        http.response.should == "stuff=string%26string"
+        EventMachine.stop
+      }
+    }
+  end
+
   it "should perform successfull POST with Ruby Hash/Array as params" do
     EventMachine.run {
       http = EventMachine::HttpRequest.new('http://127.0.0.1:8080/').post :body => {"key1" => 1, "key2" => [2,3]}

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 2
-  - 13
-  version: 0.2.13
+  - 14
+  version: 0.2.14
 platform: ruby
 authors: 
 - Ilya Grigorik
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-25 00:00:00 -04:00
+date: 2010-10-06 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -83,14 +83,13 @@ files:
 - 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/encoding_spec.rb
 - spec/fixtures/google.ca
-- spec/hash_spec.rb
 - spec/helper.rb
 - spec/mock_spec.rb
 - spec/multi_spec.rb
@@ -133,7 +132,7 @@ signing_key:
 specification_version: 3
 summary: EventMachine based, async HTTP Request interface
 test_files: 
-- spec/hash_spec.rb
+- spec/encoding_spec.rb
 - spec/helper.rb
 - spec/mock_spec.rb
 - spec/multi_spec.rb

data/lib/em-http/core_ext/hash.rb

@@ -1,53 +0,0 @@
-class Hash
-  # Stolen partially from Merb : http://noobkit.com/show/ruby/gems/development/merb/hash/to_params.html
-  # Convert this hash to a query string:
-  #   
-  #   { :name => "Bob",
-  #     :address => {
-  #       :street => '111 Ruby Ave.',
-  #       :city => 'Ruby Central',
-  #       :phones => ['111-111-1111', '222-222-2222']
-  #     }
-  #   }.to_params
-  #   #=> "name=Bob&address[city]=Ruby Central&address[phones]=111-111-1111222-222-2222&address[street]=111 Ruby Ave."
-  # 
-  def to_params
-    params = ''
-    stack = []
-    
-    each do |k, v|
-      if v.is_a?(Hash)
-        stack << [k,v]
-      elsif v.is_a?(Array)
-        stack << [k,Hash.from_array(v)]
-      else
-        params << "#{k}=#{v}&"
-      end
-    end
-    
-    stack.each do |parent, hash|
-      hash.each do |k, v|
-        if v.is_a?(Hash)
-          stack << ["#{parent}[#{k}]", v]
-        else
-          params << "#{parent}[#{k}]=#{v}&"
-        end
-      end
-    end
-    
-    params.chop! # trailing &
-    params
-  end
-  
-  ##
-  # Builds a hash from an array with keys as array indices.
-  def self.from_array(array = [])
-    h = Hash.new
-    array.size.times do |t|
-      h[t] = array[t]
-    end
-    h
-  end
-
-end
-

data/spec/hash_spec.rb

@@ -1,24 +0,0 @@
-require 'spec/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.split("&").should include "a=alpha"
-      {:a => "alpha", :b => "beta"}.to_params.split("&").should include "b=beta"
-    end
-    
-    it "should transform a more complex hash into HTTP POST Params" do
-      {:a => "a", :b => ["c", "d", "e"]}.to_params.split("&").should include "a=a"
-      {:a => "a", :b => ["c", "d", "e"]}.to_params.split("&").should include "b[0]=c"
-      {:a => "a", :b => ["c", "d", "e"]}.to_params.split("&").should include "b[1]=d"
-      {:a => "a", :b => ["c", "d", "e"]}.to_params.split("&").should include "b[2]=e"
-    end
-
-    it "should transform a very complex hash into HTTP POST Params" do
-      params = {:a => "a", :b => [{:c => "c", :d => "d"}, {:e => "e", :f => "f"}]}.to_params.split("&")
-      params.should include "a=a"
-      params.should include "b[0][d]=d"
-    end
-  end
-end