simplesol 0.0.2

data/.gitignore

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

data/.rspec

@@ -0,0 +1 @@
+--colour

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in simplesol.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Askar Zinurov
+
+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,76 @@
+# Simplesol
+Client gem for sms sending through http://simplesol.ru/.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'simplesol'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install simplesol
+
+## Usage
+Configure
+
+Instantiate Client class with some config:
+
+```ruby
+  @client = Simplesol::Client.new do |c|
+    c.login    = '<your username>'
+    c.api_key  = '<your api key>'
+  end
+```
+or configure client later:
+```ruby
+  @client = Simplesol::Client.new
+  @client.configure do |c|
+    c.login    = '<your username>'
+    c.api_key  = '<your api key>'
+  end
+```
+or reset clients settings to defaults via:
+```ruby
+  @client.reset
+```
+Available commands
+ 
+  - Sending message:
+
+    ```ruby
+      @client.send_message(['mobile1', 'mobile2'], 'Привет, как дела', { :sender => 'santa' })
+    ```
+  
+  - Get sms message status:
+    
+    ```ruby
+      @client.message_status(['message id'])
+    ``` 
+
+  - Get cost of message:
+     
+    ```ruby
+      @client.message_price(['mobile1', 'mobile2'], 'Привет, как дела')
+    ```
+
+  - Check account balance:
+     
+    ```ruby
+      @client.balance
+    ```
+For futher reading and testing please look at spec/simplesol_spec.rb
+
+Tested with ruby-1.8.7-p370 and ruby-1.9.3-p327.
+
+## 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/lib/simplesol/client.rb

@@ -0,0 +1,67 @@
+require 'hashie'
+require 'digest/md5'
+require 'digest/sha1'
+
+module Simplesol
+  class Client
+    include Configuration
+
+    attr_reader :connection
+
+    def initialize
+      reset
+      configure { yield(self) } if block_given?
+
+      @connection = Faraday::Connection.new(:url => api_server) do |c|
+        c.request  :url_encoded
+        c.response :rashify
+        c.response :dates
+        c.response :json
+
+        c.adapter Faraday.default_adapter
+      end
+    end
+
+    def balance
+      call('user/balance')
+    end
+
+    # Message Functions
+
+    # param:recipients is array of mobile phones strings
+    # param:message is text of sms message
+    # options: {:sender => 'Sender', :test => 0}, :test can be 0, 1
+    def send_message(recipients, message, options = {})
+      call('message/send', { :recipients => recipients.join(','), :message => message }.merge(options))
+    end
+
+    # param:messages_id array of messages ids
+    def message_status(messages_id)
+      call('message/status', { :messages_id => messages_id.join(',') })
+    end
+
+    # param:recipients is array of mobile phones strings
+    # param:message is text of sms message
+    def message_price(recipients, message)
+      call('message/price', { :recipients => recipients.join(','), :message => message })
+    end
+
+    private
+
+    def call(url, params = {})
+      raise Simplesol::NotConfiguredError.new unless configured?
+      signed_params = params.merge(calculate_sign(params))
+      signed_params.merge!(:user => login)
+      response = connection.post(url, signed_params).body
+      raise Simplesol::Error.parse(response) if response.status == 'error'
+      response
+    end
+
+    def calculate_sign(params)
+      str = [login]
+      params.keys.map(&:to_s).sort.each {|k| str << params[k.to_sym] }
+      str << api_key
+      { :sign => Digest::MD5.hexdigest(Digest::SHA1.hexdigest(str.compact.join(''))) }
+    end
+  end
+end

data/lib/simplesol/configuration.rb

@@ -0,0 +1,35 @@
+require 'digest/md5'
+
+module Simplesol
+  module Configuration
+    VALID_OPTIONS_KEYS = [:login, :api_key, :debug, :api_server]
+
+    DEFAULT_LOGIN      = nil
+    DEFAULT_API_KEY    = nil
+    DEFAULT_DEBUG      = true
+    DEFAULT_API_SERVER = 'http://api.gosmsinfo.ru/api'
+
+    attr_accessor *VALID_OPTIONS_KEYS
+
+    def configured?
+      status = login && api_key && api_server
+      !(status.nil? || status.empty?)
+    end
+
+    def configure
+      yield self
+    end
+
+    def options
+      VALID_OPTIONS_KEYS.inject({}) do |option, key|
+        option.merge!(key => send(key))
+      end
+    end
+
+    def reset
+      VALID_OPTIONS_KEYS.each do |key|
+        send("#{key}=", Simplesol::Configuration.const_get("default_#{key}".upcase))
+      end
+    end
+  end
+end

data/lib/simplesol/errors.rb

@@ -0,0 +1,42 @@
+module Simplesol
+  class NotConfiguredError < Exception
+    def initialize
+      @message = 'You have not provided Simplesol api settings: login or api_key'
+    end
+  end
+
+  class Error < Exception
+    attr_reader :code
+
+    def initialize(response)
+      @code = response.error
+      @message = response.message
+    end
+
+    def self.parse(response)
+      if response.error
+        Simplesol::ERRORS[response.error-1].new response
+      else
+        Exception.new('error cannot be parsed')
+      end
+    end
+  end
+
+  class InvalidUserError < Error
+  end
+
+  class InvalidSignatureError < Error
+  end
+
+  class EmptyMessageError < Error
+  end
+
+  class IncorrectRecipientsListError < Error
+  end
+
+  class NotEnoughMoneyError < Error
+  end
+
+  ERRORS = [InvalidUserError, InvalidSignatureError, EmptyMessageError,
+    IncorrectRecipientsListError, NotEnoughMoneyError]
+end

data/lib/simplesol/version.rb

@@ -0,0 +1,3 @@
+module Simplesol
+  VERSION = "0.0.2"
+end

data/lib/simplesol.rb

@@ -0,0 +1,13 @@
+require "faraday"
+require "faraday_middleware"
+require "simplesol/version"
+require "simplesol/errors"
+require "simplesol/configuration"
+require "simplesol/client"
+
+module Simplesol
+  def debug_message(obj, message)
+    p "#{obj.is_a?(Class) ? obj.name : obj.class.name}> #{message}"
+  end
+  module_function :debug_message
+end

data/simplesol.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'simplesol/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "simplesol"
+  gem.version       = Simplesol::VERSION
+  gem.authors       = ["Askar Zinurov"]
+  gem.email         = ["mail@asktim.ru"]
+  gem.description   = %q{SimpleSol service client gem}
+  gem.summary       = %q{Gem for working with sms.simplesol.ru}
+  gem.homepage      = "https://github.com/AskarZinurov/simplesol"
+  
+  gem.add_development_dependency 'bundler'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'vcr'
+  gem.add_development_dependency 'webmock'
+  gem.add_runtime_dependency 'faraday'
+  gem.add_runtime_dependency 'faraday_middleware'
+  gem.add_runtime_dependency 'hashie'
+  gem.add_runtime_dependency 'rash'
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+end

data/spec/helper.rb

@@ -0,0 +1,14 @@
+require 'simplesol'
+require 'rspec'
+require 'vcr'
+
+RSpec.configure do |c|
+  c.extend VCR::RSpec::Macros
+end
+
+VCR.configure do |c|
+  c.cassette_library_dir = 'spec/vcr_cassettes'
+  c.hook_into :webmock
+  c.default_cassette_options = { :record => :new_episodes }
+  #c.allow_http_connections_when_no_cassette = true
+end

data/spec/simplesol_spec.rb

@@ -0,0 +1,104 @@
+require 'helper'
+
+describe Simplesol do
+  it 'should be configurable' do
+    settings = { :login => 'login', :api_key => 'key', :api_server => 'server.ru' }
+    client = Simplesol::Client.new do |c|
+      c.login = settings[:login]
+      c.api_key = settings[:api_key]
+      c.api_server = settings[:api_server]
+    end
+
+    settings.each do |k, v|
+      client.send(k).should == v
+    end
+  end
+
+  it 'should raise NotConfiguredError' do
+    client = Simplesol::Client.new
+    expect { client.balance }.to raise_error(Simplesol::NotConfiguredError)
+  end
+
+  it 'can be configured later' do
+    client = Simplesol::Client.new
+    client.configure do |c|
+      c.api_key = 'some'
+      c.login = 'settings'
+    end
+    client.should be_configured
+  end
+
+  it 'can reset settings to defaults' do
+    client = Simplesol::Client.new do |c|
+      c.login = 'sample login'
+    end
+    client.reset
+    client.login.should == Simplesol::Configuration::DEFAULT_LOGIN
+  end
+
+  context 'in error scope' do
+    use_vcr_cassette 'simplesol_errors'
+
+    before :all do
+      @wrong_client = Simplesol::Client.new do |c|
+        c.login = '555555'
+        c.api_key = 'wrong'
+      end
+    end
+
+    it 'raise signature error' do
+      expect { @wrong_client.balance }.to raise_error(Simplesol::InvalidSignatureError)
+    end
+  end
+
+  # This context actually send requests to api and records them to vcr casette,
+  # so you should provide your actual api login and api key to run them properly.
+  # Btw this context does not change your balance - all sms sending runs in test mode.
+=begin
+  context 'in general' do
+    use_vcr_cassette 'simplesol'
+
+    before :all do
+      @test_mobile_number = '<your mobile number>'
+      @client = Simplesol::Client.new do |c|
+        c.login = '<your login>'
+        c.api_key = '<your api key>'
+      end
+    end
+
+    it 'can fetch balance' do
+      resp = @client.balance
+      should_be_success resp
+    end
+
+    it 'can send test message' do
+      resp = @client.send_message([@test_mobile_number], 'Привет, как дела?', { :sender => 'santa', :test => 1 })
+      should_be_success resp
+      %w(balance count messages_id parts price recipients).each do |m|
+        resp.should respond_to(m)
+      end
+      resp.messages_id.should_not be_empty
+    end
+
+    it 'can fetch price' do
+      resp = @client.message_price [@test_mobile_number], 'Привет, как дела?'
+      %w(balance blocked price parts recipients).each do |m|
+        resp.should respond_to(m)
+      end
+      should_be_success resp
+    end
+
+    it 'can get statuses' do
+      resp = @client.message_status [1]
+      %w(messages details).each do |m|
+        resp.should respond_to(m)
+      end
+      should_be_success resp
+    end
+  end
+=end
+
+  def should_be_success(response)
+    response.status.should == 'success'
+  end
+end

data/spec/vcr_cassettes/simplesol_errors.yml

@@ -0,0 +1,42 @@
+--- 
+recorded_with: VCR 2.4.0
+http_interactions: 
+- request: 
+    method: post
+    uri: http://api.gosmsinfo.ru/api/user/balance
+    body: 
+      string: sign=a6d969ddce2b9aeff22f403e0d67928a&user=555555
+    headers: 
+      Accept: 
+      - "*/*"
+      Content-Type: 
+      - application/x-www-form-urlencoded
+  response: 
+    status: 
+      code: 200
+      message: OK
+    headers: 
+      Transfer-Encoding: 
+      - chunked
+      Date: 
+      - Sat, 23 Feb 2013 10:18:48 GMT
+      Pragma: 
+      - no-cache
+      Expires: 
+      - Thu, 19 Nov 1981 08:52:00 GMT
+      Set-Cookie: 
+      - PHPSESSID=7dmop50sclmndja36gds4gs693; path=/
+      Connection: 
+      - keep-alive
+      X-Powered-By: 
+      - PHP/5.3.10-1ubuntu3.4
+      Content-Type: 
+      - text/html
+      Cache-Control: 
+      - no-store, no-cache, must-revalidate, post-check=0, pre-check=0
+      Server: 
+      - nginx/1.1.19
+    body: 
+      string: " {\"status\":\"error\",\"error\":2,\"message\":\"invalid signature\"}"
+    http_version: 
+  recorded_at: Sat, 23 Feb 2013 10:18:48 GMT

metadata

@@ -0,0 +1,193 @@
+--- !ruby/object:Gem::Specification 
+name: simplesol
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 2
+  version: 0.0.2
+platform: ruby
+authors: 
+- Askar Zinurov
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2013-02-23 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: vcr
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: webmock
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: faraday
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: faraday_middleware
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: hashie
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  name: rash
+  prerelease: false
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id008
+description: SimpleSol service client gem
+email: 
+- mail@asktim.ru
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/simplesol.rb
+- lib/simplesol/client.rb
+- lib/simplesol/configuration.rb
+- lib/simplesol/errors.rb
+- lib/simplesol/version.rb
+- simplesol.gemspec
+- spec/helper.rb
+- spec/simplesol_spec.rb
+- spec/vcr_cassettes/simplesol_errors.yml
+homepage: https://github.com/AskarZinurov/simplesol
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Gem for working with sms.simplesol.ru
+test_files: 
+- spec/helper.rb
+- spec/simplesol_spec.rb
+- spec/vcr_cassettes/simplesol_errors.yml