mindee 2.1.1 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 927e4d22c8f54feebaace71c40705a1e130d4737fce8487ae24b7c369f2aa3ea
-  data.tar.gz: 99101cdf1573be19a82ee0cd04bd54cc45edff95bac113902174f45c3ae4de4d
+  metadata.gz: 508a1201e41623fdd4b7283a90f09aefbcf66582e610120547b5706017e62c6f
+  data.tar.gz: 552288d7cee7f8b5c38d641a991fb9864f3ebb6f3d7c5140e178ebabec082a84
 SHA512:
-  metadata.gz: 38b335f5baf0b8a4757e31956472314f11e01d901c24e8e24990f48e90292d0bac7c4aba79a30ea4db27188c88d7957282fc19d08c653b3b7fce489a923f6c9a
-  data.tar.gz: 8f87a88fff6e4284a326c563f60e67c8a85e2516cb96f103ba648b5ac2366298e59fc1c60f120f4e797b738c71dc391dc881317bd1e9825d2a3f9513f9b63e5d
+  metadata.gz: a697ccd863ee69c721f8fe0199fc6321df1812a6daf9aa51031031d197ae3cd6578b4c09162ebe03cfba0008b26320533a62cd688fbc02c3acaee21488201c8b
+  data.tar.gz: ae97c33e5fd32bc1919b510e4057e0b3355892ca5178fc9e40d3769d55dbb41d3b10ac1b8153f4b028e36ec11d02df977299f0581fe3d3cbf8412be23f2bec33

data/.rubocop.yml

@@ -9,6 +9,9 @@ AllCops:
   TargetRubyVersion: 2.6
   SuggestExtensions: false
 
+Gemspec/DevelopmentDependencies:
+  EnforcedStyle: gemspec
+
 Style/TrailingCommaInHashLiteral:
   EnforcedStyleForMultiline: comma
 

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Mindee Ruby API Library Changelog
 
+## v2.2.0 - 2023-05-16
+### Changes
+* :sparkles: add support for Receipts v5
+* :pushpin: more specific dependency pinning; update some dependencies
+
+
 ## v2.1.1 - 2023-04-21
 ### Changes
 * :memo: minor docstring improvements

data/bin/mindee.rb

@@ -24,7 +24,7 @@ DOCUMENTS = {
   },
   "receipt" => {
     help: "Expense Receipt",
-    prediction: Mindee::Prediction::ReceiptV4,
+    prediction: Mindee::Prediction::ReceiptV5,
   },
   "passport" => {
     help: "Passport",

data/docs/code_samples/expense_receipts_v5.txt

@@ -0,0 +1,14 @@
+require 'mindee'
+
+# Init a new client, specifying an API key
+mindee_client = Mindee::Client.new(api_key: 'my-api-key')
+
+# Load a file from disk and parse it
+result = mindee_client.doc_from_path('/path/to/the/file.ext')
+  .parse(Mindee::Prediction::ReceiptV5)
+
+# Print a full summary of the parsed data in RST format
+puts result
+
+# Print the document-level parsed data
+# puts result.inference.prediction

data/docs/ruby-receipt-ocr.md

@@ -2,7 +2,7 @@ The Ruby  OCR SDK supports the [receipt API](https://developers.mindee.com/docs/
 
 Using this sample below, we are going to illustrate how to extract the data that we want using the OCR SDK.
 
-![sample receipt](https://raw.githubusercontent.com/mindee/client-lib-test-data/main/receipt/receipt-with-tip.jpg)
+![sample receipt](https://raw.githubusercontent.com/mindee/client-lib-test-data/main/receipt/receipt.jpg)
 
 ## Quick Start
 ```ruby
@@ -11,27 +11,41 @@ require 'mindee'
 # Init a new client, specifying an API key
 mindee_client = Mindee::Client.new(api_key: 'my-api-key')
 
-# Send the file
-result = mindee_client.doc_from_path('/path/to/the/file.ext').parse(Mindee::Prediction::ReceiptV4)
+# Load a file from disk and parse it
+result = mindee_client.doc_from_path('/path/to/the/file.ext')
+                      .parse(Mindee::Prediction::ReceiptV5)
 
-# Print a summary of the document prediction in RST format
+# Print a full summary of the parsed data in RST format
+# puts result
+
+# Print the document-level parsed data
 puts result.inference.prediction
 ```
 
 Output:
 ```
-:Locale: en-US; en; US; USD;
-:Date: 2014-07-07
-:Category: food
-:Subcategory: restaurant
-:Document type: EXPENSE RECEIPT
-:Time: 20:20
-:Supplier name: LOGANS
-:Taxes: 3.34 TAX
-:Total net: 40.48
-:Total taxes: 3.34
-:Tip: 10.00
-:Total amount: 53.8
+:Expense Locale: en-GB; en; GB; GBP;
+:Expense Category: food
+:Expense Sub Category: restaurant
+:Document Type: EXPENSE RECEIPT
+:Purchase Date: 2016-02-26
+:Purchase Time: 15:20
+:Total Amount: 10.20
+:Total Excluding Taxes: 8.50
+:Total Tax: 1.70
+:Tip and Gratuity:
+:Taxes: 1.70 20.00% VAT
+:Supplier Name: CLACHAN
+:Supplier Company Registrations: 232153895
+                                 232153895
+:Supplier Address: 34 kingley street w1b 5qh
+:Supplier Phone Number: 02074940834
+:Line Items:
+  +--------------------------------------+----------+--------------+------------+
+  | Description                          | Quantity | Total Amount | Unit Price |
+  +======================================+==========+==============+============+
+  | Meantime Pale                        | 2.00     | 10.20        |            |
+  +--------------------------------------+----------+--------------+------------+
 ```
 
 ## Fields
@@ -50,7 +64,6 @@ Depending on the field type specified, additional attributes can be extracted in
 
 Using the above sample, the following are the basic fields that can be extracted:
 
-- [Orientation](#orientation)
 - [Category](#category)
 - [Date](#date)
 - [Locale](#locale)

data/lib/mindee/client.rb

@@ -183,6 +183,9 @@ module Mindee
       @doc_configs[['mindee', Prediction::ReceiptV4.name]] = standard_document_config(
         Prediction::ReceiptV4, 'expense_receipts', '4'
       )
+      @doc_configs[['mindee', Prediction::ReceiptV5.name]] = standard_document_config(
+        Prediction::ReceiptV5, 'expense_receipts', '5'
+      )
       @doc_configs[['mindee', Prediction::PassportV1.name]] = standard_document_config(
         Prediction::PassportV1, 'passport', '1'
       )

data/lib/mindee/parsing/prediction/common_fields/locale.rb

@@ -20,7 +20,7 @@ module Mindee
     attr_reader :value
 
     # @param prediction [Hash]
-    def initialize(prediction)
+    def initialize(prediction, _page_id = nil)
       value_key = if prediction.include? 'value'
                     'value'
                   else

data/lib/mindee/parsing/prediction/eu/license_plate/license_plate_v1.rb

@@ -6,9 +6,9 @@ require_relative '../../base'
 module Mindee
   module Prediction
     module EU
-      # License plate prediction.
+      # License Plate v1 prediction results.
       class LicensePlateV1 < Prediction
-        # A list of license plates.
+        # List of all license plates found in the image.
         # @return [Array<Mindee::TextField>]
         attr_reader :license_plates
 
@@ -23,9 +23,9 @@ module Mindee
         end
 
         def to_s
-          license_plates = @license_plates.map(&:value).join(', ')
+          license_plates = @license_plates.join("\n #{' ' * 16}")
           out_str = String.new
-          out_str << "\n:License plates: #{license_plates}".rstrip
+          out_str << "\n:License Plates: #{license_plates}".rstrip
           out_str[1..].to_s
         end
       end

data/lib/mindee/parsing/prediction/financial_document/financial_document_v1.rb

@@ -2,7 +2,7 @@
 
 require_relative '../common_fields'
 require_relative '../base'
-require_relative 'invoice_line_item'
+require_relative 'financial_document_v1_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::FinancialDocumentV1LineItem>]
       attr_reader :line_items
       # Time as seen on the receipt in HH:MM format.
       # @return [Mindee::TextField]
@@ -83,7 +83,6 @@ module Mindee
       # @param page_id [Integer, nil]
       def initialize(prediction, page_id) # rubocop:todo Metrics/AbcSize
         super
-
         @time = TextField.new(prediction['time'], page_id)
         @category = TextField.new(prediction['category'], page_id)
         @subcategory = TextField.new(prediction['subcategory'], page_id)
@@ -100,7 +99,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))
@@ -121,14 +119,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(FinancialDocumentV1LineItem.new(item, page_id))
         end
         reconstruct(page_id)
       end
@@ -153,39 +149,35 @@ module Mindee
         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:Tip: #{@tip}".rstrip
-
         out_str << "\n:Taxes: #{taxes}".rstrip
         out_str << "\n:Total taxes: #{@total_tax}".rstrip
         out_str << "\n:Total net: #{@total_net}".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
-        line_item_separator = "#{'=' * 22} #{'=' * 8} #{'=' * 9} #{'=' * 10} #{'=' * 18} #{'=' * 36}"
-        line_items = @line_items.map(&:to_s).join("\n")
+        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\n:Line Items:"
-
-        return out_str if line_items.empty?
-
-        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}"
+        out_str << "\n#{line_item_separator('-')}"
+        out_str << "\n  | Code#{' ' * 17}| QTY     | Price   | Amount   | Tax (Rate)       | Description#{' ' * 26}|"
+        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/{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/proof_of_address/proof_of_address_v1.rb

@@ -5,74 +5,74 @@ 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

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

@@ -0,0 +1,136 @@
+# 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

@@ -0,0 +1,37 @@
+# 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

@@ -29,8 +29,8 @@ module Mindee
       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 << "\n:Serial Number: #{@serial_number}".rstrip
+        out_str << "\n:Size and Type: #{@size_type}".rstrip
         out_str[1..].to_s
       end
     end

data/lib/mindee/parsing/prediction.rb

@@ -6,6 +6,7 @@ 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'

data/lib/mindee/version.rb

@@ -2,7 +2,7 @@
 
 # Mindee
 module Mindee
-  VERSION = '2.1.1'
+  VERSION = '2.2.0'
 
   def self.find_platform
     host = RbConfig::CONFIG['host_os']

data/mindee.gemspec

@@ -30,10 +30,10 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = Gem::Requirement.new('>= 2.6')
 
   spec.add_runtime_dependency 'marcel', '~> 1.0.2'
-  spec.add_runtime_dependency 'origamindee', '~> 3.1'
+  spec.add_runtime_dependency 'origamindee', '~> 3.1.0'
 
-  spec.add_development_dependency 'rake', '~> 12.3'
-  spec.add_development_dependency 'rspec', '~> 3.11'
-  spec.add_development_dependency 'rubocop', '~> 1.41'
-  spec.add_development_dependency 'yard', '~> 0.9'
+  spec.add_development_dependency 'rake', '~> 12.3.3'
+  spec.add_development_dependency 'rspec', '~> 3.12.0'
+  spec.add_development_dependency 'rubocop', '~> 1.49.0'
+  spec.add_development_dependency 'yard', '~> 0.9.34'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mindee
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 2.2.0
 platform: ruby
 authors:
 - Mindee, SA
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-04-21 00:00:00.000000000 Z
+date: 2023-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: marcel
@@ -30,70 +30,70 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: 3.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: 3.1.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.11'
+        version: 3.12.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.11'
+        version: 3.12.0
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.41'
+        version: 1.49.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.41'
+        version: 1.49.0
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: 0.9.34
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: 0.9.34
 description: Quickly and easily connect to Mindee's API services using Ruby.
 email:
 - devrel@mindee.co
@@ -123,6 +123,7 @@ files:
 - docs/code_samples/custom_v1.txt
 - docs/code_samples/default.txt
 - docs/code_samples/expense_receipts_v4.txt
+- docs/code_samples/expense_receipts_v5.txt
 - docs/code_samples/financial_document_v1.txt
 - docs/code_samples/idcard_fr_v1.txt
 - docs/code_samples/invoices_v4.txt
@@ -164,15 +165,17 @@ files:
 - lib/mindee/parsing/prediction/custom/fields.rb
 - lib/mindee/parsing/prediction/eu/license_plate/license_plate_v1.rb
 - lib/mindee/parsing/prediction/financial_document/financial_document_v1.rb
-- lib/mindee/parsing/prediction/financial_document/invoice_line_item.rb
+- lib/mindee/parsing/prediction/financial_document/financial_document_v1_line_item.rb
 - lib/mindee/parsing/prediction/fr/bank_account_details/bank_account_details_v1.rb
 - lib/mindee/parsing/prediction/fr/carte_vitale/carte_vitale_v1.rb
 - lib/mindee/parsing/prediction/fr/id_card/id_card_v1.rb
-- lib/mindee/parsing/prediction/invoice/invoice_line_item.rb
 - lib/mindee/parsing/prediction/invoice/invoice_v4.rb
+- lib/mindee/parsing/prediction/invoice/invoice_v4_line_item.rb
 - lib/mindee/parsing/prediction/passport/passport_v1.rb
 - lib/mindee/parsing/prediction/proof_of_address/proof_of_address_v1.rb
 - lib/mindee/parsing/prediction/receipt/receipt_v4.rb
+- lib/mindee/parsing/prediction/receipt/receipt_v5.rb
+- lib/mindee/parsing/prediction/receipt/receipt_v5_line_item.rb
 - lib/mindee/parsing/prediction/shipping_container/shipping_container_v1.rb
 - lib/mindee/parsing/prediction/us/bank_check/bank_check_v1.rb
 - lib/mindee/version.rb