megalabs_sms 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 514e53d5f271af0a42284dd94de370448da8ff6dcafebf05dd140d3f2810f6ee
-  data.tar.gz: 68a2127266570145e574a6df04a2210c29394b51521e6ffdf53566363d98fbc4
+  metadata.gz: d82e07153abbae70e6bd8cb9a967290b1ec0dc6f29f43a1d3e1f4335b7690883
+  data.tar.gz: f4532bc91e3b879133cb33c9929ceafecd3e42a325146429fc299b620cb72bc5
 SHA512:
-  metadata.gz: 01136beb138bf4639efe0116996d8c20ad3a80d9d6f3bf915df1e2c0f632819f473e40f89f6df8c37996153aba6e3b1efe26ab6c53bd6e7705a189083864a8ae
-  data.tar.gz: 4093d7da0fe27621c8adaf161f0c357b01427becf11e2d73e003a880c59e0b01edfdb305acef2a78d303e017a110adaf82d6abe3dc44d95c562b09dbe341b9ab
+  metadata.gz: 6bab059a7777d377914b460e34249a04011a98abe3096cafe8a385a5097ad34e0807542e67b3dd1c80b6fc9ad14179f84a26ffeb3dfedbffcc9dcecb70e23782
+  data.tar.gz: 9e23e8a94f9018fef98f1046fc63f1f3f6ca6657adc9daa0c4323b7c32674516799dc8aebce6856254e271fc8d064709c25c79b03482d5842350bc953aace426

data/CHANGELOG.md

@@ -0,0 +1,35 @@
+# Changelog
+
+## [0.2.0] - 2025-03-14
+
+### Изменено
+
+- Изменён тип возвращаемого значения метода `send_sms` с String на Boolean для более чёткого определения успешности вызова API
+- Изменена документация для методов `send_sms`, `handle_stub_response`, `send_request`, `perform_http_request` и `process_http_response`
+- Обновлены тесты для работы с булевым возвращаемым значением вместо строкового
+
+## [0.1.1] - 2024-03-13
+
+### Добавлено
+
+- Добавлена поддержка GitHub Pages для документации
+- Добавлена автоматическая генерация документации через GitHub Actions
+- Добавлены метаданные для RubyGems (documentation_uri, changelog_uri, bug_tracker_uri)
+
+### Изменено
+
+- Улучшена структура gemspec
+- Улучшена документация
+
+## [0.1.0] - 2025-03-13
+
+### Инициализация
+
+- Создан базовый функционал для отправки SMS через API Megalabs
+- Реализован класс `MegalabsSms::Client` для работы с API
+- Добавлена базовая аутентификация через API-ключи
+- Добавлена возможность отправки SMS с указанием отправителя, получателя и текста сообщения
+- Реализована поддержка тестовых заглушек (stubs) для разработки
+- Добавлена настраиваемая задержка между запросами
+- Написаны тесты с использованием RSpec и WebMock
+- Добавлена базовая документация методов

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Vitalii Dementev
+
+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/lib/megalabs_sms/version.rb

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

data/lib/megalabs_sms.rb

@@ -54,7 +54,7 @@ module MegalabsSms
     # @param to [String] номер телефона получателя
     # @param message [String] текст сообщения
     #
-    # @return [String] статус отправки или текст ошибки
+    # @return [Boolean] true если SMS отправлено успешно, false в случае ошибки
     #
     def send_sms(from, to, message)
       return handle_stub_response if stub_enabled?
@@ -77,12 +77,16 @@ module MegalabsSms
     #
     # Обрабатывает эмуляцию ответов
     #
-    # @return [String] сообщение об успехе или ошибке эмуляции
+    # @return [Boolean] true если эмулируется успех, false если эмулируется ошибка
     #
     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
+      if @error_stub
+        log_message('Stubbed error: SMS not sent')
+        false
+      elsif @success_stub
+        log_message('Stubbed success: SMS would be sent')
+        true
+      end
     end
 
     #
@@ -125,13 +129,13 @@ module MegalabsSms
     #
     # @param request [Net::HTTP::Post] объект HTTP-запроса
     #
-    # @return [String] тело ответа или сообщение об ошибке
+    # @return [Boolean] true если запрос выполнен успешно, false в случае ошибки
     #
     def send_request(request)
       uri = URI('https://a2p-api.megalabs.ru/sms/v1/sms')
-      response_body = perform_http_request(uri, request)
+      success = perform_http_request(uri, request)
       sleep(@sleep_time) if @sleep_time.positive?
-      response_body
+      success
     end
 
     #
@@ -140,7 +144,7 @@ module MegalabsSms
     # @param uri [URI] URI-адрес для запроса
     # @param request [Net::HTTP::Post] объект HTTP-запроса
     #
-    # @return [String] тело ответа или сообщение об ошибке
+    # @return [Boolean] true если запрос выполнен успешно, false в случае ошибки
     #
     def perform_http_request(uri, request)
       response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
@@ -150,10 +154,11 @@ module MegalabsSms
       if response.is_a?(Net::HTTPSuccess)
         process_http_response(response.body)
       else
-        log_message("Failed to send: #{response}")
+        log_message("Failed to send: #{response}") && false
       end
     rescue StandardError => e
       log_message("Exception occurred: #{e.message}")
+      false
     end
 
     #
@@ -162,17 +167,21 @@ module MegalabsSms
     #
     # @param raw_body [String] оригинальный ответ от HTTP-запроса
     #
-    # @return [String] либо оригинальное тело (если все хорошо), либо сообщение об ошибке
+    # @return [Boolean] true если сообщение отправлено успешно, false в случае ошибки
     #
     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}")
+      success = result&.fetch('code', nil)&.zero? && result&.fetch('description', '')&.downcase == 'ok'
+      if success
+        log_message("Successfully sent: #{body}") && true
+      else
+        log_message("Failed to send: #{body}") && false
+      end
     rescue JSON::ParserError => e
       log_message("Failed to parse JSON: #{e.message}")
+      false
     end
   end
 end

data/spec/megalabs_sms/client_spec.rb

@@ -27,9 +27,11 @@ RSpec.describe MegalabsSms::Client do
       let(:success_stub) { true }
       let(:error_stub)   { false }
 
-      it 'returns a success message (stub)' do
+      it 'returns true indicating success' do
+        allow(client).to receive(:log_message).and_return(true)
         result = client.send_sms(from, to, message)
-        expect(result).to eq('[MegalabsSms] Stubbed success: SMS would be sent')
+        expect(result).to eq(true)
+        expect(client).to have_received(:log_message).with('Stubbed success: SMS would be sent')
       end
     end
 
@@ -37,9 +39,11 @@ RSpec.describe MegalabsSms::Client do
       let(:success_stub) { false }
       let(:error_stub)   { true }
 
-      it 'returns an error message (stub)' do
+      it 'returns false indicating failure' do
+        allow(client).to receive(:log_message).and_return(false)
         result = client.send_sms(from, to, message)
-        expect(result).to eq('[MegalabsSms] Stubbed error: SMS not sent')
+        expect(result).to eq(false)
+        expect(client).to have_received(:log_message).with('Stubbed error: SMS not sent')
       end
     end
   end
@@ -51,12 +55,14 @@ RSpec.describe MegalabsSms::Client do
       '{"result":{"msg_id":"id","status":{"code":0,"description":"ok"}}}'
     end
 
-    it 'makes an HTTP request' do
+    it 'makes an HTTP request and returns true on success' do
       stub_request(:post, 'https://a2p-api.megalabs.ru/sms/v1/sms')
         .to_return(status: 200, body: valid_response, headers: { 'Content-Type': 'application/json' })
 
+      allow(client).to receive(:log_message).and_return(true)
+
       result = client.send_sms(from, to, message)
-      expect(result).to eq(valid_response)
+      expect(result).to eq(true)
       expect(WebMock).to have_requested(:post, 'https://a2p-api.megalabs.ru/sms/v1/sms')
         .with(body: {
           from: from,
@@ -65,6 +71,20 @@ RSpec.describe MegalabsSms::Client do
           # rubocop:enable Style/NumericLiterals
           message: message
         }.to_json)
+      expect(client).to have_received(:log_message).with("Successfully sent: #{valid_response}")
+    end
+
+    it 'returns false when the API returns an error' do
+      error_response = '{"result":{"msg_id":"id","status":{"code":1,"description":"error"}}}'
+
+      stub_request(:post, 'https://a2p-api.megalabs.ru/sms/v1/sms')
+        .to_return(status: 200, body: error_response, headers: { 'Content-Type': 'application/json' })
+
+      allow(client).to receive(:log_message).and_return(false)
+
+      result = client.send_sms(from, to, message)
+      expect(result).to eq(false)
+      expect(client).to have_received(:log_message).with("Failed to send: #{error_response}")
     end
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: megalabs_sms
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Vitalii Dementev
 bindir: bin
 cert_chain: []
-date: 2025-03-13 00:00:00.000000000 Z
+date: 2025-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-http
@@ -87,15 +87,23 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
+- LICENSE
 - 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
+homepage: https://dementevvv.github.io/megalabs_sms/
 licenses:
 - MIT
-metadata: {}
+metadata:
+  homepage_uri: https://dementevvv.github.io/megalabs_sms/
+  documentation_uri: https://dementevvv.github.io/megalabs_sms/
+  source_code_uri: https://github.com/DementevVV/megalabs_sms
+  changelog_uri: https://github.com/DementevVV/megalabs_sms/blob/master/CHANGELOG.md
+  bug_tracker_uri: https://github.com/DementevVV/megalabs_sms/issues
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib