sms_gateway 0.0.1

data/.gitignore

@@ -0,0 +1,3 @@
+pkg/*
+*.gem
+.bundle

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in sms_gateway.gemspec
+gemspec

data/README.rdoc

@@ -0,0 +1,76 @@
+= SMS Gateway
+
+The SMS Gateway gem provides a simple and extensible interface for
+various SMS Gateways. It is loosely oriented on Action Mailer. The
+gem allows you to create a SMS and deliver it synchronously or
+asynchronously. So far it only ships with the following adapters.
+
+* smsglobal.com
+* a dummy adapter for testing purposes
+
+
+= Installation
+
+You install the gem in your rails app by adding it your +Gemfile+:
+
+    gem "sms_gateway"
+
+
+After that you run the <tt>bundle:install</tt> task and then invoke the
+gem's generator:
+
+    rails g sms_gateway:install
+
+The generator installs an initializer and a yml file which you will need
+to configure before sending a SMS.
+
+
+== Resque and Redis
+
+To deliver SMS asynchronously this gem makes use of resque, a
+popular queing system basd on the key-value data store redis. You need
+to have a working resque and redis setup if you want to use
+the aynchronous feature. For more information on resque visit
+https://github.com/defunkt/resque.
+
+
+= Usage
+
+Similar to action mailer you create the message object first:
+
+    m = SmsGateway::Sms.new(:from => '493088888888, :to => '49309999999',
+          :text => 'my sms must not be longer than 160 characters.')    
+
+
+And then deliver it with:    
+
+    m.deliver
+
+
+This will block until the the HTTP call is complete. As with email it's
+better practice to enqueue the call: 
+
+    m.deliver_later
+
+This will be non-blocking and is the recommended way of sending an SMS.
+This requires a resque worker, though, to get actually sent (see the
+resque documentation):
+
+    rake resque:work
+
+
+
+= Outlook and Todo
+
+So far the gem is pretty limited. Ideas for following version are:
+
+* unit tests
+* other sms gateway providers
+* decoupling of resque
+
+= License
+
+GPLv3. Copyright 2011 Kai Rubarth.  
+
+
+

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/lib/sms_gateway/adapters/sms_global.rb

@@ -0,0 +1,25 @@
+module SmsGateway
+
+  module Adapters
+
+    class SmsGlobal
+      require 'httparty'
+      include HTTParty
+      base_uri 'http://www.smsglobal.com'
+      def initialize(config={})
+        @config = SmsGateway::Base.config
+      end
+
+      def send_sms(sms)
+        options = @config.merge({:action => "sendsms", :to => sms.to, :text => sms.text})
+        puts options.inspect
+        self.class.post('/http-api.php', :query => options)
+      end
+
+    end
+
+  end
+
+end
+
+

data/lib/sms_gateway/adapters/test_adapter.rb

@@ -0,0 +1,18 @@
+
+module SmsGateway
+  module Adapters
+
+    class Test
+      def initialize(config={})
+        @logger = Logger.new(STDOUT)
+      end
+
+      def send_sms(sms)
+        @logger.info "would be sending sms: #{sms.to_s}" 
+      end
+
+    end
+  end
+end
+
+

data/lib/sms_gateway/base.rb

@@ -0,0 +1,30 @@
+module SmsGateway
+
+  class Base
+
+    class << self
+      attr_accessor :connection
+      attr_reader :config
+
+      def config=(options)
+        @config = options.symbolize_keys 
+        klassname = @config[:adapter].to_s.split("_").map(&:capitalize).join
+        klass = SmsGateway::Adapters.const_get(klassname)
+        self.connection = klass.new
+      end
+
+      def deliver(options)
+        self.connection.send_sms(SmsGateway::Sms.new(options.symbolize_keys))
+      end
+
+      def self.deliver_later(text, to, from=Base.config[:from]) 
+        Resque.enqueue(SmsGateway::Workers::SmsJob, text, to, from) 
+      end
+
+    end
+  end
+
+end
+
+
+

data/lib/sms_gateway/generators/install/install_generator.rb

@@ -0,0 +1,24 @@
+module SmsGateway
+
+  module Generators
+
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("../templates", __FILE__)
+
+      desc "Creates the initializer and config file template."  
+      
+      def copy_initializer_file
+        copy_file "initializer.rb", "config/initializers/setup_sms_gateway.rb"
+      end
+
+      def copy_config_file
+        copy_file "setup.yml", "config/sms_gateway.yml"
+      end
+
+    end
+
+  end
+
+end
+
+

data/lib/sms_gateway/generators/install/templates/initializer.rb

@@ -0,0 +1,6 @@
+SMS_SETTINGS = 
+  YAML.load(File.open(File.join(Rails.root, 'config', 'sms_gateway.yml')))[Rails.env].symbolize_keys
+
+SmsGateway::Base.config = SMS_SETTINGS.symbolize_keys
+
+

data/lib/sms_gateway/generators/install/templates/setup.yml

@@ -0,0 +1,18 @@
+---
+
+development:
+    user: username
+    password: secret
+    from: 493088888888
+    adapter: :sms_global
+
+test:
+    adapter: :test
+
+development:
+    user: username
+    password: secret
+    from: 493088888888
+    adapter: :sms_global
+
+

data/lib/sms_gateway/jobs/sms_job.rb

@@ -0,0 +1,16 @@
+
+module SmsGateway
+
+  class SmsJob
+
+    @queue = :sms_queue
+    def self.perform(options)
+      SmsGateway::Sms.new(options.symbolize_keys).deliver
+    end
+
+  end
+
+end
+
+
+

data/lib/sms_gateway/sms.rb

@@ -0,0 +1,28 @@
+
+## The SMS-Object
+module SmsGateway
+  class Sms < Struct.new(:from, :to, :text)
+
+    def initialize(params)
+      self.from = params[:from]||SmsGateway::Base.config[:from]
+      self.to = params[:to]
+      self.text = params[:text]
+    end
+
+    def deliver
+      SmsGateway::Base.deliver(:to=>self.to, :from=>self.from, :text=>self.text)
+    end
+
+    def deliver_later
+      Resque.enqueue(SmsGateway::SmsJob, :to=>self.to, :from=>self.from, :text=>self.text)
+    end
+
+    def to_s
+      "SMS: from:#{self.from}, to:#{self.to}, text:#{self.text}"
+    end
+
+  end
+end
+
+
+

data/lib/sms_gateway/version.rb

@@ -0,0 +1,3 @@
+module SmsGateway
+  VERSION = "0.0.1"
+end

data/lib/sms_gateway.rb

@@ -0,0 +1,14 @@
+require 'rails'
+require 'rails/generators'
+
+require 'sms_gateway/base'
+require 'sms_gateway/sms'
+require 'sms_gateway/adapters/sms_global'
+require 'sms_gateway/jobs/sms_job'
+require 'sms_gateway/generators/install/install_generator'
+
+module SmsGateway
+end
+
+
+

data/sms_gateway.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "sms_gateway/version"
+
+Gem::Specification.new do |s|
+  s.name        = "sms_gateway"
+  s.version     = SmsGateway::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Kai Rubarth"]
+  s.email       = ["kai@doxter.de"]
+  s.homepage    = ""
+  s.summary     = %q{Simple and flexible interface to SMS Gateways}
+  s.description = %q{Provides an interface to SMS Gateways. So far it supports smsglobal.com.}
+
+  s.rubyforge_project = "sms_gateway"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency('httparty')
+  s.add_dependency('resque')
+
+end
+
+

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification 
+name: sms_gateway
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Kai Rubarth
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-06-06 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: resque
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+description: Provides an interface to SMS Gateways. So far it supports smsglobal.com.
+email: 
+- kai@doxter.de
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.rdoc
+- Rakefile
+- lib/sms_gateway.rb
+- lib/sms_gateway/adapters/sms_global.rb
+- lib/sms_gateway/adapters/test_adapter.rb
+- lib/sms_gateway/base.rb
+- lib/sms_gateway/generators/install/install_generator.rb
+- lib/sms_gateway/generators/install/templates/initializer.rb
+- lib/sms_gateway/generators/install/templates/setup.yml
+- lib/sms_gateway/jobs/sms_job.rb
+- lib/sms_gateway/sms.rb
+- lib/sms_gateway/version.rb
+- sms_gateway.gemspec
+has_rdoc: true
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: sms_gateway
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Simple and flexible interface to SMS Gateways
+test_files: []
+