The Kindara Client API gem will allow users to access their own Kindara cycle and day data through the Kindara API. Kindara is a popular period-tracking, fertility awareness method application that allows users to save daily temperature and other data points to track their health.
-
Add this line to your application's Gemfile:
`gem 'kindara-client', github: 'machikoyasuda/kindara-client-gem'
-
And then execute:
bundle
gem install kindara-client
require "kindara-client"
- Authenticate yourself with:
client = Kindara::Account.authenticate("YOUR-EMAIL", "YOUR-PASSWORD")
- Pull account information and save that as an Kindara::Account object:
account = Kindara::Account.info(client)
- Get all Days data as an Array of Kindara::Day objects:
days = Kindara::Day.pull(client)
- Get all Cycles data as an Array of Kindara::Cycle objects:
cycles = Kindara::Cycle.pull(client)
| model | description | code |
|---|---|---|
| account | Your personal account data | Kindara::Account |
| days | All data from each day | Kindara::Day |
| cycles | All data from each cycle | Kindara::Cycle |
average_cycle[float]average_luteal[float]average_period[float]username[string]
Day data returns a series of Day objects
date[date]updated[date]cycle_day[integer]temperature[float]questionable_temp[boolean]temp_shift[boolean]no_fluid[boolean]fluid_sticky[integer]fluid_creamy[integer]fluid_eggwhite[integer]fluid_watery[integer]cervix_height[integer]cervix_openness[integer]cervix_firmness[integer]opk[0,1]peak_day[boolean]sex[0,1,2]first_day[boolean]menstruationcustom[Array]notes
Cycle data returns a series of Cycle objects
bardo[boolean]coverline[integer or nil]custom[Array]end[date]pregnancy[boolean]start[date]temp_shift[date]updated[date]
To run the tests, make sure you have Rspec installed and run rspec
- Fork it
- Create your feature branch (
git checkout -b my-new-feature) - Commit your changes (
git commit -am 'Add some feature') - Run the specs (
rspec) - Push to the branch (
git push origin my-new-feature) - Create new Pull Request
- 1.0.0: Initial release