didww-v3 1.3.1 → 2.0.0

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

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

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,3 +1,4 @@
+# frozen_string_literal: true
 module DIDWW
   module Resource
     class Did < Base
@@ -5,6 +6,7 @@ module DIDWW
       has_one :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/did_group.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module DIDWW
   module Resource
     class DidGroup < Base
@@ -60,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

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

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,3 +1,4 @@
+# frozen_string_literal: true
 require 'didww/complex_objects/did_order_item'
 require 'didww/complex_objects/capacity_order_item'
 
@@ -46,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

data/lib/didww/resources/pop.rb

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

data/lib/didww/resources/proof.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+module DIDWW
+  module Resource
+    class Proof < Base
+
+      has_many :files, class_name: 'EncryptedFile'
+      has_one :proof_type, class_name: 'ProofType'
+      has_one :entity, class_name: 'Entity', polymorphic: true
+
+      property :created_at, type: :date
+      # Type: Date
+      # Description:
+
+      property :is_expired, type: :boolean
+      # Type: Boolean
+      # Description:
+    end
+  end
+end

data/lib/didww/resources/proof_type.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+module DIDWW
+  module Resource
+    class ProofType < Base
+      property :name, type: :string
+      # Type: String
+      # Description:
+
+      property :entity_type, type: :string
+      # Type: String
+      # Description:
+    end
+  end
+end

data/lib/didww/resources/public_key.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+module DIDWW
+  module Resource
+    class PublicKey < Base
+
+      property :key, type: :string
+      # Type: String
+      # Description: Public key for encryption.
+
+    end
+  end
+end

data/lib/didww/resources/qty_based_pricing.rb

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

data/lib/didww/resources/region.rb

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

data/lib/didww/resources/requirement.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+module DIDWW
+  module Resource
+    class Requirement < Base
+
+      has_one :country, class_name: 'Country'
+      has_one :did_group_type, class_name: 'DidGroupType', relation_name: :group_type
+      has_one :personal_permanent_document, class_name: 'SupportingDocumentTemplate'
+      has_one :business_permanent_document, class_name: 'SupportingDocumentTemplate'
+      has_one :personal_onetime_document, class_name: 'SupportingDocumentTemplate'
+      has_one :business_onetime_document, class_name: 'SupportingDocumentTemplate'
+      has_many :personal_proof_types, class_name: 'ProofType'
+      has_many :business_proof_types, class_name: 'ProofType'
+      has_many :address_proof_types, class_name: 'ProofType'
+
+      property :identity_type, type: :integer
+      # Type: Integer
+      # Description:
+
+      property :personal_area_level, type: :string
+      # Type: String
+      # Description:
+
+      property :business_area_level, type: :string
+      # Type: String
+      # Description:
+
+      property :address_area_level, type: :string
+      # Type: String
+      # Description:
+
+      property :personal_proof_qty, type: :integer
+      # Type: Integer
+      # Description:
+
+      property :business_proof_qty, type: :integer
+      # Type: Integer
+      # Description:
+
+      property :address_proof_qty, type: :integer
+      # Type: Integer
+      # Description:
+
+      property :personal_mandatory_fields, type: :array
+      # Type: String[]
+      # Description:
+
+      property :business_mandatory_fields, type: :array
+      # Type: String[]
+      # Description:
+
+      property :service_description_required, type: :boolean
+      # Type: Boolean
+      # Description:
+
+      property :restriction_message, type: :string
+      # Type: String
+      # Description:
+    end
+  end
+end

data/lib/didww/resources/requirement_validation.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+module DIDWW
+  module Resource
+    class RequirementValidation < Base
+      has_one :requirement, class_name: 'Requirement'
+      has_one :address, class_name: 'Address'
+      has_one :identity, class_name: 'Identity'
+    end
+  end
+end

data/lib/didww/resources/shared_capacity_group.rb

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

data/lib/didww/resources/stock_keeping_unit.rb

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

data/lib/didww/resources/supporting_document_template.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+module DIDWW
+  module Resource
+    class SupportingDocumentTemplate < Base
+      property :name, type: :string
+      # Type: String
+      # Description:
+
+      property :url, type: :string
+      # Type: String
+      # Description:
+    end
+  end
+end

data/lib/didww/resources/trunk/const.rb

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

data/lib/didww/resources/trunk.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'didww/complex_objects/configurations'
 require 'didww/resources/trunk/const'
 

data/lib/didww/resources/trunk_group.rb

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

data/lib/didww/version.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module DIDWW
-  VERSION = '1.3.1'.freeze
+  VERSION = '2.0.0'.freeze
 end

data/lib/didww.rb

@@ -1,3 +1,7 @@
+# frozen_string_literal: true
 require 'didww/version'
 require 'didww/client'
-require 'didww/middleware'
+require 'didww/base_middleware'
+require 'didww/jsonapi_middleware'
+require 'didww/callback/request_validator'
+require 'didww/encrypt'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: didww-v3
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Alex Korobeinikov
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.5.3
+        version: 1.18.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.5.3
+        version: 1.18.0
 - !ruby/object:Gem::Dependency
   name: http
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: openssl-oaep
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Ruby client for DIDWW API v3
 email:
 - alex.k@didww.com
@@ -100,6 +114,8 @@ files:
 - bin/setup
 - didww-v3.gemspec
 - lib/didww.rb
+- lib/didww/base_middleware.rb
+- lib/didww/callback/request_validator.rb
 - lib/didww/client.rb
 - lib/didww/complex_objects/base.rb
 - lib/didww/complex_objects/capacity_order_item.rb
@@ -112,7 +128,11 @@ files:
 - lib/didww/complex_objects/configurations/pstn_configuration.rb
 - lib/didww/complex_objects/configurations/sip_configuration.rb
 - lib/didww/complex_objects/did_order_item.rb
-- lib/didww/middleware.rb
+- lib/didww/encrypt.rb
+- lib/didww/jsonapi_middleware.rb
+- lib/didww/resources/address.rb
+- lib/didww/resources/address_verification.rb
+- lib/didww/resources/area.rb
 - lib/didww/resources/available_did.rb
 - lib/didww/resources/balance.rb
 - lib/didww/resources/base.rb
@@ -124,12 +144,21 @@ files:
 - lib/didww/resources/did_group.rb
 - lib/didww/resources/did_group_type.rb
 - lib/didww/resources/did_reservation.rb
+- lib/didww/resources/encrypted_file.rb
+- lib/didww/resources/identity.rb
 - lib/didww/resources/order.rb
+- lib/didww/resources/permanent_supporting_document.rb
 - lib/didww/resources/pop.rb
+- lib/didww/resources/proof.rb
+- lib/didww/resources/proof_type.rb
+- lib/didww/resources/public_key.rb
 - lib/didww/resources/qty_based_pricing.rb
 - lib/didww/resources/region.rb
+- lib/didww/resources/requirement.rb
+- lib/didww/resources/requirement_validation.rb
 - lib/didww/resources/shared_capacity_group.rb
 - lib/didww/resources/stock_keeping_unit.rb
+- lib/didww/resources/supporting_document_template.rb
 - lib/didww/resources/trunk.rb
 - lib/didww/resources/trunk/const.rb
 - lib/didww/resources/trunk_group.rb