ap4r 0.3.5 → 0.3.6

data/History.txt

@@ -1,8 +1,14 @@
 == 0.3.x
 
+=== 0.3.6 (February 6, 2008)
+* Added: configuration to set HTTP timeout.
+         Based on a patch from Artem Vasiliev <abublic at gmail.com>
+* Added: provisional support Rails2.0.
+* Changed: the location of message_builder.rb from rails plugin to ap4r core (ap4r/lib directory).
+* Fixed: bug (tracker #17206) that uninitialized constant error occurs when :active_record_store is used as session store.
+
 === 0.3.5 (November 29, 2007)
-* Fixed: bug that SAF transaction is NOT guaranteed when some models are created/updated
-         before using of ap4r.async_to API in ap4r.transaction block.
+* Fixed: bug that SAF transaction is NOT guaranteed when some models are created/updated before using of ap4r.async_to API in ap4r.transaction block.
 
 === 0.3.4 (October 31, 2007)
 * Added: Support ActiveRecord as reliable RDBMS persistence.

data/Manifest.txt

@@ -15,6 +15,7 @@ lib/ap4r.rb
 lib/ap4r/carrier.rb
 lib/ap4r/db/migrate/001_reliable_msg_queue_and_topic.rb
 lib/ap4r/dispatcher.rb
+lib/ap4r/message_builder.rb
 lib/ap4r/message_store_ext.rb
 lib/ap4r/mongrel.rb
 lib/ap4r/mongrel_ap4r.rb
@@ -43,11 +44,13 @@ rails_plugin/ap4r/lib/ap4r/queue_put_stub.rb
 rails_plugin/ap4r/lib/ap4r/service_handler.rb
 rails_plugin/ap4r/lib/ap4r_client.rb
 rails_plugin/ap4r/lib/async_helper.rb
-rails_plugin/ap4r/lib/message_builder.rb
 rails_plugin/ap4r/tasks/ap4r.rake
 script/irm
 script/mongrel_ap4r
 script/start
 script/stop
 spec/local/dispatcher_base_spec.rb
+spec/local/message_builder_spec.rb
+spec/local/send_message_handler_spec.rb
+spec/local/subscribe_message_handler_spec.rb
 spec/spec_helper.rb

data/Rakefile

@@ -1,50 +1,54 @@
 require 'rubygems'
-require 'hoe'
 require 'erb'
+require 'find'
 require 'active_record'
 require File.join(File.dirname(__FILE__), 'lib/ap4r', 'version')
 
-namespace :hoe do
-  hoe = Hoe.new('ap4r', Ap4r::VERSION::STRING) do |p|
-    p.author = ["Shunichi Shinohara", "Kiwamu Kato"]
-    p.changes = p.paragraphs_of('History.txt', 1..2).join("\n\n")
-    #p.clean_globs = 
-    p.description = <<-EOF
+begin
+  namespace :hoe do
+    require 'hoe'
+
+    hoe = Hoe.new('ap4r', Ap4r::VERSION::STRING) do |p|
+      p.author = ["Shunichi Shinohara", "Kiwamu Kato"]
+      p.changes = p.paragraphs_of('History.txt', 1..2).join("\n\n")
+      #p.clean_globs =
+      p.description = <<-EOF
       Asynchronous Processing for Ruby.
     EOF
-    p.email = %q{shinohara.shunichi@future.co.jp, kato.kiwamu@future.co.jp}
-
-    p.extra_deps << ['reliable-msg', '=1.1.0']
-    p.extra_deps << ['activesupport']
-    p.extra_deps << ['mongrel']
-    p.extra_deps << ['rake']
-    p.extra_deps << ['hoe']
-
-    p.name = 'ap4r'
-    p.need_tar = false
-    p.need_zip = false
-    p.rdoc_pattern = /^(lib|bin|ext|rails_plugin)|txt$/
-
-    #p.remote_rdoc_dir = 
-    #p.rsync = 
-    p.rubyforge_name = 'ap4r'
-    #p.spec_extra = 
-    p.summary = 'Asynchronous Processing for Ruby.'
-    p.test_globs = 'spec/**/*_spec.rb'
-    p.url = 'http://ap4r.rubyforge.org/wiki/wiki.pl?HomePage'
-    p.version = Ap4r::VERSION::STRING
-  end
-  hoe.spec.dependencies.delete_if {|dep| dep.name == "hoe"}
+      p.email = %q{shinohara.shunichi@future.co.jp, kato.kiwamu@future.co.jp}
+
+      p.extra_deps << ['reliable-msg', '=1.1.0']
+      p.extra_deps << ['activesupport']
+      p.extra_deps << ['mongrel']
+      p.extra_deps << ['rake']
+      p.extra_deps << ['hoe']
+
+      p.name = 'ap4r'
+      p.need_tar = false
+      p.need_zip = false
+      p.rdoc_pattern = /^(lib|bin|ext|rails_plugin)|txt$/
+
+      #p.remote_rdoc_dir =
+      #p.rsync =
+      p.rubyforge_name = 'ap4r'
+      #p.spec_extra =
+      p.summary = 'Asynchronous Processing for Ruby.'
+      p.test_globs = 'spec/**/*_spec.rb'
+      p.url = 'http://ap4r.rubyforge.org/wiki/wiki.pl?HomePage'
+      p.version = Ap4r::VERSION::STRING
+    end
+    hoe.spec.dependencies.delete_if {|dep| dep.name == "hoe"}
 
+  end
+rescue
 end
-task :pkg => "release:copy_plugin"
 
 # AP4R release tasks --------------------------------------------------------
 
 HelloWorld = '../samples/HelloWorld'
 
 namespace :release do
-  desc "copy rails plugin from sample before gem build" 
+  desc "copy rails plugin from sample before gem build"
   task :copy_plugin do
     # TODO: Should use file task ? 2007/09/27 by shino
     FileUtils.rm_rf('./rails_plugin/ap4r')
@@ -61,8 +65,10 @@ namespace :release do
     path_list = []
     Find.find('.') do |path|
       next unless File.file?(path)
+      next if path =~ /^\.\/coverage\//
       next if path =~ /^\.\/doc\//
-      next if path =~ /\.svn|tmp$|CVS|\~$/
+      next if path =~ /^\.\/log\//
+      next if path =~ /\.svn|tmp$|CVS|\.msg$|\.idx$|\.state$|\#$|\~$/
       path_list << path
     end
 
@@ -79,7 +85,7 @@ namespace :release do
   task :sample do
     FileUtils.mkdir_p('./pkg/samples')
     FileUtils.rm_rf('./pkg/samples/HelloWorld')
-    
+
     FileUtils.cp_r(HelloWorld, './pkg/samples/')
     Find.find('./pkg/samples') do |path|
       next unless File.file? path
@@ -89,12 +95,13 @@ namespace :release do
     Dir.chdir('./pkg/samples/HelloWorld')
     `rake db:migrate`
     Dir.chdir('../../')
-    
+
     `tar czf HelloWorld-#{Ap4r::VERSION::STRING}.tar.gz ./samples/HelloWorld/`
     Dir.chdir('../')
   end
 end
 
+task :pkg => "release:copy_plugin"
 
 # Spec tasks ----------------------------------------------------------------
 require 'spec/rake/spectask'
@@ -111,10 +118,15 @@ namespace :spec do
       Spec::Rake::SpecTask.new(flavor) do |t|
         t.spec_files = FileList["spec/#{flavor}/**/*.rb"]
         t.rcov = true
+        build_artifacts = ENV['CC_BUILD_ARTIFACTS']
+        t.rcov_dir = build_artifacts.nil? ? "coverage" : "#{build_artifacts}"
         excludes = %w(^spec\/)
         if ENV['GEM_HOME']
           excludes << Regexp.escape(ENV['GEM_HOME'])
         end
+        if ENV['RUBY_HOME']
+          excludes << Regexp.escape(ENV['RUBY_HOME'])
+        end
         t.rcov_opts = ["--exclude" , excludes.join(","),
                       "--text-summary"]
       end
@@ -140,7 +152,7 @@ task :stats => "release:copy_plugin" do
 end
 
 namespace :qdb do
-  desc "Make queue and topic tables through scripts in lib/ap4r/db/migrate." 
+  desc "Make queue and topic tables through scripts in lib/ap4r/db/migrate."
   task :migrate do
 
     # Todo: configurable file name, 2007/10/01 kiwamu
@@ -159,3 +171,43 @@ namespace :qdb do
   end
 end
 
+todos_dirs = %w(lib rails_plugin spec)
+
+desc "List TODO comments in #{todos_dirs.join(", ")} directories"
+task :todos => todos_dirs.map{ |dir| "todos:#{dir}" }
+
+namespace :todos do
+  todos_dirs.each do |dir|
+    desc "List TODO comments in #{dir} directory"
+    task dir => "release:copy_plugin" do
+      print_todos(dir)
+    end
+  end
+
+  def print_todos(dir)
+    FileList.new("#{dir}/**/*.*").each do |file|
+      next unless FileTest.file?(file)
+      next if (results = todos(file)).empty?
+
+      puts file
+      results.each{ |r|
+        puts "L.#{"%4d" % r[:line]}: #{r[:msg]}  --  #{r[:date]} by #{r[:by]}"
+      }
+      puts
+    end
+  end
+
+  def todos(file)
+    pattern = /TODO\s*:?\s*(.*)\s+(\d{4}\/\d{2}\/\d{2})\s*,?(?:by)?\s*(\S+)/i
+
+    results = []
+    File.open(file, "r") do |f|
+      f.each_line do |line|
+        next unless pattern.match(line)
+        results << {:line => f.lineno, :by => $3, :date => $2, :msg => $1.strip}
+      end
+    end
+    results
+  end
+
+end

data/lib/ap4r/carrier.rb

@@ -2,11 +2,12 @@
 # Copyright:: Copyright (c) 2007 Future Architect Inc.
 # Licence:: MIT Licence
 
+begin require 'rubygems'; rescue LoadError; end
+
 require 'yaml'
 require 'thread'
 require 'pp'
 require 'active_support'
-
 require 'reliable-msg'
 
 module Ap4r
@@ -80,7 +81,7 @@ module Ap4r
             #   local_queue = ReliableMsg::Queue.new queue_name
             #   local_queue.put m.object
             # }.join
-            
+
             #version 2: store tx and set nil, and resotre tx after putting a message
             begin
               tx = Thread.current[ReliableMsg::Client::THREAD_CURRENT_TX]

data/lib/ap4r/dispatcher.rb

@@ -94,7 +94,7 @@ module Ap4r
     # If no class for +dispatch_mode+, raises an exception.
     def get_dispather_instance(dispatch_mode, message, conf_per_targets)
       klass = @@subclasses[dispatch_mode]
-      raise "undefined dispatch mode #{m.headers[:mode]}" unless klass
+      raise "undefined dispatch mode #{message.headers[:mode]}" unless klass
       klass.new(message, conf_per_targets)
     end
 
@@ -233,6 +233,12 @@ module Ap4r
         headers = make_header
 
         Net::HTTP.start(uri.host, uri.port) do |http|
+          # TODO: global configuration over dispatchers for each protocol should be considered, 2008/02/06 by kiwamu
+          # TODO: http open timeout should be considered, 2008/02/06 by kiwamu
+          if @conf['http'] && @conf['http']['timeout']
+            http.read_timeout = @conf['http']['timeout']
+            logger.info "set HTTP read timeout to #{http.read_timeout}s"
+          end
           @response, = http.post(uri.path, @message.object, headers)
         end
       end
@@ -330,7 +336,7 @@ module Ap4r
     #
     class Druby < Base
       dispatch_mode :druby
-        
+
       def invoke
         object = DRbObject.new_with_uri(@message[:target_url])
         object.method_missing(@message[:target_method].to_sym, @message.object)

data/{rails_plugin/ap4r/lib → lib/ap4r}/message_builder.rb

@@ -3,6 +3,7 @@
 # Licence:: MIT Licence
 
 require 'active_record'
+require 'active_support'
 
 module Ap4r #:nodoc:
 
@@ -81,7 +82,7 @@ module Ap4r #:nodoc:
       when :json
         set_content_type("application/json")
       when :yaml
-        set_content_type("text/plain text/yaml")
+        set_content_type("text/yaml")
       else
         set_content_type("application/x-www-form-urlencoded")
       end
@@ -124,7 +125,7 @@ module Ap4r #:nodoc:
       when :text
         return @message_body.to_s
       when :xml
-        return @message_body.to_xml @to_xml_options
+        return @message_body.to_xml(@to_xml_options)
       when :json
         return @message_body.to_json
       when :yaml

data/lib/ap4r/message_store_ext.rb

@@ -23,14 +23,14 @@ module ReliableMsg #:nodoc:
               queue == mq
             end
           }
-        }.map{|queue, messages| 
+        }.map{|queue, messages|
           [queue, messages[0][:created]]
         }.min {|q1, q2|
           q1[1] <=> q2[1]
         }
         queue_and_created ? queue_and_created[0] : nil
       end
-      
+
       # Returns a message store from the specified configuration (previously
       # created with configure).
       #
@@ -60,7 +60,7 @@ module ReliableMsg #:nodoc:
       rescue LoadError
         require 'postgres-pr/connection'
       end
-      
+
       require 'base64'
 
       class PostgreSQL < Base #:nodoc:
@@ -206,10 +206,10 @@ module ReliableMsg #:nodoc:
         end
 
         def connection
-          Thread.current[THREAD_CURRENT_PGSQL] ||= 
+          Thread.current[THREAD_CURRENT_PGSQL] ||=
             # PGconn is overriding in this file, so is defined regardless of 'postgres' LoadError.
             if Object.const_defined? :PGError
-              ::PGconn.connect @config[:host], @config[:port], @config[:options], @config[:tty], @config[:database], @config[:username], @config[:password]              
+              ::PGconn.connect @config[:host], @config[:port], @config[:options], @config[:tty], @config[:database], @config[:username], @config[:password]
             elsif Object.const_defined? :PostgresPR
               ::PostgresPR::Connection.new @config[:database], @config[:username], @config[:password], @config[:uri]
             end
@@ -217,16 +217,16 @@ module ReliableMsg #:nodoc:
         end
 
       end
-      
+
     rescue LoadError
       # do nothing
     end
 
-    
+
     begin
       # ActiveRecord
       # Make sure we have a ActiveRecord library before creating this class,
-      # worst case we end up with a disk-based message store. 
+      # worst case we end up with a disk-based message store.
       begin
         require 'active_record'
         require 'ap4r/reliable_msg_queue'
@@ -274,7 +274,7 @@ module ReliableMsg #:nodoc:
 
 
         def configuration
-          config = { "type"=>TYPE, "adapter"=>@config[:adapter], "host"=>@config[:host], 
+          config = { "type"=>TYPE, "adapter"=>@config[:adapter], "host"=>@config[:host],
             "username"=>@config[:username], "password"=>@config[:password], "database"=>@config[:database] }
           config["port"] = @config[:port] if @config[:port]
           config["socket"] = @config[:socket] if @config[:socket]
@@ -335,7 +335,7 @@ module ReliableMsg #:nodoc:
           rescue Exception=>error
             raise error
           end
-          super            
+          super
 
         end
 
@@ -356,7 +356,7 @@ module ReliableMsg #:nodoc:
             end
             queue << headers unless added
           end
-          
+
           ::Ap4r::ReliableMsgTopic.find(:all).each do |message|
             @topocs[message[:topic]] = Marshal::load(message[:headers])
           end
@@ -391,8 +391,8 @@ module ReliableMsg #:nodoc:
     rescue LoadError
       # do nothing
     end
-    
-    
+
+
     class Memory < Base #:nodoc:
 
       TYPE = self.name.split('::').last.downcase
@@ -443,7 +443,7 @@ module ReliableMsg #:nodoc:
           @mutex.synchronize do
             @memory_map[insert[:id]] = insert[:message]
           end
-        end        
+        end
         super
         @mutex.synchronize do
           deletes.each do |delete|
@@ -476,7 +476,7 @@ if Object.const_defined? :PGError
         maybe_result.clear
       end
     end
-    
+
     def quote str
       # do nothing
       str
@@ -510,15 +510,15 @@ if Object.const_defined? :PostgresPR
         # do nothing
         str
       end
-      
-    end   
+
+    end
   end
 end
 
-if ReliableMsg::MessageStore::Base.use_mysql_extention
+if Object.const_defined?(:Mysql) && ReliableMsg::MessageStore::Base.use_mysql_extention
   class Mysql #:nodoc:
     alias original_query query
-    
+
     # In Ruby/MySQL, +query+ method does NOT care about a given block.
     # To make it behave the same as MySQL/Ruby, this method adds iteration
     # over query results.

data/lib/ap4r/mongrel.rb

@@ -55,7 +55,7 @@ module Ap4r
 
       def initialize(options)
         # TODO: needs various modes for easy operations 2007/05/02 by shino
-        #        e.g. not to initialize message store, not to start dispatchers, etc. 
+        #        e.g. not to initialize message store, not to start dispatchers, etc.
 
         # TODO what is "false" here? 2007/04/13 by shinohara
         @files = ::Mongrel::DirHandler.new(options[:docroot], false)
@@ -100,5 +100,196 @@ module Ap4r
 
     end
 
+    # This class is an experimental implementation of RESTified message API.
+    # Send to queue:
+    #   using HTTP POST
+    #   a message is sent as HTTP body which format is depending on MIME type
+    #   (now supported only text/plain)
+    #
+    #   options are sent as HTTP header which header name is "X-AP4R"
+    #   url consists of prefix ("/queues") and queue name
+    #
+    #
+    #   === Request example ===
+    #   POST /queues/queue.test HTTP/1.1
+    #   Content-Type: text/plain
+    #   X-AP4R: dispatch_mode=HTTP, target_method=POST, target_url=http://localhost:3000/async_shop/execute_via_http/
+    #
+    #   hoge
+    #
+    #
+    #   === Response example ===
+    #   HTTP/1.1 200 Ok
+    #   Date: The, 11 Dec 2007 17:17:11 GMT
+    #
+    #   7bb181f0-7ee0-012a-300a-001560abd426
+    #
+    class Ap4rSendMessageHandler < ::Mongrel::HttpHandler
+
+      def initialize(options)
+        @tick = Time.now
+        @queues = {}
+      end
+
+      def process(request, response)
+        if response.socket.closed?
+          return
+        end
+
+        queue_name = request.params[::Mongrel::Const::PATH_INFO][1..-1]
+        header = make_header(request.params["HTTP_X_AP4R"]) # Todo: assign as constant 2007/11/27 by kiwamu
+
+        if "POST".include? request.params[::Mongrel::Const::REQUEST_METHOD]
+          begin
+            q = if @queues.key? queue_name
+                  @queues[queue_name]
+                else
+                  @queues[queue_name] = ::ReliableMsg::Queue.new(queue_name)
+                end
+            mid = q.put(request.body.string, header)
+
+            response.start(200) do |head, out|
+              head['Content-Type'] = 'text/plain'
+              out.write mid
+            end
+          rescue Exception
+            response.start(500) do |head, out|
+              head['Content-Type'] = 'text/plain'
+              out.write "Failed to send message. #{request.body.string}"
+            end
+          end
+        else
+          raise "HTTP method is not POST..." # Todo
+        end
+      end
+
+      def make_header(x_ap4r_header)
+        header = {}
+        if x_ap4r_header
+          x_ap4r_header.split(',').map do |e|
+            key, value = e.strip.split('=')
+            if %w(dispatch_mode target_method delivery).include?(key)
+              header[key.to_sym] = value.to_sym
+            else
+              header[key.to_sym] = value
+            end
+          end
+        end
+        header
+      end
+
+      def log_threads_waiting_for(event)
+        if Time.now - @tick > 10
+          @tick = Time.now
+        end
+      end
+
+      # Does the internal reload for Rails.  It might work for most cases, but
+      # sometimes you get exceptions.  In that case just do a real restart.
+      def reload!
+        begin
+          #TODO not implemented 2007/04/09 by shino
+          raise "not yet implemented!"
+        end
+      end
+
+    end
+
+    # This class is an experimental implementation of RESTified message API.
+    # Subscribe to queue:
+    #   using HTTP POST
+    #   a message is subscribed as HTTP body
+    #
+    #   options are sent as HTTP header which header name is "X-AP4R"
+    #   (now not supported)
+    #
+    #   url consists of prefix ("/subscribes") and queue name
+    #
+    #   response body is now return value of ReliableMsg#inspct
+    #   In the future, it will be possible to assign the format by the request header X-AP4R
+    #
+    #
+    #   === Rrequest example ===
+    #   POST /subscribes/queue.test HTTP/1.1
+    #
+    #
+    #   === Response example ===
+    #   HTTP/1.1 200 Ok
+    #   Content-Type: text/plain
+    #   Date: The, 11 Dec 2007 17:17:11 GMT
+    #
+    #   #<ReliableMsg::Message:0x320ec90 @headers={:priority=>0, :created=>1197628231, :expires=>nil, :delivery=>:best_effort, :id=>\"856016b0-8c5d-012a-79f3-0016cb9ad524\", :max_deliveries=>5}, @object=\"hoge\", @id=\"856016b0-8c5d-012a-79f3-0016cb9ad524\">
+    #
+    class Ap4rSubscribeMessageHandler < ::Mongrel::HttpHandler
+
+      def initialize(options)
+        @tick = Time.now
+        @queues = {}
+      end
+
+      def process(request, response)
+        if response.socket.closed?
+          return
+        end
+
+        queue_name = request.params[::Mongrel::Const::PATH_INFO][1..-1]
+        # header = make_header(request.params["HTTP_X_AP4R"]) # Todo: assign as constant 2007/11/27 by kiwamu
+
+        if "POST".include? request.params[::Mongrel::Const::REQUEST_METHOD]
+          begin
+            q = if @queues.key? queue_name
+                  @queues[queue_name]
+                else
+                  @queues[queue_name] = ::ReliableMsg::Queue.new(queue_name)
+                end
+            mes = q.get
+
+            response.start(200) do |head, out|
+              head['Content-Type'] = 'text/plain'
+              out.write mes.inspect
+            end
+          rescue
+            response.start(500) do |head, out|
+              head['Content-Type'] = 'text/plain'
+              out.write "Failed to get message for #{queue_name}"
+            end
+          end
+        else
+          raise "HTTP method is not POST..."
+        end
+      end
+
+      def make_header(x_ap4r_header)
+        header = {}
+        if x_ap4r_header
+          x_ap4r_header.split(',').map do |e|
+            key, value = e.strip.split('=')
+            if %w(dispatch_mode target_method delivery).include?(key)
+              header[key.to_sym] = value.to_sym
+            else
+              header[key.to_sym] = value
+            end
+          end
+        end
+        header
+      end
+
+      def log_threads_waiting_for(event)
+        if Time.now - @tick > 10
+          @tick = Time.now
+        end
+      end
+
+      # Does the internal reload for Rails.  It might work for most cases, but
+      # sometimes you get exceptions.  In that case just do a real restart.
+      def reload!
+        begin
+          #TODO not implemented 2007/04/09 by shino
+          raise "not yet implemented!"
+        end
+      end
+
+    end
+
   end
 end