didww-v3 1.3.1 → 4.0.0

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,21 +1,24 @@
+# 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
+      property :nanpa_prefix_id,      type: :string
 
       # returned
-      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
+      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,7 +1,9 @@
+# frozen_string_literal: true
 module DIDWW
   module Resource
     class AvailableDid < Base
       has_one :did_group
+      has_one :nanpa_prefix
 
       property :number, type: :string
       # Type: String

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/{resources → resource}/capacity_pool.rb

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

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

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

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
 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
 
       property :blocked, type: :boolean
       # Type: Boolean
@@ -18,7 +20,7 @@ module DIDWW
       # Type: Boolean
       # Description: Identifier for terminated DIDs that will be removed from service at the end of the billing cycle.
 
-      property :pending_removal, type: :boolean
+      property :billing_cycles_count, type: :integer
       # Type: Boolean
       # Description: Identifier for DIDs that are pending removal from your account.
 

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

@@ -1,23 +1,16 @@
+# frozen_string_literal: true
 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
@@ -30,10 +23,6 @@ module DIDWW
       # Type: String
       # Description: DID Group prefix (city or area calling code)
 
-      property :local_prefix, type: :string
-      # Type: String
-      # Description: DID Group local prefix
-
       property :features, type: :complex_object  # TODO implement array of strings?
       # Type: Array of strings
       # Description: Features available for the DID Group, including voice, sms and t38. A DID Group may have multiple features.
@@ -60,11 +49,10 @@ module DIDWW
       # is_available
       # Type: Boolean
       # Description: Defines if numbers in this DID Group are currently in stock.
-      #
-      # restrictions
-      # Type: String
-      # Description: Describes possible restrictions for the DID Group, such as "End User Registration is Required".
 
+      def features_human
+        Array.wrap(features).map { |f| FEATURES[f] }
+      end
     end
   end
 end

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

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

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

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

data/lib/didww/resource/encrypted_file.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+module DIDWW
+  module Resource
+    class EncryptedFile < Base
+      class UploadError < StandardError
+      end
+
+      property :description, type: :string
+      # Type: String
+      # Description:
+
+      property :expire_at, type: :date
+      # Type: Date
+      # Description:
+
+      # @return [Faraday::Connection]
+      def self.upload_connection
+        Faraday.new(url: site) do |connection|
+          connection.request :multipart
+          connection.request :url_encoded
+          connection.adapter Faraday.default_adapter
+          connection.use DIDWW::BaseMiddleware
+        end
+      end
+
+      # @param files [Rack::Multipart::UploadedFile,(#tempfile,#content_type,#original_filename)]
+      # @return [Array<String>]
+      # @raise [DIDWW::Resource::EncryptedFile::UploadError]
+      def self.upload_files(files, fingerprint)
+        items = files.map do |file|
+          {
+            file: Faraday::UploadIO.new(file.tempfile, file.content_type),
+            description: file.original_filename
+          }
+        end
+        payload = { encryption_fingerprint: fingerprint, items: items }
+        upload(payload)
+      end
+
+      # @param payload [Hash]
+      #   encryption_fingerprint [String] DIDWW::Encrypt#encryption_fingerprint
+      #   items [Array]
+      #     file [Faraday::UploadIO] upload io
+      #     description [String,nil] optional description
+      # @return [Array<String>]
+      # @raise [DIDWW::Resource::EncryptedFile::UploadError]
+      def self.upload(payload)
+        connection = upload_connection
+        response = connection.post('/v3/encrypted_files', encrypted_files: payload)
+        if response.status == 201
+          JSON.parse(response.body, symbolize_names: true)[:ids]
+        else
+          raise UploadError, "Code: #{response.status} #{response.body}"
+        end
+      end
+    end
+  end
+end

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

@@ -1,13 +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
 
-      property :filters, type: :cdr_export_filter
+      STATUS_COMPLETED = 'Completed'
+
+      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
@@ -27,7 +38,15 @@ module DIDWW
       # Nullable: true
       # Description: url of csv file for downloading. available only when status is "Completed"
 
-      def_delegators :filters, :year, :month, :did_number, :year=, :month=, :did_number=
+      property :callback_url, type: :string
+      # Type: String
+      # Description: valid URI for callbacks
+
+      property :callback_method, type: :string
+      # Type: String
+      # Description: GET or POST
+
+      property :export_type, type: :string
 
       def initialize(params = {})
         super params.reverse_merge(filters: {})
@@ -39,7 +58,7 @@ module DIDWW
       end
 
       def complete?
-        status == 'Completed'
+        status == STATUS_COMPLETED
       end
       alias_method :completed?, :complete?
     end