simplificator-withings 0.3.4 → 0.4.0

data/README.rdoc

@@ -2,6 +2,28 @@
 
 This is a ruby implementation for the Withings API. Description of the API can be found here: http://www.withings.com/en/api
 
+== Versions ==
+
+Note that this release (0.4.0) 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.
+
 == Installation
 
 gem install simplificator-withings
@@ -56,7 +78,7 @@ 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>')
+  user = User.userlist('<YOUR EMAIL ADDRESS>', '<YOUR PASSWORD>').first # or any other user which is returned
 
 Or you can fetch details if you have the user id and public key
   user = User.info('<YOUR USER ID>', '<YOUR PUBLIC KEY>')
@@ -65,6 +87,7 @@ If you already have user id and public key and you do not need further informati
   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() # share all
   user.share(Withings::SCALE, Withings::BLOOD_PRESSURE_MONITOR)
   user.share(0)
 
@@ -79,6 +102,8 @@ And finally you can get measurements, after all this is what it's for
   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
 

data/lib/withings/measurement_group.rb

@@ -19,13 +19,13 @@ class Withings::MeasurementGroup
   BLOOD_PRESSURE_MONITOR_TYPES = [TYPE_DIASTOLIC_BLOOD_PRESSURE, TYPE_SYSTOLIC_BLOOD_PRESSURE, TYPE_HEART_PULSE]
   SCALE_TYPES = [TYPE_WEIGHT, TYPE_SIZE, TYPE_FAT_FREE_MASS_WEIGHT, TYPE_FAT_RATIO, TYPE_FAT_MASS_WEIGHT]
 
-  attr_reader :group_id, :attribution, :created_at, :category
+  attr_reader :group_id, :attribution, :taken_at, :category
   attr_reader :weight, :size, :fat, :ratio, :fat_free, :diastolic_blood_pressure, :systolic_blood_pressure, :heart_pulse
   def initialize(params)
     params = params.stringify_keys
     @group_id = params['grpid']
     @attribution = params['attrib']
-    @created_at = Time.at(params['date'])
+    @taken_at = Time.at(params['date'])
     @category = params['category']
     params['measures'].each do |measure|
       value = (measure['value'] * 10 ** measure['unit']).to_f
@@ -43,6 +43,10 @@ class Withings::MeasurementGroup
     end
   end
 
+  def created_at
+    $stderr.puts "created_at has been deprecated in favour of taken_at. Please updated your code."
+  end
+
   def measure?
     self.category == CATEGORY_MEASURE
   end
@@ -52,7 +56,7 @@ class Withings::MeasurementGroup
   end
 
   def to_s
-    "[ Weight: #{self.weight}, Fat: #{self.fat}, Size: #{self.size}, Ratio: #{self.ratio}, Free: #{self.fat_free}, Blood Pressure: #{self.diastolic_blood_pressure}/#{self.systolic_blood_pressure} @ #{self.heart_pulse}, ID: #{self.group_id} (created at: #{self.created_at.strftime("%d.%m.%Y")})]"
+    "[ Weight: #{self.weight}, Fat: #{self.fat}, Size: #{self.size}, Ratio: #{self.ratio}, Free: #{self.fat_free}, Blood Pressure: #{self.diastolic_blood_pressure}/#{self.systolic_blood_pressure} @ #{self.heart_pulse}, ID: #{self.group_id} (created at: #{self.taken_at.strftime("%d.%m.%Y")})]"
   end
 
   def inspect

data/lib/withings/user.rb

@@ -1,9 +1,25 @@
 class Withings::User
   attr_reader :short_name, :public_key, :user_id, :birthdate, :fat_method, :first_name, :last_name, :gender
 
+
+  # Listing the users for this account
+  # 
+  def self.userlist(email, password)
+    response = Withings::Connection.get_request('/account', :action => :getuserslist, :email => email, :hash => auth_hash(email, password))
+    response['users'].map do |item|
+      Withings::User.new(item)
+    end
+  end
+  
+  
   # Authenticate a user by email/password
   #
   def self.authenticate(email, password)
+    $stderr.puts <<-EOS
+      User.authenticate(email, pwd) has been deprecated in favour of User.userlist(email, pwd) as there is no description or guarantee 
+      about the order the users are returned.
+      If you need the same behaviour as before: User.userlist(email, pwd).first
+    EOS
     response = Withings::Connection.get_request('/account', :action => :getuserslist, :email => email, :hash => auth_hash(email, password))
     Withings::User.new(response['users'].first)
   end
@@ -53,7 +69,7 @@ class Withings::User
   # - :start_at           (default: empty)
   # - :end_at             (default: empty)
   # - :last_udpated_at    (default: empty)
-  #
+  # - :device             (default: empty)
   # Parameters are described in WBS api
   def measurement_groups(params = {})
     params = params.stringify_keys
@@ -65,7 +81,7 @@ class Withings::User
     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_updated_at'].to_i if params['last_updated_at']
-
+    options[:devtype] = params['device'] if params['device']
     response = connection.get_request('/measure', options.merge(:action => :getmeas))
     response['measuregrps'].map do |group|
       Withings::MeasurementGroup.new(group)
@@ -86,7 +102,7 @@ class Withings::User
   def to_s
     "[User #{short_name} / #{:user_id} / #{share?}]"
   end
-
+  
 
   protected
 

data/simplificator-withings.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{simplificator-withings}
-  s.version = "0.3.4"
+  s.version = "0.4.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["pascalbetz"]

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: simplificator-withings
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 15
   prerelease: 
   segments: 
   - 0
-  - 3
   - 4
-  version: 0.3.4
+  - 0
+  version: 0.4.0
 platform: ruby
 authors: 
 - pascalbetz