cb-api 0.1.21 → 0.2.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YzhlNjkzODYxM2U1MmU0ZjdkNTliM2VlZmIyNTFiZmYzOTMyNGFlOQ==
+  data.tar.gz: !binary |-
+    YjNkZTVhOGE0ZmRlMjk3YWM3MzljMTlkYjgwYmRhZWFiOWIzNTdhOA==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    ODNhM2UzOTg3YTc2OGVkNDI4ZGRlZGZhY2Q0MDdmM2I3NDNlZWY4M2M0ZDE4
+    NDM1NmFiOTM1YTIyYzA2ODNiNTI2YTA4NDBkYjI0MjMyNWU3YjAxNjk3M2Jh
+    M2EzZTViNDRhYzQ0OTY2MDAxYzM5NzUxZTE1NzhjYTkxODA1OGE=
+  data.tar.gz: !binary |-
+    YzU0OGM5NzIyYmRiOGE5MDMxZGVkYmIxZjA4NGNjZjRkOTRjYTIyMzYxZWM2
+    MzFjMjJlNGUzZjY2NzVhNTJmZTc1OTE5MDk2MzY1NTk4MDIwNTk1NmRmMWQ3
+    ZmU4ODE2ZTc1ZjlmOTE5MTBlNzE4N2YyZTUwY2VlZDQ1NzcyMGM=

data/lib/cb.rb

@@ -74,4 +74,12 @@ module Cb
   def self.email_subscription
     Cb::EmailSubscriptionApi
   end
+
+  def self.saved_job_search_api
+    Cb::SavedJobSearchApi
+  end
+
+  def self.saved_search_api
+    Cb::SavedSearchApi
+  end
 end

data/lib/cb/clients/saved_search_api.rb

@@ -0,0 +1,96 @@
+require 'json'
+
+module Cb
+  class SavedSearchApi
+
+    #############################################################
+    ## Create a Saved Search
+    ##
+    ## For detailed information around this API please visit:
+    ## http://api.careerbuilder.com/savedsearchinfo.aspx
+    #############################################################
+    def self.create params
+      my_api = Cb::Utils::Api.new
+      cb_response = my_api.cb_post Cb.configuration.uri_saved_search_create, :body => CbSavedSearch.new(params).create_to_xml
+      json_hash = JSON.parse cb_response.response.body
+      saved_search = CbSavedSearch.new json_hash['SavedJobSearch']
+      my_api.append_api_responses saved_search, json_hash['SavedJobSearch']
+
+      return saved_search
+    end
+
+    #############################################################
+    ## Update a Saved Search
+    ##
+    ## For detailed information around this API please visit:
+    ## http://api.careerbuilder.com/savedsearchinfo.aspx
+    #############################################################
+    def self.update params
+      my_api = Cb::Utils::Api.new
+      cb_response = my_api.cb_post Cb.configuration.uri_saved_search_update, :body => CbSavedSearch.new(params).update_to_xml
+      json_hash = JSON.parse cb_response.response.body
+      saved_search = CbSavedSearch.new json_hash['SavedJobSearch']
+      my_api.append_api_responses saved_search, json_hash['SavedJobSearch']
+
+      return saved_search
+    end
+
+    #############################################################
+    ## Delete a Saved Search
+    ##
+    ## For detailed information around this API please visit:
+    ## http://api.careerbuilder.com/savedsearchinfo.aspx
+    #############################################################
+
+    def self.delete params
+      my_api = Cb::Utils::Api.new
+      cb_response = my_api.cb_post Cb.configuration.uri_saved_search_delete, :body=>CbSavedSearch.new(params).delete_to_xml
+      json_hash = JSON.parse cb_response.response.body
+      saved_search = CbSavedSearch.new json_hash
+      my_api.append_api_responses saved_search, json_hash
+
+      return saved_search
+    end
+
+    #############################################################
+    ## Retrieve a Saved Search
+    ##
+    ## external_id is the unique ID for the specific Saved Search
+    ## that is being requested from the API. This External_id is
+    ## found from running a SavedSearchApi.all call. This is a
+    ## 64 character long ID.
+    ##
+    ## HostSite (From Saved Search List) Required*
+    ## Developer Key of the owning site for the User is Required*
+    ##
+    ## For detailed information around this API please visit:
+    ## http://api.careerbuilder.com/savedsearchinfo.aspx
+    #############################################################
+    def self.retrieve developer_key, external_user_id, external_id, host_site
+      my_api = Cb::Utils::Api.new
+      cb_response = my_api.cb_get Cb.configuration.uri_saved_search_retrieve, :query => {:developerkey=> developer_key, :externaluserid=> external_user_id, :externalid=> external_id, :hostsite=> host_site}
+      json_hash = JSON.parse cb_response.response.body
+      saved_search = CbSavedSearch.new json_hash['SavedJobSearch']
+      my_api.append_api_responses saved_search, json_hash['SavedJobSearch']
+
+      return saved_search
+    end
+
+    #############################################################
+    ## List of Saved Search's
+    ##
+    ## For detailed information around this API please visit:
+    ## http://api.careerbuilder.com/savedsearchinfo.aspx
+    #############################################################
+    def self.list developer_key, external_user_id
+      my_api = Cb::Utils::Api.new
+      cb_response = my_api.cb_get Cb.configuration.uri_saved_search_list, :query => {:developerkey=>developer_key, :ExternalUserId=>external_user_id}
+      json_hash = JSON.parse cb_response.response.body
+      saved_search = CbSavedSearch.new json_hash['SavedJobSearches']
+      my_api.append_api_responses saved_search, json_hash['SavedJobSearches']
+
+      return json_hash
+    end
+
+  end
+end

data/lib/cb/config.rb

@@ -10,7 +10,10 @@ module Cb
                   :uri_application_external,
                   :uri_application_registered, :uri_user_change_password,
                   :uri_user_delete, :uri_user_retrieve,
-                  :uri_job_branding, :uri_tn_join_questions, :uri_saved_job_search_create,
+                  :uri_job_branding,
+                  :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_subscription_retrieve, :uri_subscription_modify
 
     def initialize
@@ -36,6 +39,11 @@ module Cb
       @uri_user_delete                    ||= '/v2/User/delete'
       @uri_user_retrieve                  ||= '/v2/user/retrieve'
       @uri_job_branding                   ||= '/branding'
+      @uri_saved_search_retrieve          ||= '/v1/savedsearch/retrieve'
+      @uri_saved_search_create            ||= '/v2/savedsearch/create'
+      @uri_saved_search_update            ||= '/v2/savedsearch/update'
+      @uri_saved_search_delete            ||= '/v1/savedsearch/delete'
+      @uri_saved_search_list              ||= '/v1/savedsearch/list'
       @uri_tn_join_questions              ||= '/talentnetwork/config/join/questions'
       @uri_subscription_retrieve          ||= '/v1/user/subscription/retrieve'
       @uri_subscription_modify            ||= '/v1/user/subscription'
@@ -63,6 +71,11 @@ module Cb
         :uri_user_change_password         => @uri_user_change_password,
         :uri_user_retrieve                => @uri_user_retrieve,
         :uri_job_branding                 => @uri_job_branding,
+        :uri_saved_search_retrieve        => @uri_saved_search_retrieve,
+        :uri_saved_search_create          => @uri_saved_search_create,
+        :uri_saved_search_update          => @uri_saved_search_update,
+        :uri_saved_search_delete          => @uri_saved_search_delete,
+        :uri_saved_search_list            => @uri_saved_search_list,
         :uri_tn_join_questions            => @uri_tn_join_questions,
         :uri_subscription_retrieve        => @uri_subscription_retrieve,
         :uri_subscription_modify          => @uri_subscription_modify,

data/lib/cb/models/{cb_saved_job_search.rb → cb_saved_search.rb}

@@ -1,11 +1,11 @@
 require 'nokogiri'
 module Cb
-  class CbSavedJobSearch
+  class CbSavedSearch
     attr_accessor :hostsite, :cobrand, :site_id, :search_name, :boolean_operator, :category, :education_code, :specific_education,
                   :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_user_id, 
-                  :dev_key
+                  :pay_info_only, :location, :job_category, :company, :city, :state, :is_daily_email, :external_id,
+                  :external_user_id, :dev_key
 
     def initialize(args={})
       @hostsite                   = args[:HostSite] || ''
@@ -35,11 +35,12 @@ module Cb
       @city                       = args[:City] || ''
       @state                      = args[:State] || ''
       @is_daily_email             = args[:IsDailyEmail] || ''
-      @external_user_id           = args[:ExternalUserId] || ''
+      @external_id                = args[:ExternalID] || ''
+      @external_user_id           = args[:ExternalUserID] || ''
       @dev_key                    = args[:DeveloperKey] || "#{Cb.configuration.dev_key}"
     end
 
-    def to_xml
+    def create_to_xml
       ret =  "<Request>"
       ret += "<HostSite>#{@hostsite}</HostSite>"
       ret += "<Cobrand>#{@cobrand}</Cobrand>"
@@ -75,5 +76,55 @@ module Cb
 
       ret
     end
+
+    def update_to_xml
+      ret =  "<Request>"
+      ret += "<HostSite>#{@hostsite}</HostSite>"
+      ret += "<Cobrand>#{@cobrand}</Cobrand>"
+      ret += "<SearchName>#{@search_name}</SearchName>"
+      ret += "<SearchParameters>"
+      ret += "<BooleanOperator>#{@boolean_operator}</BooleanOperator>"
+      ret += "<Category>#{@category}</Category>"
+      ret += "<EducationCode>#{@education_code}</EducationCode>"
+      ret += "<SpecificEducation>#{@specific_education}</SpecificEducation>"
+      ret += "<EmpType>#{@emp_type}</EmpType>"
+      ret += "<ExcludeCompanyNames>#{@exclude_company_names}</ExcludeCompanyNames>"
+      ret += "<ExcludeJobTitles>#{@exclude_job_titles}</ExcludeJobTitles>"
+      ret += "<ExcludeNational>#{@exclude_national}</ExcludeNational>"
+      ret += "<IndustryCodes>#{@industry_codes}</IndustryCodes>"
+      ret += "<Keywords>#{@keywords}</Keywords>"
+      ret += "<OrderBy>#{@order_by}</OrderBy>"
+      ret += "<OrderDirection>#{@order_direction}</OrderDirection>"
+      ret += "<Radius>#{@radius}</Radius>"
+      ret += "<PayHigh>#{@pay_high}</PayHigh>"
+      ret += "<PayLow>#{@pay_high}</PayLow>"
+      ret += "<PostedWithin>#{@posted_within}</PostedWithin>"
+      ret += "<PayInfoOnly>#{@pay_info_only}</PayInfoOnly>"
+      ret += "<Location>#{@location}</Location>"
+      ret += "<JobCategory>#{@job_category}</JobCategory>"
+      ret += "<Company>#{@company}</Company>"
+      ret += "<City>#{@city}</City>"
+      ret += "<State>#{@state}</State>"
+      ret += "</SearchParameters>"
+      ret += "<IsDailyEmail>#{@is_daily_email}</IsDailyEmail>"
+      ret += "<ExternalID>#{@external_id}</ExternalID>"
+      ret += "<ExternalUserID>#{@external_user_id}</ExternalUserID>"
+      ret += "<DeveloperKey>#{@dev_key}</DeveloperKey>"
+      ret += "</Request>"
+
+      ret
+    end
+
+    def delete_to_xml
+      ret =  "<Request>"
+      ret += "<HostSite>#{@hostsite}</HostSite>"
+      ret += "<ExternalID>#{@external_id}</ExternalID>"
+      ret += "<ExternalUserID>#{@external_user_id}</ExternalUserID>"
+      ret += "<DeveloperKey>#{@dev_key}</DeveloperKey>"
+      ret += "</Request>"
+
+      ret
+    end
+
   end
 end

data/lib/cb/version.rb

@@ -1,3 +1,3 @@
 module Cb
-  VERSION = '0.1.21'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cb-api
 version: !ruby/object:Gem::Version
-  version: 0.1.21
-  prerelease: 
+  version: 0.2.0
 platform: ruby
 authors:
 - Jesse Retchko
@@ -11,16 +10,16 @@ authors:
 - Miriam Williams
 - David Posey
 - Kyle Bumpus
+- Jon Molinaro
 - Ben Schmaltz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-25 00:00:00.000000000 Z
+date: 2013-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -28,7 +27,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -36,7 +34,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -44,7 +41,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -52,7 +48,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: nori
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -60,7 +55,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -69,7 +63,9 @@ description: Ruby wrapper for Careerbuilder Public API.
 email:
 - Jesse.Retchko@Careerbuilder.com
 - Chris.Little@Careerbuilder.com
-- Matt.Moldavan@Careerbuilder.comMiriamDeana@gmail.com
+- Matt.Moldavan@Careerbuilder.com
+- Jon.Molinaro@careerbuilder.com
+- MiriamDeana@gmail.com
 - David.Posey@Careerbuilder.com
 - Kyle.Bumpus@Careerbuilder.com
 - Ben.Schmaltz@Careerbuilder.com
@@ -80,7 +76,6 @@ files:
 - lib/cb/clients/application_api.rb
 - lib/cb/clients/application_external_api.rb
 - lib/cb/clients/category_api.rb
-- lib/cb/clients/cb_saved_job_search_api.rb
 - lib/cb/clients/company_api.rb
 - lib/cb/clients/education_api.rb
 - lib/cb/clients/email_subscription_api.rb
@@ -88,6 +83,7 @@ files:
 - lib/cb/clients/job_api.rb
 - lib/cb/clients/job_branding_api.rb
 - lib/cb/clients/recommendation_api.rb
+- lib/cb/clients/saved_search_api.rb
 - lib/cb/clients/talent_network_api.rb
 - lib/cb/clients/user_api.rb
 - lib/cb/config.rb
@@ -116,7 +112,7 @@ files:
 - lib/cb/models/cb_employee_type.rb
 - lib/cb/models/cb_job.rb
 - lib/cb/models/cb_job_branding.rb
-- lib/cb/models/cb_saved_job_search.rb
+- lib/cb/models/cb_saved_search.rb
 - lib/cb/models/cb_user.rb
 - lib/cb/utils/api.rb
 - lib/cb/utils/country.rb
@@ -128,26 +124,25 @@ files:
 - README.md
 homepage: http://api.careerbuilder.com
 licenses: []
+metadata: {}
 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.25
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Ruby wrapper around Careerbuilder Public API.
 test_files: []

data/lib/cb/clients/cb_saved_job_search_api.rb

@@ -1,14 +0,0 @@
-require "json"
-require "nokogiri"
-
-module Cb
-  class SavedJobSearchApi
-
-    def create_saved_search(search)
-      my_api = Cb::Utils::Api.new()
-      saved_search = my_api.cb_post(Cb.configuration.uri_saved_job_search_create, 
-        :body => search.to_xml)
-    end
-
-  end
-end