dispatch-rider 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,15 @@
 ---
-SHA1:
-  metadata.gz: 093cafac338ae5b0c8b1c904a165ea70fb7b9c51
-  data.tar.gz: e2a11b4fb385a9c378cbc34f306187cb43bcef7e
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MTkzOGNhMTYyMGFlNzUxMWJjM2MyY2ZmNjRmZTAxZTlkMTk3NDY5Mw==
+  data.tar.gz: !binary |-
+    ZjQxZDVmOTIxYTc3N2U1NWYwYTQzODQ1MDNjZTk2YjFmMmQ1ZjQ3OQ==
 SHA512:
-  metadata.gz: 8927e40c071aa98fc1bc00821d65ebb2be8ae7a6c903f95a474806596c068f9aaadc620d1979ee2023e936b8d090824e8319bc02a96515c29651cff234871397
-  data.tar.gz: 5fed12410bb43754a04c578dca723e5f5dca29132f7f3e451660d54784a5d4b9df73f215c594a86a54629c6a29f5f6c232f5f26d726f7796f7a5eb1393c7660a
+  metadata.gz: !binary |-
+    YjE4NTI3OGYzY2MzMzJiODBkZDFjZGU0MDcwNjZkODM2OGViNzY5MGU1YmM5
+    MTg2Y2RjNTZiYjY4ZGE0N2ViYTYwMDRmYzg5MjYzNTUxODY3MTUyYTg0MDEz
+    Mjk4ZDA1OGNhY2ZlNTNhODUxNDllNmI1YTUwMWNhNGY0MjIyYjc=
+  data.tar.gz: !binary |-
+    OTg0OGQxMDYyNWMzYTgyMjg0NWQxYWMyNjI5NzY3M2NmODM4OWQyMjU0ZmEw
+    YTg2YTJkMTUxZjUyNGZiZTc1NzJjMjVhMzdmZTBhNjIxY2I1N2U4NDI1NWMy
+    ZDZiZGQ0OTY3MDFiZWY2YzcxMjY5NGZkMmU1M2MxNDdmNDIzYmY=

data/README.md

@@ -34,11 +34,12 @@ Setting up a publisher is simple.
 All configuration can be loaded from a hash instead of being done like the examples below.
 (currently only implemented for the publisher)
 
-eg:
+#### Global configuration
+
+You can set the global configuration using either a hash:
 
 ```ruby
-publisher = DispatchRider::Publisher.new
-publisher.configure({
+DispatchRider::Publisher.configure({
   notification_services: {
     file_system: {}
   },
@@ -54,6 +55,59 @@ publisher.configure({
 })
 ```
 
+or a block:
+
+```ruby
+DispatchRider::Publisher.configure do |config|
+  config.parse({
+    notification_services: {
+      file_system: {}
+    },
+    destinations: {
+      file_foo: {
+        service: :file_system,
+        channel: :foo,
+        options: {
+          path: "test/channel",
+        }
+      }
+    }
+  })
+end
+```
+
+Then anytime you call configure on a new publisher, it will default to global configuration.
+
+```ruby
+DispatchRider::Publisher.new
+
+# is the same as
+
+DispatchRider::Publisher.new(DispatchRider::Publisher.configuration)
+```
+
+#### Local configuration
+Alternatively, you can create your own configuration and load that configuration into your new publisher.
+
+```ruby
+  config = DispatchRider::Publisher::Configuration.new({
+    notification_services: {
+      file_system: {}
+    },
+    destinations: {
+      file_foo: {
+        service: :file_system,
+        channel: :foo,
+        options: {
+          path: "test/channel",
+        }
+      }
+    }
+  })
+
+  DispatchRider::Publisher.new(config)
+```
+
 You can load this configuration hash from a YAML file or something, whatever works
 well for your environment.
 
@@ -114,54 +168,17 @@ Sample Rails publisher:
 
 ```ruby
 # app/publishers/news_update
-class NewsPublisher
-  @publisher = DispatchRider::Publisher.new
-
-  amazon_config = YAML.load_file("#{Rails.root}/config/amazon.yml")
-
-  @publisher.register_notification_service(:aws_sns)
-  @publisher.register_destination(:sns_message_queue, :aws_sns, :dev_channel, {
-    :account => amazon_config[:account],
-    :region  => amazon_config[:region],
-    :topic   => "news-updates-#{Rails.env}"
-  })
-
-  @destinations = [:sns_message_queue]
+class NewsPublisher < DispatchRider::Publisher::Base
 
-  class << self
-    attr_reader :publisher
-    attr_accessor :destinations
-  end
-
-  delegate :publisher, :destinations, :to => :"self.class"
+  destinations :sns_message_queue
+  subject "read_news"
 
-  def initialize(news)
-    @news = news
+  def self.publish(news)
+    publish({"headlines" => news.headlines})
   end
 
-  def publish
-    publisher.publish(:destinations => destinations, :message => {
-      :subject => "read_news",
-      :body => {"headlines" => @news.headlines}
-    })
-  end
-end
-
-# app/models/news
-class News
-  serialize :headlines, Array
-
-  after_create :publish
-
-  def publish
-     NewsPublisher.new(self).publish
-  end
 end
 
-News.create!(:headlines => [
-  "April 29, 2013: Rails 4.0.0.rc1 is released.",
-  "May 14, 2013: Ruby 2.0.0-p195 is released"
-])
 ```
 
 ### Subscriber

data/lib/dispatch-rider/publisher.rb

@@ -1,18 +1,19 @@
 require "active_support/core_ext/hash/indifferent_access"
+require_relative "publisher/configuration_support"
 
 # This class takes care of the publishing side of the messaging system.
 module DispatchRider
   class Publisher
-    attr_reader :service_channel_mapper, :notification_service_registrar, :publishing_destination_registrar, :sns_channel_registrar
+    extend ConfigurationSupport
 
-    def configure(configuration_hash = {})
-      ConfigurationReader.parse(configuration_hash.with_indifferent_access, self)
-    end
+    attr_reader :service_channel_mapper, :notification_service_registrar, :publishing_destination_registrar, :sns_channel_registrar
 
-    def initialize
+    def initialize(configuration = self.class.configuration)
       @notification_service_registrar = DispatchRider::Registrars::NotificationService.new
       @publishing_destination_registrar = DispatchRider::Registrars::PublishingDestination.new
       @service_channel_mapper = ServiceChannelMapper.new(publishing_destination_registrar)
+
+      ConfigurationReader.load_config(configuration, self)
     end
 
     def register_notification_service(name, options = {})
@@ -70,4 +71,6 @@ module DispatchRider
   end
 end
 
+require_relative "publisher/configuration"
 require_relative "publisher/configuration_reader"
+require_relative "publisher/base"

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

@@ -0,0 +1,47 @@
+module DispatchRider
+  class Publisher::Base
+
+    class << self
+
+      def subject(subject)
+        @subject = subject
+      end
+
+      def destinations(destinations)
+        @destinations = Array(destinations)
+      end
+
+      def default_publisher
+        @@default_publisher ||= DispatchRider::Publisher.new
+      end
+
+      def publish(*args, &block)
+        raise NotImplementedError
+      end
+
+    end
+
+    def initialize(publisher = nil)
+      @publisher = publisher
+    end
+
+    def publish(body)
+      publisher.publish(destinations: destinations, message: { subject: subject, body: body })
+    end
+
+    private
+
+    def publisher
+      @publisher || self.class.default_publisher
+    end
+
+    def destinations
+      self.class.instance_variable_get(:@destinations)
+    end
+
+    def subject
+      self.class.instance_variable_get(:@subject)
+    end
+
+  end
+end

data/lib/dispatch-rider/publisher/configuration.rb

@@ -0,0 +1,49 @@
+module DispatchRider
+  class Publisher::Configuration
+
+    def initialize(configuration_hash = {})
+      @notification_services = []
+      @destinations = []
+      parse(configuration_hash)
+    end
+
+    def notification_services
+      @notification_services
+    end
+
+    def destinations
+      @destinations
+    end
+
+    def parse(configuration_hash)
+      clear
+
+      configuration_hash = configuration_hash.with_indifferent_access
+      configure_notification_services(configuration_hash[:notification_services] || {})
+      configure_destinations(configuration_hash[:destinations] || {})
+    end
+
+    def clear
+      @notification_services.clear
+      @destinations.clear
+    end
+
+    private
+
+    def configure_notification_services(notification_services_hash)
+      notification_services_hash.each do |name, options|
+        @notification_services << NotificationService.new(name, options)
+      end
+    end
+
+    def configure_destinations(destinations_hash)
+      destinations_hash.each do |name, options|
+        @destinations << Destination.new(name, options)
+      end
+    end
+
+  end
+end
+
+require_relative "configuration/destination"
+require_relative "configuration/notification_service"

data/lib/dispatch-rider/publisher/configuration/destination.rb

@@ -0,0 +1,23 @@
+module DispatchRider
+  class Publisher::Configuration::Destination
+
+    def initialize(name, attributes={})
+      @name = name
+
+      attributes = attributes.with_indifferent_access
+      @service = attributes[:service]
+      @channel = attributes[:channel]
+      @options = attributes[:options]
+    end
+
+    attr_reader :name, :service, :channel, :options
+
+    def ==(other)
+      self.name == other.name &&
+        self.service == other.service &&
+        self.channel == other.channel &&
+        self.options == other.options
+    end
+
+  end
+end

data/lib/dispatch-rider/publisher/configuration/notification_service.rb

@@ -0,0 +1,17 @@
+module DispatchRider
+  class Publisher::Configuration::NotificationService
+
+    def initialize(name, options)
+      @name = name
+      @options = options
+    end
+
+    attr_reader :name, :options
+
+    def ==(other)
+      self.name == other.name &&
+        self.options == other.options
+    end
+
+  end
+end

data/lib/dispatch-rider/publisher/configuration_reader.rb

@@ -1,32 +1,29 @@
 module DispatchRider
-
   class Publisher
-
     module ConfigurationReader
 
       class << self
-        def parse(configuration_hash, publisher)
-          configure_notification_services(configuration_hash[:notification_services], publisher) if configuration_hash[:notification_services]
-          configure_destinations(configuration_hash[:destinations], publisher) if configuration_hash[:destinations]
+        def load_config(configuration, publisher)
+          configure_notification_services(configuration.notification_services, publisher)
+          configure_destinations(configuration.destinations, publisher)
         end
 
         private
 
-          def configure_notification_services(notification_services, publisher)
-            notification_services.each do |(service_name, service_options)|
-              publisher.register_notification_service(service_name, service_options)
-            end
+        def configure_notification_services(notification_services, publisher)
+          notification_services.each do |service|
+            publisher.register_notification_service(service.name, service.options)
           end
+        end
 
-          def configure_destinations(destinations, publisher)
-            destinations.each do |(destination_name, info)|
-              publisher.register_destination(destination_name, info[:service], info[:channel], info[:options])
-            end
+        def configure_destinations(destinations, publisher)
+          destinations.each do |destination|
+            publisher.register_destination(destination.name, destination.service, destination.channel, destination.options)
           end
+        end
 
       end
-    end
 
+    end
   end
-
 end

data/lib/dispatch-rider/publisher/configuration_support.rb

@@ -0,0 +1,20 @@
+module DispatchRider
+  class Publisher
+    module ConfigurationSupport
+
+      def configuration
+        @configuration ||= Configuration.new
+      end
+      alias_method :config, :configuration
+
+      def configure(configuration_hash = {})
+        if block_given?
+          yield configuration
+        else
+          configuration.parse(configuration_hash)
+        end
+      end
+
+    end
+  end
+end

data/lib/dispatch-rider/version.rb

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

metadata

@@ -1,69 +1,69 @@
 --- !ruby/object:Gem::Specification
 name: dispatch-rider
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Suman Mukherjee
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-01 00:00:00.000000000 Z
+date: 2013-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: activemodel
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: daemons
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
@@ -72,68 +72,70 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.8.4
+        version: !binary |-
+          MS44LjQ=
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.8.4
+        version: !binary |-
+          MS44LjQ=
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: travis-lint
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: debugger
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: Messaging system that is customizable based on which queueing system
@@ -168,7 +170,12 @@ files:
 - lib/dispatch-rider/notification_services/file_system/channel.rb
 - lib/dispatch-rider/notification_services/file_system/notifier.rb
 - lib/dispatch-rider/publisher.rb
+- lib/dispatch-rider/publisher/base.rb
+- lib/dispatch-rider/publisher/configuration.rb
+- lib/dispatch-rider/publisher/configuration/destination.rb
+- lib/dispatch-rider/publisher/configuration/notification_service.rb
 - lib/dispatch-rider/publisher/configuration_reader.rb
+- lib/dispatch-rider/publisher/configuration_support.rb
 - lib/dispatch-rider/queue_services.rb
 - lib/dispatch-rider/queue_services/aws_sqs.rb
 - lib/dispatch-rider/queue_services/aws_sqs/message_body_extractor.rb
@@ -199,17 +206,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.1.10
 signing_key: 
 specification_version: 4
 summary: Messaging system based on the reactor patter. You can publish messages to