cb-api 17.4.0 → 18.0.0

data/lib/cb/clients/user.rb

@@ -1,10 +1,19 @@
+# Copyright 2015 CareerBuilder, LLC
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and limitations under the License.
 require 'json'
 
 module Cb
   module Clients
     class User
       class << self
-
         def check_existing(email, password)
           xml = build_check_existing_request(email, password)
           response = api_client.cb_post(Cb.configuration.uri_user_check_existing, body: xml)
@@ -17,11 +26,11 @@ module Cb
           Cb::Responses::User::TemporaryPassword.new(response)
         end
 
-        def retrieve(external_id, test_mode = false)
+        def retrieve(external_id, _test_mode = false)
           my_api = Cb::Utils::Api.instance
-          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'
+          json_hash = my_api.cb_post Cb.configuration.uri_user_retrieve, body: build_retrieve_request(external_id, true)
+          if json_hash.key? 'ResponseUserInfo'
+            if json_hash['ResponseUserInfo'].key? 'UserInfo'
               user = Models::User.new json_hash['ResponseUserInfo']['UserInfo']
             end
             my_api.append_api_responses user, json_hash['ResponseUserInfo']
@@ -32,18 +41,18 @@ module Cb
 
         def change_password(user_info)
           my_api = Cb::Utils::Api.instance
-          uri = Cb::configuration.uri_user_change_password
-          response = my_api.cb_post(uri, :body => user_info.to_xml)
+          uri = Cb.configuration.uri_user_change_password
+          response = my_api.cb_post(uri, body: user_info.to_xml)
 
-          Cb::Responses::User::ChangePassword.new(response) if response.has_key?('ResponseUserChangePW')
+          Cb::Responses::User::ChangePassword.new(response) if response.key?('ResponseUserChangePW')
         end
 
         def delete(delete_criteria)
           my_api = Cb::Utils::Api.instance
-          uri = Cb::configuration.uri_user_delete
-          response = my_api.cb_post(uri, :body => delete_criteria.to_xml)
+          uri = Cb.configuration.uri_user_delete
+          response = my_api.cb_post(uri, body: delete_criteria.to_xml)
 
-          Cb::Responses::User::Delete.new(response) if response.has_key?('ResponseUserDelete')
+          Cb::Responses::User::Delete.new(response) if response.key?('ResponseUserDelete')
         end
 
         private
@@ -64,7 +73,7 @@ module Cb
             <Request>
               <DeveloperKey>#{Cb.configuration.dev_key}</DeveloperKey>
               <ExternalID>#{external_id}</ExternalID>
-              <Test>#{test_mode.to_s}</Test>
+              <Test>#{test_mode}</Test>
             </Request>
           eos
         end
@@ -74,7 +83,7 @@ module Cb
             <Request>
               <DeveloperKey>#{Cb.configuration.dev_key}</DeveloperKey>
               <ExternalID>#{external_id}</ExternalID>
-              <Test>#{test_mode.to_s}</Test>
+              <Test>#{test_mode}</Test>
               <OldPassword>#{old_password}</OldPassword>
               <NewPassword>#{new_password}</NewPassword>
             </Request>
@@ -84,7 +93,6 @@ module Cb
         def api_client
           Cb::Utils::Api.instance
         end
-
       end
     end
   end

data/lib/cb/config.rb

@@ -1,6 +1,15 @@
+# Copyright 2015 CareerBuilder, LLC
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and limitations under the License.
 module Cb
   class Config
-
     def initialize
       Cb::Utils::Country.inject_convenience_methods
       set_defaults
@@ -23,6 +32,7 @@ module Cb
     end
 
     protected
+
     #################################################################
 
     def set_defaults
@@ -33,71 +43,71 @@ module Cb
       @use_json             = true
       @host_site            = Cb.country.US
       @test_resources       = false
-      @observers            = Array.new
+      @observers            = []
       set_default_api_uris
       set_attr_accessors
     end
 
     private
+
     #################################################################
 
     def set_default_api_uris
-      @uri_job_category_search            ||= '/v1/categories'
-      @uri_job_industry_search            ||= '/v1/industrycodes'
-      @uri_employee_types                 ||= '/v1/employeetypes'
-      @uri_company_find                   ||= '/Employer/CompanyDetails'
-      @uri_job_search                     ||= '/v1/JobSearch'
-      @uri_job_search_v3                  ||= '/consumer/jobs/search/'
-      @uri_job_find                       ||= '/v3/Job'
-      @uri_education_code                 ||= '/v1/EducationCodes'
-      @uri_recommendation_for_job         ||= '/v1/Recommendations/ForJob'
-      @uri_recommendation_for_user        ||= '/v1/Recommendations/ForUser'
-      @uri_recommendation_for_company     ||= '/Employer/JobRecommendation'
-      @uri_recommendation_for_resume      ||= '/jobsearch/recommendations/:resume_hash'
-      @uri_application                    ||= '/cbapi/application/:did'
-      @uri_application_create             ||= '/cbapi/application/'
-      @uri_application_submit             ||= '/v1/Application/submit'
-      @uri_application_registered         ||= '/v3/application/registered'
-      @uri_application_external           ||= '/v1/application/external'
-      @uri_application_form               ||= '/cbapi/job/:did/applicationform'
-      @uri_user_change_password           ||= '/v2/User/ChangePW'
-      @uri_user_delete                    ||= '/v2/User/delete'
-      @uri_user_retrieve                  ||= '/v2/user/retrieve'
-      @uri_user_check_existing            ||= '/v2/user/checkexisting'
-      @uri_user_temp_password             ||= '/v1/user/temporarypassword'
-      @uri_job_branding                   ||= '/branding'
-      @uri_saved_search_retrieve          ||= '/cbapi/savedsearches/:did'
-      @uri_saved_search_create            ||= '/v2/savedsearch/create'
-      @uri_saved_search_update            ||= '/cbapi/SavedSearches'
-      @uri_saved_search_delete            ||= '/cbapi/savedsearches/:did'
-      @uri_saved_search_list              ||= '/cbapi/savedsearches'
-      @uri_anon_saved_search_create       ||= '/v1/anonymoussavedjobsearch/create'
-      @uri_anon_saved_search_delete       ||= '/v1/anonymoussavedjobsearch/delete'
-      @uri_tn_join_questions              ||= '/talentnetwork/config/join/questions'
-      @uri_tn_job_info                    ||= '/talentnetwork/internal/job'
-      @uri_tn_join_form_geo               ||= '/tn/JoinForm/Geo'
-      @uri_tn_join_form_branding          ||= '/talentnetwork/config/layout/branding'
-      @uri_tn_member_create               ||= '/talentnetwork/member/create'
-      @uri_subscription_retrieve          ||= '/v2/user/subscription/retrieve'
-      @uri_subscription_modify            ||= '/v2/user/subscription'
-      @uri_saved_job_search_create        ||= '/v2/savedsearch/create'
-      @uri_work_status_list               ||= '/v1/resume/workstatuslist'
-      @uri_resume_get                     ||= '/cbapi/resumes/:resume_hash'
-      @uri_resume_put                     ||= '/cbapi/resumes/:resume_hash'
-      @uri_resume_delete                  ||= '/cbapi/resumes/:resume_hash'
-      @uri_resume_post                    ||= '/consumer/resumedocuments'
-      @uri_resume_list                    ||= '/v3/resume/list'
-      @uri_resume_language_codes          ||= '/v1/languagecodes'
-      @uri_countries                      ||= '/consumer/datalist/countries'
-      @uri_resume_education               ||= '/consumer/datalist/ResumeEducation'
-      @uri_languages                      ||= '/consumer/datalist/languages'
-      @uri_desired_job_type               ||= '/consumer/datalist/desiredjobtype'
-      @uri_state_list                     ||= '/ajax/citysuggest.aspx'
+      @uri_job_category_search ||= '/v1/categories'
+      @uri_job_industry_search ||= '/v1/industrycodes'
+      @uri_employee_types ||= '/v1/employeetypes'
+      @uri_company_find ||= '/Employer/CompanyDetails'
+      @uri_job_search ||= '/v1/JobSearch'
+      @uri_job_search_v3 ||= '/consumer/jobs/search/'
+      @uri_job_find ||= '/v3/Job'
+      @uri_education_code ||= '/v1/EducationCodes'
+      @uri_recommendation_for_job ||= '/v1/Recommendations/ForJob'
+      @uri_recommendation_for_user ||= '/v1/Recommendations/ForUser'
+      @uri_recommendation_for_company ||= '/Employer/JobRecommendation'
+      @uri_recommendation_for_resume ||= '/jobsearch/recommendations/:resume_hash'
+      @uri_application ||= '/cbapi/application/:did'
+      @uri_application_create ||= '/cbapi/application/'
+      @uri_application_submit ||= '/v1/Application/submit'
+      @uri_application_registered ||= '/v3/application/registered'
+      @uri_application_external ||= '/v1/application/external'
+      @uri_application_form ||= '/cbapi/job/:did/applicationform'
+      @uri_user_change_password ||= '/v2/User/ChangePW'
+      @uri_user_delete ||= '/v2/User/delete'
+      @uri_user_retrieve ||= '/v2/user/retrieve'
+      @uri_user_check_existing ||= '/v2/user/checkexisting'
+      @uri_user_temp_password ||= '/v1/user/temporarypassword'
+      @uri_job_branding ||= '/branding'
+      @uri_saved_search_retrieve ||= '/cbapi/savedsearches/:did'
+      @uri_saved_search_create ||= '/v2/savedsearch/create'
+      @uri_saved_search_update ||= '/cbapi/SavedSearches'
+      @uri_saved_search_delete ||= '/cbapi/savedsearches/:did'
+      @uri_saved_search_list ||= '/cbapi/savedsearches'
+      @uri_anon_saved_search_create ||= '/v1/anonymoussavedjobsearch/create'
+      @uri_anon_saved_search_delete ||= '/v1/anonymoussavedjobsearch/delete'
+      @uri_tn_join_questions ||= '/talentnetwork/config/join/questions'
+      @uri_tn_job_info ||= '/talentnetwork/internal/job'
+      @uri_tn_join_form_geo ||= '/tn/JoinForm/Geo'
+      @uri_tn_join_form_branding ||= '/talentnetwork/config/layout/branding'
+      @uri_tn_member_create ||= '/talentnetwork/member/create'
+      @uri_subscription_retrieve ||= '/v2/user/subscription/retrieve'
+      @uri_subscription_modify ||= '/v2/user/subscription'
+      @uri_saved_job_search_create ||= '/v2/savedsearch/create'
+      @uri_work_status_list ||= '/v1/resume/workstatuslist'
+      @uri_resume_get ||= '/cbapi/resumes/:resume_hash'
+      @uri_resume_put ||= '/cbapi/resumes/:resume_hash'
+      @uri_resume_delete ||= '/cbapi/resumes/:resume_hash'
+      @uri_resume_post ||= '/consumer/resumedocuments'
+      @uri_resume_list ||= '/v3/resume/list'
+      @uri_resume_language_codes ||= '/v1/languagecodes'
+      @uri_countries ||= '/consumer/datalist/countries'
+      @uri_resume_education ||= '/consumer/datalist/ResumeEducation'
+      @uri_languages ||= '/consumer/datalist/languages'
+      @uri_desired_job_type ||= '/consumer/datalist/desiredjobtype'
+      @uri_state_list ||= '/ajax/citysuggest.aspx'
     end
 
     def set_attr_accessors
       instance_variables.each { |instance_variable| self.class.send :attr_accessor, instance_variable[1..-1].to_sym }
     end
-
   end
 end

data/lib/cb/convenience.rb

@@ -1,7 +1,16 @@
+# Copyright 2015 CareerBuilder, LLC
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and limitations under the License.
 module Cb
   module Convenience
     module ClassMethods
-
       def api_client
         Cb::Utils::Api
       end
@@ -13,7 +22,7 @@ module Cb
       def job_details_criteria
         Cb::Criteria::Job::Details.new
       end
-  
+
       def category
         Cb::Clients::Category
       end
@@ -25,7 +34,7 @@ module Cb
       def company
         Cb::Clients::Company
       end
-  
+
       def education_code
         Cb::Clients::Education
       end
@@ -33,43 +42,43 @@ module Cb
       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

data/lib/cb/criteria/application/cover_letter.rb

@@ -1,3 +1,13 @@
+# Copyright 2015 CareerBuilder, LLC
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and limitations under the License.
 module Cb
   module Criteria
     module Application

data/lib/cb/criteria/application/create.rb

@@ -1,9 +1,19 @@
+# Copyright 2015 CareerBuilder, LLC
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and limitations under the License.
 module Cb
   module Criteria
     module Application
       class Create
         extend Cb::Utils::FluidAttributes
-        fluid_attr_accessor :job_did, :is_submitted, :external_user_id, :vid, :bid, :sid, :site_id, :ipath_id, :tn_did, :host_site, 
+        fluid_attr_accessor :job_did, :is_submitted, :external_user_id, :vid, :bid, :sid, :site_id, :ipath_id, :tn_did, :host_site,
                             :resume, :cover_letter, :responses
 
         def to_json

data/lib/cb/criteria/application/get.rb

@@ -1,3 +1,13 @@
+# Copyright 2015 CareerBuilder, LLC
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and limitations under the License.
 module Cb
   module Criteria
     module Application

data/lib/cb/criteria/application/response.rb

@@ -1,3 +1,13 @@
+# Copyright 2015 CareerBuilder, LLC
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and limitations under the License.
 module Cb
   module Criteria
     module Application

data/lib/cb/criteria/application/resume.rb

@@ -1,3 +1,13 @@
+# Copyright 2015 CareerBuilder, LLC
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and limitations under the License.
 module Cb
   module Criteria
     module Application

data/lib/cb/criteria/application/update.rb

@@ -1,3 +1,13 @@
+# Copyright 2015 CareerBuilder, LLC
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and limitations under the License.
 module Cb
   module Criteria
     module Application

data/lib/cb/criteria/job/details.rb

@@ -1,3 +1,13 @@
+# Copyright 2015 CareerBuilder, LLC
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and limitations under the License.
 module Cb
   module Criteria
     module Job
@@ -8,4 +18,4 @@ module Cb
       end
     end
   end
-end
+end

data/lib/cb/criteria/resumes/get_by_hash.rb

@@ -1,3 +1,13 @@
+# Copyright 2015 CareerBuilder, LLC
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and limitations under the License.
 module Cb
   module Criteria
     module Resumes
@@ -12,10 +22,10 @@ module Cb
         end
 
         def to_hash
-          { :resume_hash => @resume_hash, :external_user_id => @external_user_id }
+          { resume_hash: @resume_hash, external_user_id: @external_user_id }
         end
 
-        alias :to_h :to_hash
+        alias_method :to_h, :to_hash
       end
     end
   end