sms-ru-client 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fdb9c999f90ca43a9b942d26e06d9135dba773a4623d0f4029beef5692e4d20b
+  data.tar.gz: 7dc839efcdf592f156a3292401a5ecc91588fba2d40f2503cf395cde5ec2357a
+SHA512:
+  metadata.gz: 6a93c6952370e6aca25a8116a0090c857f1b50c1f78b249002572d3663f6a92a60dadb53c55f1744f45c6b6b51b8c95e5ec9966cb7cbb3a3bc36494e1d4c96bc
+  data.tar.gz: ca6302411defdf000dacd442826ff233fc4850484b742c73225e78b7394b4d574f2ff57e00c508c5fd84669fb57f02f6691fa78679d38e810784abc92f6719f8

data/README.md

@@ -0,0 +1,89 @@
+# SmsRu
+
+Ruby Client Library for working with [SMS.RU](https://sms.ru).
+
+NOTE: current implementation does not support ALL features, and includes only:
+
+  * Send SMS
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sms-ru-client'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sms-ru-client
+
+## Configuration
+
+```ruby
+SmsRu.configure do |config|
+  config.api_endpoint = 'https://sms.ru/'
+  config.logger = Logger.new(STDERR)
+  config.api_id = 'your api_id'
+end
+```
+
+or
+
+```ruby
+client = SmsRu::Client.new(
+  api_endpoint: 'https://sms.ru/'
+  logger: Logger.new(STDERR)
+  api_id: 'your api_id'
+)
+```
+
+## Usage
+
+### Send SMS
+
+```ruby
+request = SmsRu::Requests::SendSms.new(
+  to: '79991234567',
+  message: 'hello world',
+  test: true
+)
+
+SmsRu.client.send_sms(request)
+```
+
+## Development
+
+Setup:
+
+```console
+make setup
+```
+
+Run linters:
+
+```console
+make lint
+```
+
+Run tests:
+
+```console
+make test
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/zabolotnov87/sms_ru. 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.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Test project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/zabolotnov87/sms_ru/blob/master/CODE_OF_CONDUCT.md).

data/lib/sms-ru-client.rb

@@ -0,0 +1 @@
+require_relative './sms_ru'

data/lib/sms_ru/client/api/sms.rb

@@ -0,0 +1,25 @@
+module SmsRu
+  class Client
+    module Api
+      module Sms
+        SEND_PATH = 'sms/send'.freeze
+
+        # @param request [SmsRu::Requests::SendSms, Hash]
+        # @raise [SmsRu::Responses::SendSms::Error]
+        # @return [SmsRu::Responses::SendSms]
+        #
+        def send_sms(request)
+          request = Requests::SendSms.new(request) unless request.is_a?(Requests::SendSms)
+          response = http_post(SEND_PATH, params: request)
+          json = JSON.parse(response.body)
+          result = Responses::SendSms.new(json)
+          return result if result.success?
+
+          raise result.to_error
+        end
+      end
+
+      include Sms
+    end
+  end
+end

data/lib/sms_ru/client/api.rb

@@ -0,0 +1 @@
+require_relative 'api/sms'

data/lib/sms_ru/client/models/requests/base.rb

@@ -0,0 +1,12 @@
+module SmsRu
+  class Client
+    module Models
+      module Requests
+        class Base < Hashie::Trash
+          include Hashie::Extensions::Dash::IndifferentAccess
+          include Hashie::Extensions::Dash::Coercion
+        end
+      end
+    end
+  end
+end

data/lib/sms_ru/client/models/requests/send_sms.rb

@@ -0,0 +1,19 @@
+module SmsRu
+  class Client
+    module Models
+      module Requests
+        class SendSms < Base
+          property :test, transform_with: ->(value) { '1' if value }
+          property :msg, from: 'message'
+          property :to, transform_with: lambda { |value|
+            if value.is_a?(Array)
+              value.join(',')
+            else
+              value
+            end
+          }
+        end
+      end
+    end
+  end
+end

data/lib/sms_ru/client/models/responses/base.rb

@@ -0,0 +1,13 @@
+module SmsRu
+  class Client
+    module Models
+      module Responses
+        class Base < Hashie::Trash
+          include Hashie::Extensions::IgnoreUndeclared
+          include Hashie::Extensions::Dash::IndifferentAccess
+          include Hashie::Extensions::Dash::Coercion
+        end
+      end
+    end
+  end
+end

data/lib/sms_ru/client/models/responses/send_sms.rb

@@ -0,0 +1,37 @@
+module SmsRu
+  class Client
+    module Models
+      module Responses
+        class SendSms < Base
+          class Error < StandardError
+            attr_reader :status, :code, :text
+
+            def initialize(status, code, text)
+              @status = status
+              @code = code
+              @text = text
+              super("status: #{status}, code: #{code}, text: #{text}")
+            end
+          end
+
+          SUCCESS_STATUS = 'OK'.freeze
+
+          property :status
+          property :code, from: 'status_code'
+          property :text, from: 'status_text'
+          property :balance
+
+          def success?
+            status == SUCCESS_STATUS
+          end
+
+          def to_error
+            return if success?
+
+            Error.new(status, code, text)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sms_ru/client/models.rb

@@ -0,0 +1,10 @@
+require_relative 'models/requests/base'
+require_relative 'models/requests/send_sms'
+
+require_relative 'models/responses/base'
+require_relative 'models/responses/send_sms'
+
+module SmsRu
+  Requests = Client::Models::Requests
+  Responses = Client::Models::Responses
+end

data/lib/sms_ru/client.rb

@@ -0,0 +1,70 @@
+require_relative 'client/models'
+require_relative 'client/api'
+
+module SmsRu
+  class Client
+    include Api
+    include Configurable
+
+    def initialize(options = {})
+      CONFIGURATION_OPTIONS.each do |attribute|
+        value = options[attribute] || SmsRu.send(attribute)
+        send("#{attribute}=", value)
+      end
+      connection
+    end
+
+    private
+
+    def connection
+      @connection ||= Faraday.new(url: api_endpoint) do |connection|
+        setup_timeouts!(connection)
+        setup_auth!(connection)
+        setup_error_handling!(connection)
+        setup_log_filters!(connection)
+        setup_json!(connection)
+
+        connection.adapter(Faraday.default_adapter)
+      end
+    end
+
+    def setup_timeouts!(connection)
+      connection.options.open_timeout = open_timeout
+      connection.options.timeout = read_timeout
+    end
+
+    def setup_auth!(connection)
+      connection.params[:api_id] = api_id
+    end
+
+    def setup_error_handling!(connection)
+      connection.response(:raise_error)
+    end
+
+    def setup_log_filters!(connection)
+      options = { headers: true, bodies: true, log_level: :debug }
+      connection.response(:logger, logger, options) do |logger|
+        logger.filter(/(api_id=)([^&]+)/, '\1[FILTERED]')
+      end
+    end
+
+    def setup_json!(connection)
+      connection.params[:json] = 1
+    end
+
+    def http_post(resource, params:, headers: {})
+      connection.post do |request|
+        request.url(resource)
+        request.headers.merge!(headers)
+        request.params.merge!(params)
+      end
+    end
+
+    def http_get(resource, params = {})
+      connection.get do |request|
+        request.url(resource)
+        request.params.update(params) unless params.empty?
+      end
+    end
+  end
+end

data/lib/sms_ru/configurable.rb

@@ -0,0 +1,34 @@
+module SmsRu
+  module Configurable
+    CONFIGURATION_OPTIONS = %i[
+      api_endpoint
+      api_id
+      logger
+      open_timeout
+      read_timeout
+    ].freeze
+
+    DEFAULTS_READ_TIMEOUT = 5
+    DEFAULTS_OPEN_TIMEOUT = 2
+
+    attr_accessor(*CONFIGURATION_OPTIONS)
+
+    def configure
+      yield self
+      set_defaults
+    end
+
+    def set_defaults
+      self.read_timeout ||= DEFAULTS_READ_TIMEOUT
+      self.open_timeout ||= DEFAULTS_OPEN_TIMEOUT
+    end
+
+    def options
+      CONFIGURATION_OPTIONS.to_h { |attr| [attr, send(attr)] }
+    end
+
+    def same_options?(options)
+      self.options.hash == options.hash
+    end
+  end
+end

data/lib/sms_ru.rb

@@ -0,0 +1,18 @@
+require 'faraday'
+require 'json'
+require 'hashie'
+
+require_relative 'sms_ru/configurable'
+require_relative 'sms_ru/client'
+
+module SmsRu
+  class << self
+    include Configurable
+
+    def client
+      return @client if defined?(@client) && @client.same_options?(options)
+
+      @client = Client.new(options)
+    end
+  end
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: sms-ru-client
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Sergey Zaboltonov
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-09-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description:
+email:
+- sergey.zabolotnov@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/sms-ru-client.rb
+- lib/sms_ru.rb
+- lib/sms_ru/client.rb
+- lib/sms_ru/client/api.rb
+- lib/sms_ru/client/api/sms.rb
+- lib/sms_ru/client/models.rb
+- lib/sms_ru/client/models/requests/base.rb
+- lib/sms_ru/client/models/requests/send_sms.rb
+- lib/sms_ru/client/models/responses/base.rb
+- lib/sms_ru/client/models/responses/send_sms.rb
+- lib/sms_ru/configurable.rb
+homepage: https://github.com/zabolotnov87/sms_ru
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: Ruby Client Library for working with SMS.RU
+test_files: []