A Ruby library implementing a Simple Message Queue protocol
Ruby Shell
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
bugs
examples
lib
smq
test
www
.gitignore
History.txt
Manifest.txt
README.rdoc
Rakefile
VERSION
smqueue.gemspec

README.rdoc

smqueue

by Sean O'Halpin

github.com/seanohalpin/smqueue

version 0.3.0

DESCRIPTION

Implements a simple protocol for using message queues, with adapters for ActiveMQ, Spread and stdio (for testing).

This is a bare-bones release to share with my colleagues - apologies for the lack of documentation and tests.

FEATURES

  • simple to use

  • designed primarily for pipeline processing

  • compatible with Rails

  • comes with a modified stomp.rb library (rstomp.rb)

BUGS

  • let me know!

SYNOPSIS

require 'smqueue'
config = YAML::load(File.read('config.yml'))
input_queue = SMQueue(config[:input])
output_queue = SMQueue(config[:output])
input_queue.get do |msg|
   # do something with msg
   new_msg = msg.body
   output_queue.put new_msg
end

Configuration

The easiest way to configure SMQueue is to use YAML files. An example can be found in ./examples/config/example_config.yml.

To find out the complete set of options each adapter supports, for now you'll have to read the source in ./lib/smqueue/adapters/*.rb.

REQUIREMENTS

  • depends on doodle >= 0.1.9

  • you need access to an ActiveMQ message broker or Spread publisher

  • development uses bones gem

INSTALL

For runtime:

sudo gem install doodle smqueue

For development:

sudo gem install bones

LICENSE

(The MIT License)

Copyright © 2008-2010 Sean O'Halpin

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.