fastly_nsq 0.1.4 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 95925013466f1c6030b499fcc757af3bb2ef9108
-  data.tar.gz: de2bf7042bd3c5e3321401292f85f90c711097e5
+  metadata.gz: 325bb3dda2921106c66242e7d74c159e19b1d23a
+  data.tar.gz: d6db3266246c089e744efb2f16fabd0cee8349a8
 SHA512:
-  metadata.gz: d6960321ea681e336e80ece23721a43e6314d1352866fa59b3ee5adb1ba851be9f4119e4514e3d07ed55dfeaefbb7b840d89380b215786524e495f2ef800bded
-  data.tar.gz: 029dc818205f8fa98c697d7de108ef6a4cb2d344f4a106eeca2ad1d18bcbb1475a7bd9800f2e6f44c39d4151201ac61ae9d698e728708c00e5f290ed4f990e5d
+  metadata.gz: cda98052c9c52f8aa1fe65a4dd0a6e311530e300adbf58d1e9bc794a652ed21852c3d6928ef1bf0b98c5e043700f68b2924d4a9de7915e1b008905a3c25097ec
+  data.tar.gz: d58bb1d4976fd771677bf38857b3b292f4bb57fb3cd56fc26772b0761896b91dd7969712f1a9011c59b04a3307b5086b340d74e9bea64fb4a96a6e02c8f69388

data/.gitignore

@@ -3,3 +3,4 @@
 /html/
 /pkg/
 /vendor/cache/*.gem
+spec/examples.txt

data/.ruby-version

@@ -0,0 +1 @@
+2.3.0

data/.travis.yml

@@ -5,7 +5,7 @@ rvm:
   - 2.2.4
   - 2.3.0
 script:
-  - bundle exec rake test
+  - bundle exec rake
 notifications:
   slack:
     rooms:

data/Gemfile

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

data/README.md

@@ -29,7 +29,7 @@ Please use [GitHub Issues] to report bugs.
 
 `fastly_nsq` is a Ruby Gem
 tested against Rails `>= 4.2`
-and Ruby `>= 2.0`.
+and Ruby `>= 2.3.0`.
 
 To get started,
 add `fastly_nsq` to your `Gemfile`
@@ -52,9 +52,9 @@ write messages onto the queue:
 
 ```ruby
 message_data = {
-  "event_type": "heartbeat",
-  "data": {
-    "key": "value"
+  "event_type" => "heartbeat",
+  "data" => {
+    "key" => "value"
   }
 }
 
@@ -73,10 +73,10 @@ to your application:
 
 ```ruby
 # for the fake
-ENV['FAKE_QUEUE'] == true
+ENV['FAKE_QUEUE'] = true
 
 # for the real thing
-ENV['FAKE_QUEUE'] == false
+ENV['FAKE_QUEUE'] = false
 ```
 
 ### `MessageQueue::Consumer`
@@ -94,9 +94,10 @@ consumer = MessageQueue::Consumer.new(
 
 consumer.size #=> 1
 message = consumer.pop
-message.body #=>'hey this is my message!'
+message.body #=> "{ 'event_type': 'heartbeat','data': { 'key': 'value' } }"
 message.finish
 consumer.size #=> 0
+consumer.terminate
 ```
 
 As above,
@@ -117,7 +118,8 @@ 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`.
+and send the JSON text body
+to `MessageProcessor.new(message_body).go`.
 
 To initiate a blocking loop to process messages continuously:
 
@@ -132,8 +134,45 @@ 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`.
+      and send it to `MessageProcessor.new(message_body).go`.
 
+### `MessageQueue::RakeTask`
+
+To help facilitate running the `MessageQueue::Listener` in a blocking fashion
+outside your application, a simple `RakeTask` is provided.
+
+This can be added into your `Rakefile` in one of two ways:
+
+Using a block:
+```ruby
+require 'fastly_nsq'
+require 'fastly_nsq/rake_task'
+
+MessageQueue::RakeTask.new(:listen_task) do |task|
+  task.topic   = 'some_topic'
+  task.channel = 'some_channel'
+end
+
+# usage:
+`rake listen_task`
+```
+
+or using passed in values:
+```ruby
+require 'fastly_nsq'
+require 'fastly_nsq/rake_task'
+
+MessageQueue::RakeTask.new(:listen_task, [:topic, :channel])
+
+# usage:
+`rake listen_task['my_topic','my_channel']`
+```
+
+Both methods can be used at the same time with the passed in values taking
+priority over block assigned values
+
+See the [`Rakefile`](examples/Rakefile) file
+for more detail.
 
 ### Real vs. Fake
 
@@ -163,15 +202,18 @@ 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
+  def initialize(message_body)
+    @message_body = message_body
   end
 
   def start
-    # Do things with the message. It's JSON body is accessible by @message.body.
+    # Do things
+  end
+
+  private
 
-    # Finish the message to let the queue know it is complete like so:
-    @message.finish
+  def message
+    JSON.parse(@message_body)
   end
 end
 ```

data/Rakefile

@@ -17,14 +17,6 @@ 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
@@ -36,5 +28,8 @@ namespace :bundler do
   end
 end
 
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
 task(:default).clear
-task default: ['test', 'bundler:audit']
+task default: ['spec', 'bundler:audit']

data/examples/Rakefile

@@ -0,0 +1,36 @@
+require 'fastly_nsq'
+require 'fastly_nsq/rake_task'
+
+##
+# Both topic and channel will need to be passed into the rake task when
+# it is called.
+#
+# ex: `rake listen_task[my_topic,my_channel]`
+# topic will be 'my_topic' and channel will be 'my_channel'
+#
+MessageQueue::RakeTask.new(:listen_task, [:topic, :channel])
+
+##
+# Topic and channel can also be preset in the task by passing a block and
+# assigning value like so. This is useful if you want a single purpose
+# listener task.
+#
+# ex: `rake listen_task`
+# topic will be 'some_topic' and channel will be 'some_channel'
+#
+MessageQueue::RakeTask.new(:listen_task) do |task|
+  task.topic   = 'some_topic'
+  task.channel = 'some_channel'
+end
+
+##
+# Both forms can be combine to provide defaults of a sort with the ability
+# to override at time of rake call
+#
+# ex: `rake listen_task[altered_topic]`
+# topic will be 'altered_topic' and channel will be 'some_channel'
+#
+MessageQueue::RakeTask.new(:listen_task, [:topic, :channel]) do |task|
+  task.topic   = 'some_topic'
+  task.channel = 'some_channel'
+end

data/fastly_nsq.gemspec

@@ -23,11 +23,10 @@ Gem::Specification.new do |gem|
   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 'rspec', '~> 3.4'
   gem.add_development_dependency 'rubygems-tasks', '~> 0.2'
 
   gem.add_dependency 'nsq-ruby', '~> 1.5.0', '>= 1.5.0'

data/lib/fastly_nsq/message_queue/consumer.rb

@@ -8,7 +8,11 @@ module MessageQueue
     end
 
     def connection
-      consumer.new(params)
+      @connection ||= consumer.new(params)
+    end
+
+    def terminate
+      @connection.terminate
     end
 
     private

data/lib/fastly_nsq/message_queue/listener.rb

@@ -6,22 +6,45 @@ module MessageQueue
     end
 
     def go
+      Signal.trap('INT') do
+        shutdown
+      end
+
+      Signal.trap('TERM') do
+        shutdown
+      end
+
       loop do
-        process_next_message
+        process_one_message
       end
     end
 
     def process_next_message
-      message = consumer.pop
-      MessageProcessor.new(message).go
+      process_one_message
+      consumer.terminate
     end
 
     private
 
+    def process_one_message
+      message = consumer.pop
+      MessageProcessor.new(message.body).go
+      message.finish
+    end
+
     attr_reader :channel, :topic
 
     def consumer
-      MessageQueue::Consumer.new(topic: topic, channel: channel).connection
+      @consumer ||= MessageQueue::Consumer.new(consumer_params).connection
+    end
+
+    def consumer_params
+      { topic: topic, channel: channel }
+    end
+
+    def shutdown
+      consumer.terminate
+      exit
     end
   end
 end

data/lib/fastly_nsq/message_queue/producer.rb

@@ -7,7 +7,11 @@ module MessageQueue
     end
 
     def connection
-      producer.new(params)
+      @producer ||= producer.new(params)
+    end
+
+    def terminate
+      @producer.terminate
     end
 
     private

data/lib/fastly_nsq/rake_task.rb

@@ -0,0 +1,40 @@
+require 'rake'
+require 'rake/tasklib'
+
+module MessageQueue
+  class RakeTask < Rake::TaskLib
+    attr_accessor :name, :topic, :channel
+
+    def initialize(*args, &task_block)
+      @name = args.shift || :begin_listening
+
+      desc 'Listen to NSQ on topic using channel' unless ::Rake.application.last_comment
+
+      task(name, *args) do |_, task_args|
+        RakeFileUtils.send(:verbose, verbose) do
+          yield(*[self, task_args].slice(0, task_block.arity)) if block_given?
+          @topic   = task_args[:topic] if task_args[:topic]
+          @channel = task_args[:channel] if task_args[:channel]
+          run_task
+        end
+      end
+    end
+
+    private
+
+    def run_task
+      raise ArgumentError, "topic and channel are required. Recieved topic: #{topic} channel: #{channel}" unless topic && channel
+
+      output "Listening to the queue on topic:'#{topic}' and channel ':#{channel}'"
+
+      MessageQueue::Listener.new(topic: topic, channel: channel).go
+
+      output "... done listening to queue on topic:'#{topic}' and channel ':#{channel}'"
+    end
+
+    # wrapping output for stubbing in tests to avoid clobbering output...
+    def output(str)
+      puts str
+    end
+  end
+end

data/lib/fastly_nsq/sample_message_processor.rb

@@ -1,25 +1,33 @@
-class HeartbeatWorker; end
-class UnknownMessageWorker; end
+class HeartbeatWorker
+  def self.perform_async(_data)
+    # noop
+  end
+end
+
+class UnknownMessageWorker
+  def self.perform_async(_data)
+    # noop
+  end
+end
 
 class SampleMessageProcessor
   EVENT_TYPE_TO_WORKER_MAP = {
     'heartbeat' => HeartbeatWorker,
   }.freeze
 
-  def initialize(message)
-    @message = message
+  def initialize(message_body)
+    @message_body = message_body
   end
 
   def go
-    process_message
-    message.finish
+    process_message_body
   end
 
   private
 
-  attr_reader :message
+  attr_reader :message_body
 
-  def process_message
+  def process_message_body
     message_processor.perform_async(message_data)
   end
 
@@ -38,8 +46,4 @@ class SampleMessageProcessor
   def parsed_message_body
     JSON.parse(message_body)
   end
-
-  def message_body
-    message.body
-  end
 end

data/lib/fastly_nsq/version.rb

@@ -1,3 +1,3 @@
 module FastlyNsq
-  VERSION = '0.1.4'
+  VERSION = '0.2.0'
 end

data/{test/lib/fastly_nsq/fake_message_queue_test.rb → spec/lib/fastly_nsq/fake_message_queue_spec.rb}

@@ -1,25 +1,25 @@
-require 'test_helper'
+require 'spec_helper'
 
-describe FakeMessageQueue do
+RSpec.describe FakeMessageQueue do
   describe '@@queue' do
     it 'is initalized as an empty array' do
-      assert_equal [], FakeMessageQueue.queue
+      expect(FakeMessageQueue.queue).to eq []
     end
   end
 
   describe '.reset!' do
     it 'resets the fake message queue' do
       FakeMessageQueue.queue = ['hello']
-      assert_equal 1, FakeMessageQueue.queue.size
+      expect(FakeMessageQueue.queue.size).to eq 1
 
       FakeMessageQueue.reset!
 
-      assert_empty FakeMessageQueue.queue
+      expect(FakeMessageQueue.queue).to be_empty
     end
   end
 end
 
-describe FakeMessageQueue::Producer do
+RSpec.describe FakeMessageQueue::Producer do
   after do
     FakeMessageQueue.reset!
   end
@@ -34,12 +34,12 @@ describe FakeMessageQueue::Producer do
       )
       producer.write('hello')
 
-      assert_equal 1, FakeMessageQueue.queue.size
+      expect(FakeMessageQueue.queue.size).to eq 1
     end
   end
 end
 
-describe FakeMessageQueue::Message do
+RSpec.describe FakeMessageQueue::Message do
   after do
     FakeMessageQueue.reset!
   end
@@ -57,12 +57,12 @@ describe FakeMessageQueue::Message do
       message = FakeMessageQueue.queue.pop
       body = message.body
 
-      assert_equal content, body
+      expect(content).to eq body
     end
   end
 end
 
-describe FakeMessageQueue::Consumer do
+RSpec.describe FakeMessageQueue::Consumer do
   after do
     FakeMessageQueue.reset!
   end
@@ -80,7 +80,7 @@ describe FakeMessageQueue::Consumer do
       )
       queue_size = consumer.size
 
-      assert_equal 1, queue_size
+      expect(queue_size).to eq 1
     end
   end
 
@@ -98,7 +98,7 @@ describe FakeMessageQueue::Consumer do
       )
       popped_message = consumer.pop
 
-      assert_equal message, popped_message
+      expect(popped_message). to eq message
     end
   end
 end