mindee 4.12.0 → 5.0.0.beta1

data/lib/mindee/v1/product/receipt/receipt_v5_document.rb

@@ -0,0 +1,187 @@
+# frozen_string_literal: true
+
+require_relative '../../parsing'
+require_relative 'receipt_v5_line_items'
+
+module Mindee
+  module V1
+    module Product
+      module Receipt
+        # Receipt API version 5.4 document data.
+        class ReceiptV5Document < Mindee::V1::Parsing::Common::Prediction
+          include Mindee::V1::Parsing::Standard
+
+          # The purchase category of the receipt.
+          # @return [Mindee::V1::Parsing::Standard::ClassificationField]
+          attr_reader :category
+          # The date the purchase was made.
+          # @return [Mindee::V1::Parsing::Standard::DateField]
+          attr_reader :date
+          # The type of receipt: EXPENSE RECEIPT or CREDIT CARD RECEIPT.
+          # @return [Mindee::V1::Parsing::Standard::ClassificationField]
+          attr_reader :document_type
+          # List of all line items on the receipt.
+          # @return [Mindee::V1::Product::Receipt::ReceiptV5LineItems]
+          attr_reader :line_items
+          # The locale of the document.
+          # @return [Mindee::V1::Parsing::Standard::LocaleField]
+          attr_reader :locale
+          # The receipt number or identifier.
+          # @return [Mindee::V1::Parsing::Standard::StringField]
+          attr_reader :receipt_number
+          # The purchase subcategory of the receipt for transport and food.
+          # @return [Mindee::V1::Parsing::Standard::ClassificationField]
+          attr_reader :subcategory
+          # The address of the supplier or merchant.
+          # @return [Mindee::V1::Parsing::Standard::StringField]
+          attr_reader :supplier_address
+          # List of company registration numbers associated to the supplier.
+          # @return [Array<Mindee::V1::Parsing::Standard::CompanyRegistrationField>]
+          attr_reader :supplier_company_registrations
+          # The name of the supplier or merchant.
+          # @return [Mindee::V1::Parsing::Standard::StringField]
+          attr_reader :supplier_name
+          # The phone number of the supplier or merchant.
+          # @return [Mindee::V1::Parsing::Standard::StringField]
+          attr_reader :supplier_phone_number
+          # The list of taxes present on the receipt.
+          # @return [Mindee::V1::Parsing::Standard::Taxes]
+          attr_reader :taxes
+          # The time the purchase was made.
+          # @return [Mindee::V1::Parsing::Standard::StringField]
+          attr_reader :time
+          # The total amount of tip and gratuity.
+          # @return [Mindee::V1::Parsing::Standard::AmountField]
+          attr_reader :tip
+          # The total amount paid: includes taxes, discounts, fees, tips, and gratuity.
+          # @return [Mindee::V1::Parsing::Standard::AmountField]
+          attr_reader :total_amount
+          # The net amount paid: does not include taxes, fees, and discounts.
+          # @return [Mindee::V1::Parsing::Standard::AmountField]
+          attr_reader :total_net
+          # The sum of all taxes.
+          # @return [Mindee::V1::Parsing::Standard::AmountField]
+          attr_reader :total_tax
+
+          # @param prediction [Hash]
+          # @param page_id [Integer, nil]
+          def initialize(prediction, page_id)
+            super
+            @category = Parsing::Standard::ClassificationField.new(
+              prediction['category'],
+              page_id
+            )
+            @date = Parsing::Standard::DateField.new(prediction['date'], page_id)
+            @document_type = Parsing::Standard::ClassificationField.new(
+              prediction['document_type'],
+              page_id
+            )
+            @line_items = Product::Receipt::ReceiptV5LineItems.new(prediction['line_items'], page_id)
+            @locale = Parsing::Standard::LocaleField.new(
+              prediction['locale'],
+              page_id
+            )
+            @receipt_number = Parsing::Standard::StringField.new(
+              prediction['receipt_number'],
+              page_id
+            )
+            @subcategory = Parsing::Standard::ClassificationField.new(
+              prediction['subcategory'],
+              page_id
+            )
+            @supplier_address = Parsing::Standard::StringField.new(
+              prediction['supplier_address'],
+              page_id
+            )
+            @supplier_company_registrations = [] # : Array[Parsing::Standard::CompanyRegistrationField]
+            prediction['supplier_company_registrations'].each do |item|
+              @supplier_company_registrations.push(Parsing::Standard::CompanyRegistrationField.new(item, page_id))
+            end
+            @supplier_name = Parsing::Standard::StringField.new(
+              prediction['supplier_name'],
+              page_id
+            )
+            @supplier_phone_number = Parsing::Standard::StringField.new(
+              prediction['supplier_phone_number'],
+              page_id
+            )
+            @taxes = Parsing::Standard::Taxes.new(prediction['taxes'], page_id)
+            @time = Parsing::Standard::StringField.new(prediction['time'], page_id)
+            @tip = Parsing::Standard::AmountField.new(prediction['tip'], page_id)
+            @total_amount = Parsing::Standard::AmountField.new(
+              prediction['total_amount'],
+              page_id
+            )
+            @total_net = Parsing::Standard::AmountField.new(
+              prediction['total_net'],
+              page_id
+            )
+            @total_tax = Parsing::Standard::AmountField.new(
+              prediction['total_tax'],
+              page_id
+            )
+          end
+
+          # @return [String]
+          def to_s
+            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:Purchase Category: #{@category}".rstrip
+            out_str << "\n:Purchase Subcategory: #{@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 Net: #{@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:Receipt Number: #{@receipt_number}".rstrip
+            out_str << "\n:Line Items:"
+            out_str << line_items
+            out_str[1..].to_s
+          end
+
+          private
+
+          # @param char [String]
+          # @return [String]
+          def line_items_separator(char)
+            out_str = String.new
+            out_str << '  '
+            out_str << "+#{char * 38}"
+            out_str << "+#{char * 10}"
+            out_str << "+#{char * 14}"
+            out_str << "+#{char * 12}"
+            out_str << '+'
+            out_str
+          end
+
+          # @return [String]
+          def line_items_to_s
+            return '' if @line_items.empty?
+
+            line_items = @line_items.map(&:to_table_line).join("\n#{line_items_separator('-')}\n  ")
+            out_str = String.new
+            out_str << "\n#{line_items_separator('-')}"
+            out_str << "\n  |"
+            out_str << ' Description                          |'
+            out_str << ' Quantity |'
+            out_str << ' Total Amount |'
+            out_str << ' Unit Price |'
+            out_str << "\n#{line_items_separator('=')}"
+            out_str << "\n  #{line_items}"
+            out_str << "\n#{line_items_separator('-')}"
+            out_str
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mindee/v1/product/receipt/receipt_v5_line_item.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+require_relative '../../parsing'
+
+module Mindee
+  module V1
+    module Product
+      module Receipt
+        # List of all line items on the receipt.
+        class ReceiptV5LineItem < Mindee::V1::Parsing::Standard::FeatureField
+          include Mindee::V1::Parsing::Standard
+
+          # 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
+
+          # @param prediction [Hash]
+          # @param page_id [Integer, nil]
+          def initialize(prediction, page_id)
+            super
+            @description = prediction['description']
+            @quantity = prediction['quantity']
+            @total_amount = prediction['total_amount']
+            @unit_price = prediction['unit_price']
+            @page_id = page_id
+          end
+
+          # @return [Hash]
+          def printable_values
+            printable = {} # @type var printable: Hash[Symbol, String]
+            printable[:description] = format_for_display(@description)
+            printable[:quantity] =
+              @quantity.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@quantity)
+            printable[:total_amount] =
+              @total_amount.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@total_amount)
+            printable[:unit_price] =
+              @unit_price.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@unit_price)
+            printable
+          end
+
+          # @return [Hash]
+          def table_printable_values
+            printable = {} # @type var printable: Hash[Symbol, String]
+            printable[:description] = format_for_display(@description, 36)
+            printable[:quantity] =
+              @quantity.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@quantity)
+            printable[:total_amount] =
+              @total_amount.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@total_amount)
+            printable[:unit_price] =
+              @unit_price.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@unit_price)
+            printable
+          end
+
+          # @return [String]
+          def to_table_line
+            printable = table_printable_values
+            out_str = String.new
+            out_str << format('| %- 37s', printable[:description])
+            out_str << format('| %- 9s', printable[:quantity])
+            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  :Quantity: #{printable[:quantity]}"
+            out_str << "\n  :Total Amount: #{printable[:total_amount]}"
+            out_str << "\n  :Unit Price: #{printable[:unit_price]}"
+            out_str
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mindee/v1/product/receipt/receipt_v5_line_items.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require_relative 'receipt_v5_line_item'
+
+module Mindee
+  module V1
+    module Product
+      module Receipt
+        # List of all line items on the receipt.
+        class ReceiptV5LineItems < Array
+          # Entries.
+          # @return [Array<ReceiptV5LineItem>]
+          attr_reader :entries
+
+          # @param prediction [Array]
+          # @param page_id [Integer, nil]
+          def initialize(prediction, page_id)
+            entries = prediction.map do |entry|
+              Receipt::ReceiptV5LineItem.new(entry, page_id)
+            end
+            super(entries)
+          end
+
+          # Creates a line of rST table-compliant string separators.
+          # @param char [String] Character to use as a separator.
+          # @return [String]
+          def self.line_items_separator(char)
+            out_str = String.new
+            out_str << "+#{char * 38}"
+            out_str << "+#{char * 10}"
+            out_str << "+#{char * 14}"
+            out_str << "+#{char * 12}"
+            out_str
+          end
+
+          # @return [String]
+          def to_s
+            return '' if empty?
+
+            lines = map do |entry|
+              "\n  #{entry.to_table_line}\n#{self.class.line_items_separator('-')}"
+            end.join
+            out_str = String.new
+            out_str << "\n#{self.class.line_items_separator('-')}\n "
+            out_str << ' | Description                         '
+            out_str << ' | Quantity'
+            out_str << ' | Total Amount'
+            out_str << ' | Unit Price'
+            out_str << " |\n#{self.class.line_items_separator('=')}"
+            out_str + lines
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mindee/v1/product/receipt/receipt_v5_page.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative '../../parsing'
+require_relative 'receipt_v5_document'
+
+module Mindee
+  module V1
+    module Product
+      module Receipt
+        # Receipt API version 5.4 page data.
+        class ReceiptV5Page < Mindee::V1::Parsing::Common::Page
+          # @param prediction [Hash]
+          def initialize(prediction)
+            super
+            @prediction = if prediction['prediction'].empty?
+                            nil
+                          else
+                            ReceiptV5PagePrediction.new(
+                              prediction['prediction'],
+                              prediction['id']
+                            )
+                          end
+          end
+        end
+
+        # Receipt V5 page prediction.
+        class ReceiptV5PagePrediction < ReceiptV5Document
+          # @return [String]
+          def to_s
+            out_str = String.new
+            out_str << "\n#{super}"
+            out_str
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mindee/v1/product/resume/resume_v1.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require_relative '../../parsing'
+require_relative 'resume_v1_document'
+require_relative 'resume_v1_page'
+
+module Mindee
+  module V1
+    module Product
+      # Resume module.
+      module Resume
+        # Resume API version 1 inference prediction.
+        class ResumeV1 < Mindee::V1::Parsing::Common::Inference
+          @endpoint_name = 'resume'
+          @endpoint_version = '1'
+          @has_async = true
+          @has_sync = false
+
+          # @param prediction [Hash]
+          def initialize(prediction)
+            super
+            @prediction = ResumeV1Document.new(prediction['prediction'], nil)
+            @pages = []
+            prediction['pages'].each do |page|
+              @pages.push(ResumeV1Page.new(page))
+            end
+          end
+
+          class << self
+            # Name of the endpoint for this product.
+            # @return [String]
+            attr_reader :endpoint_name
+            # Version for this product.
+            # @return [String]
+            attr_reader :endpoint_version
+            # Whether this product has access to an asynchronous endpoint.
+            # @return [bool]
+            attr_reader :has_async
+            # Whether this product has access to synchronous endpoint.
+            # @return [bool]
+            attr_reader :has_sync
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mindee/v1/product/resume/resume_v1_certificate.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+require_relative '../../parsing'
+
+module Mindee
+  module V1
+    module Product
+      module Resume
+        # The list of certificates obtained by the candidate.
+        class ResumeV1Certificate < Mindee::V1::Parsing::Standard::FeatureField
+          include Mindee::V1::Parsing::Standard
+
+          # The grade obtained for the certificate.
+          # @return [String]
+          attr_reader :grade
+          # The name of certification.
+          # @return [String]
+          attr_reader :name
+          # The organization or institution that issued the certificate.
+          # @return [String]
+          attr_reader :provider
+          # The year when a certificate was issued or received.
+          # @return [String]
+          attr_reader :year
+
+          # @param prediction [Hash]
+          # @param page_id [Integer, nil]
+          def initialize(prediction, page_id)
+            super
+            @grade = prediction['grade']
+            @name = prediction['name']
+            @provider = prediction['provider']
+            @year = prediction['year']
+            @page_id = page_id
+          end
+
+          # @return [Hash]
+          def printable_values
+            printable = {} # @type var printable: Hash[Symbol, String]
+            printable[:grade] = format_for_display(@grade)
+            printable[:name] = format_for_display(@name)
+            printable[:provider] = format_for_display(@provider)
+            printable[:year] = format_for_display(@year)
+            printable
+          end
+
+          # @return [Hash]
+          def table_printable_values
+            printable = {} # @type var printable: Hash[Symbol, String]
+            printable[:grade] = format_for_display(@grade, 10)
+            printable[:name] = format_for_display(@name, 30)
+            printable[:provider] = format_for_display(@provider, 25)
+            printable[:year] = format_for_display(@year, nil)
+            printable
+          end
+
+          # @return [String]
+          def to_table_line
+            printable = table_printable_values
+            out_str = String.new
+            out_str << format('| %- 11s', printable[:grade])
+            out_str << format('| %- 31s', printable[:name])
+            out_str << format('| %- 26s', printable[:provider])
+            out_str << format('| %- 5s', printable[:year])
+            out_str << '|'
+          end
+
+          # @return [String]
+          def to_s
+            printable = printable_values
+            out_str = String.new
+            out_str << "\n  :Grade: #{printable[:grade]}"
+            out_str << "\n  :Name: #{printable[:name]}"
+            out_str << "\n  :Provider: #{printable[:provider]}"
+            out_str << "\n  :Year: #{printable[:year]}"
+            out_str
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mindee/v1/product/resume/resume_v1_certificates.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require_relative 'resume_v1_social_networks_url'
+require_relative 'resume_v1_language'
+require_relative 'resume_v1_education'
+require_relative 'resume_v1_professional_experience'
+require_relative 'resume_v1_certificate'
+
+module Mindee
+  module V1
+    module Product
+      module Resume
+        # The list of certificates obtained by the candidate.
+        class ResumeV1Certificates < Array
+          # Entries.
+          # @return [Array<ResumeV1Certificate>]
+          attr_reader :entries
+
+          # @param prediction [Array]
+          # @param page_id [Integer, nil]
+          def initialize(prediction, page_id)
+            entries = prediction.map do |entry|
+              Resume::ResumeV1Certificate.new(entry, page_id)
+            end
+            super(entries)
+          end
+
+          # Creates a line of rST table-compliant string separators.
+          # @param char [String] Character to use as a separator.
+          # @return [String]
+          def self.line_items_separator(char)
+            out_str = String.new
+            out_str << "+#{char * 12}"
+            out_str << "+#{char * 32}"
+            out_str << "+#{char * 27}"
+            out_str << "+#{char * 6}"
+            out_str
+          end
+
+          # @return [String]
+          def to_s
+            return '' if empty?
+
+            lines = map do |entry|
+              "\n  #{entry.to_table_line}\n#{self.class.line_items_separator('-')}"
+            end.join
+            out_str = String.new
+            out_str << "\n#{self.class.line_items_separator('-')}\n "
+            out_str << ' | Grade     '
+            out_str << ' | Name                          '
+            out_str << ' | Provider                 '
+            out_str << ' | Year'
+            out_str << " |\n#{self.class.line_items_separator('=')}"
+            out_str + lines
+          end
+        end
+      end
+    end
+  end
+end