cottontail 0.0.1 → 0.0.2

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Rudolf Schmidt
+
+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/README.md

@@ -0,0 +1,57 @@
+# Cottontail
+
+This library is a wrapper around the popular AMQP bunny gem. It is inspired by Sinatra to easily consume messages on different routing keys.
+
+## Installation
+
+System wide:
+
+```console
+gem install cottontail
+```
+
+Or in your Gemfile:
+
+```ruby
+gem 'cottontail'
+```
+
+## Usage
+
+When using this gem, you should already be familiar with RabbitMQ and, idealy, Bunny as it's a wrapper around it. Given we place our code into `worker.rb`, we can define a simple class like so:.
+
+```ruby
+require 'cottontail'
+require 'bunny'
+
+class Worker < Cottontail::Base
+  # configure the Bunny client with the default connection (host: "localhost", port: 5672) 
+  # and with logging.
+  set :client, :logging => true
+
+  # Declare default direct exchange which is bound to all queues of the type `topic`
+  set :exchange, "", :type => :topic
+
+  # Declare the `test` queue
+  set :queue, "test"
+
+
+  # Consume messages on the routing key: `message.received`.Within the provided block 
+  # you have access to seleral methods. See Cottontail::Helpers for more details.
+  route "message.received" do
+    puts "This is the payload #{payload.inspect}"
+  end
+end
+
+# The following will start Cottontail right away. You need to be aware that it 
+# will enter the Bunny subscribe loop, so it will block the process.
+Worker.run
+```
+
+To run it, you may start it like the following code example. However, you should use a more sophisticated solution for daemonizing your processes in a production environment. See http://www.ruby-toolbox.com/categories/daemonizing for futher inspiration.
+
+```console
+ruby worker.rb &
+```
+
+Copyright &copy; 2012 Rudolf Schmidt, released under the MIT license

data/cottontail.gemspec

@@ -20,5 +20,5 @@ Gem::Specification.new do |s|
 
   # specify any dependencies here; for example:
   # s.add_development_dependency "rspec"
-  # s.add_runtime_dependency "rest-client"
+  s.add_runtime_dependency "bunny"
 end

data/lib/cottontail.rb

@@ -4,11 +4,30 @@ module Cottontail
   class RouteNotFound < StandardError; end
 
   module Helpers
-    attr_reader :message, :last_error
-
+    # The last_error is accessable within an error block.
+    #
+    # last_error will be set once an exception was raise
+    attr_reader :last_error
+
+    # A RabbitMQ message retrieved by Bunny usually contains the following information:
+    #   header [Qrack::Protocol::Header] The header of the message including size, properties, etc.
+    #   payload [String] The message sent through RabbitMQ
+    #   delivery_details [Hash] Includes the exchange, routing_key, etc
+    #
+    # This is the original message from the queue (not be confused with the payload sent via RabitMQ).
+    attr_reader :message
+
+    # Accessor to the message's payload
     def payload; message[:payload]; end
+
+    # Accessor to the message's header
+    def header; message[:header]; end
+
+    # Accessor to the message's delivery details
     def delivery_details; message[:delivery_details]; end
-    def routing_key; message[:routing_key]; end
+
+    # Accessor to the delivery detail's routing key
+    def routing_key; delivery_details[:routing_key]; end
   end
 
   class Base
@@ -70,7 +89,7 @@ module Cottontail
         codes.each { |c| (@errors[c] ||= []) << compile!("error_#{c}", &block) }
       end
 
-      # Route on class level
+      # Route on class level (handy for testing)
       #
       # @example
       #   route! :payload => "some message", :routing_key => "v2.message.sent"

data/lib/cottontail/version.rb

@@ -1,3 +1,3 @@
 module Cottontail
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -2,7 +2,7 @@
 name: cottontail
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
   - Rudolf Schmidt
@@ -11,8 +11,18 @@ bindir: bin
 cert_chain: []
 
 date: 2012-02-02 00:00:00 Z
-dependencies: []
-
+dependencies: 
+  - !ruby/object:Gem::Dependency 
+    name: bunny
+    prerelease: false
+    requirement: &id001 !ruby/object:Gem::Requirement 
+      none: false
+      requirements: 
+        - - ">="
+          - !ruby/object:Gem::Version 
+            version: "0"
+    type: :runtime
+    version_requirements: *id001
 description: Convenience wrapper around the AMQP Bunny gem to better handle routing_key specific messages
 email: 
 executables: []
@@ -24,6 +34,8 @@ extra_rdoc_files: []
 files: 
   - .gitignore
   - Gemfile
+  - LICENSE.txt
+  - README.md
   - Rakefile
   - cottontail.gemspec
   - lib/cottontail.rb