jruby-http-reactor 0.5.2

data/README.rdoc

@@ -0,0 +1,13 @@
+A client that uses the Apache HttpCore NIO library to do HTTP requests.
+
+<pre>
+require 'http_reactor'
+  
+uris = ['http://www.yahoo.com/','http://www.google.com/']
+requests = uris.map { |uri| HttpReactor::Request.new(uri) }
+
+HttpReactor::Client.new(requests) do |response, context|
+  puts "Response code: #{response.code}"
+  puts "Response body: #{response.body}"
+end
+</pre>

data/README.textile

@@ -0,0 +1,13 @@
+A client that uses the Apache HttpCore NIO library to do HTTP requests.
+
+<pre>
+require 'http_reactor'
+  
+uris = ['http://www.yahoo.com/','http://www.google.com/']
+requests = uris.map { |uri| HttpReactor::Request.new(uri) }
+
+HttpReactor::Client.new(requests) do |response, context|
+  puts "Response code: #{response.code}"
+  puts "Response body: #{response.body}"
+end
+</pre>

data/Rakefile

@@ -0,0 +1,36 @@
+require 'rake'
+require 'rake/rdoctask'
+
+desc 'Default: run tests.'
+task :default => [:test]
+
+desc 'Run tests.'
+task :test do
+  require File.dirname(__FILE__) + '/test/client_test'
+end
+
+desc 'Generate documentation.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'JRuby HTTP Reactor'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/*.rb')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "jruby-http-reactor"
+    gemspec.summary = "JRuby NIO HTTP client."
+    gemspec.email = "anthonyeden@gmail.com"
+    gemspec.homepage = "http://github.com/aeden/jruby-http-reactor"
+    gemspec.description = ""
+    gemspec.authors = ["Anthony Eden"]
+    gemspec.files.exclude 'docs/**/*'
+    gemspec.files.exclude '.gitignore'
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end

data/VERSION

@@ -0,0 +1 @@
+0.5.2

data/examples/opml.rb

@@ -0,0 +1,31 @@
+#!/usr/bin/env jruby
+#
+# Usage: jruby examples/opml.rb opml.xml
+#
+# Dependencies:
+#
+# hpricot (0.6.164)
+# threadify (1.1.0) (optional, uncomment in code)
+
+require 'uri'
+require 'rubygems'
+require 'hpricot'
+#require 'threadify'
+require File.dirname(__FILE__) + '/../lib/http_reactor'
+
+def requests
+  @requests ||= begin
+    xml = File.read(ARGV.pop)
+    doc = Hpricot::XML(xml)
+    urls = (doc/'outline').map { |outline| outline['xmlUrl'] }
+    urls.map { |url_string| HttpReactor::Request.new(URI.parse(url_string)) }
+  end
+end
+
+#uris.threadify(:each_slice, 1) do |slice|
+  HttpReactor::Client.new(requests) do |response, context|
+    puts "Response: #{response.status_line.status_code}"
+    puts "Content length: #{response.body.length}"
+  end
+#end
+puts "Processed #{requests.length} feeds"

data/jruby-http-reactor.gemspec

@@ -0,0 +1,55 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{jruby-http-reactor}
+  s.version = "0.5.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Anthony Eden"]
+  s.date = %q{2009-10-22}
+  s.description = %q{}
+  s.email = %q{anthonyeden@gmail.com}
+  s.extra_rdoc_files = [
+    "README.rdoc",
+     "README.textile"
+  ]
+  s.files = [
+    "README.rdoc",
+     "README.textile",
+     "Rakefile",
+     "VERSION",
+     "examples/opml.rb",
+     "jruby-http-reactor.gemspec",
+     "lib/http_reactor.rb",
+     "lib/http_reactor/client.rb",
+     "lib/http_reactor/request.rb",
+     "lib/http_reactor/response.rb",
+     "test/client_test.rb",
+     "test/test_helper.rb",
+     "vendor/httpcore-4.0.1.jar",
+     "vendor/httpcore-nio-4.0.1.jar"
+  ]
+  s.homepage = %q{http://github.com/aeden/jruby-http-reactor}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{JRuby NIO HTTP client.}
+  s.test_files = [
+    "test/client_test.rb",
+     "test/test_helper.rb",
+     "examples/opml.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
+    else
+    end
+  else
+  end
+end

data/lib/http_reactor/client.rb

@@ -0,0 +1,287 @@
+module HttpReactor #:nodoc:
+  class RequestExecutionHandler #:nodoc:
+    import org.apache.http.protocol
+    import org.apache.http.nio.protocol
+    include HttpRequestExecutionHandler
+    
+    REQUEST_SENT       = "request-sent"
+    RESPONSE_RECEIVED  = "response-received"
+    
+    HTTP_TARGET_PATH = 'http_target_path'
+    HTTP_TARGET_REQUEST = 'http_target_request'
+    IO_REACTOR = "io_reactor"
+    REDIRECT_HISTORY = "redirect_history"
+    
+    def initialize(request_count, handler_proc)
+      @request_count = request_count
+      @handler_proc = handler_proc
+    end
+    
+    def initalize_context(context, attachment)
+      context.set_attribute(ExecutionContext.HTTP_TARGET_HOST, attachment[:host])
+      context.set_attribute(HTTP_TARGET_PATH, attachment[:path])
+      context.set_attribute(HTTP_TARGET_REQUEST, attachment[:request])
+      context.set_attribute(IO_REACTOR, attachment[:io_reactor])
+      context.set_attribute(REDIRECT_HISTORY, attachment[:redirect_history] || [])
+    end
+    
+    def finalize_context(context)
+      flag = context.get_attribute(RESPONSE_RECEIVED)
+      @request_count.count_down() unless flag
+    end
+    
+    def submit_request(context)
+      target_host = context.get_attribute(ExecutionContext.HTTP_TARGET_HOST);
+      target_path = context.get_attribute(HTTP_TARGET_PATH)
+      target_request = context.get_attribute(HTTP_TARGET_REQUEST)
+      flag = context.get_attribute(REQUEST_SENT);
+      if flag.nil?
+        # Stick some object into the context
+        context.set_attribute(REQUEST_SENT, true);
+
+        #puts "--------------"
+        #puts "Sending request to #{target_host}#{target_path}"
+        #puts "--------------"
+
+        org.apache.http.message.BasicHttpEntityEnclosingRequest.new(
+          target_request.method, target_path
+        )
+      else
+        # No new request to submit
+      end
+    end
+     
+    def handle_response(response, context)
+      begin
+        res = HttpReactor::Response.new(response)
+        case res.code
+        when 301, 302
+          redirect_to = res.headers['Location']
+          redirect_history = context.getAttribute(REDIRECT_HISTORY)
+          if redirect_history.include?(redirect_to)
+            #puts "Too many redirects"
+            context.setAttribute(RESPONSE_RECEIVED, true)
+            @request_count.count_down()
+          else
+            #puts "Redirecting to #{redirect_to}"
+            redirect_history << redirect_to
+            context.setAttribute(REDIRECT_HISTORY, redirect_history)
+            request = context.getAttribute(HTTP_TARGET_REQUEST)
+            request.uri = URI.parse(redirect_to)
+            io_reactor = context.getAttribute(IO_REACTOR)
+            HttpReactor::Client.process_requests([request], io_reactor, @request_count)
+          end
+        else
+          @handler_proc.call(res, context)
+          context.setAttribute(RESPONSE_RECEIVED, true)
+          # Signal completion of the request execution
+          @request_count.count_down()
+        end
+      rescue => e
+        puts "Error handling response: #{e.message}"
+      end
+    end
+  end
+  
+  class SessionRequestCallback #:nodoc:
+    include org.apache.http.nio.reactor.SessionRequestCallback
+    
+    def initialize(request_count)
+      @request_count = request_count
+    end
+
+    def cancelled(request)
+      puts "Connect request cancelled: #{request.remote_address}"
+      @request_count.count_down()
+    end
+
+    def completed(request); end
+
+    def failed(request)
+      puts "Connect request failed: #{request.remote_address}"
+      @request_count.count_down()
+    end
+    
+    def timeout(request)
+      puts "Connect request timed out: #{request.remote_address}"
+      @request_count.count_down()
+    end
+  end
+  
+  class EventLogger #:nodoc:
+    import org.apache.http.nio.protocol
+    include EventListener
+    def connection_open(conn)
+      puts "Connection open: #{conn}"
+    end
+    def connection_timeout(conn)
+      puts "Connection timed out: #{conn}"
+    end
+    def connection_closed(conn)
+      puts "Connection closed: #{conn}"
+    end
+    def fatal_i_o_exception(ex, conn)
+      puts "Fatal I/O error: #{ex.message}"
+    end
+    def fatal_protocol_exception(ex, conn)
+      puts "HTTP error: #{ex.message}"
+    end
+  end
+  
+  # An HTTP client that uses the Reactor pattern.
+  class Client
+    import org.apache.http
+    import org.apache.http.params
+    import org.apache.http.protocol
+    import org.apache.http.nio.protocol
+    import org.apache.http.impl.nio
+    import org.apache.http.impl.nio.reactor
+    
+    # Create a new HttpReactor client that will request the given URIs.
+    #
+    # Parameters:
+    # * <tt>uris</tt>: An array of URI objects.
+    # * <tt>handler_proc</tt>: A Proc that will be called with the response and context
+    # * <tt>session_request_callback</tt>: A class that implements the session request
+    #   callback interface found in the HttpCore library.
+    # * <tt>options: A hash of configuration options. See below.
+    # 
+    # The options hash may include the following options
+    # * <tt>:so_timeout</tt>: (default = 5 seconds)
+    # * <tt>:connection_timeout</tt>: The HTTP connection timeout (default = 10 seconds)
+    # * <tt>:socket_buffer_size</tt>: The buffer size (defaults to 8Kb)
+    # * <tt>:stale_connection_check</tt>: (defaults to false)
+    # * <tt>:tcp_nodelay</tt>: (defaults to true)
+    # * <tt>:user_agent</tt>: The user agent string to send (defaults to "JRubyHttpReactor")
+    # * <tt>:event_listener</tt>: A class that implements the org.apache.http.nio.protocol interface
+    def initialize(requests=[], handler_proc=nil, options={}, &block)
+      handler_proc = block if block_given?
+      handler_proc ||= default_handler_proc
+      
+      initialize_options(options)
+      
+      params = build_params(options)
+      
+      io_reactor = DefaultConnectingIOReactor.new(2, params);
+      
+      httpproc = BasicHttpProcessor.new;
+      httpproc.add_interceptor(RequestContent.new);
+      httpproc.add_interceptor(RequestTargetHost.new);
+      httpproc.add_interceptor(RequestConnControl.new);
+      httpproc.add_interceptor(RequestUserAgent.new);
+      httpproc.add_interceptor(RequestExpectContinue.new);
+      
+      # We are going to use this object to synchronize between the 
+      # I/O event and main threads
+      request_counter = java.util.concurrent.CountDownLatch.new(requests.length);
+
+      handler = BufferingHttpClientHandler.new(
+        httpproc,
+        RequestExecutionHandler.new(request_counter, handler_proc),
+        org.apache.http.impl.DefaultConnectionReuseStrategy.new,
+        params
+      )
+      
+      handler.event_listener = options[:event_listener].new if options[:event_listener]
+      
+      io_event_dispatch = DefaultClientIOEventDispatch.new(handler, params)
+
+      Thread.abort_on_exception = true
+      t = Thread.new do
+        begin
+          #puts "Executing IO reactor"
+          io_reactor.execute(io_event_dispatch)
+        rescue java.io.InterruptedIOException => e
+          puts "Interrupted"
+        rescue java.io.IOException => e
+          puts "I/O error in reactor execution thread: #{e.message}"
+        end
+        #puts "Shutdown"
+      end
+      
+      process_requests(requests, io_reactor, request_counter)
+      
+      # Block until all connections signal
+      # completion of the request execution
+      request_counter.await()
+
+      #puts "Shutting down I/O reactor"
+
+      io_reactor.shutdown()
+
+      #puts "Done"
+    end
+    
+    def process_requests(requests, io_reactor, request_counter)
+      HttpReactor::Client.process_requests(requests, io_reactor, request_counter)
+    end
+    
+    def self.process_requests(requests, io_reactor, request_counter)
+      requests.each do |request|
+        uri = request.uri
+        attachment = {
+          :host => HttpHost.new(uri.host), 
+          :path => uri.request_uri,
+          :request => request,
+          :io_reactor => io_reactor
+        }
+        io_reactor.connect(
+          java.net.InetSocketAddress.new(uri.host, uri.port), 
+          nil, 
+          attachment,
+          SessionRequestCallback.new(request_counter)
+        )
+      end
+    end
+    
+    private
+    
+    def initialize_options(options)
+      options[:so_timeout] ||= 5000
+      options[:connection_timeout] ||= 10000
+      options[:socket_buffer_size] ||= 8 * 1024
+      options[:stale_connection_check] ||= false
+      options[:tcp_nodelay] ||= true
+      options[:user_agent] ||= "JRubyHttpReactor"
+      #options[:event_listener] ||= EventLogger
+    end
+    
+    def build_params(options)
+      params = BasicHttpParams.new
+      params.set_int_parameter(
+        CoreConnectionPNames.SO_TIMEOUT, options[:so_timeout])
+      params.set_int_parameter(
+        CoreConnectionPNames.CONNECTION_TIMEOUT, options[:connection_timeout])
+      params.set_int_parameter(
+        CoreConnectionPNames.SOCKET_BUFFER_SIZE, options[:socket_buffer_size])
+      params.set_boolean_parameter(
+        CoreConnectionPNames.STALE_CONNECTION_CHECK, options[:stale_connection_check])
+      params.set_boolean_parameter(
+        CoreConnectionPNames.TCP_NODELAY, options[:tcp_nodelay])
+      params.set_parameter(
+        CoreProtocolPNames.USER_AGENT, options[:user_agent])
+      params
+    end
+    
+    def default_handler_proc
+      Proc.new { |response, context|
+        target_host = context.get_attribute(ExecutionContext.HTTP_TARGET_HOST);
+        target_path = context.get_attribute(RequestExecutionHandler::HTTP_TARGET_PATH)
+
+        entity = response.entity
+        begin
+          content = org.apache.http.util.EntityUtils.toString(entity)
+
+          puts "--------------"
+          puts "Response from #{target_host}#{target_path}"
+          puts response.status_line
+          puts "Document length: #{content.length}"
+          puts "--------------"
+        rescue java.io.IOException => ex
+          puts "I/O error in handle_response: #{ex.message}"
+        end 
+      }
+    end
+    
+  end
+end

data/lib/http_reactor/request.rb

@@ -0,0 +1,16 @@
+module HttpReactor
+  # A class that represents an HTTP request.
+  class Request
+    attr_accessor :uri
+    attr_reader :method, :payload
+    attr_accessor :extra
+    
+    # Initialize the request object.
+    def initialize(uri, method='GET', payload=nil, extra={})
+      @uri = uri
+      @method = method
+      @payload = payload
+      @extra = extra
+    end
+  end
+end

data/lib/http_reactor/response.rb

@@ -0,0 +1,67 @@
+module HttpReactor #:nodoc:
+  # A class that represents an HTTP response which wraps the 
+  # Java HTTP NIO response object and provides methods for accessing
+  # the data using ruby idioms.
+  class Response
+    def initialize(response_impl)
+      @response_impl = response_impl
+    end
+    
+    # Delegates to the HTTP NIO response
+    def status_line
+      @response_impl.status_line
+    end
+    
+    # Delegates to the HTTP NIO response
+    def entity
+      @response_impl.entity
+    end
+    
+    def code
+      status_line.status_code
+    end
+    
+    # Get the response content type
+    def content_type
+      @content_type ||= @response_impl.entity.content_type.value
+    end
+    
+    # Get the response content length
+    def content_length
+      @content_length ||= @response_impl.entity.content_length
+    end
+    
+    # Access the headers
+    def [](name)
+      headers[name]
+    end
+    
+    def headers
+      @headers ||= begin
+        h = Hash.new
+        @response_impl.all_headers.each do |header|
+          if h[header.name]
+            h[header.name] = [h[header.name], header.value]
+          else
+            h[header.name] = header.value
+          end
+        end
+        h
+      end
+    end
+    
+    # Get the body text
+    def body
+      @body ||= begin
+        begin
+          io = Java.java_to_ruby(
+            org.jruby.RubyIO.new(JRuby.runtime, entity.content).java_object
+          )
+          io.read
+        rescue Exception => e
+          puts "Error in Response#body: #{e.message}"
+        end
+      end
+    end
+  end
+end

data/lib/http_reactor.rb

@@ -0,0 +1,14 @@
+require 'java'
+require File.dirname(__FILE__) + '/../vendor/httpcore-4.0.1.jar'
+require File.dirname(__FILE__) + '/../vendor/httpcore-nio-4.0.1.jar'
+
+# The Ruby module that contains wrappers for the the Apache
+# HTTP NIO implementation.
+module HttpReactor
+end
+
+$:.unshift(File.dirname(__FILE__))
+
+require 'http_reactor/request'
+require 'http_reactor/response'
+require 'http_reactor/client'

data/test/client_test.rb

@@ -0,0 +1,49 @@
+require File.dirname(__FILE__) + '/test_helper'
+require 'uri'
+require 'mime/types'
+
+class ClientTest < Test::Unit::TestCase
+  def requests
+    @requests ||= [
+      'http://yahoo.com/', 
+      'http://www.google.com/', 
+      'http://www.apache.org/',
+      'http://anthony.mp/about_me',
+      'http://search.twitter.com/search?q=jruby'
+    ].map { |url_string| HttpReactor::Request.new(URI.parse(url_string)) }
+  end
+  
+  def test_new
+    assert_nothing_raised do
+      HttpReactor::Client.new(requests)
+    end
+  end
+  
+  def test_proc
+    handler = Proc.new do |response, context|
+      assert_equal 200, response.code
+      assert response.body.length > 0
+      mime_type = MIME::Types[response.content_type].first
+      assert_equal "text/html", mime_type.content_type
+    end
+    HttpReactor::Client.new(requests, handler)
+  end
+  
+  def test_block
+    HttpReactor::Client.new(requests) do |response, context|
+      assert_equal 200, response.status_line.status_code
+      assert_equal 200, response.code
+      mime_type = MIME::Types[response.content_type].first
+      assert_equal "text/html", mime_type.content_type
+      puts "request ur: #{context.getAttribute('http_target_request').uri}"
+      puts "content-length: #{response.content_length}"
+      assert response.body.length > 0
+      puts "=== HEADERS ==="
+      puts response.headers.inspect
+      # puts "===== BODY ===="
+      # puts response.body
+      # puts "==============="
+    end
+  end
+  
+end

data/test/test_helper.rb

@@ -0,0 +1,2 @@
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/http_reactor'

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification 
+name: jruby-http-reactor
+version: !ruby/object:Gem::Version 
+  version: 0.5.2
+platform: ruby
+authors: 
+- Anthony Eden
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-22 00:00:00 -10:00
+default_executable: 
+dependencies: []
+
+description: ""
+email: anthonyeden@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- README.textile
+files: 
+- README.rdoc
+- README.textile
+- Rakefile
+- VERSION
+- examples/opml.rb
+- jruby-http-reactor.gemspec
+- lib/http_reactor.rb
+- lib/http_reactor/client.rb
+- lib/http_reactor/request.rb
+- lib/http_reactor/response.rb
+- test/client_test.rb
+- test/test_helper.rb
+- vendor/httpcore-4.0.1.jar
+- vendor/httpcore-nio-4.0.1.jar
+has_rdoc: true
+homepage: http://github.com/aeden/jruby-http-reactor
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: JRuby NIO HTTP client.
+test_files: 
+- test/client_test.rb
+- test/test_helper.rb
+- examples/opml.rb