harmoniser 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e388156d56ef5ed0664269fd342a778cf7cd96547539d8282125252a880b2fe8
-  data.tar.gz: 0d1a7a75f214c27a1f703a5b8951d0063982baf65cd8b492110e79c05c73c2f9
+  metadata.gz: b1feaead73df2956797f89d33ed45a3316cf5191852946c1b0d3cbe2e2284f18
+  data.tar.gz: 6ba7ae634d24a012d4243d392d4299a9fd88a35af5df1251efec24bb4817ce9c
 SHA512:
-  metadata.gz: 7398e433e4f12f75cbb807470c1562b569d683b846c84b3dac85c1e23e0cfc21f0365a42a3608d3d9ae7d5e412fa6d80b31ad20455ff587290c353a4b46acdd9
-  data.tar.gz: 1848ced849205cc118ad6b21a64bcce9ca5e781ce5268445ce2f2e8cb84fee7aa52a7afc4561658da5b3069ef4d8b981d63f8d5cfff10b54a84c2ea1d280ff4b
+  metadata.gz: 9cfcdeec3f6e205c9301d5f2142cd8e7fee0723ed5950fdf1bd12a704f1cc29ecf971e39c75ef7ace071ea577a37f45a874c4016a63c561d25c3e206f1fb0e6f
+  data.tar.gz: 45b409fb2bfa3ec1752101915fad8f52ccf1e5a5ea1402e23ee6fc062e952fbdb78a16015f77bc2ef2ddafda04859eb23d0e9c8c9cef06a9675fe0c44e81f5d5

data/CHANGELOG.md

@@ -1,16 +1,31 @@
 # Changelog
 
-## [0.1.0] - 2023-11-27
+## [0.4.0] - 2023-12-07
 
 ### Added
+- Default logger with error severity for when errors occur at channel level
+- Default logger with error severity for when errors occur while processing a message from a queue
 
-- 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
+### Removed
+- Unused docker image for rabbitMQ (only for development purposes)
+
+## [0.3.0] - 2023-11-29
+
+### Added
+
+- Introduce github action for building, linting and running specs anytime a pull request is opened or push to master happens
 
 ## [0.2.0] - 2023-11-28
 
 ### Added
 
 - Introduce github action for releasing the gem once is merged into master
+
+## [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

data/README.md

@@ -1,6 +1,9 @@
 # Harmoniser
 
-A minimalistic approach to communicate with RabbitMQ.
+[![Gem Version](https://badge.fury.io/rb/harmoniser.svg)](https://badge.fury.io/rb/harmoniser)
+![CI workflow](https://github.com/jollopre/harmoniser/actions/workflows/ci.yml/badge.svg)
+
+A minimalistic approach to communicating 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.
 
@@ -122,7 +125,6 @@ You can also shell into the running container by executing `$ make shell` and fr
 - [ ] 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

data/harmoniser.gemspec

@@ -8,11 +8,11 @@ Gem::Specification.new do |spec|
   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.summary = "A minimalistic approach to communicating with RabbitMQ"
+  spec.description = "A declarative approach to communicating with RabbitMQ that makes it easy to integrate publishing and consuming messages"
   spec.homepage = "https://github.com/jollopre/harmoniser"
   spec.license = "MIT"
-  spec.required_ruby_version = ">= 2.7.0"
+  spec.required_ruby_version = ">= 3.2"
 
   spec.metadata = {
     "homepage_uri" => spec.homepage,
@@ -26,6 +26,6 @@ Gem::Specification.new do |spec|
 
   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 "rspec", "~> 3"
   spec.add_development_dependency "standardrb", "~> 1.0"
 end

data/lib/harmoniser/channelable.rb

@@ -11,8 +11,20 @@ module Harmoniser
       end
 
       def create_channel
-        connection = Harmoniser.connection
-        connection.create_channel
+        channel = Harmoniser.connection.create_channel
+        channel.on_error(&method(:on_error).to_proc)
+        channel.on_uncaught_exception(&method(:on_uncaught_exception).to_proc)
+        channel
+      end
+
+      private
+
+      def on_error(channel, amq_method)
+        Harmoniser.logger.error("Default on_error handler executed for channel: method = `#{amq_method}`, exchanges = `#{channel.exchanges.keys}`, queues = `#{channel.queues.keys}`")
+      end
+
+      def on_uncaught_exception(error, consumer)
+        Harmoniser.logger.error("Default on_uncaught_exception handler executed for channel: error_class = `#{error.class}`, error_message = `#{error.message}`, error_backtrace = `#{error.backtrace&.first(5)}, queue = `#{consumer.queue}`")
       end
     end
 

data/lib/harmoniser/configuration.rb

@@ -20,14 +20,14 @@ module Harmoniser
     }
     MUTEX = Mutex.new
 
-    attr_reader :connection, :connection_opts, :logger, :options
+    attr_reader :connection_opts, :logger, :options
     def_delegators :options, :environment, :require, :verbose
 
     def initialize
       @logger = Logger.new($stdout, progname: "harmoniser@#{VERSION}")
       @options = Options.new(**default_options)
       set_logger_severity
-      @connection_opts = DEFAULT_CONNECTION_OPTS.merge({ logger: @logger })
+      @connection_opts = DEFAULT_CONNECTION_OPTS.merge({logger: @logger})
       @topology = Topology.new
     end
 
@@ -39,7 +39,7 @@ module Harmoniser
 
     def connection
       MUTEX.synchronize do
-        @connection = Connection.new(connection_opts) unless @connection
+        @connection ||= Connection.new(connection_opts)
         @connection.start unless @connection.open?
         @connection
       end
@@ -51,8 +51,8 @@ module Harmoniser
       @connection_opts = connection_opts.merge(opts)
     end
 
-    def options_with(**kwargs)
-      @options = options.with(**kwargs)
+    def options_with(**)
+      @options = options.with(**)
       set_logger_severity
     end
 
@@ -67,10 +67,10 @@ module Harmoniser
     end
 
     def set_logger_severity
-      if @options.production?
-        @logger.level = @options.verbose? ? Logger::DEBUG : Logger::INFO
+      @logger.level = if @options.production?
+        @options.verbose? ? Logger::DEBUG : Logger::INFO
       else
-        @logger.level = Logger::DEBUG
+        Logger::DEBUG
       end
     end
   end

data/lib/harmoniser/launcher.rb

@@ -34,7 +34,7 @@ module Harmoniser
     end
 
     def stop_subscribers
-      @logger.info("Connection will be closed: connection = `#{@configuration.connection.to_s}`")
+      @logger.info("Connection will be closed: connection = `#{@configuration.connection}`")
       @configuration.connection.close
     end
 

data/lib/harmoniser/publisher.rb

@@ -3,7 +3,7 @@ require "harmoniser/definition"
 
 module Harmoniser
   module Publisher
-    class MissingExchangeDefinition < StandardError ; end
+    class MissingExchangeDefinition < StandardError; end
     include Channelable
     MUTEX = Mutex.new
     private_constant :MUTEX
@@ -13,7 +13,7 @@ module Harmoniser
         @harmoniser_exchange_definition = Definition::Exchange.new(
           name: exchange_name,
           type: nil,
-          opts: { passive: true }
+          opts: {passive: true}
         )
       end
 

data/lib/harmoniser/subscriber.rb

@@ -4,7 +4,7 @@ require "harmoniser/includable"
 
 module Harmoniser
   module Subscriber
-    class MissingConsumerDefinition < StandardError ; end
+    class MissingConsumerDefinition < StandardError; end
     include Channelable
     include Includable
     MUTEX = Mutex.new

data/lib/harmoniser/topology.rb

@@ -64,7 +64,7 @@ module Harmoniser
         if binding.queue?
           channel.queue_bind(binding.destination_name, binding.exchange_name, binding.opts)
         elsif binding.exchange?
-          ;
+
         end
       end
     end

data/lib/harmoniser/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: harmoniser
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Jose Lloret
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-11-27 00:00:00.000000000 Z
+date: 2023-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bunny
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: standardrb
   requirement: !ruby/object:Gem::Requirement
@@ -66,8 +66,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
-description: A declarative approach to communicate with RabbitMQ, that uses the reference
-  low level library, to integrate publishing and consuming of messages
+description: A declarative approach to communicating with RabbitMQ that makes it easy
+  to integrate publishing and consuming messages
 email:
 - jollopre@gmail.com
 executables:
@@ -114,7 +114,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -124,5 +124,5 @@ requirements: []
 rubygems_version: 3.4.10
 signing_key: 
 specification_version: 4
-summary: A minimalistic approach to communicate with RabbitMQ
+summary: A minimalistic approach to communicating with RabbitMQ
 test_files: []