ap4r 0.3.1 → 0.3.2

data/lib/ap4r/retention_history.rb

@@ -1,10 +1,11 @@
 # Author:: Shunichi Shinohara
-# Copyright:: Copyright (c) 2006 Future System Consulting Corp.
+# Copyright:: Copyright (c) 2007 Future Architect Inc.
 # Licence:: MIT Licence
 
 require 'active_support'
 
-module ReliableMsg
+module ReliableMsg #:nodoc:
+
   # This class is too much experimental.
   # The aim: for performance monitoring, records unprocessed message count 
   # in every queues at some interval.

data/lib/ap4r/script/base.rb

@@ -1,5 +1,5 @@
 # Author:: Shunichi Shinohara
-# Copyright:: Copyright (c) 2006 Future System Consulting Corp.
+# Copyright:: Copyright (c) 2007 Future Architect Inc.
 # Licence:: MIT Licence
 
 module Ap4r

data/lib/ap4r/script/queue_manager_control.rb

@@ -1,5 +1,5 @@
 # Author:: Shunichi Shinohara
-# Copyright:: Copyright (c) 2006 Future System Consulting Corp.
+# Copyright:: Copyright (c) 2007 Future Architect Inc.
 # Licence:: MIT Licence
 
 require 'rubygems'

data/lib/ap4r/script/setup.rb

@@ -1,5 +1,5 @@
 # Author:: Shunichi Shinohara
-# Copyright:: Copyright (c) 2006 Future System Consulting Corp.
+# Copyright:: Copyright (c) 2007 Future Architect Inc.
 # Licence:: MIT Licence
 
 $:.unshift(File.join(File.dirname(__FILE__), '../../'))

data/lib/ap4r/script/workspace_generator.rb

@@ -1,5 +1,5 @@
 # Author:: Shunichi Shinohara
-# Copyright:: Copyright (c) 2006 Future System Consulting Corp.
+# Copyright:: Copyright (c) 2007 Future Architect Inc.
 # Licence:: MIT Licence
 
 require 'fileutils'
@@ -8,7 +8,7 @@ require 'optparse'
 module Ap4r
   module Script
     class WorkspaceGenerator < Base
-      AP4R_Directories = %w(config log script tmp)
+      AP4R_Directories = %w(config log public script tmp)
       
       def run argv, options
         OptionParser.new {|opt|

data/lib/ap4r/start_with_log4r.rb

@@ -1,13 +1,16 @@
 # Author:: Shunichi Shinohara
-# Copyright:: Copyright (c) 2006 Future System Consulting Corp.
+# Copyright:: Copyright (c) 2007 Future Architect Inc.
 # Licence:: MIT Licence
 
+# Sample script to use Log4R
+
 require 'rubygems'
 require 'log4r'
 require 'log4r/yamlconfigurator'
 # we use various outputters, so require them, otherwise config chokes
 require 'log4r/outputter/datefileoutputter'
 require 'log4r/outputter/emailoutputter'
+
 include Log4r
 
 cfg = YamlConfigurator

data/lib/ap4r/store_and_forward.rb

@@ -1,5 +1,5 @@
 # Author:: Kiwamu Kato
-# Copyright:: Copyright (c) 2006 Future System Consulting Corp.
+# Copyright:: Copyright (c) 2007 Future Architect Inc.
 # Licence:: MIT Licence
 
 begin require 'rubygems'; rescue LoadError; end
@@ -25,9 +25,12 @@ module Ap4r
   #    :queue_message => message, :queue_headers => options})
   #
   module StoreAndForward
-      
-    DRUBY_URI = "druby://#{ENV['AP4R_DRUBY_HOST']||'localhost'}:#{ENV['AP4R_DRUBY_PORT'] || \
-'6438'}"
+    # TODO: make AsyncController include this module. 2007/05/02 by shino
+
+    # TODO: constant or class variable, whick is better? 2007/05/02 by shino
+    DRUBY_HOST = ENV['AP4R_DRUBY_HOST'] || 'localhost'
+    DRUBY_PORT = ENV['AP4R_DRUBY_PORT'] || '6438'
+    DRUBY_URI = "druby://#{DRUBY_HOST}:#{DRUBY_PORT}" 
 
     # This method needs information about stored message, such as 
     # putting queue's name, message, options, as aruments.
@@ -59,6 +62,7 @@ module Ap4r
     # See the StoreMessage rdoc for more details.
     #
     def __ap4r_forward_by_stored_message_id(stored_message_id, options)
+      raise "not implemented"
       # TODO: Find record and make queue info , 2006/10/13 kato-k
       queue_name = nil
       queue_message = nil
@@ -68,7 +72,7 @@ module Ap4r
     alias :forward_by_stored_message_id :__ap4r_forward_by_stored_message_id 
 
     
-    # Put a message into queue.
+    # Puts a message into queue.
     # As queue_headers, some options are supported.
     # See the reliable-msg docuememt for more details.
     def __ap4r_queue_put(queue_name, queue_message, queue_headers)
@@ -84,7 +88,7 @@ end
 # For test
 if __FILE__ == $0
 
-  class TestSaf
+  class TestSaf #:nodoc:
 
     include ::Ap4r::StoreAndForward
 

data/lib/ap4r/stored_message.rb

@@ -1,5 +1,5 @@
 # Author:: Kiwamu Kato
-# Copyright:: Copyright (c) 2006 Future System Consulting Corp.
+# Copyright:: Copyright (c) 2007 Future Architect Inc.
 # Licence:: MIT Licence
 
 begin 
@@ -59,13 +59,14 @@ module Ap4r
     # * :delete_mode (:physical or :logical)
     # Default delete mmode is physical.
     # If you need logical delete, for example you neeed checking message
-    # duplication etc, Set the instance variable appropriately. 
+    # duplication etc, set the <tt>Ap4r::AsyncController.saf_delete_mode</tt>
+    # <tt>:logical</tt>.
     def self.destroy_if_exists(id, options)
       result = nil
       begin
         result = StoredMessage.find(id) 
       rescue ActiveRecord::RecordNotFound
-        # There are chances that othere thread or process already forwarded. 
+        # There are possibilities that other threads or processes have already forwarded. 
         return nil
       end
       result.destroy_or_update(options)

data/lib/ap4r/util/irm.rb

@@ -1,5 +1,5 @@
- # Author:: Shunichi Shinohara
-# Copyright:: Copyright (c) 2006 Future System Consulting Corp.
+# Author:: Shunichi Shinohara
+# Copyright:: Copyright (c) 2007 Future Architect Inc.
 # Licence:: MIT Licence
 
 $KCODE = 'u'
@@ -71,7 +71,7 @@ Ap4r::Configuration.load_setting_files
 
 $original_main = self
 
-class Object
+class Object #:nodoc:
   Ap4r::Configuration.services.each {|s|
     module_eval <<-EOS
       def #{s.name.to_s}

data/lib/ap4r/util/queue_client.rb

@@ -1,5 +1,5 @@
 # Author:: Shunichi Shinohara
-# Copyright:: Copyright (c) 2006 Future System Consulting Corp.
+# Copyright:: Copyright (c) 2007 Future Architect Inc.
 # Licence:: MIT Licence
 
 module Ap4r::Util #:nodoc:

data/lib/ap4r/version.rb

@@ -1,5 +1,5 @@
 # Author:: Kiwamu Kato
-# Copyright:: Copyright (c) 2006 Future System Consulting Corp.
+# Copyright:: Copyright (c) 2007 Future Architect Inc.
 # Licence:: MIT Licence
 
 module Ap4r
@@ -8,7 +8,7 @@ module Ap4r
   module VERSION #:nodoc:
     MAJOR = 0
     MINOR = 3
-    TINY  = 1
+    TINY  = 2
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

data/rails_plugin/ap4r/lib/async_controller.rb

@@ -1,5 +1,5 @@
 # Author:: Shunichi Shinohara
-# Copyright:: Copyright (c) 2006 Future System Consulting Corp.
+# Copyright:: Copyright (c) 2007 Future Architect Inc.
 # Licence:: MIT Licence
 
 require 'reliable-msg'
@@ -24,21 +24,31 @@ module Ap4r
 
     module Base
       Converters = {}
-      DRUBY_URI = "druby://#{ENV['AP4R_DRUBY_HOST']||'localhost'}:#{ENV['AP4R_DRUBY_PORT'] || '6438'}"
+
+      # TODO: constant or class variable, whick is better? 2007/05/02 by shino
+      DRUBY_HOST = ENV['AP4R_DRUBY_HOST'] || 'localhost'
+      DRUBY_PORT = ENV['AP4R_DRUBY_PORT'] || '6438'
+      DRUBY_URI = "druby://#{DRUBY_HOST}:#{DRUBY_PORT}" 
 
       @@default_dispatch_mode = :HTTP
-      @@default_rm_options = { :delivery => :once }
+      @@default_rm_options = { :delivery => :once, :dispatch_mode => @@default_dispatch_mode }
       @@default_queue_prefix = "queue."
 
       mattr_accessor :default_dispatch_mode, :default_rm_options, :default_queue_prefix, :saf_delete_mode
 
-      # Provide at-least-once QoS level.
-      # Execute application logic and store the message for next logic to the application
-      # database. This is a store processing. After commit to the database,
-      # put the message into queue and update or delte a management table.
-      # This is a forward processing.
-      # SAF(store and forward) processing like this guarantees that any message
-      # is never lost and keeps reasonable performance.
+      # Provides at-least-once QoS level.
+      # +block+ are tipically composed of database accesses and +async_dispatch+ calls.
+      # Database accesses are executed transactionallly by +active_record_class+'s transaction method.
+      # In the +block+, +async_dispatch+ calls invoke NOT immediate queueing but just storing messages
+      # to the database (assumed to be the same one as application uses).
+      #
+      # If the execution of +block+ finishes successfully, database transaction is committed and
+      # forward process of each stored message begins.
+      # Forward process composed in two parts. First puts the message into a queue, secondary update 
+      # or delete the entry from a management table.
+      #
+      # SAF (store and forward) processing like this guarantees that any message
+      # is never lost and keeps reasonable performance (without two phase commit).
       #
       # Examples: Just call async_dispath method in this block.
       #
@@ -57,7 +67,7 @@ module Ap4r
         Thread.current[:stored_messages] = {}
 
         # store
-        active_record_class ||= StoredMessage
+        active_record_class ||= ::Ap4r::StoredMessage
         active_record_class.transaction(*objects, &block)
 
         # forward
@@ -68,13 +78,14 @@ module Ap4r
           # Once some error occured, such as disconnect reliable-msg or server crush,
           # which is smart to keep to put a message or stop to do it?
           # In the case of being many async messages, the former strategy is not so good.
+          # 
+          # TODO: add delayed forward mode 2007/05/02 by shino
           Thread.current[:stored_messages].each {|k,v|
             __queue_put(v[:queue_name], v[:queue_message], v[:queue_headers])
             forwarded_messages[k] = v
           }
         rescue Exception => err
-          # Don't raise any Exception. Response to user already completed.
-          # nop
+          # Don't raise any Exception. Application logic has already completed and messages are saved.
           logger.warn("Failed to put a message into queue: #{err}")
         end
 
@@ -86,8 +97,7 @@ module Ap4r
             }
           end
         rescue Exception => err
-          # Don't raise any Exception. Response to user already completed.
-          # nop
+          # Don't raise any Exception. Application logic has already completed and messages are saved.
           logger.warn("Failed to put a message into queue: #{err}")
         end
 
@@ -115,29 +125,28 @@ module Ap4r
       # Object of argumemts (async_params, options and rm_options) will not be modified.
       # Implementors (of this class and converters) should not modify them.
       #
-      def async_dispatch(async_params = nil, options = {}, rm_options = nil)
+      def async_dispatch(url_options = {}, async_params = nil, rm_options = nil)
+        # TODO: add :url to url_options to specify :target_url shortly 2007/05/02 by shino
         if logger.debug?
+          logger.debug("url_options: ")
+          logger.debug(url_options.inspect)
           logger.debug("async_params: ")
           logger.debug(async_params.inspect)
-          logger.debug("options: ")
-          logger.debug(options.inspect)
-          logger.debug("rm_options")
+          logger.debug("rm_options: ")
           logger.debug(rm_options.inspect)
         end
 
         # TODO: clone it, 2006/10/16 shino
-        options ||= {}
-        options[:controller] ||= controller_path.gsub("/", ".")
+        url_options ||= {}
+        url_options[:controller] ||= self.controller_path.gsub("/", ".")
         rm_options = @@default_rm_options.merge(rm_options || {})
-        # TODO: put into :dispatch_mode to @@default_rm_options
-        rm_options[:dispatch_mode] ||= @@default_dispatch_mode
 
         # Only async_params is not cloned. options and rm_options are cloned before now.
         # This is a current contract between this class and converter classes.
-        converter = Converters[rm_options[:dispatch_mode]].new(self, async_params, options, rm_options)
+        converter = Converters[rm_options[:dispatch_mode]].new(url_options, async_params, rm_options, self)
         logger.debug{"druby uri for queue-manager : #{DRUBY_URI}"}
 
-        queue_name = __get_queue_name(options, rm_options)
+        queue_name = __get_queue_name(url_options, rm_options)
         queue_message = converter.make_params
         queue_headers = converter.make_rm_options
 
@@ -159,6 +168,7 @@ module Ap4r
 
       private
       def __queue_put(queue_name, queue_message, queue_headers)
+        # TODO: can use a Queue instance repeatedly? 2007/05/02 by shino
         q = ReliableMsg::Queue.new(queue_name, :drb_uri => DRUBY_URI)
         q.put(queue_message, queue_headers)
       end
@@ -171,15 +181,14 @@ module Ap4r
 
     end
 
-    #--
-    # TODO: pluralize it, 2006/10/16 shino
-    module Converter #:nodoc:
+    module Converters #:nodoc:
 
       # A base class for converter classes.
       # Responsibilities of subclasses are as folows
       # * by +make_params+, convert async_params to appropriate object
       # * by +make_rm_options+, make appropriate +Hash+ passed by <tt>ReliableMsg::Queue#put</tt>
       class Base
+
         # Difine a constant +DISPATCH_MODE+ to value 'mode_symbol' and
         # add self to a Converters list.
         def self.dispatch_mode(mode_symbol)
@@ -187,31 +196,33 @@ module Ap4r
           ::Ap4r::AsyncController::Base::Converters[mode_symbol] = self
         end
 
-        def initialize(controller, async_params, options, rm_options)
-          @controller = controller
+        def initialize(url_options, async_params, rm_options, url_for_handler)
+          @url_options = url_options
           @async_params = async_params
-          @options = options
           @rm_options = rm_options
-        end
-
-        # helper method for <tt>ActionController#url_for</tt>
-        def url_for(url_for_options, *parameter_for_method_reference)
-          @controller.url_for(url_for_options, *parameter_for_method_reference)
+          @url_for_handler = url_for_handler
         end
 
         # Returns a object which passed to <tt>ReliableMsg::Queue.put(message, headers)</tt>'s
         # first argument +message+.
         # Should be implemented by subclasses.
         def make_params
-          raise 'must be implemented'
+          raise 'must be implemented in subclasses'
         end
 
         # Returns a object which passed to <tt>ReliableMsg::Queue.put(message, headers)</tt>'s
         # second argument +headers+.
         # Should be implemented by subclasses.
         def make_rm_options
-          raise 'must be implemented'
+          raise 'must be implemented in subclasses'
         end
+
+        private
+        # helper method for <tt>ActionController#url_for</tt>
+        def url_for(url_for_options, *parameter_for_method_reference)
+          @url_for_handler.url_for(url_for_options, *parameter_for_method_reference)
+        end
+
       end
 
       class Http < Base
@@ -222,7 +233,7 @@ module Ap4r
         end
 
         def make_rm_options
-          @rm_options[:target_url] ||= url_for(@options)
+          @rm_options[:target_url] ||= url_for(@url_options)
           @rm_options[:target_method] ||= 'POST'
           #TODO: make option key to specify HTTP headers, 2006/10/16 shino
           @rm_options
@@ -243,12 +254,12 @@ module Ap4r
         end
 
         def action_api_name
-          action_method_name = @options[:action]
+          action_method_name = @url_options[:action]
           action_method_name.camelcase
         end
 
         def options_without_action
-          new_opts = @options.dup
+          new_opts = @url_options.dup
           new_opts[:action] = nil
           new_opts
         end

data/script/mongrel_ap4r

@@ -0,0 +1,4 @@
+require 'rubygems'
+require 'ap4r'
+
+load 'ap4r/mongrel_ap4r.rb'

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.2
 specification_version: 1
 name: ap4r
 version: !ruby/object:Gem::Version 
-  version: 0.3.1
-date: 2007-04-24 00:00:00 +09:00
+  version: 0.3.2
+date: 2007-06-06 00:00:00 +09:00
 summary: Asynchronous Processing for Ruby.
 require_paths: 
 - lib
@@ -36,12 +36,11 @@ files:
 - doc
 - lib
 - MIT-LICENSE
-- pkg
 - rails_plugin
 - Rakefile
 - README
 - script
-- temp
+- spec
 - bin/ap4r_setup
 - config/ap4r_settings.rb
 - config/log4r.yaml
@@ -49,18 +48,20 @@ files:
 - config/queues_disk.cfg
 - config/queues_mysql.cfg
 - rails_plugin/ap4r
-- rails_plugin/ap4r/init.rb
 - rails_plugin/ap4r/lib
 - rails_plugin/ap4r/lib/async_controller.rb
 - script/irm
 - script/loop.cmd
 - script/loop.rb
-- script/mongrel_ap4r.rb
+- script/mongrel_ap4r
 - script/start
 - script/stop
 - lib/ap4r
+- lib/ap4r/carrier.rb
+- lib/ap4r/dispatcher.rb
 - lib/ap4r/message_store_ext.rb
 - lib/ap4r/mongrel.rb
+- lib/ap4r/mongrel_ap4r.rb
 - lib/ap4r/multi_queue.rb
 - lib/ap4r/queue_manager_ext.rb
 - lib/ap4r/queue_manager_ext_debug.rb
@@ -75,10 +76,8 @@ files:
 - lib/ap4r/stored_message.rb
 - lib/ap4r/util
 - lib/ap4r/util/irm.rb
-- lib/ap4r/util/loc.rb
 - lib/ap4r/util/queue_client.rb
 - lib/ap4r/version.rb
-- lib/ap4r/xxx_create_table_for_saf.rb
 - lib/ap4r.rb
 test_files: []
 
@@ -108,3 +107,30 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 1.1.0
     version: 
+- !ruby/object:Gem::Dependency 
+  name: rake
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">"
+      - !ruby/object:Gem::Version 
+        version: 0.0.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">"
+      - !ruby/object:Gem::Version 
+        version: 0.0.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: mongrel
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">"
+      - !ruby/object:Gem::Version 
+        version: 0.0.0
+    version: