Class: Mindee::V1::Product::Resume::ResumeV1Document

Inherits:
Mindee::V1::Parsing::Common::Prediction show all
Includes:
Mindee::V1::Parsing::Standard
Defined in:
lib/mindee/v1/product/resume/resume_v1_document.rb,
sig/mindee/v1/product/resume/resume_v1_document.rbs

Overview

Resume API version 1.2 document data.

Direct Known Subclasses

ResumeV1PagePrediction

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(prediction, page_id) ⇒ ResumeV1Document

Returns a new instance of ResumeV1Document.

Parameters:

  • prediction (Hash)
  • page_id (Integer, nil)
  • (Hash[String | Symbol, untyped])
  • (Integer, nil) 


72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/mindee/v1/product/resume/resume_v1_document.rb', line 72

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

Instance Attribute Details

#address ⇒ Mindee::V1::Parsing::Standard::StringField (readonly)

The location information of the candidate, including city, state, and country.

Returns:



20
21
22
 
# File 'lib/mindee/v1/product/resume/resume_v1_document.rb', line 20

def address
  @address
end

#certificates ⇒ Mindee::V1::Product::Resume::ResumeV1Certificates (readonly)

The list of certificates obtained by the candidate.

Returns:



23
24
25
 
# File 'lib/mindee/v1/product/resume/resume_v1_document.rb', line 23

def certificates
  @certificates
end

#document_language ⇒ Mindee::V1::Parsing::Standard::StringField (readonly)

The ISO 639 code of the language in which the document is written.

Returns:



26
27
28
 
# File 'lib/mindee/v1/product/resume/resume_v1_document.rb', line 26

def document_language
  @document_language
end

#document_type ⇒ Mindee::V1::Parsing::Standard::ClassificationField (readonly)

The type of the document sent.

Returns:



29
30
31
 
# File 'lib/mindee/v1/product/resume/resume_v1_document.rb', line 29

def document_type
  @document_type
end

#education ⇒ Mindee::V1::Product::Resume::ResumeV1Educations (readonly)

The list of the candidate's educational background.

Returns:



32
33
34
 
# File 'lib/mindee/v1/product/resume/resume_v1_document.rb', line 32

def education
  @education
end

#email_address ⇒ Mindee::V1::Parsing::Standard::StringField (readonly)

The email address of the candidate.

Returns:



35
36
37
 
# File 'lib/mindee/v1/product/resume/resume_v1_document.rb', line 35

def email_address
  @email_address
end

#given_names ⇒ Array<Mindee::V1::Parsing::Standard::StringField> (readonly)

The candidate's first or given names.

Returns:



38
39
40
 
# File 'lib/mindee/v1/product/resume/resume_v1_document.rb', line 38

def given_names
  @given_names
end

#hard_skills ⇒ Array<Mindee::V1::Parsing::Standard::StringField> (readonly)

The list of the candidate's technical abilities and knowledge.

Returns:



41
42
43
 
# File 'lib/mindee/v1/product/resume/resume_v1_document.rb', line 41

def hard_skills
  @hard_skills
end

#job_applied ⇒ Mindee::V1::Parsing::Standard::StringField (readonly)

The position that the candidate is applying for.

Returns:



44
45
46
 
# File 'lib/mindee/v1/product/resume/resume_v1_document.rb', line 44

def job_applied
  @job_applied
end

#languages ⇒ Mindee::V1::Product::Resume::ResumeV1Languages (readonly)

The list of languages that the candidate is proficient in.

Returns:



47
48
49
 
# File 'lib/mindee/v1/product/resume/resume_v1_document.rb', line 47

def languages
  @languages
end

#nationality ⇒ Mindee::V1::Parsing::Standard::StringField (readonly)

The ISO 3166 code for the country of citizenship of the candidate.

Returns:



50
51
52
 
# File 'lib/mindee/v1/product/resume/resume_v1_document.rb', line 50

def nationality
  @nationality
end

#phone_number ⇒ Mindee::V1::Parsing::Standard::StringField (readonly)

The phone number of the candidate.

Returns:



53
54
55
 
# File 'lib/mindee/v1/product/resume/resume_v1_document.rb', line 53

def phone_number
  @phone_number
end

#profession ⇒ Mindee::V1::Parsing::Standard::StringField (readonly)

The candidate's current profession.

Returns:



56
57
58
 
# File 'lib/mindee/v1/product/resume/resume_v1_document.rb', line 56

def profession
  @profession
end

#professional_experiences ⇒ Mindee::V1::Product::Resume::ResumeV1ProfessionalExperiences (readonly)

The list of the candidate's professional experiences.

Returns:



59
60
61
 
# File 'lib/mindee/v1/product/resume/resume_v1_document.rb', line 59

def professional_experiences
  @professional_experiences
end

#social_networks_urls ⇒ Mindee::V1::Product::Resume::ResumeV1SocialNetworksUrls (readonly)

The list of social network profiles of the candidate.

Returns:



62
63
64
 
# File 'lib/mindee/v1/product/resume/resume_v1_document.rb', line 62

def social_networks_urls
  @social_networks_urls
end

#soft_skills ⇒ Array<Mindee::V1::Parsing::Standard::StringField> (readonly)

The list of the candidate's interpersonal and communication abilities.

Returns:



65
66
67
 
# File 'lib/mindee/v1/product/resume/resume_v1_document.rb', line 65

def soft_skills
  @soft_skills
end

#surnames ⇒ Array<Mindee::V1::Parsing::Standard::StringField> (readonly)

The candidate's last names.

Returns:



68
69
70
 
# File 'lib/mindee/v1/product/resume/resume_v1_document.rb', line 68

def surnames
  @surnames
end

Instance Method Details

#certificates_separator(char) ⇒ String

Parameters:

  • char (String)
  • (String)

Returns:

  • (String) 


308
309
310
311
312
313
314
315
316
317
 
# File 'lib/mindee/v1/product/resume/resume_v1_document.rb', line 308

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

#certificates_to_s ⇒ String

Returns:

  • (String) 


320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
 
# File 'lib/mindee/v1/product/resume/resume_v1_document.rb', line 320

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

#education_separator(char) ⇒ String

Parameters:

  • char (String)
  • (String)

Returns:

  • (String) 


228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'lib/mindee/v1/product/resume/resume_v1_document.rb', line 228

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

#education_to_s ⇒ String

Returns:

  • (String) 


243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
 
# File 'lib/mindee/v1/product/resume/resume_v1_document.rb', line 243

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

#languages_separator(char) ⇒ String

Parameters:

  • char (String)
  • (String)

Returns:

  • (String) 


201
202
203
204
205
206
207
208
 
# File 'lib/mindee/v1/product/resume/resume_v1_document.rb', line 201

def languages_separator(char)
  out_str = String.new
  out_str << '  '
  out_str << "+#{char * 10}"
  out_str << "+#{char * 22}"
  out_str << '+'
  out_str
end

#languages_to_s ⇒ String

Returns:

  • (String) 


211
212
213
214
215
216
217
218
219
220
221
222
223
224
 
# File 'lib/mindee/v1/product/resume/resume_v1_document.rb', line 211

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

#professional_experiences_separator(char) ⇒ String

Parameters:

  • char (String)
  • (String)

Returns:

  • (String) 


265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
 
# File 'lib/mindee/v1/product/resume/resume_v1_document.rb', line 265

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

#professional_experiences_to_s ⇒ String

Returns:

  • (String) 


282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'lib/mindee/v1/product/resume/resume_v1_document.rb', line 282

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

#social_networks_urls_separator(char) ⇒ String

Parameters:

  • char (String)
  • (String)

Returns:

  • (String) 


174
175
176
177
178
179
180
181
 
# File 'lib/mindee/v1/product/resume/resume_v1_document.rb', line 174

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

#social_networks_urls_to_s ⇒ String

Returns:

  • (String) 


184
185
186
187
188
189
190
191
192
193
194
195
196
197
 
# File 'lib/mindee/v1/product/resume/resume_v1_document.rb', line 184

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

#to_s ⇒ String

Returns:

  • (String) 


134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/mindee/v1/product/resume/resume_v1_document.rb', line 134

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