mindee 3.0.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c81762ec2e42847a182b6b864355ba0268ad22995c24b361e54fd5380f8191f3
-  data.tar.gz: 771736fbe9d28b5d7a91c7cfee9a687da116f176c8226f866ab8bf175cab7b7f
+  metadata.gz: c9ab3a3a82fc00bfcd0519d528c231face1134d38b3935dad152773cdb051422
+  data.tar.gz: a1a81837382eed829d5d413408a6f5cdc7bc6fbab1fcc0e4d87fde2673f957e7
 SHA512:
-  metadata.gz: 145a65bda997dc06a3ffafee6123d38195f66e6907c74097efca1a7d5bec9c8d70c041a7a58428e24be22a4850ff36e994a92024252735a815180032fe89f7a5
-  data.tar.gz: 605b1a9b1ffa2c0948581632eeca05e6462ce7f2280281740255183659648c7feb56ace62ec466cb69716f199a6a6467d4c5f1fa27e304fd83899b9a4dcfb2d9
+  metadata.gz: 34807307fe16dadbe2f4aa5e5bebdd8c14f7a1b43ffc6655f0f617fc0255e2cca070f27c53649f6b5f9a0c39c215c184ea48f62da369c17730a1a9c9ae026d4c
+  data.tar.gz: a0b61030ee533e949359516b440021ac4194440b4f138bb67d2aaf99dab86ad740523237677fd12d1be4a27409948802fe32a7c6e9ca1f37f06b29f2453c1872

data/CHANGELOG.md

@@ -1,8 +1,19 @@
 # Mindee Ruby API Library Changelog
 
+## v3.1.0 - 2023-08-08
+### Changes
+* :sparkles: add support for US Driver License
+* :recycle: update unit tests & dependencies
+* :arrow_up: update Bank Checks (#46)
+
+### Fixes
+* :bug: fix `all_words` display (#47)
+* :bug: fix empty `position_field` (#47)
+* :bug: fix byte repacking issues for PDF files (#45)
+
+
 ## v3.0.0 - 2023-06-29
 ### ¡Breaking Changes!
-
 * :boom: update `Client` creation & document upload
 * :boom: update custom `Endpoint` creation syntax
 * :art: improve product class syntax & structure
@@ -11,7 +22,6 @@
 * :art: separated common, standard & custom parsing features into their own modules
 
 ### Changes
-
 * :sparkles: add support for asynchronous endpoints
 * :sparkles: add support for Invoice Splitter V1
 * :sparkles: add support for OCR Full-text parsing on compatible APIs
@@ -26,7 +36,6 @@
 * :recycle: rewrite tutorials to match new syntax
 
 ### Fixes
-
 * :bug: fix: pages now use the proper `orientation` property
 * :zap: optimize: only a single endpoint is now created on document upload
 

data/docs/code_samples/carte_vitale_v1.txt

@@ -16,4 +16,4 @@ result = mindee_client.parse(
 puts result.document
 
 # Print the document-level parsed data
-# puts result.document.inference.prediction
+# puts result.document.inference.prediction

data/docs/code_samples/us_driver_license_v1.txt

@@ -0,0 +1,19 @@
+require 'mindee'
+
+# Init a new client
+mindee_client = Mindee::Client.new(api_key: 'my-api-key')
+
+# Load a file from disk
+input_source = mindee_client.source_from_path('/path/to/the/file.ext')
+
+# Parse the file
+result = mindee_client.parse(
+  input_source,
+  Mindee::Product::US::DriverLicense::DriverLicenseV1
+)
+
+# Print a full summary of the parsed data in RST format
+puts result.document
+
+# Print the document-level parsed data
+# puts result.document.inference.prediction

data/lib/mindee/http/endpoint.rb

@@ -97,13 +97,9 @@ module Mindee
         }
         req = Net::HTTP::Post.new(uri, headers)
         form_data = if input_source.is_a?(Mindee::Input::Source::UrlInputSource)
-                      {
-                        'document' => input_source.url,
-                      }
+                      [['document', input_source.url]]
                     else
-                      {
-                        'document' => input_source.read_document(close: close_file),
-                      }
+                      [input_source.read_document(close: close_file)]
                     end
         form_data.push ['include_mvision', 'true'] if all_words
 
@@ -132,13 +128,9 @@ module Mindee
         }
         req = Net::HTTP::Post.new(uri, headers)
         form_data = if input_source.is_a?(Mindee::Input::Source::UrlInputSource)
-                      {
-                        'document' => input_source.url,
-                      }
+                      [['document', input_source.url]]
                     else
-                      {
-                        'document' => input_source.read_document(close: close_file),
-                      }
+                      [input_source.read_document(close: close_file)]
                     end
         form_data.push ['include_mvision', 'true'] if all_words
 

data/lib/mindee/input/sources.rb

@@ -38,7 +38,7 @@ module Mindee
         end
 
         def pdf?
-          @file_mimetype == 'application/pdf'
+          @file_mimetype.to_s == 'application/pdf'
         end
 
         def process_pdf(options)
@@ -49,9 +49,12 @@ module Mindee
         # @param close [Boolean]
         def read_document(close: true)
           @io_stream.seek(0)
+          # Avoids needlessly re-packing some files
           data = @io_stream.read
           @io_stream.close if close
-          [data].pack('m')
+          return ['document', data, { filename: @filename }] if pdf?
+
+          ['document', [data].pack('m'), { filename: @filename }]
         end
       end
 

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

@@ -22,7 +22,7 @@ module Mindee
           ocr_prediction = http_response.fetch('ocr', nil)
           return nil if ocr_prediction.nil? || ocr_prediction.fetch('mvision-v1', nil).nil?
 
-          Ocr(ocr_prediction)
+          Ocr::Ocr.new(ocr_prediction)
         end
 
         # @param product_class [Class<Mindee::Product>]

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

@@ -19,7 +19,9 @@ module Mindee
         # @param prediction [Hash]
         # @param page_id [Integer, nil]
         def initialize(prediction, page_id)
-          @polygon = Geometry.polygon_from_prediction(prediction['polygon']) unless prediction['polygon'].empty?
+          unless prediction['polygon'].nil? || prediction['polygon'].empty?
+            @polygon = Geometry.polygon_from_prediction(prediction['polygon'])
+          end
           @quadrangle = to_quadrilateral(prediction, 'quadrangle')
           @rectangle = to_quadrilateral(prediction, 'rectangle')
           @bounding_box = to_quadrilateral(prediction, 'bounding_box')
@@ -30,13 +32,14 @@ module Mindee
         # @return [String]
         def to_s
           out_str = String.new
-          out_str << "Polygon with #{@polygon.size} points."
+          out_str << "Polygon with #{@polygon.size} points." if @polygon
+          out_str
         end
 
         private
 
         def to_quadrilateral(prediction, key)
-          Geometry.quadrilateral_from_prediction(prediction[key]) unless prediction[key].empty?
+          Geometry.quadrilateral_from_prediction(prediction[key]) unless prediction[key].nil? || prediction[key].empty?
         end
       end
     end

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

@@ -160,10 +160,23 @@ module Mindee
 
         private
 
+        # @param char [String]
+        # @return [String]
         def line_items_separator(char)
-          "  +#{char * 38}+#{char * 14}+#{char * 10}+#{char * 12}+#{char * 14}+#{char * 14}+#{char * 12}+"
+          out_str = String.new
+          out_str << '  '
+          out_str << "+#{char * 38}"
+          out_str << "+#{char * 14}"
+          out_str << "+#{char * 10}"
+          out_str << "+#{char * 12}"
+          out_str << "+#{char * 14}"
+          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?
 
@@ -181,6 +194,7 @@ module Mindee
           out_str << "\n#{line_items_separator('=')}"
           out_str << "\n  #{line_items}"
           out_str << "\n#{line_items_separator('-')}"
+          out_str
         end
       end
     end

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

@@ -75,14 +75,14 @@ module Mindee
         def to_s
           printable = printable_values
           out_str = String.new
-          out_str << printable[:description]
-          out_str << printable[:product_code]
-          out_str << printable[:quantity]
-          out_str << printable[:tax_amount]
-          out_str << printable[:tax_rate]
-          out_str << printable[:total_amount]
-          out_str << printable[:unit_price]
-          out_str.strip
+          out_str << "\n  :Description: #{printable[:description]}"
+          out_str << "\n  :Product code: #{printable[:product_code]}"
+          out_str << "\n  :Quantity: #{printable[:quantity]}"
+          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 Price: #{printable[:unit_price]}"
+          out_str
         end
       end
     end

data/lib/mindee/product/fr/bank_account_details/bank_account_details_v2_document.rb

@@ -35,7 +35,7 @@ module Mindee
 
           # @return [String]
           def to_s
-            bban = bban_to_s
+            bban = @bban.to_s
             out_str = String.new
             out_str << "\n:Account Holder's Names: #{@account_holders_names}".rstrip
             out_str << "\n:Basic Bank Account Number:"
@@ -44,13 +44,6 @@ module Mindee
             out_str << "\n:SWIFT Code: #{@swift_code}".rstrip
             out_str[1..].to_s
           end
-
-          private
-
-          # @return [String]
-          def bban_to_s
-            @bban.to_s
-          end
         end
       end
     end

data/lib/mindee/product/passport/passport_v1.rb

@@ -7,7 +7,7 @@ require_relative 'passport_v1_page'
 module Mindee
   module Product
     module Passport
-      # International Passport V1 prediction inference.
+      # Passport V1 prediction inference.
       class PassportV1 < Mindee::Parsing::Common::Inference
         @endpoint_name = 'passport'
         @endpoint_version = '1'

data/lib/mindee/product/passport/passport_v1_document.rb

@@ -5,7 +5,7 @@ require_relative '../../parsing'
 module Mindee
   module Product
     module Passport
-      # International Passport V1 document prediction.
+      # Passport V1 document prediction.
       class PassportV1Document < Mindee::Parsing::Common::Prediction
         include Mindee::Parsing::Standard
         # The date of birth of the passport holder.

data/lib/mindee/product/passport/passport_v1_page.rb

@@ -6,7 +6,7 @@ require_relative 'passport_v1_document'
 module Mindee
   module Product
     module Passport
-      # International Passport V1 page.
+      # Passport V1 page.
       class PassportV1Page < Mindee::Parsing::Common::Page
         # @param prediction [Hash]
         def initialize(prediction)
@@ -18,7 +18,7 @@ module Mindee
         end
       end
 
-      # International Passport V1 page prediction.
+      # Passport V1 page prediction.
       class PassportV1PagePrediction < PassportV1Document
         # @return [String]
         def to_s

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

@@ -7,7 +7,7 @@ require_relative 'receipt_v5_page'
 module Mindee
   module Product
     module Receipt
-      # Expense Receipt V5 prediction inference.
+      # Receipt V5 prediction inference.
       class ReceiptV5 < Mindee::Parsing::Common::Inference
         @endpoint_name = 'expense_receipts'
         @endpoint_version = '5'

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
-      # Expense Receipt V5 document prediction.
+      # Receipt V5 document prediction.
       class ReceiptV5Document < Mindee::Parsing::Common::Prediction
         include Mindee::Parsing::Standard
         # The purchase category among predefined classes.
@@ -113,10 +113,20 @@ module Mindee
 
         private
 
+        # @param char [String]
+        # @return [String]
         def line_items_separator(char)
-          "  +#{char * 38}+#{char * 10}+#{char * 14}+#{char * 12}+"
+          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?
 
@@ -131,6 +141,7 @@ module Mindee
           out_str << "\n#{line_items_separator('=')}"
           out_str << "\n  #{line_items}"
           out_str << "\n#{line_items_separator('-')}"
+          out_str
         end
       end
     end

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

@@ -57,11 +57,11 @@ module Mindee
         def to_s
           printable = printable_values
           out_str = String.new
-          out_str << printable[:description]
-          out_str << printable[:quantity]
-          out_str << printable[:total_amount]
-          out_str << printable[:unit_price]
-          out_str.strip
+          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

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

@@ -6,7 +6,7 @@ require_relative 'receipt_v5_document'
 module Mindee
   module Product
     module Receipt
-      # Expense Receipt V5 page.
+      # Receipt V5 page.
       class ReceiptV5Page < Mindee::Parsing::Common::Page
         # @param prediction [Hash]
         def initialize(prediction)
@@ -18,7 +18,7 @@ module Mindee
         end
       end
 
-      # Expense Receipt V5 page prediction.
+      # Receipt V5 page prediction.
       class ReceiptV5PagePrediction < ReceiptV5Document
         # @return [String]
         def to_s

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

@@ -8,7 +8,7 @@ module Mindee
   module Product
     module US
       module BankCheck
-        # Bank Check Inference
+        # Bank Check V1 prediction inference.
         class BankCheckV1 < Mindee::Parsing::Common::Inference
           @endpoint_name = 'bank_check'
           @endpoint_version = '1'

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

@@ -9,30 +9,24 @@ module Mindee
         # Bank Check V1 document prediction.
         class BankCheckV1Document < Mindee::Parsing::Common::Prediction
           include Mindee::Parsing::Standard
-          # Payer's bank account number.
-          # @return [Array<Mindee::Parsing::Standard::TextField>]
+          # The check payer's account number.
+          # @return [Mindee::Parsing::Standard::TextField]
           attr_reader :account_number
-          # Amount to be paid.
-          # @return [Array<Mindee::Parsing::Standard::AmountField>]
+          # The amount of the check.
+          # @return [Mindee::Parsing::Standard::AmountField]
           attr_reader :amount
-          # The check number.
+          # The issuer's check number.
           # @return [Mindee::Parsing::Standard::TextField]
           attr_reader :check_number
-          # Payer's bank account routing number.
-          # @return [Mindee::Parsing::Standard::TextField]
-          attr_reader :routing_number
-          # Date the check was issued.
+          # The date the check was issued.
           # @return [Mindee::Parsing::Standard::DateField]
           attr_reader :date
-          # The positions of the signatures on the image.
-          # @return [Array<Parsing::Standard::PositionField>]
-          attr_reader :signatures_positions
-          # Check's position in the image.
-          # @return [Parsing::Standard::PositionField]
-          attr_reader :check_position
-          # List of payees (full name or company name).
+          # 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]
@@ -42,28 +36,23 @@ module Mindee
             @amount = AmountField.new(prediction['amount'], page_id)
             @check_number = TextField.new(prediction['check_number'], page_id)
             @date = DateField.new(prediction['date'], page_id)
-            @check_position = PositionField.new(prediction['check_position'], page_id)
-            @routing_number = TextField.new(prediction['routing_number'], page_id)
-            @signatures_positions = []
-            prediction['signatures_positions'].each do |item|
-              @signatures_positions.push(PositionField.new(item, page_id))
-            end
             @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.map(&:value).join(', ')
+            payees = @payees.join("\n #{' ' * 8}")
             out_str = String.new
-            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 << "\n:Date: #{@date}".rstrip
+            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

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

@@ -21,9 +21,32 @@ module Mindee
 
         # 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

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

@@ -8,9 +8,10 @@ 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/us/bank_check/bank_check_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,7 +2,7 @@
 
 # Mindee
 module Mindee
-  VERSION = '3.0.0'
+  VERSION = '3.1.0'
 
   # @return [String]
   def self.find_platform

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mindee
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.1.0
 platform: ruby
 authors:
 - Mindee, SA
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-06-29 00:00:00.000000000 Z
+date: 2023-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: marcel
@@ -132,6 +132,7 @@ files:
 - docs/code_samples/license_plates_v1.txt
 - docs/code_samples/passport_v1.txt
 - docs/code_samples/proof_of_address_v1.txt
+- docs/code_samples/us_driver_license_v1.txt
 - docs/ruby-api-builder.md
 - docs/ruby-getting-started.md
 - docs/ruby-invoice-ocr.md
@@ -227,6 +228,9 @@ files:
 - lib/mindee/product/us/bank_check/bank_check_v1.rb
 - lib/mindee/product/us/bank_check/bank_check_v1_document.rb
 - lib/mindee/product/us/bank_check/bank_check_v1_page.rb
+- lib/mindee/product/us/driver_license/driver_license_v1.rb
+- lib/mindee/product/us/driver_license/driver_license_v1_document.rb
+- lib/mindee/product/us/driver_license/driver_license_v1_page.rb
 - lib/mindee/version.rb
 - mindee.gemspec
 homepage: https://github.com/mindee/mindee-api-ruby