mindee 3.12.0 → 3.14.0

data/lib/mindee/product/fr/payslip/payslip_v2_salary_detail.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+require_relative '../../../parsing'
+
+module Mindee
+  module Product
+    module FR
+      module Payslip
+        # Detailed information about the earnings.
+        class PayslipV2SalaryDetail < Mindee::Parsing::Standard::FeatureField
+          include Mindee::Parsing::Standard
+          # The amount of the earnings.
+          # @return [Float]
+          attr_reader :amount
+          # The base value of the earnings.
+          # @return [Float]
+          attr_reader :base
+          # The description of the earnings.
+          # @return [String]
+          attr_reader :description
+          # The rate of the earnings.
+          # @return [Float]
+          attr_reader :rate
+
+          # @param prediction [Hash]
+          # @param page_id [Integer, nil]
+          def initialize(prediction, page_id)
+            super(prediction, page_id)
+            @amount = prediction['amount']
+            @base = prediction['base']
+            @description = prediction['description']
+            @rate = prediction['rate']
+            @page_id = page_id
+          end
+
+          # @return [Hash]
+          def printable_values
+            printable = {}
+            printable[:amount] = @amount.nil? ? '' : Field.float_to_string(@amount)
+            printable[:base] = @base.nil? ? '' : Field.float_to_string(@base)
+            printable[:description] = format_for_display(@description)
+            printable[:rate] = @rate.nil? ? '' : Field.float_to_string(@rate)
+            printable
+          end
+
+          # @return [Hash]
+          def table_printable_values
+            printable = {}
+            printable[:amount] = @amount.nil? ? '' : Field.float_to_string(@amount)
+            printable[:base] = @base.nil? ? '' : Field.float_to_string(@base)
+            printable[:description] = format_for_display(@description, 36)
+            printable[:rate] = @rate.nil? ? '' : Field.float_to_string(@rate)
+            printable
+          end
+
+          # @return [String]
+          def to_table_line
+            printable = table_printable_values
+            out_str = String.new
+            out_str << format('| %- 13s', printable[:amount])
+            out_str << format('| %- 10s', printable[:base])
+            out_str << format('| %- 37s', printable[:description])
+            out_str << format('| %- 10s', printable[:rate])
+            out_str << '|'
+          end
+
+          # @return [String]
+          def to_s
+            printable = printable_values
+            out_str = String.new
+            out_str << "\n  :Amount: #{printable[:amount]}"
+            out_str << "\n  :Base: #{printable[:base]}"
+            out_str << "\n  :Description: #{printable[:description]}"
+            out_str << "\n  :Rate: #{printable[:rate]}"
+            out_str
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -6,7 +6,7 @@ require_relative 'invoice_v4_line_item'
 module Mindee
   module Product
     module Invoice
-      # Invoice API version 4.7 document data.
+      # Invoice API version 4.8 document data.
       class InvoiceV4Document < Mindee::Parsing::Common::Prediction
         include Mindee::Parsing::Standard
         # The customer's address used for billing.
@@ -42,6 +42,12 @@ module Mindee
         # The locale detected on the document.
         # @return [Mindee::Parsing::Standard::LocaleField]
         attr_reader :locale
+        # The date on which the payment is due/ was full-filled.
+        # @return [Mindee::Parsing::Standard::DateField]
+        attr_reader :payment_date
+        # The purchase order number.
+        # @return [Mindee::Parsing::Standard::StringField]
+        attr_reader :po_number
         # List of Reference numbers, including PO number.
         # @return [Array<Mindee::Parsing::Standard::StringField>]
         attr_reader :reference_numbers
@@ -103,6 +109,8 @@ module Mindee
             @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 = []
           prediction['reference_numbers'].each do |item|
             @reference_numbers.push(StringField.new(item, page_id))
@@ -137,9 +145,11 @@ module Mindee
           out_str = String.new
           out_str << "\n:Locale: #{@locale}".rstrip
           out_str << "\n:Invoice Number: #{@invoice_number}".rstrip
+          out_str << "\n:Purchase Order Number: #{@po_number}".rstrip
           out_str << "\n:Reference Numbers: #{reference_numbers}".rstrip
           out_str << "\n:Purchase Date: #{@date}".rstrip
           out_str << "\n:Due Date: #{@due_date}".rstrip
+          out_str << "\n:Payment Date: #{@payment_date}".rstrip
           out_str << "\n:Total Net: #{@total_net}".rstrip
           out_str << "\n:Total Amount: #{@total_amount}".rstrip
           out_str << "\n:Total Tax: #{@total_tax}".rstrip

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

@@ -50,6 +50,20 @@ module Mindee
 
         # @return [Hash]
         def printable_values
+          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[:unit_measure] = format_for_display(@unit_measure)
+          printable[:unit_price] = @unit_price.nil? ? '' : Field.float_to_string(@unit_price)
+          printable
+        end
+
+        # @return [Hash]
+        def table_printable_values
           printable = {}
           printable[:description] = format_for_display(@description, 36)
           printable[:product_code] = format_for_display(@product_code, nil)
@@ -64,7 +78,7 @@ module Mindee
 
         # @return [String]
         def to_table_line
-          printable = printable_values
+          printable = table_printable_values
           out_str = String.new
           out_str << format('| %- 37s', printable[:description])
           out_str << format('| %- 13s', printable[:product_code])

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

@@ -6,7 +6,7 @@ require_relative 'invoice_v4_document'
 module Mindee
   module Product
     module Invoice
-      # Invoice API version 4.7 page data.
+      # Invoice API version 4.8 page data.
       class InvoiceV4Page < Mindee::Parsing::Common::Page
         # @param prediction [Hash]
         def initialize(prediction)

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

@@ -29,7 +29,7 @@ module Mindee
 
       # Invoice Splitter V1 document prediction.
       class InvoiceSplitterV1Document < Mindee::Parsing::Common::Prediction
-        # @return[Array<Mindee::Product::InvoiceSplitterV1PageGroup>]
+        # @return[Array<Mindee::Product::InvoiceSplitter::InvoiceSplitterV1PageGroup>]
         attr_reader :invoice_page_groups
 
         # @param prediction [Hash]

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

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative '../../parsing'
+require_relative 'nutrition_facts_label_v1_document'
+require_relative 'nutrition_facts_label_v1_page'
+
+module Mindee
+  module Product
+    # Nutrition Facts Label module.
+    module NutritionFactsLabel
+      # Nutrition Facts Label API version 1 inference prediction.
+      class NutritionFactsLabelV1 < Mindee::Parsing::Common::Inference
+        @endpoint_name = 'nutrition_facts'
+        @endpoint_version = '1'
+
+        # @param prediction [Hash]
+        def initialize(prediction)
+          super
+          @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
+          end
+        end
+
+        class << self
+          # Name of the endpoint for this product.
+          # @return [String]
+          attr_reader :endpoint_name
+          # Version for this product.
+          # @return [String]
+          attr_reader :endpoint_version
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require_relative '../../parsing'
+
+module Mindee
+  module Product
+    module NutritionFactsLabel
+      # The amount of added sugars in the product.
+      class NutritionFactsLabelV1AddedSugar < Mindee::Parsing::Standard::FeatureField
+        include Mindee::Parsing::Standard
+        # DVs are the recommended amounts of added sugars to consume or not to exceed each day.
+        # @return [Float]
+        attr_reader :daily_value
+        # The amount of added sugars per 100g of the product.
+        # @return [Float]
+        attr_reader :per_100g
+        # The amount of added sugars per serving of the product.
+        # @return [Float]
+        attr_reader :per_serving
+
+        # @param prediction [Hash]
+        # @param page_id [Integer, nil]
+        def initialize(prediction, page_id)
+          super(prediction, page_id)
+          @daily_value = prediction['daily_value']
+          @per_100g = prediction['per_100g']
+          @per_serving = prediction['per_serving']
+          @page_id = page_id
+        end
+
+        # @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
+        end
+
+        # @return [String]
+        def to_s
+          printable = printable_values
+          out_str = String.new
+          out_str << "\n  :Daily Value: #{printable[:daily_value]}"
+          out_str << "\n  :Per 100g: #{printable[:per_100g]}"
+          out_str << "\n  :Per Serving: #{printable[:per_serving]}"
+          out_str
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require_relative '../../parsing'
+
+module Mindee
+  module Product
+    module NutritionFactsLabel
+      # The amount of calories in the product.
+      class NutritionFactsLabelV1Calorie < Mindee::Parsing::Standard::FeatureField
+        include Mindee::Parsing::Standard
+        # DVs are the recommended amounts of calories to consume or not to exceed each day.
+        # @return [Float]
+        attr_reader :daily_value
+        # The amount of calories per 100g of the product.
+        # @return [Float]
+        attr_reader :per_100g
+        # The amount of calories per serving of the product.
+        # @return [Float]
+        attr_reader :per_serving
+
+        # @param prediction [Hash]
+        # @param page_id [Integer, nil]
+        def initialize(prediction, page_id)
+          super(prediction, page_id)
+          @daily_value = prediction['daily_value']
+          @per_100g = prediction['per_100g']
+          @per_serving = prediction['per_serving']
+          @page_id = page_id
+        end
+
+        # @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
+        end
+
+        # @return [String]
+        def to_s
+          printable = printable_values
+          out_str = String.new
+          out_str << "\n  :Daily Value: #{printable[:daily_value]}"
+          out_str << "\n  :Per 100g: #{printable[:per_100g]}"
+          out_str << "\n  :Per Serving: #{printable[:per_serving]}"
+          out_str
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require_relative '../../parsing'
+
+module Mindee
+  module Product
+    module NutritionFactsLabel
+      # The amount of cholesterol in the product.
+      class NutritionFactsLabelV1Cholesterol < Mindee::Parsing::Standard::FeatureField
+        include Mindee::Parsing::Standard
+        # DVs are the recommended amounts of cholesterol to consume or not to exceed each day.
+        # @return [Float]
+        attr_reader :daily_value
+        # The amount of cholesterol per 100g of the product.
+        # @return [Float]
+        attr_reader :per_100g
+        # The amount of cholesterol per serving of the product.
+        # @return [Float]
+        attr_reader :per_serving
+
+        # @param prediction [Hash]
+        # @param page_id [Integer, nil]
+        def initialize(prediction, page_id)
+          super(prediction, page_id)
+          @daily_value = prediction['daily_value']
+          @per_100g = prediction['per_100g']
+          @per_serving = prediction['per_serving']
+          @page_id = page_id
+        end
+
+        # @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
+        end
+
+        # @return [String]
+        def to_s
+          printable = printable_values
+          out_str = String.new
+          out_str << "\n  :Daily Value: #{printable[:daily_value]}"
+          out_str << "\n  :Per 100g: #{printable[:per_100g]}"
+          out_str << "\n  :Per Serving: #{printable[:per_serving]}"
+          out_str
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require_relative '../../parsing'
+
+module Mindee
+  module Product
+    module NutritionFactsLabel
+      # The amount of dietary fiber in the product.
+      class NutritionFactsLabelV1DietaryFiber < Mindee::Parsing::Standard::FeatureField
+        include Mindee::Parsing::Standard
+        # DVs are the recommended amounts of dietary fiber to consume or not to exceed each day.
+        # @return [Float]
+        attr_reader :daily_value
+        # The amount of dietary fiber per 100g of the product.
+        # @return [Float]
+        attr_reader :per_100g
+        # The amount of dietary fiber per serving of the product.
+        # @return [Float]
+        attr_reader :per_serving
+
+        # @param prediction [Hash]
+        # @param page_id [Integer, nil]
+        def initialize(prediction, page_id)
+          super(prediction, page_id)
+          @daily_value = prediction['daily_value']
+          @per_100g = prediction['per_100g']
+          @per_serving = prediction['per_serving']
+          @page_id = page_id
+        end
+
+        # @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
+        end
+
+        # @return [String]
+        def to_s
+          printable = printable_values
+          out_str = String.new
+          out_str << "\n  :Daily Value: #{printable[:daily_value]}"
+          out_str << "\n  :Per 100g: #{printable[:per_100g]}"
+          out_str << "\n  :Per Serving: #{printable[:per_serving]}"
+          out_str
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,173 @@
+# frozen_string_literal: true
+
+require_relative '../../parsing'
+require_relative 'nutrition_facts_label_v1_serving_size'
+require_relative 'nutrition_facts_label_v1_calorie'
+require_relative 'nutrition_facts_label_v1_total_fat'
+require_relative 'nutrition_facts_label_v1_saturated_fat'
+require_relative 'nutrition_facts_label_v1_trans_fat'
+require_relative 'nutrition_facts_label_v1_cholesterol'
+require_relative 'nutrition_facts_label_v1_total_carbohydrate'
+require_relative 'nutrition_facts_label_v1_dietary_fiber'
+require_relative 'nutrition_facts_label_v1_total_sugar'
+require_relative 'nutrition_facts_label_v1_added_sugar'
+require_relative 'nutrition_facts_label_v1_protein'
+require_relative 'nutrition_facts_label_v1_sodium'
+require_relative 'nutrition_facts_label_v1_nutrient'
+
+module Mindee
+  module Product
+    module NutritionFactsLabel
+      # Nutrition Facts Label API version 1.0 document data.
+      class NutritionFactsLabelV1Document < Mindee::Parsing::Common::Prediction
+        include Mindee::Parsing::Standard
+        # The amount of added sugars in the product.
+        # @return [Mindee::Product::NutritionFactsLabel::NutritionFactsLabelV1AddedSugar]
+        attr_reader :added_sugars
+        # The amount of calories in the product.
+        # @return [Mindee::Product::NutritionFactsLabel::NutritionFactsLabelV1Calorie]
+        attr_reader :calories
+        # The amount of cholesterol in the product.
+        # @return [Mindee::Product::NutritionFactsLabel::NutritionFactsLabelV1Cholesterol]
+        attr_reader :cholesterol
+        # The amount of dietary fiber in the product.
+        # @return [Mindee::Product::NutritionFactsLabel::NutritionFactsLabelV1DietaryFiber]
+        attr_reader :dietary_fiber
+        # The amount of nutrients in the product.
+        # @return [Array<Mindee::Product::NutritionFactsLabel::NutritionFactsLabelV1Nutrient>]
+        attr_reader :nutrients
+        # The amount of protein in the product.
+        # @return [Mindee::Product::NutritionFactsLabel::NutritionFactsLabelV1Protein]
+        attr_reader :protein
+        # The amount of saturated fat in the product.
+        # @return [Mindee::Product::NutritionFactsLabel::NutritionFactsLabelV1SaturatedFat]
+        attr_reader :saturated_fat
+        # The number of servings in each box of the product.
+        # @return [Mindee::Parsing::Standard::AmountField]
+        attr_reader :serving_per_box
+        # The size of a single serving of the product.
+        # @return [Mindee::Product::NutritionFactsLabel::NutritionFactsLabelV1ServingSize]
+        attr_reader :serving_size
+        # The amount of sodium in the product.
+        # @return [Mindee::Product::NutritionFactsLabel::NutritionFactsLabelV1Sodium]
+        attr_reader :sodium
+        # The total amount of carbohydrates in the product.
+        # @return [Mindee::Product::NutritionFactsLabel::NutritionFactsLabelV1TotalCarbohydrate]
+        attr_reader :total_carbohydrate
+        # The total amount of fat in the product.
+        # @return [Mindee::Product::NutritionFactsLabel::NutritionFactsLabelV1TotalFat]
+        attr_reader :total_fat
+        # The total amount of sugars in the product.
+        # @return [Mindee::Product::NutritionFactsLabel::NutritionFactsLabelV1TotalSugar]
+        attr_reader :total_sugars
+        # The amount of trans fat in the product.
+        # @return [Mindee::Product::NutritionFactsLabel::NutritionFactsLabelV1TransFat]
+        attr_reader :trans_fat
+
+        # @param prediction [Hash]
+        # @param page_id [Integer, nil]
+        def initialize(prediction, page_id)
+          super()
+          @added_sugars = NutritionFactsLabelV1AddedSugar.new(prediction['added_sugars'], page_id)
+          @calories = NutritionFactsLabelV1Calorie.new(prediction['calories'], page_id)
+          @cholesterol = NutritionFactsLabelV1Cholesterol.new(prediction['cholesterol'], page_id)
+          @dietary_fiber = NutritionFactsLabelV1DietaryFiber.new(prediction['dietary_fiber'], page_id)
+          @nutrients = []
+          prediction['nutrients'].each do |item|
+            @nutrients.push(NutritionFactsLabelV1Nutrient.new(item, page_id))
+          end
+          @protein = NutritionFactsLabelV1Protein.new(prediction['protein'], page_id)
+          @saturated_fat = NutritionFactsLabelV1SaturatedFat.new(prediction['saturated_fat'], page_id)
+          @serving_per_box = AmountField.new(prediction['serving_per_box'], page_id)
+          @serving_size = NutritionFactsLabelV1ServingSize.new(prediction['serving_size'], page_id)
+          @sodium = NutritionFactsLabelV1Sodium.new(prediction['sodium'], page_id)
+          @total_carbohydrate = NutritionFactsLabelV1TotalCarbohydrate.new(prediction['total_carbohydrate'], page_id)
+          @total_fat = NutritionFactsLabelV1TotalFat.new(prediction['total_fat'], page_id)
+          @total_sugars = NutritionFactsLabelV1TotalSugar.new(prediction['total_sugars'], page_id)
+          @trans_fat = NutritionFactsLabelV1TransFat.new(prediction['trans_fat'], page_id)
+        end
+
+        # @return [String]
+        def to_s
+          serving_size = @serving_size.to_s
+          calories = @calories.to_s
+          total_fat = @total_fat.to_s
+          saturated_fat = @saturated_fat.to_s
+          trans_fat = @trans_fat.to_s
+          cholesterol = @cholesterol.to_s
+          total_carbohydrate = @total_carbohydrate.to_s
+          dietary_fiber = @dietary_fiber.to_s
+          total_sugars = @total_sugars.to_s
+          added_sugars = @added_sugars.to_s
+          protein = @protein.to_s
+          sodium = @sodium.to_s
+          nutrients = nutrients_to_s
+          out_str = String.new
+          out_str << "\n:Serving per Box: #{@serving_per_box}".rstrip
+          out_str << "\n:Serving Size:"
+          out_str << serving_size
+          out_str << "\n:Calories:"
+          out_str << calories
+          out_str << "\n:Total Fat:"
+          out_str << total_fat
+          out_str << "\n:Saturated Fat:"
+          out_str << saturated_fat
+          out_str << "\n:Trans Fat:"
+          out_str << trans_fat
+          out_str << "\n:Cholesterol:"
+          out_str << cholesterol
+          out_str << "\n:Total Carbohydrate:"
+          out_str << total_carbohydrate
+          out_str << "\n:Dietary Fiber:"
+          out_str << dietary_fiber
+          out_str << "\n:Total Sugars:"
+          out_str << total_sugars
+          out_str << "\n:Added Sugars:"
+          out_str << added_sugars
+          out_str << "\n:Protein:"
+          out_str << protein
+          out_str << "\n:sodium:"
+          out_str << sodium
+          out_str << "\n:nutrients:"
+          out_str << nutrients
+          out_str[1..].to_s
+        end
+
+        private
+
+        # @param char [String]
+        # @return [String]
+        def nutrients_separator(char)
+          out_str = String.new
+          out_str << '  '
+          out_str << "+#{char * 13}"
+          out_str << "+#{char * 22}"
+          out_str << "+#{char * 10}"
+          out_str << "+#{char * 13}"
+          out_str << "+#{char * 6}"
+          out_str << '+'
+          out_str
+        end
+
+        # @return [String]
+        def nutrients_to_s
+          return '' if @nutrients.empty?
+
+          line_items = @nutrients.map(&:to_table_line).join("\n#{nutrients_separator('-')}\n  ")
+          out_str = String.new
+          out_str << "\n#{nutrients_separator('-')}"
+          out_str << "\n  |"
+          out_str << ' Daily Value |'
+          out_str << ' Name                 |'
+          out_str << ' Per 100g |'
+          out_str << ' Per Serving |'
+          out_str << ' Unit |'
+          out_str << "\n#{nutrients_separator('=')}"
+          out_str << "\n  #{line_items}"
+          out_str << "\n#{nutrients_separator('-')}"
+          out_str
+        end
+      end
+    end
+  end
+end