pwwka 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8cf3c8a949bbd8b4d824a31484de0349a16c79d9
-  data.tar.gz: 0f53407b75ed79d8cbd3d85cd5945e2a988edeba
+  metadata.gz: d40cdf7ab32f4a3731ecba95fd75c16cca7c4c70
+  data.tar.gz: cfa26d01c9484c309b45d27f09c40a7390d1e10c
 SHA512:
-  metadata.gz: 570f563f482b9992a0e9d55d8206ac74484d49ecfbc0d3b01d3819f5616f714b7e5f0203f21700a4b0011f6507daf06bc70dad7753a718430e51c99603f08b2d
-  data.tar.gz: 87786f3b94d21352bc2148708514eb8558d61edb3cfc80037a271ca8c69c50e9eb61fc5d22a3d2676615917469c5e1bacea5528243a2bd39315ea59317eaa2a1
+  metadata.gz: addff24275e10692962c599fdb04bc5d9536e22abea010ba18d95f5b9dcb168215e376aae0c49408a8273e361066b8979db0b10100e317271292ba399387d090
+  data.tar.gz: f387dad318f3cf12262313ebfc7432cc8fe606d758c207f05453a32bcc4f9c7cd3f10c665bf72ae7e7951b3c6f61d8cbffc40f8e1b2d83f85b5d6b506e1e610a

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pwwka (0.1.0)
+    pwwka (0.2.0)
       activemodel
       activesupport
       bunny

data/README.md

@@ -39,11 +39,11 @@ And follow the instructions.
 Add to your `Gemfile`:
 
 ```ruby
-gem 'pwwka', require: false, git: 'https://github.com/stitchfix/pwwka.git'
+gem 'pwwka'
 ```
 
 
-### Set up your message_handler configration
+### Set up your pwwka configration
 
 Connect to your RabbitMQ instance using the url and choose a name for your
 topic exchange.
@@ -109,7 +109,7 @@ message_handler: rake message_handler:receive HANDLER_KLASS=ClientIndexMessageHa
 You'll also need to bring the Rake task into your app.  For Rails, you'll need to edit the top-level `Rakefile`:
 
 ```ruby
-require 'stitch_fix/message_handler/tasks'
+require 'pwwka/tasks'
 ```
 
 ### Queues - what messages will your queue receive
@@ -177,7 +177,47 @@ RabbitMQ has a web interface for checking out the health of connections, channel
 ![RabbitMQ Management 3](docs/images/RabbitMQ_Management-3.png)
 
 ## Testing
-The message_handler gem has tests for all its functionality so app testing is best done with expectations. However, if you want to test the message bus end-to-end in your app you can use some helpers in `lib/stitch_fix/message_handler/test_handler.rb`. See the gem specs for examples of how to use them.
+
+This gem has test coverage of interacting with RabbitMQ, so for unit tests, your best
+strategy is to simply mock calls to `Pwwka::Transmitter`.
+
+For integration tests, however, you can examine the actual message bus by setting up
+the provided `Pwwka::TestHandler` like so:
+
+```ruby
+require 'pwwka/test_handler'
+
+describe "my integration test" do
+
+  before(:all) do
+    @test_handler = Pwwka::TestHandler.new
+    @test_handler.test_setup
+  end
+
+  after(:all) do 
+    # this clears out any messages, so you have a clean test environment next time
+    @test_handler.test_teardown 
+  end
+
+  it "uses the message bus" do
+    post "/items", item: { size: "L" }
+
+    message = @test_handler.pop_message
+
+    expect(message.delivery_info.routing_key).to eq("my-company.items.created")
+    expect(message.payload).to eq({ item: { id: 42, size: "L" } })
+  end
+
+  it "can splat the values as well" do
+    post "/items", item: { size: "L" }
+
+    delivery_info, payload = @test_handler.pop_message
+
+    expect(delivery_info.routing_key).to eq("my-company.items.created")
+    expect(payload).to eq({ item: { id: 42, size: "L" } })
+  end
+end
+```
 
 ## TODO
 * automated monitoring

data/lib/pwwka/test_handler.rb

@@ -1,4 +1,12 @@
 module Pwwka
+  # A handler you can use to examine messages your app sends during tests.
+  #
+  # To use this:
+  #
+  # 1. Create an instance and arrange for `test_setup` to be called when
+  #    your tests are being setup (e.g.`def setup` or `before`)
+  # 2. Arrange for `test_teardown` to be called during teardown of your tests
+  # 3. Use the method `pop_message` to examine the message on the queue
   class TestHandler
 
     attr_reader :channel_connector
@@ -21,19 +29,35 @@ module Pwwka
     def test_queue
       @test_queue  ||= begin
                          test_queue  = channel.queue("test-queue", durable: true)
-                         test_queue.bind(topic_exchange, routing_key: "*.*")
+                         test_queue.bind(topic_exchange, routing_key: "#.#")
                          test_queue
                        end
     end
 
+    # Get the message on the queue as TestHandler::Message.
+    def pop_message
+      delivery_info, properties, payload = test_queue.pop
+      Message.new(delivery_info,
+                  properties,
+                  payload)
+    end
+
     def get_topic_message_payload_for_tests
-      delivery_info, properties, payload  = test_queue.pop
-      JSON.parse(payload)
+      deprecated!(:get_topic_message_payload_for_tests,
+                  "Use `pop_message.payload` instead")
+      pop_message.payload
     end
 
     def get_topic_message_properties_for_tests
-      delivery_info, properties, payload  = test_queue.pop
-      properties
+      deprecated!(:get_topic_message_properties_for_tests,
+                  "Use `pop_message.properties` instead")
+      pop_message.properties
+    end
+
+    def get_topic_message_delivery_info_for_tests
+      deprecated!(:get_topic_message_delivery_info_for_tests,
+                  "Use `pop_message.delivery_info` instead")
+      pop_message.delivery_info
     end
 
     def purge_test_queue
@@ -46,5 +70,33 @@ module Pwwka
       channel_connector.connection_close 
     end
 
+    # Simple class to hold a popped message.
+    #
+    # You can either access the message contents directly, or splat
+    # it for the most commonly-needed aspects:
+    #
+    #     delivery_info, payload = @test_handler.pop_message
+    class Message
+      attr_reader :delivery_info, :properties, :payload
+      def initialize(delivery_info, properties, payload)
+        @delivery_info = delivery_info
+        @properties = properties
+        @raw_payload = payload
+        @payload = JSON.parse(@raw_payload)
+      end
+
+      # Returns the delivery_info, payload, properties, and raw_payload for splat
+      # magic.
+      def to_ary
+        [@delivery_info,@payload,@properties,@raw_payload]
+      end
+    end
+
+  private
+
+    def deprecated!(method,message)
+      warn "#{method} is deprecated: #{message}"
+    end
+
   end
 end

data/lib/pwwka/version.rb

@@ -1,3 +1,3 @@
 module Pwwka
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/spec/transmitter_spec.rb

@@ -10,15 +10,24 @@ describe Pwwka::Transmitter do
   after(:all) { @test_handler.test_teardown }
 
   let(:payload)     { Hash[:this, "that"] }
-  let(:routing_key) { "this.that" }
+  let(:routing_key) { "this.that.and.theother" }
 
   describe "#send_message!" do
 
-    it "should send the correct payload" do
-      success = Pwwka::Transmitter.new.send_message!(payload, routing_key)
-      expect(success).to be_truthy
-      received_payload = @test_handler.get_topic_message_payload_for_tests
-      expect(received_payload["this"]).to eq("that")
+    context "happy path" do
+      it "should send the correct payload" do
+        success = Pwwka::Transmitter.new.send_message!(payload, routing_key)
+        expect(success).to be_truthy
+        received_payload = @test_handler.pop_message.payload
+        expect(received_payload["this"]).to eq("that")
+      end
+
+      it "should delivery on the expected routing key" do
+        success = Pwwka::Transmitter.new.send_message!(payload, routing_key)
+        expect(success).to be_truthy
+        delivery_info = @test_handler.pop_message.delivery_info
+        expect(delivery_info.routing_key).to eq(routing_key)
+      end
     end
 
     it "should blow up if exception raised" do
@@ -34,7 +43,7 @@ describe Pwwka::Transmitter do
 
     it "should send the correct payload" do
       Pwwka::Transmitter.send_message!(payload, routing_key)
-      received_payload = @test_handler.get_topic_message_payload_for_tests
+      received_payload = @test_handler.pop_message.payload
       expect(received_payload["this"]).to eq("that")
     end
 
@@ -51,7 +60,7 @@ describe Pwwka::Transmitter do
 
     it "should send the correct payload" do
       Pwwka::Transmitter.send_message_safely(payload, routing_key)
-      received_payload = @test_handler.get_topic_message_payload_for_tests
+      received_payload = @test_handler.pop_message.payload
       expect(received_payload["this"]).to eq("that")
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pwwka
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Stitch Fix Engineering
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-21 00:00:00.000000000 Z
+date: 2014-09-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bunny