smspilot 0.0.2

data/.gitignore

@@ -0,0 +1,19 @@
+*.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
+*.log

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Rake
+
+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,54 @@
+# Smspilot
+
+Ruby gem for smspilot.ru API
+
+http://www.smspilot.ru/download/SMSPilotRu-HTTP-v2.1.2.rtf
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'smspilot'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install smspilot
+
+## Usage
+
+create
+
+```ruby
+client = Smspilot.new api_token
+```
+
+api methods
+
+```ruby
+result = client.send_sms(sms_id, sms_from, sms_to, message_text)
+
+result = client.check_sms_status(sms_server_id)
+
+result = client.check_balance
+```
+
+Use bang! methods if you want errors to be raised.
+Otherwise access them through
+
+```ruby
+result.error
+```
+
+## 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,10 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new('spec')
+
+desc "Open an irb session preloaded with this library"
+task :console do
+  sh "pry -rubygems -I lib -r smspilot.rb"
+end

data/lib/smspilot.rb

@@ -0,0 +1,20 @@
+require "smspilot/client"
+require "smspilot/configuration"
+
+module Smspilot
+
+  extend Configuration
+
+  class << self
+    def new options = {}
+      if options.is_a? String
+        Smspilot::Client.new :api_key => options
+      elsif options.is_a? Hash
+        Smspilot::Client.new options
+      else
+        raise ArgumentError
+      end
+    end
+  end
+
+end

data/lib/smspilot/api.rb

@@ -0,0 +1,78 @@
+require 'smspilot/connection'
+require 'smspilot/configuration'
+require 'smspilot/request'
+require 'smspilot/errors'
+require 'json'
+
+module Smspilot
+  class Api
+    include Connection
+    include Request
+
+    NOT_FOUND_STATUS = "-2"
+    NOT_DELIVERED_STATUS = "-1"
+    ACCEPTED_STATUS = "0"
+    AT_OPERATOR_STATUS = "1"
+    DELIVERED_STATUS = "2"    
+
+    attr_accessor *Configuration::VALID_OPTIONS_KEYS
+
+    def initialize options = {}
+      options = Smspilot.options.merge(options)
+      Configuration::VALID_OPTIONS_KEYS.each do |key|
+        send("#{key}=", options[key])
+      end
+    end
+
+    def send_sms(sms_id, sms_from, sms_to, message_text)
+      body = {:send => [{:id => sms_id.to_s, :from => sms_from.to_s, :to => sms_to.to_s, :text => message_text.to_s}]}     
+      response = send_request body
+      enhance_response(response, "send")
+    end
+
+    def check_sms_status(sms_server_id)
+      body = {"check" => [{"server_id" => sms_server_id}]}
+      response = send_request body
+      enhance_response(response, "check")
+    end
+
+    def check_balance
+      body = {"balance" => [{"balance" => true}]}
+      send_request body
+    end
+
+
+    def send_sms!(sms_id, sms_from, sms_to, message_text)
+      response = send_sms(sms_id, sms_from, sms_to, message_text)
+      raise response.error if response.error.kind_of? StandardError
+      response
+    end
+
+    def check_sms_status! (sms_server_id)
+      response = check_sms_status (sms_server_id)
+      raise response.error if response.error.kind_of? StandardError
+      response  
+    end
+
+    def check_balance!
+      response = check_balance
+      raise response.error if response.error.kind_of? StandardError
+      response
+    end
+
+  private
+    def enhance_response(response, request_type)
+      unless response.error
+        response.instance_eval <<-RESP
+          def not_found?; #{response.body[request_type].first["status"].eql? NOT_FOUND_STATUS} end
+          def not_delivered?; #{response.body[request_type].first["status"].eql? NOT_DELIVERED_STATUS} end
+          def accepted?; #{response.body[request_type].first["status"].eql? ACCEPTED_STATUS} end
+          def at_operator?; #{response.body[request_type].first["status"].eql? AT_OPERATOR_STATUS} end
+          def delivered?; #{response.body[request_type].first["status"].eql? DELIVERED_STATUS} end
+        RESP
+      end
+
+      response
+    end
+ end
+end

data/lib/smspilot/client.rb

@@ -0,0 +1,6 @@
+require 'smspilot/api'
+
+module Smspilot
+  class Client < Api
+  end
+end

data/lib/smspilot/configuration.rb

@@ -0,0 +1,42 @@
+require 'logger'
+require 'smspilot/version'
+
+module Smspilot
+  module Configuration
+    VALID_OPTIONS_KEYS = [:endpoint, :user_agent, :adapter, :timeout, :api_key, :logger]
+
+    DEFAULT_ADAPTER     = :net_http
+    DEFAULT_ENDPOINT    = 'http://smspilot.ru/api2.php'
+    DEFAULT_USER_AGENT  = "smspilot gem #{Smspilot::VERSION}".freeze
+    DEFAULT_TIMEOUT     = 5
+    DEFAILT_API_KEY     = nil
+    DEFAILT_LOGGER      = Logger.new("log/smspilot.log")
+
+    attr_accessor *VALID_OPTIONS_KEYS
+
+    def configure
+      yield self
+    end
+
+    def self.extended(base)
+      base.reset
+    end
+
+    def options
+      options = {}
+      VALID_OPTIONS_KEYS.each{|k| options[k] = send(k)}
+      options
+    end
+
+    def reset
+      self.adapter    = DEFAULT_ADAPTER
+      self.endpoint   = DEFAULT_ENDPOINT
+      self.user_agent = DEFAULT_USER_AGENT
+      self.timeout    = DEFAULT_TIMEOUT
+      self.api_key = DEFAILT_API_KEY
+      self.logger = DEFAILT_LOGGER
+      self
+    end
+
+  end
+end

data/lib/smspilot/connection.rb

@@ -0,0 +1,30 @@
+require 'faraday_middleware'
+
+
+module Smspilot
+  module Connection
+    private
+
+      def connection
+        options = {
+          :headers => {
+            :user_agent => user_agent
+          },
+          :url => endpoint,
+          :timeout => timeout,
+          :open_timeout => timeout
+        }
+
+        Faraday.new options do |conn|
+          # conn.request :url_encoded
+          conn.request :json
+
+          conn.response :json
+          conn.response :mashify
+          conn.response :logger
+
+          conn.adapter(adapter)
+        end
+      end
+  end
+end

data/lib/smspilot/errors.rb

@@ -0,0 +1,92 @@
+module Smspilot
+  module Error
+
+    API_ERROR_CODES = {
+      "10" => "InputDataRequiredError",
+      "11" => "UnknownInputFormatError",
+      "12" => "InvalidJsonError",
+      "14" => "UnknownCommandError",
+      "100" => "ApiKeyRequired",
+      "101" => "ApiKeyInvalid",
+      "106" => "ApiKeyBlocked",
+      "110" => "SystemError",
+      "113" => "IpRestrictionError",
+      "201" => "FromInvalidError",
+      "202" => "FromDeprecatedError",
+      "210" => "ToRequiredError",
+      "211" => "ToInvalidError",
+      "212" => "ToDeprecatedError",
+      "213" => "UnsupportedZoneError",
+      "220" => "TextRequiredError",
+      "221" => "TextTooLongError",
+      "230" => "IdInvalidError",
+      "231" => "PacketIdInvalidError",
+      "240" => "InputListInvalidError",
+      "241" => "NotEnoughCreditsError",
+      "242" => "SmsCountLimitError",
+      "300" => "ServerIdRequiredError",
+      "301" => "ServerIdInvalidError",
+      "302" => "ServerIdNotFoundError",
+      "303" => "InvalidSmsCheckListError",
+      "304" => "ServerPacketIdInvalidError",
+      "400" => "UserNotFoundError"
+    }
+
+    class ApiError < StandardError
+
+      def self.raise_by_code(code=nil)
+        if API_ERROR_CODES[code].nil?
+          raise UnknownApiError
+        else
+          raise Smspilot::Error.const_get(API_ERROR_CODES[code])
+        end
+      end
+
+      def self.get_by_code(code=nil)
+        if API_ERROR_CODES[code].nil?
+          UnknownApiError
+        else
+          Smspilot::Error.const_get(API_ERROR_CODES[code])
+        end
+      end
+    end
+
+
+    class InputDataRequiredError < ApiError; end # 10
+    class UnknownInputFormatError < ApiError; end # 11
+    class InvalidJsonError < ApiError; end # 12
+    class UnknownCommandError < ApiError; end # 14
+    class ApiKeyRequired < ApiError; end # 100
+    class ApiKeyInvalid < ApiError; end # 101
+    class ApiKeyBlocked < ApiError; end # 106
+    class SystemError < ApiError; end # 110
+    class IpRestrictionError < ApiError; end # 113
+    class FromInvalidError < ApiError; end # 201
+    class FromDeprecatedError < ApiError; end # 202
+    class ToRequiredError < ApiError; end # 210
+    class ToInvalidError < ApiError; end # 211
+    class ToDeprecatedError < ApiError; end # 212
+    class UnsupportedZoneError < ApiError; end # 213
+    class TextRequiredError < ApiError; end # 220
+    class TextTooLongError < ApiError; end # 221
+    class IdInvalidError < ApiError; end # 230
+    class PacketIdInvalidError < ApiError; end # 231
+    class InputListInvalidError < ApiError; end # 240
+    class NotEnoughCreditsError < ApiError; end # 241
+    class SmsCountLimitError < ApiError; end # 242
+    class ServerIdRequiredError < ApiError; end # 300
+    class ServerIdInvalidError < ApiError; end # 301
+    class ServerIdNotFoundError < ApiError; end # 302
+    class InvalidSmsCheckListError < ApiError; end # 303
+    class ServerPacketIdInvalidError < ApiError; end # 304
+    class UserNotFoundError < ApiError; end # 400
+    class UnknownApiError < ApiError; end # unknown codes
+
+
+    class TimeoutError < StandardError; end;
+    class InvalidJsonResponseError < StandardError; end;
+    class InvalidResposeStatusError < StandardError; end;
+
+
+  end
+end

data/lib/smspilot/request.rb

@@ -0,0 +1,37 @@
+require 'timeout'
+require 'faraday_middleware'
+require 'faraday'
+require 'smspilot/errors'
+
+module Smspilot
+  module Request
+
+    def send_request(body)
+      json_body = {"apikey" => api_key}.merge(body).to_json
+      begin
+        response = connection.post do |req|
+          req.body = json_body
+        end
+        
+        response_error = (response.status == 200) ? Smspilot::Error::WrongStatusError : nil
+
+      rescue Exception => e 
+        if e.kind_of? Faraday::Error::TimeoutError
+          response_error = Smspilot::Error::TimeoutError
+        elsif e.kind_of? Faraday::Error::ParsingError
+          response_error = Smspilot::Error::ParsingError      
+        end 
+      end 
+
+      unless response.body["error"].nil?
+        response_error = Error::ApiError.get_by_code(response.body["error"]["code"]).new()
+      end
+
+      response.instance_eval <<-RESP
+        def error; #{response_error} end
+      RESP
+
+      response
+    end
+  end
+end

data/lib/smspilot/version.rb

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

data/smspilot.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/smspilot/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Rake"]
+  gem.email         = ["blazesolo@gmail.com"]
+  gem.description   = %q{}
+  gem.summary       = %q{}
+  gem.homepage      = ""
+
+  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.name          = "smspilot"
+  gem.require_paths = ["lib"]
+  gem.version       = Smspilot::VERSION
+
+
+  gem.add_runtime_dependency "faraday", '~> 0.8.1'
+  gem.add_runtime_dependency "faraday_middleware", '~> 0.8.8'
+  gem.add_runtime_dependency 'hashie', '~> 1.2.0'
+
+  gem.add_development_dependency 'rspec', '~> 2.5'
+  gem.add_development_dependency 'webmock'
+  gem.add_development_dependency 'pry'
+
+
+
+end

data/spec/lib/smspilot_spec.rb

@@ -0,0 +1,121 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Smspilot do
+
+  let(:sms_id) {'12345'}
+  let(:sms_server_id) {'10005'}
+  let(:sms_from) {'SMSPILOT'}
+  let(:sms_to) {79091112233}
+  let(:message_text) {"Тест"}
+  let(:json_failure_response) {'{"error":{"code":"1337","description":"leeterror"}}'}
+
+
+#TODO add specs for sms delivery statuses
+#TODO add specs for parameter validations
+
+
+  before do
+    @client = Smspilot.new "XXXXXXXXXXXXYYYYYYYYYYYYZZZZZZZZXXXXXXXXXXXXYYYYYYYYYYYYZZZZZZZZ"
+  end
+
+  describe "#send_sms" do 
+    
+    let(:json_send_response) { {"send"=> [{"id"=>"12345", "server_id"=>"10005", "from"=>"SMSPILOT", "to"=>"79091112233", "text"=>"Тест", "zone"=>"1", "parts"=>"1", "credits"=>"1", "status"=>"0", "error"=>"0"}], "server_packet_id"=>"1234", "balance"=>"10000"}.to_json}
+
+    it "should return correct result when succeeded" do
+      stub_normal_request(json_send_response)
+      result = @client.send_sms(sms_id, sms_from, sms_to, message_text)
+      result.body.should == {"send"=> [{"id"=>"12345", "server_id"=>"10005", "from"=>"SMSPILOT", "to"=>"79091112233", "text"=>"Тест", "zone"=>"1", "parts"=>"1", "credits"=>"1", "status"=>"0", "error"=>"0"}], "server_packet_id"=>"1234", "balance"=>"10000"}
+      result.status.should eql(200)
+    end
+
+  end
+
+
+  describe "#check_sms_status" do 
+    
+    let (:check_response_hash) { {"check"=> [{"id"=>"12345", "server_id"=>"10005", "status"=>"1", "modified"=>"2011-08-11 14:35:00"}]} }
+
+    it "should return correct hash when succeeded" do
+      stub_normal_request(check_response_hash.to_json)      
+      
+      result = @client.check_sms_status(sms_server_id)
+      result.body.should == {"check"=> [{"id"=>"12345", "server_id"=>"10005", "status"=>"1", "modified"=>"2011-08-11 14:35:00"}]} 
+      result.status.should eql(200)    
+    end
+    it "should return correct sms status when succeeded" do
+      check_response_hash["check"].first["status"] = Smspilot::Api::NOT_FOUND_STATUS
+      stub_normal_request(check_response_hash.to_json)      
+      
+      result = @client.check_sms_status(sms_server_id)
+      result.not_found?.should be_true
+    end
+    it "should return correct sms status when succeeded" do
+      check_response_hash["check"].first["status"] = Smspilot::Api::NOT_DELIVERED_STATUS
+      stub_normal_request(check_response_hash.to_json)      
+      
+      result = @client.check_sms_status(sms_server_id)
+      result.not_delivered?.should be_true   
+    end
+    it "should return correct sms status when succeeded" do
+      check_response_hash["check"].first["status"] = Smspilot::Api::ACCEPTED_STATUS
+      stub_normal_request(check_response_hash.to_json)      
+      
+      result = @client.check_sms_status(sms_server_id)
+      result.accepted?.should be_true   
+    end
+    it "should return correct sms status when succeeded" do
+      check_response_hash["check"].first["status"] = Smspilot::Api::AT_OPERATOR_STATUS
+      stub_normal_request(check_response_hash.to_json)      
+      
+      result = @client.check_sms_status(sms_server_id)
+      result.at_operator?.should be_true   
+    end
+    it "should return correct sms status when succeeded" do
+      check_response_hash["check"].first["status"] = Smspilot::Api::DELIVERED_STATUS
+      stub_normal_request(check_response_hash.to_json)      
+      
+      result = @client.check_sms_status(sms_server_id)
+      result.delivered?.should be_true   
+    end
+
+  end
+
+  describe "#check_balance" do 
+    
+    let(:json_balance_response) {'{"balance":31337}'}
+
+    it "should return correct hash when succeeded" do
+      stub_normal_request(json_balance_response)
+      
+      result = @client.check_balance
+      result.body.should == {"balance"=> 31337} 
+      result.status.should eql(200)    
+    end
+
+  end
+
+  describe "send_request errors" do
+
+    before do
+      stub_normal_request(json_failure_response)
+    end
+
+    it "should be unknown apierror when there is correct error response" do
+      result = @client.send_request({})
+      result.error.should eql(Smspilot::Error::UnknownApiError)
+    end 
+
+    it "should be correct apierror type when there is correct error response" do
+      Smspilot::Error::API_ERROR_CODES["1337"] = "LeetError"
+      class Smspilot::Error::LeetError < Smspilot::Error::ApiError; end    
+      
+      result = @client.send_request({})
+      result.error.should eql(Smspilot::Error::LeetError)
+    end 
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require 'rspec'
+require 'webmock/rspec'
+require 'smspilot'
+require 'smspilot/errors'
+require 'pry'
+
+RSpec.configure do |config|
+  config.color_enabled = true
+  config.formatter     = 'documentation'
+end
+
+def stub_normal_request(body)
+  stub_request(:post, Smspilot::Configuration::DEFAULT_ENDPOINT).to_return(:body => body, :status => 200, :headers => {:content_type => 'application/json'} )      
+end

metadata

@@ -0,0 +1,160 @@
+--- !ruby/object:Gem::Specification
+name: smspilot
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Rake
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.8
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ''
+email:
+- blazesolo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/smspilot.rb
+- lib/smspilot/api.rb
+- lib/smspilot/client.rb
+- lib/smspilot/configuration.rb
+- lib/smspilot/connection.rb
+- lib/smspilot/errors.rb
+- lib/smspilot/request.rb
+- lib/smspilot/version.rb
+- log/.gitignore
+- smspilot.gemspec
+- spec/lib/smspilot_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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.24
+signing_key: 
+specification_version: 3
+summary: ''
+test_files:
+- spec/lib/smspilot_spec.rb
+- spec/spec_helper.rb