mindee 3.10.0 → 3.12.0

data/lib/mindee/parsing/common/api_response.rb

@@ -100,7 +100,7 @@ module Mindee
         attr_reader :job
         # @return [Mindee::Parsing::Common::ApiRequest]
         attr_reader :api_request
-        # @return [Hash]
+        # @return [String]
         attr_reader :raw_http
 
         # @param product_class [Class<Mindee::Product>]

data/lib/mindee/parsing/common/ocr/mvision_v1.rb

@@ -27,6 +27,22 @@ module Mindee
             end
             out_str.strip
           end
+
+          # Constructs a line from a column, located underneath given coordinates
+          # @param coordinates [Array<Mindee::Geometry::Point>] Polygon or bounding box where the reconstruction should
+          # start.
+          # @param page_id [Integer] ID of the page to start at
+          # @param x_margin [Float] Margin of misalignment for the x coordinate.
+          # @return [Mindee::Parsing::Common::Ocr::OcrLine]
+          def reconstruct_vertically(coordinates, page_id, x_margin)
+            line_arr = OcrLine.new([])
+            @pages[page_id].all_lines.each do |line|
+              line.each do |word|
+                line_arr.push(word) if Geometry.below?(word.polygon, coordinates, x_margin / 2, x_margin * 2)
+              end
+            end
+            line_arr
+          end
         end
       end
     end

data/lib/mindee/parsing/common/ocr/ocr.rb

@@ -163,6 +163,16 @@ module Mindee
           def to_s
             @mvision_v1.to_s
           end
+
+          # Constructs a line from a column, located underneath given coordinates
+          # @param coordinates [Array<Mindee::Geometry::Point>] Polygon or bounding box where the reconstruction should
+          # start
+          # @param page_id [Integer] ID of the page to start at
+          # @param x_margin [Float] Margin of misalignment for the x coordinate (default 10%)
+          # @return [Mindee::Parsing::Common::Ocr::OcrLine]
+          def reconstruct_vertically(coordinates, page_id, x_margin = 0.05)
+            @mvision_v1.reconstruct_vertically(coordinates, page_id, x_margin)
+          end
         end
       end
     end

data/lib/mindee/parsing/standard/company_registration_field.rb

@@ -15,6 +15,23 @@ module Mindee
           super
           @type = prediction['type']
         end
+
+        def to_table_line
+          printable = printable_values
+          format('| %<type>-15s | %<value>-20s ', type: printable['type'], value: printable['value'])
+        end
+
+        def to_s
+          printable = printable_values
+          format('Type: %<type>s, Value: %<value>s', type: printable['type'], value: printable['value'])
+        end
+
+        def printable_values
+          printable = {}
+          printable['type'] = type
+          printable['value'] = value
+          printable
+        end
       end
     end
   end

data/lib/mindee/product/financial_document/financial_document_v1_document.rb

@@ -6,7 +6,7 @@ require_relative 'financial_document_v1_line_item'
 module Mindee
   module Product
     module FinancialDocument
-      # Financial Document API version 1.7 document data.
+      # Financial Document API version 1.9 document data.
       class FinancialDocumentV1Document < Mindee::Parsing::Common::Prediction
         include Mindee::Parsing::Standard
         # The customer's address used for billing.
@@ -206,6 +206,7 @@ module Mindee
           out_str << "+#{char * 12}"
           out_str << "+#{char * 14}"
           out_str << "+#{char * 14}"
+          out_str << "+#{char * 17}"
           out_str << "+#{char * 12}"
           out_str << '+'
           out_str
@@ -225,6 +226,7 @@ module Mindee
           out_str << ' Tax Amount |'
           out_str << ' Tax Rate (%) |'
           out_str << ' Total Amount |'
+          out_str << ' Unit of measure |'
           out_str << ' Unit Price |'
           out_str << "\n#{line_items_separator('=')}"
           out_str << "\n  #{line_items}"

data/lib/mindee/product/financial_document/financial_document_v1_line_item.rb

@@ -26,6 +26,9 @@ module Mindee
         # The item total amount.
         # @return [Float]
         attr_reader :total_amount
+        # The item unit of measure.
+        # @return [String]
+        attr_reader :unit_measure
         # The item unit price.
         # @return [Float]
         attr_reader :unit_price
@@ -40,6 +43,7 @@ module Mindee
           @tax_amount = prediction['tax_amount']
           @tax_rate = prediction['tax_rate']
           @total_amount = prediction['total_amount']
+          @unit_measure = prediction['unit_measure']
           @unit_price = prediction['unit_price']
           @page_id = page_id
         end
@@ -53,6 +57,7 @@ module Mindee
           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, nil)
           printable[:unit_price] = @unit_price.nil? ? '' : Field.float_to_string(@unit_price)
           printable
         end
@@ -67,6 +72,7 @@ module Mindee
           out_str << format('| %- 11s', printable[:tax_amount])
           out_str << format('| %- 13s', printable[:tax_rate])
           out_str << format('| %- 13s', printable[:total_amount])
+          out_str << format('| %- 16s', printable[:unit_measure])
           out_str << format('| %- 11s', printable[:unit_price])
           out_str << '|'
         end
@@ -81,6 +87,7 @@ module Mindee
           out_str << "\n  :Tax Amount: #{printable[:tax_amount]}"
           out_str << "\n  :Tax Rate (%): #{printable[:tax_rate]}"
           out_str << "\n  :Total Amount: #{printable[:total_amount]}"
+          out_str << "\n  :Unit of measure: #{printable[:unit_measure]}"
           out_str << "\n  :Unit Price: #{printable[:unit_price]}"
           out_str
         end

data/lib/mindee/product/financial_document/financial_document_v1_page.rb

@@ -6,7 +6,7 @@ require_relative 'financial_document_v1_document'
 module Mindee
   module Product
     module FinancialDocument
-      # Financial Document API version 1.7 page data.
+      # Financial Document API version 1.9 page data.
       class FinancialDocumentV1Page < Mindee::Parsing::Common::Page
         # @param prediction [Hash]
         def initialize(prediction)

data/lib/mindee/product/international_id/international_id_v2_document.rb

@@ -5,7 +5,7 @@ require_relative '../../parsing'
 module Mindee
   module Product
     module InternationalId
-      # International ID API version 2.0 document data.
+      # International ID API version 2.1 document data.
       class InternationalIdV2Document < Mindee::Parsing::Common::Prediction
         include Mindee::Parsing::Standard
         # The physical address of the document holder.

data/lib/mindee/product/international_id/international_id_v2_page.rb

@@ -6,7 +6,7 @@ require_relative 'international_id_v2_document'
 module Mindee
   module Product
     module InternationalId
-      # International ID API version 2.0 page data.
+      # International ID API version 2.1 page data.
       class InternationalIdV2Page < Mindee::Parsing::Common::Page
         # @param prediction [Hash]
         def initialize(prediction)

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.6 document data.
+      # Invoice API version 4.7 document data.
       class InvoiceV4Document < Mindee::Parsing::Common::Prediction
         include Mindee::Parsing::Standard
         # The customer's address used for billing.
@@ -176,6 +176,7 @@ module Mindee
           out_str << "+#{char * 12}"
           out_str << "+#{char * 14}"
           out_str << "+#{char * 14}"
+          out_str << "+#{char * 17}"
           out_str << "+#{char * 12}"
           out_str << '+'
           out_str
@@ -195,6 +196,7 @@ module Mindee
           out_str << ' Tax Amount |'
           out_str << ' Tax Rate (%) |'
           out_str << ' Total Amount |'
+          out_str << ' Unit of measure |'
           out_str << ' Unit Price |'
           out_str << "\n#{line_items_separator('=')}"
           out_str << "\n  #{line_items}"

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

@@ -26,6 +26,9 @@ module Mindee
         # The item total amount.
         # @return [Float]
         attr_reader :total_amount
+        # The item unit of measure.
+        # @return [String]
+        attr_reader :unit_measure
         # The item unit price.
         # @return [Float]
         attr_reader :unit_price
@@ -40,6 +43,7 @@ module Mindee
           @tax_amount = prediction['tax_amount']
           @tax_rate = prediction['tax_rate']
           @total_amount = prediction['total_amount']
+          @unit_measure = prediction['unit_measure']
           @unit_price = prediction['unit_price']
           @page_id = page_id
         end
@@ -53,6 +57,7 @@ module Mindee
           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, nil)
           printable[:unit_price] = @unit_price.nil? ? '' : Field.float_to_string(@unit_price)
           printable
         end
@@ -67,6 +72,7 @@ module Mindee
           out_str << format('| %- 11s', printable[:tax_amount])
           out_str << format('| %- 13s', printable[:tax_rate])
           out_str << format('| %- 13s', printable[:total_amount])
+          out_str << format('| %- 16s', printable[:unit_measure])
           out_str << format('| %- 11s', printable[:unit_price])
           out_str << '|'
         end
@@ -81,6 +87,7 @@ module Mindee
           out_str << "\n  :Tax Amount: #{printable[:tax_amount]}"
           out_str << "\n  :Tax Rate (%): #{printable[:tax_rate]}"
           out_str << "\n  :Total Amount: #{printable[:total_amount]}"
+          out_str << "\n  :Unit of measure: #{printable[:unit_measure]}"
           out_str << "\n  :Unit Price: #{printable[:unit_price]}"
           out_str
         end

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.6 page data.
+      # Invoice API version 4.7 page data.
       class InvoiceV4Page < Mindee::Parsing::Common::Page
         # @param prediction [Hash]
         def initialize(prediction)

data/lib/mindee/product/multi_receipts_detector/multi_receipts_detector_v1_document.rb

@@ -5,7 +5,7 @@ require_relative '../../parsing'
 module Mindee
   module Product
     module MultiReceiptsDetector
-      # Multi Receipts Detector API version 1.0 document data.
+      # Multi Receipts Detector API version 1.1 document data.
       class MultiReceiptsDetectorV1Document < Mindee::Parsing::Common::Prediction
         include Mindee::Parsing::Standard
         # Positions of the receipts on the document.

data/lib/mindee/product/multi_receipts_detector/multi_receipts_detector_v1_page.rb

@@ -6,7 +6,7 @@ require_relative 'multi_receipts_detector_v1_document'
 module Mindee
   module Product
     module MultiReceiptsDetector
-      # Multi Receipts Detector API version 1.0 page data.
+      # Multi Receipts Detector API version 1.1 page data.
       class MultiReceiptsDetectorV1Page < Mindee::Parsing::Common::Page
         # @param prediction [Hash]
         def initialize(prediction)

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_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/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,57 @@
+# 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, nil)
+            printable
+          end
+
+          # @return [String]
+          def to_table_line
+            printable = 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.rb

@@ -26,5 +26,6 @@ require_relative 'product/international_id/international_id_v2'
 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.10.0'
+  VERSION = '3.12.0'
 
   # Finds and return the current platform.
   # @return [String]

data/lib/mindee.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'mindee/client'
+require 'mindee/extraction'
 
 module Mindee
   # Mindee internal http module.
@@ -18,6 +19,10 @@ module Mindee
     end
   end
 
+  # Custom extraction module
+  module Extraction
+  end
+
   # Parsing internals and fields.
   module Parsing
     # Common fields and functions.

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'