easy_q 0.6.0

data/Manifest.txt

@@ -0,0 +1,14 @@
+Rakefile
+README.txt
+CHANGELOG.txt
+Manifest.txt
+setup.rb
+db/001_create_messages.rb
+bin/easy_q
+lib/easy_q/version.rb
+lib/easy_q/commands.rb
+lib/easy_q/easy_q_service.rb
+lib/easy_q/models/message.rb
+lib/easy_q.rb
+test/test_helper.rb
+test/easy_q_test.rb

data/README.txt

@@ -0,0 +1,84 @@
+== EasyQ - A nice little message queue
+
+
+EasyQ is my attempt to make a simple and uncomplicated message queue.
+It requires an ActiveRecord compatible database. It isn't very fast, 
+and it doesn't support transactions and it only string messages. 
+It's not perfect but it works for me. I didn't need those things
+for my purposes, and this was built for my purposes, but you're 
+welcome to use it any. Are you sold?
+
+Oh ya...I made this on Windows and haven't tried it on *nix.
+
+One more thing...I'm new to ruby, and I don't know anything about
+RDoc. Deal.
+
+Thanks to Assaf (reliable-msg) for the idea.
+
+== Installation
+
+gem install easy-q
+
+== Setup
+
+create a database on whatever db server your working with.
+
+create a YAML config file. Call it whatever you want, and place it anywhere one the install machine.
+
+sample config:
+
+---
+:database:
+  :adapter: mysql
+  :username: root
+  :host: localhost
+  :port: 3306
+  :password: password
+  :database: easy_q
+:service:
+  :address: 0.0.0.0
+  :port: 2222
+  :acl:
+  - deny
+  - all
+  - allow
+  - localhost
+  - allow
+  - 127.0.0.1
+  
+
+== Usage
+
+* Command Line Usage:
+# installs the database schema
+% easy_q install -c config.yaml
+
+# starts a server
+% easy_q start -c config.yaml
+
+# stops a server
+% easy_q stop -c config.yaml
+
+# shows a list of queues and current message count for a server
+% easy_q stats -c config.yaml
+
+# peek at a few messages from the top or bottom of a queue on the server
+% easy_q peek queue_name 10 top -c config.yaml
+% easy_q peek queue_name 10 bottom -c config.yaml
+
+* Pushing and Popping messages:
+
+require 'drb'
+
+o = DRbObject.new(nil,"druby://localhost:2222")
+
+# push some messages into the queue
+# :queue => 'name_of_queue' (required)
+# :ttl => 1000 (seconds to live, not required)
+# :body => 'hello!!' (the message body, bust be a String class)
+
+100.times {o.push({:queue => "test", :body => Time.now.to_s})}
+	
+# get messages, returns nil or a hash
+m = o.pop('text')
+puts m[:body] if !m.nil?

data/Rakefile

@@ -0,0 +1,56 @@
+require 'rubygems'
+require 'rake'
+require 'rake/clean'
+require 'rake/testtask'
+require 'rake/packagetask'
+require 'rake/gempackagetask'
+require 'rake/rdoctask'
+require 'rake/contrib/rubyforgepublisher'
+require 'fileutils'
+require 'hoe'
+include FileUtils
+require File.join(File.dirname(__FILE__), 'lib', 'easy_q', 'version')
+Dir["#{File.dirname(__FILE__)}/lib/tasks/*.rake"].each { |ext| load ext }
+AUTHOR = "Brandon"  # can also be an array of Authors
+EMAIL = "brandon@loudcity.net"
+DESCRIPTION = "a simple little message queue"
+GEM_NAME = "easy_q" # what ppl will type to install your gem
+RUBYFORGE_PROJECT = "easy-q" # The unix name for your project
+HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
+
+
+NAME = "easy_q"
+REV = nil # UNCOMMENT IF REQUIRED: File.read(".svn/entries")[/committed-rev="(d+)"/, 1] rescue nil
+VERS = ENV['VERSION'] || (EasyQ::VERSION::STRING + (REV ? ".#{REV}" : ""))
+                          CLEAN.include ['**/.*.sw?', '*.gem', '.config']
+RDOC_OPTS = ['--quiet', '--title', "easy_q documentation",
+    "--opname", "index.html",
+    "--line-numbers", 
+    "--main", "README",
+    "--inline-source"]
+
+class Hoe
+  def extra_deps 
+    @extra_deps.reject { |x| Array(x).first == 'hoe' } 
+  end 
+end
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+hoe = Hoe.new(GEM_NAME, VERS) do |p|
+  p.author = AUTHOR 
+  p.description = DESCRIPTION
+  p.email = EMAIL
+  p.summary = DESCRIPTION
+  p.url = HOMEPATH
+  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
+  p.test_globs = ["test/**/*_test.rb"]
+  p.clean_globs = CLEAN  #An array of file patterns to delete on clean.
+  
+  # == Optional
+  #p.changes        - A description of the release's latest changes.
+  #p.extra_deps = ["uuid","activerecord"]
+  #p.spec_extras    - A hash of extra values to set in the gemspec.
+  p.need_tar = false
+  p.need_zip = false
+end

data/bin/easy_q

@@ -0,0 +1,8 @@
+begin
+  require 'easy_q'
+rescue LoadError
+  require 'rubygems'
+  require 'easy_q'
+end
+EasyQ::Commands.new.run
+

data/db/001_create_messages.rb

@@ -0,0 +1,18 @@
+class CreateMessages < ActiveRecord::Migration
+  def self.up
+    create_table :messages, :id => false do |t|
+      t.column :id, :string, :limit => 36, :null => false
+      t.column :queue, :string, :limit => 25, :null => false
+      t.column :ttl, :integer
+      t.column :body, :text
+      t.column :created_at, :datetime
+    end
+    
+    execute "ALTER TABLE messages ADD PRIMARY KEY (id)"
+    add_index :messages, :queue
+  end
+
+  def self.down
+    drop_table :messages
+  end
+end

data/lib/easy_q/commands.rb

@@ -0,0 +1,144 @@
+require 'rubygems'
+require 'yaml'
+require 'drb'
+require 'optparse'
+require 'rdoc/usage'
+require 'active_record'
+
+module EasyQ
+  class Commands
+    
+    USAGE = <<-EOF
+usage:  easy_q command [args] [options]
+
+To see list of available commands and options
+  easy_q help
+EOF
+
+    HELP = <<-EOF
+usage:  queues command [args] [options]
+
+Reliable messaging queue manager, version #{VERSION}
+
+Available commands:
+
+  help
+    Display this help message.
+
+  start
+    Start the easy_q as a standalone server
+
+  stop
+    Stop the easy_q  server.
+
+  empty <queue>
+    Empty (delete all messages from) the named queue.
+
+  install -c config.yml
+    this  creates the queue db schema
+
+Available options:
+
+  -v --version
+    Show version number.
+
+  -c --config <path>
+    Points to the queue manager configuration file.
+    
+  end
+end
+EOF
+
+    class InvalidUsage  < Exception #:nodoc:
+    end
+
+    def initialize
+    end
+    
+    def run
+      #begin
+        config_file = nil
+        opts = OptionParser.new
+        opts.on("-c FILE", "--config FILE", String) { |value| config_file = value }
+        opts.on("-v", "--version") do
+          puts "Reliable messaging queue manager, version #{VERSION}"
+          exit
+        end
+        
+        opts.on("-h", "--help") do
+          puts HELP
+          exit
+        end
+
+        args = opts.parse(ARGV)
+
+        raise InvalidUsage if args.length < 1
+        
+        if config_file.nil?
+          puts "Specify a config file. -c settings.yml"
+          exit
+        end
+
+        @settings = YAML::load_file(config_file)
+
+        case args[0]
+          when 'help'
+            puts HELP
+          when 'install'
+            puts "installing..."
+            do_install
+          when 'start'
+            service = Service.new(@settings)
+            service.start
+            begin
+              while true
+                exit if service.shut_down
+                sleep 3
+              end
+            rescue Interrupt
+              puts exit
+            end
+          when 'stop'
+            service = DRbObject.new(nil, "druby://localhost:#{@settings[:service][:port]}")
+            service.stop
+          when 'stats'
+            service = DRbObject.new(nil, "druby://localhost:#{@settings[:service][:port]}")
+            service.stats.each do |q,c|
+              puts "#{q}: #{c}"
+            end
+          when 'peek'
+            queue = args[1]
+            number = args[2].to_i unless args[2].nil?
+            direction = args[3] unless args[3].nil?
+            service = DRbObject.new(nil, "druby://localhost:#{@settings[:service][:port]}")
+            service.peek(queue,number,direction).each do |m|
+              puts "####"
+              puts "id: #{m[:id]}"
+              puts "queue: #{m[:queue]}"
+              puts "ttl: #{m[:ttl]}"
+              puts "created_at #{m[:created_at]}"
+              puts "body: #{m[:body]}"
+            end
+          when 'empty'
+            queue = args[1]
+            service = DRbObject.new(nil, "druby://localhost:#{@settings[:service][:port]}")
+            service.empty(queue)
+        end
+      #rescue Exception => ex
+      #  puts ex
+      #end
+    end
+  
+    
+    def do_install
+      @logger = Logger.new $stderr
+      ActiveRecord::Base.logger = @logger
+      ActiveRecord::Base.colorize_logging = false
+
+      ActiveRecord::Base.establish_connection(@settings)
+
+      ActiveRecord::Migrator.migrate("#{File.dirname(__FILE__)}/../../db/", nil)
+    end
+      
+  end
+end

data/lib/easy_q/easy_q_service.rb

@@ -0,0 +1,96 @@
+require 'drb'
+require 'drb/acl'
+require 'thread'
+require 'yaml'
+require 'rubygems'
+require 'uuid'
+
+module EasyQ
+    class Service
+        attr_accessor :shut_down
+        
+        def initialize(options={})
+            @shut_down = false            
+            @settings = options
+            @mutex = Mutex.new
+            @logger = Logger.new $stderr
+            @cache = []
+            ActiveRecord::Base.logger = @logger
+            ActiveRecord::Base.colorize_logging = false
+            ActiveRecord::Base.establish_connection(options[:database])
+
+        end
+        
+        def start
+            @mutex.synchronize do
+                #to do - add code to check if service is already running
+                uri = "druby://#{@settings[:service][:address]}:#{@settings[:service][:port]}"
+                DRb.install_acl(ACL.new(@settings[:service][:acl],ACL::DENY_ALLOW))
+                @drb_service = DRb.start_service(uri, self)
+                puts "service started and listening at #{uri}"
+            end
+        end
+        
+        def stop
+          @mutex.synchronize do
+            @shut_down = true
+          end
+        end
+        
+        def stats
+          return Message.count(:group=>:queue)
+        end
+        
+        def peek(queue_name, number = 10, direction = 'top')
+            return_value = []
+            case direction
+              when 'top'
+                results =  Message.find(:all, :limit => number, :conditions => ["queue = ?",queue_name])
+              when 'bottom'
+                results = Message.find(:all, :limit => number, :conditions => ["queue = ?",queue_name], :order => :created_at)
+            end
+            results.each do |r|
+              return_value << r.to_hash
+            end
+            return return_value
+        end
+        
+        def empty(queue_name)
+          Message.delete_all "queue = '#{queue_name}'"
+          return nil
+        end
+        
+        def push(options={})
+          raise Exception, "missing options[:queue]" if  !options.key?(:queue)
+          raise Exception, "missing options[:body]" if  !options.key?(:body)
+          
+          if options.key?(:queue)
+            raise Exception, "options[:queue] cannot be empty" if options[:queue].empty?
+          end
+
+          if options.key?(:body)
+            raise Exception, "options[:body] cannot be empty" if options[:body].empty?
+            raise Exception, "options[:body] can only be a String" if options[:body].class.to_s != "String"
+          end
+          
+          Message.create(options)
+          return nil
+        end
+        
+        def pop(queue_name)
+            @mutex.synchronize do
+              message = Message.find(:first,
+                  :conditions => ["(queue = ? and (created_at + ttl) > ?) or (queue = ? and ttl is null)", 
+                                          queue_name, Time.now, queue_name]
+              )
+              
+              if  !message.nil?
+                message.destroy 
+                return message.to_hash
+              else
+                return nil
+              end
+            end
+        end
+    end
+end

data/lib/easy_q/models/message.rb

@@ -0,0 +1,12 @@
+module EasyQ
+    class Message < ActiveRecord::Base
+        def before_save
+           self.id = UUID.new
+        end
+        
+        def to_hash
+          return message = {:id => self.id, :queue => self.queue, :created_at => self.created_at, :body => self.body}
+        end
+    end
+    
+end

data/lib/easy_q/version.rb

@@ -0,0 +1,9 @@
+module EasyQ #:nodoc:
+  module VERSION #:nodoc:
+    MAJOR = 0
+    MINOR = 6
+    TINY  = 0
+
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+end

data/lib/easy_q.rb

@@ -0,0 +1 @@
+Dir[File.join(File.dirname(__FILE__), 'easy_q/**/*.rb')].sort.each { |lib| require lib }