sms24x7 0.1.0 → 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ef9489a23b505f0b5d55145e6fbd9f1a3e18f89b
+  data.tar.gz: ddfa04b66da1a6632d4316756e1c544f6ef2ca3a
+SHA512:
+  metadata.gz: 0d5f0920931f6a9e4f44c7abbc53d11d9cd895a77f8149ca3a0c01666524bd5190c8f44cdc7dae697651a8f79e860590e7b74c7031a4e82e7e3e27a14f6f6ca7
+  data.tar.gz: 605442ff1b11b9d89720056a81ab2a28a45b003aa4b47008c091475bdc72bc27555b59c58052a8a5f3be0c89fac97e16b0913971639046d012c03bc90e94456d

data/LICENSE

@@ -1,22 +1,8 @@
-Copyright (c) 2012 Gleb Averchuk
+Copyright (c) 2012, Gleb Averchuk
+All rights reserved.
 
-MIT License
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
 
-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.
+Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -1,3 +1,5 @@
+[![Gem Version](https://badge.fury.io/rb/sms24x7.png)](http://badge.fury.io/rb/sms24x7)
+
 # Sms24x7
 
 Sending SMS via sms24x7 API. For more details see http://sms24x7.ru/api/
@@ -20,12 +22,21 @@ Or install it yourself as:
 
 In the begining, you need to [register](http://outbox.sms24x7.ru/registration.php?pattern_id=2) for sending SMS through sms24x7 gateway.
 
+Before sending SMS, you need to configure SmsApi with login credentials:
+
+```
+SmsApi.setup do |config|
+  config.email = 'your@email.com'
+  config.password = 'your_password'
+end
+```
+
 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)
+SmsApi.push_msg_nologin('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).
@@ -33,18 +44,12 @@ here `recipient_phone` - is a phone number in format '7xxxyyyzzzz' and `params`
 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)
+SmsApi.login do
+  recipient_phones_str_arr.each do |recipient_phone|
+    SmsApi.push_msg(recipient_phone, 'sms_text', params)
+  end
 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/lib/sms24x7/sms_api.rb

@@ -1,5 +1,6 @@
 require 'curb-fu'
 require 'json/pure'
+require 'active_support/core_ext/module/attribute_accessors'
 
 module SmsApi
   SMS_HOST = 'api.sms24x7.ru'
@@ -14,8 +15,19 @@ module SmsApi
   class NoGateError < BaseError; end
   class OtherError < BaseError; end
 
+  # Login info
+  mattr_accessor :email
+  mattr_accessor :password
+
+  # Session cookie
+  mattr_reader :cookie
+
   module_function
 
+  def setup
+    yield self
+  end
+
   # Public: Sends request to API
   #
   # request - Associative array to pass to API, :format key will be overridden
@@ -59,7 +71,6 @@ module SmsApi
 
   # 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.
@@ -70,11 +81,11 @@ module SmsApi
   #   :credits => credits - Price for a single part
   # }
   #
-  def push_msg_nologin(email, password, phone, text, params = {})
+  def push_msg_nologin(phone, text, params = {})
     request = {
         :method => 'push_msg',
-        :email => email,
-        :password => password,
+        :email => @@email,
+        :password => @@password,
         :phone => phone,
         :text => text
     }.merge(params)
@@ -84,27 +95,30 @@ module SmsApi
 
   # 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
+  # cookie - Is a string "sid=#{session_id}" to be passed to cURL if no block given
   #
-  def login(email, password)
+  def login
     request = {
         :method => 'login',
-        :email => email,
-        :password => password
+        :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)}"
+    @@cookie = "sid=#{CGI::escape(sid)}"
+
+    if block_given?
+      yield
+      @@cookie = nil
+    end
+
+    @@cookie
   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
@@ -116,13 +130,13 @@ module SmsApi
   # }
   #
   def push_msg(phone, text, params = {})
-    raise NoLoginError, 'Must first call the login method' unless @_cookie
+    raise NoLoginError, 'Must first call the login method' unless @@cookie
     request = {
         :method => 'push_msg',
         :phone => phone,
         :text => text
     }.merge(params)
-    responce = _communicate(request, @_cookie)
+    responce = _communicate(request, @@cookie)
     check_and_result_push_msg(responce)
   end
 
@@ -141,7 +155,6 @@ module SmsApi
     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

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

data/sms24x7.gemspec

@@ -17,4 +17,5 @@ Gem::Specification.new do |gem|
 
   gem.add_dependency 'curb-fu'
   gem.add_dependency 'json'
+  gem.add_dependency 'activesupport', '>= 3.2.1'
 end

data/spec/functional_spec.rb

@@ -2,16 +2,27 @@ require File.dirname(__FILE__) + '/spec_helper'
 
 describe SmsApi do
   describe 'Testing sms24x7 api calls' do
+    def error_message(variable, filename, line_number = nil)
+      msg = "Please setup your #{variable} in spec/#{filename}"
+      msg << " at line ##{line_number}" if line_number
+      msg
+    end
+
+    def check_email_and_password
+      SmsApi.email.should_not be_nil, error_message('email', 'spec_helper.rb')
+      SmsApi.email.should match(/^([^@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})$/), error_message('email', 'spec_helper.rb')
+
+      SmsApi.password.should_not be_nil, error_message('password', 'spec_helper.rb')
+      SmsApi.password.should_not eq(''), error_message('password', 'spec_helper.rb')
+    end
+
     it 'sending SMS' do
-      email = 'your@email.com'
-      password = 'your_password'
-      phone = '79991234567' # your phone
+      check_email_and_password
 
-      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'
+      phone = '' # <- enter here your phone number
+      phone.should_not eq(''), error_message('phone number', 'functional_spec.rb', __LINE__ - 1)
 
-      sending_result = SmsApi.push_msg_nologin(email, password, phone, 'test passed',
+      sending_result = SmsApi.push_msg_nologin(phone, 'test passed',
                                                :sender_name => 'RSpec',
                                                :api => '1.1',
                                                :satellite_adv => 'IF_EXISTS')
@@ -20,10 +31,32 @@ describe SmsApi do
       sending_result.should have_key('credits')
     end
 
+    it 'sending multiple SMS' do
+      check_email_and_password
+
+      phones = %w() # <- enter here a few of your phone numbers
+      phones.should_not be_empty, error_message('phone numbers', 'functional_spec.rb', __LINE__ - 1)
+
+      SmsApi.login do
+        phones.each do |phone|
+          sending_result = SmsApi.push_msg_nologin(phone, 'multiple SMS test passed')
+          sending_result.should have_key('n_raw_sms')
+          sending_result.should have_key('credits')
+        end
+      end
+
+      SmsApi.cookie.should be_nil
+    end
+
     it 'incorrect email and password' do
-      lambda {
-        SmsApi.push_msg_nologin('test@test.tt', 'T_T', '79991234567', 'wrong')
-      }.should raise_error(SmsApi::AuthError)
+      SmsApi.setup do |config|
+        config.email = 'test@test.tt'
+        config.password = 'T_T'
+      end
+
+      expect {
+        SmsApi.push_msg_nologin('79991234567', 'wrong')
+      }.to raise_error(SmsApi::AuthError)
     end
   end
 end

data/spec/spec_helper.rb

@@ -1,3 +1,8 @@
 $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 require 'sms24x7'
 require 'rspec'
+
+SmsApi.setup do |config|
+  config.email = ''      # <- enter your email here
+  config.password = ''   # <- enter your password here
+end

metadata

@@ -1,38 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: sms24x7
 version: !ruby/object:Gem::Version
-  version: 0.1.0
-  prerelease: 
+  version: 0.2.0
 platform: ruby
 authors:
 - Gleb Averchuk
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-05 00:00:00.000000000 Z
+date: 2013-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: curb-fu
-  requirement: &11599700 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *11599700
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &11598620 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *11598620
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.1
 description: Sending SMS via sms24x7 API
 email:
 - altermn@gmail.com
@@ -53,27 +72,26 @@ files:
 - spec/spec_helper.rb
 homepage: https://github.com/newmen/sms24x7
 licenses: []
+metadata: {}
 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
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Uses sms24x7 gateway for sending SMS
 test_files:
 - spec/functional_spec.rb