ap4r 0.1.0 → 0.1.1

data/config/queues_disk.cfg

@@ -0,0 +1,15 @@
+--- 
+store: 
+  type: disk
+drb: 
+  host: 
+  port: 6438
+  acl: allow 127.0.0.1 allow 10.0.0.0/8
+dispatchers:
+  -
+    targets: queue.*
+    threads: 1
+#carriers:
+#  - 
+#    source_uri: druby://another.host.local:6438
+#    threads: 1

data/{configs → config}/queues_mysql.cfg

@@ -1,9 +1,9 @@
 --- 
 store: 
-  username: orca
   type: mysql
   host: localhost
   database: ap4r
+  username: ap4r
   password: ap4r
 drb: 
   host: 
@@ -11,5 +11,9 @@ drb:
   acl: allow 127.0.0.1 allow 10.0.0.0/8
 dispatchers:
   -
-    queue: queue.orders.*
+    targets: queue.*
     threads: 1
+#carriers:
+#  - 
+#    source_uri: druby://another.host.local:6438
+#    threads: 1

data/lib/ap4r.rb

@@ -1,17 +1,15 @@
-require 'rubygems'
-version = "> 0"
-if ARGV.size > 0 && ARGV[0][0]==95 && ARGV[0][-1]==95
-  if Gem::Version.correct?(ARGV[0][1..-2])
-    version = ARGV[0][1..-2] 
-    ARGV.shift
-  end
-end
+# Author:: Shunichi Shinohara
+# Copyright:: Copyright (c) 2006 Future System Consulting Corp.
+# Licence:: MIT Licence
 
-require_gem 'reliable-msg', version
+require 'rubygems'
+require_gem 'reliable-msg'
 
 hack = true
 debug_hack = true
 
+require 'ap4r/version'
+
 if hack
   require "ap4r/queue_manager_ext"
 end

data/lib/ap4r/message_store_ext.rb

@@ -1,7 +1,14 @@
+# Author:: Shunichi Shinohara
+# Copyright:: Copyright (c) 2006 Future System Consulting Corp.
+# Licence:: MIT Licence
+
 module ReliableMsg
   module MessageStore
     class Base
 
+      cattr_accessor :use_mysql_extention
+      @@use_mysql_extention = true
+
       def stale_queue targets
         queue_names = targets.split(/[\s;]/).
           select{|queue| !queue.empty? }.
@@ -25,5 +32,24 @@ module ReliableMsg
       end
 
     end
+
+  end
+end
+
+if ReliableMsg::MessageStore::Base.use_mysql_extention
+  class Mysql
+    alias original_query query
+    def query(q, &block)
+      maybe_result = original_query(q, &block)
+      puts "Mysql extention: query called by #{q}"
+      puts "Mysql#query returns #{maybe_result}(class: #{maybe_result.class})." if $DEBUG
+      return maybe_result unless block && maybe_result.kind_of?(Mysql::Result)
+      begin
+        puts "Mysql extention: about to yield result." if $DEBUG
+        block.call(maybe_result)
+      ensure
+        maybe_result.free
+      end
+    end
   end
 end

data/lib/ap4r/multi_queue.rb

@@ -1,10 +1,28 @@
+# Author:: Shunichi Shinohara
+# Copyright:: Copyright (c) 2006 Future System Consulting Corp.
+# Licence:: MIT Licence
+
 module ReliableMsg
+  # The +MultiQueue+ is a kind of clients.
+  # This offers two extentions to <tt>ReliableMsg::Queue</tt>
+  # 1. specify multiple target queues, by as comma-separated queue names.
+  # 1. specify prefix of a collection of queues by an asterisk at the end.
+  # Exapmles:
+  # * <tt>"a.b.c"</tt> targets single queue.
+  # * <tt>"a.b.c, x.y.z"</tt> targets two queues.
+  # * <tt>"a.b.*"</tt> targets a collection of queues such as "a.b.c", "a.b.d", etc.
+  # * <tt>"a.b.*, x.y.*"</tt> targets two collections.
   class MultiQueue < Client
+    # Creates a new +MultiQueue+ with target queues specified by +multi_queue+.
+    # See <tt>ReliableMsg::Queue</tt> for +options+.
     def initialize multi_queue, options = nil
       @multi_queue = multi_queue
       @options = options
     end
 
+    # Gets a message from target queues.
+    # Internally, first search a queue with the most stale message,
+    # and get a message from the queue by <tt>ReliableMsg::Queue#get</tt>
     def get selector = nil, &block
       queue_name = repeated {|qm|
         qm.stale_queue @multi_queue
@@ -14,6 +32,7 @@ module ReliableMsg
       queue.get selector, &block
     end
 
+    # Returns multi queue expression as +String+.
     def name
       @multi_queue
     end

data/lib/ap4r/queue_manager_ext.rb

@@ -1,3 +1,7 @@
+# Author:: Shunichi Shinohara
+# Copyright:: Copyright (c) 2006 Future System Consulting Corp.
+# Licence:: MIT Licence
+
 require 'ap4r/message_store_ext'
 require 'ap4r/multi_queue'
 require 'ap4r/retention_history'
@@ -11,11 +15,13 @@ require 'thread'
 require 'pp'
 
 module ReliableMsg
-  module LifecycleListener
+  module LifecycleListener #:nodoc:
     
   end
 
   class QueueManager
+    # Gets a queue name which has the most stale message
+    # in queues specified by +multi_queue+.
     def stale_queue multi_queue
       @store.stale_queue multi_queue
     end
@@ -24,7 +30,11 @@ module ReliableMsg
     alias :stop_original :stop
     alias :initialize_original :initialize
 
-    def initialize options = nil
+    # Hooks original initialize method to add lifecyle listeners.
+    #--
+    # TODO: Make dispatchers and carriers lifecyle listeners
+    # and separate them from QueueManager.
+    def initialize options = nil #:notnew:
       initialize_original options
       @global_lock ||= Mutex.new
       @lifecycle_listeners = []
@@ -59,8 +69,8 @@ module ReliableMsg
     end
 
     def start_dispatchers
-      return unless @config.disps
-      @logger.info{ "about to start dispatchers with config #{@config.disps.to_yaml}" }
+      return unless @config.dispatchers
+      @logger.info{ "about to start dispatchers with config #{@config.dispatchers.to_yaml}" }
       @disps = ThreadGroup.new
       @config.dispatchers.each{ |conf|
         conf["threads"].to_i.times { |index|
@@ -74,6 +84,8 @@ module ReliableMsg
               begin
                 mq.get{|m|
                   logger.debug{"dispatcher get message\n#{m.to_yaml}"} if m
+                  # TODO: divede into comcrete classes by protocols.
+
                   # version 1 SOAP
 #                  driver = SOAP::WSDLDriverFactory.new(m[:target_url]).create_rpc_driver
 #                  logger.debug(driver)
@@ -135,6 +147,8 @@ module ReliableMsg
                   end
                   #logger.debug{ "carrier gets a message\n#{m.to_yaml}" }
 
+                  # TODO: decide the better one, and delete another.
+
                   #version 1: use thread fork so queue manager use a different tx
                   # TODO probably should have a thread as an instance variable or in a thread local
                   #Thread.fork(m) {|m|

data/lib/ap4r/queue_manager_ext_debug.rb

@@ -1,9 +1,22 @@
+# Author:: Shunichi Shinohara
+# Copyright:: Copyright (c) 2006 Future System Consulting Corp.
+# Licence:: MIT Licence
+
 require 'drb/drb'
 
 module ReliableMsg
   class QueueManager
     attr_reader :store, :transactions, :mutex, :config
 
+    # Accepts ruby code as a string, evaluates it on +self+,
+    # and returns the result as a formatted string.
+    # Formats can be one of followings.
+    # * <tt>:inspect</tt> : default value
+    # * <tt>:yaml</tt>
+    # * <tt>:json</tt>
+    # * <tt>:xml</tt>
+    # Apart from <tt>:inspect</tt>, format can fail depending on 
+    # the result object.
     def eval_to_inspect code, inspect_mode = :inspect
       # TODO: too sloppy implementation
       result = Thread.new(code, inspect_mode){ |c, mode|

data/lib/ap4r/retention_history.rb

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

data/lib/ap4r/script/base.rb

@@ -0,0 +1,11 @@
+# Author:: Shunichi Shinohara
+# Copyright:: Copyright (c) 2006 Future System Consulting Corp.
+# Licence:: MIT Licence
+
+module AP4R
+  module Script #:nodoc:
+    class Base
+      cattr_accessor :logger, :ap4r_base
+    end
+  end
+end

data/lib/ap4r/script/queue_manager_control.rb

@@ -0,0 +1,27 @@
+# Author:: Shunichi Shinohara
+# Copyright:: Copyright (c) 2006 Future System Consulting Corp.
+# Licence:: MIT Licence
+
+require 'rubygems'
+require 'ap4r'
+
+module AP4R
+  module Script
+    class QueueManagerControl < Base
+      def start argv, options = {}
+        ARGV.unshift('manager', 'start')
+        run_rm_client
+      end
+
+      def stop argv, options = {}
+        ARGV.unshift('manager', 'stop')
+        run_rm_client
+      end
+
+      private
+      def run_rm_client
+        ReliableMsg::CLI.new.run
+      end
+    end
+  end
+end

data/lib/ap4r/script/setup.rb

@@ -0,0 +1,17 @@
+# Author:: Shunichi Shinohara
+# Copyright:: Copyright (c) 2006 Future System Consulting Corp.
+# Licence:: MIT Licence
+
+$:.unshift(File.join(File.dirname(__FILE__), '../../'))
+
+require 'logger'
+begin
+  require 'active_support'
+rescue LoadError
+  require 'rubygems'
+  require_gem 'active_support'
+end
+
+require 'ap4r/script/base'
+AP4R::Script::Base.logger = Logger.new(STDOUT)
+AP4R::Script::Base.ap4r_base = File.join(File.dirname(__FILE__) , '../../../')

data/lib/ap4r/script/workspace_generator.rb

@@ -0,0 +1,65 @@
+# Author:: Shunichi Shinohara
+# Copyright:: Copyright (c) 2006 Future System Consulting Corp.
+# Licence:: MIT Licence
+
+require 'fileutils'
+require 'optparse'
+
+module AP4R
+  module Script
+    class WorkspaceGenerator < Base
+      AP4R_Directories = %w(config log script tmp)
+      
+      def run argv, options
+        OptionParser.new {|opt|
+          opt.on('-m'){
+            # merge to rails project but not implemented yet... 
+          }
+
+          opt.parse!(argv)
+        }
+
+        dir = argv.last
+        unless dir
+          logger.warn{"Specify a name of application root directory."}
+          exit(1)
+        end
+
+        root_dir = File.expand_path(dir)
+
+        logger.info{"make application root directory [#{root_dir}] ... "}
+        FileUtils.mkdir_p(root_dir)
+
+        logger.info{"make directories for AP4R [#{AP4R_Directories.join(", ")}] ..."}
+        FileUtils.mkdir_p(AP4R_Directories.map{|d| File.join(root_dir, d)})
+
+        %w(config script).each{ |recursive_copy_dir|
+          copy_files(File.join(ap4r_base, recursive_copy_dir),
+                     File.join(root_dir, recursive_copy_dir))
+        }
+
+        logger.info{"\n[#{root_dir}] has successfully set up!\n"}
+
+      end
+
+      private
+      def copy_files(src_dir, dest_dir, excludes = /^\.|~$/, recursive = true)
+        logger.info{"copy files from #{File.expand_path(src_dir)} to #{dest_dir} ..."}
+        Dir.foreach(src_dir) {|name|
+          next if name =~ excludes
+          path = File.join(src_dir, name)
+          FileUtils.cp(path, dest_dir) if FileTest.file?(path)
+
+          if recursive && FileTest.directory?(path)
+            next_dest_dir = File.join(dest_dir, name)
+            FileUtils.mkdir_p(next_dest_dir)
+            copy_files(path, next_dest_dir, excludes, recursive)
+          end
+        }
+      end
+
+    end
+  end
+end
+
+

data/lib/ap4r/start_with_log4r.rb

@@ -1,3 +1,7 @@
+# Author:: Shunichi Shinohara
+# Copyright:: Copyright (c) 2006 Future System Consulting Corp.
+# Licence:: MIT Licence
+
 require 'rubygems'
 require 'log4r'
 require 'log4r/yamlconfigurator'

data/lib/ap4r/util/irm.rb

@@ -0,0 +1,93 @@
+# Author:: Shunichi Shinohara
+# Copyright:: Copyright (c) 2006 Future System Consulting Corp.
+# Licence:: MIT Licence
+
+$KCODE = 'u'
+
+require 'singleton'
+require 'rubygems'
+require 'ap4r'
+require 'ap4r/util/queue_client'
+
+class AP4R::Configuration #:nodoc:
+  SETTINGS_FILES_DEFAULT = %w( config/ap4r_settings.rb )
+
+  class Services #:nodoc:
+    include Singleton
+    include Enumerable
+
+    def initialize
+      @list = []
+    end
+
+    def add(*args)
+      client = AP4R::Util::QueueClient.new(*args)
+      @list << (client)
+    end
+
+    def each(&block)
+      @list.each(&block)
+    end
+  end
+
+  class << self
+    def setup
+      yield Services.instance
+    end
+
+    def services
+      Services.instance
+    end
+
+    def load_setting_files(settings_files = SETTINGS_FILES_DEFAULT)
+      settings_files.each{ |file|
+        load(file) if FileTest.file?(file)
+      }
+    end
+  end
+
+end
+
+# This class is TOO MUCH EXPERIMENTAL.
+#
+# IRM is the interactive reliable-msg shell.
+class IRM
+  class << self
+    def [](name)
+      sym_name = name.to_sym
+      AP4R::Configuration.services.find{|service| service.name == sym_name }
+    end
+  end
+end
+
+#--
+
+def each(&block)
+  AP4R::Configuration.services.each(&block)
+end
+extend Enumerable
+
+AP4R::Configuration.load_setting_files
+
+$original_main = self
+
+class Object
+  AP4R::Configuration.services.each {|s|
+    module_eval <<-EOS
+      def #{s.name.to_s}
+        irb_change_workspace(IRM[:#{s.name.to_s}])
+      end
+    EOS
+  }
+
+  def main
+    irb_change_workspace($original_main)
+    nil
+  end
+
+end
+
+require 'irb'
+IRB.start
+
+#++