cb-api 5.5.2 → 5.6.0

data/lib/cb/clients/application.rb

@@ -15,6 +15,12 @@ module Cb
           response cb_call(:put, criteria)
         end
 
+        def form(job_id)
+          url = Cb.configuration.uri_application_form.sub(':did', job_id)
+          response_hash = api_client.cb_get(url, headers: headers)
+          Responses::ApplicationForm.new(response_hash)
+        end
+
         private
 
         def cb_call(http_method, criteria)

data/lib/cb/config.rb

@@ -6,7 +6,7 @@ module Cb
                   :uri_education_code, :uri_employee_types,
                   :uri_recommendation_for_job, :uri_recommendation_for_user,
                   :uri_recommendation_for_company,
-                  :uri_application, :uri_application_submit,
+                  :uri_application, :uri_application_submit, :uri_application_form,
                   :uri_application_external,
                   :uri_application_registered, :uri_user_change_password, :uri_user_temp_password,
                   :uri_user_delete, :uri_user_retrieve, :uri_user_check_existing,
@@ -40,6 +40,7 @@ module Cb
       @uri_application_submit             ||= '/v1/Application/submit'
       @uri_application_registered         ||= '/v3/application/registered'
       @uri_application_external           ||= '/v1/application/external'
+      @uri_application_form               ||= '/cbapi/job/:did/applicationform'
       @uri_user_change_password           ||= '/v2/User/ChangePW'
       @uri_user_delete                    ||= '/v2/User/delete'
       @uri_user_retrieve                  ||= '/v2/user/retrieve'

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

@@ -0,0 +1,104 @@
+module Cb
+  module Models
+    class Application
+
+      class Form < ApiResponseModel
+        attr_reader :job_did, :job_title, :is_shared_apply, :question_list, :requirements,
+                    :degree_required, :travel_required, :experience_required, :external_application,
+                    :total_questions, :total_required_questions
+
+        protected
+
+        def required_fields
+          %w(
+            JobDID JobTitle IsSharedApply QuestionList Requirements DegreeRequired TravelRequired
+            ExperienceRequired ExternalApplication TotalQuestions TotalRequiredQuestions
+          )
+        end
+
+        def set_model_properties
+          @job_did                  = api_response['JobDID']
+          @job_title                = api_response['JobTitle']
+          @is_shared_apply          = api_response['IsSharedApply']
+          @requirements             = api_response['Requirements']
+          @degree_required          = api_response['DegreeRequired']
+          @travel_required          = api_response['TravelRequired']
+          @total_questions          = api_response['TotalQuestions'].to_i
+          @total_required_questions = api_response['TotalRequiredQuestions'].to_i
+          @experience_required      = api_response['ExperienceRequired']
+          @external_application     = api_response['ExternalApplication']
+          @question_list            = extracted_questions
+        end
+
+        def extracted_questions
+          questions = iterable_questions? ? response_questions : Array.new
+          questions.map { |question_hash| Question.new(question_hash) }
+        end
+
+        def iterable_questions?
+          !response_questions.nil? && !response_questions.empty? && response_questions.respond_to?(:map)
+        end
+
+        def response_questions
+          api_response['QuestionList']
+        end
+      end
+
+      class Question < ApiResponseModel
+        attr_reader :expected_response_format, :is_required, :question_id, :question_text,
+                    :question_type, :answers, :max_characters, :min_characters
+
+        protected
+
+        def required_fields
+          %w(ExpectedResponseFormat IsRequired QuestionID QuestionText QuestionType Answers)
+        end
+
+        def set_model_properties
+          @is_required    = api_response['IsRequired']
+          @question_id    = api_response['QuestionID']
+          @question_text  = api_response['QuestionText']
+          @question_type  = api_response['QuestionType']
+          @answers        = extracted_answers
+          @min_characters = extracted_int_or_nil('minCharacters')
+          @max_characters = extracted_int_or_nil('maxCharacters')
+          @expected_response_format = api_response['ExpectedResponseFormat']
+        end
+
+        def extracted_answers
+          answers = iterable_answers? ? response_answers : Array.new
+          answers.map { |answer_hash| Answer.new(answer_hash) }
+        end
+
+        def iterable_answers?
+          !response_answers.nil? && !response_answers.empty? && response_answers.respond_to?(:map)
+        end
+
+        def response_answers
+          api_response['Answers']
+        end
+
+        def extracted_int_or_nil(key)
+          api_response.has_key?(key) ? api_response[key].to_i : nil
+        end
+      end
+
+      class Answer < ApiResponseModel
+        attr_reader :answer_id, :answer_text, :question_id
+
+        protected
+
+        def required_fields
+          %w(AnswerID AnswerText QuestionID)
+        end
+
+        def set_model_properties
+          @answer_id   = api_response['AnswerID']
+          @answer_text = api_response['AnswerText']
+          @question_id = api_response['QuestionID']
+        end
+      end
+
+    end
+  end
+end

data/lib/cb/responses/application/application_form.rb

@@ -0,0 +1,23 @@
+require 'cb/responses/api_response'
+
+module Cb
+  module Responses
+    class ApplicationForm < ApiResponse
+
+      protected
+
+      def hash_containing_metadata
+        response
+      end
+
+      def validate_api_hash
+        required_response_field('Results', response)
+      end
+
+      def extract_models
+        response['Results'].map { |app_form_data| Cb::Models::Application::Form.new(app_form_data) }
+      end
+
+    end
+  end
+end

data/lib/cb/version.rb

@@ -1,3 +1,3 @@
 module Cb
-  VERSION = '5.5.2'
+  VERSION = '5.6.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cb-api
 version: !ruby/object:Gem::Version
-  version: 5.5.2
+  version: 5.6.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-24 00:00:00.000000000 Z
+date: 2014-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -215,6 +215,7 @@ files:
 - lib/cb/responses/metadata.rb
 - lib/cb/responses/job/singular.rb
 - lib/cb/responses/job/search.rb
+- lib/cb/responses/application/application_form.rb
 - lib/cb/responses/spot/retrieve_response.rb
 - lib/cb/responses/api_response.rb
 - lib/cb/responses/user/check_existing.rb
@@ -231,6 +232,7 @@ files:
 - lib/cb/models/implementations/job_branding.rb
 - lib/cb/models/implementations/application.rb
 - lib/cb/models/implementations/application/resume.rb
+- lib/cb/models/implementations/application/form.rb
 - lib/cb/models/implementations/application/cover_letter.rb
 - lib/cb/models/implementations/application/response.rb
 - lib/cb/models/implementations/job.rb