sneakers 2.2.1 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 562f562a5bb003fdf3d00ae2a37eaf8e3201f80c
-  data.tar.gz: 922e09184bfd33fd91aac65f3ca109a98f85ad46
+  metadata.gz: 3e5b3a5d3740de3c7404234fad5dfe7286d8684a
+  data.tar.gz: fce6b1c8aedb2f0755a16be3d493205badb985a2
 SHA512:
-  metadata.gz: 5261d1b94c18d35bd051313865eec1612a74cfa1b4b5d340f942eec951f3f8fc0cf1f5f169c47ac48a57ef9bbd5aee62baffcdef8eb18741542fe64ce1beaa14
-  data.tar.gz: fbcb6831ef3fa9f5fd28a6ac12c1ef8a83e12aed46e0834a128fc43e752c6bc7f435dfc51fa5cd3307b168ca7b130bc6be0dd702738ceda8e00390d8488e9cf7
+  metadata.gz: b4f462c76d5c6a36bf1d8b2731b1329461f529c12a77604ad9e2cb5f526832ffcfc94aed16239bade4b18f89626c40fd5469e4d2295b97d38bc6df130e87c828
+  data.tar.gz: 7fd337c1fd808b6c1ec19e186b0a70879ee10f8fbb7a81ae5527a9ba5df4434468ce8a90a3532a7de0f0a6970b105a9b79aa128ccc3d9c2b04d0fa8fe376db20

data/.travis.yml

@@ -1,11 +1,15 @@
-env:
-  - INTEGRATION_LOG=1 INTEGRATION=1
 services:
   - rabbitmq
   - redis-server
 language: ruby
 rvm:
+- ruby-head
 - 2.2
 - 2.1
 - 2.0.0
+matrix:
+  include:
+    - rvm: 2.2
+      env: INTEGRATION_LOG=1 INTEGRATION=1
+
 

data/examples/benchmark_worker.rb

@@ -4,7 +4,8 @@ require 'sneakers'
 class BenchmarkWorker
   include Sneakers::Worker
   from_queue 'downloads',
-             :durable => false,
+             exchange_options: { durable: false },
+             queue_options: { durable: false },
              :ack => true,
              :threads => 50,
              :prefetch => 50,

data/examples/max_retry_handler.rb

@@ -9,9 +9,8 @@ Sneakers.configure(:handler => Sneakers::Handlers::Maxretry,
                    :threads => 1,
                    :prefetch => 1,
                    :exchange => 'sneakers',
-                   :exchange_type => 'topic',
-                   :routing_key => ['#', 'something'],
-                   :durable => true,
+                   :exchange_options => { :type => 'topic', durable: true },
+                   :routing_key => ['#', 'something']
                    )
 Sneakers.logger.level = Logger::DEBUG
 

data/examples/workflow_worker.rb

@@ -4,7 +4,8 @@ require 'sneakers'
 class WorkflowWorker
   include Sneakers::Worker
   from_queue 'downloads',
-             :durable => false,
+             exchange_options: { durable: false },
+             queue_options: { durable: false },
              :ack => true,
              :threads => 50,
              :prefetch => 50,
@@ -20,5 +21,3 @@ class WorkflowWorker
     ack!
   end
 end
-
-

data/lib/sneakers.rb

@@ -27,7 +27,6 @@ module Sneakers
   def configure(opts={})
     # worker > userland > defaults
     CONFIG.merge!(opts)
-
     setup_general_logger!
     setup_worker_concerns!
     setup_general_publisher!

data/lib/sneakers/configuration.rb

@@ -6,6 +6,20 @@ module Sneakers
     extend Forwardable
     def_delegators :@hash, :to_hash, :[], :[]=, :==, :fetch, :delete, :has_key?
 
+    EXCHANGE_OPTION_DEFAULTS = {
+      :type               => :direct,
+      :durable            => true,
+      :auto_delete        => false,
+      :arguments => {} # Passed as :arguments to Bunny::Channel#exchange
+    }.freeze
+
+    QUEUE_OPTION_DEFAULTS = {
+      :durable            => true,
+      :auto_delete        => false,
+      :exclusive          => false,
+      :arguments => {}
+    }.freeze
+
     DEFAULTS = {
       # runner
       :runner_config_file => nil,
@@ -22,13 +36,12 @@ module Sneakers
       :prefetch           => 10,
       :threads            => 10,
       :share_threads      => false,
-      :durable            => true,
       :ack                => true,
       :heartbeat          => 2,
+      :hooks              => {},
       :exchange           => 'sneakers',
-      :exchange_type      => :direct,
-      :exchange_arguments => {}, # Passed as :arguments to Bunny::Channel#exchange
-      :hooks              => {}
+      :exchange_options   => EXCHANGE_OPTION_DEFAULTS,
+      :queue_options      => QUEUE_OPTION_DEFAULTS
     }.freeze
 
 
@@ -44,6 +57,9 @@ module Sneakers
 
     def merge!(hash)
       hash = hash.dup
+      hash = map_deprecated_exchange_options_key(hash, :exchange_type, :type)
+      hash = map_deprecated_exchange_options_key(hash, :exchange_arguments, :arguments)
+      hash = map_deprecated_exchange_options_key(hash, :durable, :durable)
 
       # parse vhost from amqp if vhost is not specified explicitly, only
       # if we're not given a connection to use.
@@ -62,7 +78,7 @@ module Sneakers
         end
       end
 
-      @hash.merge!(hash)
+      @hash = deep_merge(@hash, hash)
     end
 
     def merge(hash)
@@ -82,5 +98,18 @@ module Sneakers
     end
     alias_method :inspect_without_redaction, :inspect
     alias_method :inspect, :inspect_with_redaction
+
+    def map_deprecated_exchange_options_key(hash = {}, deprecated_key, key)
+      return hash if hash[deprecated_key].nil?
+      hash = deep_merge({ exchange_options: { key => hash[deprecated_key] } }, hash)
+      hash = deep_merge({ queue_options: { key => hash[deprecated_key] } }, hash) if deprecated_key == :durable
+      hash.delete(deprecated_key)
+      hash
+    end
+
+    def deep_merge(first, second)
+      merger = proc { |key, v1, v2| Hash === v1 && Hash === v2 ? v1.merge(v2, &merger) : v2 }
+      first.merge(second, &merger)
+    end
   end
 end

data/lib/sneakers/publisher.rb

@@ -20,15 +20,22 @@ module Sneakers
 
   private
     def ensure_connection!
-      @bunny = Bunny.new(@opts[:amqp], heartbeat: @opts[:heartbeat], vhost: @opts[:vhost], :logger => Sneakers::logger)
+      # If we've already got a bunny object, use it.  This allows people to
+      # specify all kinds of options we don't need to know about (e.g. for ssl).
+      @bunny = @opts[:connection]
+      @bunny ||= create_bunny_connection
       @bunny.start
       @channel = @bunny.create_channel
-      @exchange = @channel.exchange(@opts[:exchange], type: @opts[:exchange_type], durable: @opts[:durable], arguments: @opts[:exchange_arguments])
+      @exchange = @channel.exchange(@opts[:exchange], @opts[:exchange_options])
     end
 
     def connected?
       @bunny && @bunny.connected?
     end
+
+    def create_bunny_connection
+      Bunny.new(@opts[:amqp], :vhost => @opts[:vhost], :heartbeat => @opts[:heartbeat], :logger => Sneakers::logger)
+    end
   end
 end
 

data/lib/sneakers/queue.rb

@@ -26,10 +26,7 @@ class Sneakers::Queue
     @channel.prefetch(@opts[:prefetch])
 
     exchange_name = @opts[:exchange]
-    @exchange = @channel.exchange(exchange_name,
-                                  :type => @opts[:exchange_type],
-                                  :durable => @opts[:durable],
-                                  :arguments => @opts[:exchange_arguments])
+    @exchange = @channel.exchange(exchange_name, @opts[:exchange_options])
 
     routing_key = @opts[:routing_key] || @name
     routing_keys = [*routing_key]
@@ -37,8 +34,7 @@ class Sneakers::Queue
     # TODO: get the arguments from the handler? Retry handler wants this so you
     # don't have to line up the queue's dead letter argument with the exchange
     # you'll create for retry.
-    queue_durable = @opts[:queue_durable].nil? ? @opts[:durable] : @opts[:queue_durable]
-    queue = @channel.queue(@name, :durable => queue_durable, :arguments => @opts[:arguments])
+    queue = @channel.queue(@name, @opts[:queue_options])
 
     if exchange_name.length > 0
       routing_keys.each do |key|

data/lib/sneakers/version.rb

@@ -1,3 +1,3 @@
 module Sneakers
-  VERSION = "2.2.1"
+  VERSION = "2.3.0"
 end

data/spec/sneakers/publisher_spec.rb

@@ -2,6 +2,19 @@ require 'spec_helper'
 require 'sneakers'
 
 describe Sneakers::Publisher do
+  let :pub_vars do
+    {
+      :prefetch => 25,
+      :durable => true,
+      :ack => true,
+      :heartbeat => 2,
+      :vhost => '/',
+      :exchange => "sneakers",
+      :exchange_type => :direct,
+      :exchange_arguments => { 'x-arg' => 'value' }
+    }
+  end
+
   describe '#publish' do
     before do
       Sneakers.clear!
@@ -58,14 +71,14 @@ describe Sneakers::Publisher do
       logger = Logger.new('/dev/null')
       Sneakers.configure(
         amqp: 'amqp://someuser:somepassword@somehost:5672',
-        heartbeat: 1, exchange: 'another_exchange',
-        exchange_type: :topic,
-        exchange_arguments: { 'x-arg' => 'value' },
+        heartbeat: 1,
+        exchange: 'another_exchange',
+        exchange_options: { :type => :topic, :arguments => { 'x-arg' => 'value' } },
         log: logger,
         durable: false)
 
       channel = Object.new
-      mock(channel).exchange('another_exchange', type: :topic, durable: false, arguments: { 'x-arg' => 'value' }) do
+      mock(channel).exchange('another_exchange', type: :topic, durable: false, :auto_delete => false, arguments: { 'x-arg' => 'value' }) do
         mock(Object.new).publish('test msg', routing_key: 'downloads')
       end
 
@@ -78,7 +91,36 @@ describe Sneakers::Publisher do
       p = Sneakers::Publisher.new
 
       p.publish('test msg', to_queue: 'downloads')
+    end
+
+    it 'should use an externally instantiated bunny session if provided' do
+      logger = Logger.new('/dev/null')
+      channel = Object.new
+      exchange = Object.new
+      existing_session = Bunny.new
+      my_vars = pub_vars.merge(to_queue: 'downloads')
+
+      mock(existing_session).start
+      mock(existing_session).create_channel { channel }
 
+      mock(channel).exchange('another_exchange', type: :topic, durable: false, :auto_delete => false, arguments: { 'x-arg' => 'value' }) do
+        exchange
+      end
+
+      mock(exchange).publish('test msg', my_vars)
+
+      Sneakers.configure(
+        connection: existing_session,
+        heartbeat: 1, exchange: 'another_exchange',
+        exchange_type: :topic,
+        exchange_arguments: { 'x-arg' => 'value' },
+        log: logger,
+        durable: false
+      )
+
+      p = Sneakers::Publisher.new
+      p.publish('test msg', my_vars)
+      p.instance_variable_get(:@bunny).must_equal existing_session
     end
   end
 end

data/spec/sneakers/queue_spec.rb

@@ -5,13 +5,18 @@ describe Sneakers::Queue do
   let :queue_vars do
     {
       :prefetch => 25,
-      :durable => true,
       :ack => true,
       :heartbeat => 2,
       :vhost => '/',
       :exchange => "sneakers",
-      :exchange_type => :direct,
-      :exchange_arguments => { 'x-arg' => 'value' }
+      :exchange_options => {
+        :type => :direct,
+        durable: true,
+        :arguments => { 'x-arg' => 'value' }
+      },
+      queue_options: {
+        durable: true
+      }
     }
   end
 
@@ -81,7 +86,7 @@ describe Sneakers::Queue do
 
       it "creates a non-durable queue if :queue_durable => false" do
         mock(@mkchan).queue("test_nondurable", :durable => false) { @mkqueue_nondurable }
-        queue_vars[:queue_durable] = false
+        queue_vars[:queue_options][:durable] = false
         q = Sneakers::Queue.new("test_nondurable", queue_vars)
 
         mock(@mkqueue_nondurable).bind(@mkex, :routing_key => "test_nondurable")
@@ -144,4 +149,3 @@ describe Sneakers::Queue do
     end
   end
 end
-

data/spec/sneakers/worker_spec.rb

@@ -6,7 +6,18 @@ require 'timeout'
 class DummyWorker
   include Sneakers::Worker
   from_queue 'downloads',
-             :durable => false,
+             :exchange_options => {
+               :type => :topic,
+               :durable => false,
+               :auto_delete => true,
+               :arguments => { 'x-arg' => 'value' }
+             },
+             :queue_options => {
+               :durable => false,
+               :auto_delete => true,
+               :exclusive => true,
+               :arguments => { 'x-arg' => 'value' }
+             },
              :ack => false,
              :threads => 50,
              :prefetch => 40,
@@ -101,6 +112,16 @@ class WithParamsWorker
   end
 end
 
+class WithDeprecatedExchangeOptionsWorker
+  include Sneakers::Worker
+  from_queue 'defaults',
+             :durable => false,
+             :exchange_type => :topic,
+             :exchange_arguments => { 'x-arg' => 'value' }
+
+  def work(msg)
+  end
+end
 
 class TestPool
   def process(*args,&block)
@@ -153,12 +174,8 @@ describe Sneakers::Worker do
 
   describe "#initialize" do
     describe "builds an internal queue" do
-      before do
-        @dummy_q = DummyWorker.new.queue
-        @defaults_q = DefaultsWorker.new.queue
-      end
-
       it "should build a queue with correct configuration given defaults" do
+        @defaults_q = DefaultsWorker.new.queue
         @defaults_q.name.must_equal('defaults')
         @defaults_q.opts.to_hash.must_equal(
           :runner_config_file => nil,
@@ -172,13 +189,22 @@ describe Sneakers::Worker do
           :prefetch => 10,
           :threads => 10,
           :share_threads => false,
-          :durable => true,
           :ack => true,
           :amqp => "amqp://guest:guest@localhost:5672",
           :vhost => "/",
           :exchange => "sneakers",
-          :exchange_type => :direct,
-          :exchange_arguments => {},
+          :exchange_options => {
+            :type => :direct,
+            :durable => true,
+            :auto_delete => false,
+            :arguments => {}
+          },
+          :queue_options => {
+            :durable => true,
+            :auto_delete => false,
+            :exclusive => false,
+            :arguments => {}
+          },
           :hooks => {},
           :handler => Sneakers::Handlers::Oneshot,
           :heartbeat => 2,
@@ -187,6 +213,7 @@ describe Sneakers::Worker do
       end
 
       it "should build a queue with given configuration" do
+        @dummy_q = DummyWorker.new.queue
         @dummy_q.name.must_equal('downloads')
         @dummy_q.opts.to_hash.must_equal(
           :runner_config_file => nil,
@@ -200,19 +227,66 @@ describe Sneakers::Worker do
           :prefetch => 40,
           :threads => 50,
           :share_threads => false,
-          :durable => false,
           :ack => false,
           :amqp => "amqp://guest:guest@localhost:5672",
           :vhost => "/",
           :exchange => "dummy",
-          :exchange_type => :direct,
-          :exchange_arguments => {},
+          :exchange_options => {
+            :type => :topic,
+            :durable => false,
+            :auto_delete => true,
+            :arguments => { 'x-arg' => 'value' }
+          },
+          :queue_options => {
+            :durable => false,
+            :auto_delete => true,
+            :exclusive => true,
+            :arguments => { 'x-arg' => 'value' }
+          },
           :hooks => {},
           :handler => Sneakers::Handlers::Oneshot,
           :heartbeat => 5,
           :amqp_heartbeat => 10
         )
       end
+
+      it "should build a queue with correct configuration given deprecated exchange options" do
+        @deprecated_exchange_opts_q = WithDeprecatedExchangeOptionsWorker.new.queue
+        @deprecated_exchange_opts_q.name.must_equal('defaults')
+        @deprecated_exchange_opts_q.opts.to_hash.must_equal(
+          :runner_config_file => nil,
+          :metrics => nil,
+          :daemonize => true,
+          :start_worker_delay => 0.2,
+          :workers => 4,
+          :log => "sneakers.log",
+          :pid_path => "sneakers.pid",
+          :timeout_job_after => 5,
+          :prefetch => 10,
+          :threads => 10,
+          :share_threads => false,
+          :ack => true,
+          :amqp => "amqp://guest:guest@localhost:5672",
+          :vhost => "/",
+          :exchange => "sneakers",
+          :exchange_options => {
+            :type => :topic,
+            :durable => false,
+            :auto_delete => false,
+            :arguments => { 'x-arg' => 'value' }
+          },
+          :queue_options => {
+            :durable => false,
+            :auto_delete => false,
+            :exclusive => false,
+            :arguments => {}
+          },
+          :hooks => {},
+          :handler => Sneakers::Handlers::Oneshot,
+          :heartbeat => 2,
+          :amqp_heartbeat => 10
+        )
+      end
     end
 
     describe "initializes worker" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sneakers
 version: !ruby/object:Gem::Version
-  version: 2.2.1
+  version: 2.3.0
 platform: ruby
 authors:
 - Dotan Nahum
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-29 00:00:00.000000000 Z
+date: 2015-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: serverengine