mindee 3.1.1 → 3.2.0

data/docs/us_w9_v1.md

@@ -0,0 +1,207 @@
+---
+title: US W9 OCR Ruby
+---
+The Ruby OCR SDK supports the [US W9 API](https://platform.mindee.com/mindee/us_w9).
+
+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 OCR SDK.
+![US W9 sample](https://github.com/mindee/client-lib-test-data/blob/main/products/us_w9/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.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`, `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 or not 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 to through the document.
+
+# Attributes
+The following fields are extracted for US 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
+for address_elem in result.document.address do
+  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
+for business_name_elem in result.document.business_name do
+  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
+for city_state_zip_elem in result.document.city_state_zip do
+  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
+for ein_elem in result.document.ein do
+  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
+for name_elem in result.document.name do
+  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
+for signature_date_position_elem in result.document.signature_date_position do
+  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
+for signature_position_elem in result.document.signature_position do
+  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
+for ssn_elem in result.document.ssn do
+  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
+for tax_classification_elem in result.document.tax_classification do
+  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
+for tax_classification_llc_elem in result.document.tax_classification_llc do
+  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
+for tax_classification_other_details_elem in result.document.tax_classification_other_details do
+  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
+for w9_revision_date_elem in result.document.w9_revision_date do
+  puts w9_revision_date_elem.value
+end
+```
+
+# Questions?
+[Join our Slack](https://join.slack.com/t/mindee-community/shared_invite/zt-1jv6nawjq-FDgFcF2T5CmMmRpl9LLptw)

data/lib/mindee/client.rb

@@ -17,7 +17,7 @@ module Mindee
     # Call prediction API on a document and parse the results.
     #
     # @param input_source [Mindee::Input::Source::LocalInputSource, Mindee::Input::Source::UrlInputSource]
-    #
+    # @param product_class [Mindee::Product] class of the product
     # @param endpoint [HTTP::Endpoint] Endpoint of the API
     # Doesn't need to be set in the case of OTS APIs.
     #
@@ -52,14 +52,14 @@ module Mindee
         input_source.process_pdf(page_options)
       end
       endpoint = initialize_endpoint(product_class) if endpoint.nil?
-      prediction = endpoint.predict(input_source, all_words, close_file, cropper)
-      Mindee::Parsing::Common::ApiResponse.new(product_class, prediction)
+      prediction, raw_http = endpoint.predict(input_source, all_words, close_file, cropper)
+      Mindee::Parsing::Common::ApiResponse.new(product_class, prediction, raw_http)
     end
 
     # Enqueue a document for async parsing
     #
     # @param input_source [Mindee::Input::Source::LocalInputSource, Mindee::Input::Source::UrlInputSource]
-    #
+    # @param product_class [Mindee::Product] class of the product
     # @param endpoint [HTTP::Endpoint, nil] Endpoint of the API.
     # Doesn't need to be set in the case of OTS APIs.
     #
@@ -94,17 +94,18 @@ module Mindee
         input_source.process_pdf(page_options)
       end
       endpoint = initialize_endpoint(product_class) if endpoint.nil?
+      prediction, raw_http = endpoint.predict_async(input_source, all_words, close_file, cropper)
       Mindee::Parsing::Common::ApiResponse.new(product_class,
-                                               endpoint.predict_async(input_source, all_words, close_file, cropper))
+                                               prediction, raw_http)
     end
 
     # Parses a queued document
     #
+    # @param job_id [String] Id of the job (queue) to poll from
+    # @param product_class [Mindee::Product] class of the product
     # @param endpoint [HTTP::Endpoint, nil] Endpoint of the API
     # Doesn't need to be set in the case of OTS APIs.
     #
-    # @param job_id [String] Id of the job (queue) to poll from
-    #
     # @return [Mindee::Parsing::Common::ApiResponse]
     def parse_queued(
       job_id,
@@ -112,38 +113,106 @@ module Mindee
       endpoint: nil
     )
       endpoint = initialize_endpoint(product_class) if endpoint.nil?
-      Mindee::Parsing::Common::ApiResponse.new(product_class, endpoint.parse_async(job_id))
+      prediction, raw_http = endpoint.parse_async(job_id)
+      Mindee::Parsing::Common::ApiResponse.new(product_class, prediction, raw_http)
     end
 
+    # rubocop:disable Metrics/ParameterLists
+
+    # Enqueue a document for async parsing and automatically try to retrieve it
+    #
+    # @param input_source [Mindee::Input::Source::LocalInputSource, Mindee::Input::Source::UrlInputSource]
+    # @param product_class [Mindee::Product] class of the product
+    # @param endpoint [HTTP::Endpoint, nil] Endpoint of the API.
+    #   Doesn't need to be set in the case of OTS APIs.
+    # @param all_words [Boolean] Whether to extract all the words on each page.
+    #   This performs a full OCR operation on the server and will increase response time.
+    # @param close_file [Boolean] Whether to `close()` the file after parsing it.
+    #   Set to false if you need to access the file after this operation.
+    # @param page_options [Hash, nil] Page cutting/merge options:
+    #  * `:page_indexes` Zero-based list of page indexes.
+    #  * `:operation` Operation to apply on the document, given the `page_indexes specified:
+    #      * `:KEEP_ONLY` - keep only the specified pages, and remove all others.
+    #      * `:REMOVE` - remove the specified pages, and keep all others.
+    #  * `:on_min_pages` Apply the operation only if document has at least this many pages.
+    # @param cropper [Boolean, nil] Whether to include cropper results for each page.
+    #  This performs a cropping operation on the server and will increase response time.
+    # @param initial_delay_sec [Integer, Float, nil] initial delay before polling. Defaults to 6.
+    # @param delay_sec [Integer, Float, nil] delay between polling attempts. Defaults to 3.
+    # @param max_retries [Integer, nil] maximum amount of retries. Defaults to 10.
+    # @return [Mindee::Parsing::Common::ApiResponse]
+    def enqueue_and_parse(
+      input_source,
+      product_class,
+      endpoint: nil,
+      all_words: false,
+      close_file: true,
+      page_options: nil,
+      cropper: false,
+      initial_delay_sec: 6,
+      delay_sec: 3,
+      max_retries: 10
+    )
+      enqueue_res = enqueue(
+        input_source,
+        product_class,
+        endpoint: endpoint,
+        all_words: all_words,
+        close_file: close_file,
+        page_options: page_options,
+        cropper: cropper
+      )
+      sleep(initial_delay_sec)
+      polling_attempts = 1
+      job_id = enqueue_res.job.id
+      queue_res = parse_queued(job_id, product_class, endpoint: endpoint)
+      while (queue_res.job.status != Mindee::Parsing::Common::JobStatus::COMPLETED) && (polling_attempts < max_retries)
+        sleep(delay_sec)
+        queue_res = parse_queued(job_id, product_class, endpoint: endpoint)
+        polling_attempts += 1
+      end
+      if queue_res.job.status != Mindee::Parsing::Common::JobStatus::COMPLETED
+        elapsed = initial_delay_sec + (polling_attempts * delay_sec)
+        raise "Asynchronous parsing request timed out after #{elapsed} seconds (#{polling_attempts} tries)"
+      end
+
+      queue_res
+    end
+    # rubocop:enable Metrics/ParameterLists
+
     # Load a document from an absolute path, as a string.
     # @param input_path [String] Path of file to open
+    # @param fix_pdf [Boolean] Attempts to fix broken pdf if true
     # @return [Mindee::Input::Source::PathInputSource]
-    def source_from_path(input_path)
-      Input::Source::PathInputSource.new(input_path)
+    def source_from_path(input_path, fix_pdf: false)
+      Input::Source::PathInputSource.new(input_path, fix_pdf: fix_pdf)
     end
 
     # Load a document from raw bytes.
     # @param input_bytes [String] Encoding::BINARY byte input
     # @param filename [String] The name of the file (without the path)
+    # @param fix_pdf [Boolean] Attempts to fix broken pdf if true
     # @return [Mindee::Input::Source::BytesInputSource]
-    def source_from_bytes(input_bytes, filename)
-      Input::Source::BytesInputSource.new(input_bytes, filename)
+    def source_from_bytes(input_bytes, filename, fix_pdf: false)
+      Input::Source::BytesInputSource.new(input_bytes, filename, fix_pdf: fix_pdf)
     end
 
     # Load a document from a base64 encoded string.
     # @param base64_string [String] Input to parse as base64 string
     # @param filename [String] The name of the file (without the path)
+    # @param fix_pdf [Boolean] Attempts to fix broken pdf if true
     # @return [Mindee::Input::Source::Base64InputSource]
-    def source_from_b64string(base64_string, filename)
-      Input::Source::Base64InputSource.new(base64_string, filename)
+    def source_from_b64string(base64_string, filename, fix_pdf: false)
+      Input::Source::Base64InputSource.new(base64_string, filename, fix_pdf: fix_pdf)
     end
 
     # Load a document from a normal Ruby `File`.
     # @param input_file [File] Input file handle
     # @param filename [String] The name of the file (without the path)
+    # @param fix_pdf [Boolean] Attempts to fix broken pdf if true
     # @return [Mindee::Input::Source::FileInputSource]
-    def source_from_file(input_file, filename)
-      Input::Source::FileInputSource.new(input_file, filename)
+    def source_from_file(input_file, filename, fix_pdf: false)
+      Input::Source::FileInputSource.new(input_file, filename, fix_pdf: fix_pdf)
     end
 
     # Load a document from a secure remote source (HTTPS).
@@ -171,6 +240,16 @@ module Mindee
 
     private
 
+    # Validates the parameters for async auto-polling
+    # @param initial_delay_sec [Integer, Float] initial delay before polling
+    # @param delay_sec [Integer, Float] delay between polling attempts
+    # @param max_retries [Integer, nil] maximum amount of retries. Defaults to 10.
+    def validate_async_params(initial_delay_sec, delay_sec, max_retries)
+      raise 'Cannot set auto-poll delay to less than 2 seconds' if delay_sec < 2
+      raise 'Cannot set initial parsing delay to less than 4 seconds' if initial_delay_sec < 4
+      raise 'Cannot set auto-poll delay to less than 2 seconds' unless max_retries.is_a? Integer
+    end
+
     # Creates an endpoint with the given values. Raises an error if the endpoint is invalid.
     # @param product_class [Mindee::Product] class of the product
     #

data/lib/mindee/geometry/quadrilateral.rb

@@ -40,6 +40,11 @@ module Mindee
           throw '0, 1, 2, 3 only'
         end
       end
+
+      # A quadrilateral has four corners, always.
+      def size
+        4
+      end
     end
   end
 end

data/lib/mindee/http/.rubocop.yml

@@ -0,0 +1,8 @@
+inherit_from: ../../../.rubocop.yml
+
+Metrics/CyclomaticComplexity:
+  Max: 10
+
+Metrics/PerceivedComplexity:
+  Max: 10
+

data/lib/mindee/http/endpoint.rb

@@ -2,19 +2,27 @@
 
 require 'json'
 require 'net/http'
+require_relative 'error'
 require_relative '../version'
 
 module Mindee
   module HTTP
+    # API key's default environment key name.
     API_KEY_ENV_NAME = 'MINDEE_API_KEY'
+    # API key's default value.
     API_KEY_DEFAULT = nil
 
+    # Base URL default environment key name.
     BASE_URL_ENV_NAME = 'MINDEE_BASE_URL'
+    # Base URL's default value.
     BASE_URL_DEFAULT = 'https://api.mindee.net/v1'
 
+    # HTTP request timeout default environment key name.
     REQUEST_TIMEOUT_ENV_NAME = 'MINDEE_REQUEST_TIMEOUT'
+    # HTTP request timeout default value.
     TIMEOUT_DEFAULT = 120
 
+    # Default value for the user agent.
     USER_AGENT = "mindee-api-ruby@v#{Mindee::VERSION} ruby-v#{RUBY_VERSION} #{Mindee::PLATFORM}"
 
     # Generic API endpoint for a product.
@@ -43,9 +51,9 @@ module Mindee
         check_api_key
         response = predict_req_post(input_source, all_words: all_words, close_file: close_file, cropper: cropper)
         hashed_response = JSON.parse(response.body, object_class: Hash)
-        return hashed_response if (200..299).include?(response.code.to_i)
+        return [hashed_response, response.body] if (200..299).include?(response.code.to_i)
 
-        error = Parsing::Common::HttpError.new(hashed_response['api_request']['error'])
+        error = Error.handle_error!(@url_name, hashed_response, response.code.to_i)
         raise error
       end
 
@@ -58,9 +66,9 @@ module Mindee
         check_api_key
         response = document_queue_req_get(input_source, all_words, close_file, cropper)
         hashed_response = JSON.parse(response.body, object_class: Hash)
-        return hashed_response if (200..299).include?(response.code.to_i)
+        return [hashed_response, response.body] if (200..299).include?(response.code.to_i)
 
-        error = Parsing::Common::HttpError.new(hashed_response['api_request']['error'])
+        error = Error.handle_error!(@url_name, hashed_response, response.code.to_i)
         raise error
       end
 
@@ -71,9 +79,9 @@ module Mindee
         check_api_key
         response = document_queue_req(job_id)
         hashed_response = JSON.parse(response.body, object_class: Hash)
-        return hashed_response if (200..299).include?(response.code.to_i)
+        return [hashed_response, response.body] if (200..299).include?(response.code.to_i)
 
-        error = Parsing::Common::HttpError.new(hashed_response['api_request']['error'])
+        error = Error.handle_error!(@url_name, hashed_response, response.code.to_i)
         raise error
       end
 

data/lib/mindee/http/error.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+module Mindee
+  module HTTP
+    # Mindee HTTP error module.
+    module Error
+      module_function
+
+      # Creates an error object based on what's retrieved from a request.
+      # @param response [Hash] dictionary response retrieved by the server
+      def create_error_obj(response)
+        error_obj = response.respond_to?(:each_pair) ? response.dig('api_request', 'error') : nil
+        if error_obj.nil?
+          error_obj = if response.include?('Maximum pdf pages')
+                        {
+                          'code' => 'TooManyPages',
+                          'message' => 'Maximum amound of pdf pages reached.',
+                          'details' => response,
+                        }
+                      elsif response.include?('Max file size is')
+                        {
+                          'code' => 'FileTooLarge',
+                          'message' => 'Maximum file size reached.',
+                          'details' => response,
+                        }
+                      elsif response.include?('Invalid file type')
+                        {
+                          'code' => 'InvalidFiletype',
+                          'message' => 'Invalid file type.',
+                          'details' => response,
+                        }
+                      elsif response.include?('Gateway timeout')
+                        {
+                          'code' => 'RequestTimeout',
+                          'message' => 'Request timed out.',
+                          'details' => response,
+                        }
+                      elsif response.include?('Too Many Requests')
+                        {
+                          'code' => 'TooManyRequests',
+                          'message' => 'Too Many Requests.',
+                          'details' => response,
+                        }
+                      else
+                        {
+                          'code' => 'UnknownError',
+                          'message' => 'Server sent back an unexpected reply.',
+                          'details' => response,
+                        }
+                      end
+
+        end
+        error_obj
+      end
+
+      # Creates an appropriate HTTP error exception, based on retrieved http error code
+      # @param url [String] the url of the product
+      # @param response [Hash] dictionary response retrieved by the server
+      # @param code [Integer] http error code of the response
+      def handle_error!(url, response, code)
+        error_obj = create_error_obj(response)
+        case code
+        when 400..499
+          MindeeHttpClientError.new(error_obj, url, code)
+        when 500..599
+          MindeeHttpServerError.new(error_obj, url, code)
+        else
+          MindeeHttpError.new(error_obj, url, code)
+        end
+      end
+
+      # API HttpError
+      class MindeeHttpError < StandardError
+        # @return [String]
+        attr_reader :status_code
+        # @return [String]
+        attr_reader :api_code
+        # @return [String]
+        attr_reader :api_details
+        # @return [String]
+        attr_reader :api_message
+
+        # @param http_error [Hash]
+        # @param url [String]
+        # @param code [Integer]
+        def initialize(http_error, url, code)
+          @status_code = code
+          @api_code = http_error['code']
+          @api_details = http_error['details']
+          @api_message = http_error['message']
+          super("#{url} #{@status_code} HTTP error: #{@api_details} - #{@api_message}")
+        end
+      end
+
+      # API client HttpError
+      class MindeeHttpClientError < MindeeHttpError
+      end
+
+      # API server HttpError
+      class MindeeHttpServerError < MindeeHttpError
+      end
+    end
+  end
+end

data/lib/mindee/http.rb

@@ -1,3 +1,4 @@
 # frozen_string_literal: true
 
 require_relative 'http/endpoint'
+require_relative 'http/error'