mindee 2.2.0 → 3.0.0

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

@@ -1,136 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../common_fields'
-require_relative '../base'
-require_relative 'receipt_v5_line_item'
-
-module Mindee
-  module Prediction
-    # Expense Receipt v5 prediction results.
-    class ReceiptV5 < Prediction
-      # The locale identifier in BCP 47 (RFC 5646) format: ISO language code, '-', ISO country code.
-      # @return [Mindee::Locale]
-      attr_reader :locale
-      # The receipt category among predefined classes.
-      # @return [Mindee::TextField]
-      attr_reader :category
-      # The receipt sub category among predefined classes for transport and food.
-      # @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
-      # The date the purchase was made.
-      # @return [Mindee::DateField]
-      attr_reader :date
-      # Time of purchase with 24 hours formatting (HH:MM).
-      # @return [Mindee::TextField]
-      attr_reader :time
-      # The total amount paid including taxes, discounts, fees, tips, and gratuity.
-      # @return [Mindee::AmountField]
-      attr_reader :total_amount
-      # The total amount excluding taxes.
-      # @return [Mindee::AmountField]
-      attr_reader :total_net
-      # The total amount of taxes.
-      # @return [Mindee::AmountField]
-      attr_reader :total_tax
-      # The total amount of tip and gratuity.
-      # @return [Mindee::AmountField]
-      attr_reader :tip
-      # List of tax lines information including: Amount, tax rate, tax base amount and tax code.
-      # @return [Array<Mindee::TaxField>]
-      attr_reader :taxes
-      # The name of the supplier or merchant.
-      # @return [Mindee::TextField]
-      attr_reader :supplier_name
-      # List of supplier company registrations or identifiers.
-      # @return [Array<Mindee::CompanyRegistration>]
-      attr_reader :supplier_company_registrations
-      # The address of the supplier or merchant returned as a single string.
-      # @return [Mindee::TextField]
-      attr_reader :supplier_address
-      # The Phone number of the supplier or merchant returned as a single string.
-      # @return [Mindee::TextField]
-      attr_reader :supplier_phone_number
-      # Full extraction of lines, including: description, quantity, unit price and total.
-      # @return [Array<Mindee::ReceiptV5LineItem>]
-      attr_reader :line_items
-
-      # @param prediction [Hash]
-      # @param page_id [Integer, nil]
-      def initialize(prediction, page_id)
-        super
-        @locale = Locale.new(prediction['locale'], 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)
-        @date = DateField.new(prediction['date'], page_id)
-        @time = TextField.new(prediction['time'], page_id)
-        @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)
-        @taxes = []
-        prediction['taxes'].each do |item|
-          @taxes.push(TaxField.new(item, page_id))
-        end
-        @supplier_name = TextField.new(prediction['supplier_name'], page_id)
-        @supplier_company_registrations = []
-        prediction['supplier_company_registrations'].each do |item|
-          @supplier_company_registrations.push(CompanyRegistration.new(item, page_id))
-        end
-        @supplier_address = TextField.new(prediction['supplier_address'], page_id)
-        @supplier_phone_number = TextField.new(prediction['supplier_phone_number'], page_id)
-        @line_items = []
-        prediction['line_items'].each do |item|
-          @line_items.push(ReceiptV5LineItem.new(item, page_id))
-        end
-      end
-
-      # @return String
-      def to_s
-        taxes = @taxes.join("\n #{' ' * 7}")
-        supplier_company_registrations = @supplier_company_registrations.join("\n #{' ' * 32}")
-        line_items = line_items_to_s
-        out_str = String.new
-        out_str << "\n:Expense Locale: #{@locale}".rstrip
-        out_str << "\n:Expense Category: #{@category}".rstrip
-        out_str << "\n:Expense Sub Category: #{@subcategory}".rstrip
-        out_str << "\n:Document Type: #{@document_type}".rstrip
-        out_str << "\n:Purchase Date: #{@date}".rstrip
-        out_str << "\n:Purchase Time: #{@time}".rstrip
-        out_str << "\n:Total Amount: #{@total_amount}".rstrip
-        out_str << "\n:Total Excluding Taxes: #{@total_net}".rstrip
-        out_str << "\n:Total Tax: #{@total_tax}".rstrip
-        out_str << "\n:Tip and Gratuity: #{@tip}".rstrip
-        out_str << "\n:Taxes: #{taxes}".rstrip
-        out_str << "\n:Supplier Name: #{@supplier_name}".rstrip
-        out_str << "\n:Supplier Company Registrations: #{supplier_company_registrations}".rstrip
-        out_str << "\n:Supplier Address: #{@supplier_address}".rstrip
-        out_str << "\n:Supplier Phone Number: #{@supplier_phone_number}".rstrip
-        out_str << "\n:Line Items:"
-        out_str << line_items
-        out_str[1..].to_s
-      end
-
-      private
-
-      def line_items_separator(char)
-        "  +#{char * 38}+#{char * 10}+#{char * 14}+#{char * 12}+"
-      end
-
-      def line_items_to_s
-        return '' if @line_items.empty?
-
-        line_items = @line_items.map(&:to_s).join("\n#{line_items_separator('-')}\n  ")
-        out_str = String.new
-        out_str << "\n#{line_items_separator('-')}"
-        out_str << "\n  | Description #{' ' * 25}| Quantity | Total Amount | Unit Price |"
-        out_str << "\n#{line_items_separator('=')}"
-        out_str << "\n  #{line_items}"
-        out_str << "\n#{line_items_separator('-')}"
-      end
-    end
-  end
-end

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

@@ -1,37 +0,0 @@
-# frozen_string_literal: true
-
-module Mindee
-  # Full extraction of lines, including: description, quantity, unit price and total.
-  class ReceiptV5LineItem
-    # The item description.
-    # @return [String]
-    attr_reader :description
-    # The item quantity.
-    # @return [Float]
-    attr_reader :quantity
-    # The item total amount.
-    # @return [Float]
-    attr_reader :total_amount
-    # The item unit price.
-    # @return [Float]
-    attr_reader :unit_price
-
-    def initialize(prediction, page_id)
-      @description = prediction['description']
-      @quantity = prediction['quantity']
-      @total_amount = prediction['total_amount']
-      @unit_price = prediction['unit_price']
-      @page_id = page_id
-    end
-
-    # @return String
-    def to_s
-      out_str = String.new
-      out_str << format('| %- 37s', @description)
-      out_str << format('| %- 9s', Field.float_to_string(@quantity))
-      out_str << format('| %- 13s', Field.float_to_string(@total_amount))
-      out_str << format('| %- 11s', Field.float_to_string(@unit_price))
-      out_str << '|'
-    end
-  end
-end

data/lib/mindee/parsing/prediction/shipping_container/shipping_container_v1.rb

@@ -1,38 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../common_fields'
-require_relative '../base'
-
-module Mindee
-  module Prediction
-    # License plate prediction.
-    class ShippingContainerV1 < Prediction
-      # ISO 6346 code for container owner prefix + equipment identifier.
-      # @return [Array<Mindee::TextField>]
-      attr_reader :owner
-      # ISO 6346 code for container serial number (6+1 digits).
-      # @return [Array<Mindee::TextField>]
-      attr_reader :serial_number
-      # ISO 6346 code for container length, height and type.
-      # @return [Array<Mindee::TextField>]
-      attr_reader :size_type
-
-      # @param prediction [Hash]
-      # @param page_id [Integer, nil]
-      def initialize(prediction, page_id)
-        super
-        @owner = TextField.new(prediction['owner'], page_id)
-        @serial_number = TextField.new(prediction['serial_number'], page_id)
-        @size_type = TextField.new(prediction['size_type'], page_id)
-      end
-
-      def to_s
-        out_str = String.new
-        out_str << "\n:Owner: #{@owner}".rstrip
-        out_str << "\n:Serial Number: #{@serial_number}".rstrip
-        out_str << "\n:Size and Type: #{@size_type}".rstrip
-        out_str[1..].to_s
-      end
-    end
-  end
-end

data/lib/mindee/parsing/prediction/us/bank_check/bank_check_v1.rb

@@ -1,70 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../../common_fields'
-require_relative '../../base'
-
-module Mindee
-  module Prediction
-    module US
-      # License plate prediction.
-      class BankCheckV1 < Prediction
-        # Payer's bank account number.
-        # @return [Array<Mindee::TextField>]
-        attr_reader :account_number
-        # Amount to be paid.
-        # @return [Array<Mindee::AmountField>]
-        attr_reader :amount
-        # The check number.
-        # @return [Mindee::TextField]
-        attr_reader :check_number
-        # Payer's bank account routing number.
-        # @return [Mindee::TextField]
-        attr_reader :routing_number
-        # Date the check was issued.
-        # @return [Mindee::DateField]
-        attr_reader :date
-        # The positions of the signatures on the image.
-        # @return [Array<Mindee::PositionField>]
-        attr_reader :signatures_positions
-        # Check's position in the image.
-        # @return [Mindee::PositionField]
-        attr_reader :check_position
-        # List of payees (full name or company name).
-        # @return [Array<Mindee::TextField>]
-        attr_reader :payees
-
-        # @param prediction [Hash]
-        # @param page_id [Integer, nil]
-        def initialize(prediction, page_id)
-          super
-          @account_number = TextField.new(prediction['account_number'], page_id)
-          @amount = AmountField.new(prediction['amount'], page_id)
-          @check_number = TextField.new(prediction['check_number'], page_id)
-          @date = DateField.new(prediction['date'], page_id)
-          @check_position = PositionField.new(prediction['check_position'], page_id)
-          @routing_number = TextField.new(prediction['routing_number'], page_id)
-          @signatures_positions = []
-          prediction['signatures_positions'].each do |item|
-            @signatures_positions.push(PositionField.new(item, page_id))
-          end
-          @payees = []
-          prediction['payees'].each do |item|
-            @payees.push(TextField.new(item, page_id))
-          end
-        end
-
-        def to_s
-          payees = @payees.map(&:value).join(', ')
-          out_str = String.new
-          out_str << "\n:Routing number: #{@routing_number}".rstrip
-          out_str << "\n:Account number: #{@account_number}".rstrip
-          out_str << "\n:Check number: #{@check_number}".rstrip
-          out_str << "\n:Date: #{@date}".rstrip
-          out_str << "\n:Amount: #{@amount}".rstrip
-          out_str << "\n:Payees: #{payees}".rstrip
-          out_str[1..].to_s
-        end
-      end
-    end
-  end
-end

data/lib/mindee/parsing/prediction.rb

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'prediction/custom/custom_v1'
-require_relative 'prediction/proof_of_address/proof_of_address_v1'
-require_relative 'prediction/financial_document/financial_document_v1'
-require_relative 'prediction/invoice/invoice_v4'
-require_relative 'prediction/passport/passport_v1'
-require_relative 'prediction/receipt/receipt_v4'
-require_relative 'prediction/receipt/receipt_v5'
-require_relative 'prediction/eu/license_plate/license_plate_v1'
-require_relative 'prediction/shipping_container/shipping_container_v1'
-require_relative 'prediction/us/bank_check/bank_check_v1'
-require_relative 'prediction/fr/bank_account_details/bank_account_details_v1'
-require_relative 'prediction/fr/carte_vitale/carte_vitale_v1'
-require_relative 'prediction/fr/id_card/id_card_v1'