mindee 3.2.0 → 3.3.1

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

@@ -5,61 +5,85 @@ require_relative '../../parsing'
 module Mindee
   module Product
     module Invoice
-      # Line items for Invoice V4
-      class InvoiceV4LineItem
-        include Mindee::Parsing::Common
+      # List of line item details.
+      class InvoiceV4LineItem < Mindee::Parsing::Standard::FeatureField
         include Mindee::Parsing::Standard
-        # @return [String] The product code referring to the item.
-        attr_reader :product_code
+        # The item description.
         # @return [String]
         attr_reader :description
+        # The product code referring to the item.
+        # @return [String]
+        attr_reader :product_code
+        # The item quantity
         # @return [Float]
         attr_reader :quantity
+        # The item tax amount.
         # @return [Float]
-        attr_reader :unit_price
+        attr_reader :tax_amount
+        # The item tax rate in percentage.
         # @return [Float]
-        attr_reader :total_amount
-        # @return [Float] The item tax rate percentage.
         attr_reader :tax_rate
+        # The item total amount.
         # @return [Float]
-        attr_reader :tax_amount
+        attr_reader :total_amount
+        # The item unit price.
         # @return [Float]
-        attr_reader :confidence
-        # @return [Integer]
-        attr_reader :page_id
-        # @return [Mindee::Geometry::Quadrilateral]
-        attr_reader :bounding_box
-        # @return [Array<Mindee::Geometry::Polygon>]
-        attr_reader :polygon
+        attr_reader :unit_price
 
         # @param prediction [Hash]
         # @param page_id [Integer, nil]
         def initialize(prediction, page_id)
+          super(prediction, page_id)
+          @description = prediction['description']
           @product_code = prediction['product_code']
           @quantity = prediction['quantity']
-          @unit_price = prediction['unit_price']
-          @total_amount = prediction['total_amount']
           @tax_amount = prediction['tax_amount']
           @tax_rate = prediction['tax_rate']
-          @description = prediction['description']
+          @total_amount = prediction['total_amount']
+          @unit_price = prediction['unit_price']
           @page_id = page_id
         end
 
+        # @return [Hash]
+        def printable_values
+          printable = {}
+          printable[:description] = format_for_display(@description, 36)
+          printable[:product_code] = format_for_display(@product_code, nil)
+          printable[:quantity] = @quantity.nil? ? '' : Field.float_to_string(@quantity)
+          printable[:tax_amount] = @tax_amount.nil? ? '' : Field.float_to_string(@tax_amount)
+          printable[:tax_rate] = @tax_rate.nil? ? '' : Field.float_to_string(@tax_rate)
+          printable[:total_amount] = @total_amount.nil? ? '' : Field.float_to_string(@total_amount)
+          printable[:unit_price] = @unit_price.nil? ? '' : Field.float_to_string(@unit_price)
+          printable
+        end
+
         # @return [String]
-        def to_s
-          tax = Field.float_to_string(@tax_amount)
-          tax << " (#{Field.float_to_string(@tax_rate)}%)" unless @tax_rate.nil?
-          description = @description.nil? ? '' : @description
-          description = "#{description[0..32]}..." if description.size > 35
+        def to_table_line
+          printable = printable_values
           out_str = String.new
-          out_str << format('| %- 20s', @product_code)
-          out_str << " #{format('| %- 7s', Field.float_to_string(@quantity))}"
-          out_str << " #{format('| %- 7s', Field.float_to_string(@unit_price))}"
-          out_str << " #{format('| %- 8s', Field.float_to_string(@total_amount))}"
-          out_str << " #{format('| %- 16s', tax)}"
-          out_str << " #{format('| %- 37s', description)}"
+          out_str << format('| %- 37s', printable[:description])
+          out_str << format('| %- 13s', printable[:product_code])
+          out_str << format('| %- 9s', printable[:quantity])
+          out_str << format('| %- 11s', printable[:tax_amount])
+          out_str << format('| %- 13s', printable[:tax_rate])
+          out_str << format('| %- 13s', printable[:total_amount])
+          out_str << format('| %- 11s', printable[:unit_price])
           out_str << '|'
         end
+
+        # @return [String]
+        def to_s
+          printable = printable_values
+          out_str = String.new
+          out_str << "\n  :Description: #{printable[:description]}"
+          out_str << "\n  :Product code: #{printable[:product_code]}"
+          out_str << "\n  :Quantity: #{printable[:quantity]}"
+          out_str << "\n  :Tax Amount: #{printable[:tax_amount]}"
+          out_str << "\n  :Tax Rate (%): #{printable[:tax_rate]}"
+          out_str << "\n  :Total Amount: #{printable[:total_amount]}"
+          out_str << "\n  :Unit Price: #{printable[:unit_price]}"
+          out_str
+        end
       end
     end
   end

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

@@ -7,9 +7,9 @@ require_relative 'w9_v1_page'
 module Mindee
   module Product
     module US
-      # US W9 module.
+      # W9 module.
       module W9
-        # US W9 V1 prediction inference.
+        # W9 V1 prediction inference.
         class W9V1 < Mindee::Parsing::Common::Inference
           @endpoint_name = 'us_w9'
           @endpoint_version = '1'

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

@@ -6,7 +6,7 @@ module Mindee
   module Product
     module US
       module W9
-        # US W9 V1 document prediction.
+        # W9 V1 document prediction.
         class W9V1Document < Mindee::Parsing::Common::Prediction
         end
       end

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

@@ -7,7 +7,7 @@ module Mindee
   module Product
     module US
       module W9
-        # US W9 V1 page.
+        # W9 V1 page.
         class W9V1Page < Mindee::Parsing::Common::Page
           # @param prediction [Hash]
           def initialize(prediction)
@@ -19,7 +19,7 @@ module Mindee
           end
         end
 
-        # US W9 V1 page prediction.
+        # W9 V1 page prediction.
         class W9V1PagePrediction < W9V1Document
           include Mindee::Parsing::Standard
 

data/lib/mindee/product.rb

@@ -16,6 +16,7 @@ require_relative 'product/fr/bank_account_details/bank_account_details_v2'
 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'
+require_relative 'product/fr/carte_grise/carte_grise_v1'
 require_relative 'product/invoice_splitter/invoice_splitter_v1'
 require_relative 'product/us/bank_check/bank_check_v1'
 require_relative 'product/us/driver_license/driver_license_v1'

data/lib/mindee/version.rb

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

data/lib/mindee.rb

@@ -5,9 +5,6 @@ require 'mindee/client'
 module Mindee
   # Mindee internal http module.
   module HTTP
-    # Global Mindee HTTP error handler.
-    class HttpError < StandardError
-    end
   end
 
   # PDF-specific operations.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mindee
 version: !ruby/object:Gem::Version
-  version: 3.2.0
+  version: 3.3.1
 platform: ruby
 authors:
 - Mindee, SA
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-09-18 00:00:00.000000000 Z
+date: 2023-12-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: marcel
@@ -120,11 +120,13 @@ files:
 - docs/bank_account_details_v2.md
 - docs/bank_check_v1.md
 - docs/barcode_reader_v1.md
+- docs/carte_grise_v1.md
 - docs/carte_vitale_v1.md
 - docs/code_samples/bank_account_details_v1.txt
 - docs/code_samples/bank_account_details_v2.txt
 - docs/code_samples/bank_check_v1.txt
 - docs/code_samples/barcode_reader_v1.txt
+- docs/code_samples/carte_grise_v1.txt
 - docs/code_samples/carte_vitale_v1.txt
 - docs/code_samples/cropper_v1.txt
 - docs/code_samples/custom_v1.txt
@@ -224,6 +226,9 @@ files:
 - lib/mindee/product/fr/bank_account_details/bank_account_details_v2_bban.rb
 - lib/mindee/product/fr/bank_account_details/bank_account_details_v2_document.rb
 - lib/mindee/product/fr/bank_account_details/bank_account_details_v2_page.rb
+- lib/mindee/product/fr/carte_grise/carte_grise_v1.rb
+- lib/mindee/product/fr/carte_grise/carte_grise_v1_document.rb
+- lib/mindee/product/fr/carte_grise/carte_grise_v1_page.rb
 - lib/mindee/product/fr/carte_vitale/carte_vitale_v1.rb
 - lib/mindee/product/fr/carte_vitale/carte_vitale_v1_document.rb
 - lib/mindee/product/fr/carte_vitale/carte_vitale_v1_page.rb