cb-api 6.3.3 → 6.4.0

data/lib/cb.rb

@@ -3,13 +3,15 @@ require 'cb/models/implementations/branding/styles/base'
 require 'cb/models/implementations/branding/styles/css_adapter'
 require 'cb/exceptions'
 require 'cb/convenience'
+require 'cb/client'
 
 def require_directory(relative_path)
   Dir[File.dirname(__FILE__) + relative_path].each { |file| require file }
 end
 
 %w(/cb/utils/*.rb /cb/clients/**/*.rb /cb/criteria/**/*.rb /cb/models/**.rb
-   /cb/models/**/*.rb /cb/responses/*.rb /cb/responses/**/*.rb).each { |path| require_directory path }
+   /cb/models/**/*.rb /cb/responses/*.rb /cb/responses/**/*.rb
+   /cb/requests/*.rb /cb/requests/**/*.rb).each { |path| require_directory path }
 
 module Cb
   extend Convenience::ClassMethods

data/lib/cb/client.rb

@@ -0,0 +1,32 @@
+module Cb
+  class Client
+    attr_reader :callback_block
+
+    def initialize(&block)
+      @callback_block = block
+    end
+
+    def execute(request)
+      api_response = call_api(request)
+      response_class = Cb::Utils::ResponseMap.response_for(request.class)
+      response_class.new api_response
+    end
+
+    private
+
+    def call_api(request)
+      cb_client.method(:"cb_#{request.http_method}").call(
+        request.endpoint_uri,
+        {
+          query: request.query,
+          headers: request.headers,
+          body: request.body
+        },
+        &@callback_block)
+    end
+
+    def cb_client
+      Cb::Utils::Api.instance
+    end
+  end
+end

data/lib/cb/requests/base.rb

@@ -0,0 +1,30 @@
+module Cb
+  module Requests
+    class Base
+
+      def initialize(argument_hash)
+        @args = argument_hash || {}
+      end
+
+      def endpoint_uri
+        raise NotImplementedError.new __method__
+      end
+
+      def http_method
+        raise NotImplementedError.new __method__
+      end
+
+      def query
+        nil
+      end
+
+      def headers
+        nil
+      end
+
+      def body
+        nil
+      end
+    end
+  end
+end

data/lib/cb/requests/user/change_password.rb

@@ -0,0 +1,31 @@
+require_relative '../base'
+
+module Cb
+  module Requests
+    module User
+      class ChangePassword < Base
+
+        def endpoint_uri
+          Cb.configuration.uri_user_change_password
+        end
+
+        def http_method
+          :post
+        end
+
+        def body
+          <<-eos
+            <Request>
+              <DeveloperKey>#{Cb.configuration.dev_key}</DeveloperKey>
+              <ExternalID>#{@args[:external_id]}</ExternalID>
+              <Test>#{(@args[:test] || false).to_s}</Test>
+              <OldPassword>#{@args[:old_password]}</OldPassword>
+              <NewPassword>#{@args[:new_password]}</NewPassword>
+            </Request>
+          eos
+        end
+
+      end
+    end
+  end
+end

data/lib/cb/requests/user/check_existing.rb

@@ -0,0 +1,30 @@
+require_relative '../base'
+
+module Cb
+  module Requests
+    module User
+      class CheckExisting < Base
+
+        def endpoint_uri
+          Cb.configuration.uri_user_check_existing
+        end
+
+        def http_method
+          :post
+        end
+
+        def body
+          <<-eos
+            <Request>
+              <DeveloperKey>#{Cb.configuration.dev_key}</DeveloperKey>
+              <Email>#{@args[:email]}</Email>
+              <Password>#{@args[:password]}</Password>
+              <Test>#{(@args[:test] || false).to_s}</Test>
+            </Request>
+          eos
+        end
+
+      end
+    end
+  end
+end

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

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

data/lib/cb/requests/user/retrieve.rb

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

data/lib/cb/requests/user/temporary_password.rb

@@ -0,0 +1,25 @@
+require_relative '../base'
+
+module Cb
+  module Requests
+    module User
+      class TemporaryPassword < Base
+
+        def endpoint_uri
+          Cb.configuration.uri_user_temp_password
+        end
+
+        def http_method
+          :get
+        end
+
+        def query
+          {
+              'ExternalID' => @args[:external_id]
+          }
+        end
+
+      end
+    end
+  end
+end

data/lib/cb/responses/user/change_password.rb

@@ -0,0 +1,46 @@
+module Cb
+  module Responses
+    module User
+
+      class ChangePassword < ApiResponse
+        class Model < Struct.new(:status) ; end
+
+        protected
+
+        def validate_api_hash
+          required_response_field(root_node, response)
+          required_response_field(request_node, response[root_node])
+        end
+
+        def extract_models
+          model = Model.new()
+          model.status = response[root_node][status_node]
+          model
+        end
+
+        def metadata_containing_node
+          response[root_node]
+        end
+
+        def hash_containing_metadata
+          response
+        end
+
+        private
+
+        def root_node
+          'ResponseUserChangePW'
+        end
+
+        def request_node
+          'Request'
+        end
+
+        def status_node
+          'Status'
+        end
+      end
+
+    end
+  end
+end

data/lib/cb/responses/user/delete.rb

@@ -0,0 +1,46 @@
+module Cb
+  module Responses
+    module User
+
+      class Delete < ApiResponse
+        class Model < Struct.new(:status) ; end
+
+        protected
+
+        def validate_api_hash
+          required_response_field(root_node, response)
+          required_response_field(request_node, response[root_node])
+        end
+
+        def extract_models
+          model = Model.new
+          model.status = response[root_node][status_node]
+          model
+        end
+
+        def metadata_containing_node
+          response[root_node]
+        end
+
+        def hash_containing_metadata
+          response
+        end
+
+        private
+
+        def root_node
+          'ResponseUserDelete'
+        end
+
+        def request_node
+          'Request'
+        end
+
+        def status_node
+          'Status'
+        end
+      end
+
+    end
+  end
+end

data/lib/cb/responses/user/retrieve.rb

@@ -0,0 +1,43 @@
+module Cb
+  module Responses
+    module User
+
+      class Retrieve < ApiResponse
+
+        protected
+
+        def validate_api_hash
+          required_response_field(root_node, response)
+          required_response_field(request_node, response[root_node])
+        end
+
+        def extract_models
+          Models::User.new response[root_node][user_info_node]
+        end
+
+        def metadata_containing_node
+          response[root_node]
+        end
+
+        def hash_containing_metadata
+          response
+        end
+
+        private
+
+        def root_node
+          'ResponseUserInfo'
+        end
+
+        def request_node
+          'Request'
+        end
+
+        def user_info_node
+          'UserInfo'
+        end
+      end
+
+    end
+  end
+end

data/lib/cb/utils/api.rb

@@ -28,27 +28,27 @@ module Cb
         self.class.headers.merge! ({'accept-encoding' => 'deflate, gzip'}) unless Cb.configuration.debug_api
       end
 
-      def cb_get(path, options={})
+      def cb_get(path, options={}, &block)
         self.class.base_uri Cb.configuration.base_uri
-        cb_event(:cb_get_before, path, options, nil)
+        cb_event(:cb_get_before, path, options, nil, &block)
         response = self.class.get(path, options)
-        cb_event(:cb_get_after, path, options, response)
+        cb_event(:cb_get_after, path, options, response, &block)
         validate_response(response)
       end
 
-      def cb_post(path, options={})
+      def cb_post(path, options={}, &block)
         self.class.base_uri Cb.configuration.base_uri
-        cb_event(:cb_post_before, path, options, nil)
+        cb_event(:cb_post_before, path, options, nil, &block)
         response = self.class.post(path, options)
-        cb_event(:cb_post_after, path, options, response)
+        cb_event(:cb_post_after, path, options, response, &block)
         validate_response(response)
       end
 
-      def cb_put(path, options={})
+      def cb_put(path, options={}, &block)
         self.class.base_uri Cb.configuration.base_uri
-        cb_event(:cb_put_before, path, options, nil)
+        cb_event(:cb_put_before, path, options, nil, &block)
         response = self.class.put(path, options)
-        cb_event(:cb_put_after, path, options, response)
+        cb_event(:cb_put_after, path, options, response, &block)
         validate_response(response)
       end
 
@@ -110,9 +110,11 @@ module Cb
         Cb::Models::ApiCall.new(api_call_type, path, options, response)
       end
 
-      def cb_event(api_call_type, path, options, response)
+      def cb_event(api_call_type, path, options, response, &block)
+        call_model = api_call_model(api_call_type, path, options, response)
+        block.call(call_model) if block_given?
         changed(true)
-        notify_observers(api_call_model(api_call_type, path, options, response))
+        notify_observers(call_model)
       end
 
       def ensure_non_nil_metavalues(obj)

data/lib/cb/utils/response_map.rb

@@ -0,0 +1,31 @@
+module Cb
+  module Utils
+    class ResponseMap
+      class << self
+        def response_for request_class
+          response_class = response_hash[request_class]
+          return response_class unless response_class.nil?
+          raise ResponseNotFoundError.new request_class
+        end
+
+        private
+
+        def response_hash
+          {
+            Cb::Requests::User::ChangePassword => Cb::Responses::User::ChangePassword,
+            Cb::Requests::User::CheckExisting => Cb::Responses::User::CheckExisting,
+            Cb::Requests::User::Delete => Cb::Responses::User::Delete,
+            Cb::Requests::User::Retrieve => Cb::Responses::User::Retrieve,
+            Cb::Requests::User::TemporaryPassword => Cb::Responses::User::TemporaryPassword
+          }
+        end
+
+      end
+    end
+    class ResponseNotFoundError < StandardError
+      def initialize(args)
+        super(args)
+      end
+    end
+  end
+end

data/lib/cb/version.rb

@@ -1,3 +1,3 @@
 module Cb
-  VERSION = '6.3.3'
+  VERSION = '6.4.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cb-api
 version: !ruby/object:Gem::Version
-  version: 6.3.3
+  version: 6.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-07 00:00:00.000000000 Z
+date: 2014-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -220,7 +220,10 @@ files:
 - lib/cb/responses/industry/search.rb
 - lib/cb/responses/api_response.rb
 - lib/cb/responses/user/check_existing.rb
+- lib/cb/responses/user/delete.rb
+- lib/cb/responses/user/change_password.rb
 - lib/cb/responses/user/temporary_password.rb
+- lib/cb/responses/user/retrieve.rb
 - lib/cb/responses/timing.rb
 - lib/cb/responses/saved_search/list.rb
 - lib/cb/responses/saved_search/singular.rb
@@ -265,6 +268,12 @@ files:
 - lib/cb/models/implementations/spot.rb
 - lib/cb/models/implementations/email_subscription.rb
 - lib/cb/models/api_call_model.rb
+- lib/cb/requests/user/check_existing.rb
+- lib/cb/requests/user/delete.rb
+- lib/cb/requests/user/change_password.rb
+- lib/cb/requests/user/temporary_password.rb
+- lib/cb/requests/user/retrieve.rb
+- lib/cb/requests/base.rb
 - lib/cb/convenience.rb
 - lib/cb/clients/job_branding.rb
 - lib/cb/clients/recommendation.rb
@@ -282,12 +291,14 @@ files:
 - lib/cb/clients/anon_saved_search.rb
 - lib/cb/clients/spot.rb
 - lib/cb/clients/email_subscription.rb
+- lib/cb/client.rb
 - lib/cb/utils/response_array_extractor.rb
 - lib/cb/utils/country.rb
 - lib/cb/utils/validator.rb
 - lib/cb/utils/meta_values.rb
 - lib/cb/utils/console_observer.rb
 - lib/cb/utils/api.rb
+- lib/cb/utils/response_map.rb
 - lib/cb/utils/fluid_attributes.rb
 - README.md
 homepage: http://api.careerbuilder.com