pwwka 0.3.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0f8608f70d08fe1795cf8f7cf728d42edaf6ee5c
-  data.tar.gz: 0a5510a4a7a059918659c859266c53c7dd4ceaf6
+  metadata.gz: b8270662062bb3b3031eb3cb2ddbe60975ce4946
+  data.tar.gz: e812c104a3f428ed34a85bedf7ca6c232e3a0336
 SHA512:
-  metadata.gz: 273f205ae214815318c5436084c0aec578728842265df709b5774a95cfc60acb53bd2207f5306f11f591723d0d20bb07d3c43d8a184b8a28ad77cb3a87239b3a
-  data.tar.gz: 3f2344a9ab055aed811ed4ce08fd1a14150372ce01422c9c05a4940e5082e482d615009fd1ec98552ac6dcd7e2c9248cc681dee43a1e8f01c7f2e2547ca427d0
+  metadata.gz: 8e5f383962104ef7d46796c7e21e83297e167e49768d83dbf59b289a5e147499f817f15e56e9b3c7266ada89d48b129ea64149d8bc42957959e83a7603250f6d
+  data.tar.gz: 991980da0be3f35934abb2edbda4d07f567440671273577b58d9d24ac56841b434180c98c6921bd3f0dca27be5368be11cbc979777abac69ce6b96ac6238896e

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pwwka (0.3.2)
+    pwwka (0.4.0)
       activemodel
       activesupport
       bunny
@@ -10,10 +10,10 @@ PATH
 GEM
   remote: https://www.rubygems.org/
   specs:
-    activemodel (4.1.4)
-      activesupport (= 4.1.4)
+    activemodel (4.1.7)
+      activesupport (= 4.1.7)
       builder (~> 3.1)
-    activesupport (4.1.4)
+    activesupport (4.1.7)
       i18n (~> 0.6, >= 0.6.9)
       json (~> 1.7, >= 1.7.7)
       minitest (~> 5.1)
@@ -21,29 +21,49 @@ GEM
       tzinfo (~> 1.1)
     amq-protocol (1.9.2)
     builder (3.2.2)
-    bunny (1.4.0)
+    bunny (1.6.1)
       amq-protocol (>= 1.9.2)
     diff-lcs (1.2.5)
     i18n (0.6.11)
     json (1.8.1)
-    minitest (5.4.0)
+    minitest (5.4.2)
     mono_logger (1.1.0)
+    multi_json (1.10.1)
+    rack (1.6.0)
+    rack-protection (1.5.3)
+      rack
     rake (10.3.2)
-    rspec (3.0.0)
-      rspec-core (~> 3.0.0)
-      rspec-expectations (~> 3.0.0)
-      rspec-mocks (~> 3.0.0)
-    rspec-core (3.0.4)
-      rspec-support (~> 3.0.0)
-    rspec-expectations (3.0.4)
+    redis (3.2.0)
+    redis-namespace (1.5.1)
+      redis (~> 3.0, >= 3.0.4)
+    resque (1.25.2)
+      mono_logger (~> 1.0)
+      multi_json (~> 1.0)
+      redis-namespace (~> 1.3)
+      sinatra (>= 0.9.2)
+      vegas (~> 0.1.2)
+    rspec (3.1.0)
+      rspec-core (~> 3.1.0)
+      rspec-expectations (~> 3.1.0)
+      rspec-mocks (~> 3.1.0)
+    rspec-core (3.1.7)
+      rspec-support (~> 3.1.0)
+    rspec-expectations (3.1.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.0.0)
-    rspec-mocks (3.0.4)
-      rspec-support (~> 3.0.0)
-    rspec-support (3.0.4)
+      rspec-support (~> 3.1.0)
+    rspec-mocks (3.1.3)
+      rspec-support (~> 3.1.0)
+    rspec-support (3.1.2)
+    sinatra (1.4.5)
+      rack (~> 1.4)
+      rack-protection (~> 1.4)
+      tilt (~> 1.3, >= 1.3.4)
     thread_safe (0.3.4)
+    tilt (1.4.1)
     tzinfo (1.2.2)
       thread_safe (~> 0.1)
+    vegas (0.1.11)
+      rack (>= 1.0.0)
 
 PLATFORMS
   ruby
@@ -51,4 +71,5 @@ PLATFORMS
 DEPENDENCIES
   pwwka!
   rake
+  resque
   rspec

data/README.md

@@ -3,7 +3,7 @@
 
 Pronounced "Poo-ka" |ˈpo͞okə|
 
-![Pwwka Bunny Bus](http://res.cloudinary.com/stitch-fix/image/upload/c_scale,w_317/v1408570794/bunny-bus_ba72ou.png)
+![Pwwka Legit](http://res.cloudinary.com/stitch-fix/image/upload/c_scale,h_300/v1413580920/pwwka_yuw7hl.png)
 
 ---
 
@@ -21,11 +21,11 @@ The basic principle of the Pwwka Message Bus is this:
 
 As an example:
 
-* public_app sends a message that a new client has signed up
-* admin_app receives that message and updates its client index
-* email_app receives that message and sends a welcome email to the client
+* public-app sends a message that a new client has signed up
+* admin-app receives that message and updates its client index
+* email-app receives that message and sends a welcome email to the client
 
-### Persistence
+## Persistence
 
 All transmitters and receivers share the same exchange. This means that all receivers can read all messages that any transmitter sends. To ensure that all messages are received by eveyone who wants them the Pwwka message bus is configured as follows:
 
@@ -115,7 +115,7 @@ Pwwka::Transmitter.send_message!(payload, routing_key, delayed: true, delay_by:
 
 `delay_by` is an integer of milliseconds to delay the message. The default (if no value is set) is 5000 (5 seconds).
 
-These extra arguments work for all message sending methods - the safe ones, the handling, and the message_queuer methods (see below).
+These extra arguments work for all message sending methods - the safe ones, the handling, and the `message_queuer` methods (see below).
 
 ### Message Queuer
 You can queue up messages and send them in a batch. This is most useful when multiple messages need to sent from within a transaction block.
@@ -158,8 +158,8 @@ require 'pwwka/tasks'
 
 It depends on your `routing_key`. If you set your routing key to `#.#` (the default) it will receive all the messages. The `#` is a wildcard so if you set it to `client.#` it will receive any message with `client.` at the beginning. The exchange registers the queue's name and routing key so it knows what messages the queue is supposed to receive. A named queue will receive each message it expects to get once and only once.
 
-The available wildcards are as follows
-* `*` (star) can substitute for exactly one word.
+The available wildcards are as follows (and are not intuitive):
+* `*` (star) can substitute for **exactly one word**.
 * `#` (hash) can substitute for zero or more words.
 
 __A note on re-queuing:__ At the moment messages that raise an error on receipt are marked 'not acknowledged, don't resend', and the failure message is logged. All unacknowledged messages will be resent when the worker is restarted. The next iteration of this gem will allow for a specified number of resends without requiring a restart.
@@ -198,6 +198,51 @@ class ClientIndexMessageHandler
 end
 ```
 
+#### Handling Messages with Resque
+
+If you use [Resque][resque], and you wish to handle messages in a resque job, you can use `Pwwka::QueueResqueJobHandler`, which is an adapter between the
+standard `handle!` method provided by pwwka and your Resque job.
+
+1. First, modify your `Gemfile` or otherwise arrange to include `pwwka/queue_resque_job_handler`:
+
+   ```ruby
+   gem 'pwwka', require: [ 'pwwka', 'pwwka/queue_resque_job_handler' ]
+   ```
+
+   or, in `config/initializers/pwwka.rb`:
+
+   ```ruby
+   require 'pwwka/queue_resque_job_handler'
+   ```
+
+2. Now, configure your handler.  For a `Procfile` setup:
+   
+   ```
+   my_handler: rake message_handler:receive HANDLER_KLASS=Pwwka::QueueResqueJobHandler JOB_KLASS=MyResqueJob QUEUE_NAME=my_queue ROUTING_KEY="my.key.completed"
+   ```
+
+   Note the use of the environment variable `JOB_KLASS`.  This tells `QueueResqueJobHandler` which class to queue.
+3. Now, write your job.
+
+   ```ruby
+   class MyResqueJob
+     @queue = :my_resque_queue
+
+     def self.process(args) # i.e. payload
+       user = User.find(args.fetch("user_id")) # or whatever
+       user.frobnosticate!
+     end
+   end
+   ```
+
+   Note that you must provide `@queue` in your job.  `QueueResqueJobHandler` doesn't support setting a custom queue and enqueue-time (PRs welcome :).
+   Note further that your job class is not given the routing key, so you'll have to set `ROUTING_KEY` appropriately for whatever it is you're trying to
+   do.
+3. Profit!
+
+[resque]: https://github.com/resque/resque/tree/1-x-stable
+
+
 ## Monitoring
 
 RabbitMQ has a good API that should make it easy to set up some simple monitoring. In the meantime there is logging and manual monitoring.

data/lib/pwwka/queue_resque_job_handler.rb

@@ -0,0 +1,19 @@
+require 'active_support/core_ext/string/inflections'
+require 'resque'
+
+module Pwwka
+  # A handler that simply queues the payload into a Resque job.  This is useful
+  # if the code that should respond to a message needs to be managed by Resque, e.g.
+  # for the purposes of retry or better failure management.
+  #
+  # You should be able to use this directly from your handler configuration, e.g. for a Heroku-style `Procfile`:
+  #
+  #     my_handler: rake message_handler:receive HANDLER_KLASS=Pwwka::QueueResqueJobHandler JOB_KLASS=MyResqueJob QUEUE_NAME=my_queue ROUTING_KEY="my.key.completed"
+  #
+  # Note that this will not check the routing key, so you should be sure to specify the most precise ROUTING_KEY you can for handling the message.
+  class QueueResqueJobHandler
+    def self.handle!(delivery_info,properties,payload)
+      Resque.enqueue(ENV["JOB_KLASS"].constantize, payload)
+    end
+  end
+end

data/lib/pwwka/version.rb

@@ -1,3 +1,3 @@
 module Pwwka
-  VERSION = '0.3.2'
+  VERSION = '0.4.0'
 end

data/pwwka.gemspec

@@ -24,4 +24,5 @@ Gem::Specification.new do |s|
   s.add_dependency("mono_logger")
   s.add_development_dependency("rake")
   s.add_development_dependency("rspec")
+  s.add_development_dependency("resque")
 end

data/spec/queue_resque_job_handler_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+require 'pwwka/queue_resque_job_handler'
+
+class MyTestJob
+end
+
+describe Pwwka::QueueResqueJobHandler do
+
+  describe "::handle!" do
+    let(:job_class) { MyTestJob }
+    let(:delivery_info) { double("delivery info") }
+    let(:properties) { double("properties") }
+    let(:payload) {
+      {
+        "this" => "is",
+        "some" => true,
+        "payload" => 99,
+      }
+    }
+
+    before do
+      allow(Resque).to receive(:enqueue)
+      ENV["JOB_KLASS"] = MyTestJob.name
+
+      described_class.handle!(delivery_info,properties,payload)
+    end
+
+    it "should queue a resque job using JOB_KLASS and payload" do
+      expect(Resque).to have_received(:enqueue).with(MyTestJob,payload)
+    end
+
+    after do
+      ENV.delete("JOB_KLASS")
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pwwka
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.0
 platform: ruby
 authors:
 - Stitch Fix Engineering
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-23 00:00:00.000000000 Z
+date: 2015-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bunny
@@ -94,6 +94,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: resque
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: |-
   The purpose of this gem is to normalise the sending and
     receiving of messages between Rails apps using the shared RabbitMQ
@@ -121,6 +135,7 @@ files:
 - lib/pwwka/handling.rb
 - lib/pwwka/logging.rb
 - lib/pwwka/message_queuer.rb
+- lib/pwwka/queue_resque_job_handler.rb
 - lib/pwwka/receiver.rb
 - lib/pwwka/tasks.rb
 - lib/pwwka/test_handler.rb
@@ -130,6 +145,7 @@ files:
 - spec/handling_spec.rb
 - spec/logging_spec.rb
 - spec/message_queuer_spec.rb
+- spec/queue_resque_job_handler_spec.rb
 - spec/receiver_spec.rb
 - spec/spec_helper.rb
 - spec/transmitter_spec.rb
@@ -152,7 +168,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.0.rc.1
+rubygems_version: 2.4.2
 signing_key: 
 specification_version: 4
 summary: Send and receive messages via RabbitMQ
@@ -160,6 +176,7 @@ test_files:
 - spec/handling_spec.rb
 - spec/logging_spec.rb
 - spec/message_queuer_spec.rb
+- spec/queue_resque_job_handler_spec.rb
 - spec/receiver_spec.rb
 - spec/spec_helper.rb
 - spec/transmitter_spec.rb