bi-frost 0.3.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 986bfabd346d59957dd78009b4ea2170214dcd0d
-  data.tar.gz: e9454650e4be44971f021473143866bc22f31af6
+  metadata.gz: f8b9ebfc0c96cc0f16a2bd99f5c4ac62bf2af316
+  data.tar.gz: f766bfcb594119c63145c848f114973b631bef4d
 SHA512:
-  metadata.gz: bb982048b43860fed16c4e7af9058d9fdb34c206420c67c02d047e2763a9b5510d4599e94e2952e41d297832806de3c8df79966e9acb0ff528e79a4bb3d6830d
-  data.tar.gz: d19145821ad14b54be7ec645959956c1a93059d58a8cf618a82b5fd8d8f8e262ef5a9fae40c427da552a2c411d41edce06959993c3969672519e9a3a460f21f5
+  metadata.gz: 61e070940b3a4cb3f7e5bcd0b44b55ec379b07487ce145a92c765551fc326ab7af97c33faf95c7bdb33a13130ca5ccffbec5c1153fe5d1bb3383e8725937c937
+  data.tar.gz: 66067c6787062a0e72e7bb0f6bb5da4c45202a8e6aee9dd2b0b5d0bc037c8ad89ea1bf01b10c1b90a0f7459c2d2da7f69840a4d6faeee1c5024201569493b53e

data/README.md

@@ -66,13 +66,13 @@ message = Bifrost::Message.new(content: 'some data')
 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 Bifrost message can be either a primitive type or a ruby hash.
 
-A message can also be optionally published with a subject;
+A message can also be optionally published with meta data or properties, this data structure is a hash.
 
 ```ruby
 topic = Bifrost::Topic.new('topic_name')
-message = Bifrost::Message.new(content: 'some data', 'message subject')
+message = Bifrost::Message.new({ content: 'some data' }, { app_name: 'bifrost' })
 message.publish(topic)
 ```
 

data/lib/bifrost/message.rb

@@ -5,15 +5,15 @@ 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 < Entity
-    attr_reader :subject, :body, :status, :message_id
+    attr_reader :meta, :body, :status, :message_id
 
     alias_method :resource_id, :message_id
     alias_method :id, :message_id
 
     # A message must have a valid subject and body. The service
     # bus is initialised in the Entity class
-    def initialize(body, subject = nil)
-      @subject = subject || SecureRandom.base64
+    def initialize(body, meta = {})
+      @meta = meta
       if body.is_a?(Azure::ServiceBus::BrokeredMessage)
         merge(body)
       else
@@ -56,11 +56,12 @@ module Bifrost
     def merge(raw_message)
       @status = :delivered
       begin
-        @body = JSON.parse(raw_message.properties['message'])
+        @meta = raw_message.properties
+        @body = JSON.parse(raw_message.body)
       rescue JSON::ParserError
-        @body = raw_message.properties['message']
+        @body = raw_message
       end
-      @message_id = raw_message.correlation_id
+      @message_id = raw_message.message_id
     end
 
     # Create the message and attempt to deliver It
@@ -69,17 +70,20 @@ module Bifrost
       update_message_state_to_delivered(message)
     end
 
-    # Create the brokered message
+    # Create the brokered message, note that the Bifrost message supports native
+    # ruby hashes, but during the transport these messages are converted to JSON
+    # strings
     def create_brokered_message
-      message = Azure::ServiceBus::BrokeredMessage.new(subject, message: body)
-      message.correlation_id = SecureRandom.uuid
+      payload = body.respond_to?(:to_json) ? body.to_json : body
+      message = Azure::ServiceBus::BrokeredMessage.new(payload, meta)
+      message.message_id = SecureRandom.uuid
       message
     end
 
     # Update the status of the message post delivery
     def update_message_state_to_delivered(message)
       @status = :delivered
-      @message_id = message.correlation_id
+      @message_id = message.message_id
     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 = 3
+  MINOR_VERSION = 4
 
   # The patch version of Bifrost, updated only for bug fixes from the last
   # feature release.
-  PATCH_VERSION = 2
+  PATCH_VERSION = 0
 
   # The full version as a string.
   VERSION = "#{MAJOR_VERSION}.#{MINOR_VERSION}.#{PATCH_VERSION}".freeze

data/lib/bifrost/worker.rb

@@ -57,6 +57,7 @@ module Bifrost
 
     # Actual processing of the message
     def read_message
+      byebug
       raw_message = @bus.interface.receive_subscription_message(topic, subscriber, timeout: ENV['TIMEOUT'] || 10)
       if raw_message
         info("Worker #{self} picked up message #{raw_message}") if Bifrost.debug?

data/spec/bifrost/bus_spec.rb

@@ -16,7 +16,6 @@ describe Bifrost::Bus do
       topic.save
       dup_topic = Bifrost::Topic.new('bus-topic')
       expect(bus.topic_exists?(dup_topic)).to be_truthy
-      topic.delete
     end
   end
 end

data/spec/bifrost/message_spec.rb

@@ -2,9 +2,9 @@ require 'spec_helper'
 require 'bifrost'
 
 describe Bifrost::Message do
-  subject(:message) { Bifrost::Message.new({ content: 'some data' }, 'subscriber_name') }
+  subject(:message) { Bifrost::Message.new({ content: 'some data' }, { app_name: 'bifrost' }) }
 
-  it { is_expected.to respond_to(:subject) }
+  it { is_expected.to respond_to(:meta) }
   it { is_expected.to respond_to(:status) }
   it { is_expected.to respond_to(:message_id) }
   it { is_expected.to respond_to(:resource_id) }
@@ -18,11 +18,6 @@ describe Bifrost::Message do
     end
   end
 
-  it 'should be able to auto generate a subject' do
-    new_message = Bifrost::Message.new(content: 'some data')
-    expect(new_message).to_not be_nil
-  end
-
   describe 'publish' do
     it 'should publish to a valid topic' do
       topic = Bifrost::Topic.new('valid-topic')
@@ -31,7 +26,14 @@ describe Bifrost::Message do
       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 publish a primitive in its payload' do
+      topic = Bifrost::Topic.new('valid-topic')
+      topic.save
+      topic.add_subscriber(Bifrost::Subscriber.new('new_subscriber'))
+      msg = Bifrost::Message.new(1, { app_name: 'bifrost' })
+      expect(msg.publish(topic)).to be_truthy
     end
 
     it 'should not be postable to an invalid topic' do
@@ -50,7 +52,6 @@ describe Bifrost::Message do
       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 update the message id on a replublish of the same messsage' do
@@ -64,7 +65,6 @@ describe Bifrost::Message do
       expect(response).to eq(message.message_id)
       upd_response = message.publish!(topic)
       expect(upd_response).not_to eq(response)
-      topic.delete
     end
 
     it 'should raise an exception upon publish to an invalid topic' do

data/spec/bifrost/worker_spec.rb

@@ -31,7 +31,7 @@ describe Bifrost::Worker do
     topic.save
     subscriber = Bifrost::Subscriber.new('subscriber')
     topic.add_subscriber(subscriber)
-    msg = Bifrost::Message.new([item1: { data: 2 }, item2: { more_data: 3 }])
+    msg = Bifrost::Message.new([item1: { data: 2 }, item2: { more_data: 3 }], { app_name: 'bifrost' })
     msg.publish(topic)
     expect(msg.status).to eq(:delivered)
     expect(msg.message_id).not_to be_nil

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bi-frost
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.0
 platform: ruby
 authors:
 - Shirren Premaratne
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-19 00:00:00.000000000 Z
+date: 2016-11-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: azure