Project

turrialba

0.0
No commit activity in last 3 years
No release in over 3 years
A Ruby interface to the Turrialba API.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 1.14
~> 10.0
~> 3.0

Runtime

~> 0.14.0
~> 2.0
~> 0.4.0
~> 1.0
 Project Readme

Turrialba

This is a small gem that wraps the Turrialba server API.

Installation

Add this line to your application's Gemfile:

gem 'turrialba'

And then execute:

$ bundle

Or install it yourself as:

$ gem install turrialba

Usage

The api is available with the Client object:

client = Turrialba::Client.new
user = client.user(360962402) # Fetches a user by uid

By default, the server authenticates requests using a X-AUTH-TOKEN header. Defaults are set for server url (localhost:3000) and auth token (hashlol). A custom server url will need to be set using TURRIALBA_URL ENV variable. You can initialize the Client with a custom auth token.

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 https://github.com/fdoxyz/turrialba-gem.

License

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