sovren 0.0.3

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZGI2YjYyNjA3NDlkOTcwOWExOTk4MTdmNjc1ZGI2MWQ4NWY2NDI3Yw==
+  data.tar.gz: !binary |-
+    YjU3ZDU1MzFjYWEyMDQ4MWQ5NTQ3NzQ4MTk0NzFiNTRjNGY2OWIwYg==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    NjBlMTc0ODVhMTMxZjZjODM2ZjkzZTRkNGZhMWQ4NmI5YjE5NTViYTZkZmNl
+    NzM0OGUzMzNkMDBjZjlkZDVlNTgwMGJjZTEyNDc3YzU5MjIzODMyZGMwOWE4
+    M2JkYmM3MzQ2N2EzNjQ0ZTJlZDBhZGNlYTE1MjNhZThiN2Q3Y2I=
+  data.tar.gz: !binary |-
+    NWMwODgwNDA5MmM2OTc5MDU3MzUxY2QwNzg2OGNmZTJlODYyMmFiYjNhODdk
+    Y2ZjM2ZlNGJjZDZkYTJhNzA4NjgwYWMwMTc2MzE4YjAwMjc5NGIwYjA0NjBi
+    OTYxNWJhMGRlYWU4NjA2NWI3ZmI2NDBmZGFiNTMzZTk0ZDE2NTU=

data/.gitignore

@@ -0,0 +1,19 @@
+.DS_Store
+*.gem
+*.rbc
+.bundle
+.config
+.rvmrc
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,14 @@
+source 'https://rubygems.org'
+
+gem 'httpclient'
+gem 'nokogiri'
+gem 'savon'
+
+# Specify your gem's dependencies in sovren.gemspec
+gemspec
+
+gem 'pry'
+gem 'rspec'
+gem 'rspec-given'
+gem 'vcr'
+gem 'webmock', '< 1.10'

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Eric Fleming
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,41 @@
+# Sovren
+
+A simple ruby gem that parses a resume using the sovren resume parser and returns the resume back as a ruby object.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'sovren'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sovren
+
+## Usage Example
+
+1. Create a client
+
+    ```ruby
+    client = Sovren::Client.new(endpoint: "http://yourhost.com/SovrenConvertAndParse/ConvertAndParse.asmx?WSDL", username: "http basic username (optional)", password: "http basic password (optional)")
+    ```
+
+2. Parse a resume
+
+    ```ruby
+    resume = client.parse(File.read('/path/to/your/file/resume.doc'))
+    ```
+
+## Contributing
+
+The testing could use some more coverage for other hr-xml use cases.  I also haven't added any of the sovren specific fields returned but those could be added if you need them.
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec')
+
+task :default => :spec

data/lib/sovren.rb

@@ -0,0 +1,30 @@
+require "pry"
+require "sovren/version"
+require "savon"
+
+module Sovren
+  class << self
+    FIELDS = [:endpoint, :username, :password, :timeout, :hard_time_out_multiplier, :parser_configuration_params]
+    attr_accessor(*FIELDS)
+    
+    def configure
+      yield self
+      true
+    end
+  end  
+
+  require_relative "sovren/achievement"
+  require_relative "sovren/association"
+  require_relative "sovren/certification"
+  require_relative "sovren/client"
+  require_relative "sovren/competency"
+  require_relative "sovren/contact_information"
+  require_relative "sovren/education"
+  require_relative "sovren/employment"
+  require_relative "sovren/resume"
+  require_relative "sovren/language"
+  require_relative "sovren/military"
+  require_relative "sovren/patent"
+  require_relative "sovren/publication"
+  require_relative "sovren/reference"
+end

data/lib/sovren/achievement.rb

@@ -0,0 +1,16 @@
+module Sovren
+  class Achievement
+    attr_accessor :description
+
+    def self.parse(achievements)
+      return Array.new if achievements.nil?
+      result = achievements.css('Achievement').collect do |item|
+        c = Achievement.new
+        c.description = item.css('Description').text
+        c
+      end
+      result
+    end
+  
+  end
+end

data/lib/sovren/association.rb

@@ -0,0 +1,17 @@
+module Sovren
+  class Association
+    attr_accessor :name, :role
+
+    def self.parse(associations)
+      return Array.new if associations.nil?
+      result = associations.css('Association').collect do |item|
+        c = Association.new
+        c.name = item.css('Name').first.text
+        c.role = item.css('Role Name').text
+        c
+      end
+      result
+    end
+  
+  end
+end

data/lib/sovren/certification.rb

@@ -0,0 +1,18 @@
+module Sovren
+  class Certification
+    attr_accessor :name, :description, :effective_date
+
+    def self.parse(certifications)
+      return Array.new if certifications.nil?
+      result = certifications.css('LicenseOrCertification').collect do |item|
+        c = Certification.new
+        c.name = item.css('Name').text
+        c.description = item.css('Description').text
+        c.effective_date = Date.parse(item.css('EffectiveDate FirstIssuedDate AnyDate').text) rescue nil
+        c
+      end
+      result
+    end
+  
+  end
+end

data/lib/sovren/client.rb

@@ -0,0 +1,45 @@
+module Sovren
+  class Client
+    attr_reader :endpoint, :username, :password, :timeout, :hard_time_out_multiplier, :parser_configuration_params
+
+    #Initialize the client class that will be used for all sovren requests.
+    #
+    #Certain requests will require an oauth token.  See http://developer.foursquare.com/docs/index_docs.html for the full list.
+    #
+    # @param [Hash] options
+    # @option options String :endpoint The url that the web service is located at
+    # @option options String :username The HTTP Basic auth username for the webservice
+    # @option options String :password The HTTP Basic auth password for the webservice
+    # @option options Integer :timeout The timeout for the parser
+    # @option options Integer :hard_time_out_multiplier The hard timeout for the parser
+    # @option options Integer :parser_configuration_params The parser configuration params, used to tweak the output of the parser
+
+    def initialize(options={})
+      @endpoint = options[:endpoint]
+      @username = options[:username]
+      @password = options[:password]
+      @timeout = options[:timout] || 30000
+      @hard_time_out_multiplier = options[:hard_time_out_multiplier] || 2     
+      @parser_configuration_params = options[:parser_configuration_params] || "_100000_0_00000010_0000000110101100_1_0000000000000111111102000000000010000100000000000000"
+    end
+
+    def connection
+      Savon.client(wsdl: endpoint, log: false)
+    end
+
+    def parse(file)
+      result = connection.call(:parse) do |c|
+        c.message({
+          "DocumentAsByteArray" => Base64.encode64(file),
+          "ParserConfigurationParams" => parser_configuration_params,
+          "AlsoUseSovrenTaxonomy" => true,
+          "EmbedConvertedTextInHrXml" => true,
+          "HardTimeOutMultiplier" => hard_time_out_multiplier,
+          "TimeOutInMs" => timeout})
+      end
+
+      Resume.parse(result.body[:parse_response][:parse_result])
+    end
+
+  end
+end

data/lib/sovren/competency.rb

@@ -0,0 +1,18 @@
+module Sovren
+  class Competency
+    attr_accessor :name, :months, :last_used_date
+
+    def self.parse(competencies)
+      return Array.new if competencies.nil?
+      results = competencies.css('Competency').collect do |item|
+        c = Competency.new
+        c.name = item['name']
+        c.months = item.css('CompetencyEvidence NumericValue').text.to_i rescue nil
+        c.last_used_date = Date.parse(item.css('CompetencyEvidence').first['lastUsed']) rescue nil
+        c
+      end
+      results
+    end
+
+  end
+end

data/lib/sovren/contact_information.rb

@@ -0,0 +1,33 @@
+module Sovren
+  class ContactInformation
+    attr_accessor :first_name, :middle_name, :last_name, :aristocratic_title, :form_of_address, :generation, :qualification, :address_line_1, :address_line_2, :city, :state, :country, :postal_code, :home_phone, :mobile_phone, :email, :website
+
+    def self.parse(contact_information)
+      return nil if contact_information.nil?
+      result = self.new
+      result.first_name = contact_information.css('PersonName GivenName').collect(&:text).join(" ")
+      result.middle_name = contact_information.css('PersonName MiddleName').collect(&:text).join(" ")
+      result.last_name = contact_information.css('PersonName FamilyName').collect(&:text).join(" ")
+      result.aristocratic_title = contact_information.css('PersonName Affix[type=aristocraticTitle]').collect(&:text).join(" ")
+      result.form_of_address = contact_information.css('PersonName Affix[type=formOfAddress]').collect(&:text).join(" ")
+      result.generation = contact_information.css('PersonName Affix[type=generation]').collect(&:text).join(" ")
+      result.qualification = contact_information.css('PersonName Affix[type=qualification]').collect(&:text).join(" ")
+
+      address = contact_information.css('PostalAddress DeliveryAddress AddressLine').collect(&:text)
+      result.address_line_1 = address[0] if address.length > 0
+      result.address_line_2 = address[1] if address.length > 1
+      result.city = contact_information.css('PostalAddress').first.css('Municipality').text rescue nil
+      result.state = contact_information.css('PostalAddress').first.css('Region').text rescue nil
+      result.postal_code = contact_information.css('PostalAddress').first.css('PostalCode').text rescue nil
+      result.country = contact_information.css('PostalAddress').first.css('CountryCode').text rescue nil
+
+      result.home_phone = contact_information.css('Telephone FormattedNumber').first.text rescue nil
+      result.mobile_phone = contact_information.css('Mobile FormattedNumber').first.text rescue nil
+
+      result.website = contact_information.css('InternetWebAddress').first.text rescue nil
+      result.email = contact_information.css('InternetEmailAddress').first.text rescue nil
+
+      result
+    end
+  end
+end

data/lib/sovren/education.rb

@@ -0,0 +1,30 @@
+module Sovren
+  class Education
+    attr_accessor :school_name, :city, :state, :country, :degree_name, :degree_type, :major, :minor, :gpa, :gpa_out_of, :start_date, :end_date, :graduated
+    
+    def self.parse(education_history)
+      return Array.new if education_history.nil?
+      result = education_history.css('SchoolOrInstitution').collect do |item|
+        e = Education.new
+        e.school_name = item.css('SchoolName').text
+        e.city, e.state, e.country = item.css('PostalAddress Municipality, PostalAddress Region, PostalAddress CountryCode').collect(&:text)
+        e.degree_type = item.css('Degree').first['degreeType']
+        e.degree_name = item.css('Degree DegreeName').text
+        e.major = item.css('DegreeMajor Name').text
+        e.minor = item.css('DegreeMinor name').text
+        e.gpa = item.css('EducationalMeasure MeasureValue StringValue').text.to_f rescue nil
+        e.gpa_out_of = item.css('EducationalMeasure HighestPossibleValue StringValue').text.to_f rescue nil
+        e.start_date = Date.parse(item.css('DatesOfAttendance StartDate AnyDate').text) rescue nil
+        e.end_date = Date.parse(item.css('DatesOfAttendance EndDate AnyDate').text) rescue nil
+        e.graduated = item.css('Degree DegreeDate AnyDate').text != ""
+        e
+      end
+      result
+    end
+  
+    def graduated?
+      !graduated.nil? && graduated
+    end  
+
+  end
+end

data/lib/sovren/employment.rb

@@ -0,0 +1,29 @@
+module Sovren
+  class Employment
+    attr_accessor :employer, :division, :city, :state, :country, :title, :description, :start_date, :end_date, :current_employer
+    
+    def self.parse(employment_history)
+      return Array.new if employment_history.nil?
+      result = employment_history.css('EmployerOrg').collect do |item|
+        position = item.css('PositionHistory').first
+        e = Employment.new
+        e.employer = item.css('EmployerOrgName').text
+        e.division = position.css('OrganizationName').text
+        e.division = nil if e.employer == e.division
+        e.city, e.state, e.country = item.css('PositionLocation Municipality, PositionLocation Region, PositionLocation CountryCode').collect(&:text)
+        e.title = position.css('Title').text
+        e.description = position.css('Description').text
+        e.start_date = Date.parse(position.css('StartDate').text) rescue nil
+        e.current_employer = position['currentEmployer'] == "true"
+        e.end_date = e.current_employer ? nil : (Date.parse(position.css('EndDate').text) rescue nil)
+        e
+      end
+      result
+    end
+
+    def current_employer?
+      !current_employer.nil? && current_employer
+    end
+  
+  end
+end

data/lib/sovren/language.rb

@@ -0,0 +1,31 @@
+module Sovren
+  class Language
+    attr_accessor :language_code, :read, :write, :speak
+
+    def self.parse(languages)
+      return Array.new if languages.nil?
+      result = languages.css('Language').collect do |item|
+        c = Language.new
+        c.language_code = item.css('LanguageCode').text
+        c.read = item.css('Read').text == "true" rescue nil
+        c.write = item.css('Write').text == "true" rescue nil
+        c.speak = item.css('Speak').text == "true" rescue nil
+        c
+      end
+      result
+    end
+
+    def read?
+      !read.nil? && read
+    end
+  
+    def write?
+      !write.nil? && write
+    end
+  
+    def speak?
+      !speak.nil? && speak
+    end
+  
+  end
+end

data/lib/sovren/military.rb

@@ -0,0 +1,19 @@
+module Sovren
+  class Military
+    attr_accessor :country_served, :branch, :rank_achieved, :recognition_achieved, :discharge_status, :start_date, :end_date
+
+    def self.parse(military_history)
+      return nil if military_history.nil?
+      e = Military.new
+      e.country_served = military_history.css('CountryServed').text
+      e.branch = military_history.css('ServiceDetail').first['branch']
+      e.rank_achieved = military_history.css('ServiceDetail RankAchieved CurrentOrEndRank').text
+      e.recognition_achieved = military_history.css('ServiceDetail RecognitionAchieved').text
+      e.discharge_status = military_history.css('ServiceDetail DischargeStatus').text
+      e.start_date = Date.parse(military_history.css('DatesOfService StartDate AnyDate').text) rescue nil
+      e.end_date = Date.parse(military_history.css('DatesOfService EndDate AnyDate').text) rescue nil
+      e
+    end
+
+  end
+end

data/lib/sovren/patent.rb

@@ -0,0 +1,19 @@
+module Sovren
+  class Patent
+    attr_accessor :title, :description, :inventor_name, :patent_id
+
+    def self.parse(patents)
+      return Array.new if patents.nil?
+      result = patents.css('Patent').collect do |item|
+        c = Patent.new
+        c.title = item.css('PatentTitle').text
+        c.description = item.css('Description').text
+        c.inventor_name = item.css('Inventors InventorName').first.text rescue nil
+        c.patent_id = item.css('PatentDetail PatentMilestone Id').text
+        c
+      end
+      result
+    end
+  
+  end
+end