mindee 3.14.0 → 3.16.0

data/lib/mindee/product/delivery_note/delivery_note_v1_document.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require_relative '../../parsing'
+
+module Mindee
+  module Product
+    module DeliveryNote
+      # Delivery note API version 1.1 document data.
+      class DeliveryNoteV1Document < Mindee::Parsing::Common::Prediction
+        include Mindee::Parsing::Standard
+        # The address of the customer receiving the goods.
+        # @return [Mindee::Parsing::Standard::StringField]
+        attr_reader :customer_address
+        # The name of the customer receiving the goods.
+        # @return [Mindee::Parsing::Standard::StringField]
+        attr_reader :customer_name
+        # The date on which the delivery is scheduled to arrive.
+        # @return [Mindee::Parsing::Standard::DateField]
+        attr_reader :delivery_date
+        # A unique identifier for the delivery note.
+        # @return [Mindee::Parsing::Standard::StringField]
+        attr_reader :delivery_number
+        # The address of the supplier providing the goods.
+        # @return [Mindee::Parsing::Standard::StringField]
+        attr_reader :supplier_address
+        # The name of the supplier providing the goods.
+        # @return [Mindee::Parsing::Standard::StringField]
+        attr_reader :supplier_name
+        # The total monetary value of the goods being delivered.
+        # @return [Mindee::Parsing::Standard::AmountField]
+        attr_reader :total_amount
+
+        # @param prediction [Hash]
+        # @param page_id [Integer, nil]
+        def initialize(prediction, page_id)
+          super()
+          @customer_address = StringField.new(prediction['customer_address'], page_id)
+          @customer_name = StringField.new(prediction['customer_name'], page_id)
+          @delivery_date = DateField.new(prediction['delivery_date'], page_id)
+          @delivery_number = StringField.new(prediction['delivery_number'], page_id)
+          @supplier_address = StringField.new(prediction['supplier_address'], page_id)
+          @supplier_name = StringField.new(prediction['supplier_name'], page_id)
+          @total_amount = AmountField.new(prediction['total_amount'], page_id)
+        end
+
+        # @return [String]
+        def to_s
+          out_str = String.new
+          out_str << "\n:Delivery Date: #{@delivery_date}".rstrip
+          out_str << "\n:Delivery Number: #{@delivery_number}".rstrip
+          out_str << "\n:Supplier Name: #{@supplier_name}".rstrip
+          out_str << "\n:Supplier Address: #{@supplier_address}".rstrip
+          out_str << "\n:Customer Name: #{@customer_name}".rstrip
+          out_str << "\n:Customer Address: #{@customer_address}".rstrip
+          out_str << "\n:Total Amount: #{@total_amount}".rstrip
+          out_str[1..].to_s
+        end
+      end
+    end
+  end
+end

data/lib/mindee/product/delivery_note/delivery_note_v1_page.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative '../../parsing'
+require_relative 'delivery_note_v1_document'
+
+module Mindee
+  module Product
+    module DeliveryNote
+      # Delivery note API version 1.1 page data.
+      class DeliveryNoteV1Page < Mindee::Parsing::Common::Page
+        # @param prediction [Hash]
+        def initialize(prediction)
+          super(prediction)
+          @prediction = DeliveryNoteV1PagePrediction.new(
+            prediction['prediction'],
+            prediction['id']
+          )
+        end
+      end
+
+      # Delivery note V1 page prediction.
+      class DeliveryNoteV1PagePrediction < DeliveryNoteV1Document
+        # @return [String]
+        def to_s
+          out_str = String.new
+          out_str << "\n#{super}"
+          out_str
+        end
+      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.10 document data.
+      # Financial Document API version 1.11 document data.
       class FinancialDocumentV1Document < Mindee::Parsing::Common::Prediction
         include Mindee::Parsing::Standard
         # The customer's address used for billing.

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.10 page data.
+      # Financial Document API version 1.11 page data.
       class FinancialDocumentV1Page < Mindee::Parsing::Common::Page
         # @param prediction [Hash]
         def initialize(prediction)

data/lib/mindee/product/ind/indian_passport/indian_passport_v1.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require_relative '../../../parsing'
+require_relative 'indian_passport_v1_document'
+require_relative 'indian_passport_v1_page'
+
+module Mindee
+  module Product
+    module IND
+      # Passport - India module.
+      module IndianPassport
+        # Passport - India API version 1 inference prediction.
+        class IndianPassportV1 < Mindee::Parsing::Common::Inference
+          @endpoint_name = 'ind_passport'
+          @endpoint_version = '1'
+
+          # @param prediction [Hash]
+          def initialize(prediction)
+            super
+            @prediction = IndianPassportV1Document.new(prediction['prediction'], nil)
+            @pages = []
+            prediction['pages'].each do |page|
+              if page.key?('prediction') && !page['prediction'].nil? && !page['prediction'].empty?
+                @pages.push(IndianPassportV1Page.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/ind/indian_passport/indian_passport_v1_document.rb

@@ -0,0 +1,143 @@
+# frozen_string_literal: true
+
+require_relative '../../../parsing'
+
+module Mindee
+  module Product
+    module IND
+      module IndianPassport
+        # Passport - India API version 1.0 document data.
+        class IndianPassportV1Document < Mindee::Parsing::Common::Prediction
+          include Mindee::Parsing::Standard
+          # The first line of the address of the passport holder.
+          # @return [Mindee::Parsing::Standard::StringField]
+          attr_reader :address1
+          # The second line of the address of the passport holder.
+          # @return [Mindee::Parsing::Standard::StringField]
+          attr_reader :address2
+          # The third line of the address of the passport holder.
+          # @return [Mindee::Parsing::Standard::StringField]
+          attr_reader :address3
+          # The birth date of the passport holder, ISO format: YYYY-MM-DD.
+          # @return [Mindee::Parsing::Standard::DateField]
+          attr_reader :birth_date
+          # The birth place of the passport holder.
+          # @return [Mindee::Parsing::Standard::StringField]
+          attr_reader :birth_place
+          # ISO 3166-1 alpha-3 country code (3 letters format).
+          # @return [Mindee::Parsing::Standard::StringField]
+          attr_reader :country
+          # The date when the passport will expire, ISO format: YYYY-MM-DD.
+          # @return [Mindee::Parsing::Standard::DateField]
+          attr_reader :expiry_date
+          # The file number of the passport document.
+          # @return [Mindee::Parsing::Standard::StringField]
+          attr_reader :file_number
+          # The gender of the passport holder.
+          # @return [Mindee::Parsing::Standard::ClassificationField]
+          attr_reader :gender
+          # The given names of the passport holder.
+          # @return [Mindee::Parsing::Standard::StringField]
+          attr_reader :given_names
+          # The identification number of the passport document.
+          # @return [Mindee::Parsing::Standard::StringField]
+          attr_reader :id_number
+          # The date when the passport was issued, ISO format: YYYY-MM-DD.
+          # @return [Mindee::Parsing::Standard::DateField]
+          attr_reader :issuance_date
+          # The place where the passport was issued.
+          # @return [Mindee::Parsing::Standard::StringField]
+          attr_reader :issuance_place
+          # The name of the legal guardian of the passport holder (if applicable).
+          # @return [Mindee::Parsing::Standard::StringField]
+          attr_reader :legal_guardian
+          # The first line of the machine-readable zone (MRZ) of the passport document.
+          # @return [Mindee::Parsing::Standard::StringField]
+          attr_reader :mrz1
+          # The second line of the machine-readable zone (MRZ) of the passport document.
+          # @return [Mindee::Parsing::Standard::StringField]
+          attr_reader :mrz2
+          # The name of the mother of the passport holder.
+          # @return [Mindee::Parsing::Standard::StringField]
+          attr_reader :name_of_mother
+          # The name of the spouse of the passport holder (if applicable).
+          # @return [Mindee::Parsing::Standard::StringField]
+          attr_reader :name_of_spouse
+          # The date of issue of the old passport (if applicable), ISO format: YYYY-MM-DD.
+          # @return [Mindee::Parsing::Standard::DateField]
+          attr_reader :old_passport_date_of_issue
+          # The number of the old passport (if applicable).
+          # @return [Mindee::Parsing::Standard::StringField]
+          attr_reader :old_passport_number
+          # The place of issue of the old passport (if applicable).
+          # @return [Mindee::Parsing::Standard::StringField]
+          attr_reader :old_passport_place_of_issue
+          # The page number of the passport document.
+          # @return [Mindee::Parsing::Standard::ClassificationField]
+          attr_reader :page_number
+          # 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()
+            @address1 = StringField.new(prediction['address1'], page_id)
+            @address2 = StringField.new(prediction['address2'], page_id)
+            @address3 = StringField.new(prediction['address3'], page_id)
+            @birth_date = DateField.new(prediction['birth_date'], page_id)
+            @birth_place = StringField.new(prediction['birth_place'], page_id)
+            @country = StringField.new(prediction['country'], page_id)
+            @expiry_date = DateField.new(prediction['expiry_date'], page_id)
+            @file_number = StringField.new(prediction['file_number'], page_id)
+            @gender = ClassificationField.new(prediction['gender'], page_id)
+            @given_names = StringField.new(prediction['given_names'], page_id)
+            @id_number = StringField.new(prediction['id_number'], page_id)
+            @issuance_date = DateField.new(prediction['issuance_date'], page_id)
+            @issuance_place = StringField.new(prediction['issuance_place'], page_id)
+            @legal_guardian = StringField.new(prediction['legal_guardian'], page_id)
+            @mrz1 = StringField.new(prediction['mrz1'], page_id)
+            @mrz2 = StringField.new(prediction['mrz2'], page_id)
+            @name_of_mother = StringField.new(prediction['name_of_mother'], page_id)
+            @name_of_spouse = StringField.new(prediction['name_of_spouse'], page_id)
+            @old_passport_date_of_issue = DateField.new(prediction['old_passport_date_of_issue'], page_id)
+            @old_passport_number = StringField.new(prediction['old_passport_number'], page_id)
+            @old_passport_place_of_issue = StringField.new(prediction['old_passport_place_of_issue'], page_id)
+            @page_number = ClassificationField.new(prediction['page_number'], page_id)
+            @surname = StringField.new(prediction['surname'], page_id)
+          end
+
+          # @return [String]
+          def to_s
+            out_str = String.new
+            out_str << "\n:Page Number: #{@page_number}".rstrip
+            out_str << "\n:Country: #{@country}".rstrip
+            out_str << "\n:ID Number: #{@id_number}".rstrip
+            out_str << "\n:Given Names: #{@given_names}".rstrip
+            out_str << "\n:Surname: #{@surname}".rstrip
+            out_str << "\n:Birth Date: #{@birth_date}".rstrip
+            out_str << "\n:Birth Place: #{@birth_place}".rstrip
+            out_str << "\n:Issuance Place: #{@issuance_place}".rstrip
+            out_str << "\n:Gender: #{@gender}".rstrip
+            out_str << "\n:Issuance Date: #{@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 << "\n:Legal Guardian: #{@legal_guardian}".rstrip
+            out_str << "\n:Name of Spouse: #{@name_of_spouse}".rstrip
+            out_str << "\n:Name of Mother: #{@name_of_mother}".rstrip
+            out_str << "\n:Old Passport Date of Issue: #{@old_passport_date_of_issue}".rstrip
+            out_str << "\n:Old Passport Number: #{@old_passport_number}".rstrip
+            out_str << "\n:Address Line 1: #{@address1}".rstrip
+            out_str << "\n:Address Line 2: #{@address2}".rstrip
+            out_str << "\n:Address Line 3: #{@address3}".rstrip
+            out_str << "\n:Old Passport Place of Issue: #{@old_passport_place_of_issue}".rstrip
+            out_str << "\n:File Number: #{@file_number}".rstrip
+            out_str[1..].to_s
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mindee/product/ind/indian_passport/indian_passport_v1_page.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative '../../../parsing'
+require_relative 'indian_passport_v1_document'
+
+module Mindee
+  module Product
+    module IND
+      module IndianPassport
+        # Passport - India API version 1.0 page data.
+        class IndianPassportV1Page < Mindee::Parsing::Common::Page
+          # @param prediction [Hash]
+          def initialize(prediction)
+            super(prediction)
+            @prediction = IndianPassportV1PagePrediction.new(
+              prediction['prediction'],
+              prediction['id']
+            )
+          end
+        end
+
+        # Passport - India V1 page prediction.
+        class IndianPassportV1PagePrediction < IndianPassportV1Document
+          # @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/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.8 document data.
+      # Invoice API version 4.9 document data.
       class InvoiceV4Document < Mindee::Parsing::Common::Prediction
         include Mindee::Parsing::Standard
         # The customer's address used for billing.

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

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

@@ -10,7 +10,7 @@ require_relative 'resume_v1_certificate'
 module Mindee
   module Product
     module Resume
-      # Resume API version 1.0 document data.
+      # Resume API version 1.1 document data.
       class ResumeV1Document < Mindee::Parsing::Common::Prediction
         include Mindee::Parsing::Standard
         # The location information of the candidate, including city, state, and country.
@@ -252,6 +252,7 @@ module Mindee
           out_str << '  '
           out_str << "+#{char * 17}"
           out_str << "+#{char * 12}"
+          out_str << "+#{char * 38}"
           out_str << "+#{char * 27}"
           out_str << "+#{char * 11}"
           out_str << "+#{char * 10}"
@@ -274,6 +275,7 @@ module Mindee
           out_str << "\n  |"
           out_str << ' Contract Type   |'
           out_str << ' Department |'
+          out_str << ' Description                          |'
           out_str << ' Employer                  |'
           out_str << ' End Month |'
           out_str << ' End Year |'

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

@@ -6,7 +6,7 @@ require_relative 'resume_v1_document'
 module Mindee
   module Product
     module Resume
-      # Resume API version 1.0 page data.
+      # Resume API version 1.1 page data.
       class ResumeV1Page < Mindee::Parsing::Common::Page
         # @param prediction [Hash]
         def initialize(prediction)

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

@@ -14,6 +14,9 @@ module Mindee
         # The specific department or division within the company.
         # @return [String]
         attr_reader :department
+        # The description of the professional experience as written in the document.
+        # @return [String]
+        attr_reader :description
         # The name of the company or organization.
         # @return [String]
         attr_reader :employer
@@ -39,6 +42,7 @@ module Mindee
           super(prediction, page_id)
           @contract_type = prediction['contract_type']
           @department = prediction['department']
+          @description = prediction['description']
           @employer = prediction['employer']
           @end_month = prediction['end_month']
           @end_year = prediction['end_year']
@@ -53,6 +57,7 @@ module Mindee
           printable = {}
           printable[:contract_type] = format_for_display(@contract_type)
           printable[:department] = format_for_display(@department)
+          printable[:description] = format_for_display(@description)
           printable[:employer] = format_for_display(@employer)
           printable[:end_month] = format_for_display(@end_month)
           printable[:end_year] = format_for_display(@end_year)
@@ -67,6 +72,7 @@ module Mindee
           printable = {}
           printable[:contract_type] = format_for_display(@contract_type, 15)
           printable[:department] = format_for_display(@department, 10)
+          printable[:description] = format_for_display(@description, 36)
           printable[:employer] = format_for_display(@employer, 25)
           printable[:end_month] = format_for_display(@end_month, nil)
           printable[:end_year] = format_for_display(@end_year, nil)
@@ -82,6 +88,7 @@ module Mindee
           out_str = String.new
           out_str << format('| %- 16s', printable[:contract_type])
           out_str << format('| %- 11s', printable[:department])
+          out_str << format('| %- 37s', printable[:description])
           out_str << format('| %- 26s', printable[:employer])
           out_str << format('| %- 10s', printable[:end_month])
           out_str << format('| %- 9s', printable[:end_year])
@@ -97,6 +104,7 @@ module Mindee
           out_str = String.new
           out_str << "\n  :Contract Type: #{printable[:contract_type]}"
           out_str << "\n  :Department: #{printable[:department]}"
+          out_str << "\n  :Description: #{printable[:description]}"
           out_str << "\n  :Employer: #{printable[:employer]}"
           out_str << "\n  :End Month: #{printable[:end_month]}"
           out_str << "\n  :End Year: #{printable[:end_year]}"

data/lib/mindee/product.rb

@@ -2,15 +2,10 @@
 
 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/proof_of_address/proof_of_address_v1'
-require_relative 'product/financial_document/financial_document_v1'
-require_relative 'product/invoice/invoice_v4'
 require_relative 'product/cropper/cropper_v1'
-require_relative 'product/multi_receipts_detector/multi_receipts_detector_v1'
-require_relative 'product/passport/passport_v1'
-require_relative 'product/receipt/receipt_v4'
-require_relative 'product/receipt/receipt_v5'
+require_relative 'product/delivery_note/delivery_note_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'
@@ -22,11 +17,19 @@ require_relative 'product/fr/id_card/id_card_v1'
 require_relative 'product/fr/id_card/id_card_v2'
 require_relative 'product/fr/energy_bill/energy_bill_v1'
 require_relative 'product/fr/payslip/payslip_v2'
+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'
 require_relative 'product/international_id/international_id_v1'
 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/us/bank_check/bank_check_v1'
 require_relative 'product/us/driver_license/driver_license_v1'

data/lib/mindee/version.rb

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

data/lib/mindee.rb

@@ -19,6 +19,16 @@ module Mindee
     end
   end
 
+  module Image
+    # Miscellaneous image operations.
+    module ImageUtils
+    end
+
+    # Image compressor module to handle image compression.
+    module ImageCompressor
+    end
+  end
+
   # Custom extraction module
   module Extraction
   end

data/mindee.gemspec

@@ -30,8 +30,9 @@ 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 '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'