cb-api 0.2.8 → 0.2.9

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MzhjMjgzM2JhMzI1YmE0YTE3ZWExZGViNzg1NDI2MDVlN2FmZGE3Zg==
+    ZTE0YTQ1OTdhMWEzODVkMzRiNGVkY2M2ZTE4N2QyY2VhNWM4ZTY5Mw==
   data.tar.gz: !binary |-
-    NjFkMzc0MWNkZmQ5NDRhZjhiYTQ0YjUwYjk1MDc5ZmQxNmQzNWY2ZA==
+    MTJhM2FiODZmY2EwZjE3MmFhMzljYjkxMjBlNjA3MzNhYzE4MDUyYg==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    MGNhZTNkMzBmYzcyZmI4NDVkMzk1NDczYTlkYmJjM2JmODhkMzU3NWMxYmU2
-    MDAyYjE0YjlmNWIyYzI1NjYzZmE2ZmRiZTEwYzM0N2RhMTcwYjU0NjlhNmFi
-    NzM4NDczYTBlZWE1ZTFkYTIyODVlNDg2ODI2YTczOTkxNWM1ZTc=
+    MzRkNDQ4MmZiMGRhNGRkZDY4OWY5ZmUzNzgyZDI0MDczMWMzYzU0Zjg4MmM5
+    YjYxNDA4MWQ2MWVjNjFmMGI3ZGIyMTRhNGU0NjFiZjlkYjE4ZTkwMjJhYTgy
+    Mzg5M2EwODA0ZTg5YjA3MWViOTIxZjcxYmRlYWVlMDJjYTA2YzA=
   data.tar.gz: !binary |-
-    MmUwOTdjMDhlMGE4YzM5ZTE1ZTdhYTllMmZkYTBlMzE5OGM1NGQwM2NhNDk3
-    NWRmMTFhMjVhMGIxNmI2Yjc2MjliNmM2M2I0M2E1NTk0ZWQ2ODRjYTZiZGNi
-    NDRlMWNhMDE3M2I1YWQxZTY0NDdkZDZmZjlmNWQyMDRhNmQzZTg=
+    N2JiNjhiZDI4YzZhN2M2ZDUxOWM1ODZlNThiZTQ1NjNiZDdmMWMxOGRjOGE1
+    ODIwOGYwNTNmN2I0Yzk1ZTE4MzE4ZjMyNTExYjZiNzdkOTUzZjg5MDBiMWEz
+    MGU5YjYwYWVkNjQ5YjhhMmY0NDg0NjcxYTk3NTI5YmEwN2ViMmI=

data/lib/cb.rb

@@ -86,4 +86,8 @@ module Cb
   def self.saved_search_api
     Cb::SavedSearchApi
   end
+
+  def self.talent_network_api
+    Cb::TalentNetworkApi
+  end
 end

data/lib/cb/clients/recommendation_api.rb

@@ -8,10 +8,11 @@ module Cb
     ## For detailed information around this API please visit:
     ## http://api.careerbuilder.com/Recommendations.aspx
     #############################################################
-    def self.for_job(did, site_id = '', co_brand = '')
+    def self.for_job(did, countlimit = '25', site_id = '', co_brand = '')
       my_api = Cb::Utils::Api.new()
       cb_response = my_api.cb_get(Cb.configuration.uri_recommendation_for_job,
-                                  :query => {:JobDID => did, :SiteID => site_id, :CoBrand => co_brand})
+                                  :query => {:JobDID => did, :CountLimit => countlimit, :SiteID => site_id,
+                                             :CoBrand => co_brand, :HostSite => Cb.configuration.host_site})
       json_hash = JSON.parse(cb_response.response.body)
 
       jobs = []
@@ -32,10 +33,10 @@ module Cb
     ## For detailed information around this API please visit:
     ## http://api.careerbuilder.com/Recommendations.aspx
     #############################################################
-    def self.for_user(external_id, site_id = '', co_brand = '')
+    def self.for_user(external_id, countlimit = '25', site_id = '', co_brand = '')
       my_api = Cb::Utils::Api.new()
       cb_response = my_api.cb_get(Cb.configuration.uri_recommendation_for_user,
-                                  :query => {:ExternalID => external_id, :SiteID => site_id, :CoBrand => co_brand,
+                                  :query => {:ExternalID => external_id, :CountLimit => countlimit, :SiteID => site_id, :CoBrand => co_brand,
                                              :HostSite => Cb.configuration.host_site})
       json_hash = JSON.parse(cb_response.response.body)
 

data/lib/cb/clients/saved_search_api.rb

@@ -14,8 +14,13 @@ module Cb
       my_api = Cb::Utils::Api.new
       cb_response = my_api.cb_post Cb.configuration.uri_saved_search_create, :body => CbSavedSearch.new(args).create_to_xml
       json_hash = JSON.parse cb_response.response.body
-      saved_search = CbSavedSearch.new json_hash['SavedJobSearch']['SavedSearch']
-      my_api.append_api_responses saved_search, json_hash['SavedJobSearch']['SavedSearch']
+      unless json_hash['SavedJobSearch']['SavedSearch'].nil?
+        saved_search = CbSavedSearch.new json_hash['SavedJobSearch']['SavedSearch']
+      else
+        saved_search = CbSavedSearch.new json_hash['SavedJobSearch']
+      end
+
+      my_api.append_api_responses saved_search, json_hash['SavedJobSearch']
 
       return saved_search
     end
@@ -31,8 +36,8 @@ module Cb
       my_api = Cb::Utils::Api.new
       cb_response = my_api.cb_post Cb.configuration.uri_saved_search_update, :body => CbSavedSearch.new(args).update_to_xml
       json_hash = JSON.parse cb_response.response.body
-      saved_search = CbSavedSearch.new json_hash['SavedJobSearch']['SavedSearch']
-      my_api.append_api_responses saved_search, json_hash['SavedJobSearch']['SavedSearch']
+      saved_search = CbSavedSearch.new json_hash['SavedJobSearch']
+      my_api.append_api_responses saved_search, json_hash['SavedJobSearch']
 
       return saved_search
     end

data/lib/cb/clients/talent_network_api.rb

@@ -1,28 +1,75 @@
 module Cb
-	class TalentNetwork
+	class TalentNetworkApi
 		####################################################
 		## Documentation:
 		## http://api.careerbuilder.com/TalentNetwork.aspx
 		####################################################
 
-		def self.join_form_questions(tndid, responsetype)
+		def self.join_form_questions(tndid)
 			## Load the join form questions for a TalentNetworkDID
-			responsetype = 'xml' if responsetype.blank?
 			my_api = Cb::Utils::Api.new()
-			cb_response = my_api.cb_get("#{Cb.configuration.uri_tn_join_questions}/#{tndid}/#{responsetype}")
+			cb_response = my_api.cb_get_secure("#{Cb.configuration.uri_tn_join_questions}/#{tndid}/json")
+			json_hash = JSON.parse(cb_response.response.body)
+
+			tn_questions_collection = TalentNetwork.new(json_hash)
+			my_api.append_api_responses(tn_questions_collection, json_hash)
+
+			return tn_questions_collection
 		end
 
-		def self.join_form_branding
+		def self.join_form_branding(tndid)
 			## Gets branding information (stylesheets, copytext, etc...) for the join form.
+			my_api = Cb::Utils::Api.new
+
+			cb_response = my_api.cb_get_secure("#{Cb.configuration.uri_tn_join_form_branding}/#{tndid}/json")
+			json_hash = JSON.parse(cb_response.response.body)
+
+			tn_join_form_branding = TalentNetwork::JoinFormBranding.new(json_hash['Branding'])
+			my_api.append_api_responses(tn_join_form_branding, json_hash)
+
+			return tn_join_form_branding
+
 		end
 
-		def self.join_form_geography
+		def self.join_form_geography(tnlanguage="USEnglish")
 			## Gets locations needed to fill the Geography question from the Join Form Question API
+			my_api = Cb::Utils::Api.new
+			cb_response = my_api.cb_get_secure("#{Cb.configuration.uri_tn_join_form_geo}", :query=>{:TNLanguage=>"#{tnlanguage}"})
+			json_hash = JSON.parse(cb_response.response.body)
+
+			geo_dropdown = TalentNetwork::JoinFormGeo.new(json_hash)
+			my_api.append_api_responses(geo_dropdown, json_hash)
+
+			return geo_dropdown
 		end
 
-		def self.member_create
+		def self.member_create(args={})
 			## Creates a member based on the form built with the Join Form Questions API call
+			my_api = Cb::Utils::Api.new
+			tn_member = TalentNetwork::Member.new(args)
+			cb_response = my_api.cb_post("#{Cb.configuration.uri_tn_member_create}/json", :body => tn_member.to_xml )
+			json_hash = JSON.parse(cb_response.response.body)
+
+			my_api.append_api_responses(tn_member, json_hash)
+
+			if cb_response.success? && cb_response['Errors'].size == 0
+				return cb_response["MemberDID"]
+			end
+				
+			return cb_response['Errors'].first
 		end
 
+		def self.tn_job_information(job_did, join_form_intercept="true")
+			my_api = Cb::Utils::Api.new
+			cb_response = my_api.cb_get_secure("#{Cb.configuration.uri_tn_job_info}/#{job_did}/json", :query=> {
+				 :RequestJoinFormIntercept=>join_form_intercept})
+			json_hash = JSON.parse(cb_response.response.body)
+		
+			tn_job_info = TalentNetwork::JobInfo.new(json_hash['Response'])
+			my_api.append_api_responses(tn_job_info, json_hash)
+			
+			return tn_job_info
+		
+		end
 	end #TalentNetworkJoinQuestions
 end #module

data/lib/cb/config.rb

@@ -1,6 +1,6 @@
 module Cb
   class Config
-    attr_accessor :dev_key, :debug_api, :time_out, :use_json, :host_site,
+    attr_accessor :dev_key, :base_uri, :base_uri_secure, :debug_api, :time_out, :use_json, :host_site,
                   :uri_job_search, :uri_job_find,
                   :uri_company_find, :uri_job_category_search,
                   :uri_education_code, :uri_employee_types,
@@ -15,7 +15,8 @@ module Cb
                   :uri_resume_create, :uri_resume_update, :uri_resume_delete,
                   :uri_saved_search_retrieve, :uri_saved_search_create, :uri_saved_search_update, :uri_saved_search_list, :uri_saved_search_delete,
                   :uri_saved_job_search_create,
-                  :uri_job_branding, :uri_tn_join_questions,
+                  :uri_job_branding, :uri_tn_join_questions, :uri_tn_job_info, :uri_tn_join_form_geo,
+                  :uri_tn_join_form_branding, :uri_tn_member_create,
                   :uri_subscription_retrieve, :uri_subscription_modify
 
     def initialize
@@ -52,6 +53,10 @@ module Cb
       @uri_saved_search_delete            ||= '/v1/savedsearch/delete'
       @uri_saved_search_list              ||= '/v1/savedsearch/list'
       @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          ||= '/v1/user/subscription/retrieve'
       @uri_subscription_modify            ||= '/v1/user/subscription'
       @uri_saved_job_search_create        ||= '/v2/savedsearch/create'
@@ -102,6 +107,8 @@ module Cb
     def set_defaults
 
       @dev_key              = 'ruby-cb-api'  # Get a developer key at http://api.careerbuilder.com
+      @base_uri             = 'http://api.careerbuilder.com'
+      @base_uri_secure      = 'https://api.careerbuilder.com'
       @debug_api            = false
       @time_out             = 5
       @use_json             = true

data/lib/cb/models/cb_job.rb

@@ -9,7 +9,8 @@ module Cb
                   :description, :requirements, :employment_type,
                   :details_url, :service_url, :similar_jobs_url, :apply_url,
                   :begin_date, :end_date, :posted_date,
-                  :relevancy, :state, :city, :zip
+                  :relevancy, :state, :city, :zip,
+                  :can_be_quick_applied
 
     attr_writer   :external_application, :relocation_covered, :manages_others, :is_screener_apply,
                   :is_shared_job
@@ -81,6 +82,7 @@ module Cb
       @external_application         = args['ExternalApplication'] || ''
       @is_screener_apply            = args['IsScreenerApply'] || ''
       @is_shared_job                = args['IsSharedJob'] || ''
+      @can_be_quick_applied         = args['CanBeQuickApplied'] || ''
 
       # Company related
       @company_name                 = args['Company'] || ''
@@ -126,5 +128,25 @@ module Cb
     def shared_job?
       @is_shared_job.downcase == 'true' ? true : false
     end
+
+    def can_be_quick_applied?
+      @can_be_quick_applied.downcase == 'true' ? true : false
+    end
+
+    def city
+      if @city.empty?
+        return @location['City']
+      else
+        return @city
+      end
+    end
+
+    def state
+      if @state.empty?
+        return @location['State']
+      else
+        return @state
+      end
+    end
   end
 end

data/lib/cb/models/cb_saved_search.rb

@@ -5,7 +5,7 @@ module Cb
                   :emp_type, :exclude_company_names, :exclude_job_titles, :exclude_national, :industry_codes,
                   :keywords, :order_by, :order_direction, :radius, :pay_high, :pay_low, :posted_within, 
                   :pay_info_only, :location, :job_category, :company, :city, :state, :is_daily_email, :external_id,
-                  :external_user_id, :dev_key, :job_search_url, :jrdid
+                  :external_user_id, :dev_key, :job_search_url, :jrdid, :errors
 
     def initialize(args={})
       @hostsite                   = args['HostSite'] || ''
@@ -40,6 +40,7 @@ module Cb
       @dev_key                    = args['DeveloperKey'] || ''
       @job_search_url             = args['JobSearchUrl'] || ''
       @jrdid                      = args['JRDID'] || ''
+      @errors                     = args['Errors'] || nil
     end
 
     def create_to_xml

data/lib/cb/models/cb_talent_network.rb

@@ -0,0 +1,158 @@
+module Cb
+  class TalentNetwork
+    attr_accessor :join_form_questions
+    def initialize(args={})
+      @join_form_questions = Array.new
+      if args.has_key?('JoinQuestions')
+        args['JoinQuestions'].each do |question|
+          @join_form_questions << TalentNetwork::Questions.new(question)
+        end
+      end
+    end
+  end
+
+  class TalentNetwork::Member
+    attr_accessor :dev_key, :tn_did, :preferred_language, :accept_privacy, :accept_terms, :resume_word_doc,
+                  :join_values
+
+    def initialize(args={})
+      @dev_key                = args['DeveloperKey'] || Cb.configuration.dev_key
+      @tn_did                 = args['TNDID'] || ''
+      @preferred_language     = args['PreferredLanguage'] || 'USEnglish'
+      @accept_privacy         = args['AcceptPrivacy'] || true
+      @accept_terms           = args['AcceptTerms'] || true
+      @resume_word_doc        = args['ResumeWordDoc'] || ''
+      @join_values            = Hash.new
+      if args.has_key?('JoinValues') 
+        @join_values = Hash[args['JoinValues'].each_slice(2).to_a]
+      end
+    end
+
+    def to_xml
+      ret =  "<Request>"
+      ret += "<DeveloperKey>#{@dev_key}</DeveloperKey>"
+      ret += "<TalentNetworkDID>#{@tn_did}</TalentNetworkDID>"
+      ret += "<PreferredLanguage>#{@preferred_language}</PreferredLanguage>"
+      ret += "<AcceptPrivacy>#{@accept_privacy}</AcceptPrivacy>"
+      ret += "<AcceptTerms>#{@accept_terms}</AcceptTerms>"
+      ret += "<ResumeWordDoc>#{@resume_word_doc}</ResumeWordDoc>"
+      ret += "<JoinValues>"
+      @join_values.each { | k,v | 
+        ret += "<JoinValue>"
+        ret += "<Key>#{k}</Key>"
+        ret += "<Value>#{v}</Value>"
+        ret += "</JoinValue>"
+      }
+      ret += "</JoinValues>"
+      ret += "</Request>"
+    end
+  end
+
+
+  class TalentNetwork::Questions
+    attr_accessor :text, :form_value, :option_display_type, :order, :required, :options
+                  
+    def initialize(args={})
+      @text                 = args['Text'] || ''
+      @form_value           = args['FormValue'] || ''
+      @option_display_type  = args['OptionDisplayType'] || ''
+      @order                = args['Order'] || ''
+      @required             = args['Required'].to_s || ''
+      @options              = Array.new
+      if args.has_key?('Options')
+        args['Options'].each do |option_values|
+          @options << TalentNetwork::Options.new(option_values)
+        end
+      end
+    end
+  end
+
+  class TalentNetwork::Options
+    attr_accessor :value, :order, :display_text
+
+    def initialize(args={})
+      @value          = args['Value'] || ''
+      @order          = args['Order'] || ''
+      @display_text   = args['DisplayText'] || ''
+    end
+  end
+
+  class TalentNetwork::JobInfo
+    attr_accessor :join_form_url, :tn_did, :join_form_intercept_enabled
+
+    def initialize(args={})
+      @join_form_url                    = args['JoinFormUrl'] || ''
+      @tn_did                           = args['sTNDID'] || ''
+      @join_form_intercept_enabled      = args['JoinFormInterceptEnabled'].to_s || ''
+    end
+  end
+
+  class TalentNetwork::JoinFormGeo
+    attr_accessor :countries, :states
+
+    def initialize(args={})
+      @countries = Hash.new
+      @states = Hash.new
+
+      if args.has_key?('Countries')
+        @countries = TalentNetwork::JoinFormGeoLocation.new(args['Countries'])
+      end
+
+      if args.has_key?('States')
+        @states = TalentNetwork::JoinFormGeoLocation.new(args['States'])
+      end
+
+    end
+  end
+
+  class TalentNetwork::JoinFormGeoLocation
+    attr_accessor :geo_hash
+
+    def initialize(args={})
+      value = Array.new
+      display_val = Array.new
+      @geo_hash = Hash.new
+
+      if args.has_key?('Value')
+        args['Value'].each do |val|
+          value << val
+        end
+      end
+
+      if args.has_key?('Display')
+        args['Display'].each do |display|
+          display_val << display
+        end
+      end
+
+      unless value.nil? || display_val.nil?
+        @geo_hash = convert_to_hash(display_val,value)
+      end
+    end
+
+    private
+    def convert_to_hash(keys, values)
+      geo_hash = Hash.new
+      geo_hash = Hash[keys.zip(values)]
+
+      return geo_hash
+    end
+  end
+
+  class TalentNetwork::JoinFormBranding
+    attr_accessor :stylesheet_url, :join_logo_image_url, :join_custom_msg_html, :button_color, 
+                  :mobile_logo_image_url, :nav_color, :site_path
+
+    def initialize(args={})
+      @stylesheet_url                   = args['StylesheetURL'] || ''
+      @join_logo_image_url              = args['JoinLogoImageURL'] || ''
+      @join_custom_msg_html             = args['JoinCustomMsgHTML'] || ''
+      @button_color                     = args['ButtonColor'] || ''
+      @mobile_logo_image_url            = args['MobileLogoImageURL'] || ''
+      @nav_color                        = args['NavColor'] || ''
+      @site_path                        = args['SitePath'] || ''
+    end
+  end
+
+
+end

data/lib/cb/utils/api.rb

@@ -15,12 +15,17 @@ module Cb
       end
 
       def cb_get(*args, &block)
-        self.class.base_uri 'http://api.careerbuilder.com'
+        self.class.base_uri Cb.configuration.base_uri
+        self.class.get(*args, &block)
+      end
+
+      def cb_get_secure(*args, &block)
+        self.class.base_uri Cb.configuration.base_uri_secure
         self.class.get(*args, &block)
       end
 
       def cb_post(*args, &block)
-        self.class.base_uri 'https://api.careerbuilder.com'
+        self.class.base_uri Cb.configuration.base_uri_secure
         self.class.post(*args, &block)
       end
 
@@ -77,6 +82,7 @@ module Cb
       def get_meta_name_for(api_key)
         key_map = {
                     'Errors' =>                     'errors',
+                    'ApiError' =>                   'api_error',
                     'TimeResponseSent' =>           'time_sent',
                     'TimeElapsed' =>                'time_elapsed',
                     'TotalPages' =>                 'total_pages',

data/lib/cb/utils/validator.rb

@@ -0,0 +1,28 @@
+require 'json'
+
+module Cb
+  module ResponseValidator
+
+    def self.validate(response)
+      if response.blank? || response.response.body.blank?
+        return false
+      end
+
+      if response.code != 200
+        return false
+      end
+
+      begin
+        json = JSON.parse(response.response.body)
+        if json.keys.any? && json[json.keys[0]].empty?
+          return false
+        end
+      rescue JSON::ParserError
+        return false
+      end
+
+      return true
+
+    end
+  end
+end

data/lib/cb/version.rb

@@ -1,3 +1,3 @@
 module Cb
-  VERSION = '0.2.8'
+  VERSION = '0.2.9'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cb-api
 version: !ruby/object:Gem::Version
-  version: 0.2.8
+  version: 0.2.9
 platform: ruby
 authors:
 - Jesse Retchko
@@ -12,10 +12,13 @@ authors:
 - Kyle Bumpus
 - Jon Molinaro
 - Ben Schmaltz
+- Raul Gil
+- Christina Chatham
+- Alex Hristov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-13 00:00:00.000000000 Z
+date: 2013-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -69,6 +72,9 @@ email:
 - David.Posey@Careerbuilder.com
 - Kyle.Bumpus@Careerbuilder.com
 - Ben.Schmaltz@Careerbuilder.com
+- Raul.Gil@Careerbuilder.com
+- Christina.Chatham@Careerbuilder.com
+- Alex.Hristov@Careerbuilder.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -115,12 +121,14 @@ files:
 - lib/cb/models/cb_job_branding.rb
 - lib/cb/models/cb_resume.rb
 - lib/cb/models/cb_saved_search.rb
+- lib/cb/models/cb_talent_network.rb
 - lib/cb/models/cb_user.rb
 - lib/cb/utils/api.rb
 - lib/cb/utils/country.rb
 - lib/cb/utils/fluid_attributes.rb
 - lib/cb/utils/meta_values.rb
 - lib/cb/utils/string.rb
+- lib/cb/utils/validator.rb
 - lib/cb/version.rb
 - lib/cb.rb
 - README.md