workable 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f5b055057eaa9673cc11ff001494e2de8f474202
-  data.tar.gz: debfe438f1b676c201e150a3df03f912e18ebb49
+  metadata.gz: 7eaebf59a51c6219ca5f278a91b99226b043fa1d
+  data.tar.gz: f41c7493529160c2d7e134b0aeb1d3284b5218e2
 SHA512:
-  metadata.gz: dd0315dec1bd07662e96a22213263121e7306b481662326689e0bce5817999f08f74477e2877c781d043d920a8dbd2e251335374741b833ca53ec27c46b4e4d0
-  data.tar.gz: 7458b826e7359bd25ad50fabe5c88921c3e687523748664cfd982874f0b77b318de697621dbfdb7ddaccef75cb709ce08f50af8ec7a80496a9d37d70b2bec6cb
+  metadata.gz: 840612f71285030a314ab414b8facd077e0cbc8eac8076353a8ab4a4b835c954c9000d9454ceda93b19b0cf97b7154fad33e95ff109a27f2d72196217b3a8cd7
+  data.tar.gz: 3231f81122c3170a0d461eed5c95733b0cd9fe85381ced8834eacb1988d873bcf65e7e5497d21f1e5bdab5e72b6eec72afd05bccb6837b63c80c4ff924cb6172

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+## 0.2.0
+
+- stages, job_questions and filtering candidates by stages #1 (@mpapis)
+- return `Workable::Errors::RequestToLong` in case of 503 http error #2 (@mpapis)
+
+## 0.1.0
+
+- initial release

data/README.md

@@ -3,6 +3,8 @@
 [![Code Climate](https://codeclimate.com/github/emq/workable/badges/gpa.svg)](https://codeclimate.com/github/emq/workable)
 [![Build Status](https://travis-ci.org/emq/workable.svg?branch=master)](https://travis-ci.org/emq/workable)
 [![Coverage Status](https://coveralls.io/repos/emq/workable/badge.png?branch=master)](https://coveralls.io/r/emq/workable?branch=master)
+[![Gem Version](https://badge.fury.io/rb/workable.svg)](http://badge.fury.io/rb/workable)
+[![Dependency Status](https://gemnasium.com/emq/workable.svg)](https://gemnasium.com/emq/workable)
 
 Dead-simple Ruby API client for [workable.com][1]. No extra runtime dependencies. Ruby >= 1.9.3.
 
@@ -35,20 +37,25 @@ Internal interface / api is in early stage, so far you can:
 
 ``` ruby
 client = Workable::Client.new(api_key: 'api_key', subdomain: 'your_subdomain')
+
+# takes optional phase argument (string): 'published' (default), 'draft', 'closed' or 'archived'
 client.jobs # => [#<Workable::Job>, #<Workable::Job>]
 
 shortcode = 'job_shortcode'
 
 # API queries are not cached (at all) - it's up to you to cache results one way or another
 
-client.job_details(shortcode) # => #<Workable::Job>
-client.job_candidates(shortcode) # => Array of hashes
+client.stages # => Array of hashes
+client.job_details(shortcode)   # => #<Workable::Job>
+client.job_questions(shortcode) # => Array of hashes
+client.job_candidates(shortcode, stage_slug) # => Array of hashes (skip stage_slug for all stages)
 
 # Possible errors (each one inherits from Workable::Errors::WorkableError)
 Workable::Errors::InvalidConfiguration # missing api_key / subdomain
-Workable::Errors::NotAuthorized # wrong api key
+Workable::Errors::NotAuthorized   # wrong api key
 Workable::Errors::InvalidResponse # something when wrong during the request?
-Workable::Errors::NotFound # 404 from workable
+Workable::Errors::NotFound        # 404 from workable
+Workable::Errors::RequestToLong   # When the requested result takes to long to calculate, try limiting your query
 ```
 
 ## Missing/Todo

data/lib/workable/client.rb

@@ -15,10 +15,19 @@ module Workable
       Job.new(get_request"jobs/#{shortcode}")
     end
 
-    def job_candidates(shortcode)
+    def job_candidates(shortcode, stage_slug = nil)
+      shortcode = "#{shortcode}/#{stage_slug}" unless stage_slug.nil?
       get_request("jobs/#{shortcode}/candidates")['candidates']
     end
 
+    def job_questions(shortcode)
+      get_request("jobs/#{shortcode}/questions")['questions']
+    end
+
+    def stages
+      get_request("stages")['stages']
+    end
+
     private
 
     attr_reader :api_key, :subdomain
@@ -47,6 +56,8 @@ module Workable
         raise Errors::NotAuthorized, response.body
       when 404
         raise Errors::NotFound, response.body
+      when 503
+        raise Errors::RequestToLong, response.body
       when proc { |code| code != 200 }
         raise Errors::InvalidResponse, "Response code: #{response.code}"
       end

data/lib/workable/errors.rb

@@ -5,5 +5,6 @@ module Workable
     class NotAuthorized        < WorkableError; end
     class InvalidResponse      < WorkableError; end
     class NotFound             < WorkableError; end
+    class RequestToLong        < WorkableError; end
   end
 end

data/lib/workable/version.rb

@@ -1,3 +1,3 @@
 module Workable
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/spec/fixtures.rb

@@ -115,3 +115,24 @@ def job_candidates_json_fixture
     ]
   })
 end
+
+def stages_json_fixture
+  JSON.generate({"stages" => [
+    {"slug"=>"sourced",    "name"=>"Sourced",    "kind"=>"sourced",     "position"=>1},
+    {"slug"=>"applied",    "name"=>"Applied",    "kind"=>"applied",     "position"=>2},
+    {"slug"=>"soft-talk",  "name"=>"Soft Talk",  "kind"=>"interview",   "position"=>3},
+    {"slug"=>"wait",       "name"=>"Wait",       "kind"=>"shortlisted", "position"=>4},
+    {"slug"=>"assessment", "name"=>"Assessment", "kind"=>"assessment",  "position"=>5},
+    {"slug"=>"review",     "name"=>"Review",     "kind"=>"assessment",  "position"=>6},
+    {"slug"=>"tech-talk",  "name"=>"Tech Talk",  "kind"=>"interview",   "position"=>7},
+    {"slug"=>"prepare",    "name"=>"Prepare",    "kind"=>"interview",   "position"=>8},
+    {"slug"=>"ready",      "name"=>"Ready",      "kind"=>"shortlisted", "position"=>9},
+    {"slug"=>"later",      "name"=>"Later",      "kind"=>"shortlisted", "position"=>10}
+  ]})
+end
+
+def job_questions_json_fixture
+  JSON.generate({"questions" => [
+    {"key"=>"fe8", "body"=>"How many fingers do you have?", "type"=>"free_text"}
+  ]})
+end

data/spec/lib/workable/client_spec.rb

@@ -58,6 +58,18 @@ describe Workable::Client do
     end
   end
 
+  describe '#job_questions' do
+    let(:client){ described_class.new(api_key: 'test', subdomain: 'subdomain') }
+
+    it 'returns questions for given job' do
+      stub_request(:get, "https://www.workable.com/spi/v2/accounts/subdomain/jobs/03FF356C8B/questions")
+        .to_return(status: 200, body: job_questions_json_fixture, headers: {})
+
+      expect(client.job_questions('03FF356C8B')).to be_kind_of(Array)
+    end
+
+  end
+
   describe '#candidates' do
     let(:client){ described_class.new(api_key: 'test', subdomain: 'subdomain') }
 
@@ -67,6 +79,25 @@ describe Workable::Client do
 
       expect(client.job_candidates('03FF356C8B')).to be_kind_of(Array)
     end
+
+    it 'raises exception on to long requests' do
+      stub_request(:get, "https://www.workable.com/spi/v2/accounts/subdomain/jobs?phase=published")
+        .to_return(status: 503, body: '{"error":"Not authorized"}', headers: {})
+
+      expect { client.jobs }.to raise_error(Workable::Errors::RequestToLong)
+    end
+
+  end
+
+  describe '#stages' do
+    let(:client){ described_class.new(api_key: 'test', subdomain: 'subdomain') }
+
+    it 'returns array of stages' do
+      stub_request(:get, "https://www.workable.com/spi/v2/accounts/subdomain/stages")
+        .to_return(status: 200, body: stages_json_fixture, headers: {})
+
+      expect(client.stages).to be_kind_of(Array)
+    end
   end
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: workable
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Rafał Wojsznis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-05 00:00:00.000000000 Z
+date: 2015-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -90,6 +90,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -124,7 +125,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Dead-simple Ruby API client for workable.com