action_sms 0.0.1

data/.gitignore

@@ -0,0 +1,3 @@
+*~
+rerun.txt
+

data/MIT-LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) 2010 David Wilkie
+
+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.
+

data/README.markdown

@@ -0,0 +1,45 @@
+# 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)
+
+## Usage
+Establish a connection to your SMS Gateway Adapter:
+
+    ActionSms::Base.establish_connection(
+      :adapter => 'your_adapter',
+      # the remaining options are specific to the SMS Gateway Adapter
+      :username => '[username]',
+      :password => '[password]'
+    )
+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
+
+    class SMSNotifier < ActionSms::Base
+    end
+
+Now you can call:
+
+    SMSNotifier.deliver(sms)
+
+### Rails
+For convenience there are a couple of generators that can be used if you are using action_sms within a Rails app.
+
+    rails g initializer
+Generates an initializer under config/initializers with the `establish_connection` code described above.
+
+    rails g notifier
+Generates a notifier under app/notifiers with the `SMSNotifier` 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/Rakefile

@@ -0,0 +1,38 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the ActionSMS plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'spec'
+  t.libs << 'features'
+  t.pattern = 'spec/**/*_spec.rb'
+  t.verbose = true
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "action_sms"
+    gemspec.summary = "Lightweight SMS wrapper which can use any gateway"
+    gemspec.email = "dwilkie@gmail.com"
+    gemspec.homepage = "http://github.com/dwilkie/action_sms"
+    gemspec.authors = ["David Wilkie"]
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: gem install jeweler"
+end
+
+desc 'Generate documentation for the ActionSMS plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ActionSMS'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/action_sms.gemspec

@@ -0,0 +1,54 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{action_sms}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["David Wilkie"]
+  s.date = %q{2010-07-07}
+  s.email = %q{dwilkie@gmail.com}
+  s.extra_rdoc_files = [
+    "README.markdown"
+  ]
+  s.files = [
+    ".gitignore",
+     "MIT-LICENSE",
+     "README.markdown",
+     "Rakefile",
+     "VERSION",
+     "action_sms.gemspec",
+     "lib/action_sms.rb",
+     "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}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Lightweight SMS wrapper which can use any gateway}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

data/lib/action_sms.rb

@@ -0,0 +1,5 @@
+require 'action_sms/connections'
+require 'action_sms/base'
+require 'action_sms/exceptions'
+require 'action_sms/connection_adapters'
+

data/lib/action_sms/base.rb

@@ -0,0 +1,11 @@
+module ActionSms #:nodoc#
+  class Base
+    @@logger = nil
+    cattr_accessor :logger
+
+    def self.deliver(sms)
+      self.connection.deliver(sms)
+    end
+  end
+end
+

data/lib/action_sms/connection_adapters.rb

@@ -0,0 +1,2 @@
+require 'connection_adapters/abstract_adapter'
+

data/lib/action_sms/connection_adapters/abstract_adapter.rb

@@ -0,0 +1,46 @@
+require 'net/https'
+
+module ActionSms #: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
+
+      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/action_sms/connections.rb

@@ -0,0 +1,64 @@
+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/action_sms/exceptions.rb

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

data/lib/generators/action_sms/initializer/USAGE

@@ -0,0 +1,6 @@
+Description:
+  Creates an initializer under config/initializers
+
+Example:
+  rails g action_sms:initializer
+

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

@@ -0,0 +1,14 @@
+require 'rails/generators'
+module ActionSms
+  class InitializerGenerator < Rails::Generators::Base
+
+    def self.source_root
+       @source_root ||= File.join(File.dirname(__FILE__), 'templates')
+    end
+
+    def copy_conversation_file
+      copy_file "action_sms.rb", "config/initializers/action_sms.rb"
+    end
+  end
+end
+

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

@@ -0,0 +1,14 @@
+# see http://github.com/dwilkie/action_sms_gateways
+# for preconfigured sms gateways
+
+# see http://github.com/dwilkie/action_sms
+# for more details on how to make your own adapter for an sms gateway
+
+# Then uncomment the following code and replace :adapter with your adapter
+
+#ActionSms::Base.establish_connection(
+#  :adapter => 'your_adapter',
+#  :username => '[username]',
+#  :password => '[password]'
+#)
+

data/lib/generators/action_sms/notifier/USAGE

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

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

@@ -0,0 +1,14 @@
+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

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

data/todo

@@ -0,0 +1,2 @@
+Add some tests
+

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification 
+name: action_sms
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- David Wilkie
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-07-07 00:00:00 +07:00
+default_executable: 
+dependencies: []
+
+description: 
+email: dwilkie@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.markdown
+files: 
+- .gitignore
+- MIT-LICENSE
+- README.markdown
+- Rakefile
+- VERSION
+- action_sms.gemspec
+- lib/action_sms.rb
+- 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
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Lightweight SMS wrapper which can use any gateway
+test_files: []
+