fitgem 0.4.0 → 0.5.0

data/README.md

@@ -2,7 +2,7 @@
 
 Provides access to fitbit.com data through their OAuth/REST API.  Fitgem can pull data with or without user authentication. Without user authentication, any data that the a fitbit.com user has denoted as 'public' can be gathered.  If a user logs in via OAuth then all exposed data can be gathered.
 
-The fitbit.com API is currently (Late 2011) in BETA and is under development to extend its reach.  Since it is early in the lifecycle of the API I expect this gem to go through a number of revisions as we attempt to match the functionality of their platform.
+The fitbit.com API is currently (Early 2012) in BETA and is under development to extend its reach.  Since it is early in the lifecycle of the API I expect this gem to go through a number of revisions as we attempt to match the functionality of their platform.
 
 # Usage #
 
@@ -15,7 +15,7 @@ $ gem install fitgem
 
 ## Usage in a Rails Application ##
 
-We've started to develop an example app using the fitgem client.  See [https://github.com/whazzmaster/fitgem-client](https://github.com/whazzmaster/fitgem-client) for more information or check out [the hosted version](http://www.fitbit-client.com). The fitgem-client project is evolving more slowly than the library itself, but work continues.
+We've started to develop an example app using the fitgem client.  See [https://github.com/whazzmaster/fitgem-client](https://github.com/whazzmaster/fitgem-client) for more information or check out [the hosted version](http://www.fitbitclient.com). The fitgem-client project is evolving more slowly than the library itself, but work continues.
 
 # Subscriptions #
 

data/fitgem.gemspec

@@ -55,6 +55,9 @@ Gem::Specification.new do |s|
     'lib/fitgem/units.rb',
     'lib/fitgem/users.rb',
     'lib/fitgem/water.rb',
+    'lib/fitgem/blood_pressure.rb',
+    'lib/fitgem/glucose.rb',
+    'lib/fitgem/heart_rate.rb',
     'spec/fitgem_spec.rb',
     'spec/spec_helper.rb',
     'spec/fitgem_notifications_spec.rb',

data/lib/fitgem/blood_pressure.rb

@@ -0,0 +1,48 @@
+module Fitgem
+  class Client
+    # ==========================================
+    #       Blood Pressure Retrieval Methods
+    # ==========================================
+
+    # Get blood pressure log entries for the supplied date
+    #
+    # @param [DateTime, Date, String] date
+    # @return [Hash] Hash containing an average of the days logs, and a
+    #   list of all individual entries
+    def blood_pressure_on_date(date)
+      get("/user/#{@user_id}/bp/date/#{format_date(date)}.json")
+    end
+
+    # ==========================================
+    #        Blood Pressure Logging Methods
+    # ==========================================
+
+    # Log blood pressure information to fitbit
+    #
+    # @param [Hash] opts Heart rate data
+    # @option opts [Integer, String] :systolic Systolic measurement (REQUIRED)
+    # @option opts [Integer, String] :diastolic Diastolic measurement (REQUIRED)
+    # @option opts [DateTime, Date, String] :date Log entry date (REQUIRED)
+    # @option opts [DateTime, Time, String] :time Time of the measurement; hours and minutes in the format HH:mm
+    #
+    # @return [Hash] Summary of logged information
+    def log_blood_pressure(opts)
+      unless opts[:systolic] && opts[:diastolic] && opts[:date]
+        raise Fitgem::InvalidArgumentError, "Must include :systolic, :diastolic, and :date in order to log blood pressure data"
+      end
+
+      opts[:date] = format_date(opts[:date])
+      opts[:time] = format_time(opts[:time]) if opts[:time]
+      post("/user/#{@user_id}/bp.json", opts)
+    end
+
+    # Delete logged blood pressure information
+    #
+    # @param [Integer, String] blood_pressure_log_id The id of previously logged
+    #   blood pressure data
+    # @return [Hash] Empty hash denotes success
+    def delete_blood_pressure_log(blood_pressure_log_id)
+      delete("/user/-/bp/#{blood_pressure_log_id}.json")
+    end
+  end
+end

data/lib/fitgem/client.rb

@@ -5,6 +5,9 @@ require 'fitgem/users'
 require 'fitgem/activities'
 require 'fitgem/sleep'
 require 'fitgem/water'
+require 'fitgem/blood_pressure'
+require 'fitgem/glucose'
+require 'fitgem/heart_rate'
 require 'fitgem/units'
 require 'fitgem/foods'
 require 'fitgem/friends'
@@ -32,7 +35,7 @@ module Fitgem
     # @example Set this using the {Fitgem::ApiUnitSystem}
     #   client.api_unit_system = Fitgem::ApiUnitSystem.UK
     # @example May also be set in the constructor call
-    #   client = Fitgem::Client { 
+    #   client = Fitgem::Client {
     #     :consumer_key => my_key,
     #     :consumer_secret => my_secret,
     #     :token => fitbit_oauth_token,
@@ -76,11 +79,11 @@ module Fitgem
     #   client = Fitgem::Client.new { :consumer_key => my_key, :consumer_secret => my_secret }
     #
     # @example User has already authorized with fitbit, and we have a stored token/secret
-    #   client = Fitgem::Client.new { 
-    #     :consumer_key => my_key, 
-    #     :consumer_secret => my_secret, 
-    #     :token => fitbit_oauth_token, 
-    #     :secret => fitbit_oauth_secret 
+    #   client = Fitgem::Client.new {
+    #     :consumer_key => my_key,
+    #     :consumer_secret => my_secret,
+    #     :token => fitbit_oauth_token,
+    #     :secret => fitbit_oauth_secret
     #   }
     #
     # @return [Client] A Fitgem::Client; may be in a logged-in state or
@@ -168,8 +171,8 @@ module Fitgem
     private
 
       def consumer
-        @consumer ||= OAuth::Consumer.new(@consumer_key, @consumer_secret, { 
-          :site => 'http://api.fitbit.com', 
+        @consumer ||= OAuth::Consumer.new(@consumer_key, @consumer_secret, {
+          :site => 'http://api.fitbit.com',
           :proxy => @proxy
         })
       end

data/lib/fitgem/errors.rb

@@ -8,6 +8,9 @@ module Fitgem
   class InvalidDateArgument < InvalidArgumentError
   end
 
+  class InvalidTimeArgument < InvalidArgumentError
+  end
+
   class InvalidTimeRange < InvalidArgumentError
   end
 end

data/lib/fitgem/glucose.rb

@@ -0,0 +1,45 @@
+module Fitgem
+  class Client
+    # ==========================================
+    #       Glucose Retrieval Methods
+    # ==========================================
+
+    # Get glucose log entries for the supplied date
+    #
+    # @param [DateTime, Date, String] date
+    # @return [Hash] Hash containing an average of the days logs, and a
+    #   list of all individual entries
+    def glucose_on_date(date)
+      get("/user/#{@user_id}/glucose/date/#{format_date(date)}.json")
+    end
+
+    # ==========================================
+    #        Glucose Logging Methods
+    # ==========================================
+
+    # Log glucose information to fitbit
+    #
+    # @param [Hash] opts Glucose data
+    # @option opts [String] :tracker Glucose tracker name;
+    #   predefined or custom tracker name (matches tracker name on the website) (this or :hba1c is REQUIRED)
+    # @option opts [String] :hba1c HbA1c measurement; in the format "X.X" (this or :tracker is REQUIRED)
+    # @option opts [String] :glucose Glucose measurement; in the format "X.X" (REQUIRED with :tracker, OPTIONAL otherwise)
+    # @option opts [DateTime, Date, String] :date Log entry date (REQUIRED)
+    # @option opts [DateTime, String] :time Time of the measurement; hours and minutes in the format HH:mm
+    #
+    # @return [Hash] Summary of logged information
+    def log_glucose(opts)
+      unless opts[:tracker] || opts[:hba1c]
+        raise Fitgem::InvalidArgumentError, "Must include :tracker or :hba1c in order to log glucose data"
+      end
+
+      if opts[:tracker] && opts[:hba1c].nil? && opts[:glucose].nil?
+        raise Fitgem::InvalidArgumentError, "Must include :glucose if using :tracker with no :hba1c value in order to log glucose data"
+      end
+
+      opts[:date] = format_date(opts[:date])
+      opts[:time] = format_time(opts[:time]) if opts[:time]
+      post("/user/#{@user_id}/glucose.json", opts)
+    end
+  end
+end

data/lib/fitgem/heart_rate.rb

@@ -0,0 +1,50 @@
+module Fitgem
+  class Client
+    # ==========================================
+    #       Heart Rate Retrieval Methods
+    # ==========================================
+
+    # Get heart rate log entries for the supplied date
+    #
+    # @param [DateTime, Date, String] date
+    # @return [Hash] Hash containing an average of the days logs, and a
+    #   list of all individual entries
+    def heart_rate_on_date(date)
+      get("/user/#{@user_id}/heart/date/#{format_date(date)}.json")
+    end
+
+    # ==========================================
+    #        Heart Rate Logging Methods
+    # ==========================================
+
+    # Log heart rate information to fitbit
+    #
+    # @param [Hash] opts Heart rate data
+    # @option opts [String] :tracker Heart rate tracker name;
+    #   predefined or custom tracker name (matches tracker name on the website) (REQUIRED)
+    # @option opts [Integer, String] :heart_rate Heart rate measurement (REQUIRED)
+    # @option opts [DateTime, Date, String] :date Log entry date (REQUIRED)
+    # @option opts [DateTime, String] :time Time of the measurement; hours and minutes in the format HH:mm
+    #
+    # @return [Hash] Summary of logged information
+    def log_heart_rate(opts)
+      unless opts[:tracker] && opts[:heart_rate] && opts[:date]
+        raise Fitgem::InvalidArgumentError, "Must include :tracker, :heart_rate, and :date in order to lof heart rate data"
+      end
+
+      opts[:heartRate] = opts.delete :heart_rate
+      opts[:date] = format_date(opts[:date])
+      opts[:time] = format_time(opts[:time]) if opts[:time]
+      post("/user/#{@user_id}/heart.json", opts)
+    end
+
+    # Delete logged heart rate information
+    #
+    # @param [Integer, String] heart_rate_log_id The id of previously logged
+    #   heart rate data
+    # @return [Hash] Empty hash denotes success
+    def delete_heart_rate_log(heart_rate_log_id)
+      delete("/user/-/heart/#{heart_rate_log_id}.json")
+    end
+  end
+end

data/lib/fitgem/helpers.rb

@@ -33,5 +33,35 @@ module Fitgem
         raise Fitgem::InvalidDateArgument, "Date used must be a date/time object or a string in the format YYYY-MM-DD; supplied argument is a #{date.class}"
       end
     end
+
+    # Format any of a variety of time-related types into the formatted string
+    # required when using the fitbit API.
+    #
+    # The time parameter can take several different kind of objects: a DateTime object,
+    # a Time object, or a String Object.  Furthermore, the string object may be either
+    # the date in a preformatted string ("HH:mm"), or it may be the string value "now" to
+    # indicate that the time value used is the current localtime.
+    #
+    # @param [DateTime, Time, String] time The object to format into a time string
+    # @raise [Fitgem::InvalidTimeArgument] Raised when the parameter object is not a
+    #   DateTime, Time, or a valid ("HH:mm" or "now") string object
+    # @return [String] Date in "HH:mm" string format
+    def format_time(time)
+      if time.is_a? String
+        case time
+          when 'now'
+            return DateTime.now.strftime("%H:%M")
+          else
+            unless time =~ /\d{2}\:\d{2}/
+              raise Fitgem::InvalidTimeArgument, "Invalid time (#{time}), must be in HH:mm format"
+            end
+            return time
+        end
+      elsif DateTime === time || Time === time
+        return time.strftime("%H:%M")
+      else
+        raise Fitgem::InvalidTimeArgument, "Date used must be a valid time object or a string in the format HH:mm; supplied argument is a #{time.class}"
+      end
+    end
   end
 end

data/lib/fitgem/time_range.rb

@@ -23,7 +23,15 @@ module Fitgem
     #   /activities/log/minutesVeryActive
     #   /activities/log/activeScore
     #   /activities/log/activityCalories
-    # 
+    #
+    # Raw Tracker Activity:
+    #   /activities/tracker/calories
+    #   /activities/tracker/steps
+    #   /activities/tracker/distance
+    #   /activities/tracker/floors
+    #   /activities/tracker/elevation
+    #   /activities/tracker/activeScore
+    #
     # Sleep:
     #   /sleep/startTime
     #   /sleep/timeInBed

data/lib/fitgem/version.rb

@@ -1,3 +1,3 @@
 module Fitgem
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

data/spec/fitgem_helper_spec.rb

@@ -58,7 +58,7 @@ describe Fitgem::Client do
       date = "2011-3-2"
       expect {
         @client.format_date(date)
-      }.to raise_error Fitgem::InvalidDateArgument, "Invalid date (2011-3-2), must be in yyyy-MM-dd format" 
+      }.to raise_error Fitgem::InvalidDateArgument, "Invalid date (2011-3-2), must be in yyyy-MM-dd format"
     end
 
     it "rejects strings are formatted correctly but include non-numeric elements" do
@@ -74,5 +74,54 @@ describe Fitgem::Client do
         @client.format_date(date)
       }.to raise_error Fitgem::InvalidDateArgument, "Date used must be a date/time object or a string in the format YYYY-MM-DD; supplied argument is a Fixnum"
     end
-  end 
+  end
+
+  describe "#format_time" do
+    it "accepts DateTime objects" do
+      time = DateTime.parse("3rd Feb 2001 04:05:06 PM")
+      @client.format_time(time).should == "16:05"
+    end
+
+    it "accepts Time objects" do
+      time = Time.mktime 2012, 1, 20, 13, 33, 30
+      @client.format_time(time).should == "13:33"
+    end
+
+    it "accepts the string 'now' to denote the current localtime" do
+      now = DateTime.now
+      @client.format_time('now').should == now.strftime("%H:%M")
+    end
+
+    it "accepts strings in HH:mm format" do
+      time = "04:20"
+      @client.format_time(time).should == "04:20"
+    end
+
+    it "rejects Date objects" do
+      date = Date.today
+      expect {
+        @client.format_time(date)
+      }.to raise_error Fitgem::InvalidTimeArgument
+    end
+
+    it "rejects strings that are not in HH:mm format" do
+      time = "4:20pm"
+      expect {
+        @client.format_time(time)
+      }.to raise_error Fitgem::InvalidTimeArgument
+    end
+
+    it "rejects strings that are formatted correctly but include non-numeric elements" do
+      time = "4a:33"
+      expect {
+        @client.format_time(time)
+      }.to raise_error Fitgem::InvalidTimeArgument
+    end
+
+    it "rejects arguments that do not conform to accepted types" do
+      expect {
+        @client.format_time(200)
+      }.to raise_error Fitgem::InvalidTimeArgument
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fitgem
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-30 00:00:00.000000000 Z
+date: 2012-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oauth
-  requirement: &70286226199200 !ruby/object:Gem::Requirement
+  requirement: &70184430460560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70286226199200
+  version_requirements: *70184430460560
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70286226198400 !ruby/object:Gem::Requirement
+  requirement: &70184430460140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70286226198400
+  version_requirements: *70184430460140
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70286226197760 !ruby/object:Gem::Requirement
+  requirement: &70184430495900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70286226197760
+  version_requirements: *70184430495900
 - !ruby/object:Gem::Dependency
   name: guard
-  requirement: &70286226197240 !ruby/object:Gem::Requirement
+  requirement: &70184430494680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70286226197240
+  version_requirements: *70184430494680
 - !ruby/object:Gem::Dependency
   name: guard-rspec
-  requirement: &70286226185880 !ruby/object:Gem::Requirement
+  requirement: &70184430493220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70286226185880
+  version_requirements: *70184430493220
 - !ruby/object:Gem::Dependency
   name: rb-fsevent
-  requirement: &70286226184860 !ruby/object:Gem::Requirement
+  requirement: &70184430492320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70286226184860
+  version_requirements: *70184430492320
 - !ruby/object:Gem::Dependency
   name: growl
-  requirement: &70286226184280 !ruby/object:Gem::Requirement
+  requirement: &70184430491460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +87,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70286226184280
+  version_requirements: *70184430491460
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &70286226183800 !ruby/object:Gem::Requirement
+  requirement: &70184430490160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,10 +98,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70286226183800
+  version_requirements: *70184430490160
 - !ruby/object:Gem::Dependency
   name: rdiscount
-  requirement: &70286226183360 !ruby/object:Gem::Requirement
+  requirement: &70184430488900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -109,7 +109,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70286226183360
+  version_requirements: *70184430488900
 description: A client library to send and retrieve workout, weight, and diet data
   from fitbit.com
 email:
@@ -146,6 +146,9 @@ files:
 - lib/fitgem/units.rb
 - lib/fitgem/users.rb
 - lib/fitgem/water.rb
+- lib/fitgem/blood_pressure.rb
+- lib/fitgem/glucose.rb
+- lib/fitgem/heart_rate.rb
 - spec/fitgem_spec.rb
 - spec/spec_helper.rb
 - spec/fitgem_notifications_spec.rb
@@ -163,12 +166,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 2581731821553703730
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 2581731821553703730
 requirements: []
 rubyforge_project: fitgem
 rubygems_version: 1.8.10