songkick_queue 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a6dc1bf4e0b25fb8f6ed6bb49a7423a4c52649ad
-  data.tar.gz: 93d50d6793741d2f61c1a0be13408b116bdbcc22
+  metadata.gz: 1a1aac7777298d72bae853264f21dc552edc3dad
+  data.tar.gz: 90d45ace00562b8b6d5db8d0d33ec1c2cfca509d
 SHA512:
-  metadata.gz: e174cceaeee589c2ddaa3e9573dea75f0f7a971ad2f3d47365795e7123a832ebfbe5bba8d1e2ab14640c07b2dbb7052d0ce9ca88115ef5425ce06fc9b3d137f3
-  data.tar.gz: c3f9ff40394a52f35f91d1dee21e7ba89b33d98edb1d6da8ccc29fc08d5e9f6e77954a26cbed5fd51ec527d47155fc011087a0ca6e3a3249cdb14abab32453e5
+  metadata.gz: 1abc17c28cf1d98fad5900a7d76c5a5644f436d2257b8a895e2f8243ac816368dbad85cbacf14dc3c1d257ab5b4cc2f7b8e67af2ada6299d14ee9365cb4ee33f
+  data.tar.gz: 460e390e2dd5f4cf78c067ee7b22a647c884f0b8f3927e10fee635016bd39195092863308eaeef3bfc08822c650298c9b06c3371ac40009fc4637a49cde30625

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+# Changelog
+
+## 0.2.0
+### Added
+- Configuration option: `queue_namespace` to namespace queue names when
+producing and consuming messages
+
+## 0.1.0
+### Added
+- Initial project release

data/lib/songkick_queue.rb

@@ -1,4 +1,5 @@
 require 'json'
+require 'securerandom'
 require 'bunny'
 
 require 'songkick_queue/version'
@@ -28,10 +29,9 @@ module SongkickQueue
 
   # Publishes the given message to the given queue
   #
-  # @param queue_name [String] to publish to
-  # @param message [#to_json] to serialize and enqueue
-  def self.publish(queue_name, message)
-    producer.publish(queue_name, message)
+  # @see SongkickQueue::Producer#publish for argument documentation
+  def self.publish(queue_name, message, options = {})
+    producer.publish(queue_name, message, options = {})
   end
 
   private

data/lib/songkick_queue/producer.rb

@@ -9,16 +9,27 @@ module SongkickQueue
     #
     # @param queue_name [String] to publish to
     # @param message [#to_json] to serialize and enqueue
-    def publish(queue_name, message)
-      payload = JSON.generate(message)
+    # @option options [String] :message_id to pass through to the consumer (will be logged)
+    # @option options [String] :produced_at time when the message was created, ISO8601 formatted
+    def publish(queue_name, payload, options = {})
+      message_id = options.fetch(:message_id) { SecureRandom.hex(6) }
+      produced_at = options.fetch(:produced_at) { Time.now.utc.iso8601 }
+
+      message = {
+        message_id: message_id,
+        produced_at: produced_at,
+        payload: payload
+      }
+
+      message = JSON.generate(message)
 
       routing_key = [config.queue_namespace, queue_name].compact.join('.')
 
       client
         .default_exchange
-        .publish(payload, routing_key: routing_key)
+        .publish(message, routing_key: routing_key)
 
-      logger.info "Published message to #{routing_key}"
+      logger.info "Published message #{message_id} to '#{routing_key}' at #{produced_at}"
     end
 
     private

data/lib/songkick_queue/version.rb

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

data/lib/songkick_queue/worker.rb

@@ -67,8 +67,8 @@ module SongkickQueue
       queue = channel.queue(consumer_class.queue_name, durable: true,
         arguments: { 'x-ha-policy' => 'all' })
 
-      queue.subscribe(manual_ack: true) do |delivery_info, properties, payload|
-        process_message(consumer_class, delivery_info, properties, payload)
+      queue.subscribe(manual_ack: true) do |delivery_info, properties, message|
+        process_message(consumer_class, delivery_info, properties, message)
       end
 
       logger.info "Subscribed #{consumer_class} to #{consumer_class.queue_name}"
@@ -79,16 +79,19 @@ module SongkickQueue
     # @param consumer_class [Class] that was subscribed to
     # @param delivery_info [Bunny::DeliveryInfo]
     # @param properties [Bunny::MessageProperties]
-    # @param payload [String] to deserialize
-    def process_message(consumer_class, delivery_info, properties, payload)
-      logger.info "Processing message via #{consumer_class}..."
+    # @param message [String] to deserialize
+    def process_message(consumer_class, delivery_info, properties, message)
+      message = JSON.parse(message, symbolize_names: true)
 
-      set_process_name(consumer_class)
+      # Handle both old and new format of messages
+      # TODO: Tidy this up once messages always have a payload
+      payload = message.fetch(:payload, message)
 
-      message = JSON.parse(payload, symbolize_names: true)
+      logger.info "Processing message via #{consumer_class}..."
+      set_process_name(consumer_class)
 
       consumer = consumer_class.new(delivery_info, logger)
-      consumer.process(message)
+      consumer.process(payload)
     rescue Object => exception
       logger.error(exception)
     ensure
@@ -115,14 +118,13 @@ module SongkickQueue
     #
     # @example idle
     #   set_process_name #=> "songkick_queue[idle]"
-    # @example consumer running
-    #   set_process_name(TweetConsumer) #=> "songkick_queue[tweet_consumer]"
+    # @example consumer running, namespace is removed
+    #   set_process_name(Foo::TweetConsumer) #=> "songkick_queue[TweetConsumer]"
     # @param status [String] of the program
     def set_process_name(status = 'idle')
       formatted_status = String(status)
-        .gsub('::', '')
-        .gsub(/([A-Z]+)/) { "_#{$1.downcase}" }
-        .sub(/^_(\w)/) { $1 }
+        .split('::')
+        .last
 
       $PROGRAM_NAME = "#{process_name}[#{formatted_status}]"
     end

data/spec/songkick_queue/producer_spec.rb

@@ -14,11 +14,14 @@ module SongkickQueue
         allow(producer).to receive(:logger) { logger }
 
         expect(exchange).to receive(:publish)
-          .with('{"example":"message","value":true}', routing_key: 'queue_name')
+          .with('{"message_id":"92c583bdc248","produced_at":"2015-03-30T15:41:55Z",' +
+            '"payload":{"example":"message","value":true}}', routing_key: 'queue_name')
 
-        expect(logger).to receive(:info).with('Published message to queue_name')
+        expect(logger).to receive(:info)
+          .with("Published message 92c583bdc248 to 'queue_name' at 2015-03-30T15:41:55Z")
 
-        producer.publish(:queue_name, { example: 'message', value: true })
+        producer.publish(:queue_name, { example: 'message', value: true },
+          message_id: '92c583bdc248', produced_at: '2015-03-30T15:41:55Z')
       end
 
       it "should publish with a routing key using the configured queue namespace" do
@@ -32,13 +35,16 @@ module SongkickQueue
         allow(producer).to receive(:logger) { logger }
 
         expect(exchange).to receive(:publish)
-          .with('{"example":"message","value":true}', routing_key: 'test-env.queue_name')
+          .with('{"message_id":"92c583bdc248","produced_at":"2015-03-30T15:41:55Z",' +
+            '"payload":{"example":"message","value":true}}', routing_key: 'test-env.queue_name')
 
-        expect(logger).to receive(:info).with('Published message to test-env.queue_name')
+        expect(logger).to receive(:info)
+          .with("Published message 92c583bdc248 to 'test-env.queue_name' at 2015-03-30T15:41:55Z")
 
         allow(producer).to receive(:config) { double(queue_namespace: 'test-env') }
 
-        producer.publish(:queue_name, { example: 'message', value: true })
+        producer.publish(:queue_name, { example: 'message', value: true },
+          message_id: '92c583bdc248', produced_at: '2015-03-30T15:41:55Z')
       end
     end
   end

data/spec/songkick_queue/worker_spec.rb

@@ -93,6 +93,36 @@ module SongkickQueue
 
         expect(channel).to have_received(:ack).with('tag', false)
       end
+
+      it "should handle new message format with nested payload" do
+        ::BarConsumer = Class.new
+        worker = Worker.new(:process_name, BarConsumer)
+
+        logger = double(:logger, info: :null)
+        allow(worker).to receive(:logger) { logger }
+
+        channel = double(:channel, ack: :null)
+        allow(worker).to receive(:channel) { channel }
+
+        delivery_info = double(:delivery_info, delivery_tag: 'tag')
+
+        consumer = double(BarConsumer, process: :null)
+
+        expect(BarConsumer).to receive(:new)
+          .with(delivery_info, logger) { consumer }
+
+        expect(consumer).to receive(:process)
+          .with({ example: 'message', value: true})
+
+        worker.send(:process_message, BarConsumer, delivery_info, :properties,
+          '{"message_id":"92c583bdc248","produced_at":"2015-03-30T15:41:55Z",' +
+          '"payload":{"example":"message","value":true}}')
+
+        expect(logger).to have_received(:info)
+          .with('Processing message via BarConsumer...')
+
+        expect(channel).to have_received(:ack).with('tag', false)
+      end
     end
   end
 end

data/spec/songkick_queue_spec.rb

@@ -14,7 +14,7 @@ RSpec.describe SongkickQueue do
       producer = instance_double(SongkickQueue::Producer)
       allow(SongkickQueue).to receive(:producer) { producer }
 
-      expect(producer).to receive(:publish).with(:queue_name, :message)
+      expect(producer).to receive(:publish).with(:queue_name, :message, {})
 
       SongkickQueue.publish(:queue_name, :message)
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: songkick_queue
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Dan Lucraft
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-27 00:00:00.000000000 Z
+date: 2015-03-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -94,6 +94,7 @@ files:
 - .rspec
 - .travis.yml
 - .yardopts
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md