Skip to content

Latest commit

 

History

History
142 lines (106 loc) · 4.82 KB

README.md

File metadata and controls

142 lines (106 loc) · 4.82 KB
Raw

Withings API Ruby Gem

Build Status Code Climate Test Coverage Dependency Status Gem Version

This gem provides access to data collected by Withings devices through their HTTP API.

Installation

Add this line to your application's Gemfile:

gem 'withings-sdk'

And then execute:

$ bundle

Or install it yourself as:

$ gem install withings-sdk

Usage

Authorization

Withings uses OAuth 1.0a for API authorization. If you're unfamiliar with OAuth, you can read about it here or you can read the full spec if you're feeling brave.

Before you can make requests to the Withings API, you must first obtain user authorization and generate an Access Token. Before you can write an application that uses the Withings API you must register and obtain consumer credentials.

The following examples assume you are using a web framework such as Sinatra.

client = WithingsSDK::Client.new({
  consumer_key: 'YOUR_CONSUMER_KEY',
  consumer_secret: 'YOUR_CONSUMER_SECRET'
})

request_token = client.request_token({
  oauth_callback: 'YOUR_OAUTH_CALLBACK'
})

authorize_url = client.authorize_url(request_token.token, request_token.secret)
redirect authorize_url

When the user has finished authorizing your application, they will be redirected to the callback URL you specified with the following parameters in the query string: userid, oauth_token and oauth_verifier. Store these parameters as you'll need them later.

client = WithingsSDK::Client.new({
  consumer_key: 'YOUR_CONSUMER_KEY',
  consumer_secret: 'YOUR_CONSUMER_SECRET'
})

client.access_token(request_token.token, request_token.secret, {
  oauth_verifier: 'OAUTH_VERIFIER'
})

Making Requests

Now that you have an authorized access token, you can create a WithingsSDK::Client instance:

client = WithingsSDK::Client.new do |config|
  config.consumer_key        = 'YOUR_CONSUMER_KEY'
  config.consumer_secret     = 'YOUR_CONSUMER_SECRET'
  config.token               = 'YOUR_ACCESS_TOKEN'
  config.secret              = 'YOUR_ACCESS_TOKEN_SECRET'
end

Now you can make authenticated requests on behalf of a user. For example, to get a list of activity measures, you can use the following example:

activities = client.activities(user_id, { startdateymd: '2015-01-01', enddateymd: '2015-02-28' })
activities.each do |activity|
  if activity.is_a?(WithingsSDK::Activity)
    puts "Date: #{activity.date}, Steps: #{activity.steps}"
  end
end

Dates

Many of the Withings API endpoints accept a date parameter in either YYYY-MM-DD format or as a unix epoch. This gem tries to simplify date handling by allowing you to specify either, or a Date or DateTime instance. For example:

client = WithingsSDK::Client.new { options }
sleep_details = client.sleep_series(user_id, {
  startdate: DateTime.new(2015, 2, 20, 12, 0, 0),
  enddate: DateTime.new(2015, 2, 21, 12, 20, 0)
})

Or equivalently,

client = WithingsSDK::Client.new { options }
sleep_details = client.sleep_series(user_id, {
  startdate: '2015-02-20',
  enddate: '2015-02-21'
})

Development

After checking out the repo, run bin/setup to install dependencies. Then, 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 to create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

  1. Fork it ( https://github.com/paulosman/withings-sdk/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