cb-api 0.0.3 → 0.0.6

data/README.md

@@ -1,12 +1,48 @@
-cb-api
+First things first. You're going to need to get a developer key from Careerbuilder. You can obtain a key at http://api.careerbuilder.com/RequestDevKey.aspx.
+
+Now that you have a key, lets get to the good stuff.
+
+You can find an example rails site that uses the gem here:
+https://github.com/cbdr/ruby-cb-api-demo
+
+Configuration
 ================
+Set your dev key, and any other configuration settings in a place that will run prior to your API calls.
+
+Cb.configure do | config |
+	config.dev_key  	= 'your-dev-key-goes-here'
+	config.time_out 	= 5
+end
+
+Job Search
+================
+There's a couple ways to go about conducting a job search.
+
+Option 1:
 
-A gem that's going to house our internal API interactions.
+search = Cb.job_search_criteria.location('Atlanta, GA').radius(10).search()
 
+Option 2:
 
-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)
+crit = Cb.job_search_criteria
+crit.location = 'Atlanta, GA'
+crit.radius = 10
+search = crit.search()
+
+Either way, you will get back an array of CbJob.
+
+search.each | job | do
+    puts job.title
+    puts job.company_name
+    puts job.instance_variables
+end
+
+You will also get meta data regarding the search itself (helpful for pagination).
+
+puts search.cb_response.total_pages
+puts search.cb_response.total_count
+puts search.cb_response.errors # Hopefully this is nil! If it's not nil, it will be an array of error messages.
+
+Coming Soon
+================
+More documentation!

data/lib/cb.rb

@@ -26,6 +26,10 @@ module Cb
     Cb::JobSearchCriteria.new()
   end
 
+  def self.job_detail_criteria
+    Cb::JobApi::DetailsCriteria.new()
+  end
+
   def self.category
     Cb::CategoryApi
   end

data/lib/cb/clients/job_api.rb

@@ -2,6 +2,7 @@ require 'json'
 
 module Cb
   class JobApi
+
     #############################################################
     ## Run a job search against the given criteria
     ##
@@ -10,7 +11,6 @@ module Cb
     #############################################################
     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)
@@ -32,12 +32,10 @@ module Cb
     ## For detailed information around this API please visit:
     ## http://api.careerbuilder.com/JobInfo.aspx
     #############################################################
-    def self.find_by_did(did, params = {})
+    def self.find_by_criteria(criteria)
       my_api = Cb::Utils::Api.new()
-      params[:did] = did
-      if params["showjobskin"].nil?
-        params["showjobskin"] = "Full"
-      end
+      params = my_api.class.criteria_to_hash(criteria)
+
       cb_response = my_api.cb_get(Cb.configuration.uri_job_find, :query => params)
       json_hash = JSON.parse(cb_response.response.body)
 
@@ -46,5 +44,22 @@ module Cb
 
       return job
     end
+
+    def self.find_by_did(did)
+      criteria = Cb::JobDetailsCriteria.new()
+      criteria.did = did
+      return find_by_criteria(criteria)
+    end
   end # JobApi
+  
+  class JobDetailsCriteria
+    extend Cb::Utils::FluidAttributes
+
+    fluid_attr_accessor :did, :show_job_skin, :site_id, :cobrand, :show_apply_requirements
+
+    def find
+      Cb.job.find_by_did(self.did, self) 
+    end 
+  end
+
 end # Cb

data/lib/cb/job_search_criteria.rb

@@ -6,97 +6,24 @@ module Cb
 	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,
+		fluid_attr_accessor :advanced_grouping_mode, :boolean_operator, :category, :co_brand, :company_did,
+                        :company_did_csv, :company_name, :company_name_boost_params, :country_code,
+                        :education_code, :emp_type, :enable_company_collapse, :exclude_company_names,
+                        :exclude_job_titles, :exclude_keywords, :exclude_national, :exclude_non_traditional_jobs,
+                        :exclude_product_id, :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,
+                        :normalized_company_name, :onet_code, :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,
+                        :product_id, :radius, :records_per_group, :relocate_jobs, :soc_code, :school_site_id,
                         :search_all_countries, :search_view, :show_categories, :show_apply_requirements,
-                        :apply_requirements, :single_onet, :site_entity, :site_id, :skills, :specific_education,
+                        :apply_requirements, :single_onet_search, :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
+			Cb::JobApi.search(Cb::Utils::Api.criteria_to_hash(self))
 		end
 	end
 end

data/lib/cb/utils/api.rb

@@ -1,4 +1,4 @@
-require 'HTTParty'
+require 'httparty'
 
 module Cb::Utils
   class Api
@@ -43,6 +43,19 @@ module Cb::Utils
       obj.instance_variable_set(:@cb_response, meta_class)
     end
 
+    def self.criteria_to_hash(criteria)
+      params = Hash.new
+      if criteria.respond_to?(:instance_variables)
+        criteria.instance_variables.each do |var|
+          var_name = var.to_s
+          var_name.slice!(0)
+          var_name_hash_safe = var_name.camelize
+          params["#{var_name_hash_safe}"] = criteria.instance_variable_get(var)
+        end
+      end
+      return params
+    end
+
     private
     #############################################################################
 

data/lib/cb/utils/fluid_attributes.rb

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

data/lib/cb/utils/string.rb

@@ -0,0 +1,10 @@
+class String
+	
+	# Modified from Rails ActiveSupport::Inflector
+  # Source: activesupport/lib/active_support/inflector/methods.rb, line 55
+  # Documentation:  http://api.rubyonrails.org/classes/ActiveSupport/Inflector.html#method-i-camelize
+  def camelize()
+    self.sub!(/^[a-z\d]*/) { $&.capitalize }
+    self.gsub(/(?:_|(\/))([a-z\d]*)/) { "#{$2.capitalize}" }.gsub('/', '::')
+  end
+end

data/lib/cb/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cb-api
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -10,24 +10,24 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-17 00:00:00.000000000 Z
+date: 2013-05-03 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
+        version: '0.10'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 0.8.1
+        version: '0.10'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
@@ -71,6 +71,7 @@ files:
 - lib/cb/utils/country.rb
 - lib/cb/utils/fluid_attributes.rb
 - lib/cb/utils/meta_values.rb
+- lib/cb/utils/string.rb
 - lib/cb/version.rb
 - lib/cb.rb
 - README.md