fastly_nsq 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 48ea2dde563e4b7556c6d9a9f6841f4350e45013
-  data.tar.gz: bc4035a845e23506b744860d886091c02656832e
+  metadata.gz: ed99890b9268655e4d1e7b151e53274bcbe147c9
+  data.tar.gz: 42d9dffa0b05e5a02be41dd92192c3a3f9834462
 SHA512:
-  metadata.gz: 05ca0f0d7ec7e3c8145462725964424d417a4b4fc714cc1f8a73324ebdf1c2996b618b8f89ae6fc2586e46080ce5a641c155a05d09f4dcef8b189cc2c9a01b4c
-  data.tar.gz: 5fa5f796f804491aeeac0f66e3238c28b404c75d459ebfc749e5317fbc86319a6dfed4bdb6816bc84b275dc9bd88847ad25d76c95ff15abe493fda602459aad8
+  metadata.gz: 81b4855596f0aa86d2457ac2e1375e086999fb37b62be50b6f39d5895de51c34cf807b08355963697062423591dfa69e02567b7b2e1610b097e86caa33472cd2
+  data.tar.gz: b4e51dada6b9cb4b2ac0110911dd86a029be91ed4f3cf8f542095acb68333ba16a8c23f2879a26822b3fcd60cc2b3b4d8aae022e47e7a3438b7ff3c8ca81637b

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+README.md
+CHANGELOG.md
+
+LICENSE.txt

data/.gitignore

@@ -0,0 +1,5 @@
+/.bundle
+/Gemfile.lock
+/html/
+/pkg/
+/vendor/cache/*.gem

data/.rdoc_options

@@ -0,0 +1,16 @@
+--- !ruby/object:RDoc::Options
+encoding: UTF-8
+static_path: []
+rdoc_include:
+  - .
+charset: UTF-8
+exclude:
+hyperlink_all: false
+line_numbers: false
+main_page: README.md
+markup: markdown
+show_hash: false
+tab_width: 8
+title: fastly_nsq Documentation
+visibility: :protected
+webcvs:

data/.travis.yml

@@ -0,0 +1,17 @@
+language: ruby
+cache: bundler
+rvm:
+  - 2.1.8
+  - 2.2.4
+  - 2.3.0
+script:
+  - bundle exec rake test
+notifications:
+  slack:
+    rooms:
+      - 'fastly:hFvhBQKliYl9QAO3VujcrLhe#billy'
+    on_success: change
+    on_failure: change
+  email:
+    on_success: never
+    on_failure: never

data/ChangeLog.md

@@ -0,0 +1,3 @@
+### 0.1.0 / 2016-01-25
+
+* Initial release:

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'minitest-utils', require: false

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2016 Fastly, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,236 @@
+# fastly_nsq [![Build Status](https://travis-ci.org/fastly/fastly_nsq.svg?branch=master)](https://travis-ci.org/fastly/fastly_nsq)
+
+*NOTE: This is a point-release
+which is not yet suitable for production.
+Use at your own peril.*
+
+NSQ adapter and testing objects
+for using the NSQ messaging system
+in your Ruby project.
+
+This library is intended
+to facilitate publishing and consuming
+messages on an NSQ messaging queue.
+
+We also include fakes
+to make testing easier.
+
+This library is dependent
+on the [`nsq-ruby`] gem.
+
+[`nsq-ruby`]: https://github.com/wistia/nsq-ruby
+
+Please use [GitHub Issues] to report bugs.
+
+[GitHub Issues]: https://github.com/fastly/fastly_nsq/issues
+
+
+## Install
+
+`fastly_nsq` is a Ruby Gem
+tested against Rails `>= 4.2`
+and Ruby `>= 2.0`.
+
+To get started,
+add `fastly_nsq` to your `Gemfile`
+and `bundle install`.
+
+## Usage
+
+*IMPORTANT NOTE:* You must create your own `MessageProcessor` class
+for this gem to work in your application.
+
+See more information below.
+
+### `MessageQueue::Producer`
+
+This is a class
+which provides an adapter to the
+fake and real NSQ producers.
+These are used to
+write messages onto the queue:
+
+```ruby
+message_data = {
+  "event_type": "heartbeat",
+  "data": {
+    "key": "value"
+  }
+}
+
+producer = MessageQueue::Producer.new(
+  nsqd: ENV.fetch('NSQD_TCP_ADDRESS'),
+  topic: topic,
+).connection
+
+producer.write(message_data.to_json)
+```
+
+The mock/real strategy used
+can be switched
+by adding an environment variable
+to your application:
+
+```ruby
+# for the fake
+ENV['FAKE_QUEUE'] == true
+
+# for the real thing
+ENV['FAKE_QUEUE'] == false
+```
+
+### `MessageQueue::Consumer`
+This is a class
+which provides an adapter to the
+fake and real NSQ consumers.
+These are used to
+read messages off of the queue:
+
+```ruby
+consumer = MessageQueue::Consumer.new(
+  topic: 'topic',
+  channel: 'channel'
+).connection
+
+consumer.size #=> 1
+message = consumer.pop
+message.body #=>'hey this is my message!'
+message.finish
+consumer.size #=> 0
+```
+
+As above,
+the mock/real strategy used
+can be switched by setting the
+`FAKE_QUEUE` environment variable appropriately.
+
+### `MessageQueue::Listener`
+
+To process the next message on the queue:
+
+```ruby
+topic = 'user_created'
+channel = 'my_consuming_service'
+
+MessageQueue::Listener.new(topic: topic, channel: channel).process_next_message
+```
+
+This will pop the next message
+off of the queue
+and send it to `MessageProcessor.new(message).go`.
+
+To initiate a blocking loop to process messages continuously:
+
+```ruby
+topic = 'user_created'
+channel = 'my_consuming_service'
+
+MessageQueue::Listener.new(topic: topic, channel: channel).go
+```
+
+This will block until
+there is a new message on the queue,
+      pop the next message
+      off of the queue
+      and send it to `MessageProcessor.new(message).go`.
+
+
+### Real vs. Fake
+
+The real strategy
+creates a connection
+to `nsq-ruby`'s
+`Nsq::Producer` and `Nsq::Consumer` classes.
+
+The fake strategy
+mocks the connection
+to NSQ for testing purposes.
+It adheres to the same API
+as the real adapter.
+
+
+## Configuration
+
+### Processing Messages
+
+This gem expects you to create a
+new class called `MessageProcessor`
+which will process messages
+once they are consumed off of the queue topic.
+
+This class needs to adhere to the following API:
+
+```ruby
+class MessageProcessor
+  # This an instance of NSQ::Message or FakeMessageQueue::Message
+  def initialize(message)
+    @message = message
+  end
+
+  def start
+    # Do things with the message. It's JSON body is accessible by @message.body.
+
+    # Finish the message to let the queue know it is complete like so:
+    @message.finish
+  end
+end
+```
+
+### Environment Variables
+
+The URLs for the various
+NSQ endpoints are expected
+in `ENV` variables.
+
+Below are the required variables
+and sample values for using
+stock NSQ on OS X,
+installed via Homebrew:
+
+```shell
+BROADCAST_ADDRESS='127.0.0.1'
+NSQD_TCP_ADDRESS='127.0.0.1:4150'
+NSQD_HTTP_ADDRESS='127.0.0.1:4151'
+NSQLOOKUPD_TCP_ADDRESS='127.0.0.1:4160'
+NSQLOOKUPD_HTTP_ADDRESS='127.0.0.1:4161'
+```
+
+See the [`.sample.env`](examples/.sample.env) file
+for more detail.
+
+### Testing Against the Fake
+
+In the gem's test suite,
+the fake message queue is used.
+
+If you would like to force
+use of the real NSQ adapter,
+ensure `FAKE_QUEUE` is set to `false`.
+
+When you are developing your application,
+it is recommended to
+start by using the fake queue:
+
+```shell
+FAKE_QUEUE=true
+```
+
+Also note that during gem tests,
+we are aliasing `MessageProcessor` to `SampleMessageProcessor`.
+You can also refer to the latter
+as an example of how
+you might write your own processor.
+
+## Acknowledgements
+
+* Documentation inspired by [Steve Losh's "Teach Don't Tell"] post.
+* Thanks to Wistia for `nsq-ruby`.
+
+[Steve Losh's "Teach Don't Tell"]: http://stevelosh.com/blog/2013/09/teach-dont-tell/
+
+
+## Copyright
+
+Copyright (c) 2016 Fastly, Inc under an MIT license.
+
+See [LICENSE.txt](LICENSE.txt) for details.

data/Rakefile

@@ -0,0 +1,40 @@
+# encoding: utf-8
+
+require 'rubygems'
+
+begin
+  require 'bundler/setup'
+rescue LoadError => e
+  abort e.message
+end
+
+require 'rake'
+
+require 'rubygems/tasks'
+Gem::Tasks.new
+
+require 'rdoc/task'
+RDoc::Task.new
+task doc: :rdoc
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+require 'bundler/audit/cli'
+
+namespace :bundler do
+  desc 'Updates the ruby-advisory-db and runs audit'
+  task :audit do
+    %w(update check).each do |command|
+      Bundler::Audit::CLI.start [command]
+    end
+  end
+end
+
+task(:default).clear
+task default: ['test', 'bundler:audit']

data/env_configuration_for_local_gem_tests.yml

@@ -0,0 +1,6 @@
+BROADCAST_ADDRESS: '127.0.0.1'
+NSQD_TCP_ADDRESS: '127.0.0.1:4150'
+NSQD_HTTP_ADDRESS: '127.0.0.1:4151'
+NSQLOOKUPD_TCP_ADDRESS: '127.0.0.1:4160'
+NSQLOOKUPD_HTTP_ADDRESS: '127.0.0.1:4161'
+FAKE_QUEUE: 'true'

data/examples/.sample.env

@@ -0,0 +1,17 @@
+# NSQ
+# In the Fastly Dev VM
+BROADCAST_ADDRESS='billing'
+NSQD_TCP_ADDRESS='billing:1910'
+NSQD_HTTP_ADDRESS='billing:1911'
+NSQLOOKUPD_TCP_ADDRESS='billing:4160'
+NSQLOOKUPD_HTTP_ADDRESS='billing:4161'
+
+# On OSX with Homebrew defaults (brew install nsq)
+BROADCAST_ADDRESS='127.0.0.1'
+NSQD_TCP_ADDRESS='127.0.0.1:4150'
+NSQD_HTTP_ADDRESS='127.0.0.1:4151'
+NSQLOOKUPD_TCP_ADDRESS='127.0.0.1:4160'
+NSQLOOKUPD_HTTP_ADDRESS='127.0.0.1:4161'
+
+# Uncomment to test against a live queue
+#LIVE_QUEUE=true

data/fastly_nsq.gemspec

@@ -0,0 +1,34 @@
+# -*- encoding: utf-8 -*-
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fastly_nsq/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = 'fastly_nsq'
+  gem.version       = FastlyNsq::VERSION
+  gem.summary       = 'Fastly NSQ Adapter'
+  gem.description   = "Helper classes for Fastly's NSQ Services"
+  gem.license       = 'MIT'
+  gem.authors       = ["Tommy O'Neil", 'Adarsh Pandit']
+  gem.email         = 'tommy@fastly.com'
+  gem.homepage      = 'https://github.com/fastly/fastly-nsq'
+
+  gem.files         = `git ls-files`.split("\n")
+
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|features)/})
+  gem.require_paths = ['lib']
+
+  gem.add_development_dependency 'awesome_print', '~> 1.6'
+  gem.add_development_dependency 'bundler', '~> 1.10'
+  gem.add_development_dependency 'bundler-audit', '~> 0.4'
+  gem.add_development_dependency 'minitest', '~> 5.8'
+  gem.add_development_dependency 'pry-byebug', '~> 3.3'
+  gem.add_development_dependency 'rake', '~> 10.5'
+  gem.add_development_dependency 'rdoc', '~> 4.2'
+  gem.add_development_dependency 'rspec-mocks', '~> 3.4'
+  gem.add_development_dependency 'rubygems-tasks', '~> 0.2'
+
+  gem.add_dependency 'nsq-ruby', '~> 1.5.0', '>= 1.5.0'
+end

data/lib/fastly_nsq.rb

@@ -0,0 +1,3 @@
+require 'fastly_nsq/version'
+
+require 'fastly_nsq/message_queue'

data/lib/fastly_nsq/fake_message_queue.rb

@@ -0,0 +1,59 @@
+module FakeMessageQueue
+  def self.queue
+    @@queue
+  end
+
+  def self.queue=(message)
+    @@queue = message
+  end
+
+  def self.reset!
+    self.queue = []
+  end
+
+  class Producer
+    def initialize(nsqd:, topic:)
+    end
+
+    def write(string)
+      message = Message.new(string)
+      queue.push(message)
+    end
+
+    private
+
+    def queue
+      FakeMessageQueue.queue
+    end
+  end
+
+  class Consumer
+    def initialize(nsqlookupd:, topic:, channel:)
+    end
+
+    def pop
+      queue.pop
+    end
+
+    def size
+      queue.size
+    end
+
+    private
+
+    def queue
+      FakeMessageQueue.queue
+    end
+  end
+
+  class Message
+    attr_reader :body
+
+    def initialize(body)
+      @body = body
+    end
+
+    def finish
+    end
+  end
+end

data/lib/fastly_nsq/message_queue.rb

@@ -0,0 +1,11 @@
+require 'nsq'
+require_relative 'fake_message_queue'
+require_relative 'message_queue/listener'
+require_relative 'message_queue/producer'
+require_relative 'message_queue/consumer'
+require_relative 'message_queue/strategy'
+
+module MessageQueue
+  FALSY_VALUES = [false, 0, '0', 'false', 'FALSE', 'off', 'OFF', nil]
+  TRUTHY_VALUES = [true, 1, '1', 'true', 'TRUE', 'on', 'ON']
+end

data/lib/fastly_nsq/message_queue/consumer.rb

@@ -0,0 +1,30 @@
+class InvalidParameterError < StandardError; end;
+
+module MessageQueue
+  class Consumer
+    def initialize(topic:, channel:)
+      @topic = topic
+      @channel = channel
+    end
+
+    def connection
+      consumer.new(params)
+    end
+
+    private
+
+    attr_reader :channel, :topic
+
+    def consumer
+      Strategy.for_queue::Consumer
+    end
+
+    def params
+      {
+        nsqlookupd: ENV.fetch('NSQLOOKUPD_HTTP_ADDRESS'),
+        topic: topic,
+        channel: channel,
+      }
+    end
+  end
+end

data/lib/fastly_nsq/message_queue/listener.rb

@@ -0,0 +1,27 @@
+module MessageQueue
+  class Listener
+    def initialize(topic:, channel:)
+      @topic = topic
+      @channel = channel
+    end
+
+    def go
+      loop do
+        process_next_message
+      end
+    end
+
+    def process_next_message
+      message = consumer.pop
+      MessageProcessor.new(message).go
+    end
+
+    private
+
+    attr_reader :channel, :topic
+
+    def consumer
+      MessageQueue::Consumer.new(topic: topic, channel: channel).connection
+    end
+  end
+end

data/lib/fastly_nsq/message_queue/producer.rb

@@ -0,0 +1,28 @@
+class InvalidParameterError < StandardError; end;
+
+module MessageQueue
+  class Producer
+    def initialize(topic:)
+      @topic = topic
+    end
+
+    def connection
+      producer.new(params)
+    end
+
+    private
+
+    attr_reader :topic
+
+    def producer
+      Strategy.for_queue::Producer
+    end
+
+    def params
+      {
+        nsqd: ENV.fetch('NSQD_TCP_ADDRESS'),
+        topic: topic,
+      }
+    end
+  end
+end

data/lib/fastly_nsq/message_queue/strategy.rb

@@ -0,0 +1,12 @@
+class Strategy
+  def self.for_queue
+    if MessageQueue::FALSY_VALUES.include?(ENV['FAKE_QUEUE'])
+      Nsq
+    elsif MessageQueue::TRUTHY_VALUES.include?(ENV['FAKE_QUEUE'])
+      FakeMessageQueue
+    else
+      message = "You must set ENV['FAKE_QUEUE'] to either true or false"
+      raise InvalidParameterError, message
+    end
+  end
+end

data/lib/fastly_nsq/sample_message_processor.rb

@@ -0,0 +1,45 @@
+class HeartbeatWorker; end
+class UnknownMessageWorker; end
+
+class SampleMessageProcessor
+  EVENT_TYPE_TO_WORKER_MAP = {
+    'heartbeat' => HeartbeatWorker,
+  }.freeze
+
+  def initialize(message)
+    @message = message
+  end
+
+  def go
+    process_message
+    message.finish
+  end
+
+  private
+
+  attr_reader :message
+
+  def process_message
+    message_processor.perform_async(message_data)
+  end
+
+  def message_processor
+    EVENT_TYPE_TO_WORKER_MAP.fetch(event_type, UnknownMessageWorker)
+  end
+
+  def event_type
+    parsed_message_body['event_type']
+  end
+
+  def message_data
+    parsed_message_body['data']
+  end
+
+  def parsed_message_body
+    JSON.parse(message_body)
+  end
+
+  def message_body
+    message.body
+  end
+end

data/lib/fastly_nsq/version.rb

@@ -0,0 +1,3 @@
+module FastlyNsq
+  VERSION = '0.1.3'
+end

data/test/lib/fastly_nsq/fake_message_queue_test.rb

@@ -0,0 +1,86 @@
+require 'test_helper'
+
+describe FakeMessageQueue do
+  describe '.reset!' do
+    it 'resets the fake message queue' do
+      FakeMessageQueue.queue = ['hello']
+      assert_equal 1, FakeMessageQueue.queue.size
+
+      FakeMessageQueue.reset!
+
+      assert_empty FakeMessageQueue.queue
+    end
+  end
+end
+
+describe FakeMessageQueue::Producer do
+  describe '#write' do
+    it 'adds a new message to the queue' do
+      topic = 'death_star'
+
+      producer = FakeMessageQueue::Producer.new(
+        nsqd: ENV.fetch('NSQD_TCP_ADDRESS'),
+        topic: topic,
+      )
+      producer.write('hello')
+
+      assert_equal 1, FakeMessageQueue.queue.size
+    end
+  end
+end
+
+describe FakeMessageQueue::Message do
+  describe '#body' do
+    it 'returns the body of the message' do
+      topic = 'death_star'
+      content = 'hello'
+      producer = FakeMessageQueue::Producer.new(
+        nsqd: ENV.fetch('NSQD_TCP_ADDRESS'),
+        topic: topic,
+      )
+      producer.write(content)
+
+      message = FakeMessageQueue.queue.pop
+      body = message.body
+
+      assert_equal content, body
+    end
+  end
+end
+
+describe FakeMessageQueue::Consumer do
+  describe '#size' do
+    it 'tells you how many messages are in the queue' do
+      FakeMessageQueue.queue = ['hello']
+      topic = 'death_star'
+      channel = 'star_killer_base'
+
+      consumer = FakeMessageQueue::Consumer.new(
+        nsqlookupd: ENV.fetch('NSQLOOKUPD_HTTP_ADDRESS'),
+        topic: topic,
+        channel: channel,
+      )
+      queue_size = consumer.size
+
+      assert_equal 1, queue_size
+    end
+  end
+
+  describe '#pop' do
+    it 'returns the last message off of the queue' do
+      message = FakeMessageQueue::Message.new('hello')
+      FakeMessageQueue.queue = [message]
+      topic = 'death_star'
+      channel = 'star_killer_base'
+
+      consumer = FakeMessageQueue::Consumer.new(
+        nsqlookupd: ENV.fetch('NSQLOOKUPD_HTTP_ADDRESS'),
+        topic: topic,
+        channel: channel,
+      )
+      popped_message = consumer.pop
+
+      assert_equal message, popped_message
+    end
+  end
+end

data/test/lib/fastly_nsq/fastly_nsq_test.rb

@@ -0,0 +1,10 @@
+require 'test_helper'
+require 'fastly_nsq'
+
+describe FastlyNsq do
+  it 'has a version number' do
+    version = FastlyNsq.const_get('VERSION')
+
+    assert(!version.empty?, 'should have a VERSION constant')
+  end
+end

data/test/lib/fastly_nsq/message_queue/consumer_test.rb

@@ -0,0 +1,59 @@
+require 'test_helper'
+
+describe MessageQueue::Consumer do
+  describe '#connection' do
+    describe 'when using the real queue' do
+      it 'returns an instance of the queue consumer' do
+        MessageQueue::FALSY_VALUES.each do |no|
+          allow(ENV).to receive(:[]).with('FAKE_QUEUE').and_return(no)
+          allow(Nsq::Consumer).to receive(:new)
+          topic = 'death_star'
+          channel = 'star_killer_base'
+
+          MessageQueue::Consumer.new(topic: topic, channel: channel).connection
+
+          expect(Nsq::Consumer).to have_received(:new).
+            with(
+              nsqlookupd: ENV.fetch('NSQLOOKUPD_HTTP_ADDRESS'),
+              topic: topic,
+              channel: channel,
+          ).at_least(:once)
+        end
+      end
+    end
+  end
+
+  describe 'when using the fake queue' do
+    it 'returns an instance of the queue consumer' do
+      MessageQueue::TRUTHY_VALUES.each do |yes|
+        allow(ENV).to receive(:[]).with('FAKE_QUEUE').and_return(yes)
+        allow(FakeMessageQueue::Consumer).to receive(:new)
+        topic = 'death_star'
+        channel = 'star_killer_base'
+
+        MessageQueue::Consumer.new(topic: topic, channel: channel).connection
+
+        expect(FakeMessageQueue::Consumer).to have_received(:new).
+          with(
+            nsqlookupd: ENV.fetch('NSQLOOKUPD_HTTP_ADDRESS'),
+            topic: topic,
+            channel: channel,
+        ).at_least(:once)
+      end
+    end
+  end
+
+  describe 'when the ENV is set incorrectly' do
+    it 'raises with a helpful error' do
+      allow(ENV).to receive(:[]).with('FAKE_QUEUE').and_return('taco')
+      topic = 'death_star'
+      channel = 'star_killer_base'
+
+      consumer = MessageQueue::Consumer.new(topic: topic, channel: channel)
+
+      assert_raises(InvalidParameterError) do
+        consumer.connection
+      end
+    end
+  end
+end

data/test/lib/fastly_nsq/message_queue/listener_test.rb

@@ -0,0 +1,45 @@
+require 'test_helper'
+
+describe MessageQueue::Listener do
+  describe '#process_next_message' do
+    it 'pass the topic and channel to the consumer' do
+      allow(SampleMessageProcessor).to receive_message_chain(:new, :go)
+      allow(MessageQueue::Consumer).to receive_message_chain(
+        :new,
+        :connection,
+        :pop,
+      )
+      topic = 'minitest'
+      channel = 'northstar'
+
+      MessageQueue::Listener.new(topic: topic, channel: channel).
+        process_next_message
+
+      expect(MessageQueue::Consumer).to have_received(:new).
+        with(topic: topic, channel: channel)
+    end
+
+    it 'processes the message' do
+      process_message = double(go: nil)
+      allow(MessageProcessor).to receive(:new).and_return(process_message)
+      message = double
+      allow(MessageQueue::Consumer).to receive_message_chain(
+        :new,
+        :connection,
+        pop: message
+      )
+      topic = 'minitest'
+      channel = 'northstar'
+
+      MessageQueue::Listener.new(topic: topic, channel: channel).
+        process_next_message
+
+      expect(MessageProcessor).to have_received(:new).with(message)
+      expect(process_message).to have_received(:go)
+    end
+  end
+
+  describe '#go' do
+    # Infinite loops are untestable
+  end
+end

data/test/lib/fastly_nsq/message_queue/producer_test.rb

@@ -0,0 +1,54 @@
+require 'test_helper'
+
+describe MessageQueue::Producer do
+  describe '#connection' do
+    describe 'when using the real queue' do
+      it 'returns an instance of the queue producer' do
+        MessageQueue::FALSY_VALUES.each do |no|
+          allow(ENV).to receive(:[]).with('FAKE_QUEUE').and_return(no)
+          allow(Nsq::Producer).to receive(:new)
+          topic = 'death_star'
+
+          MessageQueue::Producer.new(topic: topic).connection
+
+          expect(Nsq::Producer).to have_received(:new).
+            with(
+              nsqd: ENV.fetch('NSQD_TCP_ADDRESS'),
+              topic: topic,
+          ).at_least(:once)
+        end
+      end
+    end
+  end
+
+  describe 'when using the fake queue' do
+    it 'returns an instance of the queue producer' do
+      MessageQueue::TRUTHY_VALUES.each do |yes|
+        allow(ENV).to receive(:[]).with('FAKE_QUEUE').and_return(yes)
+        allow(FakeMessageQueue::Producer).to receive(:new)
+        topic = 'death_star'
+
+        MessageQueue::Producer.new(topic: topic).connection
+
+        expect(FakeMessageQueue::Producer).to have_received(:new).
+          with(
+            nsqd: ENV.fetch('NSQD_TCP_ADDRESS'),
+            topic: topic,
+        ).at_least(:once)
+      end
+    end
+  end
+
+  describe 'when the ENV is set incorrectly' do
+    it 'raises with a helpful error' do
+      allow(ENV).to receive(:[]).with('FAKE_QUEUE').and_return('taco')
+      topic = 'death_star'
+
+      producer = MessageQueue::Producer.new(topic: topic)
+
+      assert_raises(InvalidParameterError) do
+        producer.connection
+      end
+    end
+  end
+end

data/test/lib/fastly_nsq/message_queue/strategy.rb

@@ -0,0 +1,39 @@
+require 'test_helper'
+
+describe Strategy do
+  describe '.for_queue' do
+    describe 'when using the fake queue' do
+      it 'returns the strategy based on the ENV variable' do
+        MessageQueue::TRUTHY_VALUES.each do |yes|
+          allow(ENV).to receive(:[]).with('FAKE_QUEUE').and_return(yes)
+
+          strategy = Strategy.for_queue
+
+          assert equal FakeMessageQueue, strategy
+        end
+      end
+    end
+
+    describe 'when using the real queue' do
+      it 'returns the strategy based on the ENV variable' do
+        MessageQueue::FALSY_VALUES.each do |no|
+          allow(ENV).to receive(:[]).with('FAKE_QUEUE').and_return(no)
+
+          strategy = Strategy.for_queue
+
+          assert equal Nsq, strategy
+        end
+      end
+    end
+
+    describe 'when the ENV is set incorrectly' do
+      it 'raises with a helpful error' do
+        allow(ENV).to receive(:[]).with('FAKE_QUEUE').and_return('taco')
+
+        assert_raises(InvalidParameterError) do
+          Strategy.for_queue
+        end
+      end
+    end
+  end
+end

data/test/lib/fastly_nsq/sample_message_processor_test.rb

@@ -0,0 +1,59 @@
+require 'test_helper'
+
+describe SampleMessageProcessor do
+  describe '#start' do
+    it 'enqueues the appropriate message processor' do
+      data =  { 'key' => 'value' }
+      body = { 'event_type' => 'heartbeat', 'data' => data }.to_json
+      message = double('Message', body: body, finish: nil)
+      allow(HeartbeatWorker).to receive(:perform_async)
+
+      SampleMessageProcessor.new(message).go
+
+      expect(HeartbeatWorker).to have_received(:perform_async).with(data)
+    end
+
+    it 'finishes the message' do
+      data =  { 'key' => 'value' }
+      body = { 'event_type' => 'heartbeat', 'data' => data }.to_json
+      message = double('Message', body: body, finish: nil)
+      allow(HeartbeatWorker).to receive(:perform_async)
+
+      SampleMessageProcessor.new(message).go
+
+      expect(message).to have_received(:finish)
+    end
+
+    describe 'when the message event_type is not known' do
+      it 'uses the null object processor' do
+        data = { 'sample_key' => 'sample value' }
+        body = {
+          'event_type' => 'unregistered_message_type',
+          'data' => data,
+        }.to_json
+        message = double('Message', body: body, finish: nil)
+        allow(UnknownMessageWorker).to receive(:perform_async)
+
+        SampleMessageProcessor.new(message).go
+
+        expect(UnknownMessageWorker).to have_received(:perform_async).with(data)
+      end
+    end
+
+    describe 'when the message lacks an event_type' do
+      it 'uses the null object processor' do
+        data = { 'sample_key' => 'sample value' }
+        body = {
+          'not_the_event_type_key' => 'unregistered_message_type',
+          'data' => data,
+        }.to_json
+        message = double('Message', body: body, finish: nil)
+        allow(UnknownMessageWorker).to receive(:perform_async)
+
+        SampleMessageProcessor.new(message).go
+
+        expect(UnknownMessageWorker).to have_received(:perform_async).with(data)
+      end
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,50 @@
+require 'rubygems'
+
+begin
+  require 'bundler/setup'
+rescue LoadError => error
+  abort error.message
+end
+
+require 'fastly_nsq'
+
+require 'minitest/autorun'
+require 'awesome_print'
+require 'pry-byebug'
+require_relative '../lib/fastly_nsq/sample_message_processor'
+
+MessageProcessor = SampleMessageProcessor
+
+MiniTest::Spec.before do
+  load_sample_environment_variables
+  FakeMessageQueue.reset!
+end
+
+def load_sample_environment_variables
+  env_file = File.open('env_configuration_for_local_gem_tests.yml')
+
+  YAML.load(env_file).each do |key, value|
+    ENV[key.to_s] = value
+  end
+end
+
+require 'rspec/mocks'
+module MinitestRSpecMocksIntegration
+  include ::RSpec::Mocks::ExampleMethods
+
+  def before_setup
+    ::RSpec::Mocks.setup
+    super
+  end
+
+  def after_teardown
+    super
+    ::RSpec::Mocks.verify
+  ensure
+    ::RSpec::Mocks.teardown
+  end
+end
+
+class MiniTest::Spec
+  include MinitestRSpecMocksIntegration
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fastly_nsq
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Tommy O'Neil
@@ -162,7 +162,36 @@ email: tommy@fastly.com
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- ".document"
+- ".gitignore"
+- ".rdoc_options"
+- ".travis.yml"
+- ChangeLog.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- env_configuration_for_local_gem_tests.yml
+- examples/.sample.env
+- fastly_nsq.gemspec
+- lib/fastly_nsq.rb
+- lib/fastly_nsq/fake_message_queue.rb
+- lib/fastly_nsq/message_queue.rb
+- lib/fastly_nsq/message_queue/consumer.rb
+- lib/fastly_nsq/message_queue/listener.rb
+- lib/fastly_nsq/message_queue/producer.rb
+- lib/fastly_nsq/message_queue/strategy.rb
+- lib/fastly_nsq/sample_message_processor.rb
+- lib/fastly_nsq/version.rb
+- test/lib/fastly_nsq/fake_message_queue_test.rb
+- test/lib/fastly_nsq/fastly_nsq_test.rb
+- test/lib/fastly_nsq/message_queue/consumer_test.rb
+- test/lib/fastly_nsq/message_queue/listener_test.rb
+- test/lib/fastly_nsq/message_queue/producer_test.rb
+- test/lib/fastly_nsq/message_queue/strategy.rb
+- test/lib/fastly_nsq/sample_message_processor_test.rb
+- test/test_helper.rb
 homepage: https://github.com/fastly/fastly-nsq
 licenses:
 - MIT
@@ -187,4 +216,12 @@ rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Fastly NSQ Adapter
-test_files: []
+test_files:
+- test/lib/fastly_nsq/fake_message_queue_test.rb
+- test/lib/fastly_nsq/fastly_nsq_test.rb
+- test/lib/fastly_nsq/message_queue/consumer_test.rb
+- test/lib/fastly_nsq/message_queue/listener_test.rb
+- test/lib/fastly_nsq/message_queue/producer_test.rb
+- test/lib/fastly_nsq/message_queue/strategy.rb
+- test/lib/fastly_nsq/sample_message_processor_test.rb
+- test/test_helper.rb