`Teamtailor`¶ ↑

The teamtailor gem helps Ruby developers interact with their Teamtailor account, using classes that wrap the Teamtailor API.

Installation¶ ↑

Add this line to your application's Gemfile:

gem 'teamtailor'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install teamtailor

Usage¶ ↑

To use the library, you need an API key for a specific Teamtailor account, which you can create by signing in as an Admin in Teamtailor and generating a new key under Settings.

@client = Teamtailor::Client.new(
  base_url: 'https://api.teamtailor.com',
  api_token: '<PRIVATE API KEY>',
  api_version: 20161108
)

The gem does not automatically paginate through all the pages of an API endpoint is something you can do. The #has_next_page? method is helpful when knowing if there's more to fetch.

To fetch all jobs, you could do something like this:

current_page = 1
jobs = []

while (page_result = @client.jobs(page: current_page))
  jobs.append *page_result.records
  break unless page_result.has_next_page?
  current_page += 1
end

You can get all the titles through the #title method.

irb(main):041:0> jobs.map &:title
=> ["EmberJS Developer", "Ruby on Rails developer"]

Relationships¶ ↑

The API allows you to include associated data when requesting data to help you load associations without having to make any additional requests. To do this, you can pass what you want to include when making the request.

To fetch jobs with all associated users loaded, you can call Client#jobs like this:

irb(main):006:0> page_result = @client.jobs(page: 1, include: [:user])
irb(main):007:0> page_result.records.first.user.record.login_email
=> "admin@teamtailor.localhost"

If you try to access a relationship, without having included it when loading it from the server, it'll raise a Teamtailor::UnloadedRelationError:

irb(main):010:0> page_result = @client.jobs(page: 1, include: [])
irb(main):011:0> page_result.records.first.user.record
Traceback (most recent call last):
        ...
        1: from ~/teamtailor/lib/teamtailor/relationship.rb16:in `record'
Teamtailor::UnloadedRelationError (Teamtailor::UnloadedRelationError)

To check if a relation has been loaded or not you can use the Relationship#loaded? method to check before calling it:

irb(main):012:0> page_result = @client.jobs(page: 1, include: [:user])
irb(main):013:0> page_result.records.first.user.loaded?
=> true

Development¶ ↑

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing¶ ↑

Bug reports and pull requests are welcome on GitHub at github.com/teamtailor/teamtailor-rb.

License¶ ↑

The gem is available as open source under the terms of the MIT License.

Teamtailor¶ ↑