https://github.com/hassanakbar/trackunit

TrackUnit REST API - Ruby
https://github.com/hassanakbar/trackunit

api-client api-wrapper rest-api ruby ruby-gem trackunit trackunit-api

Last synced: about 10 hours ago
JSON representation

TrackUnit REST API - Ruby

• Host: GitHub
• URL: https://github.com/hassanakbar/trackunit
• Owner: HassanAkbar
• License: mit
• Created: 2019-09-11T10:57:13.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2024-10-27T16:06:29.000Z (19 days ago)
• Last Synced: 2024-10-27T18:52:57.489Z (18 days ago)
• Topics: api-client, api-wrapper, rest-api, ruby, ruby-gem, trackunit, trackunit-api
• Language: Ruby
• Homepage:
• Size: 111 KB
• Stars: 3
• Watchers: 2
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
## TrackUnit Ruby

[![Build Status](https://travis-ci.com/HassanAkbar/trackunit.svg?branch=master)](https://travis-ci.com/HassanAkbar/trackunit) [![CodeFactor](https://www.codefactor.io/repository/github/hassanakbar/trackunit/badge)](https://www.codefactor.io/repository/github/hassanakbar/trackunit)

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/.

## Installation

Add this line to your application's Gemfile:

```ruby

gem 'trackunit'

```

And then execute:

    $ bundle install

Or install it yourself as:

    $ gem install trackunit

## Basic Usage

```ruby

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

```

## 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](https://rubygems.org).

## Contributing

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](http://contributor-covenant.org) code of conduct.

## License

The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

## Code of Conduct

Everyone interacting in the Trackunit project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/HassanAkbar/trackunit/blob/master/CODE_OF_CONDUCT.md).