manageiq-messaging 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e14f157513c6d74acad91f2afd7c3ec932e331d6
+  data.tar.gz: b0cd36a056c1cca5a9ea93f484b64b36e1495034
+SHA512:
+  metadata.gz: 2a07451e8cf57e968a6ad20c5964deca42b5c26392ba22ee52b1586f46ee0f376fc8136eb0ff81093db55e04b6140f4941b07368dedea8ef9c2527709cec45d7
+  data.tar.gz: 19c118466aa8202534457ca03c5760f9f987bd024297490d226a2465e9be7d70d2ac0ab8d18c00b2374305b80481b231884ca0b87b723feb1f4a9af185f8110d

data/.codeclimate.yml

@@ -0,0 +1,47 @@
+---
+exclude_paths:
+- ".git/"
+- "**.xml"
+- "**.yaml"
+- "**.yml"
+- "locale/"
+- "spec/"
+- "tools/"
+engines:
+  brakeman:
+    # very slow :sad_panda:
+    enabled: false
+  bundler-audit:
+    # requires Gemfile.lock
+    enabled: false
+  csslint:
+    enabled: false
+  duplication:
+    enabled: true
+    config:
+      languages:
+      - ruby
+      - javascript
+  eslint:
+    enabled: false
+    channel: "eslint-3"
+  fixme:
+    # let's enable later
+    enabled: false
+  markdownlint:
+    # let's enable later
+    enabled: false
+  rubocop:
+    enabled: true
+    config: '.rubocop_cc.yml'
+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"

data/.gitignore

@@ -0,0 +1,10 @@
+.rubocop-*
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,4 @@
+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

data/.rubocop_cc.yml

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

data/.rubocop_local.yml

@@ -0,0 +1,2 @@
+# GlobalVars:
+#   AllowedVariables:

data/.travis.yml

@@ -0,0 +1,10 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.6
+  - 2.3.1
+  - 2.4.2
+before_install: gem install bundler -v 1.13.0
+after_script: bundle exec codeclimate-test-reporter
+sudo: false
+cache: bundler

data/CHANGES

@@ -0,0 +1,2 @@
+= 0.1.0 - 4-Oct-2018
+* Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at bilwei@redhat.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in manageiq-messaging.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 ManageIQ Authors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,171 @@
+# 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.org/ManageIQ/manageiq-messaging.svg)](https://travis-ci.org/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)
+[![Dependency Status](https://gemnasium.com/ManageIQ/manageiq-messaging.svg)](https://gemnasium.com/ManageIQ/manageiq-messaging)
+[![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.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'manageiq-messaging'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install manageiq-messaging
+
+## Usage
+
+### Initialize a client
+
+It is not recommended to directly create an actual client through `new` operation. Follow the example by specifying a protocol. This allows to easily switch the underlying messaging system from one type to another. Currently `:Stomp` and `:Kafka` are implemented.
+
+```
+  ManageIQ::Messaging.logger = Logger.new(STDOUT)
+
+  client = ManageIQ::Messaging::Client.open(
+    :protocol   => 'Stomp',
+    :host       => 'localhost',
+    :port       => 61616,
+    :password   => 'smartvm',
+    :username   => 'admin',
+    :client_ref => 'generic_1',
+    :encoding   => 'json' # default 'yaml'
+  )
+
+  # publish or consume messages using the client
+
+  client.close
+```
+
+Alternatively, you can pass a block to `.open` without the need to explicitly close the client.
+
+```
+  ManageIQ::Messaging::Client.open(
+    :protocol   => 'Stomp',
+    :host       => 'localhost',
+    :port       => 61616,
+    :password   => 'smartvm',
+    :username   => 'admin',
+    :client_ref => 'generic_1'
+  ) do |client|
+      # do stuff with the client
+    end
+  end
+```
+
+### Publish and subscribe messages
+
+This is the one-to-one publish/subscribe pattern. Multiple subscribers can subscribe to the same queue but only one will consume the message. Subscribers are load balanced.
+
+```
+  client.publish_message(
+    :service  => 'ems_operation',
+    :affinity => 'ems_amazon1',
+    :message  => 'power_on',
+    :payload  => {
+      :ems_ref => 'u987',
+      :id      => '123'
+    }
+  )
+
+  client.subscribe_messages(:service => 'ems_operation', :affinity => 'ems_amazon1') do |messages|
+    messages.each do |msg|
+      # do stuff with msg.message and msg.payload
+      client.ack(msg.ack_ref)
+    end
+  end
+
+  # You can create a second client instance and call subscribe_messages with
+  # the same options. Then both clients will take turns to consume the messages.
+```
+
+For better sending performance, you can publish a collection of messages together
+
+```
+  msg1 = {:service => 'ems_inventory', :affinity => 'ems1', :message => 'refresh', :payload => 'vm1'}
+  msg2 = {:service => 'ems_inventory', :affinity => 'ems1', :massage => 'refresh', :payload => 'vm2')
+  client.publish_messages([msg1, msg2])
+```
+
+Provide a block if you want `#publish_message` to wait on a response from the subscriber. This feature may not be supported by every underlying messaging system.
+
+```
+  client.publish_message(
+    :service  => 'ems_operation',
+    :affinity => 'ems_amazon1',
+    :message  => 'power_on',
+    :payload  => {
+      :ems_ref => 'u987',
+      :id      => '123'
+    }
+  ) do |result|
+    ansible_install_pkg(vm1) if result == 'running'
+  end
+```
+
+### Publish and subscribe background jobs
+
+Background Job is a special type of message with a known `class_name` and the subscriber knows how to process the message without a user block
+
+```
+  client.publish_message(
+    :service    => 'generic',
+    :class_name => 'MiqTask',
+    :message    => 'update_attributes', # method name
+    :payload    => {
+      :instance_id => 2,
+      :args        => [{:status => 'Timeout'}]
+    }
+  )
+
+  client.subscribe_background_job(:service => 'generic')
+```
+
+Provide a call block if you want `#publish_message` to wait on a response from the subscriber.
+
+### Publish and subscribe topics (events)
+
+This is the one-to-many publish/subscribe pattern. Multiple subscribers can subscribe to the same queue and each one will receive the same message.
+
+```
+  client.publish_topic(
+    :service => 'provider_events',
+    :event   => 'powered_on',
+    :sender  => 'ems_amazon1', # optional
+    :payload => {
+      :ems_ref   => 'uid987',
+      :timestamp => '1501091391'
+    })
+
+  client.subscribe_topic(:service => 'provider_events', :persist_ref => 'automate_1') do |sender, event, payload|
+    # do stuff with event and payload. sender may be nil if not set by the publisher
+  end
+```
+
+By default, events are delivered to live subscribers only. Some messaging systems support persistence with options.
+
+## 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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ManageIQ/manageiq-messaging. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "manageiq/messaging"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/examples/README.md

@@ -0,0 +1,16 @@
+# Examples for manageiq-messaging
+
+
+```bash
+docker run -d -p 61616:61616 \
+           -e ARTEMIS_USERNAME=admin \
+           -e ARTEMIS_PASSWORD=smartvm \
+           vromero/activemq-artemis
+```
+
+
+```bash
+cd examples
+bundle exec ruby message.rb
+bundle exec ruby background_job.rb
+```

data/examples/background_job.rb

@@ -0,0 +1,36 @@
+#!/usr/bin/env ruby
+
+require 'manageiq-messaging'
+require_relative "common"
+
+Thread::abort_on_exception = true
+
+class ProducerConsumer < Common
+  SERVICE_NAME = "prodcom"
+  def run
+    ManageIQ::Messaging::Client.open(q_options) do |client|
+      puts "producer"
+      5.times do |i|
+        client.publish_message(:service    => SERVICE_NAME,
+                               :class_name => self.class.name,
+                               :message    => 'do_stuff',
+                               :payload    => {:args=>["hello#{i}"]}
+                              )
+      end
+      puts "produced 5 jobs"
+
+      # this could be a different client
+      puts "consumer"
+      client.subscribe_background_job(:service => SERVICE_NAME)
+
+      sleep(5) # wait for consumer to consume all
+      puts "consumed"
+    end
+  end
+
+  def self.do_stuff(args)
+    puts "GOT MESSAGE: do_stuff(#{args.inspect})"
+  end
+end
+
+ProducerConsumer.new.parse.run