basis-band 0.0.4 → 0.1.0

data/README.md

@@ -1,23 +1,31 @@
 # Basis API Access Gem
 
+[![Gem Version](https://badge.fury.io/rb/basis-band.png)](http://badge.fury.io/rb/basis-band)
+
 Includes a command line tool that can be used to either capture the raw JSON
 responses from app.mybasis.com, or to convert the metrics from the API
 responses into CSV.
 
-First off you need to find your userid. The command line tool now provides an
-option to output your userid given a username and password on the command line.
-Just pass the username and password joined with a colon (:) using the -l
-option and you'll get your userid back as output. Assuming your username is
+## Usage
+
+There are two different versions of the API available at app.mybasis.com. The
+V1 API (which holds most of the detailed data about heartrate and steps) uses a
+user id, while the V2 API (which holds information about activities like
+walking, running or biking state) uses an access token. You can use the -l
+option to the command line tool to dump out both values.
+Just pass the username and password joined with a colon (:).
+Assuming your username is
 'mikerowehl@gmail.com' and your password is 'pppppp' the command would look
 like this:
 
 ```
 > miker $ basis-band -l mikerowehl@gmail.com:pppppp
-1234567890abcdef12345678
+ID for V1 api: 1234567890abcdef12345678
+token for V2 api: abcdef1234567890abcdef1234567890
 ```
 
-In this example the userid returned is '1234567890abcdef12345678'. In the rest
-of the examples the userid is abbreviated to 'xxxxx'.
+In this example the userid returned is '1234567890abcdef12345678' and the 
+token is 'abcdef1234567890abcdef1234567890'.
 
 If you pass -u and -d options the raw text will be fetched from the API and
 output on standard output:
@@ -50,7 +58,29 @@ t,state,skin_temp,heartrate,air_temp,calories,gsr,steps
 ...
 ```
 
-For additional information see the PHP example at
-[https://github.com/btroia/basis-data-export](https://github.com/btroia/basis-data-export).
-That example includes instructions for finding your userid.
+If you want the activity info for a given day pass in the access token using
+-t and the date you want with -d:
 
+```
+> miker $ basis-band -t abcdef1234567890abcdef1234567890 -d 2013-11-05 | python -mjson.tool
+{
+    "content": {
+        "activities": [
+            {
+                "actual_seconds": 1323,
+                "calories": 118.8,
+                "end_time": {
+                    "iso": "2013-11-05T22:38:25Z",
+                    "time_zone": {
+                        "name": "America/Los_Angeles",
+                        "offset": -480
+                    },
+                    "timestamp": 1383691105
+                },
+                "heart_rate": {
+                    "avg": null,
+                    "max": null,
+                    "min": null
+                },
+...
+```

data/bin/basis-band

@@ -26,21 +26,47 @@ OptionParser.new do |opts|
   opts.on("-c", "--[no-]csv", "Output CSV format") do |c|
     options[:csv] = c
   end
+  opts.on("-C", "--cachedir DIR", "Directory to use to cache results") do |c|
+    options[:cachedir] = c
+  end
   opts.on("-l", "--login username:password", "Login and print user id") do |l|
     options[:login] = l
   end
+  opts.on("-s", "--summary", "Summarize all the data from the cache") do |s|
+    options[:summary] = s
+  end
+  opts.on("-t", "--token TOKEN", "Token for v2 API access") do |t|
+    options[:token] = t
+  end
 end.parse!
 
 if options[:login]
   (u,p) = options[:login].split(":", 2)
-  a = ApiAuth.new
-  puts a.login(u, p)
+  token, id = ApiAuth.new.login(u, p)
+  puts "ID for V1 api: #{id}"
+  puts "token for V2 api: #{token}"
+  exit
+end
+
+b = BasisBand.new(options[:userid])
+if options[:cachedir]
+  b.set_cache_dir(options[:cachedir])
+end
+
+if options[:summary]
+  all = b.data_for_all
+  all.each do |k,v|
+    puts "Data for day #{k}"
+    t = ApiResponseModel.new(v).summary
+    puts "  average air_temp = #{t["air_temp"]["avg"]}"
+  end
   exit
 end
 
 if options[:userid] and options[:date]
-  b = BasisBand.new(options[:userid])
   raw = b.data_for_day(options[:date])
+elsif options[:token] and options[:date]
+  raw = b.fetch_activities_for_day(options[:date], options[:token])
 else
   raw = $stdin.read
 end

data/lib/basis-band.rb

@@ -4,12 +4,66 @@ require 'basis-band/api-auth'
 require 'basis-band/api-response-model'
 
 class BasisBand
+  @cache_dir = nil
+
   def initialize(userid)
     @userid = userid
   end
 
+  def set_cache_dir(dir)
+    @cache_dir = dir
+  end
+
   def data_for_day(date)
+    r = cached_value_for_day(date)
+    if !r
+      r = fetch_value_for_day(date)
+    end
+    r
+  end
+
+  def data_for_all
+    all = all_cache_files.collect do |f|
+      d = File.basename(f, ".json")
+      [d, cached_value_for_day(d)]
+    end
+    Hash[all]
+  end
+
+  def cache_filename(date)
+    File.join(@cache_dir, date + ".json")
+  end
+
+  def all_cache_files()
+    Dir[File.join(@cache_dir, "*.json")]
+  end
+
+  def cached_value_for_day(date)
+    raw = nil
+    begin
+      File.open(cache_filename(date), "r") { |f|
+        raw = f.read
+      }
+    rescue
+      # ignore exception
+    end
+    raw
+  end
+
+  def fetch_value_for_day(date)
+    f = ApiFetch.new()
+    raw = f.get_day(@userid, date)
+    if raw && @cache_dir
+      File.open(cache_filename(date), "w") { |f|
+        f.write(raw)
+      }
+    end
+    raw
+  end
+
+  def fetch_activities_for_day(date, token)
     f = ApiFetch.new()
-    f.get_day(@userid, date)
+    raw = f.get_activities(token, date)
+    raw
   end
 end

data/lib/basis-band/api-auth.rb

@@ -7,7 +7,7 @@ class ApiAuth
 
   def login(username, password)
     token = auth_request(username, password)
-    get_user_id(token)
+    [token, get_user_id(token)]
   end
 
   def auth_request(username, password)

data/lib/basis-band/api-fetch.rb

@@ -31,6 +31,10 @@ class ApiFetch
     "https://app.mybasis.com/api/v1/chart/#{userid}.json?#{f}&#{m}"
   end
 
+  def activities_url(date)
+    "https://app.mybasis.com/api/v2/users/me/days/#{date}/activities?expand=activities&type=run,walk,bike"
+  end
+
   def https_fetch(url)
     u = URI.parse(url)
     http = Net::HTTP.new(u.host, u.port)
@@ -40,8 +44,23 @@ class ApiFetch
     http.request(request).body
   end
 
+  def https_fetch_v2(url, token)
+    u = URI.parse(url)
+    http = Net::HTTP.new(u.host, u.port)
+    http.use_ssl = true
+    http.verify_mode = OpenSSL::SSL::VERIFY_PEER
+    request = Net::HTTP::Get.new(u.request_uri)
+    request.add_field('Cookie', "access_token=#{token}; scope=login")
+    http.request(request).body
+  end
+
   def get_day(userid, date, summary = true, body_states = true, skip_metrics = [])
     res = https_fetch(url(userid, date, summary, body_states, skip_metrics))
     res
   end
+
+  def get_activities(token, date)
+    res = https_fetch_v2(activities_url(date), token)
+    res
+  end
 end

data/lib/basis-band/api-response-model.rb

@@ -38,4 +38,16 @@ class ApiResponseModel
       hash_for_minute(x)
     }
   end
+
+  def metric_summary(metric)
+    {"avg" => @json["metrics"][metric]["avg"]}
+  end
+
+  def summary
+    res = {}
+    for m in @json["metrics"].keys
+      res[m] = metric_summary(m)
+    end
+    res
+  end
 end

data/lib/basis-band/version.rb

@@ -1,3 +1,3 @@
 module BasisBandMeta
-  VERSION = '0.0.4'
+  VERSION = '0.1.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: basis-band
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-28 00:00:00.000000000 Z
+date: 2013-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json