spear-cb-api 0.0.1 → 0.0.2

data/lib/spear/resource/application.rb

@@ -0,0 +1,22 @@
+# encoding: utf-8
+
+module Spear
+  module Resource
+    module Application
+      def history(user_external_id)
+        raise Spear::ParametersRequired.new('UserExternalId') if user_external_id.blank?
+
+        Spear::Request.new.execute(:get, "/application/history",
+          {query: {:ExternalID => user_external_id}, api_options: {path: 'v1'}})
+      end
+
+      # Application Creation
+      def create_application(host_site, data={})
+        raise Spear::ParametersRequired.new('HostSite') if host_site.blank?
+
+        Spear::Request.new.execute(:apply, "/cbapi/application",
+          {query: {:HostSite => host_site}, body: data, api_options: {path: ""}})
+      end
+    end
+  end
+end

data/lib/spear/resource/job.rb

@@ -0,0 +1,20 @@
+# encoding: utf-8
+
+module Spear
+  module Resource
+    module Job
+      def search_job(params={})
+        Spear::Request.new.execute(:get, "/jobsearch", {:query => params})
+      end
+
+      # job_id:
+      #   20 character long unique job ID.
+      #   It's one of the elements received in every v1/jobsearch result item.
+      def retrieve_job(job_id, host_site)
+        raise Spear::ParametersRequired.new(%w{JobID HostSite}) if job_id.blank? or host_site.blank?
+
+        Spear::Request.new.execute(:get, "/job", {:query => {:DID => job_id, :HostSite => host_site}})
+      end
+    end
+  end
+end

data/lib/spear/resource/resume.rb

@@ -5,45 +5,59 @@ module Spear
     module Resume
       # file: kind of ActionDispatch::Http::UploadedFile
       def parse_file(file)
-        unless (file.kind_of? ActionDispatch::Http::UploadedFile) || (file.kind_of? Rack::Test::UploadedFile)
-          return {"Errors" => {"Error" => "%q{Expecting type of ActionDispatch::Http::UploadedFile or Rack::Test::UploadedFile, but got #{file.class}.}"}}
+        if !file.kind_of?(ActionDispatch::Http::UploadedFile) and !file.kind_of?(Rack::Test::UploadedFile)
+          raise Spear::ObjectTypeError.new("Expecting type of ActionDispatch::Http::UploadedFile or Rack::Test::UploadedFile, but got #{file.class}.}")
         end
 
         file.rewind
-        @request.execute(:parse_file, "/resume/parse", {:FileName => file.original_filename,
-          :FileBytes => Base64.encode64(file.read)})
+        Spear::Request.new.execute(:post, "/resume/parse", {
+          :body => {
+            :FileName => file.original_filename,
+            :FileBytes => Base64.encode64(file.read)
+          }
+        })
       end
 
-      # Required column value
-      # <ShowContactInfo>true</ShowContactInfo>
-      # <Title>asasdasdasd</Title>
-      # <ResumeText>albee009@gmail.com JobsCentral999</ResumeText>
-      # <Visibility>true</Visibility>
-      # <CanRelocateNationally>false</CanRelocateNationally>
-      # <CanRelocateInternationally>false</CanRelocateInternationally>
-      # <TotalYearsExperience>0</TotalYearsExperience>
-      # <HostSite>T3</HostSite>
-      # <DesiredJobTypes>ETFE</DesiredJobTypes>
-      # <CompanyExperiences/>
-      # <Educations/>
-      # <Languages/>
-      # <CustomValues/>
+      # {
+      #   ShowContactInfo: true,
+      #   Title: 'asasdasdasd',
+      #   ResumeText: 'albee009@gmail.com JobsCentral999',
+      #   Visibility: true,
+      #   CanRelocateNationally: false,
+      #   CanRelocateInternationally: false,
+      #   TotalYearsExperience: 1,
+      #   HostSite: 'T3',
+      #   DesiredJobTypes: 'ETFE',
+      #   CompanyExperiences: [],
+      #   Educations: [],
+      #   Languages: [],
+      #   CustomValues: []
+      # }
       def create_resume(data={})
-        @request.execute(:post, "/resume/create", data)
+        Spear::Request.new.execute(:post, "/resume/create", {body: data})
+      end
+
+      # {
+      #   ...
+      #   # if editting, we should add this column
+      #   ExternalID: 'asdasdsdaas'
+      # }
+      def edit_resume(data={})
+        Spear::Request.new.execute(:post, "/resume/edit", {body: data})
       end
 
       def upload_file(file, resume_external_id, user_external_id)
-        unless (file.kind_of? ActionDispatch::Http::UploadedFile) || (file.kind_of? Rack::Test::UploadedFile)
-          return {"Errors" => {"Error" => "%q{Expecting type of ActionDispatch::Http::UploadedFile or Rack::Test::UploadedFile, but got #{file.class}.}"}}
+        if !file.kind_of?(ActionDispatch::Http::UploadedFile) and !file.kind_of?(Rack::Test::UploadedFile)
+          raise Spear::ObjectTypeError.new("Expecting type of ActionDispatch::Http::UploadedFile or Rack::Test::UploadedFile, but got #{file.class}.}")
         end
 
-        if user_external_id.blank? or resume_external_id.blank?
-          return {"Errors" => {"Error" => "%q{User external ID and resume external ID is required.}"}}
-        end
+        raise Spear::ParametersRequired.new(%w{UserExternalId ResumeExternalId}) if user_external_id.blank? or resume_external_id.blank?
 
         file.rewind
-        @request.execute(:upload_file, "/resume/upload", {
-          :body => Base64.encode64(file.read),
+        Spear::Request.new.execute(:upload_file, "/resume/upload", {
+          :body => {
+            :FileBytes => Base64.encode64(file.read)
+          },
           :query => {
             :FileName => file.original_filename,
             :ExternalID => resume_external_id,
@@ -54,20 +68,16 @@ module Spear
 
       # list all of my resumes
       def own_all(user_external_id, host_site)
-        if user_external_id.blank? or host_site.blank?
-          return {"Errors" => {"Error" => "%q{User external ID and host site is required.}"}}
-        end
+        raise Spear::ParametersRequired.new(%w{UserExternalId HostSite}) if user_external_id.blank? or host_site.blank?
 
-        @request.execute(:get, "/resume/ownall", {
+        Spear::Request.new.execute(:get, "/resume/ownall", {
           :query => {:ExternalUserID => user_external_id, :HostSite => host_site}})
       end
 
       def retrieve_resume(resume_external_id, user_external_id)
-        if user_external_id.blank? or resume_external_id.blank?
-          return {"Errors" => {"Error" => "%q{User external ID and host site is required.}"}}
-        end
+        raise Spear::ParametersRequired.new(%w{UserExternalId ResumeExternalId}) if user_external_id.blank? or resume_external_id.blank?
 
-        @request.execute(:get, "/resume/retrieve", {
+        Spear::Request.new.execute(:get, "/resume/retrieve", {
           :query => {:ExternalUserID => user_external_id, :ExternalID => resume_external_id}})
       end
     end

data/lib/spear/resource/talent_network.rb

@@ -0,0 +1,30 @@
+# encoding: utf-8
+
+module Spear
+  module Resource
+    module TalentNetwork
+      def join_form_questions(talent_network_did)
+        raise Spear::ParametersRequired.new('TalentNetworkDID') if talent_network_did.blank?
+
+        Spear::Request.new.execute(:get, "/talentnetwork/config/join/questions/#{talent_network_did}/json",
+          {api_options: {path: ""}})
+      end
+
+      # {
+      #   TalentNetworkDID: 'YourTalentNetworkDID',
+      #   PreferredLanguage: 'USEnglish',
+      #   AcceptPrivacy: '',
+      #   AcceptTerms: '',
+      #   ResumeWordDoc: '',
+      #   JoinValues: [
+      #     {Key: 'MxDOTalentNetworkMemberInfo_EmailAddress', Value: 'some.email@example.com'},
+      #     {Key: 'JQ7I3CM6P9B09VCVD9YF', Value: 'AVAILABLENOW'}
+      #   ]
+      # }
+      def create_member(data={})
+        Spear::Request.new.execute(:post, "/talentnetwork/member/create/json",
+          {api_options: {path: ""}, body: data})
+      end
+    end
+  end
+end

data/lib/spear/resource/user.rb

@@ -5,18 +5,37 @@ module Spear
     module User
       def check_existing(email, password='')
         if password.blank?
-          @request.execute(:post, "/user/checkexisting", {:Email => email})
+          Spear::Request.new.execute(:post, "/user/checkexisting", {body: {:Email => email}})
         else
-          @request.execute(:post, "/user/checkexisting", {:Email => email, :Password => password})
+          Spear::Request.new.execute(:post, "/user/checkexisting", {body: {:Email => email, :Password => password}})
         end
       end
 
+      # {
+      #   FirstName: 'asdasdad',
+      #   LastName: 'asdasdad',
+      #   Email: 'ascacasc@sina.com.cn',
+      #   Password: 'Qwer1234!',
+      #   Phone: '+657777888999',
+      #   City: 'Singapore',
+      #   State: 'SG',
+      #   CountryCode: 'SG',
+      #   AllowNewsletterEmails: false,
+      #   HostSite: 'T3',
+      #   AllowPartnerEmails: false,
+      #   AllowEventEmails: false,
+      #   SendEmail: false,
+      #   Gender: 'U',
+      #   UserType: 'jobseeker',
+      #   Status: 'active',
+      #   Test: false
+      # }
       def create_user(data={})
-        @request.execute(:post, "/user/create", data)
+        Spear::Request.new.execute(:post, "/user/create", {body: data})
       end
 
       def retrieve_user(user_external_id, password)
-        @request.execute(:post, "/user/retrieve", {:ExternalID => user_external_id, :Password => password})
+        Spear::Request.new.execute(:post, "/user/retrieve", {body: {:ExternalID => user_external_id, :Password => password}})
       end
     end
   end

data/lib/spear/resources.rb

@@ -0,0 +1,10 @@
+# encoding: utf-8
+
+module Spear
+  module Resources
+    include Resource::User
+    include Resource::Resume
+    include Resource::Application
+    include Resource::Job
+  end
+end

data/lib/spear/structure/base.rb

@@ -0,0 +1,43 @@
+module Spear
+  module Structure
+    class Base
+      # response is an instance of Httparty::Response
+      attr_reader :response, :root, :status, :error_message
+
+      def initialize(response)
+        raise Spear::ParametersRequired.new('Response') if response.nil?
+
+        @response = response
+        # get the root keyvalue of the hash
+        @root = response.to_h.first.last
+        @status = @root["Status"]
+        @error_message = get_error_message(@root)
+      end
+
+      def success?
+        @status.nil? ? @error_message.nil? : @status.include?('Success')
+      end
+
+      private
+        def get_error_message(hash)
+          if hash["Errors"].kind_of?(Hash)
+            if !hash["Errors"]["Error"].kind_of?(Hash)
+              # 1. Api error response is an array
+              if hash["Errors"]["Error"].kind_of?(Array)
+                return hash["Errors"]["Error"].join(", ")
+              end
+              # 2. Api error response is a string
+              return hash["Errors"]["Error"]
+            else
+              # 3. Api error response is a hash
+              if !hash["Errors"]["Error"]["Message"].nil?
+                return hash["Errors"]["Error"]["Message"]
+              end
+            end
+          elsif hash["Errors"].kind_of?(Array)
+            return hash["Errors"].first
+          end
+        end
+    end
+  end
+end

data/lib/spear/structure/resume/create.rb

@@ -0,0 +1,17 @@
+module Spear
+  module Structure
+    module Resume
+      class Create < Structure::Base
+        attr_reader :external_id, :user_external_id
+        attr_accessor :title, :total_years_experience, :educations, :company_experiences
+
+        def initialize(response)
+          super(response)
+          @external_id = @root['ResponseExternalID']
+          @user_external_id = @root['Request']['ExternalUserID']
+          @title = @root['Request']['Title']
+        end
+      end
+    end
+  end
+end

data/lib/spear/structure/resume/edit.rb

@@ -0,0 +1,17 @@
+module Spear
+  module Structure
+    module Resume
+      class Edit < Structure::Base
+        attr_reader :external_id, :user_external_id
+        attr_accessor :title,  :total_years_experience, :educations, :company_experiences
+
+        def initialize(response)
+          super(response)
+          @external_id = @root['Request']['ExternalID']
+          @user_external_id = @root['Request']['ExternalUserID']
+          @title = @root['Request']['Title']
+        end
+      end
+    end
+  end
+end

data/lib/spear/structure/resume/embeded_class.rb

@@ -0,0 +1,62 @@
+# TODO: Extract Languages and EmployerOrgs ...
+module Spear
+  module Structure
+    module Resume
+      module EmbededClass
+        ##################################################################
+        # Resume embeded class
+        ##################################################################
+        class Education
+          attr_accessor :school_name, :major, :degree_name, :degree_code, :degree_type, :graduation_date
+
+          def initialize(education={})
+            @school_name = education['SchoolName']
+            @major = education['Major']
+            @degree_name = education['DegreeName']
+            @degree_code = education['DegreeCode']
+            @degree_type = education['DegreeType']
+            @graduation_date = education['GraduationDate']
+          end
+        end
+
+        def generate_educations(educations)
+          if !educations.nil?
+            if educations['Education'].kind_of?(Array)
+              educations['Education'].map {|e| Education.new(e)}
+            else  # Hash
+              [Education.new(educations['Education'])]
+            end
+          else
+            []
+          end
+        end
+
+        class CompanyExperience
+          # Date must more than 1970-01-01
+          attr_accessor :company_name, :job_title, :start_date, :end_date, :details, :is_current
+
+          def initialize(experience={})
+            @company_name = experience['CompanyName']
+            @job_title = experience['JobTitle']
+            @start_date = experience['StartDate']
+            @end_date = experience['EndDate']
+            @details = experience['Details']
+            @is_current = %w(True ture).include?(experience['IsCurrent'])
+          end
+        end
+
+        def generate_experiences(company_experiences)
+          if !company_experiences.nil?
+            if company_experiences['CompanyExperience'].kind_of?(Array)
+              company_experiences['CompanyExperience'].map {|e| CompanyExperience.new(e)}
+            else  # Hash
+              [CompanyExperience.new(company_experiences['CompanyExperience'])]
+            end
+          else
+            []
+          end
+        end
+      end
+    end
+  end
+end

data/lib/spear/structure/resume/ownall.rb

@@ -0,0 +1,28 @@
+module Spear
+  module Structure
+    module Resume
+      class Ownall < Structure::Base
+        attr_reader :resumes
+
+        def initialize(response)
+          super(response)
+          @resumes = extract_resume(@root['Resumes'])
+        end
+
+        private
+          def extract_resume(resumes, list=[])
+            unless resumes.nil?
+              if resumes['Resume'].kind_of?(Array)
+                resumes['Resume'].each do |resume|
+                  list << resume
+                end
+              elsif resumes['Resume'].kind_of?(Hash)
+                list << resumes['Resume']
+              end
+            end
+            list
+          end
+      end
+    end
+  end
+end

data/lib/spear/structure/resume/parse.rb

@@ -0,0 +1,80 @@
+module Spear
+  module Structure
+    module Resume
+      # after parse resume, we will call create resume api. So in this class, we will build
+      # the data class structure 'Create resume' needs.
+      class Parse < Structure::Base
+        include EmbededClass
+
+        attr_reader :resume, :hrxml_resume
+        attr_accessor :educations, :company_experiences, :employer_orgs, :languages, :custom_values
+        attr_accessor :resume_text, :total_years_experience
+
+        def initialize(response)
+          super(response)
+          @resume = @root['Resume'] || {}
+          @hrxml_resume = @resume['HRXMLResume']
+
+          @resume_text = @resume['ResumeText'] || ''
+          @total_years_experience = (@resume['TotalYearsExperience'].to_i rescue 0)
+          @educations = generate_educations(@resume['Educations'])
+          @company_experiences = generate_experiences(@resume['CompanyExperiences'])
+        end
+
+        def hash_for_create(external_user_id, host_site)
+          raise Spear::ParametersRequired.new(%w{UserExternalId HostSite}) if external_user_id.blank? or host_site.blank?
+
+          # Max Educations are 3
+          educations = []
+          @educations.each_with_index do |e, index|
+            break if index > 2
+            edu = {}
+            edu[:SchoolName] = e.school_name || ""
+            edu[:Major] = e.major || ""
+            edu[:DegreeCode] = e.degree_code || ""
+            edu[:GraduationDate] = e.graduation_date unless e.graduation_date.blank?
+            educations << edu
+          end
+
+          # Max CompanyExperiences are 5
+          company_experiences = []
+          @company_experiences.each_with_index do |ce, index|
+            break if index > 4
+            cen = {}
+            cen[:CompanyName] = ce.company_name || ""
+            cen[:JobTitle] = ce.job_title || ""
+            if ce.start_date.blank?
+              cen[:StartDate] = '1970-01-01'
+            else
+              cen[:StartDate] = ce.start_date
+            end
+            if ce.end_date.blank?
+              cen[:EndDate] = Time.now.strftime("%Y-%m-%d").to_s
+            else
+              cen[:EndDate] = ce.end_date
+            end
+            cen[:Details] = ce.details || ""
+            company_experiences << cen
+          end
+
+          {
+            :ExternalUserID => external_user_id,
+            :ShowContactInfo => true,
+            :Title => 'title',
+            :ResumeText => @resume_text,
+            :Visibility => 'Public',
+            :CanRelocateNationally => false,
+            :CanRelocateInternationally => false,
+            :TotalYearsExperience => @total_years_experience.to_s,
+            :HostSite => host_site,
+            :DesiredJobTypes => 'ETFE',
+            :CompanyExperiences => company_experiences,
+            :Educations => educations,
+            :Languages => [],
+            :CustomValues => []
+          }
+        end
+      end
+    end
+  end
+end