cb-api 1.3.6 → 2.0.0

data/lib/cb/clients/job.rb

@@ -0,0 +1,57 @@
+require 'json'
+
+module Cb
+  module Clients
+    class Job
+
+      def self.search(*args)
+        args = args[0] if args.is_a?(Array) && args.count == 1
+        my_api = Cb::Utils::Api.new
+        json_hash = my_api.cb_get(Cb.configuration.uri_job_search, :query => args)
+
+        jobs = Array.new
+        if !json_hash['ResponseJobSearch'].nil? && !json_hash['ResponseJobSearch']['Results'].nil?
+          job_results = json_hash['ResponseJobSearch']['Results']['JobSearchResult']
+          job_results = [job_results] if !job_results.is_a?(Array)
+          job_results.each { |job_hash| jobs.push(Models::Job.new(job_hash)) }
+          my_api.append_api_responses(jobs, json_hash['ResponseJobSearch'])
+
+          if response_has_search_metadata?(json_hash['ResponseJobSearch'])
+            my_api.append_api_responses(jobs, json_hash['ResponseJobSearch']['SearchMetaData']['SearchLocations']['SearchLocation'])
+          end
+        end
+
+        my_api.append_api_responses(jobs, json_hash)
+      end
+
+      def self.find_by_criteria(criteria)
+        my_api = Cb::Utils::Api.new
+        params = my_api.class.criteria_to_hash(criteria)
+        json_hash = my_api.cb_get(Cb.configuration.uri_job_find, :query => params)
+
+        if json_hash.has_key?('ResponseJob')
+          if json_hash['ResponseJob'].has_key?('Job')
+            job = Models::Job.new(json_hash['ResponseJob']['Job'])
+          end
+          my_api.append_api_responses(job, json_hash['ResponseJob'])
+        end
+        my_api.append_api_responses(job, json_hash)
+      end
+
+      def self.find_by_did(did)
+        criteria = Cb::Criteria::Job::Details.new
+        criteria.did = did
+        criteria.show_custom_values = true
+        return find_by_criteria(criteria)
+      end
+
+      private
+
+      def self.response_has_search_metadata?(response_hash)
+        response_hash['SearchMetaData'] &&
+        response_hash['SearchMetaData']['SearchLocations'] &&
+        response_hash['SearchMetaData']['SearchLocations']['SearchLocation']
+      end
+    end
+  end
+end

data/lib/cb/clients/job_branding.rb

@@ -0,0 +1,21 @@
+require 'nori'
+
+module Cb
+  module Clients
+    class JobBranding
+
+      def self.find_by_id id
+        my_api = Cb::Utils::Api.new
+        json_hash = my_api.cb_get Cb.configuration.uri_job_branding, :query => { :id => id }
+
+        if json_hash.has_key? 'Branding'
+          branding = Models::JobBranding.new json_hash['Branding']
+          my_api.append_api_responses(branding, json_hash['Branding'])
+        end
+
+        my_api.append_api_responses(branding, json_hash)
+      end
+
+    end
+  end
+end

data/lib/cb/clients/recommendation.rb

@@ -0,0 +1,76 @@
+require 'json'
+
+module Cb
+  module Clients
+    class Recommendation
+
+      def self.for_job(did, countlimit = '25', site_id = '', co_brand = '')
+        my_api = Cb::Utils::Api.new
+        json_hash = my_api.cb_get(Cb.configuration.uri_recommendation_for_job,
+                                    :query => {:JobDID => did, :CountLimit => countlimit, :SiteID => site_id,
+                                               :CoBrand => co_brand, :HostSite => Cb.configuration.host_site})
+
+        jobs = []
+        if json_hash.has_key?('ResponseRecommendJob')
+          if json_hash['ResponseRecommendJob'].has_key?('RecommendJobResults') &&
+             !json_hash['ResponseRecommendJob']['RecommendJobResults'].nil?
+
+            json_hash['ResponseRecommendJob']['RecommendJobResults']['RecommendJobResult'].each do |cur_job|
+              jobs << Models::Job.new(cur_job)
+            end
+
+            my_api.append_api_responses(jobs, json_hash['ResponseRecommendJob']['Request'])
+          end
+
+          my_api.append_api_responses(jobs, json_hash['ResponseRecommendJob'])
+        end
+
+        my_api.append_api_responses(jobs, json_hash)
+      end
+
+      def self.for_user(external_id, countlimit = '25', site_id = '', co_brand = '')
+        my_api = Cb::Utils::Api.new
+        json_hash = my_api.cb_get(Cb.configuration.uri_recommendation_for_user,
+                                    :query => {:ExternalID => external_id, :CountLimit => countlimit, :SiteID => site_id, :CoBrand => co_brand,
+                                               :HostSite => Cb.configuration.host_site})
+
+        jobs = []
+        if json_hash.has_key?('ResponseRecommendUser')
+
+          if json_hash['ResponseRecommendUser'].has_key?('RecommendJobResults') &&
+            !json_hash['ResponseRecommendUser']['RecommendJobResults'].nil?
+
+            json_hash['ResponseRecommendUser']['RecommendJobResults']['RecommendJobResult'].each do |cur_job|
+              jobs << Models::Job.new(cur_job)
+            end
+            my_api.append_api_responses(jobs, json_hash['ResponseRecommendUser']['Request'])
+          end
+
+          my_api.append_api_responses(jobs, json_hash['ResponseRecommendUser'])
+        end
+
+        my_api.append_api_responses(jobs, json_hash)
+      end
+
+      def self.for_company(company_did)
+        my_api = Cb::Utils::Api.new
+        json_hash = my_api.cb_get(Cb.configuration.uri_recommendation_for_company, :query => {:CompanyDID => company_did})
+
+        jobs = []
+        if json_hash.has_key?('Results')
+          if json_hash['Results'].has_key?('JobRecommendation')
+            json_hash['Results']['JobRecommendation']['Jobs'].each do |cur_job|
+              jobs << Models::Job.new(cur_job)
+            end
+            my_api.append_api_responses(jobs, json_hash['Results']['JobRecommendation'])
+          end
+
+          my_api.append_api_responses(jobs, json_hash['Results'])
+        end
+
+        my_api.append_api_responses(jobs, json_hash)
+      end
+
+    end
+  end
+end

data/lib/cb/clients/saved_search.rb

@@ -0,0 +1,66 @@
+module Cb
+  module Clients
+
+    class SavedSearch
+      def create(saved_search)
+        body = saved_search.create_to_xml
+        json = cb_client.cb_post(Cb.configuration.uri_saved_search_create, :body => body)
+        singular_model_response(json, saved_search.external_user_id)
+      end
+
+      def update(saved_search)
+        body = saved_search.update_to_xml
+        json = cb_client.cb_post(Cb.configuration.uri_saved_search_update, :body => body)
+        singular_model_response(json, saved_search.external_user_id, saved_search.external_id)
+      end
+
+      def delete(saved_search)
+        body = saved_search.delete_to_xml
+        json = cb_client.cb_post(Cb.configuration.uri_saved_search_delete, :body => body)
+        Responses::SavedSearch::Delete.new(json)
+      end
+
+      def retrieve(external_user_id, external_id, host_site)
+        query = retrieve_query(external_user_id, external_id, host_site)
+        json = cb_client.cb_get(Cb.configuration.uri_saved_search_retrieve, :query => query)
+        singular_model_response(json, external_user_id, external_id)
+      end
+
+      def list(external_user_id, host_site)
+        query = list_query(external_user_id, host_site)
+        json = cb_client.cb_get(Cb.configuration.uri_saved_search_list, :query => query)
+        Responses::SavedSearch::List.new(json)
+      end
+
+      private
+
+      def cb_client
+        @cb_client ||= Cb.api_client.new
+      end
+
+      def retrieve_query(external_user_id, external_id, host_site)
+        {
+          :developerkey   => Cb.configuration.dev_key,
+          :externalid     => external_id,
+          :externaluserid => external_user_id,
+          :hostsite       => host_site
+        }
+      end
+
+      def list_query(external_user_id, host_site)
+        {
+          :developerkey   => Cb.configuration.dev_key,
+          :externaluserid => external_user_id,
+          :hostsite       => host_site
+        }
+      end
+
+      def singular_model_response(json_hash, external_user_id = nil, external_id = nil)
+        json_hash['ExternalUserID'] = external_user_id unless external_user_id.nil?
+        json_hash['ExternalID'] = external_id unless external_id.nil?
+        Responses::SavedSearch::Singular.new(json_hash)
+      end
+    end
+
+  end
+end

data/lib/cb/clients/spot.rb

@@ -0,0 +1,27 @@
+require 'json'
+
+module Cb
+  module Clients
+    class Spot
+      class << self
+
+        def retrieve(criteria)
+          response = retrieve_api_response criteria
+          Cb::Responses::Spot::Retrieve.new(response)
+        end
+
+        private
+
+        def retrieve_api_response(criteria)
+          params = api_client.class.criteria_to_hash criteria
+          api_client.cb_get(Cb.configuration.uri_spot_retrieve, :query => params)
+        end
+
+        def api_client
+          @api ||= Cb::Utils::Api.new
+        end
+
+      end
+    end
+  end
+end

data/lib/cb/clients/talent_network.rb

@@ -0,0 +1,51 @@
+module Cb
+  module Clients
+    class TalentNetwork
+
+      def self.join_form_questions(tndid)
+        my_api = Cb::Utils::Api.new
+        json_hash = my_api.cb_get("#{Cb.configuration.uri_tn_join_questions}/#{tndid}/json")
+        tn_questions_collection = Models::TalentNetwork.new(json_hash)
+        my_api.append_api_responses(tn_questions_collection, json_hash)
+      end
+
+      def self.join_form_branding(tndid)
+        my_api = Cb::Utils::Api.new
+        json_hash = my_api.cb_get("#{Cb.configuration.uri_tn_join_form_branding}/#{tndid}/json")
+
+        if json_hash.has_key? 'Branding'
+          tn_join_form_branding = Models::TalentNetwork::JoinFormBranding.new(json_hash['Branding'])
+        end
+
+        my_api.append_api_responses(tn_join_form_branding, json_hash)
+      end
+
+      def self.join_form_geography(tnlanguage="USEnglish")
+        my_api = Cb::Utils::Api.new
+        json_hash = my_api.cb_get("#{Cb.configuration.uri_tn_join_form_geo}", :query => {:TNLanguage => "#{tnlanguage}"})
+        geo_dropdown = Models::TalentNetwork::JoinFormGeo.new(json_hash)
+        my_api.append_api_responses(geo_dropdown, json_hash)
+      end
+
+      def self.member_create(args={})
+        my_api = Cb::Utils::Api.new
+        tn_member = Models::TalentNetwork::Member.new(args)
+        json_hash = my_api.cb_post("#{Cb.configuration.uri_tn_member_create}/json", :body => tn_member.to_xml )
+        my_api.append_api_responses(json_hash, json_hash)
+      end
+
+      def self.tn_job_information(job_did, join_form_intercept="true")
+        my_api = Cb::Utils::Api.new
+        json_hash = my_api.cb_get("#{Cb.configuration.uri_tn_job_info}/#{job_did}/json", :query=> {
+           :RequestJoinFormIntercept => join_form_intercept})
+
+        if json_hash.has_key? 'Response'
+          tn_job_info = Models::TalentNetwork::JobInfo.new(json_hash['Response'])
+        end
+
+        my_api.append_api_responses(tn_job_info, json_hash)
+      end
+
+    end
+  end
+end

data/lib/cb/clients/user.rb

@@ -0,0 +1,94 @@
+require 'json'
+require 'nokogiri'
+
+module Cb
+  module Clients
+    class User
+
+      def self.retrieve external_id, test_mode = false
+        my_api = Cb::Utils::Api.new
+        json_hash = my_api.cb_post Cb.configuration.uri_user_retrieve, :body => build_retrieve_request(external_id, true)
+
+        if json_hash.has_key? 'ResponseUserInfo'
+          if json_hash['ResponseUserInfo'].has_key? 'UserInfo'
+            user = Models::User.new json_hash['ResponseUserInfo']['UserInfo']
+          end
+          my_api.append_api_responses user, json_hash['ResponseUserInfo']
+        end
+
+        my_api.append_api_responses user, json_hash
+      end
+
+      def self.change_password external_id, old_password, new_password, test_mode = false
+        result = false
+        my_api = Cb::Utils::Api.new
+        json_hash = my_api.cb_post Cb.configuration.uri_user_change_password, :body => build_change_password_request(external_id, old_password, new_password, test_mode)
+
+        if json_hash.has_key? 'ResponseUserChangePW'
+          if json_hash['ResponseUserChangePW'].has_key?('Status') && json_hash['ResponseUserChangePW']['Status'].include?('Success')
+            result = true
+          end
+          my_api.append_api_responses result, json_hash['ResponseUserChangePW']
+        end
+
+        my_api.append_api_responses result, json_hash
+      end
+
+      def self.delete external_id, password, test_mode = false
+        result = false
+        my_api = Cb::Utils::Api.new
+        json_hash = my_api.cb_post Cb.configuration.uri_user_delete, :body => build_delete_request(external_id, password, test_mode)
+
+        if json_hash.has_key? 'ResponseUserDelete'
+          if json_hash['ResponseUserDelete'].has_key?('Status') && json_hash['ResponseUserDelete']['Status'].include?('Success')
+            result = true
+          end
+          my_api.append_api_responses result, json_hash['ResponseUserDelete']
+        end
+
+        my_api.append_api_responses result, json_hash
+      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
+      end
+
+      def self.build_delete_request external_id, password, test_mode
+        builder = Nokogiri::XML::Builder.new do
+          Request {
+            ExternalID_ external_id
+            Password_ password
+            Test_ test_mode.to_s
+            DeveloperKey_ Cb.configuration.dev_key
+          }
+        end
+
+        builder.to_xml
+      end
+
+    end
+  end
+end

data/lib/cb/convenience.rb

@@ -0,0 +1,83 @@
+module Cb
+  module Convenience
+    module ClassMethods
+
+      def api_client
+        Cb::Utils::Api
+      end
+
+      def job
+        Cb::Clients::Job
+      end
+  
+      def job_search_criteria
+        Cb::Criteria::Job::Search.new
+      end
+  
+      def job_details_criteria
+        Cb::Criteria::Job::Details.new
+      end
+  
+      def category
+        Cb::Clients::Category
+      end
+  
+      def company
+        Cb::Clients::Company
+      end
+  
+      def education_code
+        Cb::Clients::Education
+      end
+
+      def employee_types
+        Cb::Clients::EmployeeTypes
+      end
+  
+      def recommendation
+        Cb::Clients::Recommendation
+      end
+  
+      def application
+        Cb::Clients::Application
+      end
+  
+      def application_external
+        Cb::Clients::ApplicationExternal
+      end
+  
+      def country
+        Cb::Utils::Country
+      end
+  
+      def user
+        Cb::Clients::User
+      end
+  
+      def job_branding
+        Cb::Clients::JobBranding
+      end
+  
+      def email_subscription
+        Cb::Clients::EmailSubscription
+      end
+  
+      def saved_search
+        Cb::Clients::SavedSearch
+      end
+  
+      def talent_network
+        Cb::Clients::TalentNetwork
+      end
+  
+      def anon_saved_search
+        Cb::Clients::AnonSavedSearch
+      end
+  
+      def spot
+        Cb::Clients::Spot
+      end
+      
+    end
+  end
+end