nofxx-activesms 0.9.0

data/lib/activesms/connection_adapters/bulk_sms_adapter.rb

@@ -0,0 +1,67 @@
+require 'activesms/connection_adapters/abstract_adapter'
+
+module ActiveSms
+  class Base
+    def self.bulk_sms_connection(config) #:nodoc:
+      return ConnectionAdapters::BulkSmsAdapter.new(logger, config)
+    end
+  end
+  
+  module ConnectionAdapters
+    class BulkSmsAdapter < AbstractAdapter
+      
+      SERVICE_HOSTS = {
+        :international => 'bulksms.vsms.net',
+        :safrica       => 'bulksms.2way.co.za',
+        :spoin         => 'bulksms.com.es',
+        :uk            => 'www.bulksms.co.uk',
+        :usa           => 'usa.bulksms.com'
+      }
+      SERVICE_PORT = 5567
+      SERVICE_PATH = '/eapi/submission/send_sms/2/2.0'
+      
+      STATUS_MESSAGES = {
+         0 => 'in progress',
+         1 => 'scheduled',
+        22 => 'internal fatal error',
+        23 => 'authentication failure',
+        24 => 'data validation failed',
+        25 => 'insufficient credits',
+        26 => 'upstream credits not available',
+        27 => 'daily quota exceeded',
+        28 => 'upstream quota exceeded',
+        40 => 'temporarily unavailable'
+      }
+      
+      # Create an adapter for the BulkSMS gateway.
+      #
+      # Options:
+      # * <tt>:region</tt>
+      # * <tt>:username</tt>
+      # * <tt>:password</tt>
+      def initialize(logger = nil, config = {})
+        super(logger)
+        @config = config.dup
+        
+        host = SERVICE_HOSTS[config[:region]] || SERVICE_HOSTS[:uk]
+        @service_url = "http://#{host}:#{SERVICE_PORT}#{SERVICE_PATH}"
+      end
+      
+      # Return the human readable name of the connection adapter name.
+      def adapter_name
+        return 'BulkSMS'
+      end
+      
+      def deliver(sms)
+        params = {
+          :username => @config[:username],
+          :password => @config[:password],
+          :msisdn   => sms.recipients,
+          :message  => sms.body,
+        }
+        send_http_request(@service_url, params)
+      end
+      
+    end
+  end
+end

data/lib/activesms/connection_adapters/clickatell_adapter.rb

@@ -0,0 +1,51 @@
+require 'activesms/connection_adapters/abstract_adapter'
+
+module ActiveSms
+  class Base
+    def self.clickatell_connection(config) #:nodoc:
+      return ConnectionAdapters::ClickatellAdapter.new(logger, config)
+    end
+  end
+  
+  module ConnectionAdapters
+    class ClickatellAdapter < AbstractAdapter
+
+      SERVICE_HOST = "api.clickatell.com"
+      SERVICE_PATH = "/http/sendmsg"
+      
+      # Create an adapter for the Clickatell gateway.
+      #
+      # Options:
+      #
+      # * <tt>:user</tt>
+      # * <tt>:password</tt>
+      # * <tt>:api_id</tt>
+      # * <tt>use_ssl</tt>
+      def initialize(logger = nil, config = {})
+        super(logger)
+        @config = config.dup
+        
+        scheme = config[:use_ssl] ? "https" : "http"
+        @service_url = "#{scheme}://#{SERVICE_HOST}#{SERVICE_PATH}"
+      end
+      
+      # Return the human readable name of the gateway adapter name.
+      def adapter_name
+        return 'Clickatell'
+      end
+      
+      def deliver(sms)
+        params = {
+          :user     => @config[:user],
+          :password => @config[:password],
+          :api_id   => @config[:api_id],
+          :to       => sms.recipients,
+          :from     => sms.from,
+          :text     => sms.body
+        }
+        send_http_request(@service_url, params)
+      end
+    end
+    
+  end
+end

data/lib/activesms/connection_adapters/human_adapter.rb

@@ -0,0 +1,174 @@
+# #
+# Human Gateway Adapter (www.human.com.br)
+# 
+# Original code: Cassio Marques
+# Merge with activesms: Marcos Piccinini
+#
+# 07/2008
+#  
+# Configuracao para envio de mensagens SMS, de acordo com 
+# especificacoes no Manual de Integracao ao Human Gateway
+require 'activesms/connection_adapters/abstract_adapter'
+
+module ActiveSms
+  class Base
+    def self.human_connection(config) #:nodoc:
+      return ConnectionAdapters::HumanAdapter.new(logger, config)
+    end
+  end
+  
+  module ConnectionAdapters
+    class HumanAdapter < AbstractAdapter
+      attr_reader :service_url
+    
+      # As Human specification on 2008
+      SERVICE_HOST = "system.human.com.br"
+      SERVICE_PATH = "GatewayIntegration/msgSms.do" 
+      SERVICE_PORT = "8080"                           
+      # Service options
+      SERVICE_TYPE = 'E'                              
+      SERVICE_DISPATCH = 'send' 
+      #  callbackOption: 1   
+      
+      # Create an adapter for the Human gateway.
+      #
+      # Options:
+      #
+      # * <tt>:account</tt>
+      # * <tt>:code</tt>
+      # * <tt>use_ssl (human does not support this as July/2008)</tt> 
+      def initialize(logger = nil, config = {})    
+        super(logger)
+        @config = config.dup
+ 
+        human_scheme = config[:use_ssl] ? 'https' : 'http'
+        @service_url = "#{human_scheme}://#{SERVICE_HOST}:#{SERVICE_PORT}/#{SERVICE_PATH}"
+      end 
+      
+      # Return the human readable name of the gateway adapter name.
+      def adapter_name
+        return 'Human'
+      end
+      
+      # Formats the data object to what human gateway expects
+      def date_format_human(date)      
+        date = Time.parse(date, Time.now.utc) unless date.respond_to?('strftime') 
+        date.strftime("%d/%m/%Y %H:%M:%S")
+      end 
+        
+      # Deliver the message!
+      # :id => Reference to the message on human servers.j
+      #  so we can check status later
+      # :schedule =>  expects a Date/Timestamp object
+      #  if date is on the past message is immeditaly sent
+      def deliver(sms)
+        params = {                 
+          :dispatch => SERVICE_DISPATCH,
+          :type     => SERVICE_TYPE,
+          :account  => @config[:account],
+          :code     => @config[:code],
+          :to       => sms.recipients,
+          :from     => sms.from || @config[:from],
+          :msg      => sms.body,      
+          :id       => sms.id,
+        }                      
+        # Human supports scheduling
+        # if we got some date, share with em!
+        params[:schedule] = date_format_human(sms.schedule) if sms.schedule 
+        # Send it!
+        send_http_request(@service_url, params)
+      end                 
+    end    
+  end
+end                 
+
+# def initialize(logger = nil, config = {})    
+#   super(logger)
+#   @config = config.dup
+# 
+#   human_scheme = config[:use_ssl] ? 'https' : 'http'
+#   @service_url = "#{human_scheme}://#{SERVICE_HOST}:#{SERVICE_PORT}/#{SERVICE_PATH}"
+#   #raise_not_configured_exception unless @@config && !@@config.empty?
+#   #@messages = []
+#   #@results = {}  
+#   #@total_sent = 0
+# end          
+            #attr_reader :total_sent  
+  # Define as configuracoes que serao utilizadas para realizar o envio
+  # das mensagens.
+  # #
+  #  # Recebe um hash com os valores a configurar.
+  #  def SmsSender.configure(config)        
+  #    @@config = config unless !@@config.nil?    
+  #  end
+  #  
+  #  # Exibe as configuracoes de envio atuais
+  #  def self.show_configuration
+  #    raise_not_configured_exception unless @@config
+  #    puts @@config.inspect
+  #  end
+  #  
+  #  # Adiciona um item na lista de mensagens a serem enviadas
+  #  def add_message(message)
+  #    unless message.kind_of? Sms 
+  #      raise ArgumentError, 
+  #            "Eu esperava receber um objeto da classe Sms, mas voce me enviou um #{message.class}",
+  #            caller
+  #    end
+  #    @messages << message
+  #  end
+  #  
+  #  # Realiza o envio de todas as mensagens.
+  #  # 
+  #  # Salva no banco o status de cada SMS
+  #  # apos a tentativa de envio.
+  #  #
+  #  # Retorna um hash com o id e o status de envio
+  #  # de cada mensagem.
+  #  def send_all    
+  #    @messages.each do |m|
+  #      resp = run_request(m)
+  #      m.status = SmsStatus.find(resp.slice(/\d{3}/))
+  #      if block_given?
+  #        yield m
+  #      end
+  #      m.save
+  #    end    
+  #  end
+  #  
+  #  # Limpa a lista de mensagens a serem enviadas
+  #  def clear_list
+  #    @messages.clear    
+  #  end
+  #  
+  #  private   
+  #  # Lanca uma excecao indicando que esse sender nao foi devidamente
+  #  # configurado antes de ser utilizado.
+  #  def self.raise_not_configured_exception # :doc:
+  #    raise RuntimeError, "Parametros para configuracao nao informados", caller
+  #  end  
+  #  
+  #  # Cria o header da requisicao (para envio de mensagens individuais)
+  #  def create_request_header(message) # :doc:
+  #    "dispatch=#{ERB::Util.url_encode(@@config['dispatch'])}"+
+  #    "&account=#{ERB::Util.url_encode(@@config['account'])}"+
+  #    "&code=#{ERB::Util.url_encode(@@config['password'])}"+
+  #    "&msg=#{ERB::Util.url_encode(message.message_text)}"+
+  #    "&from=#{ERB::Util.url_encode(@@config['from'])}"+
+  #    "&to=#{ERB::Util.url_encode(message.doador.celular.full_number)}"+
+  #    "&id=#{ERB::Util.url_encode(message.id)}"+
+  #    "&schedule=#{ERB::Util.url_encode(message.agendado_para)}"
+  #  end
+  #    
+  #  # Executa o request HTTP POST para envio da mensagem SMS
+  #  def run_request(message) # :doc:    
+  #    http = Net::HTTP.new(@@config['base_url'], @@config['port'])
+  #    headers = {
+  #      'Referer' => 'http://'+@@config['base_url']+@@config['path']      
+  #    }    
+  #    resp = http.post2(@@config['path'], create_request_header(message), headers)
+  #    @total_sent += 1
+  #    resp.body    
+  #  end
+  #              
+# end

data/lib/activesms/connection_adapters/simplewire_adapter.rb

@@ -0,0 +1,73 @@
+require 'activesms/connection_adapters/abstract_adapter'
+require 'ostruct'
+
+begin
+  require 'java'
+  include_class 'com.simplewire.sms.SMS'
+rescue LoadError
+  puts "JRuby is required for the simplewire adapter"
+  raise $!
+end
+
+module ActiveSms
+  class Base
+    def self.simplewire_connection(config) #:nodoc:
+      return ConnectionAdapters::SimplewireAdapter.new(logger, config)
+    end
+  end
+  
+  module ConnectionAdapters
+    class SimplewireAdapter < AbstractAdapter
+
+      # Create a simplewire adapter. The config requires subscriber_id and subscriber_password.
+      def initialize(logger = nil, config = {})
+        super(logger)
+        @config = config.dup
+        @config.symbolize_keys!
+        @subscriber_id = @config[:subscriber_id]
+        @subscriber_password = @config[:subscriber_password]
+        @remote_host = @config[:remote_host]
+         
+        if @subscriber_id.nil?
+          raise "subscriber_id is required for simplewire"
+        end
+        if @subscriber_password.nil?
+          raise "subscriber_password is required for simplewire"
+        end
+      end
+      
+      # Return the human readable name of the gateway adapter name.
+      def adapter_name
+        return 'Simplewire'
+      end
+      
+      # Send the sms message using the simplewire adapter
+      def deliver(sms)
+        create_sms(sms).submit()
+      end
+      
+      def parse(xmldata)        
+        sms = SMS.new
+        sms.parse(xmldata)
+        s = OpenStruct.new
+        s.body = sms.msg_text.to_s
+        s.from = sms.source_addr.address.to_s
+        s.to = sms.destination_addr.address.to_s
+        s
+      end
+      
+      # Create the simplewire sms message to send
+      def create_sms(sms) 
+        s = SMS.new
+        s.subscriber_id = @subscriber_id
+        s.subscriber_password = @subscriber_password
+        s.remote_host = @remote_host if @remote_host
+        s.msg_pin = sms.recipients
+        s.setSourceAddr(SMS::ADDR_TYPE_NETWORK, sms.from)
+        s.msg_text = sms.body
+        raise StandardError.new("SMS Body over 140 characters, body = \n#{sms.body}") if sms.body.size > 140
+        s
+      end
+    end
+  end
+end

data/lib/activesms/connections.rb

@@ -0,0 +1,63 @@
+module ActiveSms #:nodoc#
+    
+  class Base
+    @@connection = nil
+    
+    class << self
+      # Returns true if a connection that's accessible to this class has already
+      # been opened.
+      def connected?
+        return !@@connection.nil?
+      end
+          
+      # Returns the connection currently associated with the class.  This can
+      # also be used to "borrow" the connection to do work that is specific to
+      # a particular SMS gateway.
+      def connection
+        raise ConnectionNotEstablished unless @@connection
+        return @@connection
+      end
+      
+      # Set the gateway connection for the class.
+      def connection=(spec) #:nodoc:
+        raise ConnectionNotEstablished unless spec
+        @@connection = spec
+      end
+    
+      # Establishes the connection to the SMS gateway.  Accepts a hash as input
+      # where the :adapter key must be specified with the name of a gateway
+      # adapter (in lower-case)
+      #
+      #   ActiveSms::Base.establish_connection(
+      #     :adapter  => "clickatell",
+      #     :username => "myusername",
+      #     :password => "mypassword"
+      #     :api_id   => "myapiid"
+      #   )
+      #
+      # Also accepts keys as strings (for parsing from YAML, for example).
+      #
+      # The exceptions AdapterNotSpecified, AdapterNotFound, and ArgumentError
+      # may be returned.
+      def establish_connection(config) 
+        config = config.symbolize_keys
+        unless config.key?(:adapter)
+          raise AdapterNotSpecified, "#{config} adapter is not configured"
+        end
+        adapter_method = "#{config[:adapter]}_connection"
+        unless respond_to?(adapter_method)
+          raise AdapterNotFound,
+                "configuration specifies nonexistent #{config[:adapter]} adapter"
+        end
+        self.connection = self.send(adapter_method, config)
+      end
+    end
+    
+    # Returns the connection currently associated with the class.  This can
+    # also be used to "borrow" the connection to do work that is specific to
+    # a particular SMS gateway.
+    def connection
+      self.class.connection
+    end    
+  end
+end

data/lib/activesms/email.rb

@@ -0,0 +1,60 @@
+require 'yaml'
+#require 'activesms/config'
+
+module ActiveSms #:nodoc#   
+  module Email
+    RAILS_CONFIG_ROOT = defined?(RAILS_ROOT) ? "#{RAILS_ROOT}/config" : "#{File.dirname(__FILE__)}/../../generators/sms/templates" unless defined?(RAILS_CONFIG_ROOT)
+    # and load what we have!
+    conf_yml ||= YAML::load(File.open("#{RAILS_CONFIG_ROOT}/sms.yml"))
+    @@carriers ||= conf_yml['carriers']
+    @@from_address ||= conf_yml['config']['from_address']
+
+    def carriers
+      @@carriers.dup
+    end
+    
+    def email_deliver(sms)#number,carrier,message,options={})
+
+      number = sms.recipients
+      carrier = sms.carrier
+      # number = format_number(number)
+
+      #options[:limit] ||= message.length 
+        #options[:from]  ||= @@from_address
+      #message = message[0..options[:limit]-1]
+      sms_email = determine_sms_email(number, carrier)#format_number(number),carrier)
+       
+      Sms2Email.deliver_sms_message(sms_email, sms.body, @@from_address)
+    rescue CarrierException => e
+      raise e
+    end                                                   
+     
+    def get_sms_address(number,carrier)
+      number = format_number(number)
+      determine_sms_email(number,carrier)
+    end    
+
+    private
+
+    def format_number(number)
+      pre_formatted = number.gsub(/\D/,"").strip
+      formatted =  (pre_formatted.length > 11) ? pre_formatted[2..pre_formatted.length] : pre_formatted
+       
+      return is_valid?(formatted) ? formatted : (raise PhoneNumberError.new("Phone number (#{format_number(number)}) is not formatted correctly"))
+    end   
+    
+    def is_valid?(number)
+      return (number.length >= 10 && number[/^.\d+$/]) ? true : false
+    end  
+       
+    def determine_sms_email(phone_number, carrier)
+      carrier = carrier.to_s.downcase     
+
+      if carriers.has_key?(carrier)
+        "#{phone_number}#{carriers[carrier]}"
+      else 
+        raise CarrierException.new("Specified carrier, #{carrier} is not supported.")
+      end
+    end     
+  end   
+end