bi-frost 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 533fe67ffbe175327e17f804236dc3b90e033551
-  data.tar.gz: ae0b7820e19390971654ce9fc8c6eadbc2ec5d35
+  metadata.gz: e2c0c05d4f226f4592d8b654a36e2a324dcf0042
+  data.tar.gz: 2a085487e7a616543e690d4d428d89087d1b750d
 SHA512:
-  metadata.gz: b3e78411ef1729d457cf91959ad3eb8868444dd94774bf983127784294f118bb423a89c206c8ca866c2f2ef4ba10286adb80db9d34143b0497af24382422b280
-  data.tar.gz: 37bb8f048d02fcd11513398d3a1e8ae58c07ff3e06ac29c11e96d4e5122a84cfbd3ed159194320c742c2596d6acaaa5cead22db55fd110efb1fec2572044062c
+  metadata.gz: 89b9ae01ccb0f14d03d926494afa83491b98cbc597b796a1e8eb48e606acc92b8bc23648b16548a7df71803b16b5536ec285262fde25d1a09cee58aebb3cb8cf
+  data.tar.gz: da58e3c72a1e34338089a4a253e56fe60871f5564538613379b6d510827a42682d8d51e8dca56b3742c556eeb1beed4aa3952a6eb479e8eb60dd8ffe274e5c94

data/README.md

@@ -31,7 +31,7 @@ bus and how it works please refer to this [article](https://azure.microsoft.com/
 
 To begin using this gem we need to start by setting some environment variables. The gem in development and
 test environments supports .env files (i.e. .env.test and .env.development etc). The environment variables that
-require to be set prior to using the gem are; NAMESPACE, KEY_NAME and KEY_SECRET. The values for these variables
+require to be set prior to using the gem are; `AZURE_BUS_NAMESPACE`, `AZURE_BUS_KEY_NAME` and `AZURE_BUS_KEY_SECRET`. The values for these variables
 can be obtained from your Azure management portal. For more information on how to obtain these values for your
 service bus please refer to this [article](https://azure.microsoft.com/en-us/documentation/articles/service-bus-authentication-and-authorization/).
 
@@ -141,4 +141,4 @@ Permission is hereby granted, free of charge, to any person obtaining a copy of
 
 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.
+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/lib/bifrost.rb

@@ -1,3 +1,4 @@
+require 'bifrost/bus'
 require 'bifrost/entity'
 require 'bifrost/message'
 require 'bifrost/topic'
@@ -24,6 +25,11 @@ module Bifrost
     topic
   end
 
+  # Get an instance of the bus
+  def self.bus
+    Bifrost::Bus.new
+  end
+
   # Creates a manager instance
   def self.manager
     Bifrost::Manager.new

data/lib/bifrost/bus.rb

@@ -0,0 +1,24 @@
+require 'Azure'
+
+module Bifrost
+  # This type represents the Bifrost as a managed entity
+  # NOTE: Warning, this object should never use shared state as it is referenced initialize
+  # each worker
+  class Bus
+    attr_reader :interface
+
+    def initialize
+      Azure.sb_namespace = ENV['AZURE_BUS_NAMESPACE']
+      host = "https://#{Azure.sb_namespace}.servicebus.windows.net"
+      signer = Azure::ServiceBus::Auth::SharedAccessSigner.new(ENV['AZURE_BUS_KEY_NAME'], ENV['AZURE_BUS_KEY_SECRET'])
+      @interface ||= Azure::ServiceBus::ServiceBusService.new(host, signer: signer)
+    end
+
+    # This method returns a list of topics currently defined on the Bifrost
+    def topics
+      @interface.list_topics.map do |t|
+        Topic.new(t.name)
+      end
+    end
+  end
+end

data/lib/bifrost/entity.rb

@@ -4,13 +4,8 @@ module Bifrost
   # Types that require access to the message bus should inherit this type. We've chosen
   # inheritance at this point, perhaps a mixin might be a better approach
   class Entity
-    attr_reader :bus
-
     def initialize
-      Azure.sb_namespace = ENV['NAMESPACE']
-      host = "https://#{Azure.sb_namespace}.servicebus.windows.net"
-      signer = Azure::ServiceBus::Auth::SharedAccessSigner.new(ENV['KEY_NAME'], ENV['KEY_SECRET'])
-      @bus ||= Azure::ServiceBus::ServiceBusService.new(host, signer: signer)
+      @bus ||= Bifrost::Bus.new
     end
   end
 end

data/lib/bifrost/manager.rb

@@ -25,7 +25,7 @@ module Bifrost
       if topic.nil? || subscriber.nil? || proc.nil?
         raise InvalidWorkerDefinitionError, 'Invalid worker'
       else
-        @supervisor = Worker.supervise(as: Worker.handle(topic, subscriber), args: [topic, subscriber, proc])
+        Worker.supervise(as: Worker.handle(topic, subscriber), args: [topic, subscriber, proc])
       end
     end
 

data/lib/bifrost/message.rb

@@ -4,7 +4,7 @@ require_relative 'entity'
 module Bifrost
   # A message is a letter that we send to a topic. It must contain a subject and body
   # The receiver can process both fields on receipt of the message
-  class Message < Bifrost::Entity
+  class Message < Entity
     attr_reader :subject, :body, :status, :message_id
 
     # A message must have a valid subject and body. The service
@@ -20,7 +20,7 @@ module Bifrost
     def post_to(topic)
       if topic.exists?
         message = create_brokered_message
-        bus.send_topic_message(topic.name, message)
+        @bus.interface.send_topic_message(topic.name, message)
         update_message_state_to_delivered(message)
         true
       else

data/lib/bifrost/topic.rb

@@ -6,18 +6,17 @@ module Bifrost
   # Topics are central to the pub/sub system in the Bifrost. All messages must be delivered
   # to a topic. The topic is responsible for forwarding the message to registered subscribers
   class Topic < Entity
-    attr_reader :name, :options
+    attr_reader :name
 
-    def initialize(name, options = {})
+    def initialize(name)
       @name ||= name
-      @options ||= options
       super()
     end
 
     # If the topic has been defined this method returns true, if not
     # it returns false
     def exists?
-      bus.list_topics.each do |topic|
+      @bus.topics.each do |topic|
         return true if topic.name == name
       end
       false
@@ -28,7 +27,7 @@ module Bifrost
       if exists?
         false
       else
-        bus.create_topic(name)
+        @bus.interface.create_topic(name)
         true
       end
     end
@@ -36,7 +35,7 @@ module Bifrost
     # If a topic is defined, we can remove the definition
     def delete
       if exists?
-        bus.delete_topic(name)
+        @bus.interface.delete_topic(name)
         true
       else
         false
@@ -47,9 +46,10 @@ module Bifrost
     def add_subscriber(subscriber)
       if exists?
         begin
-          bus.create_subscription(name, subscriber.name)
+          @bus.interface.create_subscription(name, subscriber.name)
         rescue Azure::Core::Http::HTTPError => e
-          raise Bifrost::Exceptions::DuplicateSubscriberError, "Duplicate subscriber for topic #{name}" if e.status_code == 409
+          return false if e.status_code == 409
+          raise e
         end
         true
       else
@@ -61,7 +61,7 @@ module Bifrost
     def remove_subscriber(subscriber)
       if exists?
         begin
-          bus.delete_subscription(name, subscriber.name)
+          @bus.interface.delete_subscription(name, subscriber.name)
         rescue Azure::Core::Http::HTTPError => e
           return false if e.status_code == 404
           raise e

data/lib/bifrost/version.rb

@@ -9,7 +9,7 @@ module Bifrost
 
   # The patch version of Bifrost, updated only for bug fixes from the last
   # feature release.
-  PATCH_VERSION = 2
+  PATCH_VERSION = 3
 
   # The full version as a string.
   VERSION = "#{MAJOR_VERSION}.#{MINOR_VERSION}.#{PATCH_VERSION}".freeze

data/lib/bifrost/worker.rb

@@ -7,7 +7,7 @@ module Bifrost
   # This class is used to read messages from the subscriber, and process the messages one
   # by one. This class is a worker/actor which focusses on processes a single topic/subscriber
   # combination one at a time
-  class Worker < Bifrost::Entity
+  class Worker < Entity
     include Celluloid
     include Celluloid::Internals::Logger
     include Celluloid::Notifications
@@ -55,10 +55,10 @@ module Bifrost
 
     # Actual processing of the message
     def read_message
-      message = bus.receive_subscription_message(topic, subscriber, timeout: ENV['TIMEOUT'] || 10)
+      message = @bus.interface.receive_subscription_message(topic, subscriber, timeout: ENV['TIMEOUT'] || 10)
       if message
         callback.call(message.properties['message'])
-        bus.delete_subscription_message(message)
+        @bus.interface.delete_subscription_message(message)
       end
     end
   end

data/spec/bifrost/message_spec.rb

@@ -1,7 +1,5 @@
 require 'spec_helper'
-require 'bifrost/message'
-require 'bifrost/topic'
-require 'bifrost/subscriber'
+require 'bifrost'
 
 describe Bifrost::Message do
   subject(:message) { Bifrost::Message.new({ content: 'some data' }, 'subscriber_name') }

data/spec/bifrost/subscriber_spec.rb

@@ -1,5 +1,5 @@
 require 'spec_helper'
-require 'bifrost/subscriber'
+require 'bifrost'
 
 describe Bifrost::Subscriber do
   subject(:subscriber) { Bifrost::Subscriber.new('subscriber_name') }

data/spec/bifrost/topic_spec.rb

@@ -1,6 +1,5 @@
 require 'spec_helper'
-require 'bifrost/topic'
-require 'bifrost/subscriber'
+require 'bifrost'
 
 describe Bifrost::Topic do
   subject(:topic) { Bifrost::Topic.new('topic_name') }
@@ -78,7 +77,7 @@ describe Bifrost::Topic do
     it 'should not be able to add a duplicate subscriber' do
       subscriber = Bifrost::Subscriber.new('another_new_subscriber')
       expect(new_topic.add_subscriber(subscriber)).to be_truthy
-      expect { new_topic.add_subscriber(subscriber) }.to raise_error(Bifrost::Exceptions::DuplicateSubscriberError)
+      expect(new_topic.add_subscriber(subscriber)).to be_falsey
     end
   end
 

data/spec/bifrost/worker_spec.rb

@@ -1,9 +1,6 @@
 require 'spec_helper'
 require 'bifrost/exceptions/unsupported_lambda_error'
-require 'bifrost/message'
-require 'bifrost/topic'
-require 'bifrost/subscriber'
-require 'bifrost/worker'
+require 'bifrost'
 
 describe Bifrost::Worker do
   let(:cb) { proc { |m| puts "Received: message #{m}" } }

data/spec/spec_helper.rb

@@ -12,7 +12,7 @@ RSpec.configure do |config|
   Dotenv.load('.env.test')
 
   # All specs use this pre-defined namespace in Azure
-  Azure.sb_namespace = ENV['NAMESPACE']
+  Azure.sb_namespace = ENV['AZURE_BUS_NAMESPACE']
 
   # rspec-expectations config goes here. You can use an alternate
   # assertion/expectation library such as wrong or the stdlib/minitest

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bi-frost
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Shirren Premaratne
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-01 00:00:00.000000000 Z
+date: 2016-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: azure
@@ -160,6 +160,7 @@ extra_rdoc_files: []
 files:
 - README.md
 - lib/bifrost.rb
+- lib/bifrost/bus.rb
 - lib/bifrost/entity.rb
 - lib/bifrost/exceptions/duplicate_subscriber_error.rb
 - lib/bifrost/exceptions/invalid_worker_definition_error.rb
@@ -177,7 +178,7 @@ files:
 - spec/bifrost/version_spec.rb
 - spec/bifrost/worker_spec.rb
 - spec/spec_helper.rb
-homepage: https://github.com/filmpond/bifrost
+homepage: https://github.com/shirren/bifrost
 licenses:
 - MIT
 metadata: {}