magent 0.0.1

data/History.txt

@@ -0,0 +1,4 @@
+=== 0.0.1 2009-10-02
+
+* 1 major enhancement:
+  * Initial release

data/Manifest.txt

@@ -0,0 +1,17 @@
+History.txt
+Manifest.txt
+PostInstall.txt
+README.rdoc
+Rakefile
+bin/magent
+examples/simple/bot.rb
+lib/magent.rb
+lib/magent/actor.rb
+lib/magent/channel.rb
+lib/magent/processor.rb
+lib/magent/push.rb
+lib/magent/utils.rb
+magent.gemspec
+script/console
+test/test_helper.rb
+test/test_magent.rb

data/README.rdoc

@@ -0,0 +1,48 @@
+= magent
+
+* http://github.com/dcu/magent
+
+== DESCRIPTION:
+
+Simple job queue system based on mongodb
+
+== FEATURES/PROBLEMS:
+
+== SYNOPSIS:
+
+see examples/
+
+== REQUIREMENTS:
+
+* mongodb-ruby-driver
+
+== INSTALL:
+
+* rake gem
+* sudo gem install pkg/*.gem
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009 David Cuadrado
+
+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/Rakefile

@@ -0,0 +1,27 @@
+require 'rubygems'
+gem 'hoe', '>= 2.1.0'
+require 'hoe'
+require 'fileutils'
+require './lib/magent'
+
+Hoe.plugin :newgem
+# Hoe.plugin :website
+# Hoe.plugin :cucumberfeatures
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.spec 'magent' do
+  self.developer 'David Cuadrado', 'krawek@gmail.com'
+  self.post_install_message = 'PostInstall.txt'
+  self.rubyforge_name       = self.name
+  self.extra_deps         = [['mongodb-mongo','>= 0.14']]
+
+end
+
+require 'newgem/tasks'
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+# TODO - want other tests/tasks run by default? Add them to the list
+# remove_task :default
+# task :default => [:spec, :features]
+

data/bin/magent

@@ -0,0 +1,139 @@
+#!/usr/bin/env ruby
+
+$:.unshift File.dirname(__FILE__)+"/../lib/"
+require 'magent'
+require 'optparse'
+require 'fileutils'
+
+def usage(option_parser, error = nil)
+  $stderr.puts error if error
+  $stderr.puts option_parser
+  exit 1
+end
+
+options = {}
+
+optparser = OptionParser.new do |opts|
+  opts.banner = "Usage: #{$0} [options] <start|stop|restart>\n\nExample: magent -t carl1 -a /path/to/agent.rb -d -P /tmp restart\n\nOptions:"
+
+  opts.on("-a PATH", "--agent=PATH", "Path to agent") do |o|
+    options[:agent] = o
+  end
+
+  opts.on("-t ID", "--identifier=ID", "Identifier") do |o|
+    options[:identifier] = o
+  end
+
+  opts.on("-d", "--daemonize", "Run agent as a daemon") do |o|
+    options[:daemonize] = true
+  end
+
+  opts.on("-l", "--log-path=PATH", "Log path") do |o|
+    options[:log_path] = o
+  end
+
+  opts.on("-P", "--piddir=PATH", "PID dir to use (if daemonized)", "Default: #{options[:piddir]}") do |o|
+    options[:piddir] = o
+  end
+
+  opts.on_tail("-h", "--help", "Show this help message.") do
+    puts opts
+    exit
+  end
+end
+
+args = []
+begin
+  args = optparser.parse!
+rescue => e
+  $stderr.puts e
+  $stderr.puts optparser
+  exit 0
+end
+
+if !options[:agent]
+  usage(optparser, "Error: --agent is required")
+end
+
+load options[:agent]
+
+if Magent.current_actor.nil?
+  usage(optparser, "Use Magent.register(YourActor.new) to register an actor")
+end
+
+class Controller
+  def initialize(actor, opts)
+    @options = opts
+    @actor = actor
+
+    @options[:log_path] ||= Dir.getwd
+
+    @identity = @options[:identifier] || Magent::Utils.underscore(actor.class.to_s)
+    @identity << "-#{Socket.gethostname.split('.')[0]}"
+  end
+
+  def start
+    if @options[:daemonize] && @options[:piddir]
+      run_as_daemon
+    else
+      Magent::Processor.new(@actor).run!
+    end
+  end
+
+  def stop
+    begin
+      pid = File.read(pid_file).to_i
+      Process.kill("TERM", pid)
+      Process.kill(0, pid)
+      Process.wait
+    rescue Errno::ECHILD, Errno::ESRCH => e
+      $stdout.puts "Process #{pid} has stopped"
+    rescue Errno::ENOENT => e
+      $stdout.puts "Warning: #{e}"
+    ensure
+      File.unlink(pid_file) if File.exist?(pid_file)
+    end
+  end
+
+  def restart
+    begin
+      stop
+    rescue => e
+      $stderr.puts "Warning: #{e}"
+    end
+    start
+  end
+
+  private
+  def run_as_daemon
+    daemonize
+
+    FileUtils.mkpath(@options[:piddir])
+    if @options[:piddir]
+      File.open(pid_file, "w") do |f|
+        f.write(Process.pid)
+      end
+    end
+
+    Magent::Processor.new(@actor).run!
+  end
+
+  def pid_file
+    @pid_file ||= File.join(@options[:piddir], "magent.#{@identity}.pid")
+  end
+
+  def daemonize
+    exit if fork
+    Process.setsid
+    exit if fork
+
+    STDIN.reopen "/dev/null"
+    STDOUT.reopen "#{@options[:log_path]}/magent.#{@identity}.out", "a"
+    STDERR.reopen "#{@options[:log_path]}/magent.#{@identity}.err", "a"
+
+    STDERR.sync = true
+    STDOUT.sync = true
+  end
+end
+
+Controller.new(Magent.current_actor, options).send(args.shift)

data/examples/simple/bot.rb

@@ -0,0 +1,32 @@
+$:.unshift File.dirname(__FILE__)+"/../../lib/"
+require 'magent'
+
+# Use: magent /path/to/this/file
+
+Magent.push("/bot", :echo, "hello, world")
+Magent.push("/bot", :do_task, "File", :exist?, "/etc/passwd")
+Magent.push("/bot", :echo, "Press ctrl+c to close")
+
+class Bot
+  include Magent::Actor
+
+  expose :echo, :do_task
+
+  def echo(payload)
+    $stderr.puts payload.inspect
+  end
+
+  def do_task(payload)
+    klass, *args = payload
+
+    result = Object.module_eval(klass).send(*args)
+    $stderr.puts "RESULT: #{result}"
+  end
+
+end
+
+Magent.register(Bot.new)
+
+if $0 == __FILE__
+  Magent::Processor.new(Magent.current_actor).run!
+end

data/lib/magent.rb

@@ -0,0 +1,32 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'mongo'
+require 'set'
+require 'magent/utils'
+require 'magent/channel'
+require 'magent/push'
+require 'magent/actor'
+require 'magent/processor'
+
+module Magent
+  VERSION = '0.0.1'
+
+  def self.connection
+    @@connection ||= Mongo::Connection.new
+  end
+
+  def self.connection=(new_connection)
+    @@connection = new_connection
+  end
+
+  def self.database=(name)
+    @@database = Magent.connection.db(name)
+  end
+
+  def self.database
+    @@database
+  end
+end
+
+Magent.database = 'magent'

data/lib/magent/actor.rb

@@ -0,0 +1,41 @@
+module Magent
+  module Actor
+    def self.included(klass)
+      klass.class_eval do
+        extend Actor::ClassMethods
+      end
+    end
+
+    module ClassMethods
+      def expose(*methods)
+        methods.each do |m|
+          actions << m.to_s
+        end
+      end
+
+      def actions
+        @actions ||= Set.new
+      end
+
+      def can_handle?(action)
+        return false if @actions.nil?
+        @actions.include?(action.to_s)
+      end
+
+      def channel
+        @channel ||= begin
+          channel_name = "/"+Magent::Utils.underscore(self.name)
+          Channel.new(channel_name)
+        end
+      end
+    end
+  end # Actor
+
+  def self.register(actor)
+    @current_actor = actor
+  end
+
+  def self.current_actor
+    @current_actor
+  end
+end

data/lib/magent/channel.rb

@@ -0,0 +1,45 @@
+module Magent
+  class Channel
+    def initialize(name)
+      @name = name
+
+      if !collection.find_one({:_id => @name}, {:fields => [:_id]})
+        collection.save({:_id => @name, :messages => []})
+      end
+    end
+
+    def enqueue(message, args)
+      collection.update({:_id => @name}, {:$push => {:messages => [message, args]}}, :repsert => true)
+    end
+
+    def dequeue
+      Magent.database.eval(%@
+        function dequeue() {
+          return db.eval(function() {
+            var q = db.channels.findOne({_id: '#{@name}'});
+            var m = q.messages.shift();
+            db.channels.save(q); //slow
+            return m;
+          });
+        }
+      @)
+    end
+
+    def collection
+      self.class.collection
+    end
+
+    def self.collection
+      @collection ||= Magent.database.collection("channels")
+    end
+
+    def self.all(&block)
+      cursor = collection.find({}, :fields => [:_id])
+      if block_given?
+        cursor.map {|c| name = c["_id"]; yield name; name }
+      else
+        cursor.map {|c| c["_id"] }
+      end
+    end
+  end # Channel
+end

data/lib/magent/processor.rb

@@ -0,0 +1,32 @@
+module Magent
+  class Processor
+    attr_reader :actor
+
+    def initialize(actor)
+      @actor = actor
+
+      @actor.class.actions.each do |action|
+        if !@actor.respond_to?(action)
+          raise ArgumentError, "action '#{action}' is not defined"
+        end
+      end
+    end
+
+    def run!
+      delay = 0
+      loop do
+        method, payload = @actor.class.channel.dequeue
+
+        if method.nil?
+          delay += 0.1 if delay <= 5
+        else
+          delay = 0
+          $stderr.puts "#{@actor.class}##{method}(#{payload.inspect})"
+          @actor.send(method, payload) # TODO: what if method is not defined?
+        end
+
+        sleep delay
+      end
+    end
+  end #Processor
+end

data/lib/magent/push.rb

@@ -0,0 +1,13 @@
+module Magent
+  def self.push(channel_name, method, *args)
+    self.channel(channel_name.to_s).enqueue(method, args)
+  end
+
+  def self.channel(name)
+    self.channels[name] ||= Channel.new(name)
+  end
+
+  def self.channels
+    @channels ||= {}
+  end
+end

data/lib/magent/utils.rb

@@ -0,0 +1,13 @@
+module Magent
+  module Utils
+    def self.underscore(word)
+      word.to_s.gsub(/::/, '/').
+                gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+                gsub(/([a-z\d])([A-Z])/,'\1_\2').tr("-", "_").downcase
+    end
+
+    def self.camelize(word)
+      word.to_s.gsub(/\/(.?)/) { "::#{$1.upcase}" }.gsub(/(?:^|_)(.)/) { $1.upcase }
+    end
+  end
+end

data/magent.gemspec

@@ -0,0 +1,40 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{magent}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["David Cuadrado"]
+  s.date = %q{2009-10-03}
+  s.default_executable = %q{magent}
+  s.description = %q{Simple job queue system based on mongodb}
+  s.email = ["krawek@gmail.com"]
+  s.executables = ["magent"]
+  s.extra_rdoc_files = ["History.txt", "Manifest.txt", "PostInstall.txt"]
+  s.files = ["History.txt", "Manifest.txt", "PostInstall.txt", "README.rdoc", "Rakefile", "bin/magent", "examples/simple/bot.rb", "lib/magent.rb", "lib/magent/actor.rb", "lib/magent/channel.rb", "lib/magent/processor.rb", "lib/magent/push.rb", "lib/magent/utils.rb", "magent.gemspec", "script/console", "test/test_helper.rb", "test/test_magent.rb"]
+  s.homepage = %q{http://github.com/dcu/magent}
+  s.post_install_message = %q{PostInstall.txt}
+  s.rdoc_options = ["--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{magent}
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Simple job queue system based on mongodb}
+  s.test_files = ["test/test_helper.rb", "test/test_magent.rb"]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<mongodb-mongo>, [">= 0.14"])
+      s.add_development_dependency(%q<hoe>, [">= 2.3.3"])
+    else
+      s.add_dependency(%q<mongodb-mongo>, [">= 0.14"])
+      s.add_dependency(%q<hoe>, [">= 2.3.3"])
+    end
+  else
+    s.add_dependency(%q<mongodb-mongo>, [">= 0.14"])
+    s.add_dependency(%q<hoe>, [">= 2.3.3"])
+  end
+end

data/script/console

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+#libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/init.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/magent.rb'}"
+puts "Loading magent gem"
+exec "#{irb} #{libs} --simple-prompt"

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'stringio'
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/magent'

data/test/test_magent.rb

@@ -0,0 +1,11 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TestMagent < Test::Unit::TestCase
+
+  def setup
+  end
+  
+  def test_truth
+    assert true
+  end
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification 
+name: magent
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- David Cuadrado
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-04 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: mongodb-mongo
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0.14"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.3.3
+    version: 
+description: Simple job queue system based on mongodb
+email: 
+- krawek@gmail.com
+executables: 
+- magent
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- PostInstall.txt
+files: 
+- History.txt
+- Manifest.txt
+- PostInstall.txt
+- README.rdoc
+- Rakefile
+- bin/magent
+- examples/simple/bot.rb
+- lib/magent.rb
+- lib/magent/actor.rb
+- lib/magent/channel.rb
+- lib/magent/processor.rb
+- lib/magent/push.rb
+- lib/magent/utils.rb
+- magent.gemspec
+- script/console
+- test/test_helper.rb
+- test/test_magent.rb
+has_rdoc: true
+homepage: http://github.com/dcu/magent
+licenses: []
+
+post_install_message: PostInstall.txt
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: magent
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Simple job queue system based on mongodb
+test_files: 
+- test/test_helper.rb
+- test/test_magent.rb