simplificator-withings 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 pascalbetz
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,36 @@
+= simplificator-withings
+
+This is a ruby implementation for the Withings API. Description of the API can be found here: http://www.withings.com/en/api/
+
+== How To ==
+
+See sample.rb
+
+== Note on keys in hashes
+
+Keys to constructors (User, MeasurementGroup and NotificationDescription) and methods (User.measurement_groups)
+can be either of String or Symbol
+
+== Note on naming convention
+
+The WBS API has parameter with shortened names (e.g. 'grpid') or names not following a consistent naming pattern. While this
+API implementation tries to stick as close to the API as possible it also tries to unify and simplify the parameter names.
+The constructors for User, MeasurementGroup and NotificationDescription accept the names provided by the API but convert the names then
+to a more "ruby" way.
+An exception to this are the "id" and "publickey" parameters for User.new, they are accepted as "user_id" and "public_key" as well.
+
+
+
+== Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 simplificator. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,55 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "simplificator-withings"
+    gem.summary = %Q{API implementation for withings.com}
+    gem.description = %Q{A withings API implementation in ruby. Created for the evita project}
+    gem.email = "info@simplificator.com"
+    gem.homepage = "http://github.com/simplificator/simplificator-withings"
+    gem.authors = ["pascalbetz"]
+    gem.add_development_dependency 'shoulda'
+    gem.add_development_dependency 'mocha'
+    gem.add_dependency('httparty')
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "simplificator-withings #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/withings.rb

@@ -0,0 +1,6 @@
+require 'httparty'
+require 'digest/md5'
+
+%w(base notification_description connection measurement_group error user).each do |part|
+  require File.join(File.dirname(__FILE__), 'withings', part)
+end

data/lib/withings/base.rb

@@ -0,0 +1,14 @@
+module Withings
+end
+
+# Copied over from ActiveSupport
+unless Hash.new.respond_to?(:stringify_keys)
+  class Hash
+    def stringify_keys
+      inject({}) do |options, (key, value)|
+        options[key.to_s] = value
+        options
+      end
+    end
+  end
+end

data/lib/withings/connection.rb

@@ -0,0 +1,31 @@
+class Withings::Connection
+  include HTTParty
+  base_uri 'wbsapi.withings.net'
+  format :json
+
+  attr_reader :user
+  def initialize(user)
+    @user = user
+  end
+
+  def self.get_request(path, params)
+    response = self.get(path, :query => params)
+    verify_response!(response)
+  end
+
+  def get_request(path, params)
+    response = self.class.get(path, :query => params.merge(:publickey => user.public_key, :userid => user.user_id))
+    self.class.verify_response!(response)
+  end
+
+  protected
+  def self.verify_response!(response)
+    if response['status'] == 0
+      response['body'] || response['status']
+    else
+      raise ApiError.new(response['status'])
+    end
+
+  end
+
+end

data/lib/withings/error.rb

@@ -0,0 +1,23 @@
+class Withings::ApiError < StandardError
+  STATUS_CODES = {
+    100	  => "The hash is missing, invalid, or does not match the provided email",
+    247	  => "The userid is either absent or incorrect",
+    250	  => "The userid and publickey provided do not match, or the user does not share its data",
+    264	  => "The email address provided is either unknown or invalid",
+    293	  => "The callback URL is either absent or incorrect",
+    294	  => "No such subscription could be deleted",
+    304	  => "The comment is either absent or incorrect",
+    2554  => "Invalid Parameters . Not sure about this error message, it's not documented",
+    2555	=> "An unknown error occurred",
+  }
+
+  attr_reader :status
+  def initialize(status)
+    super(STATUS_CODES[status] || 'Undefined status code')
+    @status = status
+  end
+
+  def to_s
+    super + " - Status code: #{self.status}"
+  end
+end

data/lib/withings/measurement_group.rb

@@ -0,0 +1,71 @@
+class Withings::MeasurementGroup
+  ATTRIBUTION_SCALE = 0
+  ATTRIBUTION_SCALE_AMBIGUOUS = 1
+  ATTRIBUTION_SCALE_MANUALLY = 2
+  ATTRIBUTION_SCALE_MANUALLY_DURING_CREATION = 4
+
+  CATEGORY_MEASURE = 1
+  CATEGORY_TARGET = 2
+
+  TYPE_WEIGHT = 1
+  TYPE_SIZE = 4
+  TYPE_FAT_FREE_MASS_WEIGHT = 5
+  TYPE_FAT_RATIO = 6
+  TYPE_FAT_MASS_WEIGHT = 8
+
+  attr_reader :group_id, :attribution, :created_at, :category
+  attr_reader :weight, :height, :fat
+  def initialize(params)
+    params = params.keys_as_string
+    @group_id = params['grpid']
+    @attribution = params['attrib']
+    @created_at = Time.at(params['date'])
+    @category = params['category']
+    params['measures'].each do |measure|
+      value = (measure['value'] * 10 ** measure['unit']).to_f
+      case measure['type']
+      when TYPE_WEIGHT then @weight = value
+      when TYPE_SIZE then @height = value
+      when TYPE_FAT_MASS_WEIGHT then @fat = value
+      when TYPE_FAT_RATIO, TYPE_FAT_FREE_MASS_WEIGHT
+      else raise "Unknown #{measure.inspect}"
+      end
+    end
+  end
+
+  def measure?
+    self.category == CATEGORY_MEASURE
+  end
+
+  def target?
+    self.category == CATEGORY_TARGET
+  end
+
+  # while fat_ratio and fat_free_mass_weight is provided by the API as well i've seen responses where they were not included. Since
+  # they can be calculated as soon as weight and fat is provided we do it ourselves
+  def fat_ratio
+    (self.weight / self.fat) if self.weight && self.fat
+  end
+
+  def fat_free_weight
+    (self.weight - self.fat) if self.weight && self.fat
+  end
+
+
+  def bmi
+    if self.height && self.weight
+      self.weight / (self.height ** 2)
+    end
+  end
+
+  def to_s
+    "[ Weight: #{self.weight}, Fat: #{self.fat}, Height: #{self.height}, BMI: #{self.bmi}, Ratio: #{self.fat_ratio}, Free: #{self.fat_free_weight}, ID: #{self.group_id}]"
+  end
+
+  def inspect
+    self.to_s
+  end
+
+
+
+end

data/lib/withings/notification_description.rb

@@ -0,0 +1,13 @@
+class Withings::NotificationDescription
+  attr_reader :callback_url, :description, :expires_at
+  def initialize(params = {})
+    params = params.stringify_keys
+    @callback_url = params['callbackurl']
+    @description = params['comment']
+    @expires_at = Time.at(params['expires'])
+  end
+
+  def to_s
+    "[Notification #{self.callback_url} / #{self.description}, #{self.expires_at}]"
+  end
+end

data/lib/withings/user.rb

@@ -0,0 +1,110 @@
+class Withings::User
+  # Authenticate by email and password
+  def self.by_email(email, password)
+    response = Connection.get_request('/account', :action => :getuserslist, :email => email, :hash => auth_hash(email, password))
+    User.new(response['users'].first)
+  end
+  # Authenticate by user id and public key
+  def self.by_user_id(user_id, public_key)
+    response = Connection.get_request('/account', :action => :getbyuserid, :userid => user_id, :publickey => public_key)
+    User.new(response['users'].first)
+  end
+
+
+  attr_reader :short_name, :public_key, :user_id, :birthdate, :fat_method, :first_name, :last_name, :gender
+
+
+  #
+  # If you create a user yourself, then the only attributes of interest (required for calls to the API) are 'user_id' and 'public_key'
+  #
+  def initialize(params)
+    params = params.stringify_keys
+    @short_name = params['shortname']
+    @first_name = params['firstname']
+    @last_name = params['lastname']
+    @public_key = params['publickey']               || params['public_key']
+    @user_id = params['id']                         || params['user_id']
+    @share = params['ispublic'] == 1 ? true : false
+    @birthdate = Time.at(params['birthdate']) if params['birthdate']
+    @gender = params['gender'] == 0 ? :male : params['gender'] == 1 ? :female : nil
+    @fat_method = params['fatmethod']
+  end
+
+  def subscribe_to_notification(callback_url, description)
+    connection.get_request('/notify', :action => :subscribe, :callbackurl => callback_url, :comment => description)
+  end
+
+  def revoke_notification(callback_url)
+    connection.get_request('/notify', :action => :revoke, :callbackurl => callback_url)
+  end
+
+  def describe_notification(callback_url)
+    response = connection.get_request('/notify', :action => :get, :callbackurl => callback_url)
+    NotificationDescription.new(response.merge(:callbackurl => callback_url))
+  end
+
+
+  # list measurement groups
+  # - :per_page
+  # - :page
+  # - :category
+  # - :measurement_type
+  # - :start_at
+  # - :end_at
+  # - :last_udpated_at
+  #
+  # Parameters are described in WBS api, names are "rubyfied" (startdate -> start_at and so on)
+  def measurement_groups(params = {})
+    params = params.stringify_keys
+    options = {:limit => 100, :offset => 0}
+    options[:meastype] = params[:measurement_type] if params.has_key?(:measurement_type)
+    options[:category] = params[:category] if params.has_key?(:category)
+    options[:limit] =  params[:per_page] if params.has_key?(:per_page)
+    options[:offset] = ((params[:page] || 1) - 1) * options[:limit]
+    options[:startdate] = params[:start_at].to_i if params[:start_at]
+    options[:enddate] = params[:end_at].to_i if params[:end_at]
+    options[:lastupdate] = params[:last_update].to_i if params[:last_updated_at]
+
+    response = connection.get_request('/measure', options.merge(:action => :getmeas))
+    response['measuregrps'].map do |group|
+      MeasurementGroup.new(group)
+    end
+  end
+
+  # enable or disable sharing
+  def share=(value)
+    @share = value
+    connection.get_request('/user', :action => :update, :ispublic => is_public?)
+  end
+
+  # sharing enabled?
+  def share?
+    @share
+  end
+
+  def to_s
+    "[User #{short_name} / #{:user_id} / #{sharing?}]"
+  end
+
+
+  protected
+
+  def connection
+    @connection ||= Connection.new(self)
+  end
+
+  def self.auth_hash(email, password)
+    hashed_password = Digest::MD5.hexdigest(password)
+    Digest::MD5.hexdigest("#{email}:#{hashed_password}:#{once}")
+  end
+
+  def self.once()
+    Connection.get_request('/once', :action => :get)['once']
+  end
+
+  # convert from boolean (@share) to 1/0 as required by the API
+  def is_public?
+    @share ? 1 : 0
+  end
+
+end

data/sample.rb

@@ -0,0 +1,29 @@
+require 'rubygems'
+require 'lib/withings'
+
+# All classes are name-spaced
+include Withings
+
+# A user can be authenticated with email address and password
+user = User.by_email('<YOUR EMAIL ADDRESS>', '<YOUR PASSWORD>')
+
+# Or you can fetch details if you have the user id and public key
+user = User.by_user_id('<YOUR USER ID>', '<YOUR PUBLIC KEY>')
+
+# or if you already have user id and public key, you can create ir yourself
+user = User.new(:user_id => '<YOUR USER ID>', :public_key => '<YOUR PUBLIC_KEY>')
+
+# enable/disable sharing, disabling it will reset the public key
+user.share=true
+
+# subscribe for notification for url and pass a description
+user.subscribe_notification('http://foo.bar.com', 'test')
+
+# describe the notification for a given url, this is important for expiration dates
+user.describe_notification('http://foo.bar.com')
+
+# revoke notification for an url
+user.revoke_notification('http://foo.bar.com')
+
+# list measurement groups
+puts user.measurement_groups(:per_page => 10, :page => 1, :end_at => Time.now).join("\n")

data/test/helper.rb

@@ -0,0 +1,11 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+require 'mocha'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'withings'
+
+class Test::Unit::TestCase
+end

data/test/test_simplificator-withings.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestSimplificatorWithings < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

data/test/users_test.rb

@@ -0,0 +1,119 @@
+require 'helper'
+
+include Withings
+
+class UsersTest < Test::Unit::TestCase
+  context 'test connection calls' do
+    setup do
+      @user = User.new('user_id' => 12345, 'public_key' => 67890)
+    end
+    should 'update user' do
+      Withings::Connection.any_instance.expects(:get_request).with('/user', :action => :update, :ispublic => 1)
+      @user.share = true
+    end
+
+    should 'subscribe to notification' do
+      Withings::Connection.any_instance.expects(:get_request).with('/notify', :action => :subscribe, :callbackurl => 'http://schni.com', :comment => 'descri')
+      @user.subscribe_to_notification('http://schni.com', 'descri')
+    end
+
+    should 'revoke notification' do
+      Withings::Connection.any_instance.expects(:get_request).with('/notify', :action => :revoke, :callbackurl => 'http://schni.com')
+      @user.revoke_notification('http://schni.com')
+    end
+
+    context 'describe notification' do
+      setup do
+        Withings::Connection.
+          any_instance.expects(:get_request).with('/notify', :action => :get, :callbackurl => 'http://schni.com').
+          returns({'comment' => 'blabla', 'expires' => 1234})
+        @description = @user.describe_notification('http://schni.com')
+      end
+      should 'merge the callback url into the descripton' do
+        assert_equal 'http://schni.com', @description.callback_url
+      end
+
+      should 'contain the expires_at time' do
+        assert_equal Time.at(1234), @description.expires_at
+      end
+
+      should 'contain the description' do
+        assert_equal 'blabla', @description.description
+      end
+    end
+  end
+
+  context 'authentication by email' do
+    setup do
+      password = 'kongking'
+      email = 'king@kong.com'
+      once = 'abcdef'
+      hashed = Digest::MD5.hexdigest("#{email}:#{Digest::MD5.hexdigest(password)}:#{once}")
+      Connection.expects(:get_request).with('/once', :action => :get).returns({'once' => once})
+      Connection.expects(:get_request).with('/account', :action => :getuserslist, :email => email, :hash => hashed).
+        returns({'users' => [{}]})
+    end
+    should 'authenticate with hashed password' do
+      User.by_email('king@kong.com', 'kongking')
+    end
+  end
+
+  context 'authentication by user_id' do
+    setup do
+      user_id = 'kongking'
+      public_key = 'abcdef'
+      Connection.expects(:get_request).with('/account', :action => :getbyuserid, :userid => user_id, :publickey => public_key).
+        returns({'users' => [{}]})
+    end
+    should 'authenticate with hashed password' do
+      User.by_user_id('kongking', 'abcdef')
+    end
+  end
+
+
+  context 'constructor' do
+    should 'assign short_name' do
+      assert_equal 'Pascal', User.new('shortname' => 'Pascal').short_name
+    end
+    should 'assign first_name' do
+      assert_equal 'Pascal', User.new('firstname' => 'Pascal').first_name
+    end
+    should 'assign last_name' do
+      assert_equal 'Pascal', User.new('lastname' => 'Pascal').last_name
+    end
+
+    should 'assign public_key' do
+      assert_equal '1234', User.new('publickey' => '1234').public_key
+    end
+    should 'assign public_key with alternative key' do
+      assert_equal '1234', User.new('public_key' => '1234').public_key
+    end
+
+    should 'assign user_id' do
+      assert_equal '1234', User.new('id' => '1234').user_id
+    end
+    should 'assign user_id with alternative key' do
+      assert_equal '1234', User.new('user_id' => '1234').user_id
+    end
+
+
+    should 'assign share (to true)' do
+      assert_equal true, User.new('ispublic' => 1).share?
+    end
+    should 'assign share (to false)' do
+      assert_equal false, User.new('ispublic' => 0).share?
+    end
+
+    should 'assign gender (to true)' do
+      assert_equal :male, User.new('gender' => 0).gender
+    end
+    should 'assign gender (to false)' do
+      assert_equal :female, User.new('gender' => 1).gender
+    end
+
+    should 'assign fatmethod' do
+      assert_equal 2, User.new('fatmethod' => 2).fat_method
+    end
+
+  end
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification 
+name: simplificator-withings
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- pascalbetz
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-02 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+description: A withings API implementation in ruby. Created for the evita project
+email: info@simplificator.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/withings.rb
+- lib/withings/base.rb
+- lib/withings/connection.rb
+- lib/withings/error.rb
+- lib/withings/measurement_group.rb
+- lib/withings/notification_description.rb
+- lib/withings/user.rb
+- sample.rb
+- test/helper.rb
+- test/test_simplificator-withings.rb
+- test/users_test.rb
+has_rdoc: true
+homepage: http://github.com/simplificator/simplificator-withings
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: API implementation for withings.com
+test_files: 
+- test/helper.rb
+- test/test_simplificator-withings.rb
+- test/users_test.rb