cb-api 5.5.0 → 5.5.1

data/lib/cb/clients/application.rb

@@ -45,7 +45,7 @@ module Cb
         end
 
         def api_client
-          Cb::Utils::Api.new
+          Cb::Utils::Api.instance
         end
       end
     end

data/lib/cb/clients/application_external.rb

@@ -7,7 +7,7 @@ module Cb
       def self.submit_app(app)
         raise Cb::IncomingParamIsWrongTypeException unless app.is_a?(Cb::Models::ApplicationExternal)
 
-        my_api = Cb::Utils::Api.new
+        my_api = Cb::Utils::Api.instance
         xml_hash = my_api.cb_post(Cb.configuration.uri_application_external, :body => app.to_xml)
 
         if xml_hash.has_key? 'ApplyUrl'

data/lib/cb/clients/category.rb

@@ -5,7 +5,7 @@ module Cb
     class Category
 
       def self.search
-        my_api = Cb::Utils::Api.new
+        my_api = Cb::Utils::Api.instance
         json_hash = my_api.cb_get(Cb.configuration.uri_job_category_search)
         categoryList = []
 
@@ -23,7 +23,7 @@ module Cb
       end
 
       def self.search_by_host_site(host_site)
-        my_api = Cb::Utils::Api.new
+        my_api = Cb::Utils::Api.instance
         json_hash = my_api.cb_get(Cb.configuration.uri_job_category_search, :query => {:CountryCode => host_site})
         categoryList = []
 

data/lib/cb/clients/company.rb

@@ -5,7 +5,7 @@ module Cb
     class Company
 
       def self.find_by_did(did)
-        my_api = Cb::Utils::Api.new
+        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})
 
         if json_hash.has_key?('Results')

data/lib/cb/clients/education.rb

@@ -6,7 +6,7 @@ module Cb
 
       def self.get_for(country)
         Cb::Utils::Country.is_valid? country ? country : 'US'
-        my_api = Cb::Utils::Api.new
+        my_api = Cb::Utils::Api.instance
         json_hash = my_api.cb_get(Cb.configuration.uri_education_code, :query => {:countrycode => country})
 
         codes = []

data/lib/cb/clients/email_subscription.rb

@@ -5,7 +5,7 @@ module Cb
     class EmailSubscription
 
       def self.retrieve_by_did(did, host_site = '')
-        my_api = Cb::Utils::Api.new
+        my_api = Cb::Utils::Api.instance
         json_hash = my_api.cb_get(Cb.configuration.uri_subscription_retrieve, :query => {:ExternalID => did, :Hostsite => host_site})
 
         if json_hash.has_key?('SubscriptionValues') && !json_hash['SubscriptionValues'].nil?
@@ -26,7 +26,7 @@ module Cb
         job_recs = job_recs.nil? ? 'false' : job_recs
         unsubscribe_all = unsubscribe_all.nil? ? 'false' : unsubscribe_all
 
-        my_api = Cb::Utils::Api.new
+        my_api = Cb::Utils::Api.instance
 
         xml_body = "<Request>"
         xml_body += "<DeveloperKey>" + Cb.configuration.dev_key.to_s + "</DeveloperKey>"

data/lib/cb/clients/job.rb

@@ -26,7 +26,7 @@ module Cb
         private
 
         def api_client
-          @api ||= Cb::Utils::Api.new
+          @api ||= Cb::Utils::Api.instance
         end
 
       end

data/lib/cb/clients/job_branding.rb

@@ -3,7 +3,7 @@ module Cb
     class JobBranding
 
       def self.find_by_id id
-        my_api = Cb::Utils::Api.new
+        my_api = Cb::Utils::Api.instance
         json_hash = my_api.cb_get Cb.configuration.uri_job_branding, :query => { :id => id }
 
         if json_hash.has_key? 'Branding'

data/lib/cb/clients/recommendation.rb

@@ -5,7 +5,7 @@ module Cb
     class Recommendation
 
       def self.for_job(*args)
-        my_api = Cb::Utils::Api.new
+        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,
@@ -30,7 +30,7 @@ module Cb
       end
 
       def self.for_user(*args)
-        my_api = Cb::Utils::Api.new
+        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,
@@ -55,7 +55,7 @@ module Cb
       end
 
       def self.for_company(company_did)
-        my_api = Cb::Utils::Api.new
+        my_api = Cb::Utils::Api.instance
         json_hash = my_api.cb_get(Cb.configuration.uri_recommendation_for_company, :query => {:CompanyDID => company_did})
 
         jobs = []

data/lib/cb/clients/spot.rb

@@ -18,7 +18,7 @@ module Cb
         end
 
         def api_client
-          @api ||= Cb::Utils::Api.new
+          @api ||= Cb::Utils::Api.instance
         end
 
       end

data/lib/cb/clients/talent_network.rb

@@ -3,14 +3,14 @@ module Cb
     class TalentNetwork
 
       def self.join_form_questions(tndid)
-        my_api = Cb::Utils::Api.new
+        my_api = Cb::Utils::Api.instance
         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
+        my_api = Cb::Utils::Api.instance
         json_hash = my_api.cb_get("#{Cb.configuration.uri_tn_join_form_branding}/#{tndid}/json")
 
         if json_hash.has_key? 'Branding'
@@ -21,21 +21,21 @@ module Cb
       end
 
       def self.join_form_geography(tnlanguage="USEnglish")
-        my_api = Cb::Utils::Api.new
+        my_api = Cb::Utils::Api.instance
         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
+        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)
       end
 
       def self.tn_job_information(job_did, join_form_intercept="true")
-        my_api = Cb::Utils::Api.new
+        my_api = Cb::Utils::Api.instance
         json_hash = my_api.cb_get("#{Cb.configuration.uri_tn_job_info}/#{job_did}/json", :query=> {
            :RequestJoinFormIntercept => join_form_intercept})
 

data/lib/cb/clients/user.rb

@@ -18,7 +18,7 @@ module Cb
         end
 
         def retrieve(external_id, test_mode = false)
-          my_api = Cb::Utils::Api.new
+          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'
@@ -32,7 +32,7 @@ module Cb
 
         def change_password(external_id, old_password, new_password, test_mode = false)
           result = false
-          my_api = Cb::Utils::Api.new
+          my_api = Cb::Utils::Api.instance
           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'
@@ -47,7 +47,7 @@ module Cb
 
         def delete(external_id, password, test_mode = false)
           result = false
-          my_api = Cb::Utils::Api.new
+          my_api = Cb::Utils::Api.instance
           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'
@@ -107,7 +107,7 @@ module Cb
         end
 
         def api_client
-          Cb::Utils::Api.new
+          Cb::Utils::Api.instance
         end
 
       end

data/lib/cb/config.rb

@@ -1,6 +1,6 @@
 module Cb
   class Config
-    attr_accessor :dev_key, :base_uri, :debug_api, :time_out, :use_json, :host_site, :test_resources,
+    attr_accessor :dev_key, :base_uri, :debug_api, :time_out, :use_json, :host_site, :test_resources, :observers,
                   :uri_job_search, :uri_job_find,
                   :uri_company_find, :uri_job_category_search,
                   :uri_education_code, :uri_employee_types,
@@ -127,7 +127,7 @@ module Cb
       @use_json             = true
       @host_site            = Cb.country.US
       @test_resources       = false
-
+      @observers            = Array.new
       set_default_api_uris
     end
   end

data/lib/cb/models/api_call_model.rb

@@ -0,0 +1,7 @@
+module Cb
+  module Models
+    class ApiCall < Struct.new(:api_call_type, :path, :options, :response)
+    end
+  end
+end
+

data/lib/cb/utils/api.rb

@@ -1,14 +1,25 @@
 require 'httparty'
+require 'observer'
 
 module Cb
   module Utils
     class Api
-      include HTTParty
+      include HTTParty, Observable
 
       base_uri 'https://api.careerbuilder.com'
 
+      def self.instance
+        api = Cb::Utils::Api.new
+        Cb.configuration.observers.each do |class_name|
+          api.add_observer(class_name.new)
+        end
+        if Cb.configuration.debug_api && !Cb.configuration.observers.include?(Cb::Utils::ConsoleObserver)
+          api.add_observer(Cb::Utils::ConsoleObserver.new)
+        end
+        api
+      end
+
       def initialize
-        self.class.debug_output $stderr if Cb.configuration.debug_api
         self.class.default_params :developerkey => Cb.configuration.dev_key,
                                   :outputjson => Cb.configuration.use_json.to_s
 
@@ -18,7 +29,9 @@ module Cb
 
       def cb_get(path, options={})
         self.class.base_uri Cb.configuration.base_uri
+        cb_event(:cb_get_before, path, options, nil)
         response = self.class.get(path, options)
+        cb_event(:cb_get_after, path, options, response)
         validated_response = ResponseValidator.validate(response)
         set_api_error(validated_response)
         validated_response
@@ -26,7 +39,9 @@ module Cb
 
       def cb_post(path, options={})
         self.class.base_uri Cb.configuration.base_uri
+        cb_event(:cb_post_before, path, options, nil)
         response = self.class.post(path, options)
+        cb_event(:cb_post_after, path, options, response)
         validated_response = ResponseValidator.validate(response)
         set_api_error(validated_response)
         validated_response
@@ -34,7 +49,9 @@ module Cb
 
       def cb_put(path, options={})
         self.class.base_uri Cb.configuration.base_uri
+        cb_event(:cb_put_before, path, options, nil)
         response = self.class.put(path, options)
+        cb_event(:cb_put_after, path, options, response)
         validated_response = ResponseValidator.validate(response)
         set_api_error(validated_response)
         validated_response
@@ -88,6 +105,15 @@ module Cb
 
       private
 
+      def api_call_model(api_call_type, path, options, response)
+        Cb::Models::ApiCall.new(api_call_type, path, options, response)
+      end
+
+      def cb_event(api_call_type, path, options, response)
+        changed(true)
+        notify_observers(api_call_model(api_call_type, path, options, response))
+      end
+
       def ensure_non_nil_metavalues(obj)
         if obj.respond_to?('cb_response') && !obj.cb_response.nil?
           obj.cb_response

data/lib/cb/utils/console_observer.rb

@@ -0,0 +1,10 @@
+module Cb
+  module Utils
+    class ConsoleObserver
+      def update(api_call)
+        puts "#{api_call.api_call_type.to_s} #{api_call.path}/#{api_call.options.to_s} response: #{api_call.response.to_json}"
+      end
+    end
+  end
+end
+

data/lib/cb/version.rb

@@ -1,3 +1,3 @@
 module Cb
-  VERSION = '5.5.0'
+  VERSION = '5.5.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cb-api
 version: !ruby/object:Gem::Version
-  version: 5.5.0
+  version: 5.5.1
   prerelease: 
 platform: ruby
 authors:
@@ -120,7 +120,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '2.11'
+        version: '2.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -128,7 +128,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '2.11'
+        version: '2.14'
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
@@ -258,6 +258,7 @@ files:
 - lib/cb/models/implementations/talent_network.rb
 - lib/cb/models/implementations/spot.rb
 - lib/cb/models/implementations/email_subscription.rb
+- lib/cb/models/api_call_model.rb
 - lib/cb/convenience.rb
 - lib/cb/clients/job_branding.rb
 - lib/cb/clients/recommendation.rb
@@ -278,6 +279,7 @@ files:
 - lib/cb/utils/country.rb
 - lib/cb/utils/validator.rb
 - lib/cb/utils/meta_values.rb
+- lib/cb/utils/console_observer.rb
 - lib/cb/utils/api.rb
 - lib/cb/utils/fluid_attributes.rb
 - README.md