mindee 2.2.0 → 3.0.0

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

@@ -1,212 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../common_fields'
-require_relative '../base'
-require_relative 'invoice_v4_line_item'
-
-module Mindee
-  module Prediction
-    # Invoice document.
-    class InvoiceV4 < Prediction
-      # Locale information.
-      # @return [Mindee::Locale]
-      attr_reader :locale
-      # The nature of the invoice.
-      # @return [Mindee::TextField]
-      attr_reader :document_type
-      # The total amount with tax included.
-      # @return [Mindee::AmountField]
-      attr_reader :total_amount
-      # The total amount without the tax value.
-      # @return [Mindee::AmountField]
-      attr_reader :total_net
-      # The total tax.
-      # @return [Mindee::AmountField]
-      attr_reader :total_tax
-      # The creation date of the invoice.
-      # @return [Mindee::DateField]
-      attr_reader :date
-      # The invoice number.
-      # @return [Mindee::TextField]
-      attr_reader :invoice_number
-      # List of Reference numbers including PO number.
-      # @return [Mindee::TextField]
-      attr_reader :reference_numbers
-      # The due date of the invoice.
-      # @return [Mindee::DateField]
-      attr_reader :due_date
-      # The list of taxes.
-      # @return [Array<Mindee::TaxField>]
-      attr_reader :taxes
-      # The name of the customer.
-      # @return [Mindee::TextField]
-      attr_reader :customer_name
-      # The address of the customer.
-      # @return [Mindee::TextField]
-      attr_reader :customer_address
-      # The company registration information for the customer.
-      # @return [Array<Mindee::CompanyRegistration>]
-      attr_reader :customer_company_registrations
-      # The supplier's name.
-      # @return [Mindee::TextField]
-      attr_reader :supplier_name
-      # The supplier's address.
-      # @return [Mindee::TextField]
-      attr_reader :supplier_address
-      # The payment information.
-      # @return [Array<Mindee::PaymentDetails>]
-      attr_reader :supplier_payment_details
-      # The supplier's company registration information.
-      # @return [Array<Mindee::CompanyRegistration>]
-      attr_reader :supplier_company_registrations
-      # Line items details.
-      # @return [Array<Mindee::InvoiceV4LineItem>]
-      attr_reader :line_items
-
-      # @param prediction [Hash]
-      # @param page_id [Integer, nil]
-      def initialize(prediction, page_id)
-        super
-        @locale = Locale.new(prediction['locale'])
-        @document_type = TextField.new(prediction['document_type'], page_id)
-        @total_amount = AmountField.new(prediction['total_amount'], page_id)
-        @total_net = AmountField.new(prediction['total_net'], page_id)
-        @customer_address = TextField.new(prediction['customer_address'], page_id)
-        @customer_name = TextField.new(prediction['customer_name'], page_id)
-        @date = DateField.new(prediction['date'], page_id)
-        @due_date = DateField.new(prediction['due_date'], page_id)
-        @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))
-        end
-        @customer_company_registrations = []
-        prediction['customer_company_registrations'].each do |item|
-          @customer_company_registrations.push(CompanyRegistration.new(item, page_id))
-        end
-        @taxes = []
-        prediction['taxes'].each do |item|
-          @taxes.push(TaxField.new(item, page_id))
-        end
-        @supplier_payment_details = []
-        prediction['supplier_payment_details'].each do |item|
-          @supplier_payment_details.push(PaymentDetails.new(item, page_id))
-        end
-        @supplier_company_registrations = []
-        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(InvoiceV4LineItem.new(item, page_id))
-        end
-        reconstruct(page_id)
-      end
-
-      def to_s
-        customer_company_registrations = @customer_company_registrations.map(&:value).join('; ')
-        supplier_payment_details = @supplier_payment_details.map(&:to_s).join("\n                 ")
-        supplier_company_registrations = @supplier_company_registrations.map(&:to_s).join('; ')
-        reference_numbers = @reference_numbers.map(&:to_s).join(', ')
-        taxes = @taxes.join("\n       ")
-        out_str = String.new
-        out_str << "\n:Locale: #{@locale}".rstrip
-        out_str << "\n:Document type: #{@document_type}".rstrip
-        out_str << "\n:Invoice number: #{@invoice_number}".rstrip
-        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_items = @line_items.map(&:to_s).join("\n#{line_item_separator('-')}\n  ")
-        out_str = String.new
-        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)
-        construct_total_tax_from_taxes(page_id)
-        return unless page_id.nil?
-
-        construct_total_excl_from_tcc_and_taxes(page_id)
-        construct_total_incl_from_taxes_plus_excl(page_id)
-        construct_total_tax_from_totals(page_id)
-      end
-
-      def construct_total_excl_from_tcc_and_taxes(page_id)
-        return if @total_amount.value.nil? || taxes.empty? || !@total_net.value.nil?
-
-        total_excl = {
-          'value' => @total_amount.value - @taxes.map(&:value).sum,
-          'confidence' => TextField.array_confidence(@taxes) * @total_amount.confidence,
-        }
-        @total_net = AmountField.new(total_excl, page_id, reconstructed: true)
-      end
-
-      def construct_total_incl_from_taxes_plus_excl(page_id)
-        return if @total_net.value.nil? || @taxes.empty? || !@total_amount.value.nil?
-
-        total_incl = {
-          'value' => @taxes.map(&:value).sum + @total_net.value,
-          'confidence' => TextField.array_confidence(@taxes) * @total_net.confidence,
-        }
-        @total_amount = AmountField.new(total_incl, page_id, reconstructed: true)
-      end
-
-      def construct_total_tax_from_taxes(page_id)
-        return if @taxes.empty?
-
-        total_tax = {
-          'value' => @taxes.map(&:value).sum,
-          'confidence' => TextField.array_confidence(@taxes),
-        }
-        return unless total_tax['value'].positive?
-
-        @total_tax = AmountField.new(total_tax, page_id, reconstructed: true)
-      end
-
-      def construct_total_tax_from_totals(page_id)
-        return if !@total_tax.value.nil? || @total_amount.value.nil? || @total_net.value.nil?
-
-        total_tax = {
-          'value' => @total_amount.value - @total_net.value,
-          'confidence' => TextField.array_confidence(@taxes),
-        }
-        return unless total_tax['value'] >= 0
-
-        @total_tax = AmountField.new(total_tax, page_id, reconstructed: true)
-      end
-    end
-  end
-end

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

@@ -1,58 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../common_fields/base'
-
-module Mindee
-  # Line items for invoices
-  class InvoiceV4LineItem
-    # @return [String] The product code referring to the item.
-    attr_reader :product_code
-    # @return [String]
-    attr_reader :description
-    # @return [Float]
-    attr_reader :quantity
-    # @return [Float]
-    attr_reader :unit_price
-    # @return [Float]
-    attr_reader :total_amount
-    # @return [Float] The item tax rate percentage.
-    attr_reader :tax_rate
-    # @return [Float]
-    attr_reader :tax_amount
-    # @return [Float]
-    attr_reader :confidence
-    # @return [Integer]
-    attr_reader :page_id
-    # @return [Mindee::Geometry::Quadrilateral]
-    attr_reader :bounding_box
-    # @return [Array<Mindee::Geometry::Polygon>]
-    attr_reader :polygon
-
-    def initialize(prediction, page_id)
-      @product_code = prediction['product_code']
-      @quantity = prediction['quantity']
-      @unit_price = prediction['unit_price']
-      @total_amount = prediction['total_amount']
-      @tax_amount = prediction['tax_amount']
-      @tax_rate = prediction['tax_rate']
-      @description = prediction['description']
-      @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('| %- 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,121 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../common_fields'
-require_relative '../base'
-
-module Mindee
-  module Prediction
-    # Passport document.
-    class PassportV1 < Prediction
-      # The country of issue.
-      # @return [Mindee::TextField]
-      attr_reader :country
-      # The passport number.
-      # @return [Mindee::TextField]
-      attr_reader :id_number
-      # The expiration date of the passport.
-      # @return [Mindee::DateField]
-      attr_reader :expiry_date
-      # The issuance date of the passport.
-      # @return [Mindee::DateField]
-      attr_reader :issuance_date
-      # The surname (last name) of the passport holder.
-      # @return [Mindee::TextField]
-      attr_reader :surname
-      # List of first (given) names of the passport holder.
-      # @return [Mindee::TextField]
-      attr_reader :given_names
-      # The full name of the passport holder.
-      # @return [Array<Mindee::TextField>]
-      attr_reader :full_name
-      # The date of birth of the passport holder.
-      # @return [Mindee::DateField]
-      attr_reader :birth_date
-      # The place of birth of the passport holder.
-      # @return [Mindee::TextField]
-      attr_reader :birth_place
-      # The sex or gender of the passport holder.
-      # @return [Mindee::TextField]
-      attr_reader :gender
-      # The value of the first MRZ line.
-      # @return [Mindee::TextField]
-      attr_reader :mrz1
-      # The value of the second MRZ line.
-      # @return [Mindee::TextField]
-      attr_reader :mrz2
-      # All the MRZ values combined.
-      # @return [Mindee::TextField]
-      attr_reader :mrz
-
-      # @param prediction [Hash]
-      # @param page_id [Integer, nil]
-      def initialize(prediction, page_id)
-        super
-        @country = TextField.new(prediction['country'], page_id)
-        @id_number = TextField.new(prediction['id_number'], page_id)
-        @birth_date = DateField.new(prediction['birth_date'], page_id)
-        @expiry_date = DateField.new(prediction['expiry_date'], page_id)
-        @issuance_date = DateField.new(prediction['issuance_date'], page_id)
-        @birth_place = TextField.new(prediction['birth_place'], 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
-        @full_name = construct_full_name(page_id)
-        @mrz = construct_mrz(page_id)
-      end
-
-      def to_s
-        given_names = @given_names.join(' ')
-        out_str = String.new
-        out_str << "\n:Full name: #{@full_name}".rstrip
-        out_str << "\n:Given names: #{given_names}".rstrip
-        out_str << "\n:Surname: #{@surname}".rstrip
-        out_str << "\n:Country: #{@country}".rstrip
-        out_str << "\n:ID Number: #{@id_number}".rstrip
-        out_str << "\n:Issuance date: #{@issuance_date}".rstrip
-        out_str << "\n:Birth date: #{@birth_date}".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: #{@mrz}".rstrip
-        out_str[1..].to_s
-      end
-
-      # @return [Boolean]
-      def expired?
-        return true unless @expiry_date.date_object
-
-        @expiry_date.date_object < Date.today
-      end
-
-      private
-
-      def construct_full_name(page_id)
-        return unless @surname.value &&
-                      !@given_names.empty? &&
-                      @given_names[0].value
-
-        full_name = {
-          'value' => "#{@given_names[0].value} #{@surname.value}",
-          'confidence' => TextField.array_confidence([@surname, @given_names[0]]),
-        }
-        TextField.new(full_name, page_id, reconstructed: true)
-      end
-
-      def construct_mrz(page_id)
-        return if @mrz1.value.nil? || @mrz2.value.nil?
-
-        mrz = {
-          'value' => @mrz1.value + @mrz2.value,
-          'confidence' => Mindee::TextField.array_confidence([@mrz1, @mrz2]),
-        }
-        TextField.new(mrz, page_id, reconstructed: true)
-      end
-    end
-  end
-end

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

@@ -1,80 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../common_fields'
-require_relative '../base'
-
-module Mindee
-  module Prediction
-    # Proof of Address v1 prediction results.
-    class ProofOfAddressV1 < Prediction
-      # The locale detected on the document.
-      # @return [Mindee::Locale]
-      attr_reader :locale
-      # The name of the person or company issuing the document.
-      # @return [Mindee::TextField]
-      attr_reader :issuer_name
-      # List of company registrations found for the issuer.
-      # @return [Array<Mindee::CompanyRegistrationField>]
-      attr_reader :issuer_company_registration
-      # The address of the document's issuer.
-      # @return [Mindee::TextField]
-      attr_reader :issuer_address
-      # The name of the person or company receiving the document.
-      # @return [Mindee::TextField]
-      attr_reader :recipient_name
-      # List of company registrations found for the recipient.
-      # @return [Array<Mindee::CompanyRegistrationField>]
-      attr_reader :recipient_company_registration
-      # The address of the recipient.
-      # @return [Mindee::TextField]
-      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'], page_id)
-        @issuer_name = TextField.new(prediction['issuer_name'], 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_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
-        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 Company Registrations: #{issuer_company_registration}".rstrip
-        out_str << "\n:Issuer Address: #{@issuer_address}".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:Dates: #{dates}".rstrip
-        out_str << "\n:Date of Issue: #{@date}".rstrip
-        out_str[1..].to_s
-      end
-    end
-  end
-end

data/lib/mindee/parsing/prediction/receipt/receipt_v4.rb

@@ -1,87 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../common_fields'
-require_relative '../base'
-
-module Mindee
-  module Prediction
-    # Receipt document.
-    class ReceiptV4 < Prediction
-      # Where the purchase was made, the language, and the currency.
-      # @return [Mindee::Locale]
-      attr_reader :locale
-      # Total including taxes
-      # @return [Mindee::AmountField]
-      attr_reader :total_amount
-      # Total amount of the purchase excluding taxes.
-      # @return [Mindee::AmountField]
-      attr_reader :total_net
-      # Total tax amount of the purchase.
-      # @return [Mindee::AmountField]
-      attr_reader :total_tax
-      # The purchase date.
-      # @return [Mindee::DateField]
-      attr_reader :date
-      # The name of the supplier or merchant, as seen on the receipt.
-      # @return [Mindee::TextField]
-      attr_reader :supplier
-      # List of taxes detected on the receipt.
-      # @return [Array<Mindee::TaxField>]
-      attr_reader :taxes
-      # Time as seen on the receipt in HH:MM format.
-      # @return [Mindee::TextField]
-      attr_reader :time
-      # The receipt category among predefined classes.
-      # @return [Mindee::TextField]
-      attr_reader :category
-      # The receipt sub-category among predefined classes.
-      # @return [Mindee::TextField]
-      attr_reader :subcategory
-      # Whether the document is an expense receipt or a credit card receipt.
-      # @return [Mindee::TextField]
-      attr_reader :document_type
-      # Total amount of tip and gratuity. Both typed and handwritten characters are supported.
-      # @return [Mindee::AmountField]
-      attr_reader :tip
-
-      # @param prediction [Hash]
-      # @param page_id [Integer, nil]
-      def initialize(prediction, page_id)
-        super
-        @locale = Locale.new(prediction['locale'])
-        @total_amount = AmountField.new(prediction['total_amount'], page_id)
-        @total_net = AmountField.new(prediction['total_net'], page_id)
-        @total_tax = AmountField.new(prediction['total_tax'], page_id)
-        @tip = AmountField.new(prediction['tip'], page_id)
-        @date = DateField.new(prediction['date'], page_id)
-        @category = TextField.new(prediction['category'], page_id)
-        @subcategory = TextField.new(prediction['subcategory'], page_id)
-        @document_type = TextField.new(prediction['document_type'], page_id)
-        @supplier = TextField.new(prediction['supplier'], page_id)
-        @time = TextField.new(prediction['time'], page_id)
-        @taxes = []
-        prediction['taxes'].each do |item|
-          @taxes.push(TaxField.new(item, page_id))
-        end
-      end
-
-      def to_s
-        taxes = @taxes.join("\n       ")
-        out_str = String.new
-        out_str << "\n:Locale: #{@locale}".rstrip
-        out_str << "\n:Date: #{@date}".rstrip
-        out_str << "\n:Category: #{@category}".rstrip
-        out_str << "\n:Subcategory: #{@subcategory}".rstrip
-        out_str << "\n:Document type: #{@document_type}".rstrip
-        out_str << "\n:Time: #{@time}".rstrip
-        out_str << "\n:Supplier name: #{@supplier}".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:Tip: #{@tip}".rstrip
-        out_str << "\n:Total amount: #{@total_amount}".rstrip
-        out_str[1..].to_s
-      end
-    end
-  end
-end