mindee 4.1.2 → 4.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 32781169244b37ef1d839e05d09ffc0c58a677b33a3f7266a2a0597e9dc0e114
-  data.tar.gz: 9d3793675e7bef501031be3f70454c7681b48317bffaf61be576a13c043c5c1a
+  metadata.gz: e6c09d5108c2470661075484f14849c7205cbef88d481427bcb612d36ede9835
+  data.tar.gz: e7b6fa99499a9c3a3d82a9c87ab40dc07cbecd48a4f2d82200cfea2729f9d5cb
 SHA512:
-  metadata.gz: bb14b3e6a1fe2e52bdc1d93836f0b70f91e0ddf8a3fd667ca68cc2661f145da9e3a070c0d6124d5e9ce916a1e0110abd8723afd43312043c04b2138e311c0372
-  data.tar.gz: 12a99519ce9fbf03c69aea9651205aa17fdd96ab8bdbd2a54ad1768304baf374c1e3f53d791375ce0f91fe66589d84bf24c3d496dc294212913dd409ce8d6322
+  metadata.gz: b97c068ddeefb0908e7d9753c0439c86393d1a04b13bf8f256c3dbc93399f213b0405375a036715906a8087eba3eb5126d8e69880c819ef4b0d5b7bf61459e88
+  data.tar.gz: a15ff1b478675ec58dfd61d0f0483dcc7ab23df1fc02624e8133d5f636101e82f1eeb4f823ebe19a3a06ce70c4288270ebaca7029514e91f204298ad5843c924

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Mindee Ruby API Library Changelog
 
+## v4.2.0 - 2025-03-28
+### Changes
+* :coffin: remove support for US W9
+
+
 ## v4.1.2 - 2025-03-26
 ### Fixes
 * :wrench: loosen version restrictions on most dependencies
@@ -18,6 +23,7 @@
 ### Fixes
 * :recycle: update CLI syntax for easier product creation
 
+
 ## v4.0.0 - 2025-02-27
 ### ¡Breaking Changes!
 * :boom: drop support for ruby versions < 3.0

data/bin/cli_products.rb

@@ -163,10 +163,4 @@ PRODUCTS = {
     sync: false,
     async: true,
   },
-  "us-w9" => {
-    description: "W9",
-    doc_class: Mindee::Product::US::W9::W9V1,
-    sync: true,
-    async: false,
-  },
 }

data/docs/global_products/expense_receipts_v5.md

@@ -227,6 +227,7 @@ Aside from the basic `Field` attributes, the tax field `TaxField` also implement
 * **rate** (`Float`): the tax rate applied to an item can be expressed as a percentage. Can be `nil`.
 * **code** (`String`): tax code (or equivalent, depending on the origin of the document). Can be `nil`.
 * **base** (`Float`): base amount used for the tax. Can be `nil`.
+* **value** (`Float`): the value of the tax. Can be `nil`.
 
 > Note: currently `TaxField` is not used on its own, and is accessed through a parent `Taxes` object, an array-like
 structure.

data/docs/global_products/financial_document_v1.md

@@ -272,6 +272,7 @@ Aside from the basic `Field` attributes, the tax field `TaxField` also implement
 * **rate** (`Float`): the tax rate applied to an item can be expressed as a percentage. Can be `nil`.
 * **code** (`String`): tax code (or equivalent, depending on the origin of the document). Can be `nil`.
 * **base** (`Float`): base amount used for the tax. Can be `nil`.
+* **value** (`Float`): the value of the tax. Can be `nil`.
 
 > Note: currently `TaxField` is not used on its own, and is accessed through a parent `Taxes` object, an array-like
 structure.

data/docs/global_products/invoices_v4.md

@@ -260,6 +260,7 @@ Aside from the basic `Field` attributes, the tax field `TaxField` also implement
 * **rate** (`Float`): the tax rate applied to an item can be expressed as a percentage. Can be `nil`.
 * **code** (`String`): tax code (or equivalent, depending on the origin of the document). Can be `nil`.
 * **base** (`Float`): base amount used for the tax. Can be `nil`.
+* **value** (`Float`): the value of the tax. Can be `nil`.
 
 > Note: currently `TaxField` is not used on its own, and is accessed through a parent `Taxes` object, an array-like
 structure.

data/lib/mindee/product.rb

@@ -31,4 +31,3 @@ require_relative 'product/us/bank_check/bank_check_v1'
 require_relative 'product/us/healthcare_card/healthcare_card_v1'
 require_relative 'product/us/us_mail/us_mail_v2'
 require_relative 'product/us/us_mail/us_mail_v3'
-require_relative 'product/us/w9/w9_v1'

data/lib/mindee/version.rb

@@ -3,7 +3,7 @@
 # Mindee
 module Mindee
   # Current version.
-  VERSION = '4.1.2'
+  VERSION = '4.2.0'
 
   # Finds and return the current platform.
   # @return [Symbol, Hash[Symbol | String, Regexp], Nil?]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mindee
 version: !ruby/object:Gem::Version
-  version: 4.1.2
+  version: 4.2.0
 platform: ruby
 authors:
 - Mindee, SA
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-03-26 00:00:00.000000000 Z
+date: 2025-03-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: base64
@@ -245,7 +245,6 @@ files:
 - docs/code_samples/us_healthcare_cards_v1_async.txt
 - docs/code_samples/us_mail_v2_async.txt
 - docs/code_samples/us_mail_v3_async.txt
-- docs/code_samples/us_w9_v1.txt
 - docs/code_samples/workflow_execution.txt
 - docs/getting_started.md
 - docs/global_products.md
@@ -278,7 +277,6 @@ files:
 - docs/localized_products/payslip_fra_v3.md
 - docs/localized_products/us_healthcare_cards_v1.md
 - docs/localized_products/us_mail_v3.md
-- docs/localized_products/us_w9_v1.md
 - examples/auto_invoice_splitter_extraction.rb
 - examples/auto_multi_receipts_detector_extraction.rb
 - lib/mindee.rb
@@ -535,9 +533,6 @@ files:
 - lib/mindee/product/us/us_mail/us_mail_v3_recipient_address.rb
 - lib/mindee/product/us/us_mail/us_mail_v3_recipient_addresses.rb
 - lib/mindee/product/us/us_mail/us_mail_v3_sender_address.rb
-- lib/mindee/product/us/w9/w9_v1.rb
-- lib/mindee/product/us/w9/w9_v1_document.rb
-- lib/mindee/product/us/w9/w9_v1_page.rb
 - lib/mindee/version.rb
 - mindee.gemspec
 - sig/custom/marcel.rbs

data/docs/code_samples/us_w9_v1.txt

@@ -1,21 +0,0 @@
-#
-# Install the Ruby client library by running:
-# gem install mindee
-#
-
-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::W9::W9V1
-)
-
-# Print a full summary of the parsed data in RST format
-puts result.document

data/docs/localized_products/us_w9_v1.md

@@ -1,230 +0,0 @@
----
-title: US W9
-category: 622b805aaec68102ea7fcbc2
-slug: ruby-us-w9-ocr
-parentDoc: 67b49e29a2cd6f08d69a40d8
----
-The Ruby Client Library supports the [W9 API](https://platform.mindee.com/mindee/us_w9).
-
-
-> 📝 Product Specs
->
-> | Specification                  | Details                                            |
-> | ------------------------------ | -------------------------------------------------- |
-> | Endpoint Name                  | `us_w9`                                            |
-> | Recommended Version            | `v1.0`                                             |
-> | Supports Polling/Webhooks      | ❌ No                                              |
-> | Support Synchronous HTTP Calls | ✔️ Yes                                             |
-> | Geography                      | 🇺🇸 United States                                   |
-
-
-Using the [sample below](https://github.com/mindee/client-lib-test-data/blob/main/products/us_w9/default_sample.jpg),
-we are going to illustrate how to extract the data that we want using the Ruby Client Library.
-![W9 sample](https://github.com/mindee/client-lib-test-data/blob/main/products/us_w9/default_sample.jpg?raw=true)
-
-# Quick-Start
-```rb
-#
-# Install the Ruby client library by running:
-# gem install mindee
-#
-
-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::W9::W9V1
-)
-
-# Print a full summary of the parsed data in RST format
-puts result.document
-```
-
-**Output (RST):**
-```rst
-########
-Document
-########
-:Mindee ID: d7c5b25f-e0d3-4491-af54-6183afa1aaab
-:Filename: default_sample.jpg
-
-Inference
-#########
-:Product: mindee/us_w9 v1.0
-:Rotation applied: Yes
-
-Prediction
-==========
-
-Page Predictions
-================
-
-Page 0
-------
-:Name: Stephen W Hawking
-:SSN: 560758145
-:Address: Somewhere In Milky Way
-:City State Zip: Probably Still At Cambridge P O Box CB1
-:Business Name:
-:EIN: 942203664
-:Tax Classification: individual
-:Tax Classification Other Details:
-:W9 Revision Date: august 2013
-:Signature Position: Polygon with 4 points.
-:Signature Date Position:
-:Tax Classification LLC:
-```
-
-# 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`, `bool`): 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, always `nil` when at document-level.
-* **reconstructed** (`bool`): 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.
-
-
-### Position Field
-The position field `PositionField` does not implement all the basic `Field` attributes, only **bounding_box**,
-**polygon** and **page_id**. On top of these, it has access to:
-
-* **rectangle** (`Mindee::Geometry::Quadrilateral`): a Polygon with four points that may be oriented (even beyond
-canvas).
-* **quadrangle** (`Mindee::Geometry::Quadrilateral`): a free polygon made up of four points.
-
-### String Field
-The text field `StringField` only has one constraint: it's **value** is a `String` (or `nil`).
-
-## Page-Level Fields
-Some fields are constrained to the page level, and so will not be retrievable at document level.
-
-# Attributes
-The following fields are extracted for W9 V1:
-
-## Address
-[📄](#page-level-fields "This field is only present on individual pages.")**address** ([StringField](#string-field)): The street address (number, street, and apt. or suite no.) of the applicant.
-
-```rb
-  result.document.address.each do |address_elem|
-    puts address_elem.value
-  end
-```
-
-## Business Name
-[📄](#page-level-fields "This field is only present on individual pages.")**business_name** ([StringField](#string-field)): The business name or disregarded entity name, if different from Name.
-
-```rb
-  result.document.business_name.each do |business_name_elem|
-    puts business_name_elem.value
-  end
-```
-
-## City State Zip
-[📄](#page-level-fields "This field is only present on individual pages.")**city_state_zip** ([StringField](#string-field)): The city, state, and ZIP code of the applicant.
-
-```rb
-  result.document.city_state_zip.each do |city_state_zip_elem|
-    puts city_state_zip_elem.value
-  end
-```
-
-## EIN
-[📄](#page-level-fields "This field is only present on individual pages.")**ein** ([StringField](#string-field)): The employer identification number.
-
-```rb
-  result.document.ein.each do |ein_elem|
-    puts ein_elem.value
-  end
-```
-
-## Name
-[📄](#page-level-fields "This field is only present on individual pages.")**name** ([StringField](#string-field)): Name as shown on the applicant's income tax return.
-
-```rb
-  result.document.name.each do |name_elem|
-    puts name_elem.value
-  end
-```
-
-## Signature Date Position
-[📄](#page-level-fields "This field is only present on individual pages.")**signature_date_position** ([PositionField](#position-field)): Position of the signature date on the document.
-
-```rb
-  result.document.signature_date_position.each do |signature_date_position_elem|
-    puts signature_date_position_elem.polygon
-  end
-```
-
-## Signature Position
-[📄](#page-level-fields "This field is only present on individual pages.")**signature_position** ([PositionField](#position-field)): Position of the signature on the document.
-
-```rb
-  result.document.signature_position.each do |signature_position_elem|
-    puts signature_position_elem.polygon
-  end
-```
-
-## SSN
-[📄](#page-level-fields "This field is only present on individual pages.")**ssn** ([StringField](#string-field)): The applicant's social security number.
-
-```rb
-  result.document.ssn.each do |ssn_elem|
-    puts ssn_elem.value
-  end
-```
-
-## Tax Classification
-[📄](#page-level-fields "This field is only present on individual pages.")**tax_classification** ([StringField](#string-field)): The federal tax classification, which can vary depending on the revision date.
-
-```rb
-  result.document.tax_classification.each do |tax_classification_elem|
-    puts tax_classification_elem.value
-  end
-```
-
-## Tax Classification LLC
-[📄](#page-level-fields "This field is only present on individual pages.")**tax_classification_llc** ([StringField](#string-field)): Depending on revision year, among S, C, P or D for Limited Liability Company Classification.
-
-```rb
-  result.document.tax_classification_llc.each do |tax_classification_llc_elem|
-    puts tax_classification_llc_elem.value
-  end
-```
-
-## Tax Classification Other Details
-[📄](#page-level-fields "This field is only present on individual pages.")**tax_classification_other_details** ([StringField](#string-field)): Tax Classification Other Details.
-
-```rb
-  result.document.tax_classification_other_details.each do |tax_classification_other_details_elem|
-    puts tax_classification_other_details_elem.value
-  end
-```
-
-## W9 Revision Date
-[📄](#page-level-fields "This field is only present on individual pages.")**w9_revision_date** ([StringField](#string-field)): The Revision month and year of the W9 form.
-
-```rb
-  result.document.w9_revision_date.each do |w9_revision_date_elem|
-    puts w9_revision_date_elem.value
-  end
-```
-
-# Questions?
-[Join our Slack](https://join.slack.com/t/mindee-community/shared_invite/zt-2d0ds7dtz-DPAF81ZqTy20chsYpQBW5g)

data/lib/mindee/product/us/w9/w9_v1.rb

@@ -1,47 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../../../parsing'
-require_relative 'w9_v1_document'
-require_relative 'w9_v1_page'
-
-module Mindee
-  module Product
-    module US
-      # W9 module.
-      module W9
-        # W9 API version 1 inference prediction.
-        class W9V1 < Mindee::Parsing::Common::Inference
-          @endpoint_name = 'us_w9'
-          @endpoint_version = '1'
-          @has_async = false
-          @has_sync = true
-
-          # @param prediction [Hash]
-          def initialize(prediction)
-            super
-            @prediction = W9V1Document.new(prediction['prediction'], nil)
-            @pages = []
-            prediction['pages'].each do |page|
-              @pages.push(W9V1Page.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
-            # Whether this product has access to an asynchronous endpoint.
-            # @return [bool]
-            attr_reader :has_async
-            # Whether this product has access to synchronous endpoint.
-            # @return [bool]
-            attr_reader :has_sync
-          end
-        end
-      end
-    end
-  end
-end

data/lib/mindee/product/us/w9/w9_v1_document.rb

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../../../parsing'
-
-module Mindee
-  module Product
-    module US
-      module W9
-        # W9 API version 1.0 document data.
-        class W9V1Document < Mindee::Parsing::Common::Prediction
-        end
-      end
-    end
-  end
-end

data/lib/mindee/product/us/w9/w9_v1_page.rb

@@ -1,133 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../../../parsing'
-require_relative 'w9_v1_document'
-
-module Mindee
-  module Product
-    module US
-      module W9
-        # W9 API version 1.0 page data.
-        class W9V1Page < Mindee::Parsing::Common::Page
-          # @param prediction [Hash]
-          def initialize(prediction)
-            super
-            @prediction = if prediction['prediction'].empty?
-                            nil
-                          else
-                            W9V1PagePrediction.new(
-                              prediction['prediction'],
-                              prediction['id']
-                            )
-                          end
-          end
-        end
-
-        # W9 V1 page prediction.
-        class W9V1PagePrediction < W9V1Document
-          include Mindee::Parsing::Standard
-
-          # The street address (number, street, and apt. or suite no.) of the applicant.
-          # @return [Mindee::Parsing::Standard::StringField]
-          attr_reader :address
-          # The business name or disregarded entity name, if different from Name.
-          # @return [Mindee::Parsing::Standard::StringField]
-          attr_reader :business_name
-          # The city, state, and ZIP code of the applicant.
-          # @return [Mindee::Parsing::Standard::StringField]
-          attr_reader :city_state_zip
-          # The employer identification number.
-          # @return [Mindee::Parsing::Standard::StringField]
-          attr_reader :ein
-          # Name as shown on the applicant's income tax return.
-          # @return [Mindee::Parsing::Standard::StringField]
-          attr_reader :name
-          # Position of the signature date on the document.
-          # @return [Mindee::Parsing::Standard::PositionField]
-          attr_reader :signature_date_position
-          # Position of the signature on the document.
-          # @return [Mindee::Parsing::Standard::PositionField]
-          attr_reader :signature_position
-          # The applicant's social security number.
-          # @return [Mindee::Parsing::Standard::StringField]
-          attr_reader :ssn
-          # The federal tax classification, which can vary depending on the revision date.
-          # @return [Mindee::Parsing::Standard::StringField]
-          attr_reader :tax_classification
-          # Depending on revision year, among S, C, P or D for Limited Liability Company Classification.
-          # @return [Mindee::Parsing::Standard::StringField]
-          attr_reader :tax_classification_llc
-          # Tax Classification Other Details.
-          # @return [Mindee::Parsing::Standard::StringField]
-          attr_reader :tax_classification_other_details
-          # The Revision month and year of the W9 form.
-          # @return [Mindee::Parsing::Standard::StringField]
-          attr_reader :w9_revision_date
-
-          # @param prediction [Hash]
-          # @param page_id [Integer, nil]
-          def initialize(prediction, page_id)
-            @address = Parsing::Standard::StringField.new(
-              prediction['address'],
-              page_id
-            )
-            @business_name = Parsing::Standard::StringField.new(
-              prediction['business_name'],
-              page_id
-            )
-            @city_state_zip = Parsing::Standard::StringField.new(
-              prediction['city_state_zip'],
-              page_id
-            )
-            @ein = Parsing::Standard::StringField.new(prediction['ein'], page_id)
-            @name = Parsing::Standard::StringField.new(prediction['name'], page_id)
-            @signature_date_position = Parsing::Standard::PositionField.new(
-              prediction['signature_date_position'],
-              page_id
-            )
-            @signature_position = Parsing::Standard::PositionField.new(
-              prediction['signature_position'],
-              page_id
-            )
-            @ssn = Parsing::Standard::StringField.new(prediction['ssn'], page_id)
-            @tax_classification = Parsing::Standard::StringField.new(
-              prediction['tax_classification'],
-              page_id
-            )
-            @tax_classification_llc = Parsing::Standard::StringField.new(
-              prediction['tax_classification_llc'],
-              page_id
-            )
-            @tax_classification_other_details = Parsing::Standard::StringField.new(
-              prediction['tax_classification_other_details'],
-              page_id
-            )
-            @w9_revision_date = Parsing::Standard::StringField.new(
-              prediction['w9_revision_date'],
-              page_id
-            )
-            super
-          end
-
-          # @return [String]
-          def to_s
-            out_str = String.new
-            out_str << "\n:Name: #{@name}".rstrip
-            out_str << "\n:SSN: #{@ssn}".rstrip
-            out_str << "\n:Address: #{@address}".rstrip
-            out_str << "\n:City State Zip: #{@city_state_zip}".rstrip
-            out_str << "\n:Business Name: #{@business_name}".rstrip
-            out_str << "\n:EIN: #{@ein}".rstrip
-            out_str << "\n:Tax Classification: #{@tax_classification}".rstrip
-            out_str << "\n:Tax Classification Other Details: #{@tax_classification_other_details}".rstrip
-            out_str << "\n:W9 Revision Date: #{@w9_revision_date}".rstrip
-            out_str << "\n:Signature Position: #{@signature_position}".rstrip
-            out_str << "\n:Signature Date Position: #{@signature_date_position}".rstrip
-            out_str << "\n:Tax Classification LLC: #{@tax_classification_llc}".rstrip
-            out_str
-          end
-        end
-      end
-    end
-  end
-end