manageiq-messaging 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aa6536d137d3873d7b73cecfc02add52d949bf4c240846b9df4c0a46b02be560
-  data.tar.gz: 240ffe6f8dacc50a80759335f4d748dc826675cf38e0567117809582580489a0
+  metadata.gz: 7dd9c250d5717fe5eff8c8d84483a3b6ee4286026584beffa2a9f2491b968901
+  data.tar.gz: 12560dc540325e6681757934f5842497e19890c5c55747f5a06b3265591e8fa1
 SHA512:
-  metadata.gz: 45b6e6592e772ffc7373489116a72403d5b6fb2a2e322b4d5d6c629ee6eddd575c3eaf1e7d92afe504b361eaaaa46047e0d85b8ed640272d41098b5d185d8a45
-  data.tar.gz: e95db7f79892be46eb800e4f241b932282cdebf2f4ffb30a65bfea8a85f24161b9fdc5afbca4d182170aa7fb33f85edcf59881b51a8be80db868bf65bbf6da5b
+  metadata.gz: a46c52b888a699c483c81c19a9e1287b8dbde9a2aa3e4f7c30b220775a398b81d9fc7ea6b846b66c186ed1a83461395898bf010412e23427b8e271b7c73f349d
+  data.tar.gz: 2a5ae4e0b8ef60fd8f3d18c132719a91a2a9d0c940c01f241e1e30555d993e3b609c966895e0b135e17534d74e9f1680bd3e244d3689471b36d1a50af46ef07a

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,4 +1,4 @@
+inherit_gem:
+  manageiq-style: ".rubocop_base.yml"
 inherit_from:
-- https://raw.githubusercontent.com/ManageIQ/guides/master/.rubocop_base.yml
-# 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/.travis.yml

@@ -1,10 +1,11 @@
-sudo: false
 language: ruby
 rvm:
-  - 2.4.5
-  - 2.5.7
-  - 2.6.5
+- 2.6.9
+- 2.7.5
 before_install: gem install bundler -v 1.13.0
 after_script: bundle exec codeclimate-test-reporter
-sudo: false
 cache: bundler
+env:
+  matrix:
+    - TEST_RAILS_VERSION=6.1
+    - TEST_RAILS_VERSION=6.0

data/.whitesource

@@ -0,0 +1,3 @@
+{
+  "settingsInheritedFrom": "ManageIQ/whitesource-config@master"
+}

data/CHANGES

@@ -20,3 +20,17 @@
 
 = 1.0.0 - 28-Sep-2020
 * Switch to use rdkafka client
+
+= 1.0.1 - 15-Dec-2020
+* Allow all kafka options to be passed
+* remove sudo:false from .travis.yml
+* Use manageiq-style
+
+= 1.0.2 - 4-Jan-2021
+* Rails 6.0 Support
+
+= 1.0.3 - 12-May-2021
+* Allow bulk publish of messages to a topic
+
+= 1.1.0 - 09-Feb-2022
+* Allow rails 6.1

data/Gemfile

@@ -2,3 +2,10 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in manageiq-messaging.gemspec
 gemspec
+
+case ENV['TEST_RAILS_VERSION']
+when "6.0"
+  gem "activesupport", "~>6.0.4"
+when "6.1"
+  gem "activesupport", "~>6.1.4"
+end

data/README.md

@@ -4,7 +4,6 @@
 [![Build Status](https://travis-ci.com/ManageIQ/manageiq-messaging.svg)](https://travis-ci.com/ManageIQ/manageiq-messaging)
 [![Code Climate](https://codeclimate.com/github/ManageIQ/manageiq-messaging.svg)](https://codeclimate.com/github/ManageIQ/manageiq-messaging)
 [![Test Coverage](https://codeclimate.com/github/ManageIQ/manageiq-messaging/badges/coverage.svg)](https://codeclimate.com/github/ManageIQ/manageiq-messaging/coverage)
-[![Security](https://hakiri.io/github/ManageIQ/manageiq-messaging/master.svg)](https://hakiri.io/github/ManageIQ/manageiq-messaging/master)
 
 Client library for ManageIQ components to exchange messages through its internal message bus.
 
@@ -155,6 +154,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/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,17 +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]
-
           ::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.0"
+    VERSION = "1.1.0"
   end
 end

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/manageiq-messaging.gemspec

@@ -21,15 +21,14 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency 'activesupport', '~> 5.2.4.3'
+  spec.add_dependency 'activesupport', '>= 5.2.4.3', "< 7.0"
   spec.add_dependency 'rdkafka', '~> 0.8'
   spec.add_dependency 'stomp', '~> 1.4.4'
 
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "codeclimate-test-reporter", "~> 1.0.0"
+  spec.add_development_dependency "manageiq-style"
   spec.add_development_dependency "rake", ">= 12.3.3"
   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,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: manageiq-messaging
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - ManageIQ Authors
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-09-29 00:00:00.000000000 Z
+date: 2022-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 5.2.4.3
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 5.2.4.3
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: rdkafka
   requirement: !ruby/object:Gem::Requirement
@@ -81,61 +87,47 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.0.0
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: manageiq-style
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 12.3.3
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 12.3.3
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
-  name: rubocop-performance
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -152,7 +144,7 @@ dependencies:
         version: '0'
 description: Client library for ManageIQ components to exchange messages through its
   internal message bus.
-email:
+email: 
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -164,6 +156,7 @@ files:
 - ".rubocop_cc.yml"
 - ".rubocop_local.yml"
 - ".travis.yml"
+- ".whitesource"
 - CHANGES
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -200,7 +193,7 @@ homepage: http://github.com/ManageIQ/manageiq-messaging
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -215,8 +208,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.3
-signing_key:
+rubygems_version: 3.3.5
+signing_key: 
 specification_version: 4
 summary: Client library for ManageIQ components to exchange messages through its internal
   message bus.