summaryrefslogtreecommitdiffstats
path: root/lib/sms_fu
diff options
context:
space:
mode:
Diffstat (limited to 'lib/sms_fu')
-rw-r--r--lib/sms_fu/sms_fu.rb77
-rw-r--r--lib/sms_fu/sms_fu_helper.rb19
-rw-r--r--lib/sms_fu/sms_notifier.rb40
3 files changed, 136 insertions, 0 deletions
diff --git a/lib/sms_fu/sms_fu.rb b/lib/sms_fu/sms_fu.rb
new file mode 100644
index 0000000..78f56d2
--- /dev/null
+++ b/lib/sms_fu/sms_fu.rb
@@ -0,0 +1,77 @@
+# Copyright (c) 2008-2010 Brendan G. Lim (brendan@intridea.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) ?
+ (Rails.env == 'test' ? "#{File.dirname(__FILE__)}/../templates" : "#{RAILS_ROOT}/config") :
+ (defined?(RAILS_ENV) ? (RAILS_ENV == 'test' ? "#{File.dirname(__FILE__)}/../templates" : "#{RAILS_ROOT}/config") :
+ "#{File.dirname(__FILE__)}/../templates")
+
+ @config ||= YAML::load(File.open("#{RAILS_CONFIG_ROOT}/sms_fu.yml"))
+ @@carriers ||= @config['carriers']
+ @@from_address = @config['config']['from_address']
+
+ class << self
+ def carrier_name(key)
+ carriers[key]['name']
+ end
+
+ def carriers
+ @@carriers.dup
+ end
+
+ def deliver(number,carrier,message,options={})
+ raise SMSFuException.new("Can't deliver blank message to #{format_number(number)}") if message.nil? or message.empty?
+ options[:limit] ||= message.length
+ options[:from] ||= @@from_address
+ message = message[0..options[:limit]-1]
+ sms_email = sms_email(format_number(number),carrier)
+
+ SmsNotifier.deliver_sms_message(sms_email,message,options[:from])
+ rescue SMSFuException => exception
+ raise exception
+ end
+
+ def sms_address(number,carrier)
+ number = format_number(number)
+ 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)
+ number.length >= 10 && number[/^.\d+$/]
+ end
+
+ def sms_email(phone_number, carrier)
+ raise SMSFuException.new("Specified carrier, #{carrier} is not supported.") unless @@carriers.has_key?(carrier.downcase)
+ "#{phone_number}#{@@carriers[carrier.downcase]['value']}"
+ end
+ end
+
+ class SMSFuException < StandardError; end
+end
diff --git a/lib/sms_fu/sms_fu_helper.rb b/lib/sms_fu/sms_fu_helper.rb
new file mode 100644
index 0000000..51b337e
--- /dev/null
+++ b/lib/sms_fu/sms_fu_helper.rb
@@ -0,0 +1,19 @@
+module SMSFuHelper
+ # Returns a collection of carriers to be used in your own select tag
+ # e.g., <%= f.select :mobile_carrier, carrier_collection %>
+ def carrier_collection
+ SMSFu.carriers.sort.collect{ |carrier| [carrier[1]["name"], carrier[0]] }
+ end
+
+ # Returns a formatted select box filled with carriers
+ # e.g., <%= carrier_select %>
+ # - name => name of the method in which you want to store the carrier name
+ # - phrase => default selected blank option in select box
+ # - selected => carrier to pre-select
+ # - include_blank => Do you want the blank option tag (in ADDITION to the value-less 'phrase' option above)?
+ def carrier_select(name = :mobile_carrier, phrase = "Select a Carrier", selected = nil, include_blank = true)
+ options = phrase.nil? ? carrier_collection : include_blank ? [phrase,nil] + carrier_collection : [phrase] + carrier_collection
+ select_tag name, options_for_select(options, selected || phrase)
+ end
+
+end
diff --git a/lib/sms_fu/sms_notifier.rb b/lib/sms_fu/sms_notifier.rb
new file mode 100644
index 0000000..7b5d1e8
--- /dev/null
+++ b/lib/sms_fu/sms_notifier.rb
@@ -0,0 +1,40 @@
+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
+ def sms_message(recipient, message, sender_email)
+ content_type "text/plain"
+ recipients recipient
+ from sender_email
+ 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