✨ add support for fr bank statement (#81)

Author: sebastianMindee

README.md

@@ -143,6 +143,7 @@ customize the experience.
 * [Receipt OCR Ruby](https://developers.mindee.com/docs/receipt-ocr-ruby)
 * [EU License Plate OCR Ruby](https://developers.mindee.com/docs/eu-license-plate-ocr-ruby)
 * [FR Bank Account Details OCR Ruby](https://developers.mindee.com/docs/fr-bank-account-details-ocr-ruby)
+* [FR Bank Statement OCR Ruby](https://developers.mindee.com/docs/fr-bank-statement-ocr-ruby)
 * [FR Carte Vitale OCR Ruby](https://developers.mindee.com/docs/fr-carte-vitale-ocr-ruby)
 * [FR ID Card OCR Ruby](https://developers.mindee.com/docs/fr-id-card-ocr-ruby)
 * [US Bank Check OCR Ruby](https://developers.mindee.com/docs/us-bank-check-ocr-ruby)

bin/mindee.rb

@@ -67,6 +67,12 @@
     sync: true,
     async: false,
   },
+  "fr-bank-statement" => {
+    description: "FR Bank Statement",
+    doc_class: Mindee::Product::FR::BankStatement::BankStatementV1,
+    sync: false,
+    async: true,
+  },
   "fr-carte-vitale" => {
     description: "FR Carte Vitale",
     doc_class: Mindee::Product::FR::CarteVitale::CarteVitaleV1,

docs/bank_statement_fr_v1.md

@@ -0,0 +1,175 @@
+---
+title: FR Bank Statement (FR) OCR Ruby
+---
+The Ruby OCR SDK supports the [Bank Statement (FR) API](https://platform.mindee.com/mindee/bank_statement_fr).
+
+Using the [sample below](https://github.com/mindee/client-lib-test-data/blob/main/products/bank_statement_fr/default_sample.jpg), we are going to illustrate how to extract the data that we want using the OCR SDK.
+![Bank Statement (FR) sample](https://github.com/mindee/client-lib-test-data/blob/main/products/bank_statement_fr/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::FR::BankStatement::BankStatementV1
+)
+
+# 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.
+
+
+### Amount Field
+The amount field `AmountField` only has one constraint: its **value** is a `Float` (or `nil`).
+
+### 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`).
+
+## Specific Fields
+Fields which are specific to this product; they are not used in any other product.
+
+### Transactions Field
+The list of values that represent the financial transactions recorded in a bank statement.
+
+A `BankStatementV1Transaction` implements the following attributes:
+
+* `amount` (Float): The monetary amount of the transaction.
+* `date` (String): The date on which the transaction occurred.
+* `description` (String): The additional information about the transaction.
+
+# Attributes
+The following fields are extracted for Bank Statement (FR) V1:
+
+## Account Number
+**account_number** ([StringField](#string-field)): The unique identifier for a customer's account in the bank's system.
+
+```rb
+puts result.document.inference.prediction.account_number.value
+```
+
+## Bank Address
+**bank_address** ([StringField](#string-field)): The physical location of the bank where the statement was issued.
+
+```rb
+puts result.document.inference.prediction.bank_address.value
+```
+
+## Bank Name
+**bank_name** ([StringField](#string-field)): The name of the bank that issued the statement.
+
+```rb
+puts result.document.inference.prediction.bank_name.value
+```
+
+## Client Address
+**client_address** ([StringField](#string-field)): The address of the client associated with the bank statement.
+
+```rb
+puts result.document.inference.prediction.client_address.value
+```
+
+## Client Name
+**client_name** ([StringField](#string-field)): The name of the client who owns the bank statement.
+
+```rb
+puts result.document.inference.prediction.client_name.value
+```
+
+## Closing Balance
+**closing_balance** ([AmountField](#amount-field)): The final amount of money in the account at the end of the statement period.
+
+```rb
+puts result.document.inference.prediction.closing_balance.value
+```
+
+## Opening Balance
+**opening_balance** ([AmountField](#amount-field)): The initial amount of money in an account at the start of the period.
+
+```rb
+puts result.document.inference.prediction.opening_balance.value
+```
+
+## Statement Date
+**statement_date** ([DateField](#date-field)): The date on which the bank statement was generated.
+
+```rb
+puts result.document.inference.prediction.statement_date.value
+```
+
+## Statement End Date
+**statement_end_date** ([DateField](#date-field)): The date when the statement period ends.
+
+```rb
+puts result.document.inference.prediction.statement_end_date.value
+```
+
+## Statement Start Date
+**statement_start_date** ([DateField](#date-field)): The date when the bank statement period begins.
+
+```rb
+puts result.document.inference.prediction.statement_start_date.value
+```
+
+## Total Credits
+**total_credits** ([AmountField](#amount-field)): The total amount of money deposited into the account.
+
+```rb
+puts result.document.inference.prediction.total_credits.value
+```
+
+## Total Debits
+**total_debits** ([AmountField](#amount-field)): The total amount of money debited from the account.
+
+```rb
+puts result.document.inference.prediction.total_debits.value
+```
+
+## Transactions
+**transactions** (Array<[BankStatementV1Transaction](#transactions-field)>): The list of values that represent the financial transactions recorded in a bank statement.
+
+```rb
+for transactions_elem in result.document.inference.prediction.transactions do
+  puts transactions_elem.value
+end
+```
+
+# Questions?
+[Join our Slack](https://join.slack.com/t/mindee-community/shared_invite/zt-1jv6nawjq-FDgFcF2T5CmMmRpl9LLptw)

docs/code_samples/bank_statement_fr_v1_async.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.enqueue_and_parse(
+  input_source,
+  Mindee::Product::FR::BankStatement::BankStatementV1
+)
+
+# 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

lib/mindee/parsing/common/inference.rb

@@ -36,6 +36,8 @@ def to_s
           out_str << "\n#{@prediction.to_s.size.positive? ? "#{@prediction}\n" : ''}"
           out_str << "\nPage Predictions\n================\n\n" unless @pages.empty?
           out_str << @pages.map(&:to_s).join("\n\n")
+          out_str.rstrip!
+          out_str
         end
       end
     end

lib/mindee/product.rb

@@ -13,6 +13,7 @@
 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/bank_statement/bank_statement_v1'
 require_relative 'product/fr/carte_vitale/carte_vitale_v1'
 require_relative 'product/fr/id_card/id_card_v1'
 require_relative 'product/fr/id_card/id_card_v2'

lib/mindee/product/fr/bank_statement/bank_statement_v1.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require_relative '../../../parsing'
+require_relative 'bank_statement_v1_document'
+require_relative 'bank_statement_v1_page'
+
+module Mindee
+  module Product
+    module FR
+      # Bank Statement (FR) module.
+      module BankStatement
+        # Bank Statement (FR) V1 prediction inference.
+        class BankStatementV1 < Mindee::Parsing::Common::Inference
+          @endpoint_name = 'bank_statement_fr'
+          @endpoint_version = '1'
+
+          # @param prediction [Hash]
+          def initialize(prediction)
+            super
+            @prediction = BankStatementV1Document.new(prediction['prediction'], nil)
+            @pages = []
+            prediction['pages'].each do |page|
+              if page.key?('prediction') && !page['prediction'].nil? && !page['prediction'].empty?
+                @pages.push(BankStatementV1Page.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