ferryman 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7d253c3ecf37cdcb02dd390586852f37feb235b9
+  data.tar.gz: c83d132003bfc24337c6a8e431bb94a36e75ce6f
+SHA512:
+  metadata.gz: 814c75376361c13e49b314e1c35696d94a8eca071bb6285dea51ead10c65b72e8ea92f2f3f160bcc41ea3776c69e31f08eab5919dfb4c77e2f736b8921320bc5
+  data.tar.gz: cda89fb80b7b3e9912de04a9ae7633b1914ca574020a8ba629accf9c76de1fbe7d1a9347f3d2258ce75b74099ee2c6509a06945df99ec9459edf79bb07927d19

data/lib/ferryman.rb

@@ -0,0 +1,141 @@
+require 'global_phone'
+
+GlobalPhone.db_path = ENV.fetch('NUMBER_DB_FILE', 'phone_numbers.json')
+
+module Ferryman
+  class ConfigError < StandardError
+  end
+
+  class DeliveryError < StandardError
+  end
+
+  class RoutingRule
+    attr_reader :strategy
+    attr_reader :providers
+
+    MATCH_ALL = lambda {|_| true}
+    STRATEGIES = {
+      'first' => lambda {|providers| providers},
+      'random' => lambda {|providers| providers.shuffle}
+    }
+
+    def initialize
+      @providers = []
+      @match_rules = []
+      @strategy = 'first'
+    end
+
+    def accept?(phone_number)
+      matched = true
+
+      @match_rules.each do |rule|
+        matched &&= rule.call(phone_number)
+        break unless matched
+      end
+
+      matched
+    end
+
+    def set_match(match)
+      raise ConfigError.new('match cannot be nil!') if match.nil?
+
+      if match == '*'
+        @match_rules << MATCH_ALL
+      elsif match.respond_to? 'has_key?'
+        if match.has_key?(:regions)
+          regions = Array.new(match[:regions])
+          @match_rules << lambda do |number|
+            parsed_number = GlobalPhone.parse(number)
+            regions.include? parsed_number.territory.name
+          end
+        end
+      else
+        raise ConfigError.new("Unexpected value for 'match'")
+      end
+
+      true
+    end
+
+    def providers
+      STRATEGIES[@strategy].call(@providers)
+    end
+
+    def add_provider(provider)
+      raise ConfigError.new('provider cannot be nil!') if provider.nil?
+      @providers << provider
+    end
+
+    def strategy=(strategy)
+      raise ConfigError.new('unknown strategy') unless STRATEGIES.has_key?(strategy)
+      @strategy = strategy
+    end
+
+  end
+
+  class Config
+    attr_reader :rules, :providers
+
+    def initialize
+      @providers = {}
+      @rules = []
+      @arity = nil
+    end
+
+    def add_provider(name, provider)
+      raise ConfigError.new("Provider #{name} already exists") if @providers.has_key?(name)
+      raise ConfigError.new("Provider must accept at least a phone number") if provider.arity < 1
+      raise ConfigError.new("Provider arguments does not match with existing") unless @arity.nil? || provider.arity == @arity
+
+      @arity = provider.arity
+      @providers[name] = provider
+
+      true
+    end
+
+    def set_routing_table(table)
+      table.each do |row|
+        raise ConfigError.new('providers cannot be nil!') if row[:providers].nil?
+
+        rule = RoutingRule.new
+        rule.set_match row[:match]
+        rule.strategy = row.fetch(:strategy, 'first')
+        row[:providers].each {|provider| rule.add_provider(provider)}
+        @rules << rule
+      end
+
+      true
+    end
+  end
+
+  class Dispatcher
+    attr_reader :config
+
+    def initialize
+      @config = Config.new
+    end
+
+    def deliver(phone_number, *args)
+      @config.rules.each do |rule|
+        next unless rule.accept?(phone_number)
+
+        rule.providers.each do |provider_name|
+          provider = @config.providers[provider_name]
+          params = [phone_number] + args
+          begin
+            return provider.call(*params)
+          rescue DeliveryError
+            next
+          end
+        end
+      end
+
+      nil
+    end
+  end
+
+  def Ferryman.create
+    dispatcher = Dispatcher.new
+    yield dispatcher.config
+    dispatcher
+  end
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: ferryman
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jimmy Shen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: global_phone
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: global_phone_dbgen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Ferryman allows you to de-couple routing logic and providers
+email: thejimmyshen@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/ferryman.rb
+homepage: https://github.com/jimmyshen/ferryman
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Rules-based routing of SMS messages to providers.
+test_files: []