depalma 0.1.0

data/README.rdoc

@@ -0,0 +1,45 @@
+== depalma
+
+== Installation
+
+== Usage
+
+It's recommended that you inherit from the Dispatcher and DispatchRule classes and create your own. From there you can override the dispatch algorithm (or leave it alone). Even if you don't plan on overriding any methods you may want to at least override the Dispatcher.recall method. Which does nothing by default. 
+
+Dispatch rules basically tell the Dispatcher which "units" to assign "messages" too. A "unit" is what you are dispatching to, and a "message" is what is being dispatched. For example if you had a sales team "Salesman A", "Salesman B", and "Salesman C" they would be the "units". And if you were dispatching sales leads to those salesmen the "leads" would be the "message".
+
+First create a rule.
+
+  class SalesLeadDispatchRule < DispatchRule
+    # Create a rule to your liking maybe it accepts variables.
+  end
+
+Then create your dispatcher
+
+  class LeadDispatcher < Dispatcher
+    def recall
+      # Create code here to find all the leads dispatched in the past hour and unassign them.
+    end
+
+    def distribution_algorithm
+      # If Dispatcher.message_list or Dispatcher.unit_list or undefined throw and error.
+      raise NotImplementedError, "Dispatcher.message_list is undefined or empty.", if Dispatcher.message_list == undef || Dispatcher.message_list.empty?
+      raise NotImplementedError, "Dispatcher.unit_list is undefined or empty.", if Dispatcher.unit_list == undef || Dispatcher.unit_list.empty?
+
+      # Apply the Dispatch rules, loop through the messages and assign them to the units.
+    
+    end
+  end
+
+Then you can create your dispatcher and dispatch rules
+
+The Dispatcher takes three optional arguments (message_list, unit_list, rule_list) in that order.
+
+  sldRule = SalesLeadDispatchRule.new
+  ldispatcher = LeadDispatcher.new(todays_leads, SalesReps.find(:all), [sldRule])
+
+Or you can set each one seperately.
+  ldispatcher.add_rule(sldRule)
+  ldispatcher.message_list(todays_leads)
+  ldispatcher.unit_list(SalesReps.find(:all))
+  results = ldispatcher.dispatch

data/Rakefile

@@ -0,0 +1,46 @@
+# Rakefile
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "depalma"
+    gemspec.summary = "A simple but powerful dispatcher."
+    gemspec.description = "Configure simple dispatch rules and have data dispatched over a group of receivers."
+    gemspec.email = "rankin.devon@gmail.com"
+    gemspec.homepage = "http://github.com/crankin/depalma"
+    gemspec.authors = ["Christopher Rankin"]
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install jeweler -s http://gemcutter.org"
+end
+
+# depalma.gemspec
+Gem::Specification.new do |s|
+  s.name = %q{depalma}
+  s.version = "0.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Christopher Rankin"]
+  s.date = %q{2010-01-08}
+  s.description = %q{Configure simple dispatch rules and have data dispatched over a group of receivers.}
+  s.email = %q{rankin.devon@gmail.com}
+  s.extra_rdoc_files = ["lib/dispatcher.rb", "lib/dispatch_rule.rb", "README.rdoc"]
+  s.files = ["lib/dispatcher.rb", "lib/dispatch_rule.rb", "Rakefile", "README.rdoc", "Manifest", "depalma.gemspec"]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/crankin/depalma}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "depalma", "--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{depalma}
+  s.rubygems_version = %q{1.2.0}
+  s.summary = %q{A simple but powerful dispatcher.}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if current_version >= 3 then
+    else
+    end
+  else
+  end
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/depalma.gemspec

@@ -0,0 +1,43 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{depalma}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Christopher Rankin"]
+  s.date = %q{2010-01-10}
+  s.description = %q{Configure simple dispatch rules and have data dispatched over a group of receivers.}
+  s.email = %q{rankin.devon@gmail.com}
+  s.extra_rdoc_files = [
+    "README.rdoc"
+  ]
+  s.files = [
+    "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "depalma.gemspec",
+     "lib/dispatch_rule.rb",
+     "lib/dispatch_unit.rb",
+     "lib/dispatcher.rb"
+  ]
+  s.homepage = %q{http://github.com/crankin/depalma}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{A simple but powerful dispatcher.}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

data/lib/dispatch_rule.rb

@@ -0,0 +1,19 @@
+class DispatchRule
+  # Accessors
+  attr_accessor :weight
+  # Class Methods
+  
+  # initialize
+  #---------------------------------------------------------------------------
+  def initialize(weight=0)
+    @weight = weight
+  end
+
+  # Instance Methods
+
+  # Run the rule, called from the dispatcher. Rules should return a list of weighted "units".
+  #---------------------------------------------------------------------------
+  def run(list=[])
+    raise NotImplementedError, 'Please subclass DispatchRule, and write a "run" method.'
+  end
+end

data/lib/dispatch_unit.rb

@@ -0,0 +1,27 @@
+class DispatchUnit
+  # Accessors
+  attr_accessor :weight, :body
+
+  # Class Methods
+
+  # initialize
+  #---------------------------------------------------------------------------
+  def initialize(weight, body)
+    @weight = weight
+    @body = body
+  end
+
+  # Instance Methods
+
+  # promote
+  #---------------------------------------------------------------------------
+  def promote
+    @weight += 1
+  end
+
+  # demote
+  #---------------------------------------------------------------------------
+  def demote
+    @weight -= 1
+  end
+end

data/lib/dispatcher.rb

@@ -0,0 +1,51 @@
+class Dispatcher
+  # Accessors
+  attr_accessor :message_list, :unit_list, :rule_list
+
+  # Class Methods
+
+  # units_from_list
+  #---------------------------------------------------------------------------
+  def self.create_units_from_list(list)
+    list.map { |x|
+      DispatchUnit.new(0, x)
+    }
+  end
+
+  # Instance Methods
+
+  # initialize
+  #---------------------------------------------------------------------------
+  def initialize(messages=[], units=[], rules=[])
+    @rule_list =  rules
+    @message_list = messages
+    @unit_list = units
+  end
+
+  # dispatch_algorithm
+  #---------------------------------------------------------------------------
+  def dispatch_algorithm
+    raise NotImplementedError, 'Subclass Dispatcher and define your own "dispatch_algorithm" method.'
+  end
+
+  # add_rule
+  #---------------------------------------------------------------------------
+  def add_rule(rule)
+    @rule_list.push(rule)
+    @rule_list.sort! { |x,y| x.weight <=> y.weight }
+  end
+
+  # remove_rule
+  #---------------------------------------------------------------------------
+  def remove_rule(rule)
+    @rule_list.delete(rule)
+  end
+
+  # dispatch
+  #---------------------------------------------------------------------------
+  def dispatch
+    @rule_list.each { |rule| rule.run(self.unit_list) }
+    self.dispatch_algorithm
+  end
+
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification 
+name: depalma
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Christopher Rankin
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-10 00:00:00 -05:00
+default_executable: 
+dependencies: []
+
+description: Configure simple dispatch rules and have data dispatched over a group of receivers.
+email: rankin.devon@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- README.rdoc
+- Rakefile
+- VERSION
+- depalma.gemspec
+- lib/dispatch_rule.rb
+- lib/dispatch_unit.rb
+- lib/dispatcher.rb
+has_rdoc: true
+homepage: http://github.com/crankin/depalma
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: A simple but powerful dispatcher.
+test_files: []
+