mindee 4.0.0 → 4.1.2

data/lib/mindee/product/invoice_splitter/invoice_splitter_v1_invoice_page_groups.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require_relative 'invoice_splitter_v1_invoice_page_group'
+
+module Mindee
+  module Product
+    module InvoiceSplitter
+      # List of page groups. Each group represents a single invoice within a multi-invoice document.
+      class InvoiceSplitterV1InvoicePageGroups < Array
+        # Entries.
+        # @return [Array<InvoiceSplitterV1InvoicePageGroup>]
+        attr_reader :entries
+
+        # @param prediction [Array]
+        # @param page_id [Integer, nil]
+        def initialize(prediction, page_id)
+          entries = prediction.map do |entry|
+            InvoiceSplitter::InvoiceSplitterV1InvoicePageGroup.new(entry, page_id)
+          end
+          super(entries)
+        end
+
+        # Creates a line of rST table-compliant string separators.
+        # @param char [String] Character to use as a separator.
+        # @return [String]
+        def self.line_items_separator(char)
+          out_str = String.new
+          out_str << "+#{char * 74}"
+          out_str
+        end
+
+        # @return [String]
+        def to_s
+          return '' if empty?
+
+          lines = map do |entry|
+            "\n  #{entry.to_table_line}\n#{self.class.line_items_separator('-')}"
+          end.join
+          out_str = String.new
+          out_str << ("\n#{self.class.line_items_separator('-')}\n ")
+          out_str << ' | Page Indexes                                                            '
+          out_str << (" |\n#{self.class.line_items_separator('=')}")
+          out_str + lines
+        end
+      end
+    end
+  end
+end

data/lib/mindee/product/invoice_splitter/invoice_splitter_v1_page.rb

@@ -6,15 +6,19 @@ require_relative 'invoice_splitter_v1_document'
 module Mindee
   module Product
     module InvoiceSplitter
-      # Invoice Splitter V1 page.
+      # Invoice Splitter API version 1.2 page data.
       class InvoiceSplitterV1Page < Mindee::Parsing::Common::Page
         # @param prediction [Hash]
         def initialize(prediction)
           super
-          @prediction = InvoiceSplitterV1PagePrediction.new(
-            prediction['prediction'],
-            prediction['id']
-          )
+          @prediction = if prediction['prediction'].empty?
+                          nil
+                        else
+                          InvoiceSplitterV1PagePrediction.new(
+                            prediction['prediction'],
+                            prediction['id']
+                          )
+                        end
         end
       end
 

data/lib/mindee/product/receipt/receipt_v5_document.rb

@@ -9,31 +9,31 @@ module Mindee
       # Receipt API version 5.3 document data.
       class ReceiptV5Document < Mindee::Parsing::Common::Prediction
         include Mindee::Parsing::Standard
-        # The purchase category among predefined classes.
+        # The purchase category of the receipt.
         # @return [Mindee::Parsing::Standard::ClassificationField]
         attr_reader :category
         # The date the purchase was made.
         # @return [Mindee::Parsing::Standard::DateField]
         attr_reader :date
-        # One of: 'CREDIT CARD RECEIPT', 'EXPENSE RECEIPT'.
+        # The type of receipt: EXPENSE RECEIPT or CREDIT CARD RECEIPT.
         # @return [Mindee::Parsing::Standard::ClassificationField]
         attr_reader :document_type
-        # List of line item details.
+        # List of all line items on the receipt.
         # @return [Mindee::Product::Receipt::ReceiptV5LineItems]
         attr_reader :line_items
-        # The locale detected on the document.
+        # The locale of the document.
         # @return [Mindee::Parsing::Standard::LocaleField]
         attr_reader :locale
         # The receipt number or identifier.
         # @return [Mindee::Parsing::Standard::StringField]
         attr_reader :receipt_number
-        # The purchase subcategory among predefined classes for transport and food.
+        # The purchase subcategory of the receipt for transport and food.
         # @return [Mindee::Parsing::Standard::ClassificationField]
         attr_reader :subcategory
         # The address of the supplier or merchant.
         # @return [Mindee::Parsing::Standard::StringField]
         attr_reader :supplier_address
-        # List of company registrations associated to the supplier.
+        # List of company registration numbers associated to the supplier.
         # @return [Array<Mindee::Parsing::Standard::CompanyRegistrationField>]
         attr_reader :supplier_company_registrations
         # The name of the supplier or merchant.
@@ -42,7 +42,7 @@ module Mindee
         # The phone number of the supplier or merchant.
         # @return [Mindee::Parsing::Standard::StringField]
         attr_reader :supplier_phone_number
-        # List of tax lines information.
+        # The list of taxes present on the receipt.
         # @return [Mindee::Parsing::Standard::Taxes]
         attr_reader :taxes
         # The time the purchase was made.
@@ -57,7 +57,7 @@ module Mindee
         # The net amount paid: does not include taxes, fees, and discounts.
         # @return [Mindee::Parsing::Standard::AmountField]
         attr_reader :total_net
-        # The total amount of taxes.
+        # The sum of all taxes.
         # @return [Mindee::Parsing::Standard::AmountField]
         attr_reader :total_tax
 

data/lib/mindee/product/receipt/receipt_v5_line_item.rb

@@ -5,7 +5,7 @@ require_relative '../../parsing'
 module Mindee
   module Product
     module Receipt
-      # List of line item details.
+      # List of all line items on the receipt.
       class ReceiptV5LineItem < Mindee::Parsing::Standard::FeatureField
         include Mindee::Parsing::Standard
         # The item description.

data/lib/mindee/product/receipt/receipt_v5_line_items.rb

@@ -5,7 +5,7 @@ require_relative 'receipt_v5_line_item'
 module Mindee
   module Product
     module Receipt
-      # List of line item details.
+      # List of all line items on the receipt.
       class ReceiptV5LineItems < Array
         # Entries.
         # @return [Array<ReceiptV5LineItem>]

data/lib/mindee/product/us/healthcare_card/healthcare_card_v1_document.rb

@@ -7,7 +7,7 @@ module Mindee
   module Product
     module US
       module HealthcareCard
-        # Healthcare Card API version 1.0 document data.
+        # Healthcare Card API version 1.1 document data.
         class HealthcareCardV1Document < Mindee::Parsing::Common::Prediction
           include Mindee::Parsing::Standard
           # The name of the company that provides the healthcare plan.

data/lib/mindee/product/us/healthcare_card/healthcare_card_v1_page.rb

@@ -7,7 +7,7 @@ module Mindee
   module Product
     module US
       module HealthcareCard
-        # Healthcare Card API version 1.0 page data.
+        # Healthcare Card API version 1.1 page data.
         class HealthcareCardV1Page < Mindee::Parsing::Common::Page
           # @param prediction [Hash]
           def initialize(prediction)

data/lib/mindee/product/{eu/license_plate/license_plate_v1.rb → us/us_mail/us_mail_v2.rb}

@@ -1,28 +1,28 @@
 # frozen_string_literal: true
 
 require_relative '../../../parsing'
-require_relative 'license_plate_v1_document'
-require_relative 'license_plate_v1_page'
+require_relative 'us_mail_v2_document'
+require_relative 'us_mail_v2_page'
 
 module Mindee
   module Product
-    module EU
-      # License Plate module.
-      module LicensePlate
-        # License Plate API version 1 inference prediction.
-        class LicensePlateV1 < Mindee::Parsing::Common::Inference
-          @endpoint_name = 'license_plates'
-          @endpoint_version = '1'
-          @has_async = false
-          @has_sync = true
+    module US
+      # US Mail module.
+      module UsMail
+        # US Mail API version 2 inference prediction.
+        class UsMailV2 < Mindee::Parsing::Common::Inference
+          @endpoint_name = 'us_mail'
+          @endpoint_version = '2'
+          @has_async = true
+          @has_sync = false
 
           # @param prediction [Hash]
           def initialize(prediction)
             super
-            @prediction = LicensePlateV1Document.new(prediction['prediction'], nil)
+            @prediction = UsMailV2Document.new(prediction['prediction'], nil)
             @pages = []
             prediction['pages'].each do |page|
-              @pages.push(LicensePlateV1Page.new(page))
+              @pages.push(UsMailV2Page.new(page))
             end
           end
 

data/lib/mindee/product/us/us_mail/us_mail_v2_document.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+require_relative '../../../parsing'
+require_relative 'us_mail_v2_sender_address'
+require_relative 'us_mail_v2_recipient_addresses'
+
+module Mindee
+  module Product
+    module US
+      module UsMail
+        # US Mail API version 2.0 document data.
+        class UsMailV2Document < Mindee::Parsing::Common::Prediction
+          include Mindee::Parsing::Standard
+          # The addresses of the recipients.
+          # @return [Mindee::Product::US::UsMail::UsMailV2RecipientAddresses]
+          attr_reader :recipient_addresses
+          # The names of the recipients.
+          # @return [Array<Mindee::Parsing::Standard::StringField>]
+          attr_reader :recipient_names
+          # The address of the sender.
+          # @return [Mindee::Product::US::UsMail::UsMailV2SenderAddress]
+          attr_reader :sender_address
+          # The name of the sender.
+          # @return [Mindee::Parsing::Standard::StringField]
+          attr_reader :sender_name
+
+          # @param prediction [Hash]
+          # @param page_id [Integer, nil]
+          def initialize(prediction, page_id)
+            super
+            @recipient_addresses = Product::US::UsMail::UsMailV2RecipientAddresses.new(
+              prediction['recipient_addresses'], page_id
+            )
+            @recipient_names = [] # : Array[Parsing::Standard::StringField]
+            prediction['recipient_names'].each do |item|
+              @recipient_names.push(Parsing::Standard::StringField.new(item, page_id))
+            end
+            @sender_address = Product::US::UsMail::UsMailV2SenderAddress.new(
+              prediction['sender_address'],
+              page_id
+            )
+            @sender_name = Parsing::Standard::StringField.new(
+              prediction['sender_name'],
+              page_id
+            )
+          end
+
+          # @return [String]
+          def to_s
+            sender_address = @sender_address.to_s
+            recipient_names = @recipient_names.join("\n #{' ' * 17}")
+            recipient_addresses = recipient_addresses_to_s
+            out_str = String.new
+            out_str << "\n:Sender Name: #{@sender_name}".rstrip
+            out_str << "\n:Sender Address:"
+            out_str << sender_address
+            out_str << "\n:Recipient Names: #{recipient_names}".rstrip
+            out_str << "\n:Recipient Addresses:"
+            out_str << recipient_addresses
+            out_str[1..].to_s
+          end
+
+          private
+
+          # @param char [String]
+          # @return [String]
+          def recipient_addresses_separator(char)
+            out_str = String.new
+            out_str << '  '
+            out_str << "+#{char * 17}"
+            out_str << "+#{char * 37}"
+            out_str << "+#{char * 19}"
+            out_str << "+#{char * 13}"
+            out_str << "+#{char * 24}"
+            out_str << "+#{char * 7}"
+            out_str << "+#{char * 27}"
+            out_str << '+'
+            out_str
+          end
+
+          # @return [String]
+          def recipient_addresses_to_s
+            return '' if @recipient_addresses.empty?
+
+            line_items = @recipient_addresses.map(&:to_table_line).join("\n#{recipient_addresses_separator('-')}\n  ")
+            out_str = String.new
+            out_str << "\n#{recipient_addresses_separator('-')}"
+            out_str << "\n  |"
+            out_str << ' City            |'
+            out_str << ' Complete Address                    |'
+            out_str << ' Is Address Change |'
+            out_str << ' Postal Code |'
+            out_str << ' Private Mailbox Number |'
+            out_str << ' State |'
+            out_str << ' Street                    |'
+            out_str << "\n#{recipient_addresses_separator('=')}"
+            out_str << "\n  #{line_items}"
+            out_str << "\n#{recipient_addresses_separator('-')}"
+            out_str
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mindee/product/{eu/license_plate/license_plate_v1_page.rb → us/us_mail/us_mail_v2_page.rb}

@@ -1,21 +1,21 @@
 # frozen_string_literal: true
 
 require_relative '../../../parsing'
-require_relative 'license_plate_v1_document'
+require_relative 'us_mail_v2_document'
 
 module Mindee
   module Product
-    module EU
-      module LicensePlate
-        # License Plate API version 1.1 page data.
-        class LicensePlateV1Page < Mindee::Parsing::Common::Page
+    module US
+      module UsMail
+        # US Mail API version 2.0 page data.
+        class UsMailV2Page < Mindee::Parsing::Common::Page
           # @param prediction [Hash]
           def initialize(prediction)
             super
             @prediction = if prediction['prediction'].empty?
                             nil
                           else
-                            LicensePlateV1PagePrediction.new(
+                            UsMailV2PagePrediction.new(
                               prediction['prediction'],
                               prediction['id']
                             )
@@ -23,8 +23,8 @@ module Mindee
           end
         end
 
-        # License Plate V1 page prediction.
-        class LicensePlateV1PagePrediction < LicensePlateV1Document
+        # US Mail V2 page prediction.
+        class UsMailV2PagePrediction < UsMailV2Document
           # @return [String]
           def to_s
             out_str = String.new

data/lib/mindee/product/us/us_mail/us_mail_v2_recipient_address.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+require_relative '../../../parsing'
+
+module Mindee
+  module Product
+    module US
+      module UsMail
+        # The addresses of the recipients.
+        class UsMailV2RecipientAddress < Mindee::Parsing::Standard::FeatureField
+          include Mindee::Parsing::Standard
+          # The city of the recipient's address.
+          # @return [String]
+          attr_reader :city
+          # The complete address of the recipient.
+          # @return [String]
+          attr_reader :complete
+          # Indicates if the recipient's address is a change of address.
+          # @return [bool]
+          attr_reader :is_address_change
+          # The postal code of the recipient's address.
+          # @return [String]
+          attr_reader :postal_code
+          # The private mailbox number of the recipient's address.
+          # @return [String]
+          attr_reader :private_mailbox_number
+          # Second part of the ISO 3166-2 code, consisting of two letters indicating the US State.
+          # @return [String]
+          attr_reader :state
+          # The street of the recipient's address.
+          # @return [String]
+          attr_reader :street
+
+          # @param prediction [Hash]
+          # @param page_id [Integer, nil]
+          def initialize(prediction, page_id)
+            super
+            @city = prediction['city']
+            @complete = prediction['complete']
+            @is_address_change = prediction['is_address_change']
+            @postal_code = prediction['postal_code']
+            @private_mailbox_number = prediction['private_mailbox_number']
+            @state = prediction['state']
+            @street = prediction['street']
+            @page_id = page_id
+          end
+
+          # @return [Hash]
+          def printable_values
+            printable = {}
+            printable[:city] = format_for_display(@city)
+            printable[:complete] = format_for_display(@complete)
+            printable[:is_address_change] = format_for_display(@is_address_change)
+            printable[:postal_code] = format_for_display(@postal_code)
+            printable[:private_mailbox_number] = format_for_display(@private_mailbox_number)
+            printable[:state] = format_for_display(@state)
+            printable[:street] = format_for_display(@street)
+            printable
+          end
+
+          # @return [Hash]
+          def table_printable_values
+            printable = {}
+            printable[:city] = format_for_display(@city, 15)
+            printable[:complete] = format_for_display(@complete, 35)
+            printable[:is_address_change] = format_for_display(@is_address_change, nil)
+            printable[:postal_code] = format_for_display(@postal_code, nil)
+            printable[:private_mailbox_number] = format_for_display(@private_mailbox_number, nil)
+            printable[:state] = format_for_display(@state, nil)
+            printable[:street] = format_for_display(@street, 25)
+            printable
+          end
+
+          # @return [String]
+          def to_table_line
+            printable = table_printable_values
+            out_str = String.new
+            out_str << format('| %- 16s', printable[:city])
+            out_str << format('| %- 36s', printable[:complete])
+            out_str << format('| %- 18s', printable[:is_address_change])
+            out_str << format('| %- 12s', printable[:postal_code])
+            out_str << format('| %- 23s', printable[:private_mailbox_number])
+            out_str << format('| %- 6s', printable[:state])
+            out_str << format('| %- 26s', printable[:street])
+            out_str << '|'
+          end
+
+          # @return [String]
+          def to_s
+            printable = printable_values
+            out_str = String.new
+            out_str << "\n  :City: #{printable[:city]}"
+            out_str << "\n  :Complete Address: #{printable[:complete]}"
+            out_str << "\n  :Is Address Change: #{printable[:is_address_change]}"
+            out_str << "\n  :Postal Code: #{printable[:postal_code]}"
+            out_str << "\n  :Private Mailbox Number: #{printable[:private_mailbox_number]}"
+            out_str << "\n  :State: #{printable[:state]}"
+            out_str << "\n  :Street: #{printable[:street]}"
+            out_str
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mindee/product/us/us_mail/us_mail_v2_recipient_addresses.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require_relative 'us_mail_v2_sender_address'
+require_relative 'us_mail_v2_recipient_address'
+
+module Mindee
+  module Product
+    module US
+      module UsMail
+        # The addresses of the recipients.
+        class UsMailV2RecipientAddresses < Array
+          # Entries.
+          # @return [Array<UsMailV2RecipientAddress>]
+          attr_reader :entries
+
+          # @param prediction [Array]
+          # @param page_id [Integer, nil]
+          def initialize(prediction, page_id)
+            entries = prediction.map do |entry|
+              UsMail::UsMailV2RecipientAddress.new(entry, page_id)
+            end
+            super(entries)
+          end
+
+          # Creates a line of rST table-compliant string separators.
+          # @param char [String] Character to use as a separator.
+          # @return [String]
+          def self.line_items_separator(char)
+            out_str = String.new
+            out_str << "+#{char * 17}"
+            out_str << "+#{char * 37}"
+            out_str << "+#{char * 19}"
+            out_str << "+#{char * 13}"
+            out_str << "+#{char * 24}"
+            out_str << "+#{char * 7}"
+            out_str << "+#{char * 27}"
+            out_str
+          end
+
+          # @return [String]
+          def to_s
+            return '' if empty?
+
+            lines = map do |entry|
+              "\n  #{entry.to_table_line}\n#{self.class.line_items_separator('-')}"
+            end.join
+            out_str = String.new
+            out_str << ("\n#{self.class.line_items_separator('-')}\n ")
+            out_str << ' | City           '
+            out_str << ' | Complete Address                   '
+            out_str << ' | Is Address Change'
+            out_str << ' | Postal Code'
+            out_str << ' | Private Mailbox Number'
+            out_str << ' | State'
+            out_str << ' | Street                   '
+            out_str << (" |\n#{self.class.line_items_separator('=')}")
+            out_str + lines
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mindee/product/us/us_mail/us_mail_v2_sender_address.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require_relative '../../../parsing'
+
+module Mindee
+  module Product
+    module US
+      module UsMail
+        # The address of the sender.
+        class UsMailV2SenderAddress < Mindee::Parsing::Standard::FeatureField
+          include Mindee::Parsing::Standard
+          # The city of the sender's address.
+          # @return [String]
+          attr_reader :city
+          # The complete address of the sender.
+          # @return [String]
+          attr_reader :complete
+          # The postal code of the sender's address.
+          # @return [String]
+          attr_reader :postal_code
+          # Second part of the ISO 3166-2 code, consisting of two letters indicating the US State.
+          # @return [String]
+          attr_reader :state
+          # The street of the sender's address.
+          # @return [String]
+          attr_reader :street
+
+          # @param prediction [Hash]
+          # @param page_id [Integer, nil]
+          def initialize(prediction, page_id)
+            super
+            @city = prediction['city']
+            @complete = prediction['complete']
+            @postal_code = prediction['postal_code']
+            @state = prediction['state']
+            @street = prediction['street']
+            @page_id = page_id
+          end
+
+          # @return [Hash]
+          def printable_values
+            printable = {}
+            printable[:city] = format_for_display(@city)
+            printable[:complete] = format_for_display(@complete)
+            printable[:postal_code] = format_for_display(@postal_code)
+            printable[:state] = format_for_display(@state)
+            printable[:street] = format_for_display(@street)
+            printable
+          end
+
+          # @return [String]
+          def to_s
+            printable = printable_values
+            out_str = String.new
+            out_str << "\n  :City: #{printable[:city]}"
+            out_str << "\n  :Complete Address: #{printable[:complete]}"
+            out_str << "\n  :Postal Code: #{printable[:postal_code]}"
+            out_str << "\n  :State: #{printable[:state]}"
+            out_str << "\n  :Street: #{printable[:street]}"
+            out_str
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mindee/product.rb

@@ -6,22 +6,21 @@ require_relative 'product/business_card/business_card_v1'
 require_relative 'product/cropper/cropper_v1'
 require_relative 'product/delivery_note/delivery_note_v1'
 require_relative 'product/driver_license/driver_license_v1'
-require_relative 'product/eu/license_plate/license_plate_v1'
+require_relative 'product/financial_document/financial_document_v1'
 require_relative 'product/fr/bank_account_details/bank_account_details_v1'
 require_relative 'product/fr/bank_account_details/bank_account_details_v2'
 require_relative 'product/fr/bank_statement/bank_statement_v2'
 require_relative 'product/fr/carte_grise/carte_grise_v1'
-require_relative 'product/fr/id_card/id_card_v1'
-require_relative 'product/fr/id_card/id_card_v2'
 require_relative 'product/fr/energy_bill/energy_bill_v1'
 require_relative 'product/fr/health_card/health_card_v1'
+require_relative 'product/fr/id_card/id_card_v1'
+require_relative 'product/fr/id_card/id_card_v2'
 require_relative 'product/fr/payslip/payslip_v2'
 require_relative 'product/fr/payslip/payslip_v3'
-require_relative 'product/financial_document/financial_document_v1'
 require_relative 'product/ind/indian_passport/indian_passport_v1'
+require_relative 'product/international_id/international_id_v2'
 require_relative 'product/invoice/invoice_v4'
 require_relative 'product/invoice_splitter/invoice_splitter_v1'
-require_relative 'product/international_id/international_id_v2'
 require_relative 'product/multi_receipts_detector/multi_receipts_detector_v1'
 require_relative 'product/nutrition_facts_label/nutrition_facts_label_v1'
 require_relative 'product/passport/passport_v1'
@@ -30,5 +29,6 @@ require_relative 'product/resume/resume_v1'
 require_relative 'product/universal/universal'
 require_relative 'product/us/bank_check/bank_check_v1'
 require_relative 'product/us/healthcare_card/healthcare_card_v1'
+require_relative 'product/us/us_mail/us_mail_v2'
 require_relative 'product/us/us_mail/us_mail_v3'
 require_relative 'product/us/w9/w9_v1'

data/lib/mindee/version.rb

@@ -3,7 +3,7 @@
 # Mindee
 module Mindee
   # Current version.
-  VERSION = '4.0.0'
+  VERSION = '4.1.2'
 
   # Finds and return the current platform.
   # @return [Symbol, Hash[Symbol | String, Regexp], Nil?]