mindee 3.12.0 → 3.14.0

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

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+require_relative '../../parsing'
+
+module Mindee
+  module Product
+    module NutritionFactsLabel
+      # The amount of nutrients in the product.
+      class NutritionFactsLabelV1Nutrient < Mindee::Parsing::Standard::FeatureField
+        include Mindee::Parsing::Standard
+        # DVs are the recommended amounts of nutrients to consume or not to exceed each day.
+        # @return [Float]
+        attr_reader :daily_value
+        # The name of nutrients of the product.
+        # @return [String]
+        attr_reader :name
+        # The amount of nutrients per 100g of the product.
+        # @return [Float]
+        attr_reader :per_100g
+        # The amount of nutrients per serving of the product.
+        # @return [Float]
+        attr_reader :per_serving
+        # The unit of measurement for the amount of nutrients.
+        # @return [String]
+        attr_reader :unit
+
+        # @param prediction [Hash]
+        # @param page_id [Integer, nil]
+        def initialize(prediction, page_id)
+          super(prediction, page_id)
+          @daily_value = prediction['daily_value']
+          @name = prediction['name']
+          @per_100g = prediction['per_100g']
+          @per_serving = prediction['per_serving']
+          @unit = prediction['unit']
+          @page_id = page_id
+        end
+
+        # @return [Hash]
+        def printable_values
+          printable = {}
+          printable[:daily_value] = @daily_value.nil? ? '' : Field.float_to_string(@daily_value)
+          printable[:name] = format_for_display(@name)
+          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[:unit] = format_for_display(@unit)
+          printable
+        end
+
+        # @return [Hash]
+        def table_printable_values
+          printable = {}
+          printable[:daily_value] = @daily_value.nil? ? '' : Field.float_to_string(@daily_value)
+          printable[:name] = format_for_display(@name, 20)
+          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[:unit] = format_for_display(@unit, nil)
+          printable
+        end
+
+        # @return [String]
+        def to_table_line
+          printable = table_printable_values
+          out_str = String.new
+          out_str << format('| %- 12s', printable[:daily_value])
+          out_str << format('| %- 21s', printable[:name])
+          out_str << format('| %- 9s', printable[:per_100g])
+          out_str << format('| %- 12s', printable[:per_serving])
+          out_str << format('| %- 5s', printable[:unit])
+          out_str << '|'
+        end
+
+        # @return [String]
+        def to_s
+          printable = printable_values
+          out_str = String.new
+          out_str << "\n  :Daily Value: #{printable[:daily_value]}"
+          out_str << "\n  :Name: #{printable[:name]}"
+          out_str << "\n  :Per 100g: #{printable[:per_100g]}"
+          out_str << "\n  :Per Serving: #{printable[:per_serving]}"
+          out_str << "\n  :Unit: #{printable[:unit]}"
+          out_str
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative '../../parsing'
+require_relative 'nutrition_facts_label_v1_document'
+
+module Mindee
+  module Product
+    module NutritionFactsLabel
+      # Nutrition Facts Label API version 1.0 page data.
+      class NutritionFactsLabelV1Page < Mindee::Parsing::Common::Page
+        # @param prediction [Hash]
+        def initialize(prediction)
+          super(prediction)
+          @prediction = NutritionFactsLabelV1PagePrediction.new(
+            prediction['prediction'],
+            prediction['id']
+          )
+        end
+      end
+
+      # Nutrition Facts Label V1 page prediction.
+      class NutritionFactsLabelV1PagePrediction < NutritionFactsLabelV1Document
+        # @return [String]
+        def to_s
+          out_str = String.new
+          out_str << "\n#{super}"
+          out_str
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require_relative '../../parsing'
+
+module Mindee
+  module Product
+    module NutritionFactsLabel
+      # The amount of protein in the product.
+      class NutritionFactsLabelV1Protein < Mindee::Parsing::Standard::FeatureField
+        include Mindee::Parsing::Standard
+        # DVs are the recommended amounts of protein to consume or not to exceed each day.
+        # @return [Float]
+        attr_reader :daily_value
+        # The amount of protein per 100g of the product.
+        # @return [Float]
+        attr_reader :per_100g
+        # The amount of protein 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_saturated_fat.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require_relative '../../parsing'
+
+module Mindee
+  module Product
+    module NutritionFactsLabel
+      # The amount of saturated fat in the product.
+      class NutritionFactsLabelV1SaturatedFat < Mindee::Parsing::Standard::FeatureField
+        include Mindee::Parsing::Standard
+        # DVs are the recommended amounts of saturated fat to consume or not to exceed each day.
+        # @return [Float]
+        attr_reader :daily_value
+        # The amount of saturated fat per 100g of the product.
+        # @return [Float]
+        attr_reader :per_100g
+        # The amount of saturated fat 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_serving_size.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require_relative '../../parsing'
+
+module Mindee
+  module Product
+    module NutritionFactsLabel
+      # The size of a single serving of the product.
+      class NutritionFactsLabelV1ServingSize < Mindee::Parsing::Standard::FeatureField
+        include Mindee::Parsing::Standard
+        # The amount of a single serving.
+        # @return [Float]
+        attr_reader :amount
+        # The unit for the amount of a single serving.
+        # @return [String]
+        attr_reader :unit
+
+        # @param prediction [Hash]
+        # @param page_id [Integer, nil]
+        def initialize(prediction, page_id)
+          super(prediction, page_id)
+          @amount = prediction['amount']
+          @unit = prediction['unit']
+          @page_id = page_id
+        end
+
+        # @return [Hash]
+        def printable_values
+          printable = {}
+          printable[:amount] = @amount.nil? ? '' : Field.float_to_string(@amount)
+          printable[:unit] = format_for_display(@unit)
+          printable
+        end
+
+        # @return [String]
+        def to_s
+          printable = printable_values
+          out_str = String.new
+          out_str << "\n  :Amount: #{printable[:amount]}"
+          out_str << "\n  :Unit: #{printable[:unit]}"
+          out_str
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require_relative '../../parsing'
+
+module Mindee
+  module Product
+    module NutritionFactsLabel
+      # The amount of sodium in the product.
+      class NutritionFactsLabelV1Sodium < Mindee::Parsing::Standard::FeatureField
+        include Mindee::Parsing::Standard
+        # DVs are the recommended amounts of sodium to consume or not to exceed each day.
+        # @return [Float]
+        attr_reader :daily_value
+        # The amount of sodium per 100g of the product.
+        # @return [Float]
+        attr_reader :per_100g
+        # The amount of sodium per serving of the product.
+        # @return [Float]
+        attr_reader :per_serving
+        # The unit of measurement for the amount of sodium.
+        # @return [String]
+        attr_reader :unit
+
+        # @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']
+          @unit = prediction['unit']
+          @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[:unit] = format_for_display(@unit)
+          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 << "\n  :Unit: #{printable[:unit]}"
+          out_str
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require_relative '../../parsing'
+
+module Mindee
+  module Product
+    module NutritionFactsLabel
+      # The total amount of carbohydrates in the product.
+      class NutritionFactsLabelV1TotalCarbohydrate < Mindee::Parsing::Standard::FeatureField
+        include Mindee::Parsing::Standard
+        # DVs are the recommended amounts of total carbohydrates to consume or not to exceed each day.
+        # @return [Float]
+        attr_reader :daily_value
+        # The amount of total carbohydrates per 100g of the product.
+        # @return [Float]
+        attr_reader :per_100g
+        # The amount of total carbohydrates 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_total_fat.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require_relative '../../parsing'
+
+module Mindee
+  module Product
+    module NutritionFactsLabel
+      # The total amount of fat in the product.
+      class NutritionFactsLabelV1TotalFat < Mindee::Parsing::Standard::FeatureField
+        include Mindee::Parsing::Standard
+        # DVs are the recommended amounts of total fat to consume or not to exceed each day.
+        # @return [Float]
+        attr_reader :daily_value
+        # The amount of total fat per 100g of the product.
+        # @return [Float]
+        attr_reader :per_100g
+        # The amount of total fat 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_total_sugar.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require_relative '../../parsing'
+
+module Mindee
+  module Product
+    module NutritionFactsLabel
+      # The total amount of sugars in the product.
+      class NutritionFactsLabelV1TotalSugar < Mindee::Parsing::Standard::FeatureField
+        include Mindee::Parsing::Standard
+        # DVs are the recommended amounts of total sugars to consume or not to exceed each day.
+        # @return [Float]
+        attr_reader :daily_value
+        # The amount of total sugars per 100g of the product.
+        # @return [Float]
+        attr_reader :per_100g
+        # The amount of total 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_trans_fat.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require_relative '../../parsing'
+
+module Mindee
+  module Product
+    module NutritionFactsLabel
+      # The amount of trans fat in the product.
+      class NutritionFactsLabelV1TransFat < Mindee::Parsing::Standard::FeatureField
+        include Mindee::Parsing::Standard
+        # DVs are the recommended amounts of trans fat to consume or not to exceed each day.
+        # @return [Float]
+        attr_reader :daily_value
+        # The amount of trans fat per 100g of the product.
+        # @return [Float]
+        attr_reader :per_100g
+        # The amount of trans fat 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/receipt/receipt_v5_line_item.rb

@@ -34,6 +34,16 @@ module Mindee
 
         # @return [Hash]
         def printable_values
+          printable = {}
+          printable[:description] = format_for_display(@description)
+          printable[:quantity] = @quantity.nil? ? '' : Field.float_to_string(@quantity)
+          printable[:total_amount] = @total_amount.nil? ? '' : Field.float_to_string(@total_amount)
+          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[:quantity] = @quantity.nil? ? '' : Field.float_to_string(@quantity)
@@ -44,7 +54,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('| %- 9s', printable[:quantity])

data/lib/mindee/product/resume/resume_v1_certificate.rb

@@ -34,6 +34,16 @@ module Mindee
 
         # @return [Hash]
         def printable_values
+          printable = {}
+          printable[:grade] = format_for_display(@grade)
+          printable[:name] = format_for_display(@name)
+          printable[:provider] = format_for_display(@provider)
+          printable[:year] = format_for_display(@year)
+          printable
+        end
+
+        # @return [Hash]
+        def table_printable_values
           printable = {}
           printable[:grade] = format_for_display(@grade, 10)
           printable[:name] = format_for_display(@name, 30)
@@ -44,7 +54,7 @@ module Mindee
 
         # @return [String]
         def to_table_line
-          printable = printable_values
+          printable = table_printable_values
           out_str = String.new
           out_str << format('| %- 11s', printable[:grade])
           out_str << format('| %- 31s', printable[:name])

data/lib/mindee/product/resume/resume_v1_education.rb

@@ -46,6 +46,19 @@ module Mindee
 
         # @return [Hash]
         def printable_values
+          printable = {}
+          printable[:degree_domain] = format_for_display(@degree_domain)
+          printable[:degree_type] = format_for_display(@degree_type)
+          printable[:end_month] = format_for_display(@end_month)
+          printable[:end_year] = format_for_display(@end_year)
+          printable[:school] = format_for_display(@school)
+          printable[:start_month] = format_for_display(@start_month)
+          printable[:start_year] = format_for_display(@start_year)
+          printable
+        end
+
+        # @return [Hash]
+        def table_printable_values
           printable = {}
           printable[:degree_domain] = format_for_display(@degree_domain, 15)
           printable[:degree_type] = format_for_display(@degree_type, 25)
@@ -59,7 +72,7 @@ module Mindee
 
         # @return [String]
         def to_table_line
-          printable = printable_values
+          printable = table_printable_values
           out_str = String.new
           out_str << format('| %- 16s', printable[:degree_domain])
           out_str << format('| %- 26s', printable[:degree_type])

data/lib/mindee/product/resume/resume_v1_language.rb

@@ -26,6 +26,14 @@ module Mindee
 
         # @return [Hash]
         def printable_values
+          printable = {}
+          printable[:language] = format_for_display(@language)
+          printable[:level] = format_for_display(@level)
+          printable
+        end
+
+        # @return [Hash]
+        def table_printable_values
           printable = {}
           printable[:language] = format_for_display(@language, nil)
           printable[:level] = format_for_display(@level, 20)
@@ -34,7 +42,7 @@ module Mindee
 
         # @return [String]
         def to_table_line
-          printable = printable_values
+          printable = table_printable_values
           out_str = String.new
           out_str << format('| %- 9s', printable[:language])
           out_str << format('| %- 21s', printable[:level])

data/lib/mindee/product/resume/resume_v1_professional_experience.rb

@@ -50,6 +50,20 @@ module Mindee
 
         # @return [Hash]
         def printable_values
+          printable = {}
+          printable[:contract_type] = format_for_display(@contract_type)
+          printable[:department] = format_for_display(@department)
+          printable[:employer] = format_for_display(@employer)
+          printable[:end_month] = format_for_display(@end_month)
+          printable[:end_year] = format_for_display(@end_year)
+          printable[:role] = format_for_display(@role)
+          printable[:start_month] = format_for_display(@start_month)
+          printable[:start_year] = format_for_display(@start_year)
+          printable
+        end
+
+        # @return [Hash]
+        def table_printable_values
           printable = {}
           printable[:contract_type] = format_for_display(@contract_type, 15)
           printable[:department] = format_for_display(@department, 10)
@@ -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('| %- 16s', printable[:contract_type])
           out_str << format('| %- 11s', printable[:department])