sms_activate 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c18cb09017a160177dfb2406f8ccc7d4189b4d9a
+  data.tar.gz: 350997fa41fa4ed2eb8b78dbaa3c3fc2efe1444f
+SHA512:
+  metadata.gz: 42aef41e7d9e92b47c5c35262f5d22bee3a99f816994741446da1a0ac866db7ef4ab379566b83c423dd8a26d4637f8127f0f518b89574af2efb682c3e636526e
+  data.tar.gz: 2db160c49499fe97827ba45712b12eba07d9c256ce37e985902d28a80be0de0e455c57737c628281290fb79309b486def87c81565ccf6bf0efd7fecfa4ca4775

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.idea/

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at vladislav.faust@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Vlad Faust
+
+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,70 @@
+# SmsActivate
+
+A Ruby wrapper for http://sms-activate.ru API
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sms_activate'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sms_activate
+
+## Usage
+
+```ruby
+  # Initialize a brand new client
+  client = SmsActivate::Client.new(ENV['SMS_ACTIVATE_KEY'])
+
+  # Get the balance
+  client.get_balance
+  # => 42.0
+
+  # Get available services
+  client.get_available_services
+  # => {"vk_0"=>{"quant"=>"1000", "cost"=>10}, ...}
+
+  # Obtain a number
+  client.obtain_number('vk')
+  # => #<OpenStruct id=4876647, number="79692572262">
+
+  # It works
+  client.get_activation_status(4876647)
+  # => #<OpenStruct status=:waiting>
+
+  # Send the sms, then inform the server about it
+  client.set_activation_status(4876647, :sms_sent)
+  # => #<OpenStruct status=:confirmed>
+
+  # Profit!
+  client.get_activation_status(4876647)
+  # => #<OpenStruct status=:success, code="878080">
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/vladfaust/sms_activate. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## ToDo
+
+- [ ] Write some tests
+- [ ] Implement forwarding and operators
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler/gem_tasks'
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'sms_activate'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/sms_activate.rb

@@ -0,0 +1,6 @@
+require 'sms_activate/version'
+require 'sms_activate/errors'
+require 'sms_activate/client'
+
+module SmsActivate
+end

data/lib/sms_activate/client.rb

@@ -0,0 +1,155 @@
+require 'httparty'
+
+module SmsActivate
+  class Client
+    include HTTParty
+    base_uri 'http://sms-activate.ru/stubs/handler_api.php'
+
+    # Initializes a new SmsActivate Client
+    #
+    # @param [String] api_key The API key, can be obtained at
+    #   http://sms-activate.ru/index.php?act=profile
+    #
+    def initialize(api_key)
+      @options = { query: { api_key: api_key } }
+    end
+
+    # Returns an amount of available numbers for each service
+    #
+    # @param [Boolean] full Whether to include "cost" and "quant" keys
+    #
+    # @example
+    #   SmsActivate::Client.new('key').get_available_services
+    #   => {"vk_0"=>{"quant"=>"0", "cost"=>10}, ...}
+    #
+    #   SmsActivate::Client.new('key').get_available_services(false)
+    #   => {"vk_0"=>"0", "ok_0"=>"42", ...}
+    #
+    def get_available_services(full = true)
+      action = full ? 'getNumbersStatus1' : 'getNumbersStatus'
+      response = self.class.get('/', query: { action: action }.merge(@options[:query]))
+
+      check_errors! response
+      JSON.parse(response.parsed_response)
+    end
+
+    # Returns user's balance in RUB
+    #
+    # @example
+    #   SmsActivate::Client.new('key').get_balance
+    #   => 0.0
+    def get_balance
+      response = self.class.get('/', query: { action: 'getBalance' }.merge(@options[:query]))
+
+      check_errors! response
+      response.parsed_response.split(':')[1].to_f
+    end
+
+    # Obtains a number for the given service
+    #
+    # @example
+    #   SmsActivate::Client.new('key').obtain_number('ya')
+    #   => OpenStruct id=42 number="+1234567890"
+    #
+    # TODO: forward, operator
+    #
+    def obtain_number(service)
+      response = self.class.get('/', query: { action: 'getNumber', service: service }.merge(@options[:query]))
+      check_errors! response
+
+      splitted = response.parsed_response.split(':')
+      OpenStruct.new(id: splitted[1].to_i, number: splitted[2])
+    end
+
+    # Sets the status of the activation
+    #
+    STATUSES = {
+        cancelled:   -1, # Cancels the activation
+        sms_sent:     1, # Tells that SMS message has been sent to the number
+        on_retry:    3,  # Requests one more code (for free)
+        finished:    6,  # Finishes the activation
+        number_used: 8   # Complains that number is already used and cancels the activation
+    }.freeze
+    #
+    # @example
+    #   SmsActivate::Client.new('key').set_activation_status(42, :sms_sent)
+    #   => OpenStruct status=:confirmed
+    #
+    # TODO: forward
+    #
+    def set_activation_status(id, status)
+      raise BadStatusError unless (status = STATUSES[status])
+      response = self.class.get('/', query: { action: 'setStatus', id: id, status: status }.merge(@options[:query]))
+
+      check_errors! response
+      case response.parsed_response
+        when 'ACCESS_READY'
+          OpenStruct.new(status: :confirmed)
+        when 'ACCESS_RETRY_GET'
+          OpenStruct.new(status: :retrying)
+        when 'ACCESS_ACTIVATION'
+          OpenStruct.new(status: :activated)
+        when 'ACCESS_CANCEL'
+          OpenStruct.new(status: :cancelled)
+        else
+          raise ServerError('Bad activation response')
+      end
+    end
+
+    # Returns the activation status
+    #
+    # @example
+    #   SmsActivate::Client.new('key').get_activation_status(42)
+    #   => OpenStruct status=:success code="12345"
+    #
+    def get_activation_status(id)
+      response = self.class.get('/', query: { action: 'getStatus', id: id }.merge(@options[:query]))
+
+      check_errors! response
+      case response.parsed_response
+        when 'STATUS_WAIT_CODE'
+          OpenStruct.new(status: :waiting)
+        when 'STATUS_WAIT_RESEND'
+          OpenStruct.new(status: :waiting_for_resend)
+        when 'STATUS_CANCEL'
+          OpenStruct.new(status: :cancelled)
+        when /STATUS_WAIT_RETRY/
+          OpenStruct.new(status: :waiting_for_code_confirmation, lastcode: response.parsed_response.split(':')[1])
+        when /STATUS_OK/
+          OpenStruct.new(status: :success, code: response.parsed_response.split(':')[1])
+        else
+          raise ServerError('Bad activation response')
+      end
+    end
+
+    private
+
+    def check_errors!(response)
+      raise ServerError(response.parsed_response) if response.code != 200
+
+      case response.parsed_response
+        when 'NO_KEY'
+          raise NoKeyError
+        when 'BAD_KEY'
+          raise BadKeyError
+        when 'NO_ACTION'
+          raise NoActionError
+        when 'BAD_ACTION'
+          raise BadActionError
+        when 'ERROR_SQL'
+          raise SQLError
+        when 'NO_BALANCE'
+          raise NoBalanceError
+        when 'NO_NUMBERS'
+          raise NoNumbersError
+        when 'BAD_SERVICE'
+          raise BadServiceError
+        when 'NO_ACTIVATION'
+          raise NoActivationError
+        when 'BAD_STATUS'
+          raise BadStatusError
+        else
+      end
+    end
+  end
+end

data/lib/sms_activate/errors.rb

@@ -0,0 +1,48 @@
+module SmsActivate
+  class BaseError < RuntimeError
+  end
+
+  class ServerError < BaseError
+    def initialize(msg = 'Server error') super(msg); end
+  end
+
+  class SQLError < BaseError
+    def initialize(msg = 'SQL server error') super(msg); end
+  end
+
+  class NoBalanceError < BaseError
+    def initialize(msg = 'Not enough balance') super(msg); end
+  end
+
+  class NoNumbersError < BaseError
+    def initialize(msg = 'No numbers available') super(msg); end
+  end
+
+  class NoActivationError < BaseError
+    def initialize(msg = 'Bad activation ID provided') super(msg); end
+  end
+
+  class BadStatusError < BaseError
+    def initialize(msg = 'Bad status provided') super(msg); end
+  end
+
+  class BadServiceError < BaseError
+    def initialize(msg = 'Bad service provided') super(msg); end
+  end
+
+  class BadKeyError < BaseError
+    def initialize(msg = 'Bad API key provided') super(msg); end
+  end
+
+  class BadActionError < BaseError
+    def initialize(msg = 'Bad action provided') super(msg); end
+  end
+
+  class NoKeyError < BaseError
+    def initialize(msg = 'No API key provided') super(msg); end
+  end
+
+  class NoActionError < BaseError
+    def initialize(msg = 'No action provided') super(msg); end
+  end
+end

data/lib/sms_activate/version.rb

@@ -0,0 +1,3 @@
+module SmsActivate
+  VERSION = '0.1.0'
+end

data/sms_activate.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sms_activate/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'sms_activate'
+  spec.version       = SmsActivate::VERSION
+  spec.authors       = ['Vlad Faust']
+  spec.email         = ['vladislav.faust@gmail.com']
+
+  spec.summary       = 'sms-activate.ru Ruby API wrapper'
+  spec.homepage      = 'http://github.com/vladfaust/sms-activate'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'httparty'
+
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake',    '~> 10.0'
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: sms_activate
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Vlad Faust
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-04-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  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'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: 
+email:
+- vladislav.faust@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/sms_activate.rb
+- lib/sms_activate/client.rb
+- lib/sms_activate/errors.rb
+- lib/sms_activate/version.rb
+- sms_activate.gemspec
+homepage: http://github.com/vladfaust/sms-activate
+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.5.1
+signing_key: 
+specification_version: 4
+summary: sms-activate.ru Ruby API wrapper
+test_files: []