magent 0.4.2 → 0.5.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,7 @@
+*~
+config/gitspace.yml
+lib/couchmapper
+lib/discm
+log/*
+public/stylesheets/**/*.css
+.bundle

data/Gemfile

@@ -0,0 +1,7 @@
+source 'http://rubygems.org'
+
+gem 'mongo', '~> 1.0'
+gem 'uuidtools'
+
+gem 'em-websocket'
+

data/Gemfile.lock

@@ -0,0 +1,21 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.2.1)
+    bson (1.1)
+    em-websocket (0.1.4)
+      addressable (>= 2.1.1)
+      eventmachine (>= 0.12.9)
+    eventmachine (0.12.10)
+    mongo (1.1)
+      bson (>= 1.0.5)
+    uuidtools (2.1.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bson
+  em-websocket
+  mongo
+  uuidtools

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 David A. 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/README.rdoc

@@ -18,7 +18,7 @@ see examples/
 
 == REQUIREMENTS:
 
-* mongodb >= 1.4
+* mongodb >= 1.6
 * mongo   >= 1.0.0 (gem install mongo)
 
 == INSTALL:
@@ -26,6 +26,42 @@ see examples/
 * rake gem
 * sudo gem install pkg/*.gem
 
+== USAGE:
+
+include Magent::Async in your classes:
+
+    class MyClass
+      include Magent::Async
+
+      def self.process_task
+        puts "Processing task"
+      end
+    end
+
+enqueue with priority 1:
+
+    MyClass.async.process_task.commit!(1)
+
+start the worker:
+
+    magent start
+
+
+== RAILS SUPPORT
+
+= initializer
+
+    Magent.setup(YAML.load_file(Rails.root.join('config', 'magent.yml')),
+                 Rails.env, { :logger => Rails.logger }
+
+
+= starting the worker
+
+to run the jobs in rails type:
+
+    rake magent:start
+
+
 == LICENSE:
 
 (The MIT License)

data/Rakefile

@@ -1,27 +1,55 @@
 require 'rubygems'
-gem 'hoe', '>= 2.1.0'
-require 'hoe'
-require 'fileutils'
-require './lib/magent'
+require 'rake'
 
-Hoe.plugin :newgem
-# Hoe.plugin :website
-# Hoe.plugin :cucumberfeatures
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "magent"
+    gem.summary = %Q{Simple job queue system based on mongodb}
+    gem.description = %Q{Simple job queue system based on mongodb}
+    gem.email = "krawek@gmail.com"
+    gem.homepage = "http://github.com/dcu/magent"
+    gem.authors = ["David A. Cuadrado"]
+    gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+    gem.add_dependency "mongo"
+    gem.add_dependency "em-websocket"
+    gem.add_dependency "uuidtools"
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
 
-# 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 = ''
-  self.rubyforge_name       = self.name
-  self.extra_deps         = [['mongo','>= 0.1.0'],
-                             ['uuidtools', '>= 2.0.0']]
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
 end
 
-require 'newgem/tasks'
-Dir['tasks/**/*.rake'].each { |t| load t }
+task :test => :check_dependencies
 
-# TODO - want other tests/tasks run by default? Add them to the list
-# remove_task :default
-# task :default => [:spec, :features]
+task :default => :test
 
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "magent #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.5.0

data/bin/magent

@@ -1,23 +1,33 @@
 #!/usr/bin/env ruby
 
+if File.exist?("config/environments") && File.exist?("app/models") # rails
+  require Dir.getwd + '/config/environment'
+end
+
 $:.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 = {}
+options = {:piddir => "/tmp", :type => :async, :queue => :default}
 
 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.banner = "Usage: #{$0} [options] -Q <queue> <start|stop|restart>\n\nExample: magent -d -P /tmp -Q default restart\n\nOptions:"
 
   opts.on("-a PATH", "--agent=PATH", "Path to agent") do |o|
     options[:agent] = o
+    options[:type] = :actor
+  end
+
+  opts.on("-Q QUEUE", "--queue=QUEUE", "queue to use. default=default") do |o|
+    options[:queue] = o
   end
 
   opts.on("-t ID", "--identifier=ID", "Identifier") do |o|
@@ -51,32 +61,35 @@ rescue => e
   exit 0
 end
 
-if !options[:agent]
-  usage(optparser, "Error: --agent is required")
+if args.empty?
+  usage(optparser, "not enough arguments")
 end
 
-load options[:agent]
-
-if Magent.current_actor.nil?
-  usage(optparser, "Use Magent.register(YourActor.new) to register an actor")
+if options[:agent]
+  load options[:agent]
 end
 
 class Controller
-  def initialize(actor, opts)
+  attr_reader :options
+
+  def initialize(opts)
     @options = opts
-    @actor = actor
+
+    @queue = @options[:queue]
 
     @options[:log_path] ||= Dir.getwd
 
-    @identity = @options[:identifier] || Magent::Utils.underscore(actor.class.to_s)
+    @identity = @options[:identifier] || Magent::Utils.underscore(@options[:queue].to_s)
     @identity << "-#{Socket.gethostname.split('.')[0]}"
+
+    $stderr.puts ">> Starting magent in #{@options[:type]} model"
   end
 
   def start
     if @options[:daemonize] && @options[:piddir]
       run_as_daemon
     else
-      Magent::Processor.new(@actor).run!
+      Magent::Processor.new(self.channel).run!
     end
   end
 
@@ -104,6 +117,10 @@ class Controller
     start
   end
 
+  def channel
+    @channel ||= (@options[:type] == :async) ? Magent::AsyncChannel.new(@queue) : Magent::ActorChannel.new(@queue)
+  end
+
   private
   def run_as_daemon
     daemonize
@@ -115,7 +132,7 @@ class Controller
       end
     end
 
-    Magent::Processor.new(@actor).run!
+    Magent::Processor.new(self.channel).run!
   end
 
   def pid_file
@@ -136,4 +153,4 @@ class Controller
   end
 end
 
-Controller.new(Magent.current_actor, options).send(args.shift)
+Controller.new(options).send(args.shift)

data/examples/comm/worker.rb

@@ -25,6 +25,6 @@ end
 Magent.register(Worker.new)
 
 if $0 == __FILE__
-  Magent::Processor.new(Magent.current_actor).run!
+  Magent::Processor.new(Worker.channel).run!
 end
 

data/examples/error/error.rb

@@ -28,6 +28,6 @@ end
 Magent.register(Error.new)
 
 if $0 == __FILE__
-  Magent::Processor.new(Magent.current_actor).run!
+  Magent::Processor.new(Error.channel).run!
 end
 

data/examples/mongomapper/async.rb

@@ -0,0 +1,41 @@
+$:.unshift File.dirname(__FILE__)+"/../../lib/"
+require 'rubygems'
+require 'magent'
+require 'mongo_mapper'
+
+
+MongoMapper.database = "test"
+Magent.database = "test"
+
+class Thing
+  include MongoMapper::Document
+  include Magent::Async
+
+  key :_id, String
+  key :name
+
+  def process_something(arg)
+    puts "Processing: #{arg}"
+  end
+
+  def process_nothing
+    puts "Processing..."
+  end
+
+  def self.foo
+    puts "MAX PRIORITY"
+  end
+end
+
+
+thing = Thing.create(:_id => "foo")
+
+# 3 messages
+thing.async.process_something("testing").commit!
+thing.async.process_nothing.commit!
+Thing.async.find(thing.id).process_something("testing2").commit!
+Thing.async.foo.commit!(1)
+
+Magent::Processor.new(Magent::AsyncChannel.new(:default)).run!
+
+

data/examples/simple/bot.rb

@@ -1,4 +1,5 @@
 $:.unshift File.dirname(__FILE__)+"/../../lib/"
+require 'rubygems'
 require 'magent'
 
 # Use: magent /path/to/this/file
@@ -32,6 +33,6 @@ end
 Magent.register(Bot.new)
 
 if $0 == __FILE__
-  Magent::Processor.new(Magent.current_actor).run!
+  Magent::Processor.new(Bot.channel).run!
 end
 

data/examples/stats/stats.rb

@@ -22,6 +22,6 @@ end
 Magent.register(Stats.new)
 
 if $0 == __FILE__
-  Magent::Processor.new(Magent.current_actor).run!
+  Magent::Processor.new(Stats.channel).run!
 end
 

data/lib/magent.rb

@@ -1,62 +1,114 @@
 $:.unshift(File.dirname(__FILE__)) unless
   $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
 
+require 'rubygems'
 require 'mongo'
 require 'set'
 require 'uuidtools'
 
+require 'magent/failure'
+
 require 'magent/utils'
 require 'magent/generic_channel'
-require 'magent/channel'
+require 'magent/actor_channel'
 require 'magent/push'
 require 'magent/actor'
 require 'magent/processor'
 
+require 'magent/async'
+require 'magent/async_channel'
+
+require 'magent/railtie' if defined?(Rails)
+
+if defined?(EventMachine::WebSocket)
+  require 'magent/web_socket_server'
+end
+
 module Magent
-  VERSION = '0.4.2'
+  @@database_name = "magent"
 
-  @@db_name = 'magent'
-  @@host = 'localhost'
-  @@port = '27017'
-  @@username = nil
-  @@password = nil
+  @@config = {
+    "host" => "0.0.0.0",
+    "port" => 27017
+  }
 
-  def self.host=(host)
-    @@host = host
-    @@port = port
+  def self.connection
+    @@connection ||= Mongo::Connection.new
   end
 
-  def self.port=(port)
-    @@port = 27017
+  def self.logger
+    connection.logger
   end
 
-  def self.auth(username,password)
-    @@username = username
-    @@password = password
+  def self.connection=(new_connection)
+    @@connection = new_connection
   end
 
-  def self.db_name=(db_name)
-    @@db_name = db_name
+  def self.database=(name)
+    @@database = nil
+    @@database_name = name
   end
 
-  def self.connection
-    return @@connection if defined?(@@connection)
-    @@connection = Mongo::Connection.new(@@host, @@port)
-    @@connection.add_auth(@@db_name, @@username, @@password) if @@username && @@password
+  def self.database
+    @@database ||= Magent.connection.db(@@database_name)
+  end
 
-    @@connection
+  def self.config
+    @@config
   end
 
-  def self.connection=(new_connection)
-    @@connection = new_connection
+  def self.config=(config)
+    @@config = config
   end
 
-  def self.database=(name)
-    @@database = Magent.connection.db(name)
+  def self.connect(environment, options={})
+    raise 'Set config before connecting. Magent.config = {...}' if config.blank?
+
+    env = config_for_environment(environment)
+    Magent.connection = Mongo::Connection.new(env['host'], env['port'], options)
+    Magent.database = env['database']
+    Magent.database.authenticate(env['username'], env['password']) if env['username'] && env['password']
   end
 
-  def self.database
-    @@database ||= Magent.connection.db(@@db_name)
+  def self.setup(config, environment = nil, options = {})
+    self.config = config
+    connect(environment, options)
+  end
+
+  # deprecated
+  def self.host=(host)
+    @@config['host'] = host
+  end
+
+  def self.port=(port)
+    @@config['port'] = port
+  end
+
+  def self.db_name=(db_name)
+    @@database_name = db_name
+  end
+
+  def self.auth(username, passwd)
+    @@config['username'] = username
+    @@config['password'] = passwd
+  end
+
+  private
+  def self.config_for_environment(environment)
+    env = environment ? config[environment] : config
+
+    return env if env['uri'].blank?
+
+    uri = URI.parse(env['uri'])
+    raise InvalidScheme.new('must be mongodb') unless uri.scheme == 'mongodb'
+
+    {
+      'host'     => uri.host,
+      'port'     => uri.port,
+      'database' => uri.path.gsub(/^\//, ''),
+      'username' => uri.user,
+      'password' => uri.password,
+    }
   end
 end