dispatch-rider 0.0.7 → 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7bbb3c1f98b4bafe69fae92ea7508cd67345275a
+  data.tar.gz: b849394b852851fa7d29f25338ef17a1870ad8b3
+SHA512:
+  metadata.gz: dc1538bee183a3e7f03e0e06e141704e1abb7cdc7e765d9e69918ada0bd90fcc836a29f6440822a83c16fe7d7469bbe95735ffeb753995974beed6485698e34f
+  data.tar.gz: bcbe7f23996a3dcf324b64598db790b02886c83b1afa37c0085711cd688a0aad63096849c0fbf35753f6fba7ba231014590390b1168389754af8d08e3b1d2e96

data/README.md

@@ -166,6 +166,31 @@ News.create!(:headlines => [
 
 ### Subscriber
 
+### Configuration
+
+You can configure the subscription side of DispatchRider by using the built in configuration object.
+
+```ruby
+DispatchRider.config do |config|
+  config.before(:initialize) do
+    # code to run before initialize
+  end
+
+  config.after(:process) do
+    # code to run after process
+  end
+
+  config.error_handler = DefaultErrorHandler # an object that responds to .call(message, exception)
+
+  config.queue_kind = :sqs
+  config.queue_info = { name: "queue-production" }
+
+  config.handler_path = Rails.root + "app/handlers" # path to handler files to be autoloaded
+end
+```
+
+### Manual Setup
+
 To setup a subscriber you'll need message handlers. The handlers are named the same as the message subjects.
 
 Sample message handler:
@@ -197,23 +222,39 @@ subscriber.process
 Sample subscriber dispatch error handling (optional):
 
 ```ruby
-# using blocks
+# using objects
 
-subscriber.on_dispatch_error do |message, exception|
-  # put your error handling code here
+module ErrorHandler
+
+  def self.call(message, exception)
+    # put your error handling code here
+
+    return false # or return true to permanently remove the message
+  end
 
-  return false # or return true to permanently remove the message
 end
 
-# using methods
+subscriber.setup_demultiplexer(kind, ErrorHandler)
 
-def handle_dispatch_error(message, exception)
+# using lambdas
+
+error_handler = ->(message, exception) do
   # put your error handling code here
 
   return false # or return true to permanently remove the message
 end
 
-subscriber.on_dispatch_error &method(:handle_dispatch_error)
+subscriber.setup_demultiplexer(kind, error_handler)
+```
+
+#### Airbrake Support
+Airbrake is supported out of the box. All you need to do is:
+
+1. Install and configure the [airbrake gem](https://github.com/airbrake/airbrake).
+2. Use the `AirbrakeErrorHandler`.
+
+```ruby
+subscriber.setup_demultiplexer(kind, AirbrakeErrorHandler)
 ```
 
 ## Contributing

data/lib/dispatch-rider/callbacks/access.rb

@@ -0,0 +1,29 @@
+module DispatchRider
+  module Callbacks
+    class Access
+      attr_reader :callbacks
+
+      def initialize(callbacks)
+        @callbacks = callbacks
+      end
+
+      def invoke(event, *args)
+        begin
+          invoke_callbacks :before, event, *args
+          yield
+        ensure
+          invoke_callbacks :after, event, *args
+        end
+      end
+
+      private
+
+      def invoke_callbacks(modifier, event, *args)
+        callbacks.for(modifier, event).each do |callback|
+          callback.call(*args)
+        end
+      end
+
+    end
+  end
+end

data/lib/dispatch-rider/callbacks/storage.rb

@@ -0,0 +1,31 @@
+module DispatchRider
+  module Callbacks
+    class Storage
+
+      def initialize
+        @callbacks = {}
+      end
+
+      def before(event, block_param = nil, &block)
+        add_callback :before, event, block_param, &block
+      end
+
+      def after(event, block_param = nil, &block)
+        add_callback :after, event, block_param, &block
+      end
+
+      def for(modifier, event)
+        @callbacks[[modifier, event]] || []
+      end
+
+      private
+
+      def add_callback(modifier, event, block_param = nil, &block)
+        block = block || block_param
+        @callbacks[[modifier, event]] ||= []
+        @callbacks[[modifier, event]] << block
+      end
+
+    end
+  end
+end

data/lib/dispatch-rider/callbacks.rb

@@ -0,0 +1,7 @@
+module DispatchRider
+  module Callbacks
+  end
+end
+
+require 'dispatch-rider/callbacks/access'
+require 'dispatch-rider/callbacks/storage'

data/lib/dispatch-rider/configuration.rb

@@ -0,0 +1,32 @@
+module DispatchRider
+  class Configuration
+    attr_accessor :handler_path, :error_handler, :queue_info, :queue_kind, :subscriber
+    attr_reader :callbacks
+
+    def initialize
+      @handler_path = Dir.getwd + "/app/handlers"
+      @error_handler = DispatchRider::DefaultErrorHandler
+      @queue_kind = :file_system
+      @queue_info = { path: "tmp/dispatch-rider-queue" }
+      @callbacks = Callbacks::Storage.new
+      @subscriber = DispatchRider::Subscriber
+    end
+
+    delegate :before, :after, :to => :callbacks
+
+    def handlers
+      @handlers ||= begin
+                      load_handler_files
+                      DispatchRider::Handlers::Base.subclasses.map{ |klass| klass.name.underscore.to_sym }
+                    end
+    end
+
+    private
+
+    def load_handler_files
+      Dir["#{@handler_path}/*.rb"].each do |filename|
+        require filename.gsub(/\.rb$/, '')
+      end
+    end
+  end
+end

data/lib/dispatch-rider/demultiplexer.rb

@@ -5,21 +5,22 @@
 # The demultiplexer can be stopped by calling the Demultiplexer#stop method.
 module DispatchRider
   class Demultiplexer
-    attr_reader :queue, :dispatcher
+    attr_reader :queue, :dispatcher, :error_handler
 
-    def initialize(queue, dispatcher)
+    def initialize(queue, dispatcher, error_handler)
       @queue = queue
       @dispatcher = dispatcher
+      @error_handler = error_handler
       @continue = true
     end
 
     def start
-      catch(:done) do
-        loop do
-          throw :done unless @continue
-          queue.pop do |message|
-            dispatch_message(message)
-          end
+      do_loop do
+        begin
+          handle_next_queue_item
+        rescue Exception => exception
+          error_handler.call(Message.new(subject: "TopLevelError", body: {}), exception)
+          throw :done
         end
       end
       self
@@ -29,8 +30,28 @@ module DispatchRider
       @continue = false
     end
 
+    private
+
     def dispatch_message(message)
       dispatcher.dispatch(message)
+    rescue Exception => exception
+      error_handler.call(message, exception)
     end
+
+    def do_loop
+      catch(:done) do
+        loop do
+          throw :done unless @continue
+          yield
+        end
+      end
+    end
+
+    def handle_next_queue_item
+      queue.pop do |message|
+        dispatch_message(message)
+      end
+    end
+
   end
 end

data/lib/dispatch-rider/dispatcher.rb

@@ -7,37 +7,18 @@ module DispatchRider
   class Dispatcher
     extend Forwardable
 
-    require 'dispatch-rider/dispatcher/named_process'
-    include NamedProcess
-
     attr_reader :handler_registrar
 
     def_delegators :handler_registrar, :register, :fetch, :unregister
 
     def initialize
       @handler_registrar = Registrars::Handler.new
-      @error_handler = method(:default_error_handler)
-    end
-
-    def on_error(&block)
-      @error_handler = block
     end
 
     def dispatch(message)
-      with_named_process(message.subject) do
-        handler_registrar.fetch(message.subject).process(message.body)
-      end
-
+      handler_registrar.fetch(message.subject).new.do_process(message.body)
       true # success => true (delete message)
-    rescue Exception => exception
-      @error_handler.call(message, exception)
-      false # failure => false (put message back on queue)
     end
 
-    private
-
-    def default_error_handler(message, exception)
-      raise exception
-    end
   end
 end

data/lib/dispatch-rider/error_handlers.rb

@@ -0,0 +1,18 @@
+module DispatchRider
+
+  # This is the default error handler for dispatch rider.
+  # It simply re-raises the exception.
+  module DefaultErrorHandler
+    def self.call(message, exception)
+      raise exception
+    end
+  end
+
+  # This error handler integrates with airbrake.io, i
+  # sending the mesage and environment details.
+  module AirbrakeErrorHandler
+    def self.call(message, exception)
+      Airbrake.notify(exception, controller: "DispatchRider", action: message.subject, parameters: message.attributes, cgi_data: ENV)
+    end
+  end
+end

data/lib/dispatch-rider/handlers/base.rb

@@ -0,0 +1,18 @@
+module DispatchRider
+  module Handlers
+    class Base
+      include NamedProcess
+      extend InheritanceTracking
+
+      def do_process(options)
+        with_named_process(self.class.name) do
+          process(options)
+        end
+      end
+
+      def process(options)
+        raise NotImplementedError, "Method 'process' not overridden in subclass!"
+      end
+    end
+  end
+end

data/lib/dispatch-rider/handlers/inheritance_tracking.rb

@@ -0,0 +1,19 @@
+# This module tracks which classes inherit from the class that includes
+# the module, and provides an accessor to it.
+
+module DispatchRider
+  module Handlers
+    module InheritanceTracking
+
+      def inherited(subclass)
+        subclasses << subclass
+        super
+      end
+
+      def subclasses
+        @subclasses ||= Set.new
+      end
+
+    end
+  end
+end

data/lib/dispatch-rider/handlers/named_process.rb

@@ -0,0 +1,17 @@
+module DispatchRider
+  module Handlers
+    module NamedProcess
+
+      def with_named_process(subject)
+        original_program_name = $0
+        begin
+          $0 += " - #{subject}"
+          yield
+        ensure
+          $0 = original_program_name
+        end
+      end
+
+    end
+  end
+end

data/lib/dispatch-rider/handlers.rb

@@ -0,0 +1,8 @@
+module DispatchRider
+  module Handlers
+  end
+end
+
+require 'dispatch-rider/handlers/named_process'
+require 'dispatch-rider/handlers/inheritance_tracking'
+require 'dispatch-rider/handlers/base'

data/lib/dispatch-rider/runner.rb

@@ -0,0 +1,53 @@
+module DispatchRider
+  class Runner
+
+    def self.run
+      new.process
+    end
+
+    def initialize
+      callbacks.invoke(:initialize) do
+        ready
+        set_queue_from_config
+      end
+    end
+    private_class_method :new
+
+    def process
+      callbacks.invoke(:process) do
+        puts "Running..."
+        @subscriber.process
+      end
+    end
+
+    private
+
+    def config
+      DispatchRider.config
+    end
+
+    def callbacks
+      @callbacks ||= Callbacks::Access.new(config.callbacks)
+    end
+
+    def ready
+      puts "Creating subscriber..."
+      @subscriber = config.subscriber.new
+
+      config.handlers.each do |handler_name|
+        puts "Registering #{handler_name} handler..."
+        @subscriber.register_handler(handler_name)
+      end
+    end
+
+    def set_queue_from_config
+      kind = config.queue_kind
+      info = config.queue_info
+
+      puts "Setting #{kind} queue @ #{info.to_json} ..."
+      @subscriber.register_queue(kind, info)
+      @subscriber.setup_demultiplexer(kind, config.error_handler)
+    end
+
+  end
+end

data/lib/dispatch-rider/subscriber.rb

@@ -23,13 +23,9 @@ module DispatchRider
       self
     end
 
-    def on_dispatch_error(&block)
-      dispatcher.on_error &block
-    end
-
-    def setup_demultiplexer(queue_name)
+    def setup_demultiplexer(queue_name, error_handler = DispatchRider::DefaultErrorHandler)
       queue = queue_service_registrar.fetch(queue_name)
-      @demultiplexer ||= DispatchRider::Demultiplexer.new(queue, dispatcher)
+      @demultiplexer ||= DispatchRider::Demultiplexer.new(queue, dispatcher, error_handler)
       self
     end
 

data/lib/dispatch-rider/version.rb

@@ -1,4 +1,4 @@
 # This file specifies the current version of the gem.
 module DispatchRider
-  VERSION = "0.0.7"
+  VERSION = "0.1.0"
 end

data/lib/dispatch-rider.rb

@@ -7,15 +7,31 @@ require "active_support/json"
 require "active_support/core_ext/array/conversions"
 require "active_model"
 
+require "dispatch-rider/configuration"
+
 module DispatchRider
+  class << self
+    def configure
+      yield configuration
+    end
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+    alias_method :config, :configuration
+  end
 end
 
 require "dispatch-rider/errors"
+require "dispatch-rider/error_handlers"
+require "dispatch-rider/handlers"
+require "dispatch-rider/callbacks"
 require "dispatch-rider/message"
 require "dispatch-rider/registrars"
 require "dispatch-rider/notification_services"
 require "dispatch-rider/queue_services"
 require "dispatch-rider/dispatcher"
 require "dispatch-rider/demultiplexer"
+require "dispatch-rider/runner"
 require "dispatch-rider/publisher"
 require "dispatch-rider/subscriber"

metadata

@@ -1,84 +1,74 @@
 --- !ruby/object:Gem::Specification
 name: dispatch-rider
 version: !ruby/object:Gem::Version
-  version: 0.0.7
-  prerelease: 
+  version: 0.1.0
 platform: ruby
 authors:
 - Suman Mukherjee
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-23 00:00:00.000000000 Z
+date: 2013-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: activemodel
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: daemons
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: jeweler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -86,7 +76,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -94,65 +83,57 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: travis-lint
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: debugger
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: Messaging system that is customizable based on which queueing system
@@ -166,11 +147,19 @@ extra_rdoc_files:
 - README.md
 files:
 - lib/dispatch-rider.rb
+- lib/dispatch-rider/callbacks.rb
+- lib/dispatch-rider/callbacks/access.rb
+- lib/dispatch-rider/callbacks/storage.rb
 - lib/dispatch-rider/command.rb
+- lib/dispatch-rider/configuration.rb
 - lib/dispatch-rider/demultiplexer.rb
 - lib/dispatch-rider/dispatcher.rb
-- lib/dispatch-rider/dispatcher/named_process.rb
+- lib/dispatch-rider/error_handlers.rb
 - lib/dispatch-rider/errors.rb
+- lib/dispatch-rider/handlers.rb
+- lib/dispatch-rider/handlers/base.rb
+- lib/dispatch-rider/handlers/inheritance_tracking.rb
+- lib/dispatch-rider/handlers/named_process.rb
 - lib/dispatch-rider/message.rb
 - lib/dispatch-rider/notification_services.rb
 - lib/dispatch-rider/notification_services/aws_sns.rb
@@ -195,6 +184,7 @@ files:
 - lib/dispatch-rider/registrars/publishing_destination.rb
 - lib/dispatch-rider/registrars/queue_service.rb
 - lib/dispatch-rider/registrars/sns_channel.rb
+- lib/dispatch-rider/runner.rb
 - lib/dispatch-rider/subscriber.rb
 - lib/dispatch-rider/version.rb
 - LICENSE.txt
@@ -202,30 +192,26 @@ files:
 homepage: ''
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -1276525084671356042
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Messaging system based on the reactor patter. You can publish messages to
   a queue and then a demultiplexer runs an event loop which pops items from the queue
   and hands it over to a dispatcher. The dispatcher hands over the message to the

data/lib/dispatch-rider/dispatcher/named_process.rb

@@ -1,13 +0,0 @@
-module DispatchRider
-  module Dispatcher::NamedProcess
-    def with_named_process(subject)
-      original_program_name = $0
-      begin
-        $0 += " - #{subject}"
-        yield
-      ensure
-        $0 = original_program_name
-      end
-    end
-  end
-end