eventhub-processor2 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 560975d638bb453888cd1c153ef65b8fd186b216
-  data.tar.gz: 3e72d08346c2b3668c17ad4218c0a0e05dc76580
+  metadata.gz: b9919c5a02188e630c89bb5faafd474776be3080
+  data.tar.gz: fe6131479d6c831ce7719fbf700fdd2de2ea6b74
 SHA512:
-  metadata.gz: 3f5b88b6a0143ee9d89830a8b02f91d5d76b3c95355ab1f6b8fef4cb1f3ae73bab64f199922208ec24868a4e1d40552f0dd67508e4d75287a9cf993b04e949dc
-  data.tar.gz: 393727e798721fea7a9a8c6fd3fb605f98efd64abdb956de2578558597f68f557ff6a4bd6b085277eb1373ab5b071c547860ce86889ffc30b4cfa462f52cdcb0
+  metadata.gz: 37abfe5a7fe17cc8dd59be24ed4ed77d196443a25cc830dcb93ab00719ffe621c37963105c4dd42bafb48029614852ae0e3f80ab5832860dd2f6e2d89f794e15
+  data.tar.gz: '085633ac5ea1b55d06b2b77b6660add117b9ab87933802e285d3b4a34188b8df6297c8fb20fd79f2c8936630a59ed08e710535264a92c4429c9e33bb75619893'

data/CHANGELOG.md

@@ -0,0 +1,15 @@
+# Changelog of EventHub::Processor2
+
+## 1.3.0 / 2018-02-13
+
+* Have EventHub::BaseException for easier migration
+* Have EventHub::Configuration.instance.data for easier migration
+* Some minor documentation updates
+
+## 1.2.0 / 2018-02-09
+
+* With documentation added
+
+## 1.0.0 / 2017-12-08
+
+* Initial release

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    eventhub-processor2 (1.2.0)
+    eventhub-processor2 (1.3.0)
       bunny (~> 2.9)
       celluloid (~> 0.17)
       eventhub-components (~> 0.2)

data/README.md

@@ -13,6 +13,8 @@ Processor2 has currently the following sub-components implemented
 * 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.
 
+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.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -58,11 +60,19 @@ module EventHub
       # the processor2 gem and returned
       # to the event_hub.inbound queue
 
+      # 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')
+
       # at the end return one of
-      message # return message if sucessfull processing
+      message_to_return = message.copy # return message if sucessfull processing
+                                       # message.copy sets status.code automatically
+                                       # to EventHub::STATUS_SUCCESS which signals
+                                       # dispatcher successful processing
 
       # or if you have multiple messages to return to event_hub.inbound queue
-      [ message, new_message1, new_message2]
+      [ message_to_return, new_message1, new_message2]
 
       # or if there is no message to return to event_hub.inbound queue
       nil # [] works as well
@@ -125,6 +135,8 @@ If --config option is not provided processor tries to load config/{class_name}.j
 }
 ```
 
+More details about TLS configuration for underlying Bunny gem can be found here: http://rubybunny.info/articles/tls.html.
+
 Feel free to define additional hash key/values (outside of server and processor key) as required by your application.
 
 ```json
@@ -145,11 +157,18 @@ Feel free to define additional hash key/values (outside of server and processor
 }
 ```
 
+Processor2 symbolizes keys and sub-keys from configuration files automatically.
 ```ruby
   # access configuration values in your application as follows
-  Configuration.processor.database[:user]           # => "guest"
-  Configuration.processor.database[:password]       # => "secret"
-  Configuration.processor.database[:name][:subname] # => "value"
+  EventHub::Configuration.database[:user]             # => "guest"
+  EventHub::Configuration.database[:password]         # => "secret"
+  EventHub::Configuration.database[:name][:subname]   # => "value"
+
+  # 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"
 ```
 
 ## Development

data/example/README.md

@@ -3,13 +3,17 @@
 ### Description
 
 Example folder contains a series of applications in order to test reliability and performance of processor2 gem.
+* publisher.rb - Creates a unique file and a message
+* router.rb - routes messges via queues
+* receiver.rb - receives message and does final processing
+* crasher.rb - restarts message broker or sends signals to other processes
 
 ### How does it work?
 
 A message is passed throuhg the following components.
 publisher.rb => [example.outbound] => router.rb => [example.inbound] => receiver.rb
 
-1. publisher.rb generates a unique ID, creates a message with the ID as payload, passes the message to example.outbound queue.
+1. publisher.rb generates a unique ID, creates a json message with the ID as payload, save the message in a file, and passes the message to example.outbound queue.
 
 2. router.rb receives the message and passes it to exmaple.outbound queue
 
@@ -18,7 +22,7 @@ publisher.rb => [example.outbound] => router.rb => [example.inbound] => receiver
 ### Goal
 What ever happens to these components (restarted, killed and restarted, stopped and started, message broker killed, stopped and started) if you do a graceful shutdown at the end there should be no message in the /data folder (except store.json).
 
-Graceful shutdown with CTRL-C or TERM signal to pdi
+Graceful shutdown with CTRL-C or TERM signal to pid
 * Stop producer.rb. Leave the other components running until all messages in example.* queues are gone.
 * Stop remaining components
 * Check ./example/data folder

data/lib/eventhub/base.rb

@@ -1,6 +1,7 @@
 require 'uuidtools'
 require 'json'
 require 'base64'
+require 'optparse'
 
 require 'eventhub/components'
 require 'logstash-logger'
@@ -16,6 +17,7 @@ end
 
 require_relative 'version'
 require_relative 'constant'
+require_relative 'base_exception'
 require_relative 'logger'
 require_relative 'helper'
 require_relative 'sleeper'

data/lib/eventhub/base_exception.rb

@@ -0,0 +1,12 @@
+# EventHub module
+module EventHub
+  # BaseException class
+  class BaseException < RuntimeError
+    attr_accessor :code, :message
+    def initialize(message=nil, code=EventHub::STATUS_DEADLETTER)
+      @message = message
+      @code    = code
+      super(@message)
+    end
+  end
+end

data/lib/eventhub/configuration.rb

@@ -4,6 +4,7 @@ module EventHub
   module Configuration
     # it's a singleton (don't allow to instantiate this class)
     extend self
+    extend Helper
 
     attr_reader :name           # name of processor
     attr_reader :environment    # environment the processor is running
@@ -116,5 +117,17 @@ module EventHub
         }
       }
     end
+
+    def instance
+      warn "[DEPRECATION] `instance` is deprecated. Please use new"\
+           " configuration access method."
+      self
+    end
+
+    def data
+      warn "[DEPRECATION] `data` is deprecated. Please use new configuration"\
+           " access method."
+      stringify_keys(@config_data)
+    end
   end
 end

data/lib/eventhub/helper.rb

@@ -1,5 +1,3 @@
-require 'optparse'
-
 # EventHub module
 module EventHub
   # Helper module
@@ -56,5 +54,10 @@ module EventHub
       now ||= Time.now
       now.utc.strftime("%Y-%m-%dT%H:%M:%S.%6NZ")
     end
+
+    # stringify hash keys
+    def stringify_keys(h)
+      JSON.parse(h.to_json)
+    end
   end
 end

data/lib/eventhub/version.rb

@@ -1,3 +1,3 @@
 module EventHub
-  VERSION = '1.2.0'.freeze
+  VERSION = '1.3.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eventhub-processor2
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Steiner, Thomas
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-02-09 00:00:00.000000000 Z
+date: 2018-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: celluloid
@@ -132,6 +132,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -156,6 +157,7 @@ files:
 - lib/eventhub/actor_publisher.rb
 - lib/eventhub/actor_watchdog.rb
 - lib/eventhub/base.rb
+- lib/eventhub/base_exception.rb
 - lib/eventhub/configuration.rb
 - lib/eventhub/constant.rb
 - lib/eventhub/consumer.rb
@@ -187,7 +189,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: Next generation gem to build ruby based eventhub processor