cb-api 0.2.2 → 0.2.4

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZDg4MmFkNzJiYzBhYTUwMmVmYzgzOTdhNDJiMzY5OGMzZTU1NjAwMA==
+    YWI0NzE5NWU3YTJiNzUxY2U3YmNiYzdjNzVmYWMxZTZmOGM1NzJhZQ==
   data.tar.gz: !binary |-
-    MTgyNzFjOTMxNTNjYTdiZjIwZDQyYjY5Mzc5ODM0NDllNzQ5YWFmZQ==
+    ZTg3YmFhMTc3ZGFmZWYxNDU2Yjk1MTJlNjJlZmI1NDgyOWJhOGM0ZA==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    ZmUxNjMzY2E3OWFkMmJmYzE3MjNlMjJmOTYxY2NjYzBhNTM2MDI2YjBhNWVl
-    ZWE1ZGE1YzFhMzVmNzM1Yzk4ZThhYTIzY2FhMDNjZWE1YmJlNTU1MzE0MmRh
-    YTg1NmMwNGYyMGJhNDEwNzRmMzQzM2VhMDRmYWQzZjE1MDNlZmM=
+    MjFlOTA4YjQ3NGMzYmQ2YTlhNmUwMmI4NzczYWI0Yjg1OTBlMTlmNWRhY2Fj
+    OGU4MGE4YTc2YzczNjgxMzYzYjgzOTY1NGNlZmFlMTQ2M2M3MDU1OTE4NWJh
+    NmFjNjhjMTJhMzEzNmViMzg1NDg5NDc2NGVmNDI0MGVlYzdjYzQ=
   data.tar.gz: !binary |-
-    YjljM2RiMDZkN2U3YmM2NjcyYzMwOTU0YzNjYzE1MTlhMmVmYzhkMGY5MGU4
-    NzQ0M2IxMmRhYjMxYWQ0N2YyNDgzZmQ5NDMzMzY1NWZiNDc5MjRmMGNlMDU4
-    YTdiMGMzNzNhMjQ3ODdjOTFhYWQyYjI1MWFjZjZiODlkYzIwNjU=
+    ZDMxNDUyMmExMzYzZTVkM2Q2NzdhMjkyMjlmYTZlMWE1N2U1MTRiZTZhNjdl
+    MDlhZjM1MWVhZmQxYjBhMzAxYjBmMzQ0YjQ1Yjc4MjJiYjkyZWY3NDFiOTIz
+    NDhlODlkMGQ2NjY5ZjdiNjM0YjkyMDcxODgyOTVhZWQ5MTBiZTM=

data/lib/cb.rb

@@ -50,6 +50,10 @@ module Cb
   def self.recommendation
     Cb::RecommendationApi
   end
+
+  def self.resume
+    Cb::ResumeApi
+  end
   
   def self.application
     Cb::ApplicationApi

data/lib/cb/clients/email_subscription_api.rb

@@ -8,9 +8,9 @@ module Cb
     ## For detailed information around this API please visit:
     ## http://api.careerbuilder.com/usersubscriptionretrieve.aspx
     #############################################################
-    def self.retrieve_by_did(did)
+    def self.retrieve_by_did(did, host_site = '')
       my_api = Cb::Utils::Api.new()
-      cb_response = my_api.cb_get(Cb.configuration.uri_subscription_retrieve, :query => {:ExternalID => did})
+      cb_response = my_api.cb_get(Cb.configuration.uri_subscription_retrieve, :query => {:ExternalID => did, :Hostsite => host_site})
       json_hash = JSON.parse(cb_response.response.body)
       subscription = CbEmailSubscription.new(json_hash['SubscriptionValues'])
 
@@ -24,7 +24,7 @@ module Cb
     ## For detailed information around this API please visit:
     ## http://api.careerbuilder.com/usersubscriptionretrieve.aspx
     #############################################################
-    def self.modify_subscription ext_id, career_resources, product_sponsor_info, applicant_survey_invites, job_recs, unsubscribe_all
+    def self.modify_subscription ext_id, host_site, career_resources, product_sponsor_info, applicant_survey_invites, job_recs, unsubscribe_all
       if unsubscribe_all && unsubscribe_all != 'false'
         career_resources = product_sponsor_info = applicant_survey_invites = job_recs = false.to_s
       end
@@ -40,6 +40,7 @@ module Cb
       xml_body = "<Request>"
       xml_body += "<DeveloperKey>" + Cb.configuration.dev_key.to_s + "</DeveloperKey>"
       xml_body += "<ExternalID>" + ext_id.to_s + "</ExternalID>"
+      xml_body += "<Hostsite>" + host_site.to_s + "</Hostsite>"
       xml_body += "<CareerResources>" + career_resources.to_s + "</CareerResources>"
       xml_body += "<ProductSponsorInfo>" + product_sponsor_info.to_s + "</ProductSponsorInfo>"
       xml_body += "<ApplicantSurveyInvites>" + applicant_survey_invites.to_s + "</ApplicantSurveyInvites>"

data/lib/cb/clients/resume_api.rb

@@ -0,0 +1,188 @@
+require 'json'
+
+module Cb
+  class ResumeApi
+    #############################################################
+    ## Retrieve resumes a user owns.
+    ##
+    ## Returns an array of resumes with external id and
+    ## title set.
+    ##
+    ## Note: This does not load the resume, a subsequent resume
+    ## retrieve is required.
+    ##
+    ## For detailed information around this API please visit:
+    ## http://www.careerbuilder.com/api/ResumeInfo.aspx
+    #############################################################
+    def self.own_all(external_user_id, ignore_host_site = false)
+      my_api = Cb::Utils::Api.new
+      params = {"ExternalUserID" => external_user_id}
+      if ignore_host_site
+        params['IgnoreHostSite'] = 'true'
+      end
+      cb_response = my_api.cb_get(Cb.configuration.uri_resume_own_all, :query => params)
+      json_hash = JSON.parse(cb_response.response.body)
+
+      resumes = []
+
+      unless json_hash.nil?
+        json_hash['ResponseOwnResumes']['Resumes']['Resume'].each do |resume_hash|
+          resume = Cb::CbResume.new resume_hash
+          resume.external_resume_id = resume_hash['ExternalID']
+          resume.external_user_id = external_user_id
+          resumes << resume
+        end
+      end
+
+      return resumes
+    end
+
+    #############################################################
+    ## Retrieve the contents of a resume by external id.
+    ##
+    ## For detailed information around this API please visit:
+    ## http://www.careerbuilder.com/api/ResumeInfo.aspx
+    #############################################################
+    def self.retrieve_by_id resume_external_id, external_user_id
+      my_api = Cb::Utils::Api.new
+      params = {"ExternalID" => external_id, "ExternalUserID" => external_user_id}
+      cb_response = my_api.cb_get(Cb.configuration.uri_resume_retrieve, :query => params)
+      json_hash = JSON.parse(cb_response.response.body)
+
+      resume = Cb::CbResume.new json_hash
+      my_api.append_api_responses resume, json_hash
+
+      return resume
+    end
+
+    #############################################################
+    ## Retrieve the contents of a resume.
+    ##
+    ## For detailed information around this API please visit:
+    ## http://www.careerbuilder.com/api/ResumeInfo.aspx
+    #############################################################
+    def self.retrieve resume
+      my_api = Cb::Utils::Api.new
+      params = {"ExternalID" => resume.external_resume_id, "ExternalUserID" => resume.external_user_id}
+      cb_response = my_api.cb_get(Cb.configuration.uri_resume_retrieve, :query => params)
+      json_hash = JSON.parse(cb_response.response.body)
+
+      resume = resume.set_attributes json_hash
+      my_api.append_api_responses resume, json_hash
+
+      return resume
+    end
+
+    #############################################################
+    ## TODO: Create a resume
+    ##
+    ## For detailed information around this API please visit:
+    ## http://www.careerbuilder.com/api/ResumeInfo.aspx
+    #############################################################
+    def self.create resume
+      my_api = Cb::Utils::Api.new
+      cb_response = my_api.cb_post(Cb.configuration.uri_resume_create, :body => make_create_xml(resume))
+      json_hash = JSON.parse(cb_response.response.body)
+    end
+
+    #############################################################
+    ## TODO: Update a resume
+    ##
+    ## For detailed information around this API please visit:
+    ## http://www.careerbuilder.com/api/ResumeInfo.aspx
+    #############################################################
+    def self.update resume
+      my_api = Cb::Utils::Api.new
+      cb_response = my_api.cb_post(Cb.configuration.uri_resume_update, :body => make_update_xml(resume))
+      json_hash = JSON.parse(cb_response.response.body)
+    end
+
+    #############################################################
+    ## TODO: Delete a resume
+    ##
+    ## For detailed information around this API please visit:
+    ## http://www.careerbuilder.com/api/ResumeInfo.aspx
+    #############################################################
+    def self.delete resume
+      my_api = Cb::Utils::Api.new
+      cb_response = my_api.cb_post(Cb.configuration.uri_resume_delete, :body => make_delete_xml(resume))
+      json_hash = JSON.parse(cb_response.response.body)
+
+    end
+
+    private
+    def make_create_xml(resume)
+      xml = "<Request>"
+      xml += "<DeveloperKey>#{Cb.configuration.dev_key}</DeveloperKey>"
+      xml += "<ExternalID>#{resume.resume_external_id}</ExternalID>"
+      xml += "<Test>false</Test>"
+      xml += "<ExternalUserID>#{resume.user_external_id}</ExternalUserID>"
+      cd = self.new_record? ? Date.current : self.created_at
+      md = self.new_record? ? Date.current : self.updated_at
+      xml += "<CreatedDT>#{cd.xmlschema}</CreatedDT>"
+      xml += "<ModifiedDT>#{md.xmlschema}</ModifiedDT>"
+      xml += "<Certifications>#{resume.certifications * ','}</Certifications>"
+      xml += "<ShowContactInfo>#{resume.show_contact_info}</ShowContactInfo>"
+      xml += "<Title>#{resume.title.xmlsafe}</Title>"
+      xml += "<ResumeText>#{resume.resume_text.xmlsafe}</ResumeText>"
+      xml += "<Visibility>#{resume.visibility.to_s.downcase}</Visibility>"
+      xml += "<CanRelocateNationally>#{resume.can_relocate_nationally.to_s.downcase}</CanRelocateNationally>"
+      xml += "<CanRelocateInternationally>#{resume.can_relocate_internationally.to_s.downcase}</CanRelocateInternationally>"
+      xml += "<TotalYearsExperience>#{resume.total_years_experience.to_i}</TotalYearsExperience>"
+      xml += "<HostSite>#{Cb.configuration.host_site}</HostSite>"
+      xml += "<DesiredJobTypes>#{resume.desired_job_type}</DesiredJobTypes>" unless resume.desired_job_type.blank?
+      xml += "<DesiredJobTypes>ETFE</DesiredJobTypes>" if resume.desired_job_type.blank?
+      xml += "<RecentPayAmount>#{resume.recent_pay_amount.money_to_string}</RecentPayAmount>" unless resume.recent_pay_amount.blank?
+      xml += "<RecentPayType>#{resume.recent_pay_type.downcase}</RecentPayType>" unless resume.recent_pay_type.blank?
+
+      xml += "<CompanyExperiences>"
+      resumes.company_experiences.each do |experience|
+        xml += "<CompanyExperience>"
+        xml += "<CompanyName>#{experience.company_name.xmlsafe}</CompanyName>"
+        xml += "<JobTitle>#{experience.job_title.xmlsafe}</JobTitle>"
+        xml += "<StartDate>#{experience.start_date.to_s}</StartDate>" unless experience.start_date.blank?
+        xml += "<EndDate>#{experience.end_date.to_s}</EndDate>" unless experience.end_date.blank?
+        xml += "<EndDate>1970-01-01</EndDate>" if experience.end_date.blank?
+        xml += "<Details>#{experience.details.xmlsafe}</Details>"
+        xml += "</CompanyExperience>"
+      end
+      xml += "</CompanyExperiences>"
+      xml += "<Educations>"
+      resume.educations.each do |education|
+        xml += "<Education>"
+        xml += "<SchoolName>#{education.school_name.xmlsafe}</SchoolName>"
+        xml += "<Major>#{education.major.xmlsafe}</Major>"
+        xml += "<DegreeCode>#{education.degree_code}</DegreeCode>"
+        xml += "<GraduationDate>#{education.graduation_date.to_s}</GraduationDate>" unless education.graduation_date.blank?
+        #Never actually needed:
+        #xml += "<GPA>#{education.gpa.to_i}</GPA>"
+        xml += "</Education>"
+      end
+      xml += "</Educations>"
+      xml += "<Languages>"
+      resume.languages.each do |language|
+        xml += "<Language>#{language}</Language>"
+      end
+      xml += "</Languages>"
+      xml += "</Request>"
+      xml
+    end
+
+    def make_update_xml(resume)
+      make_create_xml resume
+    end
+
+    def make_delete_xml(resume)
+      raise "external_resume_id is undefined in CbResume." if resume.external_resume_id.blank?
+      raise "external_user_id is undefined in CbResume." if resume.external_user_id.blank?
+
+      xml = '<Request>'
+      xml += "<DeveloperKey></DeveloperKey>"
+      xml += "<ExternalID>#{resume.external_resume_id}</ExternalID>"
+      xml += "<Test>#{resume.test}</Test>"
+      xml += "<ExternalUserID>#{resume.external_user_id}</ExternalUserID>"
+      xml += '</Request>'
+      xml
+    end
+  end
+end

data/lib/cb/config.rb

@@ -11,6 +11,8 @@ module Cb
                   :uri_application_registered, :uri_user_change_password,
                   :uri_user_delete, :uri_user_retrieve,
                   :uri_job_branding,
+                  :uri_resume_own_all, :uri_resume_retrieve,
+                  :uri_resume_create, :uri_resume_update, :uri_resume_delete,
                   :uri_saved_search_retrieve, :uri_saved_search_create, :uri_saved_search_update, :uri_saved_search_list, :uri_saved_search_delete,
                   :uri_saved_job_search_create,
                   :uri_job_branding, :uri_tn_join_questions,
@@ -39,6 +41,11 @@ module Cb
       @uri_user_delete                    ||= '/v2/User/delete'
       @uri_user_retrieve                  ||= '/v2/user/retrieve'
       @uri_job_branding                   ||= '/branding'
+      @uri_resume_own_all                 ||= '/v2/resume/ownall'
+      @uri_resume_retrieve                ||= '/v2/resume/retrieve'
+      @uri_resume_create                  ||= '/v2/resume/create'
+      @uri_resume_update                  ||= '/v2/resume/update'
+      @uri_resume_delete                  ||= '/v2/resume/delete'
       @uri_saved_search_retrieve          ||= '/v1/savedsearch/retrieve'
       @uri_saved_search_create            ||= '/v2/savedsearch/create'
       @uri_saved_search_update            ||= '/v2/savedsearch/update'
@@ -68,9 +75,15 @@ module Cb
         :uri_application                  => @uri_application,
         :uri_application_submit           => @uri_application_submit,
         :uri_application_registered       => @uri_application_registered,
+        :uri_application_external         => @uri_application_external,
         :uri_user_change_password         => @uri_user_change_password,
         :uri_user_retrieve                => @uri_user_retrieve,
         :uri_job_branding                 => @uri_job_branding,
+        :uri_resume_own_all               => @uri_resume_own_all,
+        :uri_resume_retrieve              => @uri_resume_retrieve,
+        :uri_resume_create                => @uri_resume_create,
+        :uri_resume_update                => @uri_resume_update,
+        :uri_resume_delete                => @uri_resume_delete,
         :uri_saved_search_retrieve        => @uri_saved_search_retrieve,
         :uri_saved_search_create          => @uri_saved_search_create,
         :uri_saved_search_update          => @uri_saved_search_update,

data/lib/cb/models/cb_resume.rb

@@ -0,0 +1,127 @@
+module Cb
+  class CbResume
+    attr_accessor :external_resume_id, :external_user_id,
+                  :did, :title, :visibility, :resume_text,
+                  :email, :real_name, :gender, :phone, :birth_date,
+                  :address, :city, :state, :postal_code, :country_code,
+                  :show_contact_info, :test,
+                  :created_dt, :modified_dt,
+                  :categories, :languages,
+                  :company_experiences, :educations,
+                  :custom_values
+
+    def initialize(args = {})
+      set_attributes(args)
+    end
+
+    def set_attributes(args = {})
+      return if args.nil?
+      @did                      = args['ResumeDID'] || ''
+      @email                    = args['Email'] || ''
+      @real_name                = args['RealName'] || ''
+      @gender                   = args['Gender'] || ''
+      @address                  = args['Address'] || ''
+      @city                     = args['City'] || ''
+      @state                    = args['State'] || ''
+      @postal_code              = args['PostalCode'] || ''
+      @country_code             = args['CountryCode'] || ''
+      @phone                    = args['Phone'] || ''
+      @birth_date               = args['BirthDate'] || ''
+      @title                    = args['Title'] || ''
+      @visibility               = args['Visibility'] || ''
+      @show_contact_info        = args['ShowContactInfo'] || ''
+      @created_dt               = args['CreatedDT'] || ''
+      @modified_dt              = args['ModifiedDT'] || ''
+      @categories               = args['Categories'] || ''
+      @resume_text              = args['ResumeText'] || ''
+      @languages                = !args['Languages'].nil? ? args['Languages']['Language'] : ''
+      @stats_searches           = !args['Stats'].nil? ? args['Stats']['Searches'] : -1
+      @stats_clicks             = !args['Stats'].nil? ? args['Stats']['Clicks'] : -1
+      @stats_applications       = !args['Stats'].nil? ? args['Stats']['Applications'] : -1
+
+      #These don't come back on retrieve
+      @external_resume_id       = '' if @external_resume_id.blank?
+      @external_user_id         = '' if @external_user_id.blank?
+
+      @test = false
+
+      @company_experiences = []
+      if args.has_key?('CompanyExperiences')
+        unless args['CompanyExperiences'].empty?
+          args['CompanyExperiences']['CompanyExperience'].each do | qq |
+            @company_experiences << CbResume::CbCompanyExperience.new(qq)
+          end
+        end
+      end
+
+      @educations = []
+      if args.has_key?('Educations')
+        unless args['Educations'].empty?
+          args['Educations']['Education'].each do | qq |
+            @educations << CbResume::CbEducation.new(qq)
+          end
+        end
+      end
+
+      @custom_values = []
+      if args.has_key?('CustomValues')
+        unless args['CustomValues'].empty?
+          args['CustomValues']['CustomValue'].each do | qq |
+            @custom_values << CbResume::CbCustomValue.new(qq)
+          end
+        end
+      end
+    end
+
+    def load
+      Cb.resume.retrieve self
+    end
+
+    def add_company_experience(params)
+      @company_experiences << CbResume::CbCompanyExperience.new(params)
+    end
+
+    def add_education(params)
+      @educations << CbResume::CbEducation.new(params)
+    end
+
+    def add_custom_value(params)
+      @custom_values << CbResume::CbCustomValue.new(params)
+    end
+  end
+
+  class CbResume::CbCompanyExperience
+    attr_accessor :job_title, :company_name, :start_date, :end_date, :is_current, :details
+
+    def initialize(args = {})
+      @job_title        = args['JobTitle'] || ''
+      @company_name     = args['CompanyName'] || ''
+      @start_date       = args['StartDate'] || ''
+      @end_date         = args['EndDate'] || ''
+      @is_current       = args['IsCurrent'] || ''
+      @details          = args['Details'] || ''
+    end
+  end
+
+  class CbResume::CbEducation
+    attr_accessor :school_name, :major, :degree_name, :degree_code, :graduation_date, :gpa
+
+    def initialize(args = {})
+      @school_name      = args['SchoolName'] || ''
+      @major            = args['Major'] || ''
+      @degree_name      = args['DegreeName'] || ''
+      @degree_code      = args['DegreeCode'] || ''
+      @graduation_date  = args['GraduationDate'] || ''
+      @gpa              = args['GPA'] || ''
+    end
+  end
+
+  class CbResume::CbCustomValue
+    attr_accessor :key, :value
+
+    def initialize(args = {})
+      @key              = args['Key'] || ''
+      @value            = args['Value'] || ''
+    end
+  end
+end

data/lib/cb/models/cb_saved_search.rb

@@ -5,7 +5,7 @@ module Cb
                   :emp_type, :exclude_company_names, :exclude_job_titles, :exclude_national, :industry_codes,
                   :keywords, :order_by, :order_direction, :radius, :pay_high, :pay_low, :posted_within, 
                   :pay_info_only, :location, :job_category, :company, :city, :state, :is_daily_email, :external_id,
-                  :external_user_id, :dev_key, :jrdid
+                  :external_user_id, :dev_key, :job_search_url, :jrdid
 
     def initialize(args={})
       @hostsite                   = args['HostSite'] || ''
@@ -38,6 +38,7 @@ module Cb
       @external_id                = args['ExternalID'] || ''
       @external_user_id           = args['ExternalUserID'] || ''
       @dev_key                    = args['DeveloperKey'] || ''
+      @job_search_url             = args['JobSearchUrl'] || ''
       @jrdid                      = args['JRDID'] || ''
     end
 

data/lib/cb/version.rb

@@ -1,3 +1,3 @@
 module Cb
-  VERSION = '0.2.2'
+  VERSION = '0.2.4'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cb-api
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.4
 platform: ruby
 authors:
 - Jesse Retchko
@@ -15,7 +15,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-01 00:00:00.000000000 Z
+date: 2013-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -83,6 +83,7 @@ files:
 - lib/cb/clients/job_api.rb
 - lib/cb/clients/job_branding_api.rb
 - lib/cb/clients/recommendation_api.rb
+- lib/cb/clients/resume_api.rb
 - lib/cb/clients/saved_search_api.rb
 - lib/cb/clients/talent_network_api.rb
 - lib/cb/clients/user_api.rb
@@ -112,6 +113,7 @@ files:
 - lib/cb/models/cb_employee_type.rb
 - lib/cb/models/cb_job.rb
 - lib/cb/models/cb_job_branding.rb
+- lib/cb/models/cb_resume.rb
 - lib/cb/models/cb_saved_search.rb
 - lib/cb/models/cb_user.rb
 - lib/cb/utils/api.rb
@@ -141,7 +143,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.5
+rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: Ruby wrapper around Careerbuilder Public API.