Greenhouse IO

A Ruby interface to Greenhouse.io's API (requires Ruby 1.9.3 or greater).

Installation

Add this line to your application's Gemfile:

gem 'greenhouse_io'

And then execute:

$ bundle

Or install it yourself as:

$ gem install greenhouse_io

Usage

Creating an instance of the API client:

gh = GreenhouseIo::API.new("api_token")

The client will also use the environment variable 'GREENHOUSE_API_TOKEN' by default:

gh = GreenhouseIo::API.new

A default organization can be passed through an options hash:

gh = GreenhouseIo::API.new("api_token", :organization => "your_organization")

Fetching Office Data

gh.offices
gh.offices(:organization => 'different_organization')
# returns a hash containing all of the organization's department and jobs grouped by office

gh.office(officeID)
gh.office(officeID, :organization => 'different_organization')
# returns a hash containing the departments and jobs of a specific office

Fetching Department Data

gh.departments
gh.departments(:organization => 'different_organizaton')

gh.department(departmentID)
gh.department(departmentID, :organization => 'different_organization')

Fetching Job Data

gh.jobs
gh.jobs(:content => 'true')
# includes the job description in the response
gh.jobs(:organization => 'different_organization')

gh.job(jobID)
gh.job(jobID, :questions => true)
# returns the specified job and the array of questions on the application
gh.job(jobID, :organization => 'different_organization')

Submitting a Job Application

This is the only API method that requires an API token from Greenhouse

gh.apply_to_job(form_parameter_hash)

# form_parameter_hash should match the questions array of a given job opening
# there should be a hidden input with name id in your form that
# has the value of the job ID on Greenhouse.io

Contributing

Fork it
Create your feature branch (git checkout -b my-new-feature)
Commit your changes (git commit -am 'Add some feature')
Push to the branch (git push origin my-new-feature)
Create new Pull Request

pebble / greenhouse_io