smsru-ruby 2.0.1 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d72d6d4e772f82408d569348f99ef955327b2b79df8362af398e5d6a37e8a2e0
-  data.tar.gz: b63bede5061acbaa49f18c939efbe18612d8dd1293af1c0746b125c2633dc23c
+  metadata.gz: 9fa32fb7428f230423bda4d5a4b8e776c719df31daebe9ffb30e488e8bc7c620
+  data.tar.gz: 8dd26fbc54609529e34df51e2ff374e64d3657be1187e2ff76a9d33dbbcbb7ed
 SHA512:
-  metadata.gz: 0f2a3066c095d35d1ee4b57d75511202edd08c3ecd224246a0ee010d698359ece9d6863f583317a44cd134abeecdb3b32f9e0c6e264208ea52cc448c3a50f769
-  data.tar.gz: dc4f9a01b3012479bb967bc0958d2183f015afaee88d6787514a43aeb67441b0297f04d12f1d5d5b83e290277fc137a063c4ff64288f81bdca1093b53a29b5c7
+  metadata.gz: a4fb447fbe3057aaab9b6e92ee90645bb2294ef0b7a75fc697c4befd820e77f9115f485b1f4c12ac05c624a0b5224ab82b8b5f375fa7ee958b7eeb39b793f7d9
+  data.tar.gz: 235d9ca8fba5a74229ee3416a2fc58bc704aabb2f1b93d8bf18daff8916f948d10d2f56ef7aaa6a5ee3522e059515832dce806fe3fe755adbcdba09c82bea509

data/CHANGELOG.md

@@ -5,8 +5,28 @@ All notable changes to this project are documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+The public API that Semantic Versioning covers is every constant and method
+under `SmsRu` that YARD documents as public: the `SmsRu` client and its `auth`,
+`callbacks`, `call_check`, `my`, and `stoplist` sub-resources, the result and
+event `Data` classes, the `SmsRu::Statuses` constants and predicates, the error
+hierarchy under `SmsRu::Error`, and `SmsRu::Webhook.parse`. Anything marked
+`@api private`, including `SmsRu::Coerce` and the sub-resource constructors, may
+change in any release. The minimum supported Ruby version is part of the public
+API: raising it takes a MAJOR release.
+
 ## [Unreleased]
 
+## [3.0.0] - 2026-09-07
+
+### Removed
+
+- Ruby 3.2 support. The minimum supported Ruby is now 3.3.
+
+### Added
+
+- This changelog now declares which constants and methods Semantic Versioning
+  covers, so a version range says something checkable about what may change.
+
 ## [2.0.1] - 2026-07-31
 
 ### Added
@@ -26,7 +46,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Changed
 
-- **BREAKING:** Renamed the gem from `smsru_ruby` to `smsru-ruby` for
+- **Breaking:** Renamed the gem from `smsru_ruby` to `smsru-ruby` for
   consistency with the `-ruby` suffix convention. Update your `Gemfile`
   (`gem "smsru-ruby"`) and requires (`require "smsru-ruby"`). The Ruby API is
   unchanged. The top-level class is still `SmsRu`.
@@ -62,7 +82,8 @@ same API, reworked to be idiomatic Ruby. How it differs from the original:
   SMS.ru's loosely-typed JSON is normalized to the declared types at the parse
   boundary, so result objects never surface raw wire values.
 
-[Unreleased]: https://github.com/svyatov/smsru-ruby/compare/v2.0.1...HEAD
+[Unreleased]: https://github.com/svyatov/smsru-ruby/compare/v3.0.0...HEAD
+[3.0.0]: https://github.com/svyatov/smsru-ruby/compare/v2.0.1...v3.0.0
 [2.0.1]: https://github.com/svyatov/smsru-ruby/compare/v2.0.0...v2.0.1
 [2.0.0]: https://github.com/svyatov/smsru-ruby/compare/v1.0.0...v2.0.0
 [1.0.0]: https://github.com/svyatov/smsru-ruby/releases/tag/v1.0.0

data/README.md

@@ -297,6 +297,8 @@ SmsRu::Error                  # base class
    └─ SmsRu::InsufficientFundsError # not enough money (code 201)
 ```
 
+Rescue whichever level of that hierarchy your code needs, around any call.
+
 ```ruby
 begin
   client.deliver("79991234567", "Hi")
@@ -316,9 +318,8 @@ reported on each `SmsRu::Sms` in `result.messages` (see above).
 
 ## Development
 
-Ruby 3.2 or newer is required, because the result objects use
-[`Data`](https://docs.ruby-lang.org/en/3.2/Data.html). CI runs against
-`ruby-head`, `4.0`, `3.4`, `3.3`, and `3.2`.
+Ruby 3.3 or newer is required. CI runs against `ruby-head`, `4.0`, `3.4`, and
+`3.3`.
 
 ```sh
 bin/setup            # install dependencies

data/lib/sms_ru/client.rb

@@ -20,7 +20,7 @@ class SmsRu
   # @param retries [Integer] retry attempts on transport failure (0 disables; PHP default is 5)
   # @param from    [String, nil] default sender name for #deliver (overridable per call)
   # @param logger  [Logger, nil] optional logger; logs the request path and transport
-  #   failures only — never the api_id, phone numbers, or message text
+  #   failures only, never the api_id, phone numbers, or message text
   def initialize(api_id, timeout: 30, test: false, retries: 5, from: nil, logger: nil)
     @api_id = api_id
     @timeout = timeout
@@ -39,7 +39,7 @@ class SmsRu
   #   forms, must be omitted for the Hash form
   # @param from [String, nil] an approved sender name
   # @param time [Integer, nil] schedule the send at this UNIX timestamp
-  # @param ttl [Integer, nil] message lifetime in minutes (1–1440); undelivered
+  # @param ttl [Integer, nil] message lifetime in minutes (1 to 1440); undelivered
   #   messages are discarded after this period
   # @param daytime [Boolean] when true, defer night-time sends to the recipient's daytime
   # @param translit [Boolean] transliterate Cyrillic to Latin

data/lib/sms_ru/coerce.rb

@@ -2,15 +2,15 @@
 
 class SmsRu
   # Normalizes loosely-typed SMS.ru JSON values into the types the result
-  # objects declare. SMS.ru is inconsistent on the wire — `/my/limit` returns
+  # objects declare. SMS.ru is inconsistent on the wire: `/my/limit` returns
   # `total_limit` as the string `"10"` but `used_today` as the number `0`, and
-  # some counters arrive as `null` — so each field is coerced here rather than
+  # some counters arrive as `null`. Each field is coerced here rather than
   # trusted as-is.
   #
   # Each type has two helpers: the `?` variant returns nil for a
   # missing/blank/unparseable value (for the nullable fields), while the plain
   # variant falls back to a default (`""`/`0`/`0.0`, overridable) for the fields
-  # the API always populates — so call sites declare their nullability by name.
+  # the API always populates, so call sites declare their nullability by name.
   #
   # @api private
   module Coerce

data/lib/sms_ru/data.rb

@@ -155,7 +155,7 @@ class SmsRu
   end
 
   # Result of SmsRu#call (flash call). `code` is the last 4 digits of the number
-  # that calls the user — what they read off the incoming call and enter.
+  # that calls the user, which is what they read off the incoming call and enter.
   #
   # @!attribute [r] code
   #   @return [String] the 4-digit code (the calling number's last 4 digits)
@@ -212,7 +212,7 @@ class SmsRu
     def available_today = total_free - used_today
   end
 
-  # Result of SmsRu::CallCheck#add — the number the user must call to authorize.
+  # Result of SmsRu::CallCheck#add: the number the user must call to authorize.
   #
   # @!attribute [r] check_id
   #   @return [String] the check id to poll with SmsRu::CallCheck#status
@@ -235,7 +235,7 @@ class SmsRu
     end
   end
 
-  # Result of SmsRu::CallCheck#status — whether the authorizing call has arrived.
+  # Result of SmsRu::CallCheck#status: whether the authorizing call has arrived.
   #
   # @!attribute [r] status_code
   #   @return [Integer] the check status code (401 once confirmed)

data/lib/sms_ru/statuses.rb

@@ -41,10 +41,10 @@ class SmsRu
     # @return [Boolean] true once the message reached the handset (code 103)
     def delivered? = status_code == Statuses::DELIVERED
 
-    # @return [Boolean] true while the message is still in transit (codes 100–102)
+    # @return [Boolean] true while the message is still in transit (codes 100 to 102)
     def pending? = !status_code.nil? && Statuses::PENDING.include?(status_code)
 
-    # @return [Boolean] true when the message will not be delivered (codes 104–108, 150)
+    # @return [Boolean] true when the message will not be delivered (codes 104 to 108, and 150)
     def failed? = !status_code.nil? && Statuses::FAILED.include?(status_code)
   end
 end

data/lib/sms_ru/version.rb

@@ -2,5 +2,5 @@
 
 class SmsRu
   # The gem version.
-  VERSION = "2.0.1"
+  VERSION = "3.0.0"
 end

data/lib/sms_ru/webhook.rb

@@ -8,14 +8,14 @@ class SmsRu
   #
   # The `data` param arrives as a Hash in bare Rack and an Array in PHP-style
   # clients. In Rails it is an `ActionController::Parameters`, which is **not** a
-  # Hash — convert it with `.to_unsafe_h` first, or the numeric-key ordering the
+  # Hash. Convert it with `.to_unsafe_h` first, or the numeric-key ordering the
   # signature depends on is skipped and {valid?} rejects the payload. The
   # payload is signature-verified, so `to_unsafe_h` is safe here (`.to_h` would
   # drop unpermitted keys).
   #
-  # {parse} returns one typed event per record — a {SmsRu::Events::SmsStatus},
+  # {parse} returns one typed event per record: a {SmsRu::Events::SmsStatus},
   # {SmsRu::Events::CallcheckStatus}, {SmsRu::Events::Test}, or
-  # {SmsRu::Events::Unknown} — best handled with a case match:
+  # {SmsRu::Events::Unknown}. A case match handles them best:
   #
   #   data = params[:data].to_unsafe_h # Rails; pass params["data"] as-is in bare Rack
   #   return head(:forbidden) unless SmsRu::Webhook.valid?(data, params[:hash], api_id)

data/smsru-ruby.gemspec

@@ -15,7 +15,7 @@ Gem::Specification.new do |spec|
   spec.homepage = "https://github.com/svyatov/smsru-ruby"
   spec.license = "MIT"
 
-  spec.required_ruby_version = ">= 3.2.0"
+  spec.required_ruby_version = ">= 3.3.0"
 
   spec.require_paths = ["lib"]
   spec.files = Dir["lib/**/*.rb"] + Dir["sig/**/*"] +

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: smsru-ruby
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 3.0.0
 platform: ruby
 authors:
 - Leonid Svyatov
@@ -67,7 +67,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.2.0
+      version: 3.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="