sisal 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,5 @@
+source :rubygems
+
+group :test do
+  gem "rspec", "~> 2.8"
+end

data/README.md

@@ -0,0 +1,98 @@
+# Sisal - SMS Abstraction Layer
+
+Sisal is an abstraction layer to work with SMS. Think something like
+Active Merchant, but instead of payment gateways and credit cards, it
+deals with SMS providers and messages.
+
+## Architecture
+
+At this moment Sisal's core is formed by four parts:
+
+* Message
+* Response
+* Provider
+* Messenger
+
+`Message` and `Response` are the implementations for the message and you
+want send and the response from the provider, respectively. `Provider` is
+interface for all the providers implementations. And `Messenger` is a proxy
+for all your configured providers. Check the examples below.
+
+Sisal can send messages via the following providers:
+
+* Tropo
+* Twilio
+* Clickatell
+
+#### **Please note that Sisal ONLY supports US-ASCII (GSM 7-bit encoding) messages!**
+
+## TODO
+
+* Separate providers implementations, e.g. sisal-tropo, sisal-twilio
+* Implement encodings LATIN1 and UCS2
+* Support for binary messages: EMS, Nokia's Smart Messaging and MMS
+* Support for binary Concatenated SMS
+* etc.
+
+## Examples
+
+###### Send SMS using provider
+
+```ruby
+message = Sisal::Message.new('552500', 'Hello MU!')
+provider = Sisal::Providers.tropo(token: '123')
+provider.send(message)
+```
+
+###### Send SMS using Messenger
+
+Assuming you have configured your providers:
+
+```ruby
+config = Sisal.configuration
+config.default_provider = :tropo
+config.provider(:tropo,  Sisal::Providers.tropo(token: '123'))
+config.provider(:twilio, Sisal::Providers.twilio(account_id: '123', token: '123', from: '552500'))
+```
+
+You can send messages just as simple as:
+
+```ruby
+messenger = Sisal::Messenger.new
+messenger.send(message)
+```
+
+You can also change your default provider on the fly:
+
+```ruby
+messenger.send(message, provider: 'twilio')
+```
+
+If you need, you can change your providers settings:
+
+```ruby
+config.provider(:tropo) do |p|
+  p.token = '312'
+end
+```
+
+## License
+
+Copyright (c) 2012 Vinicius Horewicz
+
+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/Rakefile

@@ -0,0 +1,9 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+desc "Default: run specs."
+task :default => :spec
+
+desc "Run specs"
+RSpec::Core::RakeTask.new

data/lib/sisal.rb

@@ -0,0 +1,15 @@
+require_relative "sisal/message"
+require_relative "sisal/response"
+require_relative "sisal/provider"
+require_relative "sisal/messenger"
+require_relative "sisal/configuration"
+
+module Sisal
+  extend self
+
+  attr_writer :configuration
+
+  def configuration
+    @configuration ||= Configuration.new
+  end
+end

data/lib/sisal/configuration.rb

@@ -0,0 +1,21 @@
+module Sisal
+  class Configuration
+    attr_accessor :providers
+    attr_writer :default_provider
+
+    def initialize
+      @providers = {}
+    end
+
+    def provider(name, provider_object = nil)
+      name = name.to_s
+      @providers[name] = provider_object if provider_object
+      yield(@providers[name]) if block_given?
+      @providers[name]
+    end
+
+    def default_provider
+      @providers[@default_provider.to_s]
+    end
+  end
+end

data/lib/sisal/message.rb

@@ -0,0 +1,25 @@
+module Sisal
+  class Message
+    InvalidPhoneNumber  = Class.new(StandardError)
+
+    PHONE_REGEX       = /^\d+$/
+    PHONE_LENGTH      = [4, 15]
+
+    attr_accessor :to, :text
+
+    def initialize(to, text)
+      @to, @text = to, text
+    end
+
+    def valid?
+      validate_number
+    end
+
+    private
+
+    def validate_number
+      to.length.between?(*PHONE_LENGTH) && to.match(PHONE_REGEX) or
+      raise InvalidPhoneNumber.new(to)
+    end
+  end
+end

data/lib/sisal/messenger.rb

@@ -0,0 +1,12 @@
+module Sisal
+  class Messenger
+    UnknownProvider = Class.new(StandardError)
+
+    def send(message, options = {})
+      provider_name = options.delete(:provider).to_s
+      provider = Sisal.configuration.providers[provider_name] || Sisal.configuration.default_provider
+      raise UnknownProvider unless provider
+      provider.send(message, options)
+    end
+  end
+end

data/lib/sisal/provider.rb

@@ -0,0 +1,7 @@
+module Sisal
+  class Provider
+    def send(message, options = {})
+      raise "Provider#send must be implemented in children classes"
+    end
+  end
+end

data/lib/sisal/response.rb

@@ -0,0 +1,17 @@
+module Sisal
+  class Response
+    # Since we can't abstract all providers responses,
+    # let's use params as a general purpose hash
+    attr_accessor :success, :code, :message, :params
+
+    def initialize(success, code, message, params = {})
+      @success, @code, @message, @params = success, code, message, params
+    end
+
+    # The value of @success must be set by the caller object,
+    # usually the provider.
+    def success?
+      @success == true
+    end
+  end
+end

data/lib/sisal/version.rb

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

data/sisal.gemspec

@@ -0,0 +1,17 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path("../lib/sisal/version", __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Vinicius Horewicz"]
+  gem.email         = ["vinicius@horewi.cz"]
+  gem.description   = %q{Sisal is an abstraction layer to work with SMS. Think something like Active Merchant, but instead of payment gateways and credit cards, it deals with SMS providers and messages.}
+  gem.summary       = %q{SMS abstraction layer in Ruby}
+  gem.homepage      = "https://github.com/wicz/sisal"
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {spec,features}/*`.split("\n")
+  gem.name          = "sisal"
+  gem.require_paths = ["lib"]
+  gem.version       = Sisal::VERSION
+end

data/spec/sisal/configuration_spec.rb

@@ -0,0 +1,26 @@
+require "spec_helper"
+
+describe Sisal::Configuration do
+  let(:dummy) { DummyProvider.new }
+
+  before(:each) do
+    Sisal.configuration.provider(:dummy, dummy)
+  end
+
+  it "has a default provider" do
+    Sisal.configuration.default_provider = :dummy
+    Sisal.configuration.default_provider.should be(dummy)
+  end
+
+  it "has providers" do
+    Sisal.configuration.providers.should_not be_empty
+  end
+
+  describe "#provider" do
+    it "configures a provider" do
+      Sisal.configuration.provider(:dummy) { |p| p.token = "456"}
+      Sisal.configuration.providers["dummy"].should be
+      Sisal.configuration.providers["dummy"].token.should eq("456")
+    end
+  end
+end

data/spec/sisal/message_spec.rb

@@ -0,0 +1,33 @@
+require "spec_helper"
+
+describe Sisal::Message do
+  let(:message) { Sisal::Message.new("5525800", "") }
+
+  describe "#valid?" do
+    context "raises an error when" do
+      it "number has less than 4 digits" do
+        message.to = "123"
+        expect { message.valid? }.to raise_error(Sisal::Message::InvalidPhoneNumber)
+      end
+
+      it "number has more than 15 digits" do
+        message.to = "1" * 20
+        expect { message.valid? }.to raise_error(Sisal::Message::InvalidPhoneNumber)
+      end
+
+      it "number has chars other than digits" do
+        message.to = "+5525800"
+        expect { message.valid? }.to raise_error(Sisal::Message::InvalidPhoneNumber)
+      end
+    end
+
+    it "accepts short codes" do
+      message.valid?.should be_true
+    end
+
+    it "accepts complete E.164 number" do
+      message.to = "230234321324213"
+      message.valid?
+    end
+  end
+end

data/spec/sisal/messenger_spec.rb

@@ -0,0 +1,31 @@
+require "spec_helper"
+
+describe Sisal::Messenger do
+  let(:messenger) { Sisal::Messenger.new }
+  let(:message)   { Sisal::Message.new("1234", "OHAI!") }
+  let(:dummy)     { DummyProvider.new }
+  let(:dumber)    { DummyProvider.new }
+
+  before(:each) do
+    Sisal.configuration.provider(:dummy, dummy)
+    Sisal.configuration.provider(:dumber, dumber)
+    Sisal.configuration.default_provider = :dummy
+  end
+
+  describe "#send" do
+    it "uses the default provider" do
+      dummy.should_receive(:send).with(message, {})
+      messenger.send(message)
+    end
+
+    it "can have provider overriden in runtime" do
+      dumber.should_receive(:send).with(message, {})
+      messenger.send(message, provider: "dumber")
+    end
+
+    it "can have extra parameters" do
+      dummy.should_receive(:send).with(message, msg_id: 123)
+      messenger.send(message, msg_id: 123)
+    end
+  end
+end

data/spec/sisal/provider_spec.rb

@@ -0,0 +1,11 @@
+require "spec_helper"
+
+describe Sisal::Provider do
+  let(:provider)  { Sisal::Provider.new }
+
+  describe "#send" do
+    it "must be implemented by children classes" do
+      expect { provider.send(nil, nil) }.to raise_error(RuntimeError)
+    end
+  end
+end

data/spec/sisal/response_spec.rb

@@ -0,0 +1,28 @@
+require "spec_helper"
+
+describe Sisal::Response do
+  let(:response) { Sisal::Response.new(true, "200", "Success") }
+
+  describe "#new" do
+    it "initializes with success, code and message" do
+      response.success.should be_true
+      response.code.should eq("200")
+      response.message.should eq("Success")
+    end
+
+    it "can initialize with extra parameters" do
+      response = Sisal::Response.new(false, "401", "Error", description: "Access denied")
+      response.params.has_key?(:description).should be_true
+      response.params[:description].should eq("Access denied")
+    end
+  end
+
+  describe "#success?" do
+    it "checks if success is true" do
+      response.success = true
+      response.success?.should be_true
+      response.success = false
+      response.success?.should be_false
+    end
+  end
+end

data/spec/sisal_spec.rb

@@ -0,0 +1,7 @@
+require "spec_helper"
+
+describe Sisal do
+  it "has configuration" do
+    Sisal.configuration.should be_a(Sisal::Configuration)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+$:.unshift File.expand_path('..', __FILE__)
+$:.unshift File.expand_path('../../lib', __FILE__)
+
+require "rspec"
+
+require_relative "../lib/sisal"
+
+DummyProvider = Struct.new(:token)

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: sisal
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Vinicius Horewicz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-10 00:00:00.000000000 Z
+dependencies: []
+description: Sisal is an abstraction layer to work with SMS. Think something like
+  Active Merchant, but instead of payment gateways and credit cards, it deals with
+  SMS providers and messages.
+email:
+- vinicius@horewi.cz
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- lib/sisal.rb
+- lib/sisal/configuration.rb
+- lib/sisal/message.rb
+- lib/sisal/messenger.rb
+- lib/sisal/provider.rb
+- lib/sisal/response.rb
+- lib/sisal/version.rb
+- sisal.gemspec
+- spec/sisal/configuration_spec.rb
+- spec/sisal/message_spec.rb
+- spec/sisal/messenger_spec.rb
+- spec/sisal/provider_spec.rb
+- spec/sisal/response_spec.rb
+- spec/sisal_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/wicz/sisal
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: SMS abstraction layer in Ruby
+test_files:
+- spec/sisal/configuration_spec.rb
+- spec/sisal/message_spec.rb
+- spec/sisal/messenger_spec.rb
+- spec/sisal/provider_spec.rb
+- spec/sisal/response_spec.rb
+- spec/sisal_spec.rb
+- spec/spec_helper.rb