eventmachine_httpserver 0.0.1 → 0.1.1

data/Rakefile

@@ -1,85 +1,92 @@
 # $Id: Rakefile 3546 2006-12-31 21:01:27Z francis $
-# Rakefile for the Bayshore configurable LDAP server.
-#
-
 
 require 'rake/gempackagetask'
 require 'rake/clean'
+require 'rake/testtask'
 
-
-
-$can_minitar = false
-begin
-  require 'archive/tar/minitar'
-  require 'zlib'
-  $can_minitar  = true
-rescue LoadError
+Rake::TestTask.new do |t|
+  t.libs += %w(ext)
+  t.test_files = FileList['test/test_*.rb']
+  t.verbose = true
 end
 
-$version = "0.0.1"
-$distdir  = "eventmachine_httpserver-#{$version}"
-$tardist  = "#$distdir.tar.gz"
-$name = "eventmachine_httpserver"
-
+namespace :build do
+  sources = FileList['ext/*.{cpp,c,h}']
 
-spec = eval(File.read("eventmachine_httpserver.gemspec"))
-spec.version = $version
-desc "Build the RubyGem for EventMachine HTTP Server"
-task :gem => ["pkg/eventmachine_httpserver-#{$version}.gem"]
-Rake::GemPackageTask.new(spec) do |g|
-  if $can_minitar
-    g.need_tar    = true
-    g.need_zip    = true
+  file 'ext/Makefile' => 'ext/extconf.rb' do
+    Dir.chdir 'ext' do
+      ruby 'extconf.rb'
+    end
   end
-  g.package_dir = "pkg"
-end
-
-
-specbinary = eval(File.read("eventmachine_httpserver-binary.gemspec"))
-specbinary.version = $version
-desc "Build a binary RubyGem for EventMachine HTTP Server"
-task :gembinary => ["pkg/eventmachine_httpserver-binary-#{$version}.gem"]
-Rake::GemPackageTask.new(specbinary) do |g|
-  if $can_minitar
-    g.need_tar    = true
-    g.need_zip    = true
+  CLEAN.include('ext/Makefile')
+  CLEAN.include('ext/*.log')
+  
+  libfile = "ext/eventmachine_httpserver.#{Config::CONFIG['DLEXT']}"
+  file libfile => ['ext/Makefile', *sources] do
+    Dir.chdir 'ext' do
+      make = case RUBY_PLATFORM
+      when /mswin32/
+        'nmake'
+      else
+        # typical gcc stack, might need a case for gmake on some
+        'make'
+      end
+      sh make
+    end
   end
-  g.package_dir = "pkg"
+  CLEAN.include(libfile)
+  
+  task :makefile => 'ext/Makefile'
+  
+  task :extension => libfile
 end
 
+desc "Build the extension inside the ext dir"
+task :build => :"build:extension"
+
+desc "Build as necessary, then run tests"
+task :test => :build
+
+namespace :gem do
+  # TODO : use rake-compiler (github.com/luislavena/rake-compiler) for this!
+  # specbinary = eval(File.read("eventmachine_httpserver-binary.gemspec"))
+  # specbinary.version = $version
+  # desc "Build a binary RubyGem for EventMachine HTTP Server"
+  # task :gembinary => ["pkg/eventmachine_httpserver-binary-#{$version}.gem"]
+  # Rake::GemPackageTask.new(specbinary)
+
+  def gemspec
+    # The template executes some ruby code to make a manifest, so we just eval 
+    # it. Later you could fill it with an ERB processor or whatever. It must 
+    # return a valid gemspec object.
+    @gemspec ||= eval(File.read("eventmachine_httpserver.gemspec.tmpl"))
+  end
 
+  def version
+    gemspec.version
+  end
 
-def run_test_package test, filename_array
-  require 'test/unit/testsuite'
-  require 'test/unit/ui/console/testrunner'
-
-  runner = Test::Unit::UI::Console::TestRunner
-
-  $LOAD_PATH.unshift('test')
-  $stderr.puts "Checking for test cases:" if test.verbose
-  filename_array.each do |testcase|
-    $stderr.puts "\t#{testcase}" if test.verbose
-    load testcase
+  file "eventmachine_httpserver.gemspec" => 'eventmachine_httpserver.gemspec.tmpl' do |t|
+    open(t.name, 'w') { |f| f.write gemspec.to_ruby }
   end
 
-  suite = Test::Unit::TestSuite.new($name)
+  desc "Generate the gemspec from template"
+  task :spec => "eventmachine_httpserver.gemspec"
 
-  ObjectSpace.each_object(Class) do |testcase|
-    suite << testcase.suite if testcase < Test::Unit::TestCase
+  file "eventmachine_httpserver-#{version}.gem" => :"gem:spec" do
+    sh "gem build eventmachine_httpserver.gemspec"
   end
 
-  runner.run(suite)
-end
+  desc "Build the RubyGem for EventMachine HTTP Server"
+  task :build => "eventmachine_httpserver-#{version}.gem"
 
-desc "Run the tests for #$name."
-task :test do |t|
-    run_test_package t, Dir['test/*.rb']
-end
+  desc "run gem install on the built gem"
+  task :install => :build do
+    sh 'gem inst eventmachine_httpserver*.gem'
+  end
 
-desc "Run the application tests"
-task :test_application do |t|
-    run_test_package t, Dir['test/app.rb']
+  CLOBBER.include("eventmachine_httpserver.gemspec")
+  CLEAN.include("eventmachine_httpserver-#{version}.gem")
 end
 
-task :default => [:test]
-
+task :default => :test

data/eventmachine_httpserver.gemspec

@@ -0,0 +1,33 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{eventmachine_httpserver}
+  s.version = "0.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Francis Cianfrocca"]
+  s.cert_chain = nil
+  s.date = %q{2007-03-16}
+  s.description = %q{}
+  s.email = %q{garbagecat10@gmail.com}
+  s.extensions = ["ext/extconf.rb"]
+  s.extra_rdoc_files = ["docs/COPYING", "docs/README", "docs/RELEASE_NOTES"]
+  s.files = ["Rakefile", "docs/COPYING", "docs/README", "docs/RELEASE_NOTES", "eventmachine_httpserver.gemspec", "eventmachine_httpserver.gemspec.tmpl", "ext/extconf.rb", "ext/http.cpp", "ext/http.h", "ext/rubyhttp.cpp", "lib/evma_httpserver.rb", "lib/evma_httpserver/response.rb", "test/test_app.rb", "test/test_delegated.rb", "test/test_response.rb"]
+  s.has_rdoc = true
+  s.homepage = %q{http://rubyeventmachine.com}
+  s.rdoc_options = ["--title", "EventMachine_HttpServer", "--main", "docs/README", "--line-numbers"]
+  s.require_paths = ["lib"]
+  s.required_ruby_version = Gem::Requirement.new("> 0.0.0")
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{EventMachine HTTP Server}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 1
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/eventmachine_httpserver.gemspec.tmpl

@@ -0,0 +1,23 @@
+Gem::Specification.new do |s|
+  s.name = %q{eventmachine_httpserver}
+  s.version = "0.1.1"
+
+  s.specification_version = 1 if s.respond_to? :specification_version=
+
+  s.required_rubygems_version = nil if s.respond_to? :required_rubygems_version=
+  s.authors = ["Francis Cianfrocca"]
+  s.cert_chain = nil
+  s.date = %q{2007-03-16}
+  s.description = %q{}
+  s.email = %q{garbagecat10@gmail.com}
+  s.extensions = ["ext/extconf.rb"]
+  s.extra_rdoc_files = `git ls-files docs`.split
+  s.files = `git ls-files | grep -v .gitignore`.split
+  s.has_rdoc = true
+  s.homepage = %q{http://rubyeventmachine.com}
+  s.rdoc_options = ["--title", "EventMachine_HttpServer", "--main", "docs/README", "--line-numbers"]
+  s.require_paths = ["lib"]
+  s.required_ruby_version = Gem::Requirement.new("> 0.0.0")
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{EventMachine HTTP Server}
+end

data/ext/extconf.rb

@@ -1,5 +1,3 @@
-# $Id: extconf.rb 3896 2007-03-06 20:21:01Z francis $
-#
 #----------------------------------------------------------------------------
 #
 # Copyright (C) 2006-07 by Francis Cianfrocca. All Rights Reserved.
@@ -116,6 +114,13 @@ else
   end
   # on Unix we need a g++ link, not gcc.
   CONFIG['LDSHARED'] = "$(CXX) -shared"
+
+  # Modify the mkmf constant LINK_SO so the generated shared object is stripped.
+  # You might think modifying CONFIG['LINK_SO'] would be a better way to do this,
+  # but it doesn't work because mkmf doesn't look at CONFIG['LINK_SO'] again after
+  # it initializes.
+  # linkso = Object.send :remove_const, "LINK_SO"
+  # LINK_SO = linkso + "; strip $@"
 end
 
 if $CPPFLAGS

data/ext/http.cpp

@@ -1,7 +1,5 @@
 /*****************************************************************************
 
-$Id: http.cpp 3967 2007-03-16 11:53:55Z francis $
-
 File:     http.cpp
 Date:     21Apr06
 
@@ -27,6 +25,8 @@ Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 
 #include <iostream>
 #include <string>
+#include <cstdlib>
+#include <cstring>
 #include <sstream>
 #include <stdexcept>
 #include <stdio.h>
@@ -564,5 +564,3 @@ void HttpConnection_t::_SendError (int code)
 
 	SendData (ss.str().c_str(), ss.str().length());
 }
-
-

data/ext/http.h

@@ -1,7 +1,5 @@
 /*****************************************************************************
 
-$Id: http.h 3966 2007-03-16 11:52:05Z francis $
-
 File:     http.h
 Date:     21Apr06
 

data/ext/rubyhttp.cpp

@@ -1,7 +1,5 @@
 /*****************************************************************************
 
-$Id: rubyhttp.cpp 3966 2007-03-16 11:52:05Z francis $
-
 File:     libmain.cpp
 Date:     06Apr06
 
@@ -87,6 +85,10 @@ void RubyHttpConnection_t::CloseConnection (bool after_writing)
 }
 
 
+/*************************************
+RubyHttpConnection_t::ReceivePostData
+*************************************/
+
 void RubyHttpConnection_t::ReceivePostData (const char *data, int len)
 {
 	VALUE data_val = Qnil;
@@ -205,6 +207,7 @@ t_receive_post_data
 static VALUE t_receive_post_data (VALUE self, VALUE data)
 {
 	/** This is a NOOP.  It should be overridden.  **/
+	return Qnil;
 }
 
 /********

data/lib/evma_httpserver.rb

@@ -1,5 +1,3 @@
-# $Id: evma_httpserver.rb 3897 2007-03-06 20:21:08Z francis $
-#
 # EventMachine HTTP Server
 #
 # Author:: blackhedd (gmail address: garbagecat10).

data/lib/evma_httpserver/response.rb

@@ -1,5 +1,3 @@
-# $Id: response.rb 3897 2007-03-06 20:21:08Z francis $
-#
 # EventMachine HTTP Server
 # HTTP Response-support class
 #
@@ -34,6 +32,22 @@
 
 module EventMachine
 
+	# This class provides a wide variety of features for generating and
+	# dispatching HTTP responses. It allows you to conveniently generate
+	# headers and content (including chunks and multiparts), and dispatch
+	# responses (including deferred or partially-complete responses).
+	#
+	# Although HttpResponse is coded as a class, it's not complete as it
+	# stands. It assumes that it has certain of the behaviors of
+	# EventMachine::Connection. You must add these behaviors, either by
+	# subclassing HttpResponse, or using the alternate version of this
+	# class, DelegatedHttpResponse. See the test cases for current information
+	# on which behaviors you have to add.
+	#
+	# TODO, someday it would be nice to provide a version of this functionality
+	# that is coded as a Module, so it can simply be mixed into an instance of
+	# EventMachine::Connection.
+	#
 	class HttpResponse
 		attr_accessor :status, :content, :headers, :chunks, :multiparts
 
@@ -108,7 +122,7 @@ module EventMachine
 		def generate_header_lines in_hash
 			out_ary = []
 			in_hash.keys.sort.each {|k|
-				v = @headers[k]
+				v = in_hash[k]
 				if v.is_a?(Array)
 					v.each {|v1| out_ary << "#{k}: #{v1}\r\n" }
 				else
@@ -257,7 +271,7 @@ module EventMachine
 			end
 		end
 
-		#
+		# TODO, this is going to be way too slow. Cache up the uuidgens.
 		#
 		def self.concoct_multipart_boundary
 			@multipart_index ||= 0
@@ -278,3 +292,22 @@ module EventMachine
 	end
 end
 
+#----------------------------------------------------------------------------
+
+require 'forwardable'
+
+module EventMachine
+	class DelegatedHttpResponse < HttpResponse
+		extend Forwardable
+		def_delegators :@delegate,
+			:send_data,
+			:close_connection,
+			:close_connection_after_writing
+
+		def initialize dele
+			super()
+			@delegate = dele
+		end
+	end
+end
+

data/test/test_app.rb

@@ -0,0 +1,239 @@
+require 'test/unit'
+require 'evma_httpserver'
+
+begin
+  once = false
+  require 'eventmachine'
+rescue LoadError => e
+  raise e if once
+  once = true
+  require 'rubygems'
+  retry
+end
+
+
+
+#--------------------------------------
+
+module EventMachine
+  module HttpServer
+    def process_http_request
+      send_data generate_response()
+      close_connection_after_writing
+    end
+  end
+end
+
+#--------------------------------------
+
+require 'socket'
+
+class TestApp < Test::Unit::TestCase
+
+  TestHost = "127.0.0.1"
+  TestPort = 8911
+
+  TestResponse_1 = <<EORESP
+HTTP/1.0 200 ...
+Content-length: 4
+Content-type: text/plain
+Connection: close
+
+1234
+EORESP
+
+  Thread.abort_on_exception = true
+
+  def test_simple_get
+    received_response = nil
+
+    EventMachine::HttpServer.module_eval do
+      def generate_response
+        TestResponse_1
+      end
+    end
+
+
+    EventMachine.run do
+      EventMachine.start_server TestHost, TestPort, EventMachine::HttpServer
+      EventMachine.add_timer(1) {raise "timed out"} # make sure the test completes
+
+      cb = proc do
+        tcp = TCPSocket.new TestHost, TestPort
+        tcp.write "GET / HTTP/1.0\r\n\r\n"
+        received_response = tcp.read
+      end
+      eb = proc { EventMachine.stop }
+      EventMachine.defer cb, eb
+    end
+
+    assert_equal( TestResponse_1, received_response )
+  end
+
+
+
+
+  # This frowsy-looking protocol handler allows the test harness to make some
+  # its local variables visible, so we can set them here and they can be asserted later.
+  class MyTestServer < EventMachine::Connection
+    include EventMachine::HttpServer
+    def initialize *args
+      super
+    end
+    def generate_response
+      @assertions.call
+      TestResponse_1
+    end
+  end
+
+
+
+  def test_parameters
+    path_info = "/test.html"
+    query_string = "a=b&c=d"
+    cookie = "eat_me=I'm a cookie"
+    etag = "12345"
+
+    # collect all the stuff we want to assert outside the actual test,
+    # to ensure it gets asserted even if the test catches some exception.
+    received_response = nil
+    request_parms = {}
+
+
+    EventMachine.run do
+      EventMachine.start_server(TestHost, TestPort, MyTestServer) do |conn|
+        # In each accepted connection, set up a procedure that will copy
+        # the request parameters into a local variable visible here, so
+        # we can assert the values later.
+        conn.instance_eval do
+          @assertions = proc {
+            parms = %w( PATH_INFO QUERY_STRING HTTP_COOKIE IF_NONE_MATCH
+            CONTENT_TYPE REQUEST_METHOD REQUEST_URI )
+            parms.each {|parm|
+              # request_parms is bound to a local variable visible in this context.
+              request_parms[parm] = ENV[parm]
+            }
+          }
+        end
+      end
+      EventMachine.add_timer(1) {raise "timed out"} # make sure the test completes
+
+      cb = proc do
+        tcp = TCPSocket.new TestHost, TestPort
+        data = [
+          "GET #{path_info}?#{query_string} HTTP/1.1\r\n",
+          "Cookie: #{cookie}\r\n",
+          "If-none-match: #{etag}\r\n",
+          "\r\n"
+        ].join
+        tcp.write(data)
+        received_response = tcp.read
+      end
+      eb = proc { EventMachine.stop }
+      EventMachine.defer cb, eb
+    end
+
+    assert_equal( TestResponse_1, received_response )
+    assert_equal( path_info, request_parms["PATH_INFO"] )
+    assert_equal( query_string, request_parms["QUERY_STRING"] )
+    assert_equal( cookie, request_parms["HTTP_COOKIE"] )
+    assert_equal( etag, request_parms["IF_NONE_MATCH"] )
+    assert_equal( nil, request_parms["CONTENT_TYPE"] )
+    assert_equal( "GET", request_parms["REQUEST_METHOD"] )
+    assert_equal( path_info, request_parms["REQUEST_URI"] )
+  end
+
+
+  def test_headers
+    received_header_string = nil
+    received_header_ary = nil
+
+    EventMachine.run do
+      EventMachine.start_server(TestHost, TestPort, MyTestServer) do |conn|
+        # In each accepted connection, set up a procedure that will copy
+        # the request parameters into a local variable visible here, so
+        # we can assert the values later.
+        # The @http_headers is set automatically and can easily be parsed.
+        # It isn't automatically parsed into Ruby values because that is
+        # a costly operation, but we should provide an optional method that
+        # does the parsing so it doesn't need to be done by users.
+        conn.instance_eval do
+          @assertions = proc do
+            received_header_string = @http_headers
+            received_header_ary = @http_headers.split(/\0/).map {|line| line.split(/:\s*/, 2) }
+          end
+        end
+      end
+
+      cb = proc do
+        tcp = TCPSocket.new TestHost, TestPort
+        data = [
+          "GET / HTTP/1.1\r\n",
+          "aaa: 111\r\n",
+          "bbb: 222\r\n",
+          "ccc: 333\r\n",
+          "ddd: 444\r\n",
+          "\r\n"
+        ].join
+        tcp.write data
+        received_response = tcp.read
+      end
+      eb = proc { EventMachine.stop }
+      EventMachine.defer cb, eb
+
+      EventMachine.add_timer(1) {raise "timed out"} # make sure the test completes
+    end
+
+    assert_equal( "aaa: 111\0bbb: 222\0ccc: 333\0ddd: 444\0\0", received_header_string )
+    assert_equal( [["aaa","111"], ["bbb","222"], ["ccc","333"], ["ddd","444"]], received_header_ary )
+  end
+
+
+
+
+
+  def test_post
+    received_header_string = nil
+    post_content = "1234567890"
+    content_type = "text/plain"
+    received_post_content = ""
+    received_content_type = ""
+
+    EventMachine.run do
+      EventMachine.start_server(TestHost, TestPort, MyTestServer) do |conn|
+        # In each accepted connection, set up a procedure that will copy
+        # the request parameters into a local variable visible here, so
+        # we can assert the values later.
+        # The @http_post_content variable is set automatically.
+        conn.instance_eval do
+          @assertions = proc do
+            received_post_content = @http_post_content
+            received_content_type = ENV["CONTENT_TYPE"]
+          end
+        end
+      end
+      EventMachine.add_timer(1) {raise "timed out"} # make sure the test completes
+
+      cb = proc do
+        tcp = TCPSocket.new TestHost, TestPort
+        data = [
+          "POST / HTTP/1.1\r\n",
+          "Content-type: #{content_type}\r\n",
+          "Content-length: #{post_content.length}\r\n",
+          "\r\n",
+          post_content
+        ].join
+        tcp.write(data)
+        received_response = tcp.read
+      end
+      eb = proc do
+        EventMachine.stop
+      end
+      EventMachine.defer cb, eb
+    end
+
+    assert_equal( received_post_content, post_content )
+    assert_equal( received_content_type, content_type )
+  end
+
+end