isimud 1.3.9 → 1.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fbd377e53c6aa832554fbcaa4770094f17b35a98
-  data.tar.gz: 1d691b4c2711105f558af95cc19115aadff8a621
+  metadata.gz: 4e44d23a18cf13265519e1f9141b7548ef1a3974
+  data.tar.gz: 11817dccd7145d8b56596836cbb214d2801cf549
 SHA512:
-  metadata.gz: b8b812abc5bbf09afea8d6c79dee53521aca81a97e1df007f18eaeb2d5189d7bc64978d6e9ebc97dc66639b1cd081c95cf2044364a056151f014e95c95ffc3f4
-  data.tar.gz: 4c4a173be7017d1458f6d491d6e9bdb040d22a4e80ceeaa0ce347451165865aaf03609aae45db0fb9ca0af1689fe4bde5170cb17ae1f4ee3c37f966023f4d160
+  metadata.gz: 718764a123733b2e68180f965a33aa49e5d9d5e6ac7debb7c7914b3ef406ba75aa62a9acf3c7bb54840249992a291add6c2252b755b7e2f82c8d33d26ef69a22
+  data.tar.gz: c78ec602bf966b51015cb611d647ff793afa2a2ff162e11dcd0fcb4f660b6c3f63dc127f724c8948dc346f6052dac7ad6a7543feba07c7ffa349b8335b4762d3

data/.yardoc/checksums

@@ -1,15 +0,0 @@
-lib/isimud.rb 5a9fee170ff924c6347d98fb5a80980d5f0ecc9a
-lib/isimud/event.rb f29a804bfa084e68329825b5fb9863d268f3ff27
-lib/isimud/tasks.rb 8d07d80e178928098e959ebdcbda1707e9b50617
-lib/isimud/client.rb 88ffac5ff4cc3306d0f1c9f9a1ca9d5c344e81cf
-lib/isimud/version.rb 3c726b1fa933bfa72e64a8c111f741f10a0a8220
-lib/isimud/logging.rb 2f506f049011441628a3d573d8e2a670156b4a3a
-lib/isimud/railtie.rb e644c4d74ae8298f11dd0c2fcae1d72259e24ea3
-lib/isimud/test_client.rb e70e3b96b7cec013f8edcb4005ea72ea8acc48c7
-lib/isimud/bunny_client.rb 7009922019087e2c9920073cb79c93aba8446dc4
-lib/isimud/model_watcher.rb f6694603386e538f755ff7217f975f04c9529c26
-lib/isimud/event_observer.rb 64c3af1d81df6a97cf9700eb71dc4d241f5b0044
-lib/isimud/event_listener.rb e7fea6bb36d76bc50c28c32869653d0558a3e7f7
-lib/rails/generators/isimud/config_generator.rb d1c964f26c6e0f0289343bac17d3a9b1f99d7a98
-lib/rails/generators/isimud/initializer_generator.rb c7b188459d17d35ccbfa820a434dd6a97a58aeeb
-lib/rails/generators/isimud/templates/initializer.rb 6b937955296d704bfa4a06eec91ce14a6dd954ba

data/Gemfile

@@ -11,11 +11,11 @@ gem 'yard'
 
 group :development, :test do
   gem 'awesome_print'
-  gem 'rspec'
+  gem 'rspec-rails'
   gem 'combustion'
   gem 'database_cleaner'
   gem 'sqlite3'
-  gem 'codeclimate-test-reporter', require: false
+  gem 'codeclimate-test-reporter', require: nil
 end
 
 group :test do

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    isimud (1.3.9)
+    isimud (1.4.0)
       activerecord (>= 4.1.4)
       activesupport (>= 4.1.4)
       bunny (>= 1.6.0)
@@ -64,19 +64,23 @@ GEM
       rake (>= 0.8.7)
       thor (>= 0.18.1, < 2.0)
     rake (10.4.2)
-    rspec (3.3.0)
-      rspec-core (~> 3.3.0)
-      rspec-expectations (~> 3.3.0)
-      rspec-mocks (~> 3.3.0)
-    rspec-core (3.3.2)
-      rspec-support (~> 3.3.0)
-    rspec-expectations (3.3.1)
+    rspec-core (3.5.1)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.3.0)
-    rspec-mocks (3.3.2)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.3.0)
-    rspec-support (3.3.0)
+      rspec-support (~> 3.5.0)
+    rspec-rails (3.5.1)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
     simplecov (0.10.0)
       docile (~> 1.1.0)
       json (~> 1.8)
@@ -105,7 +109,7 @@ DEPENDENCIES
   database_cleaner
   isimud!
   rake
-  rspec
+  rspec-rails
   sqlite3
   test_after_commit
   timecop

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2016 Keas Inc.
+Copyright (c) 2016 Welltok Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -15,7 +15,7 @@ Isimud is an AMQP message publishing and consumption gem intended for Rails appl
 * An Event Listener daemon process which manages queues and dispatches messages for Event Observers.
 * A test client for mocking message publication, allowing synchronous delivery and processing of messages in unit tests.
 
-## Installation
+# Installation
 
 Add this line to your application's Gemfile:
 
@@ -36,17 +36,17 @@ For Rails applications, use the following generators to create config and initia
     
 Customize the AMQP broker settings in the config/isimud.yml
 
-## Usage
+# Usage
 
-### Connecting to an AMQP server
+## Connecting to an AMQP Server
 
 There are two supported conventions for specifying a RabbitMQ server (broker) in the configuration file:
 
-#### Using a URL
+### Using a URL
 
     server: amqp:port//user_name:password@host/vhost
 
-#### Using separate parameters:
+### Using Separate Parameters:
 
     server:
         host:  hostname
@@ -67,57 +67,98 @@ in order to prevent loss of messages due to failures.
 
 Isimud uses [Bunny](http://rubybunny.info) to connect to RabbitMQ.
 
-### Message publication
+## Message Publication
 
-Isimud uses topic based exchanges publish messages. This allows for multiple listener
-workers to operate in parallel to process messages.
+Isimud publish messages to topic based exchanges. Each message is tagged with a routing key, allowing for multiple 
+audiences to selectively receive messages. 
 
-### Message binding and consumption
+## Message Queues, Bindings, and Consumption
 
-Isimud uses non-exclusive, durable queues to listen for and consume messages. Named queues are automatically created
-if they do not exist.
+Isimud uses named, non-exclusive, durable queues to consume messages, with a configurable pre-fetch amount. 
 
-## Changes
+There are two ways that message queues may be declared:
 
-### 1.3.9
+1. Using EventObserver instances. The EventObserver module allows an implementing class to define queues and bindings 
+for each instance. 
+  * The EventListener automatically establishes and manages queues for instances of each implementing class.
+  * Each EventListener process maintains its own exclusive queue to automatically add or cancel consumers for
+  EventObserver instances as they added, modified, or deleted.
+2. Custom standalone queues. You may extend EventListener to declare individual queues not associated with a specific
+object instance.
 
-* EventListener changes:
-  * start_event_thread, dump exception backtrace to log
-  * set log level to info or higher for all event thread messages
+The EventListener process will automatically create queues on initial startup if they do not already exist. This allows
+for cold startup on a new AMQP broker.
 
-### 1.3.8
+### Message Delivery Information and Metadata
+
+Each time that a message is retrieved from the queue, the following properties are set in the current thread:
+
+ | name | contents |
+ | ---- | -------- |
+ | isimud_queue_name | Name of the queue processing the thread |
+ | isimud_delivery_info | Message delivery information (*Bunny::DeliveryInfo*) |
+ | isimud_properties | Message properties metadata (*Bunny::MessageProperties*) |
+ 
+### Exception Handling
+
+If an uncaught instance of StandardError is raised during message processing, all exception handlers added to the
+client are run in the order they were declared (see Client#on_exception). Any exceptions raised by the exception
+handlers themselves are silently ignored.
+
+You can configure the disposition of the message that triggered the exception using the configuration attribute 
+Isimud.retry_failures as follows:
+
+| Isimud.retry_failures | Behavior |
+| :-------------------: | -------- |
+| *false* | Never requeue messages (default) |
+| *true* | Always requeue messages |
+| *nil* | Conditionally re-queue messages based on exception handler return values |
+
+When conditional re-queueing is enabled, requeue is determined based on the return value of all exception handlers, 
+logically AND-ed. If the result is truthy, the message is re-queued. If the return value of any handler is falsey,
+the message is not re-queued.
+
+# Changes
+
+## 1.4.1
+
+* Enable conditional re-queuing of messages after an exception is raised (see *Exception Handling* above).
+* Log messages for receipt and ack of messages downgraded to debug level.
+* Force manual_ack mode for all queue subscriptions. 
+
+## 1.3.8
 
 * In EventListener event thread, rescue all exceptions, not just Bunny ones.
 
-### 1.3.7
+## 1.3.7
 
 * Change instance var 'status' inside the start event thread
 
-### 1.3.6
+## 1.3.6
 
 * Don't include ModelWatcher attributes in event publish log message
 * Include routing key in ModelWatcher event publish log message
 
-### 1.3.5
+## 1.3.5
 
 * Added option to EventObserver#observe_events to recreate bindings for observer queues
 * EventListener only create bindings and queues for EventObserver instances on initial startup
  
-### 1.3.4
+## 1.3.4
 
 * Always recreate bindings for observer queues when EventListener starts the event thread.
 * Cleaned up method signature on EventObserver#delete_queue so that a client may be passed to it. 
 
-### 1.3.3
+## 1.3.3
 
 * Fixed handling of exceptions in TestClient
 * Make EventListener#has_observer? public
 
-### 1.3.1
+## 1.3.1
 
 * Add EventObserver#deactivate_observer to trigger queue deletion for an observer instance.
 
-### 1.3.0
+## 1.3.0
 
 * Added a new method, EventListener#bind_event_queues() for registering custom event handlers. Override
   this method instead of bind_queues() to bind custom queues not handled by EventObserver instances.
@@ -125,27 +166,27 @@ if they do not exist.
   hosts sharing the same PID.
 * Added lots of documentation.
 
-### 1.2.1
+## 1.2.1
 
 * Include attributes in ModelWatcher destroy message
 
-### 1.2.0
+## 1.2.0
 
 * EventObserver#update_queue now always binds current routing keys. This ensures that when an enable_listener? changes
   state from false to true during an update, all bindings for the queue are established.
 * Add EventObserver#activate_observer(), which creates and binds a queue for an observer instance on demand.
 * Add declaration for Client#find_queue, and normalize the method signature for subclasses.
 
-### 1.1.0
+## 1.1.0
 
 * Clients now support multiple exception handlers. Each call to Client#on_exception will add a new block to the
   exception handlers list
 
-### 1.0.2
+## 1.0.2
 
-#### Breaking Changes:
+### Breaking Changes:
 
-* EventObserver instances are now required to have the persistent attribute /exchange_routing_keys/. These are used to
+* EventObserver instances are now required to have the persistent attribute *exchange_routing_keys*. These are used to
   store the current value of routing keys assoicated with an instance. The queue associated with an EventObserver is
   now created and updated at the same time the EventObserver is updated, rather than relying on the EventListener to
   create it.
@@ -156,7 +197,7 @@ if they do not exist.
 * Client#create_queue no longer accepts a block parameter and does not subscribe to messages.
 * Removed Client#rebind.
 
-#### Other Changes:
+### Other Changes:
 
 * TestClient::Queue now responds to bind() and unbind() in the same manner as Bunny::Queue.
 * BunnyClient#create_queue now may be called without a block to instantiate an AMQP queue without subscribing to messages
@@ -164,16 +205,16 @@ if they do not exist.
 * Changed BunnyClient#delete_queue to make it more reliable.
 * EventListener now uses a shared, durable queue for monitoring events on modified EventObserver instances.
 
-### 0.5.2
+## 0.5.2
 
 * Fixed regexp bug in TestClient affecting message delivery
 * Add more logging for EventObserver binding
 
-### 0.5.1
+## 0.5.1
 
 * Added Event#attributes
 
-### 0.5.0
+## 0.5.0
 
 * Allow EventObserver classes to override the exchange for listening to events
 * Corrected initialization of EventListener for handling defaults
@@ -181,23 +222,23 @@ if they do not exist.
 * Fixed a bug in EventObserver that caused ModelWatcher to not send update events appropriately when default columns are watched
 * Moved requires for Isimud below config attribute declarations
 
-### 0.4.10
+## 0.4.10
 
 * Corrected trap of INT and TERM signals
 * Added error counter mutex and cleaned up logging
 * Corrected race condition for registering EventObserver classes
 
-### 0.4.5
+## 0.4.5
 
 * Fixed issues with exception handling
 
-### 0.4.1
+## 0.4.1
 
 * Event now accepts an exchange option for publishing
 * Added Isimud.events_exchange
 * Cleaned up initializer template
 
-### 0.4.0
+## 0.4.0
 
 * Event logging of published message now set to debug level
 * Added EventListener and EventObserver
@@ -206,96 +247,91 @@ if they do not exist.
 * Clients can now be configured with an exception handler. This is used by EventListener to intercept exceptions raised
   during message handling by an observer.
 
-### 0.3.7
+## 0.3.7
 
 * Added EventObserver mix-in
 * Added accessors for queues and routing_keys to TestClient
 
-### 0.3.6
+## 0.3.6
 
 * Reraise all exceptions in message processing block in BunnyClient#bind.
 
-### 0.3.5
+## 0.3.5
 
 * Fixed deprecation on setting manual ack on Bunny queue subscriptions.
 
-### 0.3.4
+## 0.3.4
 
 * Catch Timeout::Error in ModelWatcher.synchronize
 
-### 0.3.1
+## 0.3.1
 
 * Tuning gargabe collector on ModelWatcher.synchronize
 
-### 0.3.0
+## 0.3.0
 
 * Added rake task for manual synchronization using ModelWatcher
 
-### 0.2.17
+## 0.2.17
 
 * Added guard on null #updated_at instances
 * Added ModelWatcher#isimud_sync for manual synchronization
 
-### 0.2.15
+## 0.2.15
 
 * Changed Event#send to Event#publish, to avoid overloading Ruby.
 
-### 0.2.13
+## 0.2.13
 
 * Add :omit_parameters option to Event#as_json
 
-### 0.2.12
+## 0.2.12
 
 * Demodulize ActiveRecord model name when setting ModelWatcher event type
 
-### 0.2.10
+## 0.2.10
 
 * Added Isimud.retry_failures
 * Isimud::ModelWatcher now includes :created_at and :updated_at columns by default
 * Added Isimud::Client.connected?
 * Avoid connecting to database when Isimud::ModelWatcher.watch_attributes is called
 
-### 0.2.4
+## 0.2.4
 
 * Add Isimud::ModelWatcher#isimud_synchronize? to allow conditional synchronization. Override to activate.
 
-### 0.2.2
+## 0.2.2
 
 * Add enable_model_watcher configuration parameter (default is true)
 
-### 0.2.0
+## 0.2.0
 
 * Added Isimud::Event
 * Extracted Isimud::Client#log into Isimud::Logging module
 
-### 0.1.4
+## 0.1.4
 
 * Don't reject messages when exception is raised in bind block
 
-### 0.1.3
+## 0.1.3
 
 * Upgrade bunny gem requirement to 1.3.x
 * Fixed message acknowledgements
 * Added log_level configuration parameter (default is :debug)
 
-### 0.1.2
+## 0.1.2
 
 * Reject message with requeue when an exception is raised during processing
 
-### 0.1.1
+## 0.1.1
 
 * Enable channel confirmations for message publication
 
-### 0.1.0
+## 0.1.0
 
 * ModelWatcher mix-in for ActiveRecord, sends events on instance changes
 * Initializer generator for Rails
 
-### 0.0.8 (first working version)
-
-* Don't clear the queues when reconnecting TestClient
-
-
 ## Contributing
 
 1. Fork it ( https://github.com/KeasInc/isimud/fork )