reliable-msg-agent 0.0.1

data/History.txt

@@ -0,0 +1,5 @@
+
+== 0.0.1 2011-03-18
+
+* minimum feature
+

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+

data/README.rdoc

@@ -0,0 +1,90 @@
+== Reliable-msg-agent
+
+reliable-msg-agent is consumer for reliable-msg.
+
+The pull type approach that acquires the message accumulated
+in A and processes it is taken. 
+
+
+=== System configuration
+
+    +-------------+
+    | Application |
+    +-------------+
+          |
+          | Push Message
+          +
+    +-------------+
+    | ReliableMsg |+------+
+    +-------------+       |
+          +               | <-- Agent regularly acquires
+          |               |      the message from ReliableMsg.
+          +               +
+      +-------+       +-------+
+      | Agent |  ...  + Agent +
+      +-------+       +-------+
+
+== Getting started
+
+=== Install
+
+ gem install reliable-msg-agent
+
+=== Set configuration file
+
+* {GEM_INSTALL_DIR}/resources/agent.conf
+  please arrange agent.conf in appropriate path.
+  (default: /etc/reliable-msg-agent/agent.conf)
+* {GEM_INSTALL_DIR}/resources/agent.rb
+  please arrange agent.conf in appropriate path.
+  (default: /etc/reliable-msg-agent/agent.rb)
+
+== Reliable-msg-agent commands
+
+ $ reliable-msg-agent
+ reliable-msg-agent available commands:
+         stop
+         start
+
+=== start
+
+ $ reliable-msg-agent start --help
+ Usage: reliable-msg-agent start [options]
+     -v, --verbose                    Verbose output
+     -c, --conf=CONFFILE              Config file
+     -l, --log=LOGFILE                Log file
+     -p, --pid=PIDFILE                PID file
+     -h, --help                       Show this message
+         --version                    Show version
+
+* -v, --verbose
+  verbose output.
+* -c, --conf=CONFFILE
+  path for config file. default is /etc/reliable-msg-agent/agent.conf
+* -l, --log=LOGFILE
+  path for log file. default is /var/reliable-msg-agent/agent.log
+* -p, --pid=PIDFILE
+  path for pid file. default is /var/reliable-msg-agent/agent.pid
+* -h, --help
+  show this message.
+* --version
+  show version.
+
+=== stop
+
+ $ reliable-msg-agent stop --help
+ Usage: reliable-msg-agent stop [options]
+     -v, --verbose                    Verbose output
+     -p, --pid=PIDFILE                PID file (only for the daemon mode)
+     -h, --help                       Show this message
+         --version                    Show version
+
+* -v, --verbose
+  verbose output.
+* -p, --pid=PIDFILE
+  path for pid file. default is /var/reliable-msg-agent/agent.pid
+* -h, --help
+  show this message.
+* --version
+  show version.
+

data/Rakefile

@@ -0,0 +1,46 @@
+
+require "rubygems"
+require "rake"
+require "rake/clean"
+require "rake/gempackagetask"
+require "rake/rdoctask"
+
+$LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
+require "reliable-msg/agent/version"
+
+spec = Gem::Specification.new do |s|
+  s.name = "reliable-msg-agent"
+  s.version = ReliableMsg::Agent::Version::STRING
+  s.has_rdoc = true
+  s.extra_rdoc_files = ["README.rdoc"]
+  s.summary = "This(it) is agent daemon for reliable-msg queue"
+  s.description = s.summary
+  s.executables = Dir.glob("bin/**/*").map { |f| File.basename(f) }
+  s.files = %w(History.txt MIT-LICENSE README.rdoc Rakefile) + Dir.glob("{bin,ext,lib,spec}/**/*")
+  s.require_path = "lib"
+  s.bindir = "bin"
+  s.author = "hamajyotan"
+  s.email = "hamajyotan@gmail.com"
+  s.homepage = "https://github.com/hamajyotan/reliable-msg-agent"
+  
+  s.add_dependency("reliable-msg")
+end
+
+Rake::GemPackageTask.new(spec) do |p|
+  p.gem_spec = spec
+  p.need_tar = true
+  p.need_zip = true
+end
+
+Rake::RDocTask.new do |rdoc|
+  files =["README.rdoc", "MIT-LICENSE", "lib/**/*.rb"]
+  rdoc.rdoc_files.add(files)
+  rdoc.main = "README.rdoc" # page to start on
+  rdoc.title = "reliable-msg-agent Docs"
+  rdoc.rdoc_dir = "doc/rdoc" # rdoc output folder
+  rdoc.options << "--line-numbers"
+end
+
+Dir["tasks/**/*.rake"].each { |t| load t }
+task :default => [:spec]
+

data/bin/reliable-msg-agent

@@ -0,0 +1,61 @@
+#!/usr/bin/env ruby
+
+require "optparse"
+
+require "rubygems"
+require "reliable-msg/agent"
+
+parsers = {}
+options = {}
+
+parsers["start"] = OptionParser.new { |parser|
+  parser.program_name += " start"
+
+  parser.on("-v", "--verbose", "Verbose output") {
+    options[:verbose] = true
+  }
+  parser.on("-c", "--conf=CONFFILE", "Config file") { |v|
+    options[:conf] = v
+  }
+  parser.on("-l", "--log=LOGFILE", "Log file") { |v|
+    options[:log] = v
+  }
+  parser.on("-p", "--pid=PIDFILE", "PID file") { |v|
+    options[:pid] = v
+  }
+}
+parsers["stop"]  = OptionParser.new { |parser|
+  parser.program_name += " stop"
+
+  parser.on("-v", "--verbose", "Verbose output") {
+    options[:verbose] = true
+  }
+  parser.on("-p", "--pid=PIDFILE", "PID file (only for the daemon mode)") { |v|
+    options[:pid] = v
+  }
+}
+parsers.each { |k,v| parser = v
+  parser.version = ReliableMsg::Agent::Version::STRING
+
+  parser.on_tail("-h", "--help", "Show this message") {
+    $stderr.puts parser
+    exit
+  }
+  parser.on_tail("--version", "Show version") {
+    $stdout.puts ReliableMsg::Agent::Version::STRING
+    exit
+  }
+}
+
+subcommand = ARGV.shift
+unless parsers.keys.include?(subcommand)
+  $stderr.puts "#{File.basename($0, ".*")} available commands:"
+  $stderr.puts  parsers.keys.map { |cmd| "\t#{cmd}" }.join("\n")
+  $stderr.puts
+  exit 1
+end
+parsers[subcommand].parse! ARGV
+
+require "reliable-msg/agent/scripts/script_runner"
+ReliableMsg::Agent::ScriptRunner.new.send subcommand.to_sym, options
+

data/lib/reliable-msg/agent/agent.rb

@@ -0,0 +1,16 @@
+
+require "rubygems"
+require "reliable-msg/agent"
+
+module ReliableMsg::Agent #:nodoc:
+  class Agent
+    def initialize logger
+      @logger = logger
+    end
+ 
+    def call msg, options = {}
+      raise AgentError, "#call(msg,options={}) not implemented!"
+    end   
+  end
+end
+

data/lib/reliable-msg/agent/error.rb

@@ -0,0 +1,8 @@
+
+require "rubygems"
+require "reliable-msg/agent"
+
+module ReliableMsg::Agent #:nodoc:
+  class AgentError < RuntimeError; end
+end
+

data/lib/reliable-msg/agent/scripts/script_runner.rb

@@ -0,0 +1,170 @@
+
+require "rubygems"
+require "reliable-msg/agent"
+
+require "erb"
+require "logger"
+require "yaml"
+require "fileutils"
+require "timeout"
+require "etc"
+
+module ReliableMsg::Agent #:nodoc:
+  class ScriptRunner #:nodoc:
+
+    def start options = {}
+      $stderr.puts "*** Starting ReliableMsg-Agent..."
+
+      default_options = {
+        :verbose => false,
+        :conf => "/etc/reliable-msg-agent/agent.conf",
+        :log => "/var/reliable-msg-agent/agent.log",
+        :pid => "/var/reliable-msg-agent/agent.pid",
+      }
+      opt = default_options.merge options
+      
+      conf = load_configurations opt[:conf]
+      change_privilege conf
+      pidfile_accessible_test opt[:pid]
+      logger = create_logger conf["logger"], opt[:log]
+
+      agent_definition conf["agent"]
+
+      daemonize(logger) {
+        service = Service.new logger, conf
+  
+        register_signal_handler logger, service, opt[:pid]
+  
+        service.start
+        write_pidfile opt[:pid]
+        while service.alive?; sleep 3; end
+      }
+
+    rescue Exception => e
+      $stderr.puts "--- ReliableMsg-Agent error! - #{e.message}"
+      $stderr.puts e.backtrace.join("\n\t") if opt[:verbose]
+      exit 1
+
+    ensure
+      $stderr.puts "*** done."
+    end
+
+    def stop options = {}
+      $stderr.puts "*** Stopping ReliableMsg-Agent..."
+
+      default_options = {
+        :verbose => false,
+        :pid => "/var/reliable-msg-agent/agent.pid",
+      }
+      opt = default_options.merge options
+
+      # send signal
+      pid = File.open(opt[:pid], "r") { |f| f.read }.to_i
+      Process.kill :TERM, pid
+
+      # wait
+      timeout(10.0) { Process.waitpid pid rescue nil }
+
+    rescue Exception => e
+      $stderr.puts "--- ReliableMsg-Agent error! - #{e.message}"
+      $stderr.puts e.backtrace.join("\n\t") if opt[:verbose]
+      exit 1
+
+    ensure
+      $stderr.puts "*** done."
+    end
+
+    private
+
+    def load_configurations conffile
+      YAML.load(ERB.new(IO.read(conffile)).result)
+    end
+
+    def change_privilege conf
+      user  = conf["user"]
+      uid   = begin
+                Etc.getpwnam(user.to_s).uid
+              rescue ArgumentError
+                raise "can't find user for #{user}"
+              end
+      group = conf["group"]
+      gid   = begin
+                Etc.getgrnam(group.to_s).gid
+              rescue ArgumentError
+                raise "can't find group for #{group}"
+              end
+
+      raise "Dont't run as root user." if uid == 0
+
+      Process::Sys.setegid(gid)
+      Process::Sys.seteuid(uid)
+    end
+
+    def pidfile_accessible_test pid
+      raise "PID file already exists - #{pid}" if File.exist?(pid)
+      FileUtils.touch pid; File.unlink pid
+    end
+
+    def create_logger creation_procedure, logfile
+      if creation_procedure
+        eval(creation_procedure.to_s).call(logfile)
+      else
+        Logger.new(logfile)
+      end
+    end
+
+    def daemonize logger
+      fork {
+        Process.setsid
+        fork {
+          begin
+            Dir.chdir("/")
+            $stdin.reopen  "/dev/null", "r"
+            $stdout.reopen "/dev/null", "a"
+            $stderr.reopen "/dev/null", "a"
+
+            yield
+            sleep
+
+          rescue Exception => e
+            logger.fatal { "ReliableMsg-Agent error! - #{e.message}" }
+            logger.fatal { e.backtrace.join("\n\t") }
+            exit! 1
+          end
+        }
+      }
+    end
+
+    def register_signal_handler logger, service, pidfile
+      stopping = false
+      [:TERM].each { |sig|
+        Signal.trap(sig) {
+          unless stopping
+            begin
+              stopping = true
+              service.stop
+              File.unlink pidfile if File.exist? pidfile
+              exit! 0
+
+            rescue Exception => e
+              File.unlink pidfile if File.exist? pidfile
+              logger.fatal { "ReliableMsg-Agent error! - #{e.message}" }
+              logger.fatal { e.backtrace.join("\n\t") }
+              exit! 1
+            end
+          end
+        }
+      }
+    end
+
+    def write_pidfile pidfile
+      File.open(pidfile, "w") { |f| f.puts $$ }
+    end
+
+    def agent_definition deffile
+      Agent.class_eval open(deffile, "r") { |f| f.read }
+    end
+
+  end
+end
+

data/lib/reliable-msg/agent/service.rb

@@ -0,0 +1,44 @@
+
+require "rubygems"
+require "reliable-msg/agent"
+
+require "monitor"
+
+module ReliableMsg::Agent #:nodoc:
+  class Service
+    def initialize logger, options = {}
+      @logger  = logger
+      @options = options
+
+      @workers = Workers.new @logger, @options
+      @locker = Monitor.new
+    end
+
+    def start
+      @locker.synchronize {
+        raise AgentError, "service already started." if alive?
+
+        @logger.info { "reliable-msg agent service starting..." }
+        @workers.start
+        @logger.info { "reliable-msg agent service started." }
+      }
+    end
+
+    def stop
+      @locker.synchronize {
+        raise AgentError, "service already stopped." unless alive?
+
+        @logger.info { "reliable-msg agent service stopping..." }
+        @workers.stop
+        @logger.info { "reliable-msg agent service stopped." }
+      }
+    end
+
+    def alive?
+      @locker.synchronize {
+        !! @workers.alive?
+      }
+    end
+  end
+end
+

data/lib/reliable-msg/agent/version.rb

@@ -0,0 +1,17 @@
+
+require "rubygems"
+require "reliable-msg/agent"
+
+module ReliableMsg::Agent #:nodoc:
+  module Version #:nodoc:
+    unless defined? MAJOR
+      MAJOR  = 0
+      MINOR  = 0
+      TINY   = 1
+      PRE    = nil
+
+      STRING = [MAJOR, MINOR, TINY, PRE].compact.join(".")
+    end
+  end
+end
+

data/lib/reliable-msg/agent/workers.rb

@@ -0,0 +1,90 @@
+
+require "rubygems"
+require "reliable-msg/agent"
+
+require "monitor"
+
+module ReliableMsg::Agent #:nodoc:
+  class Workers
+
+    @@default_options = {
+      :uri     => "druby://localhost:6438",
+      :every   => 1.0,
+      :target  => "queue.*",
+      :threads => 1,
+    }.freeze
+
+    def initialize logger, options = {}
+      @logger  = logger
+      @options = options
+      @locker  = Monitor.new
+      @threads = nil
+    end
+
+    def start
+      @locker.synchronize {
+        raise AgentError, "workers already started." if alive?
+
+        @logger.info { "starting workers." }
+
+        threads = (t = @options[:threads].to_i) <= 0 ? 1 : t
+        @threads = (1..threads).inject([]) { |t, i|
+          t << Thread.fork { worker_loop }
+        }
+      }
+    end
+
+    def stop
+      @locker.synchronize {
+        raise AgentError, "workers already stopped." unless alive?
+
+        @logger.info { "stopping workers." }
+
+        @threads.each { |t| t[:dying] = true }
+        @threads.each { |t| t.wakeup rescue nil }
+        @threads.each { |t| t.join }
+        @threads = nil
+      }
+    end
+
+    def alive?
+      @locker.synchronize { !! @threads }
+    end
+
+    private
+
+    def worker_loop
+      agent  = Agent.new @logger
+      uri    = @options[:uri]    || @@default_options[:uri]
+      every  = @options[:every]  || @@default_options[:every]
+      target = @options[:target] || @@default_options[:target]
+
+      until Thread.current[:dying]
+        begin
+          sleep every
+          
+          remote_qm = DRb::DRbObject.new_with_uri uri
+          queue_name = remote_qm.stale_queue target
+          next unless queue_name
+  
+          q = ReliableMsg::Queue.new queue_name, :drb_uri => uri
+          q.get { |m|
+            begin
+              tx = Thread.current[ReliableMsg::Client::THREAD_CURRENT_TX]
+              Thread.current[ReliableMsg::Client::THREAD_CURRENT_TX] = nil
+
+              @logger.info { "message received - <#{m.id}>" }
+              raise AgentError, "agent proc failed."  unless agent.call(m.dup)
+            ensure
+              Thread.current[ReliableMsg::Client::THREAD_CURRENT_TX] = tx
+            end
+          }
+        rescue Exception => e
+          @logger.warn { "error in fetch-msg/agent-proc: #{e}\n#{e.backtrace.join("\n\t")}" }
+        end
+      end
+    end
+
+  end
+end
+

data/lib/reliable-msg/agent.rb

@@ -0,0 +1,14 @@
+
+require "rubygems"
+require "reliable-msg"
+
+module ReliableMsg #:nodoc:
+  module Agent #:nodoc:
+    autoload :Version   , "reliable-msg/agent/version"
+    autoload :AgentError, "reliable-msg/agent/error"
+    autoload :Service   , "reliable-msg/agent/service"
+    autoload :Workers   , "reliable-msg/agent/workers"
+    autoload :Agent     , "reliable-msg/agent/agent"
+  end
+end
+

data/spec/service_spec.rb

@@ -0,0 +1,36 @@
+
+require File.dirname(__FILE__) + "/spec_helper.rb"
+
+require "logger"
+
+describe ReliableMsg::Agent::Service do
+  before do
+    l = Logger.new(nil)
+    @s = ReliableMsg::Agent::Service.new l
+  end
+
+  it "should be able to #start" do
+    @s.start
+  end
+
+  it "should not be alive" do
+    @s.alive?.should_not be_true
+  end
+
+  describe "When started" do
+    before do
+      @s.start
+    end
+
+    it "should be alive" do
+      @s.alive?.should be_true
+    end
+
+  end
+
+  after do
+    @s.stop rescue nil
+    @s = nil
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+begin
+  require "rspec"
+rescue LoadError
+  require "rubygems" unless ENV["NO_RUBYGEMS"]
+  gem "rspec"
+  require "rsepc"
+end
+
+$:.unshift(File.dirname(__FILE__) + "/../lib")
+require "reliable-msg/agent"
+

data/spec/workers_spec.rb

@@ -0,0 +1,36 @@
+
+require File.dirname(__FILE__) + "/spec_helper.rb"
+
+require "logger"
+
+describe ReliableMsg::Agent::Workers do
+  before do
+    l = Logger.new(nil)
+    @w = ReliableMsg::Agent::Workers.new l
+  end
+
+  it "should be able to #start" do
+    @w.start
+  end
+
+  it "should not be alive" do
+    @w.alive?.should_not be_true
+  end
+
+  describe "When started" do
+    before do
+      @w.start
+    end
+
+    it "should be alive" do
+      @w.alive?.should be_true
+    end
+
+  end
+
+  after do
+    @w.stop rescue nil
+    @w = nil
+  end
+end
+

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification 
+name: reliable-msg-agent
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- hamajyotan
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-18 00:00:00 +09:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: reliable-msg
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+description: This(it) is agent daemon for reliable-msg queue
+email: hamajyotan@gmail.com
+executables: 
+- reliable-msg-agent
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- History.txt
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- bin/reliable-msg-agent
+- lib/reliable-msg/agent/error.rb
+- lib/reliable-msg/agent/workers.rb
+- lib/reliable-msg/agent/version.rb
+- lib/reliable-msg/agent/service.rb
+- lib/reliable-msg/agent/agent.rb
+- lib/reliable-msg/agent/scripts/script_runner.rb
+- lib/reliable-msg/agent.rb
+- spec/spec_helper.rb
+- spec/service_spec.rb
+- spec/workers_spec.rb
+has_rdoc: true
+homepage: https://github.com/hamajyotan/reliable-msg-agent
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: This(it) is agent daemon for reliable-msg queue
+test_files: []
+