greenhouse_io 2.3.1 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9dd09e95805fe4b610dce4448a7caeaf045090aa
-  data.tar.gz: 141396f8491cfbf28f193c69dcec7af6d8f319b1
+  metadata.gz: f943bd5a8beb683ca3d3e7093ab0da59b92dc080
+  data.tar.gz: 61b72fbb33e6b07ff1182b73899820bbac253551
 SHA512:
-  metadata.gz: f7289af592c6275e6577a1a9236088e875100099a8301a69c5f9c6d1f9e2bdf15f627cdcd754e5af0b6a6ced6d63fff9cd36b1c698493aa12b5d0c00ed087cb2
-  data.tar.gz: 076bcb038e271ff443ed58cef5769f4e9be601e6d1de620c6942201799b0d29b88c0814d3804bf887e0d2ec8e3722311c469e4096c2144f96f264c5c8ae65875
+  metadata.gz: 1a60fbbbc126b6972486f2acbbae28ae86aa8b7d2ad4f16b281941279c239be64116b983e44d836a3ab6243b7df49685219bd8d2f2c958b55f7edcaa8f16cca0
+  data.tar.gz: 998ddf413dc68f561770df31e79211bd384f0219b3e87270cb5f5920bce64b4e400fb0565373ec2aa6dc29824dba43f7dfa639df0f286fa28d5c57b766d61b2b

data/.gitignore

@@ -13,4 +13,7 @@ pkg
 rdoc
 spec/reports
 tmp
-.ruby-*
+.ruby-*
+*.swp
+*.un~
+tags

data/CHANGES.md

@@ -2,9 +2,18 @@
 
 This project follows [semantic versioning](http://semver.org/).  This changelog follows suggestions from [keepachangelog.com](http://keepachangelog.com/).
 
-## Version 2.3.1
+## Version 2.4.0
 Released 2016-04-20.
 
+#### Added
+- Exposed `link` HTTP header in `GreenhouseIo::Client`.
+
+#### Removed
+- Removed dependency on `multi_json` in favor of Ruby's `json` module.
+
+## Version 2.3.1
+Released 2016-04-20.  In retrospect, this should've been a minor version bump instead of a minor version since this added functionality, not a bug fix.
+
 #### Added
 - Added method `create_candidate_note`.  Thanks for contributing, [@jleven](https://github.com/jleven)!
 

data/README.md

@@ -118,14 +118,14 @@ gh_client = GreenhouseIo::Client.new
 
 #### Listing candidates
 
-```
+```ruby
 gh_client.candidates
 ```
 
 #### Creating a candidate note
 Use this method to attach a new note to a candidate.
 
-```
+```ruby
 candidate_id = 4567
 author_id = 123 # ID of the user who wrote this note
 note = {
@@ -154,6 +154,16 @@ All `GreenhouseIo::Client` API methods accept `:page` and `:per_page` options to
 gh_client.offices(id, page: 1, per_page: 2)
 ```
 
+You can determine the last page and next page by looking at the `link` header from the last response:
+
+```ruby
+gh_client.link
+
+# => '<https://harvest.greenhouse.io/v1/candidates?page=2&per_page=100>; rel="next",<https://harvest.greenhouse.io/v1/candidates?page=142&per_page=100>; rel="last"'
+```
+
+You'll need to manually parse the `next` and `last` links to tell what the next or final page number will be.
+
 #### Available methods
 
 Methods for which an `id` is optional:

data/greenhouse_io.gemspec

@@ -19,7 +19,6 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency('httmultiparty', '~> 0.3.16')
-  spec.add_dependency('multi_json', '~>1.11.2')
   spec.required_ruby_version = '>= 1.9.3'
 
   spec.add_development_dependency "bundler", "~> 1.3"

data/lib/greenhouse_io.rb

@@ -1,5 +1,4 @@
 require 'httmultiparty'
-require 'multi_json'
 require 'json'
 
 require "greenhouse_io/version"

data/lib/greenhouse_io/api.rb

@@ -9,7 +9,7 @@ module GreenhouseIo
     end
 
     def parse_json(response)
-      MultiJson.load(response.body, symbolize_keys: GreenhouseIo.configuration.symbolize_keys)
+      JSON.parse(response.body, symbolize_names: GreenhouseIo.configuration.symbolize_keys)
     end
 
     def basic_auth

data/lib/greenhouse_io/api/client.rb

@@ -5,7 +5,7 @@ module GreenhouseIo
 
     PERMITTED_OPTIONS = [:page, :per_page, :job_id]
 
-    attr_accessor :api_token, :rate_limit, :rate_limit_remaining
+    attr_accessor :api_token, :rate_limit, :rate_limit_remaining, :link
     base_uri 'https://harvest.greenhouse.io/v1'
 
     def initialize(api_token = nil)
@@ -92,7 +92,7 @@ module GreenhouseIo
         :basic_auth => basic_auth
       })
 
-      set_rate_limits(response.headers)
+      set_headers_info(response.headers)
 
       if response.code == 200
         parse_json(response)
@@ -108,7 +108,7 @@ module GreenhouseIo
         :headers => headers
       })
 
-      set_rate_limits(response.headers)
+      set_headers_info(response.headers)
 
       if response.code == 200
         parse_json(response)
@@ -117,9 +117,10 @@ module GreenhouseIo
       end
     end
 
-    def set_rate_limits(headers)
+    def set_headers_info(headers)
       self.rate_limit = headers['x-ratelimit-limit'].to_i
       self.rate_limit_remaining = headers['x-ratelimit-remaining'].to_i
+      self.link = headers['link'].to_s
     end
   end
 end

data/lib/greenhouse_io/version.rb

@@ -1,3 +1,3 @@
 module GreenhouseIo
-  VERSION = "2.3.1"
+  VERSION = "2.4.0"
 end

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

@@ -0,0 +1,38 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://123FakeToken:@harvest.greenhouse.io/v1/candidates
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers: {}
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - application/json;charset=utf-8
+      Date:
+      - Wed, 23 Apr 2014 23:23:01 GMT
+      Link:
+      - "<https://harvest.greenhouse.io/v1/candidates/?page=1&per_page=100>; rel=\"last\""
+      Status:
+      - 200 OK
+      X-Content-Type-Options:
+      - nosniff
+      X-Ratelimit-Limit:
+      - '20'
+      X-Ratelimit-Remaining:
+      - '19'
+      Content-Length:
+      - '68109'
+      Connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      string: "[{\"id\":1,\"first_name\":\"User\",\"last_name\":\"One\",\"company\":null,\"title\":null,\"created_at\":\"2013-10-17T15:32:26Z\",\"last_activity\":\"2013-10-30T14:37:10Z\",\"photo_url\":null,\"attachments\":[{\"filename\":\"USER_1_Resume_10.13.pdf\",\"url\":\"https://resumes.com/USER_1_Resume_10.13.pdf\",\"type\":\"cover_letter\"},{\"filename\":\"USER_1_Resume_10.13.pdf\",\"url\":\"https://prod-heroku.s3.amazonaws.com/person_attachments/USER_1_Resume_10.13.pdf\",\"type\":\"resume\"}],\"application_ids\":[1234],\"phone_numbers\":[{\"value\":\"123-345-5678\",\"type\":\"other\"}],\"addresses\":[],\"email_addresses\":[{\"value\":\"user_one@email.com\",\"type\":\"personal\"}],\"website_addresses\":[],\"social_media_addresses\":[]}]"
+    http_version: 
+  recorded_at: Wed, 23 Apr 2014 23:23:02 GMT
+recorded_with: VCR 2.5.0

data/spec/greenhouse_io/api/client_spec.rb

@@ -43,22 +43,23 @@ describe GreenhouseIo::Client do
       end
     end
 
-    describe "#set_rate_limits" do
+    describe "#set_headers_info" do
       before do
-        @headers = {
-          'x-ratelimit-limit' => '20',
-          'x-ratelimit-remaining' => '20'
-        }
+        VCR.use_cassette('client/headers') do
+          @client.candidates
+        end
       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)
+        expect(@client.rate_limit_remaining).to eq(19)
+      end
+
+      it "sets rest link" do
+        expect(@client.link).to eq('<https://harvest.greenhouse.io/v1/candidates/?page=1&per_page=100>; rel="last"')
       end
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: greenhouse_io
 version: !ruby/object:Gem::Version
-  version: 2.3.1
+  version: 2.4.0
 platform: ruby
 authors:
 - Greenhouse Software
@@ -25,20 +25,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.3.16
-- !ruby/object:Gem::Dependency
-  name: multi_json
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.11.2
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.11.2
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -147,6 +133,7 @@ files:
 - spec/fixtures/cassettes/client/create_candidate_note_invalid_user_id.yml
 - spec/fixtures/cassettes/client/department.yml
 - spec/fixtures/cassettes/client/departments.yml
+- spec/fixtures/cassettes/client/headers.yml
 - spec/fixtures/cassettes/client/job.yml
 - spec/fixtures/cassettes/client/job_post.yml
 - spec/fixtures/cassettes/client/jobs.yml
@@ -218,6 +205,7 @@ test_files:
 - spec/fixtures/cassettes/client/create_candidate_note_invalid_user_id.yml
 - spec/fixtures/cassettes/client/department.yml
 - spec/fixtures/cassettes/client/departments.yml
+- spec/fixtures/cassettes/client/headers.yml
 - spec/fixtures/cassettes/client/job.yml
 - spec/fixtures/cassettes/client/job_post.yml
 - spec/fixtures/cassettes/client/jobs.yml