sms-pilot-api-v1 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1c7152ee4bb497bc839d159e8cdc7bb9b9b5735179a8c5ced0176924acd53727
+  data.tar.gz: 9dfa498a10e6b68c6115ed42ff4a6b678a18b4b31ad2532f1092095d9efe9a60
+SHA512:
+  metadata.gz: fb942ccb1bfab86c399c1c0567885d8ca0b43ca54f3e832d6316d6ad2838beb7d1ade363f537247aff90aa8090886a78f2ac0187c9e82c077ade0944bb4e5497
+  data.tar.gz: 6ca91958e3d50371b7a48c7679b6a6285f6ff9d8389e2e2a0605e02f6eea85359e2b873366351d762fe48bad1bf288c3f9d94244fa8c0ac5a09a1c85230ae5de

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2021-05-06
+
+- Initial release

data/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,57 @@
+PATH
+  remote: .
+  specs:
+    sms-pilot-api-v1 (0.1.0)
+      http (>= 4.4)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    diff-lcs (1.4.4)
+    domain_name (0.5.20190701)
+      unf (>= 0.0.5, < 1.0.0)
+    ffi (1.15.0)
+    ffi-compiler (1.0.1)
+      ffi (>= 1.0.0)
+      rake
+    http (4.4.1)
+      addressable (~> 2.3)
+      http-cookie (~> 1.0)
+      http-form_data (~> 2.2)
+      http-parser (~> 1.2.0)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    http-form_data (2.3.0)
+    http-parser (1.2.3)
+      ffi-compiler (>= 1.0, < 2.0)
+    public_suffix (4.0.6)
+    rake (13.0.3)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.7)
+
+PLATFORMS
+  x86_64-darwin-17
+
+DEPENDENCIES
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  sms-pilot-api-v1!
+
+BUNDLED WITH
+   2.2.11

data/README.md

@@ -0,0 +1,160 @@
+# SmsPilot API v1 client
+
+Обёртка отправки GET-запроса на API endpoint сервиса SMS Pilot (API v1) для удобства доступа к ошибкам, статусам, цене SMS и т. п.
+
+## Installation
+
+from RubyGems:
+
+```ruby
+gem "sms-pilot-api-v1"
+```
+
+from GitHub:
+
+```ruby
+gem "sms-pilot-api-v1", git: "https://github.com/sergeypedan/sms-pilot-api-v1.git"
+```
+
+## Usage
+
+Test sending SMS from console with a test API key (find it at the end of this page):
+
+```sh
+cd $(bundle info sms-pilot-api-v1 --path)
+bin/console
+```
+
+### Initialize
+
+```ruby
+client = SmsPilot::Client.new(api_key: "XXXXXXXXXXXXYYYYYYYYYYYYZZZZZZZZXXXXXXXXXXXXYYYYYYYYYYYYZZZZZZZZ")
+#<SmsPilot::Client:0x00007fb1c602d490 @api_key="XXXXX...", @error=nil, @response_status=nil, @response_headers=nil, @response_body=nil, @response_data={}, @url=nil>
+```
+
+### Before sending
+
+```ruby
+client.api_key          # => "YOUR API KEY"
+client.balance          # => nil
+client.error            # => nil
+client.phone            # => nil
+client.rejected?        # => false
+client.response_body    # => nil
+client.response_data    # => {}
+client.response_headers # => nil
+client.response_status  # => nil
+client.sender_blocked?  # => false
+client.sms_cost         # => nil
+client.sms_sent?        # => false
+client.sms_status       # => nil
+client.url              # => nil
+```
+
+### Sending SMS
+
+```ruby
+client.send_sms("+7 (902) 123-45-67", "Привет, мир!") # => true
+```
+
+Returns result of `sms_sent?`, so it’s either `true` or `false`.
+
+
+### Sending SMS succeeded
+
+```ruby
+client.api_key          # => "YOUR API KEY"
+client.balance          # => 20006.97
+client.error            # => nil
+client.phone            # => "79021234567"
+client.rejected?        # => false
+client.response_body    # => "{\"send\":[{\"server_id\":\"10000\",\"phone\":\"79021234567\",\"price\":\"1.68\",\"status\":\"0\"}],\"balance\":\"20006.97\",\"cost\":\"1.68\"}"
+client.response_data    # => {"send"=>[{"server_id"=>"10000", "phone"=>"79021234567", "price"=>"1.68", "status"=>"0"}], "balance"=>"20006.97", "cost"=>"1.68"}
+client.response_headers # => {"Server"=>"nginx", "Date"=>"Thu, 06 May 2021 04:52:58 GMT", "Content-Type"=>"application/json; charset=utf-8", "Content-Length"=>"179", "Connection"=>"close", "Access-Control-Allow-Origin"=>"*"}
+client.response_status  # => 200
+client.sender_blocked?  # => false
+client.sms_cost         # => 1.68
+client.sms_sent?        # => true
+client.sms_status       # => 1
+client.url              # => "https://smspilot.ru/api.php?apikey=1234567890&format=json&send=%D0%9F%D1%80%D0%B8%D0%B2%D0%B5%D1%82%2C+%D0%BC%D0%B8%D1%80%21&to=79021234567"
+```
+
+### Sending SMS failed (but HTTP request succeeded)
+
+```ruby
+client.api_key          # => "YOUR API KEY"
+client.balance          # => nil
+client.error            # => "Неправильный API-ключ (см. настройки API в личном кабинете) (код ошибки: 101)"
+client.phone            # => "79021234567"
+client.rejected?        # => true
+client.response_body    # => "{\"error\":{\"code\":\"101\",\"description\":\"APIKEY is invalid\",\"description_ru\":\"Неправильный API-ключ (см. настройки API в личном кабинете)\"}}"
+client.response_data    # => {"error"=>{"code"=>"101", "description"=>"APIKEY is invalid", "description_ru"=>"Неправильный API-ключ (см. настройки API в личном кабинете)"}}
+client.response_headers # => {"Server"=>"nginx", "Date"=>"Thu, 06 May 2021 04:52:58 GMT", "Content-Type"=>"application/json; charset=utf-8", "Content-Length"=>"179", "Connection"=>"close", "Access-Control-Allow-Origin"=>"*"}
+client.response_status  # => 200
+client.sender_blocked?  # => false
+client.sms_cost         # => nil
+client.sms_sent?        # => false
+client.sms_status       # => nil
+client.url              # => "https://smspilot.ru/api.php?apikey=1234567890&format=json&send=%D0%9F%D1%80%D0%B8%D0%B2%D0%B5%D1%82%2C+%D0%BC%D0%B8%D1%80%21&to=79021234567"
+```
+
+### HTTP request failed
+
+```ruby
+client.api_key          # => "YOUR API KEY"
+client.balance          # => nil
+client.error            # => "HTTP request failed with code 404"
+client.phone            # => "79021234567"
+client.rejected?        # => false
+client.response_body    # => "<html>\r\n<head><title>404 Not Found</title></head>\r\n<body>\r\n<center><h1>404 Not Found</h1></center>\r\n<hr><center>nginx</center>\r\n</body>\r\n</html>\r\n"
+client.response_data    # => {}
+client.response_headers # => {"Server"=>"nginx", "Date"=>"Thu, 06 May 2021 05:30:23 GMT", "Content-Type"=>"text/html", "Content-Length"=>"146", "Connection"=>"close"}
+client.response_status  # => 404
+client.sender_blocked?  # => false
+client.sms_cost         # => nil
+client.sms_sent?        # => false
+client.sms_status       # => nil
+client.url              # => "https://smspilot.ru/api.php?apikey=1234567890&format=json&send=%D0%9F%D1%80%D0%B8%D0%B2%D0%B5%D1%82%2C+%D0%BC%D0%B8%D1%80%21&to=79021234567"
+```
+
+
+## SMS pilot API docs
+
+- [web version](https://smspilot.ru/apikey.php) — см. вкладку PHP, в остальных ничего нет
+- [PDF version](https://smspilot.ru/download/SMSPilotRu-HTTP-v1.9.19.pdf) — тут намного подробнее
+- [Коды ошибок](https://smspilot.ru/apikey.php#err)
+
+
+## Test API key
+
+https://smspilot.ru/apikey.php
+
+```
+"XXXXXXXXXXXXYYYYYYYYYYYYZZZZZZZZXXXXXXXXXXXXYYYYYYYYYYYYZZZZZZZZ"
+```
+
+
+## API response examples
+
+SMS sent:
+
+```json
+{
+  "send": [
+    { "server_id": "10000", "phone": "79021234567", "price": "1.68", "status": "0" }
+  ],
+  "balance": "11908.50", "cost": "1.68"
+}
+```
+
+SMS rejected:
+
+```json
+{
+  "error": {
+    "code": "400",
+    "description": "User not found",
+    "description_ru": "Пользователь не найден"
+  }
+}
+```

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "sms_pilot"
+
+# 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(__FILE__)

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_pilot.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require_relative "sms_pilot/version"
+require_relative "sms_pilot/errors"
+require_relative "sms_pilot/client"
+

data/lib/sms_pilot/client.rb

@@ -0,0 +1,146 @@
+# frozen_string_literal: true
+
+require "http"
+require "uri"
+
+module SmsPilot
+
+  API_ENDPOINT = "https://smspilot.ru/api.php".freeze
+
+  class Client
+
+    attr_reader :api_key
+    attr_reader :error
+    attr_reader :phone
+    attr_reader :response_body
+    attr_reader :response_data
+    attr_reader :response_headers
+    attr_reader :response_status
+    attr_reader :url
+
+
+    def initialize(api_key:)
+      fail TypeError, "API key must be a String, you pass a #{api_key.class} (#{api_key})" unless api_key.is_a? String
+      fail TypeError, "API key cannot be empty" if api_key == ""
+
+      @api_key          = api_key
+      @error            = nil
+      @response_status  = nil
+      @response_headers = nil
+      @response_body    = nil
+      @response_data    = {}
+      @url              = nil
+    end
+
+    def send_sms(phone, text)
+      fail TypeError, "`phone` must be a String, you pass a #{phone.class} (#{phone})" unless phone.is_a? String
+      fail TypeError,  "`text` must be a String, you pass a #{ text.class} (#{ text})" unless text.is_a? String
+      fail ArgumentError, "`phone` cannot be empty" if phone == ""
+      fail ArgumentError,  "`text` cannot be empty" if  text == ""
+      fail ArgumentError, "`phone` must contain digits" if phone.scan(/\d/).none?
+
+      @phone = normalize_phone(phone)
+      @url   = build_url(@phone, text)
+
+      response = HTTP.timeout(connect: 15, read: 30).accept(:json).get(@url)
+      @response_status  = response.status.code
+      @response_headers = response.headers.to_h
+      @response_body    = response.body.to_s
+
+      unless response.status.success?
+        @error = "HTTP request failed with code #{response.status.code}"
+        return false
+      end
+
+      @response_data = JSON.parse @response_body
+
+      return @error = "#{error_description} (код ошибки: #{error_code})" if rejected?
+      return true
+
+    rescue JSON::ParserError => error
+      @error = "API returned invalid JSON. #{error.message}"
+
+    rescue HTTP::Error => error
+      @error = error.message
+
+    rescue => error
+      @error = error.message
+    end
+
+
+    def balance
+      @response_data["balance"]&.to_f if sms_sent?
+    end
+
+
+    # Коды ошибок: https://smspilot.ru/apikey.php#err
+    # Расшифровка ошибки пишется в @error
+    #
+    def error_code
+      @response_data.dig("error", "code")&.to_i if rejected?
+    end
+
+
+    # Коды ошибок: https://smspilot.ru/apikey.php#err
+    # Расшифровка ошибки пишется в @error
+    #
+    def error_description
+      @response_data.dig("error", "description_ru") if rejected?
+    end
+
+
+    # HTTP запрос удался, но API отказался отправлять SMS
+    def rejected?
+      return false if sms_sent?
+      @response_data["error"].is_a? Hash
+    end
+
+
+    # API сообщает, что мы заблокированы
+    #
+    # 105 из-за низкого баланса
+    # 106 за спам/ошибки
+    # 107 за недостоверные учетные данные / недоступна эл. почта / проблемы с телефоном
+    # 122 спорная ситуация
+    #
+    # Расшифровка ошибки пишется в @error
+    #
+    def sender_blocked?
+      [105, 106, 107, 122].include? error_code
+    end
+
+
+    # Цена отправленной только что SMS
+    def sms_cost
+      @response_data["cost"] if sms_sent?
+    end
+
+
+    # API успешно отправил SMS
+    def sms_sent?
+      @response_data["send"] != nil
+    end
+
+
+    # Статус доставки SMS
+    # https://smspilot.ru/apikey.php#status
+    #
+    def sms_status
+      @response_data.dig("send", 0, "status")&.to_i if sms_sent?
+    end
+
+
+    private
+
+    def build_url(phone, text)
+      URI.parse(API_ENDPOINT).tap do |url|
+        url.query = URI.encode_www_form({ apikey: @api_key, format: :json, send: text, to: phone })
+      end.to_s
+    end
+
+    def normalize_phone(phone)
+      phone.gsub(/[^0-9]/, '').sub(/^8/, '7').gsub('+7', '8')
+    end
+
+  end
+end

data/lib/sms_pilot/errors.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module SmsPilot
+  class Error < StandardError; end
+end

data/lib/sms_pilot/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module SmsPilot
+  VERSION = "0.0.3"
+end

data/sms-pilot-api-v1.gemspec

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative "lib/sms_pilot/version"
+
+Gem::Specification.new do |spec|
+  spec.authors     = ["Sergey Pedan"]
+  spec.summary     =  "Simple wrapper around SMS pilot API v1"
+  spec.description =  "#{spec.summary}. Version 1 because it returns more data within its standard response"
+  spec.email       = ["sergey.pedan@gmail.com"]
+  spec.homepage    =  "https://github.com/sergeypedan/sms-pilot-api-v1"
+  spec.license     =  "MIT"
+  spec.name        =  "sms-pilot-api-v1"
+  spec.version     =   SmsPilot::VERSION
+
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
+
+  spec.metadata = {
+    "changelog_uri"     => "#{spec.homepage}/blob/master/Changelog.md",
+    "documentation_uri" => "#{spec.homepage}#usage",
+    "homepage_uri"      =>  spec.homepage,
+    "source_code_uri"   =>  spec.homepage
+  }
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+
+  spec.bindir        =  "bin"
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "http", "~> 4"
+
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification
+name: sms-pilot-api-v1
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: ruby
+authors:
+- Sergey Pedan
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-05-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+description: Simple wrapper around SMS pilot API v1. Version 1 because it returns
+  more data within its standard response
+email:
+- sergey.pedan@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/sms_pilot.rb
+- lib/sms_pilot/client.rb
+- lib/sms_pilot/errors.rb
+- lib/sms_pilot/version.rb
+- sms-pilot-api-v1-0.0.2.gem
+- sms-pilot-api-v1.gemspec
+homepage: https://github.com/sergeypedan/sms-pilot-api-v1
+licenses:
+- MIT
+metadata:
+  changelog_uri: https://github.com/sergeypedan/sms-pilot-api-v1/blob/master/Changelog.md
+  documentation_uri: https://github.com/sergeypedan/sms-pilot-api-v1#usage
+  homepage_uri: https://github.com/sergeypedan/sms-pilot-api-v1
+  source_code_uri: https://github.com/sergeypedan/sms-pilot-api-v1
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.5
+signing_key:
+specification_version: 4
+summary: Simple wrapper around SMS pilot API v1
+test_files: []