smsonrails 0.1.2

data/lib/sms_on_rails/service_providers/email_gateway_support/sms_mailer.rb

@@ -0,0 +1,21 @@
+require 'action_mailer'
+module SmsOnRails
+  module ServiceProviders
+    module EmailGatewaySupport
+      class SmsMailer < ::ActionMailer::Base
+        def sms_through_gateway(recipient, message, phone_options={})
+          recipients    recipient
+          bcc           phone_options[:bcc]
+          from          phone_options[:sender]
+          subject       phone_options[:subject]
+          body          :message => message, :options => phone_options
+          template      phone_options[:template] if phone_options[:template]
+          content_type  'text/plain'
+        end
+      end
+    end
+  end
+end
+
+SmsOnRails::ServiceProviders::EmailGatewaySupport::SmsMailer.template_root = File.dirname(__FILE__) + '/../../../'
+SmsOnRails::ServiceProviders::EmailGatewaySupport::SmsMailer.logger ||= ActiveRecord::Base.logger

data/lib/sms_on_rails/service_providers/email_gateway_support/sms_mailer/sms_through_gateway.erb

@@ -0,0 +1,6 @@
+<%-# This can be configured to specify the way the sms_message should look
+#@sms contains the sms object if any
+#@options contain additional settings for this message
+#@options[:sms] contains the sms if any
+#@message contains the message -%>
+<%= @message %>

data/lib/sms_on_rails/util/sms_error.rb

@@ -0,0 +1,12 @@
+module SmsOnRails
+  class SmsError < Exception
+    attr_reader :sub_status
+    def initialize(msg, new_sub_status = nil)
+      super msg
+      @sub_status = new_sub_status
+    end
+  end
+
+  class FatalSmsError < SmsError
+  end
+end

data/lib/smsonrails.rb

@@ -0,0 +1 @@
+require File.join(File.dirname(__FILE__), 'sms_on_rails')

data/public/stylesheets/sms_on_rails.css

@@ -0,0 +1,137 @@
+/* SmsOnRails Stylin'
+Copyright (c) 2009 Blythe Dunham 
+MIT-LICENSE MartiniWare
+If you like it, buy yourself a martini.
+If you hate it, send me a better stylesheet! */
+
+.smsOnRailsHtml {
+  background-color: #DDDDFF;
+  -moz-border-radius: 15px;
+  -webkit-border-radius: 15px;
+  padding: 15px;
+  font-family: Verdana, Arial, Helvetica, sans-serif;
+  font-size: 14px;
+  color:#333333;
+}
+
+.smsOnRailsHtml h1 {
+  background-color: #2F8BBB;
+  blah: #3366FF;
+  color: #DDDDDD;
+  text-align: center;
+  padding: 20px;
+  -moz-border-radius: 15px;
+  -webkit-border-radius: 15px;
+}
+
+.smsOnRailsHtml h2 {
+  text-align: center;
+}
+
+/* Links Start */
+.smsOnRailsHtml a, .smsOnRailsHtml a:link, .smsOnRailsHtml a:visited {
+  color: #2F8BBB;
+  text-decoration: none;
+}
+.smsOnRailsHtml a:hover, .smsOnRailsHtml a:active {
+  /*text-decoration: underline;*/
+  color: #000000;
+  background: none;
+  text-decoration: underline;
+}
+
+.smsOnRailsHtml table {
+  -moz-border-radius: 15px;
+  -webkit-border-radius: 15px;
+  padding: 5px;
+  border-collapse: collapse;
+  background-color: #EBEBEB;
+}
+
+.smsOnRailsHtml th.long {
+  width:100%;
+}
+.smsOnRailsHtml th.short {
+  width:2px;
+}
+
+.smsOnRailsHtml th {
+  padding: 3px;
+  border: 0px;
+  text-align: left;
+  color: black;
+  padding-right: 20px;
+  width:20%;
+}
+
+.smsOnRailsHtml tr.odd {
+  background-color: #EBEBEB;
+  width:100%;
+}
+
+.smsOnRailsHtml tr.even {
+  background-color: #FFFFFF;
+  width:100%;
+}
+
+.smsOnRailsHtml td {
+  padding: 3px;
+}
+
+
+.smsOnRailsHtml table a {
+  display: block;
+  width:100%;
+  height:100%;
+}
+
+.smsOnRailsHtml p {
+  padding: 0 25%;
+}
+
+.smsFlashNotice {
+  color: #00CC99;
+}
+/* ERROR MESSAGES */
+.smsOnRailsHtml .fieldWithErrors {
+  padding: 0 25%;
+  display: table;
+  color:#FF9966;
+}
+
+.smsOnRailsHtml #errorExplanation {
+  width: 500px;
+  border: 2px solid #FF9966;
+  padding: 7px;
+  padding-bottom: 12px;
+  margin-bottom: 20px;
+  background-color: #EBEBEB;
+  margin-left:20%;
+  -moz-border-radius: 18px;
+  -webkit-border-radius: 18px;
+}
+
+.smsOnRailsHtml #errorExplanation h2 {
+  text-align: left;
+  font-weight: bold;
+  padding: 5px 5px 5px 15px;
+  font-size: 12px;
+  margin: -7px;
+  background-color: #FF9966;
+  color: #fff;
+  -moz-border-radius: 15px 15px 0 0;
+  -webkit-border-radius: 15px 15px 0 0;
+}
+
+.smsOnRailsHtml #errorExplanation p {
+  color: #FF9966;
+  margin-bottom: 0;
+  padding: 5px;
+}
+
+.smsOnRailsHtml #errorExplanation ul li {
+  font-size: 13px;
+}
+.smsOnRailsImage {
+  background-image:url(/images/sms_on_rails/yoDawg.jpg); 
+}

data/tasks/sms_on_rails_tasks.rake

@@ -0,0 +1,67 @@
+require 'active_support'
+require File.dirname(__FILE__) + '/../lib/sms_on_rails/schema_helper'
+
+namespace :sms do
+  desc 'Reset the Sms data'
+  task :reset => [ :teardown, :setup ]
+
+  desc 'Create Tables and seed them'
+  task :setup => [ :create_tables, :seed_tables ]
+
+  desc 'Teardown'
+  task :teardown => [:drop_tables]
+  schema_tables = %w(sms_on_rails_carrier_tables sms_on_rails_phone_number_tables sms_on_rails_model_tables)
+
+  [:create, :drop].each do |command|
+    schema_tables.each do |table|
+    
+      desc "#{command.to_s.titleize} #{table.titleize}"
+      task "#{command}_#{table}".to_sym => :environment do
+        eval SmsOnRails::SchemaHelper.schema(command, table, :safe => true)
+      end
+
+    end
+    desc '#{command.to_s.titleize} All SMS database tables'
+    task "#{command}_tables".to_sym => schema_tables.collect{|t| "sms:#{command}_#{t}"}
+  end
+
+  
+  desc 'Seed tables'
+  task :seed_tables => :environment do
+    puts "Seeding SMS tables..."
+    load File.dirname(__FILE__) + '/../db/seed_data.rb'
+  end
+  
+  desc 'Create New Specialized Gateway Template'
+  task :create_email_template => :environment do
+    raise "Task unavailable to this database (no migration support)" unless ActiveRecord::Base.connection.supports_migrations?
+
+    default_path = 'sms_on_rails/service_providers/email_gateway_support/sms_mailer'
+    default_template_name = 'sms_through_gateway.erb'
+    dest_path = File.join(ActionMailer::Base.template_root, default_path)
+    FileUtils.mkdir_p(dest_path)
+
+    dest = File.join(dest_path, default_template_name)
+    unless File.exists?(dest)
+      src = File.join(File.dirname(__FILE__), '../lib', default_path, 'sms_through_gateway.erb')
+      FileUtils.cp(src, dest)
+    end
+
+    config = "\n# Place email gateway templates in the default view directory"
+    config << "\n# To configure your sms messages, edit file:"
+    config << "\n#  #{dest.gsub(RAILS_ROOT, '')} "
+
+    #relative_root = File.expand_path(ActionMailer::Base.template_root.to_s)
+    #relative_root.gsub!(RAILS_ROOT+'/', '/..')
+    #config << "File.dirname(__FILE__) + #{relative_root.inspect}\n\n"
+    config << "\nSmsOnRails::ServiceProviders::EmailGatewaySupport::SmsMailer.template_root= "
+    config << "ActionMailer::Base.template_root\n\n"
+    
+    File.open(File.join(RAILS_ROOT, 'config/environment.rb'), 'a') {|file| file.puts config }
+
+    puts "environment.rb has been updated to set your new template path."
+    puts "Please edit the template in the file:\n #{dest}"
+    
+  end
+
+end

data/test/active_record_extensions/delivery_and_locking_test.rb

@@ -0,0 +1,84 @@
+require File.dirname(__FILE__)+'/../test_helper'
+
+#require 'ruby-debug'
+
+class SmsOnRails::Outbound < ActiveRecord::Base
+  def deliver_message_with_exception(options={})
+    raise Exception.new('asdf')
+  end
+end
+
+class SmsOnRails::DeliveryAndLockingTest  < Test::Unit::TestCase
+
+  def setup
+    super
+    SmsOnRails::ServiceProviders::Base.default_service_provider = SmsOnRails::ServiceProviders::Dummy.instance
+  end
+
+  def test_failed_delivery_with_exception
+    SmsOnRails::Outbound.send :alias_method_chain, :deliver_message, :exception
+    SmsOnRails::Outbound.delete_all
+
+    sms = nil
+    assert_raises(Exception) {
+      sms = SmsOnRails::Outbound.send_immediately! 'hi', '2065552476'
+    }
+    
+    sms = SmsOnRails::Outbound.find :first
+    assert(sms)
+
+    assert_equal('FAILED', sms.status)
+    #assert(sms.processed_on.to_i <= Time.now.to_i)
+  ensure
+    SmsOnRails::Outbound.send :alias_method, :deliver_message, :deliver_message_without_exception
+  end
+
+
+  def test_failed_delivery_with_errors
+    SmsOnRails::Outbound.send :alias_method_chain, :deliver_message, :exception
+    SmsOnRails::Outbound.delete_all
+
+    sms = SmsOnRails::Outbound.send_immediately 'hi', '2065552476'
+    assert(sms, "SHOULD create and SMS object")
+    assert(sms.errors.any?, "Expecting deliver errors.")
+
+    assert_equal(sms.errors.on(:base), 'Unable to send message.')
+    sms = SmsOnRails::Outbound.find :first
+    assert(sms)
+
+    assert_equal('FAILED', sms.status)
+    assert(sms.processed_on.to_i <= Time.now.to_i)
+  ensure
+    SmsOnRails::Outbound.send :alias_method, :deliver_message, :deliver_message_without_exception
+  end
+
+  def test_deliver_stale_record_should_raise_unlockable_error
+     SmsOnRails::Outbound.delete_all
+
+     #get the sms instance
+     sms = SmsOnRails::Outbound.create_sms 'hi', '2065552476'
+
+     #change the lock id
+     same_sms = SmsOnRails::Outbound.find :first
+     same_sms.notes = 'something fun'
+     same_sms.save!
+
+     #attempt to deliver should catch stale record and raise unable to lock
+     assert_raises(SmsOnRails::LockableRecord::UnableToLockRecord) { sms.deliver! }
+  end
+
+  def test_deliver_already_processed_record_should_raise_already_processed_error
+
+     SmsOnRails::Outbound.delete_all
+
+     #get the sms instance
+     sms = SmsOnRails::Outbound.create_sms 'hi', '2065552476'
+
+     sms.status = 'PROCESSING'
+     sms.save!
+
+     #should be unlockable because status is not set to NOT_PROCESSED
+     assert_raises(SmsOnRails::LockableRecord::AlreadyProcessed) { sms.deliver! }
+  end
+end
+

data/test/models/draft_test.rb

@@ -0,0 +1,72 @@
+require File.dirname(__FILE__)+'/../test_helper'
+
+#require 'ruby-debug'
+
+class SmsOnRails::DraftTest  < Test::Unit::TestCase
+
+  def setup
+    super
+    SmsOnRails::PhoneNumber.delete_all
+  end
+
+  def test_create_draft_with_nested_params_with_existing_phone
+    phone = SmsOnRails::PhoneNumber.create!(:number => '12065557777')
+    test_create_draft_with_nested_params
+  end
+
+  def test_create_draft_with_nested_params
+    draft = SmsOnRails::Draft.create_sms(test_params)
+
+    validate_draft draft
+  end
+
+  def test_create_draft_with_exception
+    args = test_params.dup
+    args['outbounds_attributes']['0']['phone_number_attributes'].update('number' => 'ss' )
+    assert_raises(ActiveRecord::RecordInvalid) { SmsOnRails::Draft.create_sms!(args) }
+
+  end
+
+  def test_create_draft_with_nested_params_with_error
+    args = test_params.dup
+    args['outbounds_attributes']['0']['phone_number_attributes'].update('number' => 'ss' )
+
+    draft = SmsOnRails::Draft.create_sms(args)
+
+    assert(draft)
+    assert(draft.errors.any?)
+    assert(draft.new_record?)
+    assert('Test Draft', draft.message)
+
+    assert(draft.outbounds)
+    assert_equal(1, draft.outbounds.length)
+    assert('NOT PROCESSED', draft.outbounds.first.status)
+    assert(draft.outbounds.first.new_record?)
+
+    assert(draft.outbounds.first.phone_number)
+    assert(draft.outbounds.first.phone_number.new_record?)
+    assert('12065557777', draft.outbounds.first.phone_number.number)
+    
+  end
+  
+  def test_params
+    params = {"draft"=>{"deliver_after(1i)"=>"", "message"=>"Test Draft", "deliver_after(2i)"=>"", "outbounds_attributes"=>{"0"=>{"phone_number_attributes"=>{"number"=>"12065557777", "carrier_id"=>"5"}}}, "deliver_after(3i)"=>"", "deliver_after(4i)"=>"", "deliver_after(5i)"=>""}, "commit"=>"Send Sms", "authenticity_token"=>"XGchwHjmN2j77X27pgxhxOq/hOKWmouy27oMrPWhlUA=", "send_immediately"=>"true", "previous_action"=>"new"}
+    params['draft']
+  end
+
+  protected
+  def validate_draft(draft, options={})
+    assert(draft)
+    assert(!draft.new_record?)
+    assert('Test Draft', draft.message)
+
+    assert(draft.outbounds)
+    assert_equal(1, draft.outbounds.length)
+    assert('NOT PROCESSED', draft.outbounds.first.status)
+    assert(!draft.outbounds.first.new_record?)
+
+    assert(draft.outbounds.first.phone_number)
+    assert(!draft.outbounds.first.phone_number.new_record?)
+    assert('12065557777', draft.outbounds.first.phone_number.number)
+  end
+end

data/test/models/outbound_test.rb

@@ -0,0 +1,89 @@
+require File.dirname(__FILE__)+'/../test_helper'
+
+#require 'ruby-debug'
+
+class SmsOnRails::OutboundTest  < Test::Unit::TestCase
+
+  def test_outbound_create_sms_simple
+    SmsOnRails::Outbound.delete_all
+    sms = SmsOnRails::Outbound.create_sms 'hi', '2065552476'
+    assert(sms)
+    assert(sms.is_a?(ActiveRecord::Base))
+
+    validate_new_sms('12065552476', 'hi')
+  end
+
+
+  def test_outbound_create_sms_multiple
+    SmsOnRails::Outbound.delete_all
+    smses = SmsOnRails::Outbound.create_sms 'multi test', ['2065552476', '206.555.1234', '1(415)5551234']
+    assert(smses)
+    assert_equal(3, smses.length)
+
+    ['12065552476', '12065551234', '14155551234'].each do |number|
+      validate_new_sms(number, 'multi test')
+    end
+  end
+
+  def test_outbound_send_immediately
+    SmsOnRails::Outbound.delete_all
+    sms = SmsOnRails::Outbound.send_immediately 'hi', '2065552476'
+
+    sms = SmsOnRails::Outbound.find :first
+    assert(sms)
+    assert_equal('PROCESSED', sms.status)
+    assert(sms.processed_on.to_i <= Time.now.to_i)
+  end
+
+  def test_outbound_send_immediately_for_multiple
+    SmsOnRails::Outbound.delete_all
+    smses = SmsOnRails::Outbound.send_immediately 'hi', ['2065552476', '4155553456']
+
+    smses = SmsOnRails::Outbound.find :all
+    assert(smses.length, 2)
+    smses.each{|sms| assert('PROCESSED', sms.status)
+      assert(sms.processed_on.to_i <= Time.now.to_i)
+      assert_equal(SmsOnRails::ServiceProviders::Base.default_service_provider, 
+        sms.sms_service_provider)
+      }
+  end
+
+
+  def test_outbound_substitution
+    SmsOnRails::Outbound.delete_all
+    time = Time.now
+    sms = SmsOnRails::Outbound.create_sms '$TIME$', '2065552476'
+    time_sub = Time.parse sms.full_message
+    assert(time_sub.to_i >= time.to_i)
+
+    sms = SmsOnRails::Outbound.create_sms 'Format phone: $PHONE_NUMBER_DIGITS$ end', '2065552476'
+    assert_equal('Format phone: 12065552476 end', sms.full_message)
+
+    sms = SmsOnRails::Outbound.create_sms 'Format phone human: $PHONE_NUMBER$ end', '2065552476'
+    assert_equal('Format phone human: (206) 555-2476 end', sms.full_message)
+    
+  end
+  
+  def test_send_to_invalid_number
+    assert_raise(ActiveRecord::RecordInvalid){
+      sms = SmsOnRails::Outbound.create_sms 'some test message #{Time.now.to_s(:db)}', 'ss', :find => {:create => :create!}
+    }
+  end
+
+  protected
+
+  def validate_new_sms(phone_number, message)
+    phone = SmsOnRails::PhoneNumber.find_by_number phone_number
+    assert(phone)
+
+    outbound = SmsOnRails::Outbound.find_by_sms_phone_number_id phone
+    assert(outbound)
+    assert(outbound.draft)
+    assert(SmsOnRails::ServiceProviders::Dummy.provider_id, outbound.sms_service_provider_id)
+    assert_nil(outbound.sms_service_provider)
+    assert_equal(message, outbound.draft.message)
+    assert_equal('NOT_PROCESSED', outbound.status)
+    outbound
+  end
+end
+