Project

todaysplan

0.0
No commit activity in last 3 years
No release in over 3 years
A Ruby Library for TodaysPlan
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

 Project Readme

Build Status

todaysplan-ruby

A Ruby Library for TodaysPlan

This library is currently limited to only a few API calls needed. Feel free to do Pull Request to include additional calls.

Installation

Add the gem to your app

gem 'todaysplan-ruby', require: 'todays_plan

Usage

To authenticate with TodaysPlan API by setting the username and password variables

TodaysPlan.username = 'email@example.com'
TodaysPlan.password = 'secret'
athletes = TodaysPlan::Athlete.all

or create a TodaysPlan client and pass the client to the method

client = TodaysPlan::Client.new('email@example.com','secret')
athletes = TodaysPlan::Athlete.all(client)

Testing

You can test live data by setting your credentials in todays_plan.yml. If this file exists, live connections can be made and log the response to the console.

---
username: 'email@example.com'
password: 'secret'
endpoint: 
timeout: 120 
logger: 'stdout'
debug: true