mindee-lite 5.0.0.beta1

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

@@ -0,0 +1,340 @@
+# frozen_string_literal: true
+
+require_relative '../../parsing'
+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 V1
+    module Product
+      module Resume
+        # Resume API version 1.2 document data.
+        class ResumeV1Document < Mindee::V1::Parsing::Common::Prediction
+          include Mindee::V1::Parsing::Standard
+
+          # The location information of the candidate, including city, state, and country.
+          # @return [Mindee::V1::Parsing::Standard::StringField]
+          attr_reader :address
+          # The list of certificates obtained by the candidate.
+          # @return [Mindee::V1::Product::Resume::ResumeV1Certificates]
+          attr_reader :certificates
+          # The ISO 639 code of the language in which the document is written.
+          # @return [Mindee::V1::Parsing::Standard::StringField]
+          attr_reader :document_language
+          # The type of the document sent.
+          # @return [Mindee::V1::Parsing::Standard::ClassificationField]
+          attr_reader :document_type
+          # The list of the candidate's educational background.
+          # @return [Mindee::V1::Product::Resume::ResumeV1Educations]
+          attr_reader :education
+          # The email address of the candidate.
+          # @return [Mindee::V1::Parsing::Standard::StringField]
+          attr_reader :email_address
+          # The candidate's first or given names.
+          # @return [Array<Mindee::V1::Parsing::Standard::StringField>]
+          attr_reader :given_names
+          # The list of the candidate's technical abilities and knowledge.
+          # @return [Array<Mindee::V1::Parsing::Standard::StringField>]
+          attr_reader :hard_skills
+          # The position that the candidate is applying for.
+          # @return [Mindee::V1::Parsing::Standard::StringField]
+          attr_reader :job_applied
+          # The list of languages that the candidate is proficient in.
+          # @return [Mindee::V1::Product::Resume::ResumeV1Languages]
+          attr_reader :languages
+          # The ISO 3166 code for the country of citizenship of the candidate.
+          # @return [Mindee::V1::Parsing::Standard::StringField]
+          attr_reader :nationality
+          # The phone number of the candidate.
+          # @return [Mindee::V1::Parsing::Standard::StringField]
+          attr_reader :phone_number
+          # The candidate's current profession.
+          # @return [Mindee::V1::Parsing::Standard::StringField]
+          attr_reader :profession
+          # The list of the candidate's professional experiences.
+          # @return [Mindee::V1::Product::Resume::ResumeV1ProfessionalExperiences]
+          attr_reader :professional_experiences
+          # The list of social network profiles of the candidate.
+          # @return [Mindee::V1::Product::Resume::ResumeV1SocialNetworksUrls]
+          attr_reader :social_networks_urls
+          # The list of the candidate's interpersonal and communication abilities.
+          # @return [Array<Mindee::V1::Parsing::Standard::StringField>]
+          attr_reader :soft_skills
+          # The candidate's last names.
+          # @return [Array<Mindee::V1::Parsing::Standard::StringField>]
+          attr_reader :surnames
+
+          # @param prediction [Hash]
+          # @param page_id [Integer, nil]
+          def initialize(prediction, page_id)
+            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(Parsing::Standard::StringField.new(item, page_id))
+            end
+            @hard_skills = [] # : Array[Parsing::Standard::StringField]
+            prediction['hard_skills'].each do |item|
+              @hard_skills.push(Parsing::Standard::StringField.new(item, page_id))
+            end
+            @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(Parsing::Standard::StringField.new(item, page_id))
+            end
+            @surnames = [] # : Array[Parsing::Standard::StringField]
+            prediction['surnames'].each do |item|
+              @surnames.push(Parsing::Standard::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 * 38}"
+            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 << ' Description                          |'
+            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
+end

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

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+require_relative '../../parsing'
+
+module Mindee
+  module V1
+    module Product
+      module Resume
+        # The list of the candidate's educational background.
+        class ResumeV1Education < Mindee::V1::Parsing::Standard::FeatureField
+          include Mindee::V1::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
+            @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 = {} # @type var printable: Hash[Symbol, String]
+            printable[:degree_domain] = format_for_display(@degree_domain)
+            printable[:degree_type] = format_for_display(@degree_type)
+            printable[:end_month] = format_for_display(@end_month)
+            printable[:end_year] = format_for_display(@end_year)
+            printable[:school] = format_for_display(@school)
+            printable[:start_month] = format_for_display(@start_month)
+            printable[:start_year] = format_for_display(@start_year)
+            printable
+          end
+
+          # @return [Hash]
+          def table_printable_values
+            printable = {} # @type var printable: Hash[Symbol, String]
+            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 = table_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
+end

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

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

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

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require_relative '../../parsing'
+
+module Mindee
+  module V1
+    module Product
+      module Resume
+        # The list of languages that the candidate is proficient in.
+        class ResumeV1Language < Mindee::V1::Parsing::Standard::FeatureField
+          include Mindee::V1::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
+            @language = prediction['language']
+            @level = prediction['level']
+            @page_id = page_id
+          end
+
+          # @return [Hash]
+          def printable_values
+            printable = {} # @type var printable: Hash[Symbol, String]
+            printable[:language] = format_for_display(@language)
+            printable[:level] = format_for_display(@level)
+            printable
+          end
+
+          # @return [Hash]
+          def table_printable_values
+            printable = {} # @type var printable: Hash[Symbol, String]
+            printable[:language] = format_for_display(@language, nil)
+            printable[:level] = format_for_display(@level, 20)
+            printable
+          end
+
+          # @return [String]
+          def to_table_line
+            printable = table_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
+end

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

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

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

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative '../../parsing'
+require_relative 'resume_v1_document'
+
+module Mindee
+  module V1
+    module Product
+      module Resume
+        # Resume API version 1.2 page data.
+        class ResumeV1Page < Mindee::V1::Parsing::Common::Page
+          # @param prediction [Hash]
+          def initialize(prediction)
+            super
+            @prediction = if prediction['prediction'].empty?
+                            nil
+                          else
+                            ResumeV1PagePrediction.new(
+                              prediction['prediction'],
+                              prediction['id']
+                            )
+                          end
+          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
+end