mindee 3.19.0 → 3.19.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ef56483dc0576b931b3d88b57e4512abd44ea4e216ed29dc1097ada3fa5b00fb
-  data.tar.gz: 8d4f6c2b99c113439b2332244cd89619189704bc75655121c26ba0122118d539
+  metadata.gz: bca81cfda2aa389c5892c16d68e78cb3204a029fe21265180e3de2478a6f8054
+  data.tar.gz: 3004a181239a458018f90258efe35940d1c466a890f92d7f221248970a13a3eb
 SHA512:
-  metadata.gz: a0461aea7ba2804e36ddc833e1ec24888227484d1ad1f1471b8b8859cfaffc14a94f623672b749fe0f73584c6c215f26d87f2e11cbeb701fc8cc9cf86088ec6f
-  data.tar.gz: aed38431cddde8abc620cf4701ecf7299929a0216b0a9e717d7ef56732211fb38ae12d093fca8839cbd981c43047f0a87088587c44fc7f4c9ff9f4ae56438f7d
+  metadata.gz: a2482ecc51f3259b7ffd0b45c4239ef42ba961a83c8c93bc50fe60503857e033d5397dc41ee3fb1defbcb5320ebb134a6aeba7c8b4ba31fa6255f5c7f95b632c
+  data.tar.gz: 6f3d4b075a60c4e9ca8d01b5474568c4799df6584dc777b74489d2228d2c14d0009eca9def8f3ddda7e07527ab6fb79e80b6e9bee996025516a54256b0846b49

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Mindee Ruby API Library Changelog
 
+## v3.19.1 - 2025-01-21
+### Changes
+* :bug: fix extras failing at document level if missing from prediction
+
+
 ## v3.19.0 - 2025-01-14
 ### Changes
 * :sparkles: add support for US Mail V3

data/README.md

@@ -162,6 +162,54 @@ Using the ruby bundler:
 bundle exec ruby ./bin/mindee.rb invoice path/to/your/file.ext
 ```
 
+
+### Enqueue and Parse a Webhook Response
+This is an optional way of handling asynchronous APIs.
+
+```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
+enqueue_response = mindee_client.enqueue(
+  input_source,
+  Mindee::Product::InternationalId::InternationalIdV2
+)
+
+job_id = enqueue_response.job.id
+
+# Load the JSON string sent by the Mindee webhook POST callback.
+# Reading the callback data will vary greatly depending on your HTTP server.
+# This is therefore beyond the scope of this example.
+
+local_response = Mindee::Input::LocalResponse.new(request.body.string)
+
+# You can also use a File object as the input.
+# FILE_PATH = File.join('path', 'to', 'file.json').freeze
+# local_response = Mindee::Input::LocalResponse.new(FILE_PATH);
+
+# Optional: verify the HMAC signature.
+unless local_response.valid_hmac_signature?(my_secret_key, 'invalid signature')
+  raise "Invalid HMAC signature!"
+end
+
+
+# Deserialize the response:
+result = mindee_client.load_prediction(
+        Mindee::Product::InternationalId::InternationalIdV2,
+        local_response
+)
+
+# Print a full summary of the parsed data in RST format
+puts result.document
+```
+
 ## Further Reading
 
 There's more to it than that for those that need more features, or want to

data/lib/mindee/parsing/common/document.rb

@@ -61,8 +61,7 @@ module Mindee
         private
 
         def inject_full_text_ocr(raw_prediction)
-          return unless raw_prediction.dig('inference', 'pages') &&
-                        raw_prediction['inference']['pages'][0]['extras']['full_text_ocr']
+          return unless raw_prediction.dig('inference', 'pages', 0, 'extras', 'full_text_ocr')
 
           full_text_ocr = String.new
           raw_prediction.dig('inference', 'pages').each do |page|

data/lib/mindee/version.rb

@@ -3,7 +3,7 @@
 # Mindee
 module Mindee
   # Current version.
-  VERSION = '3.19.0'
+  VERSION = '3.19.1'
 
   # Finds and return the current platform.
   # @return [String]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mindee
 version: !ruby/object:Gem::Version
-  version: 3.19.0
+  version: 3.19.1
 platform: ruby
 authors:
 - Mindee, SA
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-01-14 00:00:00.000000000 Z
+date: 2025-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: marcel