mindee 3.5.0 → 3.6.0

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

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

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+require_relative '../../parsing'
+
+module Mindee
+  module Product
+    module Resume
+      # The list of the candidate's educational background.
+      class ResumeV1Education < Mindee::Parsing::Standard::FeatureField
+        include Mindee::Parsing::Standard
+        # The area of study or specialization.
+        # @return [String]
+        attr_reader :degree_domain
+        # The type of degree obtained, such as Bachelor's, Master's, or Doctorate.
+        # @return [String]
+        attr_reader :degree_type
+        # The month when the education program or course was completed.
+        # @return [String]
+        attr_reader :end_month
+        # The year when the education program or course was completed.
+        # @return [String]
+        attr_reader :end_year
+        # The name of the school.
+        # @return [String]
+        attr_reader :school
+        # The month when the education program or course began.
+        # @return [String]
+        attr_reader :start_month
+        # The year when the education program or course began.
+        # @return [String]
+        attr_reader :start_year
+
+        # @param prediction [Hash]
+        # @param page_id [Integer, nil]
+        def initialize(prediction, page_id)
+          super(prediction, page_id)
+          @degree_domain = prediction['degree_domain']
+          @degree_type = prediction['degree_type']
+          @end_month = prediction['end_month']
+          @end_year = prediction['end_year']
+          @school = prediction['school']
+          @start_month = prediction['start_month']
+          @start_year = prediction['start_year']
+          @page_id = page_id
+        end
+
+        # @return [Hash]
+        def printable_values
+          printable = {}
+          printable[:degree_domain] = format_for_display(@degree_domain, 15)
+          printable[:degree_type] = format_for_display(@degree_type, 25)
+          printable[:end_month] = format_for_display(@end_month, nil)
+          printable[:end_year] = format_for_display(@end_year, nil)
+          printable[:school] = format_for_display(@school, 25)
+          printable[:start_month] = format_for_display(@start_month, nil)
+          printable[:start_year] = format_for_display(@start_year, nil)
+          printable
+        end
+
+        # @return [String]
+        def to_table_line
+          printable = printable_values
+          out_str = String.new
+          out_str << format('| %- 16s', printable[:degree_domain])
+          out_str << format('| %- 26s', printable[:degree_type])
+          out_str << format('| %- 10s', printable[:end_month])
+          out_str << format('| %- 9s', printable[:end_year])
+          out_str << format('| %- 26s', printable[:school])
+          out_str << format('| %- 12s', printable[:start_month])
+          out_str << format('| %- 11s', printable[:start_year])
+          out_str << '|'
+        end
+
+        # @return [String]
+        def to_s
+          printable = printable_values
+          out_str = String.new
+          out_str << "\n  :Domain: #{printable[:degree_domain]}"
+          out_str << "\n  :Degree: #{printable[:degree_type]}"
+          out_str << "\n  :End Month: #{printable[:end_month]}"
+          out_str << "\n  :End Year: #{printable[:end_year]}"
+          out_str << "\n  :School: #{printable[:school]}"
+          out_str << "\n  :Start Month: #{printable[:start_month]}"
+          out_str << "\n  :Start Year: #{printable[:start_year]}"
+          out_str
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require_relative '../../parsing'
+
+module Mindee
+  module Product
+    module Resume
+      # The list of languages that the candidate is proficient in.
+      class ResumeV1Language < Mindee::Parsing::Standard::FeatureField
+        include Mindee::Parsing::Standard
+        # The language's ISO 639 code.
+        # @return [String]
+        attr_reader :language
+        # The candidate's level for the language.
+        # @return [String]
+        attr_reader :level
+
+        # @param prediction [Hash]
+        # @param page_id [Integer, nil]
+        def initialize(prediction, page_id)
+          super(prediction, page_id)
+          @language = prediction['language']
+          @level = prediction['level']
+          @page_id = page_id
+        end
+
+        # @return [Hash]
+        def printable_values
+          printable = {}
+          printable[:language] = format_for_display(@language, nil)
+          printable[:level] = format_for_display(@level, 20)
+          printable
+        end
+
+        # @return [String]
+        def to_table_line
+          printable = printable_values
+          out_str = String.new
+          out_str << format('| %- 9s', printable[:language])
+          out_str << format('| %- 21s', printable[:level])
+          out_str << '|'
+        end
+
+        # @return [String]
+        def to_s
+          printable = printable_values
+          out_str = String.new
+          out_str << "\n  :Language: #{printable[:language]}"
+          out_str << "\n  :Level: #{printable[:level]}"
+          out_str
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative '../../parsing'
+require_relative 'resume_v1_document'
+
+module Mindee
+  module Product
+    module Resume
+      # Resume V1 page.
+      class ResumeV1Page < Mindee::Parsing::Common::Page
+        # @param prediction [Hash]
+        def initialize(prediction)
+          super(prediction)
+          @prediction = ResumeV1PagePrediction.new(
+            prediction['prediction'],
+            prediction['id']
+          )
+        end
+      end
+
+      # Resume V1 page prediction.
+      class ResumeV1PagePrediction < ResumeV1Document
+        # @return [String]
+        def to_s
+          out_str = String.new
+          out_str << "\n#{super}"
+          out_str
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+require_relative '../../parsing'
+
+module Mindee
+  module Product
+    module Resume
+      # The list of the candidate's professional experiences.
+      class ResumeV1ProfessionalExperience < Mindee::Parsing::Standard::FeatureField
+        include Mindee::Parsing::Standard
+        # The type of contract for the professional experience.
+        # @return [String]
+        attr_reader :contract_type
+        # The specific department or division within the company.
+        # @return [String]
+        attr_reader :department
+        # The name of the company or organization.
+        # @return [String]
+        attr_reader :employer
+        # The month when the professional experience ended.
+        # @return [String]
+        attr_reader :end_month
+        # The year when the professional experience ended.
+        # @return [String]
+        attr_reader :end_year
+        # The position or job title held by the candidate.
+        # @return [String]
+        attr_reader :role
+        # The month when the professional experience began.
+        # @return [String]
+        attr_reader :start_month
+        # The year when the professional experience began.
+        # @return [String]
+        attr_reader :start_year
+
+        # @param prediction [Hash]
+        # @param page_id [Integer, nil]
+        def initialize(prediction, page_id)
+          super(prediction, page_id)
+          @contract_type = prediction['contract_type']
+          @department = prediction['department']
+          @employer = prediction['employer']
+          @end_month = prediction['end_month']
+          @end_year = prediction['end_year']
+          @role = prediction['role']
+          @start_month = prediction['start_month']
+          @start_year = prediction['start_year']
+          @page_id = page_id
+        end
+
+        # @return [Hash]
+        def printable_values
+          printable = {}
+          printable[:contract_type] = format_for_display(@contract_type, 15)
+          printable[:department] = format_for_display(@department, 10)
+          printable[:employer] = format_for_display(@employer, 25)
+          printable[:end_month] = format_for_display(@end_month, nil)
+          printable[:end_year] = format_for_display(@end_year, nil)
+          printable[:role] = format_for_display(@role, 20)
+          printable[:start_month] = format_for_display(@start_month, nil)
+          printable[:start_year] = format_for_display(@start_year, nil)
+          printable
+        end
+
+        # @return [String]
+        def to_table_line
+          printable = printable_values
+          out_str = String.new
+          out_str << format('| %- 16s', printable[:contract_type])
+          out_str << format('| %- 11s', printable[:department])
+          out_str << format('| %- 26s', printable[:employer])
+          out_str << format('| %- 10s', printable[:end_month])
+          out_str << format('| %- 9s', printable[:end_year])
+          out_str << format('| %- 21s', printable[:role])
+          out_str << format('| %- 12s', printable[:start_month])
+          out_str << format('| %- 11s', printable[:start_year])
+          out_str << '|'
+        end
+
+        # @return [String]
+        def to_s
+          printable = printable_values
+          out_str = String.new
+          out_str << "\n  :Contract Type: #{printable[:contract_type]}"
+          out_str << "\n  :Department: #{printable[:department]}"
+          out_str << "\n  :Employer: #{printable[:employer]}"
+          out_str << "\n  :End Month: #{printable[:end_month]}"
+          out_str << "\n  :End Year: #{printable[:end_year]}"
+          out_str << "\n  :Role: #{printable[:role]}"
+          out_str << "\n  :Start Month: #{printable[:start_month]}"
+          out_str << "\n  :Start Year: #{printable[:start_year]}"
+          out_str
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require_relative '../../parsing'
+
+module Mindee
+  module Product
+    module Resume
+      # The list of social network profiles of the candidate.
+      class ResumeV1SocialNetworksUrl < Mindee::Parsing::Standard::FeatureField
+        include Mindee::Parsing::Standard
+        # The name of the social network.
+        # @return [String]
+        attr_reader :name
+        # The URL of the social network.
+        # @return [String]
+        attr_reader :url
+
+        # @param prediction [Hash]
+        # @param page_id [Integer, nil]
+        def initialize(prediction, page_id)
+          super(prediction, page_id)
+          @name = prediction['name']
+          @url = prediction['url']
+          @page_id = page_id
+        end
+
+        # @return [Hash]
+        def printable_values
+          printable = {}
+          printable[:name] = format_for_display(@name, 20)
+          printable[:url] = format_for_display(@url, 50)
+          printable
+        end
+
+        # @return [String]
+        def to_table_line
+          printable = printable_values
+          out_str = String.new
+          out_str << format('| %- 21s', printable[:name])
+          out_str << format('| %- 51s', printable[:url])
+          out_str << '|'
+        end
+
+        # @return [String]
+        def to_s
+          printable = printable_values
+          out_str = String.new
+          out_str << "\n  :Name: #{printable[:name]}"
+          out_str << "\n  :URL: #{printable[:url]}"
+          out_str
+        end
+      end
+    end
+  end
+end

data/lib/mindee/product.rb

@@ -23,6 +23,7 @@ require_relative 'product/generated/generated_v1'
 require_relative 'product/invoice_splitter/invoice_splitter_v1'
 require_relative 'product/international_id/international_id_v1'
 require_relative 'product/international_id/international_id_v2'
+require_relative 'product/resume/resume_v1'
 require_relative 'product/us/bank_check/bank_check_v1'
 require_relative 'product/us/driver_license/driver_license_v1'
 require_relative 'product/us/w9/w9_v1'

data/lib/mindee/version.rb

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