mindee 3.19.1 → 4.0.0

data/lib/mindee/product/invoice/invoice_v4.rb

@@ -12,6 +12,8 @@ module Mindee
       class InvoiceV4 < Mindee::Parsing::Common::Inference
         @endpoint_name = 'invoices'
         @endpoint_version = '4'
+        @has_async = true
+        @has_sync = true
 
         # @param prediction [Hash]
         def initialize(prediction)
@@ -19,9 +21,7 @@ module Mindee
           @prediction = InvoiceV4Document.new(prediction['prediction'], nil)
           @pages = []
           prediction['pages'].each do |page|
-            if page.key?('prediction') && !page['prediction'].nil? && !page['prediction'].empty?
-              @pages.push(InvoiceV4Page.new(page))
-            end
+            @pages.push(InvoiceV4Page.new(page))
           end
         end
 
@@ -32,6 +32,12 @@ module Mindee
           # Version for this product.
           # @return [String]
           attr_reader :endpoint_version
+          # Whether this product has access to an asynchronous endpoint.
+          # @return [bool]
+          attr_reader :has_async
+          # Whether this product has access to synchronous endpoint.
+          # @return [bool]
+          attr_reader :has_sync
         end
       end
     end

data/lib/mindee/product/invoice/invoice_v4_document.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require_relative '../../parsing'
-require_relative 'invoice_v4_line_item'
+require_relative 'invoice_v4_line_items'
 
 module Mindee
   module Product
@@ -37,7 +37,7 @@ module Mindee
         # @return [Mindee::Parsing::Standard::StringField]
         attr_reader :invoice_number
         # List of line item details.
-        # @return [Array<Mindee::Product::Invoice::InvoiceV4LineItem>]
+        # @return [Mindee::Product::Invoice::InvoiceV4LineItems]
         attr_reader :line_items
         # The locale detected on the document.
         # @return [Mindee::Parsing::Standard::LocaleField]
@@ -91,48 +91,102 @@ module Mindee
         # @param prediction [Hash]
         # @param page_id [Integer, nil]
         def initialize(prediction, page_id)
-          super()
-          @billing_address = StringField.new(prediction['billing_address'], page_id)
-          @customer_address = StringField.new(prediction['customer_address'], page_id)
-          @customer_company_registrations = []
+          super
+          @billing_address = Parsing::Standard::StringField.new(
+            prediction['billing_address'],
+            page_id
+          )
+          @customer_address = Parsing::Standard::StringField.new(
+            prediction['customer_address'],
+            page_id
+          )
+          @customer_company_registrations = [] # : Array[Parsing::Standard::CompanyRegistrationField]
           prediction['customer_company_registrations'].each do |item|
-            @customer_company_registrations.push(CompanyRegistrationField.new(item, page_id))
+            @customer_company_registrations.push(Parsing::Standard::CompanyRegistrationField.new(item, page_id))
           end
-          @customer_id = StringField.new(prediction['customer_id'], page_id)
-          @customer_name = StringField.new(prediction['customer_name'], page_id)
-          @date = DateField.new(prediction['date'], page_id)
-          @document_type = ClassificationField.new(prediction['document_type'], page_id)
-          @due_date = DateField.new(prediction['due_date'], page_id)
-          @invoice_number = StringField.new(prediction['invoice_number'], page_id)
-          @line_items = []
-          prediction['line_items'].each do |item|
-            @line_items.push(InvoiceV4LineItem.new(item, page_id))
-          end
-          @locale = LocaleField.new(prediction['locale'], page_id)
-          @payment_date = DateField.new(prediction['payment_date'], page_id)
-          @po_number = StringField.new(prediction['po_number'], page_id)
-          @reference_numbers = []
+          @customer_id = Parsing::Standard::StringField.new(
+            prediction['customer_id'],
+            page_id
+          )
+          @customer_name = Parsing::Standard::StringField.new(
+            prediction['customer_name'],
+            page_id
+          )
+          @date = Parsing::Standard::DateField.new(prediction['date'], page_id)
+          @document_type = Parsing::Standard::ClassificationField.new(
+            prediction['document_type'],
+            page_id
+          )
+          @due_date = Parsing::Standard::DateField.new(
+            prediction['due_date'],
+            page_id
+          )
+          @invoice_number = Parsing::Standard::StringField.new(
+            prediction['invoice_number'],
+            page_id
+          )
+          @line_items = Product::Invoice::InvoiceV4LineItems.new(prediction['line_items'], page_id)
+          @locale = Parsing::Standard::LocaleField.new(
+            prediction['locale'],
+            page_id
+          )
+          @payment_date = Parsing::Standard::DateField.new(
+            prediction['payment_date'],
+            page_id
+          )
+          @po_number = Parsing::Standard::StringField.new(
+            prediction['po_number'],
+            page_id
+          )
+          @reference_numbers = [] # : Array[Parsing::Standard::StringField]
           prediction['reference_numbers'].each do |item|
-            @reference_numbers.push(StringField.new(item, page_id))
+            @reference_numbers.push(Parsing::Standard::StringField.new(item, page_id))
           end
-          @shipping_address = StringField.new(prediction['shipping_address'], page_id)
-          @supplier_address = StringField.new(prediction['supplier_address'], page_id)
-          @supplier_company_registrations = []
+          @shipping_address = Parsing::Standard::StringField.new(
+            prediction['shipping_address'],
+            page_id
+          )
+          @supplier_address = Parsing::Standard::StringField.new(
+            prediction['supplier_address'],
+            page_id
+          )
+          @supplier_company_registrations = [] # : Array[Parsing::Standard::CompanyRegistrationField]
           prediction['supplier_company_registrations'].each do |item|
-            @supplier_company_registrations.push(CompanyRegistrationField.new(item, page_id))
+            @supplier_company_registrations.push(Parsing::Standard::CompanyRegistrationField.new(item, page_id))
           end
-          @supplier_email = StringField.new(prediction['supplier_email'], page_id)
-          @supplier_name = StringField.new(prediction['supplier_name'], page_id)
-          @supplier_payment_details = []
+          @supplier_email = Parsing::Standard::StringField.new(
+            prediction['supplier_email'],
+            page_id
+          )
+          @supplier_name = Parsing::Standard::StringField.new(
+            prediction['supplier_name'],
+            page_id
+          )
+          @supplier_payment_details = [] # : Array[Parsing::Standard::PaymentDetailsField]
           prediction['supplier_payment_details'].each do |item|
-            @supplier_payment_details.push(PaymentDetailsField.new(item, page_id))
+            @supplier_payment_details.push(Parsing::Standard::PaymentDetailsField.new(item, page_id))
           end
-          @supplier_phone_number = StringField.new(prediction['supplier_phone_number'], page_id)
-          @supplier_website = StringField.new(prediction['supplier_website'], page_id)
-          @taxes = Taxes.new(prediction['taxes'], 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)
+          @supplier_phone_number = Parsing::Standard::StringField.new(
+            prediction['supplier_phone_number'],
+            page_id
+          )
+          @supplier_website = Parsing::Standard::StringField.new(
+            prediction['supplier_website'],
+            page_id
+          )
+          @taxes = Parsing::Standard::Taxes.new(prediction['taxes'], page_id)
+          @total_amount = Parsing::Standard::AmountField.new(
+            prediction['total_amount'],
+            page_id
+          )
+          @total_net = Parsing::Standard::AmountField.new(
+            prediction['total_net'],
+            page_id
+          )
+          @total_tax = Parsing::Standard::AmountField.new(
+            prediction['total_tax'],
+            page_id
+          )
         end
 
         # @return [String]

data/lib/mindee/product/invoice/invoice_v4_line_item.rb

@@ -36,7 +36,7 @@ module Mindee
         # @param prediction [Hash]
         # @param page_id [Integer, nil]
         def initialize(prediction, page_id)
-          super(prediction, page_id)
+          super
           @description = prediction['description']
           @product_code = prediction['product_code']
           @quantity = prediction['quantity']
@@ -53,12 +53,17 @@ module Mindee
           printable = {}
           printable[:description] = format_for_display(@description)
           printable[:product_code] = format_for_display(@product_code)
-          printable[:quantity] = @quantity.nil? ? '' : Field.float_to_string(@quantity)
-          printable[:tax_amount] = @tax_amount.nil? ? '' : Field.float_to_string(@tax_amount)
-          printable[:tax_rate] = @tax_rate.nil? ? '' : Field.float_to_string(@tax_rate)
-          printable[:total_amount] = @total_amount.nil? ? '' : Field.float_to_string(@total_amount)
+          printable[:quantity] =
+            @quantity.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@quantity)
+          printable[:tax_amount] =
+            @tax_amount.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@tax_amount)
+          printable[:tax_rate] =
+            @tax_rate.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@tax_rate)
+          printable[:total_amount] =
+            @total_amount.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@total_amount)
           printable[:unit_measure] = format_for_display(@unit_measure)
-          printable[:unit_price] = @unit_price.nil? ? '' : Field.float_to_string(@unit_price)
+          printable[:unit_price] =
+            @unit_price.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@unit_price)
           printable
         end
 
@@ -67,12 +72,17 @@ module Mindee
           printable = {}
           printable[:description] = format_for_display(@description, 36)
           printable[:product_code] = format_for_display(@product_code, nil)
-          printable[:quantity] = @quantity.nil? ? '' : Field.float_to_string(@quantity)
-          printable[:tax_amount] = @tax_amount.nil? ? '' : Field.float_to_string(@tax_amount)
-          printable[:tax_rate] = @tax_rate.nil? ? '' : Field.float_to_string(@tax_rate)
-          printable[:total_amount] = @total_amount.nil? ? '' : Field.float_to_string(@total_amount)
+          printable[:quantity] =
+            @quantity.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@quantity)
+          printable[:tax_amount] =
+            @tax_amount.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@tax_amount)
+          printable[:tax_rate] =
+            @tax_rate.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@tax_rate)
+          printable[:total_amount] =
+            @total_amount.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@total_amount)
           printable[:unit_measure] = format_for_display(@unit_measure, nil)
-          printable[:unit_price] = @unit_price.nil? ? '' : Field.float_to_string(@unit_price)
+          printable[:unit_price] =
+            @unit_price.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@unit_price)
           printable
         end
 

data/lib/mindee/product/invoice/invoice_v4_line_items.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require_relative 'invoice_v4_line_item'
+
+module Mindee
+  module Product
+    module Invoice
+      # List of line item details.
+      class InvoiceV4LineItems < Array
+        # Entries.
+        # @return [Array<InvoiceV4LineItem>]
+        attr_reader :entries
+
+        # @param prediction [Array]
+        # @param page_id [Integer, nil]
+        def initialize(prediction, page_id)
+          entries = prediction.map do |entry|
+            Invoice::InvoiceV4LineItem.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 * 38}"
+          out_str << "+#{char * 14}"
+          out_str << "+#{char * 10}"
+          out_str << "+#{char * 12}"
+          out_str << "+#{char * 14}"
+          out_str << "+#{char * 14}"
+          out_str << "+#{char * 17}"
+          out_str << "+#{char * 12}"
+          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 << ' | Description                         '
+          out_str << ' | Product code'
+          out_str << ' | Quantity'
+          out_str << ' | Tax Amount'
+          out_str << ' | Tax Rate (%)'
+          out_str << ' | Total Amount'
+          out_str << ' | Unit of measure'
+          out_str << ' | Unit Price'
+          out_str << (" |\n#{self.class.line_items_separator('=')}")
+          out_str + lines
+        end
+      end
+    end
+  end
+end

data/lib/mindee/product/invoice/invoice_v4_page.rb

@@ -10,11 +10,15 @@ module Mindee
       class InvoiceV4Page < Mindee::Parsing::Common::Page
         # @param prediction [Hash]
         def initialize(prediction)
-          super(prediction)
-          @prediction = InvoiceV4PagePrediction.new(
-            prediction['prediction'],
-            prediction['id']
-          )
+          super
+          @prediction = if prediction['prediction'].empty?
+                          nil
+                        else
+                          InvoiceV4PagePrediction.new(
+                            prediction['prediction'],
+                            prediction['id']
+                          )
+                        end
         end
       end
 

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

@@ -12,6 +12,8 @@ module Mindee
       class InvoiceSplitterV1 < Mindee::Parsing::Common::Inference
         @endpoint_name = 'invoice_splitter'
         @endpoint_version = '1'
+        @has_sync = false
+        @has_async = true
 
         # @param prediction [Hash]
         def initialize(prediction)
@@ -30,6 +32,12 @@ module Mindee
           # Version for this product.
           # @return [String]
           attr_reader :endpoint_version
+          # Whether this product has access to an asynchronous endpoint.
+          # @return [bool]
+          attr_reader :has_async
+          # Whether this product has access to synchronous endpoint.
+          # @return [bool]
+          attr_reader :has_sync
         end
       end
     end

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

@@ -34,8 +34,8 @@ module Mindee
 
         # @param prediction [Hash]
         # @param _page_id [Integer, nil]
-        def initialize(prediction, _page_id)
-          super()
+        def initialize(prediction, _page_id = nil)
+          super(prediction, nil)
           construct_invoice_page_groups_from_prediction(prediction)
         end
 

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

@@ -10,7 +10,7 @@ module Mindee
       class InvoiceSplitterV1Page < Mindee::Parsing::Common::Page
         # @param prediction [Hash]
         def initialize(prediction)
-          super(prediction)
+          super
           @prediction = InvoiceSplitterV1PagePrediction.new(
             prediction['prediction'],
             prediction['id']

data/lib/mindee/product/multi_receipts_detector/multi_receipts_detector_v1.rb

@@ -12,6 +12,8 @@ module Mindee
       class MultiReceiptsDetectorV1 < Mindee::Parsing::Common::Inference
         @endpoint_name = 'multi_receipts_detector'
         @endpoint_version = '1'
+        @has_async = false
+        @has_sync = true
 
         # @param prediction [Hash]
         def initialize(prediction)
@@ -19,9 +21,7 @@ module Mindee
           @prediction = MultiReceiptsDetectorV1Document.new(prediction['prediction'], nil)
           @pages = []
           prediction['pages'].each do |page|
-            if page.key?('prediction') && !page['prediction'].nil? && !page['prediction'].empty?
-              @pages.push(MultiReceiptsDetectorV1Page.new(page))
-            end
+            @pages.push(MultiReceiptsDetectorV1Page.new(page))
           end
         end
 
@@ -32,6 +32,12 @@ module Mindee
           # Version for this product.
           # @return [String]
           attr_reader :endpoint_version
+          # Whether this product has access to an asynchronous endpoint.
+          # @return [bool]
+          attr_reader :has_async
+          # Whether this product has access to synchronous endpoint.
+          # @return [bool]
+          attr_reader :has_sync
         end
       end
     end

data/lib/mindee/product/multi_receipts_detector/multi_receipts_detector_v1_document.rb

@@ -15,10 +15,10 @@ module Mindee
         # @param prediction [Hash]
         # @param page_id [Integer, nil]
         def initialize(prediction, page_id)
-          super()
-          @receipts = []
+          super
+          @receipts = [] # : Array[Parsing::Standard::PositionField]
           prediction['receipts'].each do |item|
-            @receipts.push(PositionField.new(item, page_id))
+            @receipts.push(Parsing::Standard::PositionField.new(item, page_id))
           end
         end
 

data/lib/mindee/product/multi_receipts_detector/multi_receipts_detector_v1_page.rb

@@ -10,11 +10,15 @@ module Mindee
       class MultiReceiptsDetectorV1Page < Mindee::Parsing::Common::Page
         # @param prediction [Hash]
         def initialize(prediction)
-          super(prediction)
-          @prediction = MultiReceiptsDetectorV1PagePrediction.new(
-            prediction['prediction'],
-            prediction['id']
-          )
+          super
+          @prediction = if prediction['prediction'].empty?
+                          nil
+                        else
+                          MultiReceiptsDetectorV1PagePrediction.new(
+                            prediction['prediction'],
+                            prediction['id']
+                          )
+                        end
         end
       end
 

data/lib/mindee/product/nutrition_facts_label/nutrition_facts_label_v1.rb

@@ -12,6 +12,8 @@ module Mindee
       class NutritionFactsLabelV1 < Mindee::Parsing::Common::Inference
         @endpoint_name = 'nutrition_facts'
         @endpoint_version = '1'
+        @has_async = true
+        @has_sync = false
 
         # @param prediction [Hash]
         def initialize(prediction)
@@ -19,9 +21,7 @@ module Mindee
           @prediction = NutritionFactsLabelV1Document.new(prediction['prediction'], nil)
           @pages = []
           prediction['pages'].each do |page|
-            if page.key?('prediction') && !page['prediction'].nil? && !page['prediction'].empty?
-              @pages.push(NutritionFactsLabelV1Page.new(page))
-            end
+            @pages.push(NutritionFactsLabelV1Page.new(page))
           end
         end
 
@@ -32,6 +32,12 @@ module Mindee
           # Version for this product.
           # @return [String]
           attr_reader :endpoint_version
+          # Whether this product has access to an asynchronous endpoint.
+          # @return [bool]
+          attr_reader :has_async
+          # Whether this product has access to synchronous endpoint.
+          # @return [bool]
+          attr_reader :has_sync
         end
       end
     end

data/lib/mindee/product/nutrition_facts_label/nutrition_facts_label_v1_added_sugar.rb

@@ -21,7 +21,7 @@ module Mindee
         # @param prediction [Hash]
         # @param page_id [Integer, nil]
         def initialize(prediction, page_id)
-          super(prediction, page_id)
+          super
           @daily_value = prediction['daily_value']
           @per_100g = prediction['per_100g']
           @per_serving = prediction['per_serving']
@@ -31,9 +31,12 @@ module Mindee
         # @return [Hash]
         def printable_values
           printable = {}
-          printable[:daily_value] = @daily_value.nil? ? '' : Field.float_to_string(@daily_value)
-          printable[:per_100g] = @per_100g.nil? ? '' : Field.float_to_string(@per_100g)
-          printable[:per_serving] = @per_serving.nil? ? '' : Field.float_to_string(@per_serving)
+          printable[:daily_value] =
+            @daily_value.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@daily_value)
+          printable[:per_100g] =
+            @per_100g.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@per_100g)
+          printable[:per_serving] =
+            @per_serving.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@per_serving)
           printable
         end
 

data/lib/mindee/product/nutrition_facts_label/nutrition_facts_label_v1_calorie.rb

@@ -21,7 +21,7 @@ module Mindee
         # @param prediction [Hash]
         # @param page_id [Integer, nil]
         def initialize(prediction, page_id)
-          super(prediction, page_id)
+          super
           @daily_value = prediction['daily_value']
           @per_100g = prediction['per_100g']
           @per_serving = prediction['per_serving']
@@ -31,9 +31,12 @@ module Mindee
         # @return [Hash]
         def printable_values
           printable = {}
-          printable[:daily_value] = @daily_value.nil? ? '' : Field.float_to_string(@daily_value)
-          printable[:per_100g] = @per_100g.nil? ? '' : Field.float_to_string(@per_100g)
-          printable[:per_serving] = @per_serving.nil? ? '' : Field.float_to_string(@per_serving)
+          printable[:daily_value] =
+            @daily_value.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@daily_value)
+          printable[:per_100g] =
+            @per_100g.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@per_100g)
+          printable[:per_serving] =
+            @per_serving.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@per_serving)
           printable
         end
 

data/lib/mindee/product/nutrition_facts_label/nutrition_facts_label_v1_cholesterol.rb

@@ -21,7 +21,7 @@ module Mindee
         # @param prediction [Hash]
         # @param page_id [Integer, nil]
         def initialize(prediction, page_id)
-          super(prediction, page_id)
+          super
           @daily_value = prediction['daily_value']
           @per_100g = prediction['per_100g']
           @per_serving = prediction['per_serving']
@@ -31,9 +31,12 @@ module Mindee
         # @return [Hash]
         def printable_values
           printable = {}
-          printable[:daily_value] = @daily_value.nil? ? '' : Field.float_to_string(@daily_value)
-          printable[:per_100g] = @per_100g.nil? ? '' : Field.float_to_string(@per_100g)
-          printable[:per_serving] = @per_serving.nil? ? '' : Field.float_to_string(@per_serving)
+          printable[:daily_value] =
+            @daily_value.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@daily_value)
+          printable[:per_100g] =
+            @per_100g.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@per_100g)
+          printable[:per_serving] =
+            @per_serving.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@per_serving)
           printable
         end
 

data/lib/mindee/product/nutrition_facts_label/nutrition_facts_label_v1_dietary_fiber.rb

@@ -21,7 +21,7 @@ module Mindee
         # @param prediction [Hash]
         # @param page_id [Integer, nil]
         def initialize(prediction, page_id)
-          super(prediction, page_id)
+          super
           @daily_value = prediction['daily_value']
           @per_100g = prediction['per_100g']
           @per_serving = prediction['per_serving']
@@ -31,9 +31,12 @@ module Mindee
         # @return [Hash]
         def printable_values
           printable = {}
-          printable[:daily_value] = @daily_value.nil? ? '' : Field.float_to_string(@daily_value)
-          printable[:per_100g] = @per_100g.nil? ? '' : Field.float_to_string(@per_100g)
-          printable[:per_serving] = @per_serving.nil? ? '' : Field.float_to_string(@per_serving)
+          printable[:daily_value] =
+            @daily_value.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@daily_value)
+          printable[:per_100g] =
+            @per_100g.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@per_100g)
+          printable[:per_serving] =
+            @per_serving.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@per_serving)
           printable
         end