greenhouse_io 1.0.2 → 2.0.0

data/spec/fixtures/cassettes/client/offices.yml

@@ -0,0 +1,46 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://123FakeToken:@harvest.greenhouse.io/v1/offices
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers: {}
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - application/json;charset=utf-8
+      Date:
+      - Mon, 21 Apr 2014 23:39:41 GMT
+      Status:
+      - 200 OK
+      X-Content-Type-Options:
+      - nosniff
+      X-Ratelimit-Limit:
+      - '20'
+      X-Ratelimit-Remaining:
+      - '20'
+      Content-Length:
+      - '775'
+      Connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      string: "[{\"id\":215,\"name\":\"Hong Kong\",\"location\":{\"name\":\"Hong Kong\"}},{\"id\":216,\"name\":\"London\",\"location\":{\"name\":\"London,
+        United Kingdom\"}},{\"id\":217,\"name\":\"San Francisco\",\"location\":{\"name\":\"San
+        Francisco, CA\"}},{\"id\":219,\"name\":\"Sydney\",\"location\":{\"name\":\"Sydney,
+        New South Wales, Australia\"}},{\"id\":220,\"name\":\"Boston\",\"location\":{\"name\":\"Boston,
+        MA\"}},{\"id\":221,\"name\":\"Washington DC\",\"location\":{\"name\":\"Washington,
+        DC\"}},{\"id\":214,\"name\":\"New York\",\"location\":{\"name\":\"New York,
+        NY\"}},{\"id\":218,\"name\":\"Los Angeles\",\"location\":{\"name\":\"Santa
+        Monica, CA\"}},{\"id\":856,\"name\":\"Seattle\",\"location\":{\"name\":\"Seattle,
+        WA\"}},{\"id\":857,\"name\":\"Chicago\",\"location\":{\"name\":\"Chicago,
+        IL, United States\"}},{\"id\":858,\"name\":\"Atlanta\",\"location\":{\"name\":\"Atlanta,
+        GA, United States\"}}]"
+    http_version: 
+  recorded_at: Mon, 21 Apr 2014 23:39:41 GMT
+recorded_with: VCR 2.5.0

data/spec/fixtures/cassettes/client/scheduled_interviews.yml

@@ -0,0 +1,38 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://123FakeToken:@harvest.greenhouse.io/v1/applications/1/scheduled_interviews
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers: {}
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - application/json;charset=utf-8
+      Date:
+      - Sun, 11 May 2014 23:21:19 GMT
+      Status:
+      - 200 OK
+      X-Content-Type-Options:
+      - nosniff
+      X-Ratelimit-Limit:
+      - '20'
+      X-Ratelimit-Remaining:
+      - '20'
+      Content-Length:
+      - '562'
+      Connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      string: "[{\"id\":435294,\"starts_at\":\"2014-01-10T21:00:00Z\",\"ends_at\":\"2014-01-10T21:15:00Z\",\"location\":null,\"status\":\"complete\",\"interview\":{\"id\":85265,\"name\":\"Task
+        Follow Up\"},\"organizer\":{\"id\":3850,\"name\":\"Test User\"},\"interviewers\":[{\"id\":3850,\"name\":\"Test User\",\"email\":null}]},{\"id\":435293,\"starts_at\":\"2014-01-11T13:00:00Z\",\"ends_at\":\"2014-01-11T13:45:00Z\",\"location\":\"Phone\",\"status\":\"complete\",\"interview\":{\"id\":39539,\"name\":\"Preliminary
+        Screening Call\"},\"organizer\":{\"id\":3850,\"name\":\"Test User\"},\"interviewers\":[{\"id\":3850,\"name\":\"Test User\",\"email\":null}]}]"
+    http_version: 
+  recorded_at: Sun, 11 May 2014 23:21:20 GMT
+recorded_with: VCR 2.5.0

data/spec/fixtures/cassettes/client/scorecards.yml

@@ -0,0 +1,37 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://123FakeToken:@harvest.greenhouse.io/v1/applications/1/scorecards
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers: {}
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - application/json;charset=utf-8
+      Date:
+      - Sun, 11 May 2014 06:50:36 GMT
+      Status:
+      - 200 OK
+      X-Content-Type-Options:
+      - nosniff
+      X-Ratelimit-Limit:
+      - '20'
+      X-Ratelimit-Remaining:
+      - '20'
+      Content-Length:
+      - '2808'
+      Connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      string: "[{\"interview\":\"Task Follow Up\",\"interviewed_at\":\"2014-01-13T00:00:00Z\",\"submitted_by\":{\"id\":3850,\"name\":\"Test User\"},\"submitted_at\":\"2014-01-13T22:06:55Z\",\"overall_recommendation\":\"no_decision\",\"ratings\":{\"definitely_not\":[],\"no\":[],\"mixed\":[],\"yes\":[],\"strong_yes\":[]},\"questions\":[{\"id\":null,\"question\":\"Key
+        Take-Aways\",\"answer\":\"\"},{\"id\":null,\"question\":\"Private Notes\",\"answer\":\"\"}]}]"
+    http_version: 
+  recorded_at: Sun, 11 May 2014 06:50:37 GMT
+recorded_with: VCR 2.5.0

data/spec/fixtures/cassettes/client/source.yml

@@ -0,0 +1,39 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://123FakeToken:@harvest.greenhouse.io/v1/sources/1
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers: {}
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - application/json;charset=utf-8
+      Date:
+      - Sun, 11 May 2014 23:46:48 GMT
+      Status:
+      - 200 OK
+      X-Cascade:
+      - pass
+      X-Content-Type-Options:
+      - nosniff
+      X-Ratelimit-Limit:
+      - '20'
+      X-Ratelimit-Remaining:
+      - '20'
+      Content-Length:
+      - '32'
+      Connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      string: "{\"id\":1,\"name\":\"Customer newsletter\",\"type\":{\"id\":1,\"name\":\"Company
+        marketing\"}}"
+    http_version: 
+  recorded_at: Sun, 11 May 2014 23:46:49 GMT
+recorded_with: VCR 2.5.0

data/spec/fixtures/cassettes/client/sources.yml

@@ -0,0 +1,37 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://123FakeToken:@harvest.greenhouse.io/v1/sources
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers: {}
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - application/json;charset=utf-8
+      Date:
+      - Sun, 11 May 2014 23:39:54 GMT
+      Status:
+      - 200 OK
+      X-Content-Type-Options:
+      - nosniff
+      X-Ratelimit-Limit:
+      - '20'
+      X-Ratelimit-Remaining:
+      - '20'
+      Content-Length:
+      - '3028'
+      Connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      string: "[{\"id\":1,\"name\":\"Customer newsletter\",\"type\":{\"id\":1,\"name\":\"Company
+        marketing\"}}]"
+    http_version: 
+  recorded_at: Sun, 11 May 2014 23:39:55 GMT
+recorded_with: VCR 2.5.0

data/spec/fixtures/cassettes/client/stages.yml

@@ -0,0 +1,36 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://123FakeToken:@harvest.greenhouse.io/v1/jobs/4690/stages
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers: {}
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - application/json;charset=utf-8
+      Date:
+      - Sun, 11 May 2014 23:32:17 GMT
+      Status:
+      - 200 OK
+      X-Content-Type-Options:
+      - nosniff
+      X-Ratelimit-Limit:
+      - '20'
+      X-Ratelimit-Remaining:
+      - '20'
+      Content-Length:
+      - '892'
+      Connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      string: "[{\"id\":31416,\"name\":\"Offer\",\"interviews\":[]}]"
+    http_version: 
+  recorded_at: Sun, 11 May 2014 23:32:18 GMT
+recorded_with: VCR 2.5.0

data/spec/fixtures/cassettes/client/user.yml

@@ -0,0 +1,36 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://123FakeToken:@harvest.greenhouse.io/v1/users/10327
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers: {}
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - application/json;charset=utf-8
+      Date:
+      - Sun, 11 May 2014 23:37:54 GMT
+      Status:
+      - 200 OK
+      X-Content-Type-Options:
+      - nosniff
+      X-Ratelimit-Limit:
+      - '20'
+      X-Ratelimit-Remaining:
+      - '20'
+      Content-Length:
+      - '35'
+      Connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      string: "{\"id\":10327,\"name\":\"Test User 1\"}"
+    http_version: 
+  recorded_at: Sun, 11 May 2014 23:37:55 GMT
+recorded_with: VCR 2.5.0

data/spec/fixtures/cassettes/client/users.yml

@@ -0,0 +1,38 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://123FakeToken:@harvest.greenhouse.io/v1/users
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers: {}
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - application/json;charset=utf-8
+      Date:
+      - Sun, 11 May 2014 23:36:20 GMT
+      Link:
+      - "<https://harvest.greenhouse.io/v1/users?page=2&per_page=100>; rel=\"next\""
+      Status:
+      - 200 OK
+      X-Content-Type-Options:
+      - nosniff
+      X-Ratelimit-Limit:
+      - '20'
+      X-Ratelimit-Remaining:
+      - '20'
+      Content-Length:
+      - '10824'
+      Connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      string: "[{\"id\":10327,\"name\":\"Test User 1\",\"disabled\":false,\"site_admin\":false,\"emails\":[\"test_user@email.com\"]}]"
+    http_version: 
+  recorded_at: Sun, 11 May 2014 23:36:21 GMT
+recorded_with: VCR 2.5.0

data/spec/fixtures/cassettes/invalid_id.yml

@@ -2,7 +2,7 @@
 http_interactions:
 - request:
     method: get
-    uri: https://api.greenhouse.io/v1/boards/generalassembly/embed/job?id=123&questions=false
+    uri: https://api.greenhouse.io/v1/boards/generalassembly/embed/job?id=123&questions=
     body:
       encoding: US-ASCII
       string: ''

data/spec/fixtures/cassettes/job.yml

@@ -2,7 +2,7 @@
 http_interactions:
 - request:
     method: get
-    uri: https://api.greenhouse.io/v1/boards/generalassembly/embed/job?id=721&questions=false
+    uri: https://api.greenhouse.io/v1/boards/generalassembly/embed/job?id=721&questions=
     body:
       encoding: US-ASCII
       string: ''

data/spec/greenhouse_io/api/client_spec.rb

@@ -0,0 +1,474 @@
+require 'spec_helper'
+
+describe GreenhouseIo::Client do
+
+  it "should have a base url for an API endpoint" do
+    expect(GreenhouseIo::Client.base_uri).to eq("https://harvest.greenhouse.io/v1")
+  end
+
+  context "given an instance of GreenhouseIo::Client" do
+
+    before do
+      GreenhouseIo.configuration.symbolize_keys = true
+      @client = GreenhouseIo::Client.new('123FakeToken')
+    end
+
+    describe "#initialize" do
+      it "has an api_token" do
+        expect(@client.api_token).to eq('123FakeToken')
+      end
+
+      it "uses the configuration value when token is not specified" do
+        GreenhouseIo.configuration.api_token = '123FakeENV'
+        default_client = GreenhouseIo::Client.new
+        expect(default_client.api_token).to eq('123FakeENV')
+      end
+    end
+
+    describe "#path_id" do
+      context "given an id" do
+        it "returns an id path" do
+          output = @client.send(:path_id, 1)
+          expect(output).to eq('/1')
+        end
+      end
+
+      context "given no id" do
+        it "returns nothing" do
+          output = @client.send(:path_id)
+          expect(output).to be_nil
+        end
+      end
+    end
+
+    describe "#set_rate_limits" do
+      before do
+        @headers = {
+          'x-ratelimit-limit' => '20',
+          'x-ratelimit-remaining' => '20'
+        }
+      end
+
+      it "sets the rate limit" do
+        @client.send(:set_rate_limits, @headers)
+        expect(@client.rate_limit).to eq(20)
+      end
+
+      it "sets the remaining rate limit" do
+        @client.send(:set_rate_limits, @headers)
+        expect(@client.rate_limit_remaining).to eq(20)
+      end
+    end
+
+    describe "#permitted_options" do
+      let(:options) { GreenhouseIo::Client::PERMITTED_OPTIONS + [:where] }
+
+      it "allows permitted options" do
+        output = @client.send(:permitted_options, options)
+        GreenhouseIo::Client::PERMITTED_OPTIONS.each do |option|
+          expect(output).to include(option)
+        end
+      end
+
+      it "discards non-permitted options" do
+        output = @client.send(:permitted_options, options)
+        expect(output).to_not include(:where)
+      end
+    end
+
+    describe "#offices" do
+      context "given no id" do
+        before do
+          VCR.use_cassette('client/offices') do
+            @offices_response = @client.offices
+          end
+        end
+
+        it "returns a response" do
+          expect(@offices_response).to_not be_nil
+        end
+
+        it "returns an array of offices" do
+          expect(@offices_response).to be_an_instance_of(Array)
+        end
+
+        it "returns office details" do
+          expect(@offices_response.first).to have_key(:name)
+        end
+      end
+
+      context "given an id" do
+        before do
+          VCR.use_cassette('client/office') do
+            @office_response = @client.offices(220)
+          end
+        end
+
+        it "returns a response" do
+          expect(@office_response).to_not be_nil
+        end
+
+        it "returns an office hash" do
+          expect(@office_response).to be_an_instance_of(Hash)
+        end
+
+        it "returns an office's details" do
+          expect(@office_response).to have_key(:name)
+        end
+      end
+    end
+
+    describe "#departments" do
+      context "given no id" do
+        before do
+          VCR.use_cassette('client/departments') do
+            @departments_response = @client.departments
+          end
+        end
+
+        it "returns a response" do
+          expect(@departments_response).to_not be_nil
+        end
+
+        it "returns an array of departments" do
+          expect(@departments_response).to be_an_instance_of(Array)
+        end
+
+        it "returns office details" do
+          expect(@departments_response.first).to have_key(:name)
+        end
+      end
+
+      context "given an id" do
+        before do
+          VCR.use_cassette('client/department') do
+            @department_response = @client.departments(187)
+          end
+        end
+
+        it "returns a response" do
+          expect(@department_response).to_not be_nil
+        end
+
+        it "returns a department hash" do
+          expect(@department_response).to be_an_instance_of(Hash)
+        end
+
+        it "returns a department's details" do
+          expect(@department_response).to have_key(:name)
+        end
+      end
+    end
+
+    describe "#candidates" do
+      context "given no id" do
+
+        before do
+          VCR.use_cassette('client/candidates') do
+            @candidates_response = @client.candidates
+          end
+        end
+
+        it "returns a response" do
+          expect(@candidates_response).to_not be_nil
+        end
+
+        it "returns an array of candidates" do
+          expect(@candidates_response).to be_an_instance_of(Array)
+        end
+
+        it "returns details of candidates" do
+          expect(@candidates_response.first).to have_key(:first_name)
+        end
+      end
+
+      context "given an id" do
+        before do
+          VCR.use_cassette('client/candidate') do
+            @candidate_response = @client.candidates(1)
+          end
+        end
+
+        it "returns a response" do
+          expect(@candidate_response).to_not be_nil
+        end
+
+        it "returns a candidate hash" do
+          expect(@candidate_response).to be_an_instance_of(Hash)
+        end
+
+        it "returns a candidate's details" do
+          expect(@candidate_response).to have_key(:first_name)
+        end
+      end
+    end
+
+    describe "#activity_feed" do
+      before do
+        VCR.use_cassette('client/activity_feed') do
+          @activity_feed = @client.activity_feed(1)
+        end
+      end
+
+      it "returns a response" do
+        expect(@activity_feed).to_not be_nil
+      end
+
+      it "returns an activity feed" do
+        expect(@activity_feed).to be_an_instance_of(Hash)
+      end
+
+      it "returns details of the activity feed" do
+        expect(@activity_feed).to have_key(:activities)
+      end
+    end
+
+    describe "#applications" do
+      context "given no id" do
+        before do
+          VCR.use_cassette('client/applications') do
+            @applications = @client.applications
+          end
+        end
+
+        it "returns a response" do
+          expect(@applications).to_not be_nil
+        end
+
+        it "returns an array of applications" do
+          expect(@applications).to be_an_instance_of(Array)
+        end
+
+        it "returns application details" do
+          expect(@applications.first).to have_key(:person_id)
+        end
+      end
+
+      context "given an id" do
+        before do
+          VCR.use_cassette('client/application') do
+            @application = @client.applications(1)
+          end
+        end
+
+        it "returns a response" do
+          expect(@application).to_not be_nil
+        end
+
+        it "returns an application hash" do
+          expect(@application).to be_an_instance_of(Hash)
+        end
+
+        it "returns an application's details" do
+          expect(@application).to have_key(:person_id)
+        end
+      end
+    end
+
+    describe "#scorecards" do
+      before do
+        VCR.use_cassette('client/scorecards') do
+          @scorecard = @client.scorecards(1)
+        end
+      end
+
+      it "returns a response" do
+        expect(@scorecard).to_not be_nil
+      end
+
+      it "returns an array of scorecards" do
+        expect(@scorecard).to be_an_instance_of(Array)
+      end
+
+      it "returns details of the scorecards" do
+        expect(@scorecard.first).to have_key(:interview)
+      end
+    end
+
+    describe "#scheduled_interviews" do
+      before do
+        VCR.use_cassette('client/scheduled_interviews') do
+          @scheduled_interviews = @client.scheduled_interviews(1)
+        end
+      end
+
+      it "returns a response" do
+        expect(@scheduled_interviews).to_not be_nil
+      end
+
+      it "returns an array of scheduled interviews" do
+        expect(@scheduled_interviews).to be_an_instance_of(Array)
+      end
+
+      it "returns details of the interview" do
+        expect(@scheduled_interviews.first).to have_key(:starts_at)
+      end
+    end
+
+    describe "#jobs" do
+      context "given no id" do
+        before do
+          VCR.use_cassette('client/jobs') do
+            @jobs = @client.jobs
+          end
+        end
+
+        it "returns a response" do
+          expect(@jobs).to_not be_nil
+        end
+
+        it "returns an array of applications" do
+          expect(@jobs).to be_an_instance_of(Array)
+        end
+
+        it "returns application details" do
+          expect(@jobs.first).to have_key(:employment_type)
+        end
+      end
+
+      context "given an id" do
+        before do
+          VCR.use_cassette('client/job') do
+            @job = @client.jobs(4690)
+          end
+        end
+
+        it "returns a response" do
+          expect(@job).to_not be_nil
+        end
+
+        it "returns an application hash" do
+          expect(@job).to be_an_instance_of(Hash)
+        end
+
+        it "returns an application's details" do
+          expect(@job).to have_key(:employment_type)
+        end
+      end
+    end
+
+    describe "#stages" do
+      before do
+        VCR.use_cassette('client/stages') do
+          @stages = @client.stages(4690)
+        end
+      end
+
+      it "returns a response" do
+        expect(@stages).to_not be_nil
+      end
+
+      it "returns an array of scheduled interviews" do
+        expect(@stages).to be_an_instance_of(Array)
+      end
+
+      it "returns details of the interview" do
+        expect(@stages.first).to have_key(:name)
+      end
+    end
+
+    describe "#job_post" do
+      before do
+        VCR.use_cassette('client/job_post') do
+          @job_post = @client.job_post(4690)
+        end
+      end
+
+      it "returns a response" do
+        expect(@job_post).to_not be_nil
+      end
+
+      it "returns an array of scheduled interviews" do
+        expect(@job_post).to be_an_instance_of(Hash)
+      end
+
+      it "returns details of the interview" do
+        expect(@job_post).to have_key(:title)
+      end
+    end
+
+    describe "#users" do
+      context "given no id" do
+        before do
+          VCR.use_cassette('client/users') do
+            @users = @client.users
+          end
+        end
+
+        it "returns a response" do
+          expect(@users).to_not be_nil
+        end
+
+        it "returns an array of applications" do
+          expect(@users).to be_an_instance_of(Array)
+        end
+
+        it "returns application details" do
+          expect(@users.first).to have_key(:name)
+        end
+      end
+
+      context "given an id" do
+        before do
+          VCR.use_cassette('client/user') do
+            @job = @client.users(10327)
+          end
+        end
+
+        it "returns a response" do
+          expect(@job).to_not be_nil
+        end
+
+        it "returns an application hash" do
+          expect(@job).to be_an_instance_of(Hash)
+        end
+
+        it "returns an application's details" do
+          expect(@job).to have_key(:name)
+        end
+      end
+    end
+
+    describe "#sources" do
+      context "given no id" do
+        before do
+          VCR.use_cassette('client/sources') do
+            @sources = @client.sources
+          end
+        end
+
+        it "returns a response" do
+          expect(@sources).to_not be_nil
+        end
+
+        it "returns an array of applications" do
+          expect(@sources).to be_an_instance_of(Array)
+        end
+
+        it "returns application details" do
+          expect(@sources.first).to have_key(:name)
+        end
+      end
+
+      context "given an id" do
+        before do
+          VCR.use_cassette('client/source') do
+            @source = @client.sources(1)
+          end
+        end
+
+        it "returns a response" do
+          expect(@source).to_not be_nil
+        end
+
+        it "returns an application hash" do
+          expect(@source).to be_an_instance_of(Hash)
+        end
+
+        it "returns an application's details" do
+          expect(@source).to have_key(:name)
+        end
+      end
+    end
+  end
+end