fastly_nsq 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8ccbc7fd7e6fa179bd882b2484044920665c0a3a
-  data.tar.gz: eb2b73af286d71f8e8a4c07de67801ebf50768fb
+  metadata.gz: 675e3b849867520a11d52017b73a07381287abee
+  data.tar.gz: 6f6f61ed2785d5872e2ea944d88bafffdc1c7817
 SHA512:
-  metadata.gz: 023c35498c520e22c39fae392a1d912297b66371bf177aca8ee3a8c6a74941b5024c078a91f576b3659bef3efcddd7372bff70b363f040a7ced73f8076ca0b1f
-  data.tar.gz: d9bd4a185e4540466e8c4dbe64aef1e6cda7627019c98860d1a482052ca3fdf1beee7d75f2821b966b19437a81599e7b61dff631fe3b6dcf3c204f9cd0ec41ff
+  metadata.gz: 5c8e596008b721e62a78064d98e185dfeae6c2f176a995ffdf3835103d90b9bf1e537aa29a004c9acfdd9d3503961eecb998e9dcb6a7afaf9e6d46c3f6c3fc62
+  data.tar.gz: f386146874a9fd8ed2bcfeaff3a17fac5568b28873a55de583dda3f33b0ab821bc4a56a36008b5ad971be4e4a4d69ac3f7cb23d1fb2bb326721372e3d71c06c1

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,30 @@
+Reason for Change
+===================
+Describe the big picture of your changes here to communicate why this pull
+request should be accepted. If it fixes a bug or resolves a feature request,
+be sure to link to that issue.
+
+List of Changes
+===============
+* Describe your changes
+* As a concise list of items
+
+Risks
+=====
+Describe any risks you see to existing systems this fix or feature might have
+if those systems where to incorporate this change.
+
+Checklist
+=========
+_Put an `x` in the boxes that apply. 
+You can also fill these out after creating the PR._
+
+- [ ] I have linked to all relavant reference issues or work requests
+- [ ] I have added tests that prove my fix is effective or that my feature works
+- [ ] I have added or updated necessary documentation (if appropriate)
+- [ ] Any dependent changes have been merged and published in downstream
+
+
+Recommended Reviewers
+=====================
+@alieander, ...

data/examples/Rakefile

@@ -10,6 +10,11 @@ require 'fastly_nsq/rake_task'
 #
 MessageQueue::RakeTask.new(:listen_task, [:topic, :channel])
 
+##
+# In Rails, you can include the environment like so:
+#
+MessageQueue::RakeTask.new(:listen_task, [:topic, :channel] => :environment)
+
 ##
 # 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

data/lib/fastly_nsq/fake_message_queue.rb

@@ -1,12 +1,24 @@
 module FakeMessageQueue
-  @@queue = Queue.new
+  @@logger = Logger.new(nil)
 
   def self.queue
     @@queue
   end
 
+  def self.queue=(message)
+    @@queue = message
+  end
+
   def self.reset!
-    self.queue.clear
+    self.queue = []
+  end
+
+  def self.logger=(logger)
+    @@logger = logger
+  end
+
+  def self.logger
+    @@logger
   end
 
   class Producer
@@ -30,11 +42,20 @@ module FakeMessageQueue
   end
 
   class Consumer
+    SECONDS_BETWEEN_QUEUE_CHECKS = 0.5
+
     def initialize(nsqlookupd:, topic:, channel:)
     end
 
     def pop
-      queue.pop
+      message = nil
+
+      until message do
+        message = queue.pop
+        sleep SECONDS_BETWEEN_QUEUE_CHECKS
+      end
+
+      message
     end
 
     def size

data/lib/fastly_nsq/message_queue.rb

@@ -8,4 +8,16 @@ 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']
+
+  def self.logger=(logger)
+    strategy.logger = logger
+  end
+
+  def self.logger
+    strategy.logger
+  end
+
+  def self.strategy
+    Strategy.for_queue
+  end
 end

data/lib/fastly_nsq/version.rb

@@ -1,3 +1,3 @@
 module FastlyNsq
-  VERSION = '0.2.2'
+  VERSION = '0.2.3'
 end

data/spec/lib/fastly_nsq/fake_message_queue_spec.rb

@@ -2,17 +2,31 @@ require 'spec_helper'
 
 RSpec.describe FakeMessageQueue do
   describe '@@queue' do
-    it 'is initalized as an empty Ruby Queue' do
-      queue = FakeMessageQueue.queue
+    it 'is initalized as an empty array' do
+      expect(FakeMessageQueue.queue).to eq []
+    end
+  end
 
-      expect(queue).to be_a Thread::Queue
-      expect(queue).to be_empty
+  describe '@@logger' do
+    after do
+      FakeMessageQueue.logger = Logger.new(nil)
+    end
+
+    it 'is initalized as an empty Ruby Logger' do
+      expect(FakeMessageQueue.logger).to be_a Logger
+    end
+
+    it 'can be set and retrieved' do
+      logger = double('some logger')
+      FakeMessageQueue.logger = logger
+
+      expect(FakeMessageQueue.logger).to eq logger
     end
   end
 
   describe '.reset!' do
     it 'resets the fake message queue' do
-      FakeMessageQueue.queue.push('hello')
+      FakeMessageQueue.queue = ['hello']
       expect(FakeMessageQueue.queue.size).to eq 1
 
       FakeMessageQueue.reset!
@@ -42,8 +56,9 @@ RSpec.describe FakeMessageQueue::Producer do
   end
 
   describe '#terminate' do
-    it 'has a terminate method which is a noop' do
+    it 'has a `terminate` method which is a noop' do
       producer = instance_double('FakeMessageQueue::Producer')
+
       allow(producer).to receive(:terminate)
     end
   end
@@ -79,7 +94,7 @@ RSpec.describe FakeMessageQueue::Consumer do
 
   describe '#size' do
     it 'tells you how many messages are in the queue' do
-      FakeMessageQueue.queue.push('hello')
+      FakeMessageQueue.queue = ['hello']
       topic = 'death_star'
       channel = 'star_killer_base'
 
@@ -98,7 +113,7 @@ RSpec.describe FakeMessageQueue::Consumer do
     context 'when there is a message on the queue' do
       it 'returns the last message off of the queue' do
         message = FakeMessageQueue::Message.new('hello')
-        FakeMessageQueue.queue.push(message)
+        FakeMessageQueue.queue = [message]
         topic = 'death_star'
         channel = 'star_killer_base'
 
@@ -114,10 +129,11 @@ RSpec.describe FakeMessageQueue::Consumer do
     end
 
     context 'when there no message on the queue' do
-      it 'blocks on the process, waiting for a message ' do
-        FakeMessageQueue.reset!
+      it 'blocks for longer than the queue check cycle' do
+        FakeMessageQueue.queue = []
         topic = 'death_star'
         channel = 'star_killer_base'
+        delay = FakeMessageQueue::Consumer::SECONDS_BETWEEN_QUEUE_CHECKS + 0.1
 
         consumer = FakeMessageQueue::Consumer.new(
           nsqlookupd: ENV.fetch('NSQLOOKUPD_HTTP_ADDRESS'),
@@ -126,7 +142,7 @@ RSpec.describe FakeMessageQueue::Consumer do
         )
 
         expect {
-          Timeout::timeout(0.1) do
+          Timeout::timeout(delay) do
             consumer.pop
           end
         }.to raise_error(Timeout::Error)

data/spec/lib/fastly_nsq/message_queue/listener_spec.rb

@@ -51,20 +51,18 @@ RSpec.describe MessageQueue::Listener do
       expect(message).to have_received(:finish)
     end
 
-    context 'when using the fake queue and it is empty' do
-      it 'blocks on the process, waiting for a message ' do
-        MessageQueue::TRUTHY_VALUES.each do |yes|
-          allow(ENV).to receive(:[]).with('FAKE_QUEUE').and_return(yes)
-          topic = 'testing_topic'
-          channel = 'testing_channel'
+    context 'when using the fake queue and it is empty', fake_queue: true do
+      it 'blocks on the process for longer than the check cycle' do
+        topic = 'testing_topic'
+        channel = 'testing_channel'
+        delay = FakeMessageQueue::Consumer::SECONDS_BETWEEN_QUEUE_CHECKS + 0.1
 
-          expect {
-            Timeout::timeout(0.1) do
-              MessageQueue::Listener.new(topic: topic, channel: channel).
-                process_next_message
-            end
-          }.to raise_error(Timeout::Error)
-        end
+        expect {
+          Timeout::timeout(delay) do
+            MessageQueue::Listener.new(topic: topic, channel: channel).
+              process_next_message
+          end
+        }.to raise_error(Timeout::Error)
       end
     end
   end

data/spec/lib/fastly_nsq/message_queue_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+RSpec.describe MessageQueue do
+  describe '.logger' do
+    describe 'when using the fake queue' do
+      it 'allows the logger to be set and retrieved' do
+        use_fake_connection do
+          logger = Logger.new(STDOUT)
+          MessageQueue.logger = logger
+
+          expect(MessageQueue.logger).to eq logger
+        end
+      end
+    end
+
+    describe 'when using the real queue' do
+      it 'allows the logger to be set and retrieved' do
+        use_real_connection do
+          logger = Logger.new(STDOUT)
+          MessageQueue.logger = logger
+
+          expect(MessageQueue.logger).to eq logger
+        end
+      end
+    end
+  end
+end

data/{test/lib/fastly_nsq/rake_task_test.rb → spec/lib/fastly_nsq/rake_task_spec.rb}

@@ -1,35 +1,40 @@
-require 'test_helper'
+require 'spec_helper'
 require 'fastly_nsq/rake_task'
 
-describe MessageQueue::RakeTask do
+RSpec.describe MessageQueue::RakeTask do
   before(:each) do
     Rake::Task['begin_listening'].clear if Rake::Task.task_defined?('begin_listening')
   end
 
-  describe 'defining tasks' do
+  describe 'when defining tasks' do
     it 'creates a begin_listening task' do
       MessageQueue::RakeTask.new
 
       allow_any_instance_of(MessageQueue::RakeTask).to receive(:output) { nil }
-      assert_equal true, Rake::Task.task_defined?(:begin_listening)
+
+      is_defined = Rake::Task.task_defined?(:begin_listening)
+      expect(is_defined).to be_truthy
     end
 
     it 'creates a named task' do
       MessageQueue::RakeTask.new(:test_name)
 
       allow_any_instance_of(MessageQueue::RakeTask).to receive(:output) { nil }
-      assert_equal true, Rake::Task.task_defined?(:test_name)
+
+      is_defined = Rake::Task.task_defined?(:test_name)
+      expect(is_defined).to be_truthy
     end
   end
 
-  describe 'running tasks' do
+  describe 'when running tasks' do
     it 'runs with inline options defined' do
-      MessageQueue::RakeTask.new(:begin_listening, [:topic, :channel])
+      options = { topic: 'dwarf', channel: 'star' }
+      task = MessageQueue::RakeTask.new(:begin_listening, [:topic, :channel])
 
-      dbl = double('go', go: nil)
+      message_queue_listener = double('go', go: nil)
       expect(MessageQueue::Listener).to receive(:new).
-        with(topic: 'dwarf', channel: 'star').
-        and_return(dbl)
+        with(options).
+        and_return(message_queue_listener)
 
       allow_any_instance_of(MessageQueue::RakeTask).to receive(:output) { nil }
       Rake::Task['begin_listening'].execute(topic: 'dwarf', channel: 'star')
@@ -41,25 +46,25 @@ describe MessageQueue::RakeTask do
         task.channel = 'star'
       end
 
-      dbl = double('go', go: nil)
+      message_queue_listener = double('go', go: nil)
       expect(MessageQueue::Listener).to receive(:new).
         with(topic: 'dwarf', channel: 'star').
-        and_return(dbl)
+        and_return(message_queue_listener)
 
       allow_any_instance_of(MessageQueue::RakeTask).to receive(:output) { nil }
       Rake::Task['begin_listening'].execute(topic: 'dwarf', channel: 'star')
     end
 
-    it 'uses inline over block' do
+    it 'uses inline definitions over block assignments' do
       MessageQueue::RakeTask.new(:begin_listening, [:topic, :channel]) do |task|
         task.topic   = 'loud'
         task.channel = 'noise'
       end
 
-      dbl = double('go', go: nil)
+      message_queue_listener = double('go', go: nil)
       expect(MessageQueue::Listener).to receive(:new).
         with(topic: 'dwarf', channel: 'star').
-        and_return(dbl)
+        and_return(message_queue_listener)
 
       allow_any_instance_of(MessageQueue::RakeTask).to receive(:output) { nil }
       Rake::Task['begin_listening'].execute(topic: 'dwarf', channel: 'star')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fastly_nsq
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Tommy O'Neil
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-10 00:00:00.000000000 Z
+date: 2016-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_print
@@ -150,6 +150,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".document"
+- ".github/PULL_REQUEST_TEMPLATE.md"
 - ".gitignore"
 - ".rdoc_options"
 - ".ruby-version"
@@ -179,10 +180,11 @@ files:
 - spec/lib/fastly_nsq/message_queue/listener_spec.rb
 - spec/lib/fastly_nsq/message_queue/producer_spec.rb
 - spec/lib/fastly_nsq/message_queue/strategy_spec.rb
+- spec/lib/fastly_nsq/message_queue_spec.rb
+- spec/lib/fastly_nsq/rake_task_spec.rb
 - spec/lib/fastly_nsq/sample_message_processor_spec.rb
 - spec/spec_helper.rb
 - spec/support/env_helpers.rb
-- test/lib/fastly_nsq/rake_task_test.rb
 homepage: https://github.com/fastly/fastly-nsq
 licenses:
 - MIT
@@ -207,5 +209,4 @@ rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Fastly NSQ Adapter
-test_files:
-- test/lib/fastly_nsq/rake_task_test.rb
+test_files: []