sms_centre 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 888f04fa711bf759a971c6c83db68de98d5efac5
+  data.tar.gz: 9aeca8e1672f7ef79d1c7f2c3c535a9efbf9a009
+SHA512:
+  metadata.gz: 3b823ef4321cd2e9650a29055a70f6137ea5840b00e3d2370e8ea809e8919e957ede8a9549eabaac059f854548abb0f00b8c816e2bc35faccdb04eb5dc385071
+  data.tar.gz: 6090666a27660b3ed16cdc263bf7d0445c2f0d6a018e5ffcd5f1b1a9f392884ef16ca46b0ea164e142623eb4fe25b8bb826b6cdb4294c3b898fbe843c39d7e3c

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,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sms_centre.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Maxim Andryunin, Sybis Technology
+
+MIT License
+
+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.md

@@ -0,0 +1,90 @@
+# SMSCentre
+
+Send SMS via [SMS Centre](http://smscentre.com) gateway
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'sms_centre'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sms_centre
+
+## Usage
+
+1. Register at [http://smscentre.com](http://smscentre.com)
+2. Create api object:
+    
+    ```ruby
+    api = SMSCentre::API.new('your_login', 'your_password')
+    ```
+
+3. Send sms:
+
+    ```ruby
+    # Single phone
+    result = api.broadcast('PHONENUMBER1', 'This is message text')
+    
+    # Multiple phones
+    result = api.broadcast(['PHONENUMBER1', ...], 'This is message text')
+
+    # Optional, you can set sender name and message id (can be used for status check)
+    result = api.broadcast('PHONENUMBER1', 'This is message text', params: {sender: 'SENDER NAME', id: 'MESSAGE_ID'}
+
+    # Get phone status code
+    result.status_for 'PHONENUMBER1'
+
+    # Or get localized status string (only russian supported yet)
+    result.human_status_for 'PHONENUMBER1'
+    ```
+
+4. Get sms status by phone number and message id:
+
+    ```ruby
+    status = api.status('MESSAGE_ID', 'PHONENUMBER1')
+
+    # Get status code
+    status.status
+
+    # Get get localized status string
+    status.human_status
+
+    # More generic status checks
+    status.delivered? # Is message delivered?
+    status.pending?   # Is message in queue yet?
+    status.failed?    # Is message delivery failed for some reason?
+    ```
+
+5. Check your balance:
+
+    ```
+    api.balance
+    # => '999.99'
+
+## Configure
+
+Paste this code in some file, load it before send sms (rails hint: initializer is the best place to do it)
+
+```
+SMSCentre.configure.do |config|
+  # For example, disable SSL
+  config.use_ssl = false
+end
+```
+
+See options list in [source code](lib/sms_centre/configuration.rb)
+
+
+## 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

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/TODO.md

@@ -0,0 +1 @@
+* Find optimum value for max_phones_per_request option

data/lib/sms_centre.rb

@@ -0,0 +1,106 @@
+require 'json'
+require 'logger'
+require 'net/http'
+require 'i18n'
+
+require 'sms_centre/version'
+
+I18n.load_path += Dir[File.expand_path('..', __FILE__) + '/sms_centre/locales/*.yml']
+
+module SMSCentre
+  ERRORS = {
+    (ERROR_PARAMS            = 1) => 'error.parameters',
+    (ERROR_AUTH              = 2) => 'error.auth',
+    (ERROR_BALANCE           = 3) => 'error.balance',
+    (ERROR_FLOOD             = 4) => 'error.flood',
+    (ERROR_DATE_FORMAT       = 5) => 'error.data_format',
+    (ERROR_FORBIDDEN_MESSAGE = 6) => 'error.forbidden_message',
+    (ERROR_PHONE_FORMAT      = 7) => 'error.phone_format',
+    (ERROR_IMPOSSIBLE        = 8) => 'error.impossible',
+    (ERROR_REPEATED_REQUEST  = 9) => 'error.repeated_request',
+  }
+
+  MESSAGE_STATUSES = {
+    (MESSAGE_STATUS_PENDING                 = -1) => 'message_status.pending',
+    (MESSAGE_STATUS_OPERATOR                = 0 ) => 'message_status.operator',
+    (MESSAGE_STATUS_DELIVERED               = 1 ) => 'message_status.delivered',
+    (MESSAGE_STATUS_EXPIRED                 = 3 ) => 'message_status.expired',
+    (MESSAGE_STATUS_ERROR_IMPOSSIBLE        = 20) => 'message_status.impossible',
+    (MESSAGE_STATUS_ERROR_PHONE_FORMAT      = 22) => 'message_status.phone_format_error',
+    (MESSAGE_STATUS_ERROR_FORBIDDEN_MESSAGE = 23) => 'message_status.forbidden_message_error',
+    (MESSAGE_STATUS_ERROR_BALANCE           = 24) => 'message_status.balance_error',
+    (MESSAGE_STATUS_UNAVAILABLE             = 25) => 'message_status.unavailable'
+  }
+
+  STATUS_ERRORS = {
+    (STATUS_ERROR_PARAMS            = 1) => 'status_error.parameters',
+    (STATUS_ERROR_AUTH              = 2) => 'status_error.auth',
+    (STATUS_ERROR_NOT_FOUND         = 3) => 'status_error.not_found',
+    (STATUS_ERROR_IP_BANNED         = 4) => 'status_error.ip_banned',
+    (STATUS_ERROR_REPEATED_REQUEST  = 9) => 'status_error.repeated_request'
+  }
+
+  autoload :API,           'sms_centre/api'
+  autoload :Configuration, 'sms_centre/configuration'
+  autoload :Provider,      'sms_centre/provider'
+  autoload :Result,        'sms_centre/result'
+  autoload :Status,        'sms_centre/status'
+
+  Error           = Class.new(StandardError)
+  ConnectionError = Class.new(Error)
+  ServerError     = Class.new(Error)
+
+  class ClientError < Error
+    attr_reader :error_code
+
+    def initialize(error)
+      if Fixnum === error
+        @error_code = error
+        super(ERRORS[error])
+      else
+        super(error)
+      end
+    end
+
+    def human_message
+      if @error_code
+        SMSCentre.human_error(@error_code)
+      else
+        message
+      end
+    end
+  end
+
+  class << self
+    attr_writer :configuration
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def reset
+      @configuration = Configuration.new
+    end
+
+    def configure
+      yield(configuration)
+    end
+
+    def logger
+      configuration.logger
+    end
+
+    def human_error(error_code)
+      I18n.t('sms_centre.' + ERRORS[error_code])
+    end
+
+    def human_message_status(message_status_code)
+      I18n.t('sms_centre.' + MESSAGE_STATUSES[message_status_code])
+    end
+
+    def human_status_error(status_error_code)
+      I18n.t('sms_centre.' + STATUS_ERRORS[status_error_code])
+    end
+  end
+
+end

data/lib/sms_centre/api.rb

@@ -0,0 +1,81 @@
+module SMSCentre
+  class API
+    def initialize(login, password)
+      @provider = Provider.new(login, password)
+    end
+
+    def balance
+      resp = @provider.request(path: '/sys/balance.php')
+      
+      if resp.key?("balance")
+        resp["balance"]
+      else
+        raise ServerError.new("unexpected response: 'balance' key not found")
+      end
+    end
+
+    def broadcast(phones, message, opts = {})
+      opts   = {path: '/sys/send.php'}.merge(opts)
+      phones = [phones] if phones.kind_of? String
+
+      if phones.length > SMSCentre.configuration.max_phones_per_request
+        raise ClientError.new("too much phone numbers per request")
+      end
+
+      params = {
+        phones: phones.join(','),
+        mes:    message,
+        err:    1, # Show errors for each phone
+        cost:   3  # Return request cost and result balance
+      }
+
+      params.merge!(opts.delete(:params) || {})
+
+      resp = @provider.request(opts.merge(params: params))
+
+      if resp.key?("error_code")
+        global_error = case resp["error_code"]
+                       when ERROR_IMPOSSIBLE
+                         MESSAGE_STATUS_ERROR_IMPOSSIBLE
+                       when ERROR_PHONE_FORMAT
+                         MESSAGE_STATUS_ERROR_PHONE_FORMAT
+                       when ERROR_FORBIDDEN_MESSAGE
+                         MESSAGE_STATUS_ERROR_FORBIDDEN_MESSAGE
+                       when ERROR_BALANCE
+                         MESSAGE_STATUS_ERROR_BALANCE
+                       else
+                         raise ClientError.new(resp['error_code'])
+                       end
+
+        errors = {}
+        phones.each { |p| errors[p] = global_error }
+
+        Result.new(errors, resp['id'])
+      else
+        Result.new(resp['errors'] || {}, resp['id'], cost: resp['cost'], balance: resp['balance'])
+      end
+    end
+
+    def status(message_id, phone, opts = {})
+      opts   = {path: '/sys/status.php', all: 2}.merge(opts)
+      params = {
+        phone: phone,
+        id:    message_id
+      }
+
+      params.merge!(opts.delete(:params) || {})
+
+      resp = @provider.request(opts.merge(params: params))
+
+      if resp.key?('error_code')
+        raise ClientError.new(resp['error_code'])
+      end
+
+      Status.new(phone,  message_id, resp["status"],
+        err:            resp["err"],
+        last_date:      resp["last_date"],
+        last_timestamp: resp["last_timestamp"],
+      )
+    end
+  end
+end

data/lib/sms_centre/configuration.rb

@@ -0,0 +1,45 @@
+module SMSCentre
+  class Configuration
+    # @return [Boolean] use HTTPS by default.
+    #   Defaults to false.
+    attr_accessor :ssl
+
+    # @return [String] SMS Centre gateway API host.
+    #   Defaults to "smsc.ru".
+    attr_accessor :host
+
+    # @return [Fixnum] SMS Centre gateway API port.
+    #   Defaults to 80 or 443, depends on 'ssl' option.
+    def port
+      @port ||= ssl ? 443 : 80
+    end
+
+    attr_writer :port
+
+    # @return [String] Default sender name.
+    #   Defaults to nil.
+    attr_accessor :sender
+
+    # @return [Fixnum] Default timeout for single API call.
+    #   Defaults to 0 (no timeout).
+    attr_accessor :timeout
+
+    # @return [Logger] Logger instance, should be compatible with ruby logger.
+    #   Defaults to Logger.new(STDOUT).
+    attr_accessor :logger
+
+    # @return [Fixnum] Maximum phones count for single API call.
+    #   Defaults to 10.
+    attr_accessor :max_phones_per_request
+
+    def initialize
+      @ssl                    = true
+      @host                   = "smsc.ru"
+      @timeout                = 0
+      @max_phones_per_request = 10
+
+      @logger ||= Logger.new(STDOUT)
+      @logger.level = Logger::DEBUG
+    end
+  end
+end

data/lib/sms_centre/locales/ru.yml

@@ -0,0 +1,30 @@
+ru:
+  sms_centre:
+    error:
+      parameters: Ошибка в параметрах
+      auth: Неверный логин или пароль
+      balance: Недостаточно средств на счете клиента
+      flood: IP-адрес временно заблокирован из-за частых ошибок в запросах
+      data_format: Неверный формат даты
+      forbidden_message: Сообщение запрещено (по тексту или по имени отправителя)
+      phone_format: Неверный формат номера телефона
+      impossible: Сообщение на указанный номер не может быть доставлено
+      repeated_request: Отправка более одного одинакового запроса на передачу SMS-сообщения либо более пяти одинаковых запросов на получение стоимости сообщения в течение минут
+
+    message_status:
+      pending: Ожидает отправки
+      operator: Передано оператору
+      delivered: Доставлено
+      expired: Просрочено
+      impossible: Невозможно доставить
+      phone_format_error: Неверный номер
+      forbidden_message_error: Запрещено
+      balance_error: Недостаточно средств
+      unavailable: Недоступный номер
+
+    status_error:
+      parameters: Ошибка в параметрах
+      auth: Неверный логин или пароль
+      not_found: Сообщение не найдено
+      ip_banned: IP-адрес временно заблокирован
+      repeated_request: Попытка отправки более пяти запросов на получение статуса одного и того же сообщения в течение минуты

data/lib/sms_centre/provider.rb

@@ -0,0 +1,72 @@
+module SMSCentre
+  class Provider
+    def initialize(login, password)
+      @login    = login
+      @password = password
+    end
+
+    # Perform API call
+    #
+    # @option opts [Fixnum]  :timeout Timeout for API call
+    # @option opts [String]  :path ('sys/send.php') Remote script path
+    # @option opts [String]  :host SMS Centre gateway API host
+    # @option opts [Boolean] :ssl Use HTTPS for API call
+    def request(opts = {})
+      opts   = default_opts.merge(opts)
+      params = default_params.merge(opts.fetch(:params, {}))
+      data   = URI.encode_www_form(params)
+
+      resp = perform_request(opts, data)
+      JSON.parse(resp.body || '')
+    rescue Errno::ECONNREFUSED => e
+      raise ConnectionError.new(e.message)
+    rescue JSON::ParserError => e
+      raise ServerError.new("response json parsing failed: #{e.message}")
+    end
+
+    private
+
+      def default_params
+        params = {
+          login:   @login,    # Login
+          psw:     @password, # Password
+          fmt:     3,         # Use JSON format for response
+          charset: 'utf-8'    # Message charset
+        }
+
+        unless SMSCentre.configuration.sender.nil?
+          params[:sender] = SMSCentre.sender
+        end
+
+        params
+      end
+
+      def default_opts
+        {
+          timeout: SMSCentre.configuration.timeout,
+          ssl:     SMSCentre.configuration.ssl,
+          host:    SMSCentre.configuration.host,
+          port:    SMSCentre.configuration.port
+        }
+      end
+
+      def perform_request(opts, data)
+        Timeout.timeout(opts[:timeout]) do
+          uri  = opts[:ssl] ? "https://" : "http://"
+          uri += opts[:host]
+          uri += ":#{opts[:port]}"
+          uri += opts[:path]
+
+          SMSCentre.logger.debug "call: POST #{uri}; Data: '#{data}'"
+
+          resp = Net::HTTP.start(opts[:host], opts[:port], use_ssl: opts[:ssl]) do |http|
+            http.post(opts[:path], data)
+          end
+
+          SMSCentre.logger.debug "resp: (#{resp.code}) #{resp.body.inspect}"
+          
+          resp
+        end
+      end
+  end
+end

data/lib/sms_centre/result.rb

@@ -0,0 +1,30 @@
+module SMSCentre
+  class Result
+    attr_reader :message_id
+    attr_reader :cost
+    attr_reader :balance
+
+    def initialize(phones, message_id, opts = {})
+      @phones     = phones
+      @message_id = message_id
+      @cost       = opts[:cost]
+      @balance    = opts[:balance]
+    end
+
+    def status_for(phone)
+      @phones[phone] || MESSAGE_STATUS_PENDING
+    end
+
+    def human_status_for(phone)
+      SMSCentre.human_message_status(status_for(phone))
+    end
+
+    def succeed?(phone)
+      !@phones.key?(phone)
+    end
+
+    def failed?(phone)
+      @phones.key?(phone)
+    end
+  end
+end

data/lib/sms_centre/status.rb

@@ -0,0 +1,36 @@
+module SMSCentre
+  class Status
+    attr_reader :message_id
+    attr_reader :phone
+    attr_reader :status
+    attr_reader :err
+    attr_reader :last_date
+    attr_reader :last_timestamp
+
+    def initialize(phone, message_id, status, opts = {})
+      @phone      = phone
+      @message_id = message_id
+      @status     = status
+
+      @err            = opts[:err]
+      @last_date      = opts[:last_date]
+      @last_timestamp = opts[:last_timestamp]
+    end
+
+    def delivered?
+      @status == MESSAGE_STATUS_DELIVERED
+    end
+
+    def pending?
+      [MESSAGE_STATUS_PENDING, MESSAGE_STATUS_OPERATOR].include?(@status)
+    end
+
+    def failed?
+      !(delivered? || pending?)
+    end
+
+    def human_status
+      SMSCentre.human_message_status(status)
+    end
+  end
+end

data/lib/sms_centre/version.rb

@@ -0,0 +1,3 @@
+module SMSCentre
+  VERSION = "0.1.0"
+end

data/sms_centre.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sms_centre/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sms_centre"
+  spec.version       = SMSCentre::VERSION
+  spec.authors       = ["Maxim Andryunin"]
+  spec.email         = ["maxim.andryunin@gmail.com"]
+  spec.description   = %q{HTTP-API wrapper for smscentre.com}
+  spec.summary       = %q{Send SMS via smscentre.com gateway}
+  spec.homepage      = "https://github.com/sybis/sms_centre"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+
+  spec.add_dependency "i18n"
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: sms_centre
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Maxim Andryunin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: HTTP-API wrapper for smscentre.com
+email:
+- maxim.andryunin@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- TODO.md
+- lib/sms_centre.rb
+- lib/sms_centre/api.rb
+- lib/sms_centre/configuration.rb
+- lib/sms_centre/locales/ru.yml
+- lib/sms_centre/provider.rb
+- lib/sms_centre/result.rb
+- lib/sms_centre/status.rb
+- lib/sms_centre/version.rb
+- sms_centre.gemspec
+homepage: https://github.com/sybis/sms_centre
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Send SMS via smscentre.com gateway
+test_files: []