trusona 0.16.0

data/lib/trusona/helpers/key_normalizer.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Trusona
+  module Helpers
+    ##
+    # Noramlizes keys by turning all key values into symbols
+    module KeyNormalizer
+      def normalize_keys(hash)
+        hash.each_with_object({}) do |(k, v), memo|
+          memo[k.to_sym] = v
+        end
+      end
+    end
+  end
+end

data/lib/trusona/helpers/time_normalizer.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Trusona
+  module Helpers
+    ##
+    # Normalizes Strings, Date, DateTime, and Time into a UTC Time object
+    module TimeNormalizer
+      def normalize_time(time)
+        return nil if time.nil?
+        return time.to_time.gmtime if time.is_a?(DateTime)
+        return time.gmtime if time.is_a?(Time)
+        return Time.parse(time).gmtime if time.is_a?(String)
+        return nil if time.is_a?(Date)
+      end
+    end
+  end
+end

data/lib/trusona/identity_document.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module Trusona
+  ##
+  # Helpful for finding Identity Documents given a user identifier or
+  # Identity Document identifier
+  class IdentityDocument
+    ##
+    # Finds all of the identity documents associated with the user identifier
+    #
+    # @param [String] user_identifier The user identifier associated with the
+    #   requested identity documents.
+    # @return [Array<Trusona::Resources::IdentityDocument>] A collection of
+    #   identity
+    #   documents.
+    # @raise ArgumentError if the user_identifier is nil
+    #
+    # @raise [Trusona::InvalidResourceError] if the resource is not +valid?+
+    # @see Trusona::Resources::BaseResource#valid?
+    # @raise [Trusona::BadRequestError] if the request is improperly formatted
+    # @raise [Trusona::UnauthorizedRequestError] if the request is unauthorized.
+    #  Typically the result of invalid or revoked Trusona SDK keys.
+    # @raise [Trusona::ApiError] if the Trusona API is experiencing problems.
+    #
+    # @example
+    #
+    #   Trusona::IdentityDocument.find_all('user-1234')
+    #
+
+    def self.all(user_identifier: nil)
+      # rubocop:disable Metrics/LineLength
+      raise ArgumentError, 'A user identifier is required.' unless user_identifier
+      # rubocop:enable Metrics/LineLength
+
+      Trusona::Workers::IdentityDocumentFinder.new.find_all(user_identifier)
+    end
+
+    ##
+    # Finds the specified identity document
+    #
+    # @param [String] id The id of the Identity Document
+    # @return [Trusona::Resources::IdentityDocument] the Identity Document
+    # @raise ArgumentError if the user_identifier is nil
+    #
+    # @raise [Trusona::InvalidResourceError] if the resource is not +valid?+
+    # @see Trusona::Resources::BaseResource#valid?
+    # @raise [Trusona::BadRequestError] if the request is improperly formatted
+    # @raise [Trusona::UnauthorizedRequestError] if the request is unauthorized.
+    #  Typically the result of invalid or revoked Trusona SDK keys.
+    # @raise [Trusona::ApiError] if the Trusona API is experiencing problems.
+    #
+    # @example
+    #
+    #   Trusona::IdentityDocument.find('4FDF044D-89FB-4043-947D-A029CF785B5F')
+    #
+    def self.find(id: nil)
+      # rubocop:disable Metrics/LineLength
+      raise ArgumentError, 'An Identity Document identifier is required.' unless id
+      # rubocop:enable Metrics/LineLength
+
+      Trusona::Workers::IdentityDocumentFinder.new.find(id)
+    end
+  end
+end

data/lib/trusona/mappers/base_mapper.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module Trusona
+  module Mappers
+    #
+    ## A starting point for specific resource mappers
+    class BaseMapper
+      include Trusona::Helpers::KeyNormalizer
+      attr_accessor :custom_mappings, :resource
+
+      def map(response, existing = {})
+        raise ArgumentError if response_invalid?(response)
+        raise ArgumentError if existing_invalid?(existing)
+
+        raise if existing.nil?
+
+        parsed_response = response.to_h
+
+        if parsed_response.is_a?(Array)
+          parsed_response.map { |r| map_item(r, existing) }.compact
+        else
+          map_item(parsed_response, existing)
+        end
+      end
+
+      private
+
+      def map_item(item, existing)
+        return nil if item.nil? || item.empty?
+        item = normalize_keys(item)
+        item = merge_existing_state(item, existing.to_h)
+        item = map_custom_fields(item)
+
+        (resource || Trusona::Resources::BaseResource).send(:new, item)
+      end
+
+      def merge_existing_state(response, existing)
+        existing.to_h.compact.merge(response)
+      end
+
+      def map_custom_fields(response)
+        return response if custom_mappings.nil? || custom_mappings.empty?
+        custom_mappings.each do |original_key, new_key|
+          value = response.delete(original_key)
+          response[new_key] = value
+        end
+
+        response
+      end
+
+      def response_invalid?(response)
+        return true if response.nil?
+        return true unless response.respond_to?(:to_h)
+        false
+      end
+
+      def resource_invalid?(resource)
+        return true if resource.nil?
+        return true unless resource.respond_to?(:new)
+        false
+      end
+
+      def existing_invalid?(existing)
+        return true unless existing.respond_to?(:to_h)
+        false
+      end
+    end
+  end
+end

data/lib/trusona/mappers/device_mapper.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Trusona
+  module Mappers
+    #
+    ## Maps Device Responses
+    class DeviceMapper < BaseMapper
+      def resource
+        Trusona::Resources::Device
+      end
+    end
+  end
+end

data/lib/trusona/mappers/device_user_binding_mapper.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Trusona
+  module Mappers
+    #
+    ## Maps Device User Binding Responses
+    class DeviceUserBindingMapper < BaseMapper
+      def resource
+        Trusona::Resources::DeviceUserBinding
+      end
+    end
+  end
+end

data/lib/trusona/mappers/identity_document_mapper.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Trusona
+  module Mappers
+    #
+    ## Maps Identity Document Responses
+    class IdentityDocumentMapper < BaseMapper
+      def resource
+        Trusona::Resources::IdentityDocument
+      end
+
+      def custom_mappings
+        { hash: :document_hash }
+      end
+    end
+  end
+end

data/lib/trusona/mappers/nil_mapper.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Trusona
+  module Mappers
+    #
+    ## A default mapper that does nothing
+    class NilMapper
+      def map(_json, _resource); end
+    end
+  end
+end

data/lib/trusona/mappers/tru_code_mapper.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Trusona
+  module Mappers
+    #
+    ## A Mapper for TruCodes
+    class TruCodeMapper < BaseMapper
+      def resource
+        Trusona::Resources::TruCode
+      end
+    end
+  end
+end

data/lib/trusona/mappers/trusonafication_mapper.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Trusona
+  module Mappers
+    ##
+    # A mapper for Trusonafication
+    class TrusonaficationMapper < BaseMapper
+      def resource
+        Trusona::Resources::Trusonafication
+      end
+
+      def custom_mappings
+        {
+          desired_level: :level
+        }
+      end
+    end
+  end
+end

data/lib/trusona/mappers/user_account_mapper.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Trusona
+  module Mappers
+    #
+    ## A Mapper for User Accounts
+    class UserAccountMapper < BaseMapper
+      def resource
+        Trusona::Resources::UserAccount
+      end
+    end
+  end
+end

data/lib/trusona/mappers/user_identifier_mapper.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Trusona
+  module Mappers
+    #
+    ## A Mapper for UserIdentifiers
+    class UserIdentifierMapper < BaseMapper
+      def resource
+        Trusona::Resources::UserIdentifier
+      end
+    end
+  end
+end

data/lib/trusona/resources/base_resource.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Trusona
+  module Resources
+    #
+    ## A base resource
+    class BaseResource
+      include Trusona::Resources::Validators
+      attr_reader :id
+
+      def initialize(params = {})
+        @params = params
+        @id = params[:id] || params['id']
+      end
+
+      def to_h
+        @params
+      end
+
+      def to_json
+        JSON(to_h)
+      end
+
+      def valid?
+        true
+      end
+    end
+  end
+end

data/lib/trusona/resources/device.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Trusona
+  module Resources
+    #
+    ## A record representing a device in the Trusona API
+    class Device < BaseResource
+      include Trusona::Helpers::KeyNormalizer
+      include Trusona::Helpers::TimeNormalizer
+
+      attr_reader :active, :activated_at
+
+      def initialize(params = {})
+        super
+        @params = normalize_keys(params)
+
+        @active       = @params[:active]
+        @activated_at = normalize_time(@params[:activated_at])
+      end
+    end
+  end
+end

data/lib/trusona/resources/device_user_binding.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Trusona
+  module Resources
+    #
+    ## A record representing a device and user binding in the Trusona API
+    class DeviceUserBinding < BaseResource
+      include Trusona::Resources::Validators
+      include Trusona::Helpers::KeyNormalizer
+      attr_reader :user_identifier, :device_identifier, :active, :id
+
+      def initialize(params = {})
+        normalized_params  = normalize_keys(params)
+        @user_identifier   = normalized_params[:user_identifier]
+        @device_identifier = normalized_params[:device_identifier]
+        @active            = normalized_params[:active]
+        @id                = normalized_params[:id]
+
+        @params = normalized_params
+        raise Trusona::InvalidResourceError unless validate
+      end
+
+      def validate
+        return false unless @user_identifier
+        return false unless @device_identifier
+        true
+      end
+    end
+  end
+end

data/lib/trusona/resources/device_user_binding_activation.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Trusona
+  module Resources
+    #
+    ## A Device User Binding Activation
+    class DeviceUserBindingActivation < BaseResource
+      include Trusona::Resources::Validators
+      include Trusona::Helpers::KeyNormalizer
+      attr_reader :id, :active
+
+      def initialize(params = {})
+        normalized_params = normalize_keys(params)
+        @id     = normalized_params[:id]
+        @active = normalized_params[:active]
+
+        @params = normalized_params
+        raise Trusona::InvalidResourceError unless validate
+      end
+
+      def validate
+        return false unless @id
+        true
+      end
+    end
+  end
+end

data/lib/trusona/resources/identity_document.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Trusona
+  module Resources
+    ##
+    # A record representing an identity document in the Trusona API
+    class IdentityDocument < BaseResource
+      include Trusona::Resources::Validators
+      include Trusona::Helpers::KeyNormalizer
+
+      attr_accessor :document_hash, :id, :type, :verification_status,
+                    :user_identifier
+
+      def initialize(params)
+        normalized = normalize_keys(params)
+
+        @params = normalized
+        @document_hash       = normalized[:document_hash]
+        @id                  = normalized[:id]
+        @type                = normalized[:type]
+        @verification_status = normalized[:verification_status]
+        @user_identifier     = normalized[:user_identifier]
+      end
+
+      def to_json
+        JSON(
+          hash: @document_hash,
+          id: @id,
+          type: @type,
+          verification_status: @verification_status,
+          user_identifier: @user_identifier
+        )
+      end
+    end
+  end
+end