Class SmsOnRails::ServiceProviders::Base
In: lib/sms_on_rails/service_providers/base.rb
Parent: Object

Methods

assert_message_options!   check_do_not_send!   check_white_list!   deliver   find_or_create_phone_number   format_phone_number   get_service_provider   human_name   max_characters   name   phone_klass   provider_by_id   provider_by_name   provider_list   provider_map   requires_carrier?   send_message   send_sms   send_to_phone   sms_error_class  

Included Modules

Singleton

Protected Class methods

get_service_provider(provider)

Locate the service provider object by provider_id, string, symbol, or ServiceProvider object Defaults to the default service provider 

  SmsOnRails::ServiceProviders::Base.get_service_provider :dummy
  SmsOnRails::ServiceProviders::Base.get_service_provider 1
  SmsOnRails::ServiceProviders::Base.get_service_provider SmsOnRails::ServiceProviders::Dummy
human_name()

Human name of provider

name()

Name of service provider (downcase no spaces)

provider_by_id(provider_id)

Locate the service provider by provider id 

 Example: SmsOnRails::ServiceProviders::Base.provider_by_id 1
provider_by_name(provider_name)

Locate the service provider by name or symbol 

 Example: SmsOnRails::ServiceProviders::Base.provider_by_name :dummy
provider_list()

List of all providers available

provider_map()

Hash map of provider_id to the provider

Public Instance methods

deliver()

Deliver all the sms messages marked with this as its sms service provider

send_message(phone_number, message, options={})

Sends a message to a phone number directly to the provider. No validations are performed

  • phone_number the exact string text to send
  • message - the string message to send
  • options - additional options to be used by the provider
send_sms(sms, options={})

Send an Sms with validation sms is an sms active record object that responds to phone_number and full_message

Refer to send_to_phone for more infomation on validation

send_to_phone(phone_obj, message, options={})

Sends a message to a phone number active record object or string and performs validation on the phone_number

  • phone_number can be either a phone number active record obj or a string text. Strings are converted to phone_number objects
  • message - the message to send
  • options - additional options to be used by the provider

Options

:skip_validation - skips validation and sends the message directly to the provider

Protected Instance methods

assert_message_options!(phone_number, message, options)

Raise exception if invalid data is entered

check_do_not_send!(phone_number)

Raise an exception if this phone_number is marked as do not send

check_white_list!(phone_number)

Raise an exception if the white list is being used (only sends to people on this list) and this phone number is not on the list

find_or_create_phone_number(phone_text, options={})

can override in subclass if different finder should be used

format_phone_number(phone_number)

override this if the expected format differs in subclass

phone_klass()

The class used for phone numbers can be overwritten and specified in environment.rb

sms_error_class() {|| ...}

return the appropriate exception class Return a fatal error if the block returns true and a non fatal if the block returns false

[Validate]