harmoniser 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6daf41d7ec196c5f279bca1e4d9ee1339f17a81508fb4432359b32595c364a07
-  data.tar.gz: 1cab012d3c64c10590f032b768e5acd267980980e988d02b3f7297a138d8477a
+  metadata.gz: e388156d56ef5ed0664269fd342a778cf7cd96547539d8282125252a880b2fe8
+  data.tar.gz: 0d1a7a75f214c27a1f703a5b8951d0063982baf65cd8b492110e79c05c73c2f9
 SHA512:
-  metadata.gz: 3ec7c8e929076ca5725f91d1755ba5548b99e87e8d7c3b6f9d63d029cf6fd76c8419fef99c25b46a525dc49f0d1af011f71a210bf3602d75787fbba7941c5cb1
-  data.tar.gz: 554b5e2c30444280133ec848124e3b1bb88fbb994b3a2056efdbcfaa5817783530b6d25642217db43eaeb25a5cc80652395e7b1203ebe2c37767e07b8a024578
+  metadata.gz: 7398e433e4f12f75cbb807470c1562b569d683b846c84b3dac85c1e23e0cfc21f0365a42a3608d3d9ae7d5e412fa6d80b31ad20455ff587290c353a4b46acdd9
+  data.tar.gz: 1848ced849205cc118ad6b21a64bcce9ca5e781ce5268445ce2f2e8cb84fee7aa52a7afc4561658da5b3069ef4d8b981d63f8d5cfff10b54a84c2ea1d280ff4b

data/CHANGELOG.md

@@ -0,0 +1,16 @@
+# Changelog
+
+## [0.1.0] - 2023-11-27
+
+### Added
+
+- Support to express publishing through any kind of exchanges
+- Capability to subscribe to queues
+- Express RabbitMQ topology separated from the responsibility of publishing or subscribing
+- Provide dedicated Ruby process to consume messages through the subscribers defined
+
+## [0.2.0] - 2023-11-28
+
+### Added
+
+- Introduce github action for releasing the gem once is merged into master

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders 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, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at TODO: Write your email address. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 TODO: Write your name
+
+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,134 @@
+# Harmoniser
+
+A minimalistic approach to communicate with RabbitMQ.
+
+Harmoniser uses [Bunny](https://github.com/ruby-amqp/bunny) as a low level library to communicate with RabbitMQ in order to integrate publishing and messages consuming.
+
+## Getting Started
+
+1. Add this line to your application's Gemfile:
+
+```ruby
+gem "harmoniser"
+```
+
+2. Install the gem:
+
+```ruby
+  $ bundle install
+```
+
+3. Include `Harmoniser::Publisher` and/or `Harmoniser::Subscriber` in your classes. For instance, [this scenario](examples/multicast.rb) assumes that you'd like to run publishers and subscriber under the same process.
+
+4. (Optional) Run the dedicated process for Harmoniser in order to process messages from your subscribers:
+
+```sh
+  $ bundle exec harmoniser --require ./examples/multicast.rb
+```
+
+5. Inspect the logs to see if everything worked as expected. Look for logs including `harmoniser@`.
+
+## Concepts
+
+Harmoniser is a library for publishing/consuming messages through RabbitMQ. It allows to not only connect applications but also to scale an application by performing work in the background. This gem is comprised of three parts:
+
+### Publisher
+
+The Publisher runs in any Ruby process (puma, unicorn, passenger, sidekiq, etc) and allows you to
+push messages through a [RabbitMQ Exchange](https://www.rabbitmq.com/tutorials/amqp-concepts.html#exchanges). Creating a publisher is as simple as:
+
+```ruby
+require "harmoniser"
+
+class MyPublisher
+  include Harmoniser::Publisher
+  harmoniser_publisher exchange_name: "my_topic_exchange"
+end
+
+MyPublisher.publish({ salute: "Hello World!" }.to_json, routing_key: "my_resource.foo.bar")
+```
+
+The code above assumes that the exchange is already defined. We'd like to emphasize that defining RabbitMQ topology (exchanges, queues and binding) should be performed outside of the class whose role is purely focused on publishing. See more details about how to define the topology [here](examples/multicast.rb#L9-L18).
+
+### RabbitMQ
+
+RabbitMQ is the message broker used to publish/consume messages through Harmoniser. It can be configured through `Harmoniser.configure` as follows:
+
+```ruby
+require "harmoniser"
+
+Harmoniser.configure do |config|
+  config.connection_opts = {
+    host: "rabbitmq"
+  }
+end
+```
+
+The options permitted for `connection_opts` are those accepted by
+[Bunny](https://github.com/ruby-amqp/bunny/blob/80a8fc7aa0cd73f8778df87ae05f28c443d10c0d/lib/bunny/session.rb#L142) since at the end this library is built on top of the most widely used Ruby client for RabbitMQ.
+
+### Subscriber Server
+
+Harmoniser server is a process specifically dedicated to run Subscribers that are listening into [Rabbit Queues](https://www.rabbitmq.com/tutorials/amqp-concepts.html#queues). This process like any other Ruby process (puma, unicorn, passenger, sidekiq, etc) is up and running unless OS Signals like (SIGINT, SIGTERM) are sent to it. The server during boot time is able to register each class from your code that includes `Harmoniser::Subscriber` module. Creating a subscriber is as simple as:
+
+```ruby
+class MySubscriber
+  include Harmoniser::Subscriber
+  harmoniser_subscriber queue_name: "my_queue"
+
+  class << self
+    def on_delivery(delivery_info, properties, payload)
+      Harmoniser.logger.info({
+        body: "message received",
+        payload: payload
+      }.to_json)
+    end
+  end
+end
+```
+
+The code above assumes that the queue and its binding to an exchange are already defined. You can see more details about how this is specified [here](examples/multicast.rb#L9-L18).
+
+In order for the subscribers to receive messages from a queue, you should spin up a dedicated Ruby process like following:
+
+```sh
+  $ bundle exec harmoniser --require ./a_path_to_your_ruby_file.rb
+```
+
+More info about the different options accepted by harmoniser process in [Harmoniser CLI](docs/cli.md).
+
+## Contributing
+
+If you are facing issues and you suspect are related to Harmoniser, please consider opening an issue [here](https://github.com/jollopre/harmoniser/issues). Remember to include as much information as possible such as version of Ruby, Rails, Harmoniser, OS, etc.
+
+If you consider you have encountered a potential bug, detailed information about how to reproduce it might help to speed up its fix.
+
+### Code
+
+In order to contribute to this codebase, you will need to setup your local development using the following steps:
+
+```sh
+# Prepare the environment for working locally.
+  $ make build
+# Perform the desired changes into your local copy
+  $ make test
+```
+
+You can also shell into the running container by executing `$ make shell` and from within execute anything related to Harmoniser on its isolated environment.
+
+## Future Improvements
+
+- [ ] Issue: Reopen memoized Channel in the context of the class that are included. There are scenarios for which the channel gets closed, for instance Precondition Failed when checking an exchange declaration.
+- [ ] Chore: Introduce simplecov gem for code coverage.
+- [ ] Feature: Add sensible defaults for Session options like heartbeat, timeout, recovery_completed or recovery_attempt_started.
+- [ ] Feature: Add default `on_return` handler as well as permitting the definition of on_return method to be called anytime a published message gets returned.
+- [ ] Feature: Add default `on_error` and `on_uncaught_exception` as well as permitting the definition of them to be called anytime an error in the channel occurs or error in the consumer handler happens.
+- [ ] Feature: Introduce capability of configuring number of threads for queue consuming at the CLI.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Author
+
+Jose Lloret, [<jollopre@gmail.com>](mailto:jollopre@gmail.com)

data/docs/cli.md

@@ -0,0 +1,20 @@
+# Harmoniser CLI
+
+Harmoniser CLI is a command line tool than run a Ruby process through `bundle exec harmoniser`. This utility accepts the following options:
+
+```sh
+    bundle exec harmoniser -h
+
+    harmoniser [options]
+        -e, --environment ENV            Application environment
+        -r, --require [PATH|DIR]         File to require or location of Rails application
+        -v, --[no-]verbose               Run verbosely
+        -V, --version                    Print version and exit
+        -h, --help                       Show help
+```
+
+The `environment` is automatically inferred from the environment variables `RAILS_ENV` or `RACK_ENV`, otherwise fallbacks to `production`. However you can specify your preferred value, for instance `development` or `test`.
+
+The `require` is by default pointing at `.`, which means that this option when configured under a Rails application, might be ignored. Since Ruby is not Rails only, you can certainly specify the location path of your Ruby file that will be used to load the classes including Harmoniser::Subscriber. In contrast, if a path to a directory is passed, Harmoniser assumes that `./config/environment.rb` lives within the folder passed as option.
+
+The `verbose` option, when passed, sets the severity of Harmoniser logs to `debug` being able to see fine-grained details of things like RabbitMQ interactions happening or messages published into exchanges. By default, the verbosity is disabled to prevent your production environment to be flooded with unnecessary logs, however if the environment is not set to `production`, the severity of the logs is `debug` mode too.

data/harmoniser.gemspec

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require_relative "lib/harmoniser/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "harmoniser"
+  spec.version = Harmoniser::VERSION
+  spec.authors = ["Jose Lloret"]
+  spec.email = ["jollopre@gmail.com"]
+
+  spec.summary = "A minimalistic approach to communicate with RabbitMQ"
+  spec.description = "A declarative approach to communicate with RabbitMQ, that uses the reference low level library, to integrate publishing and consuming of messages"
+  spec.homepage = "https://github.com/jollopre/harmoniser"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.7.0"
+
+  spec.metadata = {
+    "homepage_uri" => spec.homepage,
+    "source_code_uri" => "https://github.com/jollopre/harmoniser",
+    "changelog_uri" => "https://github.com/jollopre/harmoniser/blob/master/CHANGELOG.md"
+  }
+
+  spec.files = Dir["lib/**/*.rb"] + Dir["bin/*"] + Dir["docs/**/*", "CHANGELOG.md", "CODE_OF_CONDUCT.md", "harmoniser.gemspec", "LICENSE.txt", "README.md"]
+  spec.executables = ["harmoniser"]
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "bunny", "~> 2.22"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "standardrb", "~> 1.0"
+end

data/lib/harmoniser/version.rb

@@ -1,3 +1,3 @@
 module Harmoniser
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: harmoniser
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Jose Lloret
@@ -66,7 +66,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
-description: A declarative tool to communicate with RabbitMQ
+description: A declarative approach to communicate with RabbitMQ, that uses the reference
+  low level library, to integrate publishing and consuming of messages
 email:
 - jollopre@gmail.com
 executables:
@@ -74,9 +75,15 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
 - bin/console
 - bin/harmoniser
 - bin/setup
+- docs/cli.md
+- harmoniser.gemspec
 - lib/harmoniser.rb
 - lib/harmoniser/channelable.rb
 - lib/harmoniser/cli.rb
@@ -117,5 +124,5 @@ requirements: []
 rubygems_version: 3.4.10
 signing_key: 
 specification_version: 4
-summary: A declarative tool to communicate with RabbitMQ
+summary: A minimalistic approach to communicate with RabbitMQ
 test_files: []