action_sms 0.0.2 → 0.0.3

data/README.markdown

@@ -1,8 +1,9 @@
 # action_sms
 
-action_sms is a lightweight wrapper based on [activesms](http://github.com/nofxx/activesms). action_sms allows you to use existing SMS Gateway Adapters and switch between them effortlessly without modifing your application code. Unlike [activesms](http://github.com/nofxx/activesms), action_sms does not implement any SMS Gateway Adapters. For this see [action_sms_gateways](http://github.com/dwilkie/action_sms_gateways)
+action_sms allows you to use existing or custom SMS Gateway Adapters and switch between them effortlessly without modifying your application or test code. By keeping SMS Gateway configuration out of your code you can be more adaptable to change.
 
 ## Usage
+
 Establish a connection to your SMS Gateway Adapter:
 
     ActionSms::Base.establish_connection(
@@ -13,33 +14,31 @@ Establish a connection to your SMS Gateway Adapter:
     )
 The only required option is `:adapter`. This specifies the SMS Gateway adapter you want to use. The remaining options are specific to the adapter.
 
-Then subclass `ActionSms::Base` to define a notifier
+Now from your application or test code you can call methods on the adapter by calling:
 
-    class SMSNotifier < ActionSms::Base
-    end
+    ActionSms::Base.connection
 
-Now you can call:
+## Adapters
 
-    SMSNotifier.deliver(sms)
+See [action_sms_gateways](http://github.com/dwilkie/action_sms_gateways) for existing adapters and information on how to create your own.
 
-### Rails
-For convenience there are a couple of generators that can be used if you are using action_sms within a Rails app.
+## Rails
 
-    rails g initializer
-Generates an initializer under config/initializers with the `establish_connection` code described above.
+For convenience there is a generator that can be used if you are using action_sms within a Rails app
 
-    rails g notifier
-Generates a notifier under app/notifiers with the `SMSNotifier` code described above.
+    rails g action_sms:initializer
+
+Generates an initializer under config/initializers with the `establish_connection` code described above.
 
 ## Installation
 
     gem install action_sms
+
 ### Rails
+
 Place the following in your Gemfile:
 
     gem action_sms
-## SMS Gateway Adapters
-See [action_sms_gateways](http://github.com/dwilkie/action_sms_gateways)
 
 Copyright (c) 2010 David Wilkie, released under the MIT license
 

data/VERSION

@@ -1 +1 @@
-0.0.2
+0.0.3

data/action_sms.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{action_sms}
-  s.version = "0.0.2"
+  s.version = "0.0.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["David Wilkie"]
-  s.date = %q{2010-09-15}
+  s.date = %q{2010-10-14}
   s.email = %q{dwilkie@gmail.com}
   s.extra_rdoc_files = [
     "README.markdown"
@@ -25,14 +25,10 @@ Gem::Specification.new do |s|
      "lib/action_sms/base.rb",
      "lib/action_sms/connection_adapters.rb",
      "lib/action_sms/connection_adapters/abstract_adapter.rb",
-     "lib/action_sms/connections.rb",
      "lib/action_sms/exceptions.rb",
      "lib/generators/action_sms/initializer/USAGE",
      "lib/generators/action_sms/initializer/initializer_generator.rb",
      "lib/generators/action_sms/initializer/templates/action_sms.rb",
-     "lib/generators/action_sms/notifier/USAGE",
-     "lib/generators/action_sms/notifier/notifier_generator.rb",
-     "lib/generators/action_sms/notifier/templates/sms_notifier.rb",
      "todo"
   ]
   s.homepage = %q{http://github.com/dwilkie/action_sms}

data/lib/action_sms/base.rb

@@ -1,10 +1,55 @@
 module ActionSms #:nodoc#
+
   class Base
-    @@logger = nil
-    cattr_accessor :logger
+    @@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
 
-    def self.deliver(sms)
-      self.connection.deliver(sms)
+      # 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)
+      #
+      #   ActionSms::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)
+        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
   end
 end

data/lib/action_sms/connection_adapters/abstract_adapter.rb

@@ -6,35 +6,19 @@ module ActionSms #:nodoc:
     # 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
-
-      def deliver(sms)
-      end
-
-      def parse(sms)
-        nil
-      end
-
       protected
-        # Helper method to send an HTTP request to +url+ with paramaters
+        # Helper method to send an HTTP POST request to +url+ with paramaters
         # specified by the +params+ hash.
-        def send_http_request(url, params)
+        def send_http_request(url, data)
           uri = URI.parse(url)
           req = Net::HTTP::Post.new(uri.path)
-          req.set_form_data(params)
+          data.is_a?(Hash) ? req.set_form_data(data) : req.body = data
 
           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?
           resp.body
         end
     end

data/lib/action_sms.rb

@@ -1,4 +1,3 @@
-require 'action_sms/connections'
 require 'action_sms/base'
 require 'action_sms/exceptions'
 require 'action_sms/connection_adapters'

data/lib/generators/action_sms/initializer/initializer_generator.rb

@@ -1,4 +1,3 @@
-require 'rails/generators'
 module ActionSms
   class InitializerGenerator < Rails::Generators::Base
 

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - David Wilkie
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-15 00:00:00 +07:00
+date: 2010-10-14 00:00:00 +07:00
 default_executable: 
 dependencies: []
 
@@ -37,14 +37,10 @@ files:
 - lib/action_sms/base.rb
 - lib/action_sms/connection_adapters.rb
 - lib/action_sms/connection_adapters/abstract_adapter.rb
-- lib/action_sms/connections.rb
 - lib/action_sms/exceptions.rb
 - lib/generators/action_sms/initializer/USAGE
 - lib/generators/action_sms/initializer/initializer_generator.rb
 - lib/generators/action_sms/initializer/templates/action_sms.rb
-- lib/generators/action_sms/notifier/USAGE
-- lib/generators/action_sms/notifier/notifier_generator.rb
-- lib/generators/action_sms/notifier/templates/sms_notifier.rb
 - todo
 has_rdoc: true
 homepage: http://github.com/dwilkie/action_sms

data/lib/action_sms/connections.rb

@@ -1,64 +0,0 @@
-module ActionSms #: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)
-      #
-      #   ActionSms::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/generators/action_sms/notifier/USAGE

@@ -1,6 +0,0 @@
-Description:
-  Creates an sms notifier under app/notifiers
-
-Example:
-  rails g action_sms:notifier
-

data/lib/generators/action_sms/notifier/notifier_generator.rb

@@ -1,14 +0,0 @@
-require 'rails/generators'
-module ActionSms
-  class NotifierGenerator < Rails::Generators::Base
-
-    def self.source_root
-       @source_root ||= File.join(File.dirname(__FILE__), 'templates')
-    end
-
-    def copy_notifier_file
-      copy_file "sms_notifier.rb", "app/notifiers/sms_notifier.rb"
-    end
-  end
-end
-

data/lib/generators/action_sms/notifier/templates/sms_notifier.rb

@@ -1,3 +0,0 @@
-class SMSNotifier < ActionSms::Base
-end
-