0.0
No commit activity in last 3 years
No release in over 3 years
Ruby API client for Qoolife, so you can easily plug it into your App
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 1.6
>= 0
>= 0

Runtime

 Project Readme

QoolifeApi - Ruby client for Qoolife API

Ruby API client for Qoolife, so you can easily plug it into your App.

Installation

Add this line to your application's Gemfile:

gem 'qoolife-api'

And then execute:

$ bundle

Or install it yourself as:

$ gem install qoolife-api

Usage

Most of QoolifeApi methods need authentication with a Qoolife account. You need to provide this data to the client like this:

QoolifeApi.authenticate 'myuser@example.com', 'veeerysekret'

After that, you can retrieve resources from the API using ActiveResource syntax.

Some examples:

QoolifeApi::JournalEntries.all # will retrieve a paginated collection of the authenticated users' journal entries
QoolifeApi::JournalEntries.last.measurements # measurements from the last journal entry
QoolifeApi::Conversation.all # conversations of any kind where the user is watcher.
QoolifeApi::Conversation.last.posts.last # last message post in the last conversation where the user is watcher.

Check the API docs for a full reference of what Qoolife API can do.

Contributing

  1. Fork it ( https://github.com/[my-github-username]/qoolife-api/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request