sms_aero2 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0543afba5dd6255815003bf2e757620ee30254f57f1885a7465836b8c5f4e36f
+  data.tar.gz: 29a95da07d357cbae6902846f7ff26ec4540573d0241111e3a09fe41c9459f3c
+SHA512:
+  metadata.gz: a65af07462c9445a60db8c0515e6322173ded4337a80b9b4cba7da8de871dfd10e77118b69cacd299e7deb1053ff827384b74eed046ee7ad913a181ccf510b26
+  data.tar.gz: d5e29855953d29ffb06f7654ec3b047a49a0c60f6285a09de3eb19da703c2f83d323b2885617ca09125a77775407fc940f422ce370793f6f0d8759d8b854984b

data/.github/workflows/ruby.yml

@@ -0,0 +1,38 @@
+name: Ruby
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  rspec:
+    runs-on: ubuntu-latest
+    env:
+      BUNDLE_JOBS: 4
+      BUNDLE_RETRY: 3
+      CI: true
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: ["3.1", "3.2", "3.3"]
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/cache@v1
+        with:
+          path: /home/runner/bundle
+          key: bundle-${{ matrix.ruby }}-${{ hashFiles('**/*.gemspec') }}
+          restore-keys: |
+            bundle-${{ matrix.ruby }}-
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - name: Bundle install
+        run: |
+          bundle config path /home/runner/bundle
+          bundle install
+          bundle update
+      - name: Run RSpec
+        run: |
+          bundle exec rspec

data/.gitignore

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

data/.rspec

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

data/.ruby-version

@@ -0,0 +1 @@
+ruby-3.2.4

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# Changelog
+
+## [Unreleased]
+
+## [0.2.0] - 2024-08-29
+
+### Added
+
+- Ruby 3 support, thanks to [Sergei](https://github.com/zumkorn)

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at skiline.alex@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,57 @@
+PATH
+  remote: .
+  specs:
+    sms_aero2 (0.1.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.7)
+      public_suffix (>= 2.0.2, < 7.0)
+    bigdecimal (3.1.8)
+    coderay (1.1.3)
+    crack (1.0.0)
+      bigdecimal
+      rexml
+    diff-lcs (1.5.1)
+    hashdiff (1.1.1)
+    method_source (1.1.0)
+    pry (0.14.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    public_suffix (6.0.1)
+    rake (13.2.1)
+    rexml (3.3.6)
+      strscan
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.0)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.1)
+    strscan (3.1.0)
+    webmock (3.23.1)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.5.10)
+  pry (~> 0.14.2)
+  rake (~> 13.2.1)
+  rspec (~> 3.13)
+  sms_aero2!
+  webmock (>= 3.23.1)
+
+BUNDLED WITH
+   2.5.10

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Alexander Shvaykin
+
+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,33 @@
+# SmsAero2
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sms_aero2'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sms_aero2
+
+## Usage
+
+```ruby
+client = SmsAero2::Client.new(login: 'some_email@example.com', token: 'some_token', logger: SomeLogger)
+
+client.send_sms(to: 79998887766, from: 'SomeCompany', text:'Hello World!', channel: :international)
+client.hlr_status(id: '1234')
+client.hlr(phone: '79998887766')
+
+```
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. 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).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "sms_aero2"
+
+require "pry"
+Pry.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_aero2/error.rb

@@ -0,0 +1,3 @@
+module SmsAero2
+  class Error < StandardError; end
+end

data/lib/sms_aero2/hlr_operation.rb

@@ -0,0 +1,9 @@
+module SmsAero2
+  class HlrOperation < Operation
+    private
+
+    def result_class
+      SmsAero2::HlrResult
+    end
+  end
+end

data/lib/sms_aero2/hlr_result.rb

@@ -0,0 +1,17 @@
+module SmsAero2
+  class HlrResult < Result
+    def id
+      data.fetch('id')
+    end
+
+    def status
+      statuses[data.fetch('hlrStatus') - 1]
+    end
+
+    private
+
+    def statuses
+      [:available, :unavailable, :not_exists, :in_work]
+    end
+  end
+end

data/lib/sms_aero2/operation.rb

@@ -0,0 +1,26 @@
+module SmsAero2
+  class Operation
+    BASE_URL = 'https://gate.smsaero.ru/v2/'.freeze
+    attr_reader :request, :action_path, :params
+
+    def initialize(request, action_path = '', **params)
+      @request = request
+      @action_path = action_path
+      @params = params
+    end
+
+    def call
+      result_class.new(request.call(url, **params))
+    end
+
+    private
+
+    def url
+      URI.join(BASE_URL, action_path)
+    end
+
+    def result_class
+      SmsAero2::Result
+    end
+  end
+end

data/lib/sms_aero2/request.rb

@@ -0,0 +1,56 @@
+require 'json'
+
+module SmsAero2
+  class Request
+    class HttpError < SmsAero2::Error
+      attr_accessor :status
+    end
+    class InvalidResponse < SmsAero2::Error; end
+
+    attr_reader :client, :logger
+
+    def initialize(client)
+      @client = client
+      @logger = client.logger
+    end
+
+    def call(url, **params)
+      uri = URI(url)
+      uri.query = URI.encode_www_form(params)
+
+      response = send_request(uri)
+      logger&.info(
+          "Send http request to GET #{url} with params: #{params}"
+      )
+      response_body(response)
+
+    rescue SmsAero2::Error => e
+      logger&.error("http request to #{url} with params: #{params} is failed message: #{e.message}")
+      raise e
+    end
+
+    private
+
+    def send_request(uri)
+      request = Net::HTTP::Get.new(uri)
+      request.basic_auth(client.login, client.token)
+      request['Content-Type'] = 'application/json'
+      Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |http|
+        http.request(request)
+      end
+    end
+
+    def response_body(response)
+      body = response.read_body
+      if response.code.to_s.match?(/2|4[0-9]{2}/)
+        JSON.parse(body)
+      else
+        error = HttpError.new("server return error code: #{response.code} response: #{body}")
+        error.status = response.code
+        raise error
+      end
+    rescue JSON::ParserError
+      raise InvalidResponse, "server return invalid response: #{body}"
+    end
+  end
+end

data/lib/sms_aero2/result.rb

@@ -0,0 +1,21 @@
+module SmsAero2
+  class Result
+    attr_reader :response
+
+    def initialize(response)
+      @response = response
+    end
+
+    def success?
+      response.fetch('success')
+    end
+
+    def reason
+      response.fetch('message')
+    end
+
+    def data
+      response.fetch('data')
+    end
+  end
+end

data/lib/sms_aero2/version.rb

@@ -0,0 +1,3 @@
+module SmsAero2
+  VERSION = "0.2.0"
+end

data/lib/sms_aero2.rb

@@ -0,0 +1,53 @@
+require 'logger'
+require "sms_aero2/error"
+require "sms_aero2/version"
+require "sms_aero2/request"
+require "sms_aero2/result"
+require "sms_aero2/hlr_result"
+require "sms_aero2/operation"
+require "sms_aero2/hlr_operation"
+
+module SmsAero2
+  class Client
+    attr_accessor :login, :token, :logger
+
+    def initialize(login:, token:, logger: nil)
+      @login = login
+      @token = token
+      @logger = logger
+    end
+
+    # channel values:
+    # 'info'	Info signature for all operators
+    # 'digital'	Digital channel sending (only permitted transaction flow)
+    # 'international'	International delivery (Operators of Russia, Kazakhstan, Ukraine and Belarus)
+    # 'direct'	Advertising channel send message free letter signature.
+    # 'service' Service channel for sending service SMS according to the approved template
+    # with a paid signature of the sender.
+    def send_sms(to:, from:, text:, channel:, **options)
+      path = options[:testsend] ? 'sms/testsend' : 'sms/send'
+      if %w[info digital international direct service].include?(channel.to_s)
+        SmsAero2::Operation.new(
+            request, path,
+            number: to, sign: from, text: text, channel: channel.upcase, **options
+        ).call
+      else
+        raise ArgumentError, "invalid channel value, see documentation"
+      end
+    end
+
+    def hlr_status(id:)
+      SmsAero2::HlrOperation.new(request, 'hlr/status',  id: id).call
+    end
+
+    def hlr(phone:)
+      SmsAero2::HlrOperation.new(request, 'hlr/check', number: phone).call
+    end
+
+    private
+
+    def request
+      @request ||= SmsAero2::Request.new(self)
+    end
+  end
+end

data/sms_aero2.gemspec

@@ -0,0 +1,31 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "sms_aero2/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "sms_aero2"
+  spec.version       = SmsAero2::VERSION
+  spec.authors       = ["Alexander Shvaykin"]
+  spec.email         = ["skiline.alex@gmail.com"]
+
+  spec.summary       = %q{Simple gem for smsaero.ru API.}
+  spec.homepage      = "https://teachbase.ru"
+  spec.license       = "MIT"
+
+  spec.metadata["homepage_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('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.5.10"
+  spec.add_development_dependency "rake", "~> 13.2.1"
+  spec.add_development_dependency "rspec", "~> 3.13"
+  spec.add_development_dependency "webmock", ">= 3.23.1"
+  spec.add_development_dependency "pry", "~> 0.14.2"
+end

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: sms_aero2
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Alexander Shvaykin
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-08-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.5.10
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.5.10
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.2.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.2.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.23.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.23.1
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.2
+description:
+email:
+- skiline.alex@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/ruby.yml"
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/sms_aero2.rb
+- lib/sms_aero2/error.rb
+- lib/sms_aero2/hlr_operation.rb
+- lib/sms_aero2/hlr_result.rb
+- lib/sms_aero2/operation.rb
+- lib/sms_aero2/request.rb
+- lib/sms_aero2/result.rb
+- lib/sms_aero2/version.rb
+- sms_aero2.gemspec
+homepage: https://teachbase.ru
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://teachbase.ru
+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: []
+rubygems_version: 3.5.17
+signing_key:
+specification_version: 4
+summary: Simple gem for smsaero.ru API.
+test_files: []