mindee 3.11.0 → 3.13.0

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_document.rb

@@ -6,7 +6,7 @@ require_relative 'receipt_v5_line_item'
 module Mindee
   module Product
     module Receipt
-      # Receipt API version 5.2 document data.
+      # Receipt API version 5.3 document data.
       class ReceiptV5Document < Mindee::Parsing::Common::Prediction
         include Mindee::Parsing::Standard
         # The purchase category among predefined classes.

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/receipt/receipt_v5_page.rb

@@ -6,7 +6,7 @@ require_relative 'receipt_v5_document'
 module Mindee
   module Product
     module Receipt
-      # Receipt API version 5.2 page data.
+      # Receipt API version 5.3 page data.
       class ReceiptV5Page < Mindee::Parsing::Common::Page
         # @param prediction [Hash]
         def initialize(prediction)

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])

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

@@ -26,6 +26,14 @@ module Mindee
 
         # @return [Hash]
         def printable_values
+          printable = {}
+          printable[:name] = format_for_display(@name)
+          printable[:url] = format_for_display(@url)
+          printable
+        end
+
+        # @return [Hash]
+        def table_printable_values
           printable = {}
           printable[:name] = format_for_display(@name, 20)
           printable[:url] = format_for_display(@url, 50)
@@ -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('| %- 21s', printable[:name])
           out_str << format('| %- 51s', printable[:url])

data/lib/mindee/product/us/healthcare_card/healthcare_card_v1.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require_relative '../../../parsing'
+require_relative 'healthcare_card_v1_document'
+require_relative 'healthcare_card_v1_page'
+
+module Mindee
+  module Product
+    module US
+      # Healthcare Card module.
+      module HealthcareCard
+        # Healthcare Card API version 1 inference prediction.
+        class HealthcareCardV1 < Mindee::Parsing::Common::Inference
+          @endpoint_name = 'us_healthcare_cards'
+          @endpoint_version = '1'
+
+          # @param prediction [Hash]
+          def initialize(prediction)
+            super
+            @prediction = HealthcareCardV1Document.new(prediction['prediction'], nil)
+            @pages = []
+            prediction['pages'].each do |page|
+              if page.key?('prediction') && !page['prediction'].nil? && !page['prediction'].empty?
+                @pages.push(HealthcareCardV1Page.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
+end

data/lib/mindee/product/us/healthcare_card/healthcare_card_v1_copay.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require_relative '../../../parsing'
+
+module Mindee
+  module Product
+    module US
+      module HealthcareCard
+        # Is a fixed amount for a covered service.
+        class HealthcareCardV1Copay < Mindee::Parsing::Standard::FeatureField
+          include Mindee::Parsing::Standard
+          # The price of service.
+          # @return [Float]
+          attr_reader :service_fees
+          # The name of service of the copay.
+          # @return [String]
+          attr_reader :service_name
+
+          # @param prediction [Hash]
+          # @param page_id [Integer, nil]
+          def initialize(prediction, page_id)
+            super(prediction, page_id)
+            @service_fees = prediction['service_fees']
+            @service_name = prediction['service_name']
+            @page_id = page_id
+          end
+
+          # @return [Hash]
+          def printable_values
+            printable = {}
+            printable[:service_fees] = @service_fees.nil? ? '' : Field.float_to_string(@service_fees)
+            printable[:service_name] = format_for_display(@service_name)
+            printable
+          end
+
+          # @return [Hash]
+          def table_printable_values
+            printable = {}
+            printable[:service_fees] = @service_fees.nil? ? '' : Field.float_to_string(@service_fees)
+            printable[:service_name] = format_for_display(@service_name, nil)
+            printable
+          end
+
+          # @return [String]
+          def to_table_line
+            printable = table_printable_values
+            out_str = String.new
+            out_str << format('| %- 13s', printable[:service_fees])
+            out_str << format('| %- 13s', printable[:service_name])
+            out_str << '|'
+          end
+
+          # @return [String]
+          def to_s
+            printable = printable_values
+            out_str = String.new
+            out_str << "\n  :Service Fees: #{printable[:service_fees]}"
+            out_str << "\n  :Service Name: #{printable[:service_name]}"
+            out_str
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mindee/product/us/healthcare_card/healthcare_card_v1_document.rb

@@ -0,0 +1,127 @@
+# frozen_string_literal: true
+
+require_relative '../../../parsing'
+require_relative 'healthcare_card_v1_copay'
+
+module Mindee
+  module Product
+    module US
+      module HealthcareCard
+        # Healthcare Card API version 1.0 document data.
+        class HealthcareCardV1Document < Mindee::Parsing::Common::Prediction
+          include Mindee::Parsing::Standard
+          # The name of the company that provides the healthcare plan.
+          # @return [Mindee::Parsing::Standard::StringField]
+          attr_reader :company_name
+          # Is a fixed amount for a covered service.
+          # @return [Array<Mindee::Product::US::HealthcareCard::HealthcareCardV1Copay>]
+          attr_reader :copays
+          # The list of dependents covered by the healthcare plan.
+          # @return [Array<Mindee::Parsing::Standard::StringField>]
+          attr_reader :dependents
+          # The date when the member enrolled in the healthcare plan.
+          # @return [Mindee::Parsing::Standard::DateField]
+          attr_reader :enrollment_date
+          # The group number associated with the healthcare plan.
+          # @return [Mindee::Parsing::Standard::StringField]
+          attr_reader :group_number
+          # The organization that issued the healthcare plan.
+          # @return [Mindee::Parsing::Standard::StringField]
+          attr_reader :issuer80840
+          # The unique identifier for the member in the healthcare system.
+          # @return [Mindee::Parsing::Standard::StringField]
+          attr_reader :member_id
+          # The name of the member covered by the healthcare plan.
+          # @return [Mindee::Parsing::Standard::StringField]
+          attr_reader :member_name
+          # The unique identifier for the payer in the healthcare system.
+          # @return [Mindee::Parsing::Standard::StringField]
+          attr_reader :payer_id
+          # The BIN number for prescription drug coverage.
+          # @return [Mindee::Parsing::Standard::StringField]
+          attr_reader :rx_bin
+          # The group number for prescription drug coverage.
+          # @return [Mindee::Parsing::Standard::StringField]
+          attr_reader :rx_grp
+          # The PCN number for prescription drug coverage.
+          # @return [Mindee::Parsing::Standard::StringField]
+          attr_reader :rx_pcn
+
+          # @param prediction [Hash]
+          # @param page_id [Integer, nil]
+          def initialize(prediction, page_id)
+            super()
+            @company_name = StringField.new(prediction['company_name'], page_id)
+            @copays = []
+            prediction['copays'].each do |item|
+              @copays.push(HealthcareCardV1Copay.new(item, page_id))
+            end
+            @dependents = []
+            prediction['dependents'].each do |item|
+              @dependents.push(StringField.new(item, page_id))
+            end
+            @enrollment_date = DateField.new(prediction['enrollment_date'], page_id)
+            @group_number = StringField.new(prediction['group_number'], page_id)
+            @issuer80840 = StringField.new(prediction['issuer_80840'], page_id)
+            @member_id = StringField.new(prediction['member_id'], page_id)
+            @member_name = StringField.new(prediction['member_name'], page_id)
+            @payer_id = StringField.new(prediction['payer_id'], page_id)
+            @rx_bin = StringField.new(prediction['rx_bin'], page_id)
+            @rx_grp = StringField.new(prediction['rx_grp'], page_id)
+            @rx_pcn = StringField.new(prediction['rx_pcn'], page_id)
+          end
+
+          # @return [String]
+          def to_s
+            dependents = @dependents.join("\n #{' ' * 12}")
+            copays = copays_to_s
+            out_str = String.new
+            out_str << "\n:Company Name: #{@company_name}".rstrip
+            out_str << "\n:Member Name: #{@member_name}".rstrip
+            out_str << "\n:Member ID: #{@member_id}".rstrip
+            out_str << "\n:Issuer 80840: #{@issuer80840}".rstrip
+            out_str << "\n:Dependents: #{dependents}".rstrip
+            out_str << "\n:Group Number: #{@group_number}".rstrip
+            out_str << "\n:Payer ID: #{@payer_id}".rstrip
+            out_str << "\n:RX BIN: #{@rx_bin}".rstrip
+            out_str << "\n:RX GRP: #{@rx_grp}".rstrip
+            out_str << "\n:RX PCN: #{@rx_pcn}".rstrip
+            out_str << "\n:copays:"
+            out_str << copays
+            out_str << "\n:Enrollment Date: #{@enrollment_date}".rstrip
+            out_str[1..].to_s
+          end
+
+          private
+
+          # @param char [String]
+          # @return [String]
+          def copays_separator(char)
+            out_str = String.new
+            out_str << '  '
+            out_str << "+#{char * 14}"
+            out_str << "+#{char * 14}"
+            out_str << '+'
+            out_str
+          end
+
+          # @return [String]
+          def copays_to_s
+            return '' if @copays.empty?
+
+            line_items = @copays.map(&:to_table_line).join("\n#{copays_separator('-')}\n  ")
+            out_str = String.new
+            out_str << "\n#{copays_separator('-')}"
+            out_str << "\n  |"
+            out_str << ' Service Fees |'
+            out_str << ' Service Name |'
+            out_str << "\n#{copays_separator('=')}"
+            out_str << "\n  #{line_items}"
+            out_str << "\n#{copays_separator('-')}"
+            out_str
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mindee/product/us/healthcare_card/healthcare_card_v1_page.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative '../../../parsing'
+require_relative 'healthcare_card_v1_document'
+
+module Mindee
+  module Product
+    module US
+      module HealthcareCard
+        # Healthcare Card API version 1.0 page data.
+        class HealthcareCardV1Page < Mindee::Parsing::Common::Page
+          # @param prediction [Hash]
+          def initialize(prediction)
+            super(prediction)
+            @prediction = HealthcareCardV1PagePrediction.new(
+              prediction['prediction'],
+              prediction['id']
+            )
+          end
+        end
+
+        # Healthcare Card V1 page prediction.
+        class HealthcareCardV1PagePrediction < HealthcareCardV1Document
+          # @return [String]
+          def to_s
+            out_str = String.new
+            out_str << "\n#{super}"
+            out_str
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mindee/product/us/us_mail/us_mail_v2_recipient_address.rb

@@ -47,6 +47,19 @@ module Mindee
 
           # @return [Hash]
           def printable_values
+            printable = {}
+            printable[:city] = format_for_display(@city)
+            printable[:complete] = format_for_display(@complete)
+            printable[:is_address_change] = format_for_display(@is_address_change)
+            printable[:postal_code] = format_for_display(@postal_code)
+            printable[:private_mailbox_number] = format_for_display(@private_mailbox_number)
+            printable[:state] = format_for_display(@state)
+            printable[:street] = format_for_display(@street)
+            printable
+          end
+
+          # @return [Hash]
+          def table_printable_values
             printable = {}
             printable[:city] = format_for_display(@city, 15)
             printable[:complete] = format_for_display(@complete, 35)
@@ -60,7 +73,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[:city])
             out_str << format('| %- 36s', printable[:complete])

data/lib/mindee/product/us/us_mail/us_mail_v2_sender_address.rb

@@ -40,26 +40,14 @@ module Mindee
           # @return [Hash]
           def printable_values
             printable = {}
-            printable[:city] = format_for_display(@city, 15)
-            printable[:complete] = format_for_display(@complete, 35)
-            printable[:postal_code] = format_for_display(@postal_code, nil)
-            printable[:state] = format_for_display(@state, nil)
-            printable[:street] = format_for_display(@street, 25)
+            printable[:city] = format_for_display(@city)
+            printable[:complete] = format_for_display(@complete)
+            printable[:postal_code] = format_for_display(@postal_code)
+            printable[:state] = format_for_display(@state)
+            printable[:street] = format_for_display(@street)
             printable
           end
 
-          # @return [String]
-          def to_table_line
-            printable = printable_values
-            out_str = String.new
-            out_str << format('| %- 16s', printable[:city])
-            out_str << format('| %- 36s', printable[:complete])
-            out_str << format('| %- 12s', printable[:postal_code])
-            out_str << format('| %- 6s', printable[:state])
-            out_str << format('| %- 26s', printable[:street])
-            out_str << '|'
-          end
-
           # @return [String]
           def to_s
             printable = printable_values

data/lib/mindee/product.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative 'product/barcode_reader/barcode_reader_v1'
+require_relative 'product/bill_of_lading/bill_of_lading_v1'
 require_relative 'product/custom/custom_v1'
 require_relative 'product/proof_of_address/proof_of_address_v1'
 require_relative 'product/financial_document/financial_document_v1'
@@ -15,16 +16,20 @@ require_relative 'product/eu/driver_license/driver_license_v1'
 require_relative 'product/fr/bank_account_details/bank_account_details_v1'
 require_relative 'product/fr/bank_account_details/bank_account_details_v2'
 require_relative 'product/fr/bank_statement/bank_statement_v1'
+require_relative 'product/fr/carte_grise/carte_grise_v1'
 require_relative 'product/fr/carte_vitale/carte_vitale_v1'
 require_relative 'product/fr/id_card/id_card_v1'
 require_relative 'product/fr/id_card/id_card_v2'
-require_relative 'product/fr/carte_grise/carte_grise_v1'
+require_relative 'product/fr/energy_bill/energy_bill_v1'
+require_relative 'product/fr/payslip/payslip_v2'
 require_relative 'product/generated/generated_v1'
 require_relative 'product/invoice_splitter/invoice_splitter_v1'
 require_relative 'product/international_id/international_id_v1'
 require_relative 'product/international_id/international_id_v2'
+require_relative 'product/nutrition_facts_label/nutrition_facts_label_v1'
 require_relative 'product/resume/resume_v1'
 require_relative 'product/us/bank_check/bank_check_v1'
 require_relative 'product/us/driver_license/driver_license_v1'
+require_relative 'product/us/healthcare_card/healthcare_card_v1'
 require_relative 'product/us/us_mail/us_mail_v2'
 require_relative 'product/us/w9/w9_v1'

data/lib/mindee/version.rb

@@ -3,7 +3,7 @@
 # Mindee
 module Mindee
   # Current version.
-  VERSION = '3.11.0'
+  VERSION = '3.13.0'
 
   # Finds and return the current platform.
   # @return [String]

data/mindee.gemspec

@@ -30,6 +30,7 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = Gem::Requirement.new('>= 2.6')
 
   spec.add_runtime_dependency 'marcel', '~> 1.0.2'
+  spec.add_runtime_dependency 'mini_magick', '~> 4.13.0'
   spec.add_runtime_dependency 'origamindee', '~> 3.1.0'
 
   spec.add_development_dependency 'rake', '~> 12.3.3'