eventhub-processor2 1.19.0 → 1.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '052794836cc75c8908c03f61cc5381717d5ed76985f7d3c949fa9dbe7d55b32f'
-  data.tar.gz: b92271dc527b40b66b6005b7a0547c77b224b0e90be973ccadaa57705ab6789a
+  metadata.gz: ff9077a8af2791cd681fb21b96a3d60d06ba79e6721e721b814dcc1f3d344eb8
+  data.tar.gz: d05e33dfff330eb2523b2050c8d5fa2d299d6f14b320bce4eaa100b53a6a03e2
 SHA512:
-  metadata.gz: 0d9aec7ca4a1f60f33ea8d07307d262e9999bedc5c285bb7369dc3667be2916e8e73b9597ab72a65837bf6a7a7de8c107e1a7f365cc17ae064f4f2e3453bf6f5
-  data.tar.gz: ff0a4e5bb9a261838913fbd6265ac796901ed23285e9f0c3e167082a8eb1f16e457b79aaad697d97acf4293690ccad2e50d4da93ff411a13a25f730360c4cfbf
+  metadata.gz: 67729c0fa807676e90fb029ac97b08c2144f77b5fa22820736975b67a871dd63dd7a7fbeba2895f239312cb2a39527c25b8c8c501fcca97ba4de71a33d9a756d
+  data.tar.gz: '09cf7cfb606c0b36c5b2e5552ee33fce244d719a4f3b979159a0fceab157e6bc3b3c77dc4c5e89d202835bdc81476c9ebb71d07b904c79e1586941431a879a22'

data/.github/dependabot.yml

@@ -5,7 +5,7 @@ updates:
     schedule:
       interval: "weekly"
       day: "saturday"
-      time: "04:00"
+      time: "04:05"
       timezone: "Europe/Zurich"
 
   - package-ecosystem: "github-actions"
@@ -13,5 +13,5 @@ updates:
     schedule:
       interval: "weekly"
       day: "saturday"
-      time: "04:00"
+      time: "04:05"
       timezone: "Europe/Zurich"

data/.github/workflows/cd.yml

@@ -10,12 +10,12 @@ jobs:
 
     steps:
     - name: Checkout current code
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
 
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:
-        ruby-version: '3.1'
+        ruby-version: '3.3'
         bundler-cache: true
         cache-version: 1
 

data/.github/workflows/ci.yml

@@ -10,7 +10,7 @@ on:
       - "*"
 
   schedule:
-  - cron: 0 2 * * 1,3,5,6
+  - cron: 0 2 * * 3,6
 
   # Allows you to run this workflow manually from the Actions tab
   workflow_dispatch:
@@ -23,11 +23,11 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: [ '3.2', '3.1', '3.0', '2.7', '2.6']
+        ruby: [ '3.3', '3.2', '3.1', '3.0', '2.7', '2.6']
 
     name: Ruby ${{ matrix.ruby }}
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
 
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1

data/.tool-versions

@@ -1 +1 @@
-ruby 3.2.2
+ruby 3.3.1

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Changelog of EventHub::Processor2
 
+## 1.21.0 / 2024-05-28
+
+* Update dependencies
+* Support Ruby 3.3.1
+* Has http endpoint for health checks
+
+## 1.20.0 / 2023-12-28
+
+* Update dependencies
+* Support Ruby 3.3.0
+* Have a console log only option
+
 ## 1.19.0 / 2023-04-23
 
 * Update dependencies

data/README.md

@@ -11,7 +11,8 @@ Processor2 has currently the following sub-components implemented
 * Heartbeater - send hearbeats to EventHub dispatcher every x minutes
 * Publisher - responsible for message publishing
 * Watchdog - Checks regularly broker connection and defined listener queue(s)
-* Listener - Listens to defined queues, parses recevied message into a EventHub::Message instance and calls handle_message method as defined in derived class.
+* Listener AMQP - Listens to defined AMQP queues, parses recevied message into a EventHub::Message instance and calls handle_message method as defined in derived class.
+* Listener HTTP - Provides an http endpoint for health checks (Exp.  /svc/{class_name}/heartbeat)
 
 Processor2 is using Bunny http://rubybunny.info a feature complete RabbitMQ Client to interact with message broker. Processor2 can deal with long running message processing.
 
@@ -19,6 +20,7 @@ Processor2 is using Bunny http://rubybunny.info a feature complete RabbitMQ Clie
 
 Currently supported and tested ruby versions are:
 
+- 3.3
 - 3.2
 - 3.1
 - 3.0
@@ -30,7 +32,7 @@ Currently supported and tested ruby versions are:
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'eventhub-processor2'
+gem "eventhub-processor2"
 ```
 
 And then execute:
@@ -51,7 +53,7 @@ module EventHub
   class Example < Processor2
 
     def version
-      '1.0.0' # define your version
+      "1.0.0" # define your version
     end
 
     def handle_message(message, args = {})
@@ -72,8 +74,8 @@ module EventHub
 
       # it is possible to publish a message during message processing but it's a
       # good style to return one or multiple messages at end of handle_message
-      publish(message: 'your message as a string') # default exchange_name is 'event_hub.inbound'
-      publish(message: 'your message as string', exchange_name: 'your_specfic_exchange')
+      publish(message: "your message as a string") # default exchange_name is 'event_hub.inbound'
+      publish(message: "your message as string", exchange_name: "your_specfic_exchange")
 
       # at the end return one of
       message_to_return = message.copy # return message if sucessfull processing
@@ -101,7 +103,7 @@ Usage: example [options]
     -e, --environment ENVIRONMENT    Define environment (default development)
     -d, --detached                   Run processor detached as a daemon
     -c, --config CONFIG              Define configuration file
-
+        --console-log-only           Logs to console only (E.g. containers)
 
 bundle exec ruby example.rb
 I, [2018-02-09T15:22:35.649646 #37966]  INFO -- : example (1.1.0): has been started
@@ -131,7 +133,12 @@ If --config option is not provided processor tries to load config/{class_name}.j
       "tls_key": null,
       "tls_ca_certificates": [],
       "verify_peer": false,
-      "show_bunny_logs": false
+      "show_bunny_logs": false,
+      "heartbeat": {
+        "bind_address": "localhost",
+        "port": 8080,
+        "path": "/svc/{class_name}/heartbeat"
+      }
     },
     "processor": {
       "listener_queues": [
@@ -144,6 +151,7 @@ If --config option is not provided processor tries to load config/{class_name}.j
   }
 }
 ```
+Default configuration will dynamically resolve {class_name}. Exp. if your class is called MyClass and is derived from Processor2, value of {class_name} would be "my_class". You can overwrite config settings as needed.
 
 More details about TLS configuration for underlying Bunny gem can be found here: http://rubybunny.info/articles/tls.html.
 
@@ -176,9 +184,9 @@ Processor2 symbolizes keys and sub-keys from configuration files automatically.
 
   # If you need strings instead of symbols you can do
   database = stringify_keys(EventHub::Configuration.database)
-  database['user']              # => "guest"
-  database['password']          # => "secret"
-  database['name']['subname']   # => "value"
+  database["user"]              # => "guest"
+  database["password"]          # => "secret"
+  database["name"]["subname"]   # => "value"
 ```
 
 Version 1.17 and newer allows you to load and merge more configuration files programmatically. It is expected that load! is called once (implicit during class initialization) and then load_more! zero, one, or multiple times. All additional files loaded with load_more! are hash deep merged into one configuration structure. Exceptions while loading of files will be catched and shown as warnings.

data/eventhub-processor2.gemspec

@@ -23,9 +23,11 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "celluloid", "~> 0.18"
+  spec.add_dependency "webrick", "~> 1.8"
   spec.add_dependency "bunny", "~> 2.20"
   spec.add_dependency "eventhub-components", "~> 0.2"
   spec.add_dependency "uuidtools", "~> 2.1"
+  spec.add_dependency "base64", "~> 0.2.0"
 
   spec.add_development_dependency "bundler", "~> 2.3"
   spec.add_development_dependency "rake", "~> 13.0"

data/example/example.rb

@@ -0,0 +1,21 @@
+require_relative "../lib/eventhub/base"
+
+module EventHub
+  class Example < Processor2
+    def version
+      "1.0.0" # define your version
+    end
+
+    def handle_message(message, args = {})
+      # deal with your parsed EventHub message
+      # message.class => EventHub::Message
+      puts message.process_name # or whatever you need to do
+
+      # or if there is no message to return to event_hub.inbound queue
+      nil # [] works as well
+    end
+  end
+end
+
+# start your processor instance
+EventHub::Example.new.start

data/lib/eventhub/{actor_listener.rb → actor_listener_amqp.rb}

@@ -1,7 +1,7 @@
 # EventHub module
 module EventHub
   # Listner Class
-  class ActorListener
+  class ActorListenerAmqp
     include Celluloid
     include Helper
     finalizer :cleanup
@@ -15,14 +15,14 @@ module EventHub
     end
 
     def start
-      EventHub.logger.info("Listener is starting...")
+      EventHub.logger.info("Listener amqp is starting...")
       EventHub::Configuration.processor[:listener_queues].each_with_index do |queue_name, index|
         async.listen(queue_name: queue_name, index: index)
       end
     end
 
     def restart
-      raise "Listener is restarting..."
+      raise "Listener amqp is restarting..."
     end
 
     def listen(args = {})
@@ -109,7 +109,7 @@ module EventHub
     end
 
     def cleanup
-      EventHub.logger.info("Listener is cleaning up...")
+      EventHub.logger.info("Listener amqp is cleaning up...")
       # close all open connections
       return unless @connections
       @connections.values.each do |connection|

data/lib/eventhub/actor_listener_http.rb

@@ -0,0 +1,49 @@
+require "webrick"
+
+# EventHub module
+module EventHub
+  # Listner Class
+  class ActorListenerHttp
+    include Celluloid
+    finalizer :cleanup
+
+    def initialize(args = {})
+      @host = args[:bind_address] || EventHub::Configuration.server.dig(:heartbeat, :bind_address)
+      @port = args[:port] || EventHub::Configuration.server.dig(:heartbeat, :port)
+      @path = args[:path] || EventHub::Configuration.server.dig(:heartbeat, :path)
+      start
+    end
+
+    def start
+      EventHub.logger.info("Listener http is starting [#{@host}, #{@port}], #{@path}...")
+      @async_server = Thread.new do
+        @server = WEBrick::HTTPServer.new(
+          BindAddress: @host,
+          Port: @port,
+          Logger: WEBrick::Log.new("/dev/null"),
+          AccessLog: []
+        )
+        @server.mount_proc @path do |req, res|
+          handle_request(req, res)
+        end
+        @server.start
+      end
+    end
+
+    def handle_request(req, res)
+      case req.request_method
+      when "GET"
+        res.status = 200
+        res.body = "OK"
+      else
+        res.status = 405
+        res.body = "Method Not Allowed"
+      end
+    end
+
+    def cleanup
+      EventHub.logger.info("Listener http is cleaning up...")
+      @async_server&.kill
+    end
+  end
+end

data/lib/eventhub/actor_publisher.rb

@@ -1,6 +1,6 @@
 # EventHub module
 module EventHub
-  # Heartbeat class
+  # Publisher class
   class ActorPublisher
     include Celluloid
     include Helper

data/lib/eventhub/base.rb

@@ -22,7 +22,8 @@ require_relative "consumer"
 require_relative "actor_heartbeat"
 require_relative "actor_watchdog"
 require_relative "actor_publisher"
-require_relative "actor_listener"
+require_relative "actor_listener_amqp"
+require_relative "actor_listener_http"
 require_relative "processor2"
 
 Celluloid.logger = nil

data/lib/eventhub/configuration.rb

@@ -10,6 +10,7 @@ module EventHub
     attr_reader :environment # environment the processor is running
     attr_reader :detached # run processor run as a daemon
     attr_reader :config_file # name of configuration file
+    attr_reader :console_log_only # only log to console
     attr_reader :config_data # data from configuration file
 
     @name = "undefined"
@@ -29,6 +30,7 @@ module EventHub
       @detached = false
       @config_file = File.join(Dir.getwd, "config", "#{@name}.json")
       @config_data = {}
+      @console_log_only = false
     end
 
     # parse options from argument list
@@ -45,6 +47,10 @@ module EventHub
           @detached = true
         end
 
+        opts.on(nil, "--console-log-only", "Only log to console (containers)") do
+          @console_log_only = true
+        end
+
         note = "Define configuration file"
         opts.on("-c", "--config CONFIG", note) do |config|
           @config_file = config
@@ -130,7 +136,12 @@ module EventHub
           tls_key: nil,
           tls_ca_certificates: [],
           verify_peer: false,
-          show_bunny_logs: false
+          show_bunny_logs: false,
+          heartbeat: {
+            bind_address: "localhost",
+            port: 8080,
+            path: "/svc/#{@name}/heartbeat"
+          }
         },
         processor: {
           heartbeat_cycle_in_s: 300,

data/lib/eventhub/logger.rb

@@ -4,10 +4,13 @@ module EventHub
     unless defined?(@logger)
       @logger = ::EventHub::Components::MultiLogger.new
       @logger.add_device(Logger.new($stdout))
-      @logger.add_device(
-        EventHub::Components::Logger.logstash(Configuration.name,
-          Configuration.environment)
-      )
+
+      unless Configuration.console_log_only
+        @logger.add_device(
+          EventHub::Components::Logger.logstash(Configuration.name,
+            Configuration.environment)
+        )
+      end
     end
     @logger
   end

data/lib/eventhub/message.rb

@@ -32,7 +32,7 @@ module EventHub
         self.header.get(header)
       end
 
-      define_method("#{name}=") do |value|
+      define_method(:"#{name}=") do |value|
         self.header.set(header, value)
       end
     end

data/lib/eventhub/processor2.rb

@@ -60,7 +60,7 @@ module EventHub
     # pass message as string like: '{ "header": ... , "body": { .. }}'
     # and optionally exchange_name: 'your exchange name'
     def publish(args = {})
-      Celluloid::Actor[:actor_listener].publish(args)
+      Celluloid::Actor[:actor_listener_amqp].publish(args)
     rescue => error
       EventHub.logger.error("Unexpected exeption while publish: #{error}")
       raise
@@ -87,7 +87,8 @@ module EventHub
     def start_supervisor
       @config = Celluloid::Supervision::Configuration.define([
         {type: ActorHeartbeat, as: :actor_heartbeat, args: [self]},
-        {type: ActorListener, as: :actor_listener, args: [self]}
+        {type: ActorListenerAmqp, as: :actor_listener_amqp, args: [self]},
+        {type: ActorListenerHttp, as: :actor_listener_http, args: []}
       ])
 
       sleeper = @sleeper
@@ -116,8 +117,8 @@ module EventHub
           EventHub.logger.info("Configuration file reloaded")
 
           # restart listener when actor is known
-          if Celluloid::Actor[:actor_listener]
-            Celluloid::Actor[:actor_listener].async.restart
+          if Celluloid::Actor[:actor_listener_amqp]
+            Celluloid::Actor[:actor_listener_amqp].async.restart
           else
             EventHub.logger.info("Was unable to get a valid listener actor to restart... check!!!")
           end

data/lib/eventhub/version.rb

@@ -1,3 +1,3 @@
 module EventHub
-  VERSION = "1.19.0".freeze
+  VERSION = "1.21.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eventhub-processor2
 version: !ruby/object:Gem::Version
-  version: 1.19.0
+  version: 1.21.0
 platform: ruby
 authors:
 - Steiner, Thomas
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-04-23 00:00:00.000000000 Z
+date: 2024-05-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: celluloid
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.18'
+- !ruby/object:Gem::Dependency
+  name: webrick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
 - !ruby/object:Gem::Dependency
   name: bunny
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: base64
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -167,11 +195,13 @@ files:
 - example/config/receiver.json
 - example/config/router.json
 - example/crasher.rb
+- example/example.rb
 - example/publisher.rb
 - example/receiver.rb
 - example/router.rb
 - lib/eventhub/actor_heartbeat.rb
-- lib/eventhub/actor_listener.rb
+- lib/eventhub/actor_listener_amqp.rb
+- lib/eventhub/actor_listener_http.rb
 - lib/eventhub/actor_publisher.rb
 - lib/eventhub/actor_watchdog.rb
 - lib/eventhub/base.rb
@@ -206,7 +236,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
+rubygems_version: 3.5.9
 signing_key: 
 specification_version: 4
 summary: Next generation gem to build ruby based eventhub processor