megalabs_sms 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 514e53d5f271af0a42284dd94de370448da8ff6dcafebf05dd140d3f2810f6ee
+  data.tar.gz: 68a2127266570145e574a6df04a2210c29394b51521e6ffdf53566363d98fbc4
+SHA512:
+  metadata.gz: 01136beb138bf4639efe0116996d8c20ad3a80d9d6f3bf915df1e2c0f632819f473e40f89f6df8c37996153aba6e3b1efe26ab6c53bd6e7705a189083864a8ae
+  data.tar.gz: 4093d7da0fe27621c8adaf161f0c357b01427becf11e2d73e003a880c59e0b01edfdb305acef2a78d303e017a110adaf82d6abe3dc44d95c562b09dbe341b9ab

data/README.md

@@ -0,0 +1,113 @@
+# MegalabsSms
+
+Простой и удобный гем для отправки SMS через A2P API от Megalabs (Мегафон). Создан для разработчиков, которые хотят быстро и эффективно интегрировать отправку SMS в свои Ruby-приложения.
+
+## Установка
+
+Добавьте эту строку в `Gemfile` вашего приложения:
+
+```ruby
+gem 'megalabs_sms'
+```
+
+И затем выполните:
+
+```bash
+$ bundle install
+```
+
+Или установите гем напрямую:
+
+```bash
+$ gem install megalabs_sms
+```
+
+## Использование
+
+### Базовый пример
+
+```ruby
+require 'megalabs_sms'
+
+# Создаем клиент
+client = MegalabsSms::Client.new(
+  'ваш_логин',
+  'ваш_пароль'
+)
+
+# Отправляем SMS
+client.send_sms(
+  'SenderName',  # имя отправителя
+  '+79001234567', # номер получателя
+  'Привет! Это тестовое сообщение.' # текст сообщения
+)
+```
+
+### Дополнительные возможности
+
+#### Задержка между запросами
+
+Если вам нужно добавить задержку между запросами (например, чтобы не превысить лимиты API):
+
+```ruby
+client = MegalabsSms::Client.new(
+  'ваш_логин',
+  'ваш_пароль',
+  sleep_time: 1.0 # задержка в 1 секунду между запросами
+)
+```
+
+#### Тестовый режим
+
+Для тестирования можно использовать режим эмуляции:
+
+```ruby
+# Эмуляция успешной отправки
+client = MegalabsSms::Client.new(
+  'ваш_логин',
+  'ваш_пароль',
+  success_stub: true
+)
+
+# Эмуляция ошибки отправки
+client = MegalabsSms::Client.new(
+  'ваш_логин',
+  'ваш_пароль',
+  error_stub: true
+)
+```
+
+## Обработка ошибок
+
+Гем автоматически обрабатывает различные ошибки и возвращает понятные сообщения:
+
+- При отсутствии учетных данных
+- При проблемах с сетью
+- При ошибках API
+- При проблемах с форматом данных
+
+## Разработка
+
+После клонирования репозитория, установите зависимости:
+
+```bash
+$ bundle install
+```
+
+Запуск тестов:
+
+```bash
+$ bundle exec rspec
+```
+
+## Лицензия
+
+Гем доступен как open source под лицензией MIT.
+
+## Поддержка
+
+Если у вас возникли вопросы или проблемы, пожалуйста, создайте issue в репозитории проекта.
+
+## Автор
+
+- Vitalii Dementev - [@DementevVV](https://github.com/DementevVV)

data/lib/megalabs_sms/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module MegalabsSms
+  VERSION = '0.1.0'
+end

data/lib/megalabs_sms.rb

@@ -0,0 +1,178 @@
+# frozen_string_literal: true
+
+require 'net/http'
+require 'json'
+require_relative 'megalabs_sms/version'
+
+#
+# Главный модуль для взаимодействия с API Megalabs, включая отправку SMS.
+#
+module MegalabsSms
+  # Класс для взаимодействия с API Megalabs для отправки SMS
+  class Client
+    #
+    # Конструктор, инициализирующий параметры клиента:
+    #
+    # @param api_user [String] логин для Basic Auth
+    # @param api_password [String] пароль для Basic Auth
+    # @param sleep_time [Float] время задержки в секундах (по умолчанию 0)
+    # @param success_stub [Boolean] эмулировать успешную отправку?
+    # @param error_stub [Boolean] эмулировать ошибку отправки?
+    #
+    # @raise [ArgumentError] если api_user или api_password отсутствуют или пусты
+    #
+    def initialize(api_user,
+                   api_password,
+                   sleep_time: 0,
+                   success_stub: false,
+                   error_stub: false)
+      raise ArgumentError, 'api_user is required' if api_user.nil? || api_user.strip.empty?
+      raise ArgumentError, 'api_password is required' if api_password.nil? || api_password.strip.empty?
+
+      @api_user = api_user
+      @api_password = api_password
+      @sleep_time = sleep_time
+      @success_stub = success_stub
+      @error_stub = error_stub
+    end
+
+    #
+    # Метод для форматирования сообщений логирования
+    #
+    # @param message [String] исходное сообщение для логирования
+    #
+    # @return [String] отформатированное сообщение с префиксом модуля
+    #
+    def log_message(message)
+      "[MegalabsSms] #{message}"
+    end
+
+    #
+    # Метод для отправки SMS через сервис Megalabs.
+    #
+    # @param from [String] имя/номер отправителя
+    # @param to [String] номер телефона получателя
+    # @param message [String] текст сообщения
+    #
+    # @return [String] статус отправки или текст ошибки
+    #
+    def send_sms(from, to, message)
+      return handle_stub_response if stub_enabled?
+
+      request = build_request(from, to, message)
+      send_request(request)
+    end
+
+    private
+
+    #
+    # Проверяет, включен ли режим эмуляции ответов
+    #
+    # @return [Boolean] true если включена эмуляция успеха или ошибки, false в противном случае
+    #
+    def stub_enabled?
+      @error_stub || @success_stub
+    end
+
+    #
+    # Обрабатывает эмуляцию ответов
+    #
+    # @return [String] сообщение об успехе или ошибке эмуляции
+    #
+    def handle_stub_response
+      return log_message('Stubbed error: SMS not sent') if @error_stub
+
+      log_message('Stubbed success: SMS would be sent') if @success_stub
+    end
+
+    #
+    # Создает HTTP-запрос для отправки SMS
+    #
+    # @param from [String] имя отправителя
+    # @param to [String] номер телефона получателя
+    # @param message [String] текст сообщения
+    #
+    # @return [Net::HTTP::Post] объект HTTP-запроса
+    #
+    def build_request(from, to, message)
+      uri = URI('https://a2p-api.megalabs.ru/sms/v1/sms')
+      request = Net::HTTP::Post.new(uri)
+      request.basic_auth(@api_user, @api_password)
+      request.content_type = 'application/json'
+      request.body = build_request_body(from, to, message)
+      request
+    end
+
+    #
+    # Создает HTTP-запрос для отправки SMS
+    #
+    # @param from [String] имя/номер отправителя
+    # @param to [String] <description>
+    # @param message [String] <description>
+    #
+    # @return [Net::HTTP::Post] объект HTTP-запроса
+    #
+    def build_request_body(from, to, message)
+      {
+        from: from,
+        to: to.gsub(/\D/, '').to_i,
+        message: message
+      }.to_json
+    end
+
+    #
+    # Отправляет HTTP-запрос
+    #
+    # @param request [Net::HTTP::Post] объект HTTP-запроса
+    #
+    # @return [String] тело ответа или сообщение об ошибке
+    #
+    def send_request(request)
+      uri = URI('https://a2p-api.megalabs.ru/sms/v1/sms')
+      response_body = perform_http_request(uri, request)
+      sleep(@sleep_time) if @sleep_time.positive?
+      response_body
+    end
+
+    #
+    # Выполняет HTTP-запрос
+    #
+    # @param uri [URI] URI-адрес для запроса
+    # @param request [Net::HTTP::Post] объект HTTP-запроса
+    #
+    # @return [String] тело ответа или сообщение об ошибке
+    #
+    def perform_http_request(uri, request)
+      response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
+        http.request(request)
+      end
+
+      if response.is_a?(Net::HTTPSuccess)
+        process_http_response(response.body)
+      else
+        log_message("Failed to send: #{response}")
+      end
+    rescue StandardError => e
+      log_message("Exception occurred: #{e.message}")
+    end
+
+    #
+    # Обрабатывает тело ответа HTTP и возвращает корректное сообщение.
+    # Если статус ответа не соответствует ожидаемому, возвращает сообщение об ошибке.
+    #
+    # @param raw_body [String] оригинальный ответ от HTTP-запроса
+    #
+    # @return [String] либо оригинальное тело (если все хорошо), либо сообщение об ошибке
+    #
+    def process_http_response(raw_body)
+      body = raw_body.dup.force_encoding('UTF-8')
+      parsed = JSON.parse(body)
+      result = parsed.dig('result', 'status')
+      return body if result&.fetch('code', nil)&.zero? && result&.fetch('description', '')&.downcase == 'ok'
+
+      log_message("Failed to send: #{body}")
+    rescue JSON::ParserError => e
+      log_message("Failed to parse JSON: #{e.message}")
+    end
+  end
+end

data/spec/megalabs_sms/client_spec.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+# rubocop:disable Metrics/BlockLength
+
+RSpec.describe MegalabsSms::Client do
+  let(:api_user)     { 'test_user' }
+  let(:api_password) { 'test_password' }
+  let(:sleep_time)   { 0 }
+  let(:from)         { 'TestSender' }
+  let(:to)           { '+70001234567' }
+  let(:message)      { 'Hello from RSpec!' }
+
+  subject(:client) do
+    described_class.new(
+      api_user,
+      api_password,
+      sleep_time: sleep_time,
+      success_stub: success_stub,
+      error_stub: error_stub
+    )
+  end
+
+  context 'with stub responses' do
+    context 'when success_stub is true' do
+      let(:success_stub) { true }
+      let(:error_stub)   { false }
+
+      it 'returns a success message (stub)' do
+        result = client.send_sms(from, to, message)
+        expect(result).to eq('[MegalabsSms] Stubbed success: SMS would be sent')
+      end
+    end
+
+    context 'when error_stub is true' do
+      let(:success_stub) { false }
+      let(:error_stub)   { true }
+
+      it 'returns an error message (stub)' do
+        result = client.send_sms(from, to, message)
+        expect(result).to eq('[MegalabsSms] Stubbed error: SMS not sent')
+      end
+    end
+  end
+
+  context 'with real HTTP request' do
+    let(:success_stub) { false }
+    let(:error_stub)   { false }
+    let(:valid_response) do
+      '{"result":{"msg_id":"id","status":{"code":0,"description":"ok"}}}'
+    end
+
+    it 'makes an HTTP request' do
+      stub_request(:post, 'https://a2p-api.megalabs.ru/sms/v1/sms')
+        .to_return(status: 200, body: valid_response, headers: { 'Content-Type': 'application/json' })
+
+      result = client.send_sms(from, to, message)
+      expect(result).to eq(valid_response)
+      expect(WebMock).to have_requested(:post, 'https://a2p-api.megalabs.ru/sms/v1/sms')
+        .with(body: {
+          from: from,
+          # rubocop:disable Style/NumericLiterals
+          to: 70001234567,
+          # rubocop:enable Style/NumericLiterals
+          message: message
+        }.to_json)
+    end
+  end
+end
+
+# rubocop:enable Metrics/BlockLength

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'rspec'
+require 'webmock/rspec'
+
+require_relative '../lib/megalabs_sms'
+
+RSpec.configure do |config|
+  config.formatter = :documentation
+  config.color     = true
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: megalabs_sms
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Vitalii Dementev
+bindir: bin
+cert_chain: []
+date: 2025-03-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: net-http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+- !ruby/object:Gem::Dependency
+  name: ostruct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This gem provides a simple interface to send SMS using the Megalabs A2P
+  API.
+email:
+- v@dementev.dev
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/megalabs_sms.rb
+- lib/megalabs_sms/version.rb
+- spec/megalabs_sms/client_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/DementevVV/megalabs_sms.git
+licenses:
+- MIT
+metadata: {}
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.5
+specification_version: 4
+summary: Ruby gem for sending SMS via the Megalabs API
+test_files: []