pwwka 0.11.0 → 0.12.0.RC1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 68a8e54adf4b1cb502093fcdc621154f449a0664
-  data.tar.gz: b3cf3d62c2d3dc6c914c83c48202fb1642058c67
+  metadata.gz: 74547cd8f8b4313cb47333486277bc22aad36e76
+  data.tar.gz: e14256ef72ea644b30f1c7af7305a5047dfdd6f3
 SHA512:
-  metadata.gz: 7b205ad3d18ebab8a85fff6a851e8258f3e001ee69fa74212a168808aa197e46b625c7335ad6e39d064297973cd85c5852cb299af23ebd57aa604aa9bdeceb3e
-  data.tar.gz: 79397d68abe1839b28d561a74240b39f735b9c4322e296dad22d25aff7d476661296f3a4e0f7149f5dc5b00047f2d3344d23e035e12f02db05b9d69104d76ac9
+  metadata.gz: 5d000df76add8d1449072d15e75c0f3ec05aab8a5a4e07b5251fa9d041e4ca8a784d57c94fa77c3eebef2283d5eb1e69f0bed9d5d9c5525ec5d728dd91a4908a
+  data.tar.gz: 164001e94240f3d154a605a808fafe196686a5006340cae84d9a8b03dd0c6deb29450b542dc5d0c937d1b1477006fb3475b50d0d62c5ade28650e34975234081

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pwwka (0.11.0)
+    pwwka (0.12.0.RC1)
       activemodel
       activesupport
       bunny
@@ -10,9 +10,9 @@ PATH
 GEM
   remote: https://www.rubygems.org/
   specs:
-    activemodel (5.1.1)
-      activesupport (= 5.1.1)
-    activesupport (5.1.1)
+    activemodel (5.1.3)
+      activesupport (= 5.1.3)
+    activesupport (5.1.3)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (~> 0.7)
       minitest (~> 5.1)
@@ -25,9 +25,9 @@ GEM
     docile (1.1.5)
     et-orbi (1.0.4)
       tzinfo
-    i18n (0.8.4)
+    i18n (0.8.6)
     json (2.1.0)
-    minitest (5.10.2)
+    minitest (5.10.3)
     mono_logger (1.1.0)
     multi_json (1.12.1)
     mustermann (1.0.0)
@@ -102,4 +102,4 @@ DEPENDENCIES
   simplecov
 
 BUNDLED WITH
-   1.14.6
+   1.15.4

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 QUEUE_NAME=my_queue ROUTING_KEY="my.key.completed"
+   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"
    ```
 
    Note the use of the environment variable `JOB_KLASS`.  This tells `QueueResqueJobHandler` which class to queue.
@@ -311,16 +311,18 @@ If you use [Resque][resque], and you wish to handle messages in a resque job, yo
    class MyResqueJob
      @queue = :my_resque_queue
 
-     def self.process(args) # i.e. payload
-       user = User.find(args.fetch("user_id")) # or whatever
+     def self.perform(payload,            # the payload
+                      routing_key,        # routing key as a string
+                      message_properties) # properties as a hash with _String_ keys
+       user = User.find(payload.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.
+   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.
 3. Profit!
 
 [resque]: https://github.com/resque/resque/tree/1-x-stable

data/lib/pwwka/queue_resque_job_handler.rb

@@ -4,16 +4,26 @@ 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.
+  # for the purposes of retry or better failure management.  You can ask for the routing key and properties
+  # by setting `PWWKA_QUEUE_EXTENDED_INFO` to `true` in your environment.
   #
   # 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"
+  #     my_handler_that_wants_more_info: rake message_handler:receive HANDLER_KLASS=Pwwka::QueueResqueJobHandler JOB_KLASS=MyOthgerResqueJob PWWKA_QUEUE_EXTENDED_INFO=true QUEUE_NAME=my_queue ROUTING_KEY="my.key.#"
   #
   # 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)
+      args = [
+        ENV["JOB_KLASS"].constantize,
+        payload
+      ]
+      if ENV["PWWKA_QUEUE_EXTENDED_INFO"] == 'true'
+        args << delivery_info.routing_key
+        args << properties.to_hash
+      end
+      Resque.enqueue(*args)
     end
   end
 end

data/lib/pwwka/version.rb

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

data/spec/integration/send_and_receive_spec.rb

@@ -1,5 +1,7 @@
 require 'spec_helper.rb'
 require 'resqutils/spec/resque_helpers'
+require 'resqutils/spec/resque_matchers'
+require 'pwwka/queue_resque_job_handler'
 
 require_relative "support/integration_test_setup"
 require_relative "support/logging_receiver"
@@ -10,25 +12,30 @@ describe "sending and receiving messages", :integration do
   include Resqutils::Spec::ResqueHelpers
 
   before do
+    ENV["JOB_KLASS"] = MyTestJob.name
+    ENV["PWWKA_QUEUE_EXTENDED_INFO"] = "true"
     @testing_setup = IntegrationTestSetup.new
     [
-      [AllReceiver      , "all_receiver_pwwkatesting"       , "#"]                 ,
-      [FooReceiver      , "foo_receiver_pwwkatesting"       , "pwwka.testing.foo"] ,
-      [OtherFooReceiver , "other_foo_receiver_pwwkatesting" , "pwwka.testing.foo"] ,
+
+      [AllReceiver                  , "all_receiver_pwwkatesting"             , "#"]                 ,
+      [FooReceiver                  , "foo_receiver_pwwkatesting"             , "pwwka.testing.foo"] ,
+      [OtherFooReceiver             , "other_foo_receiver_pwwkatesting"       , "pwwka.testing.foo"] ,
+      [Pwwka::QueueResqueJobHandler , "queue_resque_job_handler_pwwkatesting" , "#" ]                ,
+
     ].each do |(klass, queue_name, routing_key)|
       @testing_setup.make_queue_and_setup_receiver(klass,queue_name,routing_key)
     end
-  end
-
-  before :each do
     AllReceiver.reset!
     FooReceiver.reset!
     OtherFooReceiver.reset!
     clear_queue(:delayed)
+    clear_queue(MyTestJob)
   end
 
   after do
     @testing_setup.kill_threads_and_clear_queues
+    ENV.delete("JOB_KLASS")
+    ENV.delete("PWWKA_QUEUE_EXTENDED_INFO")
   end
 
   context "routing" do
@@ -201,6 +208,32 @@ describe "sending and receiving messages", :integration do
     expect(OtherFooReceiver.messages_received.size).to eq(1)
   end
 
+  it "can receive a message on a handler that just queues background jobs" do
+    payload = { sample: "payload", has: { deeply: true, nested: 4 }}
+    Pwwka::Transmitter.send_message!(payload, "foo.bar")
+
+    allow_receivers_to_process_queues
+
+    job = Resque.pop(:test_queue)
+    aggregate_failures "job paylod" do
+      expect(job["class"]).to eq(MyTestJob.name)
+      expect(job["args"][0]).to eq({ "sample" => "payload", "has" => { "deeply" => true, "nested" => 4 }})
+      expect(job["args"][1]).to eq("foo.bar")
+
+      # Expect a few things from the metadata for sanity
+      expect(job["args"][2].keys).to include("content_type")
+      expect(job["args"][2].keys).to include("message_id")
+      expect(job["args"][2].keys).to include("timestamp")
+    end
+  end
+
+  class MyTestJob
+    @queue = "test_queue"
+
+    def self.perform(payload,routing_key,properties)
+    end
+  end
+
 
   class AllReceiver < LoggingReceiver
   end

data/spec/spec_helper.rb

@@ -46,8 +46,7 @@ RSpec.configure do |config|
     if example.metadata[:integration]
       result = test_configuration.check_services
       unless result.up?
-        puts "\n\n" + Rainbow(result.error).yellow.bright + "\n\n"
-        exit 1
+        fail result.error
       end
     end
     example.run

data/spec/unit/queue_resque_job_handler_spec.rb

@@ -8,8 +8,16 @@ describe Pwwka::QueueResqueJobHandler do
 
   describe "::handle!" do
     let(:job_class) { MyTestJob }
-    let(:delivery_info) { double("delivery info") }
-    let(:properties) { double("properties") }
+    let(:routing_key) { "foo.bar.blah" }
+    let(:delivery_info) { double("delivery info", routing_key: routing_key) }
+    let(:properties_hash) {
+      {
+        "app_id" => "myapp",
+        "timestamp" => "2015-12-12 13:22:99",
+        "message_id" => "66",
+      }
+    }
+    let(:properties) { Bunny::MessageProperties.new(properties_hash) }
     let(:payload) {
       {
         "this" => "is",
@@ -21,16 +29,34 @@ describe Pwwka::QueueResqueJobHandler do
     before do
       allow(Resque).to receive(:enqueue)
       ENV["JOB_KLASS"] = MyTestJob.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)
+      end
+    end
 
-      described_class.handle!(delivery_info,properties,payload)
+    context "when asking to NOT receive more information explicitly" 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)
+      end
     end
 
-    it "should queue a resque job using JOB_KLASS and payload" do
-      expect(Resque).to have_received(:enqueue).with(MyTestJob,payload)
+    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
+        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)
+      end
     end
 
     after do
       ENV.delete("JOB_KLASS")
+      ENV.delete("PWWKA_QUEUE_EXTENDED_INFO")
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pwwka
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.12.0.RC1
 platform: ruby
 authors:
 - Stitch Fix Engineering
@@ -15,7 +15,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-12 00:00:00.000000000 Z
+date: 2017-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bunny
@@ -254,12 +254,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Send and receive messages via RabbitMQ