mindee 3.6.1 → 3.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d18b48dabb484d078d9fe9ccbe4266d80fde752fb261c13ec6143e69c0ebe0c8
-  data.tar.gz: 9340689c20fa1d161461252a379f0754fe7482dbac8fb89407845fc501ac4ae1
+  metadata.gz: 0b22c708fcdd44e0e5104e5b5e0f9cf669b7f41e46f1c627af252b86ed5b45d7
+  data.tar.gz: 5695f02623e644bbce0d26a3cec7096370d103b01914a97402887a87eba8cc2d
 SHA512:
-  metadata.gz: c74414360e4f02582286e8e49e1fbff59dbc654c75876717268f6f3805c7dfbfbd14729828dde8a86d53b8fcbe3eaca0bf0c988dd66919d54c9cfbc719e6b49f
-  data.tar.gz: d14ac158a9d719cdfe2f5ecc5ba0b6a16eb6bae3ce83474a285be980cb00791acfe0e71aa9bb6dbd17945264168ce19f7e5ca75746083994d8a8d0927d76b43f
+  metadata.gz: 6b1e14cdac5f7e0a54d5326a2a9a54387568bddc7060e505468ee3f56896cba9a6d1da341d9a5918f695e99ef7aa79d95d065b43a692f8f036892fd0c4fae070
+  data.tar.gz: 92a95c7c1802fc6099a5ce13a869add7d7865ace5331c8d5a449ca4ed83d4e5e6573a193ed151e75f7b4ec8c2da41f30bd23cc2c71e1889d83ddf4012978123d

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Mindee Ruby API Library Changelog
 
+## v3.6.2 - 2024-03-28
+### Changes
+* :sparkles: update Invoice to v4.5
+### Fixes
+* :bug: fix invalid error codes
+
+
 ## v3.6.1 - 2024-03-07
 ### Changes
 * :recycle: update error handling to account for future evolutions

data/docs/invoices_v4.md

@@ -34,12 +34,12 @@ puts result.document
 ########
 Document
 ########
-:Mindee ID: 80f2328c-58a5-486a-9599-eb2d738680f0
+:Mindee ID: a9062dd1-0d34-42ab-9505-0481a8545106
 :Filename: default_sample.jpg
 
 Inference
 #########
-:Product: mindee/invoices v4.4
+:Product: mindee/invoices v4.5
 :Rotation applied: Yes
 
 Prediction
@@ -65,6 +65,8 @@ Prediction
 :Customer Name: JIRO DOI
 :Customer Company Registrations:
 :Customer Address: 1954 Bloor Street West Toronto, ON, M6P 3K9 Canada
+:Shipping Address:
+:Billing Address: 1954 Bloor Street West Toronto, ON, M6P 3K9 Canada
 :Document Type: INVOICE
 :Line Items:
   +--------------------------------------+--------------+----------+------------+--------------+--------------+------------+
@@ -103,6 +105,8 @@ Page 0
 :Customer Name: JIRO DOI
 :Customer Company Registrations:
 :Customer Address: 1954 Bloor Street West Toronto, ON, M6P 3K9 Canada
+:Shipping Address:
+:Billing Address: 1954 Bloor Street West Toronto, ON, M6P 3K9 Canada
 :Document Type: INVOICE
 :Line Items:
   +--------------------------------------+--------------+----------+------------+--------------+--------------+------------+
@@ -205,6 +209,13 @@ A `InvoiceV4LineItem` implements the following attributes:
 # Attributes
 The following fields are extracted for Invoice V4:
 
+## Billing Address
+**billing_address** ([StringField](#string-field)): The customer's address used for billing.
+
+```rb
+puts result.document.inference.prediction.billing_address.value
+```
+
 ## Customer Address
 **customer_address** ([StringField](#string-field)): The address of the customer.
 
@@ -281,6 +292,13 @@ for reference_numbers_elem in result.document.inference.prediction.reference_num
 end
 ```
 
+## Shipping Address
+**shipping_address** ([StringField](#string-field)): Customer's delivery address.
+
+```rb
+puts result.document.inference.prediction.shipping_address.value
+```
+
 ## Supplier Address
 **supplier_address** ([StringField](#string-field)): The address of the supplier or merchant.
 

data/lib/mindee/client.rb

@@ -138,9 +138,9 @@ module Mindee
     #  * `: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 4.
-    # @param delay_sec [Integer, Float, nil] delay between polling attempts. Defaults to 2.
-    # @param max_retries [Integer, nil] maximum amount of retries. Defaults to 60.
+    # @param initial_delay_sec [Integer, Float] initial delay before polling. Defaults to 4.
+    # @param delay_sec [Integer, Float] delay between polling attempts. Defaults to 2.
+    # @param max_retries [Integer] maximum amount of retries. Defaults to 60.
     # @return [Mindee::Parsing::Common::ApiResponse]
     def enqueue_and_parse(
       input_source,
@@ -167,7 +167,7 @@ module Mindee
       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)
+      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

data/lib/mindee/http/error.rb

@@ -8,10 +8,22 @@ module Mindee
     module Error
       module_function
 
+      # Extracts the HTTP error from the response hash, or the job error if there is one.
+      # @param response [Hash] dictionary response retrieved by the server
+      def extract_error(response)
+        return unless response.respond_to?(:each_pair)
+
+        if !response.dig('api_request', 'error').empty?
+          response.dig('api_request', 'error')
+        elsif !response.dig('job', 'error').empty?
+          response.dig('job', 'error')
+        end
+      end
+
       # 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
+        error_obj = extract_error(response)
         if error_obj.nil?
           error_obj = if response.include?('Maximum pdf pages')
                         {

data/lib/mindee/http/response_validation.rb

@@ -31,6 +31,9 @@ module Mindee
         return false unless (200..302).cover?(response.code.to_i)
 
         hashed_response = JSON.parse(response.body, object_class: Hash)
+
+        return false if hashed_response.dig('job', 'status') == Mindee::Parsing::Common::JobStatus::FAILURE
+
         return false if hashed_response.dig('job', 'error') && !hashed_response.dig('job', 'error').empty?
 
         true
@@ -41,13 +44,15 @@ module Mindee
       def self.clean_request!(response)
         return response if (response.code.to_i < 200) || (response.code.to_i > 302)
 
-        return response unless response.body.empty?
+        return response if response.body.empty?
 
         hashed_response = JSON.parse(response.body, object_class: Hash)
         if hashed_response.dig('api_request', 'status_code').to_i > 399
           response.instance_variable_set(:@code, hashed_response['api_request']['status_code'].to_s)
         end
-        return unless hashed_response.dig('job', 'error').empty?
+
+        return if !hashed_response.dig('job', 'error').empty? &&
+                  (hashed_response.dig('job', 'status') != Mindee::Parsing::Common::JobStatus::FAILURE.to_s)
 
         response.instance_variable_set(:@code, '500')
       end

data/lib/mindee/product/invoice/invoice_v4_document.rb

@@ -9,6 +9,9 @@ module Mindee
       # Invoice V4 document prediction.
       class InvoiceV4Document < Mindee::Parsing::Common::Prediction
         include Mindee::Parsing::Standard
+        # The customer's address used for billing.
+        # @return [Mindee::Parsing::Standard::StringField]
+        attr_reader :billing_address
         # The address of the customer.
         # @return [Mindee::Parsing::Standard::StringField]
         attr_reader :customer_address
@@ -39,6 +42,9 @@ module Mindee
         # List of Reference numbers, including PO number.
         # @return [Array<Mindee::Parsing::Standard::StringField>]
         attr_reader :reference_numbers
+        # Customer's delivery address.
+        # @return [Mindee::Parsing::Standard::StringField]
+        attr_reader :shipping_address
         # The address of the supplier or merchant.
         # @return [Mindee::Parsing::Standard::StringField]
         attr_reader :supplier_address
@@ -68,6 +74,7 @@ module Mindee
         # @param page_id [Integer, nil]
         def initialize(prediction, page_id)
           super()
+          @billing_address = StringField.new(prediction['billing_address'], page_id)
           @customer_address = StringField.new(prediction['customer_address'], page_id)
           @customer_company_registrations = []
           prediction['customer_company_registrations'].each do |item|
@@ -87,6 +94,7 @@ module Mindee
           prediction['reference_numbers'].each do |item|
             @reference_numbers.push(StringField.new(item, page_id))
           end
+          @shipping_address = StringField.new(prediction['shipping_address'], page_id)
           @supplier_address = StringField.new(prediction['supplier_address'], page_id)
           @supplier_company_registrations = []
           prediction['supplier_company_registrations'].each do |item|
@@ -127,6 +135,8 @@ module Mindee
           out_str << "\n:Customer Name: #{@customer_name}".rstrip
           out_str << "\n:Customer Company Registrations: #{customer_company_registrations}".rstrip
           out_str << "\n:Customer Address: #{@customer_address}".rstrip
+          out_str << "\n:Shipping Address: #{@shipping_address}".rstrip
+          out_str << "\n:Billing Address: #{@billing_address}".rstrip
           out_str << "\n:Document Type: #{@document_type}".rstrip
           out_str << "\n:Line Items:"
           out_str << line_items

data/lib/mindee/version.rb

@@ -3,7 +3,7 @@
 # Mindee
 module Mindee
   # Current version.
-  VERSION = '3.6.1'
+  VERSION = '3.7.0'
 
   # 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.6.1
+  version: 3.7.0
 platform: ruby
 authors:
 - Mindee, SA
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-03-07 00:00:00.000000000 Z
+date: 2024-03-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: marcel