mindee 2.1.0 → 2.2.0

data/lib/mindee/parsing/prediction/{invoice/invoice_line_item.rb → financial_document/financial_document_v1_line_item.rb}

@@ -4,7 +4,7 @@ require_relative '../common_fields/base'
 
 module Mindee
   # Line items for invoices
-  class InvoiceLineItem
+  class FinancialDocumentV1LineItem
     # @return [String] The product code referring to the item.
     attr_reader :product_code
     # @return [String]
@@ -39,20 +39,20 @@ module Mindee
       @page_id = page_id
     end
 
+    # @return String
     def to_s
       tax = Field.float_to_string(@tax_amount)
       tax << " (#{Field.float_to_string(@tax_rate)}%)" unless @tax_rate.nil?
-
       description = @description.nil? ? '' : @description
       description = "#{description[0..32]}..." if description.size > 35
-
       out_str = String.new
-      out_str << format('%- 22s', @product_code)
-      out_str << " #{format('%- 8s', Field.float_to_string(@quantity))}"
-      out_str << " #{format('%- 9s', Field.float_to_string(@unit_price))}"
-      out_str << " #{format('%- 10s', Field.float_to_string(@total_amount))}"
-      out_str << " #{format('%- 18s', tax)}"
-      out_str << " #{description}"
+      out_str << format('| %- 20s', @product_code)
+      out_str << " #{format('| %- 7s', Field.float_to_string(@quantity))}"
+      out_str << " #{format('| %- 7s', Field.float_to_string(@unit_price))}"
+      out_str << " #{format('| %- 8s', Field.float_to_string(@total_amount))}"
+      out_str << " #{format('| %- 16s', tax)}"
+      out_str << " #{format('| %- 37s', description)}"
+      out_str << '|'
     end
   end
 end

data/lib/mindee/parsing/prediction/fr/bank_account_details/bank_account_details_v1.rb

@@ -6,15 +6,15 @@ require_relative '../../base'
 module Mindee
   module Prediction
     module FR
-      # French bank account information (RIB)
+      # Bank Account Details v1 prediction results.
       class BankAccountDetailsV1 < Prediction
-        # The account's IBAN.
+        # The International Bank Account Number (IBAN).
         # @return [Mindee::TextField]
         attr_reader :iban
-        # The account holder's name.
+        # The name of the account holder as seen on the document.
         # @return [Mindee::TextField]
         attr_reader :account_holder_name
-        # The bank's SWIFT code.
+        # The bank's SWIFT Business Identifier Code (BIC).
         # @return [Mindee::TextField]
         attr_reader :swift
 
@@ -30,8 +30,8 @@ module Mindee
         def to_s
           out_str = String.new
           out_str << "\n:IBAN: #{@iban}".rstrip
-          out_str << "\n:Account holder name: #{@account_holder_name}".rstrip
-          out_str << "\n:SWIFT: #{@swift}".rstrip
+          out_str << "\n:Account Holder's Name: #{@account_holder_name}".rstrip
+          out_str << "\n:SWIFT Code: #{@swift}".rstrip
           out_str[1..].to_s
         end
       end

data/lib/mindee/parsing/prediction/fr/carte_vitale/carte_vitale_v1.rb

@@ -6,18 +6,18 @@ require_relative '../../base'
 module Mindee
   module Prediction
     module FR
-      # French Carte Vitale
+      # Carte Vitale v1 prediction results.
       class CarteVitaleV1 < Prediction
-        # List of given (first) names of the cardholder.
+        # The given name(s) of the card holder.
         # @return [Array<Mindee::TextField>]
         attr_reader :given_names
-        # The surname (last name) of the cardholder.
+        # The surname of the card holder.
         # @return [Mindee::TextField]
         attr_reader :surname
-        # The social security number of the cardholder.
+        # The Social Security Number (Numéro de Sécurité Sociale) of the card holder
         # @return [Mindee::TextField]
         attr_reader :social_security
-        # The issuance date of the card.
+        # The date the card was issued.
         # @return [Mindee::DateField]
         attr_reader :issuance_date
 
@@ -35,12 +35,12 @@ module Mindee
         end
 
         def to_s
-          given_names = @given_names.map(&:value).join(', ')
+          given_names = @given_names.join("\n #{' ' * 15}")
           out_str = String.new
-          out_str << "\n:Given names: #{given_names}".rstrip
+          out_str << "\n:Given Name(s): #{given_names}".rstrip
           out_str << "\n:Surname: #{@surname}".rstrip
           out_str << "\n:Social Security Number: #{@social_security}".rstrip
-          out_str << "\n:Issuance date: #{@issuance_date}".rstrip
+          out_str << "\n:Issuance Date: #{@issuance_date}".rstrip
           out_str[1..].to_s
         end
       end

data/lib/mindee/parsing/prediction/fr/id_card/id_card_v1.rb

@@ -6,39 +6,39 @@ require_relative '../../base'
 module Mindee
   module Prediction
     module FR
-      # French national ID card
+      # Carte Nationale d'Identité v1 prediction results.
       class IdCardV1 < Prediction
-        # The authority which has issued the card.
-        # @return [Array<Mindee::TextField>]
-        attr_reader :authority
-        # Indicates if it is the recto side, the verso side or both.
+        # The side of the document which is visible.
         # @return [Mindee::TextField]
         attr_reader :document_side
-        # The card number.
+        # The identification card number.
         # @return [Mindee::TextField]
         attr_reader :id_number
-        # The expiration date of the card.
-        # @return [Mindee::DateField]
-        attr_reader :expiry_date
-        # The surname (last name) of the cardholder.
+        # The given name(s) of the card holder.
+        # @return [Array<Mindee::TextField>]
+        attr_reader :given_names
+        # The surname of the card holder.
         # @return [Mindee::TextField]
         attr_reader :surname
-        # List of first (given) names of the cardholder.
-        # @return [Mindee::TextField]
-        attr_reader :given_names
-        # The date of birth of the cardholder.
+        # The date of birth of the card holder.
         # @return [Mindee::DateField]
         attr_reader :birth_date
-        # The place of birth of the cardholder.
+        # The place of birth of the card holder.
         # @return [Mindee::TextField]
         attr_reader :birth_place
-        # The sex or gender of the cardholder.
+        # The expiry date of the identification card.
+        # @return [Mindee::DateField]
+        attr_reader :expiry_date
+        # The name of the issuing authority.
+        # @return [Mindee::TextField]
+        attr_reader :authority
+        # The gender of the card holder.
         # @return [Mindee::TextField]
         attr_reader :gender
-        # The value of the first MRZ line.
+        # Machine Readable Zone, first line
         # @return [Mindee::TextField]
         attr_reader :mrz1
-        # The value of the second MRZ line.
+        # Machine Readable Zone, second line
         # @return [Mindee::TextField]
         attr_reader :mrz2
 
@@ -49,33 +49,34 @@ module Mindee
           @document_side = TextField.new(prediction['document_side'], page_id) if page_id
           @authority = TextField.new(prediction['authority'], page_id)
           @id_number = TextField.new(prediction['id_number'], page_id)
+          @given_names = []
+          prediction['given_names'].each do |item|
+            @given_names.push(TextField.new(item, page_id))
+          end
+          @surname = TextField.new(prediction['surname'], page_id)
           @birth_date = DateField.new(prediction['birth_date'], page_id)
-          @expiry_date = DateField.new(prediction['expiry_date'], page_id)
           @birth_place = TextField.new(prediction['birth_place'], page_id)
+          @expiry_date = DateField.new(prediction['expiry_date'], page_id)
+          @authority = TextField.new(prediction['authority'], page_id)
           @gender = TextField.new(prediction['gender'], page_id)
-          @surname = TextField.new(prediction['surname'], page_id)
           @mrz1 = TextField.new(prediction['mrz1'], page_id)
           @mrz2 = TextField.new(prediction['mrz2'], page_id)
-          @given_names = []
-          prediction['given_names'].each do |item|
-            @given_names.push(TextField.new(item, page_id))
-          end
         end
 
         def to_s
-          given_names = @given_names.map(&:value).join(', ')
+          given_names = @given_names.join("\n #{' ' * 15}")
           out_str = String.new
-          out_str << "\n:Document side: #{@document_side}".rstrip if @document_side
-          out_str << "\n:Authority: #{@authority}".rstrip
-          out_str << "\n:Given names: #{given_names}".rstrip
+          out_str << "\n:Document Side: #{@document_side}".rstrip if @document_side
+          out_str << "\n:Identity Number: #{@id_number}".rstrip
+          out_str << "\n:Given Name(s): #{given_names}".rstrip
           out_str << "\n:Surname: #{@surname}".rstrip
+          out_str << "\n:Date of Birth: #{@birth_date}".rstrip
+          out_str << "\n:Place of Birth: #{@birth_place}".rstrip
+          out_str << "\n:Expiry Date: #{@expiry_date}".rstrip
+          out_str << "\n:Issuing Authority: #{@authority}".rstrip
           out_str << "\n:Gender: #{@gender}".rstrip
-          out_str << "\n:ID Number: #{@id_number}".rstrip
-          out_str << "\n:Birth date: #{@birth_date}".rstrip
-          out_str << "\n:Birth place: #{@birth_place}".rstrip
-          out_str << "\n:Expiry date: #{@expiry_date}".rstrip
-          out_str << "\n:MRZ 1: #{@mrz1}".rstrip
-          out_str << "\n:MRZ 2: #{@mrz2}".rstrip
+          out_str << "\n:MRZ Line 1: #{@mrz1}".rstrip
+          out_str << "\n:MRZ Line 2: #{@mrz2}".rstrip
           out_str[1..].to_s
         end
       end

data/lib/mindee/parsing/prediction/invoice/invoice_v4.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
 require_relative '../common_fields'
-require_relative 'invoice_line_item'
 require_relative '../base'
+require_relative 'invoice_v4_line_item'
 
 module Mindee
   module Prediction
@@ -60,7 +60,7 @@ module Mindee
       # @return [Array<Mindee::CompanyRegistration>]
       attr_reader :supplier_company_registrations
       # Line items details.
-      # @return [Array<Mindee::InvoiceLineItem>]
+      # @return [Array<Mindee::InvoiceV4LineItem>]
       attr_reader :line_items
 
       # @param prediction [Hash]
@@ -78,7 +78,6 @@ module Mindee
         @invoice_number = TextField.new(prediction['invoice_number'], page_id)
         @supplier_name = TextField.new(prediction['supplier_name'], page_id)
         @supplier_address = TextField.new(prediction['supplier_address'], page_id)
-
         @reference_numbers = []
         prediction['reference_numbers'].each do |item|
           @reference_numbers.push(TextField.new(item, page_id))
@@ -99,14 +98,12 @@ module Mindee
         prediction['supplier_company_registrations'].each do |item|
           @supplier_company_registrations.push(CompanyRegistration.new(item, page_id))
         end
-
         @total_tax = AmountField.new(
           { value: nil, confidence: 0.0 }, page_id
         )
-
         @line_items = []
         prediction['line_items'].each do |item|
-          @line_items.push(InvoiceLineItem.new(item, page_id))
+          @line_items.push(InvoiceV4LineItem.new(item, page_id))
         end
         reconstruct(page_id)
       end
@@ -124,39 +121,38 @@ module Mindee
         out_str << "\n:Reference numbers: #{reference_numbers}".rstrip
         out_str << "\n:Invoice date: #{@date}".rstrip
         out_str << "\n:Invoice due date: #{@due_date}".rstrip
-
         out_str << "\n:Supplier name: #{@supplier_name}".rstrip
         out_str << "\n:Supplier address: #{@supplier_address}".rstrip
         out_str << "\n:Supplier company registrations: #{supplier_company_registrations}".rstrip
         out_str << "\n:Supplier payment details: #{supplier_payment_details}".rstrip
-
         out_str << "\n:Customer name: #{@customer_name}".rstrip
         out_str << "\n:Customer address: #{@customer_address}".rstrip
         out_str << "\n:Customer company registrations: #{customer_company_registrations}".rstrip
-
         out_str << "\n:Taxes: #{taxes}".rstrip
         out_str << "\n:Total net: #{@total_net}".rstrip
         out_str << "\n:Total taxes: #{@total_tax}".rstrip
         out_str << "\n:Total amount: #{@total_amount}".rstrip
+        out_str << "\n:Line Items:"
         out_str << line_items_to_s
-
         out_str[1..].to_s
       end
 
       private
 
+      def line_item_separator(char)
+        "  +#{char * 22}+#{char * 9}+#{char * 9}+#{char * 10}+#{char * 18}+#{char * 38}+"
+      end
+
       def line_items_to_s
         return '' if @line_items.empty?
 
-        line_item_separator = "#{'=' * 22} #{'=' * 8} #{'=' * 9} #{'=' * 10} #{'=' * 18} #{'=' * 36}"
-        line_items = @line_items.map(&:to_s).join("\n")
+        line_items = @line_items.map(&:to_s).join("\n#{line_item_separator('-')}\n  ")
         out_str = String.new
-        out_str << "\n\n:Line Items:"
-        out_str << "\n#{line_item_separator}"
-        out_str << "\nCode                   QTY      Price     Amount     Tax (Rate)         Description"
-        out_str << "\n#{line_item_separator}"
-        out_str << "\n#{line_items}"
-        out_str << "\n#{line_item_separator}" unless line_items.empty?
+        out_str << "\n#{line_item_separator('-')}"
+        out_str << "\n  | Code#{' ' * 17}| QTY     | Price   | Amount   | Tax (Rate)       | Description #{' ' * 25}|"
+        out_str << "\n#{line_item_separator('=')}"
+        out_str << "\n  #{line_items}"
+        out_str << "\n#{line_item_separator('-')}"
       end
 
       def reconstruct(page_id)

data/lib/mindee/parsing/prediction/{financial_document/invoice_line_item.rb → invoice/invoice_v4_line_item.rb}

@@ -4,7 +4,7 @@ require_relative '../common_fields/base'
 
 module Mindee
   # Line items for invoices
-  class InvoiceLineItem
+  class InvoiceV4LineItem
     # @return [String] The product code referring to the item.
     attr_reader :product_code
     # @return [String]
@@ -39,20 +39,20 @@ module Mindee
       @page_id = page_id
     end
 
+    # @return String
     def to_s
       tax = Field.float_to_string(@tax_amount)
       tax << " (#{Field.float_to_string(@tax_rate)}%)" unless @tax_rate.nil?
-
       description = @description.nil? ? '' : @description
       description = "#{description[0..32]}..." if description.size > 35
-
       out_str = String.new
-      out_str << format('%- 22s', @product_code)
-      out_str << " #{format('%- 8s', Field.float_to_string(@quantity))}"
-      out_str << " #{format('%- 9s', Field.float_to_string(@unit_price))}"
-      out_str << " #{format('%- 10s', Field.float_to_string(@total_amount))}"
-      out_str << " #{format('%- 18s', tax)}"
-      out_str << " #{description}"
+      out_str << format('| %- 20s', @product_code)
+      out_str << " #{format('| %- 7s', Field.float_to_string(@quantity))}"
+      out_str << " #{format('| %- 7s', Field.float_to_string(@unit_price))}"
+      out_str << " #{format('| %- 8s', Field.float_to_string(@total_amount))}"
+      out_str << " #{format('| %- 16s', tax)}"
+      out_str << " #{format('| %- 37s', description)}"
+      out_str << '|'
     end
   end
 end

data/lib/mindee/parsing/prediction/passport/passport_v1.rb

@@ -1,19 +1,8 @@
 # frozen_string_literal: true
 
-require 'mrz'
-
 require_relative '../common_fields'
 require_relative '../base'
 
-# We need to do this disgusting thing to avoid the following error message:
-# td3 line one does not match the required format (MRZ::InvalidFormatError)
-#
-# See:
-# https://github.com/streetspotr/mrz/issues/2
-# https://github.com/streetspotr/mrz/pull/3
-#
-MRZ::TD3Parser::FORMAT_ONE = %r{\A(.{2})(.{3})([^<]+)<(.*)\z}.freeze
-
 module Mindee
   module Prediction
     # Passport document.
@@ -78,7 +67,6 @@ module Mindee
         end
         @full_name = construct_full_name(page_id)
         @mrz = construct_mrz(page_id)
-        check_mrz
       end
 
       def to_s
@@ -107,57 +95,6 @@ module Mindee
 
       private
 
-      def check_mrz
-        return if @mrz1.value.nil? || @mrz2.value.nil?
-
-        mrz = MRZ.parse([@mrz1.value, @mrz2.value])
-        checks = {
-          mrz_valid: valid_mrz?(mrz),
-          mrz_valid_birth_date: valid_birth_date?(mrz),
-          mrz_valid_expiry_date: valid_expiry_date?(mrz),
-          mrz_valid_id_number: valid_id_number?(mrz),
-          mrz_valid_surname: valid_surname?(mrz),
-          mrz_valid_country: valid_country?(mrz),
-        }
-        @checklist.merge!(checks)
-      end
-
-      def valid_mrz?(mrz)
-        check = mrz.valid?
-        @mrz.confidence = 1.0 if check
-        check
-      end
-
-      def valid_birth_date?(mrz)
-        check = mrz.valid_birth_date? && mrz.birth_date == @birth_date.date_object
-        @birth_date.confidence = 1.0 if check
-        check
-      end
-
-      def valid_expiry_date?(mrz)
-        check = mrz.valid_expiration_date? && mrz.expiration_date == @expiry_date.date_object
-        @expiry_date.confidence = 1.0 if check
-        check
-      end
-
-      def valid_id_number?(mrz)
-        check = mrz.valid_document_number? && mrz.document_number == @id_number.value
-        @id_number.confidence = 1.0 if check
-        check
-      end
-
-      def valid_surname?(mrz)
-        check = mrz.last_name == @surname.value
-        @surname.confidence = 1.0 if check
-        check
-      end
-
-      def valid_country?(mrz)
-        check = mrz.nationality == @country.value
-        @country.confidence = 1.0 if check
-        check
-      end
-
       def construct_full_name(page_id)
         return unless @surname.value &&
                       !@given_names.empty? &&

data/lib/mindee/parsing/prediction/proof_of_address/proof_of_address_v1.rb

@@ -1,80 +1,78 @@
 # frozen_string_literal: true
 
-require 'mrz'
-
 require_relative '../common_fields'
 require_relative '../base'
 
 module Mindee
   module Prediction
-    # Passport document.
+    # Proof of Address v1 prediction results.
     class ProofOfAddressV1 < Prediction
-      # ISO 639-1 code, works best with ca, de, en, es, fr, it, nl and pt.
+      # The locale detected on the document.
       # @return [Mindee::Locale]
       attr_reader :locale
-      # ISO date yyyy-mm-dd. Works both for European and US dates.
-      # @return [Mindee::DateField]
-      attr_reader :date
-      # All extracted ISO date yyyy-mm-dd. Works both for European and US dates.
-      # @return [Array<Mindee::DateField>]
-      attr_reader :dates
-      # Address of the document's issuer.
+      # The name of the person or company issuing the document.
       # @return [Mindee::TextField]
-      attr_reader :issuer_address
-      # Generic: VAT NUMBER, TAX ID, COMPANY REGISTRATION NUMBER or country specific.
-      # @return [Array<Mindee::CompanyRegistration>]
+      attr_reader :issuer_name
+      # List of company registrations found for the issuer.
+      # @return [Array<Mindee::CompanyRegistrationField>]
       attr_reader :issuer_company_registration
-      # Name of the person or company issuing the document.
+      # The address of the document's issuer.
       # @return [Mindee::TextField]
-      attr_reader :issuer_name
-      # Address of the recipient.
+      attr_reader :issuer_address
+      # The name of the person or company receiving the document.
       # @return [Mindee::TextField]
-      attr_reader :recipient_address
-      # Generic: VAT NUMBER, TAX ID, COMPANY REGISTRATION NUMBER or country specific.
-      # @return [Array<Mindee::CompanyRegistration>]
+      attr_reader :recipient_name
+      # List of company registrations found for the recipient.
+      # @return [Array<Mindee::CompanyRegistrationField>]
       attr_reader :recipient_company_registration
-      # Name of the document's recipient.
+      # The address of the recipient.
       # @return [Mindee::TextField]
-      attr_reader :recipient_name
+      attr_reader :recipient_address
+      # List of dates found on the document.
+      # @return [Array<Mindee::DateField>]
+      attr_reader :dates
+      # The date the document was issued.
+      # @return [Mindee::DateField]
+      attr_reader :date
 
       # @param prediction [Hash]
       # @param page_id [Integer, nil]
       def initialize(prediction, page_id)
         super
-        @locale = Locale.new(prediction['locale'])
-        @date = DateField.new(prediction['date'], page_id)
-        @dates = []
-        prediction['dates'].each do |item|
-          @dates.push(DateField.new(item, page_id))
-        end
+        @locale = Locale.new(prediction['locale'], page_id)
         @issuer_name = TextField.new(prediction['issuer_name'], page_id)
-        @issuer_address = TextField.new(prediction['issuer_address'], page_id)
         @issuer_company_registration = []
         prediction['issuer_company_registration'].each do |item|
           @issuer_company_registration.push(CompanyRegistration.new(item, page_id))
         end
+        @issuer_address = TextField.new(prediction['issuer_address'], page_id)
         @recipient_name = TextField.new(prediction['recipient_name'], page_id)
-        @recipient_address = TextField.new(prediction['recipient_address'], page_id)
         @recipient_company_registration = []
         prediction['recipient_company_registration'].each do |item|
           @recipient_company_registration.push(CompanyRegistration.new(item, page_id))
         end
+        @recipient_address = TextField.new(prediction['recipient_address'], page_id)
+        @dates = []
+        prediction['dates'].each do |item|
+          @dates.push(DateField.new(item, page_id))
+        end
+        @date = DateField.new(prediction['date'], page_id)
       end
 
       def to_s
-        recipient_company_registrations = @recipient_company_registration.join(' ')
-        issuer_company_registrations = @issuer_company_registration.join(' ')
-        dates = @dates.join("\n        ")
+        issuer_company_registration = @issuer_company_registration.join("\n #{' ' * 30}")
+        recipient_company_registration = @recipient_company_registration.join("\n #{' ' * 33}")
+        dates = @dates.join("\n #{' ' * 7}")
         out_str = String.new
         out_str << "\n:Locale: #{@locale}".rstrip
-        out_str << "\n:Issuer name: #{@issuer_name}".rstrip
+        out_str << "\n:Issuer Name: #{@issuer_name}".rstrip
+        out_str << "\n:Issuer Company Registrations: #{issuer_company_registration}".rstrip
         out_str << "\n:Issuer Address: #{@issuer_address}".rstrip
-        out_str << "\n:Issuer Company Registrations: #{issuer_company_registrations}".rstrip
-        out_str << "\n:Recipient name: #{@recipient_name}".rstrip
+        out_str << "\n:Recipient Name: #{@recipient_name}".rstrip
+        out_str << "\n:Recipient Company Registrations: #{recipient_company_registration}".rstrip
         out_str << "\n:Recipient Address: #{@recipient_address}".rstrip
-        out_str << "\n:Recipient Company Registrations: #{recipient_company_registrations}".rstrip
-        out_str << "\n:Issuance date: #{@date}".rstrip
         out_str << "\n:Dates: #{dates}".rstrip
+        out_str << "\n:Date of Issue: #{@date}".rstrip
         out_str[1..].to_s
       end
     end