didww-v3 4.1.0 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c311027f0ab58fdac3f8cd0558485659e23a623c1eec3065369e7a2a44bcad3b
-  data.tar.gz: 6f64fd27e3f51c0c77a3102f7efcdbc1d62d0aecc7b3b83eb233d4c385bbeb10
+  metadata.gz: 22a712d25c5bdfa402c73df24b8529f0e001e97256cf7d84cdfbb8d492af4dcd
+  data.tar.gz: f3fdb4186c6821dd1d9c93744515e0a3eb6d0d1b3da3c1da4d0449dd8d726512
 SHA512:
-  metadata.gz: cb9c3864d94db9f49eac0324b695d44a56bf5387816c53203bea979c7a705f2e8a348559b0804151c34bd080e55ccef149e62e1738030e87f69ceda4aa5d96d1
-  data.tar.gz: cb964ac512ecc7a75083e9be7373529c754fc3b9d6809eae7e420726d8f7a4f7a7504f7aa414da352a9ff8f8bba0c2949149d73c1bc492311e0e065bc8347b71
+  metadata.gz: de07093d853e4576ea5e18552786f3bb88d3013456a75f2efdaae56a3dbbb2560384d11bd22d1cd42f3cd739c0baf531e190dc70e700fba23bd46e3309861d16
+  data.tar.gz: 2a434cb0c3a17840b8b7490b45078f66bb835f5656241fb98a6f629f6c7ee7305cfe6015366c7b9fbfb47233c02dbfe3292e0408deaf8f80e116b089524f5c0c

data/.github/workflows/codespell.yml

@@ -15,7 +15,7 @@ jobs:
 
     steps:
       - name: Checkout code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
 
       - name: Install codespell
         run: |

data/.github/workflows/tests.yml

@@ -4,25 +4,22 @@ on:
   push:
     branches:
       - master
-  schedule:
-    - cron: "0 9 * * *"
 
 jobs:
   test:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby: [ '2.7', '3.0', '3.1', '3.2' ]
-        rails: [ '~> 6.0', '~> 6.1', '~> 7.0' ]
+        ruby: [ '3.3', '3.4' ]
+        rails: [ '~> 7.2', '~> 8.0', '~> 8.1' ]
     name: Tests with Ruby ${{ matrix.ruby }} Activesupport ${{ matrix.rails }}
     env:
       RAILS_VERSION: ${{ matrix.rails }}
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
       - name: Run tests
-        run: |
-          bundle install
-          bundle exec rake
+        run: bundle exec rake

data/.rubocop.yml

@@ -10,6 +10,7 @@ AllCops:
 
   Exclude:
     - db/migrate/**/*
+    - vendor/**/*
 
 ##################### Layout ##################################
 Layout/TrailingEmptyLines:

data/Gemfile

@@ -10,13 +10,13 @@ if ENV['RAILS_VERSION']
   gem 'activesupport', ENV['RAILS_VERSION'], require: false
 end
 
-gem 'rake', '~> 12.0'
+gem 'rake', '~> 13.0'
 gem 'rspec', '~> 3.0'
 gem 'pry'
-gem 'byebug'
+gem 'debug'
 gem 'awesome_print'
 gem 'http_logger'
-gem 'rubocop', '~> 1.28.2'
+gem 'rubocop', '~> 1.50'
 gem 'rubocop-performance'
 gem 'rubocop-rake'
 gem 'rubocop-rspec'

data/README.md

@@ -53,6 +53,10 @@ For details on obtaining your API key please visit https://doc.didww.com/api#int
 
 See integration example at https://github.com/didww/didww-v3-rails-sample
 
+## Resource Relationships
+
+See [docs/resource_relationships.md](docs/resource_relationships.md) for a Mermaid ER diagram showing all `has_one`, `has_many`, and `belongs_to` relationships between resources.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/didww-v3.gemspec

@@ -22,9 +22,11 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
+  spec.required_ruby_version = '>= 3.3'
+
   spec.add_dependency 'activesupport'
   spec.add_dependency 'faraday'
-  spec.add_dependency 'json_api_client', '1.18.0'
+  spec.add_dependency 'json_api_client', '1.23.0'
   spec.add_dependency 'http'
   spec.add_dependency 'down'
   spec.add_dependency 'openssl-oaep'

data/docs/resource_relationships.md

@@ -0,0 +1,138 @@
+# Resource Relationships
+
+This diagram shows all `has_one`, `has_many`, and `belongs_to` relationships between DIDWW API v3 resources.
+
+**Legend:**
+- `||--o|` — has_one (one-to-zero-or-one)
+- `||--o{` — has_many (one-to-many)
+- `}o--||` — belongs_to (many-to-one)
+
+```mermaid
+erDiagram
+    Address ||--o| Identity : "has_one identity"
+    Address ||--o| Country : "has_one country"
+    Address ||--o{ Proof : "has_many proofs"
+    Address ||--o{ City : "has_many city"
+    Address ||--o{ Area : "has_many area"
+
+    AddressVerification ||--o| Address : "has_one address"
+    AddressVerification ||--o{ Did : "has_many dids"
+    AddressVerification ||--o{ EncryptedFile : "has_many onetime_files"
+
+    Area ||--o| Country : "has_one country"
+
+    AvailableDid ||--o| DidGroup : "has_one did_group"
+    AvailableDid ||--o| NanpaPrefix : "has_one nanpa_prefix"
+
+    CapacityPool ||--o{ Country : "has_many countries"
+    CapacityPool ||--o{ SharedCapacityGroup : "has_many shared_capacity_groups"
+    CapacityPool ||--o{ QtyBasedPricing : "has_many qty_based_pricings"
+
+    City ||--o| Country : "has_one country"
+    City ||--o| Region : "has_one region"
+    City ||--o| Area : "has_one area"
+
+    Country ||--o{ Region : "has_many regions"
+
+    Did ||--o| DidGroup : "has_one did_group"
+    Did ||--o| Order : "has_one order"
+    Did ||--o| VoiceInTrunk : "has_one voice_in_trunk"
+    Did ||--o| VoiceInTrunkGroup : "has_one voice_in_trunk_group"
+    Did ||--o| CapacityPool : "has_one capacity_pool"
+    Did ||--o| SharedCapacityGroup : "has_one shared_capacity_group"
+    Did ||--o| AddressVerification : "has_one address_verification"
+
+    DidGroup ||--o| Country : "has_one country"
+    DidGroup ||--o| City : "has_one city"
+    DidGroup ||--o| DidGroupType : "has_one did_group_type"
+    DidGroup ||--o| Region : "has_one region"
+    DidGroup ||--o{ StockKeepingUnit : "has_many stock_keeping_units"
+
+    DidReservation ||--o| AvailableDid : "has_one available_did"
+
+    Identity ||--o| Country : "has_one country"
+    Identity ||--o{ Proof : "has_many proofs"
+    Identity ||--o{ Address : "has_many addresses"
+    Identity ||--o{ PermanentSupportingDocument : "has_many permanent_documents"
+
+    NanpaPrefix ||--o| Country : "has_one country"
+    NanpaPrefix ||--o| Region : "has_one region"
+
+    PermanentSupportingDocument ||--o| SupportingDocumentTemplate : "has_one template"
+    PermanentSupportingDocument ||--o| Identity : "has_one identity"
+    PermanentSupportingDocument ||--o{ EncryptedFile : "has_many files"
+
+    Proof ||--o| ProofType : "has_one proof_type"
+    Proof ||--o{ EncryptedFile : "has_many files"
+
+    QtyBasedPricing }o--|| CapacityPool : "belongs_to capacity_pool"
+
+    Region ||--o| Country : "has_one country"
+
+    Requirement ||--o| Country : "has_one country"
+    Requirement ||--o| DidGroupType : "has_one did_group_type"
+    Requirement ||--o| SupportingDocumentTemplate : "has_one personal_permanent_document"
+    Requirement ||--o| SupportingDocumentTemplate : "has_one business_permanent_document"
+    Requirement ||--o| SupportingDocumentTemplate : "has_one personal_onetime_document"
+    Requirement ||--o| SupportingDocumentTemplate : "has_one business_onetime_document"
+    Requirement ||--o{ ProofType : "has_many personal_proof_types"
+    Requirement ||--o{ ProofType : "has_many business_proof_types"
+    Requirement ||--o{ ProofType : "has_many address_proof_types"
+
+    RequirementValidation ||--o| Requirement : "has_one requirement"
+    RequirementValidation ||--o| Address : "has_one address"
+    RequirementValidation ||--o| Identity : "has_one identity"
+
+    SharedCapacityGroup ||--o| CapacityPool : "has_one capacity_pool"
+    SharedCapacityGroup ||--o{ Did : "has_many dids"
+
+    StockKeepingUnit }o--|| DidGroup : "belongs_to did_group"
+
+    VoiceInTrunk ||--o| Pop : "has_one pop"
+    VoiceInTrunk ||--o| VoiceInTrunkGroup : "has_one voice_in_trunk_group"
+
+    VoiceInTrunkGroup ||--o{ VoiceInTrunk : "has_many voice_in_trunks"
+
+    VoiceOutTrunk ||--o| Did : "has_one default_did"
+    VoiceOutTrunk ||--o{ Did : "has_many dids"
+
+    VoiceOutTrunkRegenerateCredential ||--o| VoiceOutTrunk : "has_one voice_out_trunk"
+```
+
+## Resource Summary
+
+| Resource | has_one | has_many | belongs_to |
+|----------|---------|----------|------------|
+| Address | identity, country | proofs, city, area | — |
+| AddressVerification | address | dids, onetime_files | — |
+| Area | country | — | — |
+| AvailableDid | did_group, nanpa_prefix | — | — |
+| Balance | — | — | — |
+| CapacityPool | — | countries, shared_capacity_groups, qty_based_pricings | — |
+| City | country, region, area | — | — |
+| Country | — | regions | — |
+| Did | did_group, order, voice_in_trunk, voice_in_trunk_group, capacity_pool, shared_capacity_group, address_verification | — | — |
+| DidGroup | country, city, did_group_type, region | stock_keeping_units | — |
+| DidGroupType | — | — | — |
+| DidReservation | available_did | — | — |
+| EncryptedFile | — | — | — |
+| Export | — | — | — |
+| Identity | country | proofs, addresses, permanent_documents | — |
+| NanpaPrefix | country, region | — | — |
+| Order | — | — | — |
+| PermanentSupportingDocument | template, identity | files | — |
+| Pop | — | — | — |
+| Proof | proof_type | files | — |
+| ProofType | — | — | — |
+| PublicKey | — | — | — |
+| QtyBasedPricing | — | — | capacity_pool |
+| Region | country | — | — |
+| Requirement | country, did_group_type, personal_permanent_document, business_permanent_document, personal_onetime_document, business_onetime_document | personal_proof_types, business_proof_types, address_proof_types | — |
+| RequirementValidation | requirement, address, identity | — | — |
+| SharedCapacityGroup | capacity_pool | dids | — |
+| StockKeepingUnit | — | — | did_group |
+| SupportingDocumentTemplate | — | — | — |
+| VoiceInTrunk | pop, voice_in_trunk_group | — | — |
+| VoiceInTrunkGroup | — | voice_in_trunks | — |
+| VoiceOutTrunk | default_did | dids | — |
+| VoiceOutTrunkRegenerateCredential | voice_out_trunk | — | — |

data/lib/didww/complex_objects/configurations.rb

@@ -1,9 +1,7 @@
 # frozen_string_literal: true
 require 'didww/complex_objects/configurations/base'
 require 'didww/complex_objects/configurations/sip_configuration'
-require 'didww/complex_objects/configurations/iax2_configuration'
 require 'didww/complex_objects/configurations/pstn_configuration'
-require 'didww/complex_objects/configurations/h323_configuration'
 
 module DIDWW
   module ComplexObject

data/lib/didww/encrypt.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+require 'base64'
 require 'openssl'
 require 'openssl/oaep'
 require 'net/http'

data/lib/didww/resource/capacity_pool.rb

@@ -2,9 +2,9 @@
 module DIDWW
   module Resource
     class CapacityPool < Base
-      has_many :countries, class: 'Country'
-      has_many :shared_capacity_groups, class: 'SharedCapacityGroup'
-      has_many :qty_based_pricings, class: 'QtyBasedPricing'
+      has_many :countries, class_name: 'Country'
+      has_many :shared_capacity_groups, class_name: 'SharedCapacityGroup'
+      has_many :qty_based_pricings, class_name: 'QtyBasedPricing'
 
       property :name, type: :string
       # Type: String

data/lib/didww/resource/country.rb

@@ -2,6 +2,8 @@
 module DIDWW
   module Resource
     class Country < Base
+      has_many :regions, class_name: 'Region'
+
       property :name, type: :string
       # Type: String
       # Description: Country name

data/lib/didww/resource/did.rb

@@ -2,6 +2,8 @@
 module DIDWW
   module Resource
     class Did < Base
+      has_one :did_group
+      has_one :order
       has_one :voice_in_trunk
       has_one :voice_in_trunk_group
       has_one :capacity_pool

data/lib/didww/resource/did_group.rb

@@ -17,8 +17,11 @@ module DIDWW
         FEATURE_OUT_SMS => 'SMS OUT'
       }.freeze
 
-      has_one :country, class: Country
-      has_one :city,    class: City
+      has_one :country, class_name: 'Country'
+      has_one :city,    class_name: 'City'
+      has_one :did_group_type, class_name: 'DidGroupType'
+      has_one :region, class_name: 'Region'
+      has_many :stock_keeping_units, class_name: 'StockKeepingUnit'
 
       property :area_name, type: :string
       # Type: String

data/lib/didww/resource/region.rb

@@ -2,6 +2,8 @@
 module DIDWW
   module Resource
     class Region < Base
+      has_one :country, class_name: 'Country'
+
       property :name, type: :string
       # Type: String
       # Description: Region name

data/lib/didww/resource/shared_capacity_group.rb

@@ -2,9 +2,9 @@
 module DIDWW
   module Resource
     class SharedCapacityGroup < Base
-      has_one :capacity_pool, class: 'CapacityPool'
+      has_one :capacity_pool, class_name: 'CapacityPool'
 
-      has_many :dids, class: 'Did'
+      has_many :dids, class_name: 'Did'
 
       property :name, type: :string
       # Type: String

data/lib/didww/resource/voice_in_trunk.rb

@@ -17,21 +17,15 @@ module DIDWW
 
       # Configuration types
       CONF_TYPE_SIP     = 'sip_configurations'
-      CONF_TYPE_H323    = 'h323_configurations'
-      CONF_TYPE_IAX2    = 'iax2_configurations'
       CONF_TYPE_PSTN    = 'pstn_configurations'
 
       CONF_TYPES = {
                      CONF_TYPE_SIP   => 'SIP',
-                     CONF_TYPE_H323  => 'H323',
-                     CONF_TYPE_IAX2  => 'IAX2',
                      CONF_TYPE_PSTN  => 'PSTN'
                    }.freeze
 
       CONF_TYPE_CLASSES = {
                             CONF_TYPE_SIP   => DIDWW::ComplexObject::SipConfiguration,
-                            CONF_TYPE_H323  => DIDWW::ComplexObject::H323Configuration,
-                            CONF_TYPE_IAX2  => DIDWW::ComplexObject::Iax2Configuration,
                             CONF_TYPE_PSTN  => DIDWW::ComplexObject::PstnConfiguration
                           }.freeze
 
@@ -78,8 +72,6 @@ module DIDWW
       # Type: one of
       # sip_configurations
       # pstn_configurations
-      # iax2_configurations
-      # h323_configurations
       # Description: Trunk configuration complex object
 
       property :created_at, type: :time

data/lib/didww/resource/voice_out_trunk.rb

@@ -63,6 +63,7 @@ module DIDWW
       property :force_symmetric_rtp, type: :boolean
       property :allowed_rtp_ips, type: :ip_addresses
 
+      has_one :default_did, class_name: 'Did'
       has_many :dids
 
       def regenerate_credentials

data/lib/didww/version.rb

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

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: didww-v3
 version: !ruby/object:Gem::Version
-  version: 4.1.0
+  version: 5.0.0
 platform: ruby
 authors:
 - Alex Korobeinikov
-autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-05-26 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -44,14 +43,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.18.0
+        version: 1.23.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.18.0
+        version: 1.23.0
 - !ruby/object:Gem::Dependency
   name: http
   requirement: !ruby/object:Gem::Requirement
@@ -116,6 +115,7 @@ files:
 - bin/setup
 - codespell_ignore_words.txt
 - didww-v3.gemspec
+- docs/resource_relationships.md
 - lib/didww.rb
 - lib/didww/base_middleware.rb
 - lib/didww/callback/const.rb
@@ -125,8 +125,6 @@ files:
 - lib/didww/complex_objects/capacity_order_item.rb
 - lib/didww/complex_objects/configurations.rb
 - lib/didww/complex_objects/configurations/base.rb
-- lib/didww/complex_objects/configurations/h323_configuration.rb
-- lib/didww/complex_objects/configurations/iax2_configuration.rb
 - lib/didww/complex_objects/configurations/pstn_configuration.rb
 - lib/didww/complex_objects/configurations/sip_configuration.rb
 - lib/didww/complex_objects/did_order_item.rb
@@ -175,7 +173,6 @@ homepage: https://github.com/didww/didww-v3-ruby
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -183,16 +180,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6.2
-signing_key: 
+rubygems_version: 4.0.4
 specification_version: 4
 summary: Ruby client for DIDWW API v3
 test_files: []

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

@@ -1,36 +0,0 @@
-# frozen_string_literal: true
-module DIDWW
-  module ComplexObject
-    module Configuration
-      class H323Configuration < Base
-        property :dst, type: :string
-        # Type: String
-        # Nullable: No
-        # Description: Phone number
-
-        property :host, type: :string
-        # Type: String
-        # Nullable: No
-        # Description: Destination server
-
-        property :port, type: :string
-        # Type: String
-        # Nullable: No
-        # Description: Destination port
-
-        property :codec_ids, type: :array
-        # TODO array type
-        # Type: Array
-        # Nullable: No
-        # Description:
-
-        DEFAULTS = {
-          codec_ids: DEFAULT_CODEC_IDS,
-          dst: DID_PLACEHOLDER,
-        }.freeze
-
-        RECOMMENDED = {}.freeze
-      end
-    end
-  end
-end

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

@@ -1,46 +0,0 @@
-# frozen_string_literal: true
-module DIDWW
-  module ComplexObject
-    module Configuration
-      class Iax2Configuration < Base
-        property :dst, type: :string
-        # Type: String
-        # Nullable: No
-        # Description: Phone number
-
-        property :host, type: :string
-        # Type: String
-        # Nullable: No
-        # Description: Destination server
-
-        property :port, type: :string
-        # Type: String
-        # Nullable: No
-        # Description: Destination port
-
-        property :auth_user, type: :string
-        # Type: String
-        # Nullable: No
-        # Description: Optional authorization user
-
-        property :auth_password, type: :string
-        # Type: String
-        # Nullable: No
-        # Description: Optional authorization password
-
-        property :codec_ids, type: :array
-        # TODO array type
-        # Type: Array
-        # Nullable: No
-        # Description:
-
-        DEFAULTS = {
-          codec_ids: DEFAULT_CODEC_IDS,
-          dst: DID_PLACEHOLDER,
-        }.freeze
-
-        RECOMMENDED = {}.freeze
-      end
-    end
-  end
-end