mindee 3.4.0 → 3.6.0

data/lib/mindee/product/international_id/international_id_v2_document.rb

@@ -0,0 +1,119 @@
+# frozen_string_literal: true
+
+require_relative '../../parsing'
+
+module Mindee
+  module Product
+    module InternationalId
+      # International ID V2 document prediction.
+      class InternationalIdV2Document < Mindee::Parsing::Common::Prediction
+        include Mindee::Parsing::Standard
+        # The physical address of the document holder.
+        # @return [Mindee::Parsing::Standard::StringField]
+        attr_reader :address
+        # The date of birth of the document holder.
+        # @return [Mindee::Parsing::Standard::DateField]
+        attr_reader :birth_date
+        # The place of birth of the document holder.
+        # @return [Mindee::Parsing::Standard::StringField]
+        attr_reader :birth_place
+        # The country where the document was issued.
+        # @return [Mindee::Parsing::Standard::StringField]
+        attr_reader :country_of_issue
+        # The unique identifier assigned to the document.
+        # @return [Mindee::Parsing::Standard::StringField]
+        attr_reader :document_number
+        # The type of personal identification document.
+        # @return [Mindee::Parsing::Standard::ClassificationField]
+        attr_reader :document_type
+        # The date when the document becomes invalid.
+        # @return [Mindee::Parsing::Standard::DateField]
+        attr_reader :expiry_date
+        # The list of the document holder's given names.
+        # @return [Array<Mindee::Parsing::Standard::StringField>]
+        attr_reader :given_names
+        # The date when the document was issued.
+        # @return [Mindee::Parsing::Standard::DateField]
+        attr_reader :issue_date
+        # The Machine Readable Zone, first line.
+        # @return [Mindee::Parsing::Standard::StringField]
+        attr_reader :mrz_line1
+        # The Machine Readable Zone, second line.
+        # @return [Mindee::Parsing::Standard::StringField]
+        attr_reader :mrz_line2
+        # The Machine Readable Zone, third line.
+        # @return [Mindee::Parsing::Standard::StringField]
+        attr_reader :mrz_line3
+        # The country of citizenship of the document holder.
+        # @return [Mindee::Parsing::Standard::StringField]
+        attr_reader :nationality
+        # The unique identifier assigned to the document holder.
+        # @return [Mindee::Parsing::Standard::StringField]
+        attr_reader :personal_number
+        # The biological sex of the document holder.
+        # @return [Mindee::Parsing::Standard::StringField]
+        attr_reader :sex
+        # The state or territory where the document was issued.
+        # @return [Mindee::Parsing::Standard::StringField]
+        attr_reader :state_of_issue
+        # The list of the document holder's family names.
+        # @return [Array<Mindee::Parsing::Standard::StringField>]
+        attr_reader :surnames
+
+        # @param prediction [Hash]
+        # @param page_id [Integer, nil]
+        def initialize(prediction, page_id)
+          super()
+          @address = StringField.new(prediction['address'], page_id)
+          @birth_date = DateField.new(prediction['birth_date'], page_id)
+          @birth_place = StringField.new(prediction['birth_place'], page_id)
+          @country_of_issue = StringField.new(prediction['country_of_issue'], page_id)
+          @document_number = StringField.new(prediction['document_number'], page_id)
+          @document_type = ClassificationField.new(prediction['document_type'], page_id)
+          @expiry_date = DateField.new(prediction['expiry_date'], page_id)
+          @given_names = []
+          prediction['given_names'].each do |item|
+            @given_names.push(StringField.new(item, page_id))
+          end
+          @issue_date = DateField.new(prediction['issue_date'], page_id)
+          @mrz_line1 = StringField.new(prediction['mrz_line1'], page_id)
+          @mrz_line2 = StringField.new(prediction['mrz_line2'], page_id)
+          @mrz_line3 = StringField.new(prediction['mrz_line3'], page_id)
+          @nationality = StringField.new(prediction['nationality'], page_id)
+          @personal_number = StringField.new(prediction['personal_number'], page_id)
+          @sex = StringField.new(prediction['sex'], page_id)
+          @state_of_issue = StringField.new(prediction['state_of_issue'], page_id)
+          @surnames = []
+          prediction['surnames'].each do |item|
+            @surnames.push(StringField.new(item, page_id))
+          end
+        end
+
+        # @return [String]
+        def to_s
+          surnames = @surnames.join("\n #{' ' * 10}")
+          given_names = @given_names.join("\n #{' ' * 13}")
+          out_str = String.new
+          out_str << "\n:Document Type: #{@document_type}".rstrip
+          out_str << "\n:Document Number: #{@document_number}".rstrip
+          out_str << "\n:Surnames: #{surnames}".rstrip
+          out_str << "\n:Given Names: #{given_names}".rstrip
+          out_str << "\n:Sex: #{@sex}".rstrip
+          out_str << "\n:Birth Date: #{@birth_date}".rstrip
+          out_str << "\n:Birth Place: #{@birth_place}".rstrip
+          out_str << "\n:Nationality: #{@nationality}".rstrip
+          out_str << "\n:Personal Number: #{@personal_number}".rstrip
+          out_str << "\n:Country of Issue: #{@country_of_issue}".rstrip
+          out_str << "\n:State of Issue: #{@state_of_issue}".rstrip
+          out_str << "\n:Issue Date: #{@issue_date}".rstrip
+          out_str << "\n:Expiration Date: #{@expiry_date}".rstrip
+          out_str << "\n:Address: #{@address}".rstrip
+          out_str << "\n:MRZ Line 1: #{@mrz_line1}".rstrip
+          out_str << "\n:MRZ Line 2: #{@mrz_line2}".rstrip
+          out_str << "\n:MRZ Line 3: #{@mrz_line3}".rstrip
+          out_str[1..].to_s
+        end
+      end
+    end
+  end
+end

data/lib/mindee/product/international_id/international_id_v2_page.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative '../../parsing'
+require_relative 'international_id_v2_document'
+
+module Mindee
+  module Product
+    module InternationalId
+      # International ID V2 page.
+      class InternationalIdV2Page < Mindee::Parsing::Common::Page
+        # @param prediction [Hash]
+        def initialize(prediction)
+          super(prediction)
+          @prediction = InternationalIdV2PagePrediction.new(
+            prediction['prediction'],
+            prediction['id']
+          )
+        end
+      end
+
+      # International ID V2 page prediction.
+      class InternationalIdV2PagePrediction < InternationalIdV2Document
+        # @return [String]
+        def to_s
+          out_str = String.new
+          out_str << "\n#{super}"
+          out_str
+        end
+      end
+    end
+  end
+end

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

@@ -19,7 +19,9 @@ module Mindee
           @prediction = InvoiceV4Document.new(prediction['prediction'], nil)
           @pages = []
           prediction['pages'].each do |page|
-            @pages.push(InvoiceV4Page.new(page))
+            if page.key?('prediction') && !page['prediction'].nil? && !page['prediction'].empty?
+              @pages.push(InvoiceV4Page.new(page))
+            end
           end
         end
 

data/lib/mindee/product/multi_receipts_detector/multi_receipts_detector_v1.rb

@@ -19,7 +19,9 @@ module Mindee
           @prediction = MultiReceiptsDetectorV1Document.new(prediction['prediction'], nil)
           @pages = []
           prediction['pages'].each do |page|
-            @pages.push(MultiReceiptsDetectorV1Page.new(page))
+            if page.key?('prediction') && !page['prediction'].nil? && !page['prediction'].empty?
+              @pages.push(MultiReceiptsDetectorV1Page.new(page))
+            end
           end
         end
 

data/lib/mindee/product/passport/passport_v1.rb

@@ -19,7 +19,9 @@ module Mindee
           @prediction = PassportV1Document.new(prediction['prediction'], nil)
           @pages = []
           prediction['pages'].each do |page|
-            @pages.push(PassportV1Page.new(page))
+            if page.key?('prediction') && !page['prediction'].nil? && !page['prediction'].empty?
+              @pages.push(PassportV1Page.new(page))
+            end
           end
         end
 

data/lib/mindee/product/proof_of_address/proof_of_address_v1.rb

@@ -19,7 +19,9 @@ module Mindee
           @prediction = ProofOfAddressV1Document.new(prediction['prediction'], nil)
           @pages = []
           prediction['pages'].each do |page|
-            @pages.push(ProofOfAddressV1Page.new(page))
+            if page.key?('prediction') && !page['prediction'].nil? && !page['prediction'].empty?
+              @pages.push(ProofOfAddressV1Page.new(page))
+            end
           end
         end
 

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

@@ -19,7 +19,9 @@ module Mindee
           @prediction = ReceiptV5Document.new(prediction['prediction'], nil)
           @pages = []
           prediction['pages'].each do |page|
-            @pages.push(ReceiptV5Page.new(page))
+            if page.key?('prediction') && !page['prediction'].nil? && !page['prediction'].empty?
+              @pages.push(ReceiptV5Page.new(page))
+            end
           end
         end
 

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

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative '../../parsing'
+require_relative 'resume_v1_document'
+require_relative 'resume_v1_page'
+
+module Mindee
+  module Product
+    # Resume module.
+    module Resume
+      # Resume V1 prediction inference.
+      class ResumeV1 < Mindee::Parsing::Common::Inference
+        @endpoint_name = 'resume'
+        @endpoint_version = '1'
+
+        # @param prediction [Hash]
+        def initialize(prediction)
+          super
+          @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
+          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
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require_relative '../../parsing'
+
+module Mindee
+  module Product
+    module Resume
+      # The list of certificates obtained by the candidate.
+      class ResumeV1Certificate < Mindee::Parsing::Standard::FeatureField
+        include Mindee::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(prediction, page_id)
+          @grade = prediction['grade']
+          @name = prediction['name']
+          @provider = prediction['provider']
+          @year = prediction['year']
+          @page_id = page_id
+        end
+
+        # @return [Hash]
+        def printable_values
+          printable = {}
+          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 = 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

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

@@ -0,0 +1,322 @@
+# 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'
+
+module Mindee
+  module Product
+    module Resume
+      # Resume V1 document prediction.
+      class ResumeV1Document < Mindee::Parsing::Common::Prediction
+        include Mindee::Parsing::Standard
+        # The location information of the candidate, including city, state, and country.
+        # @return [Mindee::Parsing::Standard::StringField]
+        attr_reader :address
+        # The list of certificates obtained by the candidate.
+        # @return [Array<Mindee::Product::Resume::ResumeV1Certificate>]
+        attr_reader :certificates
+        # The ISO 639 code of the language in which the document is written.
+        # @return [Mindee::Parsing::Standard::StringField]
+        attr_reader :document_language
+        # The type of the document sent.
+        # @return [Mindee::Parsing::Standard::ClassificationField]
+        attr_reader :document_type
+        # The list of the candidate's educational background.
+        # @return [Array<Mindee::Product::Resume::ResumeV1Education>]
+        attr_reader :education
+        # The email address of the candidate.
+        # @return [Mindee::Parsing::Standard::StringField]
+        attr_reader :email_address
+        # The candidate's first or given names.
+        # @return [Array<Mindee::Parsing::Standard::StringField>]
+        attr_reader :given_names
+        # The list of the candidate's technical abilities and knowledge.
+        # @return [Array<Mindee::Parsing::Standard::StringField>]
+        attr_reader :hard_skills
+        # The position that the candidate is applying for.
+        # @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>]
+        attr_reader :languages
+        # The ISO 3166 code for the country of citizenship of the candidate.
+        # @return [Mindee::Parsing::Standard::StringField]
+        attr_reader :nationality
+        # The phone number of the candidate.
+        # @return [Mindee::Parsing::Standard::StringField]
+        attr_reader :phone_number
+        # The candidate's current profession.
+        # @return [Mindee::Parsing::Standard::StringField]
+        attr_reader :profession
+        # The list of the candidate's professional experiences.
+        # @return [Array<Mindee::Product::Resume::ResumeV1ProfessionalExperience>]
+        attr_reader :professional_experiences
+        # The list of social network profiles of the candidate.
+        # @return [Array<Mindee::Product::Resume::ResumeV1SocialNetworksUrl>]
+        attr_reader :social_networks_urls
+        # The list of the candidate's interpersonal and communication abilities.
+        # @return [Array<Mindee::Parsing::Standard::StringField>]
+        attr_reader :soft_skills
+        # The candidate's last names.
+        # @return [Array<Mindee::Parsing::Standard::StringField>]
+        attr_reader :surnames
+
+        # @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 = []
+          prediction['given_names'].each do |item|
+            @given_names.push(StringField.new(item, page_id))
+          end
+          @hard_skills = []
+          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))
+          end
+          @social_networks_urls = []
+          prediction['social_networks_urls'].each do |item|
+            @social_networks_urls.push(ResumeV1SocialNetworksUrl.new(item, page_id))
+          end
+          @soft_skills = []
+          prediction['soft_skills'].each do |item|
+            @soft_skills.push(StringField.new(item, page_id))
+          end
+          @surnames = []
+          prediction['surnames'].each do |item|
+            @surnames.push(StringField.new(item, page_id))
+          end
+        end
+
+        # @return [String]
+        def to_s
+          given_names = @given_names.join("\n #{' ' * 13}")
+          surnames = @surnames.join("\n #{' ' * 10}")
+          social_networks_urls = social_networks_urls_to_s
+          languages = languages_to_s
+          hard_skills = @hard_skills.join("\n #{' ' * 13}")
+          soft_skills = @soft_skills.join("\n #{' ' * 13}")
+          education = education_to_s
+          professional_experiences = professional_experiences_to_s
+          certificates = certificates_to_s
+          out_str = String.new
+          out_str << "\n:Document Language: #{@document_language}".rstrip
+          out_str << "\n:Document Type: #{@document_type}".rstrip
+          out_str << "\n:Given Names: #{given_names}".rstrip
+          out_str << "\n:Surnames: #{surnames}".rstrip
+          out_str << "\n:Nationality: #{@nationality}".rstrip
+          out_str << "\n:Email Address: #{@email_address}".rstrip
+          out_str << "\n:Phone Number: #{@phone_number}".rstrip
+          out_str << "\n:Address: #{@address}".rstrip
+          out_str << "\n:Social Networks:"
+          out_str << social_networks_urls
+          out_str << "\n:Profession: #{@profession}".rstrip
+          out_str << "\n:Job Applied: #{@job_applied}".rstrip
+          out_str << "\n:Languages:"
+          out_str << languages
+          out_str << "\n:Hard Skills: #{hard_skills}".rstrip
+          out_str << "\n:Soft Skills: #{soft_skills}".rstrip
+          out_str << "\n:Education:"
+          out_str << education
+          out_str << "\n:Professional Experiences:"
+          out_str << professional_experiences
+          out_str << "\n:Certificates:"
+          out_str << certificates
+          out_str[1..].to_s
+        end
+
+        private
+
+        # @param char [String]
+        # @return [String]
+        def social_networks_urls_separator(char)
+          out_str = String.new
+          out_str << '  '
+          out_str << "+#{char * 22}"
+          out_str << "+#{char * 52}"
+          out_str << '+'
+          out_str
+        end
+
+        # @return [String]
+        def social_networks_urls_to_s
+          return '' if @social_networks_urls.empty?
+
+          line_items = @social_networks_urls.map(&:to_table_line).join("\n#{social_networks_urls_separator('-')}\n  ")
+          out_str = String.new
+          out_str << "\n#{social_networks_urls_separator('-')}"
+          out_str << "\n  |"
+          out_str << ' Name                 |'
+          out_str << ' URL                                                |'
+          out_str << "\n#{social_networks_urls_separator('=')}"
+          out_str << "\n  #{line_items}"
+          out_str << "\n#{social_networks_urls_separator('-')}"
+          out_str
+        end
+
+        # @param char [String]
+        # @return [String]
+        def languages_separator(char)
+          out_str = String.new
+          out_str << '  '
+          out_str << "+#{char * 10}"
+          out_str << "+#{char * 22}"
+          out_str << '+'
+          out_str
+        end
+
+        # @return [String]
+        def languages_to_s
+          return '' if @languages.empty?
+
+          line_items = @languages.map(&:to_table_line).join("\n#{languages_separator('-')}\n  ")
+          out_str = String.new
+          out_str << "\n#{languages_separator('-')}"
+          out_str << "\n  |"
+          out_str << ' Language |'
+          out_str << ' Level                |'
+          out_str << "\n#{languages_separator('=')}"
+          out_str << "\n  #{line_items}"
+          out_str << "\n#{languages_separator('-')}"
+          out_str
+        end
+
+        # @param char [String]
+        # @return [String]
+        def education_separator(char)
+          out_str = String.new
+          out_str << '  '
+          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 << '+'
+          out_str
+        end
+
+        # @return [String]
+        def education_to_s
+          return '' if @education.empty?
+
+          line_items = @education.map(&:to_table_line).join("\n#{education_separator('-')}\n  ")
+          out_str = String.new
+          out_str << "\n#{education_separator('-')}"
+          out_str << "\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#{education_separator('=')}"
+          out_str << "\n  #{line_items}"
+          out_str << "\n#{education_separator('-')}"
+          out_str
+        end
+
+        # @param char [String]
+        # @return [String]
+        def professional_experiences_separator(char)
+          out_str = String.new
+          out_str << '  '
+          out_str << "+#{char * 17}"
+          out_str << "+#{char * 12}"
+          out_str << "+#{char * 27}"
+          out_str << "+#{char * 11}"
+          out_str << "+#{char * 10}"
+          out_str << "+#{char * 22}"
+          out_str << "+#{char * 13}"
+          out_str << "+#{char * 12}"
+          out_str << '+'
+          out_str
+        end
+
+        # @return [String]
+        def professional_experiences_to_s
+          return '' if @professional_experiences.empty?
+
+          line_items = @professional_experiences.map(&:to_table_line).join(
+            "\n#{professional_experiences_separator('-')}\n  "
+          )
+          out_str = String.new
+          out_str << "\n#{professional_experiences_separator('-')}"
+          out_str << "\n  |"
+          out_str << ' Contract Type   |'
+          out_str << ' Department |'
+          out_str << ' Employer                  |'
+          out_str << ' End Month |'
+          out_str << ' End Year |'
+          out_str << ' Role                 |'
+          out_str << ' Start Month |'
+          out_str << ' Start Year |'
+          out_str << "\n#{professional_experiences_separator('=')}"
+          out_str << "\n  #{line_items}"
+          out_str << "\n#{professional_experiences_separator('-')}"
+          out_str
+        end
+
+        # @param char [String]
+        # @return [String]
+        def certificates_separator(char)
+          out_str = String.new
+          out_str << '  '
+          out_str << "+#{char * 12}"
+          out_str << "+#{char * 32}"
+          out_str << "+#{char * 27}"
+          out_str << "+#{char * 6}"
+          out_str << '+'
+          out_str
+        end
+
+        # @return [String]
+        def certificates_to_s
+          return '' if @certificates.empty?
+
+          line_items = @certificates.map(&:to_table_line).join("\n#{certificates_separator('-')}\n  ")
+          out_str = String.new
+          out_str << "\n#{certificates_separator('-')}"
+          out_str << "\n  |"
+          out_str << ' Grade      |'
+          out_str << ' Name                           |'
+          out_str << ' Provider                  |'
+          out_str << ' Year |'
+          out_str << "\n#{certificates_separator('=')}"
+          out_str << "\n  #{line_items}"
+          out_str << "\n#{certificates_separator('-')}"
+          out_str
+        end
+      end
+    end
+  end
+end