cb-api 0.0.3

data/README.md

@@ -0,0 +1,12 @@
+cb-api
+================
+
+A gem that's going to house our internal API interactions.
+
+
+TODO
+==================
+1. Error handling
+2. Figure out base CbApi internactions with child classes
+	2.1 CbApi should handle errors, and setting standard fields (response time, errors, etc)
+	2.2 CbApi should extract the base fields from the json packet (meaning sub classes don't have to parse them)

data/lib/cb.rb

@@ -0,0 +1,52 @@
+require 'cb/config'
+Dir[File.dirname(__FILE__) + '/cb/utils/*.rb'].each {| file| require file }
+Dir[File.dirname(__FILE__) + '/cb/clients/*.rb'].each {| file| require file }
+Dir[File.dirname(__FILE__) + '/cb/models/*.rb'].each {| file| require file }
+require 'cb/job_search_criteria'
+
+module Cb
+	def self.configure
+		yield configuration
+	end
+
+  def self.configuration
+    @configuration ||= Cb::Config.new
+    @configuration.set_default_api_uris
+
+    return @configuration
+  end
+
+  # Convenience methods, in case you're lazy... like me :)
+  ###############################################################
+  def self.job
+    Cb::JobApi
+  end
+
+  def self.job_search_criteria
+    Cb::JobSearchCriteria.new()
+  end
+
+  def self.category
+    Cb::CategoryApi
+  end
+
+  def self.company
+    Cb::CompanyApi
+  end
+
+  def self.education_code
+    Cb::EducationApi
+  end
+
+  def self.recommendation
+    Cb::RecommendationApi
+  end
+  
+  def self.job_application
+    Cb::JobApplicationApi
+  end
+
+  def self.country
+    Cb::Utils::Country
+  end
+end

data/lib/cb/clients/category_api.rb

@@ -0,0 +1,36 @@
+require "json"
+
+module Cb
+  class CategoryApi
+  	def self.search
+      my_api = Cb::Utils::Api.new()
+      cb_response = my_api.cb_get(Cb.configuration.uri_job_category_search)
+      json_hash = JSON.parse(cb_response.response.body)
+
+      categoryList = []
+      json_hash["ResponseCategories"]["Categories"]["Category"].each do |cat|
+        categoryList << CbCategory.new(cat)
+      end
+      return categoryList
+    end
+
+    def self.search_by_host_site(host_site)
+      my_api = Cb::Utils::Api.new()
+      cb_response = my_api.cb_get(Cb.configuration.uri_job_category_search, :query => {:CountryCode => host_site})
+      json_hash = JSON.parse(cb_response.response.body)
+
+      categoryList = []
+      unless json_hash.empty?
+        if json_hash["ResponseCategories"]["Categories"]["Category"].is_a?(Array)
+          json_hash["ResponseCategories"]["Categories"]["Category"].each do |cat|
+            categoryList << CbCategory.new(cat)
+          end
+        elsif json_hash["ResponseCategories"]["Categories"]["Category"].is_a?(Hash) && json_hash.length < 2
+          categoryList << CbCategory.new(json_hash["ResponseCategories"]["Categories"]["Category"])
+        end
+      end
+
+      return categoryList
+    end
+  end  
+end

data/lib/cb/clients/company_api.rb

@@ -0,0 +1,33 @@
+require 'json'
+
+module Cb
+	class CompanyApi
+		#############################################################
+		## Retrieve a company by did
+		## 
+		## For detailed information around this API please visit:
+		## http://api.careerbuilder.com/CompanyDetailsInfo.aspx
+		#############################################################
+		def self.find_by_did(did)
+      my_api = Cb::Utils::Api.new()
+			cb_response = my_api.cb_get(Cb.configuration.uri_company_find, :query => {:CompanyDID => did})
+			json_hash = JSON.parse(cb_response.response.body)
+
+			company = CbCompany.new(json_hash['Results']['CompanyProfileDetail'])
+      my_api.append_api_responses(company, json_hash['Results'])
+
+      return company
+		end
+
+		def self.find_for(obj)
+			if obj.is_a?(String)
+				did = obj
+			elsif obj.is_a?(Cb::CbJob)
+				did = obj.company_did
+			end
+			did ||= ''
+
+			find_by_did did unless did.empty?
+		end
+	end
+end

data/lib/cb/clients/education_api.rb

@@ -0,0 +1,27 @@
+require 'json'
+
+module Cb
+	class EducationApi
+		#############################################################
+		## Retrieve Education codes by country code
+		## 
+		## For detailed information around this API please visit:
+		## http://api.careerbuilder.com/EducationCodes.aspx
+		#############################################################
+		def self.get_for(country)
+			Cb::Utils::Country.is_valid? country ? country : 'US'
+
+			my_api = Cb::Utils::Api.new()
+			cb_response = my_api.cb_get(Cb.configuration.uri_education_code, :query => {:countrycode => country})
+			json_hash = JSON.parse(cb_response.response.body)
+
+			codes = []
+			json_hash['ResponseEducationCodes']['EducationCodes']['Education'].each do | education |
+        codes << Cb::CbEducation.new(education)
+      end
+      my_api.append_api_responses(codes, json_hash['ResponseEducationCodes'])
+
+      return codes
+		end
+	end
+end

data/lib/cb/clients/employee_types_api.rb

@@ -0,0 +1,39 @@
+require "json"
+
+module Cb
+	class EmployeeTypesApi
+
+		def self.search
+			my_api = Cb::Utils::Api.new()
+			cb_response = my_api.cb_get(Cb.configuration.uri_employee_types)
+			
+			return array_of_objects_from_hash(cb_response)
+		end
+
+		def self.search_by_host_site(hostsite)
+			my_api = Cb::Utils::Api.new()
+			cb_response = my_api.cb_get(Cb.configuration.uri_employee_types, :query => {:CountryCode => hostsite})
+
+			return array_of_objects_from_hash(cb_response)
+		end
+
+		private
+		def self.array_of_objects_from_hash(cb_response)
+			json_hash = JSON.parse(cb_response.response.body)
+
+			employee_types = []
+			unless json_hash.empty?
+				if json_hash["ResponseEmployeeTypes"]["EmployeeTypes"]["EmployeeType"].is_a?(Array)
+					json_hash["ResponseEmployeeTypes"]["EmployeeTypes"]["EmployeeType"].each do |et|
+						employee_types << CbEmployeeType.new(et)
+					end
+				elsif json_hash["ResponseEmployeeTypes"]["EmployeeTypes"]["EmployeeType"].is_a?(Hash) && json_hash.length < 2
+					employee_types << CbEmployeeType.new(json_hash["ResponseEmployeeTypes"]["EmployeeTypes"]["EmployeeType"])
+				end
+			end
+			
+			return employee_types
+		end
+
+	end
+end

data/lib/cb/clients/job_api.rb

@@ -0,0 +1,50 @@
+require 'json'
+
+module Cb
+  class JobApi
+    #############################################################
+    ## Run a job search against the given criteria
+    ##
+    ## For detailed information around this API please visit:
+    ## http://api.careerbuilder.com/JobSearchInfo.aspx
+    #############################################################
+    def self.search(*args)
+        args = args[0] if args.is_a?(Array) && args.count == 1
+
+        my_api = Cb::Utils::Api.new()
+        cb_response = my_api.cb_get(Cb.configuration.uri_job_search, :query => args)
+        json_hash = JSON.parse(cb_response.response.body)
+
+        jobs = []
+        unless json_hash['ResponseJobSearch']['Results'].nil?
+          json_hash['ResponseJobSearch']['Results']['JobSearchResult'].each do | cur_job |
+            jobs << CbJob.new(cur_job)
+          end
+        end
+        my_api.append_api_responses(jobs, json_hash['ResponseJobSearch'])
+
+        return jobs
+    end
+
+    #############################################################
+    ## Retrieve a job by did
+    ##
+    ## For detailed information around this API please visit:
+    ## http://api.careerbuilder.com/JobInfo.aspx
+    #############################################################
+    def self.find_by_did(did, params = {})
+      my_api = Cb::Utils::Api.new()
+      params[:did] = did
+      if params["showjobskin"].nil?
+        params["showjobskin"] = "Full"
+      end
+      cb_response = my_api.cb_get(Cb.configuration.uri_job_find, :query => params)
+      json_hash = JSON.parse(cb_response.response.body)
+
+      job = CbJob.new(json_hash['ResponseJob']['Job'])
+      my_api.append_api_responses(job, json_hash['ResponseJob'])
+
+      return job
+    end
+  end # JobApi
+end # Cb

data/lib/cb/clients/job_application_api.rb

@@ -0,0 +1,35 @@
+require 'json'
+
+module Cb
+  class JobApplicationApi
+    #############################################################
+    ## Get job application information
+    ## 
+    ## For detailed information around this API please visit:
+    ## http://api.careerbuilder.com/ApplicationInfo.aspx
+    #############################################################
+    
+    def self.get_for(job_did, site_id = '', co_brand = '')
+      my_api = Cb::Utils::Api.new()
+      cb_response = my_api.cb_get(Cb.configuration.uri_job_application, :query => {:JobDID => job_did, :SiteID => site_id, :CoBrand => co_brand})
+      json_hash = JSON.parse(cb_response.response.body)
+
+      job_application = CbJobApplication.new(json_hash['ResponseBlankApplication']['BlankApplication'])
+      my_api.append_api_responses(job_application, json_hash['ResponseBlankApplication'])
+
+      return job_application 
+    end
+    
+    #############################################################
+    ## Submit a job application
+    ## 
+    ## For detailed information around this API please visit:
+    ## http://api.careerbuilder.com/ApplicationInfo.aspx
+    #############################################################
+    
+    # def self.submit(did)
+
+    # end
+    
+  end # JobApplicationApi
+end # Cb

data/lib/cb/clients/recommendation_api.rb

@@ -0,0 +1,78 @@
+require 'json'
+
+module Cb
+  class RecommendationApi
+    #############################################################
+    ## Get recommendations for a job
+    ##
+    ## For detailed information around this API please visit:
+    ## http://api.careerbuilder.com/Recommendations.aspx
+    #############################################################
+    def self.for_job(did, 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})
+      json_hash = JSON.parse(cb_response.response.body)
+
+      jobs = []
+      unless json_hash['ResponseRecommendJob']['RecommendJobResults'].nil?
+        json_hash['ResponseRecommendJob']['RecommendJobResults']['RecommendJobResult'].each do |cur_job|
+          jobs << CbJob.new(cur_job)
+        end
+      end
+      my_api.append_api_responses(jobs, json_hash['ResponseRecommendJob'])
+      my_api.append_api_responses(jobs, json_hash['ResponseRecommendJob']['Request'])
+
+      return jobs
+    end
+
+    #############################################################
+    ## Get recommendations for a user
+    ##
+    ## For detailed information around this API please visit:
+    ## http://api.careerbuilder.com/Recommendations.aspx
+    #############################################################
+    def self.for_user(external_id, 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,
+                                             :HostSite => Cb.configuration.host_site})
+      json_hash = JSON.parse(cb_response.response.body)
+
+      jobs = []
+      unless json_hash['ResponseRecommendUser']['RecommendJobResults'].nil?
+        json_hash['ResponseRecommendUser']['RecommendJobResults']['RecommendJobResult'].each do |cur_job|
+          jobs << CbJob.new(cur_job)
+        end
+      end
+      my_api.append_api_responses(jobs, json_hash['ResponseRecommendUser'])
+      my_api.append_api_responses(jobs, json_hash['ResponseRecommendUser']['Request'])
+
+      return jobs
+    end
+
+    #############################################################
+    ## Get recommendations for a company
+    ##
+    ## For detailed information around this API please visit:
+    ## http://api.careerbuilder.com/Recommendations.aspx
+    #############################################################
+    def self.for_company(company_did)
+      my_api = Cb::Utils::Api.new()
+      cb_response = my_api.cb_get(Cb.configuration.uri_recommendation_for_company,
+                                  :query => {:CompanyDID => company_did})
+      json_hash = JSON.parse(cb_response.response.body)
+
+      jobs = []
+      unless json_hash['Results']['JobRecommendation'].nil?
+        json_hash['Results']['JobRecommendation']['Jobs'].each do |cur_job|
+          jobs << CbJob.new(cur_job)
+        end
+      end
+      my_api.append_api_responses(jobs, json_hash['Results'])
+      my_api.append_api_responses(jobs, json_hash['Results']['JobRecommendation'])
+
+      return jobs
+    end
+  end
+end

data/lib/cb/config.rb

@@ -0,0 +1,64 @@
+module Cb
+  class Config
+    attr_accessor :dev_key, :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,
+                  :uri_recommendation_for_job, :uri_recommendation_for_user,
+                  :uri_recommendation_for_company,
+                  :uri_job_application
+                  #:uri_job_application_submit
+
+    def initialize
+      Cb::Utils::Country.inject_convenience_methods
+      set_defaults
+    end
+
+    def set_default_api_uris
+      @uri_job_category_search            ||= '/v1/categories'
+      @uri_employee_types                 ||= '/v1/employeetypes'
+      @uri_company_find                   ||= '/Employer/CompanyDetails'
+      @uri_job_search                     ||= '/v1/JobSearch'
+      @uri_job_find                       ||= '/v1/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_job_application                ||= '/v1/application/blank'
+      #@uri_job_application_submit        ||= '/v1/application/submit'
+    end
+
+    def to_hash
+      {
+        :uri_job_category_search          => @uri_job_category_search,
+        :uri_employee_types               => @uri_employee_types,
+        :dev_key                          => @dev_key,
+        :host_site                        => @host_site,
+        :time_out  	                      => @time_out,
+        :use_json                         => @use_json,
+        :uri_job_search                   => @uri_job_search,
+        :uri_job_find                     => @uri_job_find,
+        :uri_company_find                 => @uri_company_find,
+        :uri_education_code               => @uri_education_code,
+        :uri_recommendation_for_job       => @uri_recommendation_for_job,
+        :uri_recommendation_for_user      => @uri_recommendation_for_user,
+        :uri_recommendation_for_company   => @uri_recommendation_for_company,
+        :uri_job_application              => @uri_job_application
+        # :uri_job_application_submit       => @uri_job_application_submit
+      }
+    end
+
+    private
+    #################################################################
+
+    def set_defaults
+
+      @dev_key              = 'ruby-cb-api'  # Get a developer key at http://api.careerbuilder.com
+      @time_out             = 5
+      @use_json             = true
+      @host_site            = Cb.country.US
+
+      set_default_api_uris
+    end
+  end
+end

data/lib/cb/job_search_criteria.rb

@@ -0,0 +1,102 @@
+module Cb
+	# Trying to simplify the large number of inputs our job search api accepts
+	# For indepth information around all of the different inputs, please visit:
+	# http://api.careerbuilder.com/JobSearchInfo.aspx
+	####################################################################################
+	class JobSearchCriteria
+		extend Cb::Utils::FluidAttributes
+
+		fluid_attr_accessor :advanced_grouping, :boolean_operator, :category, :co_brand, :company_did,
+                        :company_did_csv, :company_name, :company_name_boost, :country_code,
+                        :education_code, :employer_type, :enable_company_collapse, :exclude_company_names,
+                        :exclude_job_titles, :exclude_keywords, :exclude_national, :exclude_mlms,
+                        :exclude_product, :facet_category, :facet_company, :facet_city, :facet_state,
+                        :facet_city_state, :facet_pay, :facet_normalized_company_did, :host_site,
+                        :include_company_children, :industry_codes, :job_title, :keywords, :location,
+                        :normalized_company_did, :normalized_company_did_boost_params,
+                        :normalized_company_name, :onet, :order_by, :order_direction, :page_number,
+                        :partner_id, :pay_high, :pay_info_only, :pay_low, :per_page, :posted_within,
+                        :product, :radius, :records_per_group, :relocate_jobs, :soc, :school_id,
+                        :search_all_countries, :search_view, :show_categories, :show_apply_requirements,
+                        :apply_requirements, :single_onet, :site_entity, :site_id, :skills, :specific_education,
+                        :spoken_language, :tags, :talent_network_did, :url_compression_service, :use_facets,
+                        :str_crit
+
+		def search
+			Cb::JobApi.search(self.to_hash)
+		end
+
+		def to_hash
+			ret = {}
+
+			ret.merge!(:AdvancedGroupingMode => 				    @advanced_grouping) unless @advanced_grouping.nil?
+			ret.merge!(:BooleanOperator => 						      @boolean_operator) unless @boolean_operator.nil?
+			ret.merge!(:Category => 							          @category) unless @category.nil?
+			ret.merge!(:CoBrand => 								          @co_brand) unless @co_brand.nil?
+			ret.merge!(:CompanyDID => 							        @company_did) unless @company_did.nil?
+			ret.merge!(:CompanyDIDCSV => 						        @company_did_csv) unless @company_did_csv.nil?
+			ret.merge!(:CompanyName => 							        @company_name) unless @company_name.nil?
+			ret.merge!(:CompanyNameBoostParams => 			    @company_name_boost) unless @company_name_boost.nil?
+			ret.merge!(:CountryCode => 							        @country_code) unless @country_code.nil?
+			ret.merge!(:EducationCode => 						        @education_code) unless @education_code.nil?
+			ret.merge!(:EmpType => 								          @employer_type) unless @employer_type.nil?
+			ret.merge!(:EnableCompanyCollapse => 				    @enable_company_collapse) unless @enable_company_collapse.nil?
+			ret.merge!(:ExcludeCompanyNames => 					    @exclude_company_names) unless @exclude_company_names.nil?
+			ret.merge!(:ExcludeJobTitles => 					      @exclude_job_titles) unless @exclude_job_titles.nil?
+			ret.merge!(:ExcludeKeywords => 						      @exclude_keywords) unless @exclude_keywords.nil?
+			ret.merge!(:ExcludeNational => 						      @exclude_national) unless @exclude_national.nil?
+			ret.merge!(:ExcludeNonTraditionalJobs => 		    @exclude_mlms) unless @exclude_mlms.nil?
+			ret.merge!(:ExcludeProductID => 					      @exclude_product) unless @exclude_product.nil?
+			ret.merge!(:FacetCategory => 						        @facet_category) unless @facet_category.nil?
+			ret.merge!(:FacetCompany => 						        @facet_company) unless @facet_company.nil?
+			ret.merge!(:FacetCity => 							          @facet_city) unless @facet_city.nil?
+			ret.merge!(:FacetState => 							        @facet_state) unless @facet_state.nil?
+			ret.merge!(:FacetCityState => 						      @facet_city_state) unless @facet_city_state.nil?
+			ret.merge!(:FacetPay => 							          @facet_pay) unless @facet_pay.nil?
+			ret.merge!(:FacetNormalizedCompanyDID => 		    @facet_normalized_company_did) unless @facet_normalized_company_did.nil?
+			ret.merge!(:HostSite => 							          @host_site) unless @host_site.nil?
+			ret.merge!(:IncludeCompanyChildren => 			    @include_company_children) unless @include_company_children.nil?
+			ret.merge!(:IndustryCodes => 						        @industry_codes) unless @industry_codes.nil?
+			ret.merge!(:JobTitle => 							          @job_title) unless @job_title.nil?
+			ret.merge!(:Keywords => 							          @keywords) unless @keywords.nil?
+			ret.merge!(:Location => 							          @location) unless @location.nil?
+			ret.merge!(:NormalizedCompanyDID => 				    @normalized_company_did) unless @normalized_company_did.nil?
+			ret.merge!(:NormalizedCompanyDIDBoostParams => 	@normalized_company_did_boost_params) unless @normalized_company_did_boost_params.nil?
+			ret.merge!(:NormalizedCompanyName => 				    @normalized_company_name) unless @normalized_company_name.nil?
+			ret.merge!(:ONetCode => 							          @onet) unless @onet.nil?
+			ret.merge!(:OrderBy => 								          @order_by) unless @order_by.nil?
+			ret.merge!(:OrderDirection => 						      @order_direction) unless @order_direction.nil?
+			ret.merge!(:PageNumber => 							        @page_number) unless @page_number.nil?
+			ret.merge!(:PartnerID => 							          @partner_id) unless @partner_id.nil?
+			ret.merge!(:PayHigh => 								          @pay_high) unless @pay_high.nil?
+			ret.merge!(:PayInfoOnly => 							        @pay_info_only) unless @pay_info_only.nil?
+			ret.merge!(:PayLow => 								          @pay_low) unless @pay_low.nil?
+			ret.merge!(:PerPage => 								          @per_page) unless @per_page.nil?
+			ret.merge!(:PostedWithin => 						        @posted_within) unless @posted_within.nil?
+			ret.merge!(:ProductID => 							          @product) unless @product.nil?
+			ret.merge!(:Radius => 								          @radius) unless @radius.nil?
+			ret.merge!(:RecordsPerGroup => 						      @records_per_group) unless @records_per_group.nil?
+			ret.merge!(:RelocateJobs => 						        @relocate_jobs) unless @relocate_jobs.nil?
+			ret.merge!(:SOCCode => 								          @soc) unless @soc.nil?
+			ret.merge!(:SchoolSiteID => 						        @school_id) unless @school_id.nil?
+			ret.merge!(:SearchAllCountries => 					    @search_all_countries) unless @search_all_countries.nil?
+			ret.merge!(:SearchView => 							        @search_view) unless @search_view.nil?
+			ret.merge!(:ShowCategories => 						      @show_categories) unless @show_categories.nil?
+			ret.merge!(:ShowApplyRequirements => 				    @show_apply_requirements) unless @show_apply_requirements.nil?
+			ret.merge!(:ApplyRequirements => 					      @apply_requirements) unless @apply_requirements.nil?
+			ret.merge!(:SingleONetSearch => 					      @single_onet) unless @single_onet.nil?
+			ret.merge!(:SiteEntity => 							        @site_entity) unless @site_entity.nil?
+			ret.merge!(:SiteID => 								          @site_id) unless @site_id.nil?
+			ret.merge!(:Skills => 								          @skills) unless @skills.nil?
+			ret.merge!(:SpecificEducation => 					      @specific_education) unless @specific_education.nil?
+			ret.merge!(:SpokenLanguage => 						      @spoken_language) unless @spoken_language.nil?
+			ret.merge!(:Tags => 								            @tags) unless @tags.nil?
+			ret.merge!(:TalentNetworkDID => 					      @talent_network_did) unless @talent_network_did.nil?
+			ret.merge!(:UrlCompressionService => 				    @url_compression_service) unless @url_compression_service.nil?
+			ret.merge!(:UseFacets => 							          @use_facets) unless @use_facets.nil?
+			ret.merge!(:strcrit => 								          @str_crit) unless @str_crit.nil?
+
+			return ret
+		end
+	end
+end

data/lib/cb/models/cb_category.rb

@@ -0,0 +1,22 @@
+module Cb
+  class CbCategory
+  	attr_accessor :code, :name, :language
+  	def initialize(args={})
+  	  @code					= args["Code"] || ""
+  	  @name					= args["Name"]["#text"] || ""
+      @language     = args["Name"]["@language"] || ""
+    end
+
+    def CategoryName()
+      return @name if @name.present?
+    end
+
+    def CategoryCode()
+      return @code if @code.present?
+    end
+
+    def CategoryLanguage()
+      return @language if @language.present?
+    end
+  end
+end

data/lib/cb/models/cb_company.rb

@@ -0,0 +1,133 @@
+module Cb
+	class CbCompany
+    attr_accessor :did, :name, :hh_name, :url,  :size, :type, :year_founded, 
+                  :news_feed, :overview, :total_jobs, :headquarters, :host_sites, :s_drive, 
+                  :industry,
+
+                  :image_file, :header_image, :footer_image, :logo, :photos, :my_photos,
+                  :bright_cove_video,
+
+                  :twitter_url, :linked_in_url, :facebook_url, :facebook_widget,
+                  :linked_in_widget, :twitter_widget,
+
+                  :benefits, :benefits_label, :history, :contact, :contact_label, :links,
+                  :vision, :vision_label, :products, :products_label, :career_opps, :career_opps_label,
+                  :culture, :culture_label, :addresses, :bulletin_board, :testimonials, 
+                  :college, :college_label, :diversity, :diversity_label, :people, :people_label,
+
+                  :extra_custom_tab, :tab_header_bg_color, :tab_header_text_color, :tab_header_hover_color,
+                  :side_bar_header_color, :button_color, :button_text_color, :gutter_bg_color,
+                  :my_content_tabs, :info_tabs, :is_enhance, :is_military, :is_premium 
+
+    def initialize(args = {})
+      return if args.nil?
+
+      # General
+      ################################################################
+      @did                         = args['CompanyDID'] || ''
+      @name                        = args['CompanyName'] || ''
+      @hh_name                     = args['HHName'] || ''
+      @url                         = args['URL'] || ''
+      @size                        = args['CompanySize'] || ''
+      @type                        = args['CompanyType'] || ''
+      @year_founded                = args['YearFounded'] || ''
+      @news_feed                   = args['NewsFeed'] || ''
+      @overview                    = args['Overview'] || ''
+      @total_jobs                  = args['TotalNumberJobs'] || ''
+      @headquarters                = args['Headquarter'] || ''
+      @host_sites                  = args['HostSites'] || ''
+      @s_drive                     = args['SDrive'] || ''
+      @industry                    = args['IndustryType'] || ''
+
+      # Images
+      ################################################################
+      @logo                        = args['CompanyLogo'] || ''
+      @header_image                = args['HeaderImage'] || ''
+      @footer_image                = args['FooterImage'] || ''
+      @image_file                  = args['ImageFile'] || ''
+      
+      @photos                      = args['CompanyPhotos']['PhotoList'] || ''
+      @my_photos                   = args['MyPhotos'] || ''
+
+      # Videos
+      ################################################################
+      @bright_cove_video           = args['BrightcoveVideo'] || ''
+
+      # Social sites
+      ################################################################
+      @facebook_url                = args['FBPageURL'] || args['FacebookURL'] || '' 
+      @facebook_widget             = args['FacebookWidget'] || ''
+      @twitter_url                 = args['TwitterURL'] || ''
+      @twitter_widget              = args['TwitterWidget'] || ''
+      @linked_in_url               = args['LinkedURL'] || ''
+      @linked_in_widget            = args['LinkedInWidget'] || ''
+
+      # Detailed information (blobs)
+      ################################################################
+      @history                     = args['HistoryBody'] || ''
+      @people                      = args['PeopleBody'] || ''
+      @people_label                = args['PeopleLabel'] || ''
+      @contact                     = args['ContactBody'] || ''
+      @contact_label               = args['ContactLabel'] || ''
+      @benefits                    = args['BenefitsBody'] || ''
+      @benefits_label              = args['BenefitsLabel'] || ''
+      @vision                      = args['VisionBody'] || ''
+      @vision_label                = args['VisionLabel'] || ''
+      @products                    = args['ProductsBody'] || ''
+      @products_label              = args['ProductsLabel'] || ''
+      @career_opps                 = args['CareerOpportunitiesBody'] || ''
+      @career_opps_label           = args['CareerOpportunitiesLabel'] || ''
+      @culture                     = args['CultureBody'] || ''
+      @culture_label               = args['CultureLabel'] || ''
+      @bulletin_board              = args['CompanyBulletinBoard']['bulletinboards'] || ''
+      @testimonials                = args['Testimonials']['Testimonials'] || ''
+      @addresses = []
+      if args.has_key?('CompanyAddress')
+        unless args['CompanyAddress'].empty? || args['CompanyAddress']['AddressList'].nil?
+          args['CompanyAddress']['AddressList']['Address'].each do |cur_addr|
+            @addresses << CbCompany::CbAddress.new(cur_addr)
+          end
+        end
+      end
+      @college                     = args['CollegeBody'] || ''
+      @college_label               = args['CollegeLabel'] || ''
+      @diversity                   = args['DiversityBody'] || ''
+      @diversity_label             = args['DiversityLabel'] || ''
+      @links                       = args['CompanyLinksCollection']['companylinks'] || ''
+
+      # tabs, colors, buttons, headers, etc
+      ################################################################
+      @extra_custom_tab            = args['ExtraCustomTab'] || ''
+      @tab_header_bg_color         = args['TabHeaderBGColor'] || ''
+      @tab_header_text_color       = args['TabHeaderTextColor'] || ''
+      @tab_header_hover_color      = args['TabHeaderHoverColor'] || ''
+      @side_bar_header_color       = args['SidebarHeaderColor'] || ''
+      @button_color                = args['ButtonColor'] || ''
+      @button_text_color           = args['ButtonTextColor'] || ''
+      @gutter_bg_color             = args['GutterBGColor'] || ''
+      @my_content_tabs             = args['MyContent']['MyContentTabs'] || ''
+      @info_tabs                   = args['InfoTabs']['InfoTabs'] || ''
+      @is_enhance                  = args['isEnhance'] || ''
+      @is_military                 = args['MilitaryIcon'] || ''
+      @is_premium                  = args['PremiumProfile'] || ''
+    end
+
+    # CbAddress               # CbCompany has a collection of these
+    ################################################################
+    class CbAddress
+      attr_accessor :street, :city, :state, :country, :zip
+
+      def initialize(args = {})
+        begin
+          @street                    = args['Street'] || ''
+          @city                      = args['City'] || ''
+          @state                     = args['State'] || ''
+          @country                   = args['Country'] || ''
+          @zip                       = args['ZIPCode'] || ''
+        rescue
+          # failed to load address
+        end
+      end
+    end #CbAddress
+	end #CbCompany
+end #Cb

data/lib/cb/models/cb_education.rb

@@ -0,0 +1,25 @@
+module Cb
+  class CbEducation
+    attr_accessor :code, :text, :language
+
+    ##############################################################
+    ## This object stores Education Codes having to do with a
+    ## country. The API objects dealing with job, will populate
+    ## one or many of this object.
+    ##
+    ## For more information, please visit:
+    ## http://api.careerbuilder.com/v1/educationcodes
+    ##############################################################
+    def initialize(args = {})
+      return if args.nil?
+
+      @code          = args['Code'] || ''
+      @language			 = args['Name']['@language'] unless args['Name'].nil?
+      @text          = args['Name']['#text'] unless args['Name'].nil?
+
+      # I have got to find a better way to do this
+      @language ||= ''
+      @text ||= ''
+    end
+  end
+end

data/lib/cb/models/cb_employee_type.rb

@@ -0,0 +1,12 @@
+module Cb
+	class CbEmployeeType
+
+		attr_accessor	:code, :name, :language
+
+		def initialize(args={})
+			@code			||= args['Code'] || ''
+			@name			||= args['Name']["#text"] || ''
+			@language	||= args['Name']["@language"] || ''
+		end
+	end
+end

data/lib/cb/models/cb_job.rb

@@ -0,0 +1,67 @@
+module Cb
+	class CbJob
+    attr_accessor :did, :title, :pay,
+                  :company_name, :company_did, :company_details_url, :company_image_url, :company,
+                  :description_teaser, :location, :distance, :latitude, :longitude,
+                  :description, :requirements, :employment_type,
+                  :details_url, :service_url, :similar_jobs_url, :apply_url,
+                  :begin_date, :end_date, :posted_date,
+                  :relevancy, :state, :city
+
+		##############################################################
+		## This general purpose object stores anything having to do
+    ## with a job. The API objects dealing with job, will populate
+    ## one or many of this object.
+		##############################################################
+    def initialize(args = {})
+      return if args.nil?
+
+      # General
+      @did                          = args['DID'] || args['JobDID'] || ''
+      @title                        = args['JobTitle'] || args['Title'] || ''
+      @employment_type              = args['EmploymentType'] || ''
+      @latitude                     = args['LocationLatitude'] || ''
+      @longitude                    = args['LocationLongitude'] || ''
+      @pay                          = args['Pay'] || ''
+
+      # Job Search related
+      @description_teaser           = args['DescriptionTeaser'] || ''
+      @posted_date                  = args['PostedDate'] || ''
+      @distance                     = args['Distance'] || ''
+      @details_url                  = args['JobDetailsURL'] || ''
+      @service_url                  = args['JobServiceURL'] || ''
+      @location                     = args['Location'] || ''
+      @similar_jobs_url             = args['SimilarJobsURL'] || ''
+
+      # Job Details related
+      @description                  = args['Description'] || args['JobDescription'] || ''
+      @requirements                 = args['JobRequirements'] || ''
+      @begin_date                   = args['BeginDate'] || ''
+      @end_date                     = args['EndDate'] || ''
+      @apply_url                    = args['ApplyURL'] || ''
+
+      # Company related
+      @company_name                 = args['Company'] || ''
+      @company_did                  = args['CompanyDID'] || ''
+      @company_details_url          = args['CompanyDetailsURL'] || ''
+      @company_image_url            = args['CompanyImageURL'] || ''
+
+      # Recommendations related
+      @relevancy                    = args['Relevancy'] || ''
+      @state                        = args['Location']['State'] unless args['Location'].nil? || args['Location']['State'].nil?
+      @city                         = args['Location']['City'] unless args['Location'].nil? || args['Location']['City'].nil?
+      @company_name                 = args['Company']['CompanyName'] unless args['Company'].nil? || args['Company']['CompanyName'].nil?
+      @company_details_url          = args['Company']['CompanyDetailsURL'] unless args['Company'].nil? || args['Company']['CompanyDetailsURL'].nil?
+    end
+
+    def find_company
+      if @company
+        return @company
+      else
+        @company = Cb::CompanyApi.find_for self
+
+        return @company
+      end
+    end
+  end
+end

data/lib/cb/models/cb_job_application.rb

@@ -0,0 +1,29 @@
+module Cb
+  class CbJobApplication
+    attr_accessor :job_did, :site_id, :co_brand, :apply_url, :title, :total_questions,
+                  :total_required_questions, :questions, :submit_service_url
+    
+    ##############################################################
+    ## This general purpose object stores anything having to do
+    ## with an application. The API objects dealing with application,
+    ## will populate this object.
+    ##############################################################
+    def initialize(args = {})
+      return if args.nil?
+
+      @job_did                      = args['JobDID'] || ''
+      @site_id                      = args['SiteID'] || ''
+      @co_brand                     = args['CoBrand'] || ''
+      @apply_url                    = args['ApplyURL'] || ''
+      @title                        = args['JobTitle'] || ''
+      @total_questions              = args['TotalQuestions'] || ''
+      @total_required_questions     = args['TotalRequiredQuestions'] || ''
+      @questions                    = args['Questions'] || ''
+      @submit_service_url           = args['ApplicationSubmitServiceURL'] || ''
+      
+      #TODO
+      # Questions needs to be an array of data containers (of question)
+      
+    end
+  end # CbJobApplication
+end # Cb

data/lib/cb/utils/api.rb

@@ -0,0 +1,74 @@
+require 'HTTParty'
+
+module Cb::Utils
+  class Api
+    include HTTParty
+    base_uri 'http://api.careerbuilder.com'
+    #debug_output $stderr
+
+    def initialize
+      self.class.default_params :developerkey => Cb.configuration.dev_key,
+                                :outputjson => Cb.configuration.use_json.to_s
+
+      self.class.default_timeout Cb.configuration.time_out
+    end
+
+    def cb_get(*args, &block)
+      self.class.get(*args, &block)
+    end
+
+    def append_api_responses(obj, resp)
+      if obj.respond_to?('cb_response')
+        meta_class = obj.cb_response
+      else
+        meta_class = Cb::Utils::MetaValues.new()
+      end
+
+      resp.each do | api_key, api_value |
+        meta_name = get_meta_name_for api_key
+
+        unless meta_name.empty?
+          if meta_name == 'errors' && api_value.is_a?(Hash)
+            api_value = api_value.values
+          elsif is_numeric?(api_value)
+            api_value = api_value.to_i
+          end
+
+          meta_class.class.send(:attr_reader, meta_name)
+          meta_class.instance_variable_set(:"@#{meta_name}", api_value)
+        end
+      end
+
+      obj.class.send(:attr_reader, 'cb_response')
+      obj.instance_variable_set(:@cb_response, meta_class)
+    end
+
+    private
+    #############################################################################
+
+    def is_numeric?(obj)
+      true if Float(obj) rescue false
+    end
+
+    def get_meta_name_for(api_key)
+      key_map = {
+                  'Errors' =>                     'errors',
+                  'TimeResponseSent' =>           'time_sent',
+                  'TimeElapsed' =>                'time_elapsed',
+                  'TotalPages' =>                 'total_pages',
+                  'TotalCount' =>                 'total_count',
+                  'FirstItemIndex' =>             'first_item_index',
+                  'LastItemIndex' =>              'last_item_index',
+                  'CountryCode' =>                'country_code',
+                  'DeveloperKey' =>               'developer_key',
+                  'SiteID' =>                     'site_id',
+                  'CoBrand' =>                    'co_brand',
+                  'CountLimit' =>                 'count_limit',
+                  'MinQualityLimit' =>            'min_quality',
+                  'RecommendationsAvailable' =>   'recs_available'
+      }
+
+      key_map["#{api_key}"] ||= ''
+    end
+  end
+end

data/lib/cb/utils/country.rb

@@ -0,0 +1,22 @@
+module Cb::Utils::Country
+  # These aren't all country codes. We get it. Our naming scheme didn't hold up over time.
+  def self.get_supported
+    %w(AH BE CA CC CE CH CN CP CS CY DE DK E1 ER ES EU F1 
+       FR GC GR I1 IE IN IT J1 JC JS LJ M1 MY NL NO PD PI 
+       PL RM RO RX S1 SE SF SG T1 T2 UK US WH WM WR)
+  end
+
+  def self.is_valid?(country)
+    get_supported.include? country
+  end
+
+  def self.inject_convenience_methods
+    get_supported.each do | country |
+      unless self.respond_to? "#{country}"
+        self.define_singleton_method "#{country}" do
+          return country
+        end
+      end
+    end
+  end
+end

data/lib/cb/utils/fluid_attributes.rb

@@ -0,0 +1,16 @@
+module Cb::Utils::FluidAttributes
+	def fluid_attr_accessor(*names)
+		names.each do |name|
+			define_method :"#{name}" do | *args |
+				return instance_variable_get(:"@#{name}") if args.length == 0
+
+				if args.length == 1
+					instance_variable_set(:"@#{name}", args[0])
+					return self
+				end
+
+				raise ArgumentError.new("Wrong number of arguments (#{args.length} for 1)")
+			end
+		end
+	end
+end

data/lib/cb/utils/meta_values.rb

@@ -0,0 +1,13 @@
+module Cb::Utils
+  class MetaValues
+    # This class will be dynamically constructed at run time.
+    # I don't want values that don't make sense to the API call you made to be accessible
+    # I'm not dynamically creating the class because we may want to add functionality at some point
+
+    # This class, with its dynamically created attr_accr's will be dynamically appended to api
+    # entities, like job and company. It will contain things like errors, time elapsed, and
+    # any other meta values that the API may return.
+
+    # The mapping for allowed values, and what they translate to on this object live in Cb::Utils::Api
+  end
+end

data/lib/cb/version.rb

@@ -0,0 +1,3 @@
+module Cb
+  VERSION = '0.0.3'
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: cb-api
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+  prerelease: 
+platform: ruby
+authors:
+- Jesse Retchko
+- Chris Little
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.7.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.7.6
+description: Ruby wrapper for Careerbuilder Public API.
+email:
+- Jesse.Retchko@Careerbuilder.com
+- Chris.Little@Careerbuilder.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/cb/clients/category_api.rb
+- lib/cb/clients/company_api.rb
+- lib/cb/clients/education_api.rb
+- lib/cb/clients/employee_types_api.rb
+- lib/cb/clients/job_api.rb
+- lib/cb/clients/job_application_api.rb
+- lib/cb/clients/recommendation_api.rb
+- lib/cb/config.rb
+- lib/cb/job_search_criteria.rb
+- lib/cb/models/cb_category.rb
+- lib/cb/models/cb_company.rb
+- lib/cb/models/cb_education.rb
+- lib/cb/models/cb_employee_type.rb
+- lib/cb/models/cb_job.rb
+- lib/cb/models/cb_job_application.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/version.rb
+- lib/cb.rb
+- README.md
+homepage: http://api.careerbuilder.com
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Ruby wrapper around Careerbuilder Public API.
+test_files: []