sms_traffic_sdk 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7073f3fdf9537cf98008d5c6fac2bbc28457fbe4ef05852ccfd4e3b3a4606fbc
-  data.tar.gz: 7ad131b8ca90beebf7d4e227fa4031655bdc49d7e5db4f12c7ee11763cde8e0a
+  metadata.gz: 4c5c633712d477a8978bb88a14dded77e522195705ecc68e2bae2bf18078943c
+  data.tar.gz: 64b2ea39745e547e707898b6ec4778a937eff0c9c54ee2df5783b37af04d01d6
 SHA512:
-  metadata.gz: f22009b2e84816ea0ad7294fd80ec8810dfc99c4ad46a7c66e9f9604f837c31fe5d6ae996639e776cb79501523b50257d20390069412993c704b2456ed3b5fb7
-  data.tar.gz: 4dc45cb30d25dd521d716f16bcb7a4ae530ee9fa3b8d14f0b8ec0cfde6a479c81d41268b1015a7518bdd16d79a11fc4f8c5663d2e8266dc7f34c1d0415202843
+  metadata.gz: 4f02913510ac31a7b1b7f8f61cb503ca10332ec04a6bc2281c90da2598444ad9a940b329948b6759a79be48842a918299936b74e5b0b7c2b986fe5cf6b5febd8
+  data.tar.gz: 7a708811f729349e37db2c75c68c636390f147ef3facff7cfcaf7b200ef57d6538a20b64c0dde0a93af71066f7d632d747127f10ebabf50eab874ac51b3f8b3c

data/CHANGELOG.md

@@ -1,5 +1,39 @@
 # Changelog
 
+## 0.4.0 - 2026-11-03
+
+### Breaking changes
+
+- An HTTP 200 body that is not an XML `<reply>` element (an HTML error page, plain text, a truncated or empty body)
+  raises `SmsTraffic::MalformedReplyError` instead of returning an empty reply. Its message is
+  `"Malformed reply (N bytes)"`; `#body` keeps the body. `Sms#deliver` returns `false` and records that message
+  instead of `"Sms has not been enqueued: "`. An empty `<reply/>` is still an empty reply.
+- The debug request line shows only `originator`, `want_sms_ids`, `rus`, `operation` and `sms_id`; `phones` and any
+  extra `deliver` option are now `[FILTERED]` too.
+
+### Changed
+
+- `Client.status` and `Client.balance` repeat on the fallback host after `MalformedReplyError`; `Client.deliver`
+  does not, since the provider may already have queued the SMS.
+
+## 0.3.0 - 2026-11-03
+
+### Breaking changes
+
+- `nokogiri` is no longer a dependency. Applications that relied on Nokogiri being installed through this gem must
+  depend on it themselves.
+
+### Changed
+
+- The default XML parser is `Nori.new(advanced_typecasting: false, parser: :rexml)`. Every fixture parses to the
+  same hash as with Nokogiri. `rexml` (`>= 3.3.9`, after the 2024 DoS fixes) is a new runtime dependency; a custom
+  `xml_parser` is still possible.
+- A body that is not well-formed XML (an HTML error page, plain text, a truncated reply) keeps the 0.2.0 behavior:
+  the reply is empty, so `Sms#deliver` returns `false` and `Client.*` return a reply with an empty hash.
+- Runtime dependency lower bounds are tested: `gemfiles/minimum.gemfile` pins `nori` 2.8.0, `rexml` 3.3.9 and
+  `bigdecimal` 3.1.0, and the suite passes with them. CI runs it as `test-minimum` on Ruby 3.1 and 3.4; `publish`
+  waits for it.
+
 ## 0.2.0 - 2026-11-03
 
 ### Added

data/README.md

@@ -58,7 +58,8 @@ end
 
 `login`, `password` and `host` are required; `logger` is required when `debug` is enabled.
 With `debug` on, one request line and one response line are written through `logger.debug`;
-`login`, `password` and `message` are replaced with `[FILTERED]`.
+only `originator`, `want_sms_ids`, `rus`, `operation` and `sms_id` are shown, every other param (credentials,
+`phones`, `message`, extra options) is replaced with `[FILTERED]`.
 
 Send an SMS:
 
@@ -132,16 +133,24 @@ The value is returned as the provider sends it; its units are not documented and
 Set `config.fallback_host` (the provider documents `https://api2.smstraffic.ru`) to repeat a failed request once
 on the backup host. The request is repeated after `SocketError`, `Errno::ECONNREFUSED`, `Errno::EHOSTUNREACH`,
 `Errno::ENETUNREACH`, `Net::OpenTimeout`, or API error 1000 (temporary server problem). `Client.status` and
-`Client.balance` also retry after any `ConnectionError` (read timeout, reset connection, TLS failure) and HTTP 5xx.
+`Client.balance` also retry after any `ConnectionError` (read timeout, reset connection, TLS failure), HTTP 5xx and
+`MalformedReplyError`.
 `Client.deliver` does not, since the provider may already have queued the SMS. The error of the last attempt is raised. With `debug`, the retry is
 logged in one line without credentials.
 
+### XML parser
+
+Replies are parsed with Nori and its pure-Ruby REXML backend, so no native extension is needed. To use another
+parser, set `config.xml_parser` to any object that responds to `parse(xml)` and returns a Hash.
+
 ### Errors
 
 All errors inherit from `SmsTraffic::Error`:
 
 - `SmsTraffic::ConnectionError` - network, timeout or TLS failure (the original exception is `cause`).
 - `SmsTraffic::HttpError` - non-2xx response; has `status` and `body`.
+- `SmsTraffic::MalformedReplyError` - HTTP 200 whose body is not an XML `<reply>` element (an HTML error page, plain
+  text, a truncated reply); has `body`, the message gives only its size.
 - `SmsTraffic::ApiError` - the provider replied `ERROR` (or `ERRO`); has `code` and `description`, and the
   predicates `retryable?` (1000), `access_denied?` (411, 412), `insufficient_funds?` (415) and `blocked_phone?` (432).
 

data/lib/sms_traffic/client/reply.rb

@@ -1,3 +1,6 @@
+# Nori loads REXML lazily on the first parse; Reply#parse rescues its exception even with a custom parser.
+require 'rexml/parsers/baseparser'
+
 module SmsTraffic
   class Client
     class Reply
@@ -6,10 +9,11 @@ module SmsTraffic
 
       attr_reader :xml, :to_h
 
+      # @raise [MalformedReplyError] the body is not an XML `<reply>` element
       def initialize(xml, xml_parser: SmsTraffic.configuration.xml_parser)
-        @xml = xml.gsub(/\s+/, ' ')
-        parsed = fetch_value(xml_parser.parse(@xml), :reply)
-        @to_h  = parsed.is_a?(Hash) ? parsed : {}
+        @xml  = xml.to_s.gsub(/\s+/, ' ')
+        @to_h = reply_hash(parse(xml_parser))
+        raise MalformedReplyError, xml if @to_h.nil?
       end
 
       def result
@@ -31,6 +35,20 @@ module SmsTraffic
 
       private
 
+      def parse(xml_parser)
+        xml_parser.parse(@xml)
+      rescue REXML::ParseException
+        nil
+      end
+
+      # An empty `<reply/>` carries no data; a missing `<reply>` element or one holding only text is malformed.
+      def reply_hash(parsed)
+        return unless parsed.is_a?(Hash) && (parsed.key?('reply') || parsed.key?(:reply))
+
+        reply = fetch_value(parsed, :reply) || {}
+        reply if reply.is_a?(Hash)
+      end
+
       def fetch_value(source, key)
         return unless source.is_a?(Hash)
 

data/lib/sms_traffic/client.rb

@@ -10,7 +10,8 @@ module SmsTraffic
   class Client
     ENDPOINT = 'multi.php'.freeze
     FILTERED = '[FILTERED]'.freeze
-    FILTERED_PARAMS = %i[login password message].freeze
+    # The only request params the debug log shows; every other value, phones and options included, is FILTERED.
+    LOGGED_PARAMS = %i[originator want_sms_ids rus operation sms_id].freeze
     CONNECTION_ERRORS = [
       SocketError, SystemCallError, IOError, Net::OpenTimeout, Net::ReadTimeout, OpenSSL::SSL::SSLError
     ].freeze
@@ -25,7 +26,7 @@ module SmsTraffic
       # @param originator [String] originator (subject), defaults to the configured one
       # @param options [Hash] additional options
       # @return [DeliverReply]
-      # @raise [ConnectionError, HttpError, ApiError]
+      # @raise [ConnectionError, HttpError, MalformedReplyError, ApiError]
       def deliver(phone, message, originator = nil, **options)
         originator ||= SmsTraffic.configuration.originator
         request(DeliverReply, deliver_params(phone, message, originator, **options), read_only: false)
@@ -33,13 +34,13 @@ module SmsTraffic
 
       # @param sms_ids [Array<String>] sms ids
       # @return [StatusReply]
-      # @raise [ConnectionError, HttpError, ApiError]
+      # @raise [ConnectionError, HttpError, MalformedReplyError, ApiError]
       def status(*sms_ids)
         request(StatusReply, status_params(sms_ids), read_only: true)
       end
 
       # @return [AccountReply]
-      # @raise [ConnectionError, HttpError, ApiError]
+      # @raise [ConnectionError, HttpError, MalformedReplyError, ApiError]
       def balance
         request(AccountReply, account_params, read_only: true)
       end
@@ -76,12 +77,15 @@ module SmsTraffic
       def retry_on_fallback?(error, read_only:)
         case error
         when ApiError then error.retryable?
-        when ConnectionError then read_only || UNREACHABLE_ERRORS.any? { |klass| error.cause.is_a?(klass) }
+        when MalformedReplyError then read_only
+        when ConnectionError then read_only || unreachable?(error)
         when HttpError then read_only && error.status >= 500
         else false
         end
       end
 
+      def unreachable?(error) = UNREACHABLE_ERRORS.any? { |klass| error.cause.is_a?(klass) }
+
       # @param form_data [Hash<Symbol, String|Integer>]
       # @return [String] response body
       def post(form_data, host)
@@ -118,7 +122,7 @@ module SmsTraffic
       end
 
       def filter(form_data)
-        form_data.to_h { |key, value| [key, FILTERED_PARAMS.include?(key) ? FILTERED : value] }
+        form_data.to_h { |key, value| [key, LOGGED_PARAMS.include?(key.to_sym) ? value : FILTERED] }
       end
 
       def deliver_params(phone, message, originator, **options)

data/lib/sms_traffic/configuration.rb

@@ -17,7 +17,7 @@ module SmsTraffic
 
     def reset!
       ATTRIBUTES.each { |attribute| public_send("#{attribute}=", DEFAULTS[attribute]) }
-      self.xml_parser = Nori.new(advanced_typecasting: false)
+      self.xml_parser = Nori.new(advanced_typecasting: false, parser: :rexml)
     end
 
     def validate!

data/lib/sms_traffic/errors.rb

@@ -15,6 +15,16 @@ module SmsTraffic
     end
   end
 
+  # HTTP 200 body that is not an XML `<reply>` element: an HTML error page, plain text, a truncated reply.
+  class MalformedReplyError < Error
+    attr_reader :body
+
+    def initialize(body)
+      @body = body
+      super("Malformed reply (#{body.to_s.bytesize} bytes)")
+    end
+  end
+
   # HTTP 200 reply whose `result` is not `OK` (`ERROR`, `ERRO`).
   class ApiError < Error
     attr_reader :code, :description

data/lib/sms_traffic/version.rb

@@ -1,3 +1,3 @@
 module SmsTraffic
-  VERSION = '0.2.0'.freeze
+  VERSION = '0.4.0'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sms_traffic_sdk
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.0
 platform: ruby
 authors:
 - David Rybolovlev
@@ -25,33 +25,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.1'
 - !ruby/object:Gem::Dependency
-  name: nokogiri
+  name: nori
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '2.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '2.8'
 - !ruby/object:Gem::Dependency
-  name: nori
+  name: rexml
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.8'
+        version: 3.3.9
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.8'
+        version: 3.3.9
 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,