amqp-utils 0.0.1

data/History.txt

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

data/License.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Doug Barth
+
+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/Manifest.txt

@@ -0,0 +1,25 @@
+History.txt
+License.txt
+Manifest.txt
+README.txt
+Rakefile
+bin/amqp-dequeue
+bin/amqp-enqueue
+bin/amqp-peek
+bin/amqp-pop
+bin/amqp-deleteq
+bin/amqp-statq
+config/hoe.rb
+config/requirements.rb
+lib/amqp_utils.rb
+lib/amqp_utils/command.rb
+lib/amqp_utils/version.rb
+script/console
+script/destroy
+script/generate
+setup.rb
+tasks/deployment.rake
+tasks/environment.rake
+tasks/website.rake
+test/test_amqp_utils.rb
+test/test_helper.rb

data/README.txt

@@ -0,0 +1,48 @@
+= amqp-utils
+
+== DESCRIPTION:
+
+CLI utility programs for interacting with an AMQP queue. Using these utilities,
+one can interact with an AMQP queue from the command line or via a shell
+script.
+
+These utilities have been tested against RabbitMQ, but they should work with
+other AMQP compliant queues. They depend on the amqp gem available at 
+<http://github.com/tmm1/amqp>.
+
+== FEATURES/PROBLEMS:
+
+== SYNOPSIS:
+
+== REQUIREMENTS:
+
+* amqp 0.6.0 or greater
+
+== INSTALL:
+
+* sudo gem install amqp-utils
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009 Doug Barth
+
+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,4 @@
+require 'config/requirements'
+require 'config/hoe' # setup Hoe + all gem configuration
+
+Dir['tasks/**/*.rake'].each { |rake| load rake }

data/bin/amqp-deleteq

@@ -0,0 +1,31 @@
+#!/usr/bin/ruby
+
+require File.dirname(__FILE__) + '/../lib/amqp_utils/command'
+
+class QueueDeleteCommand < AmqpUtils::Command
+  def prepare_options(options)
+    options.banner %Q{
+    |Deletes the supplied queues.
+    |
+    |  #{command_name} <queue>[, <another queue>, ...]
+    }.margin
+  end
+
+  def execute
+    @queues = ARGV
+    def @queues.delete_or_stop
+      queue = pop
+      if queue
+        puts "Deleteing #{queue}..."
+        MQ.new.queue(queue).delete
+        EM.next_tick { delete_or_stop }
+      else
+        AMQP.stop { EM.stop }
+      end
+    end
+
+    EM.next_tick { @queues.delete_or_stop }
+  end
+end
+
+QueueDeleteCommand.run

data/bin/amqp-dequeue

@@ -0,0 +1,30 @@
+#!/usr/bin/ruby
+
+require File.dirname(__FILE__) + '/../lib/amqp_utils/command'
+
+class DequeueCommand < AmqpUtils::Command
+  def prepare_options(options)
+    options.banner %Q{
+    |Removes messages from the supplied queues and displays them on STDOUT.
+    |
+    |  #{command_name} <queue>[, <another queue>, ...]
+    }.margin
+  end
+
+  def execute
+    @queues = ARGV
+    @queues.each do |queue|
+      puts "Dequeueing from #{queue}..."
+      mq = MQ.new
+
+      process_message = lambda do |header, message|
+        puts "(#{queue})"
+        puts "  Header: #{header.properties.inspect}"
+        puts "  Message: #{message.inspect}"
+      end
+      mq.queue(queue).subscribe &process_message
+    end
+  end
+end
+
+DequeueCommand.run

data/bin/amqp-enqueue

@@ -0,0 +1,39 @@
+#!/usr/bin/ruby
+
+require File.dirname(__FILE__) + '/../lib/amqp_utils/command'
+
+class EnqueueCommand < AmqpUtils::Command
+  def prepare_options(options)
+    options.banner %Q{
+    |Publishes a message to a particular queue.
+    |
+    |  #{command_name} <queue> <message>
+    |
+    |Enqueue options:
+    }.margin
+    options.opt :persistent, 'Mark messages as persistent.'
+    options.opt :count, 'Number of times the message should be published.', :type => :int, :default => 1
+  end
+
+  def execute
+    @queue = ARGV[0]
+    @message = ARGV[1]
+
+    publisher = EM.spawn do |queue, message, messages, options|
+      if messages > 0
+        @mq ||= MQ.new
+        @mq.queue(queue, :durable => true, :auto_delete => false).
+          publish(message, :persistent => options.persistent)
+
+        print '.'; STDOUT.flush
+        publisher.notify(queue, message, messages - 1, options)
+      else
+        EM.next_tick { AMQP.stop { EM.stop } }
+      end
+    end
+
+    publisher.notify(@queue, @message, options.count, options)
+  end
+end
+
+EnqueueCommand.run

data/bin/amqp-peek

@@ -0,0 +1,40 @@
+#!/usr/bin/ruby
+
+require File.dirname(__FILE__) + '/../lib/amqp_utils/command'
+
+class PeekCommand < AmqpUtils::Command
+  def prepare_options(options)
+    options.banner %Q{
+    |Displays the head of the queue without removing the message from the queue.
+    |
+    |  #{command_name} <queue>
+    |
+    |  NOTE: This operation does have side effects on the server. The message is
+    |        placed at the end of the queue after returning from this method. The
+    |        message is also marked as being redelivered.
+    }.margin
+  end
+
+  def execute
+    @queue = args[0]
+
+    mq = MQ.new
+
+    mq.queue(@queue).pop(:ack => true) do |header, message|
+      if message
+        puts "(#{@queue})"
+        puts "  Header: "
+        header.properties.each do |key, value|
+          puts "    #{key.inspect} => #{value.inspect}"
+        end
+        puts "  Message: #{message.inspect}"
+      else
+        puts "(#{@queue}) empty"
+      end
+
+      AMQP.stop { EM.stop }
+    end
+  end
+end
+
+PeekCommand.run

data/bin/amqp-pop

@@ -0,0 +1,35 @@
+#!/usr/bin/ruby
+
+require File.dirname(__FILE__) + '/../lib/amqp_utils/command'
+
+class PopCommand < AmqpUtils::Command
+  def prepare_options(options)
+    options.banner %Q{
+    |Pops a single message from the queue.
+    |
+    |   #{command_name} <queue>
+    }.margin
+  end
+
+  def execute
+    @queue = args[0]
+
+    mq = MQ.new
+    mq.queue(@queue).pop do |header, message|
+      if message
+        puts "(#{@queue})"
+        puts "  Header: "
+        header.properties.each do |key, value|
+          puts "    #{key.inspect} => #{value.inspect}"
+        end
+        puts "  Message: #{message.inspect}"
+      else
+        puts "(#{@queue}) empty"
+      end
+
+      AMQP.stop { EM.stop }
+    end
+  end
+end
+
+PopCommand.run

data/bin/amqp-statq

@@ -0,0 +1,28 @@
+#!/usr/bin/ruby
+
+require File.dirname(__FILE__) + '/../lib/amqp_utils/command'
+
+class QueueStatCommand < AmqpUtils::Command
+  def prepare_options(options)
+    options.banner %Q{
+    |Gets statistics on the queues specified.
+    |
+    |  #{command_name} <queue> [<another_queue> ..]
+    }.margin
+  end
+
+  def execute
+    @queues = ARGV
+
+    @queues.each do |queue|
+      MQ.new.queue(queue).status do |size, consumers|
+        puts "Queue <#{queue}>: #{size} message(s), #{consumers} consumer(s)"
+
+        @queues.delete(queue)
+        AMQP.stop { EM.stop } if @queues.empty?
+      end
+    end
+  end
+end
+
+QueueStatCommand.run

data/config/hoe.rb

@@ -0,0 +1,75 @@
+require 'amqp_utils/version'
+
+AUTHOR = 'Doug Barth'  # can also be an array of Authors
+EMAIL = "dougbarth@gmail.com"
+DESCRIPTION = "Command line utilities for interacting with AMQP compliant queues"
+GEM_NAME = 'amqp-utils' # what ppl will type to install your gem
+RUBYFORGE_PROJECT = 'amqp-utils' # The unix name for your project
+HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
+DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+EXTRA_DEPENDENCIES = [
+  ['amqp', '>= 0.6.0'],
+  ['trollop', '>= 1.10.2'],
+  ['facets', '>= 2.4.4']
+]    # An array of rubygem dependencies [name, version]
+
+@config_file = "~/.rubyforge/user-config.yml"
+@config = nil
+RUBYFORGE_USERNAME = "unknown"
+def rubyforge_username
+  unless @config
+    begin
+      @config = YAML.load(File.read(File.expand_path(@config_file)))
+    rescue
+      puts <<-EOS
+ERROR: No rubyforge config file found: #{@config_file}
+Run 'rubyforge setup' to prepare your env for access to Rubyforge
+ - See http://newgem.rubyforge.org/rubyforge.html for more details
+      EOS
+      exit
+    end
+  end
+  RUBYFORGE_USERNAME.replace @config["username"]
+end
+
+
+REV = nil
+# UNCOMMENT IF REQUIRED:
+# REV = YAML.load(`svn info`)['Revision']
+VERS = AmqpUtils::VERSION::STRING + (REV ? ".#{REV}" : "")
+RDOC_OPTS = ['--quiet', '--title', 'amqp-utils documentation',
+    "--opname", "index.html",
+    "--line-numbers",
+    "--main", "README",
+    "--inline-source"]
+
+class Hoe
+  def extra_deps
+    @extra_deps.reject! { |x| Array(x).first == 'hoe' }
+    @extra_deps
+  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.developer(AUTHOR, EMAIL)
+  p.description = DESCRIPTION
+  p.summary = DESCRIPTION
+  p.url = HOMEPATH
+  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
+  p.test_globs = ["test/**/test_*.rb"]
+  p.clean_globs |= ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store']  #An array of file patterns to delete on clean.
+
+  # == Optional
+  p.changes = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  p.extra_deps = EXTRA_DEPENDENCIES
+
+    #p.spec_extras = {}    # A hash of extra values to set in the gemspec.
+  end
+
+CHANGES = $hoe.paragraphs_of('History.txt', 0..1).join("\\n\\n")
+PATH    = (RUBYFORGE_PROJECT == GEM_NAME) ? RUBYFORGE_PROJECT : "#{RUBYFORGE_PROJECT}/#{GEM_NAME}"
+$hoe.remote_rdoc_dir = File.join(PATH.gsub(/^#{RUBYFORGE_PROJECT}\/?/,''), 'rdoc')
+$hoe.rsync_args = '-av --delete --ignore-errors'
+$hoe.spec.post_install_message = File.open(File.dirname(__FILE__) + "/../PostInstall.txt").read rescue ""

data/config/requirements.rb

@@ -0,0 +1,15 @@
+require 'fileutils'
+include FileUtils
+
+require 'rubygems'
+%w[rake newgem rubigen].each do |req_gem|
+  begin
+    require req_gem
+  rescue LoadError
+    puts "This Rakefile requires the '#{req_gem}' RubyGem."
+    puts "Installation: gem install #{req_gem} -y"
+    exit
+  end
+end
+
+$:.unshift(File.join(File.dirname(__FILE__), %w[.. lib]))

data/lib/amqp_utils/command.rb

@@ -0,0 +1,61 @@
+require File.dirname(__FILE__) + '/../amqp_utils'
+
+class AmqpUtils::Command
+  class << self
+    def run(args = ARGV)
+      command = new(args)
+      command.process_options
+      command.go
+    end
+  end
+
+  def initialize(args)
+    @args = args
+  end
+
+  attr_reader :args, :options
+
+  def process_options
+    command = self
+    @options = Trollop::options(@args) do
+      command.prepare_options(self) if command.respond_to?(:prepare_options)
+
+      banner %Q{
+      |
+      |Standard options:
+      }.margin
+      opt :host, 'The AMQP host to connect to', :default => 'localhost'
+      opt :port, 'The AMQP port to connect to', :default => 5672
+      opt :vhost, 'The vhost to connect to', :default => '/'
+      opt :user, 'The user name to authenticate with', :default => 'guest'
+      opt :password, 'The password to connect with', :default => 'guest'
+      opt :timeout, 'The connect timeout in seconds', :default => 5
+      opt :verbose, 'Print all AMQP commands sent and received.'
+    end
+  end
+
+  def command_name
+    File.basename($0)
+  end
+
+  def go
+    EM.run do
+      %w(host port vhost user timeout).each do |val|
+        AMQP.settings[val.to_sym] = options[val.to_sym]
+      end
+      AMQP.settings[:pass] = options.password
+      AMQP.logging = options.verbose
+
+      trap("INT") do
+        if @nice_tried
+          EM.stop
+        else
+          AMQP.stop { EM.stop }
+          @nice_tried = true
+        end
+      end
+
+      execute
+    end
+  end
+end

data/lib/amqp_utils/version.rb

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

data/lib/amqp_utils.rb

@@ -0,0 +1,17 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+module AmqpUtils
+  
+end
+
+require 'rubygems'
+
+gem 'trollop'
+require 'trollop'
+
+gem 'amqp'
+require 'mq'
+
+gem 'facets'
+require 'facets/string/tab'

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/amqp_utils.rb'}"
+puts "Loading amqp-utils gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)