pwwka 0.12.0.RC1 → 0.12.0.RC2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 74547cd8f8b4313cb47333486277bc22aad36e76
-  data.tar.gz: e14256ef72ea644b30f1c7af7305a5047dfdd6f3
+  metadata.gz: d2a01012af3050ef6e214e57b4831e9953c7296c
+  data.tar.gz: 0cf0a7b780a9b91b83ee2824d4dc5ffc747f58a0
 SHA512:
-  metadata.gz: 5d000df76add8d1449072d15e75c0f3ec05aab8a5a4e07b5251fa9d041e4ca8a784d57c94fa77c3eebef2283d5eb1e69f0bed9d5d9c5525ec5d728dd91a4908a
-  data.tar.gz: 164001e94240f3d154a605a808fafe196686a5006340cae84d9a8b03dd0c6deb29450b542dc5d0c937d1b1477006fb3475b50d0d62c5ade28650e34975234081
+  metadata.gz: 10be7d442840c8a0d676ae60a91817383cac3dae1a76273c669229d32e1666c064acd1426da4e457ebed66473f196985d2134d8c07f541bf7ab1dc9713d054cc
+  data.tar.gz: c63039a9bac0ca399296694312c40bf430063e610880b1a5c2956437ad224eaa94dda85373da54229a62eab9e60ed94c930d33f4d35912335bf24faedcac2dc7

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pwwka (0.12.0.RC1)
+    pwwka (0.12.0.RC2)
       activemodel
       activesupport
       bunny

data/README.md

@@ -301,7 +301,7 @@ If you use [Resque][resque], and you wish to handle messages in a resque job, yo
 2. Now, configure your handler.  For a `Procfile` setup:
 
    ```
-   my_handler: rake message_handler:receive HANDLER_KLASS=Pwwka::QueueResqueJobHandler JOB_KLASS=MyResqueJob PWWKA_QUEUE_EXTENDED_INFO=true QUEUE_NAME=my_queue ROUTING_KEY="my.key.completed"
+   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.
@@ -322,7 +322,8 @@ If you use [Resque][resque], and you wish to handle messages in a resque job, yo
 
    Note that you must provide `@queue` in your job.  `QueueResqueJobHandler` doesn't support setting a custom queue at enqueue-time (PRs welcome :).
 
-   Note that if you were using this library before version 0.12.0, your job would only be given the payload.  This is why `PWWKA_QUEUE_EXTENDED_INFO` must be set.  Without it, your job only gets the payload to avoid breaking legacy consumers.  You should always set this so you have access to the entire message.
+   Note that if you were using this library before version 0.12.0, your job would only be given the payload.  If you change your job to accept exatly three arguments, you will be given the payload, routing key, and message properties.  If any of those arguments are optional, you will need to set `PWWKA_QUEUE_EXTENDED_INFO` to `"true"` to force pwwka to pass those along.  Without it, your job only gets the payload to avoid breaking legacy consumers. 
+
 3. Profit!
 
 [resque]: https://github.com/resque/resque/tree/1-x-stable

data/lib/pwwka/queue_resque_job_handler.rb

@@ -15,15 +15,25 @@ module Pwwka
   # 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)
+      job_klass = ENV["JOB_KLASS"].constantize
       args = [
-        ENV["JOB_KLASS"].constantize,
+        job_klass,
         payload
       ]
-      if ENV["PWWKA_QUEUE_EXTENDED_INFO"] == 'true'
+      if ENV["PWWKA_QUEUE_EXTENDED_INFO"] == 'true' || job_klass_can_handle_args?(job_klass)
         args << delivery_info.routing_key
         args << properties.to_hash
       end
       Resque.enqueue(*args)
     end
+
+  private
+
+  def self.job_klass_can_handle_args?(job_klass)
+      method = job_klass.method(:perform)
+      return false if method.nil?
+      method.arity == 3
+    end
   end
+
 end

data/lib/pwwka/version.rb

@@ -1,3 +1,3 @@
 module Pwwka
-  VERSION = '0.12.0.RC1'
+  VERSION = '0.12.0.RC2'
 end

data/spec/unit/queue_resque_job_handler_spec.rb

@@ -1,13 +1,20 @@
 require 'spec_helper'
 require 'pwwka/queue_resque_job_handler'
 
-class MyTestJob
+class MyLegacyTestJob
+  def self.perform(payload)
+  end
+end
+
+class MyNewTestJob
+  def self.perform(payload, routing_key, properties)
+  end
 end
 
 describe Pwwka::QueueResqueJobHandler do
 
   describe "::handle!" do
-    let(:job_class) { MyTestJob }
+    let(:job_class) { MyLegacyTestJob }
     let(:routing_key) { "foo.bar.blah" }
     let(:delivery_info) { double("delivery info", routing_key: routing_key) }
     let(:properties_hash) {
@@ -28,13 +35,13 @@ describe Pwwka::QueueResqueJobHandler do
 
     before do
       allow(Resque).to receive(:enqueue)
-      ENV["JOB_KLASS"] = MyTestJob.name
+      ENV["JOB_KLASS"] = MyLegacyTestJob.name
     end
 
     context "when not asking for more information explicitly" do
       it "should queue a resque job using JOB_KLASS and the payload" do
         described_class.handle!(delivery_info,properties,payload)
-        expect(Resque).to have_received(:enqueue).with(MyTestJob,payload)
+        expect(Resque).to have_received(:enqueue).with(MyLegacyTestJob,payload)
       end
     end
 
@@ -42,15 +49,26 @@ describe Pwwka::QueueResqueJobHandler do
       it "should queue a resque job using JOB_KLASS and the payload" do
         ENV["PWWKA_QUEUE_EXTENDED_INFO"] = 'false'
         described_class.handle!(delivery_info,properties,payload)
-        expect(Resque).to have_received(:enqueue).with(MyTestJob,payload)
+        expect(Resque).to have_received(:enqueue).with(MyLegacyTestJob,payload)
       end
     end
 
     context "when asking for more information via PWWKA_QUEUE_EXTENDED_INFO" do
       it "should queue a resque job using JOB_KLASS, payload, routing key, and properties as a hash" do
+        # Note, using MyLegacyTestJob to ensure this doesn't trigger the method param examination logic and respects
+        # the env var, even though it is not used correctly in this case.
         ENV["PWWKA_QUEUE_EXTENDED_INFO"] = 'true'
         described_class.handle!(delivery_info,properties,payload)
-        expect(Resque).to have_received(:enqueue).with(MyTestJob,payload,routing_key,properties_hash)
+        expect(Resque).to have_received(:enqueue).with(MyLegacyTestJob,payload,routing_key,properties_hash)
+      end
+    end
+
+    context "when not asking for more information via PWWKA_QUEUE_EXTENDED_INFO but for a job that can handle it" do
+      it "should queue a resque job using JOB_KLASS, payload, routing key, and properties as a hash" do
+        ENV["JOB_KLASS"] = MyNewTestJob.name
+        ENV.delete("PWWKA_QUEUE_EXTENDED_INFO")
+        described_class.handle!(delivery_info,properties,payload)
+        expect(Resque).to have_received(:enqueue).with(MyNewTestJob,payload,routing_key,properties_hash)
       end
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pwwka
 version: !ruby/object:Gem::Version
-  version: 0.12.0.RC1
+  version: 0.12.0.RC2
 platform: ruby
 authors:
 - Stitch Fix Engineering
@@ -15,7 +15,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-29 00:00:00.000000000 Z
+date: 2017-08-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bunny