cb-api 19.1.1 → 20.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7e1ad51af191a99572a406269d6c2651a8fa5ff7
-  data.tar.gz: b64a995401eb9222ad3081084e2ea1198e3c1b49
+  metadata.gz: c0242c0310d95df0d5a5ec18e5b6854c854d6d75
+  data.tar.gz: 57a461e4922d487512d15d42591202cb6895a536
 SHA512:
-  metadata.gz: f8c76d539e0823fefecb876a5d94869e2d862e13574838f01839e33c8556b3def6341cb8c24ad06cf9740a3a6410e98d2857c45a8b7c48bcaadae68bb7bbec63
-  data.tar.gz: 4894150692ad214101a51c26e2528d97aaf0c16e2772c6d8e95423f225efc35e1faf097631509b3d2a561ddf004004048af03954703a820ff7240b56aabe371a
+  metadata.gz: 094c95855fd37458d597fe4c21e283bddc3367ee775aa5e057a4fbabb8e0db9573d418ef3aafffbc5ac09083847e69102facdf824aaa3e68ec065aab5868551f
+  data.tar.gz: 361519737459ad1b9bbc70308009c0deeadc129036507a4b50d5167832d1e5a56f3514194bc35d665ad57ce70d8049c44d23b46188c49b726a3b331e02c7ab45

data/CHANGELOG.md

@@ -3,6 +3,7 @@ Version History
     * All Version bumps are required to update this file as well!!
 ----
 
+* 20.0.0 Refactoring of the clients.  Breaking changes to AnonSavedSearch, EmployeeTypes, SavedSearch
 * 19.1.1 No functional differences, some code cleanup
 * 19.1.0 Add Migration ID field to resume listing model.
 * 19.0.0 Removed job search version(s) prior to version 3.  Breaks existing consumers of the API in the following ways. JobResultsV3 renamed to JobResults.  The old JobResults path no longer works.  Users of the JobSearch API will now need to use OAuth and not Developer Keys to use the JobSearch API>

data/lib/cb/clients/anon_saved_search.rb

@@ -8,16 +8,17 @@
 # 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_relative 'base'
 module Cb
   module Clients
-    class AnonSavedSearch
-      def create(*args)
+    class AnonSavedSearch < Base
+      def self.create(*args)
         body = new_model(*args).create_anon_to_xml
         json = cb_client.cb_post(create_uri, body: body)
         Responses::AnonymousSavedSearch::Create.new(json)
       end
 
-      def delete(*args)
+      def self.delete(*args)
         body = new_model(*args).delete_anon_to_xml
         json = cb_client.cb_post(delete_uri, body: body)
         Responses::AnonymousSavedSearch::Delete.new(json)
@@ -25,26 +26,22 @@ module Cb
 
       private
 
-      def new_model(*args)
+      def self.new_model(*args)
         return args.first if args.respond_to?(:[]) && args.first.is_a?(Models::SavedSearch)
         Models::SavedSearch.new(extract_args(*args))
       end
 
-      def extract_args(*args)
+      def self.extract_args(*args)
         args.is_a?(Array) && args.count == 1 ? args[0] : args
       end
 
-      def create_uri
+      def self.create_uri
         Cb.configuration.uri_anon_saved_search_create
       end
 
-      def delete_uri
+      def self.delete_uri
         Cb.configuration.uri_anon_saved_search_delete
       end
-
-      def cb_client
-        @cb_client ||= Cb::Utils::Api.instance
-      end
     end
   end
 end

data/lib/cb/clients/application.rb

@@ -8,9 +8,10 @@
 # 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_relative 'base'
 module Cb
   module Clients
-    class Application
+    class Application < Base
       class << self
         def get(criteria)
           response cb_call(:get, criteria, Cb.configuration.host_site)
@@ -26,7 +27,7 @@ module Cb
 
         def form(job_id)
           url = Cb.configuration.uri_application_form.sub(':did', job_id)
-          response_hash = api_client.cb_get(url, headers: headers(Cb.configuration.host_site))
+          response_hash = cb_client.cb_get(url, headers: headers(Cb.configuration.host_site))
           Responses::ApplicationForm.new response_hash
         end
 
@@ -40,7 +41,7 @@ module Cb
           end
 
           uri = uri(criteria)
-          api_client.method(:"cb_#{http_method}").call(uri, options)
+          cb_client.method(:"cb_#{http_method}").call(uri, options)
         end
 
         def response(response_hash)
@@ -59,10 +60,6 @@ module Cb
             'Content-Type' => 'application/json'
           }
         end
-
-        def api_client
-          Cb::Utils::Api.instance
-        end
       end
     end
   end

data/lib/cb/clients/application_external.rb

@@ -9,15 +9,14 @@
 # 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'
-
+require_relative 'base'
 module Cb
   module Clients
-    class ApplicationExternal
+    class ApplicationExternal < Base
       def self.submit_app(app)
         fail Cb::IncomingParamIsWrongTypeException unless app.is_a?(Cb::Models::ApplicationExternal)
 
-        my_api = Cb::Utils::Api.instance
-        xml_hash = my_api.cb_post(Cb.configuration.uri_application_external, body: app.to_xml)
+        xml_hash = cb_client.cb_post(Cb.configuration.uri_application_external, body: app.to_xml)
 
         if xml_hash.key? 'ApplyUrl'
           app.apply_url = xml_hash['ApplyUrl']
@@ -25,7 +24,7 @@ module Cb
           app.apply_url = ''
         end
 
-        my_api.append_api_responses(app, xml_hash)
+        cb_client.append_api_responses(app, xml_hash)
       end
     end
   end

data/lib/cb/clients/base.rb

@@ -0,0 +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 Clients
+    class Base
+      def self.cb_client
+        @cb_client ||= Cb::Utils::Api.instance
+      end
+    end
+  end
+end

data/lib/cb/clients/category.rb

@@ -9,13 +9,12 @@
 # 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'
-
+require_relative 'base'
 module Cb
   module Clients
-    class Category
+    class Category < Base
       def self.search
-        my_api = Cb::Utils::Api.instance
-        json_hash = my_api.cb_get(Cb.configuration.uri_job_category_search)
+        json_hash = cb_client.cb_get(Cb.configuration.uri_job_category_search)
         categoryList = []
 
         if json_hash.key?('ResponseCategories')
@@ -25,15 +24,14 @@ module Cb
             end
           end
 
-          my_api.append_api_responses(categoryList, json_hash['ResponseCategories'])
+          cb_client.append_api_responses(categoryList, json_hash['ResponseCategories'])
         end
 
-        my_api.append_api_responses(categoryList, json_hash)
+        cb_client.append_api_responses(categoryList, json_hash)
       end
 
       def self.search_by_host_site(host_site)
-        my_api = Cb::Utils::Api.instance
-        json_hash = my_api.cb_get(Cb.configuration.uri_job_category_search, query: { CountryCode: host_site })
+        json_hash = cb_client.cb_get(Cb.configuration.uri_job_category_search, query: { CountryCode: host_site })
         categoryList = []
 
         if json_hash.key?('ResponseCategories')
@@ -47,10 +45,10 @@ module Cb
             end
           end
 
-          my_api.append_api_responses(categoryList, json_hash['ResponseCategories'])
+          cb_client.append_api_responses(categoryList, json_hash['ResponseCategories'])
         end
 
-        my_api.append_api_responses(categoryList, json_hash)
+        cb_client.append_api_responses(categoryList, json_hash)
       end
     end
   end

data/lib/cb/clients/company.rb

@@ -9,22 +9,22 @@
 # 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'
-
+require_relative 'base'
 module Cb
   module Clients
-    class Company
+    class Company < Base
       def self.find_by_did(did)
-        my_api = Cb::Utils::Api.instance
-        json_hash = my_api.cb_get(Cb.configuration.uri_company_find, query: { CompanyDID: did, hostsite: Cb.configuration.host_site })
+        json_hash = cb_client.cb_get(Cb.configuration.uri_company_find,
+                                     query: { CompanyDID: did, hostsite: Cb.configuration.host_site })
 
         if json_hash.key?('Results')
           if json_hash['Results'].key?('CompanyProfileDetail')
             company = Models::Company.new(json_hash['Results']['CompanyProfileDetail'])
           end
-          my_api.append_api_responses(company, json_hash['Results'])
+          cb_client.append_api_responses(company, json_hash['Results'])
         end
 
-        my_api.append_api_responses(company, json_hash)
+        cb_client.append_api_responses(company, json_hash)
       end
 
       def self.find_for(obj)

data/lib/cb/clients/cover_letters.rb

@@ -0,0 +1,55 @@
+# 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_relative 'base'
+module Cb
+  module Clients
+    class CoverLetters < Base
+      def self.get(args={})
+        uri = Cb.configuration.uri_cover_letters
+        uri += "/#{ args[:id] }" if args[:id]
+        cb_client.cb_get(uri, headers: headers(args))
+      end
+
+      def self.create(args={})
+        cb_client.cb_put(Cb.configuration.uri_cover_letters,
+                         body: body(args),
+                         headers: headers(args))
+      end
+
+      def self.delete(args={})
+        uri = "#{ Cb.configuration.uri_cover_letters }/#{ args[:id] }"
+        cb_client.cb_delete(uri, body: body(args), headers: headers(args))
+      end
+
+      def self.update(args={})
+        uri = "#{ Cb.configuration.uri_cover_letters }/#{ args[:id] }"
+        cb_client.cb_post(uri, body: body(args), headers: headers(args))
+      end
+
+      private
+      def self.headers(args)
+        {
+            'Accept' => 'application/json',
+            'Authorization' => "Bearer #{ args[:oauth_token] }",
+            'Content-Type' => 'application/json'
+        }
+      end
+
+      def self.body(args)
+        body = Hash.new
+        body[:id] = args[:id] if args[:id]
+        body[:text] = args[:text] if args[:text]
+        body[:name] = args[:name] if args[:name]
+        body.to_json
+      end
+    end
+  end
+end

data/lib/cb/clients/education.rb

@@ -9,14 +9,13 @@
 # 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'
-
+require_relative 'base'
 module Cb
   module Clients
-    class Education
+    class Education < Base
       def self.get_for(country)
         Cb::Utils::Country.is_valid? country ? country : 'US'
-        my_api = Cb::Utils::Api.instance
-        json_hash = my_api.cb_get(Cb.configuration.uri_education_code, query: { countrycode: country })
+        json_hash = cb_client.cb_get(Cb.configuration.uri_education_code, query: { countrycode: country })
 
         codes = []
         if json_hash.key?('ResponseEducationCodes')
@@ -26,10 +25,10 @@ module Cb
               codes << Cb::Models::Education.new(education)
             end
           end
-          my_api.append_api_responses(codes, json_hash['ResponseEducationCodes'])
+          cb_client.append_api_responses(codes, json_hash['ResponseEducationCodes'])
         end
 
-        my_api.append_api_responses(codes, json_hash)
+        cb_client.append_api_responses(codes, json_hash)
       end
     end
   end

data/lib/cb/clients/employee_types.rb

@@ -8,30 +8,27 @@
 # 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_relative 'base'
 module Cb
   module Clients
-    class EmployeeTypes
-      def search
+    class EmployeeTypes < Base
+      def self.search
         json = cb_client.cb_get(endpoint)
         new_response_object(json)
       end
 
-      def search_by_hostsite(host_site)
+      def self.search_by_hostsite(host_site)
         json = cb_client.cb_get(endpoint, query: { CountryCode: host_site })
         new_response_object(json)
       end
 
       private
 
-      def cb_client
-        @client ||= Cb::Utils::Api.instance
-      end
-
-      def endpoint
+      def self.endpoint
         Cb.configuration.uri_employee_types
       end
 
-      def new_response_object(json_response)
+      def self.new_response_object(json_response)
         Responses::EmployeeTypes::Search.new(json_response)
       end
     end

data/lib/cb/clients/industry.rb

@@ -9,21 +9,14 @@
 # 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'
-
+require_relative 'base'
 module Cb
   module Clients
-    class Industry
-      class << self
-        def search
-          response = api_client.cb_get(Cb.configuration.uri_job_industry_search, query: { CountryCode: Cb.configuration.host_site })
-          Cb::Responses::Industry::Search.new(response)
-        end
-
-        private
-
-        def api_client
-          @api ||= Cb::Utils::Api.instance
-        end
+    class Industry < Base
+      def self.search
+        response = cb_client.cb_get(Cb.configuration.uri_job_industry_search,
+                                    query: { CountryCode: Cb.configuration.host_site })
+        Cb::Responses::Industry::Search.new(response)
       end
     end
   end

data/lib/cb/clients/job.rb

@@ -9,14 +9,14 @@
 # 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'
-
+require_relative 'base'
 module Cb
   module Clients
-    class Job
+    class Job < Base
       class << self
         def find_by_criteria(criteria)
-          query = api_client.class.criteria_to_hash(criteria)
-          json_response = api_client.cb_get(Cb.configuration.uri_job_find, query: query)
+          query = cb_client.class.criteria_to_hash(criteria)
+          json_response = cb_client.cb_get(Cb.configuration.uri_job_find, query: query)
           Responses::Job::Singular.new(json_response)
         end
 
@@ -26,12 +26,6 @@ module Cb
           criteria.show_custom_values = true
           find_by_criteria(criteria)
         end
-
-        private
-
-        def api_client
-          @api ||= Cb::Utils::Api.instance
-        end
       end
     end
   end

data/lib/cb/clients/job_branding.rb

@@ -8,19 +8,19 @@
 # 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_relative 'base'
 module Cb
   module Clients
-    class JobBranding
+    class JobBranding < Base
       def self.find_by_id(id)
-        my_api = Cb::Utils::Api.instance
-        json_hash = my_api.cb_get Cb.configuration.uri_job_branding, query: { id: id }
+        json_hash = cb_client.cb_get Cb.configuration.uri_job_branding, query: { id: id }
 
         if json_hash.key? 'Branding'
           branding = Models::JobBranding.new json_hash['Branding']
-          my_api.append_api_responses(branding, json_hash['Branding'])
+          cb_client.append_api_responses(branding, json_hash['Branding'])
         end
 
-        my_api.append_api_responses(branding, json_hash)
+        cb_client.append_api_responses(branding, json_hash)
       end
     end
   end

data/lib/cb/clients/recommendation.rb

@@ -9,15 +9,14 @@
 # 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'
-
+require_relative 'base'
 module Cb
   module Clients
-    class Recommendation
+    class Recommendation < Base
       def self.for_job(*args)
-        my_api = Cb::Utils::Api.instance
         hash = normalize_args(args)
         hash = set_hash_defaults(hash)
-        json_hash = my_api.cb_get(Cb.configuration.uri_recommendation_for_job,
+        json_hash = cb_client.cb_get(Cb.configuration.uri_recommendation_for_job,
                                   query: hash)
 
         jobs = []
@@ -28,20 +27,19 @@ module Cb
 
             jobs = create_jobs json_hash, 'Job'
 
-            my_api.append_api_responses(jobs, json_hash['ResponseRecommendJob']['Request'])
+            cb_client.append_api_responses(jobs, json_hash['ResponseRecommendJob']['Request'])
           end
 
-          my_api.append_api_responses(jobs, json_hash['ResponseRecommendJob'])
+          cb_client.append_api_responses(jobs, json_hash['ResponseRecommendJob'])
         end
 
-        my_api.append_api_responses(jobs, json_hash)
+        cb_client.append_api_responses(jobs, json_hash)
       end
 
       def self.for_user(*args)
-        my_api = Cb::Utils::Api.instance
         hash = normalize_args(args)
         hash = set_hash_defaults(hash)
-        json_hash = my_api.cb_get(Cb.configuration.uri_recommendation_for_user,
+        json_hash = cb_client.cb_get(Cb.configuration.uri_recommendation_for_user,
                                   query: hash)
 
         jobs = []
@@ -53,18 +51,17 @@ module Cb
 
             jobs = create_jobs json_hash, 'User'
 
-            my_api.append_api_responses(jobs, json_hash['ResponseRecommendUser']['Request'])
+            cb_client.append_api_responses(jobs, json_hash['ResponseRecommendUser']['Request'])
           end
 
-          my_api.append_api_responses(jobs, json_hash['ResponseRecommendUser'])
+          cb_client.append_api_responses(jobs, json_hash['ResponseRecommendUser'])
         end
 
-        my_api.append_api_responses(jobs, json_hash)
+        cb_client.append_api_responses(jobs, json_hash)
       end
 
       def self.for_company(company_did)
-        my_api = Cb::Utils::Api.instance
-        json_hash = my_api.cb_get(Cb.configuration.uri_recommendation_for_company, query: { CompanyDID: company_did })
+        json_hash = cb_client.cb_get(Cb.configuration.uri_recommendation_for_company, query: { CompanyDID: company_did })
         jobs = []
         if json_hash
           api_jobs = json_hash.fetch('Results', {}).fetch('JobRecommendation', {}).fetch('Jobs', {})
@@ -74,9 +71,9 @@ module Cb
               jobs << Models::Job.new(cur_job)
             end
           end
-          my_api.append_api_responses(jobs, json_hash.fetch('Results', {}).fetch('JobRecommendation', {}))
-          my_api.append_api_responses(jobs, json_hash.fetch('Results', {}))
-          my_api.append_api_responses(jobs, json_hash)
+          cb_client.append_api_responses(jobs, json_hash.fetch('Results', {}).fetch('JobRecommendation', {}))
+          cb_client.append_api_responses(jobs, json_hash.fetch('Results', {}))
+          cb_client.append_api_responses(jobs, json_hash)
         end
       end
 

data/lib/cb/clients/saved_search.rb

@@ -8,22 +8,23 @@
 # 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_relative 'base'
 module Cb
   module Clients
-    class SavedSearch
-      def create(saved_search)
+    class SavedSearch < Base
+      def self.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)
+      def self.update(saved_search)
         body = saved_search.update_to_json
         json = cb_client.cb_put(Cb.configuration.uri_saved_search_update, body: body, headers: update_headers(saved_search.host_site))
         Responses::SavedSearch::Update.new(json)
       end
 
-      def delete(hash)
+      def self.delete(hash)
         uri = replace_uri_field(Cb.configuration.uri_saved_search_delete, ':did', hash[:did])
         json = cb_client.cb_delete(
           uri,
@@ -33,14 +34,14 @@ module Cb
         Responses::SavedSearch::Delete.new(json)
       end
 
-      def retrieve(oauth_token, external_id)
+      def self.retrieve(oauth_token, external_id)
         query = retrieve_query(oauth_token)
         uri = replace_uri_field(Cb.configuration.uri_saved_search_retrieve, ':did', external_id)
         json = cb_client.cb_get(uri, query: query)
         Responses::SavedSearch::Retrieve.new(json)
       end
 
-      def list(oauth_token, hostsite)
+      def self.list(oauth_token, hostsite)
         query = list_query(oauth_token, hostsite)
         json = cb_client.cb_get(Cb.configuration.uri_saved_search_list, query: query)
         Responses::SavedSearch::List.new(json)
@@ -48,7 +49,7 @@ module Cb
 
       private
 
-      def update_headers(host_site)
+      def self.update_headers(host_site)
         {
           'developerkey' => Cb.configuration.dev_key,
           'Content-Type' => 'application/json',
@@ -56,18 +57,14 @@ module Cb
         }
       end
 
-      def cb_client
-        @cb_client ||= Cb::Utils::Api.instance
-      end
-
-      def retrieve_query(oauth_token)
+      def self.retrieve_query(oauth_token)
         {
           developerkey: Cb.configuration.dev_key,
           useroauthtoken: oauth_token
         }
       end
 
-      def list_query(oauth_token, hostsite)
+      def self.list_query(oauth_token, hostsite)
         {
           developerkey: Cb.configuration.dev_key,
           useroauthtoken: oauth_token,
@@ -75,13 +72,13 @@ module Cb
         }
       end
 
-      def singular_model_response(json_hash, external_user_id = nil, external_id = nil)
+      def self.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
 
-      def replace_uri_field(uri_string, field, replacement)
+      def self.replace_uri_field(uri_string, field, replacement)
         uri_string.gsub(field, replacement)
       end
     end

data/lib/cb/clients/talent_network.rb

@@ -8,51 +8,47 @@
 # 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_relative 'base'
 module Cb
   module Clients
-    class TalentNetwork
+    class TalentNetwork < Base
       def self.join_form_questions(tndid)
-        my_api = Cb::Utils::Api.instance
-        json_hash = my_api.cb_get("#{Cb.configuration.uri_tn_join_questions}/#{tndid}/json")
+        json_hash = cb_client.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)
+        cb_client.append_api_responses(tn_questions_collection, json_hash)
       end
 
       def self.join_form_branding(tndid)
-        my_api = Cb::Utils::Api.instance
-        json_hash = my_api.cb_get("#{Cb.configuration.uri_tn_join_form_branding}/#{tndid}/json")
+        json_hash = cb_client.cb_get("#{Cb.configuration.uri_tn_join_form_branding}/#{tndid}/json")
 
         if json_hash.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)
+        cb_client.append_api_responses(tn_join_form_branding, json_hash)
       end
 
       def self.join_form_geography(tnlanguage = 'USEnglish')
-        my_api = Cb::Utils::Api.instance
-        json_hash = my_api.cb_get("#{Cb.configuration.uri_tn_join_form_geo}", query: { TNLanguage: "#{tnlanguage}" })
+        json_hash = cb_client.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)
+        cb_client.append_api_responses(geo_dropdown, json_hash)
       end
 
       def self.member_create(args = {})
-        my_api = Cb::Utils::Api.instance
         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)
+        json_hash = cb_client.cb_post("#{Cb.configuration.uri_tn_member_create}/json", body: tn_member.to_xml)
+        cb_client.append_api_responses(json_hash, json_hash)
       end
 
       def self.tn_job_information(job_did, join_form_intercept = 'true')
-        my_api = Cb::Utils::Api.instance
-        json_hash = my_api.cb_get("#{Cb.configuration.uri_tn_job_info}/#{job_did}/json",
+        json_hash = cb_client.cb_get("#{Cb.configuration.uri_tn_job_info}/#{job_did}/json",
                                   query: {RequestJoinFormIntercept: join_form_intercept } )
 
         if json_hash.key? 'Response'
           tn_job_info = Models::TalentNetwork::JobInfo.new(json_hash['Response'])
         end
 
-        my_api.append_api_responses(tn_job_info, json_hash)
+        cb_client.append_api_responses(tn_job_info, json_hash)
       end
     end
   end

data/lib/cb/clients/user.rb

@@ -12,45 +12,43 @@ require 'json'
 
 module Cb
   module Clients
-    class User
+    class User < Base
       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)
+          response = cb_client.cb_post(Cb.configuration.uri_user_check_existing, body: xml)
           Cb::Responses::User::CheckExisting.new(response)
         end
 
         def temporary_password(external_id)
           query = { 'ExternalID' => external_id }
-          response = api_client.cb_get(Cb.configuration.uri_user_temp_password, query: query)
+          response = cb_client.cb_get(Cb.configuration.uri_user_temp_password, query: query)
           Cb::Responses::User::TemporaryPassword.new(response)
         end
 
         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)
+          cb_client = Cb::Utils::Api.instance
+          json_hash = cb_client.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']
+            cb_client.append_api_responses user, json_hash['ResponseUserInfo']
           end
 
-          my_api.append_api_responses user, json_hash
+          cb_client.append_api_responses user, json_hash
         end
 
         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)
+          response = cb_client.cb_post(uri, body: user_info.to_xml)
 
           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)
+          response = cb_client.cb_post(uri, body: delete_criteria.to_xml)
 
           Cb::Responses::User::Delete.new(response) if response.key?('ResponseUserDelete')
         end
@@ -89,10 +87,6 @@ module Cb
             </Request>
           eos
         end
-
-        def api_client
-          Cb::Utils::Api.instance
-        end
       end
     end
   end

data/lib/cb/config.rb

@@ -63,6 +63,7 @@ module Cb
       @uri_application_form ||= '/cbapi/job/:did/applicationform'
       @uri_company_find ||= '/Employer/CompanyDetails'
       @uri_countries ||= '/consumer/datalist/countries'
+      @uri_cover_letters ||= '/consumer/coverletters'
       @uri_cover_letter_list ||= '/v1/coverletter/list'
       @uri_cover_letter_retrieve ||= '/coverletter/retrieve'
       @uri_cover_letter_update ||= '/coverletter/edit'

data/lib/cb/convenience.rb

@@ -27,6 +27,10 @@ module Cb
         Cb::Clients::Category
       end
 
+      def cover_letters
+        Cb::Clients::CoverLetters
+      end
+
       def industry
         Cb::Clients::Industry
       end

data/lib/cb/utils/api.rb

@@ -73,6 +73,10 @@ module Cb
       end
 
       def append_api_responses(obj, resp)
+        #As of ruby 2.2 nil is frozen so stop monkey patching it please -jyeary
+        if obj.nil? && obj.frozen?
+          obj = Cb::Utils::NilResponse.new
+        end
         meta_class = ensure_non_nil_metavalues(obj)
 
         resp.each do |api_key, api_value|
@@ -92,7 +96,6 @@ module Cb
             meta_class.instance_variable_set(:"@#{meta_name}", api_value)
           end
         end
-
         obj.class.send(:attr_reader, 'api_error')
         obj.instance_variable_set(:@api_error, @api_error)
 

data/lib/cb/utils/nil_response.rb

@@ -0,0 +1,23 @@
+# 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 'httparty'
+require 'observer'
+
+module Cb
+  module Utils
+    class NilResponse
+      def initialize ;end
+      def nil?
+        true
+      end
+    end
+  end
+end

data/lib/cb/version.rb

@@ -9,5 +9,5 @@
 # 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
-  VERSION = '19.1.1'
+  VERSION = '20.0.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cb-api
 version: !ruby/object:Gem::Version
-  version: 19.1.1
+  version: 20.0.0
 platform: ruby
 authors:
 - The CareerBuilder.com Niche and Consumer Development teams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-24 00:00:00.000000000 Z
+date: 2016-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -213,8 +213,10 @@ files:
 - lib/cb/clients/anon_saved_search.rb
 - lib/cb/clients/application.rb
 - lib/cb/clients/application_external.rb
+- lib/cb/clients/base.rb
 - lib/cb/clients/category.rb
 - lib/cb/clients/company.rb
+- lib/cb/clients/cover_letters.rb
 - lib/cb/clients/education.rb
 - lib/cb/clients/employee_types.rb
 - lib/cb/clients/industry.rb
@@ -373,6 +375,7 @@ files:
 - lib/cb/utils/country.rb
 - lib/cb/utils/fluid_attributes.rb
 - lib/cb/utils/meta_values.rb
+- lib/cb/utils/nil_response.rb
 - lib/cb/utils/response_array_extractor.rb
 - lib/cb/utils/response_map.rb
 - lib/cb/utils/validator.rb