From f04b37c5fadbe2f4058782280cc622461b901c0d Mon Sep 17 00:00:00 2001 From: Brendan G. Lim Date: Mon, 23 Aug 2010 23:09:01 -0400 Subject: Reorganizing for gem --- init.rb | 7 +--- lib/sms_fu.rb | 84 +++------------------------------------------ lib/sms_fu/sms_fu.rb | 77 +++++++++++++++++++++++++++++++++++++++++ lib/sms_fu/sms_fu_helper.rb | 19 ++++++++++ lib/sms_fu/sms_notifier.rb | 40 +++++++++++++++++++++ lib/sms_fu_helper.rb | 19 ---------- lib/sms_notifier.rb | 40 --------------------- rails/init.rb | 2 ++ sms_fu.gemspec | 53 ++++++++++++++++++++++++++++ 9 files changed, 196 insertions(+), 145 deletions(-) create mode 100644 lib/sms_fu/sms_fu.rb create mode 100644 lib/sms_fu/sms_fu_helper.rb create mode 100644 lib/sms_fu/sms_notifier.rb delete mode 100644 lib/sms_fu_helper.rb delete mode 100644 lib/sms_notifier.rb create mode 100644 rails/init.rb create mode 100644 sms_fu.gemspec diff --git a/init.rb b/init.rb index c5555d9..2644663 100644 --- a/init.rb +++ b/init.rb @@ -1,6 +1 @@ -require 'actionmailer' -require 'sms_fu' -require 'sms_fu_helper' - -ActionController::Base.send(:include, SMSFu) -ActionView::Base.send(:include, SMSFuHelper) +require File.dirname(__FILE__) + "/rails/init" \ No newline at end of file diff --git a/lib/sms_fu.rb b/lib/sms_fu.rb index 3e17b78..38ca789 100644 --- a/lib/sms_fu.rb +++ b/lib/sms_fu.rb @@ -1,81 +1,5 @@ -require 'yaml' +require 'sms_fu/sms_fu' +require 'sms_fu/sms_notifier' +require 'sms_fu/sms_fu_helper' require 'action_mailer' -require 'sms_notifier' - -# 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 +require 'yaml' \ No newline at end of file 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 diff --git a/lib/sms_fu_helper.rb b/lib/sms_fu_helper.rb deleted file mode 100644 index 51b337e..0000000 --- a/lib/sms_fu_helper.rb +++ /dev/null @@ -1,19 +0,0 @@ -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_notifier.rb b/lib/sms_notifier.rb deleted file mode 100644 index 7b5d1e8..0000000 --- a/lib/sms_notifier.rb +++ /dev/null @@ -1,40 +0,0 @@ -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 diff --git a/rails/init.rb b/rails/init.rb new file mode 100644 index 0000000..c9ffe9b --- /dev/null +++ b/rails/init.rb @@ -0,0 +1,2 @@ +require 'sms_fu' +ActionView::Base.send(:include, SMSFuHelper) diff --git a/sms_fu.gemspec b/sms_fu.gemspec new file mode 100644 index 0000000..f3847c0 --- /dev/null +++ b/sms_fu.gemspec @@ -0,0 +1,53 @@ +# -*- encoding: utf-8 -*- + +Gem::Specification.new do |s| + s.name = %q{sms_fu} + s.version = "1.0.3" + + s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version= + s.authors = ["Brendan G. Lim"] + s.date = %q{2010-08-23} + s.description = %q{sms_fu allows you to send free text messages to a mobile recipient.} + s.email = %q{brendangl@gmail.com} + s.extra_rdoc_files = [ + "README.rdoc" + ] + s.files = [ + "CHANGELOG", + "MIT-LICENSE", + "README.rdoc", + "Rakefile", + "VERSION", + "init.rb", + "install.rb", + "lib/sms_fu.rb", + "lib/sms_fu/sms_fu.rb", + "lib/sms_fu/sms_fu_helper.rb", + "lib/sms_fu/sms_notifier.rb", + "sms_fu.gemspec", + "tasks/sms_fu_tasks.rake", + "templates/sms_fu.yml", + "test/sms_fu_test.rb", + "uninstall.rb", + "views/sms_notifier/sms_message.html.erb" + ] + s.has_rdoc = true + s.homepage = %q{http://github.com/brendanlim/sms-fu} + s.rdoc_options = ["--charset=UTF-8"] + s.require_paths = ["lib"] + s.rubygems_version = %q{1.3.1} + s.summary = %q{sms_fu allows you to send free text messages to a mobile recipient using an e-mail to sms gateway.} + s.test_files = [ + "test/sms_fu_test.rb" + ] + + if s.respond_to? :specification_version then + current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION + s.specification_version = 2 + + if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then + else + end + else + end +end -- cgit v1.2.3