Merge pull request #19 from grnhse/NoRedInk-activity-feed-notes

Add create candidate notes method

CHANGES.md

@@ -2,6 +2,12 @@
 
 This project follows [semantic versioning](http://semver.org/).  This changelog follows suggestions from [keepachangelog.com](http://keepachangelog.com/).
 
+## Version 2.3.1
+Released 2016-04-20.
+
+#### Added
+- Added method `create_candidate_note`.  Thanks for contributing, [@jleven](https://github.com/jleven)!
+
 ## Version 2.3.0
 Released 2016-02-13.
 

README.md

@@ -116,6 +116,27 @@ If you've configured the gem with a default `api_token`, then you can just insta
 gh_client = GreenhouseIo::Client.new
 ```
 
+#### Listing candidates
+
+```
+gh_client.candidates
+```
+
+#### Creating a candidate note
+Use this method to attach a new note to a candidate.
+
+```
+candidate_id = 4567
+author_id = 123 # ID of the user who wrote this note
+note = {
+  :user_id => 123,
+  :message => "This candidate has very strong opinions about Node.JS.",
+  :visibility => "public"
+}
+
+gh_client.create_candidate_note(candidate_id, note, author_id)
+```
+
 #### Throttling
 
 Rate limit and rate limit remaining are available after making an API request with an API client:
@@ -135,7 +156,7 @@ gh_client.offices(id, page: 1, per_page: 2)
 
 #### Available methods
 
-Methods in which an `id` is optional:
+Methods for which an `id` is optional:
 
 * `offices`
 * `departments`
@@ -147,13 +168,14 @@ Methods in which an `id` is optional:
 * `all_scorecards`
 * `offers`
 
-Methods in which an `id` is **required**:
+Methods for which an `id` is **required**:
 
 * `activity_feed` *(requires a candidate ID)*
 * `scorecards` *(requires an application ID)*
 * `scheduled_interviews` *(requires an application ID)*
 * `stages` *(requires a job ID)*
 * `job_post` *(requires a job ID)*
+* `create_candidate_note` *(requires a candidate ID)*
 
 ## Contributing
 
@@ -162,3 +184,5 @@ Methods in which an `id` is **required**:
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+
+Contributions are always welcome!

lib/greenhouse_io.rb

@@ -1,6 +1,6 @@
 require 'httmultiparty'
 require 'multi_json'
-require 'cgi'
+require 'json'
 
 require "greenhouse_io/version"
 require "greenhouse_io/error"

lib/greenhouse_io/api/client.rb

@@ -32,6 +32,14 @@ def activity_feed(id, options = {})
       get_from_harvest_api "/candidates/#{id}/activity_feed", options
     end
 
+    def create_candidate_note(candidate_id, note_hash, on_behalf_of)
+      post_to_harvest_api(
+        "/candidates/#{candidate_id}/activity_feed/notes",
+        note_hash,
+        { 'On-Behalf-Of' => on_behalf_of.to_s }
+      )
+    end
+
     def applications(id = nil, options = {})
       get_from_harvest_api "/applications#{path_id(id)}", options
     end
@@ -79,8 +87,29 @@ def permitted_options(options)
     end
 
     def get_from_harvest_api(url, options = {})
-      response = get_response(url, query: permitted_options(options), basic_auth: basic_auth)
+      response = get_response(url, {
+        :query => permitted_options(options), 
+        :basic_auth => basic_auth
+      })
+
+      set_rate_limits(response.headers)
+
+      if response.code == 200
+        parse_json(response)
+      else
+        raise GreenhouseIo::Error.new(response.code)
+      end
+    end
+
+    def post_to_harvest_api(url, body, headers)
+      response = post_response(url, {
+        :body => JSON.dump(body),
+        :basic_auth => basic_auth,
+        :headers => headers
+      })
+
       set_rate_limits(response.headers)
+
       if response.code == 200
         parse_json(response)
       else

lib/greenhouse_io/version.rb

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