sms_safe 1.0.0

data/gemfiles/mail_2_5_4.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "action_texter", "0.2.0", :git => "git://github.com/mstycom/action_texter.git"
+gem "mail", "2.5.4"
+
+gemspec :path => "../"

data/gemfiles/mail_2_5_4.gemfile.lock

@@ -0,0 +1,106 @@
+GIT
+  remote: git://github.com/mstycom/action_texter.git
+  revision: 75dea6a6dffe3e69082f1e2b50403f0e6c567119
+  specs:
+    action_texter (0.2.0)
+
+PATH
+  remote: ../
+  specs:
+    sms_safe (0.1.0)
+      mail (>= 2.4)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (4.2.0)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    ansi (1.4.3)
+    appraisal (1.0.2)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    builder (3.2.2)
+    codeclimate-test-reporter (0.4.3)
+      simplecov (>= 0.7.1, < 1.0.0)
+    coveralls (0.7.1)
+      multi_json (~> 1.3)
+      rest-client
+      simplecov (>= 0.7)
+      term-ansicolor
+      thor
+    docile (1.1.5)
+    i18n (0.7.0)
+    json (1.8.1)
+    jwt (1.0.0)
+    mail (2.5.4)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    metaclass (0.0.4)
+    mime-types (1.25.1)
+    minitest (5.5.0)
+    minitest-reporters (1.0.8)
+      ansi
+      builder
+      minitest (>= 5.0)
+      ruby-progressbar
+    mocha (1.1.0)
+      metaclass (~> 0.0.1)
+    multi_json (1.10.1)
+    netrc (0.10.2)
+    nexmo (2.0.0)
+    polyglot (0.3.5)
+    rake (10.4.2)
+    rest-client (1.7.2)
+      mime-types (>= 1.16, < 3.0)
+      netrc (~> 0.7)
+    ruby-progressbar (1.7.1)
+    shoulda (3.5.0)
+      shoulda-context (~> 1.0, >= 1.0.1)
+      shoulda-matchers (>= 1.4.1, < 3.0)
+    shoulda-context (1.2.1)
+    shoulda-matchers (2.7.0)
+      activesupport (>= 3.0.0)
+    simplecov (0.9.1)
+      docile (~> 1.1.0)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.8.0)
+    simplecov-html (0.8.0)
+    term-ansicolor (1.3.0)
+      tins (~> 1.0)
+    thor (0.19.1)
+    thread_safe (0.3.4)
+    tins (1.3.3)
+    treetop (1.4.15)
+      polyglot
+      polyglot (>= 0.3.1)
+    twilio-ruby (3.14.2)
+      builder (>= 2.1.2)
+      jwt (~> 1.0.0)
+      multi_json (>= 1.3.0)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  action_texter (= 0.2.0)!
+  appraisal
+  bundler
+  codeclimate-test-reporter
+  coveralls
+  mail (= 2.5.4)
+  minitest
+  minitest-reporters
+  mocha
+  nexmo
+  rake
+  shoulda
+  simplecov
+  sms_safe!
+  twilio-ruby

data/gemfiles/mail_2_6_1.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "action_texter", "0.2.0", :git => "git://github.com/mstycom/action_texter.git"
+gem "mail", "2.6.1"
+
+gemspec :path => "../"

data/gemfiles/mail_2_6_1.gemfile.lock

@@ -0,0 +1,101 @@
+GIT
+  remote: git://github.com/mstycom/action_texter.git
+  revision: 75dea6a6dffe3e69082f1e2b50403f0e6c567119
+  specs:
+    action_texter (0.2.0)
+
+PATH
+  remote: ../
+  specs:
+    sms_safe (0.1.0)
+      mail (>= 2.4)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (4.2.0)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    ansi (1.4.3)
+    appraisal (1.0.2)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    builder (3.2.2)
+    codeclimate-test-reporter (0.4.3)
+      simplecov (>= 0.7.1, < 1.0.0)
+    coveralls (0.7.1)
+      multi_json (~> 1.3)
+      rest-client
+      simplecov (>= 0.7)
+      term-ansicolor
+      thor
+    docile (1.1.5)
+    i18n (0.7.0)
+    json (1.8.1)
+    jwt (1.0.0)
+    mail (2.6.1)
+      mime-types (>= 1.16, < 3)
+    metaclass (0.0.4)
+    mime-types (2.4.3)
+    minitest (5.5.0)
+    minitest-reporters (1.0.8)
+      ansi
+      builder
+      minitest (>= 5.0)
+      ruby-progressbar
+    mocha (1.1.0)
+      metaclass (~> 0.0.1)
+    multi_json (1.10.1)
+    netrc (0.10.2)
+    nexmo (2.0.0)
+    rake (10.4.2)
+    rest-client (1.7.2)
+      mime-types (>= 1.16, < 3.0)
+      netrc (~> 0.7)
+    ruby-progressbar (1.7.1)
+    shoulda (3.5.0)
+      shoulda-context (~> 1.0, >= 1.0.1)
+      shoulda-matchers (>= 1.4.1, < 3.0)
+    shoulda-context (1.2.1)
+    shoulda-matchers (2.7.0)
+      activesupport (>= 3.0.0)
+    simplecov (0.9.1)
+      docile (~> 1.1.0)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.8.0)
+    simplecov-html (0.8.0)
+    term-ansicolor (1.3.0)
+      tins (~> 1.0)
+    thor (0.19.1)
+    thread_safe (0.3.4)
+    tins (1.3.3)
+    twilio-ruby (3.14.2)
+      builder (>= 2.1.2)
+      jwt (~> 1.0.0)
+      multi_json (>= 1.3.0)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  action_texter (= 0.2.0)!
+  appraisal
+  bundler
+  codeclimate-test-reporter
+  coveralls
+  mail (= 2.6.1)
+  minitest
+  minitest-reporters
+  mocha
+  nexmo
+  rake
+  shoulda
+  simplecov
+  sms_safe!
+  twilio-ruby

data/gemfiles/mail_2_6_3.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "action_texter", "0.2.0", :git => "git://github.com/mstycom/action_texter.git"
+gem "mail", "2.6.3"
+
+gemspec :path => "../"

data/gemfiles/mail_2_6_3.gemfile.lock

@@ -0,0 +1,101 @@
+GIT
+  remote: git://github.com/mstycom/action_texter.git
+  revision: 75dea6a6dffe3e69082f1e2b50403f0e6c567119
+  specs:
+    action_texter (0.2.0)
+
+PATH
+  remote: ../
+  specs:
+    sms_safe (0.1.0)
+      mail (>= 2.4)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (4.2.0)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    ansi (1.4.3)
+    appraisal (1.0.2)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    builder (3.2.2)
+    codeclimate-test-reporter (0.4.3)
+      simplecov (>= 0.7.1, < 1.0.0)
+    coveralls (0.7.1)
+      multi_json (~> 1.3)
+      rest-client
+      simplecov (>= 0.7)
+      term-ansicolor
+      thor
+    docile (1.1.5)
+    i18n (0.7.0)
+    json (1.8.1)
+    jwt (1.0.0)
+    mail (2.6.3)
+      mime-types (>= 1.16, < 3)
+    metaclass (0.0.4)
+    mime-types (2.4.3)
+    minitest (5.5.0)
+    minitest-reporters (1.0.8)
+      ansi
+      builder
+      minitest (>= 5.0)
+      ruby-progressbar
+    mocha (1.1.0)
+      metaclass (~> 0.0.1)
+    multi_json (1.10.1)
+    netrc (0.10.2)
+    nexmo (2.0.0)
+    rake (10.4.2)
+    rest-client (1.7.2)
+      mime-types (>= 1.16, < 3.0)
+      netrc (~> 0.7)
+    ruby-progressbar (1.7.1)
+    shoulda (3.5.0)
+      shoulda-context (~> 1.0, >= 1.0.1)
+      shoulda-matchers (>= 1.4.1, < 3.0)
+    shoulda-context (1.2.1)
+    shoulda-matchers (2.7.0)
+      activesupport (>= 3.0.0)
+    simplecov (0.9.1)
+      docile (~> 1.1.0)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.8.0)
+    simplecov-html (0.8.0)
+    term-ansicolor (1.3.0)
+      tins (~> 1.0)
+    thor (0.19.1)
+    thread_safe (0.3.4)
+    tins (1.3.3)
+    twilio-ruby (3.14.2)
+      builder (>= 2.1.2)
+      jwt (~> 1.0.0)
+      multi_json (>= 1.3.0)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  action_texter (= 0.2.0)!
+  appraisal
+  bundler
+  codeclimate-test-reporter
+  coveralls
+  mail (= 2.6.3)
+  minitest
+  minitest-reporters
+  mocha
+  nexmo
+  rake
+  shoulda
+  simplecov
+  sms_safe!
+  twilio-ruby

data/lib/sms_safe.rb

@@ -0,0 +1,10 @@
+require 'sms_safe/config'
+require 'sms_safe/interceptor'
+require 'sms_safe/message'
+require 'sms_safe/version'
+
+require 'sms_safe/interceptors/action_texter'
+require 'sms_safe/interceptors/twilio'
+require 'sms_safe/interceptors/nexmo'
+
+require 'sms_safe/hooks' # Must be at the end, it needs access to all the other classes

data/lib/sms_safe/config.rb

@@ -0,0 +1,49 @@
+module SmsSafe
+
+  class InvalidConfigSettingError < StandardError; end
+
+  def self.configuration
+    @configuration ||=  Configuration.new
+  end
+
+  def self.configure
+    yield(configuration) if block_given?
+  end
+
+  class Configuration
+
+    # List of phone numbers that can accept SMS. Any phone number not on this list will get the SMS intercepted
+    # Leaving this empty means *all* SMS are intercepted, which is a valid use case.
+    # Value can be a String, a Regex, or a Proc to determine whether the phone is internal or not.
+    # Value can also be an Array, in which case the SMS will be allowed to go through if *any* of the entries match.
+    attr_accessor :internal_phone_numbers
+
+    # What to do with intercepted messages.
+    # Options are:
+    #   :redirect - send SMS to another number. Must set redirect_target option
+    #   :email - send an Email instead. Must set email_target option.
+    #   :discard - don't send anything. May want to set discard_delay if simulating load
+    attr_accessor :intercept_mechanism
+
+    # The target number where messages are redirected, if intercept mechanism is :redirect
+    # Value can be a string or a Proc that returns a string
+    attr_accessor :redirect_target
+
+    # The target email where messages are sent, instead of sending SMS, if intercept mechanism is :email
+    # Value can be a string or a Proc that returns a string
+    attr_accessor :email_target
+
+    # If you are doing stress testing, you don't want to send out millions of SMS or Emails, so discarding is the
+    #   way to go. However, this may give you an unrealistic view of how many SMS you can send per minute, distorting
+    #   the results of the stress test. Discard delay introduces a little `sleep` whilst discarding, to compensate for that.
+    # Defaults to 50ms
+    # Specify it in ms
+    attr_accessor :discard_delay
+
+    def initialize
+      @internal_phone_numbers = []
+      @intercept_mechanism = 'redirect'
+      @discard_delay = 50 # 50 milliseconds
+    end
+  end
+end

data/lib/sms_safe/hooks.rb

@@ -0,0 +1,60 @@
+
+module SmsSafe
+
+  # Hooks into the specified texter gem to be able to analyze and modify / discard messages before they are sent.
+  #   Uses a civilized method for :action_texter, and monkey_patching for the rest, unfortunately
+  # @param [Symbol] texter_gem the gem that is being used for sending messages.
+  #   Can be :action_texter, :twilio, or :nexmo
+  # @return Nothing useful
+  def self.hook!(texter_gem)
+    case texter_gem
+      when :action_texter
+        ActionTexter.register_interceptor(SmsSafe::Interceptors::ActionTexter.new)
+      when :twilio
+        hook_twilio!
+      when :nexmo
+        hook_nexmo!
+      else
+        raise InvalidConfigSettingError.new("Ensure texter_gem is either :action_texter, :twilio or :nexmo")
+    end
+  end
+
+  private
+
+  # Hooks into Nexmo's message sending method to allows us to intercept.
+  #   Uses monkeypatching, unfortunately.
+  def self.hook_nexmo!
+    Nexmo::Client.class_eval do
+      alias_method :sms_safe_original_send_message, :send_message
+
+      def send_message(params)
+        interceptor = SmsSafe::Interceptors::Nexmo.new
+        new_message = interceptor.process_message(params)
+        if new_message.nil?
+          return new_message
+        else
+          return sms_safe_original_send_message(new_message)
+        end
+      end
+    end
+  end
+
+  # Hooks into Twilio's message sending method to allows us to intercept.
+  #   Uses monkeypatching, unfortunately.
+  def self.hook_twilio!
+    Twilio::REST::Messages.class_eval do
+      # There is no method to alias, the gem relies on method_missing on a base class...
+      #alias_method :sms_safe_original_send_message, :send_message
+
+      def create(params)
+        interceptor = SmsSafe::Interceptors::Twilio.new
+        new_message = interceptor.process_message(params)
+        if new_message.nil?
+          return new_message
+        else
+          return super(new_message)
+        end
+      end
+    end
+  end
+end