didww-v3 6.1.0 → 6.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9cdeedbb317141c84de28bbedb4f652b858793e257d8d84f70155b08fc54623c
-  data.tar.gz: c48319beb5292ef53595e7905d4ac62ff0e59685bcb57eb48c2f7e6efbb7bd3e
+  metadata.gz: d834eeacdcc690b1b19e390a31730342681b1efe94d1e5f124d9b8c82d9ba5ca
+  data.tar.gz: 694e8a57d08a8cd646d715d424a1824aff726b3af40190db4749417de158c3ca
 SHA512:
-  metadata.gz: 42be04280b6673a827de5f4bc680f032f28d72437137d081455f2168aa02e92d3861b7fc842e6c70406e6495d1f377745f90a23ead254fdf0a5a6caf40417d63
-  data.tar.gz: e6aeccf261500d0307c5cbc7eae427880a853d008ce28639ff2512daa1ea1cb40c54962b3d0f972f7e3ea0a73274bc40a6a8a57b9df45689b9c0ddfb83987acb
+  metadata.gz: 0565f13367337588e62fadcc5464a3aaea268567b8b7af51e1c0f1b221027be039f242d1fae74e3a1b8980edff2add2cd394055b7e4c30a4bc453c0e39e15288
+  data.tar.gz: 44ceb7b1488be5a77b1d1b15a3ed45fd963a09e280941a5a14a7476fa331355ac81768974149aab51d44a38fe1d0f2717fb8fd38fd456704e6e9ccbe505d9879

data/CHANGELOG.md

@@ -4,6 +4,13 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [6.1.1] - 2026-05-04
+### Fixed
+- `SipConfiguration#enabled_sip_registration = true` now always emits `host: null` and `port: null` on the wire, not only when the local attribute hash already had them set. The previous conditional cascade (introduced in 6.1.0) silently no-op'd when re-enabling SIP registration on an existing trunk through a fresh `SipConfiguration` instance: the PATCH body carried only `enabled_sip_registration: true`, the server merged it with the trunk's persisted host, and rejected with 422 (`host must be blank when the SIP registration is enabled`). Verified end-to-end against the live sandbox via the new `examples/voice_in_trunk_sip_registration.rb`.
+
+### Added
+- `examples/voice_in_trunk_sip_registration.rb` — end-to-end create / rename / disable / re-enable flow demonstrating every cascade rule against the sandbox API.
+
 ## [6.1.0] - 2026-05-04
 ### Added
 - Complete the 2026-04-16 `SipConfiguration` attribute set that was missed during the 2026-04-16 rollout (and is not present in the public Postman collection — server form is the source of truth):

data/didww-v3.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
   spec.email         = ['alex.k@didww.com']
 
   spec.summary       = %q{Ruby client for DIDWW API v3}
-  spec.description   = %q{Ruby client for DIDWW API v3}
+  spec.description   = %q{Ruby client for the DIDWW JSON:API v3, covering DID inventory, voice in/out trunks, regulatory documents, exports, and emergency calling services.}
   spec.homepage      = 'https://github.com/didww/didww-v3-ruby'
   spec.license       = 'MIT'
 
@@ -24,11 +24,16 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 3.3'
 
-  spec.add_dependency 'activesupport'
-  spec.add_dependency 'faraday'
-  spec.add_dependency 'faraday-multipart'
-  spec.add_dependency 'json_api_client', '1.23.0'
-  spec.add_dependency 'http'
-  spec.add_dependency 'down'
-  spec.add_dependency 'openssl-oaep'
+  # Lower bounds match the oldest version verified by CI; upper bounds
+  # cap on the next known-incompatible major so consumers get a clear
+  # constraint failure rather than a runtime surprise. The CI matrix in
+  # .github/workflows/tests.yml exercises activesupport ~> 7.2 / 8.0 /
+  # 8.1 — declaring a wider lower bound than that would be aspirational.
+  spec.add_dependency 'activesupport',     '>= 7.2', '< 9'
+  spec.add_dependency 'faraday',           '~> 2.0'
+  spec.add_dependency 'faraday-multipart', '~> 1.0'
+  spec.add_dependency 'json_api_client',   '1.23.0'
+  spec.add_dependency 'http',              '~> 5.0'
+  spec.add_dependency 'down',              '~> 5.0'
+  spec.add_dependency 'openssl-oaep',      '~> 0.1'
 end

data/examples/README.md

@@ -41,6 +41,7 @@ DIDWW_API_KEY=your_api_key ruby examples/orders_nanpa.rb
 | Script | Description |
 |---|---|
 | [`voice_in_trunks.rb`](voice_in_trunks.rb) | Lists voice in trunks and their configurations. |
+| [`voice_in_trunk_sip_registration.rb`](voice_in_trunk_sip_registration.rb) | End-to-end SIP registration flow: create with `enabled_sip_registration: true`, rename, disable by setting `host`, re-enable by toggling the flag. The SDK keeps the dependent fields (`host`, `port`, `use_did_in_ruri`) aligned with the server's validation rules automatically. |
 | [`voice_in_trunk_groups.rb`](voice_in_trunk_groups.rb) | CRUD for trunk groups with trunk relationships. |
 
 ### Voice Out (Outbound)

data/examples/voice_in_trunk_sip_registration.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+#
+# End-to-end SIP registration flow on /voice_in_trunks (API 2026-04-16):
+# create with sip_registration enabled → rename → disable by setting
+# `host` → re-enable by toggling the flag. The SDK keeps the
+# dependent fields (`host`, `port`, `use_did_in_ruri`) aligned with
+# the server's validation rules automatically. The sandbox trunk is
+# left in place after the script completes so it can be inspected
+# afterwards.
+#
+# Usage: DIDWW_API_KEY=your_sandbox_key ruby examples/voice_in_trunk_sip_registration.rb
+
+require 'bundler/setup'
+require 'didww'
+
+DIDWW::Client.configure do |client|
+  client.api_key  = ENV.fetch('DIDWW_API_KEY') { abort 'Please set DIDWW_API_KEY' }
+  client.api_mode = :sandbox
+end
+
+puts "=== Ruby SDK v#{DIDWW::VERSION} — SIP registration flow ==="
+
+# 1) Create a SIP trunk with sip_registration enabled. The server
+#    generates `incoming_auth_*` credentials and returns them in the
+#    response — they are read-only and stripped from any subsequent
+#    write payload by the SDK.
+puts "\n[1/4] Create with sip_registration enabled..."
+trunk = DIDWW::Client.voice_in_trunks.new(
+  name: "sip-registration-example-#{Time.now.to_i}",
+  priority: 1,
+  weight: 100,
+  cli_format: 'e164',
+  ringing_timeout: 30,
+  configuration: DIDWW::ComplexObject::SipConfiguration.new.tap do |c|
+    c.enabled_sip_registration = true
+    c.use_did_in_ruri = true
+    c.cnam_lookup = false
+    c.codec_ids = [9, 7]
+    c.transport_protocol_id = 1
+  end
+)
+abort "create failed: #{trunk.errors.full_messages.join('; ')}" unless trunk.save
+puts "  id=#{trunk.id}"
+puts "  incoming_auth_username=#{trunk.configuration.incoming_auth_username.inspect}"
+puts "  incoming_auth_password=#{trunk.configuration.incoming_auth_password.inspect}"
+trunk_id = trunk.id
+
+# 2) Rename — a single-field PATCH that doesn't touch SIP-registration state.
+puts "\n[2/4] Rename trunk..."
+trunk.name = "sip-registration-renamed-#{Time.now.to_i}"
+abort "rename failed: #{trunk.errors.full_messages.join('; ')}" unless trunk.save
+puts "  name=#{trunk.name}"
+
+# 3) Disable sip_registration by setting `host`. The SDK flips
+#    `enabled_sip_registration` and `use_did_in_ruri` to false in the
+#    same PATCH so the server-side validators accept the change.
+puts "\n[3/4] Disable by setting host..."
+trunk.configuration = DIDWW::ComplexObject::SipConfiguration.new.tap do |c|
+  c.host = '203.0.113.10'
+end
+abort "disable failed: #{trunk.errors.full_messages.join('; ')}" unless trunk.save
+fresh = DIDWW::Client.voice_in_trunks.find(trunk_id).first
+puts "  enabled_sip_registration=#{fresh.configuration.enabled_sip_registration.inspect}"
+puts "  use_did_in_ruri=#{fresh.configuration.use_did_in_ruri.inspect}"
+puts "  host=#{fresh.configuration.host.inspect}"
+puts "  incoming_auth_username=#{fresh.configuration.incoming_auth_username.inspect}"
+
+# 4) Re-enable sip_registration. Setting `enabled_sip_registration = true`
+#    sends host=nil / port=nil on the wire so the server (which still has
+#    the host from step 3) is told to clear them.
+puts "\n[4/4] Re-enable by toggling enabled_sip_registration..."
+trunk = DIDWW::Client.voice_in_trunks.find(trunk_id).first
+trunk.configuration = DIDWW::ComplexObject::SipConfiguration.new.tap do |c|
+  c.enabled_sip_registration = true
+  c.use_did_in_ruri = true
+end
+abort "re-enable failed: #{trunk.errors.full_messages.join('; ')}" unless trunk.save
+fresh = DIDWW::Client.voice_in_trunks.find(trunk_id).first
+puts "  enabled_sip_registration=#{fresh.configuration.enabled_sip_registration.inspect}"
+puts "  host=#{fresh.configuration.host.inspect}"
+puts "  incoming_auth_username=#{fresh.configuration.incoming_auth_username.inspect}"
+
+puts "\n=== PASS — trunk #{trunk_id} left in sandbox ==="

data/lib/didww/complex_objects/configurations/sip_configuration.rb

@@ -350,12 +350,14 @@ module DIDWW
         def enabled_sip_registration=(val)
           case val
           when true
-            # Clear host/port only if they were already set — never emit a
-            # spurious `host: null` on a fresh config, which would otherwise
-            # widen every PATCH/POST body. If the trunk had a host, we have
-            # to send `host: null` explicitly so the server clears it.
-            self[:host] = nil if attributes.key?('host') && !self[:host].nil?
-            self[:port] = nil if attributes.key?('port') && !self[:port].nil?
+            # Always emit host: null and port: null on the wire when
+            # enabling sip_registration. The server requires both blank
+            # (returns 422 otherwise) AND a PATCH against an existing
+            # trunk that already has host/port set on the server side
+            # MUST explicitly nullify them — the SDK's local attributes
+            # hash starts empty, so there's nothing to "preserve".
+            self[:host] = nil
+            self[:port] = nil
           when false
             # Server requires use_did_in_ruri = false whenever sip_registration
             # is disabled. Always emit it on the wire so the server's check

data/lib/didww/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module DIDWW
-  VERSION = '6.1.0'.freeze
+  VERSION = '6.1.1'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: didww-v3
 version: !ruby/object:Gem::Version
-  version: 6.1.0
+  version: 6.1.1
 platform: ruby
 authors:
 - Alex Korobeinikov
@@ -15,42 +15,48 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '7.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '7.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: faraday-multipart
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: json_api_client
   requirement: !ruby/object:Gem::Requirement
@@ -69,45 +75,46 @@ dependencies:
   name: http
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: down
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: openssl-oaep
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-description: Ruby client for DIDWW API v3
+        version: '0.1'
+description: Ruby client for the DIDWW JSON:API v3, covering DID inventory, voice
+  in/out trunks, regulatory documents, exports, and emergency calling services.
 email:
 - alex.k@didww.com
 executables: []
@@ -158,6 +165,7 @@ files:
 - examples/regions.rb
 - examples/shared_capacity_groups.rb
 - examples/voice_in_trunk_groups.rb
+- examples/voice_in_trunk_sip_registration.rb
 - examples/voice_in_trunks.rb
 - examples/voice_out_trunks.rb
 - lib/didww.rb