la_gear 1.3.0 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cf848e73d2235da6d435ad58dca4a1dc145c260d
-  data.tar.gz: 0e6c492bd0154d0315a7475e03dce357991601fc
+  metadata.gz: 4ca8da71c32e27e8aabc8d13e7b00c12c5cc6107
+  data.tar.gz: d7eded901af06f3145c15f2395bc959d63f45082
 SHA512:
-  metadata.gz: 6e2f6b5625e1b8c708029443d13da69e9734334713b66622de4f5cf64d8ce0984cd68dbea5823194a3eb99b593f86d7051ca82d15247646d2adedb8756db0732
-  data.tar.gz: c45ddfbcb2dbcc5d64d9a7665576127466ea34b7deaa07b4672a537e3a2a1df741a41297b67a41fd428329eab6584871f8b27d669b410db2e1b4a79b6c1c24b7
+  metadata.gz: 90cbd481807e189e60dec7c78ff5cd707abdc93c63972077bd1c5efaab3c7659e0c5ab17759bb723cad38b1106826d654a6b64878054626fe3e3b82612034790
+  data.tar.gz: c49890fda1ecbaa23614da07584eb1f456539bb2b34fea737d0eccc5da0ed2a997d70e8aba3453f6660b6a8ac41b4e245d330aa9e2a03eaa96ff442bfedd10c3

data/README.md

@@ -30,53 +30,74 @@ Or install it yourself as:
 ## Usage
 
 Instead of `include Sneakers::Worker` in your workers, use `include LaGear::Worker`. Then all of your queues and routing key bindings will automatically use an `Sneakers::Config[:app_name]` plus the class name of your worker as your queue name and the class name of your worker as the routing key. For example,
-```
+```ruby
 Sneakers.configure app_name: 'pogs_are_awesome'
 
 class BoKnows
   include LaGear::Worker
   
   def perform(baseball, football)
-    # ... message processing code ...
+    # process message ...
   end
 end
 ```
-would by default result in the following 2 queue names: `pogs_are_awesome.bo_knows` and `pogs_are_awesome.bo_knows.retry`. The default routing key would be: `bo_knows`. This allows for multiple consumer queue bindings for a direct exchange (see the Multiple Bindings section of https://www.rabbitmq.com/tutorials/tutorial-four-ruby.html). The `.retry` is for if you are using [dead letter exchanges](https://www.rabbitmq.com/dlx.html) and [message expirations](https://www.rabbitmq.com/ttl.html) to perform retries (which you should). Just call the `Sneakers::Worker#from_queue` method to override the convention-based defaults.
+would by default result in the following 2 queue names:
 
-Also, notice in the example above that we don't define a `work` method for `Sneakers::Worker`. That's because `LaGear::Worker` defines it for you. All the method does deserialize your RabbitMQ message (defaults to JSON) and pass each of the properties as a parameters to Sidekiq's `perform_async` method to process the message. Put your message processing code in a `perform` method instead. That's the method that Sidekiq invokes when it actual processes the message that `LaGear::Worker#work` sent to it.
+- `pogs_are_awesome.bo_knows`
+- `pogs_are_awesome.bo_knows.retry`
 
-### The Bus
+The default routing key would be: `bo_knows`. This allows for multiple consumer queue bindings for a direct exchange (see the Multiple Bindings section of https://www.rabbitmq.com/tutorials/tutorial-four-ruby.html). The `.retry` is for if you are using [dead letter exchanges](https://www.rabbitmq.com/dlx.html) and [message expirations](https://www.rabbitmq.com/ttl.html) to perform retries (which you should). Just call the `Sneakers::Worker#from_queue` method to override the convention-based defaults like so:
+
+```ruby
+class PowerRanger
+  include LaGear::Worker
 
-There is also a `LaGear::Bus` class which is an alternative to the `Sneakers::Publisher`. It adds an `opts` parameter to the `publish` method, allowing you to pass the options you would pass to the `bunny` exchange publish [method](http://reference.rubybunny.info/Bunny/Exchange.html#publish-instance_method) (see http://reference.rubybunny.info/Bunny/Exchange.html#publish-instance_method for the list of options).
+  def self.routing_key
+    'bo_knows'
+  end
 
-`LaGear::Bus` also has support for BigWig's [bi-endpoint]((https://devcenter.heroku.com/articles/rabbitmq-bigwig#provisioning-the-add-on)) configuration where they use one RabbitMQ endpoint for receiving and one for transmitting. Configure Sneaker with an `amqp` and `amqp_publish` to get this working. Or you can just use the `LaGear::SneakersConfigurer.configure_bi_amqp_endpoints` convience method. Here's an example for a Heroku app:
-```
-if ENV['RABBITMQ_BIGWIG_RX_URL'] && ENV['RABBITMQ_BIGWIG_TX_URL']
-  LaGear::SneakersConfigurer.configure_bi_amqp_endpoints(
-    ENV['RABBITMQ_BIGWIG_RX_URL'],
-    ENV['RABBITMQ_BIGWIG_TX_URL']
-  )
+  def self.default_queue_name
+    "#{Sneakers::CONFIG.fetch(:app_name).underscore}.#{name.underscore}"
+  end
+
+  from_queue default_queue_name, default_queue_opts
+
+  def perform(red, yellow)
+    # process message...
+  end
 end
-# else Sneakers/Bunny just uses the default RabbitMQ endpoint (amqp://localhost:15672)
 ```
 
-The reason I call it a "bus" is because I want to end up adding bus-style semantic methods to it besides publish similar to the methods in NServiceBus's [`IBus`](https://github.com/Particular/NServiceBus/blob/develop/src/NServiceBus.Core/IBus.cs) (see also [`ISendOnlyBus`](https://github.com/Particular/NServiceBus/blob/develop/src/NServiceBus.Core/ISendOnlyBus.cs)).
+Also, notice in the example above that we don't define a `work` method for `Sneakers::Worker`. That's because `LaGear::Worker` defines it for you. All the method does is deserialize your RabbitMQ message (defaults to JSON) and pass each of the properties as a parameters to Sidekiq's `perform_async` method to process the message. Put your message processing code in a `perform` method instead. That's the method that Sidekiq invokes when it actually processes the message that `LaGear::Worker#work` sent to it.
 
-## Known Issues
+You can also use the conventions to create versioned workers to more easily handle backwards compatibility when message parameters change. This module/class:
 
-* For workers in a Rails 3.2 app I have, I had to explicilty include `Sneakers::Worker` and `Sidekiq::Worker` before `LaGear::Worker` because of an issue with it complaing that the `include` method was private in the Rails environment (see [here](https://github.com/gabrieljoelc/la_gear/blob/master/lib/la_gear/worker.rb#L6) for the current workaround). Here's what your workers should look like if this is happening to you:
-```
-class BoKnows
-  include Sneakers::Worker unless LaGear::Worker.sidekiq_proc?
-  include Sidekiq::Worker
-  include LaGear::Worker
-  
-  def perform(baseball, football)
-    # ... your worker code ...
+```ruby
+module BoKnows
+  class V1
+    def perform
+      # process message...
+    end
   end
 end
 ```
 
+would create the routing key `bo_knows.v1` and these queue names:
+
+- `pogs_are_awesome.bo_knows.v1`
+- `pogs_are_awesome.bo_knows.v1.retry`
+
+### The Bus
+
+There is also a `LaGear::Bus` class which is an alternative to the `Sneakers::Publisher`. It adds an `opts` parameter to the `publish` method, allowing you to pass the options you would pass to the `bunny` exchange publish [method](http://reference.rubybunny.info/Bunny/Exchange.html#publish-instance_method) (see http://reference.rubybunny.info/Bunny/Exchange.html#publish-instance_method for the list of options). It also allows you use a common way to publish messages:
+
+- `LaGear::Bus.publish('bo_knows', baseball: 'royals', football: 'cowboys')`
+- `LaGear::Bus.publish('bo_knows', { baseball: 'royals', football: 'cowboys' }, version: 2)` - will publish to the exchange with the `bo_knows.v2` routing key
+- `LaGear::Bus.publish_in(1.day, 'bo_knows', baseball: 'royals', football: 'cowboys')`
+- `LaGear::Bus.publish_at(1.day.from_now, 'bo_knows', baseball: 'royals', football: 'cowboys')`
+- `LaGear::Bus.publish_local('bo_knows_local', baseball: 'royals', football: 'cowboys')` - this is for local only (`include Sidekiq::Worker`) workers
+- `LaGear::Bus.publish_local_in('bo_knows', { baseball: 'royals', football: 'cowboys' }, 1.day)`
+
 ## Contributing
 
 1. Fork it ( https://github.com/[my-github-username]/la_gear/fork )

data/la_gear.gemspec

@@ -21,12 +21,12 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'bunny', '~> 2.2.0'
   spec.add_dependency 'sneakers', '~> 2.3'
   spec.add_dependency 'activesupport', '~> 4.2'
-  spec.add_dependency 'sidekiq', '~> 3.3'
+  spec.add_dependency 'sidekiq', '>= 3.3'
   spec.add_dependency 'connection_pool', '~> 2.1'
 
   spec.add_development_dependency 'rake', '~> 10.4'
   spec.add_development_dependency 'minitest', '~> 5.7.0'
   spec.add_development_dependency 'simplecov'
-  spec.add_development_dependency 'rr'
+  spec.add_development_dependency 'mocha'
   spec.add_development_dependency 'pry'
 end

data/lib/la_gear/version.rb

@@ -1,3 +1,3 @@
 module LaGear
-  VERSION = '1.3.0'
+  VERSION = '1.3.1'
 end

data/test/helper.rb

@@ -12,6 +12,7 @@ rescue LoadError
 end
 require 'minitest/autorun'
 require 'minitest/pride'
+require 'mocha/mini_test'
 require 'sidekiq'
 require 'sneakers'
 

data/test/test_publisher.rb

@@ -79,8 +79,6 @@ class TestPublisher < LaGear::Test
   end
 
   describe 'when serialize is overriden to be a no-op' do
-    require 'rr'
-
     class PumpItUpPublisher < LaGear::Publisher
       def self.serialize(msg)
         msg
@@ -96,46 +94,46 @@ class TestPublisher < LaGear::Test
 
       it 'should publish a message to an exchange' do
         xchg = Object.new
-        mock(xchg).publish('test msg', routing_key: 'downloads')
+        xchg.expects(:publish).with('test msg', routing_key: 'downloads')
 
         p = PumpItUpPublisher.new
         p.instance_variable_set(:@exchange, xchg)
 
-        mock(p).ensure_connection! {}
+        p.stubs(:ensure_connection!)
         p.publish('test msg', to_queue: 'downloads')
       end
 
       it 'should publish with the persistence specified' do
         xchg = Object.new
-        mock(xchg).publish('test msg', routing_key: 'downloads', persistence: true)
+        xchg.expects(:publish).with('test msg', routing_key: 'downloads', persistence: true)
 
         p = PumpItUpPublisher.new
         p.instance_variable_set(:@exchange, xchg)
 
-        mock(p).ensure_connection! {}
+        p.stubs(:ensure_connection!)
         p.publish('test msg', to_queue: 'downloads', persistence: true)
       end
 
       it 'should publish with arbitrary metadata specified' do
         xchg = Object.new
-        mock(xchg).publish('test msg', routing_key: 'downloads', expiration: 1, headers: { foo: 'bar' })
+        xchg.expects(:publish).with('test msg', routing_key: 'downloads', expiration: 1, headers: { foo: 'bar' })
 
         p = PumpItUpPublisher.new
         p.instance_variable_set(:@exchange, xchg)
 
-        mock(p).ensure_connection! {}
+        p.stubs(:ensure_connection!)
         p.publish('test msg', to_queue: 'downloads', expiration: 1, headers: { foo: 'bar' })
       end
 
       it 'should not reconnect if already connected' do
         xchg = Object.new
-        mock(xchg).publish('test msg', routing_key: 'downloads')
+        xchg.expects(:publish).with('test msg', routing_key: 'downloads')
 
         p = PumpItUpPublisher.new
         p.instance_variable_set(:@exchange, xchg)
 
-        mock(p).connected? { true }
-        mock(p).ensure_connection!.times(0)
+        p.stubs(:connected?).returns(true)
+        p.expects(:ensure_connection!).never
 
         p.publish('test msg', to_queue: 'downloads')
       end
@@ -151,15 +149,15 @@ class TestPublisher < LaGear::Test
           durable: false)
 
         channel = Object.new
-        mock(channel).exchange('another_exchange', type: :topic, durable: false) do
-          mock(Object.new).publish('test msg', routing_key: 'downloads')
+        channel.expects(:exchange).with('another_exchange', type: :topic, durable: false) do
+          Object.new.expects(:publish).with('test msg', routing_key: 'downloads')
         end
 
         bunny = Object.new
-        mock(bunny).start
-        mock(bunny).create_channel { channel }
+        bunny.expects(:start)
+        bunny.stubs(:create_channel).returns(channel)
 
-        mock(Bunny).new('amqp://someuser:somepassword@somehost:5672', heartbeat: 1, vhost: '/', logger: logger) { bunny }
+        Bunny.expects(:new).with('amqp://someuser:somepassword@somehost:5672', heartbeat: 1, vhost: '/', logger: logger).returns bunny
 
         p = PumpItUpPublisher.new
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: la_gear
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.3.1
 platform: ruby
 authors:
 - Gabriel Chaney
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-12 00:00:00.000000000 Z
+date: 2016-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -72,14 +72,14 @@ dependencies:
   name: sidekiq
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.3'
 - !ruby/object:Gem::Dependency
@@ -139,7 +139,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rr
+  name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="