raq 0.1.0 → 0.1.2

data/Gemfile

@@ -4,17 +4,19 @@ gem "eventmachine", "~> 1.0"
 gem "amqp", "~> 1.0"
 
 group :development do
+  gem "bcat", "~> 0.6.2"
   gem "bundler", "~> 1.3.0"
   gem "guard", "~> 1.8.0"
   gem "guard-cucumber", "~> 1.4.0"
   gem "guard-rspec", "~> 3.0.2"
   gem "pry", "~> 0.9.12"
-  gem "rdoc", "~> 3.12"
+  gem "rdoc", "~> 4.0.0"
+  gem "rdiscount", "~> 2.1.6"
   gem "travis-lint", "~> 1.7.0"
 end
 
 group :test do
-  gem "aruba", "~> 0.5.3"
+  gem "aruba", github: 'cpb/aruba', branch: 'reporting_argument_error'
   gem "cucumber", "~> 1.3.0"
   gem "jeweler", "~> 1.8.4"
   gem "rake", "~> 10.0.4"

data/README.md

@@ -1,7 +1,69 @@
-Raq [![Build Status](https://travis-ci.org/cpb/raq.png?branch=master)](https://travis-ci.org/cpb/raq) [![Dependency Status](https://gemnasium.com/cpb/raq.png)](https://gemnasium.com/cpb/raq) [![Code Climate](https://codeclimate.com/github/cpb/raq.png)](https://codeclimate.com/github/cpb/raq)
-=====
+Raq [![Build Status](https://travis-ci.org/cpb/raq.png?branch=master)](https://travis-ci.org/cpb/raq) [![Dependency Status](https://gemnasium.com/cpb/raq.png)](https://gemnasium.com/cpb/raq) [![Code Climate](https://codeclimate.com/repos/51d5c98289af7e2eda089f9a/badges/f4cb8a49dee9210b9775/gpa.png)](https://codeclimate.com/repos/51d5c98289af7e2eda089f9a/feed)
+===
 
-Description goes here.
+Raq makes it easy to create durable message queue consumers. It tries to learn from [Thin](https://github.com/macournoyer/thin) and [Rack](https://github.com/rack/rack) in order to provide a reasonably familiar way of creating and running AMQP consumers.
+
+Raq expresses the opinion that, like database configuration, queue configuration should be configured by the environment. Raq offers the ability to specify message broker connection information and queue names as command line flags, or in an separate configuration file.
+
+Installation
+------------
+
+Add this to your Gemfile:
+
+```ruby
+gem 'raq'
+```
+
+Then install it by running Bundler:
+
+```bash
+$ bundle
+```
+
+Usage
+-----
+
+Raq provides a Rack-like api for creating consumers and message middleware by implementing ```run``` and ```use```.
+
+However, unlike Rack, Raq does not infer anything about the payload. It exposes the protocol level meta information, and the unmodified payload body directly as arguments to your consumers. Though, you can quickly chain together middleware to satisfy your application.
+
+Consider this example.rb:
+
+```ruby
+require 'raq'
+
+class Echo < Struct.new(:app)
+  def call(meta, payload)
+    puts "Echo: #{payload}"
+    app.call(meta,payload)
+  end
+end
+
+runner = Raq::Runner.new(ARGV)
+server = Raq::Server.new(
+  connection: runner.connection_options,
+  queues: runner.options[:queue]) do
+
+  use Echo
+
+  run do |meta, payload|
+    puts "Acknowledging #{payload}"
+    meta.ack
+
+    # Not for long lived processes...
+    server.connection.close { EM.stop }
+  end
+end
+
+server.run
+```
+
+When run like so:
+```bash
+$ ruby example.rb --queue a.queue.with.messages
+```
+
+It will print the payload to stdout a couple times, acknowledge the message, and exit.
 
 == Contributing to raq
 
@@ -15,6 +77,5 @@ Description goes here.
 
 == Copyright
 
-Copyright (c) 2013 Caleb Buxton. See LICENSE.txt for
-further details.
+Copyright (c) 2013 Caleb Buxton. See LICENSE.txt for further details.
 

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.2

data/features/README.md.feature

@@ -0,0 +1,47 @@
+Feature: The README instructions and examples
+
+  @disable-bundler
+  Scenario: Installation
+    Given a file named "Gemfile" with:
+    """
+    gem 'raq', path: '../../'
+    """
+    When I run `bundle install`
+    Then the output should match /Using raq \(\d+\.\d+\.\d+\) from source at ../
+
+  @amqp
+  Scenario: Usage
+    Given a file named "example.rb" with:
+    """
+    $: << '../../lib'
+    require 'raq'
+
+    class Echo < Struct.new(:app)
+      def call(meta, payload)
+        puts "Echo: #{payload}"
+        app.call(meta,payload)
+      end
+    end
+
+    runner = Raq::Runner.new(ARGV)
+    server = Raq::Server.new(
+      connection: runner.connection_options,
+      queues: runner.options[:queue]) do
+
+      use Echo
+
+      run do |meta, payload|
+        puts "Acknowledging #{payload}"
+        meta.ack
+
+        # Not for long lived processes...
+        server.connection.close { EM.stop }
+      end
+    end
+
+    server.run
+    """
+    And I produce a message "Usage\ Example" on the queue "readme.usage.examples"
+    When I run `ruby example.rb --queue readme.usage.examples`
+    Then the output should contain "Echo: Usage Example"
+    And the output should contain "Acknowledging Usage Example"

data/features/raq.feature

@@ -44,6 +44,7 @@ Feature: Raq provides a friendly and familiar way of consuming messages off a du
     And a consumer with:
     """
     runner = Raq::Runner.new(ARGV)
+
     server = Raq::Server.new(
       connection: runner.connection_options,
       queues: runner.options[:queue]) do
@@ -76,11 +77,7 @@ Feature: Raq provides a friendly and familiar way of consuming messages off a du
     """
     And a consumer with:
     """
-    begin
-      require 'always_ack'
-    rescue LoadError => e
-      puts $LOAD_PATH
-    end
+    require 'always_ack'
 
     runner = Raq::Runner.new(ARGV)
     server = Raq::Server.new(

data/features/step_definitions/raq_steps.rb

@@ -37,14 +37,11 @@ THE_CONSUMER = Transform /^the consumer(?: "(.*?)")?$/ do |possible_name|
 end
 
 Given(/^a raq agent file named "(.*?)" with:$/) do |name, content|
-  steps %{
-    Given a file named "#{name}" with:
-    """
-    #{simplecov_for(name)}
-    require 'raq'
+  step %{a file named "#{name}" with:},%{
+#{simplecov_for(name)}
+require 'raq'
 
-    #{content}
-    """
+#{content}
   }
 end
 
@@ -74,12 +71,7 @@ Given(/^I produce (#{SOME_MESSAGE}) on (#{QUEUE})/) do |message, queue|
 end
 
 Given(/^(#{A_CONSUMER}) with:$/) do |consumer_path, consumer_implementation|
-  steps %{
-    Given a raq agent file named "#{consumer_path}" with:
-    """
-    #{consumer_implementation}
-    """
-  }
+  step %{a raq agent file named "#{consumer_path}" with:},consumer_implementation
 end
 
 When(/^I run the raq agent "(.*?)"(, failing)?(, again)?$/) do |agent_run_string, failing, again|
@@ -124,4 +116,5 @@ Then(/^it should never return$/) do
       end
     end
   end.to raise_error(Timeout::Error)
+  terminate_processes!
 end

data/features/support/env.rb

@@ -35,7 +35,7 @@ module CoverageHelper
     SimpleCov.command_name(#{path.inspect})
     SimpleCov.start
     SimpleCov.root(#{File.join(File.dirname(__FILE__),'..','..').inspect})
-    }
+    } unless ENV.has_key?('ARUBA_REPORT_DIR')
   end
 end
 

data/raq.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "raq"
-  s.version = "0.1.0"
+  s.version = "0.1.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Caleb Buxton"]
-  s.date = "2013-07-04"
+  s.date = "2013-07-05"
   s.description = "The elegance of Rack with none of the unreliability of HTTP"
   s.email = "me@cpb.ca"
   s.extra_rdoc_files = [
@@ -27,6 +27,7 @@ Gem::Specification.new do |s|
     "README.md",
     "Rakefile",
     "VERSION",
+    "features/README.md.feature",
     "features/raq.feature",
     "features/step_definitions/raq_steps.rb",
     "features/support/env.rb",
@@ -57,33 +58,39 @@ Gem::Specification.new do |s|
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<eventmachine>, ["~> 1.0"])
       s.add_runtime_dependency(%q<amqp>, ["~> 1.0"])
+      s.add_development_dependency(%q<bcat>, ["~> 0.6.2"])
       s.add_development_dependency(%q<bundler>, ["~> 1.3.0"])
       s.add_development_dependency(%q<guard>, ["~> 1.8.0"])
       s.add_development_dependency(%q<guard-cucumber>, ["~> 1.4.0"])
       s.add_development_dependency(%q<guard-rspec>, ["~> 3.0.2"])
       s.add_development_dependency(%q<pry>, ["~> 0.9.12"])
-      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<rdoc>, ["~> 4.0.0"])
+      s.add_development_dependency(%q<rdiscount>, ["~> 2.1.6"])
       s.add_development_dependency(%q<travis-lint>, ["~> 1.7.0"])
     else
       s.add_dependency(%q<eventmachine>, ["~> 1.0"])
       s.add_dependency(%q<amqp>, ["~> 1.0"])
+      s.add_dependency(%q<bcat>, ["~> 0.6.2"])
       s.add_dependency(%q<bundler>, ["~> 1.3.0"])
       s.add_dependency(%q<guard>, ["~> 1.8.0"])
       s.add_dependency(%q<guard-cucumber>, ["~> 1.4.0"])
       s.add_dependency(%q<guard-rspec>, ["~> 3.0.2"])
       s.add_dependency(%q<pry>, ["~> 0.9.12"])
-      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<rdoc>, ["~> 4.0.0"])
+      s.add_dependency(%q<rdiscount>, ["~> 2.1.6"])
       s.add_dependency(%q<travis-lint>, ["~> 1.7.0"])
     end
   else
     s.add_dependency(%q<eventmachine>, ["~> 1.0"])
     s.add_dependency(%q<amqp>, ["~> 1.0"])
+    s.add_dependency(%q<bcat>, ["~> 0.6.2"])
     s.add_dependency(%q<bundler>, ["~> 1.3.0"])
     s.add_dependency(%q<guard>, ["~> 1.8.0"])
     s.add_dependency(%q<guard-cucumber>, ["~> 1.4.0"])
     s.add_dependency(%q<guard-rspec>, ["~> 3.0.2"])
     s.add_dependency(%q<pry>, ["~> 0.9.12"])
-    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<rdoc>, ["~> 4.0.0"])
+    s.add_dependency(%q<rdiscount>, ["~> 2.1.6"])
     s.add_dependency(%q<travis-lint>, ["~> 1.7.0"])
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: raq
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-04 00:00:00.000000000 Z
+date: 2013-07-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eventmachine
@@ -43,6 +43,22 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bcat
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.2
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -130,7 +146,23 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: 4.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: rdiscount
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.1.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -138,7 +170,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: 2.1.6
 - !ruby/object:Gem::Dependency
   name: travis-lint
   requirement: !ruby/object:Gem::Requirement
@@ -173,6 +205,7 @@ files:
 - README.md
 - Rakefile
 - VERSION
+- features/README.md.feature
 - features/raq.feature
 - features/step_definitions/raq_steps.rb
 - features/support/env.rb
@@ -205,7 +238,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 705315900894353883
+      hash: -107125167469032534
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: