ap4r 0.1.0 → 0.1.1

data/lib/ap4r/util/loc.rb

@@ -0,0 +1,12 @@
+# Author:: Shunichi Shinohara
+# Copyright:: Copyright (c) 2006 Future System Consulting Corp.
+# Licence:: MIT Licence
+
+require 'active_support'
+require 'code_statistics'
+
+CodeStatistics.new(
+                   ["Core Sources", "lib"],
+                   ["Rails plugin", "rails_plugin"],
+                   ["Scripts", "script"],
+).to_s

data/lib/ap4r/util/queue_client.rb

@@ -0,0 +1,123 @@
+# Author:: Shunichi Shinohara
+# Copyright:: Copyright (c) 2006 Future System Consulting Corp.
+# Licence:: MIT Licence
+
+module AP4R::Util #:nodoc:
+  # This class is TOO EXPERIMENTAL
+  #
+  # Client class for +QueueManager+.
+  # This class wraps DRb client and provides some helper methods.
+  # TODO: many drb calls are executed in a method call such as +list_queues+.
+  #       ParseTree is perhaps needed.
+  # TODO: +Proc+ object cannnot be passed via DRb. ParseTree also?
+  class QueueClient
+    CONFIG_DIR_DEFAULT = 'config'
+    CONFIG_FILE_DEFAULT = 'queues.cfg'
+
+    HOST_DEFAULT = 'localhost'
+    
+    DEFAULT_QUEUE_PREFIX = 'queue.test.'
+    DEFAULT_QUEUE_SUFFIX = 'default'
+    DEFAULT_MULTI_QUEUE = DEFAULT_QUEUE_PREFIX + '*'
+
+    @@config_dir = CONFIG_DIR_DEFAULT
+    cattr_accessor :config_dir
+
+    attr_reader :name, :config
+
+    # Creates new client from a configuration file.
+    # Some options are supported.
+    # * <tt>:host</tt>
+    # * <tt>:port</tt>
+    # * <tt>:name</tt>
+    def initialize(config_file = CONFIG_FILE_DEFAULT,
+                   options = {},
+                   config_dir = @@config_dir)
+      @config = ReliableMsg::Config.new(File.join(config_dir, config_file))
+      @config.load_no_create
+      @host = options[:host] || @config.drb['host'] || 'localhost'
+      @port = options[:port] || @config.drb['port'] || 6438
+      @name = (options[:name]).to_sym
+      @qm = nil
+    end
+
+    def queue_manager
+      @qm ||= DRb::DRbObject.new_with_uri(drb_uri)
+    end
+
+    def queue_manager_stop
+      manager = queue_manager
+      begin
+        manager.stop
+      rescue DRb::DRbConnError => error
+        error.message
+      end
+    end
+
+    def list_queues
+      qm.store.queues.keys
+    end
+  
+    def list_messages(suffix = DEFAULT_QUEUE_SUFFIX,
+                      prefix = DEFAULT_QUEUE_PREFIX)
+      qm.store.queues[prefix.to_s + suffix.to_s]
+    end
+
+    def make_queue(suffix = DEFAULT_QUEUE_SUFFIX,
+                   prefix = DEFAULT_QUEUE_PREFIX)
+      ReliableMsg::Queue.new(prefix.to_s + suffix.to_s, :drb_uri => drb_uri)
+    end
+
+    def queue_get(suffix = DEFAULT_QUEUE_SUFFIX, selector = nil,
+                  prefix = DEFAULT_QUEUE_PREFIX, &block)
+      q = make_queue suffix, prefix
+      q.get selector, &block
+    end
+
+    def queue_put(suffix = DEFAULT_QUEUE_SUFFIX,
+                  message = nil, prefix = DEFAULT_QUEUE_PREFIX,
+                  headers = nil)
+      unless message
+        t = Time.now
+        message = sprintf("test message %s,%s",
+                          t.strftime("%Y/%m/%d %H:%M:%S"), t.usec)
+      end
+      q = make_queue suffix, prefix
+      q.put message, headers
+    end
+
+    def make_multi_queue multi_queue = DEFAULT_MULTI_QUEUE
+      ReliableMsg::MultiQueue.new(multi_queue.to_s, :drb_uri => drb_uri)
+    end
+
+    def multi_queue_get(selector = nil,
+                        multi_queue = DEFAULT_MULTI_QUEUE, &block)
+      mq = make_multi_queue multi_queue, :drb_uri => irm_drb_uri
+      mq.get selector, &block
+    end
+
+    def drb_uri
+      "druby://#{@host}:#{@port}"
+    end
+
+    def to_s
+      @name.to_s
+    end
+
+    alias qm queue_manager
+    alias stop queue_manager_stop
+
+    alias lsq list_queues
+    alias lsm list_messages
+
+    alias mkq make_queue
+    alias qg queue_get
+    alias qp queue_put
+
+    alias mkmq make_multi_queue
+    alias mqg multi_queue_get
+
+    alias uri drb_uri
+
+  end
+end

data/lib/ap4r/version.rb

@@ -0,0 +1,15 @@
+# Author:: Kiwamu Kato
+# Copyright:: Copyright (c) 2006 Future System Consulting Corp.
+# Licence:: MIT Licence
+
+module AP4R
+  # Defines version number contants, and provides 
+  # its string expression.
+  module VERSION #:nodoc:
+    MAJOR = 0
+    MINOR = 1
+    TINY  = 1
+
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+end

data/rails_plugin/ap4r/init.rb

@@ -0,0 +1,10 @@
+# Author:: Shunichi Shinohara
+# Copyright:: Copyright (c) 2006 Future System Consulting Corp.
+# Licence:: MIT Licence
+
+require_dependency 'async_controller'
+
+class ActionController::Base
+  include AP4R::AsyncController
+end
+

data/rails_plugin/ap4r/lib/async_controller.rb

@@ -0,0 +1,64 @@
+# Author:: Shunichi Shinohara
+# Copyright:: Copyright (c) 2006 Future System Consulting Corp.
+# Licence:: MIT Licence
+
+require 'reliable-msg'
+
+module AP4R
+  # This +asyncController+ is the Rails plugin for asynchronous processing.
+  # Asynchronous logics are called via various protocols, such as XML-RPC,
+  # SOAP, HTTP PUT, and more. Now implemented jsut as XML-RPC.
+  #
+  # Examples: The part of calling next asynchronous logics in a controller in the HelloWorld Sample.
+  #
+  #     req = WorldRequest.new
+  #     req.world_id = 1
+  #     req.message = "World"
+  #
+  #     req_hash = {}
+  #     req.each_pair{|k,v| req_hash[k.to_sym]=v}
+  #
+  #     render :action => 'response'
+  #
+  #     async_dispatch(req_hash,
+  #                     :controller => 'async_world', :action => 'execute',
+  #                     :mode => :XMLRPC)
+  #
+  module AsyncController
+    #DEFAULT_DISPATCH_MODE = :SOAP
+    DEFAULT_DISPATCH_MODE = :XMLRPC
+
+    # Queue a message for next asynchronous logic. Some options are supported.
+    # * :controller (name of next logic)
+    # * :action (name of next logic)
+    # * :mode (protocol)
+    def async_dispatch(object, options = {})
+      target_url = url_for(:controller => options[:controller],
+                           :action => nil)
+      options[:mode] = options[:mode] || dispatch_mode
+      options[:target_url] = target_url_name(target_url, options[:mode])
+      target_action = action_api_name(options.delete(:action), options[:mode])
+      options[:target_action] = target_action
+
+      queue_name = "queue.".concat(options[:controller].to_s).
+        concat('.').concat(target_action)
+
+      q = ReliableMsg::Queue.new(queue_name)
+      mid = q.put(object, options)
+      mid
+    end
+    
+    private
+    def dispatch_mode
+      DEFAULT_DISPATCH_MODE
+    end
+
+    def target_url_name(target_url, mode)
+      target_url + "/api"
+    end
+
+    def action_api_name(action_method_name, mode)
+      action_method_name.capitalize
+    end
+  end
+end

data/script/irm

@@ -0,0 +1,4 @@
+require 'rubygems'
+require 'ap4r'
+
+require 'ap4r/util/irm'

data/script/start

@@ -0,0 +1,5 @@
+require 'rubygems'
+require 'ap4r/script/setup'
+
+require 'ap4r/script/queue_manager_control'
+AP4R::Script::QueueManagerControl.new.start(ARGV)

data/script/stop

@@ -0,0 +1 @@
+

metadata

@@ -3,18 +3,17 @@ rubygems_version: 0.8.11
 specification_version: 1
 name: ap4r
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
-date: 2006-09-01 00:00:00 +09:00
+  version: 0.1.1
+date: 2006-10-05 00:00:00 +09:00
 summary: Asynchronous Processing for Ruby.
 require_paths: 
 - lib
-email: kato.kiwamu@future.co.jp, shinohara.shunichi@future.co.jp
+email: shinohara.shunichi@future.co.jp, kato.kiwamu@future.co.jp
 homepage: http://rubyforge.org/projects/ap4r/
 rubyforge_project: ap4r
 description: Asynchronous Processing for Ruby.
 autorequire: ap4r.rb
-default_executable: 
-- ap4r
+default_executable: ap4r_setup
 bindir: bin
 has_rdoc: true
 required_ruby_version: !ruby/object:Gem::Version::Requirement 
@@ -27,19 +26,33 @@ platform: ruby
 signing_key: 
 cert_chain: 
 authors: 
-- Shunichi Shinohara, Kiwamu Kato
+- Shunichi Shinohara
+- Kiwamu Kato
 files: 
-- bin/ap4r
-- bin/irm.cmd
-- bin/loop.cmd
-- bin/loop.rb
-- bin/queues.cmd
-- bin/queues.rb
-- bin/stop.cmd
-- configs/log4r.yaml
-- configs/queues.cfg
-- configs/queues_disk.cfg
-- configs/queues_mysql.cfg
+- bin
+- CHANGELOG
+- config
+- lib
+- MIT-LICENSE
+- rails_plugin
+- Rakefile
+- README
+- script
+- bin/ap4r_setup
+- config/ap4r_settings.rb
+- config/log4r.yaml
+- config/queues.cfg
+- 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/start
+- script/stop
 - lib/ap4r
 - lib/ap4r.rb
 - lib/ap4r/message_store_ext.rb
@@ -47,26 +60,35 @@ files:
 - lib/ap4r/queue_manager_ext.rb
 - lib/ap4r/queue_manager_ext_debug.rb
 - lib/ap4r/retention_history.rb
+- lib/ap4r/script
 - lib/ap4r/start_with_log4r.rb
-- lib/ap4r/utils
-- lib/ap4r/utils/irm.rb
-- lib/ap4r/utils/loc.rb
-- CHANGELOG
-- MIT-LICENSE
-- Rakefile
-- README
+- lib/ap4r/util
+- lib/ap4r/version.rb
+- lib/ap4r/script/base.rb
+- lib/ap4r/script/queue_manager_control.rb
+- lib/ap4r/script/setup.rb
+- lib/ap4r/script/workspace_generator.rb
+- lib/ap4r/util/irm.rb
+- lib/ap4r/util/loc.rb
+- lib/ap4r/util/queue_client.rb
 test_files: []
 
-rdoc_options: []
-
-extra_rdoc_files: []
-
+rdoc_options: 
+- --main
+- README
+- --title
+- Asynchronous Processing for Ruby
+- --line-numbers
+extra_rdoc_files: 
+- README
+- CHANGELOG
+- rails_plugin
 executables: 
-- ap4r
+- ap4r_setup
 extensions: []
 
-requirements: 
-- none
+requirements: []
+
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: reliable-msg

data/bin/irm.cmd

@@ -1,2 +0,0 @@
-@ECHO OFF
-irb -Ilib/ -r utils/irm

data/bin/queues.cmd

@@ -1,2 +0,0 @@
-@ECHO OFF
-ruby script\queues.rb %*

data/bin/queues.rb

@@ -1,3 +0,0 @@
-require 'ap4r'
-
-ReliableMsg::CLI.new.run

data/bin/stop.cmd

@@ -1 +0,0 @@
-./queues manager stop

data/configs/queues_disk.cfg

@@ -1,15 +0,0 @@
---- 
-store: 
-  username: orca
-  type: mysql
-  host: localhost
-  database: ap4r
-  password: ap4r
-drb: 
-  host: 
-  port: 6438
-  acl: allow 127.0.0.1 allow 10.0.0.0/8
-dispatchers:
-  -
-    queue: queue.orders.*
-    threads: 1

data/lib/ap4r/utils/irm.rb

@@ -1,109 +0,0 @@
-# interactive reliable message
-#   version 0.1.1
-#   written by shino
-
-require 'reliable-msg-hack'
-
-require 'pathname'
-require 'uri'
-
-$KCODE = 'u'
-
-$config = 'queues.cfg'
-$drb_host = 'localhost'
-$drb_port = 6438
-
-module Kernel
-  DEFAULT_QUEUE_PREFIX = 'queue.test.'
-  DEFAULT_QUEUE_SUFFIX = 'default'
-  DEFAULT_MULTI_QUEUE = DEFAULT_QUEUE_PREFIX + '*'
-
-  def irm_queue_manager config = $config
-    raise "NOT exist : #{config}" unless Pathname.new(config).exist?
-    DRb::DRbObject.new_with_uri irm_drb_uri
-  end
-
-  def irm_queue_manager_stop config = $config
-    manager = irm_queue_manager config
-    begin
-      manager.stop
-    rescue DRb::DRbConnError => error
-      error.message
-    end
-  end
-
-
-  def irm_list_queues
-    qm.store.queues.keys
-  end
-  
-  def irm_list_messages suffix = DEFAULT_QUEUE_SUFFIX,
-    prefix = DEFAULT_QUEUE_PREFIX
-    qm.store.queues[prefix.to_s + suffix.to_s]
-  end
-
-
-  def irm_make_queue suffix = DEFAULT_QUEUE_SUFFIX,
-    prefix = DEFAULT_QUEUE_PREFIX
-    ReliableMsg::Queue.new prefix.to_s + suffix.to_s, :drb_uri => irm_drb_uri
-  end
-
-  def irm_queue_get suffix = DEFAULT_QUEUE_SUFFIX, selector = nil,
-    prefix = DEFAULT_QUEUE_PREFIX, &block
-    q = irm_make_queue suffix, prefix
-    q.get selector, &block
-  end
-
-  def irm_queue_put suffix = DEFAULT_QUEUE_SUFFIX,
-    message = nil, prefix = DEFAULT_QUEUE_PREFIX,
-    headers = nil
-    unless message
-      t = Time.now
-      message = sprintf("test message %s,%s",
-                        t.strftime("%Y/%m/%d %H:%M:%S"), t.usec)
-    end
-    q = irm_make_queue suffix, prefix
-    q.put message, headers
-  end
-
-  def irm_make_multi_queue multi_queue = DEFAULT_MULTI_QUEUE
-    ReliableMsg::MultiQueue.new multi_queue.to_s
-  end
-
-  def irm_multi_queue_get selector = nil,
-    multi_queue = DEFAULT_MULTI_QUEUE, &block
-    mq = irm_make_multi_queue multi_queue, :drb_uri => irm_drb_uri
-    mq.get selector, &block
-  end
-
-  def irm_set_config arg
-    if arg.is_a? Integer
-      $config = "queues#{arg.to_s}.cfg"
-    else
-      $config = arg.to_s
-    end
-    config = ReliableMsg::Config.new($config)
-    config.load_no_create
-    $drb_port = config.drb['port']
-  end
-
-  def irm_drb_uri
-    "druby://#{$drb_host}:#{$drb_port}"
-  end
-
-  alias qm irm_queue_manager
-  alias qm_stop irm_queue_manager_stop
-
-  alias lsq irm_list_queues
-  alias lsm irm_list_messages
-
-  alias mkq irm_make_queue
-  alias qg irm_queue_get
-  alias qp irm_queue_put
-  alias mkmq irm_make_multi_queue
-  alias mqg irm_multi_queue_get
-
-  alias cfg irm_set_config
-  alias uri irm_drb_uri
-end
-