didww-v3 1.2.0 → 3.0.0

data/lib/didww/complex_objects/base.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'json_api_client/schema'
 
 module DIDWW
@@ -11,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
@@ -44,7 +45,10 @@ module DIDWW
 
         # Returns a ComplexObject class if given JSON API type matches any
         def class_for_type(type)
-          "#{parent.name}::#{type.classify}".safe_constantize
+          # activesupport 6 has breaking change - parent* methods renamed to module_parent*.
+          # see https://github.com/rails/rails/pull/34051
+          name = respond_to?(:module_parent_name) ? module_parent_name : parent_name
+          "#{name}::#{type.classify}".safe_constantize
         end
       end
 
@@ -84,5 +88,3 @@ module DIDWW
     end
   end
 end
-
-JsonApiClient::Schema.register complex_object: DIDWW::ComplexObject::Base

data/lib/didww/complex_objects/capacity_order_item.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+module DIDWW
+  module ComplexObject
+    class CapacityOrderItem < Base
+      # passed at order creation
+      property :qty,                type: :int
+      property :capacity_pool_id,   type: :string
+
+      # returned
+      property :nrc,                type: :decimal
+      property :mrc,                type: :decimal
+      property :propated_mrc,       type: :boolean
+      property :billed_from,        type: :string
+      property :billed_to,          type: :string
+    end
+  end
+end

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

@@ -1,10 +1,151 @@
-require 'didww/complex_objects/configurations/const'
+# frozen_string_literal: true
 
 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/h323_configuration.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module DIDWW
   module ComplexObject
     module Configuration

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module DIDWW
   module ComplexObject
     module Configuration

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module DIDWW
   module ComplexObject
     module Configuration

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module DIDWW
   module ComplexObject
     module Configuration
@@ -147,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
@@ -157,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',
@@ -176,7 +207,7 @@ module DIDWW
             transport_protocol_id: 1
         }.freeze
 
-        RECOMMENDED = DEFAULTS.merge({
+        RECOMMENDED = DEFAULTS.merge(
             #-- Authentication
             auth_user: '',
             auth_password: '',
@@ -190,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/configurations.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'didww/complex_objects/configurations/base'
 require 'didww/complex_objects/configurations/sip_configuration'
 require 'didww/complex_objects/configurations/iax2_configuration'

data/lib/didww/complex_objects/did_order_item.rb

@@ -1,16 +1,23 @@
+# frozen_string_literal: true
 module DIDWW
   module ComplexObject
     class DidOrderItem < Base
       # passed at order creation
-      property :qty,                type: :int
-      property :available_did_id,   type: :string
-      property :did_reservation_id, type: :string
-      property :sku_id,             type: :string
+      property :qty,                  type: :int
+      property :available_did_id,     type: :string
+      property :did_reservation_id,   type: :string
+      property :sku_id,               type: :string
+      property :billing_cycles_count, type: :string
 
       # returned
-      property :setup_price,        type: :decimal
-      property :monthly_price,      type: :decimal
-      property :did_group_id,       type: :string
+      property :setup_price,          type: :decimal
+      property :monthly_price,        type: :decimal
+      property :nrc,                  type: :decimal
+      property :mrc,                  type: :decimal
+      property :propated_mrc,         type: :boolean
+      property :billed_from,          type: :string
+      property :billed_to,            type: :string
+      property :did_group_id,         type: :string
     end
   end
 end

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/encrypt.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+require 'openssl'
+require 'openssl/oaep'
+require 'net/http'
+
+module DIDWW
+  # Allows to encrypt file on Ruby-side before uploading to `/v3/encrypted_files`.
+  # @example
+  #   file_content_1 = File.read('file_to_send_1.jpg', mode: 'rb')
+  #   file_content_2 = File.read('file_to_send_1.pdf', mode: 'rb')
+  #   enc = DIDWW::Encrypt.new
+  #   enc_data_1 = enc.encrypt(file_content_1)
+  #   enc_data_2 = enc.encrypt(file_content_2)
+  #   enc_io_1 = Faraday::UploadIO.new(StringIO.new(enc_data_1), 'application/octet-stream')
+  #   enc_io_2 = Faraday::UploadIO.new(StringIO.new(enc_data_2), 'application/octet-stream')
+  #   DIDWW::Resource::EncryptedFile.upload(
+  #     encryption_fingerprint: enc.encryption_fingerprint,
+  #     items: [
+  #       { file: enc_io_1, description: 'file_to_send_1.jpg' },
+  #       { file: enc_io_2, description: 'file_to_send_2.pdf' }
+  #     ]
+  #   ) # => Array if IDs
+  #
+  class Encrypt
+    AES_ALGO = [256, :CBC]
+    AES_KEY_LEN = 32
+    AES_IV_LEN = 16
+    LABEL = ''
+    SEPARATOR = ':::'
+
+    class << self
+      # @param binary [String]
+      # @return [String]
+      def encrypt(binary)
+        new.encrypt(binary)
+      end
+    end
+
+    attr_reader :public_keys, :encryption_fingerprint
+
+    def initialize
+      reset!
+    end
+
+    # @param binary [String] binary content of a file.
+    # @return [String] binary content of an encrypted file.
+    def encrypt(binary)
+      aes_key, aes_iv, encrypted_aes = encrypt_aes(binary)
+      aes_credentials = aes_key + aes_iv
+      encrypted_rsa_a = encrypt_rsa_oaep(public_keys[0], aes_credentials)
+      encrypted_rsa_b = encrypt_rsa_oaep(public_keys[1], aes_credentials)
+      encrypted_rsa_a + encrypted_rsa_b + encrypted_aes
+    end
+
+    # Resets public keys and fingerprint.
+    def reset!
+      @public_keys = fetch_public_keys
+      @encryption_fingerprint = calculate_fingerprint
+    end
+
+    private
+
+    # @return [Array(String,String)] public keys.
+    def fetch_public_keys
+      DIDWW::Resource::PublicKey.find.map(&:key)
+    end
+
+    def calculate_fingerprint
+      public_keys.map { |pub_key| fingerprint_for(pub_key) }.join(SEPARATOR)
+    end
+
+    # @param public_key [String] PEM public key.
+    # @return [String] hexstring digest SHA1 for public key binary.
+    def fingerprint_for(public_key)
+      public_key += "\n" unless public_key[-1] == "\n"
+      public_key_base64 = public_key.split("\n")[1..-2].join
+      public_key_bin = Base64.decode64(public_key_base64)
+      OpenSSL::Digest::SHA1.hexdigest(public_key_bin)
+    end
+
+    # @param public_key [String]
+    # @param text [String]
+    def encrypt_rsa_oaep(public_key, text)
+      rsa = OpenSSL::PKey::RSA.new(public_key)
+      rsa.public_encrypt_oaep(text, LABEL, OpenSSL::Digest::SHA256)
+    end
+
+    # @param binary [String]
+    # @return [Array(String,String,String)] binaries key, vector, encrypted data.
+    def encrypt_aes(binary)
+      key = SecureRandom.random_bytes(AES_KEY_LEN)
+      iv = SecureRandom.random_bytes(AES_IV_LEN)
+      cipher = OpenSSL::Cipher::AES.new(*AES_ALGO)
+      cipher.encrypt
+      cipher.key = key
+      cipher.iv = iv
+      encrypted = cipher.update(binary) + cipher.final
+      [key, iv, encrypted]
+    end
+  end
+end

data/lib/didww/jsonapi_middleware.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+module DIDWW
+  # :nodoc:
+  class JsonapiMiddleware < Faraday::Middleware
+    def call(request_env)
+      headers = {}
+      headers['Content-Type']        = 'application/vnd.api+json'
+      headers['Api-Key']             = DIDWW::Client.api_key
+      headers['User-Agent']          = "didww-v3 Ruby gem v#{VERSION}"
+      headers['x-didww-api-version'] = DIDWW::Client.api_version unless DIDWW::Client.api_version.blank?
+
+      request_env[:request_headers].merge!(headers)
+      request_env.url.host = URI(DIDWW::Client.api_base_url).host
+
+      @app.call(request_env).on_complete do |response_env|
+        # do something with the response
+        # response_env[:response_headers].merge!(...)
+      end
+    end
+  end
+end

data/lib/didww/resource/address.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+module DIDWW
+  module Resource
+    class Address < Base
+
+      has_one :identity, class_name: 'Identity'
+      has_one :country, class_name: 'Country'
+      has_many :proofs, class_name: 'Proof'
+      has_many :city, class_name: 'City'
+      has_many :area, class_name: 'Area'
+
+      property :city_name, type: :string
+      # Type: String
+      # Description:
+
+      property :postal_code, type: :string
+      # Type: String
+      # Description:
+
+      property :address, type: :string
+      # Type: String
+      # Description:
+
+      property :description, type: :string
+      # Type: String
+      # Description:
+
+      property :created_at, type: :date
+      # Type: Date
+      # Description:
+
+      property :verified, type: :boolean
+      # Type: Boolean
+      # Description:
+    end
+  end
+end

data/lib/didww/resource/address_verification.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+module DIDWW
+  module Resource
+    class AddressVerification < Base
+      STATUS_PENDING = 'Pending'
+      STATUS_APPROVED = 'Approved'
+      STATUS_REJECTED = 'Rejected'
+      STATUSES = [
+        STATUS_PENDING,
+        STATUS_APPROVED,
+        STATUS_REJECTED
+      ].freeze
+
+      has_one :address, class_name: 'Address'
+      has_many :dids, class_name: 'Did'
+      has_many :onetime_files, class_name: 'EncryptedFile'
+
+      property :service_description, type: :string
+      # Type: String
+      # Description:
+
+      property :status, type: :string
+      # Type: String
+      # Description:
+
+      property :reject_reasons, type: :string
+      # Type: String
+      # Description:
+
+      property :created_at, type: :date
+      # Type: Date
+      # Description:
+
+      property :callback_url, type: :string
+      # Type: String
+      # Description: valid URI for callbacks
+
+      property :callback_method, type: :string
+      # Type: String
+      # Description: GET or POST
+
+      def pending?
+        status == STATUS_PENDING
+      end
+
+      def approved?
+        status == STATUS_APPROVED
+      end
+
+      def rejected?
+        status == STATUS_REJECTED
+      end
+
+    end
+  end
+end

data/lib/didww/resource/area.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+module DIDWW
+  module Resource
+    class Area < Base
+      has_one :country, class_name: 'Country'
+
+      property :name, type: :string
+      # Type: String
+      # Description: Regulatory Area name
+    end
+  end
+end

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module DIDWW
   module Resource
     class AvailableDid < Base

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module DIDWW
   module Resource
     class Balance < Base

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

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

data/lib/didww/resource/capacity_pool.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+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'
+
+      property :name, type: :string
+      # Type: String
+      # Description: Capacity pool name
+
+      property :renew_date, type: :string
+      # Type: String
+      # Description: Next monthly renew date in format 'YYYY-MM-DD'
+
+      property :total_channels_count, type: :integer
+      # Type: Integer
+      # Description: Channels count owned by customer in this pool
+
+      property :assigned_channels_count, type: :integer
+      # Type: Integer
+      # Description: Channels used by at least one service in this pool
+
+      property :minimum_limit, type: :integer
+      # Type: Integer
+      # Description: A minimum amount of channels in this pool. Customer cannot remove unassigned channels below this level.
+
+      property :minimum_qty_per_order, type: :integer
+      # Type: Integer
+      # Description: A minimum amount of new channels to add to this pool in one order.
+
+      property :setup_price, type: :decimal
+      # Type: String
+      # Description: Non-recurring price per channel
+
+      property :monthly_price, type: :decimal
+      # Type: String
+      # Description: Monthly recurring price per channel
+
+      property :metered_rate, type: :decimal
+      # Type: String
+      # Description: Metered rate per minute
+
+    end
+  end
+end

data/lib/didww/resource/city.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+module DIDWW
+  module Resource
+    class City < Base
+      has_one :country, class_name: 'Country'
+      has_one :region, class_name: 'Region'
+      has_one :area, class_name: 'Area'
+
+      property :name, type: :string
+      # Type: String
+      # Description: City name
+    end
+  end
+end

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module DIDWW
   module Resource
     class Country < Base