amqpcat-hw 0.0.2

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+# gem "bunny", "~> 0.7.0"
+gem 'bunny', :git => 'git://github.com/ruby-amqp/bunny.git'

data/Gemfile.lock

@@ -0,0 +1,15 @@
+GIT
+  remote: git://github.com/ruby-amqp/bunny.git
+  revision: f2deea037057169014b0f7a67682baf6a9d70c30
+  specs:
+    bunny (0.8.0.pre1)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bunny!

data/README.md

@@ -0,0 +1,106 @@
+amqpcat - Netcat-like tool for AMQP queues
+==========================================
+
+This was originally written as a "toy" to learn and experiment with
+rabbitmq. It allows you to easily read/write from AMQP queues/exchanges
+from the command line or from shell scripts. It is implemented with the
+`bunny` Ruby gem.
+
+Install
+-------
+Install from gem:
+
+    sudo gem install amqpcat
+
+Install from github:
+
+    git clone https://github.com/joemiller/amqpcat
+    gem build amqpcat.gemspec
+    gem install amqpcat-0.0.1.gem
+
+Example Usage
+-------------
+
+### 1:1 Messaging
+
+Start a consumer. This will block until a message is received.
+
+    amqpcat --consumer amqp://guest:guest@rabbitmq.server/
+
+Publish a message:
+
+    echo "hello rabbit" | amqpcat --publisher amqp://guest:guest@rabbitmq.server/
+
+The consumer should output the message and exit.
+
+### 1:N (fanout / pubsub)
+
+See the `examples/test_fanout.sh` script for another example of fanout
+messaging.
+
+Start 2 consumers, using `-s` to prefix the output of each with an
+identifying string:
+
+    amqpcat --consumer -n fanout.test -t fanout -s "Consumer 1: " amqp://guest:guest@rabbitmq.server/
+    amqpcat --consumer -n fanout.test -t fanout -s "Consumer 2: " amqp://guest:guest@rabbitmq.server/
+
+Note: In fanout mode, consumers will create their own server-named queues and bind to an exchange
+defined by the `-n` parameter.
+
+Published a message to the exchange:
+
+    echo "hello rabbits" | amqpcat --publisher -n fanout.test -t fanout amqp://guest:guest@rabbitmq.server/
+
+Both of the consumers should print out the message we published.
+
+Options
+-------
+Run `amqpcat -h` to get detailed help output.
+
+### One-message -vs- Continuous message mode
+
+By default, when publishing, `amqpcat` will use the newline character to 
+distinguish between messages to publish. However, you can send a single
+message by using the `--once` option. This can be useful if you need
+to send a single message that contains new lines.
+
+SSL Support
+-----------
+SSL support has been written but is not tested nor is it fully working
+at this time (v0.0.1).
+ 
+Additionally, the --ssl-key and --ssl-cert options are only supported 
+under newer versions of the Bunny gem (0.8+) or if bunny is installed
+from the master branch on github.
+
+Contributing
+------------
+1. Fork it.
+2. Create a branch (`git checkout -b my_feature`)
+3. Commit your changes (`git commit -am "did some stuff"`)
+4. Push to the branch (`git push origin my_feature`)
+5. Create an with a link to your branch
+
+Author
+------
+
+Joe Miller - http://twitter.com/miller_joe || https://github.com/joemiller
+
+License
+-------
+
+    Author:: Joe Miller (<joeym@joeym.net>)
+    Copyright:: Copyright (c) 2012 Joe Miller
+    License:: Apache License, Version 2.0
+
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+
+        http://www.apache.org/licenses/LICENSE-2.0
+
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.

data/amqpcat.gemspec

@@ -0,0 +1,32 @@
+
+# -*- encoding: utf-8 -*-
+$:.push('lib')
+require "amqpcat/version"
+
+Gem::Specification.new do |s|
+  s.name     = "amqpcat-hw"
+  s.version  = Amqpcat::VERSION.dup
+  s.date     = "2012-02-05"
+  s.summary  = "Netcat-like tool for reading and writing messages to AMQP message brokers"
+  s.email    = "joeym@joeym.net"
+  s.homepage = "https://github.com/joemiller/amqpcat"
+  s.authors  = ['Joe Miller']
+  
+  s.description = <<-EOF
+A netcat inspired command line tool for reading and writing simple
+messages to AMQP based message brokers such as RabbitMQ.
+EOF
+  
+  s.files         = Dir['**/*']
+  s.test_files    = Dir['test/**/*'] + Dir['spec/**/*']
+  s.executables   = Dir['bin/*'].map { |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  
+  ## Make sure you can build the gem on older versions of RubyGems too:
+  s.rubygems_version = "1.3.6"
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.specification_version = 3 if s.respond_to? :specification_version
+  
+  s.add_dependency("bunny", "0.7.8")
+
+end

data/bin/amqpcat

@@ -0,0 +1,118 @@
+#!/usr/bin/env ruby
+
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+
+require 'optparse'
+require 'amqpcat'
+
+options = {}
+optparse = OptionParser.new do |opts|
+  opts.banner = <<-EOS
+Usage: #{$0} [options] amqp-url
+
+  amqp-url format: 'amqp://user:pass@host:port/vhost'
+
+  'amqp'      : required. Either amqp or amqps (SSL)
+  'user:pass' : optional. Default: guest:guest
+  'host'      : required.
+  'port'      : optional. Default: 5672 (amqp), 5671 (amqps)
+  'vhost'     : optional. Default: /
+
+Options:
+EOS
+
+  opts.on('-h', '--help', 'Display usage') { puts opts; exit 0 }
+
+  options[:mode] = nil
+  opts.on('-c', '--consumer', 'Read data from the queue specified by -n and write to STDOUT') do
+    options[:mode] = :consumer
+  end
+
+  opts.on('-p', '--publisher', 'Read data from STDIN and publish to the exchange specified by -n') do
+    options[:mode] = :publisher
+  end
+
+  opts.on('-k', '--ssl-key FILE', 'Use SSL key in FILE.') do |f|
+    options[:ssl_key] = f
+  end
+
+  opts.on('-r', '--ssl-cert FILE', 'Use SSL cert in FILE.') do |f|
+    options[:ssl_cert] = f
+  end
+
+  options[:verify_ssl] = true
+  opts.on('y', '--[no-]verify-ssl', 'Verify server SSL certficiate. (Default: true)') do |y|
+    options[:verify_ssl] = y
+  end
+
+  options[:prefix] = ''
+  opts.on('-s', '--string STRING', "prefix output with STRING") do |s|
+     options[:prefix] = s
+   end
+
+  options[:once] = false
+  opts.on('-o', '--once', "Read/Write one message then exit. (Default: false)") do
+    options[:once] = true
+  end
+
+  options[:name] = 'amqpcat.default'
+  opts.on('-n', '--name NAME', "Queue and Exchange NAME to use. (Default: amqpcat.default)") do |name|
+    options[:name] = name
+  end
+
+  options[:type] = 'direct'
+  opts.on('-t', '--type TYPE', "Exchange type: direct, fanout. (Default: direct)") do |type|
+    options[:type] = type
+  end
+
+  options[:durable] = true
+  opts.on('--[no-]durable', "Enable/Disable durable messages. (Default: durable=true)") do |d|
+    options[:durable] = d
+  end
+
+  options[:auto_delete] = false
+  opts.on('--[no-]auto_delete', "Enable/Disable auto_delete. (Default: auto_delete=false)") do |d|
+    options[:auto_delete] = d
+  end
+
+  opts.on('--routing-key KEY', "Bind or publish to the exchange with a routing key.") do |k|
+    options[:routing_key] = k
+  end
+
+end
+optparse.parse!
+
+if ARGV.size < 1
+  puts "Must specify amqp-url. --help for help"
+  exit 1
+end
+
+if options[:mode].nil?
+  puts "Must specify --consumer or --publisher. --help for help"
+  exit 1
+end
+
+amqp_url = ARGV[0]
+amqpcat = Amqpcat.new(amqp_url, options)
+
+trap 'SIGINT', proc { amqpcat.finish; exit 0 }
+
+case options[:mode]
+  when :consumer
+    amqpcat.subscribe do |msg|
+      $stdout.write options[:prefix] + msg[:payload]
+      $stdout.flush
+      if options[:once]
+         amqpcat.finish
+         exit
+      end
+    end
+  when :publisher
+    if options[:once]
+      amqpcat.publish $stdin.read
+    else
+      $stdin.each_line { |l| amqpcat.publish(l) }
+    end
+end
+
+amqpcat.finish

data/examples/test_direct.sh

@@ -0,0 +1,20 @@
+#!/bin/sh
+
+amqpcat_bin="`dirname $0`/../bin/amqpcat"
+
+url="amqp://guest:guest@rabbitmq/"
+opts="--name=direct.test --type=direct"
+
+## start 2 consumers ##
+$amqpcat_bin -s "Consumer 1: " --consumer $url $opts &
+$amqpcat_bin -s "Consumer 2: " --consumer $url $opts &
+
+## send messages ##
+echo "test direct queue: 1" | $amqpcat_bin --publisher $url $opts
+echo "test direct queue: 2" | $amqpcat_bin --publisher $url $opts
+echo "test direct queue: 3" | $amqpcat_bin --publisher $url $opts
+echo "test direct queue: 4" | $amqpcat_bin --publisher $url $opts
+
+## kill the consumers we forked ##
+sleep 1
+kill %1 %2

data/examples/test_fanout.sh

@@ -0,0 +1,21 @@
+#!/bin/sh
+
+amqpcat_bin="`dirname $0`/../bin/amqpcat"
+
+amqp_url="amqp://guest:guest@rabbitmq/"
+amqp_opts="--name=fanout.test --type=fanout"
+
+## start 2 consumers ##
+$amqpcat_bin -s "Consumer 1: " $amqp_url $amqp_opts &
+$amqpcat_bin -s "Consumer 2: " $amqp_url $amqp_opts &
+sleep 1
+
+## send messages ##
+echo "test fanout queue: 1" | $amqpcat_bin $amqp_url $amqp_opts
+echo "test fanout queue: 2" | $amqpcat_bin $amqp_url $amqp_opts
+echo "test fanout queue: 3" | $amqpcat_bin $amqp_url $amqp_opts
+echo "test fanout queue: 4" | $amqpcat_bin $amqp_url $amqp_opts
+
+## kill the consumers we forked ##
+sleep 1
+kill %1 %2

data/examples/test_ssl.sh

@@ -0,0 +1,24 @@
+#!/bin/sh
+
+whereami=$(dirname $0)
+amqpcat_bin="$whereami/../bin/amqpcat"
+
+url="amqps://guest:guest@rabbitmq/"
+opts="--name=direct.test --type=direct \
+      --ssl-key=$whereami/client_key.pem \
+      --ssl-cert=$whereami/client_cert.pem\
+      --no-verify-ssl"
+
+## start 2 consumers ##
+$amqpcat_bin -s "Consumer 1: " --consumer $url $opts &
+$amqpcat_bin -s "Consumer 2: " --consumer $url $opts &
+
+## send messages ##
+echo "test direct queue: 1" | $amqpcat_bin --publisher $url $opts
+echo "test direct queue: 2" | $amqpcat_bin --publisher $url $opts
+echo "test direct queue: 3" | $amqpcat_bin --publisher $url $opts
+echo "test direct queue: 4" | $amqpcat_bin --publisher $url $opts
+
+## kill the consumers we forked ##
+sleep 1
+kill %1 %2

data/lib/amqpcat.rb

@@ -0,0 +1,86 @@
+require 'uri'
+require 'bunny'
+
+class Amqpcat
+  DEFAULT_QUEUE = 'amqpcat.default'
+
+  def initialize(url, options={})
+    parse_amqp_url(url)
+
+    @opts = {
+      :type => 'direct',
+      :name => DEFAULT_QUEUE,
+      :durable => true,
+      :auto_delete => false,
+      :persistent => true,
+      :ssl_key => nil,
+      :ssl_cert => nil,
+      :verify_ssl => true,
+    }.merge(options)
+
+    @amqp_settings.merge!(@opts)
+    @amqp = Bunny.new(@amqp_settings)
+    @amqp.start
+  end
+
+  def publish(msg)
+    exchange.publish(msg, :persistent => @opts[:persistent], :key => @opts[:routing_key])
+  end
+
+  def message_count
+    queue.message_count
+  end
+
+  def fetch
+    queue.pop[:payload]
+  end
+
+  def subscribe(&block)
+    queue.subscribe(&block)
+  end
+
+  def finish
+    @amqp.stop
+  end
+
+  private
+
+  def parse_amqp_url(str)
+    url = URI.parse(str)
+    use_ssl = url.scheme.downcase == 'amqps'
+    @amqp_settings = {
+      :host => url.host,
+      :port => url.port || (use_ssl ? 5671 : 5672),
+      :user => url.user || 'guest',
+      :pass => url.password || 'guest',
+      :vhost => url.path == "" ? '/' : url.path,
+      :ssl => use_ssl,
+    }
+  end
+
+  def exchange
+    return @exchange if @exchange
+    options = {
+      :type => @opts[:type],
+      :durable => @opts[:durable],
+      :auto_delete => @opts[:auto_delete]
+    }
+    @exchange = @amqp.exchange(@opts[:name], options)
+  end
+
+  def queue
+    return @queue if @queue
+    options = {
+      :durable => @opts[:durable],
+      :auto_delete => @opts[:auto_delete]
+    }
+    @queue = case @opts[:type]
+    when 'fanout'
+      @amqp.queue(options)
+    else
+      @amqp.queue(@opts[:name], options)
+    end
+    @queue.bind(exchange, :routing_key => @opts[:routing_key])
+    @queue
+  end
+end

data/lib/amqpcat/version.rb

@@ -0,0 +1,3 @@
+module Amqpcat
+  VERSION = '0.0.2'
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: amqpcat-hw
+version: !ruby/object:Gem::Version
+  prerelease: 
+  version: 0.0.2
+platform: ruby
+authors:
+- Joe Miller
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-02-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  type: :runtime
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.7.8
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.7.8
+  name: bunny
+description: ! 'A netcat inspired command line tool for reading and writing simple
+
+  messages to AMQP based message brokers such as RabbitMQ.
+
+'
+email: joeym@joeym.net
+executables:
+- amqpcat
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- bin/amqpcat
+- lib/amqpcat/version.rb
+- lib/amqpcat.rb
+- examples/test_ssl.sh
+- examples/test_direct.sh
+- examples/test_fanout.sh
+- amqpcat.gemspec
+- README.md
+homepage: https://github.com/joemiller/amqpcat
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Netcat-like tool for reading and writing messages to AMQP message brokers
+test_files: []