fastly_nsq 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b2f03d7a90d220d61bbbab80806d305f49017361
-  data.tar.gz: fa5f44e2035bd6a9bf655040498bbdeb9b378b37
+  metadata.gz: 99e79a12dff28f51a1a2d2a16fc456afbf8e5e4d
+  data.tar.gz: a0c405bf11017a747d3667f05770a21533db4ffc
 SHA512:
-  metadata.gz: f34fd7c48a23702fb39115295110d3b1a1aab08f882a514cb83ad9eddcfe7a75e2d67f64a5b6414c543bd557e44c113479d64d45b47e7d010747a8559988169f
-  data.tar.gz: 4a68b4cab8892638444669e2ce3c3780b9df7596a0ebd9753df6f4dd1909a33f7b4ba96c90fc0027de3066da937d9b49486bcc12f43956b476d7c18c7ff3d31c
+  metadata.gz: 0ecb27b7315a6e0296a6d6ce77fd55fcbbad53dfa7c256b1bd72ac200e8f85fff5dff888f35d5f90cb8df6dc9b808bc77096711e308673c2666c135137331b75
+  data.tar.gz: a43d3792df3c2f93910d32fa22409eba609f93458404f5defc455a8a08aea069d485072343c54e821b4e87527135d7db1fe6bb862675f169983c482c83fd8db8

data/ChangeLog.md

@@ -1,3 +1,7 @@
+### 0.9.0 / 2016-12-20
+
+* Add FastlyNsq::Messenger to persist Producers
+
 ### 0.8.0 / 2016-11-23
 
 * Upgrade nsq-ruby to version 2.0.3

data/README.md

@@ -158,6 +158,40 @@ The task can also define a `call`-able "preprocessor" (called before any `Proces
 See the [`Rakefile`](examples/Rakefile) file
 for more detail.
 
+### FastlyNsq::Messgener
+
+Wrapper around a producer for sending messages and persisting producer objects.
+
+```ruby
+FastlyNsq::Messenger.deliver(message: msg, on_topic: 'my_topic', originating_service: 'my service')
+```
+
+This will use a FastlyNsq::Producer for the given topic or create on if it isn't
+already persisted. Then it will write the passed message to the queue. If you don't set
+the originating service it will use `unknown`
+
+You can also set the originating service for all `deliver` calls:
+
+```ruby
+FastlyNsq::Messenger.originating_service = 'some awesome service'
+```
+
+`FastlyNsq::Messenger` can also be used to manage Producer connections
+
+```ruby
+# get a producer:
+producer = FastlyNsq::Messenger.producer_for(topic: 'hot_topic')
+
+# get a hash of all persisted producers:
+producers = FastlyNsq::Messenger.producers
+
+# terminate a producer
+FastlyNsq::Messenger.terminate_producer(topic: 'hot_topic')
+
+# terminate all producers
+FastlyNsq::Messenger.terminate_all_producers
+```
+
 ### Real vs. Fake
 
 The real strategy
@@ -223,16 +257,20 @@ You can also refer to the latter
 as an example of how
 you might write your own processor.
 
-## Acknowledgements
+## Contributors
 
-* Documentation inspired by [Steve Losh's "Teach Don't Tell"] post.
-* Thanks to Wistia for `nsq-ruby`.
+* Adarsh Pandit ([@adarsh](https://github.com/adarsh))
+* Thomas O'Neil ([@alieander](https://github.com/alieander))
+* Joshua Wehner ([@jaw6](https://github.com/jaw6))
+* Lukas Eklund  ([@leklund](https://github.com/leklund))
 
-[Steve Losh's "Teach Don't Tell"]: http://stevelosh.com/blog/2013/09/teach-dont-tell/
+## Acknowledgements
 
+* Documentation inspired by [Steve Losh's "Teach Don't Tell"](http://stevelosh.com/blog/2013/09/teach-dont-tell/) post.
+* Thanks to Wistia for [`nsq-ruby`](https://github.com/wistia/nsq-ruby).
 
 ## Copyright
 
-Copyright (c) 2016 Fastly, Inc under an MIT license.
+Copyright (c) 2016 [Fastly, Inc](https://fastly.com) under an MIT license.
 
 See [LICENSE.txt](LICENSE.txt) for details.

data/fastly_nsq.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |gem|
   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.authors       = ["Tommy O'Neil", 'Adarsh Pandit', 'Joshua Wehner', 'Lukas Eklund']
   gem.email         = 'tommy@fastly.com'
   gem.homepage      = 'https://github.com/fastly/fastly-nsq'
 

data/lib/fastly_nsq.rb

@@ -3,6 +3,7 @@ require 'fastly_nsq/consumer'
 require 'fastly_nsq/fake_backend'
 require 'fastly_nsq/listener'
 require 'fastly_nsq/message'
+require 'fastly_nsq/messenger'
 require 'fastly_nsq/producer'
 require 'fastly_nsq/strategy'
 require 'fastly_nsq/tls_options'

data/lib/fastly_nsq/messenger.rb

@@ -0,0 +1,48 @@
+module FastlyNsq::Messenger
+  def self.deliver(message:, on_topic:, originating_service: nil)
+    payload = {
+      data: message,
+      meta: {
+        originating_service: originating_service || self.originating_service,
+      },
+    }
+
+    producer_for(topic: on_topic) do |producer|
+      producer.write payload.to_json
+    end
+  end
+
+  def self.originating_service=(service)
+    @originating_service = service
+  end
+
+  def self.producer_for(topic:)
+    producer = producers[topic]
+
+    yield producer if block_given?
+
+    producer
+  end
+
+  def self.producers
+    @producers ||= Hash.new { |hash, topic| hash[topic] = FastlyNsq::Producer.new(topic: topic) }
+  end
+
+  def self.terminate_producer(topic:)
+    producer_for(topic: topic).terminate
+    producers.delete(topic)
+  end
+
+  def self.terminate_all_producers
+    producers.each do |topic, producer|
+      producer.terminate
+      producers.delete(topic)
+    end
+  end
+
+  private_class_method
+
+  def self.originating_service
+    @originating_service || 'Unknown'.freeze
+  end
+end

data/lib/fastly_nsq/version.rb

@@ -1,3 +1,3 @@
 module FastlyNsq
-  VERSION = '0.8.0'.freeze
+  VERSION = '0.9.0'.freeze
 end

data/spec/lib/fastly_nsq/messenger_spec.rb

@@ -0,0 +1,104 @@
+
+require 'spec_helper'
+require 'json'
+
+RSpec.describe FastlyNsq::Messenger do
+  let(:message)  { { sample: 'sample', message: 'message' } }
+  let(:producer) { double 'FastlyNsq::Producer', write: nil, terminate: :terminated }
+  let(:origin)   { 'originating_service' }
+
+  let(:expected_attributes) do
+    {
+      data: message,
+      meta: {
+        originating_service: 'originating_service',
+      },
+    }
+  end
+
+  subject { FastlyNsq::Messenger }
+
+  before do
+    FastlyNsq::Messenger.instance_variable_set(:@producers, nil)
+  end
+
+  describe '#deliver' do
+    it 'writes a single message on a producer' do
+      subject.producers['topic'] = producer
+
+      subject.deliver message: message, on_topic: 'topic', originating_service: origin
+
+      expect(producer).to have_received(:write).with(expected_attributes.to_json)
+    end
+
+    it 'uses a Unknown for the default originating_service' do
+      subject.producers['topic'] = producer
+      expected_attributes[:meta][:originating_service] = 'Unknown'
+
+      subject.deliver message: message, on_topic: 'topic'
+
+      expect(producer).to have_received(:write).with(expected_attributes.to_json)
+    end
+  end
+
+  describe '#originating_service=' do
+    it "set's the default originating service" do
+      subject.producers['nanotopic'] = producer
+      service = 'nano service'
+      subject.originating_service = service
+      expected_attributes[:meta][:originating_service] = service
+
+      subject.deliver message: message, on_topic: 'nanotopic'
+
+      expect(producer).to have_received(:write).with(expected_attributes.to_json)
+
+      # reset
+      subject.originating_service = nil
+    end
+  end
+
+  describe '#producer_for' do
+    it 'returns an FastlyNsq::Producer for the given topic' do
+      my_producer = subject.producer_for(topic: 'my_topic')
+      expect(my_producer).to be_a(FastlyNsq::Producer)
+    end
+
+    it 'persists producers' do
+      subject.producers['topic'] = producer
+
+      my_producer = subject.producer_for(topic: 'topic')
+
+      expect(my_producer).to eq(producer)
+    end
+  end
+
+  describe '#terminate_producer' do
+    before do
+      subject.producers['topic'] = producer
+      subject.terminate_producer(topic: 'topic')
+    end
+
+    it 'terminates a producer' do
+      expect(producer).to have_received(:terminate)
+    end
+
+    it 'removes the producer from the persisted producers' do
+      expect(subject.producers.key?('topic')).to be(false)
+    end
+  end
+
+  describe '#terminate_all_producers' do
+    let(:producer_2) { double 'FastlyNsq::Producer', write: nil, terminate: :terminated }
+
+    it 'terminates all the producers and resets the hash or producers' do
+      subject.producers['topic'] = producer
+      subject.producers['topic_2'] = producer_2
+
+      subject.terminate_all_producers
+
+      expect(producer).to have_received(:terminate)
+      expect(producer_2).to have_received(:terminate)
+      expect(subject.producers).to be_empty
+    end
+  end
+end

metadata

@@ -1,15 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: fastly_nsq
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Tommy O'Neil
 - Adarsh Pandit
+- Joshua Wehner
+- Lukas Eklund
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-29 00:00:00.000000000 Z
+date: 2016-12-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_print
@@ -199,6 +201,7 @@ files:
 - lib/fastly_nsq/fake_backend.rb
 - lib/fastly_nsq/listener.rb
 - lib/fastly_nsq/message.rb
+- lib/fastly_nsq/messenger.rb
 - lib/fastly_nsq/producer.rb
 - lib/fastly_nsq/rake_task.rb
 - lib/fastly_nsq/strategy.rb
@@ -209,6 +212,7 @@ files:
 - spec/lib/fastly_nsq/fastly_nsq_spec.rb
 - spec/lib/fastly_nsq/listener_spec.rb
 - spec/lib/fastly_nsq/message_spec.rb
+- spec/lib/fastly_nsq/messenger_spec.rb
 - spec/lib/fastly_nsq/producer_spec.rb
 - spec/lib/fastly_nsq/rake_task_spec.rb
 - spec/lib/fastly_nsq/strategy_spec.rb