mindee 2.2.1 → 3.1.0

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

@@ -0,0 +1,149 @@
+# frozen_string_literal: true
+
+require_relative '../../parsing'
+require_relative 'receipt_v5_line_item'
+
+module Mindee
+  module Product
+    module Receipt
+      # Receipt V5 document prediction.
+      class ReceiptV5Document < Mindee::Parsing::Common::Prediction
+        include Mindee::Parsing::Standard
+        # The purchase category among predefined classes.
+        # @return [Mindee::Parsing::Standard::ClassificationField]
+        attr_reader :category
+        # The date the purchase was made.
+        # @return [Mindee::Parsing::Standard::DateField]
+        attr_reader :date
+        # One of: 'CREDIT CARD RECEIPT', 'EXPENSE RECEIPT'.
+        # @return [Mindee::Parsing::Standard::ClassificationField]
+        attr_reader :document_type
+        # List of line item details.
+        # @return [Array<Mindee::Product::Receipt::ReceiptV5LineItem>]
+        attr_reader :line_items
+        # The locale detected on the document.
+        # @return [Mindee::Parsing::Standard::Locale]
+        attr_reader :locale
+        # The purchase subcategory among predefined classes for transport and food.
+        # @return [Mindee::Parsing::Standard::ClassificationField]
+        attr_reader :subcategory
+        # The address of the supplier or merchant.
+        # @return [Mindee::Parsing::Standard::TextField]
+        attr_reader :supplier_address
+        # List of company registrations associated to the supplier.
+        # @return [Array<Mindee::Parsing::Standard::CompanyRegistration>]
+        attr_reader :supplier_company_registrations
+        # The name of the supplier or merchant.
+        # @return [Mindee::Parsing::Standard::TextField]
+        attr_reader :supplier_name
+        # The phone number of the supplier or merchant.
+        # @return [Mindee::Parsing::Standard::TextField]
+        attr_reader :supplier_phone_number
+        # List of tax lines information.
+        # @return [Mindee::Parsing::Standard::Taxes]
+        attr_reader :taxes
+        # The time the purchase was made.
+        # @return [Mindee::Parsing::Standard::TextField]
+        attr_reader :time
+        # The total amount of tip and gratuity.
+        # @return [Mindee::Parsing::Standard::AmountField]
+        attr_reader :tip
+        # The total amount paid: includes taxes, discounts, fees, tips, and gratuity.
+        # @return [Mindee::Parsing::Standard::AmountField]
+        attr_reader :total_amount
+        # The net amount paid: does not include taxes, fees, and discounts.
+        # @return [Mindee::Parsing::Standard::AmountField]
+        attr_reader :total_net
+        # The total amount of taxes.
+        # @return [Mindee::Parsing::Standard::AmountField]
+        attr_reader :total_tax
+
+        # @param prediction [Hash]
+        # @param page_id [Integer, nil]
+        def initialize(prediction, page_id)
+          super()
+          @category = ClassificationField.new(prediction['category'], page_id)
+          @date = DateField.new(prediction['date'], page_id)
+          @document_type = ClassificationField.new(prediction['document_type'], page_id)
+          @line_items = []
+          prediction['line_items'].each do |item|
+            @line_items.push(ReceiptV5LineItem.new(item, page_id))
+          end
+          @locale = Locale.new(prediction['locale'], page_id)
+          @subcategory = ClassificationField.new(prediction['subcategory'], page_id)
+          @supplier_address = TextField.new(prediction['supplier_address'], page_id)
+          @supplier_company_registrations = []
+          prediction['supplier_company_registrations'].each do |item|
+            @supplier_company_registrations.push(CompanyRegistration.new(item, page_id))
+          end
+          @supplier_name = TextField.new(prediction['supplier_name'], page_id)
+          @supplier_phone_number = TextField.new(prediction['supplier_phone_number'], page_id)
+          @taxes = Taxes.new(prediction['taxes'], page_id)
+          @time = TextField.new(prediction['time'], page_id)
+          @tip = AmountField.new(prediction['tip'], page_id)
+          @total_amount = AmountField.new(prediction['total_amount'], page_id)
+          @total_net = AmountField.new(prediction['total_net'], page_id)
+          @total_tax = AmountField.new(prediction['total_tax'], page_id)
+        end
+
+        # @return [String]
+        def to_s
+          supplier_company_registrations = @supplier_company_registrations.join("\n #{' ' * 32}")
+          line_items = line_items_to_s
+          out_str = String.new
+          out_str << "\n:Expense Locale: #{@locale}".rstrip
+          out_str << "\n:Purchase Category: #{@category}".rstrip
+          out_str << "\n:Purchase Subcategory: #{@subcategory}".rstrip
+          out_str << "\n:Document Type: #{@document_type}".rstrip
+          out_str << "\n:Purchase Date: #{@date}".rstrip
+          out_str << "\n:Purchase Time: #{@time}".rstrip
+          out_str << "\n:Total Amount: #{@total_amount}".rstrip
+          out_str << "\n:Total Net: #{@total_net}".rstrip
+          out_str << "\n:Total Tax: #{@total_tax}".rstrip
+          out_str << "\n:Tip and Gratuity: #{@tip}".rstrip
+          out_str << "\n:Taxes:#{@taxes}".rstrip
+          out_str << "\n:Supplier Name: #{@supplier_name}".rstrip
+          out_str << "\n:Supplier Company Registrations: #{supplier_company_registrations}".rstrip
+          out_str << "\n:Supplier Address: #{@supplier_address}".rstrip
+          out_str << "\n:Supplier Phone Number: #{@supplier_phone_number}".rstrip
+          out_str << "\n:Line Items:"
+          out_str << line_items
+          out_str[1..].to_s
+        end
+
+        private
+
+        # @param char [String]
+        # @return [String]
+        def line_items_separator(char)
+          out_str = String.new
+          out_str << '  '
+          out_str << "+#{char * 38}"
+          out_str << "+#{char * 10}"
+          out_str << "+#{char * 14}"
+          out_str << "+#{char * 12}"
+          out_str << '+'
+          out_str
+        end
+
+        # @return [String]
+        def line_items_to_s
+          return '' if @line_items.empty?
+
+          line_items = @line_items.map(&:to_table_line).join("\n#{line_items_separator('-')}\n  ")
+          out_str = String.new
+          out_str << "\n#{line_items_separator('-')}"
+          out_str << "\n  |"
+          out_str << ' Description                          |'
+          out_str << ' Quantity |'
+          out_str << ' Total Amount |'
+          out_str << ' Unit Price |'
+          out_str << "\n#{line_items_separator('=')}"
+          out_str << "\n  #{line_items}"
+          out_str << "\n#{line_items_separator('-')}"
+          out_str
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require_relative '../../parsing'
+
+module Mindee
+  module Product
+    module Receipt
+      # List of line item details.
+      class ReceiptV5LineItem < Mindee::Parsing::Standard::FeatureField
+        include Mindee::Parsing::Standard
+        # The item description.
+        # @return [String]
+        attr_reader :description
+        # The item quantity.
+        # @return [Float]
+        attr_reader :quantity
+        # The item total amount.
+        # @return [Float]
+        attr_reader :total_amount
+        # The item unit price.
+        # @return [Float]
+        attr_reader :unit_price
+
+        # @param prediction [Hash]
+        # @param page_id [Integer, nil]
+        def initialize(prediction, page_id)
+          super(prediction, page_id)
+          @description = prediction['description']
+          @quantity = prediction['quantity']
+          @total_amount = prediction['total_amount']
+          @unit_price = prediction['unit_price']
+          @page_id = page_id
+        end
+
+        # @return [Hash]
+        def printable_values
+          printable = {}
+          printable[:description] = format_for_display(@description, 36)
+          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 [String]
+        def to_table_line
+          printable = printable_values
+          out_str = String.new
+          out_str << format('| %- 37s', printable[:description])
+          out_str << format('| %- 9s', printable[:quantity])
+          out_str << format('| %- 13s', printable[:total_amount])
+          out_str << format('| %- 11s', printable[:unit_price])
+          out_str << '|'
+        end
+
+        # @return [String]
+        def to_s
+          printable = printable_values
+          out_str = String.new
+          out_str << "\n  :Description: #{printable[:description]}"
+          out_str << "\n  :Quantity: #{printable[:quantity]}"
+          out_str << "\n  :Total Amount: #{printable[:total_amount]}"
+          out_str << "\n  :Unit Price: #{printable[:unit_price]}"
+          out_str
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative '../../parsing'
+require_relative 'receipt_v5_document'
+
+module Mindee
+  module Product
+    module Receipt
+      # Receipt V5 page.
+      class ReceiptV5Page < Mindee::Parsing::Common::Page
+        # @param prediction [Hash]
+        def initialize(prediction)
+          super(prediction)
+          @prediction = ReceiptV5PagePrediction.new(
+            prediction['prediction'],
+            prediction['id']
+          )
+        end
+      end
+
+      # Receipt V5 page prediction.
+      class ReceiptV5PagePrediction < ReceiptV5Document
+        # @return [String]
+        def to_s
+          out_str = String.new
+          out_str << "\n#{super}"
+          out_str
+        end
+      end
+    end
+  end
+end

data/lib/mindee/product/us/bank_check/bank_check_v1.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative '../../../parsing'
+require_relative 'bank_check_v1_document'
+require_relative 'bank_check_v1_page'
+
+module Mindee
+  module Product
+    module US
+      module BankCheck
+        # Bank Check V1 prediction inference.
+        class BankCheckV1 < Mindee::Parsing::Common::Inference
+          @endpoint_name = 'bank_check'
+          @endpoint_version = '1'
+
+          # @param prediction [Hash]
+          def initialize(prediction)
+            super
+            @prediction = BankCheckV1Document.new(prediction['prediction'], nil)
+            @pages = []
+            prediction['pages'].each do |page|
+              @pages.push(BankCheckV1Page.new(page))
+            end
+          end
+
+          class << self
+            # Name of the endpoint for this product.
+            # @return [String]
+            attr_reader :endpoint_name
+            # Version for this product.
+            # @return [String]
+            attr_reader :endpoint_version
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mindee/product/us/bank_check/bank_check_v1_document.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require_relative '../../../parsing'
+
+module Mindee
+  module Product
+    module US
+      module BankCheck
+        # Bank Check V1 document prediction.
+        class BankCheckV1Document < Mindee::Parsing::Common::Prediction
+          include Mindee::Parsing::Standard
+          # The check payer's account number.
+          # @return [Mindee::Parsing::Standard::TextField]
+          attr_reader :account_number
+          # The amount of the check.
+          # @return [Mindee::Parsing::Standard::AmountField]
+          attr_reader :amount
+          # The issuer's check number.
+          # @return [Mindee::Parsing::Standard::TextField]
+          attr_reader :check_number
+          # The date the check was issued.
+          # @return [Mindee::Parsing::Standard::DateField]
+          attr_reader :date
+          # List of the check's payees (recipients).
+          # @return [Array<Mindee::Parsing::Standard::TextField>]
+          attr_reader :payees
+          # The check issuer's routing number.
+          # @return [Mindee::Parsing::Standard::TextField]
+          attr_reader :routing_number
+
+          # @param prediction [Hash]
+          # @param page_id [Integer, nil]
+          def initialize(prediction, page_id)
+            super()
+            @account_number = TextField.new(prediction['account_number'], page_id)
+            @amount = AmountField.new(prediction['amount'], page_id)
+            @check_number = TextField.new(prediction['check_number'], page_id)
+            @date = DateField.new(prediction['date'], page_id)
+            @payees = []
+            prediction['payees'].each do |item|
+              @payees.push(TextField.new(item, page_id))
+            end
+            @routing_number = TextField.new(prediction['routing_number'], page_id)
+          end
+
+          # @return [String]
+          def to_s
+            payees = @payees.join("\n #{' ' * 8}")
+            out_str = String.new
+            out_str << "\n:Check Issue Date: #{@date}".rstrip
+            out_str << "\n:Amount: #{@amount}".rstrip
+            out_str << "\n:Payees: #{payees}".rstrip
+            out_str << "\n:Routing Number: #{@routing_number}".rstrip
+            out_str << "\n:Account Number: #{@account_number}".rstrip
+            out_str << "\n:Check Number: #{@check_number}".rstrip
+            out_str[1..].to_s
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mindee/product/us/bank_check/bank_check_v1_page.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require_relative '../../../parsing'
+require_relative 'bank_check_v1_document'
+
+module Mindee
+  module Product
+    module US
+      module BankCheck
+        # Bank Check V1 page.
+        class BankCheckV1Page < Mindee::Parsing::Common::Page
+          # @param prediction [Hash]
+          def initialize(prediction)
+            super(prediction)
+            @prediction = BankCheckV1PagePrediction.new(
+              prediction['prediction'],
+              prediction['id']
+            )
+          end
+        end
+
+        # Bank Check V1 page prediction.
+        class BankCheckV1PagePrediction < BankCheckV1Document
+          include Mindee::Parsing::Standard
+
+          # The position of the check on the document.
+          # @return [Mindee::Parsing::Standard::PositionField]
+          attr_reader :check_position
+          # List of signature positions
+          # @return [Array<Mindee::Parsing::Standard::PositionField>]
+          attr_reader :signatures_positions
+
+          # @param prediction [Hash]
+          # @param page_id [Integer, nil]
+          def initialize(prediction, page_id)
+            @check_position = PositionField.new(prediction['check_position'], page_id)
+            @signatures_positions = []
+            prediction['signatures_positions'].each do |item|
+              @signatures_positions.push(PositionField.new(item, page_id))
+            end
+            super(prediction, page_id)
+          end
+
+          # @return [String]
+          def to_s
+            signatures_positions = @signatures_positions.join("\n #{' ' * 21}")
+            out_str = String.new
+            out_str << "\n:Check Position: #{@check_position}".rstrip
+            out_str << "\n:Signature Positions: #{signatures_positions}".rstrip
+            out_str << "\n#{super}"
+            out_str
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mindee/product/us/driver_license/driver_license_v1.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative '../../../parsing'
+require_relative 'driver_license_v1_document'
+require_relative 'driver_license_v1_page'
+
+module Mindee
+  module Product
+    module US
+      module DriverLicense
+        # Driver License V1 prediction inference.
+        class DriverLicenseV1 < Mindee::Parsing::Common::Inference
+          @endpoint_name = 'us_driver_license'
+          @endpoint_version = '1'
+
+          # @param prediction [Hash]
+          def initialize(prediction)
+            super
+            @prediction = DriverLicenseV1Document.new(prediction['prediction'], nil)
+            @pages = []
+            prediction['pages'].each do |page|
+              @pages.push(DriverLicenseV1Page.new(page))
+            end
+          end
+
+          class << self
+            # Name of the endpoint for this product.
+            # @return [String]
+            attr_reader :endpoint_name
+            # Version for this product.
+            # @return [String]
+            attr_reader :endpoint_version
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mindee/product/us/driver_license/driver_license_v1_document.rb

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+
+require_relative '../../../parsing'
+
+module Mindee
+  module Product
+    module US
+      module DriverLicense
+        # Driver License V1 document prediction.
+        class DriverLicenseV1Document < Mindee::Parsing::Common::Prediction
+          include Mindee::Parsing::Standard
+          # US driver license holders address
+          # @return [Mindee::Parsing::Standard::TextField]
+          attr_reader :address
+          # US driver license holders date of birth
+          # @return [Mindee::Parsing::Standard::DateField]
+          attr_reader :date_of_birth
+          # Document Discriminator Number of the US Driver License
+          # @return [Mindee::Parsing::Standard::TextField]
+          attr_reader :dd_number
+          # US driver license holders class
+          # @return [Mindee::Parsing::Standard::TextField]
+          attr_reader :dl_class
+          # ID number of the US Driver License.
+          # @return [Mindee::Parsing::Standard::TextField]
+          attr_reader :driver_license_id
+          # US driver license holders endorsements
+          # @return [Mindee::Parsing::Standard::TextField]
+          attr_reader :endorsements
+          # Date on which the documents expires.
+          # @return [Mindee::Parsing::Standard::DateField]
+          attr_reader :expiry_date
+          # US driver license holders eye colour
+          # @return [Mindee::Parsing::Standard::TextField]
+          attr_reader :eye_color
+          # US driver license holders first name(s)
+          # @return [Mindee::Parsing::Standard::TextField]
+          attr_reader :first_name
+          # US driver license holders hair colour
+          # @return [Mindee::Parsing::Standard::TextField]
+          attr_reader :hair_color
+          # US driver license holders hight
+          # @return [Mindee::Parsing::Standard::TextField]
+          attr_reader :height
+          # Date on which the documents was issued.
+          # @return [Mindee::Parsing::Standard::DateField]
+          attr_reader :issued_date
+          # US driver license holders last name
+          # @return [Mindee::Parsing::Standard::TextField]
+          attr_reader :last_name
+          # US driver license holders restrictions
+          # @return [Mindee::Parsing::Standard::TextField]
+          attr_reader :restrictions
+          # US driver license holders gender
+          # @return [Mindee::Parsing::Standard::TextField]
+          attr_reader :sex
+          # US State
+          # @return [Mindee::Parsing::Standard::TextField]
+          attr_reader :state
+          # US driver license holders weight
+          # @return [Mindee::Parsing::Standard::TextField]
+          attr_reader :weight
+
+          # @param prediction [Hash]
+          # @param page_id [Integer, nil]
+          def initialize(prediction, page_id)
+            super()
+            @address = TextField.new(prediction['address'], page_id)
+            @date_of_birth = DateField.new(prediction['date_of_birth'], page_id)
+            @dd_number = TextField.new(prediction['dd_number'], page_id)
+            @dl_class = TextField.new(prediction['dl_class'], page_id)
+            @driver_license_id = TextField.new(prediction['driver_license_id'], page_id)
+            @endorsements = TextField.new(prediction['endorsements'], page_id)
+            @expiry_date = DateField.new(prediction['expiry_date'], page_id)
+            @eye_color = TextField.new(prediction['eye_color'], page_id)
+            @first_name = TextField.new(prediction['first_name'], page_id)
+            @hair_color = TextField.new(prediction['hair_color'], page_id)
+            @height = TextField.new(prediction['height'], page_id)
+            @issued_date = DateField.new(prediction['issued_date'], page_id)
+            @last_name = TextField.new(prediction['last_name'], page_id)
+            @restrictions = TextField.new(prediction['restrictions'], page_id)
+            @sex = TextField.new(prediction['sex'], page_id)
+            @state = TextField.new(prediction['state'], page_id)
+            @weight = TextField.new(prediction['weight'], page_id)
+          end
+
+          # @return [String]
+          def to_s
+            out_str = String.new
+            out_str << "\n:State: #{@state}".rstrip
+            out_str << "\n:Driver License ID: #{@driver_license_id}".rstrip
+            out_str << "\n:Expiry Date: #{@expiry_date}".rstrip
+            out_str << "\n:Date Of Issue: #{@issued_date}".rstrip
+            out_str << "\n:Last Name: #{@last_name}".rstrip
+            out_str << "\n:First Name: #{@first_name}".rstrip
+            out_str << "\n:Address: #{@address}".rstrip
+            out_str << "\n:Date Of Birth: #{@date_of_birth}".rstrip
+            out_str << "\n:Restrictions: #{@restrictions}".rstrip
+            out_str << "\n:Endorsements: #{@endorsements}".rstrip
+            out_str << "\n:Driver License Class: #{@dl_class}".rstrip
+            out_str << "\n:Sex: #{@sex}".rstrip
+            out_str << "\n:Height: #{@height}".rstrip
+            out_str << "\n:Weight: #{@weight}".rstrip
+            out_str << "\n:Hair Color: #{@hair_color}".rstrip
+            out_str << "\n:Eye Color: #{@eye_color}".rstrip
+            out_str << "\n:Document Discriminator: #{@dd_number}".rstrip
+            out_str[1..].to_s
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mindee/product/us/driver_license/driver_license_v1_page.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require_relative '../../../parsing'
+require_relative 'driver_license_v1_document'
+
+module Mindee
+  module Product
+    module US
+      module DriverLicense
+        # Driver License V1 page.
+        class DriverLicenseV1Page < Mindee::Parsing::Common::Page
+          # @param prediction [Hash]
+          def initialize(prediction)
+            super(prediction)
+            @prediction = DriverLicenseV1PagePrediction.new(
+              prediction['prediction'],
+              prediction['id']
+            )
+          end
+        end
+
+        # Driver License V1 page prediction.
+        class DriverLicenseV1PagePrediction < DriverLicenseV1Document
+          include Mindee::Parsing::Standard
+
+          # Has a photo of the US driver license holder
+          # @return [Mindee::Parsing::Standard::PositionField]
+          attr_reader :photo
+          # Has a signature of the US driver license holder
+          # @return [Mindee::Parsing::Standard::PositionField]
+          attr_reader :signature
+
+          # @param prediction [Hash]
+          # @param page_id [Integer, nil]
+          def initialize(prediction, page_id)
+            @photo = PositionField.new(prediction['photo'], page_id)
+            @signature = PositionField.new(prediction['signature'], page_id)
+            super(prediction, page_id)
+          end
+
+          # @return [String]
+          def to_s
+            out_str = String.new
+            out_str << "\n:Photo: #{@photo}".rstrip
+            out_str << "\n:Signature: #{@signature}".rstrip
+            out_str << "\n#{super}"
+            out_str
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mindee/product.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+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/passport/passport_v1'
+require_relative 'product/receipt/receipt_v4'
+require_relative 'product/receipt/receipt_v5'
+require_relative 'product/eu/license_plate/license_plate_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/carte_vitale/carte_vitale_v1'
+require_relative 'product/fr/id_card/id_card_v1'
+require_relative 'product/invoice_splitter/invoice_splitter_v1'
+require_relative 'product/us/bank_check/bank_check_v1'
+require_relative 'product/us/driver_license/driver_license_v1'

data/lib/mindee/version.rb

@@ -2,8 +2,9 @@
 
 # Mindee
 module Mindee
-  VERSION = '2.2.1'
+  VERSION = '3.1.0'
 
+  # @return [String]
   def self.find_platform
     host = RbConfig::CONFIG['host_os']
     platforms = {

data/lib/mindee.rb

@@ -3,6 +3,8 @@
 require 'mindee/client'
 
 module Mindee
-  class Error < StandardError
+  module HTTP
+    class HttpError < StandardError
+    end
   end
 end