cb-api 7.0.0 → 7.1.0

data/README.md

@@ -61,4 +61,24 @@ You will also get meta data regarding the search itself (helpful for pagination)
 
 Coming Soon
 ================
-More documentation!!
+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.
+
+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.
+
+    client = Cb::Client.new { |request_metadata| storage_device.add(request_metadata) }
+
+Or just call it without the block if you don't care about an individual call's observer info
+
+    client = Cb::Client.new
+
+Pass it a request object, and you will receive the appropriate response object back
+
+    request = Cb::Requests::Endpoint::CallName.new( { key1: 'value1', key2: 'value2' } )
+    response = client.execute request
+
+Currently, this workflow only works on the following endpoints:
+
+* User
+* Anonymous Saved Search
+
+Look here for future updates on this refactor!

data/lib/cb/client.rb

@@ -15,7 +15,8 @@ module Cb
     private
 
     def call_api(request)
-      cb_client.method(:"cb_#{request.http_method}").call(
+      http_wrapper.execute_http_request(
+        request.http_method,
         request.endpoint_uri,
         {
           query: request.query,
@@ -25,7 +26,7 @@ module Cb
         &@callback_block)
     end
 
-    def cb_client
+    def http_wrapper
       Cb::Utils::Api.instance
     end
   end

data/lib/cb/requests/anonymous_saved_search/create.rb

@@ -0,0 +1,66 @@
+require_relative '../base'
+
+module Cb
+  module Requests
+    module AnonymousSavedSearch
+      class Create < Base
+
+        def endpoint_uri
+          Cb.configuration.uri_anon_saved_search_create
+        end
+
+        def http_method
+          :post
+        end
+
+        def body
+          <<-eos
+          <Request>
+            <HostSite>#{@args[:host_site]}</HostSite>
+            <Cobrand>#{@args[:cobrand]}</Cobrand>
+            <BrowserID>#{@args[:browser_id]}</BrowserID>
+            <SessionID>#{@args[:session_id]}</SessionID>
+            <Test>#{(@args[:test] || false).to_s}</Test>
+            <EmailAddress>#{@args[:email_address]}</EmailAddress>
+            <SearchName>#{@args[:search_name]}</SearchName>
+#{search_parameters(@args[:search_parameters]) unless @args[:search_parameters].nil?}
+            <IsDailyEmail>#{@args[:is_daily_email]}</IsDailyEmail>
+            <DeveloperKey>#{Cb.configuration.dev_key}</DeveloperKey>
+          </Request>
+          eos
+        end
+
+        private
+
+        def search_parameters(args)
+          <<-eos
+            <SearchParameters>
+              <BooleanOperator>#{args[:boolean_operator]}</BooleanOperator>
+              <JobCategory>#{args[:job_category]}</JobCategory>
+              <EducationCode>#{args[:education_code]}</EducationCode>
+              <EmpType>#{args[:emp_type]}</EmpType>
+              <ExcludeCompanyNames>#{args[:exclude_company_names]}</ExcludeCompanyNames>
+              <ExcludeJobTitles>#{args[:exclude_job_titles]}</ExcludeJobTitles>
+              <ExcludeKeywords>#{args[:exclude_keywords]}</ExcludeKeywords>
+              <Country>#{args[:country]}</Country>
+              <IndustryCodes>#{args[:industry_codes]}</IndustryCodes>
+              <JobTitle>#{args[:job_title]}</JobTitle>
+              <Keywords>#{args[:keywords]}</Keywords>
+              <Location>#{args[:location]}</Location>
+              <OrderBy>#{args[:order_by]}</OrderBy>
+              <OrderDirection>#{args[:order_direction]}</OrderDirection>
+              <PayHigh>#{args[:pay_high]}</PayHigh>
+              <PayLow>#{args[:pay_low]}</PayLow>
+              <PostedWithin>#{args[:posted_within]}</PostedWithin>
+              <Radius>#{args[:radius]}</Radius>
+              <SpecificEducation>#{args[:specific_education]}</SpecificEducation>
+              <ExcludeNational>#{args[:exclude_national]}</ExcludeNational>
+              <PayInfoOnly>#{args[:pay_info_only]}</PayInfoOnly>
+            </SearchParameters>
+eos
+        end
+
+      end
+    end
+  end
+end

data/lib/cb/requests/anonymous_saved_search/delete.rb

@@ -0,0 +1,29 @@
+require_relative '../base'
+
+module Cb
+  module Requests
+    module AnonymousSavedSearch
+      class Delete < Base
+
+        def endpoint_uri
+          Cb.configuration.uri_anon_saved_search_delete
+        end
+
+        def http_method
+          :post
+        end
+
+        def body
+          <<-eos
+          <Request>
+            <ExternalID>#{@args[:external_id]}</ExternalID>
+            <DeveloperKey>#{Cb.configuration.dev_key}</DeveloperKey>
+            <Test>#{(@args[:test] || false).to_s}</Test>
+          </Request>
+          eos
+        end
+
+      end
+    end
+  end
+end

data/lib/cb/utils/api.rb

@@ -29,34 +29,26 @@ module Cb
       end
 
       def cb_get(path, options={}, &block)
-        self.class.base_uri Cb.configuration.base_uri
-        cb_event(:cb_get_before, path, options, nil, &block)
-        response = self.class.get(path, options)
-        cb_event(:cb_get_after, path, options, response, &block)
-        validate_response(response)
+        execute_http_request(:get, path, options, &block)
       end
 
       def cb_post(path, options={}, &block)
-        self.class.base_uri Cb.configuration.base_uri
-        cb_event(:cb_post_before, path, options, nil, &block)
-        response = self.class.post(path, options)
-        cb_event(:cb_post_after, path, options, response, &block)
-        validate_response(response)
+        execute_http_request(:post, path, options, &block)
       end
 
       def cb_put(path, options={}, &block)
-        self.class.base_uri Cb.configuration.base_uri
-        cb_event(:cb_put_before, path, options, nil, &block)
-        response = self.class.put(path, options)
-        cb_event(:cb_put_after, path, options, response, &block)
-        validate_response(response)
+        execute_http_request(:put, path, options, &block)
       end
 
       def cb_delete(path, options={}, &block)
+        execute_http_request(:delete, path, options, &block)
+      end
+
+      def execute_http_request(http_method, path, options={}, &block)
         self.class.base_uri Cb.configuration.base_uri
-        cb_event(:cb_delete_before, path, options, nil, &block)
-        response = self.class.delete(path, options)
-        cb_event(:cb_delete_after, path, options, response, &block)
+        cb_event(:"cb_#{http_method.to_s}_before", path, options, nil, &block)
+        response = self.class.method(http_method).call(path, options)
+        cb_event(:"cb_#{http_method.to_s}_after", path, options, response, &block)
         validate_response(response)
       end
 

data/lib/cb/utils/response_map.rb

@@ -12,6 +12,9 @@ module Cb
 
         def response_hash
           {
+            Cb::Requests::AnonymousSavedSearch::Create => Cb::Responses::AnonymousSavedSearch::Create,
+            Cb::Requests::AnonymousSavedSearch::Delete => Cb::Responses::AnonymousSavedSearch::Delete,
+
             Cb::Requests::User::ChangePassword => Cb::Responses::User::ChangePassword,
             Cb::Requests::User::CheckExisting => Cb::Responses::User::CheckExisting,
             Cb::Requests::User::Delete => Cb::Responses::User::Delete,

data/lib/cb/version.rb

@@ -1,3 +1,3 @@
 module Cb
-  VERSION = '7.0.0'
+  VERSION = '7.1.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cb-api
 version: !ruby/object:Gem::Version
-  version: 7.0.0
+  version: 7.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-21 00:00:00.000000000 Z
+date: 2014-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -268,6 +268,8 @@ files:
 - lib/cb/models/implementations/spot.rb
 - lib/cb/models/implementations/email_subscription.rb
 - lib/cb/models/api_call_model.rb
+- lib/cb/requests/anonymous_saved_search/delete.rb
+- lib/cb/requests/anonymous_saved_search/create.rb
 - lib/cb/requests/user/check_existing.rb
 - lib/cb/requests/user/delete.rb
 - lib/cb/requests/user/change_password.rb