manageiq-messaging 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 56402b3a8736e2983e711c6521c39e12c5afac32dc431e1fc64c9a608c59cc09
-  data.tar.gz: cfe1fb310fbf5971c98f69e866d2637e0b3639822bd05dbc8a16a607c0fbd133
+  metadata.gz: 64efdc1c23146264a24fb6464a2d72480cacd3db28ebc729394ac511d82dbec4
+  data.tar.gz: bb21c6264ee6c05c1d5ea6151f49fe81a156b2f2f9180682a2a14a5597047969
 SHA512:
-  metadata.gz: d107b4468ef6e1b6a37a6a2ab3b294c2fa6f2a6482949bec3b01cc38aa75f8cc4ccf95eeb7e0a22802afcf0e8158dc4cb68de0ea26b22713c520febd8457b1be
-  data.tar.gz: 0fd07ec8805d22ac6cdfef59f58b5e30393e011e822a534f6f6e2159104aa7cba28f1403e1b78872f4f73e5a506e466c25d061318510090bd8fc836345cb8c85
+  metadata.gz: 6f8823df33b9cf386e2ff0188e6df0aa1a28bfb90b6b81b6e6112cc1249429cbc2548601ebf81e2970635535fb4c81b76559e203210b4a97d7a4c6513dad84a8
+  data.tar.gz: 93ec75aa96126b9938318f107e0b789aa5a02f557137668d563506abf24e3d78af333f334318ea114e2bfcc4e1ebdfe9a2659f5d81319a914b9c31a476ad87e4

data/.codeclimate.yml

@@ -1,18 +1,21 @@
----
-exclude_paths:
-- ".git/"
-- "**.xml"
-- "**.yaml"
-- "**.yml"
-- "locale/"
-- "spec/"
-- "tools/"
-engines:
+prepare:
+  fetch:
+  - url: https://raw.githubusercontent.com/ManageIQ/manageiq-style/master/.rubocop_base.yml
+    path: ".rubocop_base.yml"
+  - url: https://raw.githubusercontent.com/ManageIQ/manageiq-style/master/.rubocop_cc_base.yml
+    path: ".rubocop_cc_base.yml"
+  - url: https://raw.githubusercontent.com/ManageIQ/manageiq-style/master/styles/base.yml
+    path: styles/base.yml
+  - url: https://raw.githubusercontent.com/ManageIQ/manageiq-style/master/styles/cc_base.yml
+    path: styles/cc_base.yml
+plugins:
+  rubocop:
+    enabled: true
+    config: ".rubocop_cc.yml"
+    channel: rubocop-0-82
   brakeman:
-    # very slow :sad_panda:
     enabled: false
   bundler-audit:
-    # requires Gemfile.lock
     enabled: false
   csslint:
     enabled: false
@@ -24,25 +27,17 @@ engines:
       - javascript
   eslint:
     enabled: false
-    channel: "eslint-3"
+    channel: eslint-3
   fixme:
-    # let's enable later
     enabled: false
   markdownlint:
-    # let's enable later
     enabled: false
-  rubocop:
-    enabled: true
-    config: '.rubocop_cc.yml'
-    channel: 'rubocop-0-69'
-prepare:
-  fetch:
-  - url: "https://raw.githubusercontent.com/ManageIQ/guides/master/.rubocop_base.yml"
-    path: ".rubocop_base.yml"
-  - url: "https://raw.githubusercontent.com/ManageIQ/guides/master/.rubocop_cc_base.yml"
-    path: ".rubocop_cc_base.yml"
-ratings:
-  paths:
-  - Gemfile.lock
-  - "**.rake"
-  - "**.rb"
+exclude_patterns:
+- ".git/"
+- "**.xml"
+- "**.yaml"
+- "**.yml"
+- locale/
+- spec/
+- tools/
+version: '2'

data/.rubocop.yml

@@ -1,5 +1,4 @@
 inherit_gem:
-  manageiq-style: .rubocop_base.yml
+  manageiq-style: ".rubocop_base.yml"
 inherit_from:
-# put all local rubocop config into .rubocop_local.yml as it will be loaded by .rubocop_cc.yml as well
-- .rubocop_local.yml
+- ".rubocop_local.yml"

data/.rubocop_cc.yml

@@ -1,5 +1,4 @@
 inherit_from:
-# this is downloaded by .codeclimate.yml
-- .rubocop_base.yml
-- .rubocop_cc_base.yml
-- .rubocop_local.yml
+- ".rubocop_base.yml"
+- ".rubocop_cc_base.yml"
+- ".rubocop_local.yml"

data/CHANGES

@@ -28,3 +28,6 @@
 
 = 1.0.2 - 4-Jan-2021
 * Rails 6.0 Support
+
+= 1.0.3 - 12-May-2021
+* Allow bulk publish of messages to a topic

data/README.md

@@ -155,6 +155,19 @@ 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.
 
+### Publish bulk messages to a topic
+
+Often it is more efficient to publish messages in bulk rather than one-at-a-time.  To do this you can pass an array of messages to the `publish_topic` API:
+
+```ruby
+  client.publish_topic(
+    [
+      {:service => 'provider_events', :event => 'powered_off', :payload => {:ems_ref => 'uid987', :timestamp => '1501091391'}},
+      {:service => 'provider_events', :event => 'powered_on', :payload => {:ems_ref => 'uid987', :timestamp => '1501091429'}},
+    ]
+  )
+```
+
 ### Add your own headers to a message (Queue or Topic)
 
 If you want you can add in your own headers to the send message

data/lib/manageiq/messaging.rb

@@ -1,3 +1,4 @@
+require 'active_support/core_ext/array/wrap'
 require 'active_support/core_ext/module/delegation'
 require 'active_support/core_ext/hash'
 require 'yaml'

data/lib/manageiq/messaging/client.rb

@@ -161,7 +161,8 @@ module ManageIQ
       end
 
       # Publish a message as a topic. All subscribers will receive a copy of the message.
-      # Expected keys in +options+ are:
+      # +messages+ can be either a hash or an array of hashes.
+      # Expected keys are:
       # * :service (service is used to determine the topic address)
       # * :event   (event name)
       # * :payload (message body, a string or an user object that can be serialized)
@@ -169,10 +170,11 @@ module ManageIQ
       # * :headers (optional, additional headers to add to the message)
       # Other options are underlying messaging system specific.
       #
-      def publish_topic(options)
-        assert_options(options, [:event, :service])
+      def publish_topic(messages)
+        messages = Array.wrap(messages)
+        messages.each { |msg| assert_options(msg, [:event, :service]) }
 
-        publish_topic_impl(options)
+        publish_topic_impl(messages)
       end
 
       # Subscribe to receive topic type messages.

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

@@ -76,18 +76,23 @@ module ManageIQ
         attr_reader :kafka_client
 
         def initialize(options)
-          hosts = Array(options[:hosts] || options[:host])
-          hosts.collect! { |host| "#{host}:#{options[:port]}" }
-
           @encoding = options[:encoding] || 'yaml'
           require "json" if @encoding == "json"
 
-          connection_opts = {:"bootstrap.servers" => hosts.join(',')}
-          connection_opts[:"client.id"] = options[:client_ref] if options[:client_ref]
-          connection_opts.merge!(options.except(:port, :host, :hosts, :encoding, :protocol, :client_ref))
-
           ::Rdkafka::Config.logger = logger
-          @kafka_client = ::Rdkafka::Config.new(connection_opts)
+          @kafka_client = ::Rdkafka::Config.new(rdkafka_connection_opts(options))
+        end
+
+        def rdkafka_connection_opts(options)
+          hosts = Array(options[:hosts] || options[:host])
+          hosts.collect! { |host| "#{host}:#{options[:port]}" }
+
+          result = {:"bootstrap.servers" => hosts.join(',')}
+          result[:"client.id"] = options[:client_ref] if options[:client_ref]
+          result[:"sasl.username"] = options[:username] if options[:username]
+          result[:"sasl.password"] = options[:password] if options[:password]
+
+          result.merge(options.except(:port, :host, :hosts, :encoding, :protocol, :client_ref, :username, :password))
         end
       end
     end

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

@@ -21,12 +21,9 @@ module ManageIQ
           @consumer = kafka_client.consumer
         end
 
-        def raw_publish(wait, body, options)
+        def raw_publish(body, options)
           options[:payload] = encode_body(options[:headers], body)
-          producer.produce(options).tap do |handle|
-            handle.wait if wait
-            logger.info("Published to topic(#{options[:topic]}), msg(#{payload_log(body.inspect)})")
-          end
+          producer.produce(options)
         end
 
         def queue_for_publish(options)

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

@@ -8,11 +8,11 @@ module ManageIQ
 
         def publish_message_impl(options)
           raise ArgumentError, "Kafka messaging implementation does not take a block" if block_given?
-          raw_publish(true, *queue_for_publish(options))
+          raw_publish(*queue_for_publish(options)).wait
         end
 
         def publish_messages_impl(messages)
-          handles = messages.collect { |msg_options| raw_publish(false, *queue_for_publish(msg_options)) }
+          handles = messages.collect { |msg_options| raw_publish(*queue_for_publish(msg_options)) }
           handles.each(&:wait)
         end
 

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

@@ -8,8 +8,9 @@ module ManageIQ
 
         private
 
-        def publish_topic_impl(options)
-          raw_publish(true, *topic_for_publish(options))
+        def publish_topic_impl(messages)
+          handles = messages.collect { |message| raw_publish(*topic_for_publish(message)) }
+          handles.each(&:wait)
         end
 
         def subscribe_topic_impl(options, &block)

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

@@ -4,7 +4,7 @@ module ManageIQ
       module Topic
         private
 
-        def publish_topic_impl(options)
+        def publish_topic_single(options)
           address, headers = topic_for_publish(options)
           headers[:sender] = options[:sender] if options[:sender]
           headers[:event_type] = options[:event] if options[:event]
@@ -12,6 +12,10 @@ module ManageIQ
           raw_publish(address, options[:payload], headers)
         end
 
+        def publish_topic_impl(messages)
+          messages.each { |message| publish_topic_single(message) }
+        end
+
         def subscribe_topic_impl(options)
           queue_name, headers = topic_for_subscribe(options)
 

data/lib/manageiq/messaging/version.rb

@@ -1,5 +1,5 @@
 module ManageIQ
   module Messaging
-    VERSION = "1.0.2"
+    VERSION = "1.0.3"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: manageiq-messaging
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - ManageIQ Authors
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-01-04 00:00:00.000000000 Z
+date: 2021-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -207,7 +207,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.0.rc.2
+rubygems_version: 3.2.5
 signing_key:
 specification_version: 4
 summary: Client library for ManageIQ components to exchange messages through its internal