fitgem 0.3.5 → 0.3.6

data/lib/fitgem/foods.rb

@@ -25,10 +25,21 @@ module Fitgem
       get("/foods/units.json")
     end
 
+    # ==========================================
+    #           Food Query Methods
+    # ==========================================
+
+    # Search the foods database
     def find_food(query_string)
       get("/foods/search.json?query=#{URI.escape(query_string)}")
     end
 
+    # Using the foodId field from the results of find_food(), query
+    # the details of a specific food
+    def food_info(food_id)
+      get("/foods/#{food_id}.json")
+    end
+
     # ==========================================
     #           Food Update Methods
     # ==========================================
@@ -75,4 +86,4 @@ module Fitgem
       post("/foods.json", options)
     end
   end
-end
+end

data/lib/fitgem/time_range.rb

@@ -1,13 +1,11 @@
 module Fitgem
   class Client
-    
     # Gets historical resource data in the time range specified by 
-    # options param.  The time range can either be specified by 
+    # options hash param.  The time range can either be specified by 
     # :base_date and :end_date OR by using :base_date and a :period
     # (supported periods are 1d, 7d, 30d, 1w, 1m, 3m, 6m, 1y, max)
     #
-    # Example values for resource_path are below:
-    #
+    # Supported values for resource_path are:
     # Food:
     # /foods/log/caloriesIn
     # 
@@ -15,6 +13,8 @@ module Fitgem
     # /activities/log/calories
     # /activities/log/steps
     # /activities/log/distance
+    # /activities/log/floors
+    # /activities/log/elevation
     # /activities/log/minutesSedentary
     # /activities/log/minutesLightlyActive
     # /activities/log/minutesFairlyActive
@@ -32,11 +32,20 @@ module Fitgem
     # /body/weight
     # /body/bmi
     # /body/fat
+    #
+    #  Examples
+    #
+    #  * To get the floors traveled for the week of October 24th
+    #    data_by_time_range("/activities/log/floors", {:base_date => "2011-10-24", :period => "7d"})
+    #
+    #  * To get all of the body weight logs from April 3rd until July 27th
+    #    data_by_time_range("/body/weight", {:base_date => "2011-03-03", :end_date => "2011-07-27"})
+    #
     def data_by_time_range(resource_path, options)
       range_str = construct_date_range_fragment(options)
       get("/user/#{@user_id}#{resource_path}/#{range_str}.json")
     end
-    
+
     def construct_date_range_fragment(options)
       range_str = "date/"
       if options[:base_date] && options[:period]
@@ -50,4 +59,4 @@ module Fitgem
     end
     
   end
-end
+end

data/lib/fitgem/version.rb

@@ -1,3 +1,3 @@
 module Fitgem
-  VERSION = "0.3.5"
+  VERSION = "0.3.6"
 end

metadata

@@ -2,7 +2,7 @@
 name: fitgem
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.3.5
+  version: 0.3.6
 platform: ruby
 authors: 
 - Zachery Moneypenny
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-09-12 00:00:00 -05:00
+date: 2011-10-25 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency