📝 fix eudl doc + add missing entry for international id v2 (#84)

Author: sebastianMindee

docs/eu_driver_license_v1.md

@@ -1,10 +1,10 @@
 ---
-title: EU EU Driver License OCR Ruby
+title: EU Driver License OCR Ruby
 ---
-The Ruby OCR SDK supports the [EU Driver License API](https://platform.mindee.com/mindee/eu_driver_license).
+The Ruby OCR SDK supports the [Driver License API](https://platform.mindee.com/mindee/eu_driver_license).
 
 Using the [sample below](https://github.com/mindee/client-lib-test-data/blob/main/products/eu_driver_license/default_sample.jpg), we are going to illustrate how to extract the data that we want using the OCR SDK.
-![EU Driver License sample](https://github.com/mindee/client-lib-test-data/blob/main/products/eu_driver_license/default_sample.jpg?raw=true)
+![Driver License sample](https://github.com/mindee/client-lib-test-data/blob/main/products/eu_driver_license/default_sample.jpg?raw=true)
 
 # Quick-Start
 ```rb
@@ -115,7 +115,7 @@ The text field `StringField` only has one constraint: it's **value** is a `Strin
 Some fields are constrained to the page level, and so will not be retrievable to through the document.
 
 # Attributes
-The following fields are extracted for EU Driver License V1:
+The following fields are extracted for Driver License V1:
 
 ## Address
 **address** ([StringField](#string-field)): EU driver license holders address

docs/international_id_v2.md

@@ -0,0 +1,195 @@
+---
+title: International ID OCR Ruby
+---
+The Ruby OCR SDK supports the [International ID API](https://platform.mindee.com/mindee/international_id).
+
+Using the [sample below](https://github.com/mindee/client-lib-test-data/blob/main/products/international_id/default_sample.jpg), we are going to illustrate how to extract the data that we want using the OCR SDK.
+![International ID sample](https://github.com/mindee/client-lib-test-data/blob/main/products/international_id/default_sample.jpg?raw=true)
+
+# Quick-Start
+```rb
+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.enqueue_and_parse(
+  input_source,
+  Mindee::Product::InternationalId::InternationalIdV2
+)
+
+# 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
+```
+
+**Output (RST):**
+```rst
+```
+
+# Field Types
+## Standard Fields
+These fields are generic and used in several products.
+
+### Basic Field
+Each prediction object contains a set of fields that inherit from the generic `Field` class.
+A typical `Field` object will have the following attributes:
+
+* **value** (`String`, `Float`, `Integer`, `Boolean`): corresponds to the field value. Can be `nil` if no value was extracted.
+* **confidence** (Float, nil): the confidence score of the field prediction.
+* **bounding_box** (`Mindee::Geometry::Quadrilateral`, `nil`): contains exactly 4 relative vertices (points) coordinates of a right rectangle containing the field in the document.
+* **polygon** (`Mindee::Geometry::Polygon`, `nil`): contains the relative vertices coordinates (`Point`) of a polygon containing the field in the image.
+* **page_id** (`Integer`, `nil`): the ID of the page, is `nil` when at document-level.
+* **reconstructed** (`Boolean`): indicates whether an object was reconstructed (not extracted as the API gave it).
+
+
+Aside from the previous attributes, all basic fields have access to a `to_s` method that can be used to print their value as a string.
+
+
+### Classification Field
+The classification field `ClassificationField` does not implement all the basic `Field` attributes. It only implements **value**, **confidence** and **page_id**.
+
+> Note: a classification field's `value is always a `String`.
+
+### Date Field
+Aside from the basic `Field` attributes, the date field `DateField` also implements the following: 
+
+* **date_object** (`Date`): an accessible representation of the value as a JavaScript object.
+
+### String Field
+The text field `StringField` only has one constraint: it's **value** is a `String` (or `nil`).
+
+# Attributes
+The following fields are extracted for International ID V2:
+
+## Address
+**address** ([StringField](#string-field)): The physical address of the document holder.
+
+```rb
+puts result.document.inference.prediction.address.value
+```
+
+## Birth Date
+**birth_date** ([DateField](#date-field)): The date of birth of the document holder.
+
+```rb
+puts result.document.inference.prediction.birth_date.value
+```
+
+## Birth Place
+**birth_place** ([StringField](#string-field)): The place of birth of the document holder.
+
+```rb
+puts result.document.inference.prediction.birth_place.value
+```
+
+## Country of Issue
+**country_of_issue** ([StringField](#string-field)): The country where the document was issued.
+
+```rb
+puts result.document.inference.prediction.country_of_issue.value
+```
+
+## Document Number
+**document_number** ([StringField](#string-field)): The unique identifier assigned to the document.
+
+```rb
+puts result.document.inference.prediction.document_number.value
+```
+
+## Document Type
+**document_type** ([ClassificationField](#classification-field)): The type of personal identification document.
+
+```rb
+puts result.document.inference.prediction.document_type.value
+```
+
+## Expiration Date
+**expiry_date** ([DateField](#date-field)): The date when the document becomes invalid.
+
+```rb
+puts result.document.inference.prediction.expiry_date.value
+```
+
+## Given Names
+**given_names** (Array<[StringField](#string-field)>): The list of the document holder's given names.
+
+```rb
+for given_names_elem in result.document.inference.prediction.given_names do
+  puts given_names_elem.value
+end
+```
+
+## Issue Date
+**issue_date** ([DateField](#date-field)): The date when the document was issued.
+
+```rb
+puts result.document.inference.prediction.issue_date.value
+```
+
+## MRZ Line 1
+**mrz_line1** ([StringField](#string-field)): The Machine Readable Zone, first line.
+
+```rb
+puts result.document.inference.prediction.mrz_line1.value
+```
+
+## MRZ Line 2
+**mrz_line2** ([StringField](#string-field)): The Machine Readable Zone, second line.
+
+```rb
+puts result.document.inference.prediction.mrz_line2.value
+```
+
+## MRZ Line 3
+**mrz_line3** ([StringField](#string-field)): The Machine Readable Zone, third line.
+
+```rb
+puts result.document.inference.prediction.mrz_line3.value
+```
+
+## Nationality
+**nationality** ([StringField](#string-field)): The country of citizenship of the document holder.
+
+```rb
+puts result.document.inference.prediction.nationality.value
+```
+
+## Personal Number
+**personal_number** ([StringField](#string-field)): The unique identifier assigned to the document holder.
+
+```rb
+puts result.document.inference.prediction.personal_number.value
+```
+
+## Sex
+**sex** ([StringField](#string-field)): The biological sex of the document holder.
+
+```rb
+puts result.document.inference.prediction.sex.value
+```
+
+## State of Issue
+**state_of_issue** ([StringField](#string-field)): The state or territory where the document was issued.
+
+```rb
+puts result.document.inference.prediction.state_of_issue.value
+```
+
+## Surnames
+**surnames** (Array<[StringField](#string-field)>): The list of the document holder's family names.
+
+```rb
+for surnames_elem in result.document.inference.prediction.surnames do
+  puts surnames_elem.value
+end
+```
+
+# Questions?
+[Join our Slack](https://join.slack.com/t/mindee-community/shared_invite/zt-1jv6nawjq-FDgFcF2T5CmMmRpl9LLptw)

lib/mindee/product/eu/driver_license/driver_license_v1.rb

@@ -7,9 +7,9 @@
 module Mindee
   module Product
     module EU
-      # EU Driver License module.
+      # Driver License module.
       module DriverLicense
-        # EU Driver License V1 prediction inference.
+        # Driver License V1 prediction inference.
         class DriverLicenseV1 < Mindee::Parsing::Common::Inference
           @endpoint_name = 'eu_driver_license'
           @endpoint_version = '1'

lib/mindee/product/eu/driver_license/driver_license_v1_document.rb

@@ -6,7 +6,7 @@ module Mindee
   module Product
     module EU
       module DriverLicense
-        # EU Driver License V1 document prediction.
+        # Driver License V1 document prediction.
         class DriverLicenseV1Document < Mindee::Parsing::Common::Prediction
           include Mindee::Parsing::Standard
           # EU driver license holders address

lib/mindee/product/eu/driver_license/driver_license_v1_page.rb

@@ -7,7 +7,7 @@ module Mindee
   module Product
     module EU
       module DriverLicense
-        # EU Driver License V1 page.
+        # Driver License V1 page.
         class DriverLicenseV1Page < Mindee::Parsing::Common::Page
           # @param prediction [Hash]
           def initialize(prediction)
@@ -19,7 +19,7 @@ def initialize(prediction)
           end
         end
 
-        # EU Driver License V1 page prediction.
+        # Driver License V1 page prediction.
         class DriverLicenseV1PagePrediction < DriverLicenseV1Document
           include Mindee::Parsing::Standard
 

spec/document/eu/driver_license_v1_spec.rb

@@ -9,7 +9,7 @@
 DIR_EU_DRIVER_LICENSE_V1 = File.join(DATA_DIR, 'products', 'eu_driver_license', 'response_v1').freeze
 
 describe Mindee::Product::EU::DriverLicense::DriverLicenseV1 do
-  context 'A EU Driver License V1' do
+  context 'A Driver License V1' do
     it 'should load an empty document prediction' do
       response = load_json(DIR_EU_DRIVER_LICENSE_V1, 'empty.json')
       inference = Mindee::Parsing::Common::Document.new(