cb-api 1.3.6 → 2.0.0

data/lib/cb/criteria/job/details.rb

@@ -0,0 +1,11 @@
+module Cb
+  module Criteria
+    module Job
+      class Details
+        extend Cb::Utils::FluidAttributes
+
+        fluid_attr_accessor :did, :show_job_skin, :site_id, :lhs, :cobrand, :show_apply_requirements, :show_custom_values
+      end
+    end
+  end
+end

data/lib/cb/criteria/job/search.rb

@@ -0,0 +1,25 @@
+module Cb
+	module Criteria
+    module Job
+      class Search
+        extend Cb::Utils::FluidAttributes
+
+        fluid_attr_accessor :advanced_grouping_mode, :boolean_operator, :category, :co_brand, :company_did,
+                            :company_did_csv, :company_name, :company_name_boost_params, :country_code,
+                            :education_code, :emp_type, :enable_company_collapse, :exclude_company_names,
+                            :exclude_job_titles, :exclude_keywords, :exclude_national, :exclude_non_traditional_jobs,
+                            :exclude_product_id, :facet_category, :facet_company, :facet_city, :facet_state,
+                            :facet_city_state, :facet_pay, :facet_normalized_company_did, :host_site,
+                            :include_company_children, :industry_codes, :job_title, :keywords, :location,
+                            :normalized_company_did, :normalized_company_did_boost_params,
+                            :normalized_company_name, :onet_code, :order_by, :order_direction, :page_number,
+                            :partner_id, :pay_high, :pay_info_only, :pay_low, :per_page, :posted_within,
+                            :product_id, :radius, :records_per_group, :relocate_jobs, :soc_code, :school_site_id,
+                            :search_all_countries, :search_view, :show_categories, :show_apply_requirements,
+                            :apply_requirements, :exclude_apply_requirements, :single_onet_search, :site_entity, :site_id, :skills, :specific_education,
+                            :spoken_language, :tags, :talent_network_did, :url_compression_service, :use_facets,
+                            :str_crit
+      end
+    end
+  end
+end

data/lib/cb/criteria/spot/retrieve.rb

@@ -0,0 +1,12 @@
+module Cb
+  module Criteria
+    module Spot
+      class Retrieve
+        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 }
+      end
+    end
+  end
+end

data/lib/cb/exceptions.rb

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

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

@@ -0,0 +1,92 @@
+module Cb
+  module Models
+    class Application
+      #request params
+      attr_accessor :job_did, :site_id, :ipath, :co_brand, :test,
+                    :resume_file_name, :resume,
+                    :user_external_id, :user_external_resume_id,
+                    :answers
+
+      #response params
+      #redirect_url is returned from the api for shared apply applications.
+      attr_accessor :redirect_url
+
+      def initialize(args = {})
+        @job_did                  = args[:job_did]
+        @site_id                  = args[:site_id] || 'cbnsv'
+        @ipath                    = args[:ipath] || ''
+        @co_brand                 = args[:co_brand] || ''
+        @test                     = args[:test] || 'false'
+        @resume_file_name         = args[:resume_file_name] || ''
+        @resume                   = args[:resume] || ''
+        @user_external_id         = args[:user_external_id] || ''
+        @user_external_resume_id  = args[:user_external_resume_id] || ''
+        @answers                  = []
+        @redirect_url             = ''
+      end
+
+      def submit
+        if is_registered?
+          Cb.application.submit_registered_app(self)
+        else
+          Cb.application.submit_app(self)
+        end
+      end
+
+      def is_registered?
+        !@user_external_id.blank? && @resume.blank?
+      end
+
+      def is_unregistered?
+        !is_registered?
+      end
+
+      def complete?
+        cb_response.application_status == 'Complete' || cb_response.application_status == 'Complete (Test)'
+      end
+
+      def add_answer(id, text)
+        @answers << Application::Answer.new(id, text)
+      end
+
+      def to_xml
+        ret = '<RequestApplication>'
+
+        ret = "#{ret}<DeveloperKey>#{Cb.configuration.dev_key}</DeveloperKey>"
+        ret = "#{ret}<JobDID>#{@job_did}</JobDID>"
+        ret = "#{ret}<Test>#{@test}</Test>" unless @test.blank?
+        ret = "#{ret}<SiteID>#{@site_id}</SiteID>" unless @site_id.blank?
+        #ret = "#{ret}<IPath>#{@ipath}</IPath>" unless @ipath.blank? #this has to be passed by query string because the api is lame.
+        ret = "#{ret}<CoBrand>#{@co_brand}</CoBrand>" unless @co_brand.blank?
+        ret = "#{ret}<HostSite>#{Cb.configuration.host_site}</HostSite>"
+        ret = "#{ret}<Resume><ResumeFileName>#{@resume_file_name}</ResumeFileName><ResumeData>#{@resume}</ResumeData></Resume>" if is_unregistered?
+
+        unless @answers.count == 0
+          ret = "#{ret}<Responses>"
+          @answers.each do | ans |
+            ret = "#{ret}#{ans.to_xml}"
+          end
+          ret = "#{ret}</Responses>"
+        end
+
+        ret = "#{ret}<ExternalUserID>#{@user_external_id}</ExternalUserID>" if is_registered?
+        ret = "#{ret}<ExternalResumeID>#{@user_external_resume_id}</ExternalResumeID>" if is_registered?
+
+        "#{ret}</RequestApplication>"
+      end # to_xml
+    end # CbApplication
+
+    class Application::Answer
+      attr_accessor :id, :text
+
+      def initialize(id, text)
+        @id   = id
+        @text = text
+      end
+
+      def to_xml
+        "<Response><QuestionID>#{@id}</QuestionID><ResponseText>#{@text}</ResponseText></Response>"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+module Cb
+  module Models
+    class ApplicationExternal
+      attr_accessor :job_did, :email, :site_id, :ipath, :apply_url
+
+      def initialize(args = {})
+        @job_did          = args[:job_did] || ''
+        @email            = args[:email] || ''
+        @site_id          = args[:site_id] || 'cbnsv'
+        @ipath            = args[:ipath] || ''
+        @apply_url        = ''
+      end
+
+      def to_xml
+        ret = "<Request>"
+        ret += "<DeveloperKey>#{Cb.configuration.dev_key}</DeveloperKey>"
+        ret += "<EmailAddress>#{@email}</EmailAddress>"
+        ret += "<JobDID>#{@job_did}</JobDID>"
+        ret += "<SiteID>#{@site_id}</SiteID>"
+        ret += "<IPath>#{@ipath}</IPath>"
+        ret += "<IsExternalLinkApply>false</IsExternalLinkApply>"
+        ret += "<HostSite>#{Cb.configuration.host_site}</HostSite>"
+        ret += "</Request>"
+        ret
+      end
+    end
+  end
+end

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

@@ -0,0 +1,75 @@
+module Cb
+  module Models
+    class ApplicationSchema
+      attr_accessor :did, :title, :requirements,
+                    :apply_url, :submit_service_url, :is_shared_apply,
+                    :total_questions, :total_required_questions, :questions
+
+      def initialize(args = {})
+        return if args.nil?
+
+        # Job Info related
+        @did                      = args['JobDID'] || ''
+        @title       			        = args['JobTitle'] || ''
+        @requirements             = args['Requirements'] || ''
+
+        # Apply URL related
+        @submit_service_url       = args['ApplicationSubmitServiceURL'] || ''
+        @apply_url       			    = args['ApplyURL'] || ''
+        @is_shared_apply          = (args['IsSharedApply'].downcase == 'true')
+
+        # Question related
+        @total_questions       		= args['TotalQuestions'] || ''
+        @total_required_questions	= args['TotalRequiredQuestions'] || ''
+        @total_questions          = @total_questions.to_i if Cb::Utils::Api.is_numeric? @total_questions
+        @total_required_questions = @total_required_questions.to_i if Cb::Utils::Api.is_numeric? @total_required_questions
+
+        @questions = []
+        if args.has_key?('Questions')
+          unless args['Questions'].empty?
+            args['Questions']['Question'].each do | qq |
+              @questions << ApplicationSchema::QuestionSchema.new(qq)
+            end
+          end
+        end
+      end # Initialize
+    end # CbApplicationSchema
+
+    #################################################################
+    class ApplicationSchema::QuestionSchema
+      attr_accessor :id, :type, :required, :format, :text, :answers
+
+      def initialize(args = {})
+        return if args.nil?
+
+        @id       = args['QuestionID'] || ''
+        @type     = args['QuestionType'] || ''
+        @required = (args['IsRequired'].downcase == 'true')
+        @format   = args['ExpectedResponseFormat'] || ''
+        @text     = args['QuestionText'] || ''
+
+        @answers = []
+        if args.has_key?('Answers')
+          unless args['Answers'].empty?
+            args['Answers']['Answer'].each do | aa |
+              @answers << ApplicationSchema::AnswerSchema.new(aa)
+            end
+          end
+        end
+      end
+    end # CbQuestionSchema
+
+    #################################################################
+    class ApplicationSchema::AnswerSchema
+      attr_accessor :question_id, :id, :text
+
+      def initialize(args = {})
+        return if args.nil?
+
+        @question_id    = args['QuestionID']
+        @id             = args['AnswerID']
+        @text           = args['AnswerText']
+      end
+    end # CbAnswerSchema
+  end
+end

data/lib/cb/models/implementations/branding/media.rb

@@ -1,20 +1,20 @@
 module Cb
-  module Branding
+  module Models
+    module Branding
 
-    class Media
+      class Media
+        attr_accessor :header, :header_type, :tablet_banner, :mobile_logo, :footer, :is_multi_video
 
-      attr_accessor :header, :header_type, :tablet_banner, :mobile_logo, :footer, :video, :is_multi_video
-
-      def initialize args = {}
-        @header = args['Header'] || ''
-        @header_type = args['HeaderType'] || ''
-        @tablet_banner = args['TabletBanner'] || ''
-        @mobile_logo = args['MobileLogo'] || ''
-        @footer = args['Footer'] || ''
-        @video = args['Video'] || ''
-        @is_multi_video = args['IsMultiVideo'] == true
+        def initialize(args = {})
+          @header = args['Header'] || ''
+          @header_type = args['HeaderType'] || ''
+          @tablet_banner = args['TabletBanner'] || ''
+          @mobile_logo = args['MobileLogo'] || ''
+          @footer = args['Footer'] || ''
+          @is_multi_video = args['IsMultiVideo'] == 'true'
+        end
       end
 
     end
-	end
-end
+  end
+end

data/lib/cb/models/implementations/branding/section.rb

@@ -1,22 +1,21 @@
 module Cb
-  module Branding
+  module Models
+    module Branding
 
-    class Section
-      # Might be changing?
-      attr_accessor :type, :section_1, :section_2, :section_3, :description, :requirements, :snapshot
+      class Section
+        attr_accessor :type, :section_1, :section_2, :section_3, :description, :requirements, :snapshot
 
-      def initialize type, args = {}
-        @type = type
-
-        @section_1 = args['Section1'] || ''
-        @section_2 = args['Section2'] || ''
-        @section_3 = args['Section3'] || ''
-        @description = args['Description'] || ''
-        @requirements = args['Requirements'] || ''
-        @snapshot = args['Snapshot'] || ''
+        def initialize(type, args = {})
+          @type = type
+          @section_1 = args['Section1'] || ''
+          @section_2 = args['Section2'] || ''
+          @section_3 = args['Section3'] || ''
+          @description = args['Description'] || ''
+          @requirements = args['Requirements'] || ''
+          @snapshot = args['Snapshot'] || ''
+        end
       end
 
     end
   end
-
-end
+end

data/lib/cb/models/implementations/branding/style.rb

@@ -1,17 +1,17 @@
 module Cb
-  module Branding
+  module Models
+    module Branding
 
-    class Style
+      class Style
+        attr_accessor :page, :job_details, :company_info
 
-      attr_accessor :page, :job_details, :company_info
-
-      def initialize args = {}
-        @page = Cb::Branding::Styles::Page.new args['Page']
-        @job_details = Cb::Branding::Styles::JobDetails.new args['JobDetails']
-        @company_info = Cb::Branding::Styles::CompanyInfo.new args['CompanyInfo']
+        def initialize(args = {})
+          @page         = Styles::Page.new args['Page']
+          @job_details  = Styles::JobDetails.new args['JobDetails']
+          @company_info = Styles::CompanyInfo.new args['CompanyInfo']
+        end
       end
 
     end
-
   end
-end
+end

data/lib/cb/models/implementations/branding/styles/base.rb

@@ -1,19 +1,21 @@
 module Cb
-  module Branding
-    module Styles
+  module Models
+    module Branding
+      module Styles
 
-      class Base
-        attr_writer :styles
+        class Base
+          attr_writer :styles
 
-        def initialize args = {}
-          @styles = args
-        end
+          def initialize args = {}
+            @styles = args
+          end
 
-        def raw
-          @styles
+          def raw
+            @styles
+          end
         end
+
       end
     end
   end
-
 end

data/lib/cb/models/implementations/branding/styles/buttons.rb

@@ -1,12 +1,13 @@
 module Cb
-  module Branding
-    module Styles
+  module Models
+    module Branding
+      module Styles
 
-      class Buttons < Base
-        include Cb::Branding::Styles::CssAdapter
+        class Buttons < Base
+          include CssAdapter
+        end
 
       end
     end
   end
-
-end
+end

data/lib/cb/models/implementations/branding/styles/company_info.rb

@@ -1,19 +1,21 @@
 module Cb
-  module Branding
-    module Styles
+  module Models
+    module Branding
+      module Styles
 
-      class CompanyInfo < Base
-        attr_accessor :buttons, :container, :content, :headings
+        class CompanyInfo < Base
+          attr_accessor :buttons, :container, :content, :headings
 
-        def initialize args = {}
-          super
-
-          @buttons = Buttons.new args['Buttons']
-          @container = Container.new args['Container']
-          @content = Content.new args['Content']
-          @headings = Headings.new args['Headings']
+          def initialize args = {}
+            super
+            @buttons = Buttons.new args['Buttons']
+            @container = Container.new args['Container']
+            @content = Content.new args['Content']
+            @headings = Headings.new args['Headings']
+          end
         end
+
       end
     end
   end
-end
+end