mindee 3.19.1 → 4.0.0

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require_relative '../../../parsing'
-require_relative 'healthcare_card_v1_copay'
+require_relative 'healthcare_card_v1_copays'
 
 module Mindee
   module Product
@@ -14,7 +14,7 @@ module Mindee
           # @return [Mindee::Parsing::Standard::StringField]
           attr_reader :company_name
           # Is a fixed amount for a covered service.
-          # @return [Array<Mindee::Product::US::HealthcareCard::HealthcareCardV1Copay>]
+          # @return [Mindee::Product::US::HealthcareCard::HealthcareCardV1Copays]
           attr_reader :copays
           # The list of dependents covered by the healthcare plan.
           # @return [Array<Mindee::Parsing::Standard::StringField>]
@@ -50,25 +50,52 @@ module Mindee
           # @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 = []
+            super
+            @company_name = Parsing::Standard::StringField.new(
+              prediction['company_name'],
+              page_id
+            )
+            @copays = Product::US::HealthcareCard::HealthcareCardV1Copays.new(prediction['copays'], page_id)
+            @dependents = [] # : Array[Parsing::Standard::StringField]
             prediction['dependents'].each do |item|
-              @dependents.push(StringField.new(item, page_id))
+              @dependents.push(Parsing::Standard::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)
+            @enrollment_date = Parsing::Standard::DateField.new(
+              prediction['enrollment_date'],
+              page_id
+            )
+            @group_number = Parsing::Standard::StringField.new(
+              prediction['group_number'],
+              page_id
+            )
+            @issuer80840 = Parsing::Standard::StringField.new(
+              prediction['issuer_80840'],
+              page_id
+            )
+            @member_id = Parsing::Standard::StringField.new(
+              prediction['member_id'],
+              page_id
+            )
+            @member_name = Parsing::Standard::StringField.new(
+              prediction['member_name'],
+              page_id
+            )
+            @payer_id = Parsing::Standard::StringField.new(
+              prediction['payer_id'],
+              page_id
+            )
+            @rx_bin = Parsing::Standard::StringField.new(
+              prediction['rx_bin'],
+              page_id
+            )
+            @rx_grp = Parsing::Standard::StringField.new(
+              prediction['rx_grp'],
+              page_id
+            )
+            @rx_pcn = Parsing::Standard::StringField.new(
+              prediction['rx_pcn'],
+              page_id
+            )
           end
 
           # @return [String]

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

@@ -11,11 +11,15 @@ module Mindee
         class HealthcareCardV1Page < Mindee::Parsing::Common::Page
           # @param prediction [Hash]
           def initialize(prediction)
-            super(prediction)
-            @prediction = HealthcareCardV1PagePrediction.new(
-              prediction['prediction'],
-              prediction['id']
-            )
+            super
+            @prediction = if prediction['prediction'].empty?
+                            nil
+                          else
+                            HealthcareCardV1PagePrediction.new(
+                              prediction['prediction'],
+                              prediction['id']
+                            )
+                          end
           end
         end
 

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

@@ -13,6 +13,8 @@ module Mindee
         class UsMailV3 < Mindee::Parsing::Common::Inference
           @endpoint_name = 'us_mail'
           @endpoint_version = '3'
+          @has_async = true
+          @has_sync = false
 
           # @param prediction [Hash]
           def initialize(prediction)
@@ -20,9 +22,7 @@ module Mindee
             @prediction = UsMailV3Document.new(prediction['prediction'], nil)
             @pages = []
             prediction['pages'].each do |page|
-              if page.key?('prediction') && !page['prediction'].nil? && !page['prediction'].empty?
-                @pages.push(UsMailV3Page.new(page))
-              end
+              @pages.push(UsMailV3Page.new(page))
             end
           end
 
@@ -33,6 +33,12 @@ module Mindee
             # 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

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

@@ -2,7 +2,7 @@
 
 require_relative '../../../parsing'
 require_relative 'us_mail_v3_sender_address'
-require_relative 'us_mail_v3_recipient_address'
+require_relative 'us_mail_v3_recipient_addresses'
 
 module Mindee
   module Product
@@ -15,7 +15,7 @@ module Mindee
           # @return [Mindee::Parsing::Standard::BooleanField]
           attr_reader :is_return_to_sender
           # The addresses of the recipients.
-          # @return [Array<Mindee::Product::US::UsMail::UsMailV3RecipientAddress>]
+          # @return [Mindee::Product::US::UsMail::UsMailV3RecipientAddresses]
           attr_reader :recipient_addresses
           # The names of the recipients.
           # @return [Array<Mindee::Parsing::Standard::StringField>]
@@ -30,18 +30,26 @@ module Mindee
           # @param prediction [Hash]
           # @param page_id [Integer, nil]
           def initialize(prediction, page_id)
-            super()
-            @is_return_to_sender = BooleanField.new(prediction['is_return_to_sender'], page_id)
-            @recipient_addresses = []
-            prediction['recipient_addresses'].each do |item|
-              @recipient_addresses.push(UsMailV3RecipientAddress.new(item, page_id))
-            end
-            @recipient_names = []
+            super
+            @is_return_to_sender = Parsing::Standard::BooleanField.new(
+              prediction['is_return_to_sender'],
+              page_id
+            )
+            @recipient_addresses = Product::US::UsMail::UsMailV3RecipientAddresses.new(
+              prediction['recipient_addresses'], page_id
+            )
+            @recipient_names = [] # : Array[Parsing::Standard::StringField]
             prediction['recipient_names'].each do |item|
-              @recipient_names.push(StringField.new(item, page_id))
+              @recipient_names.push(Parsing::Standard::StringField.new(item, page_id))
             end
-            @sender_address = UsMailV3SenderAddress.new(prediction['sender_address'], page_id)
-            @sender_name = StringField.new(prediction['sender_name'], page_id)
+            @sender_address = Product::US::UsMail::UsMailV3SenderAddress.new(
+              prediction['sender_address'],
+              page_id
+            )
+            @sender_name = Parsing::Standard::StringField.new(
+              prediction['sender_name'],
+              page_id
+            )
           end
 
           # @return [String]

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

@@ -11,11 +11,15 @@ module Mindee
         class UsMailV3Page < Mindee::Parsing::Common::Page
           # @param prediction [Hash]
           def initialize(prediction)
-            super(prediction)
-            @prediction = UsMailV3PagePrediction.new(
-              prediction['prediction'],
-              prediction['id']
-            )
+            super
+            @prediction = if prediction['prediction'].empty?
+                            nil
+                          else
+                            UsMailV3PagePrediction.new(
+                              prediction['prediction'],
+                              prediction['id']
+                            )
+                          end
           end
         end
 

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

@@ -16,7 +16,7 @@ module Mindee
           # @return [String]
           attr_reader :complete
           # Indicates if the recipient's address is a change of address.
-          # @return [Boolean]
+          # @return [bool]
           attr_reader :is_address_change
           # The postal code of the recipient's address.
           # @return [String]
@@ -37,7 +37,7 @@ module Mindee
           # @param prediction [Hash]
           # @param page_id [Integer, nil]
           def initialize(prediction, page_id)
-            super(prediction, page_id)
+            super
             @city = prediction['city']
             @complete = prediction['complete']
             @is_address_change = prediction['is_address_change']

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

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require_relative 'us_mail_v3_sender_address'
+require_relative 'us_mail_v3_recipient_address'
+
+module Mindee
+  module Product
+    module US
+      module UsMail
+        # The addresses of the recipients.
+        class UsMailV3RecipientAddresses < Array
+          # Entries.
+          # @return [Array<UsMailV3RecipientAddress>]
+          attr_reader :entries
+
+          # @param prediction [Array]
+          # @param page_id [Integer, nil]
+          def initialize(prediction, page_id)
+            entries = prediction.map do |entry|
+              UsMail::UsMailV3RecipientAddress.new(entry, page_id)
+            end
+            super(entries)
+          end
+
+          # Creates a line of rST table-compliant string separators.
+          # @param char [String] Character to use as a separator.
+          # @return [String]
+          def self.line_items_separator(char)
+            out_str = String.new
+            out_str << "+#{char * 17}"
+            out_str << "+#{char * 37}"
+            out_str << "+#{char * 19}"
+            out_str << "+#{char * 13}"
+            out_str << "+#{char * 24}"
+            out_str << "+#{char * 7}"
+            out_str << "+#{char * 27}"
+            out_str << "+#{char * 17}"
+            out_str
+          end
+
+          # @return [String]
+          def to_s
+            return '' if empty?
+
+            lines = map do |entry|
+              "\n  #{entry.to_table_line}\n#{self.class.line_items_separator('-')}"
+            end.join
+            out_str = String.new
+            out_str << ("\n#{self.class.line_items_separator('-')}\n ")
+            out_str << ' | City           '
+            out_str << ' | Complete Address                   '
+            out_str << ' | Is Address Change'
+            out_str << ' | Postal Code'
+            out_str << ' | Private Mailbox Number'
+            out_str << ' | State'
+            out_str << ' | Street                   '
+            out_str << ' | Unit           '
+            out_str << (" |\n#{self.class.line_items_separator('=')}")
+            out_str + lines
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -28,7 +28,7 @@ module Mindee
           # @param prediction [Hash]
           # @param page_id [Integer, nil]
           def initialize(prediction, page_id)
-            super(prediction, page_id)
+            super
             @city = prediction['city']
             @complete = prediction['complete']
             @postal_code = prediction['postal_code']

data/lib/mindee/product/us/w9/w9_v1.rb

@@ -13,16 +13,16 @@ module Mindee
         class W9V1 < Mindee::Parsing::Common::Inference
           @endpoint_name = 'us_w9'
           @endpoint_version = '1'
+          @has_async = false
+          @has_sync = true
 
           # @param prediction [Hash]
           def initialize(prediction)
             super
-            @prediction = W9V1Document.new
+            @prediction = W9V1Document.new(prediction['prediction'], nil)
             @pages = []
             prediction['pages'].each do |page|
-              if page.key?('prediction') && !page['prediction'].nil? && !page['prediction'].empty?
-                @pages.push(W9V1Page.new(page))
-              end
+              @pages.push(W9V1Page.new(page))
             end
           end
 
@@ -33,6 +33,12 @@ module Mindee
             # 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

data/lib/mindee/product/us/w9/w9_v1_page.rb

@@ -11,11 +11,15 @@ module Mindee
         class W9V1Page < Mindee::Parsing::Common::Page
           # @param prediction [Hash]
           def initialize(prediction)
-            super(prediction)
-            @prediction = W9V1PagePrediction.new(
-              prediction['prediction'],
-              prediction['id']
-            )
+            super
+            @prediction = if prediction['prediction'].empty?
+                            nil
+                          else
+                            W9V1PagePrediction.new(
+                              prediction['prediction'],
+                              prediction['id']
+                            )
+                          end
           end
         end
 
@@ -63,19 +67,46 @@ module Mindee
           # @param prediction [Hash]
           # @param page_id [Integer, nil]
           def initialize(prediction, page_id)
-            @address = StringField.new(prediction['address'], page_id)
-            @business_name = StringField.new(prediction['business_name'], page_id)
-            @city_state_zip = StringField.new(prediction['city_state_zip'], page_id)
-            @ein = StringField.new(prediction['ein'], page_id)
-            @name = StringField.new(prediction['name'], page_id)
-            @signature_date_position = PositionField.new(prediction['signature_date_position'], page_id)
-            @signature_position = PositionField.new(prediction['signature_position'], page_id)
-            @ssn = StringField.new(prediction['ssn'], page_id)
-            @tax_classification = StringField.new(prediction['tax_classification'], page_id)
-            @tax_classification_llc = StringField.new(prediction['tax_classification_llc'], page_id)
-            @tax_classification_other_details = StringField.new(prediction['tax_classification_other_details'], page_id)
-            @w9_revision_date = StringField.new(prediction['w9_revision_date'], page_id)
-            super()
+            @address = Parsing::Standard::StringField.new(
+              prediction['address'],
+              page_id
+            )
+            @business_name = Parsing::Standard::StringField.new(
+              prediction['business_name'],
+              page_id
+            )
+            @city_state_zip = Parsing::Standard::StringField.new(
+              prediction['city_state_zip'],
+              page_id
+            )
+            @ein = Parsing::Standard::StringField.new(prediction['ein'], page_id)
+            @name = Parsing::Standard::StringField.new(prediction['name'], page_id)
+            @signature_date_position = Parsing::Standard::PositionField.new(
+              prediction['signature_date_position'],
+              page_id
+            )
+            @signature_position = Parsing::Standard::PositionField.new(
+              prediction['signature_position'],
+              page_id
+            )
+            @ssn = Parsing::Standard::StringField.new(prediction['ssn'], page_id)
+            @tax_classification = Parsing::Standard::StringField.new(
+              prediction['tax_classification'],
+              page_id
+            )
+            @tax_classification_llc = Parsing::Standard::StringField.new(
+              prediction['tax_classification_llc'],
+              page_id
+            )
+            @tax_classification_other_details = Parsing::Standard::StringField.new(
+              prediction['tax_classification_other_details'],
+              page_id
+            )
+            @w9_revision_date = Parsing::Standard::StringField.new(
+              prediction['w9_revision_date'],
+              page_id
+            )
+            super
           end
 
           # @return [String]

data/lib/mindee/product.rb

@@ -3,15 +3,13 @@
 require_relative 'product/barcode_reader/barcode_reader_v1'
 require_relative 'product/bill_of_lading/bill_of_lading_v1'
 require_relative 'product/business_card/business_card_v1'
-require_relative 'product/custom/custom_v1'
 require_relative 'product/cropper/cropper_v1'
 require_relative 'product/delivery_note/delivery_note_v1'
 require_relative 'product/driver_license/driver_license_v1'
 require_relative 'product/eu/license_plate/license_plate_v1'
-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/bank_statement/bank_statement_v2'
 require_relative 'product/fr/carte_grise/carte_grise_v1'
 require_relative 'product/fr/id_card/id_card_v1'
 require_relative 'product/fr/id_card/id_card_v2'
@@ -20,7 +18,6 @@ require_relative 'product/fr/health_card/health_card_v1'
 require_relative 'product/fr/payslip/payslip_v2'
 require_relative 'product/fr/payslip/payslip_v3'
 require_relative 'product/financial_document/financial_document_v1'
-require_relative 'product/generated/generated_v1'
 require_relative 'product/ind/indian_passport/indian_passport_v1'
 require_relative 'product/invoice/invoice_v4'
 require_relative 'product/invoice_splitter/invoice_splitter_v1'
@@ -28,13 +25,10 @@ require_relative 'product/international_id/international_id_v2'
 require_relative 'product/multi_receipts_detector/multi_receipts_detector_v1'
 require_relative 'product/nutrition_facts_label/nutrition_facts_label_v1'
 require_relative 'product/passport/passport_v1'
-require_relative 'product/proof_of_address/proof_of_address_v1'
-require_relative 'product/receipt/receipt_v4'
 require_relative 'product/receipt/receipt_v5'
 require_relative 'product/resume/resume_v1'
+require_relative 'product/universal/universal'
 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/us_mail/us_mail_v3'
 require_relative 'product/us/w9/w9_v1'

data/lib/mindee/version.rb

@@ -3,10 +3,10 @@
 # Mindee
 module Mindee
   # Current version.
-  VERSION = '3.19.1'
+  VERSION = '4.0.0'
 
   # Finds and return the current platform.
-  # @return [String]
+  # @return [Symbol, Hash[Symbol | String, Regexp], Nil?]
   def self.find_platform
     host = RbConfig::CONFIG['host_os']
     platforms = {

data/lib/mindee.rb

@@ -1,9 +1,17 @@
 # frozen_string_literal: true
 
 require 'mindee/client'
-require 'mindee/extraction'
+require 'mindee/logging'
 
 module Mindee
+  # Mindee internal error module.
+  module Errors
+  end
+
+  # Custom extraction module
+  module Extraction
+  end
+
   # Mindee internal http module.
   module HTTP
   end
@@ -29,8 +37,8 @@ module Mindee
     end
   end
 
-  # Custom extraction module
-  module Extraction
+  # Logging
+  module Logging
   end
 
   # Parsing internals and fields.
@@ -39,16 +47,12 @@ module Mindee
     module Common
     end
 
-    # Custom fields and functions.
-    module Custom
-    end
-
     # Standard fields and functions.
     module Standard
     end
 
-    # Generated fields and functions.
-    module Generated
+    # Universal fields and functions.
+    module Universal
     end
   end
 
@@ -66,8 +70,17 @@ module Mindee
     module FR
     end
 
+    # Indian-specific products.
+    module IND
+    end
+
     # US-specific products.
     module US
     end
   end
 end
+
+# Shorthand to call the logger from anywhere.
+def logger
+  Mindee::Logging.logger
+end

data/mindee.gemspec

@@ -6,20 +6,18 @@ Gem::Specification.new do |spec|
   spec.name          = 'mindee'
   spec.version       = Mindee::VERSION
   spec.authors       = ['Mindee, SA']
-  spec.email         = ['devrel@mindee.co']
+  spec.email         = ['opensource@mindee.co']
 
   spec.summary       = 'Mindee API Helper Library for Ruby'
   spec.description   = "Quickly and easily connect to Mindee's API services using Ruby."
   spec.homepage      = 'https://github.com/mindee/mindee-api-ruby'
   spec.license       = 'MIT'
 
-  spec.metadata['homepage_uri'] = 'https://mindee.com/'
-  spec.metadata['source_code_uri'] = 'https://github.com/mindee/mindee-api-ruby'
-  spec.metadata['changelog_uri'] = 'https://github.com/mindee/mindee-api-ruby/blob/main/CHANGELOG.md'
+  spec.metadata['homepage_uri']      = 'https://mindee.com/'
+  spec.metadata['source_code_uri']   = 'https://github.com/mindee/mindee-api-ruby'
+  spec.metadata['changelog_uri']     = 'https://github.com/mindee/mindee-api-ruby/blob/main/CHANGELOG.md'
   spec.metadata['rubygems_mfa_required'] = 'true'
 
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(.github|spec|features)/}) }
   end
@@ -27,15 +25,19 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.required_ruby_version = Gem::Requirement.new('>= 2.6')
-
-  spec.add_runtime_dependency 'marcel', '~> 1.0.2'
-  spec.add_runtime_dependency 'mini_magick', '>=4', '< 6'
-  spec.add_runtime_dependency 'origamindee', '~> 3.1.0'
-  spec.add_runtime_dependency 'pdf-reader', '~> 2.12.0'
-
-  spec.add_development_dependency 'rake', '~> 12.3.3'
-  spec.add_development_dependency 'rspec', '~> 3.12.0'
-  spec.add_development_dependency 'rubocop', '~> 1.49.0'
-  spec.add_development_dependency 'yard', '~> 0.9.34'
+  spec.required_ruby_version = Gem::Requirement.new('>= 3.0')
+
+  spec.add_dependency 'base64', '~> 0.1.0'
+  spec.add_dependency 'marcel', '~> 1.0.4'
+  spec.add_dependency 'mini_magick', '>= 4', '< 6'
+  spec.add_dependency 'origamindee', '~> 4.0.0'
+  spec.add_dependency 'pdf-reader', '~> 2.13.0'
+
+  spec.add_development_dependency 'prism', '~> 1.3'
+  spec.add_development_dependency 'rake', '~> 13.2.1'
+  spec.add_development_dependency 'rbs', '~> 3.6'
+  spec.add_development_dependency 'rspec', '~> 3.13.0'
+  spec.add_development_dependency 'rubocop', '~> 1.70.0'
+  spec.add_development_dependency 'steep', '~> 1.7.1'
+  spec.add_development_dependency 'yard', '~> 0.9.37'
 end

data/sig/custom/marcel.rbs

@@ -0,0 +1,3 @@
+module Marcel
+  MimeType: untyped
+end

data/sig/custom/mini_magick.rbs

@@ -0,0 +1,24 @@
+# Stub for the mini_magick library.
+module MiniMagick
+  class Image
+    def format: (String, ?Integer?, ?Hash[Symbol, untyped]?) -> Net::BufferedIO
+    def self.format: (String, ?Integer?, ?Hash[Symbol, untyped]?) -> Net::BufferedIO
+    def self.quality: (String) -> Net::BufferedIO
+    def self.crop: (String) -> Net::BufferedIO
+    def self.height: () -> Integer
+    def height: () -> Integer
+    def self.width: () -> Integer
+    def width: () -> Integer
+    def self.read: (untyped) -> self
+    def self.resolution: () -> Array[Float | Integer]
+    def self.write: (StringIO | String) -> Net::BufferedIO
+    def write: (StringIO | String) -> Net::BufferedIO
+    def quality: (Integer) -> void
+    def self.resize: (String) -> void
+    def resize: (String) -> void
+    def self.to_blob: () -> String
+    def to_blob: () -> String
+    def self.[]: (?untyped) -> untyped
+    def []: (?untyped) -> untyped
+  end
+end