mindee 4.13.0 → 5.0.0.rc1

data/lib/mindee/product/fr/payslip/payslip_v3_pay_detail.rb

@@ -1,122 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../../../parsing'
-
-module Mindee
-  module Product
-    module FR
-      module Payslip
-        # Detailed information about the pay.
-        class PayslipV3PayDetail < Mindee::Parsing::Standard::FeatureField
-          include Mindee::Parsing::Standard
-          # The gross salary of the employee.
-          # @return [Float]
-          attr_reader :gross_salary
-          # The year-to-date gross salary of the employee.
-          # @return [Float]
-          attr_reader :gross_salary_ytd
-          # The income tax rate of the employee.
-          # @return [Float]
-          attr_reader :income_tax_rate
-          # The income tax withheld from the employee's pay.
-          # @return [Float]
-          attr_reader :income_tax_withheld
-          # The net paid amount of the employee.
-          # @return [Float]
-          attr_reader :net_paid
-          # The net paid amount before tax of the employee.
-          # @return [Float]
-          attr_reader :net_paid_before_tax
-          # The net taxable amount of the employee.
-          # @return [Float]
-          attr_reader :net_taxable
-          # The year-to-date net taxable amount of the employee.
-          # @return [Float]
-          attr_reader :net_taxable_ytd
-          # The total cost to the employer.
-          # @return [Float]
-          attr_reader :total_cost_employer
-          # The total taxes and deductions of the employee.
-          # @return [Float]
-          attr_reader :total_taxes_and_deductions
-
-          # @param prediction [Hash]
-          # @param page_id [Integer, nil]
-          def initialize(prediction, page_id)
-            super
-            @gross_salary = prediction['gross_salary']
-            @gross_salary_ytd = prediction['gross_salary_ytd']
-            @income_tax_rate = prediction['income_tax_rate']
-            @income_tax_withheld = prediction['income_tax_withheld']
-            @net_paid = prediction['net_paid']
-            @net_paid_before_tax = prediction['net_paid_before_tax']
-            @net_taxable = prediction['net_taxable']
-            @net_taxable_ytd = prediction['net_taxable_ytd']
-            @total_cost_employer = prediction['total_cost_employer']
-            @total_taxes_and_deductions = prediction['total_taxes_and_deductions']
-            @page_id = page_id
-          end
-
-          # @return [Hash]
-          def printable_values
-            printable = {}
-            printable[:gross_salary] =
-              @gross_salary.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@gross_salary)
-            printable[:gross_salary_ytd] =
-              @gross_salary_ytd.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@gross_salary_ytd)
-            printable[:income_tax_rate] =
-              @income_tax_rate.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@income_tax_rate)
-            printable[:income_tax_withheld] =
-              if @income_tax_withheld.nil?
-                ''
-              else
-                Parsing::Standard::BaseField.float_to_string(@income_tax_withheld)
-              end
-            printable[:net_paid] =
-              @net_paid.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@net_paid)
-            printable[:net_paid_before_tax] =
-              if @net_paid_before_tax.nil?
-                ''
-              else
-                Parsing::Standard::BaseField.float_to_string(@net_paid_before_tax)
-              end
-            printable[:net_taxable] =
-              @net_taxable.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@net_taxable)
-            printable[:net_taxable_ytd] =
-              @net_taxable_ytd.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@net_taxable_ytd)
-            printable[:total_cost_employer] =
-              if @total_cost_employer.nil?
-                ''
-              else
-                Parsing::Standard::BaseField.float_to_string(@total_cost_employer)
-              end
-            printable[:total_taxes_and_deductions] =
-              if @total_taxes_and_deductions.nil?
-                ''
-              else
-                Parsing::Standard::BaseField.float_to_string(@total_taxes_and_deductions)
-              end
-            printable
-          end
-
-          # @return [String]
-          def to_s
-            printable = printable_values
-            out_str = String.new
-            out_str << "\n  :Gross Salary: #{printable[:gross_salary]}"
-            out_str << "\n  :Gross Salary YTD: #{printable[:gross_salary_ytd]}"
-            out_str << "\n  :Income Tax Rate: #{printable[:income_tax_rate]}"
-            out_str << "\n  :Income Tax Withheld: #{printable[:income_tax_withheld]}"
-            out_str << "\n  :Net Paid: #{printable[:net_paid]}"
-            out_str << "\n  :Net Paid Before Tax: #{printable[:net_paid_before_tax]}"
-            out_str << "\n  :Net Taxable: #{printable[:net_taxable]}"
-            out_str << "\n  :Net Taxable YTD: #{printable[:net_taxable_ytd]}"
-            out_str << "\n  :Total Cost Employer: #{printable[:total_cost_employer]}"
-            out_str << "\n  :Total Taxes and Deductions: #{printable[:total_taxes_and_deductions]}"
-            out_str
-          end
-        end
-      end
-    end
-  end
-end

data/lib/mindee/product/fr/payslip/payslip_v3_pay_period.rb

@@ -1,66 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../../../parsing'
-
-module Mindee
-  module Product
-    module FR
-      module Payslip
-        # Information about the pay period.
-        class PayslipV3PayPeriod < Mindee::Parsing::Standard::FeatureField
-          include Mindee::Parsing::Standard
-          # The end date of the pay period.
-          # @return [String]
-          attr_reader :end_date
-          # The month of the pay period.
-          # @return [String]
-          attr_reader :month
-          # The date of payment for the pay period.
-          # @return [String]
-          attr_reader :payment_date
-          # The start date of the pay period.
-          # @return [String]
-          attr_reader :start_date
-          # The year of the pay period.
-          # @return [String]
-          attr_reader :year
-
-          # @param prediction [Hash]
-          # @param page_id [Integer, nil]
-          def initialize(prediction, page_id)
-            super
-            @end_date = prediction['end_date']
-            @month = prediction['month']
-            @payment_date = prediction['payment_date']
-            @start_date = prediction['start_date']
-            @year = prediction['year']
-            @page_id = page_id
-          end
-
-          # @return [Hash]
-          def printable_values
-            printable = {}
-            printable[:end_date] = format_for_display(@end_date)
-            printable[:month] = format_for_display(@month)
-            printable[:payment_date] = format_for_display(@payment_date)
-            printable[:start_date] = format_for_display(@start_date)
-            printable[:year] = format_for_display(@year)
-            printable
-          end
-
-          # @return [String]
-          def to_s
-            printable = printable_values
-            out_str = String.new
-            out_str << "\n  :End Date: #{printable[:end_date]}"
-            out_str << "\n  :Month: #{printable[:month]}"
-            out_str << "\n  :Payment Date: #{printable[:payment_date]}"
-            out_str << "\n  :Start Date: #{printable[:start_date]}"
-            out_str << "\n  :Year: #{printable[:year]}"
-            out_str
-          end
-        end
-      end
-    end
-  end
-end

data/lib/mindee/product/fr/payslip/payslip_v3_salary_detail.rb

@@ -1,97 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../../../parsing'
-
-module Mindee
-  module Product
-    module FR
-      module Payslip
-        # Detailed information about the earnings.
-        class PayslipV3SalaryDetail < Mindee::Parsing::Standard::FeatureField
-          include Mindee::Parsing::Standard
-          # The amount of the earning.
-          # @return [Float]
-          attr_reader :amount
-          # The base rate value of the earning.
-          # @return [Float]
-          attr_reader :base
-          # The description of the earnings.
-          # @return [String]
-          attr_reader :description
-          # The number of units in the earning.
-          # @return [Float]
-          attr_reader :number
-          # The rate of the earning.
-          # @return [Float]
-          attr_reader :rate
-
-          # @param prediction [Hash]
-          # @param page_id [Integer, nil]
-          def initialize(prediction, page_id)
-            super
-            @amount = prediction['amount']
-            @base = prediction['base']
-            @description = prediction['description']
-            @number = prediction['number']
-            @rate = prediction['rate']
-            @page_id = page_id
-          end
-
-          # @return [Hash]
-          def printable_values
-            printable = {}
-            printable[:amount] =
-              @amount.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@amount)
-            printable[:base] =
-              @base.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@base)
-            printable[:description] = format_for_display(@description)
-            printable[:number] =
-              @number.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@number)
-            printable[:rate] =
-              @rate.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@rate)
-            printable
-          end
-
-          # @return [Hash]
-          def table_printable_values
-            printable = {}
-            printable[:amount] =
-              @amount.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@amount)
-            printable[:base] =
-              @base.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@base)
-            printable[:description] = format_for_display(@description, 36)
-            printable[:number] =
-              @number.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@number)
-            printable[:rate] =
-              @rate.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@rate)
-            printable
-          end
-
-          # @return [String]
-          def to_table_line
-            printable = table_printable_values
-            out_str = String.new
-            out_str << format('| %- 13s', printable[:amount])
-            out_str << format('| %- 10s', printable[:base])
-            out_str << format('| %- 37s', printable[:description])
-            out_str << format('| %- 7s', printable[:number])
-            out_str << format('| %- 10s', printable[:rate])
-            out_str << '|'
-          end
-
-          # @return [String]
-          def to_s
-            printable = printable_values
-            out_str = String.new
-            out_str << "\n  :Amount: #{printable[:amount]}"
-            out_str << "\n  :Base: #{printable[:base]}"
-            out_str << "\n  :Description: #{printable[:description]}"
-            out_str << "\n  :Number: #{printable[:number]}"
-            out_str << "\n  :Rate: #{printable[:rate]}"
-            out_str
-          end
-        end
-      end
-    end
-  end
-end

data/lib/mindee/product/fr/payslip/payslip_v3_salary_details.rb

@@ -1,65 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'payslip_v3_pay_period'
-require_relative 'payslip_v3_employee'
-require_relative 'payslip_v3_employer'
-require_relative 'payslip_v3_bank_account_detail'
-require_relative 'payslip_v3_employment'
-require_relative 'payslip_v3_salary_detail'
-require_relative 'payslip_v3_pay_detail'
-require_relative 'payslip_v3_paid_time_off'
-
-module Mindee
-  module Product
-    module FR
-      module Payslip
-        # Detailed information about the earnings.
-        class PayslipV3SalaryDetails < Array
-          # Entries.
-          # @return [Array<PayslipV3SalaryDetail>]
-          attr_reader :entries
-
-          # @param prediction [Array]
-          # @param page_id [Integer, nil]
-          def initialize(prediction, page_id)
-            entries = prediction.map do |entry|
-              Payslip::PayslipV3SalaryDetail.new(entry, page_id)
-            end
-            super(entries)
-          end
-
-          # Creates a line of rST table-compliant string separators.
-          # @param char [String] Character to use as a separator.
-          # @return [String]
-          def self.line_items_separator(char)
-            out_str = String.new
-            out_str << "+#{char * 14}"
-            out_str << "+#{char * 11}"
-            out_str << "+#{char * 38}"
-            out_str << "+#{char * 8}"
-            out_str << "+#{char * 11}"
-            out_str
-          end
-
-          # @return [String]
-          def to_s
-            return '' if empty?
-
-            lines = map do |entry|
-              "\n  #{entry.to_table_line}\n#{self.class.line_items_separator('-')}"
-            end.join
-            out_str = String.new
-            out_str << "\n#{self.class.line_items_separator('-')}\n "
-            out_str << ' | Amount      '
-            out_str << ' | Base     '
-            out_str << ' | Description                         '
-            out_str << ' | Number'
-            out_str << ' | Rate     '
-            out_str << " |\n#{self.class.line_items_separator('=')}"
-            out_str + lines
-          end
-        end
-      end
-    end
-  end
-end

data/lib/mindee/product/ind/indian_passport/indian_passport_v1_document.rb

@@ -1,206 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../../../parsing'
-
-module Mindee
-  module Product
-    module IND
-      module IndianPassport
-        # Passport - India API version 1.2 document data.
-        class IndianPassportV1Document < Mindee::Parsing::Common::Prediction
-          include Mindee::Parsing::Standard
-          # The first line of the address of the passport holder.
-          # @return [Mindee::Parsing::Standard::StringField]
-          attr_reader :address1
-          # The second line of the address of the passport holder.
-          # @return [Mindee::Parsing::Standard::StringField]
-          attr_reader :address2
-          # The third line of the address of the passport holder.
-          # @return [Mindee::Parsing::Standard::StringField]
-          attr_reader :address3
-          # The birth date of the passport holder, ISO format: YYYY-MM-DD.
-          # @return [Mindee::Parsing::Standard::DateField]
-          attr_reader :birth_date
-          # The birth place of the passport holder.
-          # @return [Mindee::Parsing::Standard::StringField]
-          attr_reader :birth_place
-          # ISO 3166-1 alpha-3 country code (3 letters format).
-          # @return [Mindee::Parsing::Standard::StringField]
-          attr_reader :country
-          # The date when the passport will expire, ISO format: YYYY-MM-DD.
-          # @return [Mindee::Parsing::Standard::DateField]
-          attr_reader :expiry_date
-          # The file number of the passport document.
-          # @return [Mindee::Parsing::Standard::StringField]
-          attr_reader :file_number
-          # The gender of the passport holder.
-          # @return [Mindee::Parsing::Standard::ClassificationField]
-          attr_reader :gender
-          # The given names of the passport holder.
-          # @return [Mindee::Parsing::Standard::StringField]
-          attr_reader :given_names
-          # The identification number of the passport document.
-          # @return [Mindee::Parsing::Standard::StringField]
-          attr_reader :id_number
-          # The date when the passport was issued, ISO format: YYYY-MM-DD.
-          # @return [Mindee::Parsing::Standard::DateField]
-          attr_reader :issuance_date
-          # The place where the passport was issued.
-          # @return [Mindee::Parsing::Standard::StringField]
-          attr_reader :issuance_place
-          # The name of the legal guardian of the passport holder (if applicable).
-          # @return [Mindee::Parsing::Standard::StringField]
-          attr_reader :legal_guardian
-          # The first line of the machine-readable zone (MRZ) of the passport document.
-          # @return [Mindee::Parsing::Standard::StringField]
-          attr_reader :mrz1
-          # The second line of the machine-readable zone (MRZ) of the passport document.
-          # @return [Mindee::Parsing::Standard::StringField]
-          attr_reader :mrz2
-          # The name of the mother of the passport holder.
-          # @return [Mindee::Parsing::Standard::StringField]
-          attr_reader :name_of_mother
-          # The name of the spouse of the passport holder (if applicable).
-          # @return [Mindee::Parsing::Standard::StringField]
-          attr_reader :name_of_spouse
-          # The date of issue of the old passport (if applicable), ISO format: YYYY-MM-DD.
-          # @return [Mindee::Parsing::Standard::DateField]
-          attr_reader :old_passport_date_of_issue
-          # The number of the old passport (if applicable).
-          # @return [Mindee::Parsing::Standard::StringField]
-          attr_reader :old_passport_number
-          # The place of issue of the old passport (if applicable).
-          # @return [Mindee::Parsing::Standard::StringField]
-          attr_reader :old_passport_place_of_issue
-          # The page number of the passport document.
-          # @return [Mindee::Parsing::Standard::ClassificationField]
-          attr_reader :page_number
-          # The surname of the passport holder.
-          # @return [Mindee::Parsing::Standard::StringField]
-          attr_reader :surname
-
-          # @param prediction [Hash]
-          # @param page_id [Integer, nil]
-          def initialize(prediction, page_id)
-            super
-            @address1 = Parsing::Standard::StringField.new(
-              prediction['address1'],
-              page_id
-            )
-            @address2 = Parsing::Standard::StringField.new(
-              prediction['address2'],
-              page_id
-            )
-            @address3 = Parsing::Standard::StringField.new(
-              prediction['address3'],
-              page_id
-            )
-            @birth_date = Parsing::Standard::DateField.new(
-              prediction['birth_date'],
-              page_id
-            )
-            @birth_place = Parsing::Standard::StringField.new(
-              prediction['birth_place'],
-              page_id
-            )
-            @country = Parsing::Standard::StringField.new(
-              prediction['country'],
-              page_id
-            )
-            @expiry_date = Parsing::Standard::DateField.new(
-              prediction['expiry_date'],
-              page_id
-            )
-            @file_number = Parsing::Standard::StringField.new(
-              prediction['file_number'],
-              page_id
-            )
-            @gender = Parsing::Standard::ClassificationField.new(
-              prediction['gender'],
-              page_id
-            )
-            @given_names = Parsing::Standard::StringField.new(
-              prediction['given_names'],
-              page_id
-            )
-            @id_number = Parsing::Standard::StringField.new(
-              prediction['id_number'],
-              page_id
-            )
-            @issuance_date = Parsing::Standard::DateField.new(
-              prediction['issuance_date'],
-              page_id
-            )
-            @issuance_place = Parsing::Standard::StringField.new(
-              prediction['issuance_place'],
-              page_id
-            )
-            @legal_guardian = Parsing::Standard::StringField.new(
-              prediction['legal_guardian'],
-              page_id
-            )
-            @mrz1 = Parsing::Standard::StringField.new(prediction['mrz1'], page_id)
-            @mrz2 = Parsing::Standard::StringField.new(prediction['mrz2'], page_id)
-            @name_of_mother = Parsing::Standard::StringField.new(
-              prediction['name_of_mother'],
-              page_id
-            )
-            @name_of_spouse = Parsing::Standard::StringField.new(
-              prediction['name_of_spouse'],
-              page_id
-            )
-            @old_passport_date_of_issue = Parsing::Standard::DateField.new(
-              prediction['old_passport_date_of_issue'],
-              page_id
-            )
-            @old_passport_number = Parsing::Standard::StringField.new(
-              prediction['old_passport_number'],
-              page_id
-            )
-            @old_passport_place_of_issue = Parsing::Standard::StringField.new(
-              prediction['old_passport_place_of_issue'],
-              page_id
-            )
-            @page_number = Parsing::Standard::ClassificationField.new(
-              prediction['page_number'],
-              page_id
-            )
-            @surname = Parsing::Standard::StringField.new(
-              prediction['surname'],
-              page_id
-            )
-          end
-
-          # @return [String]
-          def to_s
-            out_str = String.new
-            out_str << "\n:Page Number: #{@page_number}".rstrip
-            out_str << "\n:Country: #{@country}".rstrip
-            out_str << "\n:ID Number: #{@id_number}".rstrip
-            out_str << "\n:Given Names: #{@given_names}".rstrip
-            out_str << "\n:Surname: #{@surname}".rstrip
-            out_str << "\n:Birth Date: #{@birth_date}".rstrip
-            out_str << "\n:Birth Place: #{@birth_place}".rstrip
-            out_str << "\n:Issuance Place: #{@issuance_place}".rstrip
-            out_str << "\n:Gender: #{@gender}".rstrip
-            out_str << "\n:Issuance Date: #{@issuance_date}".rstrip
-            out_str << "\n:Expiry Date: #{@expiry_date}".rstrip
-            out_str << "\n:MRZ Line 1: #{@mrz1}".rstrip
-            out_str << "\n:MRZ Line 2: #{@mrz2}".rstrip
-            out_str << "\n:Legal Guardian: #{@legal_guardian}".rstrip
-            out_str << "\n:Name of Spouse: #{@name_of_spouse}".rstrip
-            out_str << "\n:Name of Mother: #{@name_of_mother}".rstrip
-            out_str << "\n:Old Passport Date of Issue: #{@old_passport_date_of_issue}".rstrip
-            out_str << "\n:Old Passport Number: #{@old_passport_number}".rstrip
-            out_str << "\n:Old Passport Place of Issue: #{@old_passport_place_of_issue}".rstrip
-            out_str << "\n:Address Line 1: #{@address1}".rstrip
-            out_str << "\n:Address Line 2: #{@address2}".rstrip
-            out_str << "\n:Address Line 3: #{@address3}".rstrip
-            out_str << "\n:File Number: #{@file_number}".rstrip
-            out_str[1..].to_s
-          end
-        end
-      end
-    end
-  end
-end

data/lib/mindee/product/ind/indian_passport/indian_passport_v1_page.rb

@@ -1,38 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../../../parsing'
-require_relative 'indian_passport_v1_document'
-
-module Mindee
-  module Product
-    module IND
-      module IndianPassport
-        # Passport - India API version 1.2 page data.
-        class IndianPassportV1Page < Mindee::Parsing::Common::Page
-          # @param prediction [Hash]
-          def initialize(prediction)
-            super
-            @prediction = if prediction['prediction'].empty?
-                            nil
-                          else
-                            IndianPassportV1PagePrediction.new(
-                              prediction['prediction'],
-                              prediction['id']
-                            )
-                          end
-          end
-        end
-
-        # Passport - India V1 page prediction.
-        class IndianPassportV1PagePrediction < IndianPassportV1Document
-          # @return [String]
-          def to_s
-            out_str = String.new
-            out_str << "\n#{super}"
-            out_str
-          end
-        end
-      end
-    end
-  end
-end

data/lib/mindee/product/international_id/international_id_v2.rb

@@ -1,45 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../../parsing'
-require_relative 'international_id_v2_document'
-require_relative 'international_id_v2_page'
-
-module Mindee
-  module Product
-    # International ID module.
-    module InternationalId
-      # International ID API version 2 inference prediction.
-      class InternationalIdV2 < Mindee::Parsing::Common::Inference
-        @endpoint_name = 'international_id'
-        @endpoint_version = '2'
-        @has_async = true
-        @has_sync = false
-
-        # @param prediction [Hash]
-        def initialize(prediction)
-          super
-          @prediction = InternationalIdV2Document.new(prediction['prediction'], nil)
-          @pages = []
-          prediction['pages'].each do |page|
-            @pages.push(InternationalIdV2Page.new(page))
-          end
-        end
-
-        class << self
-          # Name of the endpoint for this product.
-          # @return [String]
-          attr_reader :endpoint_name
-          # Version for this product.
-          # @return [String]
-          attr_reader :endpoint_version
-          # Whether this product has access to an asynchronous endpoint.
-          # @return [bool]
-          attr_reader :has_async
-          # Whether this product has access to synchronous endpoint.
-          # @return [bool]
-          attr_reader :has_sync
-        end
-      end
-    end
-  end
-end