Code Monkey home page Code Monkey logo

greenhouse_io's Introduction

Greenhouse IO

Gem Version Build Status Coverage Status

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

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  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

greenhouse_io's People

Contributors

adrianbautista avatar braidn avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.