simplificator-withings 0.1.1 → 0.2.0

data/README.rdoc

@@ -2,20 +2,74 @@
 
 This is a ruby implementation for the Withings API. Description of the API can be found here: http://www.withings.com/en/api/
 
+== Status
+The gem is still under development and the API might change a bit.
 
-== Installation ==
+== Installation
 
 gem install simplificator-withings
 
+== Authentication
 
-== How To ==
+The WBS API provides a way to login by user_id and public_key. You can either ask your users to enter the user_id/public_key manually
+(they can be found in the sharing overlay on my.withings.com) or ask them for email/password once and then use those credentials
+to authenticate through the API (User.authenticate(email, password)). The User instance returned will have the
+user_id and public_key attributes populated and you can store them for further use.
 
-See sample.rb
+As soon as you have user_id/public_key available you can either use User.info or User.new to create a User instance. While User.info
+will make an API call to populate the attributes, User.new just requires user_id/public_key.
+
+== Remarks
+
+* Authentication by user_id/public_key is only supported when the user has activated sharing. He can do this either in the sharing overlay on my.withings.com or through the api (user.share = true) after authentication by email/password
+* As soon as the user sets sharing to false (user.share = false) the public_key is reset and upon next activation of sharing (user.share = true) a new public_key is assigned.
+* All the methods making remote calls can throw Withing::ApiError if something goes wrong (wrong public_key, missing parameters, ...). You can find more details on the error by looking at the status code in the error.
+
+== How To
+
+Require the API implementation
+
+  require 'rubygems'
+  require 'withings'
+
+All classes are name-spaced, if your other code allows you can include Withings
+
+  include Withings
+
+A user can be authenticated with email address and password
+
+  user = User.authenticate('<YOUR EMAIL ADDRESS>', '<YOUR PASSWORD>')
+
+Or you can fetch details if you have the user id and public key
+
+  user = User.info('<YOUR USER ID>', '<YOUR PUBLIC KEY>')
+
+If you already have user id and public key and you do not need further information on the user
+
+  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
+
+You can handle subscriptions through the API
+
+  user.subscribe_notification('http://foo.bar.com', 'test subscription')
+  user.describe_notification('http://foo.bar.com')
+  user.revoke_notification('http://foo.bar.com')
+
+And finally you can get measurements, after all it's a scale
+
+  user.measurement_groups(:per_page => 10, :page => 1, :end_at => Time.now)
+  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)
 
 == Note on keys in hashes
 
 Keys to constructors (User, MeasurementGroup and NotificationDescription) and methods (User.measurement_groups)
-can be either of String or Symbol
+can be either String or Symbol
 
 == Note on naming convention
 
@@ -25,8 +79,6 @@ The constructors for User, MeasurementGroup and NotificationDescription accept t
 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.
@@ -37,6 +89,12 @@ An exception to this are the "id" and "publickey" parameters for User.new, they
   (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.
 
+== Dependencies
+
+HTTParty is used for making the HTTP requests and Shoulda and Mocha are used for testing.
+Thanks for these Gems.
+
+
 == Copyright
 
 Copyright (c) 2010 simplificator. See LICENSE for details.

data/Rakefile

@@ -1,47 +1,13 @@
 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.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'

data/lib/withings/measurement_group.rb

@@ -14,7 +14,7 @@ class Withings::MeasurementGroup
   TYPE_FAT_MASS_WEIGHT = 8
 
   attr_reader :group_id, :attribution, :created_at, :category
-  attr_reader :weight, :height, :fat
+  attr_reader :weight, :height, :fat, :ratio, :fat_free
   def initialize(params)
     params = params.keys_as_string
     @group_id = params['grpid']
@@ -27,7 +27,8 @@ class Withings::MeasurementGroup
       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
+      when TYPE_FAT_RATIO then @ratio = value
+      when TYPE_FAT_FREE_MASS_WEIGHT then @fat_free = value
       else raise "Unknown #{measure.inspect}"
       end
     end
@@ -41,17 +42,6 @@ class Withings::MeasurementGroup
     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)

data/lib/withings/user.rb

@@ -1,31 +1,23 @@
 class Withings::User
+  attr_reader :short_name, :public_key, :user_id, :birthdate, :fat_method, :first_name, :last_name, :gender
 
-  def self.authenticate(email_or_user_id, password_or_public_key)
-    if email_or_user_id.include?('@')
-      by_email(email_or_user_id, password_or_public_key)
-    else
-      by_user_id(email_or_user_id, password_or_public_key)
-    end
-  end
-
-  # Authenticate by email and password
-  def self.by_email(email, password)
+  # Authenticate a user by email/password
+  #
+  def self.authenticate(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)
+
+  def self.info(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']

data/simplificator-withings.gemspec

@@ -0,0 +1,59 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{simplificator-withings}
+  s.version = "0.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["pascalbetz"]
+  s.date = %q{2010-08-03}
+  s.description = %q{A withings API implementation in ruby. Created for the evita project}
+  s.email = %q{info@simplificator.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "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",
+     "simplificator-withings.gemspec",
+  ]
+  s.homepage = %q{http://github.com/simplificator/simplificator-withings}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{API implementation for withings.com}
+  s.test_files = [
+    "test/helper.rb",
+     "test/users_test.rb",
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<mocha>, [">= 0"])
+      s.add_runtime_dependency(%q<httparty>, [">= 0"])
+    else
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<mocha>, [">= 0"])
+      s.add_dependency(%q<httparty>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<mocha>, [">= 0"])
+    s.add_dependency(%q<httparty>, [">= 0"])
+  end
+end
+

data/test/users_test.rb

@@ -54,11 +54,11 @@ class UsersTest < Test::Unit::TestCase
         returns({'users' => [{}]})
     end
     should 'authenticate with hashed password' do
-      User.by_email('king@kong.com', 'kongking')
+      User.authenticate('king@kong.com', 'kongking')
     end
   end
 
-  context 'authentication by user_id' do
+  context 'info by user_id' do
     setup do
       user_id = 'kongking'
       public_key = 'abcdef'
@@ -66,7 +66,7 @@ class UsersTest < Test::Unit::TestCase
         returns({'users' => [{}]})
     end
     should 'authenticate with hashed password' do
-      User.by_user_id('kongking', 'abcdef')
+      User.info('kongking', 'abcdef')
     end
   end
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: simplificator-withings
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 23
   prerelease: false
   segments: 
   - 0
-  - 1
-  - 1
-  version: 0.1.1
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - pascalbetz
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-02 00:00:00 +02:00
+date: 2010-08-03 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -71,11 +71,9 @@ extra_rdoc_files:
 - README.rdoc
 files: 
 - .document
-- .gitignore
 - LICENSE
 - README.rdoc
 - Rakefile
-- VERSION
 - lib/withings.rb
 - lib/withings/base.rb
 - lib/withings/connection.rb
@@ -83,9 +81,8 @@ files:
 - lib/withings/measurement_group.rb
 - lib/withings/notification_description.rb
 - lib/withings/user.rb
-- sample.rb
+- simplificator-withings.gemspec
 - test/helper.rb
-- test/test_simplificator-withings.rb
 - test/users_test.rb
 has_rdoc: true
 homepage: http://github.com/simplificator/simplificator-withings
@@ -123,5 +120,4 @@ specification_version: 3
 summary: API implementation for withings.com
 test_files: 
 - test/helper.rb
-- test/test_simplificator-withings.rb
 - test/users_test.rb

data/.gitignore

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

data/VERSION

@@ -1 +0,0 @@
-0.1.1

data/sample.rb

@@ -1,29 +0,0 @@
-require 'rubygems'
-require 'withings'
-
-# All classes are name-spaced
-include Withings
-
-# A user can be authenticated with email address and password
-user = User.authenticate('<YOUR EMAIL ADDRESS>', '<YOUR PASSWORD>')
-
-# Or you can fetch details if you have the user id and public key
-user = User.authenticate('<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
-user.measurement_groups(:per_page => 10, :page => 1, :end_at => Time.now).join("\n")

data/test/test_simplificator-withings.rb

@@ -1,7 +0,0 @@
-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