sms24x7 0.1.0

data/.gitignore

@@ -0,0 +1,19 @@
+.idea/
+*~
+*.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,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sms24x7.gemspec
+gemspec
+
+gem 'rspec'

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Gleb Averchuk
+
+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,50 @@
+# Sms24x7
+
+Sending SMS via sms24x7 API. For more details see http://sms24x7.ru/api/
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'sms24x7'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sms24x7
+
+## Usage
+
+In the begining, you need to [register](http://outbox.sms24x7.ru/registration.php?pattern_id=2) for sending SMS through sms24x7 gateway.
+
+There are two ways for sending your SMS.
+
+The first - it's sending a SMS to one recipient. To do this, use:
+
+```
+SmsApi.push_msg_nologin('your@email.com', 'your_password', 'recipient_phone', 'sms_text', params)
+```
+
+here `recipient_phone` - is a phone number in format '7xxxyyyzzzz' and `params` - additional params that you can see in [documentation](http://sms24x7.ru/wp-content/uploads/2011/04/api_manual.pdf).
+
+The second way - it's sending multiple SMS to multiple recipients.
+
+```
+SmsApi.login('your@email.com', 'your_password')
+recipient_phones_str_arr.each do |recipient_phone|
+  SmsApi.push_msg(recipient_phone, 'sms_text', params)
+end
+```
+
+here `recipient_phones_str_arr` - it's array that consist phone numbers as strings in format that represented above.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/sms24x7.rb

@@ -0,0 +1,2 @@
+require "sms24x7/sms_api"
+require "sms24x7/version"

data/lib/sms24x7/sms_api.rb

@@ -0,0 +1,147 @@
+require 'curb-fu'
+require 'json/pure'
+
+module SmsApi
+  SMS_HOST = 'api.sms24x7.ru'
+
+  class BaseError < Exception; end
+  class InterfaceError < BaseError; end
+  class AuthError < BaseError; end
+  class NoLoginError < BaseError; end
+  class BalanceError < BaseError; end
+  class SpamError < BaseError; end
+  class EncodingError < BaseError; end
+  class NoGateError < BaseError; end
+  class OtherError < BaseError; end
+
+  module_function
+
+  # Public: Sends request to API
+  #
+  # request - Associative array to pass to API, :format key will be overridden
+  # cookie - Cookies string to be passed
+  #
+  # Returns:
+  # {
+  #   :error_code => error_code,
+  #   :data => data
+  # }
+  # If response was OK, data is an associative array, error_code is an error numeric code.
+  # Otherwise exception will be raised.
+  #
+  def _communicate(request, cookie = nil, secure = true)
+    request[:format] = 'json'
+    protocol = secure ? 'https' : 'http'
+    curl = CurbFu.post({ :host => SMS_HOST, :protocol => protocol }, request) do |curb|
+      curb.cookies = cookie if cookie
+    end
+    raise InterfaceError, 'cURL request failed' unless curl.success?
+
+    json = JSON.parse(curl.body)
+    unless (response = json['response']) && (msg = response['msg']) && (error_code = msg['err_code'])
+      raise InterfaceError, 'Empty some necessary data fields'
+    end
+
+    error_code = error_code.to_i
+    if error_code > 0
+      case error_code
+        when 2 then raise AuthError
+        when 29 then raise NoGateError
+        when 35 then raise EncodingError
+        when 36 then raise BalanceError, 'No money'
+        when 37, 38 then raise SpamError
+        else raise OtherError, "Communication to API failed. Error code: #{error_code}"
+      end
+    end
+
+    { :error_code => error_code, :data => response['data'] }
+  end
+
+  # Public: Sends a message via sms24x7 API, combining authenticating and sending message in one request.
+  #
+  # email, passwrod - Login info
+  # phone - Recipient phone number in international format (like 7xxxyyyzzzz)
+  # text - Message text, ASCII or UTF-8.
+  # params - Additional parameters as key => value array, see API doc.
+  #
+  # Returns:
+  # {
+  #   :n_raw_sms => n_raw_sms, - Number of SMS parts in message
+  #   :credits => credits - Price for a single part
+  # }
+  #
+  def push_msg_nologin(email, password, phone, text, params = {})
+    request = {
+        :method => 'push_msg',
+        :email => email,
+        :password => password,
+        :phone => phone,
+        :text => text
+    }.merge(params)
+    responce = _communicate(request)
+    check_and_result_push_msg(responce)
+  end
+
+  # Public: Logs in API, producing a session ID to be sent back in session cookie.
+  #
+  # email - User's email
+  # password - User's password
+  #
+  # Returns:
+  # cookie - Is a string "sid=#{session_id}" to be passed to cURL
+  #
+  def login(email, password)
+    request = {
+        :method => 'login',
+        :email => email,
+        :password => password
+    }
+    responce = _communicate(request)
+    raise InterfaceError, "Login request OK, but no 'sid' set" unless (sid = responce[:data]['sid'])
+    @_cookie = "sid=#{CGI::escape(sid)}"
+  end
+
+  # Public: Sends message via API, using previously obtained cookie to authenticate.
+  # That is, must first call the login method.
+  #
+  # cookie - String, returned by smsapi_login, "sid=#{session_id}"
+  # phone - Target phone
+  # text - Message text, ASCII or UTF-8
+  # params - Dictionary of optional parameters, see API documentation of push_msg method
+  #
+  # Returns:
+  # {
+  #   :n_raw_sms => n_raw_sms, - Number of SMS parts in message
+  #   :credits => credits - Price for a single part
+  # }
+  #
+  def push_msg(phone, text, params = {})
+    raise NoLoginError, 'Must first call the login method' unless @_cookie
+    request = {
+        :method => 'push_msg',
+        :phone => phone,
+        :text => text
+    }.merge(params)
+    responce = _communicate(request, @_cookie)
+    check_and_result_push_msg(responce)
+  end
+
+  # Private: Check the responce to a required fields. And formation of the resulting hash.
+  #
+  # responce - Result of _communicate method
+  #
+  # Returns:
+  # {
+  #   :n_raw_sms => n_raw_sms, - Number of SMS parts in message
+  #   :credits => credits - Price for a single part
+  # }
+  #
+  def check_and_result_push_msg(responce)
+    data = responce[:data]
+    unless (n_raw_sms = data['n_raw_sms']) && (credits = data['credits'])
+      raise InterfaceError, "Could not find 'n_raw_sms' or 'credits' in successful push_msg response"
+    end
+    #{ :n_raw_sms => n_raw_sms.to_i, :credits => credits.to_f }
+    data
+  end
+end

data/lib/sms24x7/version.rb

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

data/sms24x7.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/sms24x7/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Gleb Averchuk"]
+  gem.email         = ["altermn@gmail.com"]
+  gem.description   = %q{Sending SMS via sms24x7 API}
+  gem.summary       = %q{Uses sms24x7 gateway for sending SMS}
+  gem.homepage      = "https://github.com/newmen/sms24x7"
+
+  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 -- {test,spec,features}/*`.split("\n")
+  gem.name          = "sms24x7"
+  gem.require_paths = ["lib"]
+  gem.version       = SmsApi::VERSION
+
+  gem.add_dependency 'curb-fu'
+  gem.add_dependency 'json'
+end

data/spec/functional_spec.rb

@@ -0,0 +1,29 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe SmsApi do
+  describe 'Testing sms24x7 api calls' do
+    it 'sending SMS' do
+      email = 'your@email.com'
+      password = 'your_password'
+      phone = '79991234567' # your phone
+
+      email.should match(/^([^@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})$/), 'We need your email'
+      password.should_not eq(''), 'We need your password'
+      phone.should_not eq(''), 'We need your phone number'
+
+      sending_result = SmsApi.push_msg_nologin(email, password, phone, 'test passed',
+                                               :sender_name => 'RSpec',
+                                               :api => '1.1',
+                                               :satellite_adv => 'IF_EXISTS')
+
+      sending_result.should have_key('n_raw_sms')
+      sending_result.should have_key('credits')
+    end
+
+    it 'incorrect email and password' do
+      lambda {
+        SmsApi.push_msg_nologin('test@test.tt', 'T_T', '79991234567', 'wrong')
+      }.should raise_error(SmsApi::AuthError)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'sms24x7'
+require 'rspec'

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: sms24x7
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Gleb Averchuk
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: curb-fu
+  requirement: &11599700 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *11599700
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: &11598620 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *11598620
+description: Sending SMS via sms24x7 API
+email:
+- altermn@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/sms24x7.rb
+- lib/sms24x7/sms_api.rb
+- lib/sms24x7/version.rb
+- sms24x7.gemspec
+- spec/functional_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/newmen/sms24x7
+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.17
+signing_key: 
+specification_version: 3
+summary: Uses sms24x7 gateway for sending SMS
+test_files:
+- spec/functional_spec.rb
+- spec/spec_helper.rb