cb-api 0.4.0 → 0.4.6

data/lib/cb.rb

@@ -1,15 +1,17 @@
 require 'cb/config'
-Dir[File.dirname(__FILE__) + '/cb/utils/*.rb'].each {| file| require file }
-Dir[File.dirname(__FILE__) + '/cb/clients/*.rb'].each {| file| require file }
-Dir[File.dirname(__FILE__) + '/cb/criteria/*.rb'].each {| file| require file }
-Dir[File.dirname(__FILE__) + '/cb/models/*.rb'].each {| file| require file }
-require 'cb/models/branding/styles/base'
-require 'cb/models/branding/styles/css_adapter'
-Dir[File.dirname(__FILE__) + '/cb/models/**/*.rb'].each {| file| require file }
+require 'cb/models/implementations/branding/styles/base'
+require 'cb/models/implementations/branding/styles/css_adapter'
+require 'cb/exceptions'
 
-module Cb
-  class IncomingParamIsWrongTypeException < StandardError; end
+def require_directory(relative_path)
+  Dir[File.dirname(__FILE__) + relative_path].each { |file| require file }
+end
+
+required_paths = %w(/cb/utils/*.rb /cb/clients/*.rb /cb/criteria/*.rb /cb/models/*.rb
+                    /cb/models/**/*.rb /cb/responses/*.rb /cb/responses/**/*.rb)
+required_paths.each { |path| require_directory path }
 
+module Cb
 	def self.configure
 		yield configuration
 	end
@@ -28,11 +30,11 @@ module Cb
   end
 
   def self.job_search_criteria
-    Cb::JobSearchCriteria.new()
+    Cb::JobSearchCriteria.new
   end
 
   def self.job_detail_criteria
-    Cb::JobApi::DetailsCriteria.new()
+    Cb::JobDetailsCriteria.new
   end
 
   def self.category
@@ -79,10 +81,6 @@ module Cb
     Cb::EmailSubscriptionApi
   end
 
-  def self.saved_job_search_api
-    Cb::SavedJobSearchApi
-  end
-
   def self.saved_search_api
     Cb::SavedSearchApi
   end
@@ -94,4 +92,8 @@ module Cb
   def self.anon_saved_search_api
     Cb::AnonSavedSearchApi
   end
-end
+
+  def self.spot
+    Cb::ApiClients::Spot
+  end
+end

data/lib/cb/clients/application_api.rb

@@ -17,11 +17,11 @@ module Cb
       json_hash = my_api.cb_get(Cb.configuration.uri_application, :query => {:JobDID => did})
 
       if json_hash.has_key?('ResponseBlankApplication')
-          if json_hash['ResponseBlankApplication'].has_key?('BlankApplication')
-            app = Cb::CbApplicationSchema.new(json_hash['ResponseBlankApplication']['BlankApplication'])
-          end
+        if json_hash['ResponseBlankApplication'].has_key?('BlankApplication')
+          app = Cb::CbApplicationSchema.new(json_hash['ResponseBlankApplication']['BlankApplication'])
+        end
 
-          my_api.append_api_responses(app, json_hash['ResponseBlankApplication'])
+        my_api.append_api_responses(app, json_hash['ResponseBlankApplication'])
       end
 
       my_api.append_api_responses(app, json_hash)

data/lib/cb/clients/job_api.rb

@@ -24,6 +24,7 @@ module Cb
             end
           end
           my_api.append_api_responses(jobs, json_hash['ResponseJobSearch'])
+          my_api.append_api_responses(jobs, json_hash['ResponseJobSearch']['SearchMetaData']['SearchLocations']['SearchLocation'])
         end
 
         my_api.append_api_responses(jobs, json_hash)

data/lib/cb/clients/spot_api.rb

@@ -0,0 +1,25 @@
+require 'json'
+
+module Cb::ApiClients
+  class Spot
+    class << self
+
+      def retrieve(criteria)
+        response = retrieve_api_response criteria
+        Cb::Responses::Spot::Retrieve.extract_models 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.new
+      end
+
+    end
+  end
+end

data/lib/cb/config.rb

@@ -18,7 +18,8 @@ module Cb
                   :uri_saved_job_search_create,
                   :uri_job_branding, :uri_tn_join_questions, :uri_tn_job_info, :uri_tn_join_form_geo,
                   :uri_tn_join_form_branding, :uri_tn_member_create,
-                  :uri_subscription_retrieve, :uri_subscription_modify
+                  :uri_subscription_retrieve, :uri_subscription_modify,
+                  :uri_spot_retrieve
 
     def initialize
       Cb::Utils::Country.inject_convenience_methods
@@ -63,6 +64,7 @@ module Cb
       @uri_subscription_retrieve          ||= '/v1/user/subscription/retrieve'
       @uri_subscription_modify            ||= '/v1/user/subscription'
       @uri_saved_job_search_create        ||= '/v2/savedsearch/create'
+      @uri_spot_retrieve                  ||= '/v2/spot/load'
     end
 
     def to_hash
@@ -101,11 +103,12 @@ module Cb
         :uri_tn_join_questions            => @uri_tn_join_questions,
         :uri_subscription_retrieve        => @uri_subscription_retrieve,
         :uri_subscription_modify          => @uri_subscription_modify,
-        :uri_saved_job_search_create      => @uri_saved_job_search_create
+        :uri_saved_job_search_create      => @uri_saved_job_search_create,
+        :uri_spot_retrieve                => @uri_spot_retrieve
       }
     end
 
-    private
+    protected
     #################################################################
 
     def set_defaults

data/lib/cb/criteria/spot_retrieve_criteria.rb

@@ -0,0 +1,12 @@
+module Cb::Criteria
+  class SpotRetrieve
+    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 }
+
+    def retrieve
+      Cb::ApiClients::Spot.retrieve self
+    end
+  end
+end

data/lib/cb/exceptions.rb

@@ -0,0 +1,4 @@
+module Cb
+  class IncomingParamIsWrongTypeException < StandardError; end
+  class ExpectedResponseFieldMissing < StandardError; end
+end

data/lib/cb/models/api_response_model.rb

@@ -0,0 +1,34 @@
+module Cb
+  module Models
+    class ApiResponseModel
+
+      attr_accessor :api_response
+
+      def initialize(response={})
+        @api_response = response
+        validate_api_response
+        set_model_properties
+      end
+
+      protected
+
+      def required_fields
+        # return an array of hash keys to check for in your api hash
+        raise NotImplementedError.new(__method__)
+      end
+
+      def set_model_properties
+        # do whatever work you need to do to set up the attributes on your model
+        raise NotImplementedError.new(__method__)
+      end
+
+      private
+
+      def validate_api_response
+        missing_fields  = required_fields.map { |field| field unless @api_response.has_key?(field) }.compact
+        raise ExpectedResponseFieldMissing.new(missing_fields.join(' ')) unless missing_fields.empty?
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+module Cb::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
+
+    def initialize(response={})
+      super(response)
+    end
+
+    private
+
+    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

data/lib/cb/responses/raw_api_response.rb

@@ -0,0 +1,34 @@
+module Cb
+  module Responses
+    class RawApiResponse
+
+      attr_accessor :raw_api_hash
+
+      def initialize(raw_api_response={})
+        @raw_api_hash = raw_api_response
+        validate_raw_api_response
+      end
+
+      def validate_raw_api_response
+        # call #required_response_field in here for each node that you know you'll need - stuff like the root node
+        # or the node that contains the data from which your model is built.
+        raise NotImplementedError.new(__method__)
+      end
+
+      def extract_models
+        # your api hash is considered valid at this point - grab the data you need and turn it into model(s)
+        raise NotImplementedError.new(__method__)
+      end
+
+      protected
+
+      def required_response_field(field_name, parent_hash)
+        [field_name, parent_hash].each do |arg|
+          raise ArgumentError.new("No nils! field_name nil?: #{field_name.nil?} parent_hash nil?: #{parent_hash.nil?}") if arg.nil?
+        end
+        raise ExpectedResponseFieldMissing.new(field_name) unless parent_hash.has_key? field_name
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+module Cb::Responses::Spot
+  class Retrieve < Cb::Responses::RawApiResponse
+
+    ROOT_NODE = 'ResponseRetrieve'
+    SPOT_COLLECTION = 'SpotData'
+
+    class << self
+      def extract_models(raw_api_response)
+        new(raw_api_response).extract_models
+      end
+    end
+
+    def initialize(raw_api_response={})
+      super(raw_api_response)
+    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_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
+
+  end
+end

data/lib/cb/utils/api.rb

@@ -51,7 +51,6 @@ module Cb
 
         resp.each do | api_key, api_value |
           meta_name = get_meta_name_for api_key
-
           unless meta_name.empty?
             if meta_name == 'errors' && api_value.is_a?(Hash)
               api_value = api_value.values
@@ -73,6 +72,7 @@ module Cb
 
         obj.class.send(:attr_reader, 'cb_response')
         obj.instance_variable_set(:@cb_response, meta_class)
+        obj
       end
 
       def self.criteria_to_hash(criteria)
@@ -109,23 +109,9 @@ module Cb
 
       def get_meta_name_for(api_key)
         key_map = {
-                    'Errors' =>                     'errors',
-                    'Error' =>                      'error',
-                    'TimeResponseSent' =>           'time_sent',
-                    'TimeElapsed' =>                'time_elapsed',
-                    'TotalPages' =>                 'total_pages',
-                    'TotalCount' =>                 'total_count',
-                    'FirstItemIndex' =>             'first_item_index',
-                    'LastItemIndex' =>              'last_item_index',
-                    'CountryCode' =>                'country_code',
-                    'DeveloperKey' =>               'developer_key',
-                    'SiteID' =>                     'site_id',
-                    'CoBrand' =>                    'co_brand',
-                    'CountLimit' =>                 'count_limit',
-                    'MinQualityLimit' =>            'min_quality',
-                    'RecommendationsAvailable' =>   'recs_available',
-                    'ApplicationStatus' =>          'application_status',
-                    'Status' =>                     'status'
+          'MinQualityLimit'           =>  'min_quality',
+          'RecommendationsAvailable'  =>  'recs_available',
+          api_key                     =>  api_key.snakecase
         }
 
         key_map["#{api_key}"] ||= ''

data/lib/cb/utils/fluid_attributes.rb

@@ -19,10 +19,10 @@ module Cb
           define_method :"#{name}=" do |*args|
             instance_variable_set(:"@#{name}", args[0]) if args.length == 1
             return self
-            raise ArgumentError, "Wrong number of arguments (#{args.length} for 1)"
           end
         end
       end
+
     end
   end
-end
+end

data/lib/cb/version.rb

@@ -1,3 +1,3 @@
 module Cb
-  VERSION = '0.4.0'
+  VERSION = '0.4.6'
 end

metadata

@@ -1,7 +1,8 @@
 --- !ruby/object:Gem::Specification
 name: cb-api
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.6
+  prerelease: 
 platform: ruby
 authors:
 - Jesse Retchko
@@ -18,11 +19,12 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-03 00:00:00.000000000 Z
+date: 2013-10-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -30,6 +32,7 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -37,20 +40,23 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.7.6
+        version: 1.7.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.7.6
+        version: 1.7.7
 - !ruby/object:Gem::Dependency
   name: nori
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -58,6 +64,7 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -65,6 +72,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -72,10 +80,123 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 1.6.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.6.0
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.9.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.7.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.7.1
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2.11'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.0
 description: Ruby wrapper for Careerbuilder Public API.
 email:
 - Jesse.Retchko@Careerbuilder.com
@@ -106,38 +227,45 @@ files:
 - lib/cb/clients/recommendation_api.rb
 - lib/cb/clients/resume_api.rb
 - lib/cb/clients/saved_search_api.rb
+- lib/cb/clients/spot_api.rb
 - lib/cb/clients/talent_network_api.rb
 - lib/cb/clients/user_api.rb
 - lib/cb/config.rb
 - lib/cb/criteria/job_details_criteria.rb
 - lib/cb/criteria/job_search_criteria.rb
-- lib/cb/models/branding/media.rb
-- lib/cb/models/branding/section.rb
-- lib/cb/models/branding/style.rb
-- lib/cb/models/branding/styles/base.rb
-- lib/cb/models/branding/styles/buttons.rb
-- lib/cb/models/branding/styles/company_info.rb
-- lib/cb/models/branding/styles/container.rb
-- lib/cb/models/branding/styles/content.rb
-- lib/cb/models/branding/styles/css_adapter.rb
-- lib/cb/models/branding/styles/headings.rb
-- lib/cb/models/branding/styles/job_details.rb
-- lib/cb/models/branding/styles/page.rb
-- lib/cb/models/branding/widget.rb
-- lib/cb/models/cb_application.rb
-- lib/cb/models/cb_application_external.rb
-- lib/cb/models/cb_application_schema.rb
-- lib/cb/models/cb_category.rb
-- lib/cb/models/cb_company.rb
-- lib/cb/models/cb_education.rb
-- lib/cb/models/cb_email_subscription.rb
-- lib/cb/models/cb_employee_type.rb
-- lib/cb/models/cb_job.rb
-- lib/cb/models/cb_job_branding.rb
-- lib/cb/models/cb_resume.rb
-- lib/cb/models/cb_saved_search.rb
-- lib/cb/models/cb_talent_network.rb
-- lib/cb/models/cb_user.rb
+- lib/cb/criteria/spot_retrieve_criteria.rb
+- lib/cb/exceptions.rb
+- lib/cb/models/api_response_model.rb
+- lib/cb/models/implementations/branding/media.rb
+- lib/cb/models/implementations/branding/section.rb
+- lib/cb/models/implementations/branding/style.rb
+- lib/cb/models/implementations/branding/styles/base.rb
+- lib/cb/models/implementations/branding/styles/buttons.rb
+- lib/cb/models/implementations/branding/styles/company_info.rb
+- lib/cb/models/implementations/branding/styles/container.rb
+- lib/cb/models/implementations/branding/styles/content.rb
+- lib/cb/models/implementations/branding/styles/css_adapter.rb
+- lib/cb/models/implementations/branding/styles/headings.rb
+- lib/cb/models/implementations/branding/styles/job_details.rb
+- lib/cb/models/implementations/branding/styles/page.rb
+- lib/cb/models/implementations/branding/widget.rb
+- lib/cb/models/implementations/cb_application.rb
+- lib/cb/models/implementations/cb_application_external.rb
+- lib/cb/models/implementations/cb_application_schema.rb
+- lib/cb/models/implementations/cb_category.rb
+- lib/cb/models/implementations/cb_company.rb
+- lib/cb/models/implementations/cb_education.rb
+- lib/cb/models/implementations/cb_email_subscription.rb
+- lib/cb/models/implementations/cb_employee_type.rb
+- lib/cb/models/implementations/cb_job.rb
+- lib/cb/models/implementations/cb_job_branding.rb
+- lib/cb/models/implementations/cb_resume.rb
+- lib/cb/models/implementations/cb_saved_search.rb
+- lib/cb/models/implementations/cb_spot.rb
+- lib/cb/models/implementations/cb_talent_network.rb
+- lib/cb/models/implementations/cb_user.rb
+- lib/cb/responses/raw_api_response.rb
+- lib/cb/responses/spot/retrieve_response.rb
 - lib/cb/utils/api.rb
 - lib/cb/utils/country.rb
 - lib/cb/utils/fluid_attributes.rb
@@ -149,26 +277,28 @@ files:
 - lib/cb.rb
 - README.md
 homepage: http://api.careerbuilder.com
-licenses: []
-metadata: {}
+licenses:
+- MIT
 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: 2.0.3
+rubygems_version: 1.8.25
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: Ruby wrapper around Careerbuilder Public API.
 test_files: []

checksums.yaml

@@ -1,7 +0,0 @@
----
-SHA1:
-  metadata.gz: 12a868480664d09635e4c498df02f757f2bffd69
-  data.tar.gz: a01294cdb386a46dd5f263caa003b4fd61c2afb4
-SHA512:
-  metadata.gz: 45c1a4ba86ba4f9326af0dce83a4917721280d6bafd8b26178b3b65cf2a0d3180abc560c04f78da989d5788f9b22d3c01b1f6f93e7963b45157bd5d8e670b4f3
-  data.tar.gz: edfd55c81b38add802881f5da4afd553d4367078e2fce58cbb671923bd52e52730fe32a8df20422341a57a4a7c6ec6a4237ce5e09847f798a9b13e6474d348e4