sms_kit 1.3.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZGYxN2NiNzg5MmE4ZDI2NmEyMzFjYTAxZjYwZDg2NTg1Mjc4YWEzNw==
+  data.tar.gz: !binary |-
+    NWI5MWFiMTQzZjEyMGZiYzkzNTM1YjZmODUwYjE5YmIwOGJiN2NlOA==
+SHA512:
+  metadata.gz: !binary |-
+    ZmI5YjkwOGU5ZTE3MGQ2YTllMDQxNmQzYzgzNDVkYzUyYjg4ZGYyOGU0ZGUz
+    NzBkMjkzY2JkNjE0NTVlOTVjZGVhOWY5OWFjNGI2NTMyYTczZDY0YzgyZWEw
+    MTJkZGU2YWZhOTBjYjRmODQ0N2MwOGFmNjI5OWJkNjZlY2ViZTM=
+  data.tar.gz: !binary |-
+    N2EwNzVmMWVlMjM0ODRjZWIwMDViZGM3ZmFlYWE3ZjlmOGRlZDZjYjIxZDBm
+    ZGY1YzUyMGU0Njc2NjkyYjhhNzA2NDBhYzljODU0ZTk0ZWFmZTVmNmE1NmZj
+    YThlMTg1NDY3YTBjZDJhOGRmMGE4ZjI1ZDlmZjI3MmQzODY3MmE=

data/README.md

@@ -0,0 +1,118 @@
+# SmsKit [![Build Status](https://travis-ci.org/jamii-Technologies/sms_kit.svg?branch=master)](https://travis-ci.org/jamii-Technologies/sms_kit)
+
+Easily send text messages via an HTTP SMS gateway.  
+The goal is to offer one streamlined API for any provider adapter.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'sms_kit', github: 'jamii-Technologies/sms_kit'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sms_kit
+
+## Usage
+
+### Configuration
+
+You can store arbitrary options in a provider's configuration:
+
+```rb
+require 'sms_kit/providers/mobi_web'
+SmsKit::MobiWeb.configure do |config|
+  config.username = 'user'
+  config.password = 'pass'
+  config.sender   = 123456
+end
+```
+
+### Send text message
+
+```rb
+provider = SmsKit::MobiWeb.new text: 'Hello World.', to: 491231234567
+result   = provider.deliver
+
+# returns the message id from MobiWeb or nil if something went wrong
+puts result // 1234
+```
+
+There's also a short version:
+
+```rb
+SmsKit::MobiWeb.deliver text: 'Hello World.', to: 491231234567
+```
+
+### Sending "Objects"
+
+If your class responds to `to_sms`, you can send it itself:
+
+```rb
+class TextMessage
+  def to_sms
+    {
+      to: 491231234567
+      text: 'hello world'
+    }
+  end
+end
+
+SmsKit.deliver :provider_name, TextMessage.new
+
+# or on a provider level
+
+class MyProvider < SmsKit::Provider
+  # ...
+end
+
+MyProvider.deliver TextMessage.new
+
+```
+
+#### Error handling
+
+SmsKit will throw a `SmsKit::DeliveryError` if something goes wrong.
+Though it depends on the specific provider this generally happens
+upon authentication errors as well as returned error codes from the web service.
+
+```rb
+begin
+  provider = :provider_symbol
+  SmsKit.deliver provider, text: 'hello world', to: '...'
+rescue SmsKit::DeliveryError => e
+  logger.error e
+end
+```
+
+## Common SMS options
+
+Which options the `#deliver` method expects generallly depends on provider implementation.
+However, core providers expect the following options, at least:
+
+- `:to` The number to send the message to
+- `:from` The sender ID
+- `:text` The text message
+
+## Packaged providers
+
+- CentralICT -- [www.centralict.com](http://www.centralict.com/)
+- MobiWeb -- [mobile-sms.biz](http://mobile-sms.biz/)
+- Mobimex -- [www.mobimex.com](http://www.mobimex.com/)
+- smstrade -- [www.smstrade.de](http://www.smstrade.eu/)
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## License
+
+SmsKit is released under the [MIT License](http://www.opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.pattern = "test/*_test.rb"
+end
+
+task default: :test

data/lib/sms_kit.rb

@@ -0,0 +1,15 @@
+require 'sms_kit/version'
+require 'sms_kit/utils'
+require 'sms_kit/delivery'
+require 'sms_kit/logging'
+require 'sms_kit/railtie' if defined?(Rails)
+
+module SmsKit
+  extend Utils
+  extend Delivery
+  extend Logging
+
+  class DeliveryError < StandardError; end
+
+  USER_AGENT = "SmsKit #{VERSION}"
+end

data/lib/sms_kit/config.rb

@@ -0,0 +1,43 @@
+require 'ostruct'
+
+module SmsKit
+  module Config
+
+    def self.included base
+      base.extend ClassMethods
+
+      base.class_eval do
+        def config
+          self.class.config
+        end
+      end
+    end
+
+    class Store < Hash
+      def method_missing meth, *args
+        unless respond_to? meth
+          if key = meth.to_s[/(.*)=$/, 1]
+            self[key.to_sym] = args.first
+          else
+            self[meth.to_sym]
+          end
+        else
+          super
+        end
+      end
+    end
+
+    module ClassMethods
+
+      def config
+        @config ||= Store.new
+      end
+
+      def configure
+        yield config
+      end
+
+    end
+
+  end
+end

data/lib/sms_kit/delivery.rb

@@ -0,0 +1,13 @@
+module SmsKit
+  module Delivery
+
+    def deliver provider, options, &block
+      unless klass = providers[provider.to_sym]
+        raise "SMS provider #{provider} not known"
+      end
+
+      klass.deliver options, &block
+    end
+
+  end
+end

data/lib/sms_kit/http.rb

@@ -0,0 +1,28 @@
+require 'faraday'
+
+module SmsKit
+  module HTTP
+
+    def uri
+      @uri ||= URI.parse self.class.const_get 'HTTP_ENDPOINT'
+    end
+
+    def post data
+      connection.post uri.path, data
+    end
+
+    def get data
+      connection.get uri.path, data
+    end
+
+    def connection
+      @conn ||= Faraday.new "#{uri.scheme}://#{uri.host}", ssl: { verify: false } do |f|
+        f.headers[:user_agent] = USER_AGENT
+        f.response :logger, SmsKit.logger
+        f.adapter Faraday.default_adapter
+        yield f if block_given?
+      end
+    end
+
+  end
+end

data/lib/sms_kit/logging.rb

@@ -0,0 +1,27 @@
+require 'logger'
+
+module SmsKit
+  module Logging
+
+    attr_writer :logger
+
+    def logger
+      @logger ||= begin
+        require 'logger'
+        Logger.new(STDOUT).tap do |l|
+          if l.respond_to? :formatter=
+            l.formatter ||= Logger::Formatter.new
+            l.formatter.extend Formatter
+          end
+        end
+      end
+    end
+
+    module Formatter
+      def call severity, datetime, progname, msg
+        '[SmsKit] ' + super(severity, datetime, progname, msg)
+      end
+    end
+
+  end
+end

data/lib/sms_kit/provider.rb

@@ -0,0 +1,25 @@
+require 'sms_kit/config'
+require 'sms_kit/http'
+
+module SmsKit
+  class Provider
+    include SmsKit::Config
+    include SmsKit::HTTP
+
+    attr_reader :data, :error_code, :error_message
+
+    def self.deliver options = {}, &block
+      options = options.to_sms if options.respond_to? :to_sms
+      new(options, &block).deliver
+    end
+
+    def initialize options = {}, &block
+      @data = options
+      yield self if block_given?
+    end
+
+    def deliver options = {}
+      raise "#{self.class.name} needs to implement #deliver"
+    end
+  end
+end

data/lib/sms_kit/providers.rb

@@ -0,0 +1,3 @@
+require 'sms_kit/providers/mobi_web'
+require 'sms_kit/providers/mobimex'
+require 'sms_kit/providers/central_ict'

data/lib/sms_kit/providers/central_ict.rb

@@ -0,0 +1,46 @@
+require 'sms_kit/provider'
+
+module SmsKit
+  class CentralICT < Provider
+
+    HTTP_ENDPOINT = 'http://api.de.centralict.net/controller/cgi/'
+
+    def deliver
+      response        = get params
+      parsed_response = parse response.body
+      status          = parsed_response['sent']
+
+      if 1 != status.to_i
+        raise DeliveryError, "Delivery failed (#{status})"
+      else
+        true
+      end
+    end
+
+    def params
+      {
+        type:    'SMS',
+        src:     data[:from] || config.sender,
+        dst:     data[:to],
+        body:    data[:text],
+        uid:     data[:uid] || '',
+        pin:     data[:pin] || '',
+        subject: data[:subject] || '',
+        call:    data[:call] || 'message_sender'
+      }
+    end
+
+    def get payload
+      connection.basic_auth config.username, config.password
+      super
+    end
+
+    def parse string
+      Hash[string.scan %r{(\w+)=(.*)}]
+    end
+
+  end
+
+  register central_ict: CentralICT
+
+end

data/lib/sms_kit/providers/mobi_web.rb

@@ -0,0 +1,54 @@
+require 'sms_kit/provider'
+
+module SmsKit
+  class MobiWeb < Provider
+
+    # http://api2.solutions4mobiles.com/bulksms/bulksend.go?msgtext=&originator=&password=mobiweb-pass&phone=491231234567&showDLR=1&username=mail@example.com
+    HTTP_ENDPOINT = "https://api2.solutions4mobiles.com/bulksms/bulksend.go"
+
+    ERROR_CODES = {
+      100 => 'Temporary Internal Server Error. Try again later',
+      101 => 'Authentication Error',
+      102 => 'No credits available',
+      103 => 'MSIDSN (phone parameter) is invalid or prefix is not supported',
+      104 => 'Tariff Error',
+      105 => 'You are not allowed to send to that destination/country',
+      106 => 'Not Valid Route number or you are not allowed to use this route',
+      107 => 'No proper Authentication (IP restriction is activated)',
+      108 => 'You have no permission to send messages through HTTP API',
+      109 => 'Not Valid Originator',
+      110 => 'You are not allowed to send (Routing not available) or Reseller is trying to send while not allowed',
+      111 => 'Invalid Expiration date or Expiration Date is less than 30 minutes than the date of SMS submission',
+      999 => 'Invalid HTTP request'
+    }
+
+    def deliver
+      response = get params
+      status   = response.body[/([a-z]+)(\d+)?/i, 1]
+      code     = response.body[/([a-z]+)(\d+)?/i, 2]
+
+      if 'ERROR' == status
+        raise DeliveryError, "#{ERROR_CODES[code.to_i]} (#{code})"
+      end
+
+      status == "OK" ? code.to_i : nil
+    end
+
+    def params
+      _data = data.dup
+      {
+        username:   config.username,
+        password:   config.password,
+        originator: _data.delete(:from) || config.sender,
+        phone:      _data.delete(:to),
+        msgtext:    _data.delete(:text),
+        showDLR:    _data.delete(:dlr) || 1,
+        charset:    _data.delete(:charset) || 8
+      }.merge _data
+    end
+
+  end
+
+  register mobi_web: MobiWeb
+
+end

data/lib/sms_kit/providers/mobimex.rb

@@ -0,0 +1,56 @@
+require 'sms_kit/provider'
+require 'json'
+
+module SmsKit
+  class Mobimex < Provider
+
+    ROUTE_AFRICA = 'AFRIKA'.freeze
+
+    HTTP_ENDPOINT = 'https://gate.quadra-mm.com/feed/http.asp'
+    RESPONSE_FORMATS = { text: 0, xml: 1, json: 2 }
+
+    # response json looks like this:
+    # {"procedure":"SMS Feed","result":1,"description":"DONE: SMS is in the send queue."}
+    def deliver
+      response = post params
+      if response.body.length > 1
+        json = JSON.parse(response.body)
+        json['result'].to_i == 1
+      else
+        raise DeliveryError, "Delivery failed (#{response.body})"
+      end
+    end
+
+    def params
+      {
+        user:        config.username,
+        pass:        config.password,
+        dlr:         data[:dlr_profile] || 0,
+        xml:         response_format,
+        from_number: data[:from] || config.sender,
+        number:      data[:to],
+        message:     data[:text],
+        idd:         data[:idd] || 0,
+        im:          data[:im] || 0,
+        route:       data[:route] || config.route,
+        type:        data[:type] || 'text'
+      }.reject { |k, v| v.nil? }
+    end
+
+    def response_format
+      RESPONSE_FORMATS.fetch data[:format], :json
+    end
+
+    def post payload
+      connection.post do |req|
+        req.url uri.path
+        req.headers['Content-Type'] = 'application/json'
+        req.body = payload.to_json
+      end
+    end
+
+  end
+
+  register mobimex: Mobimex
+
+end