activesms 0.0.2 → 0.6.0

data/CHANGELOG

@@ -0,0 +1,3 @@
+*0.0.1*
+
+* Initial release [Robert Cottrell]

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2007 Robert Cottrell
+
+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 PURPOa AND
+NONINFRINGEMENT. IN NO EVENT SaALL 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/Manifest.txt

@@ -1,12 +1,31 @@
+CHANGELOG
 History.txt
 License.txt
+MIT-LICENSE
 Manifest.txt
 README.txt
 Rakefile
+generators/sms/USAGE
+generators/sms/sms_generator.rb
+generators/sms/templates/fixture.rhtml
+generators/sms/templates/model.rb
+generators/sms/templates/unit_test.rb
+init.rb
 lib/activesms.rb
+lib/activesms/adv_attr_accessor.rb
+lib/activesms/base.rb
+lib/activesms/connection_adapters/abstract_adapter.rb
+lib/activesms/connection_adapters/bulk_sms_adapter.rb
+lib/activesms/connection_adapters/clickatell_adapter.rb
+lib/activesms/connection_adapters/simplewire_adapter.rb
+lib/activesms/connections.rb
+lib/activesms/exceptions.rb
+lib/activesms/sms.rb
+lib/activesms/validations.rb
 lib/activesms/version.rb
 scripts/txt2html
 setup.rb
+test/connection_adapters/test_simplewire_adapter.rb
 test/test_activesms.rb
 test/test_helper.rb
 website/index.html

data/generators/sms/USAGE

@@ -0,0 +1,19 @@
+Active SMS Generator
+
+Description:
+    The SMS generator creates stubs for a new SMS model.
+    
+    The generator takes an SMS model name and a list of SMS methods as
+    arguments.  The model name may be given in CamelCase or under_score.
+    
+    The generator creates an SMS model class in app/models and a test suite
+    with fixtures in test/unit.
+    
+Example:
+    ./script/generate sms Notifier signup forgot_password
+    
+    This will create a Nofier SMS class:
+        Model:     app/models/notifier.rb
+        Test:      test/unit/notifier_test.rb
+        Fixtures:  test/fixtures/notifier/signup
+                   test/fixtures/notifier/forgot_password

data/generators/sms/sms_generator.rb

@@ -0,0 +1,31 @@
+class SmsGenerator < Rails::Generator::NamedBase
+  def manifest
+    record do |m|
+      # Check for class naming collisions.
+      m.class_collisions class_path, class_name, "#{class_name}Test"
+      
+      # Create model, view, test, and fixture directories.
+      m.directory File.join('app/models', class_path)
+      m.directory File.join('test/unit', class_path)
+      m.directory File.join('test/fixtures', file_path)
+      
+      # Create model class and unit test.
+      m.template "model.rb", File.join('app/models',
+                                       class_path,
+                                       "#{file_name}.rb")
+      m.template "unit_test.rb", File.join('test/unit',
+                                            class_path,
+                                            "#{file_name}_test.rb")
+
+      # Create fixture for each action.
+      actions.each do |action|
+        relative_path = File.join(file_path, action)
+        fixture_path  = File.join('test/fixtures', relative_path)
+        
+        m.template "fixture.rhtml", fixture_path,
+                   :assigns => { :action => action, :path => fixture_path }
+      end 
+    end
+  end
+
+end

data/generators/sms/templates/fixture.rhtml

@@ -0,0 +1 @@
+<%= class_name %>#<%= action %>

data/generators/sms/templates/model.rb

@@ -0,0 +1,11 @@
+class <%= class_name %> < ActiveSms::Base
+<% actions.each do |action| -%>
+
+  def <%= action %>
+    @recipients = ''
+    @from       = ''
+    @body       = "<%= class_name %>#<%= action %>"
+    @options    = {}
+  end
+<% end -%>
+end

data/generators/sms/templates/unit_test.rb

@@ -0,0 +1,31 @@
+require File.dirname(__FILE__) + '<%= '/..' * class_nesting_depth %>/../test_helper'
+
+class <%= class_name %>Test < Test::Unit::TestCase
+  FIXTURES_PATH = File.dirname(__FILE__) + '<%= '/..' * class_nesting_depth %>/../fixtures'
+  
+  def setup
+    ActiveSms::Base.delivery_method = :test
+    ActiveSms::Base.perform_deliveries = true
+    ActiveSms::Base.deliveries = []
+    
+    @expected = ActiveSms::Sms.new
+  end
+  
+<% actions.each do |action| -%>
+  def test_<%= action %>
+    @expected.recipients = ''
+    @expected.from = ''
+    @expected.body = read_fixture('<%= action %>')
+    
+    actual = <%= class_name %>.create_<%= action %>
+    assert_equal @expected.recipients, actual.recipients
+    assert_equal @expected.from, actual.from
+    assert_equal @expected.body, actual.body
+  end
+  
+<% end -%>
+  private
+  def read_fixture(action)
+    IO.read("#{FIXTURES_PATH}/<%= file_path %>/#{action}")
+  end
+end

data/init.rb

@@ -0,0 +1,2 @@
+require 'activesms'
+ActiveSms::Base.logger = RAILS_DEFAULT_LOGGER

data/lib/activesms/adv_attr_accessor.rb

@@ -0,0 +1,32 @@
+module ActiveSms
+  module AdvAttrAccessor #:nodoc:
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+    
+    module ClassMethods #:nodoc:
+      def adv_attr_accessor(*names)
+        names.each do |name|
+          ivar = "@#{name}"
+          
+          define_method("#{name}=") do |value|
+            instance_variable_set(ivar, value)
+          end
+          
+          define_method(name) do |*parameters|
+            if parameters.length > 1
+              raise ArgumentError, "expected 0 or 1 parameters"
+            end
+            if parameters.empty?
+              if instance_variables.include?(ivar)
+                instance_variable_get(ivar)
+              end
+            else
+              instance_variable_set(ivar, parameters.first)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/activesms/base.rb

@@ -0,0 +1,217 @@
+require 'activesms/adv_attr_accessor'
+require 'activesms/sms'
+require 'net/https'
+
+module ActiveSms #:nodoc:
+  
+  # Active SMS allows you to send SMS messages from your application using
+  # an SMS model.
+  #
+  # = SMS models
+  #
+  # To use Action SMS, you need to create an SMS model.
+  #
+  #   $ script/generate sms Notifier signup
+  #
+  # The generated model inherits from ActiveSms::Base.  SMS messages are
+  # defined by creating methods on the model which are then used to set
+  # variables to be used in the message or to change options on the message.
+  #
+  # Examples:
+  #
+  #   class Notifier < ActiveSms::Base
+  #     def signup
+  #       recipients "447987654321"
+  #       from       "447123456789"
+  #       body       "Your account has been created"
+  #     end
+  #   end
+  #
+  # Sender methods have the following configuration methods available.
+  #
+  # * <tt>recipients</tt> - Takes one or more destination numbers.  These
+  #   numbers should be formatted in standard international number format.
+  #
+  # * <tt>from</tt> - Who the SMS message you are sending is from.  This
+  #   may be either a number formatted in standard internation number format,
+  #   or, if the gateway supports it, an alphanumeric origination.
+  #
+  # * <tt>body</tt> - The content of the message.  This must fit within the
+  #   length limitation of SMS messages.
+  #
+  # = Sending SMS messages
+  #
+  # Once an SMS action is defined, you can deliver you message or create it
+  # and save it for delivery later.
+  #
+  #   Notifier.deliver_signup_noification(david) # sends the SMS message
+  #
+  #   sms = Notifier.create_signup_notification(david) # an SMS object
+  #   Notifier.deliver(sms)
+  #
+  # You never instantiate your model class.  Rather, your delivery instance
+  # methods are automatically wrapped in class methods that start with the
+  # word <tt>deliver</tt> followed by the name of the SMS method that you
+  # would like to deliver.  The <tt>signup_notification</tt> method defined
+  # above is delivered by invoking <tt>Notifier.deliver_signup_notification</tt>.
+  #
+  # = Configuration options
+  #
+  # These options are specified on the class level.
+  #
+  # * <tt>logger</tt> - The logger is used for generating information about
+  #   the sending run if available.  This can be set to nil for no logging.
+  #   It is compatible with Ruby's own Logger and Log4r loggers.
+  #
+  # * <tt>gateway_settings</tt> - Allows detailed configuration of the SMS
+  #   gateway used to deliver the messages.  Some gateways may require
+  #   additional configuration settings.
+  #
+  # * <tt>raise_delivery_errors</tt> - Determines whether or not errors should
+  #   be raised if the SMS fails to be delivered.
+  #
+  # * <tt>delivery_method</tt> - Defines a delivery method.  Possible values
+  #   are :gateway (default) or :test.
+  #
+  # * <tt>perform_deliveries</tt> - Determines whether or not deliver_*
+  #   methods are actually carried out.  By default they are, but this can be
+  #   turned off to help functional testing.
+  #
+  # * <tt>deliveries</tt> - Keeps an array of all the messages sent out through
+  #   Active SMS with deliver_method :test.  Most useful for unit and functional
+  #   testing.
+  class Base
+    include AdvAttrAccessor
+    include ActionController::UrlWriter
+    
+    @@logger = nil
+    cattr_accessor :logger
+
+    private_class_method :new #:nodoc:
+
+    @@raise_delivery_errors = true
+    cattr_accessor :raise_delivery_errors
+    
+    @@delivery_method = :gateway
+    cattr_accessor :delivery_method
+    
+    @@perform_deliveries = true
+    cattr_accessor :perform_deliveries
+    
+    @@deliveries = []
+    cattr_accessor :deliveries
+    
+    # The recipient numbers for the message, either as a string (for a single
+    # recipient) or an array (for multiple recipients).
+    adv_attr_accessor :recipients
+    
+    # Specify the from number or identifier for the message.
+    adv_attr_accessor :from
+    
+    # Specify the subject of the message.
+    adv_attr_accessor :subject
+    
+    # The content of the message.
+    adv_attr_accessor :body
+    
+    # The Sms message object instance referenced by this model.
+    attr_reader :sms
+    
+    class << self
+      def method_missing(method_symbol, *parameters) #:nodoc:
+        case method_symbol.id2name
+          when /^create_([_a-z]\w+)/ then new($1, *parameters).sms
+          when /^deliver_([_a-z]\w+)/ then new($1, *parameters).deliver!
+          when "new" then nil
+          else super
+        end
+      end
+      
+      # Receives an SMS message, parses it into an SMS object, instantiates
+      # a new model, and passes the message object to the model object's
+      # #receive method.  If you want your model to be able to process
+      # incoming messages, you'll need to implement a #receive method
+      # that accepts the SMS object as a parameter.
+      #
+      #   class Notifier < ActionSms::Base
+      #     def receive(sms)
+      #       ...
+      #     end
+      #   end
+      def receive(sms)
+        sms = connection.parse(sms)
+        new.receive(sms)
+      end
+      
+      # Deliver the given Sms message object directly.  This can be used to
+      # deliver a preconstructed message, like:
+      #
+      #   sms = Notifier.create_signup_notification(parameters)
+      #   Notifier.deliver(sms)
+      def deliver(sms)
+        new.deliver!(sms)
+      end
+      
+    end
+      
+    # Instantiate a new Active SMS model object.  If +method_name+ is not
+    # +nil+, the model will be initialized according to the named method.
+    # If not, the model will remain uninitialized (useful when you need to
+    # invoke the "receive" method, for instance).
+    def initialize(method_name = nil, *parameters) #:nodoc:
+      create!(method_name, *parameters) if method_name
+    end
+      
+    # Initialize the model via the given +method_name+.  The body will be
+    # rendered and a new Sms object created.
+    def create!(method_name, *parameters) #:nodoc:
+      initialize_defaults(method_name)
+      send(method_name, *parameters)
+      
+      # Build the SMS object itself.
+      @sms = create_sms
+    end
+      
+    # Delivers an Sms message object.  By default, it deliver the cached object
+    # (from the #create! method).  If no cached object exists, and no
+    # alternate has been give as the prameter, this will fail.
+    def deliver!(sms = @sms) #:nodoc:
+      raise "no SMS object available for delivery!" unless sms
+      logger.info "Sending SMS: #{sms}" unless logger.nil?
+      
+      begin
+        send("perform_delivery_#{delivery_method}", sms) if perform_deliveries
+      rescue Exception => e
+        raise e if raise_delivery_errors
+      end
+      
+      return sms
+    end
+    
+    private
+    
+      # Set up the default values for the various instance variables of this
+      # model.  Subclasses may override this method to provide different
+      # defaults.
+      def initialize_defaults(method_name)
+      end
+    
+      def create_sms
+        sms = Sms.new
+        sms.recipients = recipients
+        sms.from = from
+        sms.body = body      
+        @sms = sms
+      end
+    
+      def perform_delivery_gateway(sms)
+        raise ConnectionNotEstablished unless connection
+        connection.deliver(sms)
+      end
+          
+      def perform_delivery_test(sms)
+        deliveries << sms
+      end
+
+  end
+end

data/lib/activesms/connection_adapters/abstract_adapter.rb

@@ -0,0 +1,52 @@
+require 'net/https'
+
+module ActiveSms #:nodoc:
+  module ConnectionAdapters #:nodoc:
+    # All the concrete gateway adapters follow the interface laid down in this
+    # class.  You can use this interface directly by borrowing the gateway
+    # connection from the Base with Base.connection.
+    class AbstractAdapter
+      
+      @logger = nil
+      attr_accessor :logger
+      
+      def initialize(logger = nil) #:nodoc:
+        @logger = logger
+      end
+      
+      # Return the human readable name of the gateway adapter.
+      def adapter_name
+        return 'Abstract'
+      end
+      
+      def deliver(sms)
+      end
+      
+      def parse(sms)
+        nil
+      end
+      
+      protected
+      
+      # Helper method to send an HTTP request to +url+ with paramaters
+      # specified by the +params+ hash.
+      def send_http_request(url, params)
+        uri = URI.parse(url)
+        req = Net::HTTP::Post.new(uri.path)
+        req.set_form_data(params)
+
+        http = Net::HTTP.new(uri.host, uri.port)
+        http.use_ssl = true if uri.scheme == 'https'
+        resp = http.start do
+          http.request(req)
+        end
+        @logger.info "Response: #{resp.body}" unless @logger.nil?
+        
+        return resp.body
+      rescue Exception => e
+        raise e
+      end
+      
+    end
+  end
+end

data/lib/activesms/connection_adapters/bulk_sms_adapter.rb

@@ -0,0 +1,67 @@
+require 'activesms/connection_adapters/abstract_adapter'
+
+module ActiveSms
+  class Base
+    def self.bulk_sms_connection(config) #:nodoc:
+      return ConnectionAdapters::BulkSmsAdapter.new(logger, config)
+    end
+  end
+  
+  module ConnectionAdapters
+    class BulkSmsAdapter < AbstractAdapter
+      
+      SERVICE_HOSTS = {
+        :international => 'bulksms.vsms.net',
+        :safrica       => 'bulksms.2way.co.za',
+        :spoin         => 'bulksms.com.es',
+        :uk            => 'www.bulksms.co.uk',
+        :usa           => 'usa.bulksms.com'
+      }
+      SERVICE_PORT = 5567
+      SERVICE_PATH = '/eapi/submission/send_sms/2/2.0'
+      
+      STATUS_MESSAGES = {
+         0 => 'in progress',
+         1 => 'scheduled',
+        22 => 'internal fatal error',
+        23 => 'authentication failure',
+        24 => 'data validation failed',
+        25 => 'insufficient credits',
+        26 => 'upstream credits not available',
+        27 => 'daily quota exceeded',
+        28 => 'upstream quota exceeded',
+        40 => 'temporarily unavailable'
+      }
+      
+      # Create an adapter for the BulkSMS gateway.
+      #
+      # Options:
+      # * <tt>:region</tt>
+      # * <tt>:username</tt>
+      # * <tt>:password</tt>
+      def initialize(logger = nil, config = {})
+        super(logger)
+        @config = config.dup
+        
+        host = SERVICE_HOSTS[config[:region]] || SERVICE_HOSTS[:uk]
+        @service_url = "http://#{host}:#{SERVICE_PORT}#{SERVICE_PATH}"
+      end
+      
+      # Return the human readable name of the connection adapter name.
+      def adpter_name
+        return 'BulkSMS'
+      end
+      
+      def deliver(sms)
+        params = {
+          :username => @config[:username],
+          :password => @config[:password],
+          :msisdn   => sms.recipients,
+          :message  => sms.body,
+        }
+        send_http_request(@service_url, params)
+      end
+      
+    end
+  end
+end

data/lib/activesms/connection_adapters/clickatell_adapter.rb

@@ -0,0 +1,51 @@
+require 'activesms/connection_adapters/abstract_adapter'
+
+module ActiveSms
+  class Base
+    def self.clickatell_connection(config) #:nodoc:
+      return ConnectionAdapters::ClickatellAdapter.new(logger, config)
+    end
+  end
+  
+  module ConnectionAdapters
+    class ClickatellAdapter < AbstractAdapter
+
+      SERVICE_HOST = "api.clickatell.com"
+      SERVICE_PATH = "/http/sendmsg"
+      
+      # Create an adapter for the Clickatell gateway.
+      #
+      # Options:
+      #
+      # * <tt>:user</tt>
+      # * <tt>:password</tt>
+      # * <tt>:api_id</tt>
+      # * <tt>use_ssl</tt>
+      def initialize(logger = nil, config = {})
+        super(logger)
+        @config = config.dup
+        
+        scheme = config[:use_ssl] ? "https" : "http"
+        @service_url = "#{scheme}://#{SERVICE_HOST}#{SERVICE_PATH}"
+      end
+      
+      # Return the human readable name of the gateway adapter name.
+      def adpter_name
+        return 'Clickatell'
+      end
+      
+      def deliver(sms)
+        params = {
+          :user     => @config[:user],
+          :password => @config[:password],
+          :api_id   => @config[:api_id],
+          :to       => sms.recipients,
+          :from     => sms.from,
+          :text     => sms.body
+        }
+        send_http_request(@service_url, params)
+      end
+    end
+    
+  end
+end

data/lib/activesms/connection_adapters/simplewire_adapter.rb

@@ -0,0 +1,58 @@
+require 'activesms/connection_adapters/abstract_adapter'
+
+begin
+  require 'java'
+  include_class 'com.simplewire.sms.SMS'
+rescue LoadError
+  puts "JRuby is required for the simplewire adapter"
+  raise $!
+end
+
+module ActiveSms
+  class Base
+    def self.simplewire_connection(config) #:nodoc:
+      return ConnectionAdapters::SimplewireAdapter.new(logger, config)
+    end
+  end
+  
+  module ConnectionAdapters
+    class SimplewireAdapter < AbstractAdapter
+
+      # Create a simplewire adapter. The config requires subscriber_id and subscriber_password.
+      def initialize(logger = nil, config = {})
+        super(logger)
+        @config = config.dup
+        @config.symbolize_keys!
+        
+        unless @config.member?(:subscriber_id) 
+          raise "subscriber_id is required for simplewire"
+        end
+        unless @config.member?(:subscriber_password) 
+          raise "subscriber_password is required for simplewire"
+        end
+      end
+      
+      # Return the human readable name of the gateway adapter name.
+      def adpter_name
+        return 'Simplewire'
+      end
+      
+      # Send the sms message using the simplewire adapter
+      def deliver(sms)
+        create_sms(sms).submit()
+      end
+      
+      def parse(sms)
+      end
+      
+      # Create the simplewire sms message to send
+      def create_sms(sms) 
+        s = SMS.new
+        s.destination_addr = sms.recipients
+        s.source_addr = sms.from
+        s.msg_text = sms.body
+        s
+      end
+    end
+  end
+end

data/lib/activesms/connections.rb

@@ -0,0 +1,64 @@
+module ActiveSms #:nodoc#
+    
+  class Base
+    @@connection = nil
+    
+    class << self
+      # Returns true if a connection that's accessible to this class has already
+      # been opened.
+      def connected?
+        return !@@connection.nil?
+      end
+          
+      # Returns the connection currently associated with the class.  This can
+      # also be used to "borrow" the connection to do work that is specific to
+      # a particular SMS gateway.
+      def connection
+        raise ConnectionNotEstablished unless @@connection
+        return @@connection
+      end
+      
+      # Set the gateway connection for the class.
+      def connection=(spec) #:nodoc:
+        raise ConnectionNotEstablished unless spec
+        @@connection = spec
+      end
+    
+      # Establishes the connection to the SMS gateway.  Accepts a hash as input
+      # where the :adapter key must be specified with the name of a gateway
+      # adapter (in lower-case)
+      #
+      #   ActiveSms::Base.establish_connection(
+      #     :adapter  => "clickatell",
+      #     :username => "myusername",
+      #     :password => "mypassword"
+      #     :api_id   => "myapiid"
+      #   )
+      #
+      # Also accepts keys as strings (for parsing from YAML, for example).
+      #
+      # The exceptions AdapterNotSpecified, AdapterNotFound, and ArgumentError
+      # may be returned.
+      def establish_connection(config)
+        config = config.symbolize_keys
+        unless config.key?(:adapter)
+          raise AdapterNotSpecified, "#{config} adapter is not configured"
+        end
+        adapter_method = "#{config[:adapter]}_connection"
+        unless respond_to?(adapter_method)
+          raise AdapterNotFound,
+                "configuration specifies nonexistent #{config[:adapter]} adapter"
+        end
+        self.connection = self.send(adapter_method, config)
+      end
+    end
+    
+    # Returns the connection currently associated with the class.  This can
+    # also be used to "borrow" the connection to do work that is specific to
+    # a particular SMS gateway.
+    def connection
+      self.class.connection
+    end
+    
+  end
+end

data/lib/activesms/exceptions.rb

@@ -0,0 +1,23 @@
+module ActiveSms #:nodoc:
+
+  # Generic error class and superclass of all other errors raised by
+  # Active SMS
+  class ActiveSmsError < StandardError
+  end
+  
+  # The configuration hash used in <tt>establish_connection</tt> didn't include
+  # <tt>:adapter</tt> key
+  class AdapterNotSpecified < ActiveSmsError
+  end
+  
+  # The <tt>adapter</tt> key used in <tt>establish_connection</tt> specified a
+  # nonexistent adapter.
+  class AdapterNotFound < ActiveSmsError
+  end
+  
+  # No connection has been established.  Use <tt>establish_connection</tt>
+  # before sending a message.
+  class ConnectionNotEstablished < ActiveSmsError
+  end
+  
+end

data/lib/activesms/sms.rb

@@ -0,0 +1,11 @@
+module ActiveSms
+  class Sms
+    attr_accessor :recipients
+    attr_accessor :from
+    attr_accessor :body
+    
+    def to_s
+      "#<#{self.class.name} @recipients=#{recipients.inspect} @from=#{from.inspect} @body=#{body.inspect}>"
+    end
+  end
+end

data/lib/activesms/validations.rb

@@ -0,0 +1,49 @@
+module ActiveSms
+  # The SMS message object is invalid.  Use the sms method to retrieve the
+  # message which did not validate.
+  class SmsInvalid < ActiveSmsError
+    attr_reader :sms
+    def initialize(sms)
+      @sms = sms
+      super("Validation failed: #{@sms.errors.full_messages.join(', ')}")
+    end
+  end
+  
+  # Active SMS validation is reported to and from this object, which is used
+  # by Base to determine whether the message is in a valid state to be sent.
+  class Errors
+    include Enumerable
+    
+    # Holds a hash with all the default error message.  This can be replaced
+    # by your own copy or localizations.
+    @@default_error_messages = {
+      :invalid => "is invalid"
+    }
+    cattr_accessor :default_error_messages
+    
+    def initialize(base) #:nodoc:
+      @base = base
+      @errors = {}
+    end
+    
+    # Adds an error message to the base object instead of any particular
+    # attribute for the object.  This is used to report errors that don't
+    # tie to any specific attribute, but to the object as a whole.  These
+    # error messages don't get prepended with any field name when iterating
+    # with each_full, so they should be complete sentences.
+    def add_to_base(msg)
+      add(:base, msg)
+    end
+    
+    # Adds an error message +msg+ to the +attribute+, which will be returned
+    # on a call to <tt>on(attribute)</tt> for the same attribute and ensure
+    # that this error object returns false when asked if <tt>empty?</tt>.
+    # More than one error can be added to the same +attribute+, in which
+    # case an array will be returned on a call to <tt>on(attribute)</tt>.
+    # If no +msg+ is supplied, "invalid" is assumed.
+    def add(attribute, msg = @@default_error_messages[:invalid])
+      @errors[attribute.to_s] ||= []
+      @errors[attribute.to_s] << msg
+    end
+  end
+end

data/lib/activesms/version.rb

@@ -1,8 +1,8 @@
 module ActiveSms #:nodoc:
   module VERSION #:nodoc:
     MAJOR = 0
-    MINOR = 0
-    TINY  = 2
+    MINOR = 6
+    TINY  = 0
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

data/website/index.html

@@ -5,7 +5,7 @@
   <link rel="stylesheet" href="stylesheets/screen.css" type="text/css" media="screen" />
   <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
   <title>
-      activesms
+      ActiveSms
   </title>
   <script src="javascripts/rounded_corners_lite.inc.js" type="text/javascript"></script>
 <style>
@@ -30,7 +30,7 @@
 <body>
 <div id="main">
 
-    <h1>activesms</h1>
+    <h1>ActiveSms</h1>
     <div id="version" class="clickable" onclick='document.location = "http://rubyforge.org/projects/activesms"; return false'>
       <p>Get Version</p>
       <a href="http://rubyforge.org/projects/activesms" class="numbers">0.0.2</a>
@@ -38,33 +38,60 @@
     <h2>What</h2>
 
 
+	<p>Active <span class="caps">SMS</span> is a framework for creating and sending <span class="caps">SMS</span> messages.</p>
+
+
 	<h2>Installing</h2>
 
 
 <pre syntax="ruby">sudo gem install activesms</pre>
 
-	<h2>The basics</h2>
+	<h2>Demonstration of usage</h2>
 
 
-	<h2>Demonstration of usage</h2>
+	<p><span class="caps">TBD</span>.</p>
 
 
-	<h2>Forum</h2>
+	<h2>Supported Gateways</h2>
+
+
+	<p>Active <span class="caps">SMS</span> will require a valid account from a third party <span class="caps">SMS</span> gateway to
+send or receive <span class="caps">SMS</span> messages.  The following gateways are currently supported:</p>
 
 
-	<p><a href="http://groups.google.com/group/activesms">http://groups.google.com/group/activesms</a></p>
+	<ul>
+	<li>BulkSMS[http://www.bulksms.com]</li>
+		<li>Clickatell[http://www.clickatell.com]</li>
+		<li>Simplewire[http://www.simplewire.com] (requires jruby)</li>
+	</ul>
 
 
-	<p><span class="caps">TODO</span> &#8211; create Google Group &#8211; activesms</p>
+	<p>Not all features are supported by all gateways.</p>
 
 
-	<h2>How to submit patches</h2>
+	<h3>Simplewire Configuration</h3>
 
 
-	<p>Read the <a href="http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/">8 steps for fixing other people&#8217;s code</a> and for section <a href="http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/#8b-google-groups">8b: Submit patch to Google Groups</a>, use the Google Group above.</p>
+	<ul>
+	<li>Make sure you are using jruby</li>
+		<li>Make sure swsms.jar is in your classpath (Download at: <a href="http://www.simplewire.com/developers/sdk/java/">http://www.simplewire.com/developers/sdk/java/</a>)</li>
+		<li>Add the following configuration code to the rails environment.</li>
+	</ul>
 
 
-	<p>The trunk repository is <code>svn://rubyforge.org/var/svn/activesms/trunk</code> for anonymous access.</p>
+<pre syntax="ruby">
+ActiveSms::Base.establish_connection(
+     :adapter  =&gt; "simplewire",
+     :subscriber_id =&gt; "id",
+     :subscriber_password =&gt; "password" 
+   )
+
+</pre>
+
+	<h2>Forum</h2>
+
+
+	<p><a href="http://rubyforge.org/forum/?group_id=2923">http://rubyforge.org/forum/?group_id=2923</a></p>
 
 
 	<h2>License</h2>
@@ -73,14 +100,11 @@
 	<p>This code is free to use under the terms of the <span class="caps">MIT</span> license.</p>
 
 
-	<h2>Contact</h2>
+	<h2>Support</h2>
+
 
+	<p>You can find the Active <span class="caps">SMS</span> RubyForge page at <a href="http://rubyforge.org/projects/activesms">http://rubyforge.org/projects/activesms</a>.</p>
 
-	<p>Comments are welcome. Send an email to <a href="mailto:FIXME"><span class="caps">FIXME</span> full name</a> email.</p>
-    <p class="coda">
-      <a href="mailto:drnicwilliams@gmail.com">Dr Nic</a>, 26th July 2007<br>
-      Theme extended from <a href="http://rb2js.rubyforge.org/">Paul Battley</a>
-    </p>
 </div>
 
 <!-- insert site tracking codes here, like Google Urchin -->

data/website/index.txt

@@ -1,35 +1,51 @@
-h1. activesms
+h1. ActiveSms
 
 h2. What
 
+Active SMS is a framework for creating and sending SMS messages.
 
 h2. Installing
 
 <pre syntax="ruby">sudo gem install activesms</pre>
 
-h2. The basics
+h2. Demonstration of usage
 
+TBD.
 
-h2. Demonstration of usage
+h2. Supported Gateways
 
+Active SMS will require a valid account from a third party SMS gateway to
+send or receive SMS messages.  The following gateways are currently supported:
 
+* BulkSMS[http://www.bulksms.com]
+* Clickatell[http://www.clickatell.com]
+* Simplewire[http://www.simplewire.com] (requires jruby)
 
-h2. Forum
+Not all features are supported by all gateways.
 
-"http://groups.google.com/group/activesms":http://groups.google.com/group/activesms
+h3. Simplewire Configuration
 
-TODO - create Google Group - activesms
+* Make sure you are using jruby
+* Make sure swsms.jar is in your classpath (Download at: "http://www.simplewire.com/developers/sdk/java/":http://www.simplewire.com/developers/sdk/java/)
+* Add the following configuration code to the rails environment.
 
-h2. How to submit patches
+<pre syntax="ruby">
+ActiveSms::Base.establish_connection(
+     :adapter  => "simplewire",
+     :subscriber_id => "id",
+     :subscriber_password => "password"
+   )
+   
+</pre>
 
-Read the "8 steps for fixing other people's code":http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/ and for section "8b: Submit patch to Google Groups":http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/#8b-google-groups, use the Google Group above.
+h2. Forum
 
-The trunk repository is <code>svn://rubyforge.org/var/svn/activesms/trunk</code> for anonymous access.
+"http://rubyforge.org/forum/?group_id=2923":http://rubyforge.org/forum/?group_id=2923
 
 h2. License
 
 This code is free to use under the terms of the MIT license. 
 
-h2. Contact
+h2. Support
 
-Comments are welcome. Send an email to "FIXME full name":mailto:FIXME email.
+You can find the Active SMS RubyForge page at "http://rubyforge.org/projects/activesms":http://rubyforge.org/projects/activesms.

data/website/template.rhtml

@@ -36,10 +36,7 @@
       <a href="<%= download %>" class="numbers"><%= version %></a>
     </div>
     <%= body %>
-    <p class="coda">
-      <a href="mailto:drnicwilliams@gmail.com">Dr Nic</a>, <%= modified.pretty %><br>
-      Theme extended from <a href="http://rb2js.rubyforge.org/">Paul Battley</a>
-    </p>
+
 </div>
 
 <!-- insert site tracking codes here, like Google Urchin -->

metadata

@@ -3,7 +3,7 @@ rubygems_version: 0.9.2
 specification_version: 1
 name: activesms
 version: !ruby/object:Gem::Version 
-  version: 0.0.2
+  version: 0.6.0
 date: 2007-07-26 00:00:00 -07:00
 summary: Active SMS is a framework for sending and receiving SMS messages
 require_paths: 
@@ -34,15 +34,34 @@ authors:
 - Ben Curren
 - Dean Mao
 files: 
+- CHANGELOG
 - History.txt
 - License.txt
+- MIT-LICENSE
 - Manifest.txt
 - README.txt
 - Rakefile
+- generators/sms/USAGE
+- generators/sms/sms_generator.rb
+- generators/sms/templates/fixture.rhtml
+- generators/sms/templates/model.rb
+- generators/sms/templates/unit_test.rb
+- init.rb
 - lib/activesms.rb
+- lib/activesms/adv_attr_accessor.rb
+- lib/activesms/base.rb
+- lib/activesms/connection_adapters/abstract_adapter.rb
+- lib/activesms/connection_adapters/bulk_sms_adapter.rb
+- lib/activesms/connection_adapters/clickatell_adapter.rb
+- lib/activesms/connection_adapters/simplewire_adapter.rb
+- lib/activesms/connections.rb
+- lib/activesms/exceptions.rb
+- lib/activesms/sms.rb
+- lib/activesms/validations.rb
 - lib/activesms/version.rb
 - scripts/txt2html
 - setup.rb
+- test/connection_adapters/test_simplewire_adapter.rb
 - test/test_activesms.rb
 - test/test_helper.rb
 - website/index.html