didww-v3 1.0.0 → 2.0.0

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module DIDWW
   module ComplexObject
     module Configuration
@@ -149,6 +150,14 @@ module DIDWW
         # Nullable: No
         # Description: The transport layer that will be responsible for the actual transmission of SIP requests and responses (1 - UDP, 2 - TCP)
 
+        property :max_transfers, type: :integer
+        # Nullable: No
+        # Description: Max count of the REFER requests
+
+        property :max_30x_redirects, type: :integer
+        # Nullable: No
+        # Description: Max count of 301/302 redirects
+
         DEFAULTS = {
             username: DID_PLACEHOLDER,
             port: '5060',
@@ -161,6 +170,8 @@ module DIDWW
             dns_srv_failover_timer: 2000,
             rtp_timeout: 30,
             auth_enabled: false,
+            max_transfers: 0,
+            max_30x_redirects: 0,
             codec_ids: DEFAULT_CODEC_IDS,
             rerouting_disconnect_code_ids: DEFAULT_REROUTING_DISCONNECT_CODE_IDS,
             transport_protocol_id: 1

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,14 +1,23 @@
+# frozen_string_literal: true
 module DIDWW
   module ComplexObject
     class DidOrderItem < Base
       # passed at order creation
-      property :qty,     type: :int
-      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/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/resources/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/resources/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/resources/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/available_did.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+module DIDWW
+  module Resource
+    class AvailableDid < Base
+      has_one :did_group
+
+      property :number, type: :string
+      # Type: String
+      # Description: The actual DID number in the format [country code][area code][subscriber number].
+
+    end
+  end
+end

data/lib/didww/resources/balance.rb

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

data/lib/didww/resources/base.rb

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

data/lib/didww/resources/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/resources/cdr_export.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'forwardable'
 require 'didww/complex_objects/cdr_export_filter'
 require 'down/http'
@@ -7,6 +8,8 @@ module DIDWW
     class CdrExport < Base
       extend Forwardable
 
+      STATUS_COMPLETED = 'Completed'
+
       property :filters, type: :cdr_export_filter
       # Type: CDR Export Filters Object
       # Nullable: No
@@ -27,6 +30,14 @@ module DIDWW
       # Nullable: true
       # Description: url of csv file for downloading. available only when status is "Completed"
 
+      property :callback_url, type: :string
+      # Type: String
+      # Description: valid URI for callbacks
+
+      property :callback_method, type: :string
+      # Type: String
+      # Description: GET or POST
+
       def_delegators :filters, :year, :month, :did_number, :year=, :month=, :did_number=
 
       def initialize(params = {})
@@ -39,7 +50,7 @@ module DIDWW
       end
 
       def complete?
-        status == 'Completed'
+        status == STATUS_COMPLETED
       end
       alias_method :completed?, :complete?
     end

data/lib/didww/resources/city.rb

@@ -1,6 +1,11 @@
+# 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

data/lib/didww/resources/country.rb

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

data/lib/didww/resources/did.rb

@@ -1,8 +1,12 @@
+# frozen_string_literal: true
 module DIDWW
   module Resource
     class Did < Base
       has_one :trunk
       has_one :trunk_group
+      has_one :capacity_pool
+      has_one :shared_capacity_group
+      has_one :address_verification
 
       property :blocked, type: :boolean
       # Type: Boolean
@@ -16,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.
 
@@ -36,6 +40,10 @@ module DIDWW
       # Type: Integer
       # Description: The number of channels included with this DID.
 
+      property :dedicated_channels_count, type: :integer
+      # Type: Integer
+      # Description: The number of channels included with this DID.
+
       property :expires_at, type: :time
       # Type: DateTime
       # Description: DateTime when the DID expired or will expire. DateTime is in the ISO 8601 format "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'", where "SSS" are milliseconds and 'Z' denotes Zulu time (UTC).

data/lib/didww/resources/did_group.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module DIDWW
   module Resource
     class DidGroup < Base
@@ -49,6 +50,10 @@ module DIDWW
       # TODO
       # Meta attributes
       #
+      # :available_dids_enabled
+      # Type: Boolean
+      # Description: Defines if particular DID from this DID group can be ordered via available_dids or did_reservations.
+      #
       # needs_registration
       # Type: Boolean
       # Description: Defines if end-user registration is required for this DID Group.
@@ -56,10 +61,6 @@ 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".
 
     end
   end

data/lib/didww/resources/did_group_type.rb

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

data/lib/didww/resources/did_reservation.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+module DIDWW
+  module Resource
+    class DidReservation < Base
+      has_one :available_did
+
+      property :expire_at, type: :time
+      # Type: DateTime
+      # Description: DateTime when the DID reservation expired or will expire. DateTime is in the ISO 8601 format "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'", where "SSS" are milliseconds and 'Z' denotes Zulu time (UTC).
+
+      property :created_at, type: :time
+      # Type: DateTime
+      # Description: DID reservation created at DateTime.
+
+    end
+  end
+end

data/lib/didww/resources/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/identity.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+module DIDWW
+  module Resource
+    class Identity < Base
+      IDENTITY_TYPE_PERSONAL = 'Personal'
+      IDENTITY_TYPE_BUSINESS = 'Business'
+
+      has_one :country, class_name: 'Country'
+      has_many :proofs, class_name: 'Proof'
+      has_many :addresses, class_name: 'Address'
+      has_many :permanent_documents, class_name: 'PermanentSupportingDocument'
+
+      property :first_name, type: :string
+      # Type: String
+      # Description:
+
+      property :last_name, type: :string
+      # Type: String
+      # Description:
+
+      property :phone_number, type: :string
+      # Type: String
+      # Description:
+
+      property :id_number, type: :string
+      # Type: String
+      # Description:
+
+      property :birth_date, type: :date
+      # Type: Date
+      # Description:
+
+      property :company_name, type: :string
+      # Type: String
+      # Description:
+
+      property :company_reg_number, type: :string
+      # Type: String
+      # Description:
+
+      property :vat_id, type: :string
+      # Type: String
+      # Description:
+
+      property :description, type: :string
+      # Type: String
+      # Description:
+
+      property :personal_tax_id, type: :string
+      # Type: String
+      # Description:
+
+      property :identity_type, type: :string
+      # Type: String
+      # Description:
+
+      property :created_at, type: :date
+      # Type: Date
+      # Description:
+
+      property :external_reference_id, type: :string
+      # Type: String
+      # Description:
+
+      property :verified, type: :boolean
+      # Type: Boolean
+      # Description:
+
+      def personal?
+        identity_type == IDENTITY_TYPE_PERSONAL
+      end
+
+      def business?
+        identity_type == IDENTITY_TYPE_BUSINESS
+      end
+    end
+  end
+end

data/lib/didww/resources/order.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 require 'didww/complex_objects/did_order_item'
+require 'didww/complex_objects/capacity_order_item'
 
 module DIDWW
   module Resource
@@ -45,6 +47,14 @@ module DIDWW
       # Type: Boolean
       # Description: Allowing back ordering
 
+      property :callback_url, type: :string
+      # Type: String
+      # Description: valid URI for callbacks
+
+      property :callback_method, type: :string
+      # Type: String
+      # Description: GET or POST
+
       def initialize(*args)
         super
         self.items ||= []

data/lib/didww/resources/permanent_supporting_document.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+module DIDWW
+  module Resource
+    class PermanentSupportingDocument < Base
+
+      has_many :files, class_name: 'EncryptedFile'
+      has_one :template, class_name: 'SupportingDocumentTemplate'
+      has_one :identity, class_name: 'Identity'
+
+      property :created_at, type: :date
+      # Type: Date
+      # Description:
+    end
+  end
+end