amqp-utils 0.0.1 → 0.2.0

data/.gitignore

@@ -0,0 +1,5 @@
+.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/Rakefile

@@ -1,4 +1,68 @@
-require 'config/requirements'
-require 'config/hoe' # setup Hoe + all gem configuration
-
-Dir['tasks/**/*.rake'].each { |rake| load rake }
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "amqp-utils"
+    gem.summary = %Q{Command line utilities for interacting with AMQP compliant queues}
+    gem.description = %Q{Command line utilies for interacting with AMQP compliant queues.
+      The intention is provide simple management tools that can be used to complete ad hoc
+      housework on an AMQP queue. In addition, simple scripts can be layered over the tools
+      when needed.}
+    gem.email = "dougbarth@gmail.com"
+    gem.homepage = "http://github.com/dougbarth/amqp-utils"
+    gem.authors = ["Doug Barth"]
+    gem.rubyforge_project = "amqp-utils"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+
+    gem.add_dependency('tmm1-amqp', '~> 0.6.4')
+    gem.add_dependency('trollop', '~> 1.10.2')
+    gem.add_dependency('facets', '~> 2.7.0')
+    gem.add_dependency('clio', '~> 0.3.0')
+    gem.add_dependency('json', '~> 1.1.6')
+  end
+  Jeweler::RubyforgeTasks.new do |rubyforge|
+    rubyforge.doc_task = "rdoc"
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo 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
+
+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
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "amqp-utils #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/TODO.txt

@@ -0,0 +1,7 @@
+[x] fix amqp-enqueue message count
+[x] detect commandline ARGV when no queue is specified bring up help
+[x] amqp-stat hangs when no queue specified
+[x] amqp-enqueue inspect error when message not specified
+[o] amqp-dequeue hangs on exit
+[o] setup.rb seems to install command.rb in wrong location
+[o] gem create

data/VERSION

@@ -0,0 +1 @@
+0.2.0

data/amqp-utils.gemspec

@@ -0,0 +1,79 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{amqp-utils}
+  s.version = "0.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Doug Barth"]
+  s.date = %q{2009-11-13}
+  s.description = %q{Command line utilies for interacting with AMQP compliant queues.
+      The intention is provide simple management tools that can be used to complete ad hoc
+      housework on an AMQP queue. In addition, simple scripts can be layered over the tools
+      when needed.}
+  s.email = %q{dougbarth@gmail.com}
+  s.executables = ["amqp-deleteq", "amqp-dequeue", "amqp-enqueue", "amqp-peek", "amqp-pop", "amqp-purge", "amqp-statq"]
+  s.extra_rdoc_files = [
+    "README.txt"
+  ]
+  s.files = [
+    ".gitignore",
+     "History.txt",
+     "License.txt",
+     "README.txt",
+     "Rakefile",
+     "TODO.txt",
+     "VERSION",
+     "amqp-utils.gemspec",
+     "bin/amqp-deleteq",
+     "bin/amqp-dequeue",
+     "bin/amqp-enqueue",
+     "bin/amqp-peek",
+     "bin/amqp-pop",
+     "bin/amqp-purge",
+     "bin/amqp-statq",
+     "lib/amqp_utils.rb",
+     "lib/amqp_utils/command.rb",
+     "lib/amqp_utils/message_formatter.rb",
+     "test/test_amqp_utils.rb",
+     "test/test_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/dougbarth/amqp-utils}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{amqp-utils}
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Command line utilities for interacting with AMQP compliant queues}
+  s.test_files = [
+    "test/test_amqp_utils.rb",
+     "test/test_helper.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<tmm1-amqp>, ["~> 0.6.4"])
+      s.add_runtime_dependency(%q<trollop>, ["~> 1.10.2"])
+      s.add_runtime_dependency(%q<facets>, ["~> 2.7.0"])
+      s.add_runtime_dependency(%q<clio>, ["~> 0.3.0"])
+      s.add_runtime_dependency(%q<json>, ["~> 1.1.6"])
+    else
+      s.add_dependency(%q<tmm1-amqp>, ["~> 0.6.4"])
+      s.add_dependency(%q<trollop>, ["~> 1.10.2"])
+      s.add_dependency(%q<facets>, ["~> 2.7.0"])
+      s.add_dependency(%q<clio>, ["~> 0.3.0"])
+      s.add_dependency(%q<json>, ["~> 1.1.6"])
+    end
+  else
+    s.add_dependency(%q<tmm1-amqp>, ["~> 0.6.4"])
+    s.add_dependency(%q<trollop>, ["~> 1.10.2"])
+    s.add_dependency(%q<facets>, ["~> 2.7.0"])
+    s.add_dependency(%q<clio>, ["~> 0.3.0"])
+    s.add_dependency(%q<json>, ["~> 1.1.6"])
+  end
+end

data/bin/amqp-deleteq

@@ -1,4 +1,4 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
 
 require File.dirname(__FILE__) + '/../lib/amqp_utils/command'
 
@@ -7,12 +7,16 @@ class QueueDeleteCommand < AmqpUtils::Command
     options.banner %Q{
     |Deletes the supplied queues.
     |
-    |  #{command_name} <queue>[, <another queue>, ...]
+    |  #{command_name} <queue> [<another queue> ...]
     }.margin
   end
 
+  def validate
+    raise "need at least one queue name" unless args[0] && !args[0].empty?
+  end
+
   def execute
-    @queues = ARGV
+    @queues = args
     def @queues.delete_or_stop
       queue = pop
       if queue

data/bin/amqp-dequeue

@@ -1,28 +1,40 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
 
 require File.dirname(__FILE__) + '/../lib/amqp_utils/command'
+require File.dirname(__FILE__) + '/../lib/amqp_utils/message_formatter'
 
 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>, ...]
+    |  #{command_name} <queue> [<another queue> ...]
+    |
+    |Dequeue options:
     }.margin
+    options.opt :format, 'The format that the messages should be displayed as',
+      :short => :none, :default => 'pretty'
+    options.opt :quiet, 'Suppresses non-message content output',
+      :short => 'q', :default => false
+  end
+
+  def validate
+    raise "need at least one queue name" if args.empty?
   end
 
   def execute
-    @queues = ARGV
+    @queues = args
+    @formatter = AmqpUtils::MessageFormatter.for_type(options[:format])
+
     @queues.each do |queue|
-      puts "Dequeueing from #{queue}..."
+      puts "Dequeueing from #{queue} (^C to stop)..." unless options[:quiet]
       mq = MQ.new
 
       process_message = lambda do |header, message|
-        puts "(#{queue})"
-        puts "  Header: #{header.properties.inspect}"
-        puts "  Message: #{message.inspect}"
+        puts "(#{queue})" unless options[:quiet]
+        @formatter.generate(STDOUT, header, message)
       end
-      mq.queue(queue).subscribe &process_message
+      mq.queue(queue).subscribe(&process_message)
     end
   end
 end

data/bin/amqp-enqueue

@@ -1,6 +1,7 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
 
 require File.dirname(__FILE__) + '/../lib/amqp_utils/command'
+require 'clio/progressbar'
 
 class EnqueueCommand < AmqpUtils::Command
   def prepare_options(options)
@@ -11,28 +12,35 @@ class EnqueueCommand < AmqpUtils::Command
     |
     |Enqueue options:
     }.margin
-    options.opt :persistent, 'Mark messages as persistent.'
+    options.opt :persistent, 'Mark messages as persistent.', :short => :none
     options.opt :count, 'Number of times the message should be published.', :type => :int, :default => 1
   end
 
+  def validate
+    raise "need a queue to publish to" unless args[0] && !args[0].empty?
+    raise "need a message to publish" unless args[1] && !args[1].empty?
+  end
+
   def execute
-    @queue = ARGV[0]
-    @message = ARGV[1]
+    @queue, @message = args
 
     publisher = EM.spawn do |queue, message, messages, options|
+      @progress ||= Clio::Progressbar.new('Enqueuing', options[:count])
+
       if messages > 0
         @mq ||= MQ.new
         @mq.queue(queue, :durable => true, :auto_delete => false).
           publish(message, :persistent => options.persistent)
 
-        print '.'; STDOUT.flush
+        @progress.inc
         publisher.notify(queue, message, messages - 1, options)
       else
+        @progress.finish
         EM.next_tick { AMQP.stop { EM.stop } }
       end
     end
 
-    publisher.notify(@queue, @message, options.count, options)
+    publisher.notify(@queue, @message, options[:count], options)
   end
 end
 

data/bin/amqp-peek

@@ -1,6 +1,7 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
 
 require File.dirname(__FILE__) + '/../lib/amqp_utils/command'
+require File.dirname(__FILE__) + '/../lib/amqp_utils/message_formatter'
 
 class PeekCommand < AmqpUtils::Command
   def prepare_options(options)
@@ -12,22 +13,26 @@ class PeekCommand < AmqpUtils::Command
     |  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.
+    |
+    |Peek options:
     }.margin
+    options.opt :format, 'The format that the messages should be displayed as',
+      :short => :none, :default => 'pretty'
+  end
+
+  def validate
+    raise "need a queue name" unless args[0] && !args[0].empty?
   end
 
   def execute
     @queue = args[0]
+    @formatter = AmqpUtils::MessageFormatter.for_type(options[:format])
 
     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}"
+        @formatter.generate(STDOUT, header, message)
       else
         puts "(#{@queue}) empty"
       end

data/bin/amqp-pop

@@ -1,6 +1,7 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
 
 require File.dirname(__FILE__) + '/../lib/amqp_utils/command'
+require File.dirname(__FILE__) + '/../lib/amqp_utils/message_formatter'
 
 class PopCommand < AmqpUtils::Command
   def prepare_options(options)
@@ -8,21 +9,26 @@ class PopCommand < AmqpUtils::Command
     |Pops a single message from the queue.
     |
     |   #{command_name} <queue>
+    |
+    |Pop options:
     }.margin
+    options.opt :format, 'The format that the messages should be displayed as',
+      :short => :none, :default => 'pretty'
+  end
+
+  def validate
+    raise "need a queue name" unless args[0] && !args[0].empty?
   end
 
   def execute
     @queue = args[0]
+    @formatter = AmqpUtils::MessageFormatter.for_type(options[:format])
 
     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}"
+        @formatter.generate(STDOUT, header, message)
       else
         puts "(#{@queue}) empty"
       end

data/bin/amqp-purge

@@ -0,0 +1,47 @@
+#!/usr/bin/env ruby
+
+require File.dirname(__FILE__) + '/../lib/amqp_utils/command'
+
+# Monkey patching in purge support.
+#
+# TODO: submit this change back to the AMQP project.
+class MQ::Queue
+  def purge(options = {})
+    @mq.callback {
+      @mq.send Protocol::Queue::Purge.new({:queue => name,
+                                           :nowait => true}.merge(options))
+    }
+  end
+end
+
+class PurgeCommand < AmqpUtils::Command
+  def prepare_options(options)
+    options.banner %Q{
+    |Removes all messages from the supplied queues.
+    |
+    |  #{command_name} <queue> [<another queue> ...]
+    }.margin
+  end
+
+  def validate
+    raise "need at least one queue name" if args.empty?
+  end
+
+  def execute
+    mq = MQ.new
+    @queues = args
+    purge_one = lambda do
+      queue = @queues.shift
+      puts "Purging #{queue}..."
+      mq.queue(queue).purge
+      if @queues.empty?
+        AMQP.stop { EM.stop }
+      else
+        EM.next_tick(&purge_one)
+      end
+    end
+    EM.next_tick(&purge_one)
+  end
+end
+
+PurgeCommand.run

data/bin/amqp-statq

@@ -1,4 +1,4 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
 
 require File.dirname(__FILE__) + '/../lib/amqp_utils/command'
 
@@ -7,15 +7,19 @@ class QueueStatCommand < AmqpUtils::Command
     options.banner %Q{
     |Gets statistics on the queues specified.
     |
-    |  #{command_name} <queue> [<another_queue> ..]
+    |  #{command_name} <queue> [<another_queue> ...]
     }.margin
   end
 
+  def validate
+    raise "need at least one queue name" unless args[0] && !args[0].empty?
+  end
+
   def execute
-    @queues = ARGV
+    @queues = args
 
     @queues.each do |queue|
-      MQ.new.queue(queue).status do |size, consumers|
+      mq.queue(queue, :passive => true).status do |size, consumers|
         puts "Queue <#{queue}>: #{size} message(s), #{consumers} consumer(s)"
 
         @queues.delete(queue)

data/lib/amqp_utils/command.rb

@@ -1,10 +1,19 @@
 require File.dirname(__FILE__) + '/../amqp_utils'
 
 class AmqpUtils::Command
+  include Clio::Terminal
+
   class << self
     def run(args = ARGV)
       command = new(args)
       command.process_options
+
+      begin
+        command.validate
+      rescue RuntimeError => e
+        Trollop::die(e.message)
+      end
+
       command.go
     end
   end
@@ -13,25 +22,43 @@ class AmqpUtils::Command
     @args = args
   end
 
+  def version
+    IO.read(File.join(File.dirname(__FILE__), '..', '..', 'VERSION'))
+  end
+
   attr_reader :args, :options
 
   def process_options
     command = self
     @options = Trollop::options(@args) do
+      version(command.version)
       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.'
+      opt :host, 'The AMQP host to connect to', :short => 'H', :default => 'localhost'
+      opt :port, 'The AMQP port to connect to', :short => 'P', :default => 5672
+      opt :vhost, 'The vhost to connect to', :short => 'V', :default => '/'
+      opt :user, 'The user name to authenticate with', :default => 'guest', :short => 'u'
+      opt :prompt, 'Prompt the user for a password', :short => 'p'
+      opt :password, 'The password to connect with.', :default => 'guest', :short => :none
+      conflicts(:prompt, :password)
+      opt :timeout, 'The connect timeout in seconds', :default => 5, :short => 't'
+      opt :verbose, 'Print all AMQP commands sent and received.', :short => 'v'
     end
+
+    @args = @args.dup
+    ARGV.clear
+  end
+
+  # Called to validate that the supplied command line options and arguments
+  # are valid. If there is a problem with the supplied values, and exception
+  # should be raised.
+  #
+  # Subclasses show override this method and do their validation.
+  def validate
   end
 
   def command_name
@@ -39,23 +66,42 @@ class AmqpUtils::Command
   end
 
   def go
-    EM.run do
-      %w(host port vhost user timeout).each do |val|
-        AMQP.settings[val.to_sym] = options[val.to_sym]
+    if options.prompt
+      options[:password] = password()
+      puts
+    end
+
+    %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
-      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
+
+    EM.run do
+      amqp.connection_status do |status|
+        if status == :disconnected
+          Trollop::die "disconnected from #{AMQP.settings[:host]}:#{AMQP.settings[:port]}"
         end
       end
 
-      execute
+      mq.callback { execute }
     end
   end
+
+  def amqp
+    @amqp ||= AMQP.start
+  end
+
+  def mq
+    @mq ||= MQ.new
+  end
 end

data/lib/amqp_utils/message_formatter.rb

@@ -0,0 +1,42 @@
+class AmqpUtils::MessageFormatter
+  class << self
+    @@formatters ||= {}
+
+    def for_type(format_type)
+      @@formatters[format_type.downcase].new
+    end
+
+    def register_formatter(formatter, format_type)
+      @@formatters[format_type.downcase] = formatter
+    end
+  end
+
+  class Base
+    def self.inherited(klass)
+      ::AmqpUtils::MessageFormatter.register_formatter(klass, klass.basename)
+    end
+  end
+
+  class Pretty < Base
+    def generate(io, header, message)
+      io.puts "  Header: "
+      header.properties.each do |key, value|
+        io.puts "    #{key.inspect} => #{value.inspect}"
+      end
+      io.puts "  Message: #{message.inspect}"
+    end
+  end
+
+  class JSON < Base
+    def generate(io, header, message)
+      json_obj = {'header' => header.properties, 'message' => message}
+      io.puts ::JSON.generate(json_obj)
+    end
+  end
+
+  class Message < Base
+    def generate(io, header, message)
+      io.puts message
+    end
+  end
+end

data/lib/amqp_utils.rb

@@ -10,8 +10,16 @@ require 'rubygems'
 gem 'trollop'
 require 'trollop'
 
-gem 'amqp'
+gem 'tmm1-amqp'
 require 'mq'
 
 gem 'facets'
 require 'facets/string/tab'
+require 'facets/kernel/returning'
+require 'facets/module/basename'
+
+gem 'clio'
+require 'clio/consoleutils'
+
+gem 'json'
+require 'json'