README.rdoc in simplificator-withings-0.6.6 vs README.rdoc in simplificator-withings-0.6.8

- old
+ new

@@ -2,10 +2,19 @@ This is a ruby implementation for the Withings API. Description of the API can be found here: http://www.withings.com/en/api == Versions == +=== 0.6.8 === + +* updated README (thanks to jmaddi) + +=== 0.6.7 === + +* Swap ruby-hmac for openssl +* Allow string userid in User.authenticate + === 0.6.6 === Added list_notifications method to user. === 0.6.3 === @@ -31,20 +40,20 @@ Note that this release breaks the API of previous releases: === User.authenticate === User.authenticate() has been replaced by User.userlist - + There is no description available and no guarantee on the order that users are returned by the API (and yes, there can be many users for a single Account) so it seems best to leave the decision to the users of the API. The old method is still there but please update your code. It will be removed in the next release. === MeasurementGroup === MeasurementGroup#createt_at has been replaced by MeasurementGroup#taken_on - + Created at is usually the timestamp at which a record was created. But MeasurementGroup#created_at was the timestamp when you actually took the measurement. You can also take measurements (via the Web UI on withings.com) which are for a past date. The record is created today, but the measurement was taken on 2 weeks ago. The old method is still there but please update your code. It will be removed in the next release. @@ -93,11 +102,11 @@ require 'rubygems' require 'withings' All classes are name-spaced, if your other code allows you can include Withings include Withings - + Setup Withings.consumer_secret = '1234' Withings.consumer_key = 'abcd' @@ -105,13 +114,13 @@ user = User.authenticate('<YOUR USER ID>', '<YOUR OAUTH TOKEN>', '<YOUR OAUTH TOKEN SECRET>') You can handle subscriptions through the API (all devices currently known => Scale + Blood Pressure Monitor) user.subscribe_notification('http://foo.bar.com', 'test subscription') -Specify what devices you are interested +Specify what devices you are interested user.subscribe_notification('http://foo.bar.com', 'test subscription', Withings::SCALE, Withings::BLOOD_PRESSURE_MONITOR) - + user.describe_notification('http://foo.bar.com') user.revoke_notification('http://foo.bar.com') List notifications is now possible user.list_notifications @@ -121,10 +130,10 @@ user.measurement_groups(:category => MeasurementGroup::CATEGORY_TARGET) user.measurement_groups(:last_updated_at => Time.at(12345)) user.measurement_groups(:start_at => Time.at(12345), :end_at => Time.at(67890)) user.measurement_groups(:measurement_type => MeasurementGroup::TYPE_FAT) user.measurement_groups(:device => Withings::SCALE) - + == Note on keys in hashes Keys to constructors (User, MeasurementGroup and NotificationDescription) and methods (User.measurement_groups) can be either String or Symbol