sms_traffic_sdk 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 73b544fc8bce8a1627dca1e7be082da47adbb4116bc6d47a4fdb9cd50bbc2e3c
-  data.tar.gz: d653685da42c1e33a1d06a300edf98d8f5f83e5b6da969f57e41eb4b444692b2
+  metadata.gz: 4c5c633712d477a8978bb88a14dded77e522195705ecc68e2bae2bf18078943c
+  data.tar.gz: 64b2ea39745e547e707898b6ec4778a937eff0c9c54ee2df5783b37af04d01d6
 SHA512:
-  metadata.gz: 75efe5af30bde21435b11fde083721a9cc9b701dbb3f3eab506670694a9b6b863b2c143a288793b27e63607ef138c2ffd8b31d7a3387821ac439b2765ffeed16
-  data.tar.gz: 640e577af992334877dcaf3c0839e005cf2929e5fa21c9ac9bb0f4fb4f94a64f446ad428e3764fdaf152444bf7e33b01f5b967414e1a78928bc39c502aab9895
+  metadata.gz: 4f02913510ac31a7b1b7f8f61cb503ca10332ec04a6bc2281c90da2598444ad9a940b329948b6759a79be48842a918299936b74e5b0b7c2b986fe5cf6b5febd8
+  data.tar.gz: 7a708811f729349e37db2c75c68c636390f147ef3facff7cfcaf7b200ef57d6538a20b64c0dde0a93af71066f7d632d747127f10ebabf50eab874ac51b3f8b3c

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 # 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

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,7 +133,8 @@ 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.
 
@@ -147,6 +149,8 @@ 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

@@ -9,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(parse(xml_parser), :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
@@ -34,11 +35,18 @@ module SmsTraffic
 
       private
 
-      # A body that is not well-formed XML is an empty reply, as before the REXML parser.
       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)

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/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.3.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.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - David Rybolovlev