Dead-simple Ruby API client for workable.com. No extra runtime dependencies. Ruby >= 1.9.3.
Uses v2 API provided by workable.
Add this line to your application's Gemfile:
gem 'workable'And then execute:
$ bundle
Or install it yourself as:
$ gem install workable
Internal interface / api is in early stage, so far you can:
- fetch jobs
- fetch job details
- fetch candidates for given job
client = Workable::Client.new(api_key: 'api_key', subdomain: 'your_subdomain')
# takes optional phase argument (string): 'published' (default), 'draft', 'closed' or 'archived'
client.jobs # => Array of hashes
shortcode = client.jobs.first["shortcode"]
# API queries are not cached (at all) - it's up to you to cache results one way or another
client.stages # => Array of hashes
client.recruiters # => Array of hashes
client.job_details(shortcode) # => Hash
client.job_questions(shortcode) # => Array of hashes
client.job_candidates(shortcode, stage_slug) # => Array of hashes (stage_slug is optional)
# Adding candidates - candidate is a Hash as described in:
# http://resources.workable.com/add-candidates-using-api
client.create_job_candidate(candidate, shortcode, stage_slug) # => Hash (stage_slug is optional)
# Possible errors (each one inherits from Workable::Errors::WorkableError)
Workable::Errors::InvalidConfiguration # missing api_key / subdomain
Workable::Errors::NotAuthorized # wrong api key
Workable::Errors::InvalidResponse # something when wrong during the request?
Workable::Errors::NotFound # 404 from workable
Workable::Errors::RequestToLong # When the requested result takes to long to calculate, try limiting your queryWhen creating Client you can specify extra methods/Procs for
automated transformation of results and input.
client = Workable::Client.new(
api_key: 'api_key',
subdomain: 'your_subdomain'
transform_to: {
candidate: OpenStruct.method(:new)
}
transform_from: {
candidate: Proc.new { |input| input.to_h }
}
)The first transformation to will make the Client return
OpenStruct.new(result) instead of just plain result everywhere where
candidate is expected. In case of Arrays the transformation will be
applied to every element.
The second transformation from will expect an instance of OpenStruct
instead of raw data and will execute the to_h on the instance before
sending it to workable API.
The rest of result will be returned as Arrays/Hashes,
no transformation will be applied if not defined - raw data will be
returned.
- Fork it ( https://github.com/emq/workable/fork )
- 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 a new Pull Request