cb-api 16.3.0 → 17.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8046403de4f6a1efab5bca180496e17a50430f1f
-  data.tar.gz: 1c62bd9e585e9a1d92d0ff2a70a2264c98e21d16
+  metadata.gz: 7116daa56671ff7d7bd59cdc9346452c5e915c6f
+  data.tar.gz: 09095c9812dea645376cb72a86235f41c8049a71
 SHA512:
-  metadata.gz: c1b6566803730c435efdfdc1f4f827e0453a5ff7073fe7af1bb3098c30701c13e15777b84f1b3378c24aabfafbde08b42b80a7ebc012b60508409f27ace582a1
-  data.tar.gz: d688616894a70bc3e2a2f7be4a5ae9757a929ad4bc9905353e57578b6ea5f88d82f1008780a54ea65b08eae4dd06f64a7bc95c068e20388d427c2d5eed68338c
+  metadata.gz: e6639fc9cb077b43eca8755cf6f27a77b4d15fa65916b6af589921c90abc7e41405c4e8ce9ac512668adc15318608ef77b38335cd73266b5ab3258b2dc3ca271
+  data.tar.gz: d1111f7532ce9ae50609df07f3b046c559916604504457339d204628950789f2bfa58a2efc690186cefc38af6a5dd482e885fe1c1cb85638b0b773646e477733

data/CHANGELOG.md

@@ -3,6 +3,7 @@ Version History
     * All Version bumps are required to update this file as well!!
 ----
 
+* 17.0.0 removed spot cms dependency
 * 16.3.0 changed api error response to use join instead of to_s
 * 16.2.2 change degree code to be degree which fixes compatibilty problems
 * 16.2.1 fix major or program in resume put. it was looking for the wrong value

data/README.md

@@ -32,58 +32,153 @@ https://github.com/cbdr/ruby-cb-api/blob/master/lib/cb/config.rb
 
 Job Search
 ================
-There's a couple ways to go about conducting a job search.
 
-Option 1:
+Use the `Cb` convenience methods to access the job client (`Cb::Clients::Job`)
 
-    search = Cb.job_search_criteria.location('Atlanta, GA').radius(10).search()
+    job_client = Cb.job
 
-Option 2:
+Using the job client you can search through the listings
 
-    crit = Cb.job_search_criteria
-    crit.location = 'Atlanta, GA'
-    crit.radius = 10
-    search = crit.search()
+    job_client.search({ location: 'Atlanta' })
 
-Either way, you will get back an array of CbJob.
+Or you can search for one job via it's details
 
-    search.each do |job|
-      puts job.title
-      puts job.company_name
-      puts job.instance_variables
+    job_client.find_by_criteria({ })
+
+Or you can search for one job via it's `did`
+
+    job_client.find_by_did('J3H4CK6XNXYQ07RHSYL')
+
+When using the job client to do a search you will receive back a search response instance (`Response::Job::Search`)
+
+    search_response = job_client.search({ location: 'Atlanta' })
+
+Which can be used to retrieve an search result model instance (`Cb::Models::JobResults`)
+
+    search_result_model = search_response.model
+
+Which encapsulates details of the search result
+
+    search_result.total_count
+    search_result.last_item_index
+    search_result.city
+    search_result.state
+    search_result.postal_code
+    search_result.search_location 
+
+As well as returning back the jobs from the search result (`Cb::Models::Job` instances)
+
+    jobs = search_result.jobs
+
+Each returned job object contains details of one job listing
+
+    jobs.each do |job|
+      puts "#{job.did}: #{job.company_name} - #{job.title}"
     end
 
-You will also get meta data regarding the search itself (helpful for pagination).
+The search response can also return you any errors which occured during the job search (`Cb::Responses::Errors`). The parsed errors will contain an `Array` of error messages. If it is not empty an error occurred during the request.
 
-    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.
+    search_response.errors.parsed
 
-Coming Soon
-================
-The way that requests are handled is being completely redone. You will now only need to instantiate a single client class and pass it a request object.
+Job Search params
+=================
 
-You may now pass a block that will be executed before and after each API call. This will provide the same information that the Observer methods do.
+When performing a job search you can provide a `Hash` of search parameters. For example
 
-    client = Cb::Client.new { |request_metadata| storage_device.add(request_metadata) }
+    search_params = { location: 'Atlanta', keywords: 'Database Admin' }
+    Cb.job.search(search_params)
 
-Or just call it without the block if you don't care about an individual call's observer info
+The search params hash can include the following keys:
 
-    client = Cb::Client.new
+* keywords
+* location
+* postedwithin
+* excludeapplyrequirments
+* orderdirection
+* orderby
+* pagenumber
+* hostsite
+* siteentity
+* countrycode
 
-Pass it a request object, and you will receive the appropriate response object back
+Job details
+===========
 
-    request = Cb::Requests::Endpoint::CallName.new( { key1: 'value1', key2: 'value2' } )
-    response = client.execute request
+`Cb::Models::Job` has many accessor methods which are used to get the details of the job
 
-Currently, this workflow only works on the following endpoints:
+If you have preformed a job search, such as
 
-* Anonymous Saved Search
-* Application
-* Application External
-* Category
-* Education
-* Company
-* User
+    Cb.job.search({ location: 'Atlanta' }).results.model.jobs.each do |job|
+      puts "Job Details: #{job.company_name} - #{job.title}"
+    end
 
-Look here for future updates on this refactor!
+The following data is available from a job
+
+* `did`
+* `title`
+* `job_skin`
+* `job_skin_did`
+* `job_branding`
+* `pay`
+* `pay_per`
+* `commission`
+* `bonus`
+* `pay_other`
+* `categories`
+* `category_codes`
+* `degree_required`
+* `experience_required`
+* `travel_required`
+* `industry_codes`
+* `manages_others_code`
+* `contact_email_url`
+* `contact_fax`
+* `contact_name`
+* `contact_phone`
+* `company_name`
+* `company_did`
+* `company_details_url`
+* `company_image_url`
+* `company`
+* `description_teaser`
+* `external_apply_url`
+* `job_tracking_url`
+* `location`
+* `distance`
+* `latitude`
+* `longitude`
+* `location_formatted`
+* `description`
+* `requirements`
+* `employment_type`
+* `details_url`
+* `service_url`
+* `similar_jobs_url`
+* `apply_url`
+* `begin_date`
+* `end_date`
+* `posted_date`
+* `relevancy`
+* `state`
+* `city`
+* `zip`
+* `can_be_quick_applied`
+* `apply_requirements`
+* `divison`
+* `industry`
+* `location_street_1`
+* `relocation_options`
+* `location_street_2`
+* `display_job_id`
+* `manages_others_string`
+* `degree_required_code`
+* `travel_required_code`
+* `employment_type_code`
+* `external_application?`
+* `relocation_covered?`
+* `manages_others?`
+* `screener_apply?`
+* `shared_job?`
+* `can_be_quick_applied?`
+* `has_questionnaire?`
+* `find_company`

data/lib/cb/config.rb

@@ -80,7 +80,6 @@ module Cb
       @uri_subscription_retrieve          ||= '/v2/user/subscription/retrieve'
       @uri_subscription_modify            ||= '/v2/user/subscription'
       @uri_saved_job_search_create        ||= '/v2/savedsearch/create'
-      @uri_spot_retrieve                  ||= '/v2/spot/load'
       @uri_work_status_list               ||= '/v1/resume/workstatuslist'
       @uri_resume_get                     ||= '/cbapi/resumes/:resume_hash'
       @uri_resume_put                     ||= '/cbapi/resumes/:resume_hash'

data/lib/cb/convenience.rb

@@ -73,10 +73,6 @@ module Cb
       def anon_saved_search
         Cb::Clients::AnonSavedSearch
       end
-  
-      def spot
-        Cb::Clients::Spot
-      end
 
       def language_codes
         Cb::Clients::LanguageCodes

data/lib/cb/version.rb

@@ -1,3 +1,3 @@
 module Cb
-  VERSION = '16.3.0'
+  VERSION = '17.0.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cb-api
 version: !ruby/object:Gem::Version
-  version: 16.3.0
+  version: 17.0.0
 platform: ruby
 authors:
 - The CareerBuilder.com Niche and Consumer Development teams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-10 00:00:00.000000000 Z
+date: 2015-06-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -206,7 +206,6 @@ files:
 - lib/cb/clients/job_branding.rb
 - lib/cb/clients/recommendation.rb
 - lib/cb/clients/saved_search.rb
-- lib/cb/clients/spot.rb
 - lib/cb/clients/talent_network.rb
 - lib/cb/clients/user.rb
 - lib/cb/config.rb
@@ -219,7 +218,6 @@ files:
 - lib/cb/criteria/application/update.rb
 - lib/cb/criteria/job/details.rb
 - lib/cb/criteria/resumes/get_by_hash.rb
-- lib/cb/criteria/spot/retrieve.rb
 - lib/cb/criteria/user/change_password.rb
 - lib/cb/criteria/user/delete.rb
 - lib/cb/exceptions.rb
@@ -269,7 +267,6 @@ files:
 - lib/cb/models/implementations/resumes/skills_and_qualifications.rb
 - lib/cb/models/implementations/resumes/work_experience.rb
 - lib/cb/models/implementations/saved_search.rb
-- lib/cb/models/implementations/spot.rb
 - lib/cb/models/implementations/state.rb
 - lib/cb/models/implementations/talent_network.rb
 - lib/cb/models/implementations/user.rb
@@ -335,7 +332,6 @@ files:
 - lib/cb/responses/saved_search/retrieve.rb
 - lib/cb/responses/saved_search/singular.rb
 - lib/cb/responses/saved_search/update.rb
-- lib/cb/responses/spot/retrieve_response.rb
 - lib/cb/responses/timing.rb
 - lib/cb/responses/user/change_password.rb
 - lib/cb/responses/user/check_existing.rb

data/lib/cb/clients/spot.rb

@@ -1,27 +0,0 @@
-require 'json'
-
-module Cb
-  module Clients
-    class Spot
-      class << self
-
-        def retrieve(criteria)
-          response = retrieve_api_response criteria
-          Cb::Responses::Spot::Retrieve.new(response)
-        end
-
-        private
-
-        def retrieve_api_response(criteria)
-          params = api_client.class.criteria_to_hash criteria
-          api_client.cb_get(Cb.configuration.uri_spot_retrieve, :query => params)
-        end
-
-        def api_client
-          @api ||= Cb::Utils::Api.instance
-        end
-
-      end
-    end
-  end
-end

data/lib/cb/criteria/spot/retrieve.rb

@@ -1,12 +0,0 @@
-module Cb
-  module Criteria
-    module Spot
-      class Retrieve
-        extend Cb::Utils::FluidAttributes
-
-        fluid_attr_accessor :contenttype, :language, :sortfield, :sortdirection, :maxitems
-        (1..8).each { |num| fluid_attr_accessor "field#{num.to_s}".to_sym }
-      end
-    end
-  end
-end

data/lib/cb/models/implementations/spot.rb

@@ -1,30 +0,0 @@
-module Cb
-  module Models
-    class Spot < ApiResponseModel
-
-      attr_accessor :content_type, :start_date, :end_date, :sequence, :language, :experiment_weight_custom_column,
-                    :field_1, :field_2, :field_3, :field_4, :field_5, :field_6, :field_7, :field_8,
-                    :text_1, :text_2, :text_3, :text_4
-
-      protected
-
-      def required_fields
-        %w(ContentType StartDate EndDate Sequence Language)
-      end
-
-      def set_model_properties
-        @content_type                     = api_response['ContentType']                  || String.new
-        @start_date                       = api_response['StartDate']                    || String.new
-        @end_date                         = api_response['EndDate']                      || String.new
-        @sequence                         = api_response['Sequence']                     || String.new
-        @language                         = api_response['Language']                     || String.new
-        @experiment_weight_custom_value   = api_response['ExperimentWeightCustomValue']  || String.new
-
-        # meta programming the @field_# and @text_# variables => ruby swag
-        (1..8).each { |num| instance_variable_set("@field_#{num.to_s}", api_response["Field#{num.to_s}"] || String.new) }
-        (1..4).each { |num| instance_variable_set("@text_#{num.to_s}",  api_response["Text#{num.to_s}"]  || String.new) }
-      end
-
-    end
-  end
-end

data/lib/cb/responses/spot/retrieve_response.rb

@@ -1,43 +0,0 @@
-module Cb
-  module Responses
-    module Spot
-
-      class Retrieve < Responses::ApiResponse
-
-        protected
-
-        def validate_api_hash
-          required_response_field(root_node, response)
-          required_response_field(spot_collection, response[root_node])
-        end
-
-        def extract_models
-          if spot_hashes.kind_of?(Array)
-            spot_hashes.map { |spot_data| Cb::Models::Spot.new(spot_data) }
-          else
-            Cb::Models::Spot.new(spot_hashes)
-          end
-        end
-
-        def hash_containing_metadata
-          response[root_node]
-        end
-
-        private
-
-        def root_node
-          @root_node ||= 'ResponseRetrieve'
-        end
-
-        def spot_collection
-          @spot_collection ||= 'SpotData'
-        end
-
-        def spot_hashes
-          response[root_node][spot_collection]
-        end
-      end
-
-    end
-  end
-end