mindee 4.13.0 → 5.0.0.beta1

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

@@ -1,143 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../../../parsing'
-require_relative 'payslip_v2_employee'
-require_relative 'payslip_v2_employer'
-require_relative 'payslip_v2_bank_account_detail'
-require_relative 'payslip_v2_employment'
-require_relative 'payslip_v2_salary_details'
-require_relative 'payslip_v2_pay_detail'
-require_relative 'payslip_v2_pto'
-require_relative 'payslip_v2_pay_period'
-
-module Mindee
-  module Product
-    module FR
-      module Payslip
-        # Payslip API version 2.0 document data.
-        class PayslipV2Document < Mindee::Parsing::Common::Prediction
-          include Mindee::Parsing::Standard
-          # Information about the employee's bank account.
-          # @return [Mindee::Product::FR::Payslip::PayslipV2BankAccountDetail]
-          attr_reader :bank_account_details
-          # Information about the employee.
-          # @return [Mindee::Product::FR::Payslip::PayslipV2Employee]
-          attr_reader :employee
-          # Information about the employer.
-          # @return [Mindee::Product::FR::Payslip::PayslipV2Employer]
-          attr_reader :employer
-          # Information about the employment.
-          # @return [Mindee::Product::FR::Payslip::PayslipV2Employment]
-          attr_reader :employment
-          # Detailed information about the pay.
-          # @return [Mindee::Product::FR::Payslip::PayslipV2PayDetail]
-          attr_reader :pay_detail
-          # Information about the pay period.
-          # @return [Mindee::Product::FR::Payslip::PayslipV2PayPeriod]
-          attr_reader :pay_period
-          # Information about paid time off.
-          # @return [Mindee::Product::FR::Payslip::PayslipV2Pto]
-          attr_reader :pto
-          # Detailed information about the earnings.
-          # @return [Mindee::Product::FR::Payslip::PayslipV2SalaryDetails]
-          attr_reader :salary_details
-
-          # @param prediction [Hash]
-          # @param page_id [Integer, nil]
-          def initialize(prediction, page_id)
-            super
-            @bank_account_details = Product::FR::Payslip::PayslipV2BankAccountDetail.new(
-              prediction['bank_account_details'],
-              page_id
-            )
-            @employee = Product::FR::Payslip::PayslipV2Employee.new(
-              prediction['employee'],
-              page_id
-            )
-            @employer = Product::FR::Payslip::PayslipV2Employer.new(
-              prediction['employer'],
-              page_id
-            )
-            @employment = Product::FR::Payslip::PayslipV2Employment.new(
-              prediction['employment'],
-              page_id
-            )
-            @pay_detail = Product::FR::Payslip::PayslipV2PayDetail.new(
-              prediction['pay_detail'],
-              page_id
-            )
-            @pay_period = Product::FR::Payslip::PayslipV2PayPeriod.new(
-              prediction['pay_period'],
-              page_id
-            )
-            @pto = Product::FR::Payslip::PayslipV2Pto.new(prediction['pto'], page_id)
-            @salary_details = Product::FR::Payslip::PayslipV2SalaryDetails.new(prediction['salary_details'], page_id)
-          end
-
-          # @return [String]
-          def to_s
-            employee = @employee.to_s
-            employer = @employer.to_s
-            bank_account_details = @bank_account_details.to_s
-            employment = @employment.to_s
-            salary_details = salary_details_to_s
-            pay_detail = @pay_detail.to_s
-            pto = @pto.to_s
-            pay_period = @pay_period.to_s
-            out_str = String.new
-            out_str << "\n:Employee:"
-            out_str << employee
-            out_str << "\n:Employer:"
-            out_str << employer
-            out_str << "\n:Bank Account Details:"
-            out_str << bank_account_details
-            out_str << "\n:Employment:"
-            out_str << employment
-            out_str << "\n:Salary Details:"
-            out_str << salary_details
-            out_str << "\n:Pay Detail:"
-            out_str << pay_detail
-            out_str << "\n:PTO:"
-            out_str << pto
-            out_str << "\n:Pay Period:"
-            out_str << pay_period
-            out_str[1..].to_s
-          end
-
-          private
-
-          # @param char [String]
-          # @return [String]
-          def salary_details_separator(char)
-            out_str = String.new
-            out_str << '  '
-            out_str << "+#{char * 14}"
-            out_str << "+#{char * 11}"
-            out_str << "+#{char * 38}"
-            out_str << "+#{char * 11}"
-            out_str << '+'
-            out_str
-          end
-
-          # @return [String]
-          def salary_details_to_s
-            return '' if @salary_details.empty?
-
-            line_items = @salary_details.map(&:to_table_line).join("\n#{salary_details_separator('-')}\n  ")
-            out_str = String.new
-            out_str << "\n#{salary_details_separator('-')}"
-            out_str << "\n  |"
-            out_str << ' Amount       |'
-            out_str << ' Base      |'
-            out_str << ' Description                          |'
-            out_str << ' Rate      |'
-            out_str << "\n#{salary_details_separator('=')}"
-            out_str << "\n  #{line_items}"
-            out_str << "\n#{salary_details_separator('-')}"
-            out_str
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,78 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../../../parsing'
-
-module Mindee
-  module Product
-    module FR
-      module Payslip
-        # Information about the employee.
-        class PayslipV2Employee < Mindee::Parsing::Standard::FeatureField
-          include Mindee::Parsing::Standard
-          # The address of the employee.
-          # @return [String]
-          attr_reader :address
-          # The date of birth of the employee.
-          # @return [String]
-          attr_reader :date_of_birth
-          # The first name of the employee.
-          # @return [String]
-          attr_reader :first_name
-          # The last name of the employee.
-          # @return [String]
-          attr_reader :last_name
-          # The phone number of the employee.
-          # @return [String]
-          attr_reader :phone_number
-          # The registration number of the employee.
-          # @return [String]
-          attr_reader :registration_number
-          # The social security number of the employee.
-          # @return [String]
-          attr_reader :social_security_number
-
-          # @param prediction [Hash]
-          # @param page_id [Integer, nil]
-          def initialize(prediction, page_id)
-            super
-            @address = prediction['address']
-            @date_of_birth = prediction['date_of_birth']
-            @first_name = prediction['first_name']
-            @last_name = prediction['last_name']
-            @phone_number = prediction['phone_number']
-            @registration_number = prediction['registration_number']
-            @social_security_number = prediction['social_security_number']
-            @page_id = page_id
-          end
-
-          # @return [Hash]
-          def printable_values
-            printable = {}
-            printable[:address] = format_for_display(@address)
-            printable[:date_of_birth] = format_for_display(@date_of_birth)
-            printable[:first_name] = format_for_display(@first_name)
-            printable[:last_name] = format_for_display(@last_name)
-            printable[:phone_number] = format_for_display(@phone_number)
-            printable[:registration_number] = format_for_display(@registration_number)
-            printable[:social_security_number] = format_for_display(@social_security_number)
-            printable
-          end
-
-          # @return [String]
-          def to_s
-            printable = printable_values
-            out_str = String.new
-            out_str << "\n  :Address: #{printable[:address]}"
-            out_str << "\n  :Date of Birth: #{printable[:date_of_birth]}"
-            out_str << "\n  :First Name: #{printable[:first_name]}"
-            out_str << "\n  :Last Name: #{printable[:last_name]}"
-            out_str << "\n  :Phone Number: #{printable[:phone_number]}"
-            out_str << "\n  :Registration Number: #{printable[:registration_number]}"
-            out_str << "\n  :Social Security Number: #{printable[:social_security_number]}"
-            out_str
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,78 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../../../parsing'
-
-module Mindee
-  module Product
-    module FR
-      module Payslip
-        # Information about the employer.
-        class PayslipV2Employer < Mindee::Parsing::Standard::FeatureField
-          include Mindee::Parsing::Standard
-          # The address of the employer.
-          # @return [String]
-          attr_reader :address
-          # The company ID of the employer.
-          # @return [String]
-          attr_reader :company_id
-          # The site of the company.
-          # @return [String]
-          attr_reader :company_site
-          # The NAF code of the employer.
-          # @return [String]
-          attr_reader :naf_code
-          # The name of the employer.
-          # @return [String]
-          attr_reader :name
-          # The phone number of the employer.
-          # @return [String]
-          attr_reader :phone_number
-          # The URSSAF number of the employer.
-          # @return [String]
-          attr_reader :urssaf_number
-
-          # @param prediction [Hash]
-          # @param page_id [Integer, nil]
-          def initialize(prediction, page_id)
-            super
-            @address = prediction['address']
-            @company_id = prediction['company_id']
-            @company_site = prediction['company_site']
-            @naf_code = prediction['naf_code']
-            @name = prediction['name']
-            @phone_number = prediction['phone_number']
-            @urssaf_number = prediction['urssaf_number']
-            @page_id = page_id
-          end
-
-          # @return [Hash]
-          def printable_values
-            printable = {}
-            printable[:address] = format_for_display(@address)
-            printable[:company_id] = format_for_display(@company_id)
-            printable[:company_site] = format_for_display(@company_site)
-            printable[:naf_code] = format_for_display(@naf_code)
-            printable[:name] = format_for_display(@name)
-            printable[:phone_number] = format_for_display(@phone_number)
-            printable[:urssaf_number] = format_for_display(@urssaf_number)
-            printable
-          end
-
-          # @return [String]
-          def to_s
-            printable = printable_values
-            out_str = String.new
-            out_str << "\n  :Address: #{printable[:address]}"
-            out_str << "\n  :Company ID: #{printable[:company_id]}"
-            out_str << "\n  :Company Site: #{printable[:company_site]}"
-            out_str << "\n  :NAF Code: #{printable[:naf_code]}"
-            out_str << "\n  :Name: #{printable[:name]}"
-            out_str << "\n  :Phone Number: #{printable[:phone_number]}"
-            out_str << "\n  :URSSAF Number: #{printable[:urssaf_number]}"
-            out_str
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,73 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../../../parsing'
-
-module Mindee
-  module Product
-    module FR
-      module Payslip
-        # Information about the employment.
-        class PayslipV2Employment < Mindee::Parsing::Standard::FeatureField
-          include Mindee::Parsing::Standard
-          # The category of the employment.
-          # @return [String]
-          attr_reader :category
-          # The coefficient of the employment.
-          # @return [Float]
-          attr_reader :coefficient
-          # The collective agreement of the employment.
-          # @return [String]
-          attr_reader :collective_agreement
-          # The job title of the employee.
-          # @return [String]
-          attr_reader :job_title
-          # The position level of the employment.
-          # @return [String]
-          attr_reader :position_level
-          # The start date of the employment.
-          # @return [String]
-          attr_reader :start_date
-
-          # @param prediction [Hash]
-          # @param page_id [Integer, nil]
-          def initialize(prediction, page_id)
-            super
-            @category = prediction['category']
-            @coefficient = prediction['coefficient']
-            @collective_agreement = prediction['collective_agreement']
-            @job_title = prediction['job_title']
-            @position_level = prediction['position_level']
-            @start_date = prediction['start_date']
-            @page_id = page_id
-          end
-
-          # @return [Hash]
-          def printable_values
-            printable = {}
-            printable[:category] = format_for_display(@category)
-            printable[:coefficient] =
-              @coefficient.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@coefficient)
-            printable[:collective_agreement] = format_for_display(@collective_agreement)
-            printable[:job_title] = format_for_display(@job_title)
-            printable[:position_level] = format_for_display(@position_level)
-            printable[:start_date] = format_for_display(@start_date)
-            printable
-          end
-
-          # @return [String]
-          def to_s
-            printable = printable_values
-            out_str = String.new
-            out_str << "\n  :Category: #{printable[:category]}"
-            out_str << "\n  :Coefficient: #{printable[:coefficient]}"
-            out_str << "\n  :Collective Agreement: #{printable[:collective_agreement]}"
-            out_str << "\n  :Job Title: #{printable[:job_title]}"
-            out_str << "\n  :Position Level: #{printable[:position_level]}"
-            out_str << "\n  :Start Date: #{printable[:start_date]}"
-            out_str
-          end
-        end
-      end
-    end
-  end
-end

data/lib/mindee/product/fr/payslip/payslip_v2_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 PayslipV2PayDetail < 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_v2_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 PayslipV2PayPeriod < 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_v2_pto.rb

@@ -1,65 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../../../parsing'
-
-module Mindee
-  module Product
-    module FR
-      module Payslip
-        # Information about paid time off.
-        class PayslipV2Pto < Mindee::Parsing::Standard::FeatureField
-          include Mindee::Parsing::Standard
-          # The amount of paid time off accrued in this period.
-          # @return [Float]
-          attr_reader :accrued_this_period
-          # The balance of paid time off at the end of the period.
-          # @return [Float]
-          attr_reader :balance_end_of_period
-          # The amount of paid time off used in this period.
-          # @return [Float]
-          attr_reader :used_this_period
-
-          # @param prediction [Hash]
-          # @param page_id [Integer, nil]
-          def initialize(prediction, page_id)
-            super
-            @accrued_this_period = prediction['accrued_this_period']
-            @balance_end_of_period = prediction['balance_end_of_period']
-            @used_this_period = prediction['used_this_period']
-            @page_id = page_id
-          end
-
-          # @return [Hash]
-          def printable_values
-            printable = {}
-            printable[:accrued_this_period] =
-              if @accrued_this_period.nil?
-                ''
-              else
-                Parsing::Standard::BaseField.float_to_string(@accrued_this_period)
-              end
-            printable[:balance_end_of_period] =
-              if @balance_end_of_period.nil?
-                ''
-              else
-                Parsing::Standard::BaseField.float_to_string(@balance_end_of_period)
-              end
-            printable[:used_this_period] =
-              @used_this_period.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@used_this_period)
-            printable
-          end
-
-          # @return [String]
-          def to_s
-            printable = printable_values
-            out_str = String.new
-            out_str << "\n  :Accrued This Period: #{printable[:accrued_this_period]}"
-            out_str << "\n  :Balance End of Period: #{printable[:balance_end_of_period]}"
-            out_str << "\n  :Used This Period: #{printable[:used_this_period]}"
-            out_str
-          end
-        end
-      end
-    end
-  end
-end