jcnetdev-sms-fu 1.0.20080704

data/CHANGELOG

@@ -0,0 +1,77 @@
+commit f1026d0aca169caf57dd44e57661177bd66e2e37
+Author: Brendan G. Lim <brendan@intridea.com>
+Date:   Thu Jun 19 02:17:08 2008 -0400
+
+    Updating to be compatibile with Rails 2.1
+
+commit de241d15bfa878f600a462f49b4fd3c92285c3ab
+Author: Brendan G. Lim <brendan@intridea.com>
+Date:   Sat May 31 10:05:16 2008 -0700
+
+    Merging in changes from gcnovus for fixing warnings and redundant YAML parsing when requiring sms_fu more than once.
+
+commit d23d86216ffc5a6b44db5b354934f40178e9dfc0
+Author: Brendan G. Lim <brendan@intridea.com>
+Date:   Sat Apr 19 01:23:45 2008 -0500
+
+    Another update to README
+
+commit e8386f3b75f5f4794d5f280025772a34e79542ba
+Author: Brendan G. Lim <brendan@intridea.com>
+Date:   Sat Apr 19 01:23:17 2008 -0500
+
+    Another update to README
+
+commit d16925d6f60669d492005b419df212d26b3d21bd
+Author: Brendan G. Lim <brendan@intridea.com>
+Date:   Sat Apr 19 01:17:51 2008 -0500
+
+    Adding in kajeet to carrier list and updated README
+
+commit 9cf4ef9db332418dd167bd942f29ed34d11f20f9
+Author: Jannis Leidel <jannis@leidel.info>
+Date:   Sat Apr 12 13:40:30 2008 +0200
+
+    added some international carriers
+
+commit 364997b52bdb1c7ae8b3382b4742b5fbd52fb20c
+Author: Brendan G. Lim <brendan@intridea.com>
+Date:   Mon Mar 31 18:23:53 2008 -0400
+
+    Fixed indentation of README and minor tweak
+
+commit 5ecbaaee4d38543a66767b02d5b41ef9e885f2d5
+Author: Brendan G. Lim <brendan@intridea.com>
+Date:   Mon Mar 31 18:18:40 2008 -0400
+
+    Fixed some of the tests
+
+commit cb0138f5f1f637bcd5065e548b0dac04d413acd8
+Author: Brendan G. Lim <brendan@intridea.com>
+Date:   Mon Mar 31 17:58:07 2008 -0400
+
+    Quick fix for international numbers
+
+commit fc874c849ed5fb4f7b1e35b3e6b0e1496b95cf4f
+Author: Brendan G. Lim <brendan@intridea.com>
+Date:   Mon Mar 31 17:45:09 2008 -0400
+
+    Updating README with International carrier information
+
+commit 7813e59c8535f6180852a534fd0bfd7ba6085ace
+Author: Brendan G. Lim <brendan@intridea.com>
+Date:   Mon Mar 31 17:37:02 2008 -0400
+
+    Adding in international support and externalizing carrier list into sms_fu.yml
+
+commit 5393cc834ce85da8856ed8869e7b5e66b004239f
+Author: Brendan G. Lim <brendan@intridea.com>
+Date:   Sun Mar 30 19:01:20 2008 -0400
+
+    Made some readme changes
+
+commit aba05f07d765306b5bd5f6c403a318092a437c0b
+Author: Brendan G. Lim <brendan@intridea.com>
+Date:   Sun Mar 30 16:10:05 2008 -0400
+
+    Initial import

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Brendan G. Lim
+
+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.rdoc

@@ -0,0 +1,59 @@
+= SMS Fu
+
+Want to send an SMS from your Rails application?  SMS Fu allows you to do just that.  
+It allows you to send a text-message in the form of an e-mail to a cell phone on any
+of the supported carriers.
+
+== Supported Carriers (US & International): 
+
+Alltel, Ameritech, AT&T, BellSouth Mobility, BlueSkyFrog, Boost Mobile, Cellular South, 
+E-Plus, Fido, kajeet, Metro PCS, Powertel, PSC Wireless, Qwest, Southern Link, Sprint, 
+Suncom, T-Mobile (US/UK/Germany), Telefonica, Virgin Mobile, Verizon Wireless, 
+Vodafone (UK,Italy,Japan, Spain)
+
+== Setup Instructions
+
+Add this this one line to the controller you want to be able to use SMS Fu in.
+
+    class ExampleController < ApplicationController
+      include SMSFu
+    end
+
+Modify sms_fu.yml in your config folder with your reply-to e-mail address.
+
+That's it!  Now you're good to go.
+
+== Example Usage
+	
+* You have to send in the phone number, without any non-numeric characters.  The
+  phone numbers must be 10 digits in length.  
+* The two required parameters are the phone number and the phone carrier.
+* Here are some of the default carrier values:
+		
+    Alltel Wireless   =>  "alltel"
+    AT&T/Cingular     =>  "at&t"
+    Boost Mobile      =>  "boost"
+    Sprint Wireless   =>  "sprint"
+    T-Mobile US       =>  "t-mobile"
+    T-Mobile UK       =>  "t-mobile-uk"
+    Virgin Mobile     =>  "virgin"
+    Verizon Wireless  =>  "verizon"
+    Vodafone Tokyo    =>  "vodafone-jp-tokyo"
+
+* <b>Check sms_fu.yml for a complete list of supported carriers, including international
+  carriers as well.</b>
+		
+    deliver_sms("5558675309","at&t","your message here")
+		
+* You can set the maximum length of the SMS message, which is not set by
+  default.  Most phones can only accept 128 characters.  To do this just 
+  specify the limit option.
+		
+    deliver_sms("5558675309","at&t","your message here", :limit => 128)
+
+* You can retrieve just the formatted address to use in your own mailer.
+
+    get_sms_address("5558675309","at&t") # => "5558675309@txt.att.net"
+
+		
+Copyright (c) 2008 Brendan G. Lim, Intridea, Inc., released under the MIT license

data/Rakefile

@@ -0,0 +1,22 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the sms_fu plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the sms_fu plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'SmsFu'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/sms_fu.rb

@@ -0,0 +1,73 @@
+require 'yaml'
+require 'sms_notifier'
+# Copyright (c) 2008 Brendan G. Lim (brendangl@gmail.com)
+# 
+# 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.
+
+module SMSFu
+  RAILS_CONFIG_ROOT = defined?(RAILS_ROOT) ? "#{RAILS_ROOT}/config" : "#{File.dirname(__FILE__)}/../templates" unless defined?(RAILS_CONFIG_ROOT)
+  @config ||= YAML::load(File.open("#{RAILS_CONFIG_ROOT}/sms_fu.yml"))
+  @@carriers ||= @config['carriers']
+  
+  def self.carriers
+    @@carriers.dup
+  end
+  
+  def deliver_sms(number,carrier,message,options={})
+    number = format_number(number)
+    raise SMSFuException.new("Cannot deliver an empty message to #{number}") if message.nil? or message.empty?
+    
+    options[:limit] ||= message.length
+    message = message[0..options[:limit]-1]
+    sms_email = determine_sms_email(format_number(number),carrier)
+    
+    SmsNotifier.deliver_sms_message(sms_email,message)
+  rescue SMSFuException => exception
+    raise exception
+  end
+  
+  def get_sms_address(number,carrier)
+    number = format_number(number)
+    determine_sms_email(number,carrier)
+  end
+  
+  private
+  
+  def format_number(number)
+    pre_formatted = number.gsub("-","").strip
+    formatted =  (pre_formatted.length == 11 && pre_formatted[0,1] == "1") ? pre_formatted[1..pre_formatted.length] : pre_formatted
+
+    return is_valid?(formatted) ? formatted : (raise SMSFuException.new("Phone number (#{number}) is not formatted correctly"))
+  end
+  
+  def is_valid?(number)
+    return (number.length >= 10 && number[/^.\d+$/]) ? true : false
+  end  
+  
+  def determine_sms_email(phone_number, carrier)
+    if @@carriers.has_key?(carrier.downcase)
+      "#{phone_number}#{@@carriers[carrier.downcase]}"
+    else 
+      raise SMSFuException.new("Specified carrier, #{carrier} is not supported.")
+    end
+  end 
+       
+  class SMSFuException < StandardError; end
+end

data/lib/sms_notifier.rb

@@ -0,0 +1,45 @@
+require 'yaml'
+# Copyright (c) 2008 Brendan G. Lim (brendangl@gmail.com)
+# 
+# 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.
+
+class SmsNotifier < ActionMailer::Base
+  @config = YAML::load(File.open("#{RAILS_ROOT}/config/sms_fu.yml"))
+  @@from_address = @config['config']['from_address']
+  cattr_accessor :from_address
+
+  def sms_message(recipient, message)
+    content_type      "text/plain"
+    recipients        recipient
+    from              from_address
+    
+    body['message'] = message
+  end
+
+  view_path = File.join(File.dirname(__FILE__), '..', 'views')
+  if public_methods.include?('append_view_path')
+    self.append_view_path view_path
+  elsif public_methods.include?("view_paths")
+    self.view_paths << view_path
+  else
+    self.template_root = view_path
+  end
+  
+end

data/rails/init.rb

@@ -0,0 +1,3 @@
+require "action_mailer"
+require File.dirname(__FILE__) + '/lib/sms_fu' 
+ActionView::Base.send(:include, SMSFu)

data/sms-fu.gemspec

@@ -0,0 +1,33 @@
+Gem::Specification.new do |s|
+  s.name = 'sms-fu'
+  s.version = '1.0.20080704'
+  s.date = '2008-07-04'
+  
+  s.summary = "Easily send SMS messages from Rails"
+  s.description = "Want to send an SMS from your Rails application?  SMS Fu allows you to do just that. It allows you to send a text-message in the form of an e-mail to a cell phone on any of the supported carriers."
+  
+  s.authors = ['Brendan G. Lim']
+  s.email = 'brendan@intridea.com'
+  s.homepage = 'http://github.com/brendanlim/sms-fu'
+  
+  s.has_rdoc = true
+  s.rdoc_options = ["--main", "README"]
+  s.extra_rdoc_files = ["README.rdoc"]
+
+  s.add_dependency 'rails', ['>= 2.1']
+  
+  s.files = ["CHANGELOG",
+             "MIT-LICENSE",
+             "README.rdoc",
+             "Rakefile",
+             "lib/sms_fu.rb",
+             "lib/sms_notifier.rb",
+             "rails/init.rb",
+             "sms-fu.gemspec",
+             "templates/sms_fu.yml",
+             "views/sms_notifier/sms_message.html.erb"]
+  
+  
+  s.test_files = ["test/sms_fu_test.rb"]
+
+end

data/templates/sms_fu.yml

@@ -0,0 +1,52 @@
+config:
+  from_address: noreply@domain.com
+  
+carriers:
+  # US Carriers
+  alltell: @message.alltell.com
+  ameritech: @paging.acswireless.com  
+  at&t: @txt.att.net
+  bellsouthmobility: @blsdcs.net
+  blueskyfrog: @blueskyfrog.com
+  boost: @myboostmobile.com
+  cellularsouth: @csouth1.com
+  kajeet: @mobile.kajeet.net
+  metropcs: @mymetropcs.com
+  powertel: @ptel.net
+  pscwireless: @sms.pscel.com
+  qwest: @qwestmp.com
+  southernlink: @page.southernlinc.com
+  sprint: @messaging.sprintpcs.com
+  suncom: @tms.suncom.com
+  t-mobile: @tmomail.net
+  virgin: @vmobl.net
+  verizon: @vtext.com
+  # International Carriers
+  e-plus-germany: @smsmail.eplus.de
+  fido-canada: @fido.ca
+  o2-germany: @o2online.de
+  o2-uk: @mmail.co.uk
+  orange-netherlands: @sms.orange.nl
+  orange-uk: @orange.net
+  t-mobile-austria: @sms.t-mobile.at
+  t-mobile-germany: @t-d1-sms.de
+  t-mobile-uk: @t-mobile.uk.net
+  telefonica-spain: @movistar.net
+  vodafone-germany: @vodafone-sms.de
+  vodafone-uk: @sms.vodafone.net
+  vodafone-italy: @sms.vodafone.it
+  vodafone-jp-chuugoku: @n.vodafone.ne.jp
+  vodafone-jp-hokkaido: @d.vodafone.ne.jp
+  vodafone-jp-hokuriko: @r.vodafone.ne.jp
+  vodafone-jp-kansai: @k.vodafone.ne.jp
+  vodafone-jp-osaka: @k.vodafone.ne.jp
+  vodafone-jp-kanto: @k.vodafone.ne.jp
+  vodafone-jp-koushin: @k.vodafone.ne.jp
+  vodafone-jp-tokyo: @k.vodafone.ne.jp
+  vodafone-jp-kyuushu: @q.vodafone.ne.jp
+  vodafone-jp-okinawa: @q.vodafone.ne.jp
+  vodafone-jp-shikoku: @s.vodafone.ne.jp
+  vodafone-jp-touhoku: @h.vodafone.ne.jp
+  vodafone-jp-niigata: @h.vodafone.ne.jp
+  vodafone-jp-toukai: @h.vodafone.ne.jp
+  vodafone-spain: @vodafone.es

data/test/sms_fu_test.rb

@@ -0,0 +1,23 @@
+require 'test/unit'
+require 'sms_fu'
+
+class SmsFuTest < Test::Unit::TestCase
+  include SMSFu
+  
+  def test_validity_of_number
+    assert_raise(SMSFuException) { deliver_sms("456789011","AT&T","Message") }
+    assert_equal("5555555555@txt.att.net", get_sms_address("1-555-555-5555","AT&T"))
+  end
+
+  def test_international_number
+    assert_equal("+445555555555@txt.att.net", get_sms_address("+44-555-555-5555","AT&T"))
+  end
+  
+  def test_handling_of_blank_message
+    assert_raise(SMSFuException) { deliver_sms("1234567890","AT&T","") }
+  end
+
+  def test_get_sms_address
+    assert_equal("1234567890@txt.att.net", get_sms_address("1234567890","AT&T"))
+  end
+end

data/views/sms_notifier/sms_message.html.erb

@@ -0,0 +1 @@
+<%= @message %>

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification 
+name: jcnetdev-sms-fu
+version: !ruby/object:Gem::Version 
+  version: 1.0.20080704
+platform: ruby
+authors: 
+- Brendan G. Lim
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-07-04 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rails
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "2.1"
+    version: 
+description: Want to send an SMS from your Rails application?  SMS Fu allows you to do just that. It allows you to send a text-message in the form of an e-mail to a cell phone on any of the supported carriers.
+email: brendan@intridea.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- CHANGELOG
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- lib/sms_fu.rb
+- lib/sms_notifier.rb
+- rails/init.rb
+- sms-fu.gemspec
+- templates/sms_fu.yml
+- views/sms_notifier/sms_message.html.erb
+has_rdoc: true
+homepage: http://github.com/brendanlim/sms-fu
+post_install_message: 
+rdoc_options: 
+- --main
+- README
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Easily send SMS messages from Rails
+test_files: 
+- test/sms_fu_test.rb