wiscale 0.1.0 → 0.2.0

data/README.rdoc

@@ -2,6 +2,50 @@
 
 Ruby Wrapper for Withings Wifi Scale API
 
+== INSTALL:
+sudo gem install wiscale
+
+== SYNOPSIS:
+
+Setup: 
+  require 'wiscale' 
+  client = WiScale.new(:userid => 123, :publickey => 'asdlkfja')
+
+Get all measurements without any filters: 
+  measurements = client.get_meas
+
+Get only the last measurement: 
+  measurements = client.get_meas(:limit => 1)
+
+Get the last measurement as weight in lbs and %fat:
+  measurements[0].each do |rec|
+    type = rec['type'].to_i
+    value = (rec['value'].to_i * (10 ** rec['unit'])).to_f
+
+    if type == 6
+      puts "Fat %: " + value.round(2)
+    elsif type == 1
+      puts "Weight " + (value * 2.20462262).round(2) + " lb"
+    end
+  end
+
+Subscribe a URL to push notification: 
+  client.notify_subscribe('http://www.mytestingurl.com', 'this is a test')
+
+Get the notification you just created: 
+  client.notify_get('http://www.mytestingurl.com')
+
+Revoke the notification: 
+  client.notify_revoke('http://www.mytestingurl.com')
+
+
+Get all user information: 
+  client.get_by_userid
+
+Get a list of users for a logon: 
+  WiScale.get_users_list('myemail@address.com', 'mywithingspassword')
+
+
 == Note on Patches/Pull Requests
  
 * Fork the project.

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/credentials.yml.example

@@ -1,4 +1,6 @@
 # Change to a userid/publickey for running test suite
 
-userid : '60'
-publickey : 'fdb811'
+userid : 'userid_of_user'
+publickey : 'publickey_of_user'
+secret : 'secret_key_from_scale'
+mac : 'mac_address_of_scale'

data/lib/wiscale.rb

@@ -112,6 +112,65 @@ class WiScale
     end
   end
 
+  def scale_once()
+    ret_val = JSON.parse(HTTParty.get(scale_url + '/once', :query => {:action => 'get'}))
+    return ret_val['body']['once']
+  end
+
+  def compute_scale_hash(mac, secret)
+    once = scale_once
+    hash = mac + ':' + secret + ':' + once
+
+    Digest::MD5::hexdigest(hash)
+  end
+
+  def session_start(email, secret, mac)
+    hash = compute_scale_hash(mac, secret)
+
+    ret_val = JSON.parse(HTTParty.get(scale_url + '/session', :query => {:action => 'new', :auth => mac, :duration => '30', :hash => hash}))
+
+    if ret_val['status'] == 0
+      ret_val['body']['sessionid']
+    else
+      ret_val['status']
+    end
+
+  end
+
+  def session_delete(sessionid)
+    ret_val = JSON.parse(HTTParty.get(scale_url + '/session', :query => {:action => 'delete', :sessionid => sessionid}))
+    ret_val['status']
+  end
+
+  # Create a new measurements record for the user
+  # * email address of account owner
+  # * secret password of scale masquerading as
+  # * mac address of scale masquerading as
+  # * timestamp (epoch time) of measurement recording
+  # * weight value (in kg) of measurement
+  # * percent body fat of measurement
+  def meas_create(email, secret, mac, timestamp, weight, bodyfat)
+    session = session_start(email, secret, mac)
+
+    bfmass = (weight*bodyfat*10).to_i
+    weight = weight * 1000
+
+    meas_string = "{\"measures\":[{\"value\":'#{weight}',\"type\":1,\"unit\":-3},{\"value\":'#{bfmass}',\"type\":8,\"unit\":-3}]}"
+
+    ret_val = JSON.parse(HTTParty.get(scale_url + '/measure', :query => {
+      :action => 'store',
+      :sessionid => session,
+      :userid => userid,
+      :macaddress => mac,
+      :meastime => timestamp,
+      :devtype => '1',
+      :attribstatus => '0',
+      :measures => meas_string
+    }))
+
+    ret_val
+  end
+
   def compute_hash(email, passwd)
     once = get_once
     hash = email + ':' + Digest::MD5::hexdigest(passwd) + ':' + once
@@ -123,6 +182,10 @@ class WiScale
     @api_url || @api_url = 'http://wbsapi.withings.net'
   end
 
+  def scale_url
+    @scale_url || @scale_url = 'http://scalews.withings.net/cgi-bin'
+  end
+
   def userid
     @userid
   end

data/test/test_wiscale.rb

@@ -64,4 +64,26 @@ class TestWiscaleRuby < Test::Unit::TestCase
     end
   end
 
+  context "sessions" do
+    should "start and end session" do
+      config = YAML.load_file("credentials.yml")
+      client = WiScale.new()
+
+      sessionid = client.session_start('jon@digital-drip.com', config['secret'], config['mac'])
+      assert_equal 0, client.session_delete(sessionid)
+
+    end
+  end
+
+  context "create measurement" do
+    should "create a new measurement" do
+      config = YAML.load_file("credentials.yml")
+      client = WiScale.new(:userid => config['userid'], :publickey => config['publickey'])
+
+      ret_val = client.meas_create(config['email'], config['secret'], config['mac'], Time.now.to_i, 100, 50)
+      p 'got return val of: ' + ret_val.inspect
+    end
+  end
+
 end
+

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 1
+  - 2
   - 0
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Jon Gaudette