mindee 4.13.0 → 5.0.0.rc1

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

@@ -1,55 +0,0 @@
-# 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
-          @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? ? '' : 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
-
-        # @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

@@ -1,55 +0,0 @@
-# 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
-          @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? ? '' : 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
-
-        # @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

@@ -1,55 +0,0 @@
-# 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
-          @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? ? '' : 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
-
-        # @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

@@ -1,55 +0,0 @@
-# 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
-          @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? ? '' : 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
-
-        # @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/passport/passport_v1.rb

@@ -1,45 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../../parsing'
-require_relative 'passport_v1_document'
-require_relative 'passport_v1_page'
-
-module Mindee
-  module Product
-    # Passport module.
-    module Passport
-      # Passport API version 1 inference prediction.
-      class PassportV1 < Mindee::Parsing::Common::Inference
-        @endpoint_name = 'passport'
-        @endpoint_version = '1'
-        @has_async = false
-        @has_sync = true
-
-        # @param prediction [Hash]
-        def initialize(prediction)
-          super
-          @prediction = PassportV1Document.new(prediction['prediction'], nil)
-          @pages = []
-          prediction['pages'].each do |page|
-            @pages.push(PassportV1Page.new(page))
-          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
-          # 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
-  end
-end

data/lib/mindee/product/passport/passport_v1_document.rb

@@ -1,109 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../../parsing'
-
-module Mindee
-  module Product
-    module Passport
-      # Passport API version 1.1 document data.
-      class PassportV1Document < Mindee::Parsing::Common::Prediction
-        include Mindee::Parsing::Standard
-        # The date of birth of the passport holder.
-        # @return [Mindee::Parsing::Standard::DateField]
-        attr_reader :birth_date
-        # The place of birth of the passport holder.
-        # @return [Mindee::Parsing::Standard::StringField]
-        attr_reader :birth_place
-        # The country's 3 letter code (ISO 3166-1 alpha-3).
-        # @return [Mindee::Parsing::Standard::StringField]
-        attr_reader :country
-        # The expiry date of the passport.
-        # @return [Mindee::Parsing::Standard::DateField]
-        attr_reader :expiry_date
-        # The gender of the passport holder.
-        # @return [Mindee::Parsing::Standard::StringField]
-        attr_reader :gender
-        # The given name(s) of the passport holder.
-        # @return [Array<Mindee::Parsing::Standard::StringField>]
-        attr_reader :given_names
-        # The passport's identification number.
-        # @return [Mindee::Parsing::Standard::StringField]
-        attr_reader :id_number
-        # The date the passport was issued.
-        # @return [Mindee::Parsing::Standard::DateField]
-        attr_reader :issuance_date
-        # Machine Readable Zone, first line
-        # @return [Mindee::Parsing::Standard::StringField]
-        attr_reader :mrz1
-        # Machine Readable Zone, second line
-        # @return [Mindee::Parsing::Standard::StringField]
-        attr_reader :mrz2
-        # The surname of the passport holder.
-        # @return [Mindee::Parsing::Standard::StringField]
-        attr_reader :surname
-
-        # @param prediction [Hash]
-        # @param page_id [Integer, nil]
-        def initialize(prediction, page_id)
-          super
-          @birth_date = Parsing::Standard::DateField.new(
-            prediction['birth_date'],
-            page_id
-          )
-          @birth_place = Parsing::Standard::StringField.new(
-            prediction['birth_place'],
-            page_id
-          )
-          @country = Parsing::Standard::StringField.new(
-            prediction['country'],
-            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(Parsing::Standard::StringField.new(item, page_id))
-          end
-          @id_number = Parsing::Standard::StringField.new(
-            prediction['id_number'],
-            page_id
-          )
-          @issuance_date = Parsing::Standard::DateField.new(
-            prediction['issuance_date'],
-            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]
-        def to_s
-          given_names = @given_names.join("\n #{' ' * 15}")
-          out_str = String.new
-          out_str << "\n:Country Code: #{@country}".rstrip
-          out_str << "\n:ID Number: #{@id_number}".rstrip
-          out_str << "\n:Given Name(s): #{given_names}".rstrip
-          out_str << "\n:Surname: #{@surname}".rstrip
-          out_str << "\n:Date of Birth: #{@birth_date}".rstrip
-          out_str << "\n:Place of Birth: #{@birth_place}".rstrip
-          out_str << "\n:Gender: #{@gender}".rstrip
-          out_str << "\n:Date of Issue: #{@issuance_date}".rstrip
-          out_str << "\n:Expiry Date: #{@expiry_date}".rstrip
-          out_str << "\n:MRZ Line 1: #{@mrz1}".rstrip
-          out_str << "\n:MRZ Line 2: #{@mrz2}".rstrip
-          out_str[1..].to_s
-        end
-      end
-    end
-  end
-end

data/lib/mindee/product/passport/passport_v1_page.rb

@@ -1,36 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../../parsing'
-require_relative 'passport_v1_document'
-
-module Mindee
-  module Product
-    module Passport
-      # Passport API version 1.1 page data.
-      class PassportV1Page < Mindee::Parsing::Common::Page
-        # @param prediction [Hash]
-        def initialize(prediction)
-          super
-          @prediction = if prediction['prediction'].empty?
-                          nil
-                        else
-                          PassportV1PagePrediction.new(
-                            prediction['prediction'],
-                            prediction['id']
-                          )
-                        end
-        end
-      end
-
-      # Passport V1 page prediction.
-      class PassportV1PagePrediction < PassportV1Document
-        # @return [String]
-        def to_s
-          out_str = String.new
-          out_str << "\n#{super}"
-          out_str
-        end
-      end
-    end
-  end
-end

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

@@ -1,45 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../../parsing'
-require_relative 'receipt_v5_document'
-require_relative 'receipt_v5_page'
-
-module Mindee
-  module Product
-    # Receipt module.
-    module Receipt
-      # Receipt API version 5 inference prediction.
-      class ReceiptV5 < Mindee::Parsing::Common::Inference
-        @endpoint_name = 'expense_receipts'
-        @endpoint_version = '5'
-        @has_async = true
-        @has_sync = true
-
-        # @param prediction [Hash]
-        def initialize(prediction)
-          super
-          @prediction = ReceiptV5Document.new(prediction['prediction'], nil)
-          @pages = []
-          prediction['pages'].each do |page|
-            @pages.push(ReceiptV5Page.new(page))
-          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
-          # 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
-  end
-end

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

@@ -1,184 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../../parsing'
-require_relative 'receipt_v5_line_items'
-
-module Mindee
-  module Product
-    module Receipt
-      # Receipt API version 5.4 document data.
-      class ReceiptV5Document < Mindee::Parsing::Common::Prediction
-        include Mindee::Parsing::Standard
-        # The purchase category of the receipt.
-        # @return [Mindee::Parsing::Standard::ClassificationField]
-        attr_reader :category
-        # The date the purchase was made.
-        # @return [Mindee::Parsing::Standard::DateField]
-        attr_reader :date
-        # The type of receipt: EXPENSE RECEIPT or CREDIT CARD RECEIPT.
-        # @return [Mindee::Parsing::Standard::ClassificationField]
-        attr_reader :document_type
-        # List of all line items on the receipt.
-        # @return [Mindee::Product::Receipt::ReceiptV5LineItems]
-        attr_reader :line_items
-        # The locale of the document.
-        # @return [Mindee::Parsing::Standard::LocaleField]
-        attr_reader :locale
-        # The receipt number or identifier.
-        # @return [Mindee::Parsing::Standard::StringField]
-        attr_reader :receipt_number
-        # The purchase subcategory of the receipt for transport and food.
-        # @return [Mindee::Parsing::Standard::ClassificationField]
-        attr_reader :subcategory
-        # The address of the supplier or merchant.
-        # @return [Mindee::Parsing::Standard::StringField]
-        attr_reader :supplier_address
-        # List of company registration numbers associated to the supplier.
-        # @return [Array<Mindee::Parsing::Standard::CompanyRegistrationField>]
-        attr_reader :supplier_company_registrations
-        # The name of the supplier or merchant.
-        # @return [Mindee::Parsing::Standard::StringField]
-        attr_reader :supplier_name
-        # The phone number of the supplier or merchant.
-        # @return [Mindee::Parsing::Standard::StringField]
-        attr_reader :supplier_phone_number
-        # The list of taxes present on the receipt.
-        # @return [Mindee::Parsing::Standard::Taxes]
-        attr_reader :taxes
-        # The time the purchase was made.
-        # @return [Mindee::Parsing::Standard::StringField]
-        attr_reader :time
-        # The total amount of tip and gratuity.
-        # @return [Mindee::Parsing::Standard::AmountField]
-        attr_reader :tip
-        # The total amount paid: includes taxes, discounts, fees, tips, and gratuity.
-        # @return [Mindee::Parsing::Standard::AmountField]
-        attr_reader :total_amount
-        # The net amount paid: does not include taxes, fees, and discounts.
-        # @return [Mindee::Parsing::Standard::AmountField]
-        attr_reader :total_net
-        # The sum of all taxes.
-        # @return [Mindee::Parsing::Standard::AmountField]
-        attr_reader :total_tax
-
-        # @param prediction [Hash]
-        # @param page_id [Integer, nil]
-        def initialize(prediction, page_id)
-          super
-          @category = Parsing::Standard::ClassificationField.new(
-            prediction['category'],
-            page_id
-          )
-          @date = Parsing::Standard::DateField.new(prediction['date'], page_id)
-          @document_type = Parsing::Standard::ClassificationField.new(
-            prediction['document_type'],
-            page_id
-          )
-          @line_items = Product::Receipt::ReceiptV5LineItems.new(prediction['line_items'], page_id)
-          @locale = Parsing::Standard::LocaleField.new(
-            prediction['locale'],
-            page_id
-          )
-          @receipt_number = Parsing::Standard::StringField.new(
-            prediction['receipt_number'],
-            page_id
-          )
-          @subcategory = Parsing::Standard::ClassificationField.new(
-            prediction['subcategory'],
-            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(Parsing::Standard::CompanyRegistrationField.new(item, page_id))
-          end
-          @supplier_name = Parsing::Standard::StringField.new(
-            prediction['supplier_name'],
-            page_id
-          )
-          @supplier_phone_number = Parsing::Standard::StringField.new(
-            prediction['supplier_phone_number'],
-            page_id
-          )
-          @taxes = Parsing::Standard::Taxes.new(prediction['taxes'], page_id)
-          @time = Parsing::Standard::StringField.new(prediction['time'], page_id)
-          @tip = Parsing::Standard::AmountField.new(prediction['tip'], 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]
-        def to_s
-          supplier_company_registrations = @supplier_company_registrations.join("\n #{' ' * 32}")
-          line_items = line_items_to_s
-          out_str = String.new
-          out_str << "\n:Expense Locale: #{@locale}".rstrip
-          out_str << "\n:Purchase Category: #{@category}".rstrip
-          out_str << "\n:Purchase Subcategory: #{@subcategory}".rstrip
-          out_str << "\n:Document Type: #{@document_type}".rstrip
-          out_str << "\n:Purchase Date: #{@date}".rstrip
-          out_str << "\n:Purchase Time: #{@time}".rstrip
-          out_str << "\n:Total Amount: #{@total_amount}".rstrip
-          out_str << "\n:Total Net: #{@total_net}".rstrip
-          out_str << "\n:Total Tax: #{@total_tax}".rstrip
-          out_str << "\n:Tip and Gratuity: #{@tip}".rstrip
-          out_str << "\n:Taxes:#{@taxes}".rstrip
-          out_str << "\n:Supplier Name: #{@supplier_name}".rstrip
-          out_str << "\n:Supplier Company Registrations: #{supplier_company_registrations}".rstrip
-          out_str << "\n:Supplier Address: #{@supplier_address}".rstrip
-          out_str << "\n:Supplier Phone Number: #{@supplier_phone_number}".rstrip
-          out_str << "\n:Receipt Number: #{@receipt_number}".rstrip
-          out_str << "\n:Line Items:"
-          out_str << line_items
-          out_str[1..].to_s
-        end
-
-        private
-
-        # @param char [String]
-        # @return [String]
-        def line_items_separator(char)
-          out_str = String.new
-          out_str << '  '
-          out_str << "+#{char * 38}"
-          out_str << "+#{char * 10}"
-          out_str << "+#{char * 14}"
-          out_str << "+#{char * 12}"
-          out_str << '+'
-          out_str
-        end
-
-        # @return [String]
-        def line_items_to_s
-          return '' if @line_items.empty?
-
-          line_items = @line_items.map(&:to_table_line).join("\n#{line_items_separator('-')}\n  ")
-          out_str = String.new
-          out_str << "\n#{line_items_separator('-')}"
-          out_str << "\n  |"
-          out_str << ' Description                          |'
-          out_str << ' Quantity |'
-          out_str << ' Total Amount |'
-          out_str << ' Unit Price |'
-          out_str << "\n#{line_items_separator('=')}"
-          out_str << "\n  #{line_items}"
-          out_str << "\n#{line_items_separator('-')}"
-          out_str
-        end
-      end
-    end
-  end
-end