didww-v3 2.0.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9d736e9893b21ef96ef76993d6bb3da3e47c1dbb760edcc6ea13d0cf86d5e847
-  data.tar.gz: 9d641935ce36af938ea6641b7488835535ef4a01f6464b5c90f667dafac953c3
+  metadata.gz: 3033b22b339631f852f135fcc40650102feab555bcb153072f64d73d03092eac
+  data.tar.gz: c9f1c20a485a40539f8034bc8cc8ba160ee26538b7585ffe2ed3e9bd3c0137e6
 SHA512:
-  metadata.gz: b2cef4993cda70bd45a3a1efd960ab26d9ba603de9a10c246c537ccdbbb3506e923f1628643fabcefcc7be8ca1f9a6a93342b996e6233b9eadadc77818d766fe
-  data.tar.gz: de556881b793c412ea2fb486bacd00f89a3c07ad3902e755f5a4140e2eb0fda10f1b748ea719ce9968e87e476797bed8b28ce3b032f1e107ed457946235f303f
+  metadata.gz: 4864de1d500e14be418849cfd3e9fb7d4ec3becbf2678972ff667afe587123893e12ad08e3030ad329f215ce70a9b902e31f422b87c883062c9c2f944d8a76d4
+  data.tar.gz: fd3651c1410f7d67148b79a5219d068a7c9304f6e497fd1455337229f8c5d0867d294932c35f5a63768c633e4ac5abc8d3cb80f74a3be724403a1ac3d574b9ae

data/CHANGELOG.md

@@ -4,6 +4,28 @@ 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).
 
+## [3.0.0]
+### Breaking Changes
+- /v3/trunks being moved to /v3/voice_in_trunks.
+- /v3/trunk_groups being moved to /v3/voice_in_trunk_groups.
+- /v3/cdr_exports being moved to /v3/exports. Endpoint now allows generating both inbound and outbound CDRs export.
+- /v3/exports result file will be CSV archived in GZIP.
+- Callbacks payload for exports being changed: value of type attribute is changed to exports.
+- /v3/exports export_type required attribute being added to request and response with possible values: cdr_in, cdr_out.
+- /v3/exports filters attribute being removed from response.
+- /v3/did_groups filter features allowed values to be changed to sms_in, sms_out, voice_in, voice_out, t38.
+- /v3/did_groups response value of features attribute to be changed to sms_in, sms_out, voice_in, voice_out, t38.
+- /v3/available_dids filter did_group.features allowed values being changed to sms_in, sms_out, voice_in, voice_out, t38.
+- /v3/dids rename trunk_group relationship to voice_in_trunk_group with type voice_in_trunk_groups.
+- /v3/dids rename trunks relationship to voice_in_trunks with type voice_in_trunks.
+
+### Changes
+- /v3/voice_out_trunks endpoints being added.
+- /v3/voice_out_trunk_regenerate_credentials endpoint being added.
+- /v3/voice_in_trunks SIP configuration additional attributes being added to request and response: media_encryption_mode, stir_shaken_mode, allowed_rtp_ips.
+- /v3/dids filter add filter did_group.features with allowed values: sms_in, sms_out, voice_in, voice_out, t38.
+- Callbacks allow receiving events about /v3/voice_out_trunks status change.
+
 ## [2.0.0] - 2021-10-26
 ### Breaking Changes
 - upgrade `json_api_client` version to `1.18.0` [#9](https://github.com/didww/didww-v3-ruby/pull/9)  

data/README.md

@@ -1,6 +1,7 @@
 Ruby client for DIDWW API v3.
 
 ![Tests](https://github.com/didww/didww-v3-ruby/workflows/Tests/badge.svg)
+[![Gem Version](https://badge.fury.io/rb/didww-v3.svg)](https://badge.fury.io/rb/didww-v3)
 
 About DIDWW API v3
 -----
@@ -11,9 +12,9 @@ The DIDWW API v3 is a fully compliant implementation of the [JSON API specificat
 
 Read more https://doc.didww.com/api
 
-Gem Versions **2.X.X** are intended to use with DIDWW API 3 version [2021-04-19](https://doc.didww.com/api3/2021-04-19/index.html).
+Gem Versions **2.X.X** and branch [master](https://github.com/didww/didww-v3-ruby) are intended to use with DIDWW API 3 version [2021-04-19](https://doc.didww.com/api3/2021-04-19/index.html).
 
-Gem Versions **1.X.X** are intended to use with DIDWW API 3 version [2017-09-18](https://doc.didww.com/api3/2017-09-18/index.html).
+Gem Versions **1.X.X** and branch [release-1](https://github.com/didww/didww-v3-ruby/tree/release-1) are intended to use with DIDWW API 3 version [2017-09-18](https://doc.didww.com/api3/2017-09-18/index.html).
 
 ## Installation
 

data/lib/didww/callback/const.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module DIDWW
+  module Callback
+    module CONST
+      CALLBACK_METHOD_POST = 'POST'
+      CALLBACK_METHOD_GET = 'GET'
+      CALLBACK_METHODS = [
+                           CALLBACK_METHOD_GET,
+                           CALLBACK_METHOD_POST
+                         ].freeze
+    end
+  end
+end

data/lib/didww/callback/request_validator.rb

@@ -37,14 +37,23 @@ module DIDWW
       private
 
       # @param url [String]
-      # @param payload [Hash]
+      # @param payload [Hash,Array]
       # @return [String] generated signature in URL safe format.
       def valid_signature(url, payload)
-        normalized_url = normalize_url(url)
-        data = normalized_url + payload.sort.join
+        data = normalize_url(url) + normalize_payload(payload)
         OpenSSL::HMAC.hexdigest(DIGEST_ALGO, @api_key, data)
       end
 
+      # @param payload [Hash,Array]
+      # @return [String] normalized payload.
+      def normalize_payload(payload)
+        if payload.is_a?(Hash)
+          payload.sort.join
+        else
+          payload.map { |item| item.sort.join }.join
+        end
+      end
+
       # @return [String] normalized URL.
       def normalize_url(url)
         parsed_url = URI ensure_protocol_url(url)

data/lib/didww/client.rb

@@ -3,13 +3,13 @@ require 'active_support/core_ext/module/attribute_accessors'
 require 'active_support/core_ext/object/blank'
 require 'json_api_client'
 
-require 'didww/resources/base'
+require 'didww/resource/base'
 
 module DIDWW
   module Client
     BASE_URLS = {
       sandbox:    'https://sandbox-api.didww.com/v3/'         .freeze,
-      production: 'https://api.didww.com/v3/'                 .freeze
+      production: 'https://sandbox-api.didww.com/v3/'                 .freeze
     }.freeze
     DEFAULT_MODE = :sandbox
 
@@ -55,8 +55,8 @@ module DIDWW
         Resource::CapacityPool
       end
 
-      def cdr_exports
-        Resource::CdrExport
+      def exports
+        Resource::Export
       end
 
       def shared_capacity_groups
@@ -95,12 +95,16 @@ module DIDWW
         Resource::Region
       end
 
-      def trunk_groups
-        Resource::TrunkGroup
+      def voice_in_trunk_groups
+        Resource::VoiceInTrunkGroup
       end
 
-      def trunks
-        Resource::Trunk
+      def voice_in_trunks
+        Resource::VoiceInTrunk
+      end
+
+      def voice_out_trunks
+        Resource::VoiceOutTrunk
       end
 
       def available_dids
@@ -167,36 +171,38 @@ module DIDWW
       end
 
       def require_didww_resources
-        require 'didww/resources/balance'
-        require 'didww/resources/capacity_pool'
-        require 'didww/resources/cdr_export'
-        require 'didww/resources/shared_capacity_group'
-        require 'didww/resources/city'
-        require 'didww/resources/country'
-        require 'didww/resources/did_group_type'
-        require 'didww/resources/did_group'
-        require 'didww/resources/did'
-        require 'didww/resources/order'
-        require 'didww/resources/pop'
-        require 'didww/resources/qty_based_pricing'
-        require 'didww/resources/region'
-        require 'didww/resources/stock_keeping_unit'
-        require 'didww/resources/trunk_group'
-        require 'didww/resources/trunk'
-        require 'didww/resources/available_did'
-        require 'didww/resources/did_reservation'
-        require 'didww/resources/requirement'
-        require 'didww/resources/proof_type'
-        require 'didww/resources/supporting_document_template'
-        require 'didww/resources/identity'
-        require 'didww/resources/proof'
-        require 'didww/resources/address'
-        require 'didww/resources/permanent_supporting_document'
-        require 'didww/resources/encrypted_file'
-        require 'didww/resources/address_verification'
-        require 'didww/resources/requirement_validation'
-        require 'didww/resources/public_key'
-        require 'didww/resources/area'
+        require 'didww/resource/balance'
+        require 'didww/resource/capacity_pool'
+        require 'didww/resource/export'
+        require 'didww/resource/shared_capacity_group'
+        require 'didww/resource/city'
+        require 'didww/resource/country'
+        require 'didww/resource/did_group_type'
+        require 'didww/resource/did_group'
+        require 'didww/resource/did'
+        require 'didww/resource/order'
+        require 'didww/resource/pop'
+        require 'didww/resource/qty_based_pricing'
+        require 'didww/resource/region'
+        require 'didww/resource/stock_keeping_unit'
+        require 'didww/resource/voice_in_trunk_group'
+        require 'didww/resource/voice_in_trunk'
+        require 'didww/resource/available_did'
+        require 'didww/resource/did_reservation'
+        require 'didww/resource/requirement'
+        require 'didww/resource/proof_type'
+        require 'didww/resource/supporting_document_template'
+        require 'didww/resource/identity'
+        require 'didww/resource/proof'
+        require 'didww/resource/address'
+        require 'didww/resource/permanent_supporting_document'
+        require 'didww/resource/encrypted_file'
+        require 'didww/resource/address_verification'
+        require 'didww/resource/requirement_validation'
+        require 'didww/resource/public_key'
+        require 'didww/resource/area'
+        require 'didww/resource/voice_out_trunk'
+        require 'didww/resource/voice_out_trunk_regenerate_credential'
       end
 
     end

data/lib/didww/complex_objects/base.rb

@@ -12,7 +12,7 @@ module DIDWW
         end
 
         def property(name, options = {})
-          property = schema.add(name, options)
+          schema.add(name, options)
           define_method(name.to_sym) { self[name] }
           define_method("#{name}=".to_sym) { |val| self[name] = val }
         end
@@ -88,5 +88,3 @@ module DIDWW
     end
   end
 end
-
-JsonApiClient::Schema.register complex_object: DIDWW::ComplexObject::Base

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

@@ -1,11 +1,151 @@
 # frozen_string_literal: true
-require 'didww/complex_objects/configurations/const'
 
 module DIDWW
   module ComplexObject
     module Configuration
       class Base < ComplexObject::Base
-        include CONST
+        RX_DTMF_FORMATS = {
+                            1 => 'RFC 2833',
+                            2 => 'SIP INFO application/dtmf-relay OR application/dtmf',
+                            3 => 'RFC 2833 OR SIP INFO'
+                          }.freeze
+
+        TX_DTMF_FORMATS = {
+                            0 => 'Disable sending',
+                            1 => 'RFC 2833',
+                            2 => 'SIP INFO application/dtmf-relay',
+                            4 => 'SIP INFO application/dtmf'
+                          }.freeze
+
+        SST_REFRESH_METHODS = {
+                                1 => 'Invite',
+                                2 => 'Update',
+                                3 => 'Update fallback Invite'
+                              }.freeze
+
+        TRANSPORT_PROTOCOLS = {
+                                1 => 'UDP',
+                                2 => 'TCP',
+                                3 => 'TLS'
+                              }.freeze
+
+        REROUTING_DISCONNECT_CODES = {
+                                       56 => '400 | Bad Request',
+                                       57 => '401 | Unauthorized',
+                                       58 => '402 | Payment Required',
+                                       59 => '403 | Forbidden',
+                                       60 => '404 | Not Found',
+                                       64 => '408 | Request Timeout',
+                                       65 => '409 | Conflict',
+                                       66 => '410 | Gone',
+                                       67 => '412 | Conditional Request Failed',
+                                       68 => '413 | Request Entity Too Large',
+                                       69 => '414 | Request-URI Too Long',
+                                       70 => '415 | Unsupported Media Type',
+                                       71 => '416 | Unsupported URI Scheme',
+                                       72 => '417 | Unknown Resource-Priority',
+                                       73 => '420 | Bad Extension',
+                                       74 => '421 | Extension Required',
+                                       75 => '422 | Session Interval Too Small',
+                                       76 => '423 | Interval Too Brief',
+                                       77 => '424 | Bad Location Information',
+                                       78 => '428 | Use Identity Header',
+                                       79 => '429 | Provide Referrer Identity',
+                                       80 => '433 | Anonymity Disallowed',
+                                       81 => '436 | Bad Identity-Info',
+                                       82 => '437 | Unsupported Certificate',
+                                       83 => '438 | Invalid Identity Header',
+                                       84 => '480 | Temporarily Unavailable',
+                                       86 => '482 | Loop Detected',
+                                       87 => '483 | Too Many Hops',
+                                       88 => '484 | Address Incomplete',
+                                       89 => '485 | Ambiguous',
+                                       90 => '486 | Busy Here',
+                                       91 => '487 | Request Terminated',
+                                       92 => '488 | Not Acceptable Here',
+                                       96 => '494 | Security Agreement Required',
+                                       97 => '500 | Server Internal Error',
+                                       98 => '501 | Not Implemented',
+                                       99 => '502 | Bad Gateway',
+                                       100 => '503 | Service Unavailable',
+                                       101 => '504 | Server Time-out',
+                                       102 => '505 | Version Not Supported',
+                                       103 => '513 | Message Too Large',
+                                       104 => '580 | Precondition Failure',
+                                       105 => '600 | Busy Everywhere',
+                                       106 => '603 | Decline',
+                                       107 => '604 | Does Not Exist Anywhere',
+                                       108 => '606 | Not Acceptable',
+                                       1505 => 'Ringing timeout'
+                                     }.freeze
+
+        CODECS = {
+                   6 => 'telephone-event',
+                   7 => 'G723',
+                   8 => 'G729',
+                   9 => 'PCMU',
+                   10 => 'PCMA',
+                   12 => 'speex',
+                   13 => 'GSM',
+                   14 => 'G726-32',
+                   15 => 'G721',
+                   16 => 'G726-24',
+                   17 => 'G726-40',
+                   18 => 'G726-16',
+                   19 => 'L16'
+                 }.freeze
+
+        DEFAULT_REROUTING_DISCONNECT_CODE_IDS = [
+                                                  56,
+                                                  58,
+                                                  59,
+                                                  60,
+                                                  64,
+                                                  65,
+                                                  66,
+                                                  67,
+                                                  68,
+                                                  69,
+                                                  70,
+                                                  71,
+                                                  72,
+                                                  73,
+                                                  74,
+                                                  75,
+                                                  76,
+                                                  77,
+                                                  78,
+                                                  79,
+                                                  80,
+                                                  81,
+                                                  82,
+                                                  83,
+                                                  84,
+                                                  86,
+                                                  87,
+                                                  88,
+                                                  89,
+                                                  90,
+                                                  91,
+                                                  92,
+                                                  96,
+                                                  97,
+                                                  98,
+                                                  99,
+                                                  101,
+                                                  102,
+                                                  103,
+                                                  104,
+                                                  105,
+                                                  106,
+                                                  107,
+                                                  108,
+                                                  1505
+                                                ].freeze
+
+        DEFAULT_CODEC_IDS = [9, 10, 8, 7, 6].freeze
+
+        DID_PLACEHOLDER = '{DID}'
       end
     end
   end

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

@@ -148,7 +148,7 @@ module DIDWW
         property :transport_protocol_id, type: :integer
         # Type: Integer
         # Nullable: No
-        # Description: The transport layer that will be responsible for the actual transmission of SIP requests and responses (1 - UDP, 2 - TCP)
+        # Description: The transport layer that will be responsible for the actual transmission of SIP requests and responses. See TRANSPORT_PROTOCOLS for available values.
 
         property :max_transfers, type: :integer
         # Nullable: No
@@ -158,6 +158,36 @@ module DIDWW
         # Nullable: No
         # Description: Max count of 301/302 redirects
 
+        property :media_encryption_mode, type: :string
+        # Type: String
+        # Nullable: No
+        # Description: The Media encryption mode for RTP traffic. See MEDIA_ENCRYPTION_MODES for available values.
+
+        property :stir_shaken_mode, type: :string
+        # Type: String
+        # Nullable: No
+        # Description: The STIR/SHAKEN mode for sending identity via SIP. See STIR_SHAKEN_MODES for available values.
+
+        property :allowed_rtp_ips, type: :ip_addresses
+        # Type: Array of strings
+        # Nullable: Yes
+        # Description: Allowed IP addresses for RTP connection.
+
+        MEDIA_ENCRYPTION_MODES = [
+                                   'disabled',
+                                   'srtp_sdes',
+                                   'srtp_dtls',
+                                   'zrtp'
+                                 ].freeze
+
+        STIR_SHAKEN_MODES = [
+                              'disabled',
+                              'original',
+                              'pai',
+                              'original_pai',
+                              'verstat'
+                            ].freeze
+
         DEFAULTS = {
             username: DID_PLACEHOLDER,
             port: '5060',
@@ -177,7 +207,7 @@ module DIDWW
             transport_protocol_id: 1
         }.freeze
 
-        RECOMMENDED = DEFAULTS.merge({
+        RECOMMENDED = DEFAULTS.merge(
             #-- Authentication
             auth_user: '',
             auth_password: '',
@@ -191,7 +221,7 @@ module DIDWW
             #-- Advanced Signalling Settings
             sst_enabled: false,
             sst_session_expires: '',
-        }).freeze
+        ).freeze
 
         def sst_refresh_method
           SST_REFRESH_METHODS[sst_refresh_method_id]

data/lib/didww/complex_objects/export_filters.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+require 'json_api_client/schema'
+
+module DIDWW
+  module ComplexObject
+    class ExportFilters < Base
+      # Type casting for JsonApiClient parser/setters
+      def self.cast_single_object(hash)
+        new(hash)
+      end
+
+      property :year,       type: :integer
+      property :month,      type: :integer
+      property :day,        type: :integer # only for CDR Out
+      property :did_number, type: :string # only for CDR in
+      property :voice_out_trunk_id, type: :string # only for CDR Out
+
+      def as_json(*)
+        result = attributes.as_json.with_indifferent_access
+        result[:'voice_out_trunk.id'] = result.delete(:voice_out_trunk_id) if result.key?(:voice_out_trunk_id)
+        result
+      end
+
+    end
+  end
+end

data/lib/didww/{resources → resource}/base.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 require 'didww/jsonapi_middleware'
-require 'didww/complex_objects/base'
 
 module DIDWW
   module Resource

data/lib/didww/{resources → resource}/did.rb

@@ -2,8 +2,8 @@
 module DIDWW
   module Resource
     class Did < Base
-      has_one :trunk
-      has_one :trunk_group
+      has_one :voice_in_trunk
+      has_one :voice_in_trunk_group
       has_one :capacity_pool
       has_one :shared_capacity_group
       has_one :address_verification

data/lib/didww/{resources → resource}/did_group.rb

@@ -2,23 +2,15 @@
 module DIDWW
   module Resource
     class DidGroup < Base
-      module CONST
-        # Possible values for did_group.features array
-        FEATURE_VOICE    = 'voice'                           .freeze
-        FEATURE_T38      = 't38'                             .freeze
-        FEATURE_SMS      = 'sms'                             .freeze
-        FEATURES = {
-          FEATURE_VOICE => 'Voice'                           .freeze,
-          FEATURE_T38   => 'T.38 Fax'                        .freeze,
-          FEATURE_SMS   => 'SMS'                             .freeze
-        }.freeze
-
-        def features_human
-          Array.wrap(features).map { |f| FEATURES[f] }
-        end
-      end
-
-      include CONST
+      # Possible values for did_group.features array
+      FEATURE_VOICE    = 'voice'                           .freeze
+      FEATURE_T38      = 't38'                             .freeze
+      FEATURE_SMS      = 'sms'                             .freeze
+      FEATURES = {
+                   FEATURE_VOICE => 'Voice'                           .freeze,
+                   FEATURE_T38   => 'T.38 Fax'                        .freeze,
+                   FEATURE_SMS   => 'SMS'                             .freeze
+                 }.freeze
 
       has_one :country, class: Country
       has_one :city,    class: City
@@ -62,6 +54,9 @@ module DIDWW
       # Type: Boolean
       # Description: Defines if numbers in this DID Group are currently in stock.
 
+      def features_human
+        Array.wrap(features).map { |f| FEATURES[f] }
+      end
     end
   end
 end

data/lib/didww/{resources/cdr_export.rb → resource/export.rb}

@@ -1,16 +1,24 @@
 # frozen_string_literal: true
 require 'forwardable'
-require 'didww/complex_objects/cdr_export_filter'
 require 'down/http'
+require 'didww/callback/const'
 
 module DIDWW
   module Resource
-    class CdrExport < Base
+    class Export < Base
+      include DIDWW::Callback::CONST
       extend Forwardable
 
       STATUS_COMPLETED = 'Completed'
 
-      property :filters, type: :cdr_export_filter
+      EXPORT_TYPE_CDR_IN = 'cdr_in'
+      EXPORT_TYPE_CDR_OUT = 'cdr_out'
+      EXPORT_TYPES = [
+        EXPORT_TYPE_CDR_IN,
+        EXPORT_TYPE_CDR_OUT
+      ].freeze
+
+      property :filters, type: :export_filters
       # Type: CDR Export Filters Object
       # Nullable: No
       # Description: Filters
@@ -38,7 +46,7 @@ module DIDWW
       # Type: String
       # Description: GET or POST
 
-      def_delegators :filters, :year, :month, :did_number, :year=, :month=, :did_number=
+      property :export_type, type: :string
 
       def initialize(params = {})
         super params.reverse_merge(filters: {})

data/lib/didww/{resources → resource}/order.rb

@@ -1,23 +1,22 @@
 # frozen_string_literal: true
 require 'didww/complex_objects/did_order_item'
 require 'didww/complex_objects/capacity_order_item'
+require 'didww/callback/const'
 
 module DIDWW
   module Resource
     class Order < Base
-      module CONST
-        # Possible values for order.status
-        STATUS_PENDING      = 'Pending'                       .freeze
-        STATUS_COMPLETED    = 'Completed'                     .freeze
-        STATUS_CANCELLED    = 'Canceled'                      .freeze
-        STATUSES = [
-          STATUS_PENDING,
-          STATUS_COMPLETED,
-          STATUS_CANCELLED
-        ].freeze
-      end
-
-      include CONST
+      include DIDWW::Callback::CONST
+
+      # Possible values for order.status
+      STATUS_PENDING      = 'Pending'
+      STATUS_COMPLETED    = 'Completed'
+      STATUS_CANCELLED    = 'Canceled'
+      STATUSES = [
+                   STATUS_PENDING,
+                   STATUS_COMPLETED,
+                   STATUS_CANCELLED
+                 ].freeze
 
       property :reference, type: :string
       # Type: String