em-net-http 0.1.3 → 0.2.0

data/Gemfile

@@ -3,7 +3,10 @@ source :rubygems
 gem 'em-http-request'
 group :development do
   gem 'rspec', '>= 1.2.9'
+  gem 'diff-lcs'
   gem 'weary'
   gem 'right_aws'
   gem 'tumblr-rb'
+  gem 'mimic', '>= 0.3.0'
+  gem 'rake'
 end

data/README.md

@@ -21,9 +21,13 @@ fiber:
     
 The above will run without blocking your carefully-tuned nonblocking webapp.
 
-I have vaguely tested <tt>em-net-http</tt> with <tt>[right_aws][3]</tt>,
-[Weary][4] and the [Tumblr gem][5]. There's no actual unit tests as such; if you're
-feeling smarter than I am, please feel free to contribute some! <tt>:-)</tt>
+There are a few tests (taking advantage of Luke Redpath's very useful [Mimic][6] gem)
+that assert that responses are identical to those created by <tt>Net::HTTP</tt>.
+These are by no means exhaustive; if you're using <tt>Net::HTTP</tt> in some other way
+and the <tt>em-net-http</tt>'s behaviour is not what you expect, do send me a failing test
+case.
+
+Currently tested with Ruby (MRI) 1.9.1 and 1.9.2.
 
 ### Caveat
 
@@ -35,4 +39,5 @@ therefore vary. Please feed me patches, pull requests and bug reports!
 [2]: http://rubyeventmachine.com/
 [3]: http://rightaws.rubyforge.org/
 [4]: http://github.com/mwunsch/weary
-[5]: http://github.com/mwunsch/tumblr
+[5]: http://github.com/mwunsch/tumblr
+[6]: http://github.com/lukeredpath/mimic

data/Rakefile

@@ -11,10 +11,10 @@ begin
     gem.homepage = "http://github.com/jfairbairn/em-net-http"
     gem.authors = ["James Fairbairn"]
     gem.add_development_dependency "rspec", ">= 1.2.9"
-    gem.add_development_dependency "weary"
-    gem.add_development_dependency "right_aws"
-    
-    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+    gem.add_development_dependency "mimic", ">= 0.3.0"
+    gem.add_development_dependency 'weary'
+    gem.add_development_dependency 'right_aws'
+    gem.add_development_dependency 'tumblr-rb'
   end
   Jeweler::GemcutterTasks.new
 rescue LoadError

data/VERSION

@@ -1 +1 @@
-0.1.3
+0.2.0

data/bin/autospec

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'autospec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile", __FILE__)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rspec', 'autospec')

data/bin/htmldiff

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'htmldiff' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile", __FILE__)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('diff-lcs', 'htmldiff')

data/bin/ldiff

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'ldiff' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile", __FILE__)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('diff-lcs', 'ldiff')

data/bin/oauth

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'oauth' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile", __FILE__)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('oauth', 'oauth')

data/bin/rackup

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rackup' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile", __FILE__)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rack', 'rackup')

data/bin/rake

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile", __FILE__)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rake', 'rake')

data/bin/spec

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'spec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile", __FILE__)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rspec', 'spec')

data/bin/tumblr

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'tumblr' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile", __FILE__)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('tumblr-rb', 'tumblr')

data/em-net-http.gemspec

@@ -5,13 +5,14 @@
 
 Gem::Specification.new do |s|
   s.name = %q{em-net-http}
-  s.version = "0.1.3"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["James Fairbairn"]
-  s.date = %q{2010-08-18}
+  s.date = %q{2010-08-21}
   s.description = %q{Monkeypatching Net::HTTP to use em-http-request under the hood.}
   s.email = %q{james@netlagoon.com}
+  s.executables = ["autospec", "htmldiff", "ldiff", "oauth", "rackup", "rake", "spec", "tumblr"]
   s.extra_rdoc_files = [
     "LICENSE",
      "README.md"
@@ -49,17 +50,23 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_development_dependency(%q<mimic>, [">= 0.3.0"])
       s.add_development_dependency(%q<weary>, [">= 0"])
       s.add_development_dependency(%q<right_aws>, [">= 0"])
+      s.add_development_dependency(%q<tumblr-rb>, [">= 0"])
     else
       s.add_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_dependency(%q<mimic>, [">= 0.3.0"])
       s.add_dependency(%q<weary>, [">= 0"])
       s.add_dependency(%q<right_aws>, [">= 0"])
+      s.add_dependency(%q<tumblr-rb>, [">= 0"])
     end
   else
     s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    s.add_dependency(%q<mimic>, [">= 0.3.0"])
     s.add_dependency(%q<weary>, [">= 0"])
     s.add_dependency(%q<right_aws>, [">= 0"])
+    s.add_dependency(%q<tumblr-rb>, [">= 0"])
   end
 end
 

data/lib/em-net-http.rb

@@ -5,65 +5,85 @@ require 'net/http'
 require 'fiber'
 
 module EventMachine
-  class NetHTTPResponse
-    attr_reader :code, :body, :header, :message, :http_version
-    alias_method :msg, :message
+  module NetHTTP
+    class Response
+      attr_reader :code, :body, :header, :message, :http_version
+      alias_method :msg, :message
     
-    def initialize(res)
-      @code = res.response_header.http_status
-      @message = res.response_header.http_reason
-      @http_version = res.response_header.http_version
-      @header = res.response_header
-      @body = res.response
-    end
+      def initialize(res)
+        @code = res.response_header.http_status
+        @message = res.response_header.http_reason
+        @http_version = res.response_header.http_version
+        @header = res.response_header
+        @body = res.response
+      end
     
-    def content_type
-      self['content-type']
-    end
+      def content_type
+        self['content-type']
+      end
     
-    def [](k)
-      @header[key(k)]
-    end
+      def [](k)
+        @header[key(k)]
+      end
     
-    def key?(k)
-      @header.key? key(k)
-    end
+      def key?(k)
+        @header.key? key(k)
+      end
     
-    def read_body(dest=nil,&block)
-      @body
-    end
+      def read_body(dest=nil,&block)
+        @body
+      end
     
-    def to_hash
-      h={}
-      @header.each do |k, v|
-        h[fromkey(k)] = v
+      def to_hash
+        h={}
+        @header.each do |k, v|
+          h[fromkey(k)] = v
+        end
+        h
       end
-      h
-    end
       
-    private
-    def key(k)
-      k.upcase.tr('-','_')
-    end
+      private
+      def key(k)
+        k.upcase.tr('-','_')
+      end
     
-    def fromkey(k)
-      k.tr('_', '-').split('-').map{|i|i.capitalize}.join('-')
-    end
+      def fromkey(k)
+        k.tr('_', '-').split('-').map{|i|i.capitalize}.join('-')
+      end
     
-    include Enumerable
-    def each(&blk)
-      @header.each(&blk)
-    end
+      include Enumerable
+      def each(&blk)
+        @header.each(&blk)
+      end
     
+    end
   end
 end
   
 
 module Net
+  class HTTPResponse
+    class << self
+      public :response_class
+    end
+    
+    alias_method :orig_net_http_read_body, :read_body
+
+    def read_body(dest=nil, &block)
+      return orig_net_http_read_body(dest, &block) unless ::EM.reactor_running?
+      @body
+    end
+  end
+  
   class HTTP
+    alias_method :orig_net_http_request, :request
+    
     def request(req, body = nil, &block)
-      f=Fiber.current
+
+      return orig_net_http_request(req, body, &block) unless ::EM.reactor_running?
+
       uri = Addressable::URI.parse("#{use_ssl? ? 'https://' : 'http://'}#{addr_port}#{req.path}")
+
       body = body || req.body
       opts = body.nil? ? {} : {:body => body}
       if use_ssl?
@@ -72,14 +92,32 @@ module Net
         sslopts[:private_key_file] = key if key
         sslopts[:cert_chain_file] = ca_file if ca_file
       end
+
       headers = opts[:head] = {}
       req.each do |k, v|
         headers[k] = v
       end
+
       headers['content-type'] ||= "application/x-www-form-urlencoded"
+      
       httpreq = EM::HttpRequest.new(uri).send(req.class::METHOD.downcase.to_sym, opts)
-      httpreq.callback {|res|f.resume(EM::NetHTTPResponse.new(res))}
-      httpreq.errback {|res|f.resume(EM::NetHTTPResponse.new(res))}
+
+      f=Fiber.current
+
+      convert_em_http_response = lambda do |res|
+        emres = EM::NetHTTP::Response.new(res)
+        nhresclass = Net::HTTPResponse.response_class(emres.code)
+        nhres = nhresclass.new(emres.http_version, emres.code, emres.message)
+        emres.to_hash.each do |k, v|
+          nhres.add_field(k, v)
+        end
+        nhres.body = emres.body if req.response_body_permitted? && nhresclass.body_permitted?
+        nhres.instance_variable_set '@read', true
+        f.resume nhres
+      end
+
+      httpreq.callback &convert_em_http_response
+      httpreq.errback &convert_em_http_response
       res = Fiber.yield
       yield res if block_given?
       res

data/spec/em-net-http_spec.rb

@@ -1,7 +1,98 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
-describe "EmNetHttp" do
-  it "fails" do
-    fail "hey buddy, you should probably rename this file and start specing for real"
+describe "em-net-http" do
+  describe 'should be compatible' do
+    it 'for Net::HTTP.get()' do
+      run_requests {Net::HTTP.get(URI.parse('http://localhost/hello'))}
+      @expected_res.should == @actual_res
+    end
+
+    # it 'for Net::HTTP.get_print()' do
+    #   run_requests {Net::HTTP.get_print(URI.parse('http://localhost/hello'))}
+    #   @expected_res.should == @actual_res
+    # end
+
+    # We don't test responses like 100 Continue at the moment.
+    %w(200 201 202 203 204 205 206 300 301 302 303 307 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 500 501 502 503 504 505).each do |code|
+      it "for Net::HTTP.start(host, port, &block) with response code #{code}" do
+        assert_identical {
+          Net::HTTP.start('localhost', Mimic::MIMIC_DEFAULT_PORT) do |http|
+            http.get("/code/#{code}")
+          end
+        }
+      end
+  
+      it "for Net::HTTP.new(host, port).start(&block) with response code #{code}" do
+        assert_identical {
+          h = Net::HTTP.new('localhost', Mimic::MIMIC_DEFAULT_PORT)
+          h.start do |http|
+            http.get("/code/#{code}")
+          end
+        }
+      end
+    end
+    
+    it "with response code 304" do
+      assert_identical {
+        Net::HTTP.start('localhost', Mimic::MIMIC_DEFAULT_PORT) do |http|
+          req = Net::HTTP::Get.new('/code/304')
+          req['If-Modified-Since'] = Time.now.rfc2822
+          http.request(req)
+        end
+      }
+      
+    end
+    
+    it 'with post' do
+      assert_identical {
+        Net::HTTP.start('localhost', Mimic::MIMIC_DEFAULT_PORT) do |http|
+          req = Net::HTTP::Post.new('/testpost')
+          req.body = 'hello mimic'
+          http.request(req)
+        end
+      }
+      
+    end
+    
+  end
+  
+  def run_requests(&block)
+    @expected_res = yield
+    EM.run do
+      Fiber.new do
+        @actual_res = yield
+      end.resume
+      EM.add_periodic_timer(0.0) do
+        EM.stop_event_loop if @actual_res
+      end
+    end
+  end
+  
+  def assert_identical(&block)
+    run_requests(&block)
+    @actual_res.should match_response(@expected_res)
+  end
+  
+  def match_response(expected)
+    ResponseMatcher.new(expected)
+  end
+  
+  class ResponseMatcher
+    def initialize(expected)
+      @expected = expected
+    end
+    
+    def matches?(actual)
+      # Dates could differ slightly :(
+      expected_date = Time.parse(@expected.delete('date').join)
+      actual_date = Time.parse(actual.delete('date').join)
+      actual_date.should >= expected_date
+      actual_date.should <= expected_date + 2
+      [:class, :code, :to_hash, :body].each do |i|
+        actual.send(i).should == @expected.send(i)
+      end
+      true
+    end
+    
   end
 end

data/spec/spec_helper.rb

@@ -1,9 +1,28 @@
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 require 'em-net-http'
+require 'time'
 require 'spec'
 require 'spec/autorun'
 
+require 'mimic'
+
 Spec::Runner.configure do |config|
+  config.before(:all) do
+    Mimic.mimic do
+      Net::HTTPResponse::CODE_TO_OBJ.each do |code, klass|
+        get("/code/#{code}").returning("#{code} #{klass.name}", code.to_i, {})
+      end
+      
+      get('/hello').returning('Hello World!', 200, {'Content-Type'=>'text/plain'})
+      
+      post('/testpost') do
+        "You said #{request.body.read}."
+      end
+    end
+  end
   
+  config.after(:all) do
+    Mimic.cleanup!
+  end
 end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 1
-  - 3
-  version: 0.1.3
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - James Fairbairn
@@ -14,12 +14,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-18 00:00:00 +01:00
+date: 2010-08-21 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rspec
-  prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -31,10 +30,10 @@ dependencies:
         - 9
         version: 1.2.9
   type: :development
+  prerelease: false
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: weary
-  prerelease: false
+  name: mimic
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -42,12 +41,14 @@ dependencies:
       - !ruby/object:Gem::Version 
         segments: 
         - 0
-        version: "0"
+        - 3
+        - 0
+        version: 0.3.0
   type: :development
+  prerelease: false
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: right_aws
-  prerelease: false
+  name: weary
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -57,11 +58,45 @@ dependencies:
         - 0
         version: "0"
   type: :development
+  prerelease: false
   version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: right_aws
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: tumblr-rb
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id005
 description: Monkeypatching Net::HTTP to use em-http-request under the hood.
 email: james@netlagoon.com
-executables: []
-
+executables: 
+- autospec
+- htmldiff
+- ldiff
+- oauth
+- rackup
+- rake
+- spec
+- tumblr
 extensions: []
 
 extra_rdoc_files: 
@@ -83,6 +118,14 @@ files:
 - spec/em-net-http_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
+- bin/autospec
+- bin/htmldiff
+- bin/ldiff
+- bin/oauth
+- bin/rackup
+- bin/rake
+- bin/spec
+- bin/tumblr
 has_rdoc: true
 homepage: http://github.com/jfairbairn/em-net-http
 licenses: []
@@ -97,6 +140,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 969805767585921057
       segments: 
       - 0
       version: "0"