bi-frost 0.1.4 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9bae9c137149abf5f29d00b38d46763ead852eec
-  data.tar.gz: 6dbd4e1370c6b62ce67bd7df6826b0a8d75e664b
+  metadata.gz: 5c7ef1811b993361b82e924590621cd7acbcd263
+  data.tar.gz: b365ca8848c557b296fbef2ad330746e70472aa5
 SHA512:
-  metadata.gz: e07411b6991e054810097254fc39d2e5745ff2fccb2a75bdb0e9c4051c269feed887094c4e2eaef128a37d4978ba453c263da0c903e199163d6e4b7b1b0f3ea0
-  data.tar.gz: 105f3f014d5fb0d5444f03b6c258eb9fdc2e0cbaf65b97089b87167ddf0f728f9a78dda8dc7356736b043f1bc57d8f087e1eaec197cad6cd2339be00e9285962
+  metadata.gz: 933abde1218ef15a966004dcded976de5076fb5eb7b4e97fa316dc957e55e8009e1058758a1f6c4cb78649a5e5c522238bd8a6e9387e340714dff541a4d49fd7
+  data.tar.gz: c0b8558f903e565ce019cdc833e9b99a604ceb1d144653b82a7a4152a6b350b21fa1eb287c992dce98836e60eae8e179b155dee61d11d977d2c7b7cfcc5f4b67

data/README.md

@@ -56,31 +56,29 @@ subscriber = Bifrost::Subscriber.new('new_subscriber')
 topic.add_subscriber(subscriber)
 ```
 
-Each topic can only have a unique list of subscribers, a subscriber cannot be added to a topic more than once. When a subscriber is added to
-a topic this function will return a true or false indicating success of the add.
+Each topic can only have a unique list of subscribers, a subscriber cannot be added to a topic more than once. When a subscriber is added to a topic this function will return a true or false indicating success of the add.
 
 To post a message to a topic;
 
 ```ruby
 topic = Bifrost::Topic.new('topic_name')
 message = Bifrost::Message.new(content: 'some data')
-message.post_to(topic)
+message.publish(topic)
 ```
 
-This function returns a `true` or `false` indicating the success of the message delivery. This method is synchronous. Each message has an
-identifier which gets sets upon successful delivery only.
+This function returns a `true` or `false` indicating the success of the message delivery. This method is synchronous. Each message has an identifier which gets sets upon successful delivery only.
 
 A message can also be optionally published with a subject;
 
 ```ruby
 topic = Bifrost::Topic.new('topic_name')
 message = Bifrost::Message.new(content: 'some data', 'message subject')
-message.post_to(topic)
+message.publish(topic)
 ```
 
-Subscribers in the Bifrost are [actors](http://http://doc.akka.io/docs/akka/2.4/general/actors.html), these actors run in
-their own threads. At present the Bifrost does not support thread pools, this is something we are investigating and are
-hoping to add at some point. In the Bifrost each actor is referred to as a `worker`. A worker is designed to receive
+An alternative method named `publish!` also exists. This method raises an error is a message cannot be delivered. The error raised is `Bifrost::Exceptions::MessageDeliveryError`. If the message is successfully delivered with the method `publish!`, the messages `UUID` is returned in the call.
+
+Subscribers in the Bifrost are [actors](http://http://doc.akka.io/docs/akka/2.4/general/actors.html), these actors run in their own threads. At present the Bifrost does not support thread pools, this is something we are investigating and are hoping to add at some point. In the Bifrost each actor is referred to as a `worker`. A worker is designed to receive
 messages published to a particular topic with a specific subscriber in mind (refer to the fan-out comment earlier).
 
 Workers are added to the Bifrost via the manager. The manager is what activates the workers in the Bifrost environment.

data/lib/bifrost.rb

@@ -5,11 +5,16 @@ require 'bifrost/topic'
 require 'bifrost/subscriber'
 require 'bifrost/manager'
 require 'bifrost/worker'
+
+require 'bifrost/exceptions/duplicate_subscriber_error'
+require 'bifrost/exceptions/invalid_worker_definition_error'
+require 'bifrost/exceptions/message_delivery_error'
+require 'bifrost/exceptions/unsupported_lambda_error'
+
 require 'celluloid'
 
 # Bifrost is a pub/sub gem built on top of the Azure MessageBus system
 module Bifrost
-
   # Workers and the infrastructure can log using the standard level of granularity affored to any
   # standard logger (i.e. info, debug, error levels etc)
   def self.logger=(log_provider)

data/lib/bifrost/bus.rb

@@ -47,4 +47,4 @@ module Bifrost
       ENV['AZURE_BUS_KEY_SECRET']
     end
   end
-end
+end

data/lib/bifrost/exceptions/message_delivery_error.rb

@@ -0,0 +1,6 @@
+module Bifrost
+  module Exceptions
+    class MessageDeliveryError < StandardError
+    end
+  end
+end

data/lib/bifrost/message.rb

@@ -17,23 +17,38 @@ module Bifrost
     end
 
     # A message can be posted to a particular topic
-    def post_to(topic)
+    def publish(topic)
       if topic.exists?
-        message = create_brokered_message
-        @bus.interface.send_topic_message(topic.name, message)
-        update_message_state_to_delivered(message)
+        send_message(topic, create_brokered_message)
         true
       else
         false
       end
     end
 
+    # A message can be posted to a particular topic, if the message is succssfully delivered
+    # we return a unique identifier for the message
+    def publish!(topic)
+      if topic.exists?
+        send_message(topic, create_brokered_message)
+        message_id
+      else
+        raise Bifrost::Exceptions::MessageDeliveryError, "Could not post message to #{topic}"
+      end
+    end
+
     private
 
+    # Create the message and attempt to deliver It
+    def send_message(topic, message)
+      @bus.interface.send_topic_message(topic.name, message)
+      update_message_state_to_delivered(message)
+    end
+
     # Create the brokered message
     def create_brokered_message
       message = Azure::ServiceBus::BrokeredMessage.new(subject, message: body)
-      message.correlation_id = SecureRandom.hex
+      message.correlation_id = SecureRandom.uuid
       message
     end
 

data/lib/bifrost/topic.rb

@@ -33,6 +33,13 @@ module Bifrost
       end
     end
 
+    # This method returns a list of subscribers currently defined on the topic
+    def subscribers
+      @bus.interface.list_subscriptions(name).map do |s|
+        Subscriber.new(s.name)
+      end
+    end
+
     # A new subscriber can be added to a topic
     def add_subscriber(subscriber)
       if exists?
@@ -63,8 +70,8 @@ module Bifrost
       end
     end
 
-    def ==(another_topic)
-      self.name == another_topic.name && self.class == another_topic.class
+    def ==(other)
+      name == other.name && self.class == other.class
     end
 
     # Topics are self aware, and know if they exist or not, but only with the help
@@ -72,5 +79,9 @@ module Bifrost
     def exists?
       @bus.topic_exists?(self)
     end
+
+    def to_s
+      name
+    end
   end
 end

data/lib/bifrost/version.rb

@@ -5,11 +5,11 @@ module Bifrost
   MAJOR_VERSION = 0
 
   # The minor version of Bifrost, updated for new feature releases.
-  MINOR_VERSION = 1
+  MINOR_VERSION = 2
 
   # The patch version of Bifrost, updated only for bug fixes from the last
   # feature release.
-  PATCH_VERSION = 4
+  PATCH_VERSION = 0
 
   # The full version as a string.
   VERSION = "#{MAJOR_VERSION}.#{MINOR_VERSION}.#{PATCH_VERSION}".freeze

data/spec/bifrost/bus_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 describe Bifrost::Bus do
-  let(:bus)   { Bifrost::Bus.new }
+  let(:bus) { Bifrost::Bus.new }
 
   context 'for an undefined topic' do
     it 'should return false for defined?' do

data/spec/bifrost/message_spec.rb

@@ -8,7 +8,8 @@ describe Bifrost::Message do
   it { is_expected.to respond_to(:status) }
   it { is_expected.to respond_to(:message_id) }
   it { is_expected.to respond_to(:body) }
-  it { is_expected.to respond_to(:post_to) }
+  it { is_expected.to respond_to(:publish) }
+  it { is_expected.to respond_to(:publish!) }
 
   context 'which is initialized' do
     it 'should be in an undelivered status' do
@@ -21,18 +22,39 @@ describe Bifrost::Message do
     expect(new_message).to_not be_nil
   end
 
-  it 'should be postable to a valid topic' do
-    topic = Bifrost::Topic.new('valid-topic')
-    topic.save
-    topic.add_subscriber(Bifrost::Subscriber.new('new_subscriber'))
-    expect(message.post_to(topic)).to be_truthy
-    expect(message.status).to eq(:delivered)
-    expect(message.message_id).not_to be_nil
-    topic.delete
+  describe 'publish' do
+    it 'should publish to a valid topic' do
+      topic = Bifrost::Topic.new('valid-topic')
+      topic.save
+      topic.add_subscriber(Bifrost::Subscriber.new('new_subscriber'))
+      expect(message.publish(topic)).to be_truthy
+      expect(message.status).to eq(:delivered)
+      expect(message.message_id).not_to be_nil
+      topic.delete
+    end
+
+    it 'should not be postable to an invalid topic' do
+      topic = Bifrost::Topic.new('invalid-topic') # A topic that is neither saved, nor with no subscribers is semantically invalid
+      expect(message.publish(topic)).to be_falsey
+    end
   end
 
-  it 'should not be postable to an invalid topic' do
-    topic = Bifrost::Topic.new('invalid-topic') # A topic that is neither saved, nor with no subscribers is semantically invalid
-    expect(message.post_to(topic)).to be_falsey
+  describe 'publish!' do
+    it 'should publish to a valid topic and return the message id' do
+      topic = Bifrost::Topic.new('valid-topic')
+      topic.save
+      topic.add_subscriber(Bifrost::Subscriber.new('new_subscriber'))
+      response = message.publish!(topic)
+      expect(response).not_to be_nil
+      expect(message.status).to eq(:delivered)
+      expect(message.message_id).not_to be_nil
+      expect(response).to eq(message.message_id)
+      topic.delete
+    end
+
+    it 'should raise an exception upon publish to an invalid topic' do
+      topic = Bifrost::Topic.new('invalid-topic')
+      expect { message.publish!(topic) }.to raise_error(Bifrost::Exceptions::MessageDeliveryError)
+    end
   end
 end

data/spec/bifrost/topic_spec.rb

@@ -15,6 +15,15 @@ describe Bifrost::Topic do
     expect { invalid_topic.save }.to raise_error(TypeError)
   end
 
+  it 'should have a friendly name' do
+    expect(topic.to_s).to eq('topic_name')
+  end
+
+  it 'should not accept names with spaces in them' do
+    invalid_topic = Bifrost::Topic.new('topic name')
+    expect { invalid_topic.save }.to raise_error(URI::InvalidURIError)
+  end
+
   describe 'equality' do
     it 'should return true for the same object' do
       expect(topic).to eq(topic)
@@ -32,10 +41,13 @@ describe Bifrost::Topic do
   end
 
   context 'for an undefined topic' do
-    it 'should persist the topic' do
-      new_topic = Bifrost::Topic.new('new_topic_name')
-      expect(new_topic.save).to be_truthy
-      expect(new_topic.delete).to be_truthy
+
+    describe 'save' do
+      it 'should persist the topic and return a binary value' do
+        new_topic = Bifrost::Topic.new('new_topic_name')
+        expect(new_topic.save).to be_truthy
+        expect(new_topic.delete).to be_truthy
+      end
     end
 
     it 'should return false for delete' do
@@ -56,16 +68,8 @@ describe Bifrost::Topic do
   context 'for a defined topic' do
     let(:new_topic) { Bifrost::Topic.new('test_donotdelete') }
 
-    before(:all) do
-      bus = Bifrost::Bus.new
-      tp = Bifrost::Topic.new('test_donotdelete')
-      tp.save unless bus.topic_exists?(tp)
-    end
-
-    after(:all) do
-      bus = Bifrost::Bus.new
-      tp = Bifrost::Topic.new('test_donotdelete')
-      tp.delete if bus.topic_exists?(tp)
+    before(:each) do
+      new_topic.save
     end
 
     it 'should return false for save' do
@@ -88,10 +92,24 @@ describe Bifrost::Topic do
       expect(new_topic.add_subscriber(subscriber)).to be_truthy
       expect(new_topic.add_subscriber(subscriber)).to be_falsey
     end
-  end
 
-  it 'should not accept names with spaces in them' do
-    invalid_topic = Bifrost::Topic.new('topic name')
-    expect { invalid_topic.save }.to raise_error(URI::InvalidURIError)
+    context 'with no subscribers' do
+      it 'should return no subscribers' do
+        expect(new_topic.subscribers).to be_empty
+      end
+    end
+
+    context 'with subscribers' do
+      before(:each) do
+        subscriber_a = Bifrost::Subscriber.new('new_subscriber_a')
+        subscriber_b = Bifrost::Subscriber.new('new_subscriber_b')
+        new_topic.add_subscriber(subscriber_a)
+        new_topic.add_subscriber(subscriber_b)
+      end
+
+      it 'should return a list of it\'s subscribers' do
+        expect(new_topic.subscribers.size).to eq(2)
+      end
+    end
   end
 end

data/spec/bifrost/worker_spec.rb

@@ -1,5 +1,4 @@
 require 'spec_helper'
-require 'bifrost/exceptions/unsupported_lambda_error'
 require 'bifrost'
 
 describe Bifrost::Worker do
@@ -33,7 +32,7 @@ describe Bifrost::Worker do
     subscriber = Bifrost::Subscriber.new('subscriber')
     topic.add_subscriber(subscriber)
     msg = Bifrost::Message.new([item1: { data: 2 }, item2: { more_data: 3 }])
-    msg.post_to(topic)
+    msg.publish(topic)
     expect(msg.status).to eq(:delivered)
     expect(msg.message_id).not_to be_nil
     worker.async.run

data/spec/spec_helper.rb

@@ -44,4 +44,16 @@ RSpec.configure do |config|
   # inherited by the metadata hash of host groups and examples, rather than
   # triggering implicit auto-inclusion in groups with matching metadata.
   config.shared_context_metadata_behavior = :apply_to_host_groups
+
+  # Clear the bifrost before running each spec
+  config.before(:example) do
+    bus = Bifrost::Bus.new
+    bus.topics.each(&:delete)
+  end
+
+  # Clear the bifrost after running specs
+  config.after(:suite) do
+    bus = Bifrost::Bus.new
+    bus.topics.each(&:delete)
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bi-frost
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.2.0
 platform: ruby
 authors:
 - Shirren Premaratne
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-02 00:00:00.000000000 Z
+date: 2016-11-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: azure
@@ -164,6 +164,7 @@ files:
 - lib/bifrost/entity.rb
 - lib/bifrost/exceptions/duplicate_subscriber_error.rb
 - lib/bifrost/exceptions/invalid_worker_definition_error.rb
+- lib/bifrost/exceptions/message_delivery_error.rb
 - lib/bifrost/exceptions/unsupported_lambda_error.rb
 - lib/bifrost/manager.rb
 - lib/bifrost/message.rb