cb-api 0.1.4 → 0.1.5

data/lib/cb/clients/user_api.rb

@@ -3,29 +3,55 @@ require 'nokogiri'
 
 module Cb
   class UserApi
-	#############################################################
+    #############################################################
+    ## Retrieve a user
+    ##
+    ## For detailed information around this API please visit:
+    ## http://www.careerbuilder.com/api/UserInfo.aspx
+    #############################################################
+    def self.retrieve external_id, test_mode = false
+      my_api = Cb::Utils::Api.new
+
+      cb_response = my_api.cb_post Cb.configuration.uri_user_retrieve, :body => build_retrieve_request(external_id, test_mode)
+
+      json_hash = JSON.parse cb_response.response.body
+
+      user = CbUser.new json_hash['ResponseUserInfo']['UserInfo']
+
+      my_api.append_api_responses user, json_hash['ResponseUserInfo']
+
+      return user
+    end
+
+    #############################################################
     ## Change a user's password
     ##
     ## For detailed information around this API please visit:
     ## http://www.careerbuilder.com/api/UserInfo.aspx
     #############################################################
     def self.change_password external_id, old_password, new_password, test_mode = false
-    	result = false
+      result = false
+
+      my_api = Cb::Utils::Api.new
+      cb_response = my_api.cb_post Cb.configuration.uri_user_change_password, :body => build_change_password_request(external_id, old_password, new_password, test_mode)
+      json_hash = JSON.parse cb_response.response.body
 
-        my_api = Cb::Utils::Api.new
-        cb_response = my_api.cb_post Cb.configuration.uri_user_change_password, :body => build_change_password_request(external_id, old_password, new_password, test_mode)
-        json_hash = JSON.parse cb_response.response.body
+      my_api.append_api_responses result, json_hash['ResponseUserChangePW']
 
+      if result.cb_response.status.include? 'Success'
+        result = true
         my_api.append_api_responses result, json_hash['ResponseUserChangePW']
+      end
 
-        if result.cb_response.status.include? 'Success'
-        	result = true
-        	my_api.append_api_responses result, json_hash['ResponseUserChangePW']
-        end
-
-        result
+      result
     end
 
+    #############################################################
+    ## De-activate a user
+    ##
+    ## For detailed information around this API please visit:
+    ## http://www.careerbuilder.com/api/UserInfo.aspx
+    #############################################################
     def self.delete external_id, password, test_mode = false
       result = false
 
@@ -44,18 +70,30 @@ module Cb
     end
 
     private
+    def self.build_retrieve_request external_id, test_mode
+      builder = Nokogiri::XML::Builder.new do
+        Request {
+          ExternalID_ external_id
+          Test_ test_mode.to_s
+          DeveloperKey_ Cb.configuration.dev_key
+        }
+      end
+
+      builder.to_xml
+    end
+
     def self.build_change_password_request external_id, old_password, new_password, test_mode
-	    builder = Nokogiri::XML::Builder.new do
-			Request {
-				ExternalID_ external_id
-				OldPassword_ old_password
-				NewPassword_ new_password
-				Test_ test_mode.to_s
-				DeveloperKey_ Cb.configuration.dev_key
-			}
-		end
-		
-		builder.to_xml
+      builder = Nokogiri::XML::Builder.new do
+        Request {
+          ExternalID_ external_id
+          OldPassword_ old_password
+          NewPassword_ new_password
+          Test_ test_mode.to_s
+          DeveloperKey_ Cb.configuration.dev_key
+        }
+    end
+    
+    builder.to_xml
     end
 
     def self.build_delete_request external_id, password, test_mode

data/lib/cb/config.rb

@@ -8,7 +8,7 @@ module Cb
                   :uri_recommendation_for_company,
                   :uri_application, :uri_application_submit,
                   :uri_application_registered, :uri_user_change_password,
-                  :uri_user_delete
+                  :uri_user_delete, :uri_user_retrieve
 
     def initialize
       Cb::Utils::Country.inject_convenience_methods
@@ -30,6 +30,7 @@ module Cb
       @uri_application_registered         ||= '/v3/Application/registered'
       @uri_user_change_password           ||= '/v2/User/ChangePW'
       @uri_user_delete                    ||= '/v2/User/delete'
+      @uri_user_retrieve                  ||= '/v2/user/retrieve'
     end
 
     def to_hash
@@ -50,7 +51,8 @@ module Cb
         :uri_application                  => @uri_application,
         :uri_application_submit           => @uri_application_submit,
         :uri_application_registered       => @uri_application_registered,
-        :uri_user_change_password         => @uri_user_change_password
+        :uri_user_change_password         => @uri_user_change_password,
+        :uri_user_retrieve                => @uri_user_retrieve
       }
     end
 

data/lib/cb/models/cb_user.rb

@@ -0,0 +1,52 @@
+module Cb
+	class CbUser
+	    attr_accessor :user_status, :password, :email, :address_1, :address_2, :city, :state,
+	                  :province, :postal_code, :zip, :country_code, :first_name,
+	                  :last_name, :phone, :fax, :last_login, :created, :allow_partner_emails,
+	                  :allow_newsletter_emails, :allow_email_from_headhunter, :domain, :registration_path, 
+	                  :user_type, :gender, :birth_date, :cobrand_code, :resume_stats, :custom_values
+
+	    def initialize(args = {})
+			return if args.nil?
+
+			@user_status                  = args['UserStatus'] || ''
+			@password                     = ''
+			@email              		  = args['Email'] || ''
+			@address_1                    = args['Address1'] || ''
+			@address_2                    = args['Address2'] || ''
+			@city                         = args['City'] || ''
+			@state                        = args['State'] || ''
+			@province                     = args['Province'] || ''
+			@postal_code                  = args['PostalCode'] || ''
+			@zip                          = args['Zip'] || ''
+			@country_code                 = args['CountryCode'] || ''
+			@first_name                   = args['FirstName'] || ''
+			@last_name                    = args['LastName'] || ''
+			@phone                        = args['Phone'] || ''
+			@fax                          = args['Fax'] || ''
+			@last_login                   = args['LastLogin'] || ''
+			@created                      = args['CreatedDT'] || ''
+			@allow_partner_emails         = args['AllowPartnerEmails'] || ''
+			@allow_newsletter_emails      = args['AllowNewsletterEmails'] || ''
+			@allow_email_from_headhunter  = args['AllowEmailFromHeadHunter'] || ''
+			@domain                       = args['Domain'] || ''
+			@registration_path            = args['RegistrationPath'] || ''
+			@user_type                    = args['UserType'] || ''
+			@gender                       = args['Gender'] || ''
+			@birth_date                   = args['BirthDate'] || ''
+			@cobrand_code                 = args['CoBrandCode'] || ''
+			@resume_stats                 = args['ResumeStats'] || ''
+			@custom_values                = args['CustomValues'] || ''
+	    end
+
+	    def custom_value custom_value_key
+	    	custom_value_value = nil
+	    	
+	    	@custom_values['CustomValue'].each do |custom_value|
+	    		custom_value_value = custom_value['Value'] if custom_value['Key'] == custom_value_key
+	    	end
+
+	    	return custom_value_value
+	    end
+	end
+end

data/lib/cb/version.rb

@@ -1,3 +1,3 @@
 module Cb
-  VERSION = '0.1.4'
+  VERSION = '0.1.5'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cb-api
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
   prerelease: 
 platform: ruby
 authors:
@@ -10,10 +10,11 @@ authors:
 - Miriam Williams
 - David Posey
 - Kyle Bumpus
+- Ben Schmaltz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-29 00:00:00.000000000 Z
+date: 2013-06-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -54,6 +55,7 @@ email:
 - MiriamDeana@gmail.com
 - David.Posey@Careerbuilder.com
 - Kyle.Bumpus@Careerbuilder.com
+- Ben.Schmaltz@Careerbuilder.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -76,6 +78,7 @@ files:
 - lib/cb/models/cb_education.rb
 - lib/cb/models/cb_employee_type.rb
 - lib/cb/models/cb_job.rb
+- lib/cb/models/cb_user.rb
 - lib/cb/utils/api.rb
 - lib/cb/utils/country.rb
 - lib/cb/utils/fluid_attributes.rb