basis-band 0.3.0 → 0.3.1

data/README.md

@@ -6,51 +6,56 @@ 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.
 
-## Usage
+## Authentication
 
 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 (:).
+walking, running or biking state) uses an access token. The basis-band-login
+command takes a username and password and spits out both identifiers.
 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
+> miker $ basis-band-login -e mikerowehl@gmail.com -p pppppp
 ID for V1 api: 1234567890abcdef12345678
 token for V2 api: abcdef1234567890abcdef1234567890
 ```
 
 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:
+token is 'abcdef1234567890abcdef1234567890'. The userid lives for a long time,
+but the token needs to be refreshed each session. If you want to store the
+userid you can add it to a ~/.basis-band file, to avoid entering it on the
+command line every time. Just create a file like this as ~/.basis-band:
 
 ```
-> miker $ basis-band -u 1234567890abcdef12345678 -d 2013-10-14
-{"metrics":{"skin_temp":{"min":77.0,"max":95.0,"sum":113642.0,"summary":{"max_skin_temp_per_minute":null...
+---
+:userid: '1234567890abcdef12345678'
 ```
 
-If you want the metric data as CSV instead of raw JSON:
+## Data Retrieval
+
+The main basis-band command requires the name of a cache directory to use.
+You can either pass it on the command line using --cachedir, or add it to the
+~/basis-band initialization file. The cache directory must exist before
+running the commands.
+
+The default is to fetch metrics for a given day (expressed in YYYY-MM-DD
+format). Assuming you have userid and cachedir setup in your config file the
+commands look like below.
+
+To fetch metrics for a given day:
 
 ```
-> miker $ basis-band -u 1234567890abcdef12345678 -d 2013-10-14 -c
-t,state,skin_temp,heartrate,air_temp,calories,gsr,steps
-2013/10/01 00:00:00,inactive,83.8,58,80.6,1.3,0.000439,0
-2013/10/01 00:01:00,inactive,83.8,62,80.6,1.4,0.000402,0
-2013/10/01 00:02:00,inactive,83.8,64,80.6,1.4,0.000464,0
-...
+> miker $ basis-band -d 2013-10-14
+{"metrics":{"skin_temp":{"min":77.0,"max":95.0,"sum":113642.0,"summary":{"max_skin_temp_per_minute":null...
 ```
 
-If you already have the JSON in a local file, you can pass it in on standard
-input and transform it to CSV:
+If you want the metric data as CSV instead of raw JSON:
 
 ```
-> miker $ basis-band -c < cache/2013-10-14.json
+> miker $ basis-band -d 2013-10-14 -c
 t,state,skin_temp,heartrate,air_temp,calories,gsr,steps
 2013/10/01 00:00:00,inactive,83.8,58,80.6,1.3,0.000439,0
 2013/10/01 00:01:00,inactive,83.8,62,80.6,1.4,0.000402,0
@@ -59,10 +64,10 @@ t,state,skin_temp,heartrate,air_temp,calories,gsr,steps
 ```
 
 If you want the activity info for a given day pass in the access token using
--t and the date you want with -d:
+-t and set --type to 'activities'
 
 ```
-> miker $ basis-band -t abcdef1234567890abcdef1234567890 -d 2013-11-05 | python -mjson.tool
+> miker $ basis-band -t abcdef1234567890abcdef1234567890 -d 2013-11-05 -T activities | python -mjson.tool
 {
     "content": {
         "activities": [
@@ -85,15 +90,3 @@ If you want the activity info for a given day pass in the access token using
 ...
 ```
 
-## Optional
-
-The command line tool parses the ~/.basis-band file as YAML to pick up
-persistent options. So if you want to avoid having to keep passing the userid
-on the command line you can just add it to the options file:
-
-```
----
-:userid: '1234567890abcdef12345678'
-```
-
-And that value will be used as if you passed a -u to the command.

data/bin/basis-band

@@ -51,11 +51,18 @@ end.parse!
 b = BasisBand.new(options[:cachedir])
 
 if options[:summary]
-  all = b.data_for_all
+  all = b.metrics_for_all
+  puts "date,air_temp,calories,gsr,heartrate,skin_temp,steps"
   all.each do |k,v|
-    puts "Data for day #{k}"
+    line = [k]
     t = ApiResponseModel.new(v).summary
-    puts "  average air_temp = #{t["air_temp"]["avg"]}"
+    line << t['air_temp']['avg']
+    line << t['calories']['avg']
+    line << t['gsr']['avg']
+    line << t['heartrate']['avg']
+    line << t['skin_temp']['avg']
+    line << t['steps']['avg']
+    puts line.join(',')
   end
   exit
 end

data/lib/basis-band.rb

@@ -44,7 +44,7 @@ class BasisBand
   def metrics_for_all
     metrics = metrics_cache_files.collect { |f|
       date = File.basename(f, "_metrics.json")
-      [d, cached_value(f)]
+      [date, cached_value(f)]
     }
     Hash[metrics]
   end

data/lib/basis-band/version.rb

@@ -1,3 +1,3 @@
 module BasisBandMeta
-  VERSION = '0.3.0'
+  VERSION = '0.3.1'
 end

metadata

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