didww-v3 5.2.0 → 5.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: df4c6143fca0f8b1f6c6d5c4e43fc89a71a4a9fcc5b63b3b63c3bb9ab03ce102
-  data.tar.gz: dd9ad527373290850d9555f1117aa097aa534497668115fdcbb9dd2f2323f783
+  metadata.gz: c780bc13f7f052f1733482ee69b37994b6bd8c9926a498857947faf23865c8d2
+  data.tar.gz: 22be4b92ea6dd9616dc2e67b77b51b3305876b51b6fed40cba6ce7abb8d015e5
 SHA512:
-  metadata.gz: 32dc4dc452c8ef98f1855ec47aee83cd7959f9abc3c3ade68489610d71600a8bcf1e232cb4a4e3a76ffae9a5b68adb19d133b8788d6d4ba7711dff36141c96b4
-  data.tar.gz: e759ef5119ea80accac264b297e4730f9391e774adc47d7dca853b0c9d79f6c1d2af4a61562e849af04c4a4ba476213a18696a9e88c7f8ee92b811c68059a09e
+  metadata.gz: 0c80b1331067374890afec7505eeff625af09f4c36d6e093585483005091c56db11cfd36a4a6ba62547c3e3a300d9b7acc37d78502c8db45f8a91f6cf86c9b83
+  data.tar.gz: 549b86aadb2a060b2ed3ae5f84e4d9f0140c012080087ee84b7feb800137957b0726f39c347a1574ea1109e09e8d39b875b2f416389e8633f4cd008f092ca44a

data/CHANGELOG.md

@@ -4,6 +4,47 @@ 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).
 
+## [5.3.0]
+### Added
+- `DIDWW::Client.customize_connection` to allow customizing the Faraday connection (e.g. proxy, timeouts, custom middleware).
+
+## [5.2.0]
+### Changes
+- Extract status predicate methods into `HasStatusHelpers` concern.
+- Merge shared auth header logic into `BaseMiddleware`, `JsonapiMiddleware` inherits and adds `Content-Type`.
+- Replace 29 resource accessor methods with `RESOURCE_CLASSES` hash and `define_method`.
+- Document date and datetime field types in README.
+
+### Fixed
+- Fix date type attributes: use `:time` for ISO 8601 timestamps.
+- Add missing resource fields: `reference`, `permanent`, `iso`, `contact_email`.
+- Add `requirement` relationship to `DidGroup`.
+- Skip `Api-Key` header on `public_keys` endpoint.
+- Add `User-Agent` header to export download.
+- Use timing-safe comparison for callback signature validation.
+- Fix `is_expired` boolean changed to `expires_at` date on `Proof`.
+
+## [5.1.0]
+### Added
+- `X-DIDWW-API-Version` header sent with requests.
+- Exclusive relationship auto-nullification for DID `voice_in_trunk`/`voice_in_trunk_group`.
+- Export gzip decompression support (`.csv.gz`).
+- `VoiceOutTrunk` CRUD tests and fixtures.
+
+### Changes
+- Rename test fixtures from `sample_N` to self-descriptive names.
+
+## [5.0.0]
+### Breaking Changes
+- Remove H323 and IAX2 trunk configuration support.
+- Update dependencies and CI for current Ruby/Rails versions.
+
+### Added
+- Add missing relationship declarations and tests for included resources.
+
+### Fixed
+- Fix compatibility with `json_api_client` 1.23.0 and newer Ruby.
+
 ## [4.1.0]
 ### Breaking Changes
 - removed DIDWW::Resource::DidGroup::FEATURE_VOICE in favor DIDWW::Resource::DidGroup::FEATURE_VOICE_IN and DIDWW::Resource::DidGroup::FEATURE_VOICE_OUT [#42](https://github.com/didww/didww-v3-ruby/pull/42)

data/README.md

@@ -100,6 +100,36 @@ end
 | `:production` | `https://api.didww.com/v3/` |
 | `:sandbox` | `https://sandbox-api.didww.com/v3/` |
 
+### Connection Customization
+
+Use `customize_connection` to customize the underlying Faraday connection, for example to configure a proxy or add custom middleware:
+
+```ruby
+# Using a proxy
+DIDWW::Client.configure do |config|
+  config.api_key  = 'YOUR_API_KEY'
+  config.api_mode = :production
+  config.customize_connection do |conn|
+    # conn is a JsonApiClient::Connection instance
+    conn.faraday.proxy = 'http://proxy.example.com:8080'
+  end
+end
+```
+
+```ruby
+# Adding custom middleware and timeouts
+DIDWW::Client.configure do |config|
+  config.api_key  = 'YOUR_API_KEY'
+  config.api_mode = :production
+  config.customize_connection do |conn|
+    # conn is a JsonApiClient::Connection instance
+    conn.use MyCustomMiddleware
+    conn.faraday.options.timeout = 30
+    conn.faraday.options.open_timeout = 10
+  end
+end
+```
+
 ### API Version
 
 The SDK sends `X-DIDWW-API-Version: 2022-05-10` by default. You can override it per block:

data/lib/didww/client.rb

@@ -14,10 +14,14 @@ module DIDWW
     DEFAULT_MODE = :sandbox
     DEFAULT_API_VERSION = '2022-05-10'
 
-    mattr_accessor :api_key, :api_mode, :http_verbose, :api_version
+    mattr_accessor :api_key, :api_mode, :http_verbose, :api_version, :_customize_conn_block
     self.api_version = DEFAULT_API_VERSION
 
     class << self
+      def customize_connection(&block)
+        self._customize_conn_block = block
+      end
+
       def configure
         yield self if block_given?
         connect!
@@ -107,6 +111,7 @@ module DIDWW
         DIDWW::Resource::Base.connection do |connection|
           connection.use Faraday::Response::Logger if http_verbose?
           connection.use DIDWW::JsonapiMiddleware
+          _customize_conn_block.call(connection) if _customize_conn_block
         end
         JsonApiClient::Paginating::Paginator.page_param = 'number'
         JsonApiClient::Paginating::Paginator.per_page_param = 'size'

data/lib/didww/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: didww-v3
 version: !ruby/object:Gem::Version
-  version: 5.2.0
+  version: 5.3.0
 platform: ruby
 authors:
 - Alex Korobeinikov
@@ -211,7 +211,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.7.1
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Ruby client for DIDWW API v3
 test_files: []