This library is designed to help ruby/rails based applications communicate with the publicly available REST API for Trackunit.

If you are unfamiliar with the Trackunit REST API, you should first read the documentation located at https://dev.trackunit.com/.

Add this line to your application's Gemfile:

gem 'trackunit'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install trackunit

require 'rubygems'
require 'trackunit'

# Create client (used to communicate with the API).
client = TrackUnit::Client.new(YOUR_TRACKUNIT_TOKEN)

# Retrieve list of Units (note: all communication must be made through the client).
units = client.units

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.

Bug reports and pull requests are welcome on GitHub at https://github.com/HassanAkbar/trackunit. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

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

Everyone interacting in the Trackunit project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.