songkick_queue 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1a1aac7777298d72bae853264f21dc552edc3dad
-  data.tar.gz: 90d45ace00562b8b6d5db8d0d33ec1c2cfca509d
+  metadata.gz: 75d2f489f41e935f1c16ef27861a7d9044472eb5
+  data.tar.gz: d154004c62f76f7a99cff3841fbccaf863930c8e
 SHA512:
-  metadata.gz: 1abc17c28cf1d98fad5900a7d76c5a5644f436d2257b8a895e2f8243ac816368dbad85cbacf14dc3c1d257ab5b4cc2f7b8e67af2ada6299d14ee9365cb4ee33f
-  data.tar.gz: 460e390e2dd5f4cf78c067ee7b22a647c884f0b8f3927e10fee635016bd39195092863308eaeef3bfc08822c650298c9b06c3371ac40009fc4637a49cde30625
+  metadata.gz: 815d1add90cd8a2d5adc0922babfb3de115d098ee0d86f45d77fc6c92b1e996da766c8ecb244cd22939976581dcb70490d493cec53b433b18dbd6d115334570d
+  data.tar.gz: 19f0a0f9f4a7dc0f145df5b21f6a96e0fa5ddf1c8e1194fb6810a40878f7e990847fcd3220e5d097d74d6fb3ca7ce37ca4e45281ca9bdd67ef76f12b592e32a6

data/README.md

@@ -8,7 +8,7 @@ A gem for processing tasks asynchronously, powered by RabbitMQ.
 ## Dependencies
 
 * Ruby 2.0+
-* RabbitMQ ~v2.8
+* RabbitMQ 3.3+
 
 ## Installation
 
@@ -30,19 +30,22 @@ Or install it yourself as:
 
 ### Setup
 
-You must define both the AMQP URL and a logger instance:
+Configure a logger and your AMQP connection settings as follows. The values defined below are the defaults:
 
 ```ruby
 SongkickQueue.configure do |config|
-  config.amqp = 'amqp://localhost:5672'    # required
-  config.logger = Logger.new(STDOUT)       # required
-  config.queue_namespace = ENV['RACK_ENV'] # optional
+  config.logger = Logger.new(STDOUT)
+  config.host = '127.0.0.1'
+  config.port = 5672
+  config.username = 'guest'
+  config.password = 'guest'
+  config.vhost = '/'
 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.
+SongkickQueue should work out the box with a new, locally installed RabbitMQ instance.
+
+NB. The `vhost` option can be a useful way to isolate environments that share the same RabbitMQ instance (eg. staging and production).
 
 ### Creating consumers
 

data/examples/environment.rb

@@ -6,7 +6,7 @@
 require_relative '../lib/songkick_queue'
 
 SongkickQueue.configure do |config|
-  config.amqp = 'amqp://localhost:5672'
+  config.host = 'localhost'
   config.logger = Logger.new(STDOUT)
 end
 

data/examples/producer.rb

@@ -1,7 +1,7 @@
 require_relative '../lib/songkick_queue'
 
 SongkickQueue.configure do |config|
-  config.amqp = 'amqp://localhost:5672'
+  config.host = 'localhost'
   config.logger = Logger.new(STDOUT)
 end
 

data/lib/songkick_queue.rb

@@ -1,5 +1,6 @@
 require 'json'
 require 'securerandom'
+require 'logger'
 require 'bunny'
 
 require 'songkick_queue/version'
@@ -10,14 +11,25 @@ require 'songkick_queue/worker'
 require 'songkick_queue/cli'
 
 module SongkickQueue
-  Configuration = Struct.new(:amqp, :logger, :queue_namespace)
+  Configuration = Struct.new(
+    :logger,
+    :host,
+    :port,
+    :username,
+    :password,
+    :vhost,
+  )
+
   ConfigurationError = Class.new(StandardError)
 
   # Retrieve configuration for SongkickQueue
   #
   # @return [Configuration]
   def self.configuration
-    @configuration ||= Configuration.new
+    @configuration ||= Configuration.new(
+      logger: Logger.new(STDOUT),
+      port: 5672,
+    )
   end
 
   # Yields a block, passing the memoized configuration instance
@@ -25,6 +37,8 @@ module SongkickQueue
   # @yield [Configuration]
   def self.configure
     yield(configuration)
+
+    configuration
   end
 
   # Publishes the given message to the given queue

data/lib/songkick_queue/client.rb

@@ -21,7 +21,15 @@ module SongkickQueue
     # @return [Bunny::Session]
     def connection
       @connection ||= begin
-        connection = Bunny.new(config_amqp)
+        connection = Bunny.new(
+          host: config.host,
+          port: config.port,
+          username: config.username,
+          password: config.password,
+          vhost: config.vhost,
+          heartbeat_interval: 60,
+        )
+
         connection.start
 
         connection
@@ -30,13 +38,6 @@ module SongkickQueue
 
     private
 
-    # Retrieve the AMQP URL from the configuration
-    #
-    # @raise [ConfigurationError] if not defined
-    def config_amqp
-      config.amqp || fail(ConfigurationError, 'missing AMQP URL from config')
-    end
-
     def config
       SongkickQueue.configuration
     end

data/lib/songkick_queue/consumer.rb

@@ -16,8 +16,6 @@ module SongkickQueue
       def queue_name
         @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

data/lib/songkick_queue/producer.rb

@@ -23,13 +23,11 @@ module SongkickQueue
 
       message = JSON.generate(message)
 
-      routing_key = [config.queue_namespace, queue_name].compact.join('.')
-
       client
         .default_exchange
-        .publish(message, routing_key: routing_key)
+        .publish(message, routing_key: String(queue_name))
 
-      logger.info "Published message #{message_id} to '#{routing_key}' at #{produced_at}"
+      logger.info "Published message #{message_id} to '#{queue_name}' at #{produced_at}"
     end
 
     private

data/lib/songkick_queue/version.rb

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

data/songkick_queue.gemspec

@@ -25,5 +25,5 @@ Gem::Specification.new do |spec|
   # Used by yardoc for processing README.md code snippets
   spec.add_development_dependency "redcarpet"
 
-  spec.add_dependency "bunny", "~> 1.2.1"
+  spec.add_dependency "bunny", ">= 1.7.0"
 end

data/spec/songkick_queue/consumer_spec.rb

@@ -20,18 +20,6 @@ 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

@@ -23,29 +23,6 @@ module SongkickQueue
         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
-        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('{"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 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 },
-          message_id: '92c583bdc248', produced_at: '2015-03-30T15:41:55Z')
-      end
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: songkick_queue
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Dan Lucraft
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-31 00:00:00.000000000 Z
+date: 2015-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -71,16 +71,16 @@ dependencies:
   name: bunny
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: 1.2.1
+        version: 1.7.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: 1.2.1
+        version: 1.7.0
 description: A gem for processing tasks asynchronously, powered by RabbitMQ.
 email:
 - dan.lucraft@songkick.com