smsru_ruby 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d8d52bb804fe21a23adffdcc6a2a5cea8ca864042f517b9f1258e95688d3a48c
-  data.tar.gz: f9e9c5cbd4ea6980885b589f07bda2b7f12bbe0dcdff2af559adfe922e4c979d
+  metadata.gz: 83b4caabc11d6eb0b3795b891079da1125ab846268aeddb7eb88b75db0237078
+  data.tar.gz: 663be0182ac17cf6d607d9e56ce30f0d4703a5c9c2b84d9dc77c01bc57c006e4
 SHA512:
-  metadata.gz: a091a855d10c251fa1891fb440c89ccaaac9d74105006b2211a1325ac92de301cd68b00198f7e33198a4535417b3d0eddcdf64fc0a9a2f3a53ad36a7cb7d1567
-  data.tar.gz: 65fbe47c1243a1580795da2833df5697f628b4c9d10ece5793d1d7ac7214468468c29a9b3d31e805f1e850e9dc752b159515a30d34248bc278f206a9f672582b
+  metadata.gz: f323d6639adc27b88586dde1ea065122895fc0aba8056afb14c9f617d8b5cf68e54d65742e6b2077bdab2a13f07aa5b192c0e787f5d1c0f6353e6fe130d9d64d
+  data.tar.gz: 25f64521bddde691a57dd54617c95ff6732796377647d6df1861e6b79d70ba911c51a9ba6094f2c5ed1ab88acf7add67e7a6905ca3f8f456999902af5c6dd1e0

data/README.md

@@ -1,5 +1,10 @@
 # smsru_ruby
 
+> [!WARNING]
+> **This gem has been renamed to [`smsru-ruby`](https://rubygems.org/gems/smsru-ruby) and is no longer maintained.**
+> Switch your `Gemfile` to `gem "smsru-ruby"` and your code to `require "smsru-ruby"`.
+> The Ruby API is unchanged — the top-level class is still `SmsRu`. See <https://github.com/svyatov/smsru-ruby>.
+
 [![Gem Version](https://badge.fury.io/rb/smsru_ruby.svg)](https://rubygems.org/gems/smsru_ruby)
 [![CI](https://github.com/svyatov/smsru_ruby/actions/workflows/main.yml/badge.svg)](https://github.com/svyatov/smsru_ruby/actions/workflows/main.yml)
 [![codecov](https://codecov.io/gh/svyatov/smsru_ruby/branch/main/graph/badge.svg)](https://codecov.io/gh/svyatov/smsru_ruby)
@@ -286,16 +291,23 @@ In your webhook handler, verify the signature, parse the payload, and
 acknowledge it by replying with the string `"100"`:
 
 ```ruby
+# In Rails, params[:data] is ActionController::Parameters, not a Hash — convert
+# it with .to_unsafe_h first, or the numeric-key ordering the signature depends
+# on is skipped and the check below rejects the payload. The payload is
+# signature-verified, so to_unsafe_h is safe here (.to_h would drop keys).
+# In bare Rack params["data"] is already a Hash; pass it as-is.
+data = params[:data].to_unsafe_h
+
 # Reject forged callbacks: SMS.ru signs every payload with your api_id.
 # The check is constant-time (timing-attack safe).
-unless SmsRu::Webhook.valid?(params["data"], params["hash"], "YOUR_API_ID")
+unless SmsRu::Webhook.valid?(data, params[:hash], "YOUR_API_ID")
   return head(:forbidden)
 end
 
 # SMS.ru sends up to 100 records as POST fields data[0]..data[N]
-# (a Hash in Rack/Rails, an Array in PHP). #parse handles either shape and
+# (a Hash in Rack, an Array in PHP). #parse handles either shape and
 # returns a typed event per record.
-SmsRu::Webhook.parse(params["data"]).each do |event|
+SmsRu::Webhook.parse(data).each do |event|
   case event
   when SmsRu::Events::SmsStatus        # delivery report
     # event.id, event.status_code, event.created_at; event.delivered? => 103

data/lib/sms_ru/version.rb

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

data/lib/sms_ru/webhook.rb

@@ -3,15 +3,23 @@
 class SmsRu
   # Parses the inbound webhook payload SMS.ru POSTs to your callback URL and
   # verifies its signature. SMS.ru sends the records as POST fields
-  # `data[0]..data[N]` (so `params["data"]` is a Hash in Rack/Rails, an Array
-  # in PHP) plus a `hash` field; acknowledge the webhook by replying with "100".
+  # `data[0]..data[N]` plus a `hash` field; acknowledge the webhook by replying
+  # with "100".
+  #
+  # 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
+  # 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},
   # {SmsRu::Events::CallcheckStatus}, {SmsRu::Events::Test}, or
   # {SmsRu::Events::Unknown} — best handled with a case match:
   #
-  #   return head(:forbidden) unless SmsRu::Webhook.valid?(params["data"], params["hash"], api_id)
-  #   SmsRu::Webhook.parse(params["data"]).each do |event|
+  #   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)
+  #   SmsRu::Webhook.parse(data).each do |event|
   #     case event
   #     when SmsRu::Events::SmsStatus       then update_delivery(event.id, event.status_code)
   #     when SmsRu::Events::CallcheckStatus then confirm(event.id) if event.confirmed?

data/smsru_ruby.gemspec

@@ -15,6 +15,17 @@ Gem::Specification.new do |spec|
   spec.homepage = "https://github.com/svyatov/smsru_ruby"
   spec.license = "MIT"
 
+  spec.post_install_message = <<~MSG
+    NOTE: `smsru_ruby` has been renamed to `smsru-ruby` and is no longer maintained.
+
+    Please switch:
+      * Gemfile:  gem "smsru-ruby"
+      * require:  require "smsru-ruby"
+
+    The Ruby API is unchanged (the top-level class is still `SmsRu`).
+    https://github.com/svyatov/smsru-ruby
+  MSG
+
   spec.required_ruby_version = ">= 3.2.0"
 
   spec.require_paths = ["lib"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: smsru_ruby
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Leonid Svyatov
@@ -61,6 +61,15 @@ metadata:
   source_code_uri: https://github.com/svyatov/smsru_ruby
   changelog_uri: https://github.com/svyatov/smsru_ruby/blob/main/CHANGELOG.md
   bug_tracker_uri: https://github.com/svyatov/smsru_ruby/issues
+post_install_message: |
+  NOTE: `smsru_ruby` has been renamed to `smsru-ruby` and is no longer maintained.
+
+  Please switch:
+    * Gemfile:  gem "smsru-ruby"
+    * require:  require "smsru-ruby"
+
+  The Ruby API is unchanged (the top-level class is still `SmsRu`).
+  https://github.com/svyatov/smsru-ruby
 rdoc_options: []
 require_paths:
 - lib