smess 1.0.4 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7bd97cb82c4e104f4878fd93026390b7f64e557d
-  data.tar.gz: fb1c0c5c63933f965109182d2f6525359939b7e8
+  metadata.gz: bfda4dab3491c3d330309d126e50c9f57e39ba5c
+  data.tar.gz: c46314bbba0a491a7fa9b6b442cc3f5fc490cb0e
 SHA512:
-  metadata.gz: a02d6af367b2b63838c692cb1e4bf9fc5d012d286de836e07d8c42b8f7d926f0aa8878f74204baaeef48a5149f5b5b586d289e01acfc269a57b69d548fc2f917
-  data.tar.gz: 2a6bd99ef07c08ece8c04beea6ea65e0a820d422b6377e76f948ce22c76f9232fb34ef133eceead3ee62c11b5ac1286e0108fe75af9e8eb7fdd322830c5884b9
+  metadata.gz: 8812e709f447971d3e37395953749c6dbd4ed149426ef850f7a9b44d0a2262318fe835b6e26830890be578cb1c9ef1e9aec54711f762d8c759188c410fd5d802
+  data.tar.gz: 16336412133c3b916ef2de6bf3c92f76279e52d92674fc2c823a17060e11604bd523749c94c3ec066a1254510585a349965c023112bac9404673831e248bc443

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    smess (1.0.3)
+    smess (1.0.4)
       activesupport (>= 3.0)
       clickatell
       httpi
@@ -21,7 +21,7 @@ GEM
     akami (1.2.0)
       gyoku (>= 0.4.0)
       nokogiri (>= 1.4.0)
-    atomic (1.1.13)
+    atomic (1.1.14)
     builder (3.2.2)
     clickatell (0.8.2)
     diff-lcs (1.2.4)
@@ -63,12 +63,16 @@ GEM
       nokogiri (>= 1.4.0)
       nori (~> 1.1.0)
       wasabi (~> 2.5.0)
-    thread_safe (0.1.2)
+    simplecov (0.7.1)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.7.1)
+    simplecov-html (0.7.1)
+    thread_safe (0.1.3)
       atomic
     treetop (1.4.15)
       polyglot
       polyglot (>= 0.3.1)
-    twilio-ruby (3.10.1)
+    twilio-ruby (3.11.0)
       builder (>= 2.1.2)
       jwt (>= 0.1.2)
       multi_json (>= 1.3.0)
@@ -84,4 +88,5 @@ DEPENDENCIES
   dotenv
   jahtml_formatter
   rspec (>= 2.4.0)
+  simplecov
   smess!

data/lib/smess.rb

@@ -15,6 +15,7 @@ require 'smess/outputs/http_base'
 require 'smess/outputs/auto'
 require 'smess/outputs/ipx'
 require 'smess/outputs/ipxus'
+require 'smess/outputs/card_board_fish'
 require 'smess/outputs/clickatell'
 require 'smess/outputs/etisalatdemo'
 require 'smess/outputs/smsglobal'
@@ -29,8 +30,8 @@ require 'string'
 module Smess
 
   # Move to config?
-  OUTPUTS = %w{auto clickatell etisalatdemo global_mouth iconectiv mblox ipxus smsglobal twilio}
-  COUNTRY_CODES = [1, 20, 34, 46, 49, 966, 971]
+  OUTPUTS = %w{auto card_board_fish clickatell etisalatdemo global_mouth iconectiv mblox ipxus smsglobal twilio}
+  COUNTRY_CODES = [1, 20, 212, 34, 46, 49, 966, 971]
 
   def self.new(*args)
     Sms.new(*args)
@@ -60,4 +61,5 @@ HTTPI.adapter = :net_http
 
 # Setting config defaults
 # there is probably a better way and better place
+# Unused and deprecated
 Smess.config.debug = Smess.booleanize(ENV["SMESS_DEBUG"])

data/lib/smess/country_code_registry.rb

@@ -24,6 +24,7 @@ module Smess
     "1869"=> :global_mouth,
     "1876"=> :global_mouth,
     "20"  => :global_mouth,
+    "212" => :card_board_fish,
     "34"  => :global_mouth,
     "46"  => :global_mouth,
     "49"  => :global_mouth,

data/lib/smess/outputs/auto.rb

@@ -14,7 +14,7 @@ module Smess
 
     def output_for(msisdn)
       out_class = get_output_name_for_msisdn msisdn
-      ("Smess::#{out_class.to_s.camelize}").constantize.new(sms)
+      "Smess::#{out_class.to_s.camelize}".constantize.new(sms)
     end
 
     def deliver

data/lib/smess/outputs/card_board_fish.rb

@@ -0,0 +1,53 @@
+module Smess
+  class CardBoardFish < HttpBase
+
+    def deliver
+      request.url = "#{url}?#{params.to_query}"
+      http_get request
+    end
+
+    private
+
+    def username
+      ENV["SMESS_CARD_BOARD_FISH_USER"]
+    end
+
+    def password
+      ENV["SMESS_CARD_BOARD_FISH_PASS"]
+    end
+
+    def sender_id
+      ENV["SMESS_SENDER_ID"]
+    end
+
+    def url
+      "https://sms2.cardboardfish.com:9444/HTTPSMS"
+    end
+
+    def params
+      @params ||= {
+        "S" => "H",
+        "UN" => username,
+        "P" => password,
+        "DA" => sms.to,
+        "M" => sms.message.strip_nongsm_chars.encode("ISO-8859-1"),
+        "SA" => from,
+        "ST" => 5
+      }
+    end
+
+    def normal_result(response)
+      response_code = response.code
+      response_code = "0" if response.code.to_s == "200"
+      # Successful response
+      {
+        message_id: message_id,
+        response_code: response_code.to_s,
+        response: {body: response.body},
+        destination_address: sms.to,
+        data: result_data
+      }
+    end
+
+  end
+end

data/lib/smess/outputs/clickatell.rb

@@ -40,7 +40,7 @@ module Smess
           responses << rsp
         end
         result = normal_result(responses.first)
-      rescue Exception => e
+      rescue => e
         # connection problem or some error
         result = result_for_error(e)
       end

data/lib/smess/outputs/etisalatdemo.rb

@@ -31,7 +31,7 @@ module Smess
 
       begin
         mail.deliver
-      rescue Exception => e
+      rescue => e
         result = {
           response_code: "-1",
           response: {text: "Email2sms: Delivery Error: #{e.inspect}"},

data/lib/smess/outputs/global_mouth.rb

@@ -7,16 +7,7 @@ module Smess
     def deliver
       generate_mac_hash
       request.url = "#{url}?#{params.to_query}"
-
-      begin
-        response = HTTPI.get request
-        result = normal_result(response)
-      rescue Exception => e
-        logger.warn response
-        # connection problem or some error
-        result = result_for_error(e)
-      end
-      result
+      http_get request
     end
 
     private

data/lib/smess/outputs/http_base.rb

@@ -30,6 +30,22 @@ module Smess
       @request ||= HTTPI::Request.new
     end
 
+    def http_get(request)
+      http_request(:get, request)
+    end
+
+    def http_post(request)
+      http_request(:post, request)
+    end
+
+    def http_request(method, request)
+      response = HTTPI.send(method, request)
+      normal_result(response)
+    rescue => e
+      logger.warn response
+      result_for_error(e)
+    end
+
     def result_for_error(e)
       {
         response_code: '-1',

data/lib/smess/outputs/iconectiv.rb

@@ -1,17 +1,10 @@
 module Smess
   class Iconectiv < Ipxus
 
-    def account
-      @account ||= {
-        sms_url: 'http://66.70.32.42:32005/api/services2/SmsApi52?wsdl',
-        shortcode: ENV["SMESS_ICONECTIV_SHORTCODE"],
-        username: ENV["SMESS_ICONECTIV_USER"],
-        password: ENV["SMESS_ICONECTIV_PASS"],
-        account_name: ENV["SMESS_ICONECTIV_ACCOUNT_NAME"],
-        service_name: ENV["SMESS_SERVICE_NAME"],
-        service_meta_data_t_mobile_us: ENV["SMESS_ICONECTIV_SERVICE_META_DATA_T_MOBILE_US"],
-        service_meta_data_verizon: ENV["SMESS_ICONECTIV_SERVICE_META_DATA_VERIZON"]
-      }
+    private
+
+    def account_key_prefix
+      "ICONECTIV"
     end
 
   end

data/lib/smess/outputs/ipx.rb

@@ -5,21 +5,10 @@ module Smess
     def initialize(sms)
       @sms = sms
       @results = []
-      @endpoint = account[:sms_url]
+      @endpoint = sms_url
       @credentials = {
-        name: account[:username],
-        pass: account[:password]
-      }
-    end
-
-    def account
-      @account ||= {
-        sms_url: 'http://europe.ipx.com/api/services2/SmsApi52?wsdl',
-        shortcode: ENV["SMESS_IPX_SHORTCODE"],
-        username: ENV["SMESS_IPX_USER"],
-        password: ENV["SMESS_IPX_PASS"],
-        account_name: ENV["SMESS_IPX_ACCOUNT_NAME"],
-        service_name: ENV["SMESS_SERVICE_NAME"]
+        name: username,
+        pass: password
       }
     end
 
@@ -47,10 +36,50 @@ module Smess
     attr_reader :sms
     attr_accessor :results
 
+    def account_key_prefix
+      "IPX"
+    end
+
+    def account_key_for(key_part)
+      "SMESS_#{account_key_prefix}_#{key_part}"
+    end
+
+    def sms_url
+      ENV[ account_key_for("URL") ]
+    end
+
+    def shortcode
+      ENV[ account_key_for("SHORTCODE") ]
+    end
+
+    def username
+      ENV[ account_key_for("USER") ]
+    end
+
+    def password
+      ENV[ account_key_for("PASS") ]
+    end
+
+    def account_name
+      ENV[ account_key_for("ACCOUNT_NAME") ]
+    end
+
+    def service_name
+      ENV["SMESS_SERVICE_NAME"]
+    end
+
+    def service_meta_data_t_mobile_us
+      ENV[ account_key_for("SERVICE_META_DATA_T_MOBILE_US") ]
+    end
+
+    def service_meta_data_verizon
+      ENV[ account_key_for("SERVICE_META_DATA_VERIZON") ]
+    end
+
     def soap_body
       @soap_body ||= {
         "correlationId" => Time.now.strftime('%Y%m%d%H%M%S') + sms.to,
-        "originatingAddress" => account[:shortcode],
+        "originatingAddress" => shortcode,
         "originatorTON" => "0",
         "destinationAddress" => sms.to,
         "userData" => "",
@@ -60,16 +89,16 @@ module Smess
         "relativeValidityTime" => "-1",
         "deliveryTime" => "#NULL#",
         "statusReportFlags" => "1", # 1
-        "accountName" => account[:account_name],
+        "accountName" => account_name,
         "tariffClass" => "USD0", # needs to be extracted and variable per country
         "VAT" => "-1",
         "referenceId" => "#NULL#",
-        "serviceName" => account[:service_name],
+        "serviceName" =>  service_name,
         "serviceCategory" => "#NULL#",
         "serviceMetaData" => "#NULL#",
         "campaignName" => "#NULL#",
-        "username" => account[:username],
-        "password" => account[:password]
+        "username" => username,
+        "password" => password
       }
     end
 
@@ -156,7 +185,7 @@ module Smess
           soap.body = soap_body_var
         end
         result = parse_sms_response(response)
-      rescue Exception => e
+      rescue => e
         result = result_for_error(e)
         # LOG error here?
       end

data/lib/smess/outputs/ipxus.rb

@@ -1,19 +1,6 @@
 module Smess
   class Ipxus < Ipx
 
-    def account
-      @account ||= {
-        sms_url: 'http://europe.ipx.com/api/services2/SmsApi52?wsdl',
-        shortcode: ENV["SMESS_IPX_SHORTCODE"],
-        username: ENV["SMESS_IPX_USER"],
-        password: ENV["SMESS_IPX_PASS"],
-        account_name: ENV["SMESS_IPX_ACCOUNT_NAME"],
-        service_name: ENV["SMESS_SERVICE_NAME"],
-        service_meta_data_t_mobile_us: ENV["SMESS_IPX_SERVICE_META_DATA_T_MOBILE_US"],
-        service_meta_data_verizon: ENV["SMESS_IPX_SERVICE_META_DATA_VERIZON"]
-      }
-    end
-
   private
 
     def set_originator(originator)
@@ -25,7 +12,7 @@ module Smess
     def perform_operator_adaptation(msisdn)
       operator_data = lookup_operator msisdn
       unless operator_data[:operator].nil?
-        method_name = "adapt_for_#{operator_data[:operator].to_underscore.gsub(" ","_")}"
+        method_name = "adapt_for_#{operator_data[:operator].smess_to_underscore.gsub(" ","_")}"
         send(method_name, msisdn) if respond_to?(:"#{method_name}", true)
       end
     end
@@ -41,8 +28,8 @@ module Smess
         "correlationId" => Time.now.strftime('%Y%m%d%H%M%S') + msisdn,
         "consumerId" => msisdn,
         "campaignName" => "#NULL#",
-        "username" => account[:username],
-        "password" => account[:password]
+        "username" => username,
+        "password" => password
       }
 
       begin
@@ -50,7 +37,7 @@ module Smess
           soap.body = body
         end
         result = parse_operator_response(response)
-      rescue Exception => e
+      rescue => e
         result = result_for_error(e)
       ensure
         @endpoint = orig_endpoint
@@ -71,11 +58,11 @@ module Smess
 
 
     def adapt_for_verizon(msisdn)
-      soap_body["serviceMetaData"] = account[:service_meta_data_verizon]
+      soap_body["serviceMetaData"] = service_meta_data_verizon
     end
 
     def adapt_for_t_mobile_us(msisdn)
-      soap_body["serviceMetaData"] = account[:service_meta_data_t_mobile_us]
+      soap_body["serviceMetaData"] = service_meta_data_t_mobile_us
     end
 
   end

data/lib/smess/outputs/mblox.rb

@@ -90,7 +90,7 @@ module Smess
         HTTPI.log_level = :debug
         response = HTTPI.post request
         result = normal_result(response)
-      rescue Exception => e
+      rescue => e
         logger.warn response
         # connection problem or some error
         result = result_for_error(e)

data/lib/smess/outputs/smsglobal.rb

@@ -8,15 +8,7 @@ module Smess
       request.url = url
       request.body = params
 
-      begin
-        response = HTTPI.post request
-        result = normal_result(response)
-      rescue Exception => e
-        logger.warn response
-        # connection problem or some error
-        result = result_for_error(e)
-      end
-      result
+      http_post request
     end
 
     private

data/lib/smess/outputs/twilio.rb

@@ -32,7 +32,7 @@ module Smess
     end
 
     def split_parts
-      Smess.split_sms(sms.message.strip_nongsm_chars).reject {|s| s.empty? }
+      Smess.separate_sms(sms.message.strip_nongsm_chars).reject {|s| s.empty? }
     end
 
     def client
@@ -48,7 +48,7 @@ module Smess
           status_callback: ENV["SMESS_TWILIO_CALLBACK_URL"]
         })
         result = normal_result(response)
-      rescue Exception => e
+      rescue => e
         result = result_for_error(e)
       end
       result

data/lib/smess/sms.rb

@@ -13,12 +13,12 @@ module Smess
 
     def deliver
       out_class = output
-      out = ("Smess::#{out_class.to_s.camelize}").constantize.new(self)
+      out = "Smess::#{out_class.to_s.camelize}".constantize.new(self)
       results = out.deliver
     end
 
     def delivered?
-      @results[:response_code] == "0" rescue false
+      results[:response_code] == "0"
     end
 
   end

data/lib/smess/utils.rb

@@ -3,51 +3,71 @@
 module Smess
   class << self
 
+    def booleanize(value)
+      value.to_s.downcase == "true"
+    end
+
     # returns an array of strings of gsm-compatible lengths
-    # performance issue: utf8_safe_split also loops over the split point
     # this should be used when sending via concatenating providers
     def split_sms(text)
       return [text] unless text.sms_length > 160
-
       result = []
+
       while text.sms_length > 0
-        end_char = 151
-        part = ""
-        while part.sms_length < 152 && part != text
-          end_char = end_char + 1
-          part = text.utf8_safe_split(end_char)[0] || ""
-        end
+        part, text = text.split_at( split_point(text) )
         result << part
-        text = text.utf8_safe_split(end_char)[1] || ""
       end
       result
     end
 
-    # returns an array of strings of <160 char lengths
-    # splits on whitespace and will mangle non-space whitespace
+    # it is not as simple as
+    #def split_sms(text)
+    #  text = text.scan(/.{1,154}/m) if text.sms_length > SMS_MAX_LENGTH
+    #  Array(text)
+    #end
+    # (which i forgot trying to please Code Climate)
+
+
+
+    # returns an array of strings of <160 char lengths, split on whitespace
     # this should be used when sending via non-concatenating providers
     def separate_sms(text)
-      return [text] unless text.sms_length > 160
-
-      end_char = 160
+      return [text] unless text.sms_length > SMS_MAX_LENGTH
       result = []
-      while text.sms_length > end_char
-        part = ""
-        parts = text.utf8_safe_split(end_char)
-        text = parts[1]
-        splitpoint = end_char-parts[0].reverse.index(/[^\w-]+/)
-        split = parts[0].utf8_safe_split(splitpoint)
-        result << split[0].strip
-        text = (split[1]+text).strip rescue text
+      while text.sms_length > SMS_MAX_LENGTH
+        part, text = text.split_at( separation_point(text) )
+        result << part.strip
       end
-      result << text
+      result << text.strip
     end
 
+    private
 
-    def booleanize(value)
-      value.to_s.downcase == "true"
+    SMS_MAX_LENGTH = 160
+
+    # for finding the GSM alphabet split point for concatenated message strings
+    # The reason this is a bit qirky is that a subset of characters are "extended".
+    # These and take 2 bytes and the number of these in the message body alter the
+    # "byte" splitpoint.
+    def split_point(text)
+      end_char = 155
+      while text.sms_length > 154
+        end_char -= 1
+        text = text.split_at(end_char).first
+        # puts "split_point #{end_char}"
+      end
+      end_char
     end
 
+    # This is used when there is no concatenation and you want the string split on whitespace.
+    def separation_point(text)
+      end_char = SMS_MAX_LENGTH + 1
+      while text.sms_length > SMS_MAX_LENGTH || !(text[-1] =~ /\s/)
+        end_char -= 1
+        text = text.split_at(end_char).first
+      end
+      end_char
+    end
 
   end
 end

data/lib/smess/version.rb

@@ -1,3 +1,3 @@
 module Smess
-  VERSION = '1.0.4'
+  VERSION = '1.0.5'
 end

data/lib/string.rb

@@ -1,6 +1,6 @@
 # coding: UTF-8
 class String
-  def to_underscore
+  def smess_to_underscore
     self.gsub(/::/, '/').
     gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
     gsub(/([a-z\d])([A-Z])/,'\1_\2').
@@ -9,23 +9,8 @@ class String
   end
 
 
-  def valid_utf8?
-    !!unpack("U") rescue false
-  end
-
-  def utf8_safe_split(n)
-    if length <= n
-      [self, nil]
-    else
-      before = self[0, n]
-      after = self[n..-1]
-      until after.valid_utf8?
-        n = n - 1
-        before = self[0, n]
-        after = self[n..-1]
-      end
-      [before, after.empty? ? nil : after]
-    end
+  def split_at(index)
+      [ self[0, index], self[index..-1] || "" ]
   end
 
   # like strlen but with SMS alphabet calculations

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smess
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.0.5
 platform: ruby
 authors:
 - Martin Westin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-19 00:00:00.000000000 Z
+date: 2013-12-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -24,6 +24,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: 2.4.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: jahtml_formatter
   requirement: !ruby/object:Gem::Requirement
@@ -145,6 +159,7 @@ files:
 - lib/smess/country_code_registry.rb
 - lib/smess/logging.rb
 - lib/smess/outputs/auto.rb
+- lib/smess/outputs/card_board_fish.rb
 - lib/smess/outputs/clickatell.rb
 - lib/smess/outputs/etisalatdemo.rb
 - lib/smess/outputs/global_mouth.rb
@@ -185,7 +200,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.7
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.2
+rubygems_version: 2.1.9
 signing_key: 
 specification_version: 4
 summary: A messy SMS messenger supporting every aggregator I have gotten my hands