workable 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f79182d801ebc90eb4f72ff018f5963b67d6e619
-  data.tar.gz: 84d6252a9b5f2cbe24254b0bea3997908c77188e
+  metadata.gz: 00c9c45350f524e1d18031f7d20666e40d4a9302
+  data.tar.gz: 0250bd9e919ddc827ce4e55e7c815d92276fa8a0
 SHA512:
-  metadata.gz: bc72c0fbb34291527fd66ebdce1e02c53edd6af4f040989d9f0207e8b0a09b7582c728e8d4f5f904956930b50d279ade62cc97da3419b5219ccee3ace483cdb9
-  data.tar.gz: 599d72ac71fa533f05f4ad8d4ad041a50c5c413c923f84267a49d219e9c4e2364b4fe3a5ab94b872a7c74a8a8f983d32d13366031b85a9e790a6e2c7d7b444a8
+  metadata.gz: 829b209a894014d59465119e3bae09aeb640dc065cc71ac92683f2382199b3ffb36449c7d66fe4cfe830c76970a2f0d0eb86155e3058f2b56a63c3d615642737
+  data.tar.gz: a156cdc5e1b037cedd6934787c8e39116798bb145edaa476878c5d5d9426a3910dc02cdf1b3cff7c2c69f11e9b2d12f669b0aa16d0e03ff70634519b25027480

data/.travis.yml

@@ -4,11 +4,10 @@ cache: bundler
 
 rvm:
   - 2.1.10
-  - 2.2.7
-  - 2.3.4
-  - 2.4.1
-  - jruby-head
-  - ruby-head
+  - 2.2.8
+  - 2.3.5
+  - 2.4.2
+  - jruby-9.1.6.0
 
 # https://github.com/travis-ci/travis-ci/issues/5861
 before_install:

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 2.2.0
+
+Date: 2017-11-09
+
+- manage candidates endpoints support [#12](https://github.com/emq/workable/pull/12) (@aquateen)
+
 ## 2.1.0
 
 Date: 2017-06-19

data/README.md

@@ -56,6 +56,8 @@ shortcode = client.jobs.first["shortcode"]
 
 client.stages     # => Array of hashes
 client.recruiters # => Array of hashes
+client.members    # => Array of hashes
+
 client.job_details(shortcode)    # => Hash
 client.job_questions(shortcode)  # => Array of hashes
 client.job_application_form(shortcode) # => Hash
@@ -68,6 +70,15 @@ client.job_candidates(shortcode, :stage => stage_slug, :limit => 100) # => Array
 
 client.create_job_candidate(candidate, shortcode, stage_slug) # => Hash (stage_slug is optional)
 
+# managing candidates
+client.disqualify(candidate_id, member_id, reason)
+client.revert(candidate_id, member_id) # reverts disqualification
+client.copy(candidate_id, member_id, shortcode, stage)
+client.relocate(candidate_id, member_id, shortcode, stage)
+client.move(candidate_id, member_id, stage)
+client.create_rating(candidate_id, member_id, comment, score)
+client.create_comment(candidate_id, member_id, comment_text, attachment)
+
 # Possible errors (each one inherits from Workable::Errors::WorkableError)
 Workable::Errors::InvalidConfiguration # missing api_key / subdomain
 Workable::Errors::NotAuthorized   # wrong api key

data/lib/workable.rb

@@ -4,6 +4,7 @@ require 'net/http'
 require 'date'
 require 'ostruct'
 require 'cgi'
+require 'forwardable'
 
 require_relative 'workable/version'
 require_relative 'workable/errors'

data/lib/workable/client.rb

@@ -133,6 +133,106 @@ module Workable
       @transform_to.apply(:candidate, response['candidate'])
     end
 
+    # create a comment on the candidate's timeline
+    # @param candidate_id [String] the candidate's id
+    # @param member_id [String] id of the member leaving the comment
+    # @param comment_text [String] the comment's text
+    # @param policy [String] option to set the view rights of the comment
+    # @param attachment [Hash] optional attachment for the comment
+    # @param attachment :name [String] filename of the attachment
+    # @param attachment :data [String] payload of the attachment, encoded in base64
+    def create_comment(candidate_id, member_id, comment_text, policy = [], attachment = nil)
+      comment = { body: comment_text, policy: policy, attachment: attachment }
+
+      post_request("candidates/#{candidate_id}/comments") do |request|
+        request.body = { member_id: member_id, comment: comment }.to_json
+      end
+    end
+
+    # disqualify a candidate
+    # @param candidate_id [String] the candidate's id
+    # @param member_id [String] id of the member performing the disqualification
+    # @param reason [String] why the candidate should be disqualified
+    def disqualify(candidate_id, member_id, reason = nil)
+      post_request("candidates/#{candidate_id}/disqualify") do |request|
+        request.body = { member_id: member_id, disqualification_reason: reason }.to_json
+      end
+    end
+
+    # revert a candidate's disqualification
+    # @param candidate_id [String] the candidate's id
+    # @param member_id [String] id of the member reverting the disqualification
+    def revert(candidate_id, member_id)
+      post_request("candidates/#{candidate_id}/revert") do |request|
+        request.body = { member_id: member_id }.to_json
+      end
+    end
+
+    # copy a candidate to another job
+    # @param candidate_id [String] the candidate's id
+    # @param member_id [String] id of the member performing the copy
+    # @param shortcode [String] shortcode of the job that the candidate will be copied to
+    # @param stage [String] stage the candidate should be copied to
+    def copy(candidate_id, member_id, shortcode, stage = nil)
+      body = {
+        member_id: member_id,
+        target_job_shortcode: shortcode,
+        target_stage: stage
+      }
+
+      response = post_request("candidates/#{candidate_id}/copy") do |request|
+        request.body = body.to_json
+      end
+
+      @transform_to.apply(:candidate, response['candidate'])
+    end
+
+    # moves a candidate to another job
+    # @param candidate_id [Number|String] the candidate's id
+    # @param member_id [Number|String] id of the member performing the relocation
+    # @param shortcode [String] shortcode of the job that the candidate will be moved to
+    # @param stage [String] stage the candidate should be moved to
+    def relocate(candidate_id, member_id, shortcode, stage = nil)
+      body = {
+        member_id: member_id,
+        target_job_shortcode: shortcode,
+        target_stage: stage
+      }
+
+      response = post_request("candidates/#{candidate_id}/relocate") do |request|
+        request.body = body.to_json
+      end
+
+      @transform_to.apply(:candidate, response['candidate'])
+    end
+
+    # moves a candidate to another stage
+    # @param candidate_id [String] the candidate's id
+    # @param member_id [String] id of the member performing the move
+    # @param stage [String] stage the candidate should be moved to
+    def move(candidate_id, member_id, stage)
+      post_request("candidates/#{candidate_id}/move") do |request|
+        request.body = { member_id: member_id, target_stage: stage }.to_json
+      end
+    end
+
+    # creates a rating for a candidate
+    # @param candidate_id [String] the candidate's id
+    # @param member_id [String] id of the member adding the rating
+    # @param comment [String] a comment about the scoring of the candidate
+    # @param score [String] one of 'negative', 'positive', or 'definitely'
+    def create_rating(candidate_id, member_id, comment, score)
+      body = {
+        member_id: member_id,
+        comment: comment,
+        score: score
+      }
+
+      post_request("candidates/#{candidate_id}/ratings") do |request|
+        request.body = body.to_json
+      end
+    end
+
     private
 
     attr_reader :api_key, :subdomain
@@ -177,7 +277,7 @@ module Workable
       when 204, 205
         nil
       when 200...300
-        JSON.parse(response.body)
+        JSON.parse(response.body) if !response.body.to_s.empty?
       when 401
         fail Errors::NotAuthorized, JSON.parse(response.body)['error']
       when 404

data/lib/workable/version.rb

@@ -1,3 +1,3 @@
 module Workable
-  VERSION = '2.1.0'
+  VERSION = '2.2.0'
 end

data/spec/fixtures.rb

@@ -41,14 +41,22 @@ def members_json_fixture
   read_fixture 'members.json'
 end
 
-def new_candiate_hash_fixture
+def new_candidate_hash_fixture
   JSON.parse(read_fixture('new_candidate.json'))
 end
 
-def new_candiate_response_json_fixture
+def new_candidate_response_json_fixture
   read_fixture 'new_candidate_response.json'
 end
 
+def copy_candidate_response_json_fixture
+  read_fixture 'copy_candidate_response.json'
+end
+
+def relocate_candidate_response_json_fixture
+  read_fixture 'relocate_candidate_response.json'
+end
+
 def read_fixture(filename)
   File.read File.expand_path("../fixtures/#{filename}", __FILE__)
 end

data/spec/fixtures/copy_candidate_response.json

@@ -0,0 +1,6 @@
+{
+  "candidate": {
+    "id": "123456",
+    "url": "https://www.workable.com/spi/v3/accounts/subdomain/candidates/123456"
+  }
+}

data/spec/fixtures/relocate_candidate_response.json

@@ -0,0 +1,6 @@
+{
+  "candidate": {
+    "id": "123456",
+    "url": "https://www.workable.com/spi/v3/accounts/subdomain/candidates/123456"
+  }
+}

data/spec/lib/workable/client_spec.rb

@@ -148,11 +148,11 @@ describe Workable::Client do
       expect(form).to be_kind_of(Hash)
       expect(form.has_key?('questions')).to eq true
       expect(form['form_fields'][0]).to eq({
-                                            'key' => 'phone',
-                                            'label' => 'Phone',
-                                            'type' => 'string',
-                                            'required' => true
-                                           })
+        'key' => 'phone',
+        'label' => 'Phone',
+        'type' => 'string',
+        'required' => true
+      })
 
     end
   end
@@ -190,7 +190,7 @@ describe Workable::Client do
   describe '#job_candidates' do
     context 'happy path' do
       let(:candidates){ client.job_candidates('03FF356C8B') }
-    before do
+      before do
         stub_request(:get, 'https://www.workable.com/spi/v3/accounts/subdomain/jobs/03FF356C8B/candidates')
           .to_return(status: 200, body: job_candidates_json_fixture)
       end
@@ -233,11 +233,159 @@ describe Workable::Client do
   describe '#create_job_candidate' do
     it 'POSTs requests and parses response' do
       stub_request(:post, 'https://www.workable.com/spi/v3/accounts/subdomain/jobs/slug/candidates')
-        .with(body: new_candiate_hash_fixture.to_json)
-        .to_return(status: 200, body: new_candiate_response_json_fixture)
+        .with(body: new_candidate_hash_fixture.to_json)
+        .to_return(status: 200, body: new_candidate_response_json_fixture)
 
-      candidate = client.create_job_candidate(new_candiate_hash_fixture, 'slug')
+      candidate = client.create_job_candidate(new_candidate_hash_fixture, 'slug')
       expect(candidate['id']).to eq('3fc9a80f')
     end
   end
+
+  describe '#create_comment' do
+    let(:candidate_id) { '123456' }
+    let(:member_id) { '314' }
+    let(:comment_text) { "Hire this person!" }
+    let(:body) do
+      {
+        member_id: member_id,
+        comment: {
+          body: comment_text,
+          policy: [],
+          attachment: nil
+        }
+      }
+    end
+
+    it 'submits POST request' do
+      stub = stub_request(:post, 'https://www.workable.com/spi/v3/accounts/subdomain/candidates/123456/comments')
+        .with(body: body.to_json)
+
+      client.create_comment(candidate_id, member_id, comment_text)
+      expect(stub).to have_been_requested.once
+    end
+  end
+
+  describe '#disqualify' do
+    let(:candidate_id) { '123456' }
+    let(:member_id) { '314' }
+    let(:reason) { 'Lacks experience.' }
+    let(:body) do
+      {
+        member_id: member_id,
+        disqualification_reason: reason
+      }
+    end
+
+    it 'submits POST request' do
+      stub = stub_request(:post, 'https://www.workable.com/spi/v3/accounts/subdomain/candidates/123456/disqualify')
+        .with(body: body.to_json)
+
+      client.disqualify(candidate_id, member_id, reason)
+      expect(stub).to have_been_requested.once
+    end
+  end
+
+  describe '#revert' do
+    let(:candidate_id) { '123456' }
+    let(:member_id) { '314' }
+    let(:body) do
+      { member_id: member_id }
+    end
+
+    it 'submits POST request' do
+      stub = stub_request(:post, 'https://www.workable.com/spi/v3/accounts/subdomain/candidates/123456/revert')
+        .with(body: body.to_json)
+
+      client.revert(candidate_id, member_id)
+      expect(stub).to have_been_requested.once
+    end
+  end
+
+  describe '#copy' do
+    let(:candidate_id) { '123456' }
+    let(:member_id) { '314' }
+    let(:shortcode) { 'GROOV005' }
+    let(:stage) { 'applied' }
+    let(:body) do
+      {
+        member_id: member_id,
+        target_job_shortcode: shortcode,
+        target_stage: stage
+      }
+    end
+
+    it 'POSTs requests and parses response' do
+      stub_request(:post, 'https://www.workable.com/spi/v3/accounts/subdomain/candidates/123456/copy')
+        .with(body: body.to_json)
+        .to_return(status: 201, body: copy_candidate_response_json_fixture)
+
+      candidate = client.copy(candidate_id, member_id, shortcode, stage)
+      expect(candidate['id']).to eq(candidate_id)
+    end
+  end
+
+  describe '#relocate' do
+    let(:candidate_id) { '123456' }
+    let(:member_id) { '314' }
+    let(:shortcode) { 'GROOV005' }
+    let(:stage) { 'applied' }
+    let(:body) do
+      {
+        member_id: member_id,
+        target_job_shortcode: shortcode,
+        target_stage: stage
+      }
+    end
+
+    it 'POSTs requests and parses response' do
+      stub_request(:post, 'https://www.workable.com/spi/v3/accounts/subdomain/candidates/123456/relocate')
+        .with(body: body.to_json)
+        .to_return(status: 201, body: relocate_candidate_response_json_fixture)
+
+      candidate = client.relocate(candidate_id, member_id, shortcode, stage)
+      expect(candidate['id']).to eq(candidate_id)
+    end
+  end
+
+  describe '#move' do
+    let(:candidate_id) { '123456' }
+    let(:member_id) { '314' }
+    let(:stage ) { 'applied' }
+    let(:body) do
+      {
+        member_id: member_id,
+        target_stage: stage
+      }
+    end
+
+    it 'submits POST request' do
+      stub = stub_request(:post, 'https://www.workable.com/spi/v3/accounts/subdomain/candidates/123456/move')
+        .with(body: body.to_json)
+
+      client.move(candidate_id, member_id, stage)
+      expect(stub).to have_been_requested.once
+    end
+  end
+
+  describe '#create_rating' do
+    let(:candidate_id) { '123456' }
+    let(:member_id) { '314' }
+    let(:comment) { 'Good, I guess' }
+    let(:score) { 'positive' }
+    let(:body) do
+      {
+        member_id: member_id,
+        comment: comment,
+        score: score
+      }
+    end
+
+    it 'submits POST request' do
+      stub = stub_request(:post, 'https://www.workable.com/spi/v3/accounts/subdomain/candidates/123456/ratings')
+        .with(body: body.to_json)
+
+      client.create_rating(candidate_id, member_id, comment, score)
+      expect(stub).to have_been_requested.once
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: workable
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Rafał Wojsznis
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-19 00:00:00.000000000 Z
+date: 2017-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -92,6 +92,7 @@ files:
 - lib/workable/version.rb
 - spec/fixtures.rb
 - spec/fixtures/about.json
+- spec/fixtures/copy_candidate_response.json
 - spec/fixtures/job.json
 - spec/fixtures/job_application_form.json
 - spec/fixtures/job_candidate.json
@@ -102,6 +103,7 @@ files:
 - spec/fixtures/new_candidate.json
 - spec/fixtures/new_candidate_response.json
 - spec/fixtures/recruiters.json
+- spec/fixtures/relocate_candidate_response.json
 - spec/fixtures/stages.json
 - spec/lib/workable/client_spec.rb
 - spec/lib/workable/collection_spec.rb
@@ -135,6 +137,7 @@ summary: Dead-simple Ruby API client for workable.com
 test_files:
 - spec/fixtures.rb
 - spec/fixtures/about.json
+- spec/fixtures/copy_candidate_response.json
 - spec/fixtures/job.json
 - spec/fixtures/job_application_form.json
 - spec/fixtures/job_candidate.json
@@ -145,6 +148,7 @@ test_files:
 - spec/fixtures/new_candidate.json
 - spec/fixtures/new_candidate_response.json
 - spec/fixtures/recruiters.json
+- spec/fixtures/relocate_candidate_response.json
 - spec/fixtures/stages.json
 - spec/lib/workable/client_spec.rb
 - spec/lib/workable/collection_spec.rb