mindee 3.19.1 → 4.0.0

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require_relative '../../parsing'
-require_relative 'receipt_v5_line_item'
+require_relative 'receipt_v5_line_items'
 
 module Mindee
   module Product
@@ -19,7 +19,7 @@ module Mindee
         # @return [Mindee::Parsing::Standard::ClassificationField]
         attr_reader :document_type
         # List of line item details.
-        # @return [Array<Mindee::Product::Receipt::ReceiptV5LineItem>]
+        # @return [Mindee::Product::Receipt::ReceiptV5LineItems]
         attr_reader :line_items
         # The locale detected on the document.
         # @return [Mindee::Parsing::Standard::LocaleField]
@@ -64,30 +64,60 @@ module Mindee
         # @param prediction [Hash]
         # @param page_id [Integer, nil]
         def initialize(prediction, page_id)
-          super()
-          @category = ClassificationField.new(prediction['category'], page_id)
-          @date = DateField.new(prediction['date'], page_id)
-          @document_type = ClassificationField.new(prediction['document_type'], page_id)
-          @line_items = []
-          prediction['line_items'].each do |item|
-            @line_items.push(ReceiptV5LineItem.new(item, page_id))
-          end
-          @locale = LocaleField.new(prediction['locale'], page_id)
-          @receipt_number = StringField.new(prediction['receipt_number'], page_id)
-          @subcategory = ClassificationField.new(prediction['subcategory'], page_id)
-          @supplier_address = StringField.new(prediction['supplier_address'], page_id)
-          @supplier_company_registrations = []
+          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(CompanyRegistrationField.new(item, page_id))
+            @supplier_company_registrations.push(Parsing::Standard::CompanyRegistrationField.new(item, page_id))
           end
-          @supplier_name = StringField.new(prediction['supplier_name'], page_id)
-          @supplier_phone_number = StringField.new(prediction['supplier_phone_number'], page_id)
-          @taxes = Taxes.new(prediction['taxes'], page_id)
-          @time = StringField.new(prediction['time'], page_id)
-          @tip = AmountField.new(prediction['tip'], 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)
+          @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]

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

@@ -24,7 +24,7 @@ module Mindee
         # @param prediction [Hash]
         # @param page_id [Integer, nil]
         def initialize(prediction, page_id)
-          super(prediction, page_id)
+          super
           @description = prediction['description']
           @quantity = prediction['quantity']
           @total_amount = prediction['total_amount']
@@ -36,9 +36,12 @@ module Mindee
         def printable_values
           printable = {}
           printable[:description] = format_for_display(@description)
-          printable[:quantity] = @quantity.nil? ? '' : Field.float_to_string(@quantity)
-          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[: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
 
@@ -46,9 +49,12 @@ module Mindee
         def table_printable_values
           printable = {}
           printable[:description] = format_for_display(@description, 36)
-          printable[:quantity] = @quantity.nil? ? '' : Field.float_to_string(@quantity)
-          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[: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
 

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

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require_relative 'receipt_v5_line_item'
+
+module Mindee
+  module Product
+    module Receipt
+      # List of line item details.
+      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

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

@@ -10,11 +10,15 @@ module Mindee
       class ReceiptV5Page < Mindee::Parsing::Common::Page
         # @param prediction [Hash]
         def initialize(prediction)
-          super(prediction)
-          @prediction = ReceiptV5PagePrediction.new(
-            prediction['prediction'],
-            prediction['id']
-          )
+          super
+          @prediction = if prediction['prediction'].empty?
+                          nil
+                        else
+                          ReceiptV5PagePrediction.new(
+                            prediction['prediction'],
+                            prediction['id']
+                          )
+                        end
         end
       end
 

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

@@ -12,6 +12,8 @@ module Mindee
       class ResumeV1 < Mindee::Parsing::Common::Inference
         @endpoint_name = 'resume'
         @endpoint_version = '1'
+        @has_async = true
+        @has_sync = false
 
         # @param prediction [Hash]
         def initialize(prediction)
@@ -19,9 +21,7 @@ module Mindee
           @prediction = ResumeV1Document.new(prediction['prediction'], nil)
           @pages = []
           prediction['pages'].each do |page|
-            if page.key?('prediction') && !page['prediction'].nil? && !page['prediction'].empty?
-              @pages.push(ResumeV1Page.new(page))
-            end
+            @pages.push(ResumeV1Page.new(page))
           end
         end
 
@@ -32,6 +32,12 @@ module Mindee
           # 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

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

@@ -24,7 +24,7 @@ module Mindee
         # @param prediction [Hash]
         # @param page_id [Integer, nil]
         def initialize(prediction, page_id)
-          super(prediction, page_id)
+          super
           @grade = prediction['grade']
           @name = prediction['name']
           @provider = prediction['provider']

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

@@ -0,0 +1,58 @@
+# 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 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

data/lib/mindee/product/resume/resume_v1_document.rb

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
 require_relative '../../parsing'
-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'
+require_relative 'resume_v1_social_networks_urls'
+require_relative 'resume_v1_languages'
+require_relative 'resume_v1_educations'
+require_relative 'resume_v1_professional_experiences'
+require_relative 'resume_v1_certificates'
 
 module Mindee
   module Product
@@ -17,7 +17,7 @@ module Mindee
         # @return [Mindee::Parsing::Standard::StringField]
         attr_reader :address
         # The list of certificates obtained by the candidate.
-        # @return [Array<Mindee::Product::Resume::ResumeV1Certificate>]
+        # @return [Mindee::Product::Resume::ResumeV1Certificates]
         attr_reader :certificates
         # The ISO 639 code of the language in which the document is written.
         # @return [Mindee::Parsing::Standard::StringField]
@@ -26,7 +26,7 @@ module Mindee
         # @return [Mindee::Parsing::Standard::ClassificationField]
         attr_reader :document_type
         # The list of the candidate's educational background.
-        # @return [Array<Mindee::Product::Resume::ResumeV1Education>]
+        # @return [Mindee::Product::Resume::ResumeV1Educations]
         attr_reader :education
         # The email address of the candidate.
         # @return [Mindee::Parsing::Standard::StringField]
@@ -41,7 +41,7 @@ module Mindee
         # @return [Mindee::Parsing::Standard::StringField]
         attr_reader :job_applied
         # The list of languages that the candidate is proficient in.
-        # @return [Array<Mindee::Product::Resume::ResumeV1Language>]
+        # @return [Mindee::Product::Resume::ResumeV1Languages]
         attr_reader :languages
         # The ISO 3166 code for the country of citizenship of the candidate.
         # @return [Mindee::Parsing::Standard::StringField]
@@ -53,10 +53,10 @@ module Mindee
         # @return [Mindee::Parsing::Standard::StringField]
         attr_reader :profession
         # The list of the candidate's professional experiences.
-        # @return [Array<Mindee::Product::Resume::ResumeV1ProfessionalExperience>]
+        # @return [Mindee::Product::Resume::ResumeV1ProfessionalExperiences]
         attr_reader :professional_experiences
         # The list of social network profiles of the candidate.
-        # @return [Array<Mindee::Product::Resume::ResumeV1SocialNetworksUrl>]
+        # @return [Mindee::Product::Resume::ResumeV1SocialNetworksUrls]
         attr_reader :social_networks_urls
         # The list of the candidate's interpersonal and communication abilities.
         # @return [Array<Mindee::Parsing::Standard::StringField>]
@@ -68,50 +68,63 @@ module Mindee
         # @param prediction [Hash]
         # @param page_id [Integer, nil]
         def initialize(prediction, page_id)
-          super()
-          @address = StringField.new(prediction['address'], page_id)
-          @certificates = []
-          prediction['certificates'].each do |item|
-            @certificates.push(ResumeV1Certificate.new(item, page_id))
-          end
-          @document_language = StringField.new(prediction['document_language'], page_id)
-          @document_type = ClassificationField.new(prediction['document_type'], page_id)
-          @education = []
-          prediction['education'].each do |item|
-            @education.push(ResumeV1Education.new(item, page_id))
-          end
-          @email_address = StringField.new(prediction['email_address'], page_id)
-          @given_names = []
+          super
+          @address = Parsing::Standard::StringField.new(
+            prediction['address'],
+            page_id
+          )
+          @certificates = Product::Resume::ResumeV1Certificates.new(prediction['certificates'], page_id)
+          @document_language = Parsing::Standard::StringField.new(
+            prediction['document_language'],
+            page_id
+          )
+          @document_type = Parsing::Standard::ClassificationField.new(
+            prediction['document_type'],
+            page_id
+          )
+          @education = Product::Resume::ResumeV1Educations.new(prediction['education'], page_id)
+          @email_address = Parsing::Standard::StringField.new(
+            prediction['email_address'],
+            page_id
+          )
+          @given_names = [] # : Array[Parsing::Standard::StringField]
           prediction['given_names'].each do |item|
-            @given_names.push(StringField.new(item, page_id))
+            @given_names.push(Parsing::Standard::StringField.new(item, page_id))
           end
-          @hard_skills = []
+          @hard_skills = [] # : Array[Parsing::Standard::StringField]
           prediction['hard_skills'].each do |item|
-            @hard_skills.push(StringField.new(item, page_id))
-          end
-          @job_applied = StringField.new(prediction['job_applied'], page_id)
-          @languages = []
-          prediction['languages'].each do |item|
-            @languages.push(ResumeV1Language.new(item, page_id))
-          end
-          @nationality = StringField.new(prediction['nationality'], page_id)
-          @phone_number = StringField.new(prediction['phone_number'], page_id)
-          @profession = StringField.new(prediction['profession'], page_id)
-          @professional_experiences = []
-          prediction['professional_experiences'].each do |item|
-            @professional_experiences.push(ResumeV1ProfessionalExperience.new(item, page_id))
+            @hard_skills.push(Parsing::Standard::StringField.new(item, page_id))
           end
-          @social_networks_urls = []
-          prediction['social_networks_urls'].each do |item|
-            @social_networks_urls.push(ResumeV1SocialNetworksUrl.new(item, page_id))
-          end
-          @soft_skills = []
+          @job_applied = Parsing::Standard::StringField.new(
+            prediction['job_applied'],
+            page_id
+          )
+          @languages = Product::Resume::ResumeV1Languages.new(prediction['languages'], page_id)
+          @nationality = Parsing::Standard::StringField.new(
+            prediction['nationality'],
+            page_id
+          )
+          @phone_number = Parsing::Standard::StringField.new(
+            prediction['phone_number'],
+            page_id
+          )
+          @profession = Parsing::Standard::StringField.new(
+            prediction['profession'],
+            page_id
+          )
+          @professional_experiences = Product::Resume::ResumeV1ProfessionalExperiences.new(
+            prediction['professional_experiences'], page_id
+          )
+          @social_networks_urls = Product::Resume::ResumeV1SocialNetworksUrls.new(
+            prediction['social_networks_urls'], page_id
+          )
+          @soft_skills = [] # : Array[Parsing::Standard::StringField]
           prediction['soft_skills'].each do |item|
-            @soft_skills.push(StringField.new(item, page_id))
+            @soft_skills.push(Parsing::Standard::StringField.new(item, page_id))
           end
-          @surnames = []
+          @surnames = [] # : Array[Parsing::Standard::StringField]
           prediction['surnames'].each do |item|
-            @surnames.push(StringField.new(item, page_id))
+            @surnames.push(Parsing::Standard::StringField.new(item, page_id))
           end
         end
 

data/lib/mindee/product/resume/resume_v1_education.rb

@@ -33,7 +33,7 @@ module Mindee
         # @param prediction [Hash]
         # @param page_id [Integer, nil]
         def initialize(prediction, page_id)
-          super(prediction, page_id)
+          super
           @degree_domain = prediction['degree_domain']
           @degree_type = prediction['degree_type']
           @end_month = prediction['end_month']

data/lib/mindee/product/resume/resume_v1_educations.rb

@@ -0,0 +1,64 @@
+# 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 Product
+    module Resume
+      # The list of the candidate's educational background.
+      class ResumeV1Educations < Array
+        # Entries.
+        # @return [Array<ResumeV1Education>]
+        attr_reader :entries
+
+        # @param prediction [Array]
+        # @param page_id [Integer, nil]
+        def initialize(prediction, page_id)
+          entries = prediction.map do |entry|
+            Resume::ResumeV1Education.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 * 17}"
+          out_str << "+#{char * 27}"
+          out_str << "+#{char * 11}"
+          out_str << "+#{char * 10}"
+          out_str << "+#{char * 27}"
+          out_str << "+#{char * 13}"
+          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 << ' | Domain         '
+          out_str << ' | Degree                   '
+          out_str << ' | End Month'
+          out_str << ' | End Year'
+          out_str << ' | School                   '
+          out_str << ' | Start Month'
+          out_str << ' | Start Year'
+          out_str << (" |\n#{self.class.line_items_separator('=')}")
+          out_str + lines
+        end
+      end
+    end
+  end
+end

data/lib/mindee/product/resume/resume_v1_language.rb

@@ -18,7 +18,7 @@ module Mindee
         # @param prediction [Hash]
         # @param page_id [Integer, nil]
         def initialize(prediction, page_id)
-          super(prediction, page_id)
+          super
           @language = prediction['language']
           @level = prediction['level']
           @page_id = page_id

data/lib/mindee/product/resume/resume_v1_languages.rb

@@ -0,0 +1,54 @@
+# 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 Product
+    module Resume
+      # The list of languages that the candidate is proficient in.
+      class ResumeV1Languages < Array
+        # Entries.
+        # @return [Array<ResumeV1Language>]
+        attr_reader :entries
+
+        # @param prediction [Array]
+        # @param page_id [Integer, nil]
+        def initialize(prediction, page_id)
+          entries = prediction.map do |entry|
+            Resume::ResumeV1Language.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 * 10}"
+          out_str << "+#{char * 22}"
+          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 << ' | Language'
+          out_str << ' | Level               '
+          out_str << (" |\n#{self.class.line_items_separator('=')}")
+          out_str + lines
+        end
+      end
+    end
+  end
+end

data/lib/mindee/product/resume/resume_v1_page.rb

@@ -10,11 +10,15 @@ module Mindee
       class ResumeV1Page < Mindee::Parsing::Common::Page
         # @param prediction [Hash]
         def initialize(prediction)
-          super(prediction)
-          @prediction = ResumeV1PagePrediction.new(
-            prediction['prediction'],
-            prediction['id']
-          )
+          super
+          @prediction = if prediction['prediction'].empty?
+                          nil
+                        else
+                          ResumeV1PagePrediction.new(
+                            prediction['prediction'],
+                            prediction['id']
+                          )
+                        end
         end
       end
 

data/lib/mindee/product/resume/resume_v1_professional_experience.rb

@@ -39,7 +39,7 @@ module Mindee
         # @param prediction [Hash]
         # @param page_id [Integer, nil]
         def initialize(prediction, page_id)
-          super(prediction, page_id)
+          super
           @contract_type = prediction['contract_type']
           @department = prediction['department']
           @description = prediction['description']