cb-api 1.3.6 → 2.0.0

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

@@ -0,0 +1,34 @@
+module Cb
+  module Models
+    class JobBranding
+
+      attr_accessor :name, :media, :sections, :styles, :widgets, :id, :account_id, :type, :errors, :show_widgets, :company_description
+
+      def initialize args = {}
+        @name = args['Name'] || ''
+        @id = args['Id'] || ''
+        @account_id = args['AccountId'] || ''
+        @type = args['Type'] || ''
+        @media = Branding::Media.new args['Media']
+        @styles = Branding::Style.new args['Styles']
+        @errors = args['Errors'] || ''
+        @company_description = args['CompanyDescription'] || ''
+        @sections, @widgets = [], []
+
+        args['Sections'].each do |type, sections|
+          @sections << Branding::Section.new(type, sections) unless sections.nil?
+        end
+
+        args['Widgets'].each do |type, url|
+          if type == 'ShowWidgets'
+            @show_widgets = url == 'true'
+          else
+            @widgets << Branding::Widget.new(type, url) unless url.nil?
+          end
+        end
+
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,159 @@
+module Cb
+  module Models
+    class SavedSearch
+      attr_accessor :host_site, :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_id,
+                    :external_user_id, :job_search_url, :jrdid, :errors, :browser_id, :session_id, :test, :email_address,
+                    :saved_search_parameters, :country, :search_parameters
+
+      def initialize(args={})
+        @host_site                  = args['HostSite']         || String.new
+        @cobrand                    = args['Cobrand']          || String.new
+        @search_name                = args['SearchName']       || String.new
+        @site_id                    = args['SiteId']           || String.new
+        @is_daily_email             = args['IsDailyEmail']     || String.new
+        @email_delivery_day         = args['EmailDeliveryDay'] || String.new
+        @external_id                = args['ExternalID']       || String.new
+        @external_user_id           = args['ExternalUserID']   || String.new
+        @browser_id                 = args['BrowserID']        || nil
+        @session_id                 = args['SessionID']        || String.new
+        @email_address              = args['EmailAddress']     || String.new
+        @search_parameters          = SearchParameters.new(args['SavedSearchParameters'] || {})
+      end
+
+      def create_to_xml
+        ret =  "<Request>"
+        ret += "<HostSite>#{@hostsite}</HostSite>"
+        ret += "<Cobrand>#{@cobrand}</Cobrand>"
+        ret += "<SearchName>#{@search_name}</SearchName>"
+        ret += search_parameters.to_xml(:save_with => Nokogiri::XML::Node::SaveOptions::NO_DECLARATION)
+        ret += "<IsDailyEmail>#{@is_daily_email.to_s.upcase}</IsDailyEmail>"
+        ret += "<ExternalUserID>#{@external_user_id}</ExternalUserID>"
+        ret += "<DeveloperKey>#{Cb.configuration.dev_key}</DeveloperKey>"
+        ret + "</Request>"
+      end
+
+      def create_anon_to_xml
+        ret =  "<Request>"
+        ret += "<HostSite>#{@hostsite}</HostSite>"
+        ret += "<Cobrand>#{@cobrand}</Cobrand>"
+        ret += "<BrowserID>#{@browser_id}</BrowserID>"
+        ret += "<SessionID>#{@session_id}</SessionID>"
+        ret += "<Test>#{false}</Test>"
+        ret += "<EmailAddress>#{@email_address}</EmailAddress>"
+        ret += "<SearchName>#{@search_name}</SearchName>"
+        ret += search_parameters.to_xml(:save_with => Nokogiri::XML::Node::SaveOptions::NO_DECLARATION)
+        ret += "<IsDailyEmail>#{@is_daily_email.to_s.upcase}</IsDailyEmail>"
+        ret += "<DeveloperKey>#{Cb.configuration.dev_key}</DeveloperKey>"
+        ret + "</Request>"
+      end
+
+      def update_to_xml
+        ret =  "<Request>"
+        ret += "<HostSite>#{@hostsite}</HostSite>"
+        ret += "<Cobrand>#{@cobrand}</Cobrand>"
+        ret += "<SearchName>#{@search_name}</SearchName>"
+        ret += search_parameters.to_xml(:save_with => Nokogiri::XML::Node::SaveOptions::NO_DECLARATION)
+        ret += "<IsDailyEmail>#{@is_daily_email.to_s.upcase}</IsDailyEmail>"
+        ret += "<ExternalID>#{@external_id}</ExternalID>"
+        ret += "<ExternalUserID>#{@external_user_id}</ExternalUserID>"
+        ret += "<DeveloperKey>#{Cb.configuration.dev_key}</DeveloperKey>"
+        ret + "</Request>"
+      end
+
+      def delete_to_xml
+        Nokogiri::XML::Builder.new do
+          Request {
+            ExternalID     external_id
+            ExternalUserID external_user_id
+            HostSite       host_site
+            DeveloperKey   Cb.configuration.dev_key
+          }
+        end.to_xml
+      end
+
+
+
+      def delete_anon_to_xml
+        Nokogiri::XML::Builder.new do
+          Request {
+            DeveloperKey Cb.configuration.dev_key
+            ExternalID   external_id
+            Test         false
+          }
+        end.to_xml
+      end
+
+      class Delete
+        attr_reader :status
+
+        def initialize(response)
+          @status = response['Status']
+        end
+      end
+
+      class SearchParameters
+        attr_accessor :boolean_operator, :category, :education_code, :emp_type, :exclude_company_names, :exclude_job_titles,
+                      :exclude_keywords, :exclude_national, :industry_codes, :job_title, :keywords, :location, :order_by,
+                      :order_direction, :pay_high, :pay_info_only, :pay_low, :posted_within, :radius, :specific_education,
+                      :country
+
+        def initialize(args = {})
+          @boolean_operator      = args['BooleanOperator']     || String.new
+          @category              = args['Category']            || String.new
+          @job_category          = args['JobCategory']         || String.new
+          @education_code        = args['EducationCode']       || String.new
+          @emp_type              = args['EmpType']             || String.new
+          @exclude_company_names = args['ExcludeCompanyNames'] || String.new
+          @exclude_job_titles    = args['ExcludeJobTitles']    || String.new
+          @exclude_keywords      = args['ExcludeKeywords']     || String.new
+          @country               = args['Country']             || String.new
+          @industry_codes        = args['IndustryCodes']       || String.new
+          @job_title             = args['JobTitle']            || String.new
+          @keywords              = args['Keywords']            || String.new
+          @location              = args['Location']            || String.new
+          @order_by              = args['OrderBy']             || String.new
+          @order_direction       = args['OrderDirection']      || String.new
+          @pay_high              = args['PayHigh']             || 0
+          @pay_low               = args['PayLow']              || 0
+          @posted_within         = args['PostedWithin']        || 30
+          @radius                = args['Radius']              || 30
+          @specific_education    = args['SpecificEducation'].nil? ? false : args['SpecificEducation']
+          @exclude_national      = args['ExcludeNational'].nil?   ? false : args['ExcludeNational']
+          @pay_info_only         = args['PayInfoOnly'].nil?       ? false : args['PayInfoOnly']
+        end
+
+        def to_xml(args = {})
+          Nokogiri::XML::Builder.new do
+            SearchParameters {
+              BooleanOperator     boolean_operator
+              JobCategory         category
+              EducationCode       education_code
+              EmpType             emp_type
+              ExcludeCompanyNames exclude_company_names
+              ExcludeJobTitles    exclude_job_titles
+              ExcludeKeywords     exclude_keywords
+              Country             country
+              IndustryCodes       industry_codes
+              JobTitle            job_title
+              Keywords            keywords
+              Location            location
+              OrderBy             order_by
+              OrderDirection      order_direction
+              PayHigh             pay_high
+              PayLow              pay_low
+              PostedWithin        posted_within
+              Radius              radius
+              SpecificEducation   specific_education
+              ExcludeNational     exclude_national
+              PayInfoOnly         pay_info_only
+            }
+          end.to_xml(args)
+        end
+      end
+    end
+
+  end
+end

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

@@ -0,0 +1,30 @@
+module Cb
+  module 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
+
+      protected
+
+      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
+end

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

@@ -0,0 +1,156 @@
+module Cb
+  module Models
+    class TalentNetwork
+      attr_accessor :join_form_questions
+      def initialize(args={})
+        @join_form_questions = Array.new
+        if args.has_key?('JoinQuestions')
+          args['JoinQuestions'].each do |question|
+            @join_form_questions << TalentNetwork::Questions.new(question)
+          end
+        end
+      end
+    end
+
+    class TalentNetwork::Member
+      attr_accessor :dev_key, :tn_did, :preferred_language, :accept_privacy, :accept_terms, :resume_word_doc,
+                    :join_values
+
+      def initialize(args={})
+        @dev_key                = args['DeveloperKey'] || Cb.configuration.dev_key
+        @tn_did                 = args['TNDID'] || ''
+        @preferred_language     = args['PreferredLanguage'] || 'USEnglish'
+        @accept_privacy         = args['AcceptPrivacy'] || true
+        @accept_terms           = args['AcceptTerms'] || true
+        @resume_word_doc        = args['ResumeWordDoc'] || ''
+        @join_values            = args['JoinValues'] || Array.new
+      end
+
+      def to_xml
+        ret =  "<Request>"
+        ret += "<DeveloperKey>#{@dev_key}</DeveloperKey>"
+        ret += "<TalentNetworkDID>#{@tn_did}</TalentNetworkDID>"
+        ret += "<PreferredLanguage>#{@preferred_language}</PreferredLanguage>"
+        ret += "<AcceptPrivacy>#{@accept_privacy}</AcceptPrivacy>"
+        ret += "<AcceptTerms>#{@accept_terms}</AcceptTerms>"
+        ret += "<ResumeWordDoc>#{@resume_word_doc}</ResumeWordDoc>"
+        ret += "<JoinValues>"
+        @join_values.each { | k,v |
+          ret += "<JoinValue>"
+          ret += "<Key>#{k}</Key>"
+          ret += "<Value>#{v}</Value>"
+          ret += "</JoinValue>"
+        }
+        ret += "</JoinValues>"
+        ret += "</Request>"
+      end
+    end
+
+
+    class TalentNetwork::Questions
+      attr_accessor :text, :form_value, :option_display_type, :order, :required, :options
+
+      def initialize(args={})
+        @text                 = args['Text'] || ''
+        @form_value           = args['FormValue'] || ''
+        @option_display_type  = args['OptionDisplayType'] || ''
+        @order                = args['Order'] || ''
+        @required             = args['Required'].to_s || ''
+        @options              = Array.new
+        if args.has_key?('Options')
+          args['Options'].each do |option_values|
+            @options << TalentNetwork::Options.new(option_values)
+          end
+        end
+      end
+    end
+
+    class TalentNetwork::Options
+      attr_accessor :value, :order, :display_text
+
+      def initialize(args={})
+        @value          = args['Value'] || ''
+        @order          = args['Order'] || ''
+        @display_text   = args['DisplayText'] || ''
+      end
+    end
+
+    class TalentNetwork::JobInfo
+      attr_accessor :join_form_url, :tn_did, :join_form_intercept_enabled
+
+      def initialize(args={})
+        @join_form_url                    = args['JoinFormUrl'] || ''
+        @tn_did                           = args['sTNDID'] || ''
+        @join_form_intercept_enabled      = args['JoinFormInterceptEnabled'].to_s || ''
+      end
+    end
+
+    class TalentNetwork::JoinFormGeo
+      attr_accessor :countries, :states
+
+      def initialize(args={})
+        @countries = Hash.new
+        @states = Hash.new
+
+        if args.has_key?('Countries')
+          @countries = TalentNetwork::JoinFormGeoLocation.new(args['Countries'])
+        end
+
+        if args.has_key?('States')
+          @states = TalentNetwork::JoinFormGeoLocation.new(args['States'])
+        end
+
+      end
+    end
+
+    class TalentNetwork::JoinFormGeoLocation
+      attr_accessor :geo_hash
+
+      def initialize(args={})
+        value = Array.new
+        display_val = Array.new
+        @geo_hash = Hash.new
+
+        if args.has_key?('Value')
+          args['Value'].each do |val|
+            value << val
+          end
+        end
+
+        if args.has_key?('Display')
+          args['Display'].each do |display|
+            display_val << display
+          end
+        end
+
+        unless value.nil? || display_val.nil?
+          @geo_hash = convert_to_hash(display_val,value)
+        end
+      end
+
+      private
+      def convert_to_hash(keys, values)
+        geo_hash = Hash.new
+        geo_hash = Hash[keys.zip(values)]
+
+        return geo_hash
+      end
+    end
+
+    class TalentNetwork::JoinFormBranding
+      attr_accessor :stylesheet_url, :join_logo_image_url, :join_custom_msg_html, :button_color,
+                    :mobile_logo_image_url, :nav_color, :site_path
+
+      def initialize(args={})
+        @stylesheet_url                   = args['StylesheetURL'] || ''
+        @join_logo_image_url              = args['JoinLogoImageURL'] || ''
+        @join_custom_msg_html             = args['JoinCustomMsgHTML'] || ''
+        @button_color                     = args['ButtonColor'] || ''
+        @mobile_logo_image_url            = args['MobileLogoImageURL'] || ''
+        @nav_color                        = args['NavColor'] || ''
+        @site_path                        = args['SitePath'] || ''
+      end
+    end
+
+  end
+end

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

@@ -0,0 +1,58 @@
+module Cb
+  module Models
+    class User
+      attr_accessor :user_status, :password, :email, :address_1, :address_2, :city, :state,
+                    :province, :postal_code, :zip, :country_code, :first_name,
+                    :last_name, :phone, :fax, :last_login, :created, :allow_partner_emails,
+                    :allow_newsletter_emails, :allow_email_from_headhunter, :domain, :registration_path,
+                    :user_type, :gender, :birth_date, :cobrand_code, :resume_stats, :custom_values
+
+      def initialize(args = {})
+        return if args.nil?
+
+        @user_status                  = args['UserStatus'] || ''
+        @password                     = ''
+        @email              		      = args['Email'] || ''
+        @address_1                    = args['Address1'] || ''
+        @address_2                    = args['Address2'] || ''
+        @city                         = args['City'] || ''
+        @state                        = args['State'] || ''
+        @province                     = args['Province'] || ''
+        @postal_code                  = args['PostalCode'] || ''
+        @zip                          = args['Zip'] || ''
+        @country_code                 = args['CountryCode'] || ''
+        @first_name                   = args['FirstName'] || ''
+        @last_name                    = args['LastName'] || ''
+        @phone                        = args['Phone'] || ''
+        @fax                          = args['Fax'] || ''
+        @last_login                   = args['LastLogin'] || ''
+        @created                      = args['CreatedDT'] || ''
+        @allow_partner_emails         = args['AllowPartnerEmails'] || ''
+        @allow_newsletter_emails      = args['AllowNewsletterEmails'] || ''
+        @allow_email_from_headhunter  = args['AllowEmailFromHeadHunter'] || ''
+        @domain                       = args['Domain'] || ''
+        @registration_path            = args['RegistrationPath'] || ''
+        @user_type                    = args['UserType'] || ''
+        @gender                       = args['Gender'] || ''
+        @birth_date                   = args['BirthDate'] || ''
+        @cobrand_code                 = args['CoBrandCode'] || ''
+        @resume_stats                 = args['ResumeStats'] || ''
+        @custom_values                = args['CustomValues'] || ''
+      end
+
+      def custom_value custom_value_key
+        custom_value = nil
+
+        if @custom_values['CustomValue'].is_a? Array
+          @custom_values['CustomValue'].each do |cv|
+            custom_value = cv['Value'] if cv['Key'] == custom_value_key
+          end
+        elsif @custom_values['CustomValue'].is_a? Hash
+          custom_value = @custom_values['CustomValue']['Value'] if @custom_values['CustomValue']['Key'] == custom_value_key
+        end
+
+        return custom_value
+      end
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+module Cb
+  module Responses
+    module AnonymousSavedSearch
+
+      class Create < ApiResponse
+        protected
+
+        def hash_containing_metadata
+          response
+        end
+
+        def validate_api_hash
+          required_response_field(external_id_node, response)
+          required_response_field(model_node, response)
+        end
+
+        def extract_models
+          # external ID comes back outside of the model node so we need to do some rearranging
+          response[model_node][external_id_node] = response[external_id_node]
+          Models::SavedSearch.new(response[model_node])
+        end
+
+        private
+
+        def model_node
+          'AnonymousSavedSearch'
+        end
+
+        def external_id_node
+          'ExternalID'
+        end
+      end
+
+    end
+  end
+end