delivery_boy 0.2.0.beta1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cbb2e9c4ceb1a7b4cac859fa21f33eb69d43b1ba
-  data.tar.gz: a8c55dc6eb604a71dbdf83a8f80334693e6ec144
+  metadata.gz: 53868e134ceaddeaafb5f96416b3fe6a44c866dd
+  data.tar.gz: 3953493bbe3755d81a971b1e62c1a1a7289ad3a9
 SHA512:
-  metadata.gz: 6cd6a9bb4def19bcf1fe9bbba80bdc70e2a8f9df0211fb8f65b776fef784e1c914114159d3e13ecb837e61e25d51356edab0fdb62b7399fc2105c5f1c359b5a8
-  data.tar.gz: 06dc18208a20403c71d810a8b7488a15a4aae1ad7f14fd1ec18b2bffa3703d32fc6aef28c61b78a7f522d177795b38407eb6a26e47f70b3b1101ffced3369d23
+  metadata.gz: c62591d732bc07cead953039d63a3fb62b00d59bdcc17dd848d859c69efbd8bca5df98c0ad47b9aa29c3fdc44698da0f16913ac5af9cc23309ced52e8e50f627
+  data.tar.gz: b51fc9e418556e3cdc8da29357d46a949c284d4806f7c4a047d6d424d907e2c7fd60fddbc97b5580e70974000e0620ca575f98e023a232c756a524b7f2040f27

data/CHANGELOG

@@ -0,0 +1,6 @@
+# Changelog
+
+## v0.2.0
+
+* Add a test mode
+* Improve config system

data/README.md

@@ -167,6 +167,43 @@ A PEM encoded client cert to use with an SSL connection. Must be used in combina
 
 A PEM encoded client cert key to use with an SSL connection. Must be used in combination with `ssl_client_cert`.
 
+### Testing
+
+DeliveryBoy provides a test mode out of the box. When this mode is enabled, messages will be stored in memory rather than being sent to Kafka. If you use RSpec, enabling test mode is as easy as adding this to your spec helper:
+
+```ruby
+# spec/spec_helper.rb
+require "delivery_boy/rspec"
+```
+
+Now your application can use DeliveryBoy in tests without connecting to an actual Kafka cluster. Asserting that messages have been delivered is simple:
+
+```ruby
+describe PostsController do
+  describe "#show" do
+    it "emits an event to Kafka" do
+      post = Post.create!(body: "hello")
+      
+      get :show, id: post.id
+      
+      # Use this API to extract all messages written to a Kafka topic.
+      messages = DeliveryBoy.testing.messages_for("post_views")
+      
+      expect(messages.count).to eq 1
+      
+      # In addition to #value, you can also pull out #key and #partition_key.
+      event = JSON.parse(messages.first.value)
+      
+      expect(event["post_id"]).to eq post.id
+    end
+  end
+end
+```
+
+This takes care of clearing messages after each example, as well.
+
+If you're not using RSpec, you can easily replicate the functionality yourself. Call `DeliveryBoy.test_mode` at load time, and make sure that `DeliveryBoy.testing.clear` is called after each test.
+
 ### Instrumentation & monitoring
 
 Since DeliveryBoy is just an opinionated API on top of ruby-kafka, you can use all the [instrumentation made available by that library](https://github.com/zendesk/ruby-kafka#instrumentation). You can also use the [existing monitoring solutions](https://github.com/zendesk/ruby-kafka#monitoring) that integrate with various monitoring services.

data/lib/delivery_boy/fake.rb

@@ -18,9 +18,15 @@ module DeliveryBoy
     alias deliver_async! deliver
 
     def shutdown
+      clear
+    end
+
+    # Clear all messages stored in memory.
+    def clear
       @messages.clear
     end
 
+    # Return all messages written to the specified topic.
     def messages_for(topic)
       @messages[topic]
     end

data/lib/delivery_boy/rspec.rb

@@ -0,0 +1,10 @@
+require "delivery_boy"
+
+DeliveryBoy.test_mode!
+
+RSpec.configure do |config|
+  # Clear the messages after each example.
+  config.after(:each) do
+    DeliveryBoy.testing.clear
+  end
+end

data/lib/delivery_boy/version.rb

@@ -1,3 +1,3 @@
 module DeliveryBoy
-  VERSION = "0.2.0.beta1"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: delivery_boy
 version: !ruby/object:Gem::Version
-  version: 0.2.0.beta1
+  version: 0.2.0
 platform: ruby
 authors:
 - Daniel Schierbeck
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-14 00:00:00.000000000 Z
+date: 2017-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-kafka
@@ -90,6 +90,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -105,6 +106,7 @@ files:
 - lib/delivery_boy/fake.rb
 - lib/delivery_boy/instance.rb
 - lib/delivery_boy/railtie.rb
+- lib/delivery_boy/rspec.rb
 - lib/delivery_boy/version.rb
 - lib/generators/delivery_boy/config_file.yml.erb
 - lib/generators/delivery_boy/install_generator.rb
@@ -123,12 +125,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: A simple way to produce messages to Kafka from Ruby applications