smess 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c788fb1adca56a19e9415362cdf44e74c8064e89
+  data.tar.gz: 4778a898c0d307f1b7e45606e9942b9a81456a3e
+SHA512:
+  metadata.gz: 64dcc2a833300d0d55a55c38329bd7c5562556a4b1189c2e587380ab4a5d94af45a0ecb98e5080ae6d5f6ff72e85ae903cca7c63a324c32833fd615c182eda43
+  data.tar.gz: 50ea00e53fda127b453cf3975dd936f9459025b1fe1f02fdfcc32566b9f81f8a0eeebbb48d89793e02496d8adb3e869e7a2761496ab47c1caf558ec9a90bc05c

data/Gemfile

@@ -0,0 +1,2 @@
+source "http://rubygems.org"
+gemspec

data/Gemfile.lock

@@ -0,0 +1,87 @@
+PATH
+  remote: .
+  specs:
+    smess (1.0.0)
+      activesupport (>= 3.0)
+      clickatell
+      httpi
+      mail
+      savon (= 1.2.0)
+      twilio-ruby
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (4.0.0)
+      i18n (~> 0.6, >= 0.6.4)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.37)
+    akami (1.2.0)
+      gyoku (>= 0.4.0)
+      nokogiri (>= 1.4.0)
+    atomic (1.1.13)
+    builder (3.2.2)
+    clickatell (0.8.2)
+    diff-lcs (1.2.4)
+    dotenv (0.9.0)
+    gyoku (0.4.6)
+      builder (>= 2.1.2)
+    httpi (1.1.1)
+      rack
+    i18n (0.6.5)
+    jahtml_formatter (1.0.5)
+      rspec (~> 2.14)
+    jwt (0.1.8)
+      multi_json (>= 1.5)
+    mail (2.5.4)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.25)
+    mini_portile (0.5.1)
+    minitest (4.7.5)
+    multi_json (1.7.9)
+    nokogiri (1.6.0)
+      mini_portile (~> 0.5.0)
+    nori (1.1.5)
+    polyglot (0.3.3)
+    rack (1.5.2)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.5)
+    rspec-expectations (2.14.2)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.3)
+    savon (1.2.0)
+      akami (~> 1.2.0)
+      builder (>= 2.1.2)
+      gyoku (~> 0.4.5)
+      httpi (~> 1.1.0)
+      nokogiri (>= 1.4.0)
+      nori (~> 1.1.0)
+      wasabi (~> 2.5.0)
+    thread_safe (0.1.2)
+      atomic
+    treetop (1.4.15)
+      polyglot
+      polyglot (>= 0.3.1)
+    twilio-ruby (3.10.1)
+      builder (>= 2.1.2)
+      jwt (>= 0.1.2)
+      multi_json (>= 1.3.0)
+    tzinfo (0.3.37)
+    wasabi (2.5.1)
+      httpi (~> 1.0)
+      nokogiri (>= 1.4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  dotenv
+  jahtml_formatter
+  rspec (>= 2.4.0)
+  smess!

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Martin Westin
+
+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.md

@@ -0,0 +1,114 @@
+# Smess - A mess of SMS messaging
+
+This is a messy SMS messenger supporting every aggregator I have gotten my hands on.
+
+In 2008 I started working on SMS and MMS messaging applications. Within the first 2 months it was apparent that I needed an abstraction that could route messages to different aggregators (messaging providers) to support different countries. No one API supports the entire word in any useful way.
+
+This is that abstraction finally cleaned up (a little) enabling it to be public. Everyone from mBlox to  Clickatell. The following 7 aggregators are supported.
+
+* Auto - will automatically select the best option for each country. Most often using Global Mouth.
+* Clickatell - http://www.clickatell.com
+* Global Mouth - http://www.globalmouth.com
+* Iconectiv - http://www.iconectiv.com
+* IPX - http://www.ipx.com (who knows what'll happen to them)
+* mBlox - http://www.mblox.com
+* SMS Global - https://www.smsglobal.com
+* Twilio - http://www.twilio.com
+
+There is also a _test_ aggregator that you should set evrything to use when running tests in your code.
+
+
+## Who should use this?
+
+* You want to send SMS messages from Ruby code.
+* You want one API to call regardless of which aggregator you switch to.
+* You may even want to do it to people in multiple countries using the "best" aggregator for each.
+
+## Why?
+
+It may be old and crappy but it has served many millions of SMS messages in production across all continents of the globe. Being in production it has some nice touches that may serve you well.
+
+There is automatic fallback delivery in places where it really makes a difference. Delivery reliability, particularly in the US, is appalling and being able to reduce non-deliveries by more than half is a big deal when sending transactional messages.
+
+The aggregator outputs are a very simple plugin system so you can subclass, modify and write your own. The protocol is just one method accepting a single argument.
+
+```ruby
+module Smess
+  class Example
+
+    def deliver_sms(sms)
+      # Do work and return a hash like this one
+      {
+      :response_code => '-1',
+        :response  => {
+          :temporaryError =>'true',
+          :responseCode => '-1',
+          :responseText => 'Delivery not implemented.'
+        }
+      }
+    end
+
+  end
+end
+```
+
+
+
+## Installation
+
+### Get the gem going
+
+```
+gem "smess"
+```
+or
+```
+gem install smess
+```
+
+### Set a hundred ENV vars
+All credentials, and other account-sepcific settings, have been extracted into ENV vars allowing you to set these any way you like. I use Dotenv but Figaro or other env manager should work equally well. As should setting them any other way.
+
+All ENV variables used by Smess are listed in the file .env. You only need to define the aggregator credentials you actually use though.
+
+## Usage
+
+```ruby
+sms = Smess.new(
+  to: '46701234567', # phone number in normalized msisdn format
+  message: 'Test SMS', # Message text
+  originator: 'TestSuite', # originator, sender id. This has many names. Outside the US this can usually be set to whatever you like.
+  output: "test" # Name of the output plugin to use. Defaults to auto select.
+)
+results = sms.deliver
+puts result
+```
+
+Look in the project test folder for end-to-end test files showcasing normal usage.
+
+There are also convenience methods patched onto String to normalize phone numbers.
+```ruby
+"\r\n +(070-123)\n45 67\n".msisdn(46)
+#=> 46701234567
+```
+US numbers cannot be banged into shape as much as most international numbers can. This is due to area codes not conforming to leading 0 as most other countries do. Tt is actually not terribly simple to see the difference between the US area code 850 and the North Korean country code 850. :)
+
+More usage is pretty clear from the specs.
+
+## Disclaimers
+
+Being Swedish, disclaimers are required.
+
+* Much of the code is old and crappy. It started in 2008 in PHP, ported to Ruby in 2010.
+* There are OK specs for the simple stuff. No specs for the more error-prone API calls. There are live tests that can be run to verify end-to-end messaging, though.
+* Does not handle the other part of messaging... accepting and processing Delivery Reports. (I have the code... it is just not extracted yet.)
+
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/lib/smess.rb

@@ -0,0 +1,63 @@
+# encoding: UTF-8
+smess_path = File.expand_path('.', File.dirname(__FILE__))
+$:.unshift(smess_path) if File.directory?(smess_path) && !$:.include?(smess_path)
+
+require 'mail'
+require 'savon'
+require 'active_support/core_ext'
+
+require "smess/version"
+require 'smess/logging'
+require 'smess/country_code_registry'
+require 'smess/utils'
+require 'smess/sms'
+require 'smess/outputs/auto'
+require 'smess/outputs/mm7'
+require 'smess/outputs/ipx'
+require 'smess/outputs/ipxus'
+require 'smess/outputs/clickatell'
+require 'smess/outputs/etisalatdemo'
+require 'smess/outputs/smsglobal'
+require 'smess/outputs/global_mouth'
+require 'smess/outputs/mblox'
+require 'smess/outputs/twilio'
+require 'smess/outputs/iconectiv'
+require 'smess/outputs/test'
+
+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]
+
+  def self.new(*args)
+    Sms.new(*args)
+  end
+
+  def self.config
+    @config ||=Config.new
+  end
+
+  class Config
+    def initialize
+      @config=Hash.new
+    end
+    def method_missing(method,*args,&block)
+      method = method.to_s.gsub(/[=]/,'')
+      if args.length>0
+        @config[method] = args.first
+      end
+      @config[method]
+    end
+  end
+
+end
+
+# httpclient does not send basic auth correctly, or at all.
+HTTPI.adapter = :net_http
+
+# Setting config defaults
+# there is probably a better way and better place
+Smess.config.debug = Smess.booleanize(ENV["SMESS_DEBUG"])

data/lib/smess/country_code_registry.rb

@@ -0,0 +1,33 @@
+module Smess
+  OUTPUT_BY_COUNTRY_CODE = {
+    "0"   => :global_mouth, # default for any undefined code
+    "1"   => :iconectiv,
+    "1242"=> :global_mouth,
+    "1246"=> :global_mouth,
+    "1264"=> :global_mouth,
+    "1268"=> :global_mouth,
+    "1284"=> :global_mouth,
+    "1345"=> :global_mouth,
+    "1441"=> :global_mouth,
+    "1473"=> :global_mouth,
+    "1649"=> :global_mouth,
+    "1664"=> :global_mouth,
+    "1670"=> :global_mouth,
+    "1671"=> :global_mouth,
+    "1684"=> :global_mouth,
+    "1758"=> :global_mouth,
+    "1767"=> :global_mouth,
+    "1784"=> :global_mouth,
+    "1787"=> :global_mouth,
+    "1809"=> :global_mouth,
+    "1868"=> :global_mouth,
+    "1869"=> :global_mouth,
+    "1876"=> :global_mouth,
+    "20"  => :global_mouth,
+    "34"  => :global_mouth,
+    "46"  => :global_mouth,
+    "49"  => :global_mouth,
+    "966" => :global_mouth,
+    "971" => :etisalatdemo
+  }
+end

data/lib/smess/logging.rb

@@ -0,0 +1,16 @@
+module Smess
+  module Logging
+
+    def logger
+      # use the Rails logger if it's defined
+      @logger ||= if defined?(Rails)
+        Rails.logger
+      else
+        l = ::Logger.new(STDOUT)
+        l.level = Logger::WARN
+        l
+      end
+    end
+
+  end
+end

data/lib/smess/outputs/auto.rb

@@ -0,0 +1,26 @@
+module Smess
+  class Auto
+
+    def get_output_name_for_msisdn(msisdn)
+      3.downto(0).each do |index|
+        return OUTPUT_BY_COUNTRY_CODE[msisdn[0..index]] if OUTPUT_BY_COUNTRY_CODE.key? msisdn[0..index]
+      end
+      OUTPUT_BY_COUNTRY_CODE["0"]
+    end
+
+    def output_for(msisdn)
+      out_class = get_output_name_for_msisdn msisdn
+      ("Smess::#{out_class.to_s.camelize}").constantize.new
+    end
+
+    def deliver_sms(sms)
+      out = output_for sms.to
+      if out.respond_to? :deliver_sms
+        out.deliver_sms sms
+      else
+        nil
+      end
+    end
+
+  end
+end

data/lib/smess/outputs/clickatell.rb

@@ -0,0 +1,115 @@
+require 'clickatell'
+
+# This hack should be removed soon
+module Clickatell
+  class API
+
+    def send_message(recipient, message_text, opts={})
+      valid_options = opts.only(:from, :mo, :callback, :climsgid, :concat)
+      valid_options.merge!(:req_feat => '48') if valid_options[:from]
+      valid_options.merge!(:mo => '1') if opts[:set_mobile_originated]
+      valid_options.merge!(:climsgid => opts[:client_message_id]) if opts[:client_message_id]
+      valid_options[:deliv_ack] = 1 if opts[:callback]
+      recipient = recipient.join(",")if recipient.is_a?(Array)
+      response = execute_command('sendmsg', 'http',
+        {:to => recipient, :text => message_text}.merge(valid_options)
+      )
+      response = parse_response(response)
+      #response.is_a?(Array) ? response.map { |r| r['ID'] } : response['ID']
+    end
+
+  end
+end
+
+
+module Smess
+  class Clickatell
+    include Smess::Logging
+
+    def initialize
+      ::Clickatell::API.debug_mode = true
+      ::Clickatell::API.secure_mode = true
+    end
+
+    def split_sms(text)
+      return [text] unless text.sms_length > 160
+      logger.debug "message text is long"
+
+      result = []
+      while text.sms_length > 160
+        logger.debug end_char = text.rindex(/[\n\r]/, 160)
+        part = text[0..end_char]
+        result << part
+        text = text[(end_char+1)..text.length]
+      end
+      result << text
+      result
+    end
+
+    def sender_not_supported(sms)
+      sms.to[0] == "1" || # USA
+      sms.to[0..2] == "962" || # Jordan
+      sms.to[0..2] == "971" # UAE
+    end
+    def concat_not_supported(sms)
+      sms.to[0] == "1" # USA
+    end
+
+
+
+    def deliver_sms(sms)
+      return false unless sms.kind_of? Sms
+      @sms = sms
+
+      api = ::Clickatell::API.authenticate(
+        ENV["SMESS_CLICKATELL_API_ID"],
+        ENV["SMESS_CLICKATELL_USER"],
+        ENV["SMESS_CLICKATELL_PASS"]
+      )
+      message = sms.message.strip_nongsm_chars.encode('ISO-8859-1')
+      from = ENV["SMESS_CLICKATELL_SENDER_IDS"].split(",").include?(sms.originator) ? sms.originator : ENV["SMESS_CLICKATELL_SENDER_ID"]
+
+      # Pretty pretty "feature detection"
+      if sender_not_supported sms
+        from = nil
+      end
+      if concat_not_supported sms
+        message_array = split_sms(message)
+      end
+
+      begin
+        if concat_not_supported sms
+          response = nil
+          message_array.each do |msg|
+            rsp = api.send_message(sms.to, msg, {:from => from, :concat => 3, :callback => 7})
+            response = rsp if response.nil?
+          end
+        else
+          response = api.send_message(sms.to, message, {:from => from, :concat => 3, :callback => 7})
+        end
+      rescue Exception => e
+        logger.warn response
+        # connection problem or some error
+        result = {
+          :response_code => '-1',
+          :response  => {
+            :temporaryError =>'true',
+            :responseCode => e.code,
+            :responseText => e.message
+          },
+          :data => {:to => sms.to, :text => sms.message.strip_nongsm_chars, :from => from}
+        }
+        return result
+      end
+      # Successful response
+      result = {
+        :message_id => response['ID'],
+        :response_code => '0',
+        :response => response,
+        :destination_address => sms.to,
+        :data => {:to => sms.to, :text => sms.message.strip_nongsm_chars, :from => from}
+      }
+    end
+
+  end
+end