manageiq-messaging 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 78b0fa6b782a5bb3e21552abd1c0b54f473bdc460c722f896a7fecc7389259b3
-  data.tar.gz: f0ff3e82e5108b2241cebcfb2cbf9dde8208c3cf21e61b355d1cec9292562a64
+  metadata.gz: 6d0c0df7c314aa421d82df4122b949a0c3a1bdb10619e77de5e56453b363d339
+  data.tar.gz: 41d110a2e0625e016ba6e9744cfa0c2cf3ae58dae9944aa0ac144b5dbc144905
 SHA512:
-  metadata.gz: 331823865454b700433699cb00f8938311ba91cf0ad87a807ffbc955be6e2d7060e5fc3fabbe91fea5f52b72eaf74a49d0909e94a63a665ccb2f44f9e56f76a0
-  data.tar.gz: a3e6c91fc5ba3a476908d26baf2f5cb3d1d4c768d63e69d3e318442b35f4bf71a3cf501d9dc12bbd53cdba66121f19d2c87ec14dd7eabc19a8aa4aefa40dc302
+  metadata.gz: 9abed064106ee030cd2dd04a7571f91f51f75d2a97bf0c2c15be5a36c8150f8cf910c6c8e4b47c47a659ca4e2134e45798d2c78a62fbe1e92c10adafdfde9b31
+  data.tar.gz: ea8f2f8c8c7712cc91a7f27a47af03ebdbee2fe1366c05b185bf0293bab04d967e190c5b8914389c9c8db2ce82dd13a9b927ae57c9076a0af0cada7e36294481

data/CHANGES

@@ -11,3 +11,6 @@
 = 0.1.4 - 3-Apr-2019
 * Add an #ack method to a ReceivedMessage to simplify manual acknowledgements
 * Allow caller to provide a session_timeout to kafka consumers, default of 30sec
+
+= 0.1.5 - 6-Jun-2019
+* Allow caller to provide extra headers to the message

data/README.md

@@ -156,6 +156,24 @@ This is the one-to-many publish/subscribe pattern. Multiple subscribers can subs
 
 By default, events are delivered to live subscribers only. Some messaging systems support persistence with options.
 
+### Add your own headers to a message (Queue or Topic)
+
+If you want you can add in your own headers to the send message
+
+```
+  client.publish_topic(
+    :service => 'provider_events',
+    :event   => 'powered_on',
+    :headers => {:request_id => "12345"},
+    :payload => {:ems_ref => 'uid987'}
+
+  )
+
+  client.subscribe_topic(:service => 'provider_events', :persist_ref => 'automate_1') do |msg|
+    puts "Received event #{msg.message} with request-id: #{msg.headers['request_id']}"
+  end
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/manageiq/messaging/client.rb

@@ -58,6 +58,7 @@ module ManageIQ
       # * :message    (e.g. method name or message type)
       # * :payload    (message body, a string or an user object that can be serialized)
       # * :sender     (optional, identify the sender)
+      # * :headers    (optional, additional headers to add to the message)
       # Other options are underlying messaging system specific.
       #
       # Optionally a call back block can be provided to wait on the consumer to send
@@ -164,6 +165,7 @@ module ManageIQ
       # * :event   (event name)
       # * :payload (message body, a string or an user object that can be serialized)
       # * :sender  (optional, identify the sender)
+      # * :headers (optional, additional headers to add to the message)
       # Other options are underlying messaging system specific.
       #
       def publish_topic(options)

data/lib/manageiq/messaging/kafka/common.rb

@@ -53,6 +53,7 @@ module ManageIQ
           body, kafka_opts = for_publish(options)
           kafka_opts[:headers][:message_type] = options[:message] if options[:message]
           kafka_opts[:headers][:class_name] = options[:class_name] if options[:class_name]
+          kafka_opts[:headers].merge!(options[:headers].except(*message_header_keys)) if options.key?(:headers)
 
           [body, kafka_opts]
         end
@@ -60,13 +61,15 @@ module ManageIQ
         def topic_for_publish(options)
           body, kafka_opts = for_publish(options)
           kafka_opts[:headers][:event_type] = options[:event] if options[:event]
+          kafka_opts[:headers].merge!(options[:headers].except(*event_header_keys)) if options.key?(:headers)
 
           [body, kafka_opts]
         end
 
         def for_publish(options)
-          kafka_opts = {:topic => address(options), :headers => {}}
-          kafka_opts[:partition_key] = options[:group_name] if options[:group_name]
+          kafka_opts = {:topic => address(options)}
+          kafka_opts[:partition_key]    = options[:group_name] if options[:group_name]
+          kafka_opts[:headers]          = {}
           kafka_opts[:headers][:sender] = options[:sender] if options[:sender]
 
           body = options[:payload] || ''
@@ -85,26 +88,39 @@ module ManageIQ
         def process_queue_message(queue, message)
           payload = decode_body(message.headers, message.value)
           sender, message_type, class_name = parse_message_headers(message.headers)
+          client_headers = message.headers.except(*message_header_keys)
+
           logger.info("Message received: queue(#{queue}), message(#{payload_log(payload)}), sender(#{sender}), type(#{message_type})")
-          [sender, message_type, class_name, payload]
+          [sender, message_type, class_name, payload, client_headers]
         end
 
         def process_topic_message(topic, message)
           begin
             payload = decode_body(message.headers, message.value)
             sender, event_type = parse_event_headers(message.headers)
+            client_headers = message.headers.except(*event_header_keys)
+
             logger.info("Event received: topic(#{topic}), event(#{payload_log(payload)}), sender(#{sender}), type(#{event_type})")
-            yield ManageIQ::Messaging::ReceivedMessage.new(sender, event_type, payload, message, self)
+            yield ManageIQ::Messaging::ReceivedMessage.new(sender, event_type, payload, client_headers, message, self)
             logger.info("Event processed")
           rescue StandardError => e
             logger.error("Event processing error: #{e.message}")
             logger.error(e.backtrace.join("\n"))
+            raise
           end
         end
 
+        def message_header_keys
+          ['sender', 'message_type', 'class_name']
+        end
+
         def parse_message_headers(headers)
           return [nil, nil, nil] unless headers.kind_of?(Hash)
-          headers.values_at('sender', 'message_type', 'class_name')
+          headers.values_at(*message_header_keys)
+        end
+
+        def event_header_keys
+          ['sender', 'event_type']
         end
 
         def parse_event_headers(headers)

data/lib/manageiq/messaging/kafka/queue.rb

@@ -29,7 +29,7 @@ module ManageIQ
             begin
               messages = batch.messages.collect do |message|
                 sender, message_type, _class_name, payload = process_queue_message(topic, message)
-                ManageIQ::Messaging::ReceivedMessage.new(sender, message_type, payload, message, self)
+                ManageIQ::Messaging::ReceivedMessage.new(sender, message_type, payload, headers, message, self)
               end
 
               yield messages

data/lib/manageiq/messaging/received_message.rb

@@ -1,10 +1,10 @@
 module ManageIQ
   module Messaging
     class ReceivedMessage
-      attr_accessor :sender, :message, :payload, :ack_ref, :client
+      attr_accessor :sender, :message, :payload, :headers, :ack_ref, :client
 
-      def initialize(sender, message, payload, ack_ref, client)
-        @sender, @message, @payload, @ack_ref, @client = sender, message, payload, ack_ref, client
+      def initialize(sender, message, payload, headers, ack_ref, client)
+        @sender, @message, @payload, @headers, @ack_ref, @client = sender, message, payload, headers, ack_ref, client
       end
 
       def ack

data/lib/manageiq/messaging/stomp/common.rb

@@ -17,6 +17,8 @@ module ManageIQ
           address = "queue/#{options[:service]}.#{affinity}"
 
           headers = {:"destination-type" => 'ANYCAST', :persistent => true}
+          headers.merge!(options[:headers].except(*internal_header_keys)) if options.key?(:headers)
+
           headers[:expires]            = options[:expires_on].to_i * 1000 if options[:expires_on]
           headers[:AMQ_SCHEDULED_TIME] = options[:deliver_on].to_i * 1000 if options[:deliver_on]
           headers[:priority]           = options[:priority] if options[:priority]
@@ -38,6 +40,8 @@ module ManageIQ
           address = "topic/#{options[:service]}"
 
           headers = {:"destination-type" => 'MULTICAST', :persistent => true}
+          headers.merge!(options[:headers].except(*internal_header_keys)) if options.key?(:headers)
+
           headers[:expires]            = options[:expires_on].to_i * 1000 if options[:expires_on]
           headers[:AMQ_SCHEDULED_TIME] = options[:deliver_on].to_i * 1000 if options[:deliver_on]
           headers[:priority]           = options[:priority] if options[:priority]
@@ -63,6 +67,10 @@ module ManageIQ
           raw_publish(address, result || '', response_headers.merge(:correlation_id => correlation_ref))
         end
 
+        def internal_header_keys
+          [:"destination-type", :persistent, :expires, :AMQ_SCHEDULED_TIME, :priority, :_AMQ_GROUP_ID]
+        end
+
         def receive_response(service, correlation_ref)
           response_options = {
             :service  => "#{service}.response",

data/lib/manageiq/messaging/stomp/queue.rb

@@ -33,9 +33,15 @@ module ManageIQ
               sender = msg.headers['sender']
               message_type = msg.headers['message_type']
               message_body = decode_body(msg.headers, msg.body)
+              client_headers = msg.headers.except(*internal_header_keys)
+
               logger.info("Message received: queue(#{queue_name}), msg(#{payload_log(message_body)}), headers(#{msg.headers})")
 
-              result = yield [ManageIQ::Messaging::ReceivedMessage.new(sender, message_type, message_body, msg, self)]
+              messages = [
+                ManageIQ::Messaging::ReceivedMessage.new(sender, message_type, message_body, client_headers, msg, self)
+              ]
+
+              result = yield messages
               logger.info("Message processed")
 
               correlation_ref = msg.headers['correlation_id']

data/lib/manageiq/messaging/stomp/topic.rb

@@ -21,9 +21,11 @@ module ManageIQ
 
               sender = event.headers['sender']
               event_type = event.headers['event_type']
+              client_headers = event.headers.except(*internal_header_keys)
+
               event_body = decode_body(event.headers, event.body)
               logger.info("Event received: queue(#{queue_name}), event(#{event_body}), headers(#{event.headers})")
-              yield ManageIQ::Messaging::ReceivedMessage.new(sender, event_type, event_body, event, self)
+              yield ManageIQ::Messaging::ReceivedMessage.new(sender, event_type, event_body, client_headers, event, self)
               logger.info("Event processed")
             rescue => e
               logger.error("Event processing error: #{e.message}")

data/lib/manageiq/messaging/version.rb

@@ -1,5 +1,5 @@
 module ManageIQ
   module Messaging
-    VERSION = "0.1.4"
+    VERSION = "0.1.5"
   end
 end

data/manageiq-messaging.gemspec

@@ -24,10 +24,11 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'ruby-kafka', '~> 0.7.0'
   spec.add_dependency 'stomp', '~> 1.4.4'
 
-  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "bundler"
   spec.add_development_dependency "codeclimate-test-reporter", "~> 1.0.0"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "rubocop"
+  spec.add_development_dependency "rubocop-performance"
   spec.add_development_dependency "simplecov"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: manageiq-messaging
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - ManageIQ Authors
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-04-03 00:00:00.000000000 Z
+date: 2019-06-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -56,16 +56,16 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: codeclimate-test-reporter
   requirement: !ruby/object:Gem::Requirement
@@ -122,6 +122,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement