sms_safe 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 995545e18c459164e07f01bd321450729f95dfe7
+  data.tar.gz: 631d83f2446e3736b1aadb0c9a78eaaea73b3738
+SHA512:
+  metadata.gz: 2e3a1c3a4b4fbc0eb61da46600242b4eaf94b536c35fad468b9b750b937dbe77ab8117d474326fca45bbf01315d474f7de286953e58a0e86f61fd216f3bf98fc
+  data.tar.gz: ee2bd5071bc7684b0b794ff4b00785470aaf5e81db29b003fef34b6672ef4c3abab50d67ec284a98d909eb1c0e07b49f06ee729873f063e5b467e2c3b84ee456

data/.gitignore

@@ -0,0 +1,7 @@
+.DS_Store
+.idea
+*.gem
+coverage
+Gemfile.lock
+.yardoc
+doc

data/.travis.yml

@@ -0,0 +1,18 @@
+language: ruby
+rvm:
+  - "1.9.3"
+  - "2.0.0"
+  - "2.1.1"
+  - "2.1.2"
+  - "2.1.3"
+  - "2.1.5"
+  # Test in all the platforms that "mail" (our main dependency) tests on
+
+gemfile:
+  - gemfiles/mail_2_6_3.gemfile
+  - gemfiles/mail_2_6_1.gemfile
+  - gemfiles/mail_2_5_4.gemfile
+  - gemfiles/mail_2_5_3.gemfile
+  - gemfiles/mail_2_4_4.gemfile
+
+script: bundle exec rake test_with_coveralls

data/Appraisals

@@ -0,0 +1,19 @@
+appraise "mail-2-6-3" do
+  gem "mail", "2.6.3"
+end
+
+appraise "mail-2-6-1" do
+  gem "mail", "2.6.1"
+end
+
+appraise "mail-2-5-4" do
+  gem "mail", "2.5.4"
+end
+
+appraise "mail-2-5-3" do
+  gem "mail", "2.5.3"
+end
+
+appraise "mail-2-4-4" do
+  gem "mail", "2.4.4"
+end

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sms_safe.gemspec
+gemspec
+
+gem 'action_texter', '0.2.0', :git => 'git://github.com/mstycom/action_texter.git'

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2014, Daniel Magliola
+
+MIT License
+
+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,173 @@
+# SmsSafe
+
+[![Build Status](https://travis-ci.org/dmagliola/sms_safe.svg?branch=master)](https://travis-ci.org/dmagliola/sms_safe)
+[![Coverage Status](https://coveralls.io/repos/dmagliola/sms_safe/badge.png?branch=master)](https://coveralls.io/r/dmagliola/sms_safe?branch=master)
+[![Code Climate](https://codeclimate.com/github/dmagliola/sms_safe/badges/gpa.svg)](https://codeclimate.com/github/dmagliola/sms_safe)
+[![Inline docs](http://inch-ci.org/github/dmagliola/sms_safe.svg?branch=master&style=flat)](http://inch-ci.org/github/dmagliola/sms_safe)
+[![Gem Version](https://badge.fury.io/rb/sms_safe.png)](http://badge.fury.io/rb/sms_safe)
+[![Dependency Status](https://gemnasium.com/dmagliola/sms_safe.svg)](https://gemnasium.com/dmagliola/sms_safe)
+
+
+SMS safe provides a safety net while you're developing an application that sends SMS.
+It keeps SMS messages from escaping into the wild.
+
+Inspired by [MailSafe](https://rubygems.org/gems/mail_safe), it is essentially "MailSafe for SMS".
+
+Once you've installed and configured this gem, you can rest assured that your app won't send
+SMS messages to external phone numbers.
+
+Messages going to your own, internal phone numbers will still go through normally, however, anything else will
+either get sent to you instead (via SMS or Email), or discarded.
+
+## Download
+
+Gem: `gem install sms_safe`
+
+## Installation
+
+Load the gem in the appropriate environments in your GemFile. For example, I'm loading this in Gemfile as:
+
+  `gem "sms_safe", group: [:development, :staging]`
+
+IMPORTANT: Be sure not to load this in your production environment, otherwise, your SMS won't be sent to the proper
+recipients. In your test environment, you may or may not want this depending on how you are dealing with SMS right now.
+
+We recommend using [ActionTexter](https://rubygems.org/gems/action_texter) to send your SMS, which already provides
+for a very good way of switching SMS off in your test environment, while giving you testable objects that you can use
+to check your logic.
+
+
+## Configuration
+
+You should configure SmsSafe in the same initializer that you use for your SMS, so you can make sure that it runs
+after your Texter gem has been configured.
+
+```
+SmsSafe.configure do |config|
+  config.internal_phone_numbers = ['+12223334444', '+447111222222']
+  config.intercept_mechanism = :redirect
+  config.redirect_target = '+12223334444'
+end
+
+SmsSafe.hook!(:action_texter) # or :twilio or :nexmo
+
+```
+
+Call hook! **after** setting the configuration for your texter gem.
+
+The configuration specifies:
+
+- **internal_phone_numbers:** SMS sent to these numbers will be sent normally. These can be specified
+       as a String, Regex, Proc, or an array of the same. Any phone number that doesn't match these is
+       considered external, and its SMS will get intercepted. If left empty, **all** SMS will be intercepted.
+- **intercept_mechanism:** Whether to `:redirect` (default), `:email` or `:discard` the SMS sent to an external number.
+- **redirect_target:** If `:redirect`ing, SMS will be sent to this number instead of the original recipient.
+      Can be a String or a Proc
+- **email_target:** If `:email`ing, SMS will be sent as an e-mail to this e-mail address. Can be a String or a Proc
+- **discard_delay:** [ms] If `:discard`ing, a delay this long will be introduced, for slightly more realistic
+      performance characteristics.
+
+
+## Interception mechanisms
+
+When an SMS is being sent to a phone number that is not recognized as internal, it gets intercepted
+and it will be processed according to the `intercept_mechanism` configured.
+
+**IMPORTANT!**
+
+If you choose to `:email` or `:discard` instead of `:redirect`ing, then when you send a message
+the return value from your texter gem can be nil if the SMS does get intercepted.
+You need to account for that, and consider it a successful send for your app logic.
+
+
+### Redirection
+
+SMS will be sent anyway, but to the number specified by `redirect_target`.
+
+A string "(SmsSafe: #{original_phone_number})" will be added, so you know it was meant for a different number.
+
+### Emailing
+
+Instead of sending the SMS, an e-mail will be sent to the address specified by `email_target`, describing all the information about the SMS.
+This is useful in dev / staging as a less annoying alternative to SMS'ing yourself, and also
+for teams, since multiple people may end up having access to the e-mail, as opposed to an SMS.
+
+### Discarding
+
+In some cases, you just don't care, you simply don't want to be notified. This is particularly useful
+if you are doing load testing / stress testing, where millions of SMS / emails might end up being sent to you.
+
+For this scenario, we include the `discard_delay` setting, which will make the "sending" take longer
+than a simple discard. You should set this to an average value that your SMS provider exhibits. This way,
+even if you are queueing SMS sending using Resque / DelayedJob, you can still check that, when dealing with
+a real load, your queue workers can keep up with the demand.
+
+
+## Supported Libraries
+
+SmsSafe can currently hook into the following texter gems:
+
+- **[ActionTexter](https://rubygems.org/gems/action_texter)**
+- [Nexmo](https://rubygems.org/gems/nexmo)
+- [Twilio Ruby](https://rubygems.org/gems/twilio-ruby)
+
+Of these 3, ActionTexter is the only one that provides useful functionality for automated testing,
+and functionality for interceptors / observers. It also works natively with both Twilio and Nexmo,
+so we recommend it extensively.
+
+For Nexmo and Twilio Ruby, unfortunately, the way we hook is by monkey-patching them. This works,
+but it's not ideal, so we recommend using ActionTexter if you can.
+
+If you would like the SmsSafe functionality but you use another SMS provider / gem, you can add the new provider
+and submit a Pull Request (see bottom of README), add the new provider to [ActionTexter](https://github.com/watu/action_texter),
+or just ask, I'd like to extend this gem as much as possible.
+
+
+## Version Compatibility and Continuous Integration
+
+Tested with [Travis](https://travis-ci.org/dmagliola/sms_safe) using Ruby 1.9.3, 2.0, 2.1.1, 2.1.2, 2.1.3 and 2.1.5,
+ and against mail 2.6.3, 2.6.1, 2.5.4, 2.5.3 and 2.4.4.
+
+To locally run tests do:
+
+````
+appraisal rake test
+```
+
+## Copyright
+
+Copyright (c) 2014, 2015, Daniel Magliola
+
+See LICENSE for details.
+
+
+## Users
+
+This gem is being used by:
+
+- [MSTY](https://www.msty.com)
+- You? please, let us know if you are using this gem.
+
+
+## Changelog
+
+### Version 1.0.0 (Jan 2nd, 2015)
+- Newly released gem, supports ActionTexter, Nexmo and Twilio.
+- Still waiting to make sure Mail configuration works transparently for both Mail and ActionMailer.
+- Also waiting to figure out how to get Coveralls to recognize the true coverage (aka 100%)
+
+
+## Contributing
+
+1. Fork it
+1. Create your feature branch (`git checkout -b my-new-feature`)
+1. Code your thing
+1. Write and run tests:
+        bundle install
+        appraisal
+        appraisal rake test
+1. Write documentation and make sure it looks good: yard server --reload
+1. Add items to the changelog, in README.
+1. Commit your changes (`git commit -am "Add some feature"`)
+1. Push to the branch (`git push origin my-new-feature`)
+1. Create new Pull Request

data/Rakefile

@@ -0,0 +1,15 @@
+require "rubygems"
+require "bundler/setup"
+require "bundler/gem_tasks"
+
+require "rake/testtask"
+Rake::TestTask.new do |t|
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test
+
+require 'coveralls/rake/task'
+Coveralls::RakeTask.new
+task :test_with_coveralls => ["test", "coveralls:push"]

data/gemfiles/mail_2_4_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.4.4"
+
+gemspec :path => "../"

data/gemfiles/mail_2_4_4.gemfile.lock

@@ -0,0 +1,107 @@
+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.4.4)
+      i18n (>= 0.4.0)
+      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.4.4)
+  minitest
+  minitest-reporters
+  mocha
+  nexmo
+  rake
+  shoulda
+  simplecov
+  sms_safe!
+  twilio-ruby

data/gemfiles/mail_2_5_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.5.3"
+
+gemspec :path => "../"

data/gemfiles/mail_2_5_3.gemfile.lock

@@ -0,0 +1,107 @@
+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.3)
+      i18n (>= 0.4.0)
+      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.3)
+  minitest
+  minitest-reporters
+  mocha
+  nexmo
+  rake
+  shoulda
+  simplecov
+  sms_safe!
+  twilio-ruby