message_router 0.0.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Brad Gessler
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,72 @@
+= Message Router
+
+Message router is a Sinatra-like DSL for processing simple messages, like SMS messages or Tweets.
+
+== Example Code
+
+This is a contrived example for a Twitter message router, but it gives you an idea of how it works.
+
+    class TwitterRouter < MessageRouter
+      context :all_caps_with_numbers do
+        # All caps without numbers... but in a proc
+        context Proc.new{|r| r.message[:body] =~ /^[A-Z\s]+$/ } do
+          match /.+/ do
+            "STOP SHOUTING WITHOUT NUMBERS!"
+          end
+        end
+    
+        match /.+/ do
+          "STOP SHOUTING WITH NUMBERS!"
+        end
+      end
+  
+      match /hi dude/ do
+        "pleased to meet you"
+      end
+  
+      match /hi (\w+)/ do |name|
+        "how do you do #{name}"
+      end
+  
+      match /hola (\w+)/, :from => 'bradgessler' do |name|
+        "hello #{name} in spanish"
+      end
+  
+    private
+      def all_caps_with_numbers
+        message[:body] =~ /^[A-Z0-9\s]+$/
+      end
+    end
+
+And now some irb action.
+
+    >> TwitterRouter.new({:body => 'hi dude'}).dispatch
+    => "pleased to meet you"
+    >> TwitterRouter.new({:body => 'hi brad'}).dispatch
+    => "how do you do brad"
+    >> TwitterRouter.new({:body => 'HI BRAD 90'}).dispatch
+    => "STOP SHOUTING WITH NUMBERS!"
+    >> TwitterRouter.new({:body => 'HI BRAD'}).dispatch
+    => "STOP SHOUTING WITHOUT NUMBERS!"
+
+== License
+
+Copyright (c) 2010, Brad Gessler
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,45 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "message_router"
+    gem.summary = %Q{Route small messages, like SMS and Tweets}
+    gem.description = %Q{Message Router is a Sinatra like DSL that deals with routing small, non-web messages, like Tweets or SMS messages.}
+    gem.email = "brad@bradgessler.com"
+    gem.homepage = "http://github.com/bradgessler/message_router"
+    gem.authors = ["Brad Gessler"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "message_router #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.0

data/lib/message_router/context.rb

@@ -0,0 +1,23 @@
+class MessageRouter
+  class Context
+    def initialize(context_proc, &block)
+      @block = block
+      @context_proc = normalize_context_proc(context_proc)
+    end
+    
+    def call(router)
+      if args = context_proc.call(router)
+        klass = Class.new(router.class)
+        klass.instance_exec(*args, &block)
+        klass.new(router.message).dispatch
+      end
+    end
+    
+  private
+    attr_reader :block, :context_proc
+    
+    def normalize_context_proc(proc)
+      proc.is_a?(Proc) ? proc : Proc.new{|instance| instance.send(proc) }
+    end
+  end
+end

data/lib/message_router/matcher.rb

@@ -0,0 +1,49 @@
+class MessageRouter
+  class Matcher
+    
+    def initialize(*args, &block)
+      @params, @block = normalize_params(*args), block
+    end
+    
+    # Check if all the keys and expression values match the message
+    def match(message)
+      params.inject({}) do |memo, (key,expression)|
+        break unless message.include?(key) # Get out of here if the key isn't even around
+        
+        case expression
+        when Regexp # Grap the regexp captures
+          if match = message[key].match(expression)
+            memo[key] = match.captures
+          end
+        else # Capture the values, similar to how a regexp would be captured
+          memo[key] = Array(message[key]) if message[key] == expression
+        end
+        
+        memo[key] ? memo : break
+      end
+    end
+    
+    def call(router)
+      if match = match(router.message)
+        router.instance_exec(*match[self.class.default_param], &block)
+      end
+    end
+    
+    def self.default_param
+      :body
+    end
+    
+  private
+    attr_reader :params, :block
+  
+    def normalize_params(*args)
+      if args.size == 2
+        args.last.merge(self.class.default_param => args.first)
+      elsif args.size == 1 and args.first.is_a?(Hash)
+        args.first
+      elsif args.size == 1
+        { self.class.default_param => args.first }
+      end
+    end
+  end
+end

data/lib/message_router.rb

@@ -0,0 +1,39 @@
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__))
+
+class MessageRouter
+  
+  autoload :Context, 'message_router/context'
+  autoload :Matcher, 'message_router/matcher'
+  
+  class << self
+    def match(*args, &block)
+      route Matcher.new(*args, &block)
+    end
+    
+    def context(proc, &block)
+      route Context.new(proc, &block)
+    end
+    
+    def route(proc)
+      routes.push proc
+    end
+    
+    def routes
+      @routes ||= []
+    end
+  end
+  
+  attr_accessor :message
+  
+  def initialize(message)
+    @message = message
+  end
+  
+  # Iterate through all of the matchers, find the first one, and call the block on it.
+  def dispatch
+    self.class.routes.each do |route|
+      # Break out of the loop if a match is found
+      match = route.call(self) and return match
+    end
+  end
+end

data/message_router.gemspec

@@ -0,0 +1,59 @@
+# 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{message_router}
+  s.version = "0.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Brad Gessler"]
+  s.date = %q{2010-09-06}
+  s.description = %q{Message Router is a Sinatra like DSL that deals with routing small, non-web messages, like Tweets or SMS messages.}
+  s.email = %q{brad@bradgessler.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/message_router.rb",
+     "lib/message_router/context.rb",
+     "lib/message_router/matcher.rb",
+     "message_router.gemspec",
+     "spec/message_dispatcher_spec.rb",
+     "spec/routers.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/bradgessler/message_router}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Route small messages, like SMS and Tweets}
+  s.test_files = [
+    "spec/message_dispatcher_spec.rb",
+     "spec/routers.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+  end
+end
+

data/spec/message_dispatcher_spec.rb

@@ -0,0 +1,96 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe MessageRouter::Matcher do
+  context "regexp expressions" do
+    it "should return captures" do
+      match = MessageRouter::Matcher.new({:body => /(\w+) (\w+) (\w+)/}).match({:body => 'hi there dude'})
+      match[:body].should eql(%w(hi there dude))
+    end
+  end
+  
+  context "string expressions" do
+    it "should return capture" do
+      match = MessageRouter::Matcher.new({:body => 'testing'}).match({:body => 'testing'})
+      match[:body].should eql(['testing'])
+    end
+  end
+  
+  it "should return captures if all matchers have captures" do
+    match = MessageRouter::Matcher.new({:body => 'testing', :carrier => 'att'}).match({:body => 'testing', :carrier => 'att'})
+    match.should_not be_nil
+  end
+  
+  it "should not return captures if some matchers have captures" do
+    match = MessageRouter::Matcher.new({:body => 'testing', :carrier => 'att'}).match({:body => 'testing', :carrier => 'verizon'})
+    match.should be_nil
+  end
+  
+  it "should not return captures of params are missing" do
+    match = MessageRouter::Matcher.new({:body => 'testing', :carrier => 'att'}).match({:body => 'testing'})
+  end
+  
+  it "should default matcher param to :body" do
+    MessageRouter::Matcher.default_param.should eql(:body)
+  end
+end
+
+describe MessageRouter do
+  
+  class TwitterRouter < MessageRouter
+    context :all_caps_with_numbers do
+      # All caps without numbers... but in a proc
+      context Proc.new{|r| r.message[:body] =~ /^[A-Z\s]+$/ } do
+        match /.+/ do
+          "STOP SHOUTING WITHOUT NUMBERS!"
+        end
+      end
+      
+      match /.+/ do
+        "STOP SHOUTING WITH NUMBERS!"
+      end
+    end
+    
+    match /hi dude/ do
+      "pleased to meet you"
+    end
+    
+    match /hi (\w+)/ do |name|
+      "how do you do #{name}"
+    end
+    
+    match /hola (\w+)/, :from => 'bradgessler' do |name|
+      "hello #{name} in spanish"
+    end
+    
+  private
+    def all_caps_with_numbers
+      message[:body] =~ /^[A-Z0-9\s]+$/
+    end
+  end
+  
+  context "default matcher" do
+    it "should capture regexps" do
+      TwitterRouter.new({:body => 'hi dude'}).dispatch.should eql('pleased to meet you')
+    end
+    
+    it "should pass regexp captures through blocks" do
+      TwitterRouter.new({:body => 'hi brad'}).dispatch.should eql("how do you do brad")
+    end
+  end
+  
+  context "hash matcher" do
+    it "should capture with default matcher" do
+      TwitterRouter.new({:from => 'bradgessler', :body => 'hola jeannette'}).dispatch.should eql("hello jeannette in spanish")
+    end
+  end
+  
+  context "context" do
+    it "should handle contexts and non-proc conditions" do
+      TwitterRouter.new({:body => 'HI BRAD 90'}).dispatch.should eql("STOP SHOUTING WITH NUMBERS!")
+    end
+    
+    it "should handle nested contexts and proc conditions" do
+      TwitterRouter.new({:body => 'HI BRAD'}).dispatch.should eql("STOP SHOUTING WITHOUT NUMBERS!")
+    end
+  end
+end

data/spec/routers.rb

@@ -0,0 +1,40 @@
+class SMS < MessageRouter
+  
+  context :group_session do |session|
+    match /(\w)?\s(.*)/ do |keyword, value|
+      "#{stats(keyword, value)} || #{session}"
+    end
+    
+    match /leave/ do
+      'leaaave'
+    end
+  end
+  
+  context :lists do
+  end
+  
+  match /para(ms)/ do |m|
+    message
+  end
+  
+  match /ping/ do
+    "PONG #{Time.now.to_s}"
+  end
+  
+  match /(\w+)\s?(.*)/ do |keyword, text|
+    stats(keyword, text)
+  end
+  
+private
+  def group_session
+    true
+  end
+  
+  def stats(keyword, text)
+    "Global:#{keyword}"
+  end
+  
+  def super_session
+    true
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'message_router'
+require 'rubygems'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification 
+name: message_router
+version: !ruby/object:Gem::Version 
+  hash: 31
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 0
+  version: 0.0.0
+platform: ruby
+authors: 
+- Brad Gessler
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-09-06 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id001
+description: Message Router is a Sinatra like DSL that deals with routing small, non-web messages, like Tweets or SMS messages.
+email: brad@bradgessler.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/message_router.rb
+- lib/message_router/context.rb
+- lib/message_router/matcher.rb
+- message_router.gemspec
+- spec/message_dispatcher_spec.rb
+- spec/routers.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/bradgessler/message_router
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Route small messages, like SMS and Tweets
+test_files: 
+- spec/message_dispatcher_spec.rb
+- spec/routers.rb
+- spec/spec_helper.rb