cb-api 1.3.6 → 2.0.0

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

@@ -0,0 +1,23 @@
+module Cb
+  module Responses
+    module AnonymousSavedSearch
+
+      class Delete < ApiResponse
+        protected
+
+        def hash_containing_metadata
+          response
+        end
+
+        def validate_api_hash
+          required_response_field('Status', response)
+        end
+
+        def extract_models
+          Models::SavedSearch::Delete.new(response)
+        end
+      end
+
+    end
+  end
+end

data/lib/cb/responses/api_response.rb

@@ -0,0 +1,64 @@
+require 'forwardable'
+
+module Cb
+  module Responses
+
+    class ApiResponse
+      extend Forwardable
+      delegate [:timing, :errors] => :metadata
+      delegate :[] => :response
+
+      attr_reader :models, :response
+      alias_method :model, :models
+
+      def initialize(raw_response_hash)
+        set_response_variable(raw_response_hash)
+        @metadata = extract_metadata
+        @models   = validated_models
+      end
+
+      protected
+      attr_reader :metadata
+
+      def extract_models
+        raise NotImplementedError.new(__method__)
+      end
+
+      def validate_api_hash
+        raise NotImplementedError.new(__method__)
+      end
+
+      def hash_containing_metadata
+        raise NotImplementedError.new(__method__)
+      end
+
+      def raise_on_timing_parse_error
+        true
+      end
+
+      def required_response_field(field_name, parent_hash)
+        raise ArgumentError.new("field_name can't be nil!")  if field_name.nil?
+        raise ArgumentError.new("parent_hash can't be nil!") if parent_hash.nil?
+        raise ExpectedResponseFieldMissing.new(field_name) unless parent_hash.has_key?(field_name)
+      end
+
+      private
+
+      def set_response_variable(response_hash)
+        should_raise = response_hash.nil? || response_hash.empty?
+        raise ApiResponseError.new('Response is empty!') if should_raise
+        @response = response_hash
+      end
+
+      def extract_metadata
+        Metadata.new(hash_containing_metadata, raise_on_timing_parse_error)
+      end
+
+      def validated_models
+        validate_api_hash
+        extract_models
+      end
+    end
+
+  end
+end

data/lib/cb/responses/employee_types/search.rb

@@ -0,0 +1,48 @@
+module Cb
+  module Responses
+    module EmployeeTypes
+
+      class Search < ApiResponse
+        protected
+
+        def hash_containing_metadata
+          response[root_node]
+        end
+
+        def validate_api_hash
+          required_response_field(root_node, response)
+          required_response_field(outer_collection_node, response[root_node])
+          required_response_field(inner_collection_node, employee_types_data)
+        end
+
+        def extract_models
+          extracted_employee_types_data.map { |emp_type| Models::EmployeeType.new(emp_type) }
+        end
+
+        private
+
+        def root_node
+          'ResponseEmployeeTypes'
+        end
+
+        def outer_collection_node
+          'EmployeeTypes'
+        end
+
+        def inner_collection_node
+          'EmployeeType'
+        end
+
+        def employee_types_data
+          response[root_node][outer_collection_node]
+        end
+
+        def extracted_employee_types_data
+          Utils::ResponseArrayExtractor.extract(response[root_node], outer_collection_node)
+        end
+      end
+
+    end
+  end
+end
+

data/lib/cb/responses/errors.rb

@@ -0,0 +1,47 @@
+module Cb
+  module Responses
+
+    class Errors
+      attr_reader :parsed
+
+      def initialize(raw_response_hash, raise_on_error = true)
+        @response     = raw_response_hash
+        @should_raise = raise_on_error
+        @parsed       = parsed_errors
+      end
+
+      private
+      attr_reader :response, :should_raise
+
+      def parsed_errors
+        return Array.new unless response.respond_to?(:map)
+        errors = response.map { |key, value| parsed_error(key, value) }.flatten
+        raise ApiResponseError.new(errors.to_s) if errors.any? && should_raise
+        errors
+      end
+
+      def parsed_error(key, value)
+        if hashy_errors?(key, value)
+          value.values
+        elsif error_array?(key, value)
+          value
+        else
+          Array.new
+        end
+      end
+
+      def hashy_errors?(key, value)
+        key.downcase == 'errors' && value.is_a?(Hash)
+      end
+
+      def error_array?(key, value)
+        (key.downcase == 'error' || key.downcase == 'errors') && value.is_a?(Array)
+      end
+
+      def method_missing(method, *args, &block)
+        parsed.send(method, *args, &block)
+      end
+    end
+
+  end
+end

data/lib/cb/responses/metadata.rb

@@ -0,0 +1,27 @@
+module Cb
+  module Responses
+
+    class Metadata
+      attr_reader :errors, :timing
+
+      def initialize(raw_response_hash, raise_on_timing_missing = true)
+        @response     = raw_response_hash
+        @should_raise = raise_on_timing_missing
+        @errors       = parsed_errors
+        @timing       = parsed_timing_info
+      end
+
+      private
+      attr_reader :response, :should_raise
+
+      def parsed_errors
+        Errors.new(response)
+      end
+
+      def parsed_timing_info
+        Timing.new(response, should_raise)
+      end
+    end
+
+  end
+end

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

@@ -0,0 +1,28 @@
+module Cb
+  module Responses
+    module SavedSearch
+
+      class Delete < ApiResponse
+        protected
+
+        def validate_api_hash
+          raise "Response can't be nil!" if response.nil?
+          required_response_field('Status', response)
+        end
+
+        def hash_containing_metadata
+          response
+        end
+
+        def extract_models
+          Models::SavedSearch::Delete.new(response)
+        end
+
+        def raise_on_timing_parse_error
+          false
+        end
+      end
+
+    end
+  end
+end

data/lib/cb/responses/saved_search/list.rb

@@ -0,0 +1,43 @@
+module Cb
+  module Responses
+    module SavedSearch
+
+      class List < ApiResponse
+        protected
+
+        def validate_api_hash
+          required_response_field(root_node, response)
+          required_response_field(outer_collection_node, response[root_node])
+          required_response_field(inner_collection_node, response[root_node][outer_collection_node])
+        end
+
+        def hash_containing_metadata
+          response
+        end
+
+        def extract_models
+          model_hashes.map { |model_data| Models::SavedSearch.new(model_data) }
+        end
+
+        private
+
+        def root_node
+          'SavedJobSearches'
+        end
+
+        def outer_collection_node
+          'SavedSearches'
+        end
+
+        def inner_collection_node
+          'SavedSearch'
+        end
+
+        def model_hashes
+          Utils::ResponseArrayExtractor.extract(response[root_node], outer_collection_node, inner_collection_node)
+        end
+      end
+
+    end
+  end
+end

data/lib/cb/responses/saved_search/singular.rb

@@ -0,0 +1,50 @@
+module Cb
+  module Responses
+    module SavedSearch
+
+      class Singular < ApiResponse
+        protected
+
+        def validate_api_hash
+          required_response_field(root_node, response)
+          required_response_field(model_node, response[root_node])
+        end
+
+        def hash_containing_metadata
+          response[root_node]
+        end
+
+        def extract_models
+          # these IDs comes back in weird places in the response hash,
+          # we need to move them around a little bit so things work correctly.
+          model_hash[user_id_node] = response[user_id_node]
+          model_hash[search_id_node] = response[search_id_node]
+          Models::SavedSearch.new(model_hash)
+        end
+
+        private
+
+        def root_node
+          'SavedJobSearch'
+        end
+
+        def model_node
+          'SavedSearch'
+        end
+
+        def user_id_node
+          'ExternalUserID'
+        end
+
+        def search_id_node
+          'ExternalID'
+        end
+
+        def model_hash
+          response[root_node][model_node]
+        end
+      end
+
+    end
+  end
+end

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

@@ -1,28 +1,39 @@
-module Cb::Responses::Spot
-  class Retrieve < Cb::Responses::RawApiResponse
+module Cb
+  module Responses
+    module Spot
 
-    ROOT_NODE = 'ResponseRetrieve'
-    SPOT_COLLECTION = 'SpotData'
+      class Retrieve < Responses::ApiResponse
 
-    class << self
-      def extract_models(raw_api_response)
-        new(raw_api_response).extract_models
-      end
-    end
+        protected
 
-    def initialize(raw_api_response={})
-      super(raw_api_response)
-    end
+        def validate_api_hash
+          required_response_field(root_node, response)
+          required_response_field(spot_collection, response[root_node])
+        end
 
-    def validate_raw_api_response
-      required_response_field ROOT_NODE, raw_api_hash
-      required_response_field SPOT_COLLECTION, raw_api_hash[ROOT_NODE]
-    end
+        def extract_models
+          spot_hashes.map { |spot_data| Cb::Models::Spot.new(spot_data) }
+        end
 
-    def extract_models
-      spot_models = raw_api_hash[ROOT_NODE][SPOT_COLLECTION].map { |spot_data| Cb::Models::Spot.new(spot_data) }
-      Cb::Utils::Api.new.append_api_responses(spot_models, raw_api_hash[ROOT_NODE])
-    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

data/lib/cb/responses/timing.rb

@@ -0,0 +1,37 @@
+module Cb
+  module Responses
+
+    class Timing
+      attr_reader :response_sent, :elapsed
+
+      def initialize(response, raise_on_parse_fail = true)
+        @response = response
+        @should_raise_on_parse_fail = raise_on_parse_fail
+        post_initialize
+      end
+
+      private
+      attr_reader :response, :should_raise_on_parse_fail
+
+      def post_initialize
+        raise_on_empty_timing_info
+        @response_sent = parsed_response_sent
+        @elapsed       = parsed_time_elapsed
+      end
+
+      def raise_on_empty_timing_info
+        should_raise = (response.nil? || !response.respond_to?(:[])) && should_raise_on_parse_fail
+        raise ExpectedResponseFieldMissing.new('Missing/malformed timing info!') if should_raise
+      end
+
+      def parsed_response_sent
+        DateTime.parse(response['TimeResponseSent']) rescue nil
+      end
+
+      def parsed_time_elapsed
+        response.include?('TimeElapsed') ? response['TimeElapsed'].to_f : nil
+      end
+    end
+
+  end
+end

data/lib/cb/utils/api.rb

@@ -32,7 +32,8 @@ module Cb
       end
 
       def append_api_responses(obj, resp)
-        meta_class = obj.respond_to?('cb_response') && !obj.cb_response.nil? ? obj.cb_response : Cb::Utils::MetaValues.new
+        meta_class = obj.respond_to?('cb_response') ? obj.cb_response : Cb::Utils::MetaValues.new
+
         resp.each do |api_key, api_value|
           meta_name = format_hash_key(api_key)
           unless meta_name.empty?
@@ -51,7 +52,6 @@ module Cb
           end
         end
 
-        # Convenience method on the response data model
         obj.class.send(:attr_reader, 'api_error')
         obj.instance_variable_set(:@api_error, @api_error)