sms_traffic_sdk 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 97b598c2448cc5371fb1d2dd91d0f5706473ea3657e5494e4e72edb53a304792
-  data.tar.gz: 4f42caff68f07f17e841119111b013dd40be2cda9b321bb8e7bdafa4509ddb2e
+  metadata.gz: a24fc568f771f8a36b3b9c6cf8593b653441ca3f98bba4ab214a26f4cdbee01b
+  data.tar.gz: 5a1bf2789cba41f9334199342efed9d0d8e3c0ddaf6aba581fe99797ae10ff82
 SHA512:
-  metadata.gz: 2b09f25a918672f487011f79861441f96b650625f1fc9cf0db213a9204b8cfab9f78b1d883b3ed76da5ba0d6b47d6bd1d52710c0cb902e386cffc0f625f76c13
-  data.tar.gz: fe2cfb46546cf8438b325e2a676e28792d2ff585a13ac75304af2a3079a2401f72acbb7c00c7af2f5fe3a2748a799d622f204dec1442b025215f96ccfd38239b
+  metadata.gz: 0546d6134d67834a19e5ec0fcc97f8ecc6e5db0de31bb2cba5c13780097554abc866ce1702974bf51ef958204b46603f3ff6b2bf97e595f8c3388b946e9338de
+  data.tar.gz: 2aca58a629bc318d0da343486c2ed2072f2048b774dee6507aa23b8e5209adaaf80312fd76a4ade0d075234bf08db940aa04ba54ccfb865943ce4ba063997bef

data/.github/workflows/ci.yml

@@ -7,10 +7,6 @@ on:
     branches: [ main ]
   release:
     types: [created]
-    on:
-      push:
-        tags:
-          - 'v*'
 
 jobs:
   build:
@@ -51,6 +47,7 @@ jobs:
   publish:
     needs: build
     runs-on: ubuntu-latest
+    if: startsWith(github.ref, 'refs/tags/v')
     steps:
       - uses: actions/checkout@v2
 

data/README.md

@@ -1,10 +1,21 @@
 # SmsTraffic
 
-[![Gem Version](https://badge.fury.io/rb/sms_traffic.svg)](https://badge.fury.io/rb/sms_traffic)
+[![Gem Version](https://badge.fury.io/rb/sms_traffic_sdk.svg)](https://badge.fury.io/rb/sms_traffic_sdk)
 [![Maintainability](https://api.codeclimate.com/v1/badges/bb4795be5024dd81d927/maintainability)](https://codeclimate.com/github/golifox/sms_traffic/maintainability)
 [![Coverage](https://codecov.io/github/golifox/sms_traffic/graph/badge.svg?token=74C0YBJP3F)](https://codecov.io/github/golifox/sms_traffic)
 [![CI](https://github.com/golifox/sms_traffic/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/golifox/sms_traffic/actions/workflows/ci.yml)
 
+Ruby Gem as a software development kit (SDK) that facilitates interaction with the SMS Traffic HTTP API (smstraffic.ru/api).
+This gem provides a convenient wrapper to integrate SMS Traffic services within Ruby applications, allowing for easy 
+sending of SMS messages and checking delivery statuses.
+
+## Features
+
+- Send SMS messages to single or multiple recipients.
+- Check the delivery status of sent messages.
+- **TODO:** Support for various message formats and encodings.
+
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -23,7 +34,6 @@ Or install it yourself as:
 
 ## Usage
 
-
 Define settings:
 
 ```ruby
@@ -81,13 +91,26 @@ reply.hash
 
 ```
 
-## Development
+# Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/golifox/sms_traffic_sdk. 
 
 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 install this gem onto your local machine, run `bundle exec rake install`.
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+The gem is available as open-source under the terms of the [MIT License](LICENSE).
+
+## Contact
+
+If you have any questions or feedback regarding SMS Traffic SDK, please feel free to contact us via GitHub issues or directly by email at i@golifox.ru.
+
+## Acknowledgments
+
+- Thanks to the SMS Traffic team for providing the API that this gem is based upon.
+- Anyone who contributes to this project is greatly appreciated.
+
+For more information please visit [SMS Traffic API docs](http://smstraffic.ru/api).
 

data/lib/sms_traffic/client/deliver_reply.rb

@@ -5,6 +5,8 @@ module SmsTraffic
 
       def ok?
         fetch_value(hash, :result) == OK_REPLY
+      rescue NoMethodError
+        false
       end
 
       def error?
@@ -29,7 +31,7 @@ module SmsTraffic
 
       def sms_id(phone = nil)
         message_info = fetch_value(message_infos, :message_info)
-        return fetch_value(message_info, :sms_id) if message_info.is_a?(Hash)
+        return fetch_value(message_info, :sms_id) if message_info.is_a?(Hash) || message_info.nil?
 
         raise ArgumentError, 'phone is required' unless phone
 

data/lib/sms_traffic/client/reply.rb

@@ -4,7 +4,7 @@ module SmsTraffic
       attr_reader :xml, :hash
 
       def initialize(xml, xml_parser: SmsTraffic.configuration.xml_parser)
-        @xml = xml.gsub!(/\s+/, ' ')
+        @xml  = xml.gsub!(/\s+/, ' ')
         @hash = fetch_value(xml_parser.parse(xml), :reply)
       end
 
@@ -12,6 +12,8 @@ module SmsTraffic
 
       def fetch_value(hash, key)
         hash.fetch(key.to_s, nil) || hash.fetch(key.to_sym, nil)
+      rescue NoMethodError
+        nil
       end
     end
   end

data/lib/sms_traffic/configuration.rb

@@ -5,12 +5,13 @@ module SmsTraffic
   class Configuration
     include Singleton
 
-    attr_accessor :login, :password, :host, :originator, :debug, :logger, :xml_parser
+    attr_accessor :login, :password, :host, :originator, :debug, :logger, :xml_parser, :validate_phone
 
     def initialize
-      self.debug = default_configuration[:debug]
-      self.logger = default_configuration[:logger]
-      self.xml_parser = default_configuration[:xml_parser]
+      self.debug          = default_configuration[:debug]
+      self.logger         = default_configuration[:logger]
+      self.xml_parser     = default_configuration[:xml_parser]
+      self.validate_phone = default_configuration[:validate_phone]
       super
     end
 
@@ -46,13 +47,14 @@ module SmsTraffic
 
     def default_configuration
       {
-        login:      nil,
-        password:   nil,
-        host:       nil,
-        originator: nil,
-        debug:      false,
-        logger:     $stdout,
-        xml_parser: default_xml_parser
+        login:          nil,
+        password:       nil,
+        host:           nil,
+        originator:     nil,
+        debug:          false,
+        logger:         $stdout,
+        xml_parser:     default_xml_parser,
+        validate_phone: true
       }
     end
 

data/lib/sms_traffic/sms.rb

@@ -4,11 +4,11 @@ module SmsTraffic
     attr_reader :id, :status, :errors
 
     def initialize(phone, message, originator: nil)
-      @phone = phone
-      @message = message
+      @phone      = phone
+      @message    = message
       @originator = originator || SmsTraffic.configuration.originator
-      @status = 'not-sent'
-      @errors = []
+      @status     = 'not-sent'
+      @errors     = []
       validate!
     end
 
@@ -26,10 +26,10 @@ module SmsTraffic
 
       if reply.ok?
         @status = 'sent'
-        @id = reply.sms_id
+        @id     = reply.sms_id
         true
       else
-        @errors << reply.error_description
+        @errors << (reply.error_description || 'Sms has been not enqueued')
         false
       end
     end
@@ -45,10 +45,10 @@ module SmsTraffic
 
     private
 
-    def validate!
+    def validate! # rubocop:disable Metrics/ AbcSize
       raise ArgumentError, "Phone should be assigned to #{self.class}." if phone.nil?
 
-      unless phone.to_s =~ /^[0-9]{11}$/
+      if SmsTraffic.configuration.validate_phone && phone.to_s !~ /^[0-9]{11,}$/
         raise ArgumentError, 'Phone number should contain only numbers. Minimum length is 11.'
       end
 

data/lib/sms_traffic/version.rb

@@ -1,3 +1,3 @@
 module SmsTraffic
-  VERSION = '0.0.1'.freeze
+  VERSION = '0.0.3'.freeze
 end

data/sms_traffic_sdk.gemspec

@@ -10,7 +10,9 @@ Gem::Specification.new do |spec|
   spec.email         = ['i@golifox.ru']
 
   spec.summary       = 'Send sms via SmsTraffic service.'
-  spec.description   = 'Send sms via SmsTraffic service.'
+  spec.description   = 'Ruby Gem as a SDK for interacting with the SMS Traffic HTTP API (smstraffic.ru/api).
+                        This gem provides a convenient way to integrate SMS Traffic services into Ruby applications,
+                        enabling tasks such as sending SMS messages, checking delivery status, and others.'
   spec.homepage      = 'https://github.com/golifox/sms_traffic'
   spec.license       = 'MIT'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sms_traffic_sdk
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors:
 - David Rybolovlev
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-07-15 00:00:00.000000000 Z
+date: 2024-09-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -52,7 +52,10 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.5'
-description: Send sms via SmsTraffic service.
+description: |-
+  Ruby Gem as a SDK for interacting with the SMS Traffic HTTP API (smstraffic.ru/api).
+                          This gem provides a convenient way to integrate SMS Traffic services into Ruby applications,
+                          enabling tasks such as sending SMS messages, checking delivery status, and others.
 email:
 - i@golifox.ru
 executables:
@@ -89,7 +92,7 @@ licenses:
 - MIT
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -105,7 +108,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.5.11
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Send sms via SmsTraffic service.
 test_files: []