mindee 2.1.0 → 2.2.0

data/lib/mindee/parsing/prediction/receipt/receipt_v5.rb

@@ -0,0 +1,136 @@
+# frozen_string_literal: true
+
+require_relative '../common_fields'
+require_relative '../base'
+require_relative 'receipt_v5_line_item'
+
+module Mindee
+  module Prediction
+    # Expense Receipt v5 prediction results.
+    class ReceiptV5 < Prediction
+      # The locale identifier in BCP 47 (RFC 5646) format: ISO language code, '-', ISO country code.
+      # @return [Mindee::Locale]
+      attr_reader :locale
+      # The receipt category among predefined classes.
+      # @return [Mindee::TextField]
+      attr_reader :category
+      # The receipt sub category among predefined classes for transport and food.
+      # @return [Mindee::TextField]
+      attr_reader :subcategory
+      # Whether the document is an expense receipt or a credit card receipt.
+      # @return [Mindee::TextField]
+      attr_reader :document_type
+      # The date the purchase was made.
+      # @return [Mindee::DateField]
+      attr_reader :date
+      # Time of purchase with 24 hours formatting (HH:MM).
+      # @return [Mindee::TextField]
+      attr_reader :time
+      # The total amount paid including taxes, discounts, fees, tips, and gratuity.
+      # @return [Mindee::AmountField]
+      attr_reader :total_amount
+      # The total amount excluding taxes.
+      # @return [Mindee::AmountField]
+      attr_reader :total_net
+      # The total amount of taxes.
+      # @return [Mindee::AmountField]
+      attr_reader :total_tax
+      # The total amount of tip and gratuity.
+      # @return [Mindee::AmountField]
+      attr_reader :tip
+      # List of tax lines information including: Amount, tax rate, tax base amount and tax code.
+      # @return [Array<Mindee::TaxField>]
+      attr_reader :taxes
+      # The name of the supplier or merchant.
+      # @return [Mindee::TextField]
+      attr_reader :supplier_name
+      # List of supplier company registrations or identifiers.
+      # @return [Array<Mindee::CompanyRegistration>]
+      attr_reader :supplier_company_registrations
+      # The address of the supplier or merchant returned as a single string.
+      # @return [Mindee::TextField]
+      attr_reader :supplier_address
+      # The Phone number of the supplier or merchant returned as a single string.
+      # @return [Mindee::TextField]
+      attr_reader :supplier_phone_number
+      # Full extraction of lines, including: description, quantity, unit price and total.
+      # @return [Array<Mindee::ReceiptV5LineItem>]
+      attr_reader :line_items
+
+      # @param prediction [Hash]
+      # @param page_id [Integer, nil]
+      def initialize(prediction, page_id)
+        super
+        @locale = Locale.new(prediction['locale'], page_id)
+        @category = TextField.new(prediction['category'], page_id)
+        @subcategory = TextField.new(prediction['subcategory'], page_id)
+        @document_type = TextField.new(prediction['document_type'], page_id)
+        @date = DateField.new(prediction['date'], page_id)
+        @time = TextField.new(prediction['time'], page_id)
+        @total_amount = AmountField.new(prediction['total_amount'], page_id)
+        @total_net = AmountField.new(prediction['total_net'], page_id)
+        @total_tax = AmountField.new(prediction['total_tax'], page_id)
+        @tip = AmountField.new(prediction['tip'], page_id)
+        @taxes = []
+        prediction['taxes'].each do |item|
+          @taxes.push(TaxField.new(item, page_id))
+        end
+        @supplier_name = TextField.new(prediction['supplier_name'], page_id)
+        @supplier_company_registrations = []
+        prediction['supplier_company_registrations'].each do |item|
+          @supplier_company_registrations.push(CompanyRegistration.new(item, page_id))
+        end
+        @supplier_address = TextField.new(prediction['supplier_address'], page_id)
+        @supplier_phone_number = TextField.new(prediction['supplier_phone_number'], page_id)
+        @line_items = []
+        prediction['line_items'].each do |item|
+          @line_items.push(ReceiptV5LineItem.new(item, page_id))
+        end
+      end
+
+      # @return String
+      def to_s
+        taxes = @taxes.join("\n #{' ' * 7}")
+        supplier_company_registrations = @supplier_company_registrations.join("\n #{' ' * 32}")
+        line_items = line_items_to_s
+        out_str = String.new
+        out_str << "\n:Expense Locale: #{@locale}".rstrip
+        out_str << "\n:Expense Category: #{@category}".rstrip
+        out_str << "\n:Expense Sub Category: #{@subcategory}".rstrip
+        out_str << "\n:Document Type: #{@document_type}".rstrip
+        out_str << "\n:Purchase Date: #{@date}".rstrip
+        out_str << "\n:Purchase Time: #{@time}".rstrip
+        out_str << "\n:Total Amount: #{@total_amount}".rstrip
+        out_str << "\n:Total Excluding Taxes: #{@total_net}".rstrip
+        out_str << "\n:Total Tax: #{@total_tax}".rstrip
+        out_str << "\n:Tip and Gratuity: #{@tip}".rstrip
+        out_str << "\n:Taxes: #{taxes}".rstrip
+        out_str << "\n:Supplier Name: #{@supplier_name}".rstrip
+        out_str << "\n:Supplier Company Registrations: #{supplier_company_registrations}".rstrip
+        out_str << "\n:Supplier Address: #{@supplier_address}".rstrip
+        out_str << "\n:Supplier Phone Number: #{@supplier_phone_number}".rstrip
+        out_str << "\n:Line Items:"
+        out_str << line_items
+        out_str[1..].to_s
+      end
+
+      private
+
+      def line_items_separator(char)
+        "  +#{char * 38}+#{char * 10}+#{char * 14}+#{char * 12}+"
+      end
+
+      def line_items_to_s
+        return '' if @line_items.empty?
+
+        line_items = @line_items.map(&:to_s).join("\n#{line_items_separator('-')}\n  ")
+        out_str = String.new
+        out_str << "\n#{line_items_separator('-')}"
+        out_str << "\n  | Description #{' ' * 25}| Quantity | Total Amount | Unit Price |"
+        out_str << "\n#{line_items_separator('=')}"
+        out_str << "\n  #{line_items}"
+        out_str << "\n#{line_items_separator('-')}"
+      end
+    end
+  end
+end

data/lib/mindee/parsing/prediction/receipt/receipt_v5_line_item.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Mindee
+  # Full extraction of lines, including: description, quantity, unit price and total.
+  class ReceiptV5LineItem
+    # The item description.
+    # @return [String]
+    attr_reader :description
+    # The item quantity.
+    # @return [Float]
+    attr_reader :quantity
+    # The item total amount.
+    # @return [Float]
+    attr_reader :total_amount
+    # The item unit price.
+    # @return [Float]
+    attr_reader :unit_price
+
+    def initialize(prediction, page_id)
+      @description = prediction['description']
+      @quantity = prediction['quantity']
+      @total_amount = prediction['total_amount']
+      @unit_price = prediction['unit_price']
+      @page_id = page_id
+    end
+
+    # @return String
+    def to_s
+      out_str = String.new
+      out_str << format('| %- 37s', @description)
+      out_str << format('| %- 9s', Field.float_to_string(@quantity))
+      out_str << format('| %- 13s', Field.float_to_string(@total_amount))
+      out_str << format('| %- 11s', Field.float_to_string(@unit_price))
+      out_str << '|'
+    end
+  end
+end

data/lib/mindee/parsing/prediction/shipping_container/shipping_container_v1.rb

@@ -29,8 +29,8 @@ module Mindee
       def to_s
         out_str = String.new
         out_str << "\n:Owner: #{@owner}".rstrip
-        out_str << "\n:Serial number: #{@serial_number}".rstrip
-        out_str << "\n:Size and type: #{@size_type}".rstrip
+        out_str << "\n:Serial Number: #{@serial_number}".rstrip
+        out_str << "\n:Size and Type: #{@size_type}".rstrip
         out_str[1..].to_s
       end
     end

data/lib/mindee/parsing/prediction.rb

@@ -6,6 +6,7 @@ require_relative 'prediction/financial_document/financial_document_v1'
 require_relative 'prediction/invoice/invoice_v4'
 require_relative 'prediction/passport/passport_v1'
 require_relative 'prediction/receipt/receipt_v4'
+require_relative 'prediction/receipt/receipt_v5'
 require_relative 'prediction/eu/license_plate/license_plate_v1'
 require_relative 'prediction/shipping_container/shipping_container_v1'
 require_relative 'prediction/us/bank_check/bank_check_v1'

data/lib/mindee/version.rb

@@ -2,7 +2,7 @@
 
 # Mindee
 module Mindee
-  VERSION = '2.1.0'
+  VERSION = '2.2.0'
 
   def self.find_platform
     host = RbConfig::CONFIG['host_os']

data/mindee.gemspec

@@ -30,11 +30,10 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = Gem::Requirement.new('>= 2.6')
 
   spec.add_runtime_dependency 'marcel', '~> 1.0.2'
-  spec.add_runtime_dependency 'mrz', '~> 0.2'
-  spec.add_runtime_dependency 'origamindee', '~> 3.1'
+  spec.add_runtime_dependency 'origamindee', '~> 3.1.0'
 
-  spec.add_development_dependency 'rake', '~> 12.3.1'
-  spec.add_development_dependency 'rspec', '~> 3.11'
-  spec.add_development_dependency 'rubocop', '~> 1.41'
-  spec.add_development_dependency 'yard', '0.9.28'
+  spec.add_development_dependency 'rake', '~> 12.3.3'
+  spec.add_development_dependency 'rspec', '~> 3.12.0'
+  spec.add_development_dependency 'rubocop', '~> 1.49.0'
+  spec.add_development_dependency 'yard', '~> 0.9.34'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mindee
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Mindee, SA
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-01-30 00:00:00.000000000 Z
+date: 2023-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: marcel
@@ -24,90 +24,76 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.0.2
-- !ruby/object:Gem::Dependency
-  name: mrz
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.2'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.2'
 - !ruby/object:Gem::Dependency
   name: origamindee
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: 3.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: 3.1.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 12.3.1
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 12.3.1
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.11'
+        version: 3.12.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.11'
+        version: 3.12.0
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.41'
+        version: 1.49.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.41'
+        version: 1.49.0
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.28
+        version: 0.9.34
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.28
+        version: 0.9.34
 description: Quickly and easily connect to Mindee's API services using Ruby.
 email:
 - devrel@mindee.co
@@ -131,6 +117,20 @@ files:
 - Rakefile
 - bin/console
 - bin/mindee.rb
+- docs/code_samples/bank_account_details_v1.txt
+- docs/code_samples/bank_check_v1.txt
+- docs/code_samples/carte_vitale_v1.txt
+- docs/code_samples/custom_v1.txt
+- docs/code_samples/default.txt
+- docs/code_samples/expense_receipts_v4.txt
+- docs/code_samples/expense_receipts_v5.txt
+- docs/code_samples/financial_document_v1.txt
+- docs/code_samples/idcard_fr_v1.txt
+- docs/code_samples/invoices_v4.txt
+- docs/code_samples/license_plates_v1.txt
+- docs/code_samples/passport_v1.txt
+- docs/code_samples/proof_of_address_v1.txt
+- docs/code_samples/shipping_containers_v1.txt
 - docs/ruby-api-builder.md
 - docs/ruby-getting-started.md
 - docs/ruby-invoice-ocr.md
@@ -165,15 +165,17 @@ files:
 - lib/mindee/parsing/prediction/custom/fields.rb
 - lib/mindee/parsing/prediction/eu/license_plate/license_plate_v1.rb
 - lib/mindee/parsing/prediction/financial_document/financial_document_v1.rb
-- lib/mindee/parsing/prediction/financial_document/invoice_line_item.rb
+- lib/mindee/parsing/prediction/financial_document/financial_document_v1_line_item.rb
 - lib/mindee/parsing/prediction/fr/bank_account_details/bank_account_details_v1.rb
 - lib/mindee/parsing/prediction/fr/carte_vitale/carte_vitale_v1.rb
 - lib/mindee/parsing/prediction/fr/id_card/id_card_v1.rb
-- lib/mindee/parsing/prediction/invoice/invoice_line_item.rb
 - lib/mindee/parsing/prediction/invoice/invoice_v4.rb
+- lib/mindee/parsing/prediction/invoice/invoice_v4_line_item.rb
 - lib/mindee/parsing/prediction/passport/passport_v1.rb
 - lib/mindee/parsing/prediction/proof_of_address/proof_of_address_v1.rb
 - lib/mindee/parsing/prediction/receipt/receipt_v4.rb
+- lib/mindee/parsing/prediction/receipt/receipt_v5.rb
+- lib/mindee/parsing/prediction/receipt/receipt_v5_line_item.rb
 - lib/mindee/parsing/prediction/shipping_container/shipping_container_v1.rb
 - lib/mindee/parsing/prediction/us/bank_check/bank_check_v1.rb
 - lib/mindee/version.rb