message-driver 0.1.0 → 0.2.0.rc1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ee1e524ed1e97823d1bf57bebb54afdd7be3d377
+  data.tar.gz: a1e55de021a74bcbf71b4df3be92e3f28506464f
+SHA512:
+  metadata.gz: aaa3bd79fe84ddb7020fbb1173824d4bd24dba54b86737712bf412f450d07bee650ea1636d411f55a7d19668a950e87d4a583ac28fd2f167814fad1ea253accb
+  data.tar.gz: b71dbc3eb07d9f75b00032ea1c8bdcf8412026cc8b51a77c257ec62b8b578d754efdbeaf7a2b5b3a46763f2723150bfd181d970756b3d7852cf01a254a205d4e

data/.gitignore

@@ -5,6 +5,7 @@
 .yardoc
 .rvmrc
 .ruby-version
+.rbenv-version
 Gemfile.lock
 InstalledFiles
 _yardoc

data/.travis.yml

@@ -5,19 +5,30 @@ services:
 before_script:
   - sudo rabbitmqctl add_vhost message-driver-test
   - sudo rabbitmqctl set_permissions -p message-driver-test guest ".*" ".*" ".*"
+  - sudo rabbitmq-plugins enable rabbitmq_stomp
+  - sudo service rabbitmq-server restart
+env:
+  - ADAPTER=in_memory
+  - ADAPTER=bunny:0.9.0
+  - ADAPTER=bunny:0.10.0
+  - ADAPTER=stomp
+  - ADAPTER=bunny:1.0.0.pre
 rvm:
-  - 1.9.2
-  - 1.9.3
   - 2.0.0
+  - 1.9.3
+  - 1.9.2
   - jruby-19mode
-  - ruby-head
   - jruby-head
   - rbx-19mode
-env:
-  - ADAPTER=in_memory
-  - ADAPTER=bunny
 matrix:
+  exclude:
+    - rvm: jruby-19mode
+      env: ADAPTER=bunny:0.9.0
+    - rvm: jruby-head
+      env: ADAPTER=bunny:0.9.0
   allow_failures:
-    - rvm: ruby-head
+    - env: ADAPTER=bunny:1.0.0.pre
     - rvm: jruby-head
     - rvm: rbx-19mode
+    - rvm: jruby-19mode
+      env: ADAPTER=stomp

data/CHANGELOG.md

@@ -1,6 +1,16 @@
-# Change Log
+# Changelog
 
-## 0.1.0
+## 0.2.0.rc1 - 2013-09-23
+
+* Features
+    * Message Consumers
+        * Bunny and InMemory adapters
+    * Client Acks
+        * Bunny adapter
+* Adapters
+    * begin work on Stomp 1.1/1.2 adapter
+
+## 0.1.0 - 2013-04-05
 
 Initial Release
 

data/Gemfile

@@ -16,5 +16,22 @@ group :tools do
     gem 'ruby_gntp'
     gem 'rb-fsevent'
     gem 'relish'
+    gem 'lunchy'
+  end
+end
+
+require File.expand_path("../test_lib/broker_config", __FILE__)
+
+adapter = BrokerConfig.current_adapter.to_s
+version = BrokerConfig.adapter_version
+
+case adapter
+when 'in_memory'
+else
+  case version
+  when nil
+    gem adapter
+  else
+    gem adapter.to_s, "~> #{version}"
   end
 end

data/Guardfile

@@ -8,8 +8,9 @@ guard 'bundler' do
   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'}}
+common_rspec_opts = {keep_failed: true, all_after_pass: true}
+unit_spec_opts = common_rspec_opts.merge({spec_paths: ["spec/units"], cli: '-f doc', run_all: {cli: ''}})
+integration_spec_opts = common_rspec_opts.merge({spec_paths: ["spec/integration/#{BrokerConfig.current_adapter}"], cli: '-f doc -t all_adapters', run_all: {cli: '-t all_adapters'}})
 
 group 'specs' do
   guard 'rspec', unit_spec_opts do
@@ -21,15 +22,18 @@ group 'specs' do
 end
 
 group 'integration' do
-  guard 'rspec', acceptance_spec_opts do
+  guard 'rspec', integration_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
+end
 
+group 'features' do
   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
+  cucumber_run_all_cli = "#{cucumber_cli} --tag ~@slow"
+  guard 'cucumber', change_format: 'pretty', all_on_start: false, cli: cucumber_cli, run_all: { cli: cucumber_run_all_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' }

data/README.md

@@ -2,11 +2,13 @@
 
 Easy message queues for ruby
 
-[![Build Status](https://travis-ci.org/soupmatt/message-driver.png?branch=master)](https://travis-ci.org/soupmatt/message-driver)
+[![Gem Version](https://badge.fury.io/rb/message-driver.png)](http://badge.fury.io/rb/message-driver)
 
-[![Dependency Status](https://gemnasium.com/soupmatt/message-driver.png)](https://gemnasium.com/soupmatt/message-driver)
+[![Build Status](https://travis-ci.org/message-driver/message-driver.png?branch=master)](https://travis-ci.org/message-driver/message-driver)
 
-[![Code Climate](https://codeclimate.com/github/soupmatt/message-driver.png)](https://codeclimate.com/github/soupmatt/message-driver)
+[![Dependency Status](https://gemnasium.com/message-driver/message-driver.png)](https://gemnasium.com/message-driver/message-driver)
+
+[![Code Climate](https://codeclimate.com/github/message-driver/message-driver.png)](https://codeclimate.com/github/message-driver/message-driver)
 
 ## Installation
 
@@ -14,6 +16,11 @@ Add this line to your application's Gemfile:
 
     gem 'message-driver'
 
+You'll also want to add a driver gem:
+
+    gem 'bunny'
+    gem 'stomp'
+
 And then execute:
 
     $ bundle
@@ -22,9 +29,11 @@ Or install it yourself as:
 
     $ gem install message-driver
 
-## Usage
+## Documentation
+
+You can find the main documentation here: https://www.relishapp.com/message-driver/message-driver
 
-TODO: Write usage instructions here
+You can also take a look at the [examples](/examples)
 
 ## Contributing
 

data/Rakefile

@@ -1,23 +1,56 @@
+require 'rubygems'
+require 'bundler/setup'
+
 require 'bundler/gem_tasks'
 
 require 'rspec/core/rake_task'
 require 'cucumber/rake/task'
 
-require File.join(File.dirname(__FILE__), 'test_lib', 'broker_config')
+#require File.join(File.dirname(__FILE__), 'test_lib', 'broker_config')
+
+namespace :spec do
+  desc "Run unit specs"
+  RSpec::Core::RakeTask.new(:units) do |t|
+    t.pattern = "./spec/units{,/*/**}/*_spec.rb"
+  end
+
+  desc "Run the integration specs"
+  RSpec::Core::RakeTask.new(:integrations) do |t|
+    t.rspec_opts = "--tag all_adapters"
+    t.pattern = "./spec/integration/#{BrokerConfig.current_adapter}{,/*/**}/*_spec.rb"
+  end
+
+  cucumber_opts = "--format progress --tag @all_adapters,@#{BrokerConfig.current_adapter} --tag ~@wip"
+  cucumber_opts += " --tag ~@no_ci" if ENV['CI']=='true' && ENV['ADAPTER'] && ENV['ADAPTER'].start_with?('bunny')
+  Cucumber::Rake::Task.new(:features) do |t|
+    t.cucumber_opts = cucumber_opts
+  end
+
+  desc "run all the specs"
+  task :all => [:units, :integrations, :features]
 
-RSpec::Core::RakeTask.new(:spec) do |t|
-  t.pattern = "./spec/units{,/*/**}/*_spec.rb"
+  desc "run all the specs for each adapter"
+  task :all_adapters do
+    current_adapter = BrokerConfig.current_adapter
+    BrokerConfig.all_adapters.each do |adapter|
+      set_adapter_under_test(adapter)
+      system("rake spec:all")
+    end
+    set_adapter_under_test(current_adapter)
+  end
 end
 
-RSpec::Core::RakeTask.new(:integrations) do |t|
-  t.rspec_opts = "--tag all_adapters"
-  t.pattern = "./spec/integration{,/*/**}/*_spec.rb"
+def set_adapter_under_test(adapter)
+  system "echo #{adapter} > #{File.join(File.dirname(__FILE__), '.adapter_under_test')}"
 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
+namespace :undertest do
+  BrokerConfig.all_adapters.each do |adapter|
+    desc "set the adapter under test to #{adapter}"
+    task adapter do
+      set_adapter_under_test(adapter)
+    end
+  end
 end
 
-task :default => [:spec, :integrations, :cucumber]
+task :default => ["spec:all"]

data/examples/basic_producer_and_consumer/Gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gem "message-driver", path: "../.."
+
+gem 'bunny'

data/examples/basic_producer_and_consumer/common.rb

@@ -0,0 +1,17 @@
+require 'bundler/setup'
+require 'message-driver'
+require 'logger'
+
+LOG = Logger.new(STDOUT)
+LOG.level = Logger::DEBUG
+
+MessageDriver.configure(
+  adapter: "bunny",
+  vhost: "message-driver-dev",
+  heartbeat_interval: 2,
+  logger: LOG
+)
+
+MessageDriver::Broker.define do |b|
+  b.destination :basic_consumer_producer, "basic.consumer.producer", durable: true
+end

data/examples/basic_producer_and_consumer/consumer.rb

@@ -0,0 +1,24 @@
+require_relative "./common"
+
+LOG.info("starting consumer")
+
+end_thread = Thread.new do
+  Thread.stop
+  LOG.info("stopping consumer")
+  MessageDriver::Broker.stop
+end
+
+ending_proc = proc do
+  end_thread.wakeup
+end
+
+trap "TERM", &ending_proc
+trap "INT", &ending_proc
+
+MessageDriver::Broker.consumer(:basic_consumer) do |message|
+  LOG.info("I got a message! #{message.body}")
+end
+
+MessageDriver::Client.subscribe(:basic_consumer_producer, :basic_consumer)
+
+end_thread.join

data/examples/basic_producer_and_consumer/producer.rb

@@ -0,0 +1,33 @@
+require_relative "./common"
+
+LOG.info("starting producer")
+
+stopping = false
+
+ending_proc = proc do
+  stopping = true
+end
+
+trap "TERM", &ending_proc
+trap "INT", &ending_proc
+
+counter = 0
+
+while !stopping do
+  10.times do
+    counter += 1
+    begin
+      MessageDriver::Client.publish(:basic_consumer_producer, "message #{counter}")
+    rescue MessageDriver::ConnectionError => e
+      LOG.info("The connection is closed! #{e}")
+      sleep 1
+      LOG.info("retrying...")
+      retry
+    end
+  end
+  LOG.info("sent 10 more messages for a total of #{counter}")
+  sleep 1
+end
+
+LOG.info("stopping producer")
+MessageDriver::Broker.stop

data/features/.nav

@@ -4,9 +4,17 @@
 - publishing_with_transactions.feature
 - dynamic_destinations.feature
 - destination_metadata.feature
+- client_acks.feature
+- logging.feature
+- message_consumers.feature
+- message_consumers
+  - auto_ack_consumers.feature
+  - manual_ack_consumers.feature
+  - transactional_ack_consumers.feature
 - amqp_specific_features (AMQP-Specific Features):
   - declaring_amqp_destinations.feature
   - binding_amqp_destinations.feature
   - server_named_desitnations.feature
+  - requeueing_on_nack.feature
 - error_handling.feature
 - Rails.md

data/features/CHANGELOG.md

@@ -1,6 +1,16 @@
-# Change Log
+# Changelog
 
-## 0.1.0
+## 0.2.0.rc1 - 2013-09-23
+
+* Features
+    * Message Consumers
+        * Bunny and InMemory adapters
+    * Client Acks
+        * Bunny adapter
+* Adapters
+    * begin work on Stomp 1.1/1.2 adapter
+
+## 0.1.0 - 2013-04-05
 
 Initial Release
 

data/features/amqp_specific_features/binding_amqp_destinations.feature

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

data/features/amqp_specific_features/declaring_amqp_exchanges.feature

@@ -7,16 +7,16 @@ Feature: Declaring AMQP exchanges
     Given I am connected to the broker
 
   Scenario: Declaring a direct exchange
-    When I execute the following code:
+    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"}]
+      b.destination :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:
+    Then I expect to find the following message on :my_queue
       | body                 |
       | Test My New Exchange |

data/features/amqp_specific_features/nack_redelivered_messages.feature

@@ -0,0 +1,92 @@
+@bunny
+Feature: Nacking Redelievered Messages from a consumer
+
+  You can configure the consumer to nack a re-delievered message. In this example, we use
+  a dead letter exchange to show how things end up working.
+
+  Background:
+    Given the following broker configuration
+    """ruby
+    MessageDriver::Broker.define do |b|
+      # declare a dead letter exchange
+      b.destination :rabbit_dlx, "rabbit.dead.letter.exchange", type: :exchange, declare: { type: :fanout }
+
+      # declare a dead letter queue and bind it to the exchange
+      b.destination :rabbit_dlq, "rabbit.dead.letter.queue", bindings: [
+        { source: "rabbit.dead.letter.exchange" }
+      ]
+
+      # declare a work queue that sends dead letters to our dead letter queue
+      b.destination :rabbit_work, "rabbit.work", arguments: { :"x-dead-letter-exchange" => "rabbit.dead.letter.exchange" }
+    end
+    """
+    And I have no messages on :rabbit_work
+    And I have no messages on :rabbit_dlq
+    And I have a destination :rabbit_track with no messages on it
+
+
+  Scenario: Raising a DontRequeueError in an auto_ack consumer
+    Given I have a message consumer
+    """ruby
+    MessageDriver::Broker.consumer(:manual_redeliver) do |message|
+      publish(:rabbit_track, "#{message.body} Attempt")
+      raise "oh nos!"
+    end
+    """
+    And I create a subscription
+    """ruby
+    MessageDriver::Client.subscribe(:rabbit_work, :manual_redeliver, ack: :auto, retry_redelivered: false)
+    """
+
+    When I send the following messages to :rabbit_work
+      | body         |
+      | Auto Retry 1 |
+      | Auto Retry 2 |
+    And I let the subscription process
+
+    Then I expect to find no messages on :rabbit_work
+    And I expect to find the following 2 messages on :rabbit_dlq
+      | body         |
+      | Auto Retry 1 |
+      | Auto Retry 2 |
+    And I expect to find the following 4 messages on :rabbit_track
+      | body                 |
+      | Auto Retry 1 Attempt |
+      | Auto Retry 2 Attempt |
+      | Auto Retry 1 Attempt |
+      | Auto Retry 2 Attempt |
+
+
+  Scenario: Raising a DontRequeueError in a transactional consumer
+    Given I have a message consumer
+    """ruby
+    @attempts = 0
+    MessageDriver::Broker.consumer(:transactional_redeliver) do |message|
+      publish(:rabbit_track, "#{message.body} Attempt")
+      @attempts += 1
+      raise "oh nos!"
+    end
+    """
+    And I create a subscription
+    """ruby
+    MessageDriver::Client.subscribe(:rabbit_work, :transactional_redeliver, ack: :transactional, retry_redelivered: false)
+    """
+
+    When I send the following messages to :rabbit_work
+      | body                      |
+      | Transactional Redeliver 1 |
+      | Transactional Redeliver 2 |
+    And I let the subscription process
+    And I restart the subscription
+    And I let the subscription process
+
+    Then I expect to find no messages on :rabbit_track
+    Then I expect to find no messages on :rabbit_work
+    Then I expect the following check to pass
+    """ruby
+    expect(@attempts).to eq(4)
+    """
+    Then I expect to find the following 2 messages on :rabbit_dlq
+      | body                      |
+      | Transactional Redeliver 1 |
+      | Transactional Redeliver 2 |

data/features/amqp_specific_features/requeueing_on_nack.feature

@@ -0,0 +1,44 @@
+@bunny
+Feature: Controlling requeue on message nack
+  You can control whether or not a message is requeued when you nack the message.
+  Exact behavior when requeue is false is specific to your broker's setup.
+
+  Background:
+    Given I am connected to the broker
+    And I have a destination :source_queue
+    And I have the following messages on :source_queue
+      | body         |
+      | Test Message |
+
+  Scenario: Requeue by default
+    When I execute the following code
+    """ruby
+    message = MessageDriver::Client.pop_message(:source_queue, client_ack: true)
+    message.nack
+    """
+
+    Then I expect to find the following message on :source_queue
+      | body         |
+      | Test Message |
+
+
+  Scenario: Requeue is true
+    When I execute the following code
+    """ruby
+    message = MessageDriver::Client.pop_message(:source_queue, client_ack: true)
+    message.nack(requeue: true)
+    """
+
+    Then I expect to find the following message on :source_queue
+      | body         |
+      | Test Message |
+
+
+  Scenario: Requeue is false
+    When I execute the following code
+    """ruby
+    message = MessageDriver::Client.pop_message(:source_queue, client_ack: true)
+    message.nack(requeue: false)
+    """
+
+    Then I expect to find no messages on :source_queue

data/features/amqp_specific_features/server_named_destinations.feature

@@ -9,7 +9,7 @@ Feature: Server-Named Destinations
   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:
+    When I execute the following code
     """ruby
     destination = MessageDriver::Broker.dynamic_destination("", exclusive: true)
     expect(destination.name).to_not be_empty
@@ -18,18 +18,18 @@ Feature: Server-Named Destinations
     Then I expect to have no errors
 
   Scenario: sending and receiving messages through a server-named queue
-    Given the following broker configuration:
+    Given the following broker configuration
     """ruby
     MessageDriver::Broker.define do |b|
-      b.destination :my_queue, "my_queue", exclusive: true
+      b.destination :my_queue, "", exclusive: true
     end
     """
 
-    When I execute the following code:
+    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:
+    Then I expect to find the following message on :my_queue
       | body                       |
       | server-named queue message |