♻️ update test lib + update doc (#88)

Author: sebastianMindee

README.md

@@ -1,12 +1,15 @@
 [![License: MIT](https://img.shields.io/github/license/mindee/mindee-api-ruby)](https://opensource.org/licenses/MIT) [![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/mindee/mindee-api-ruby/test.yml)](https://github.com/mindee/mindee-api-ruby) [![Gem Version](https://img.shields.io/gem/v/mindee)](https://rubygems.org/gems/mindee) [![Downloads](https://img.shields.io/gem/dt/mindee.svg)](https://rubygems.org/gems/mindee)
 
 # Mindee API Helper Library for Ruby
+
 Quickly and easily connect to Mindee's API services using Ruby.
 
 ## Requirements
+
 The following Ruby versions are tested and supported: 2.6, 2.7, 3.0, 3.1, 3.2
 
 ## Quick Start
+
 Here's the TL;DR of getting started.
 
 First, get an [API Key](https://developers.mindee.com/docs/create-api-key)
@@ -18,15 +21,38 @@ gem 'mindee'
 ```
 
 And then execute:
+
 ```sh
 bundle install
 ```
 
 Finally, Ruby away!
 
+### Environment Variables
+
+This library offers customizable features through environment variables. While there may be instances where you need to
+rely on them, it's crucial to exercise caution when modifying them to avoid unintended consequences.
+
+If you're unsure whether you need to adjust these variables, it's advisable to refrain from doing so unless you have a
+specific reason. Accidentally overwriting them can lead to unexpected behavior.
+
+Before making any changes, we recommend reviewing the following information to understand the purpose and potential
+impact of each environment variable:
+
+* `MINDEE_API_KEY`: 
+  * **Description**: Your personal Mindee API Key as shown on the platform. Be careful not to show this publicly!
+  * **Default Value**: `nil`
+* `MINDEE_BASE_URL`:
+  * **Description**: The default base URL of the API endpoint. Use this variable to specify the root URL for API requests. Modify as needed for proxy configurations or changes in API endpoint location.
+  * **Default Value**: `https://api.mindee.net/v1`
+* `MINDEE_REQUEST_TIMEOUT`:
+  * **Description**: The default timeout for HTTP requests (in seconds).
+  * **Default Value**: `120`
+
 ### Loading a File and Parsing It
 
 #### Global Documents
+
 ```ruby
 require 'mindee'
 
@@ -47,26 +73,31 @@ puts result.document
 **Note:** Files can also be loaded from:
 
 A URL (`https`):
+
 ```rb
 input_source = mindee_client.source_from_url("https://my-url")
 ```
 
 A bytes input stream:
+
 ```rb
 input_source = mindee_client.source_from_bytes('/path/to/the/file.ext', "name-of-my-file.ext")
 ```
 
 A base64 encoded string:
+
 ```rb
 input_source = mindee_client.source_from_b64string('/path/to/the/file.ext', "name-of-my-file.ext")
 ```
 
 A ruby `file` object:
+
 ```rb
 input_source = mindee_client.source_from_file(input_file, "name-of-my-file.ext")
 ```
 
 #### Region-Specific Documents
+
 ```ruby
 require 'mindee'
 
@@ -86,6 +117,7 @@ puts result.document
 ```
 
 ### Custom Document (API Builder)
+
 ```ruby
 require 'mindee'
 
@@ -119,17 +151,19 @@ end
 ## CLI Tool
 
 A command-line interface tool is available to quickly test documents:
+
 ```sh
 ruby ./bin/mindee.rb invoice path/to/your/file.ext
 ```
 
-
 Using the ruby bundler:
+
 ```sh
 bundle exec ruby ./bin/mindee.rb invoice path/to/your/file.ext
 ```
 
 ## Further Reading
+
 There's more to it than that for those that need more features, or want to
 customize the experience.
 
@@ -157,15 +191,15 @@ customize the experience.
 * [Invoice Splitter API Ruby](https://developers.mindee.com/docs/invoice-splitter-api-ruby)
 * [Multi Receipts Detector API Ruby](https://developers.mindee.com/docs/multi-receipts-detector-api-ruby)
 
-
 You can also take a look at the
 [Reference Documentation](https://mindee.github.io/mindee-api-ruby/).
 
-
 ## License
+
 Copyright © Mindee, SA
 
 Available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
 
 ## Questions?
+
 [Join our Slack](https://join.slack.com/t/mindee-community/shared_invite/zt-2d0ds7dtz-DPAF81ZqTy20chsYpQBW5g)

docs/international_id_v2.md

@@ -31,6 +31,37 @@ puts result.document
 
 **Output (RST):**
 ```rst
+########
+Document
+########
+:Mindee ID: cfa20a58-20cf-43b6-8cec-9505fa69d1c2
+:Filename: default_sample.jpg
+
+Inference
+#########
+:Product: mindee/international_id v2.0
+:Rotation applied: No
+
+Prediction
+==========
+:Document Type: IDENTIFICATION_CARD
+:Document Number: 12345678A
+:Surnames: MUESTRA
+           MUESTRA
+:Given Names: CARMEN
+:Sex: F
+:Birth Date: 1980-01-01
+:Birth Place: CAMPO DE CRIPTANA CIUDAD REAL ESPANA
+:Nationality: ESP
+:Personal Number: BAB1834284<44282767Q0
+:Country of Issue: ESP
+:State of Issue: MADRID
+:Issue Date:
+:Expiration Date: 2030-01-01
+:Address: C/REAL N13, 1 DCHA COLLADO VILLALBA MADRID MADRID MADRID
+:MRZ Line 1: IDESPBAB1834284<44282767Q0<<<<
+:MRZ Line 2: 8001010F1301017ESP<<<<<<<<<<<3
+:MRZ Line 3: MUESTRA<MUESTRA<<CARMEN<<<<<<<
 ```
 
 # Field Types