message-driver 0.1.0

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+.rvmrc
+.ruby-version
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.adapter_under_test

data/.rbenv-version

@@ -0,0 +1 @@
+1.9.3-p327

data/.relish

@@ -0,0 +1,2 @@
+---
+project: message-driver/message-driver

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.travis.yml

@@ -0,0 +1,23 @@
+language: ruby
+bundler_args: --without tools darwin
+services:
+  - rabbitmq
+before_script:
+  - sudo rabbitmqctl add_vhost message-driver-test
+  - sudo rabbitmqctl set_permissions -p message-driver-test guest ".*" ".*" ".*"
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0
+  - jruby-19mode
+  - ruby-head
+  - jruby-head
+  - rbx-19mode
+env:
+  - ADAPTER=in_memory
+  - ADAPTER=bunny
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: jruby-head
+    - rvm: rbx-19mode

data/CHANGELOG.md

@@ -0,0 +1,17 @@
+# Change Log
+
+## 0.1.0
+
+Initial Release
+
+* Features
+    * Publish a message
+    * Broker transactions for publishing
+    * Pop a message
+    * named and dynamic destinations
+    * message_count for destinations
+* Adapters
+    * InMemory
+        * #reset_after_test method for clearing out queues
+    * Bunny (amqp 0.9)
+        * handle connection and channel errors transparently

data/Gemfile

@@ -0,0 +1,20 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in message-driver.gemspec
+gemspec
+
+group :tools do
+  gem 'guard'
+  gem 'guard-bundler'
+  gem 'guard-rspec'
+  gem 'guard-cucumber'
+  gem 'pry'
+  platform :ruby do
+    gem 'pry-debugger'
+  end
+  group :darwin do
+    gem 'ruby_gntp'
+    gem 'rb-fsevent'
+    gem 'relish'
+  end
+end

data/Guardfile

@@ -0,0 +1,39 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+require File.join(File.dirname(__FILE__), 'test_lib', 'broker_config')
+
+guard 'bundler' do
+  watch('Gemfile')
+  watch(/^.+\.gemspec/)
+end
+
+unit_spec_opts = {spec_paths: ["spec/units"], cli: '-f doc', run_all: {cli: ''}}
+acceptance_spec_opts = {spec_paths: ["spec/integration"], cli: '-f doc -t all_adapters', run_all: {cli: '-t all_adapters'}}
+
+group 'specs' do
+  guard 'rspec', unit_spec_opts do
+    watch(%r{^spec/units/.+_spec\.rb$})
+    watch(%r{^lib/(.+)\.rb$})          { |m| "spec/units/#{m[1]}_spec.rb" }
+    watch(%r{^spec/support/(.+)\.rb$}) { "spec" }
+    watch('spec/spec_helper.rb')       { "spec" }
+  end
+end
+
+group 'integration' do
+  guard 'rspec', acceptance_spec_opts do
+    watch(%r{^spec/integration/.+_spec\.rb$})
+    watch(%r{^lib/(.+)\.rb$})          { |m| "spec/integration/#{m[1]}_spec.rb" }
+    watch(%r{^spec/support/(.+)\.rb$}) { "spec" }
+    watch('spec/spec_helper.rb')       { "spec" }
+  end
+
+  cucumber_cli = "--no-profile --color --format progress --strict --tag @all_adapters,@#{BrokerConfig.current_adapter} --tag ~@wip"
+  guard 'cucumber', change_format: 'pretty', cli: cucumber_cli do
+    watch(%r{^features/.+\.feature$})
+    watch(%r{^features/support/.+$})          { 'features' }
+    watch(%r{^features/step_definitions/(.+)_steps\.rb$}) { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'features' }
+  end
+end
+
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Matt Campbell
+
+MIT License
+
+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,36 @@
+# Message::Driver
+
+Easy message queues for ruby
+
+[![Build Status](https://travis-ci.org/soupmatt/message-driver.png?branch=master)](https://travis-ci.org/soupmatt/message-driver)
+
+[![Dependency Status](https://gemnasium.com/soupmatt/message-driver.png)](https://gemnasium.com/soupmatt/message-driver)
+
+[![Code Climate](https://codeclimate.com/github/soupmatt/message-driver.png)](https://codeclimate.com/github/soupmatt/message-driver)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'message-driver'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install message-driver
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Write your code with tests
+4. Commit your changes (`git commit -am 'Add some feature'`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create new Pull Request

data/Rakefile

@@ -0,0 +1,23 @@
+require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+require 'cucumber/rake/task'
+
+require File.join(File.dirname(__FILE__), 'test_lib', 'broker_config')
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.pattern = "./spec/units{,/*/**}/*_spec.rb"
+end
+
+RSpec::Core::RakeTask.new(:integrations) do |t|
+  t.rspec_opts = "--tag all_adapters"
+  t.pattern = "./spec/integration{,/*/**}/*_spec.rb"
+end
+
+cucumber_opts = "--format progress --tag @all_adapters,@#{BrokerConfig.current_adapter} --tag ~@wip"
+cucumber_opts += " --tag ~@no_travis" if ENV['TRAVIS']=='true' && ENV['ADAPTER']=='bunny'
+Cucumber::Rake::Task.new do |t|
+  t.cucumber_opts = cucumber_opts
+end
+
+task :default => [:spec, :integrations, :cucumber]

data/features/.nav

@@ -0,0 +1,12 @@
+- getting_started.md (Getting Started)
+- CHANGELOG.md (Changelog)
+- publishing_a_message.feature
+- publishing_with_transactions.feature
+- dynamic_destinations.feature
+- destination_metadata.feature
+- amqp_specific_features (AMQP-Specific Features):
+  - declaring_amqp_destinations.feature
+  - binding_amqp_destinations.feature
+  - server_named_desitnations.feature
+- error_handling.feature
+- Rails.md

data/features/CHANGELOG.md

@@ -0,0 +1,17 @@
+# Change Log
+
+## 0.1.0
+
+Initial Release
+
+* Features
+    * Publish a message
+    * Broker transactions for publishing
+    * Pop a message
+    * named and dynamic destinations
+    * message_count for destinations
+* Adapters
+    * InMemory
+        * #reset_after_test method for clearing out queues
+    * Bunny (amqp 0.9)
+        * handle connection and channel errors transparently

data/features/README.md

@@ -0,0 +1 @@
+Welcome to MessageDriver! Easy message queues for ruby.

data/features/Rails.md

@@ -0,0 +1 @@
+Instructions for getting rails going

data/features/amqp_specific_features/README.md

@@ -0,0 +1,3 @@
+Here are some extensions to the MessageDriver API that allow you to
+leverage some of the advanced features of AMQP and RabbitMQ when using
+the bunny driver.

data/features/amqp_specific_features/binding_amqp_destinations.feature

@@ -0,0 +1,50 @@
+@bunny
+Feature: Binding AMQP destinations to exchanges
+  Background:
+    Given the following broker configuration:
+    """ruby
+    MessageDriver::Broker.define do |b|
+      b.destination :direct_exchange, "amq.direct", type: :exchange
+    end
+    """
+
+  Scenario: Binding a queue to an exchange
+    When I execute the following code:
+    """ruby
+    MessageDriver::Broker.define do |b|
+      b.destination :my_queue, "my_queue", exclusive: true, bindings: [
+        {source: "amq.direct", args: {routing_key: "test_binding"}},
+        {source: "amq.direct", args: {routing_key: "spec_binding"}}
+      ]
+    end
+
+    publish(:direct_exchange, "Test Message", {}, {routing_key: "test_binding"})
+    publish(:direct_exchange, "Spec Message", {}, {routing_key: "spec_binding"})
+    """
+
+    Then I expect to find 2 messages on :my_queue with:
+      | body         |
+      | Test Message |
+      | Spec Message |
+
+  Scenario: Binding an exchange to an exchange
+    RabbitMQ's AMQP 0.9 extenstions support binding exchanges to exchanges
+
+    When I execute the following code:
+    """ruby
+    MessageDriver::Broker.define do |b|
+      b.destination :fanout, "amq.fanout", type: :exchange, bindings: [
+        {source: "amq.direct", args: {routing_key: "test_binding"}},
+        {source: "amq.direct", args: {routing_key: "spec_binding"}}
+      ]
+      b.destination :my_queue, "my_queue", exclusive: true, bindings: [{source: "amq.fanout"}]
+    end
+
+    publish(:direct_exchange, "Test Message", {}, {routing_key: "test_binding"})
+    publish(:direct_exchange, "Spec Message", {}, {routing_key: "spec_binding"})
+    """
+
+    Then I expect to find 2 messages on :my_queue with:
+      | body         |
+      | Test Message |
+      | Spec Message |

data/features/amqp_specific_features/declaring_amqp_exchanges.feature

@@ -0,0 +1,22 @@
+@bunny
+Feature: Declaring AMQP exchanges
+  If you want to create an exchange that doesn't exist on the broker, you can do so by adding
+  the "declare" option to your destination.
+
+  Background:
+    Given I am connected to the broker
+
+  Scenario: Declaring a direct exchange
+    When I execute the following code:
+    """ruby
+    MessageDriver::Broker.define do |b|
+      b.destination :my_exchange, "my_exchange", type: :exchange, declare: {type: :direct, auto_delete: true}
+      b.destination :my_queue, "my_queue", exclusive: true, bindings: [{source: "my_exchange", routing_key: "my_queue"}]
+    end
+
+    publish(:my_exchange, "Test My New Exchange", routing_key: "my_queue")
+    """
+
+    Then I expect to find 1 message on :my_queue with:
+      | body                 |
+      | Test My New Exchange |

data/features/amqp_specific_features/server_named_destinations.feature

@@ -0,0 +1,35 @@
+@bunny
+Feature: Server-Named Destinations
+  AMQP brokers allow you to create queues that are named by the server. Here's
+  how you do it with message_driver.
+
+  Background:
+    Given I am connected to the broker
+
+  Scenario: Creating a server-named queue
+    I expect my destination to have the queue name given to it by the server
+
+    When I execute the following code:
+    """ruby
+    destination = MessageDriver::Broker.dynamic_destination("", exclusive: true)
+    expect(destination.name).to_not be_empty
+    """
+
+    Then I expect to have no errors
+
+  Scenario: sending and receiving messages through a server-named queue
+    Given the following broker configuration:
+    """ruby
+    MessageDriver::Broker.define do |b|
+      b.destination :my_queue, "my_queue", exclusive: true
+    end
+    """
+
+    When I execute the following code:
+    """ruby
+    publish(:my_queue, "server-named queue message")
+    """
+
+    Then I expect to find 1 message on :my_queue with:
+      | body                       |
+      | server-named queue message |

data/features/destination_metadata.feature

@@ -0,0 +1,33 @@
+@bunny
+@in_memory
+Feature: Destination Metadata
+  Background:
+    Given the following broker configuration:
+    """ruby
+    MessageDriver::Broker.define do |b|
+      b.destination :my_queue, "my_queue", exclusive: true
+    end
+    """
+
+  Scenario: Checking the message count when the queue is empty
+    When I execute the following code:
+    """ruby
+    destination = MessageDriver::Broker.find_destination(:my_queue)
+    expect(destination.message_count).to eq(0)
+    """
+
+    Then I expect to have no errors
+    And I expect to find no messages on :my_queue
+
+  @no_travis
+  Scenario: Checking the message count when the queue has messages
+    When I execute the following code:
+    """ruby
+    publish(:my_queue, "test message 1")
+    publish(:my_queue, "test message 2")
+    destination = MessageDriver::Broker.find_destination(:my_queue)
+    expect(destination.message_count).to eq(2)
+    """
+
+    Then I expect to have no errors
+    And I expect to find 2 messages on :my_queue

data/features/dynamic_destinations.feature

@@ -0,0 +1,41 @@
+@all_adapters
+Feature: Dynamic Destinations
+  Sometime you want to connect to a queue that has some of it's characteristics
+  determined at runtime. Dynamic destinations allow you to do with without
+  leaking tons of destination definitions.
+
+  Background:
+    Given I am connected to the broker
+
+  Scenario: Sending to a dynamic destination
+    When I execute the following code:
+    """ruby
+    my_new_destination = MessageDriver::Broker.dynamic_destination("temp_queue", exclusive: true)
+    my_new_destination.publish("Test Message")
+    """
+
+    Then I expect to find 1 message on the dynamic destination "temp_queue" with:
+      | body         |
+      | Test Message |
+
+  Scenario: Poping messages off a dynamic destination
+    Given I have a dynamic destination "temp_queue" with the following messages on it:
+      | body           |
+      | Test Message 1 |
+      | Test Message 2 |
+
+    When I execute the following code:
+    """ruby
+    my_new_destination = MessageDriver::Broker.dynamic_destination("temp_queue", exclusive: true)
+
+    msg1 = my_new_destination.pop_message
+    expect(msg1.body).to eq("Test Message 1")
+
+    msg2 = my_new_destination.pop_message
+    expect(msg2.body).to eq("Test Message 2")
+
+    msg3 = my_new_destination.pop_message
+    expect(msg3).to be_nil
+    """
+
+    Then I expect to have no errors

data/features/error_handling.feature

@@ -0,0 +1,47 @@
+Feature: Error Handling
+
+  Background:
+    Given I am connected to the broker
+
+  @bunny
+  Scenario: Queue isn't found on the broker
+    When I execute the following code:
+    """ruby
+    MessageDriver::Broker.dynamic_destination("missing_queue", passive: true)
+    """
+
+    Then I expect it to raise a MessageDriver::QueueNotFound error
+
+  @no_travis
+  @bunny
+  Scenario: The broker goes down
+    Given the following broker configuration:
+    """ruby
+    MessageDriver::Broker.define do |b|
+      b.destination :my_queue, "broker_down_queue", arguments: {:'x-expires' => 10000 }
+    end
+    """
+
+    When I execute the following code:
+    """ruby
+    publish(:my_queue, "Test Message 1")
+    """
+    And the broker goes down
+    And I execute the following code:
+    """ruby
+    publish(:my_queue, "Test Message 2")
+    """
+    Then I expect it to raise a MessageDriver::ConnectionException error
+
+    When the broker comes up
+    And I execute the following code:
+    """ruby
+    publish(:my_queue, "Test Message 3")
+    """
+
+    Then I expect to have no errors
+    And I expect to find 2 messages on :my_queue with:
+      | body           |
+      | Test Message 1 |
+      | Test Message 3 |
+

data/features/getting_started.md

@@ -0,0 +1 @@
+Here's how to get started!

data/features/publishing_a_message.feature

@@ -0,0 +1,19 @@
+@all_adapters
+Feature: Publishing A Message
+  Background:
+    Given the following broker configuration:
+    """ruby
+    MessageDriver::Broker.define do |b|
+      b.destination :my_queue, "my_queue", exclusive: true
+    end
+    """
+
+  Scenario: Running within a with_message_transaction block
+    When I execute the following code:
+    """ruby
+    publish(:my_queue, "Test Message")
+    """
+
+    Then I expect to find 1 message on :my_queue with:
+      | body         |
+      | Test Message |

data/features/publishing_with_transactions.feature

@@ -0,0 +1,36 @@
+@bunny
+Feature: Publishing a Message within a Transaction
+  Background:
+    Given the following broker configuration:
+    """ruby
+    MessageDriver::Broker.define do |b|
+      b.destination :my_queue, "my_queue", exclusive: true
+    end
+    """
+
+  Scenario: The block completes successfully
+    When I execute the following code:
+    """ruby
+    with_message_transaction do
+      publish(:my_queue, "Transacted Message 1")
+      publish(:my_queue, "Transacted Message 2")
+    end
+    """
+
+    Then I expect to find 2 messages on :my_queue with:
+      | body                 |
+      | Transacted Message 1 |
+      | Transacted Message 2 |
+
+  Scenario: An error is raised inside the block
+    When I execute the following code:
+    """ruby
+    with_message_transaction do
+      publish(:my_queue, "Transacted Message 1")
+      raise "an error that causes a rollback"
+      publish(:my_queue, "Transacted Message 2")
+    end
+    """
+
+    Then I expect it to raise "an error that causes a rollback"
+    And I expect to find no messages on :my_queue

data/features/step_definitions/dynamic_destinations_steps.rb

@@ -0,0 +1,12 @@
+Given(/^I have a dynamic destination "(#{STRING_OR_SYM})" with the following messages on it:$/) do |destination, table|
+  dest = MessageDriver::Broker.dynamic_destination(destination, exclusive: true)
+  test_runner.publish_table_to_destination(dest, table)
+end
+
+Then(/^I expect to find (#{NUMBER}) messages? on the dynamic destination "(#{STRING_OR_SYM})" with:$/) do |count, destination, table|
+  expect(test_runner).to have_no_errors
+  dest = MessageDriver::Broker.dynamic_destination(destination, passive: true)
+  messages = test_runner.fetch_messages(dest)
+  expect(messages).to have(count).items
+  expect(messages).to match_message_table(table)
+end

data/features/step_definitions/error_handling_steps.rb

@@ -0,0 +1,11 @@
+When "the broker goes down" do
+  result = block_broker_port
+end
+
+When "the broker comes up" do
+  result = unblock_broker_port
+end
+
+After do
+  unblock_broker_port
+end

data/features/step_definitions/steps.rb

@@ -0,0 +1,41 @@
+Given "I am connected to the broker" do
+  MessageDriver.configure(BrokerConfig.config)
+end
+
+Given "the following broker configuration:" do |src|
+  step "I am connected to the broker"
+  test_runner.config_broker(src)
+end
+
+When "I execute the following code:" do |src|
+  test_runner.run_test_code(src)
+end
+
+Then(/^I expect to find (#{NUMBER}) messages? on (#{STRING_OR_SYM})$/) do |count, destination|
+  expect(test_runner).to have_no_errors
+  messages = test_runner.fetch_messages(destination)
+  expect(messages).to have(count).items
+end
+
+Then(/^I expect to find (#{NUMBER}) messages? on (#{STRING_OR_SYM}) with:$/) do |count, destination, table|
+  expect(test_runner).to have_no_errors
+  messages = test_runner.fetch_messages(destination)
+  expect(messages).to have(count).items
+  expect(messages).to match_message_table(table)
+end
+
+Then(/^I expect it to raise "(.*?)"$/) do |error_msg|
+  expect(test_runner.raised_error).to_not be_nil
+  expect(test_runner.raised_error.to_s).to match error_msg
+  test_runner.raised_error = nil
+end
+
+Then(/^I expect it to raise a (.*?) error$/) do |error_type|
+  expect(test_runner.raised_error).to_not be_nil
+  expect(test_runner.raised_error.class.to_s).to match error_type
+  test_runner.raised_error = nil
+end
+
+Then "I expect to have no errors" do
+  expect(test_runner).to have_no_errors
+end

data/features/support/env.rb

@@ -0,0 +1,7 @@
+require File.join(File.dirname(__FILE__), '..', '..', 'test_lib', 'broker_config')
+
+require 'message_driver'
+
+After do
+  MessageDriver.stop
+end