smshelper 0.4.5 → 0.4.6

data/Gemfile

@@ -1,17 +1,14 @@
 source "http://rubygems.org"
-# Add dependencies required to use your gem here.
-# Example:
-#   gem "activesupport", ">= 2.3.5"
 
-# Add dependencies to develop your gem here.
-# Include everything needed to run rake, tests, features, etc.
 gem 'api_smith'
 gem 'savon'
 gem 'nokogiri'
+
 gem 'textmagic'
 
 gem 'uuid'
 gem 'digest-crc'
+gem 'virtus'
 
 group :development do
   gem "pry"

data/README.md

@@ -0,0 +1,122 @@
+Smshelper
+---------
+
+__THE lib for SMS-MT / HLR-Lookups.__
+
+One day i was asked to connect a crm to correspond in SMS with call
+center customers. Chose at random one of the operators, wrote a few
+lines of code and there it was - SMS inbound/outbound.
+
+> "Some of our messages aren't being delivered on time, some are being
+> lost altogether, some arrive multiple times, some arrive after more
+> then 24 hours from being sent"
+
+> _--Your faithful customer_
+
+I kept adding operators and here are the results...
+
+__Currently supported:__
+
+* __Unicode:__  across all operators
+<table>
+    <tr>
+        <th>Operator</th><th>#send_message</th><th>#get_balance</th><th>#get_status</th><th>#get_callback_response</th><th>#hlr_lookup</th>
+    </tr>
+    <tr>
+        <td>Aql</td><td>X</td><td>X</td><td>_</td><td>X</td><td>_</td>
+    </tr>
+    <tr>
+        <td>Bulksms</td><td>X</td><td>X</td><td>X</td><td>X</td><td>_</td>
+    </tr>
+    <tr>
+        <td>Clickatell</td><td>X</td><td>X</td><td>X</td><td>_</td><td>_</td>
+    </tr>
+    <tr>
+        <td>Esendex</td><td>X</td><td>X</td><td>X</td><td>X</td><td>_</td>
+    </tr>
+    <tr>
+        <td>Mediaburst</td><td>X</td><td>X</td><td>_</td><td>X</td><td>_</td>
+    </tr>
+    <tr>
+        <td>Mycoolsms</td><td>X</td><td>X</td><td>_</td><td>X</td><td>X</td>
+    </tr>
+    <tr>
+        <td>Nexmo</td><td>X</td><td>X</td><td>_</td><td>X</td><td>_</td>
+    </tr>
+    <tr>
+        <td>Routomessaging</td><td>X</td><td>X</td><td>_</td><td>X</td><td>X**</td>
+    </tr>
+    <tr>
+        <td>Smstrade</td><td>X</td><td>X</td><td>_</td><td>X</td><td>_</td>
+    </tr>
+    <tr>
+        <td>Textmagic</td><td>X</td><td>X</td><td>_</td><td>X</td><td>_</td>
+    </tr>
+    <tr>
+        <td>Traitel</td><td>X</td><td>X</td><td>_</td><td>_</td><td>_</td>
+    </tr>
+    <tr>
+        <td>Vianett</td><td>X</td><td>X</td><td>_</td><td>X</td><td>X</td>
+    </tr>
+    <tr>
+        <td>Webtext</td><td>X</td><td>X</td><td>_</td><td>_</td><td>_</td>
+    </tr>
+</table>
+
+<!-- <iframe width='561' height='300' frameborder='0' src='https://docs.google.com/spreadsheet/pub?key=0AvGdwcIrVUI9dDNOUkE5Mlo0VnJEcmJaYlRJRkg1aEE&single=true&gid=0&output=html&widget=true'></iframe> -->
+** _Does_ __NOT__ _provide handset network status, so you can't check if a
+   subscriber is in reception zone with a switched-on handset._
+
+__Installation__
+
+gem install smshelper
+
+__Usage__
+
+```ruby
+require 'smshelper'
+config = Smshelper::Config.new(
+                               :webtext => {:uname => '', :passwd => ''},
+                               :bulksms => {:uname => '', :passwd => ''},
+                               :clickatell => {:api_key => '',:uname => '', :passwd => ''},
+                               :textmagic => {:uname => '', :passwd => ''},
+                               :smstrade => {:api_key => ''},
+                               :esendex => {:uname => '', :passwd => '', :acc => ''},
+                               :mediaburst => {:uname => '', :passwd => ''},
+                               :nexmo => {:uname => '', :passwd => ''}
+                               )
+
+service0 = Smshelper::Api::Bulksms.new config
+service1 = Smshelper::Api::Webtext.new config
+service2 = Smshelper::Api::Clickatell.new config
+service3 = Smshelper::Api::Textmagic.new config
+service4 = Smshelper::Api::Smstrade.new config, :route => 'gold'
+service5 = Smshelper::Api::Esendex.new config, 'com:validityperiod' => '1'
+service6 = Smshelper::Api::MediaBurst.new config
+service7 = Smshelper::Api::Nexmo.new config, :ttl => '60000'
+
+message = Smshelper::Message.new(
+                                 :recipient => '14128765432',
+                                 :text => "The balance on
+                                 #{serviceX.class.name} is
+                                 #{serviceX.get_balance}",
+                                 :sender => '33765432132')
+
+serviceX.send_message message
+
+```
+
+### Is It "Production Ready™"?
+
+Most likely not, there are no tests yet and the API is going
+to change a bit until v1.0.0 release
+
+__TODO:__
+
+* TESTs
+* introduce plugin infrastructure
+* handle sms of any size (_currently smshelper tries to use concat
+  setts, operator permitting_)
+* add support for www.totext.net, www.world-text.com, www.mpulse.eu, www.clicksms.co.uk, www.tellustalk.com, www.tm4b.com, www.txtnation.com, www.smsextrapro.com, www.truesenses.com
+
+### I welcome pull requests!

data/Rakefile

@@ -17,8 +17,8 @@ Jeweler::Tasks.new do |gem|
   gem.name = "smshelper"
   gem.homepage = "http://github.com/voipscout/smshelper"
   gem.license = "MIT"
-  gem.summary = %Q{send sms with: www.bulksms.com, www.webtext.com, www.clickatell.com, www.textmagic.com, www.smstrade.eu, www.esendex.com, www.mediaburst.co.uk, www.nexmo.com, www.vianett.com, www.traitel.com.au, www.my-cool-sms.com, www.aql.com}
-  gem.description = %Q{works www.bulksms.com, www.webtext.com, www.clickatell.com, www.textmagic.com, www.smstrade.eu, www.esendex.com, www.mediaburst.co.uk, www.nexmo.com, www.vianett.com, www.traitel.com.au, www.my-cool-sms.com, www.aql.com}
+  gem.summary = %Q{send sms with 10+ gateways}
+  gem.description = %Q{send sms with multiple gateways, like esendex, bulksms, clickatell etc..}
   gem.email = "voipscout@gmail.com"
   gem.authors = ["Voip Scout"]
   # dependencies defined in Gemfile

data/VERSION

@@ -1 +1 @@
-0.4.5
+0.4.6

data/lib/smshelper/api.rb

@@ -1,26 +1,31 @@
-require 'hashie'
+require 'virtus'
 
 module Smshelper
   module Api
     path = (File.dirname File.expand_path(__FILE__))
-    VERSION = '0.0.1'#File.read('blahblah')
+    VERSION = '0.0.2'#File.read('blahblah')
 
     autoload :Base, "#{path}/api/base"
     autoload :ResponseCodes, "#{path}/api/response_codes"
-    autoload :Webtext, "#{path}/api/webtext"
+
     autoload :Bulksms, "#{path}/api/bulksms"
-    autoload :Clickatell, "#{path}/api/clickatell"
     autoload :Textmagic, "#{path}/api/textmagic"
     autoload :Smstrade, "#{path}/api/smstrade"
     autoload :Esendex, "#{path}/api/esendex"
     autoload :Mediaburst, "#{path}/api/mediaburst"
     autoload :Nexmo, "#{path}/api/nexmo"
-    autoload :Traitel, "#{path}/api/traitel"
-
     autoload :Aql, "#{path}/api/aql"
     autoload :Vianett, "#{path}/api/vianett"
-    autoload :Txtnation, "#{path}/api/txtnation"
-    autoload :Totext, "#{path}/api/totext"
     autoload :Mycoolsms, "#{path}/api/mycoolsms"
+    autoload :Routomessaging, "#{path}/api/routomessaging"
+    # Still no support for get_callback_response
+
+    autoload :Traitel, "#{path}/api/traitel"
+    autoload :Clickatell, "#{path}/api/clickatell"
+    autoload :Webtext, "#{path}/api/webtext"
+    #TODO:
+    #autoload :Txtnation, "#{path}/api/txtnation"
+    #autoload :Totext, "#{path}/api/totext"
+    #autoload :Smswarehouse, "#{path}/api/smswarehouse"
   end
 end

data/lib/smshelper/api/base.rb

@@ -9,9 +9,9 @@ module Smshelper
       def initialize(*args)
         @sent_message_ids, @sent_message_statuses = Array.new, Hash.new
         @response_code = ResponseCodes.new
-        @extra_options = args.shift
+        @extra_options = (args.empty? ? {} : args.shift)
         @uuid = UUID.new
-        class_factory 'DeliveryReport', 'InboundMessage', 'UnknownReply'
+        class_factory 'DeliveryReport', 'InboundMessage', 'UnknownReply', 'HlrReport'
       end
 
       protected
@@ -19,31 +19,52 @@ module Smshelper
         names.each do |name|
           klass = self.class.const_set(name, Class.new)
           klass.class_eval do
-            attr_reader :uuid, :service
+            include Virtus
 
             define_method(:initialize) do |args = {}|
               args.each do |k,v|
+                # Sinatra params has splat, captures
                 unless k.to_s =~ (/splat/ || /captures/)
-                  self.class.send(:define_method, k.to_sym) {v}
-                  instance_variable_set("@"+k.to_s, v)
+                  self.class.attribute(k, v.class, :default => v)
                 end
               end
-              instance_variable_set("@uuid", UUID.generate)
-              instance_variable_set("@service", self.class.name.split('::')[2])
-            end
-
-            #TODO: Find out why is this needed!
-            define_method("_dump".to_sym) do |level|
-              self.to_yaml
-            end
-
-            def self._load(str)
-              YAML.load str
+              self.class.attribute(:uuid, String, :default => UUID.generate)
+              self.class.attribute(:service, String, :default => self.class.name.split('::')[2])
             end
 
           end
         end
       end
-    end
-  end
-end
+
+      # def class_factory(*names)
+      #   names.each do |name|
+      #     klass = self.class.const_set(name, Class.new)
+      #     klass.class_eval do
+      #       attr_reader :uuid, :service
+
+      #       define_method(:initialize) do |args = {}|
+      #         args.each do |k,v|
+      #           unless k.to_s =~ (/splat/ || /captures/)
+      #             self.class.send(:define_method, k.to_sym) {v}
+      #             instance_variable_set("@"+k.to_s, v)
+      #           end
+      #         end
+      #         instance_variable_set("@uuid", UUID.generate)
+      #         instance_variable_set("@service", self.class.name.split('::')[2])
+      #       end
+
+      #       define_method("_dump".to_sym) do |level|
+      #         self.to_yaml
+      #       end
+
+      #       def self._load(str)
+      #         YAML.load str
+      #       end
+
+      #     end
+      #   end
+      # end
+
+    end # class Base
+  end # module Api
+end # module Smshelper

data/lib/smshelper/api/bulksms.rb

@@ -21,7 +21,7 @@ module Smshelper
           :msisdn => message.recipient,
           :message => message.text,
           :sender => message.sender}
-        options = options.merge(@extra_options) unless @extra_options.nil?
+        options.merge!(@extra_options) unless @extra_options.nil?
         resp = (post 'eapi/submission/send_sms/2/2.0', :extra_query => options.merge(q)).split('|')
         process_response_code(resp.first) ? (@sent_message_ids << resp.last.strip; resp.last.strip) : (raise ErrorDuringSend, @response_code.bulksms(resp.first))
       end

data/lib/smshelper/api/mycoolsms.rb

@@ -24,6 +24,10 @@ module Smshelper
         {'EUR' => JSON.parse(post 'api-socket.php', :extra_query => {:function => 'getBalance'})['balance']}
       end
 
+      def get_status
+        raise NotImplementedError, "Sms status checks unsupported by #{self.class.name}"
+      end
+
       def hlr_lookup(number)
         JSON.parse(post 'api-socket.php', :extra_query => {:function => 'doHlrLookup', :number => number})
       end

data/lib/smshelper/api/nexmo.rb

@@ -30,6 +30,7 @@ module Smshelper
       end
 
       def get_status(message_id)
+        raise NotImplementedError, "Sms status checks unsupported by #{self.class.name}"
       end
 
       def get_callback_response(args = {})

data/lib/smshelper/api/response_codes.rb

@@ -174,6 +174,69 @@ module Smshelper
 
       AQL = {}
 
+      ROUTO = {
+        '0' => 'Delivered',
+        '1' => 'Rejected: Message length is invalid',
+        '2' => 'Subscriber absent',
+        '3' => 'Device memory capacity exceeded',
+        '4' => 'Equipment protocol error',
+        '5' => 'Equipment not supported',
+        '6' => 'Equipment not SM equipped',
+        '7' => 'Unknown service centre',
+        '8' => 'Service centre congestion',
+        '9' => 'Undeliverable',
+        '10' => 'Rejected: Invalid source address',
+        '11' => 'Invalid destination address',
+        '12' => 'Illegal subscriber',
+        '13' => 'Teleservice not provisioned',
+        '14' => 'Illegal equipment',
+        '15' => 'Call barred',
+        '16' => 'Facility not supported',
+        '17' => 'Subscriber busy for SM',
+        '18' => 'System failure',
+        '19' => 'Message waiting, list full',
+        '20' => 'Data missing',
+        '21' => 'Unexpected data value',
+        '22' => 'Resource limitation',
+        '23' => 'Initiating release',
+        '24' => 'Unknown alphabet',
+        '25' => 'USSD busy',
+        '26' => 'Duplicated invoke ID',
+        '27' => 'No supported service',
+        '28' => 'Mistyped parameter',
+        '29' => 'Unexpected response from peer',
+        '30' => 'Service completion failure',
+        '31' => 'No response from peer',
+        '32' => 'Invalid response received',
+        '34' => 'Invalid destination',
+        '49' => 'Message type not supported',
+        '50' => 'Destination blocked for sending',
+        '51' => 'Not enough money',
+        '52' => 'No price',
+        '67' => 'Invalid esm_class field data',
+        '69' => 'Rejected by SMSC',
+        '72' => 'Rejected: Invalid source address TON',
+        '73' => 'Rejected: Invalid source address NPI',
+        '80' => 'Rejected: Invalid destination address TON',
+        '81' => 'Rejected: Invalid destination address NPI',
+        '88' => 'Throttling error',
+        '97' => 'Rejected: Invalid scheduled delivery time',
+        '100' => 'Error sending message',
+        '247' => 'Sent',
+        '248' => 'Sent',
+        '249' => 'Rejected',
+        '250' => 'Accepted',
+        '251' => 'Undeliverable',
+        '252' => 'Deleted',
+        '253' => 'Expired',
+        '254' => 'Roaming level not supported',
+        '255' => 'Unknown error'
+      }
+      def routomessaging(code)
+        # Those are delivery callback status codes
+        ROUTO[code]
+      end
+
       def webtext(code)
         WEBTEXT[code]
       end

data/lib/smshelper/api/routomessaging.rb

@@ -1,30 +1,67 @@
 #TODO: different base_uri's for get_balance and send_message
-module SmsTools
-  class Routomessaging < Base
-    base_uri "http://smsc5.routotelecom.com"
+module Smshelper
+  module Api
+    class Routomessaging < Base
 
-    def initialize(*args)
-      @uname, @passwd = args.shift, args.shift
-    end
+      def initialize(*args)
+        config = args.shift
+        @uname, @passwd = config.routomessaging[:uname], config.routomessaging[:passwd]
+        add_request_options! :skip_endpoint => true
+        super
+      end
 
-    #send_message TO, MESSAGE, FROM
-    def send_message(*args)
-      add_query_options! :user => @uname, :pass => @passwd, :type => 'LongSMS'
+      #send_message TO, MESSAGE, FROM
+      def send_message(message)
+        uuid = (Digest::CRC32.hexdigest @uuid.generate).unpack('U*').collect {|x| sprintf '%02X', x}.join
 
-      (post 'SMSsend', :extra_query => {
-         :number => args.shift,
-         :message => args.shift,
-         :ownnum => args.shift})
-    end
+        if message.utf_8
+          message.to_hex_be
+          q = {:type => 'longunicode'}
+        else
+          q = {:type => 'LongSMS'}
+        end
+
+        options = {
+          :number => message.recipient,
+          :message => message.text,
+          :ownnum => message.sender
+        }
+        options.merge!(@extra_options) unless @extra_options.nil?
+        options.merge!(:mess_id => uuid) if options[:delivery]
+        options.merge!(:user => @uname, :pass => @passwd)
+
+        resp = (post 'http://smsc5.routotelecom.com/NewSMSsend', :extra_query => options.merge(q))
+        process_response_code(resp) ? (@sent_message_ids << uuid; uuid) : (raise ErrorDuringSend, 'error response processing not implemented yet')
+      end
 
-    def get_balance
-      # TODO: change base_uri before executing the query
-      # self.base_uri 'http://smsc6.routotelecom.com'
-      add_query_options! :username => @uname, :password => @passwd, :base_uri => 'http://smsc6.routotelecom.com'
+      def get_balance
+        opts = {:username => @uname, :password => @passwd}
+        {'EUR' => (post 'http://smsc6.routotelecom.com/balance.php', :extra_query => opts).gsub("\n", '').to_f.round(4)}
+      end
 
-      (post 'balance.php').to_s.chomp
+      def hlr_lookup(number)
+        opts = {:number => number, :user => @uname, :pass => @passwd}
+        (get 'http://hlr.routotelecom.com', :extra_query => opts)
+      end
+
+      def get_callback_response(args = {})
+          DeliveryReport.new(
+                             :message_id => args['mess_id'],
+                             :timestamp => Time.now,
+                             :delivered => ((args['status'] == '0') ? true : false),
+                             :status => @response_code.routomessaging(args['status']),
+                             :original_params => args
+                             )
+      end
+
+      def get_status
+        raise NotImplementedError, "Sms status checks unsupported by #{self.class.name}"
+      end
+
+      private
+      def process_response_code(code)
+        (code.gsub!("\n", '') == 'success') ? true : false
+      end
     end
   end
 end
-
-#

data/lib/smshelper/api/smswarehouse.rb

@@ -1,22 +1,25 @@
 module Smshelper
   module Api
     class Smswarehouse < Base
-      base_uri "http://websms.smswarehouse.com:7800"
-      endpoint "websms"
+      # base_uri "http://websms.smswarehouse.com:7800"
+      # endpoint "websms"
 
-      def initialize(config)
+      def initialize(*args)
+        config = args.shift
         @uname, @passwd = config.smswarehouse[:uname], config.smswarehouse[:passwd]
+        add_request_options! :skip_endpoint => true
         super
       end
 
       def send_message(message)
 
         if message.utf_8
-          message.to_hex
-          @q = {:type => '0', :esm => '64', :dcs => '8'}
+          message.to_hex_be
+          q = {:type => '0', :esm => '64', :dcs => '8'}
           # raise NotImplementedError, "UTF-8 unsupported by #{self.class.name}"
         else
-          @q = {:type => '5', :esm => '64', :dcs => '0'}
+          #q = {:type => '5', :esm => '64', :dcs => '0'}
+          q = {:type => '1', :esm => '0', :dcs => '0'}
         end
 
         options = {
@@ -26,19 +29,25 @@ module Smshelper
           :text => message.text,
           :sid => message.sender}
 
-        resp = (post "webmsg", :extra_query => @q.merge(options)).split('::').last.strip
+        options.merge!(@extra_options) unless @extra_options.nil?
+
+        url = 'http://websms.smswarehouse.com:7800/websms/webmsg'
+        resp = (post url, :extra_query => q.merge(options)) #.split('::').last.strip
         @sent_message_ids << resp
+        pp resp
         resp
       end
 
       def get_balance
-        @q = {:userid => @uname, :password => @passwd}
-        {'EUR' => (post "balanceReport", :extra_query => @q).split(/\n/).last.split('::').last.strip}
+        opts = {:userid => @uname, :password => @passwd}
+        url = 'http://websms.smswarehouse.com:7800/websms/balanceReport'
+        {'EUR' => (post url, :extra_query => opts).split(/\n/).last.split('::').last.strip}
       end
 
       def get_status(message_id)
+        url = 'http://websms.smswarehouse.com:7800/websms/websmsstatus'
         options = {:userid => @uname, :password => @passwd}
-        resp = (post 'websmsstatus', :extra_query => {:respid => message_id.to_s}.merge(options)).split('-')[1].strip
+        resp = (post url, :extra_query => {:respid => message_id.to_s}.merge(options)).split('-')[1].strip
         @sent_message_statuses[message_id] = []
         [resp].each_with_index do |status, index|
           @sent_message_statuses[message_id] << {"part #{index}" => resp}
@@ -46,6 +55,28 @@ module Smshelper
         {message_id => @sent_message_statuses[message_id]}
       end
 
+      def get_callback_response(args = {})
+        if args['notificationType'] == 'MessageReceived'
+          InboundMessage.new(
+                             :message_id => args['id'],
+                             :sender => args['originator'],
+                             :recipient => args['recipient'],
+                             :text => args['body'],
+                             :timestamp => Time.now,
+                             :original_params => args
+                             )
+        elsif args['notificationType'] == 'MessageEvent'
+          DeliveryReport.new(
+                             :message_id => args['id'],
+                             :timestamp => Time.now,
+                             :delivered => ((args['eventType'] == 'Delivered') ? true : false),
+                             :original_params => args
+                             )
+        else
+          UnknownReply.new(args)
+        end
+      end
+
       private
       def process_response_code(code)
         (code == 'DELIVRD') ? true : false

data/lib/smshelper/api/textmagic.rb

@@ -21,9 +21,7 @@ module Smshelper
       end
 
       def get_status(message_id)
-        @sent_message_statuses[message_id] = []
-        @sent_message_statuses[message_id] << {"Part 01" => @api.message_status(message_id)}
-        {message_id => @sent_message_statuses[message_id]}
+        raise NotImplementedError, "Sms status checks unsupported by #{self.class.name}"
       end
 
       def get_callback_response(args = {})

data/lib/smshelper/api/traitel.rb

@@ -23,7 +23,7 @@ module Smshelper
           :output => :verbose,
           :concatenate => true
         }
-        options = options.merge(@extra_options) unless @extra_options.nil?
+        options.merge!(@extra_options) unless @extra_options.nil?
         resp = (get 'smsgateway.pl', :extra_query => options.merge(q))
         process_response_code(resp) ?  (@sent_message_ids << resp.split(',')[2]; resp.split(',')[2]) : (raise ErrorDuringSend "Could not deliver")
       end
@@ -36,6 +36,15 @@ module Smshelper
         raise NotImplementedError, "Sms status checks unsupported by #{self.class.name}"
       end
 
+      def get_callback_response(args = {})
+          DeliveryReport.new(
+                             :message_id => args['tt_id'],
+                             :timestamp => Time.now,
+                             :delivered => ((args['code'] == '0') ? true : false),
+                             :original_params => args
+                             )
+      end
+
       private
       def process_response_code(code)
         code =~ /accepted/ ? true : false

data/lib/smshelper/api/vianett.rb

@@ -1,11 +1,11 @@
 module Smshelper
   module Api
     class Vianett < Base
-      base_uri 'http://smsc.vianett.no/V3/CPA/MT'
 
       def initialize(*args)
         config = args.shift
         add_query_options! :username => config.vianett[:uname], :password => config.vianett[:passwd]
+        add_request_options! :skip_endpoint => true
         super
       end
 
@@ -13,28 +13,50 @@ module Smshelper
         uuid = (Digest::CRC32.hexdigest @uuid.generate).unpack('U*').collect {|x| sprintf '%02X', x}.join
 
         options = {
-          :destinationaddr => message.recipient,
-          :message => message.text,
-          :sourceaddr => message.sender,
+          :tel => message.recipient,
+          :msg => message.text,
+          :senderaddress => message.sender,
+          :senderaddresstype => '1',
+          :nrq => '1',
           # :refno => '1',
           :msgid => uuid}
-        options = options.merge(@extra_options) unless @extra_options.nil?
-        resp = (post 'MT.ashx', :extra_query => options)
-        process_response_code(resp['ack']) ? (@sent_message_ids << uuid; uuid) : (raise ErrorDuringSend, "#{self.class.name} does not implement detailed errors")
+binding.pry
+        options.merge!(@extra_options) unless @extra_options.nil?
+        resp = (post 'http://smsc.vianett.no/V3/CPA/MT/MT.ashx', :extra_query => options)
+        process_response_code(resp) ? (@sent_message_ids << uuid; uuid) : (raise ErrorDuringSend, "#{self.class.name} does not implement detailed error reporting - #{resp}")
       end
 
       def get_balance
-        {:fake => :value}
+        {'EUR' => (post 'http://oldsms.vianett.com/files/balancelimit_check.asp').split('|').last}
       end
 
+      # Vianett provides async lookup as well with callbacks
+      def hlr_lookup_synchronous(number)
+        opts = {:phonenumber => number}
+        (get 'http://smsc.vianett.no/v3/cpa/cpawebservice.asmx/SubmitHLR2', :extra_query => opts )['SubmitHLRResponse']
+      end
+      alias_method :hlr_lookup, :hlr_lookup_synchronous
+
       def get_status(message_id)
         raise NotImplementedError, "Sms status checks unsupported by #{self.class.name}"
       end
 
-      private
+      def get_callback_response(args = {})
+        if args['requesttype'] == 'notificationstatus'
+          DeliveryReport.new(
+                             :message_id => args['refno'],
+                             :timestamp => Time.parse(args['now']),
+                             :delivered => ((args['Status'] == 'DELIVRD') ? true : false),
+                             :original_params => args
+                             )
+        else
+          UnknownReply.new(args)
+        end
+      end
 
+      private
       def process_response_code(code)
-        (code == 'OK') ? true : false
+        (code['ack']['__content__'] == 'OK') ? true : false
       end
 
     end

data/smshelper.gemspec

@@ -5,23 +5,23 @@
 
 Gem::Specification.new do |s|
   s.name = "smshelper"
-  s.version = "0.4.5"
+  s.version = "0.4.6"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Voip Scout"]
-  s.date = "2012-05-26"
-  s.description = "works www.bulksms.com, www.webtext.com, www.clickatell.com, www.textmagic.com, www.smstrade.eu, www.esendex.com, www.mediaburst.co.uk, www.nexmo.com, www.vianett.com, www.traitel.com.au, www.my-cool-sms.com, www.aql.com"
+  s.date = "2012-05-31"
+  s.description = "send sms with multiple gateways, like esendex, bulksms, clickatell etc.."
   s.email = "voipscout@gmail.com"
   s.extra_rdoc_files = [
     "LICENSE.txt",
-    "README.rdoc"
+    "README.md"
   ]
   s.files = [
     ".document",
     ".rspec",
     "Gemfile",
     "LICENSE.txt",
-    "README.rdoc",
+    "README.md",
     "Rakefile",
     "VERSION",
     "lib/smshelper.rb",
@@ -55,7 +55,7 @@ Gem::Specification.new do |s|
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
   s.rubygems_version = "1.8.24"
-  s.summary = "send sms with: www.bulksms.com, www.webtext.com, www.clickatell.com, www.textmagic.com, www.smstrade.eu, www.esendex.com, www.mediaburst.co.uk, www.nexmo.com, www.vianett.com, www.traitel.com.au, www.my-cool-sms.com, www.aql.com"
+  s.summary = "send sms with 10+ gateways"
 
   if s.respond_to? :specification_version then
     s.specification_version = 3
@@ -67,6 +67,7 @@ Gem::Specification.new do |s|
       s.add_runtime_dependency(%q<textmagic>, [">= 0"])
       s.add_runtime_dependency(%q<uuid>, [">= 0"])
       s.add_runtime_dependency(%q<digest-crc>, [">= 0"])
+      s.add_runtime_dependency(%q<virtus>, [">= 0"])
       s.add_development_dependency(%q<pry>, [">= 0"])
       s.add_development_dependency(%q<rspec>, [">= 0"])
       s.add_development_dependency(%q<rdoc>, [">= 0"])
@@ -80,6 +81,7 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<textmagic>, [">= 0"])
       s.add_dependency(%q<uuid>, [">= 0"])
       s.add_dependency(%q<digest-crc>, [">= 0"])
+      s.add_dependency(%q<virtus>, [">= 0"])
       s.add_dependency(%q<pry>, [">= 0"])
       s.add_dependency(%q<rspec>, [">= 0"])
       s.add_dependency(%q<rdoc>, [">= 0"])
@@ -94,6 +96,7 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<textmagic>, [">= 0"])
     s.add_dependency(%q<uuid>, [">= 0"])
     s.add_dependency(%q<digest-crc>, [">= 0"])
+    s.add_dependency(%q<virtus>, [">= 0"])
     s.add_dependency(%q<pry>, [">= 0"])
     s.add_dependency(%q<rspec>, [">= 0"])
     s.add_dependency(%q<rdoc>, [">= 0"])

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: smshelper
 version: !ruby/object:Gem::Version
-  version: 0.4.5
+  version: 0.4.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-26 00:00:00.000000000 Z
+date: 2012-05-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: api_smith
@@ -107,6 +107,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: virtus
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -203,21 +219,19 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: works www.bulksms.com, www.webtext.com, www.clickatell.com, www.textmagic.com,
-  www.smstrade.eu, www.esendex.com, www.mediaburst.co.uk, www.nexmo.com, www.vianett.com,
-  www.traitel.com.au, www.my-cool-sms.com, www.aql.com
+description: send sms with multiple gateways, like esendex, bulksms, clickatell etc..
 email: voipscout@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files:
 - LICENSE.txt
-- README.rdoc
+- README.md
 files:
 - .document
 - .rspec
 - Gemfile
 - LICENSE.txt
-- README.rdoc
+- README.md
 - Rakefile
 - VERSION
 - lib/smshelper.rb
@@ -261,7 +275,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2671716086035374482
+      hash: 2305576144060548028
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -273,7 +287,5 @@ rubyforge_project:
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: ! 'send sms with: www.bulksms.com, www.webtext.com, www.clickatell.com, www.textmagic.com,
-  www.smstrade.eu, www.esendex.com, www.mediaburst.co.uk, www.nexmo.com, www.vianett.com,
-  www.traitel.com.au, www.my-cool-sms.com, www.aql.com'
+summary: send sms with 10+ gateways
 test_files: []

data/README.rdoc

@@ -1,71 +0,0 @@
-= smshelper
-A utility library to do SMS-MT
-
-== Currently supported providers:
-
-* www.bulksms.com
-* www.webtext.com
-* www.clickatell.com
-* www.textmagic.com
-* www.smstrade.eu
-* www.esendex.com
-* www.mediaburst.co.uk
-* www.nexmo.com
-* www.vianett.com
-* www.traitel.com.au
-* www.my-cool-sms.com
-* www.aql.com
-== Features
-
-* NEW HLR lookup support via my-cool-sms
-* unicode support - all operators
-* send message
-* check balance, all except vianett
-* check sent message status - select operators only
-== Installation
-
-gem install smshelper
-== Usage
-
-  require 'smshelper'
-  config = Smshelper::Config.new(
-                                 :webtext => {:uname => '', :passwd => ''},
-                                 :bulksms => {:uname => '', :passwd => ''},
-                                 :clickatell => {:api_key => '',:uname => '', :passwd => ''},
-                                 :textmagic => {:uname => '', :passwd => ''},
-                                 :smstrade => {:api_key => ''},
-                                 :esendex => {:uname => '', :passwd => '', :acc => ''},
-                                 :mediaburst => {:uname => '', :passwd => ''},
-                                 :nexmo => {:uname => '', :passwd => ''}
-                                 )
-
-  service0 = Smshelper::Api::Bulksms.new config
-  service1 = Smshelper::Api::Webtext.new config
-  service2 = Smshelper::Api::Clickatell.new config
-  service3 = Smshelper::Api::Textmagic.new config
-  service4 = Smshelper::Api::Smstrade.new config, :route => 'gold'
-  service5 = Smshelper::Api::Esendex.new config, 'com:validityperiod' => '1'
-  service6 = Smshelper::Api::MediaBurst.new config
-  service7 = Smshelper::Api::Nexmo.new config, :ttl => '60000'
-
-  message = Smshelper::Message.new(:recipient => '14128765432', :text => "The balance on #{serviceX.class.to_s} is #{serviceX.get_balance}", :sender => '33765432132')
-  serviceX.send_message message
-== TODO:
-
-* create tests
-* refactor / rewrite class factories as modules
-* handle sms of any size - operator specific settings
-* add support for www.totext.net, www.world-text.com, www.mpulse.eu, www.clicksms.co.uk, www.tellustalk.com, www.tm4b.com, www.txtnation.com, www.smsextrapro.com, www.truesenses.com, www.routomessaging.net
-== Contributing to smshelper
-
-* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
-* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
-* Fork the project.
-* Start a feature/bugfix branch.
-* Commit and push until you are happy with your contribution.
-* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
-* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
-
-== Copyright
-
-Copyright (c) 2012 Voip Scout.