mindee 3.19.1 → 4.0.0

data/lib/mindee/product/fr/energy_bill/energy_bill_v1_energy_usage.rb

@@ -31,7 +31,7 @@ module Mindee
           # @param prediction [Hash]
           # @param page_id [Integer, nil]
           def initialize(prediction, page_id)
-            super(prediction, page_id)
+            super
             @description = prediction['description']
             @end_date = prediction['end_date']
             @start_date = prediction['start_date']
@@ -47,9 +47,12 @@ module Mindee
             printable[:description] = format_for_display(@description)
             printable[:end_date] = format_for_display(@end_date)
             printable[:start_date] = format_for_display(@start_date)
-            printable[:tax_rate] = @tax_rate.nil? ? '' : Field.float_to_string(@tax_rate)
-            printable[:total] = @total.nil? ? '' : Field.float_to_string(@total)
-            printable[:unit_price] = @unit_price.nil? ? '' : Field.float_to_string(@unit_price)
+            printable[:tax_rate] =
+              @tax_rate.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@tax_rate)
+            printable[:total] =
+              @total.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@total)
+            printable[:unit_price] =
+              @unit_price.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@unit_price)
             printable
           end
 
@@ -59,9 +62,12 @@ module Mindee
             printable[:description] = format_for_display(@description, 36)
             printable[:end_date] = format_for_display(@end_date, 10)
             printable[:start_date] = format_for_display(@start_date, nil)
-            printable[:tax_rate] = @tax_rate.nil? ? '' : Field.float_to_string(@tax_rate)
-            printable[:total] = @total.nil? ? '' : Field.float_to_string(@total)
-            printable[:unit_price] = @unit_price.nil? ? '' : Field.float_to_string(@unit_price)
+            printable[:tax_rate] =
+              @tax_rate.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@tax_rate)
+            printable[:total] =
+              @total.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@total)
+            printable[:unit_price] =
+              @unit_price.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@unit_price)
             printable
           end
 

data/lib/mindee/product/fr/energy_bill/energy_bill_v1_energy_usages.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require_relative 'energy_bill_v1_energy_supplier'
+require_relative 'energy_bill_v1_energy_consumer'
+require_relative 'energy_bill_v1_subscription'
+require_relative 'energy_bill_v1_energy_usage'
+require_relative 'energy_bill_v1_taxes_and_contribution'
+require_relative 'energy_bill_v1_meter_detail'
+
+module Mindee
+  module Product
+    module FR
+      module EnergyBill
+        # Details of energy consumption.
+        class EnergyBillV1EnergyUsages < Array
+          # Entries.
+          # @return [Array<EnergyBillV1EnergyUsage>]
+          attr_reader :entries
+
+          # @param prediction [Array]
+          # @param page_id [Integer, nil]
+          def initialize(prediction, page_id)
+            entries = prediction.map do |entry|
+              EnergyBill::EnergyBillV1EnergyUsage.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 * 12}"
+            out_str << "+#{char * 12}"
+            out_str << "+#{char * 10}"
+            out_str << "+#{char * 11}"
+            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 << ' | End Date  '
+            out_str << ' | Start Date'
+            out_str << ' | Tax Rate'
+            out_str << ' | Total    '
+            out_str << ' | Unit Price'
+            out_str << (" |\n#{self.class.line_items_separator('=')}")
+            out_str + lines
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mindee/product/fr/energy_bill/energy_bill_v1_meter_detail.rb

@@ -22,7 +22,7 @@ module Mindee
           # @param prediction [Hash]
           # @param page_id [Integer, nil]
           def initialize(prediction, page_id)
-            super(prediction, page_id)
+            super
             @meter_number = prediction['meter_number']
             @meter_type = prediction['meter_type']
             @unit = prediction['unit']

data/lib/mindee/product/fr/energy_bill/energy_bill_v1_page.rb

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

data/lib/mindee/product/fr/energy_bill/energy_bill_v1_subscription.rb

@@ -31,7 +31,7 @@ module Mindee
           # @param prediction [Hash]
           # @param page_id [Integer, nil]
           def initialize(prediction, page_id)
-            super(prediction, page_id)
+            super
             @description = prediction['description']
             @end_date = prediction['end_date']
             @start_date = prediction['start_date']
@@ -47,9 +47,12 @@ module Mindee
             printable[:description] = format_for_display(@description)
             printable[:end_date] = format_for_display(@end_date)
             printable[:start_date] = format_for_display(@start_date)
-            printable[:tax_rate] = @tax_rate.nil? ? '' : Field.float_to_string(@tax_rate)
-            printable[:total] = @total.nil? ? '' : Field.float_to_string(@total)
-            printable[:unit_price] = @unit_price.nil? ? '' : Field.float_to_string(@unit_price)
+            printable[:tax_rate] =
+              @tax_rate.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@tax_rate)
+            printable[:total] =
+              @total.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@total)
+            printable[:unit_price] =
+              @unit_price.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@unit_price)
             printable
           end
 
@@ -59,9 +62,12 @@ module Mindee
             printable[:description] = format_for_display(@description, 36)
             printable[:end_date] = format_for_display(@end_date, 10)
             printable[:start_date] = format_for_display(@start_date, nil)
-            printable[:tax_rate] = @tax_rate.nil? ? '' : Field.float_to_string(@tax_rate)
-            printable[:total] = @total.nil? ? '' : Field.float_to_string(@total)
-            printable[:unit_price] = @unit_price.nil? ? '' : Field.float_to_string(@unit_price)
+            printable[:tax_rate] =
+              @tax_rate.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@tax_rate)
+            printable[:total] =
+              @total.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@total)
+            printable[:unit_price] =
+              @unit_price.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@unit_price)
             printable
           end
 

data/lib/mindee/product/fr/energy_bill/energy_bill_v1_subscriptions.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require_relative 'energy_bill_v1_energy_supplier'
+require_relative 'energy_bill_v1_energy_consumer'
+require_relative 'energy_bill_v1_subscription'
+require_relative 'energy_bill_v1_energy_usage'
+require_relative 'energy_bill_v1_taxes_and_contribution'
+require_relative 'energy_bill_v1_meter_detail'
+
+module Mindee
+  module Product
+    module FR
+      module EnergyBill
+        # The subscription details fee for the energy service.
+        class EnergyBillV1Subscriptions < Array
+          # Entries.
+          # @return [Array<EnergyBillV1Subscription>]
+          attr_reader :entries
+
+          # @param prediction [Array]
+          # @param page_id [Integer, nil]
+          def initialize(prediction, page_id)
+            entries = prediction.map do |entry|
+              EnergyBill::EnergyBillV1Subscription.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 * 12}"
+            out_str << "+#{char * 12}"
+            out_str << "+#{char * 10}"
+            out_str << "+#{char * 11}"
+            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 << ' | End Date  '
+            out_str << ' | Start Date'
+            out_str << ' | Tax Rate'
+            out_str << ' | Total    '
+            out_str << ' | Unit Price'
+            out_str << (" |\n#{self.class.line_items_separator('=')}")
+            out_str + lines
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mindee/product/fr/energy_bill/energy_bill_v1_taxes_and_contribution.rb

@@ -31,7 +31,7 @@ module Mindee
           # @param prediction [Hash]
           # @param page_id [Integer, nil]
           def initialize(prediction, page_id)
-            super(prediction, page_id)
+            super
             @description = prediction['description']
             @end_date = prediction['end_date']
             @start_date = prediction['start_date']
@@ -47,9 +47,12 @@ module Mindee
             printable[:description] = format_for_display(@description)
             printable[:end_date] = format_for_display(@end_date)
             printable[:start_date] = format_for_display(@start_date)
-            printable[:tax_rate] = @tax_rate.nil? ? '' : Field.float_to_string(@tax_rate)
-            printable[:total] = @total.nil? ? '' : Field.float_to_string(@total)
-            printable[:unit_price] = @unit_price.nil? ? '' : Field.float_to_string(@unit_price)
+            printable[:tax_rate] =
+              @tax_rate.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@tax_rate)
+            printable[:total] =
+              @total.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@total)
+            printable[:unit_price] =
+              @unit_price.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@unit_price)
             printable
           end
 
@@ -59,9 +62,12 @@ module Mindee
             printable[:description] = format_for_display(@description, 36)
             printable[:end_date] = format_for_display(@end_date, 10)
             printable[:start_date] = format_for_display(@start_date, nil)
-            printable[:tax_rate] = @tax_rate.nil? ? '' : Field.float_to_string(@tax_rate)
-            printable[:total] = @total.nil? ? '' : Field.float_to_string(@total)
-            printable[:unit_price] = @unit_price.nil? ? '' : Field.float_to_string(@unit_price)
+            printable[:tax_rate] =
+              @tax_rate.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@tax_rate)
+            printable[:total] =
+              @total.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@total)
+            printable[:unit_price] =
+              @unit_price.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@unit_price)
             printable
           end
 

data/lib/mindee/product/fr/energy_bill/energy_bill_v1_taxes_and_contributions.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require_relative 'energy_bill_v1_energy_supplier'
+require_relative 'energy_bill_v1_energy_consumer'
+require_relative 'energy_bill_v1_subscription'
+require_relative 'energy_bill_v1_energy_usage'
+require_relative 'energy_bill_v1_taxes_and_contribution'
+require_relative 'energy_bill_v1_meter_detail'
+
+module Mindee
+  module Product
+    module FR
+      module EnergyBill
+        # Details of Taxes and Contributions.
+        class EnergyBillV1TaxesAndContributions < Array
+          # Entries.
+          # @return [Array<EnergyBillV1TaxesAndContribution>]
+          attr_reader :entries
+
+          # @param prediction [Array]
+          # @param page_id [Integer, nil]
+          def initialize(prediction, page_id)
+            entries = prediction.map do |entry|
+              EnergyBill::EnergyBillV1TaxesAndContribution.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 * 12}"
+            out_str << "+#{char * 12}"
+            out_str << "+#{char * 10}"
+            out_str << "+#{char * 11}"
+            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 << ' | End Date  '
+            out_str << ' | Start Date'
+            out_str << ' | Tax Rate'
+            out_str << ' | Total    '
+            out_str << ' | Unit Price'
+            out_str << (" |\n#{self.class.line_items_separator('=')}")
+            out_str + lines
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mindee/product/fr/health_card/health_card_v1.rb

@@ -13,6 +13,8 @@ module Mindee
         class HealthCardV1 < Mindee::Parsing::Common::Inference
           @endpoint_name = 'french_healthcard'
           @endpoint_version = '1'
+          @has_async = true
+          @has_sync = false
 
           # @param prediction [Hash]
           def initialize(prediction)
@@ -20,9 +22,7 @@ module Mindee
             @prediction = HealthCardV1Document.new(prediction['prediction'], nil)
             @pages = []
             prediction['pages'].each do |page|
-              if page.key?('prediction') && !page['prediction'].nil? && !page['prediction'].empty?
-                @pages.push(HealthCardV1Page.new(page))
-              end
+              @pages.push(HealthCardV1Page.new(page))
             end
           end
 
@@ -33,6 +33,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/fr/health_card/health_card_v1_document.rb

@@ -25,14 +25,23 @@ module Mindee
           # @param prediction [Hash]
           # @param page_id [Integer, nil]
           def initialize(prediction, page_id)
-            super()
-            @given_names = []
+            super
+            @given_names = [] # : Array[Parsing::Standard::StringField]
             prediction['given_names'].each do |item|
-              @given_names.push(StringField.new(item, page_id))
+              @given_names.push(Parsing::Standard::StringField.new(item, page_id))
             end
-            @issuance_date = DateField.new(prediction['issuance_date'], page_id)
-            @social_security = StringField.new(prediction['social_security'], page_id)
-            @surname = StringField.new(prediction['surname'], page_id)
+            @issuance_date = Parsing::Standard::DateField.new(
+              prediction['issuance_date'],
+              page_id
+            )
+            @social_security = Parsing::Standard::StringField.new(
+              prediction['social_security'],
+              page_id
+            )
+            @surname = Parsing::Standard::StringField.new(
+              prediction['surname'],
+              page_id
+            )
           end
 
           # @return [String]

data/lib/mindee/product/fr/health_card/health_card_v1_page.rb

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

data/lib/mindee/product/fr/id_card/id_card_v1.rb

@@ -13,6 +13,8 @@ module Mindee
         class IdCardV1 < Mindee::Parsing::Common::Inference
           @endpoint_name = 'idcard_fr'
           @endpoint_version = '1'
+          @has_async = false
+          @has_sync = true
 
           # @param prediction [Hash]
           def initialize(prediction)
@@ -20,9 +22,7 @@ module Mindee
             @prediction = IdCardV1Document.new(prediction['prediction'], nil)
             @pages = []
             prediction['pages'].each do |page|
-              if page.key?('prediction') && !page['prediction'].nil? && !page['prediction'].empty?
-                @pages.push(IdCardV1Page.new(page))
-              end
+              @pages.push(IdCardV1Page.new(page))
             end
           end
 
@@ -33,6 +33,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/fr/id_card/id_card_v1_document.rb

@@ -43,20 +43,41 @@ module Mindee
           # @param prediction [Hash]
           # @param page_id [Integer, nil]
           def initialize(prediction, page_id)
-            super()
-            @authority = StringField.new(prediction['authority'], page_id)
-            @birth_date = DateField.new(prediction['birth_date'], page_id)
-            @birth_place = StringField.new(prediction['birth_place'], page_id)
-            @expiry_date = DateField.new(prediction['expiry_date'], page_id)
-            @gender = StringField.new(prediction['gender'], page_id)
-            @given_names = []
+            super
+            @authority = Parsing::Standard::StringField.new(
+              prediction['authority'],
+              page_id
+            )
+            @birth_date = Parsing::Standard::DateField.new(
+              prediction['birth_date'],
+              page_id
+            )
+            @birth_place = Parsing::Standard::StringField.new(
+              prediction['birth_place'],
+              page_id
+            )
+            @expiry_date = Parsing::Standard::DateField.new(
+              prediction['expiry_date'],
+              page_id
+            )
+            @gender = Parsing::Standard::StringField.new(
+              prediction['gender'],
+              page_id
+            )
+            @given_names = [] # : Array[Parsing::Standard::StringField]
             prediction['given_names'].each do |item|
-              @given_names.push(StringField.new(item, page_id))
+              @given_names.push(Parsing::Standard::StringField.new(item, page_id))
             end
-            @id_number = StringField.new(prediction['id_number'], page_id)
-            @mrz1 = StringField.new(prediction['mrz1'], page_id)
-            @mrz2 = StringField.new(prediction['mrz2'], page_id)
-            @surname = StringField.new(prediction['surname'], page_id)
+            @id_number = Parsing::Standard::StringField.new(
+              prediction['id_number'],
+              page_id
+            )
+            @mrz1 = Parsing::Standard::StringField.new(prediction['mrz1'], page_id)
+            @mrz2 = Parsing::Standard::StringField.new(prediction['mrz2'], page_id)
+            @surname = Parsing::Standard::StringField.new(
+              prediction['surname'],
+              page_id
+            )
           end
 
           # @return [String]

data/lib/mindee/product/fr/id_card/id_card_v1_page.rb

@@ -11,11 +11,15 @@ module Mindee
         class IdCardV1Page < Mindee::Parsing::Common::Page
           # @param prediction [Hash]
           def initialize(prediction)
-            super(prediction)
-            @prediction = IdCardV1PagePrediction.new(
-              prediction['prediction'],
-              prediction['id']
-            )
+            super
+            @prediction = if prediction['prediction'].empty?
+                            nil
+                          else
+                            IdCardV1PagePrediction.new(
+                              prediction['prediction'],
+                              prediction['id']
+                            )
+                          end
           end
         end
 
@@ -30,8 +34,11 @@ module Mindee
           # @param prediction [Hash]
           # @param page_id [Integer, nil]
           def initialize(prediction, page_id)
-            @document_side = ClassificationField.new(prediction['document_side'], page_id)
-            super(prediction, page_id)
+            @document_side = Parsing::Standard::ClassificationField.new(
+              prediction['document_side'],
+              page_id
+            )
+            super
           end
 
           # @return [String]

data/lib/mindee/product/fr/id_card/id_card_v2.rb

@@ -13,6 +13,8 @@ module Mindee
         class IdCardV2 < Mindee::Parsing::Common::Inference
           @endpoint_name = 'idcard_fr'
           @endpoint_version = '2'
+          @has_async = false
+          @has_sync = true
 
           # @param prediction [Hash]
           def initialize(prediction)
@@ -20,9 +22,7 @@ module Mindee
             @prediction = IdCardV2Document.new(prediction['prediction'], nil)
             @pages = []
             prediction['pages'].each do |page|
-              if page.key?('prediction') && !page['prediction'].nil? && !page['prediction'].empty?
-                @pages.push(IdCardV2Page.new(page))
-              end
+              @pages.push(IdCardV2Page.new(page))
             end
           end
 
@@ -33,6 +33,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