workable 1.0.0.rc2 → 1.0.0.rc3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ada51e56baba92f9000eef95141cf2398a1e928f
-  data.tar.gz: c3d58edf13520d31ea1f318c28757301b986db89
+  metadata.gz: 3a012b72ac227d6a5e255ab04744c9d1d73b3702
+  data.tar.gz: c4d387f0f391433e9daa0dcea11e44d31a199530
 SHA512:
-  metadata.gz: c2a4cff53fe413453ab557278c2f90c7762fd0a425842db4f0eb94081f9c348da28adf2c8fd88eb95a9929caabec0a0e64968360be4f94f666bcf9b1394719d0
-  data.tar.gz: c816f6b7c325a148da17b2765ca63cdd9fc06117c7f6c2222f817bc6b9cea00081b934480966bc482556ce5bddb6b9a642f62049e6875dcc80db4f179477e082
+  metadata.gz: 7bf6600e83452fcb61a6f42ffcf91dae9ef568a9e003fa86901f22dd2fc4c48ea84babb708edf131f37f911a1799292e2cc4f2d49629d267ca7b893e4fe86629
+  data.tar.gz: 25d8a1c06fe687e3101bcb1df465f370a4cb46ea5de0cc8eb36d249044389f4f285ed642e50fb35f537a6a6fae89a18acf8e3bbeba9b164cb35bbbdd225c9941

data/README.md

@@ -49,7 +49,9 @@ client.stages     # => Array of hashes
 client.recruiters # => Array of hashes
 client.job_details(shortcode)    # => Hash
 client.job_questions(shortcode)  # => Array of hashes
-client.job_candidates(shortcode, stage_slug) # => Array of hashes (stage_slug is optional)
+client.job_candidates(shortcode, :stage => stage_slug, :limit => 100) # => Array of hashes:
+#   if given stage limits to given stage
+#   if given limit lists the last `limit` added candidates
 
 # Adding candidates - candidate is a Hash as described in:
 #   http://resources.workable.com/add-candidates-using-api

data/lib/workable/client.rb

@@ -48,11 +48,13 @@ module Workable
     end
 
     # list candidates for given job
-    # @param shortcode  [String]     job shortcode to select candidates from
-    # @param stage_slug [String|nil] optional stage slug, if not given candidates are listed for all stages
-    def job_candidates(shortcode, stage_slug = nil)
-      shortcode = "#{shortcode}/#{stage_slug}" unless stage_slug.nil?
-      transform_to(:candidate, get_request("jobs/#{shortcode}/candidates")['candidates'])
+    # @param  shortcode [String] job shortcode to select candidates from
+    # @param  options   [Hash]   extra options like `stage_slug` or `limit`
+    # @option options :stage [String]        optional stage slug, if not given candidates are listed for all stages
+    # @option options :limit [Number|String] optional limit of candidates to download, if not given all candidates are listed
+    def job_candidates(shortcode, options = {})
+      url = build_job_candidates_url(shortcode, options)
+      transform_to(:candidate, get_request(url)['candidates'])
     end
 
     # list of questions for job
@@ -160,6 +162,23 @@ module Workable
       }
     end
 
+    # build url for fetching job candidates
+    # @param  shortcode [String] job shortcode to select candidates from
+    # @param  options   [Hash]   extra options like `stage_slug` or `limit`
+    # @option options :stage_slug [String]        optional stage slug, if not given candidates are listed for all stages
+    # @option options :limit      [Number|String] optional limit of candidates to download, if not given all candidates are listed
+    def build_job_candidates_url(shortcode, options)
+      if (stage_slug = options.delete(:stage))
+      then stage_slug = "/#{stage_slug}"
+      end
+      params =
+      if options.empty?
+      then ""
+      else "?#{options.map{|k,v| "#{k}=#{v}"}.join("&")}"
+      end
+      "jobs/#{shortcode}#{stage_slug}/candidates#{params}"
+    end
+
     # transform result using given method if defined
     # @param type [Symbol] type of the transformation, one of `[:job, :candidate, :question, :stage]`
     # @param result [Hash|Array|nil] the value to transform, can be nothing, `Hash` of values or `Array` of `Hash`es

data/lib/workable/version.rb

@@ -1,3 +1,3 @@
 module Workable
-  VERSION = "1.0.0.rc2"
+  VERSION = "1.0.0.rc3"
 end

data/spec/lib/workable/client_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 
 describe Workable::Client do
 
-  describe 'initialization' do
+  describe '#new' do
     it 'raises an error on missing api_key / subdomain' do
       expect { described_class.new }.to raise_error(Workable::Errors::InvalidConfiguration)
       expect { described_class.new(api_key: 'key') }.to raise_error(Workable::Errors::InvalidConfiguration)
@@ -70,7 +70,31 @@ describe Workable::Client do
 
   end
 
-  describe '#candidates' do
+  describe "#build_job_candidates_url" do
+    subject{ described_class.new(api_key: 'test', subdomain: 'subdomain') }
+
+    it "builds url without options" do
+      expect(subject.send(:build_job_candidates_url, "test", {})).to eq("jobs/test/candidates")
+    end
+
+    it "builds url with multiple unknown options" do
+      expect(subject.send(:build_job_candidates_url, "test", {:a => 1, :b =>1})).to eq("jobs/test/candidates?a=1&b=1")
+    end
+
+    it "builds url with limit" do
+      expect(subject.send(:build_job_candidates_url, "test", {:limit => 100})).to eq("jobs/test/candidates?limit=100")
+    end
+
+    it "builds url with stage slug" do
+      expect(subject.send(:build_job_candidates_url, "test", {:stage => "sourced"})).to eq("jobs/test/sourced/candidates")
+    end
+
+    it "builds url with stage slug and limit" do
+      expect(subject.send(:build_job_candidates_url, "test", {:limit => 100, :stage => "sourced"})).to eq("jobs/test/sourced/candidates?limit=100")
+    end
+  end
+
+  describe '#job_candidates' do
     let(:client){ described_class.new(api_key: 'test', subdomain: 'subdomain') }
 
     it 'returns array of candidates for given job' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: workable
 version: !ruby/object:Gem::Version
-  version: 1.0.0.rc2
+  version: 1.0.0.rc3
 platform: ruby
 authors:
 - Rafał Wojsznis
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-16 00:00:00.000000000 Z
+date: 2015-04-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake