josh-splat 0.0.2

data/.document

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

data/.gitignore

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

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Gautam Rege
+
+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,32 @@
+ SPlat - Sms PLATform
+
+SPlat is an integration platform to make use of SMS integration really 
+easy. Using this platform has the following advantages:
+
+* Single point of integration
+* Change vendors without changing code.
+* Send and receive SMS.
+* Generic Exception Handling.
+* Standardized reports.
+* SMS tagged user groups.
+* SMS bogus gateway for testing.
+* Scheduling SMS for delivery.
+
+What SPlat isn't!
+
+SPlat is not an SMS gateway. You still need to buy a subscription from one
+of the vendors SPlat supports. 
+
+Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Josh Software Pvt. Ltd. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "splat"
+    gem.summary = %Q{TODO: one-line summary of your gem}
+    gem.description = %Q{TODO: longer description of your gem}
+    gem.email = "gautam@joshsoftware.com"
+    gem.homepage = "http://github.com/gautamrege/splat"
+    gem.authors = ["Gautam Rege"]
+    gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+    # 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 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "splat #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.2

data/generators/splat_config/splat_generator.rb

@@ -0,0 +1,16 @@
+class SplatGenerator < Rails::Generator::Base
+
+  def manifest
+    record do |m|
+      m.file 'splat.yml',    'config/splat.yml'
+      m.file 'vendors.yml',  'config/vendors.yml'
+    end
+  end
+
+  protected
+
+  def banner
+    "Usage: #{$0} splat"
+  end
+end
+

data/generators/splat_config/templates/splat.yml

@@ -0,0 +1,28 @@
+
+# Mobile number formats varies from vendor to vendor. 
+# To resolve this, SPlat splits country_code and mobile number.
+# The default format is: +<country code><single white space><mobile number.
+# 
+# Its quite possible that you may require to use the before_send hook to
+# manipulate the number format. 
+#
+# At your own risk, update the regex for default_number_format if you know
+# what you are doing.
+#default_number_format: '^\+\d{1,4}\ \d{8,12}$'  # +91 9812345867
+
+
+# By default SPlat will try 5 times to send an SMS on failure.
+#retries: 5
+
+# Default insertion is a means to work-around incomplete string insertions.
+# This can be overridden using the options parameter.
+#use_default_insertion: true
+#default_insertion: ""
+
+
+default:
+  number_format: '^\+\d{1,4}\ \d{8,12}$'  # +91 9812345867
+  retries: 5
+  use_default_insertion: true
+  default_insertion: ""
+

data/generators/splat_config/templates/vendors.yml

@@ -0,0 +1,19 @@
+
+vmobo:
+  provider_url: 'http://www.vMobo.in/bulk_send/v1'
+  username: 
+  api_key: 
+  keyword: 
+
+bulksmspune:
+  provider_url: 'http://www.bulksmspune.mobi/sendurlcomma.asp'
+  username: 
+  password: 
+  senderid: 
+
+clickatell:
+  provider_url: 'http://api.clickatell.com'
+  api_key:  
+  username: 
+  password: 
+  

data/init.rb

@@ -0,0 +1,2 @@
+
+require File.dirname(__FILE__) + '/lib/splat'

data/lib/splat/configuration.rb

@@ -0,0 +1,35 @@
+require 'yaml'
+
+module Splat
+
+  #Singleton class
+  class Configuration
+
+    @options = nil
+
+    def initialize
+      @options = YAML.load_file('config/splat.yml')
+      @options = @options.merge YAML.load_file('config/vendors.yml') 
+    end
+
+    def self.instance
+      @@configuration
+    end
+
+    def vendor(vendor = "default")
+      @options[vendor.to_s] 
+    end
+
+    def all
+      @options
+    end
+
+    def vendors
+      @options.keys
+    end
+
+    @@configuration = Configuration.new
+    private_class_method :new
+
+  end
+end

data/lib/splat/error.rb

@@ -0,0 +1,23 @@
+
+module Splat
+
+    class SplatError < StandardError
+    end
+
+    class SplatGatewayError < SplatError
+    end
+
+    class SplatFormatError < SplatError
+    end
+
+    class SplatNoGatewaySupportError < SplatError
+    end
+
+    class SplatGatewayImplError < SplatError
+    end
+
+end
+
+
+
+

data/lib/splat/gateway.rb

@@ -0,0 +1,118 @@
+
+require 'net/http'
+require File.dirname(__FILE__) + '/configuration'
+require File.dirname(__FILE__) + '/utils'
+require File.dirname(__FILE__) + '/insertion'
+
+module Splat
+
+  autoload :Initializer, File.dirname(__FILE__) + '/initializer'
+
+  class Gateway
+
+    include Insertion
+    include Utils
+
+    @@vendor_implementations = {}
+    @@configuration = nil
+
+    attr_reader :vendor
+
+    def initialize
+      @vendor = self.class.name.downcase.split("::").last if self.class != Gateway
+    end
+
+    def self.inherited(subclass)
+      @@vendor_implementations[subclass.name.downcase.split("::").last] = subclass
+    end
+
+    def self.[](name)
+      @@vendor_implementations[name.to_s]
+    end
+
+    def self.default_configuration
+      Configuration.instance.vendor
+    end
+
+    def configuration
+      Configuration.instance.vendor(@vendor)
+    end
+
+    def config_option(option)
+       Configuration.instance.vendor(@vendor)[option.to_s]
+    end
+
+    # Send an SMS.
+    # message:: The message. This will be automatically sanitized
+    #           and url-encoded.
+    # number::  The number in Config::Splat.default_number_format
+    # options:: The various options specified configure_options
+    #
+    # Return Values
+    # Success:: Return the id if the message was sent to the gateway.
+    #           This not imply that the messages were delivered.
+    # Failure:: Raise SplatGatewayError on failure with the relevant
+    #           error message and error code.
+    #
+    # Example:
+    # message => "Hello Smith, welcome to splat" 
+    # number => '+91 9812345678'
+    #
+    # This returns and id, for which you can track the status.
+    def send_sms(message, number, options = {})
+      raise SplatGatewayImplError.new("Implement send_sms(message, number, options = {}) method in #{self.class}")
+    end
+
+    # Send bulk SMS
+    # message:: The message. This will be automatically sanitized
+    #           and url-encoded. This message can contain string
+    #           insertions.
+    # number::  Array of numbers in the Config::Splat.default_number_format
+    # options:: The various options specified configure_options
+    # 
+    # In case the numbers do not match with string insertions, the
+    # default_insertion will be used. If use_default_insertion is
+    # set to false, then those numbers will be skipped.
+    # 
+    # Return Values
+    # Success:: Return the id if the message was sent to the gateway.
+    #           This not imply that the messages were delivered.
+    # Failure:: Raise SplatGatewayError on failure with the relevant
+    #           error message and error code.
+    #
+    # Example:
+    # message => "Hello $1, hold on to your $2"
+    # numbers => [ '+91 9812345678', '+1 4034832933', '+44 123783218']
+    # options => 
+    #    :insertions => { 1 => [ 'Smith', 'John Doe', 'Jane'],
+    #                     2 => [ 'stocks', 'socks', 'skirt']
+    #                   },
+    #    :default_insertion => { 1 => 'User', 2 => '' }
+    # REVIEW:
+    #    :insertions => { '+91 981234565' => [ 'Smith', 'stocks'],
+    #                     '+1 4034832933' => ['John Doe', 'socks'],
+    #                     '+44 123783218' => ['Jane', 'skirt']
+    #                     '+44 122342418' => ['Jane' ]
+    #    :default_insertion => { 1 => 'User', 2 => '' }
+    #    }
+    def send_bulk_sms(message, numbers, options = {})
+      raise  SplatGatewayImplError.new("Implement send_bulk_sms(message, numbers, options = {}) in #{self.class}")
+    end
+
+    def send_bulk_sms_with_insertion(message, insertions ={}, options = {})
+      raise  SplatGatewayImplError.new("Implement send_bulk_sms_with_insertion(message, insertions ={}, options = {}) in #{self.class}")
+    end
+
+    def required_config(options = [])
+        options.each do |option|
+          raise SplatError.new("'#{option}' not define for '#{@vendor}' in config file") if self.configuration[option.to_s].blank? 
+        end
+    end
+
+  end
+
+  unless Splat.included_modules.include?(Splat::Initializer)
+    include  Initializer
+  end
+
+end

data/lib/splat/initializer.rb

@@ -0,0 +1,13 @@
+module Splat
+
+  module Initializer
+
+    Dir[File.dirname(__FILE__) + '/vendors/**/*_gateway.rb'].each do |file|
+      require file
+      #vendor_implemetation = File.basename(file, '.rb').camelize
+      #autoload vendor_implemetation, file
+    end
+
+  end
+
+end

data/lib/splat/insertion.rb

@@ -0,0 +1,17 @@
+module Splat
+
+  module Insertion
+
+    def insert_values(message,insertions = {}, default_insertions = {})
+      number_messsage_map = {}
+
+      insertions.each do |key, value|
+        i = -1
+        insertions[key] = message.gsub(/\$\d/) {|match| value[i += 1] }
+      end
+      insertions
+    end
+
+  end
+
+end

data/lib/splat/request.rb

@@ -0,0 +1,32 @@
+module Splat
+
+  class Request
+
+    SINGLE         = 0
+    BULK           = 1
+    BULK_INSERTION = 2
+
+    INVALID_NUMBER_FORMAT = "Invalid phone number format"
+
+    attr_accessor :type
+    attr_accessor :message
+    attr_accessor :numbers
+    attr_accessor :options
+
+    def sms(message, number, options = {})
+        @type, @message, @numbers, @options = SINGLE, message, number, options
+    end
+
+
+    def bulk_sms(message, numbers, options = {}))
+      @type, @message, @numbers, @options = BULK, message, numbers, options
+    end
+
+    def bulk_sms_with_insertion(message, numbers, options = {}))
+      @type, @message, @numbers, @options = BULK_INSERTION, message, numbers, options
+    end
+
+
+  end
+
+end

data/lib/splat/response.rb

@@ -0,0 +1,29 @@
+module Splat
+
+  class Response
+
+    INVALID_NUMBER_FORMAT = "Invalid phone number format"
+    SUCCESSFUL = 'Message sent successfully'
+    FAIL = "Fail to send message"
+
+    attr_accessor :phone_numbers, :message
+
+    def initialize
+      @phone_numbers = {}
+    end
+
+    def invalid_phone_format(number)
+      @phone_numbers[number] = INVALID_NUMBER_FORMAT 
+    end
+
+    def add(number, message)
+      @phone_numbers[number] = message 
+    end
+
+    def invalid_phone_numbers
+      @phone_numbers.keys
+    end
+
+  end
+
+end

data/lib/splat/utils.rb

@@ -0,0 +1,9 @@
+module Splat
+  module Utils
+
+    def url_escape(data)
+      URI.escape(data, Regexp.new("[^#{URI::PATTERN::UNRESERVED}]"))
+    end
+
+  end
+end

data/lib/splat/validator.rb

@@ -0,0 +1,14 @@
+module Spalt
+
+  module Validator
+
+    def valid_phone?(number)
+      number.to_s =~ number_format_regx
+    end
+
+    def valid_phones?(numbers)
+    end
+
+  end
+
+end

data/lib/splat/vendors/bulksmspune/bulksmspune_gateway.rb

@@ -0,0 +1,51 @@
+
+require 'net/http'
+
+module Splat
+
+  class Bulksmspune <  Gateway
+
+    def initialize()
+      super
+      self.required_config([:provider_url, :username, :password, :senderid])
+      @url = "#{self.config_option(:provider_url)}?user=#{self.config_option(:username)}&pwd=#{self.config_option(:password)}&senderid=#{self.config_option(:senderid)}"
+
+      #if options[:callbacks]
+      #   before_send = options[:callback][:before_send]
+      #end
+    end
+ 
+    def send_sms(message, number, options = {})
+       options[:response].message =  call_service(message, parse_number(number))
+       options[:response]
+    end
+
+    def send_bulk_sms(message, numbers, options = {})
+      numbers = numbers.collect{ |x| parse_number(x) }.join(',')
+      options[:response].message = call_service(message, numbers)
+      options[:response]
+    end
+
+    def send_bulk_sms_with_insertion(message, insertions = {}, options = {})
+      
+      number_message_map  = insert_values(message, insertions)
+      number_message_map.each do |number, message|
+         options[:response].add(number, call_service(message, parse_number(number)))
+      end
+      options[:response]
+    end
+
+    private 
+
+    def call_service(message, number)
+      url = "#{@url}&mobileno=#{number}&msgtext=#{url_escape(message)}&priority=High"
+      Net::HTTP.get URI.parse(url)
+    end
+
+    def parse_number(number)
+      number.split(' ').last
+    end
+
+  end
+
+end

data/lib/splat/vendors/clickatell/clickatell_gateway.rb

@@ -0,0 +1,119 @@
+
+module Splat
+
+  class Clickatell <  Gateway
+
+    PARSE_REGEX = /[A-Za-z0-9]+:.*?(?:(?=[A-Za-z0-9]+:)|$)/
+
+    def initialize()
+      super
+      self.required_config([:provider_url, :api_key, :username, :password])
+      @url      = self.config_option(:provider_url)
+      @api_key  = self.config_option(:api_key)
+      @username = self.config_option(:username)
+      @password = self.config_option(:password)
+
+      @last_call_time = Time.now - 30*60
+      @session_id = nil
+    end
+ 
+    def send_sms(message, number, options = {})
+      options[:response].add(number, parse_response(call_service(message, parse_number(number))))
+      options[:response]
+    end
+
+    def send_bulk_sms(message, numbers, options = {})
+      numbers = numbers.collect{ |x| parse_number(x) }.join(',')
+      response = parse_response(call_batch_service(message, numbers))
+      response.each do |result|
+        options[:response].add(result[1].split(': ').last, result[0])
+      end
+      options[:response]
+    end
+
+    def send_bulk_sms_with_insertion(message, insertions = {}, options = {})
+      call_batch_service_with_insertion(message, insertions, options[:response])
+    end
+
+    private 
+
+    def get_session_id
+        if (Time.now - @last_call_time) > 800
+          response = http_get("#{@url}/http/auth?api_id=#{@api_key}&user=#{@username}&password=#{@password}").split(": ")
+          
+          unless response[0] == 'OK'
+            raise SplatGatewayError.new('Cliclatell :' + response[1])
+          end
+
+          @session_id = response[1]
+        end
+        @last_call_time = Time.now
+        @session_id
+    end
+
+    def get_batch_id(message)
+      i = 0
+      message = message.gsub(/\$\d/) {|match| "#field#{i += 1}#" }
+      response = http_get("#{@url}/http_batch/startbatch?session_id=#{get_session_id}&template=#{url_escape(message)}").split(': ')
+
+      unless response[0] == 'ID'
+        raise SplatGatewayError.new('Cliclatell :' + response[1])
+      end
+      response[1]
+    end
+
+    def call_service(message, numbers)
+      http_get "#{@url}/http/sendmsg?session_id=#{get_session_id}&to=#{numbers}&text=#{url_escape(message)}"
+      #response = http_get "#{@url}/http/sendmsg?user=#{@username}&password=#{@password}&api_id=#{@api_key}&to=#{numbers}&text=#{url_escape(message)}"
+    end
+    
+
+    def call_batch_service(message, numbers)
+       batch_id = get_batch_id(message)
+       response = http_get "#{@url}/http_batch/quicksend?session_id=#{get_session_id}&batch_id=#{batch_id}&to=#{numbers}"
+       end_batch(batch_id)
+       response
+    end
+
+    def call_batch_service_with_insertion(message, insertions, response)
+       batch_id = get_batch_id(message)
+
+       url = "#{@url}/http_batch/senditem?session_id=#{get_session_id}&batch_id=#{batch_id}"
+
+       insertions.each do |number,fields|
+         i = 0
+         fields = fields.collect do |field|
+                   "field#{i += 1}=#{field}" 
+                  end
+         response.add(number , http_get("#{url}&to=#{parse_number(number)}&#{fields.join('&')}")) 
+       end
+       end_batch(batch_id)
+       response
+    end
+
+    def end_batch(batch_id)
+      http_get "#{@url}/http_batch/endbatch?session_id=#{get_session_id}&batch_id=#{batch_id}"
+    end
+
+    def http_get(url)
+      response = Net::HTTP.get URI.parse(url)               
+      response
+    end
+
+    def parse_number(number)
+      number.tr('+ ', '')
+    end
+
+    def parse_response(http_response)
+      if http_response.scan(/ERR/).any?
+        return http_response
+      end
+      results = http_response.split("\n").map do |line|
+      response_fields = line.scan(PARSE_REGEX)
+      end
+      results.length == 1 ? results.first : results
+    end
+
+  end
+
+end

data/lib/splat/vendors/vmobo/vmobo_gateway.rb

@@ -0,0 +1,108 @@
+
+require 'net/http'
+require  File.dirname(__FILE__) + '/xml/schema'
+
+module Splat
+
+  class Vmobo <  Gateway
+    include VmoboSchema
+
+     SUCCESSFUL = "200"
+     BAD_REQUEST = "400"
+     FORBIDDEN   = "403"
+     SERVICE_UNAVAILABLE = "503"
+     INTERNAL_ERROR = "500"
+
+     SUPPORTED_COUNTRY_CODES = ['+91']
+
+    def initialize()
+      super
+      self.required_config([:provider_url, :username, :api_key, :keyword])
+      @url = URI.parse(self.config_option(:provider_url))
+      @username = self.config_option(:username)
+      @api_key  = self.config_option(:api_key)
+      @keyword  = self.config_option(:keyword)
+      @custom_message = SOAP::SOAPRawString.new("<%= custom_message %>")
+    end
+
+    def supported_country_code
+      SUPPORTED_COUNTRY_CODE
+    end
+ 
+    def send_sms(message, number, options = {})
+       call_service make_request(message, [number]), options[:response]
+    end
+
+    def send_bulk_sms(message, numbers, options = {})
+      call_service make_request(message, numbers), options[:response]
+    end
+
+    def send_bulk_sms_with_insertion(message, insertions = {}, options = {})
+       call_service make_request_with_insertion(insert_values(message, insertions)), options[:response]
+    end
+
+    private 
+
+    def call_service(request, response = Response.new)
+      request_xml = XSD::Mapping.obj2xml(request, 'request')
+      http_response = Net::HTTP.post_form(@url, {'xml_request' => request_xml})
+
+      case http_response.code
+      when SUCCESSFUL
+           response = parse_response(http_response.body, response)
+      when BAD_REQUEST
+           response.message = 'Bad Request'
+      when FORBIDDEN
+           response.message = 'Forbidden. You do not have permission to access this resource.'
+      when SERVICE_UNAVAILABLE
+           response.message = 'Service unavailable. An internal problem prevented us from returning data to you.'
+      when INTERNAL_ERROR
+           response.message = 'Internal error.'
+      end
+      response
+    end
+
+    def make_request(message, numbers)
+      recipients = Recipients.new()
+      numbers.each do |number|
+         recipients << Recipient.new(parse_number(number))   
+      end
+
+      Request.new(@username, @api_key, message, @keyword, recipients)
+    end
+
+    def make_request_with_insertion(number_message_map)
+      recipients = Recipients.new()
+      number_message_map.each do |number, message|
+        recipients << Recipient.new(parse_number(number), Attributes.new(message))
+      end
+       Request.new(@username, @api_key, @custom_message, @keyword, recipients)
+    end
+
+    def parse_response(response_xml, response)
+      res_obj = XSD::Mapping.xml2obj(response_xml)
+      recipients = res_obj.successful_recipients.recipient
+      if recipients.instance_of? Array
+         recipients.each do |recipient|
+           response.add(recipient.xmlattr_phone_number, Response::SUCCESSFUL)
+         end
+      else 
+        response.add(recipients.xmlattr_phone_number, Response::SUCCESSFUL)
+      end
+      #For failed recipients
+       if res_obj.failed_recipients.instance_of? String
+          failed_recipients = res_obj.failed_recipients.split(',')
+          failed_recipients.each do |recipient|
+            response.add(recipient, Response::FAIL)
+          end
+       end
+       response
+    end
+
+    def parse_number(number)
+        number.split(' ').last
+    end
+
+  end
+
+end

data/lib/splat/vendors/vmobo/xml/schema/vmobo.xsd

@@ -0,0 +1,32 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
+  <xs:complexType name="attributes">
+     <xs:sequence>
+      <xs:element name="custom_message" type="xs:string"/>
+     </xs:sequence>
+  </xs:complexType>
+
+  <xs:complexType name="recipient">
+     <xs:sequence>
+	<xs:element name="phone_number" type="xs:string"/>
+	<xs:element name="attributes" type="attributes"/>
+     </xs:sequence>
+  </xs:complexType>
+
+  <xs:complexType name="recipients">
+     <xs:sequence>
+      <xs:element name="recipient" type="recipient" maxOccurs="unbounded"/>
+     </xs:sequence>
+  </xs:complexType>
+
+  <xs:complexType name="request">
+     <xs:sequence>
+	<xs:element name="user" type="xs:string"/>
+	<xs:element name="app_id" type="xs:string"/>
+	<xs:element name="message" type="xs:string"/>
+	<xs:element name="keyword" type="xs:string"/>
+	<xs:element name="recipients" type="recipients" />
+     </xs:sequence>
+  </xs:complexType>
+
+</xs:schema>

data/lib/splat/vendors/vmobo/xml/schema.rb

@@ -0,0 +1,60 @@
+require 'xsd/qname'
+require "xsd/mapping"
+
+module VmoboSchema
+  # {}attributes
+  class Attributes
+    @@schema_type = "attributes"
+    @@schema_ns = nil
+    @@schema_element = [["custom_message", "SOAP::SOAPString"]]
+
+    attr_accessor :custom_message
+
+    def initialize(custom_message = nil)
+      @custom_message = custom_message
+    end
+  end
+
+  # {}recipient
+  class Recipient
+    @@schema_type = "recipient"
+    @@schema_ns = nil
+    @@schema_element = [["phone_number", "SOAP::SOAPString"], ["attributes", "Attributes"]]
+
+    attr_accessor :phone_number
+    attr_accessor :attributes
+
+    def initialize(phone_number = nil, attributes = nil)
+      @phone_number = phone_number
+      @attributes = attributes
+    end
+  end
+
+  # {}recipients
+  class Recipients < ::Array
+    @@schema_type = "recipient"
+    @@schema_ns = nil
+    @@schema_element = [["recipient", ["Recipient[]", XSD::QName.new(nil, "recipient")]]]
+  end
+
+  # {}request
+  class Request
+    @@schema_type = "request"
+    @@schema_ns = nil
+    @@schema_element = [["user", "SOAP::SOAPString"], ["app_id", "SOAP::SOAPString"], ["message", "SOAP::SOAPString"], ["keyword", "SOAP::SOAPString"], ["recipients", "Recipients"]]
+
+    attr_accessor :user
+    attr_accessor :app_id
+    attr_accessor :message
+    attr_accessor :keyword
+    attr_accessor :recipients
+
+    def initialize(user = nil, app_id = nil, message = nil, keyword = nil, recipients = nil)
+      @user = user
+      @app_id = app_id
+      @message = message
+      @keyword = keyword
+      @recipients = recipients
+    end
+  end
+end

data/lib/splat.rb

@@ -0,0 +1,89 @@
+
+$:.unshift File.dirname(__FILE__)
+
+require 'active_support'
+require  File.dirname(__FILE__) + '/splat/gateway'
+require  File.dirname(__FILE__) + '/splat/error'
+require  File.dirname(__FILE__) + '/splat/response'
+
+
+module Splat
+
+  class Base
+
+    @@gateways = {}
+    @vendor = nil
+    attr_reader :number_format_regx
+
+    def initialize(vendor_name)
+      self.vendor = vendor_name
+
+      if number_format = Gateway.default_configuration['number_format']
+        @number_format_regx =  Regexp.new(number_format)
+      else
+        raise SplatError.new("default:  number_format not define in splat.yml") unless number_format
+      end
+
+    end
+
+    def send_sms(message, number, options = {})
+      options[:response] = Response.new
+      unless validate_phone?(number)
+        return options[:response].invalid_phone_format(number)
+      end
+      get_vender_object(vendor).send_sms(message, number, options) 
+    end
+
+    def send_bulk_sms(message, numbers = [], options = {})
+       options[:response] = validate_phones(numbers)    
+       get_vender_object(vendor).send_bulk_sms(message, numbers - options[:response].invalid_phone_numbers, options)
+    end
+
+    def send_bulk_sms_with_insertion(message, insertions ={}, options = {})
+       options[:response] = validate_phones(insertions.keys)    
+
+       insertions.delete_if do |key, value|
+         !options[:response].phone_numbers[key].nil?
+       end
+
+       get_vender_object(vendor).send_bulk_sms_with_insertion(message, insertions, options)
+    end
+
+    def vendor
+      raise SplatError.new('Vendor is nil.Set vendor name.') unless @vendor
+      @vendor
+    end
+
+    private 
+
+    def vendor=(vendor_name)
+      raise SplatNoGatewaySupportError.new("#{vendor_name} not supported") unless get_vender_object(vendor_name) 
+      @vendor = vendor_name
+    end
+
+    def get_vender_object(name)
+      unless @@gateways[name.to_s]
+        @@gateways[name.to_s] = Gateway[name].new if Gateway[name]
+      end
+      @@gateways[name.to_s]
+    end
+
+    def validate_phone?(number)
+      number.to_s =~ number_format_regx
+    end
+
+    def validate_phones(numbers)
+      response = Response.new
+      numbers.each do |number|
+        response.invalid_phone_format(number) unless validate_phone?(number)
+      end
+      response
+    end
+
+  end
+
+end
+
+
+
+

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'splat'
+
+class Test::Unit::TestCase
+end

data/test/test_splat.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestSplat < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

data/test.rb

@@ -0,0 +1,44 @@
+
+require 'rubygems'
+require 'lib/splat'
+
+number = '+91 9850888082'
+
+gateways = {}
+#gateways['bulksms'] = Splat::Base.new(:bulksmspune)
+#gateways['vmobo'] = Splat::Base.new(:vmobo)
+gateways['clickatell'] = Splat::Base.new(:clickatell)
+
+
+=begin
+#number = '+1 5599726538'
+number = '+91 9881395656'
+msg = "Testing for splat"
+gateways.each do |provider, obj|
+  p "Sending SMS via #{provider}"
+  p obj.send_sms(msg, number)
+  p "SMS Sent successfully via #{provider}"
+end
+p "========================"
+
+msg = "Testing for splat"
+numbers = ['+91 9960054954', '+91 9850888082']
+gateways.each do |provider, obj|
+  p obj.send_bulk_sms(msg, numbers) 
+  p "Bulk Send successfully via #{provider}"
+end
+p "========================"
+
+=end
+custom_msg = "Hi $1, hold on to your $2."
+options = {'+91 9960054954' => ['Sagar', 'coffee'],
+           '+91 9850888082' => ['Gautam' , 'stocks']}
+           #'+91 9880397111' => ['Jane' , 'skirt']}
+
+gateways.each do |provider, obj|
+  p obj.send_bulk_sms_with_insertion(custom_msg, options)
+  p "Bulk Send successfully via #{provider}"
+end
+
+
+

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification 
+name: josh-splat
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 2
+  version: 0.0.2
+platform: ruby
+authors: 
+- Gautam Rege
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-07-13 00:00:00 +05:30
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+description: "\n    SPlat is an integration platform to make use of SMS integration really easy. Using this platform has the following advantages:<br/>\n\n      <br/>\n      * Single point of integration <br/>\n      * Change vendors without changing code. <br/>\n      * Send and receive SMS. <br/>\n      * Generic Exception Handling. <br/>\n      * Standardized reports. <br/>\n      * SMS tagged user groups. <br/>\n      * SMS bogus gateway for testing. <br/>\n      * Scheduling SMS for delivery. <br/>\n  "
+email: info@joshsoftware.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- test/helper.rb
+- test/test_splat.rb
+- generators/splat_config/splat_generator.rb
+- generators/splat_config/templates/splat.yml
+- generators/splat_config/templates/vendors.yml
+- init.rb
+- lib/splat/configuration.rb
+- lib/splat/error.rb
+- lib/splat/gateway.rb
+- lib/splat/initializer.rb
+- lib/splat/insertion.rb
+- lib/splat/request.rb
+- lib/splat/response.rb
+- lib/splat/utils.rb
+- lib/splat/validator.rb
+- lib/splat/vendors/bulksmspune/bulksmspune_gateway.rb
+- lib/splat/vendors/clickatell/clickatell_gateway.rb
+- lib/splat/vendors/vmobo/vmobo_gateway.rb
+- lib/splat/vendors/vmobo/xml/schema/vmobo.xsd
+- lib/splat/vendors/vmobo/xml/schema.rb
+- lib/splat.rb
+- test.rb
+has_rdoc: true
+homepage: http://github.com/gautamrege/splat
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: SPlat is an integration platform to make use of SMS integration really easy
+test_files: 
+- test/helper.rb
+- test/test_splat.rb