spear-cb-api 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 572c44d8a917c806d6cc051ec15a1718f18bf0e8
-  data.tar.gz: c1a4a9002901cfd850f11c9818afaf7f7fef340b
+  metadata.gz: 99a2043f153e08a27aca5f2460d0c8e740f54820
+  data.tar.gz: b6860970868165b0524d84f8405e7ce141e99234
 SHA512:
-  metadata.gz: 2def3db8234e53e22b19122a937c2675c4e754bfe270db980cf44eeafe323479176f7239f9c88c96211adf010c3810e044b232ae21d3c8830e2cbb67813d8bac
-  data.tar.gz: 02c44672205e3af0bc2cc8c91459efe0fe93056b98efd8a4faf49d49a9927e58c900934f2fff1088bf24aabb10a37063e9f9cd18bc5a65e471944c66cc39b523
+  metadata.gz: 1a0125557056f2a98096a3b604523e38259adfa5303c112bdfc2b2a27ac302f1e5291c61b3679ee1a1c04b43321a9ac60bf207cc1e71847c78312cd0700967e6
+  data.tar.gz: 4a62e65fe56416e23b67c06270f6f099f5f51bc7e6261816b4635b71da873fc42d01dbb44363efa2da8c2449be101b8140af49280e2e0b5681de4846e6fb7cdc

data/lib/spear.rb

@@ -36,6 +36,8 @@ module Spear
     end
 
     module Application
+      autoload :Create, 'spear/structure/application/create'
+      autoload :History, 'spear/structure/application/history'
     end
 
     module Job
@@ -45,6 +47,9 @@ module Spear
     end
 
     module TalentNetwork
+      autoload :EmbededClass, 'spear/structure/talent_network/embeded_class'
+      autoload :CreateMember, 'spear/structure/talent_network/create_member'
+      autoload :JoinFormQuestion, 'spear/structure/talent_network/join_form_question'
     end
   end
 

data/lib/spear/configuration.rb

@@ -1,12 +1,10 @@
 module Spear
   module Configuration
-    include Resources
-
     @@options = {}
 
     # use https or http
     def ssh?
-      @@options[:use_ssh] || true
+      @@options[:use_ssh].nil? ? true : @@options[:use_ssh]
     end
 
     def hostname
@@ -22,7 +20,7 @@ module Spear
     end
 
     def test?
-      @@options[:use_test] || false
+      @@options[:use_test].nil? ? false : @@options[:use_test]
     end
 
     def dev_key
@@ -31,11 +29,11 @@ module Spear
 
     # need save api info
     def save_api?
-      @@options[:saving_api] || false
+      @@options[:saving_api].nil? ? false : @@options[:saving_api]
     end
 
     def use_model?
-      @@options[:using_model] || false
+      @@options[:using_model].nil? ? false : @@options[:using_model]
     end
 
     def project
@@ -59,7 +57,13 @@ module Spear
     private
       def include_plugins
         Request.include Plugins::SaveApis if save_api?
-        Spear.extend Plugins::Models if use_model?
+
+        if use_model?
+          Spear.extend Plugins::Models
+        else
+          Spear.extend Resources
+        end
+
         # Spear.extend Dummy if use_dummy?
       end
 

data/lib/spear/plugins/model/application.rb

@@ -2,6 +2,18 @@ module Spear
   module Plugins
     module Model
       module Application
+        include Resource::Application
+
+        def history(user_external_id)
+          response = super(user_external_id)
+          Structure::Application::History.new(response)
+        end
+
+        # Application Creation
+        def create_application(host_site, data={})
+          response = super(host_site, data)
+          Structure::Application::Create.new(response)
+        end
       end
     end
   end

data/lib/spear/plugins/model/job.rb

@@ -2,6 +2,8 @@ module Spear
   module Plugins
     module Model
       module Job
+        include Resource::Job
+
         def search_job(params={})
           response = super(params)
           Structure::Job::Search.new(response)

data/lib/spear/plugins/model/resume.rb

@@ -2,6 +2,8 @@ module Spear
   module Plugins
     module Model
       module Resume
+        include Resource::Resume
+
         def parse_file(file)
           response = super(file)
           Structure::Resume::Parse.new(response)

data/lib/spear/plugins/model/talent_network.rb

@@ -2,6 +2,17 @@ module Spear
   module Plugins
     module Model
       module TalentNetwork
+        include Resource::TalentNetwork
+
+        def join_form_questions(talent_network_did)
+          response = super(talent_network_did)
+          Structure::TalentNetwork::JoinFormQuestion.new(response)
+        end
+
+        def create_member(data={})
+          response = super(data)
+          Structure::TalentNetwork::CreateMember.new(response)
+        end
       end
     end
   end

data/lib/spear/plugins/model/user.rb

@@ -2,6 +2,8 @@ module Spear
   module Plugins
     module Model
       module User
+        include Resource::User
+
         def check_existing(email, password='')
           response = super(email, password)
           Structure::User::CheckExisting.new(response)

data/lib/spear/request.rb

@@ -6,11 +6,21 @@ module Spear
     extend ActiveModel::Callbacks
     define_model_callbacks :execute, :only => [:before, :after]
 
+    attr_accessor :method, :query, :body, :api_options, :url
+
     # params: {:body => {}, :query => {}, :api_options => {}}
     #   exp: api_options: {:path => "/v1"}
-    def execute(method, endpoint, params={})
+    def initialize(method, endpoint, params={})
+      @method = method
+      @query = params[:query] || {}
+      @body = params[:body] || {}
+      @api_options = params[:api_options] || {}
+      @url = generate_resource + endpoint
+    end
+
+    def execute
       run_callbacks(:execute) {
-        response = exec(method, endpoint, params)
+        response = exec
         begin
           self.api_response = response
         rescue NoMethodError => e  # if we don't use save api info plugin, it'll throw NoMethodError.
@@ -20,24 +30,19 @@ module Spear
     end
 
     private
-      def exec(method, endpoint, params={})
-        query = params[:query] || {}
-        body = params[:body] || {}
-        api_options = params[:api_options] || {}
-        url = generate_resource(api_options) + endpoint
-
+      def exec
         begin
-          case method
+          case @method
           when :get
-            HTTParty.get(url, query: splice_query(query))
+            HTTParty.get(@url, query: splice_query)
           when :post
-            HTTParty.post(url, body: splice_body(body), query: query)
+            HTTParty.post(@url, body: splice_body, query: @query)
           when :upload_file
-            HTTParty.post(url, body: body, query: splice_query(query))
+            HTTParty.post(@url, body: @body, query: splice_query)
           when :parse_file
-            HTTParty.post(url, body: splice_body(body))
+            HTTParty.post(@url, body: splice_body)
           when :apply
-            HTTParty.post(url, body: to_xml(body), query: splice_query(query))
+            HTTParty.post(@url, body: to_xml(@body), query: splice_query)
           else
             raise Spear::ParametersNotValid.new("#{method} is not support.")
           end
@@ -47,27 +52,27 @@ module Spear
       end
 
       # generate cb api host and version
-      def generate_resource(api_options)
+      def generate_resource
         uri = URI("")
         uri.scheme = Spear.ssh? ? 'https' : 'http'
         uri.host = Spear.hostname
         uri.port = Spear.port
 
         # Some api endpoint have no version and fixed pattern.
-        if api_options[:path].nil?
+        if @api_options[:path].nil?
           uri.path = "/#{Spear.version}"
         else
-          uri.path = "/#{api_options[:path]}"
+          uri.path = "#{@api_options[:path]}"
         end
 
         uri.to_s
       end
 
       # splice request body
-      def splice_body(body, xml=true)
-        body[:DeveloperKey] = Spear.dev_key
-        body[:Test] = Spear.test?
-        xml ? to_xml(body) : body
+      def splice_body
+        @body[:DeveloperKey] = Spear.dev_key
+        @body[:Test] = Spear.test? if need_test_key?
+        to_xml(@body)
       end
 
       # parse body from hash to xml format
@@ -76,10 +81,14 @@ module Spear
       end
 
       # splice query(url params) {:query => {}} with DeveloperKey and Test
-      def splice_query(query)
-        query[:DeveloperKey] = Spear.dev_key
-        query[:Test] = Spear.test?
-        query
+      def splice_query
+        @query[:DeveloperKey] = Spear.dev_key
+        @query[:Test] = Spear.test?  if need_test_key?
+        @query
+      end
+
+      def need_test_key?
+        @api_options[:need_test_key].nil? ? true : @api_options[:need_test_key]
       end
 
   end

data/lib/spear/resource/application.rb

@@ -1,21 +1,20 @@
-# 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'}})
+        Spear::Request.new(:get, "/application/history",
+          {query: {:ExternalID => user_external_id}, api_options: {path: '/v1'}}).execute
       end
 
       # Application Creation
       def create_application(host_site, data={})
         raise Spear::ParametersRequired.new('HostSite') if host_site.blank?
+        raise Spear::ParametersRequired.new(%w{JobID Resume Responses}) if data[:JobDID].blank? or data[:Resume].nil? or data[:Responses].nil?
 
-        Spear::Request.new.execute(:apply, "/cbapi/application",
-          {query: {:HostSite => host_site}, body: data, api_options: {path: ""}})
+        Spear::Request.new(:apply, '',
+          {query: {:HostSite => host_site}, body: data, api_options: {path: "/cbapi/application"}}).execute
       end
     end
   end

data/lib/spear/resource/job.rb

@@ -1,10 +1,8 @@
-# encoding: utf-8
-
 module Spear
   module Resource
     module Job
       def search_job(params={})
-        Spear::Request.new.execute(:get, "/jobsearch", {:query => params})
+        Spear::Request.new(:get, "/jobsearch", {:query => params}).execute
       end
 
       # job_id:
@@ -13,7 +11,7 @@ module Spear
       def retrieve_job(job_id)
         raise Spear::ParametersRequired.new('JobID') if job_id.blank?
 
-        Spear::Request.new.execute(:get, "/job", {:query => {:DID => job_id}})
+        Spear::Request.new(:get, "/job", {:query => {:DID => job_id}}).execute
       end
     end
   end

data/lib/spear/resource/resume.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module Spear
   module Resource
     module Resume
@@ -10,40 +8,22 @@ module Spear
         end
 
         file.rewind
-        Spear::Request.new.execute(:post, "/resume/parse", {
+        Spear::Request.new(:post, "/resume/parse", {
           :body => {
             :FileName => file.original_filename,
             :FileBytes => Base64.encode64(file.read)
           }
-        })
+        }).execute
       end
 
-      # {
-      #   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={})
-        Spear::Request.new.execute(:post, "/resume/create", {body: data})
+        Spear::Request.new(:post, "/resume/create", {body: data}).execute
       end
 
-      # {
-      #   ...
-      #   # if editting, we should add this column
-      #   ExternalID: 'asdasdsdaas'
-      # }
       def edit_resume(data={})
-        Spear::Request.new.execute(:post, "/resume/edit", {body: data})
+        raise Spear::ParametersRequired.new('Resume ExternalId') if data[:ExternalID].blank?
+
+        Spear::Request.new(:post, "/resume/edit", {body: data}).execute
       end
 
       def upload_file(file, resume_external_id, user_external_id)
@@ -54,7 +34,7 @@ module Spear
         raise Spear::ParametersRequired.new(%w{UserExternalId ResumeExternalId}) if user_external_id.blank? or resume_external_id.blank?
 
         file.rewind
-        Spear::Request.new.execute(:upload_file, "/resume/upload", {
+        Spear::Request.new(:upload_file, "/resume/upload", {
           :body => {
             :FileBytes => Base64.encode64(file.read)
           },
@@ -63,22 +43,22 @@ module Spear
             :ExternalID => resume_external_id,
             :ExternalUserID => user_external_id
           }
-        })
+        }).execute
       end
 
       # list all of my resumes
       def own_all(user_external_id, host_site)
         raise Spear::ParametersRequired.new(%w{UserExternalId HostSite}) if user_external_id.blank? or host_site.blank?
 
-        Spear::Request.new.execute(:get, "/resume/ownall", {
-          :query => {:ExternalUserID => user_external_id, :HostSite => host_site}})
+        Spear::Request.new(:get, "/resume/ownall", {
+          :query => {:ExternalUserID => user_external_id, :HostSite => host_site}}).execute
       end
 
       def retrieve_resume(resume_external_id, user_external_id)
         raise Spear::ParametersRequired.new(%w{UserExternalId ResumeExternalId}) if user_external_id.blank? or resume_external_id.blank?
 
-        Spear::Request.new.execute(:get, "/resume/retrieve", {
-          :query => {:ExternalUserID => user_external_id, :ExternalID => resume_external_id}})
+        Spear::Request.new(:get, "/resume/retrieve", {
+          :query => {:ExternalUserID => user_external_id, :ExternalID => resume_external_id}}).execute
       end
     end
   end

data/lib/spear/resource/talent_network.rb

@@ -1,29 +1,16 @@
-# 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: ""}})
+        Spear::Request.new(:get, '',
+          {api_options: {path: "/talentnetwork/config/join/questions/#{talent_network_did}/json"}}).execute
       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})
+        Spear::Request.new(:post, '', {api_options:
+          {path: "/talentnetwork/member/create/json", :need_test_key => false}, body: data}).execute
       end
     end
   end

data/lib/spear/resource/user.rb

@@ -1,41 +1,20 @@
-# encoding: utf-8
-
 module Spear
   module Resource
     module User
       def check_existing(email, password='')
         if password.blank?
-          Spear::Request.new.execute(:post, "/user/checkexisting", {body: {:Email => email}})
+          Spear::Request.new(:post, "/user/checkexisting", {body: {:Email => email}}).execute
         else
-          Spear::Request.new.execute(:post, "/user/checkexisting", {body: {:Email => email, :Password => password}})
+          Spear::Request.new(:post, "/user/checkexisting", {body: {:Email => email, :Password => password}}).execute
         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={})
-        Spear::Request.new.execute(:post, "/user/create", {body: data})
+        Spear::Request.new(:post, "/user/create", {body: data}).execute
       end
 
       def retrieve_user(user_external_id, password)
-        Spear::Request.new.execute(:post, "/user/retrieve", {body: {:ExternalID => user_external_id, :Password => password}})
+        Spear::Request.new(:post, "/user/retrieve", {body: {:ExternalID => user_external_id, :Password => password}}).execute
       end
     end
   end

data/lib/spear/resources.rb

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

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

@@ -0,0 +1,19 @@
+module Spear
+  module Structure
+    module Application
+      class Create < Structure::Base
+        attr_reader :total_results, :returned_results
+
+        attr_accessor :results
+
+        def initialize(response)
+          super(response)
+
+          @total_results = @root["TotalResults"]
+          @returned_results = @root["ReturnedResults"]
+          @results = @root["Results"]
+        end
+      end
+    end
+  end
+end

data/lib/spear/structure/application/history.rb

@@ -0,0 +1,11 @@
+module Spear
+  module Structure
+    module Application
+      class History < Structure::Base
+        def initialize(response)
+          super(response)
+        end
+      end
+    end
+  end
+end

data/lib/spear/structure/base.rb

@@ -9,7 +9,11 @@ module Spear
 
         @response = response
         # get the root keyvalue of the hash
-        @root = response.to_h.first.last
+        if response.to_h.has_key?('Errors')
+          @root = response.to_h
+        else
+          @root = response.to_h.first.last
+        end
         @status = @root["Status"]
         @error_message = get_error_message(@root)
       end

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

@@ -1,4 +1,3 @@
-# TODO: Extract Languages and EmployerOrgs ...
 module Spear
   module Structure
     module Job

data/lib/spear/structure/job/retrieve.rb

@@ -7,7 +7,10 @@ module Spear
 
         def initialize(response)
           super(response)
-          @job_id = response.request.options[:query][:DID]
+
+          if response.kind_of?(HTTParty::Response)
+            @job_id = response.request.options[:query][:DID]
+          end
 
           unless @root["Job"].nil?
             @job_description = @root["Job"]["JobDescription"]

data/lib/spear/structure/job/search.rb

@@ -9,7 +9,10 @@ module Spear
 
         def initialize(response)
           super(response)
-          @tn_did = response.request.options[:query][:TalentNetworkDID]
+
+          if response.kind_of?(HTTParty::Response)
+            @tn_did = response.request.options[:query][:TalentNetworkDID]
+          end
 
           job_search_result = @root['Results'].nil? ? [] : @root['Results']['JobSearchResult']
           @jobs = generate_jobs(job_search_result, @tn_did)

data/lib/spear/structure/talent_network/create_member.rb

@@ -0,0 +1,15 @@
+module Spear
+  module Structure
+    module TalentNetwork
+      class CreateMember < Structure::Base
+        attr_reader :member_did
+
+        def initialize(response)
+          super(response)
+          @member_did = @root['MemberDID']
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+module Spear
+  module Structure
+    module TalentNetwork
+      module EmbededClass
+        ##################################################################
+        # Resume embeded class
+        ##################################################################
+        class JoinQuestion
+          attr_accessor :text, :required, :form_value, :option_display_type, :order, :options
+
+          def initialize(question)
+            @text = question['Text']
+            @required = question['Required']
+            @form_value = question['FormValue']
+            @option_display_type = question['OptionDisplayType']
+            @order = question['Order']
+            @options = question['Options']
+          end
+        end
+
+        def generate_questions(questions)
+          if !questions.nil?
+            if questions.kind_of?(Array)
+              questions.map {|question| JoinQuestion.new(question)}
+            else  # Hash
+              [JoinQuestion.new(questions)]
+            end
+          else
+            []
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/spear/structure/talent_network/join_form_question.rb

@@ -0,0 +1,17 @@
+module Spear
+  module Structure
+    module TalentNetwork
+      class JoinFormQuestion < Structure::Base
+        include EmbededClass
+
+        attr_accessor :join_questions
+
+        def initialize(response)
+          super(response)
+          @join_questions = generate_questions(@root["JoinQuestions"])
+        end
+
+      end
+    end
+  end
+end

data/lib/spear/version.rb

@@ -1,3 +1,3 @@
 module Spear
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

data/spec/spear_spec.rb

@@ -5,26 +5,46 @@ describe Spear do
 
   it "check user existing" do
     s = Spear.check_existing('zhangfei@163.com.cn', '111111111')
-    puts s
+    puts s.response
   end
 
   it "application history" do
     s = Spear.history('XRHR3NV6S8SK6DJ0GKSD')
-    puts s
+    puts s.response
   end
 
   it 'search job' do
     s = Spear.search_job({:TalentNetworkDID => 'TN818G76D6YWYNBXHB3Z', :SiteEntity => 'TalentNetworkJob', :CountryCode => 'IN'})
-    puts s.jobs.last.nil? ? 'nil' : s.jobs.last.posted_date
+    puts s.response
   end
 
   it "retrieve job" do
     s = Spear.retrieve_job('J3J4BP6MGVH2DJZ6MJH')
-    puts s.job_description
+    puts s.response
   end
 
   it "create application" do
-    s = Spear.create_application('IN')
-    puts s
+    s = Spear.create_application('IN', {JobDID: 'xxx', Resume: {ResumeTitle: 'title'}, Responses: [{QuestionID: 'id', ResponseText: 'text'}]})
+    puts s.response
+  end
+
+  it "tn join form question" do
+    s = Spear.join_form_questions('TN818G76D6YWYNBXHB3Z')
+    puts s.response
+  end
+
+  it "tn create member" do
+    s = Spear.create_member({
+      TalentNetworkDID: 'TN818G76D6YWYNBXHB3Z',
+      PreferredLanguage: 'USEnglish',
+      AcceptPrivacy: false,
+      AcceptTerms: false,
+      ResumeWordDoc: '',
+      JoinValues: [
+        {Key: 'MxDOTalentNetworkMemberInfo_EmailAddress', Value: 'some.email@example.com'},
+        {Key: 'JQ7I3CM6P9B09VCVD9YF', Value: 'AVAILABLENOW'}
+      ]
+    })
+    puts s.response
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spear-cb-api
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - CBluowei
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-02 00:00:00.000000000 Z
+date: 2015-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: builder
@@ -158,6 +158,8 @@ files:
 - lib/spear/resource/talent_network.rb
 - lib/spear/resource/user.rb
 - lib/spear/resources.rb
+- lib/spear/structure/application/create.rb
+- lib/spear/structure/application/history.rb
 - lib/spear/structure/base.rb
 - lib/spear/structure/job/embeded_class.rb
 - lib/spear/structure/job/retrieve.rb
@@ -169,6 +171,9 @@ files:
 - lib/spear/structure/resume/parse.rb
 - lib/spear/structure/resume/retrieve.rb
 - lib/spear/structure/resume/upload.rb
+- lib/spear/structure/talent_network/create_member.rb
+- lib/spear/structure/talent_network/embeded_class.rb
+- lib/spear/structure/talent_network/join_form_question.rb
 - lib/spear/structure/user/check_existing.rb
 - lib/spear/structure/user/create.rb
 - lib/spear/structure/user/retrieve.rb