manageiq-messaging 1.0.2 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 56402b3a8736e2983e711c6521c39e12c5afac32dc431e1fc64c9a608c59cc09
-  data.tar.gz: cfe1fb310fbf5971c98f69e866d2637e0b3639822bd05dbc8a16a607c0fbd133
+  metadata.gz: f305d2c3c254dc42831ab6d12154fa65edeedc3461fbf88bfa77166e68613702
+  data.tar.gz: 939165f57c4671312398de35cec92781d5f97a82c08a584e7a0da727e2ed2eca
 SHA512:
-  metadata.gz: d107b4468ef6e1b6a37a6a2ab3b294c2fa6f2a6482949bec3b01cc38aa75f8cc4ccf95eeb7e0a22802afcf0e8158dc4cb68de0ea26b22713c520febd8457b1be
-  data.tar.gz: 0fd07ec8805d22ac6cdfef59f58b5e30393e011e822a534f6f6e2159104aa7cba28f1403e1b78872f4f73e5a506e466c25d061318510090bd8fc836345cb8c85
+  metadata.gz: 14e817bf9ee97c577b866a49989b8041c96c8ec2f9949aace412c3065e5143f6bac18ffae0569b8ff87506dc33604349b2a79e4ed62edbf44820e7ebcae9bcfe
+  data.tar.gz: a8d5a83c36de5a9290573e893fcbd97468ef47700e96ec499cce1649e4dc68090a6d3fdb43acdf1a4a7b4ce62f8daa49f469db1b2f7b7be721e46122fda04f9b

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/.github/workflows/ci.yaml

@@ -0,0 +1,36 @@
+name: CI
+
+on:
+  push:
+  pull_request:
+  schedule:
+  - cron: '0 0 * * 0'
+
+jobs:
+  ci:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version:
+        - '2.6'
+        - '2.7'
+        - '3.0'
+        rails-version:
+        - '6.0'
+        - '6.1'
+    env:
+      TEST_RAILS_VERSION: ${{ matrix.rails-version }}
+      CC_TEST_REPORTER_ID: ${{ secrets.CC_TEST_REPORTER_ID }}
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true
+    - name: Run tests
+      run: bundle exec rake
+    - name: Report code coverage
+      if: ${{ github.ref == 'refs/heads/master' && matrix.ruby-version == '3.0' && matrix.rails-version == '6.1' }}
+      continue-on-error: true
+      uses: paambaati/codeclimate-action@v3.0.0

data/.rspec

@@ -1,2 +1,3 @@
---format documentation
+--require spec_helper
 --color
+--order random

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/.whitesource

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

data/CHANGELOG.md

@@ -0,0 +1,78 @@
+# Change Log
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/)
+and this project adheres to [Semantic Versioning](http://semver.org/).
+
+## [Unreleased]
+
+## [1.1.1] - 6-May-2022
+
+* Ruby 3.0 support [#71](https://github.com/ManageIQ/manageiq-messaging/pull/71)
+
+## [1.1.0] - 09-Feb-2022
+
+* Allow rails 6.1 [#66](https://github.com/ManageIQ/manageiq-messaging/pull/66)
+
+## [1.0.3] - 12-May-2021
+
+* Allow bulk publish of messages to a topic
+
+## [1.0.2] - 4-Jan-2021
+
+* Rails 6.0 Support
+
+## [1.0.1] - 15-Dec-2020
+
+* Allow all kafka options to be passed
+* remove sudo:false from .travis.yml
+* Use manageiq-style
+
+## [1.0.0] - 28-Sep-2020
+
+* Switch to use rdkafka client
+
+## [0.1.7] - 14-May-2021
+
+* Loosen ActiveSupport dependency to ~> 5.2
+
+## [0.1.6] - 6-July-2020
+
+* Rescue message body decoding errors. Re-raise errors raised by users code of processing received messages. 
+
+## [0.1.5] - 6-Jun-2019
+
+* Allow caller to provide extra headers to the message
+
+## [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.3] - 25-Feb-2019
+
+## 0.1.2 - 11-Dec-2018
+
+* Allow to set max_bytes to each_batch when subscribe to a Kafka topic.
+
+## 0.1.1 - 20-Nov-2018
+
+* By default upon receiving a message or an event, it is automatically acknowledged. But
+  the subscriber can decide to turn off the auto ack feature and ack it in the callback block.
+
+## 0.1.0 - 4-Oct-2018
+
+* Initial release
+
+[Unreleased]: https://github.com/ManageIQ/manageiq-messaging/compare/v1.1.1...HEAD
+[1.1.1]: https://github.com/ManageIQ/manageiq-messaging/compare/v1.1.0...v1.1.1
+[1.1.0]: https://github.com/ManageIQ/manageiq-messaging/compare/v1.0.3...v1.1.0
+[1.0.3]: https://github.com/ManageIQ/manageiq-messaging/compare/v1.0.2...v1.0.3
+[1.0.2]: https://github.com/ManageIQ/manageiq-messaging/compare/v1.0.1...v1.0.2
+[1.0.1]: https://github.com/ManageIQ/manageiq-messaging/compare/v1.0.0...v1.0.1
+[1.0.0]: https://github.com/ManageIQ/manageiq-messaging/compare/v0.1.7...v1.0.0
+[0.1.7]: https://github.com/ManageIQ/manageiq-messaging/compare/v0.1.6...v0.1.7
+[0.1.6]: https://github.com/ManageIQ/manageiq-messaging/compare/v0.1.5...v0.1.6
+[0.1.5]: https://github.com/ManageIQ/manageiq-messaging/compare/v0.1.4...v0.1.5
+[0.1.4]: https://github.com/ManageIQ/manageiq-messaging/compare/v0.1.3...v0.1.4
+

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

@@ -1,10 +1,9 @@
 # ManageIQ Messaging Client
 
 [![Gem Version](https://badge.fury.io/rb/manageiq-messaging.svg)](http://badge.fury.io/rb/manageiq-messaging)
-[![Build Status](https://travis-ci.com/ManageIQ/manageiq-messaging.svg)](https://travis-ci.com/ManageIQ/manageiq-messaging)
+[![CI](https://github.com/ManageIQ/manageiq-messaging/actions/workflows/ci.yaml/badge.svg)](https://github.com/ManageIQ/manageiq-messaging/actions/workflows/ci.yaml)
 [![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,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.1.1"
   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

@@ -11,24 +11,28 @@ Gem::Specification.new do |spec|
 
   spec.summary       = 'Client library for ManageIQ components to exchange messages through its internal message bus.'
   spec.description   = 'Client library for ManageIQ components to exchange messages through its internal message bus.'
-  spec.homepage      = 'http://github.com/ManageIQ/manageiq-messaging'
+  spec.homepage      = 'https://github.com/ManageIQ/manageiq-messaging'
   spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
+  spec.metadata    = {
+    "changelog_uri" => "https://github.com/ManageIQ/manageiq-messaging/blob/master/CHANGELOG.md",
+    "source_code_uri" => "https://github.com/ManageIQ/manageiq-messaging/",
+    "bug_tracker_uri" => "https://github.com/ManageIQ/manageiq-messaging/issues"
+  }
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency 'activesupport', '>= 5.2.4.3', "< 6.1"
+  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 "simplecov"
+  spec.add_development_dependency "rake",      ">= 12.3.3"
+  spec.add_development_dependency "rspec",     "~> 3.0"
+  spec.add_development_dependency "simplecov", ">= 0.21.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: manageiq-messaging
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.1
 platform: ruby
 authors:
 - ManageIQ Authors
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-01-04 00:00:00.000000000 Z
+date: 2022-05-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -19,7 +19,7 @@ dependencies:
         version: 5.2.4.3
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: 5.2.4.3
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: rdkafka
   requirement: !ruby/object:Gem::Requirement
@@ -72,20 +72,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: codeclimate-test-reporter
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.0.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: manageiq-style
   requirement: !ruby/object:Gem::Requirement
@@ -134,14 +120,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.21.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.21.2
 description: Client library for ManageIQ components to exchange messages through its
   internal message bus.
 email:
@@ -150,13 +136,14 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".codeclimate.yml"
+- ".github/workflows/ci.yaml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
 - ".rubocop_cc.yml"
 - ".rubocop_local.yml"
-- ".travis.yml"
-- CHANGES
+- ".whitesource"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -188,10 +175,13 @@ files:
 - lib/manageiq/messaging/stomp/topic.rb
 - lib/manageiq/messaging/version.rb
 - manageiq-messaging.gemspec
-homepage: http://github.com/ManageIQ/manageiq-messaging
+homepage: https://github.com/ManageIQ/manageiq-messaging
 licenses:
 - MIT
-metadata: {}
+metadata:
+  changelog_uri: https://github.com/ManageIQ/manageiq-messaging/blob/master/CHANGELOG.md
+  source_code_uri: https://github.com/ManageIQ/manageiq-messaging/
+  bug_tracker_uri: https://github.com/ManageIQ/manageiq-messaging/issues
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -207,7 +197,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.3.5
 signing_key:
 specification_version: 4
 summary: Client library for ManageIQ components to exchange messages through its internal

data/.travis.yml

@@ -1,8 +0,0 @@
-language: ruby
-rvm:
-  - 2.4.5
-  - 2.5.7
-  - 2.6.5
-before_install: gem install bundler -v 1.13.0
-after_script: bundle exec codeclimate-test-reporter
-cache: bundler

data/CHANGES

@@ -1,30 +0,0 @@
-= 0.1.0 - 4-Oct-2018
-* Initial release
-
-= 0.1.1 - 20-Nov-2018
-* By default upon receiving a message or an event, it is automatically acknowledged. But
-  the subscriber can decide to turn off the auto ack feature and ack it in the callback block.
-
-= 0.1.2 - 11-Dec-2018
-* Allow to set max_bytes to each_batch when subscribe to a Kafka topic.
-
-= 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
-
-= 0.1.6 - 6-July-2020
-* Rescue message body decoding errors. Re-raise errors raised by users code of processing received messages. 
-
-= 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