songkick_queue 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e8a5f871097112612e6bc9bc581afe8f7a1dcced
-  data.tar.gz: 983110a1e0eb96ea33c88584ba9bdeb198365acf
+  metadata.gz: a6dc1bf4e0b25fb8f6ed6bb49a7423a4c52649ad
+  data.tar.gz: 93d50d6793741d2f61c1a0be13408b116bdbcc22
 SHA512:
-  metadata.gz: 0a78a279786c3ea6b30cb35e4b667a8dfa3d4c661bd930e2802c8ec0f2666e447ec38c00e567358cf45e960e377f8a1b5dd0d007f9bbd119db92e4443d6a6d04
-  data.tar.gz: 1bd3ae7c10e1c9913817aeaa06e3816c53911b1dd296549c234ac2668613e08ff298272fe844f0fbda99d720d2f3996b4ee4b85729ba923b44d77cd30d678f09
+  metadata.gz: e174cceaeee589c2ddaa3e9573dea75f0f7a971ad2f3d47365795e7123a832ebfbe5bba8d1e2ab14640c07b2dbb7052d0ce9ca88115ef5425ce06fc9b3d137f3
+  data.tar.gz: c3f9ff40394a52f35f91d1dee21e7ba89b33d98edb1d6da8ccc29fc08d5e9f6e77954a26cbed5fd51ec527d47155fc011087a0ca6e3a3249cdb14abab32453e5

data/README.md

@@ -2,6 +2,7 @@
 
 A gem for processing tasks asynchronously, powered by RabbitMQ.
 
+[![Rubygems](https://badge.fury.io/rb/songkick_queue.svg)](https://rubygems.org/gems/songkick_queue)
 [![Build status](https://travis-ci.org/songkick/queue.svg?branch=master)](https://travis-ci.org/songkick/queue)
 
 ## Dependencies
@@ -33,18 +34,23 @@ You must define both the AMQP URL and a logger instance:
 
 ```ruby
 SongkickQueue.configure do |config|
-  config.amqp = 'amqp://localhost:5672'
-  config.logger = Logger.new(STDOUT)
+  config.amqp = 'amqp://localhost:5672'    # required
+  config.logger = Logger.new(STDOUT)       # required
+  config.queue_namespace = ENV['RACK_ENV'] # optional
 end
 ```
 
+You can also optionally define a namespace to apply to your queue names automatically when
+publishing and consuming. This can be useful to isolate environments that share the same RabbitMQ
+instance.
+
 ### Creating consumers
 
 To create a consumer simply construct a new class and include the `SongkickQueue::Consumer`
 module.
 
 Consumers must declare a queue name to consume from (by calling `consume_from_queue`) and
-and define a `#process` method which receives a message.
+define a `#process` method which receives a message.
 
 For example:
 
@@ -104,10 +110,10 @@ NB. The `songkick_queue` process does not daemonize. We recommend running it usi
 To publish messages for consumers, call the `#publish` method on `SongkickQueue`, passing in the
 name of the queue to publish to and the message to send.
 
-The queue name must match one declared in a consumer by calling `consume_from_queue`.
+The queue name must match one declared by `consume_from_queue` in a consumer.
 
 The message can be any primitive Ruby object that can be serialized into JSON. Messages are
-serialized whilst enqueued and deserialized for being passed to the `#process` method in your
+serialized whilst enqueued and deserialized before being passed to the `#process` method in your
 consumer.
 
 ```ruby

data/lib/songkick_queue.rb

@@ -9,7 +9,7 @@ require 'songkick_queue/worker'
 require 'songkick_queue/cli'
 
 module SongkickQueue
-  Configuration = Struct.new(:amqp, :logger)
+  Configuration = Struct.new(:amqp, :logger, :queue_namespace)
   ConfigurationError = Class.new(StandardError)
 
   # Retrieve configuration for SongkickQueue

data/lib/songkick_queue/consumer.rb

@@ -14,8 +14,14 @@ module SongkickQueue
       #
       # @raise [NotImplementedError] if queue name was not already defined
       def queue_name
-        @queue_name || fail(NotImplementedError, 'you must declare a queue name to consume from ' +
+        @queue_name or fail(NotImplementedError, 'you must declare a queue name to consume from ' +
           'by calling #consume_from_queue in your consumer class. See README for more info.')
+
+        [config.queue_namespace, @queue_name].compact.join('.')
+      end
+
+      def config
+        SongkickQueue.configuration
       end
     end
 

data/lib/songkick_queue/producer.rb

@@ -12,13 +12,28 @@ module SongkickQueue
     def publish(queue_name, message)
       payload = JSON.generate(message)
 
+      routing_key = [config.queue_namespace, queue_name].compact.join('.')
+
       client
         .default_exchange
-        .publish(payload, routing_key: String(queue_name))
+        .publish(payload, routing_key: routing_key)
+
+      logger.info "Published message to #{routing_key}"
     end
 
     private
 
+    # Retrieve the logger defined in the configuration
+    #
+    # @raise [ConfigurationError] if not defined
+    def logger
+      config.logger || fail(ConfigurationError, 'No logger configured, see README for more details')
+    end
+
+    def config
+      SongkickQueue.configuration
+    end
+
     attr_reader :client
   end
 end

data/lib/songkick_queue/version.rb

@@ -1,3 +1,3 @@
 module SongkickQueue
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/songkick_queue/worker.rb

@@ -65,7 +65,7 @@ module SongkickQueue
     # @param consumer_class [Class] to subscribe to
     def subscribe_to_queue(consumer_class)
       queue = channel.queue(consumer_class.queue_name, durable: true,
-        arguments: {'x-ha-policy' => 'all'})
+        arguments: { 'x-ha-policy' => 'all' })
 
       queue.subscribe(manual_ack: true) do |delivery_info, properties, payload|
         process_message(consumer_class, delivery_info, properties, payload)

data/spec/songkick_queue/consumer_spec.rb

@@ -20,6 +20,18 @@ module SongkickQueue
 
         expect(ExampleConsumer.queue_name).to eq 'app.examples'
       end
+
+      it "should add the configured namespace to the queue name" do
+        class ExampleConsumer
+          include SongkickQueue::Consumer
+
+          consume_from_queue 'app.examples'
+        end
+
+        allow(ExampleConsumer).to receive(:config) { double(queue_namespace: 'test-env') }
+
+        expect(ExampleConsumer.queue_name).to eq 'test-env.app.examples'
+      end
     end
 
     describe "#initialize" do

data/spec/songkick_queue/producer_spec.rb

@@ -10,9 +10,34 @@ module SongkickQueue
         client = instance_double(Client, default_exchange: exchange)
         allow(producer).to receive(:client) { client }
 
+        logger = double(:logger, info: true)
+        allow(producer).to receive(:logger) { logger }
+
         expect(exchange).to receive(:publish)
           .with('{"example":"message","value":true}', routing_key: 'queue_name')
 
+        expect(logger).to receive(:info).with('Published message to queue_name')
+
+        producer.publish(:queue_name, { example: 'message', value: true })
+      end
+
+      it "should publish with a routing key using the configured queue namespace" do
+        producer = Producer.new
+
+        exchange = double(:exchange, publish: :published)
+        client = instance_double(Client, default_exchange: exchange)
+        allow(producer).to receive(:client) { client }
+
+        logger = double(:logger, info: true)
+        allow(producer).to receive(:logger) { logger }
+
+        expect(exchange).to receive(:publish)
+          .with('{"example":"message","value":true}', routing_key: 'test-env.queue_name')
+
+        expect(logger).to receive(:info).with('Published message to test-env.queue_name')
+
+        allow(producer).to receive(:config) { double(queue_namespace: 'test-env') }
+
         producer.publish(:queue_name, { example: 'message', value: true })
       end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: songkick_queue
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Dan Lucraft
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-25 00:00:00.000000000 Z
+date: 2015-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake