isimud 1.3.9 → 1.4.1

data/doc/top-level-namespace.html

@@ -81,16 +81,6 @@
 </dl>
 <div class="clear"></div>
 
-<h2>Defined Under Namespace</h2>
-<p class="children">
-  
-    
-      <strong class="modules">Modules:</strong> <span class='object_link'><a href="Isimud.html" title="Isimud (module)">Isimud</a></span>
-    
-  
-    
-  
-</p>
 
 
 
@@ -103,9 +93,9 @@
 </div>
 
     <div id="footer">
-  Generated on Mon Jan 18 17:07:52 2016 by
+  Generated on Wed Aug 24 18:59:45 2016 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.8.7.6 (ruby-2.2.3).
+  0.8.7.6 (ruby-2.3.0).
 </div>
 
   </body>

data/lib/isimud.rb

@@ -3,36 +3,41 @@ require 'active_support/core_ext/module/attribute_accessors'
 
 module Isimud
   include ::ActiveSupport::Configurable
-  # @!attribute [r] client_type
+  # @!attribute [rw] client_type
   #   @return [Enumerable<'bunny', 'test'>] Type of client to use
-  # @!attribute [r] client_options
+  # @!attribute [rw] client_options
   #   @return [Hash] client specific options
-  # @!attribute [r] default_client
+  # @!attribute [rw] default_client
   #   @return [Isimud::Client] default client
-  # @!attribute [r] events_exchange
+  # @!attribute [rw] events_exchange
   #   @return [String] AMQP exchange used for publishing Event instances
-  # @!attribute [r] enable_model_watcher
+  # @!attribute [rw] enable_model_watcher
   #   @return [Boolean] when set, send Isimud::ModelWatcher messages
-  # @!attribute [r] listener_error_limit
-  #   @return [Integer] maximum number of exceptions allowed per hour before listener shuts down (100)
-  # @!attribute [r] logger
+  # @!attribute [rw] listener_error_limit
+  #   @return [Integer] maximum number of uncaught exceptions allowed per hour before listener shuts down (100)
+  # @!attribute [rw] logger
   #   @return [Logger] logger for tracing messages (Rails.logger)
-  # @!attribute [r] log_level
+  # @!attribute [rw] log_level
   #   @return [Symbol] log level (:debug)
-  # @!attribute [r] model_watcher_exchange
+  # @!attribute [rw] model_watcher_exchange
   #   @return [String] AMQP exchange used for publishing ModelWatcher messages
-  # @!attribute [r] model_watcher_schema
+  # @!attribute [rw] model_watcher_schema
   #   @return [String] schema name (Rails.configuration.database_configuration[Rails.env]['database'])
-  # @!attribute [r] prefetch_count
+  # @!attribute [rw] prefetch_count
   #   @return [Integer] number of messages to fetch -- only applies to BunnyClient
-  # @!attribute [r] retry_failures
-  #   @return [Boolean] when set, if an exception occurs during message processing, requeue it
-  # @!attribute [r] server
-  #   @return [<String, Hash>] server connection attributes
+  # @!attribute [rw] retry_failures
+  #   @return [Boolean|nil] whether to requeue a message if an exception occurs during processing.
+  #   When set to nil, the return status from exception handlers is used. (false)
+  #   @see Isimud::Client#on_exception
+  # @!attribute [rw] server
+  #   @return [<String, Hash>] server connection attributes ()
   config_accessor :client_type do
     :bunny
   end
-  config_accessor :client_options, :default_client, :enable_model_watcher, :model_watcher_schema, :retry_failures
+  config_accessor :client_options, :default_client, :enable_model_watcher, :model_watcher_schema
+  config_accessor :retry_failures do
+    false
+  end
   config_accessor :listener_error_limit do
     100
   end

data/lib/isimud/bunny_client.rb

@@ -58,27 +58,28 @@ module Isimud
 
     # Subscribe to messages on the Bunny queue. The provided block will be called each time a message is received.
     #   The message will be acknowledged and deleted from the queue unless an exception is raised from the block.
-    #   In the case that an exception is caught, the message is rejected, and any declared exception handlers will
-    #   be called.
+    #   In the case that an uncaught exception is raised, the message is rejected, and any declared exception handlers
+    #   will be called.
     #
     # @param [Bunny::Queue] queue Bunny queue
-    # @param [Hash] options {manual_ack: true} subscription options -- @see Bunny::Queue#subscribe
+    # @param [Hash] options {} subscription options -- @see Bunny::Queue#subscribe
     # @yieldparam [String] payload message text
-    def subscribe(queue, options = {manual_ack: true}, &block)
-      current_channel = channel
-      queue.subscribe(options) do |delivery_info, properties, payload|
+    def subscribe(queue, options = {}, &block)
+      queue.subscribe(options.merge(manual_ack: true)) do |delivery_info, properties, payload|
+        current_channel = channel
         begin
-          log "Isimud: queue #{queue.name} received #{delivery_info.delivery_tag} routing_key: #{delivery_info.routing_key}"
+          log "Isimud: queue #{queue.name} received #{delivery_info.delivery_tag} routing_key: #{delivery_info.routing_key}", :debug
           Thread.current['isimud_queue_name']    = queue.name
           Thread.current['isimud_delivery_info'] = delivery_info
           Thread.current['isimud_properties']    = properties
           block.call(payload)
-          log "Isimud: queue #{queue.name} finished with #{delivery_info.delivery_tag}, acknowledging"
+          log "Isimud: queue #{queue.name} finished with #{delivery_info.delivery_tag}, acknowledging", :debug
           current_channel.ack(delivery_info.delivery_tag)
         rescue => e
           log("Isimud: queue #{queue.name} error processing #{delivery_info.delivery_tag} payload #{payload.inspect}: #{e.class.name} #{e.message}\n  #{e.backtrace.join("\n  ")}", :warn)
-          current_channel.reject(delivery_info.delivery_tag, Isimud.retry_failures)
-          run_exception_handlers(e)
+          retry_status  = run_exception_handlers(e)
+          log "Isimud: rejecting #{delivery_info.delivery_tag} requeue=#{retry_status}", :warn
+          current_channel.reject(delivery_info.delivery_tag, retry_status)
         end
       end
     end
@@ -142,6 +143,7 @@ module Isimud
     #   e.g. "user.goal.complete"
     # @see http://rubybunny.info/articles/exchanges.html
     def publish(exchange, routing_key, payload)
+      log "Isimud::BunnyClient#publish: exchange=#{exchange} routing_key=#{routing_key}", :debug
       channel.topic(exchange, durable: true).publish(payload, routing_key: routing_key, persistent: true)
     end
 

data/lib/isimud/client.rb

@@ -39,8 +39,17 @@ module Isimud
 
     # Call each of the exception handlers declared by #on_exception.
     # @param [Exception] exception
+    # @return [Boolean] true if message should be requeued, false otherwise
     def run_exception_handlers(exception)
-      exception_handlers.each{|handler| handler.call(exception)}
+      status = true
+      exception_handlers.each do |handler|
+        status &&= begin
+          handler.call(exception)
+        rescue
+          nil
+        end
+      end
+      Isimud.retry_failures.nil? ? status : Isimud.retry_failures
     end
 
     def publish(exchange, routing_key, payload)

data/lib/isimud/event_listener.rb

@@ -84,8 +84,8 @@ module Isimud
       @events_exchange     = options[:events_exchange]
       @models_exchange     = options[:models_exchange]
       @name                = options[:name]
-      @observer_mutex      = Thread::Mutex.new
-      @error_counter_mutex = Thread::Mutex.new
+      @observer_mutex      = Mutex.new
+      @error_counter_mutex = Mutex.new
       @status              = STATUS_INITIALIZE
     end
 
@@ -171,16 +171,16 @@ module Isimud
 
     def start_event_thread
       Thread.new do
-        log 'EventListener: starting event_thread', :info
+        log 'EventListener: starting event_thread'
         until shutdown? do
           begin
             bind_queues
-            log 'EventListener: event_thread bind_queues finished', :info
+            log 'EventListener: event_thread finished'
             @status = STATUS_RUNNING
             Thread.stop
           rescue => e
-            log "EventListener: error in event thread: #{e.message}\n  #{e.backtrace.join("\n  ")}", :warn
             count_error(e)
+            log 'EventListener: resetting queues', :warn
             @observer_queue = nil
             client.reset
           end
@@ -201,7 +201,7 @@ module Isimud
     end
 
     def start_error_counter_thread
-      log 'EventListener: starting error counter', :info
+      log 'EventListener: starting error counter'
       @error_count = 0
       Thread.new do
         while true

data/lib/isimud/test_client.rb

@@ -1,11 +1,11 @@
 module Isimud
 
-  # Interface for a messaging client that is suitable for testing. No network connections are involved.
-  # Note that all message deliveries are handled in a synchronous manner. When a message is published to the
-  # client, each declared queue is examined and, if the message's routing key matches any of the patterns bound to the
-  # queue, the queue's block is called with the message. Any uncaught exceptions raised within a message processing
-  # block will cause any declared exception handlers to be run. However, the message will not be re-placed onto the
-  # queue should this occur.
+  # Interface for a messaging client that is suitable for testing. No network connections are used.
+  # All message deliveries are handled in a synchronous manner. When a message is published to the client, each declared
+  # queue is examined and, if the message's routing key matches any of the patterns bound to the queue, the queue's
+  # block is called with the message. Any uncaught exceptions raised within a message processing
+  # block will cause any declared exception handlers to be run. However, the message will not be re-queued should this
+  # occur.
   class TestClient < Isimud::Client
     attr_accessor :queues
 
@@ -14,11 +14,11 @@ module Isimud
       attr_reader :name, :bindings, :client
       attr_accessor :proc
 
-      def initialize(client, name, proc = Proc.new{ |_| } )
-        @client = client
-        @name         = name
-        @bindings     = Hash.new{ |hash, key| hash[key] = Set.new }
-        @proc         = proc
+      def initialize(client, name, proc = Proc.new { |_|})
+        @client   = client
+        @name     = name
+        @bindings = Hash.new { |hash, key| hash[key] = Set.new }
+        @proc     = proc
       end
 
       def bind(exchange, opts = {})
@@ -44,7 +44,7 @@ module Isimud
       end
 
       def make_regexp(key)
-        Regexp.new(key.gsub(/\./, "\\.").gsub(/\*/, '.*'))
+        Regexp.new(key.gsub(/\./, "\\.").gsub(/\*/, '[^.]*').gsub(/#/, '.*'))
       end
 
       def has_matching_key?(exchange, route)

data/lib/isimud/version.rb

@@ -1,3 +1,3 @@
 module Isimud
-  VERSION = '1.3.9'
+  VERSION = '1.4.1'
 end

data/release

@@ -27,4 +27,4 @@ puts 'Publishing to RubyGems'.cyan
 run! "gem push #{built_gem_path}"
 
 puts 'Testing install'.cyan
-run! "gem install #{gem_name} -v #{Isimud::VERSION} -P MediumSecurity"
+run! "gem install #{gem_version} -P MediumSecurity"

data/spec/isimud/bunny_client_spec.rb

@@ -1,17 +1,14 @@
 require 'spec_helper'
 
 describe Isimud::BunnyClient do
-  before(:each) do
-    @exchange_name = 'isimud_test'
-    @url = 'amqp://guest:guest@localhost'
-  end
-
-  let!(:client) { Isimud::BunnyClient.new(@url) }
+  let!(:exchange_name) { 'isimud_test' }
+  let!(:url) { 'amqp://guest:guest@localhost' }
+  let!(:client) { Isimud::BunnyClient.new(url) }
   let!(:connection) { client.connection }
 
   describe '#initialize' do
     it 'sets the broker URL' do
-      expect(client.url).to eq(@url)
+      expect(client.url).to eq(url)
     end
   end
 
@@ -20,48 +17,52 @@ describe Isimud::BunnyClient do
     let(:proc) { Proc.new { puts('hello') } }
     let(:keys) { %w(foo.bar baz.*) }
     let(:queue_name) { 'my_queue' }
+
     before do
-      Isimud.logger = Logger.new(STDOUT)
+      client.connect
+      @block_called = Array.new
     end
+
     after do
       client.delete_queue(queue_name)
+      client.close
     end
 
-
     it 'creates a new queue' do
-      consumer = client.bind('my_queue', @exchange_name, keys, &proc)
+      consumer = client.bind(queue_name, exchange_name, keys, &proc)
       expect(consumer).to be_a Bunny::Consumer
-      expect(consumer.queue_name).to eq('my_queue')
+      expect(consumer.queue_name).to eq(queue_name)
     end
 
     context 'when a block is passed to the call' do
       it 'binds specified routing keys and subscribes to the specified exchange' do
-        queue = double('queue', name: 'my_queue', bind: 'ok')
-        expect(client).to receive(:find_queue).with('my_queue', durable: true).and_return(queue)
+        queue = double('queue', name: queue_name, bind: 'ok')
+        expect(client).to receive(:find_queue).with(queue_name, durable: true).and_return(queue)
         expect(queue).to receive(:subscribe).with({manual_ack: true})
-        keys.each { |key| expect(queue).to receive(:bind).with(@exchange_name, routing_key: key, nowait: false).once }
-        client.bind('my_queue', @exchange_name, *keys, &proc)
+        keys.each { |key| expect(queue).to receive(:bind).with(exchange_name, routing_key: key, nowait: false).once }
+        client.bind(queue_name, exchange_name, *keys, &proc)
       end
     end
 
     context 'when a block is NOT passed' do
-      it 'binds specified routing keys BUT does not subscribes to the specified exchange' do
-        queue = double('queue', name: 'my_queue', bind: 'ok')
-        expect(client).to receive(:find_queue).with('my_queue', durable: true).and_return(queue)
+      it 'binds specified routing keys BUT does not subscribe to the specified exchange' do
+        queue = double('queue', name: queue_name, bind: 'ok')
+        expect(client).to receive(:find_queue).with(queue_name, durable: true).and_return(queue)
         expect(queue).not_to receive(:subscribe).with(manual_ack: true)
-        keys.each { |key| expect(queue).to receive(:bind).with(@exchange_name, routing_key: key, nowait: false).once }
-        client.bind('my_queue', @exchange_name, *keys)
+        keys.each { |key| expect(queue).to receive(:bind).with(exchange_name, routing_key: key, nowait: false).once }
+        client.bind(queue_name, exchange_name, *keys)
       end
     end
 
     it 'calls block when a message is received' do
-      @block_called = Array.new
-      queue_name    = 'test_queue'
-      client.bind("#{queue_name}", @exchange_name, 'my.test.key') do |payload|
+      client.create_queue(queue_name, exchange_name)
+      client.channel.wait_for_confirms
+      client.bind(queue_name, exchange_name, 'my.test.key') do |payload|
         @block_called << payload
       end
-      client.publish(@exchange_name, 'my.test.key', "Hi there")
-      sleep(1)
+      client.channel.wait_for_confirms
+      client.publish(exchange_name, 'my.test.key', "Hi there")
+      client.channel.wait_for_confirms
       expect(@block_called).to eq ['Hi there']
     end
   end
@@ -134,9 +135,9 @@ describe Isimud::BunnyClient do
     it 'sends the data with the appropriate routing key to the exchange' do
       payload = {a: '123', b: 'this is b'}
       topic   = double(:topic)
-      expect(channel).to receive(:topic).with(@exchange_name, durable: true).and_return(topic)
+      expect(channel).to receive(:topic).with(exchange_name, durable: true).and_return(topic)
       expect(topic).to receive(:publish).with(payload, routing_key: 'foo.bar.baz', persistent: true)
-      client.publish(@exchange_name, 'foo.bar.baz', payload)
+      client.publish(exchange_name, 'foo.bar.baz', payload)
     end
   end
 

data/spec/isimud/client_spec.rb

@@ -4,13 +4,15 @@ describe Isimud::Client do
   let(:client) { Isimud::Client.new }
 
   before do
-    @exceptions_1 = Array.new
-    @exceptions_2 = Array.new
+    @exceptions_1    = Array.new
+    @exceptions_2    = Array.new
+    @return_status_1 = true
+    @return_status_2 = false
   end
 
   describe 'exception handling' do
-    let!(:exception_handler_1) { Proc.new { |e| @exceptions_1 << e } }
-    let!(:exception_handler_2) { Proc.new { |e| @exceptions_2 << e } }
+    let(:exception_handler_1) { Proc.new { |e| @exceptions_1 << e; @return_status_1 } }
+    let(:exception_handler_2) { Proc.new { |e| @exceptions_2 << e; @return_status_2 } }
     let!(:exception) { double(:exception) }
 
     context 'with one handler added' do
@@ -28,13 +30,56 @@ describe Isimud::Client do
       before do
         client.on_exception(&exception_handler_1)
         client.on_exception(&exception_handler_2)
-        client.run_exception_handlers(exception)
       end
 
       it 'calls both exception handlers' do
+        client.run_exception_handlers(exception)
         expect(@exceptions_1).to include(exception)
         expect(@exceptions_2).to include(exception)
       end
+
+
+      context 'with Isimud.retry_failures set to false' do
+        before do
+          Isimud.retry_failures = false
+        end
+
+        it 'does not requeue message' do
+          expect(client.run_exception_handlers(exception)).to be_falsey
+        end
+      end
+
+      context 'with Isimud.retry_failures set to true regardless of handler return status' do
+        before do
+          Isimud.retry_failures = true
+        end
+
+        it 'requeues message' do
+          expect(client.run_exception_handlers(exception)).to be_truthy
+        end
+      end
+
+      context 'with Isimud.retry_failures nil' do
+        before do
+          Isimud.retry_failures = nil
+        end
+
+        context 'and all exception handlers return truthy status' do
+          before do
+            @return_status_2 = true
+          end
+
+          it 'requeues message' do
+            expect(client.run_exception_handlers(exception)).to be_truthy
+          end
+        end
+
+        context 'and any exception handler returns falsey status' do
+          it 'does not requeue message if any handler returns false' do
+            expect(client.run_exception_handlers(exception)).to be_falsey
+          end
+        end
+      end
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: isimud
 version: !ruby/object:Gem::Version
-  version: 1.3.9
+  version: 1.4.1
 platform: ruby
 authors:
 - George Feil
@@ -31,7 +31,7 @@ cert_chain:
   wSKk31gq6KY7rgi11mcLvVzwSuwZFqnonAmu/uin3cbXcOUkqNsyzZ0LQLXNKiwi
   k0RgrsSNtQ8hcsVSQla0Ot+X3WpFI4ZuIfSLFA==
   -----END CERTIFICATE-----
-date: 2016-09-14 00:00:00.000000000 Z
+date: 2016-08-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -114,6 +114,7 @@ files:
 - Rakefile
 - certs/gfeil.pem
 - checksum/isimud-1.3.8.gem.sha512
+- checksum/isimud-1.4.0.gem.sha512
 - config.ru
 - config/tddium.yml
 - doc/Isimud.html
@@ -124,8 +125,6 @@ files:
 - doc/Isimud/EventObserver.html
 - doc/Isimud/EventObserver/ClassMethods.html
 - doc/Isimud/Generators.html
-- doc/Isimud/Generators/ConfigGenerator.html
-- doc/Isimud/Generators/InitializerGenerator.html
 - doc/Isimud/Logging.html
 - doc/Isimud/ModelWatcher.html
 - doc/Isimud/ModelWatcher/ClassMethods.html