didww-v3 1.3.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 67435ef42f0af2a8862a0951069af3d7a4ce4b3afedfeef02c89203fef215645
-  data.tar.gz: f5bcb5ea9069ef3b10a1ac6c9b714d315e3b0f55d80fc132e22e21cc076a24ac
+  metadata.gz: 9d736e9893b21ef96ef76993d6bb3da3e47c1dbb760edcc6ea13d0cf86d5e847
+  data.tar.gz: 9d641935ce36af938ea6641b7488835535ef4a01f6464b5c90f667dafac953c3
 SHA512:
-  metadata.gz: 843ef3ddb29b72b09a7ef3b586169fe2f481463a0de49a8361642ff20c31973dee901f0c0d4f21bfa0c6aff60df2243e0e9e2e22b1e123168775bea200ecd6f0
-  data.tar.gz: 842db8a8747dcfe7aa79fb363d45022d31a407ef2321e2599b770b7294c9eba890b4f1858a35735f77512d639a58948db44d25afddc69cfcad50f26f581820ec
+  metadata.gz: b2cef4993cda70bd45a3a1efd960ab26d9ba603de9a10c246c537ccdbbb3506e923f1628643fabcefcc7be8ca1f9a6a93342b996e6233b9eadadc77818d766fe
+  data.tar.gz: de556881b793c412ea2fb486bacd00f89a3c07ad3902e755f5a4140e2eb0fda10f1b748ea719ce9968e87e476797bed8b28ce3b032f1e107ed457946235f303f

data/.github/workflows/tests.yml

@@ -1,5 +1,9 @@
 name: Tests
-on: [ 'pull_request' ]
+on:
+  pull_request:
+  push:
+    branches:
+      - master
 
 jobs:
   test:

data/.rubocop.yml

@@ -52,6 +52,9 @@ Style/StringLiterals:
 Style/StringLiteralsInInterpolation:
   Enabled: true
 
+Style/FrozenStringLiteralComment:
+  Enabled: true
+
 ##################### Performance ############################
 
 # Use `casecmp` rather than `downcase ==`.

data/CHANGELOG.md

@@ -4,15 +4,33 @@ 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).
 
-## [1.3.1] - 2021-10-26
+## [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)  
+    Handling of 4XX responses was changed - it now raises JsonApiClient::Errors::ClientError with `detail` as error message instead of adding it into base errors.
+- /v3/dids in request and response attributes pending_removal being removed in favor of billing_cycles_count.
+- /v3/did_groups restriction message removed in favor of requirements relationship.
+  
 ### Changes
 - replace travis with github actions [#7](https://github.com/didww/didww-v3-ruby/pull/7) [#9](https://github.com/didww/didww-v3-ruby/pull/9)
 - use rubocop 1.9.X version [#7](https://github.com/didww/didww-v3-ruby/pull/7)
 - add bundle-audit [#7](https://github.com/didww/didww-v3-ruby/pull/7)
+- /v3/orders request attribute items of type DID Order Item Attributes can have billing_cycles_count.
+- /v3/dids added address_verification relationship.
+- callbacks attributes added to /v3/orders, /v3/cdr_exports.
+- /v3/proof_types read endpoints being added.
+- /v3/supporting_document_templates read endpoints being added.
+- /v3/requirements read endpoints being added.
+- /v3/identities read, write, and delete endpoints being added.
+- /v3/addresses read, write, and delete endpoints being added.
+- /v3/encrypted_files read, write, and delete endpoints being added.
+- /v3/proofs write, delete endpoint being added.
+- /v3/permanent_supporting_documents write, delete endpoint being added.
+- /v3/address_verifications read and write endpoints being added.
+- /v3/requirement_validations write endpoint being added.
 
 ### Bugfixes
 - fix order purchase when activesupport 6.X.X is used.
-- fix BigDecimal 2 support for ruby 2.7+.
 
 ## [1.3.0] - 2018-09-03
 ### Changes

data/Gemfile

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 source 'https://rubygems.org'
 
 git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }

data/README.md

@@ -1,6 +1,6 @@
 Ruby client for DIDWW API v3.
 
-[![Build Status](https://github.com/didww/didww-v3-ruby/workflows/tests/badge.svg?branch=master)](https://github.com/didww/didww-v3-ruby/actions)
+![Tests](https://github.com/didww/didww-v3-ruby/workflows/Tests/badge.svg)
 
 About DIDWW API v3
 -----
@@ -11,6 +11,10 @@ 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 **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).
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/Rakefile

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 require 'bundler/audit/task'

data/bin/console

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'bundler/setup'
 require 'didww'

data/didww-v3.gemspec

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
@@ -23,7 +24,8 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'activesupport'
   spec.add_dependency 'faraday'
-  spec.add_dependency 'json_api_client', '1.5.3'
+  spec.add_dependency 'json_api_client', '1.18.0'
   spec.add_dependency 'http'
   spec.add_dependency 'down'
+  spec.add_dependency 'openssl-oaep'
 end

data/lib/didww/{middleware.rb → base_middleware.rb}

@@ -1,11 +1,12 @@
+# frozen_string_literal: true
 module DIDWW
   # :nodoc:
-  class Middleware < Faraday::Middleware
+  class BaseMiddleware < 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['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

data/lib/didww/callback/request_validator.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+require 'openssl'
+
+module DIDWW
+  module Callback
+    # @example
+    #   validator = DIDWW::Callback::RequestValidator.new(api_key)
+    #   uri = request.original_url
+    #   if request.post?
+    #     # Collect all parameters passed from DIDWW.
+    #     params = env['rack.request.form_hash']
+    #   else
+    #     params = env['rack.request.query_hash']
+    #   end
+    #
+    # signature = env['HTTP_X_DIDWW_SIGNATURE']
+    # validator.validate(uri, params, signature) #=> true if the request is from DIDWW
+    # # or with rails
+    class RequestValidator
+      DIGEST_ALGO = 'SHA1'
+      HEADER = 'X-DIDWW-Signature'
+
+      def initialize(api_key)
+        @api_key = api_key
+      end
+
+      # @param url [String]
+      # @param payload [Hash]
+      # @param signature [String]
+      # @return [Boolean] whether signature valid or not.
+      def validate(url, payload, signature)
+        return false if signature.blank?
+
+        signature == valid_signature(url, payload)
+      end
+
+      private
+
+      # @param url [String]
+      # @param payload [Hash]
+      # @return [String] generated signature in URL safe format.
+      def valid_signature(url, payload)
+        normalized_url = normalize_url(url)
+        data = normalized_url + payload.sort.join
+        OpenSSL::HMAC.hexdigest(DIGEST_ALGO, @api_key, data)
+      end
+
+      # @return [String] normalized URL.
+      def normalize_url(url)
+        parsed_url = URI ensure_protocol_url(url)
+        url = "#{parsed_url.scheme || 'http'}://"
+        url += "#{parsed_url.userinfo}@" if parsed_url.userinfo
+        url += "#{parsed_url.host}:#{parsed_url.port || parsed_url.default_port}#{parsed_url.path}"
+        url += "?#{parsed_url.query}" if parsed_url.query
+        url += "##{parsed_url.fragment}" if parsed_url.fragment
+        url
+      end
+
+      def ensure_protocol_url(url)
+        if url[%r{\A[a-zA-Z]+://}i]
+          url
+        else
+          'http://' + url
+        end
+      end
+    end
+  end
+end

data/lib/didww/client.rb

@@ -1,18 +1,10 @@
+# frozen_string_literal: true
 require 'active_support/core_ext/module/attribute_accessors'
+require 'active_support/core_ext/object/blank'
 require 'json_api_client'
 
 require 'didww/resources/base'
 
-# Fixes BigDecimal 2 support for ruby 2.7+ without introducing json_api_client breaking changes.
-# https://github.com/JsonApiClient/json_api_client/commit/ac372b8bab3b71bb0aa5c4dcc6ced1d9c3fe8d14
-class JsonApiClient::Schema::Types::FixedDecimal
-  def self.cast(value, _)
-    BigDecimal(value)
-  end
-end
-
-JsonApiClient::Schema.register decimal: JsonApiClient::Schema::Types::FixedDecimal
-
 module DIDWW
   module Client
     BASE_URLS = {
@@ -21,7 +13,7 @@ module DIDWW
     }.freeze
     DEFAULT_MODE = :sandbox
 
-    mattr_accessor :api_key, :api_mode, :http_verbose
+    mattr_accessor :api_key, :api_mode, :http_verbose, :api_version
 
     class << self
       def configure
@@ -39,8 +31,20 @@ module DIDWW
         @@api_key
       end
 
+      def api_version
+        @@api_version
+      end
+
+      def with_api_version(api_version)
+        old_api_version = self.api_version
+        self.api_version = api_version
+        yield
+      ensure
+        self.api_version = old_api_version
+      end
+
       def api_base_url
-        BASE_URLS[api_mode]
+        ENV['DIDWW_API_URL'].presence || BASE_URLS[api_mode]
       end
 
       def balance
@@ -107,6 +111,38 @@ module DIDWW
         Resource::DidReservation
       end
 
+      def requirements
+        Resource::Requirement
+      end
+
+      def identities
+        Resource::Identity
+      end
+
+      def proofs
+        Resource::Proof
+      end
+
+      def addresses
+        Resource::Address
+      end
+
+      def permanent_supporting_documents
+        Resource::PermanentSupportingDocument
+      end
+
+      def encrypted_file
+        Resource::EncryptedFile
+      end
+
+      def address_verifications
+        Resource::AddressVerification
+      end
+
+      def requirement_validation
+        Resource::RequirementValidation
+      end
+
       def api_mode=(arg)
         unless BASE_URLS.keys.include?(arg)
           raise ArgumentError.new("Mode should be in #{BASE_URLS.keys} (given '#{arg}').")
@@ -124,7 +160,7 @@ module DIDWW
         DIDWW::Resource::Base.site = api_base_url
         DIDWW::Resource::Base.connection do |connection|
           connection.use Faraday::Response::Logger if http_verbose?
-          connection.use DIDWW::Middleware
+          connection.use DIDWW::JsonapiMiddleware
         end
         JsonApiClient::Paginating::Paginator.page_param = 'number'
         JsonApiClient::Paginating::Paginator.per_page_param = 'size'
@@ -149,6 +185,18 @@ module DIDWW
         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'
       end
 
     end

data/lib/didww/complex_objects/base.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'json_api_client/schema'
 
 module DIDWW

data/lib/didww/complex_objects/capacity_order_item.rb

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

data/lib/didww/complex_objects/cdr_export_filter.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'json_api_client/schema'
 
 module DIDWW

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

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

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

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

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

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,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 :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/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

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

data/lib/didww/resources/balance.rb

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