fitgem 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0093dff6f708728ec192e7dd062940d0091d856b
-  data.tar.gz: da17edef7d5d5b62529eae6f0afad4a7b3ba7fc4
+  metadata.gz: 76633b7e4a93d47e6f38b05ea29bb61aa1bc99a7
+  data.tar.gz: 8c9e95113e9fae7d0ac8da7794e57e001f3a7949
 SHA512:
-  metadata.gz: 88e9581a93d35371073e55e41bc612fb0db45b5f46c4113f9354dbc1e63bf8e8475e0ce0a7f2c7f169d5f18d3312a1b9a7a47f96bc3c97b27e6bbdc3c30c1671
-  data.tar.gz: 0f650a3fb149884f52ddab2e6c731ff58da874455a7e3b2ae43258bfb73b5b73a84a0d26daf71beb09ba93ee7ed221ee79e04ae8002f109eb5e05c79b40217d3
+  metadata.gz: 27d833fae2901dad5e2f44c69183c020c8685ddd1c7989c8d0c4d07e8744e123a045059dc22b8862a4c4ed19a397694abcaa3cfb26b11601cdd0a8ee41dfdcb2
+  data.tar.gz: e995db140ef78a18144ae95673fb0dfa6192392f3edb94f91a1e0f65ad14099b925f3e4d44a97c6b0df0c02ec7682b67da18aa032fe8751075f0b9112c121595

data/.gitignore

@@ -8,3 +8,5 @@ test*.rb
 .fitgem.yml
 .idea
 .rvmrc
+.ruby-version
+.ruby-gemset

data/README.md

@@ -1,10 +1,10 @@
 # Fitgem [![Build Status](https://secure.travis-ci.org/whazzmaster/fitgem.png)](http://travis-ci.org/whazzmaster/fitgem)
 
-Provides access to [fitbit.com](http://www.fitbit.com) data through [their REST API](http://dev.fitbit.com).  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.
+This gem provides access to [fitbit.com](http://www.fitbit.com) data through [their REST API](http://dev.fitbit.com).  Fitgem can pull data with or without a valid OAUth access_token. Without an access_token you can only gather data that a user has denoted as 'public'.  However, if an access_token is provided then all exposed data can be gathered for the logged-in account.
 
-The [Fitbit API](https://wiki.fitbit.com/display/API/Fitbit+API) is currently in BETA and is under development to extend its reach. As the API evolves and is enhanced it's a priority to mirror the functionality in the gem, and any **pull requests** are appreciated if you see gaps in API support.
+The [Fitbit API](https://wiki.fitbit.com/display/API/Fitbit+API) is currently in BETA and is under development to extend its reach. As the API evolves and is enhanced it's a priority to mirror the functionality in the gem, and **pull requests** are appreciated if you see gaps in API support.
 
-# Usage
+## Installation
 
 Install fitgem
 
@@ -18,11 +18,16 @@ or add it to your Gemfile
 gem 'fitgem'
 ```
 
+## API Reference
+
 Comprehensive method documentation is [available online](http://www.rubydoc.info/github/whazzmaster/fitgem/frames).
 
 The best way to connect your users to the Fitbit API is to use
-**[omniauth-fitbit](https://github.com/tkgospodinov/omniauth-fitbit)** to integrate Fitbit accounts into your web
-application. Once you have a Fitbit API OAuth `access_token` for a user it's simple to create a client object through fitgem to send and receive fitness data.
+[omniauth-fitbit](https://github.com/tkgospodinov/omniauth-fitbit) to integrate Fitbit accounts into your web application. Once you have a Fitbit API OAuth `access_token` for a user it's simple to create a client object through fitgem to send and receive fitness data.
+
+## Subscriptions
+
+The Fitbit API allows for you to set up notification subscriptions. When user data changes (through syncing with the fitbit device) your applications can be notified automatically.  You can set up a default subscription callback URL via the [Fitbit dev site](https://dev.fitbit.com/ 'Fitbit Developer Site') and then use the Subscriptions API to add or remove subscriptions for individual users.
 
 ## Reference Application
 
@@ -34,13 +39,9 @@ The reference app is written using Rails 3.2 and [Backbone.js](http://backbonejs
 * Store and use OAuth access tokens
 * Create and use instances of `Fitgem::Client` using the stored OAuth access token
 
-# Subscriptions
+## Contributing to Fitgem
 
-The Fitbit API allows for you to set up notification subscription so that when values change (via automatic syncs with the fitbit device) your applications can be notified automatically.  You can set up a default subscription callback URL via the [Fitbit dev site](https://dev.fitbit.com/ 'Fitbit Developer Site') and then use the Subscriptions API to add or remove subscriptions for individual users.
-
-# Help Improve Fitgem!
-
-The Fitbit REST API is in BETA right now, and so it will quite likely change over time (though I can't be sure whether it will be additive change or change of the non-backwards-compatible variety).  I aim to keep as up-to-date as I can but if you absolutely need functionality that isn't included here, **feel free to fork and implement it, then send me a pull request**.
+The Fitbit REST API is in BETA right now, and so it will quite likely change over time.  I aim to keep as up-to-date as I can but if you absolutely need functionality that isn't included here, **feel free to fork and implement it, then send me a pull request**.
 
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
 * Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
@@ -51,11 +52,10 @@ The Fitbit REST API is in BETA right now, and so it will quite likely change ove
 * **Please try not to mess with the Rakefile, version, or history**. If you want to have your own version, or is otherwise
 necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
 
-## Contributors
+### Contributors
 
 **Many, many thanks** to [everyone that has contributed to improve fitgem](https://github.com/whazzmaster/fitgem/graphs/contributors)!
 
-# Copyright & Disclaimer
+## Copyright & Disclaimer
 
 Copyright © 2011-2013 Zachery Moneypenny. See LICENSE for further details. __I am not employed by [Fitbit](http://fitbit.com)__.  I created this library to assist other ruby developers in creating interesting applications on top of fitbit.com's data store and device data stream.
-

data/changelog.md

@@ -3,6 +3,35 @@
 
 # fitgem changelog
 
+## v0.9.0
+
+#### 2014-02-11 Zachery Moneypenny <fitgem@whazzmaster.com>
+
+The v0.9.0 release adds a number of new methods to match new functionality available through the Fitbit REST API. It
+also removes support for concepts (monthly leaderboards) that have been removed from the Fitbit REST API.
+
+There's a big change to **leaderboard support** in this update; please read the notes below if you're currently using
+`monthly_leaderboard` or `weekly_leaderboard` -- you should update your code to use the new method before v1.0 is
+released.
+
+* Add ability to target SSL Fitbit REST endpoints
+* Add `activity_on_date_range` method
+* Condense existing `weekly_leaderboard` and (no longer available) `monthly_leaderboard` into a simple `leaderboard`
+method. There is now only one leaderboard (weekly) so no need to differentiate in the API. The previous leaderboard
+methods are now deprecated and **will be removed** in v1.0.
+* Add `create_or_update_weekly_goal` method and specs
+* Add `create_or_update_daily_goal` method and specs
+* Add `daily_goals` method and update documentation
+* Add `delete_body_fat_log` method
+* Add `delete_body_weight_log` method
+* Add `create_or_update_body_fat_goal` method
+* Add `create_or_update_body_weight_goal` method
+* Add `log_body_fat` method to push a body fat measurement to Fitbit
+* Add `body_fat_goal` method to fetch the current body fat goal
+* Add `body_fat` method to fetch body fat measurements
+* Add `body_weight` method to fetch body fat measurements
+* For the `body_weight` and `body_fat` methods, determine a URI based on the base URI and provided options
+
 ## v0.8.0
 
 #### 2013-08-03 Zachery Moneypenny <fitgem@whazzmaster.com>

data/lib/fitgem/activities.rb

@@ -22,24 +22,34 @@ module Fitgem
       get("/user/#{@user_id}/activities/date/#{format_date(date)}.json")
     end
 
+    # Get activity information for a date range
+    #
+    # @param [String] activity to retrieve information for
+    # @param [Datetime] start of date range
+    # @param [Datetime] end of date range
+    # @return [Hash] activity information for the given date range
+    def activity_on_date_range(activity, start, finish)
+      get("/user/#{@user_id}/activities/#{activity}/date/#{format_date(start)}/#{format_date(finish)}.json")
+    end
+
     # Get a list of the frequently logged activities
     #
     # @return [Array] list of frequently logged activities
-    def frequent_activities()
+    def frequent_activities
       get("/user/#{@user_id}/activities/frequent.json")
     end
 
     # Get a list of recently logged activities
     #
     # @return [Array] list of of recently-logged activities
-    def recent_activities()
+    def recent_activities
       get("/user/#{@user_id}/activities/recent.json")
     end
 
     # Get a list of activities marked as favorite by the user
     #
     # @return [Array] list of user-defined favorite activities
-    def favorite_activities()
+    def favorite_activities
       get("/user/#{@user_id}/activities/favorite.json")
     end
 
@@ -58,23 +68,40 @@ module Fitgem
     # Get the activity statistics for the current user
     #
     # @return [Hash] Hash containing statistics for the activities that
-    # the user has logged
+    #   the user has logged
     def activity_statistics
       get("/user/#{@user_id}/activities.json")
     end
 
+    # ==========================================
+    #         Goal Retrieval Methods
+    # ==========================================
+
     # Get the daily activity goals for the current user
     #
-    # @return [Hash] Hash containing the calorie, distance, floors, and 
-    # step goals for the current user
+    # @return [Hash] Hash containing the calorie, distance, floors, and
+    #   step goals for the current user
+    #
+    # @deprecated Use the daily_goals method; in v1.0.0 this method will
+    #   be removed
     def goals
       get("/user/#{@user_id}/activities/goals/daily.json")
     end
 
+    # Get the daily activity goals for the current user
+    #
+    # @return [Hash] Hash containing the calorie, distance, floors, and
+    #   step goals for the current user
+    #
+    # @since v0.9.0
+    def daily_goals
+      goals
+    end
+
     # Get the weekly activity goals for the current user
     #
     # @return [Hash] Hash containing the distance, floors and step goals
-    # for the current user
+    #   for the current user
     def weekly_goals
       get("/user/#{@user_id}/activities/goals/weekly.json")
     end
@@ -88,25 +115,26 @@ module Fitgem
     # @param [Hash] opts The options used to log the activity for the
     #   current user
     #
-    # @option opts [String] :activityId The id of the activity, directory activity or intensity 
-    #   level activity. See activity types at {http://wiki.fitbit.com/display/API/API-Log-Activity} for more 
+    # @option opts [String] :activityId The id of the activity, directory
+    #   activity or intensity level activity. See activity types at
+    #   {http://wiki.fitbit.com/display/API/API-Log-Activity} for more
     #   information. This value OR activityName is REQUIRED for all calls.
-    # @option opts [String] :activityName The name of the activity to log.  This value OR activityId 
-    #   is REQUIRED for alls.
-    #
+    # @option opts [String] :activityName The name of the activity to log.
+    #   This value OR activityId is REQUIRED for alls.
     # @option opts [String, Integer] :durationMillis Activity duration in milliseconds.
     #   Must be a numeric value in Integer or String format. This value is REQUIRED for all calls.
     # @option opts [String] :startTime Activity start time, in the format "HH:mm" using hours
     #   and seconds. This value is REQUIRED for all calls.
-    # @option opts [String] :date Activity date, in "yyyy-MM-dd" format. This value is REQUIRED for all calls.
-    #
-    # @option opts [String] :distance Distance traveled, a string in the format "X.XX".  This value is 
+    # @option opts [String] :date Activity date, in "yyyy-MM-dd" format. This
+    #   value is REQUIRED for all calls.
+    # @option opts [String] :distance Distance traveled, a string in the format "X.XX".  This value is
     #   REQUIRED when logging a directory activity, OPTIONAL otherwise.
-    # @option opts [String, Integer] :manualCalories The number of calories to log against the activity. This
-    #   value is REQUIRED if using the activityName, OPTIONAL otherwise.
-    #
-    # @option opts [String] :distanceUnit One of {Fitgem::ApiDistanceUnit}. The "steps" units are available 
-    #   only for "Walking" and "Running" directory activities and their intensity levels
+    # @option opts [String, Integer] :manualCalories The number of calories
+    #   to log against the activity. This value is REQUIRED if using the activityName,
+    #   OPTIONAL otherwise.
+    # @option opts [String] :distanceUnit One of {Fitgem::ApiDistanceUnit}.
+    #   The "steps" units are available only for "Walking" and "Running"
+    #   directory activities and their intensity levels
     #
     # @return [Hash] A hash with a summary of the logged activity
     def log_activity(opts)
@@ -119,11 +147,60 @@ module Fitgem
     #   typcially retrieved by browsing or searching the list of all
     #   available activities.  Must be a numerical ID in either Integer
     #   or String format.
+    #
     # @return [Hash] Empty hash if successfully marked as a favorite
     def add_favorite_activity(activity_id)
       post("/user/#{@user_id}/activities/log/favorite/#{activity_id}.json")
     end
 
+    # ==========================================
+    #       Goal Creation/Update Methods
+    # ==========================================
+
+    # Create or update a user's daily goal
+    #
+    # @param [Hash] :opts
+    #
+    # @option opts [Symbol] :type The type of goal to create or update; must be one of
+    #   :steps, :distance, :floors, or :caloriesOut. REQUIRED
+    # @option opts [Decimal, Integer, String] :value The goal value; in the format 'X.XX'
+    #   if a string. REQUIRED
+    #
+    # @since v0.9.0
+    def create_or_update_daily_goal(opts)
+      unless opts[:type] && [:steps, :distance, :floors, :caloriesOut].include?(opts[:type])
+        raise InvalidArgumentError, 'Must specify type in order to create or update a daily goal. One of (:steps, :distance, :floors, or :caloriesOut) is required.'
+      end
+
+      unless opts[:value]
+        raise InvalidArgumentError, 'Must specify value of the daily goal to be created or updated.'
+      end
+
+      post("/user/#{@user_id}/activities/goals/daily.json", opts)
+    end
+
+    # Create or update a user's weekly goal
+    #
+    # @param [Hash] :opts
+    #
+    # @option opts [Symbol] :type The type of goal to create or update; must be one of
+    #   :steps, :distance, or :floors. REQUIRED
+    # @option opts [Decimal, Integer, String] :value The goal value; in the format 'X.XX'
+    #   if a string. REQUIRED
+    #
+    # @since v0.9.0
+    def create_or_update_weekly_goal(opts)
+      unless opts[:type] && [:steps, :distance, :floors].include?(opts[:type])
+        raise InvalidArgumentError, 'Must specify type in order to create or update a weekly goal. One of (:steps, :distance, or :floors) is required.'
+      end
+
+      unless opts[:value]
+        raise InvalidArgumentError, 'Must specify value of the weekly goal to be created or updated.'
+      end
+
+      post("/user/#{@user_id}/activities/goals/weekly.json", opts)
+    end
+
     # ==========================================
     #         Activity Removal Methods
     # ==========================================

data/lib/fitgem/body_measurements.rb

@@ -1,38 +1,77 @@
 module Fitgem
   class Client
     # ==========================================
-    #      Body Measurements Update Methods
+    #      Body Measurements Methods
     # ==========================================
 
     # Get the body measurements logged on a specified date
     #
     # @param [DateTime, String] date The date to retrieve body
     #   measurements for.  May be a DateTime object or a String
-    #   in "yyyy-MM-dd" format.
+    #   in 'yyyy-MM-dd' format.
     # @return [Hash] A hash containing the logged body measurements
     #   along with any goals set for the current user.
     def body_measurements_on_date(date)
       get("/user/#{@user_id}/body/date/#{format_date(date)}.json")
     end
 
-    # ==========================================
-    #      Body Measurements Update Methods
-    # ==========================================
+    # Get a list of logged body weight entries for the specified period
+    #
+    # @params [Hash] opts body weight options
+    # @option opts [Date] date The date in the format YYYY-mm-dd.
+    # @option opts [Date] base_date The end date when period is provided, in the
+    #   format yyyy-MM-dd or today; range start date when a date range is provided.
+    # @option opts [String] period The date range period. One of 1d, 7d, 30d, 1w, 1m
+    # @option opts [Date] end_date Range end date when date range is provided.
+    #   Note that period should not be longer than 31 day
+    #
+    # @return [Hash] A hash containing body weight log entries
+    #
+    # @since v0.9.0
+    def body_weight(opts = {})
+      get determine_body_uri("/user/#{@user_id}/body/log/weight", opts)
+    end
 
-    # Log weight to fitbit for the current user
+    # Retrieve the body weight goal of the current user
     #
-    # @param [Integer, String] weight The weight to log, as either
-    #   an integer or a string in "X.XX'" format
-    # @param [DateTime, String] date The date the weight should be
-    #   logged, as either a DateTime or a String in "yyyy-MM-dd" format
-    # @return [Hash]
+    # @return [Hash] A hash containing the start date,
+    #   start weight and current weight.
     #
-    # @deprecated {#log_body_measurements} should be used instead of
-    #   log_weight
-    def log_weight(weight, date, options={})
-      post("/user/#{@user_id}/body/weight.json", options.merge(:weight => weight, :date => format_date(date)))
+    # @since v0.9.0
+    def body_weight_goal
+      get("/user/#{@user_id}/body/log/weight/goal.json")
     end
 
+    # Get a list of logged body fat entries for the specified period
+    #
+    # @params [Hash] opts body fat options
+    # @option opts [Date] date The date in the format YYYY-mm-dd.
+    # @option opts [Date] base_date The end date when period is provided, in the
+    #   format yyyy-MM-dd or today; range start date when a date range is provided.
+    # @option opts [String] period The date range period. One of 1d, 7d, 30d, 1w, 1m
+    # @option opts [Date] end_date Range end date when date range is provided.
+    #   Note that period should not be longer than 31 day
+    #
+    # @return [Hash] A hash containing body fat log entries
+    #
+    # @since v0.9.0
+    def body_fat(opts = {})
+      get determine_body_uri("/user/#{@user_id}/body/log/fat", opts)
+    end
+
+    # Retrieve the body fat goal of the current user
+    #
+    # @return [Hash] A hash containing the body fat goal
+    #
+    # @since v0.9.0
+    def body_fat_goal
+      get("/user/#{@user_id}/body/log/fat/goal.json")
+    end
+
+    # ==========================================
+    #      Body Measurements Update Methods
+    # ==========================================
+
     # Log body measurements to fitbit for the current user
     #
     # At least ONE measurement item is REQUIRED in the call, as well as the
@@ -65,5 +104,115 @@ module Fitgem
       opts[:date] = format_date(opts[:date]) if opts[:date]
       post("/user/#{@user_id}/body.json", opts)
     end
+
+    # Log weight to fitbit for the current user
+    #
+    # @param [Integer, String] weight The weight to log, as either
+    #   an integer or a string in "X.XX'" format
+    # @param [DateTime, String] date The date the weight should be
+    #   logged, as either a DateTime or a String in 'yyyy-MM-dd' format
+    #
+    # @options opts [DateTime, String] :time The time the weight should be logged
+    #   as either a DateTime or a String in 'HH:mm:ss' format
+    #
+    # @return [Hash]
+    #
+    # @since v0.9.0
+    def log_weight(weight, date, opts={})
+      opts[:time] = format_time(opts[:time]) if opts[:time]
+      post("/user/#{@user_id}/body/log/weight.json", opts.merge(:weight => weight, :date => format_date(date)))
+    end
+
+    # Log body fat percentage
+    #
+    # @param [Decimal, Integer, String] fatPercentage Body fat percentage to log,
+    #   in format "X.XX" if a string
+    # @param [DateTime, Date, String] date The date to log body fat percentage on,
+    #   in format "yyyy-MM-dd" if a string
+    # @param [Hash] opts
+    # @option opts [DateTime, Time, String] :time The time to log body fat percentage
+    #   at, in " HH:mm:ss" format if a String
+    #
+    # @since v0.9.0
+    def log_body_fat(fatPercentage, date, opts={})
+      opts[:fat] = fatPercentage
+      opts[:date] = format_date(date)
+      opts[:time] = format_time(opts[:time]) if opts[:time]
+      post("/user/#{@user_id}/body/fat.json", opts)
+    end
+
+    # Create or update a user's weight goal
+    #
+    # @param [DateTime, Date, String] startDate Weight goal start date;
+    #   in the format "yyyy-MM-dd" if a string
+    # @param [Decimal, Integer, String] startWeight Weight goal start weight;
+    #   in the format "X.XX" if a string
+    # @param [Decimal, Integer, String] goalWeight Weight goal target weight;
+    #   in the format "X.XX" if a string
+    #
+    # @since v0.9.0
+    def create_or_update_body_weight_goal(startDate, startWeight, goalWeight)
+      opts = {startDate: format_date(startDate), startWeight: startWeight, weight: goalWeight}
+      post("/user/#{@user_id}/body/log/weight/goal.json", opts)
+    end
+
+    # Create or update a user's body fat percentage goal
+    #
+    # @param [Decimal, Integer, String] fatPercentageGoal Target body fat in %;
+    #   in the format "X.XX" if a string
+    #
+    # @since v0.9.0
+    def create_or_update_body_fat_goal(fatPercentageGoal)
+      opts = {fat: fatPercentageGoal}
+      post("/user/#{@user_id}/body/log/fat/goal.json", opts)
+    end
+
+    # ==========================================
+    #      Body Measurements Delete Methods
+    # ==========================================
+
+    # Delete user's body weight log entry with the given id
+    #
+    # @param [Integer] logId The id of the body weight entry
+    #
+    # @since v0.9.0
+    def delete_body_weight_log(logId)
+      delete("/user/#{@user_id}/body/log/weight/#{logId}.json")
+    end
+
+    # Delete user's body fat log entry with the given id
+    #
+    # @param [Integer] logId The id of the body fat entry
+    #
+    # @since v0.9.0
+    def delete_body_fat_log(logId)
+      delete("/user/#{@user_id}/body/log/fat/#{logId}.json")
+    end
+
+    private
+
+    # Determine the URI for the body_weight or body_fat method
+    #
+    # @params [String] base_uri the base URI for the body weight or body fat method
+    # @params [Hash] opts body weight/fat options
+    # @option opts [Date] date The date in the format YYYY-mm-dd.
+    # @option opts [Date] base-date The end date when period is provided, in the
+    #   format yyyy-MM-dd or today; range start date when a date range is provided.
+    # @option opts [String] period The date range period. One of 1d, 7d, 30d, 1w, 1m
+    # @option opts [Date] end-date Range end date when date range is provided.
+    #   Note that period should not be longer than 31 day
+    #
+    # @return [String] an URI based on the base URI and provided options
+    def determine_body_uri(base_uri, opts = {})
+      if opts[:date]
+        date = format_date opts[:date]
+        "#{base_uri}/date/#{date}.json"
+      elsif opts[:base_date] && (opts[:period] || opts[:end_date])
+        date_range = construct_date_range_fragment opts
+        "#{base_uri}/#{date_range}.json"
+      else
+        raise Fitgem::InvalidArgumentError, "You didn't supply one of the required options."
+      end
+    end
   end
 end

data/lib/fitgem/client.rb

@@ -22,14 +22,19 @@ require 'uri'
 
 module Fitgem
   class Client
-    API_VERSION = "1"
-    EMPTY_BODY = ""
+    API_VERSION = '1'
+    EMPTY_BODY = ''
 
     # Sets or gets the api_version to be used in API calls
     #"
     # @return [String]
     attr_accessor :api_version
 
+    # Sets or gets the ssl settings
+    # 
+    # @return [Boolean]
+    attr_accessor :ssl
+    
     # Sets or gets the api unit system to be used in API calls
     #
     # @return [String]
@@ -98,12 +103,13 @@ module Fitgem
       @consumer_key = opts[:consumer_key]
       @consumer_secret = opts[:consumer_secret]
 
+      @ssl = opts[:ssl]
 
       @token = opts[:token]
       @secret = opts[:secret]
 
       @proxy = opts[:proxy] if opts[:proxy]
-      @user_id = opts[:user_id] || "-"
+      @user_id = opts[:user_id] || '-'
 
       @api_unit_system = opts[:unit_system] || Fitgem::ApiUnitSystem.US
       @api_version = API_VERSION
@@ -176,12 +182,19 @@ module Fitgem
       consumer.options[:authorize_path] = '/oauth/authenticate'
       request_token(opts)
     end
+    
+    # The protocol to be used for the API requests
+    # 
+    # @return [String], 'http', or 'https' if ssl == true
+    def protocol
+      ssl ? "https" : "http"
+    end
 
     private
 
       def consumer
         @consumer ||= OAuth::Consumer.new(@consumer_key, @consumer_secret, {
-          :site => 'http://api.fitbit.com',
+          :site => "#{protocol}://api.fitbit.com",
           :proxy => @proxy
         })
       end
@@ -195,7 +208,7 @@ module Fitgem
       end
 
       def raw_get(path, headers={})
-        headers.merge!("User-Agent" => "fitgem gem v#{Fitgem::VERSION}", "Accept-Language" => @api_unit_system)
+        headers.merge!('User-Agent' => "fitgem gem v#{Fitgem::VERSION}", 'Accept-Language' => @api_unit_system)
         uri = "/#{@api_version}#{path}"
         access_token.get(uri, headers)
       end
@@ -205,7 +218,7 @@ module Fitgem
       end
 
       def raw_post(path, body='', headers={})
-        headers.merge!("User-Agent" => "fitgem gem v#{Fitgem::VERSION}", "Accept-Language" => @api_unit_system)
+        headers.merge!('User-Agent' => "fitgem gem v#{Fitgem::VERSION}", 'Accept-Language' => @api_unit_system)
         uri = "/#{@api_version}#{path}"
         access_token.post(uri, body, headers)
       end
@@ -215,7 +228,7 @@ module Fitgem
       end
 
       def raw_delete(path, headers={})
-        headers.merge!("User-Agent" => "fitgem gem v#{Fitgem::VERSION}", "Accept-Language" => @api_unit_system)
+        headers.merge!('User-Agent' => "fitgem gem v#{Fitgem::VERSION}", 'Accept-Language' => @api_unit_system)
         uri = "/#{@api_version}#{path}"
         access_token.delete(uri, headers)
       end

data/lib/fitgem/foods.rb

@@ -17,7 +17,7 @@ module Fitgem
     #
     # @return [Array] A list of foods, each of which is a Hash
     #   containing the food details
-    def recent_foods()
+    def recent_foods
       get("/user/#{@user_id}/foods/log/recent.json")
     end
 
@@ -25,7 +25,7 @@ module Fitgem
     #
     # @return [Array] A list of foods, each of which is a Hash
     #   containing the food details
-    def frequent_foods()
+    def frequent_foods
       get("/user/#{@user_id}/foods/log/frequent.json")
     end
 
@@ -33,15 +33,24 @@ module Fitgem
     #
     # @return [Array] A list of foods, each of which is a Hash
     #   containing the food details
-    def favorite_foods()
+    def favorite_foods
       get("/user/#{@user_id}/foods/log/favorite.json")
     end
 
     # Get a list of all of the available food units
     #
     # @return [Array] List of food units
-    def foods_units()
-      get("/foods/units.json")
+    def foods_units
+      get('/foods/units.json')
+    end
+
+    # Get a hash containing the user's meal informarion
+    #
+    # @return [Hash] Meal information
+    #
+    # @since v0.9.0
+    def meals
+      get("/user/#{@user_id}/meals.json")
     end
 
     # ==========================================
@@ -77,7 +86,7 @@ module Fitgem
     # @option opts [Integer, String] :foodId Food id
     # @option opts [String] :foodName Food entry name
     # @option opts [String] :brandName Brand name, valid only with foodName
-    # @option opts [Integer, String] :calories Calories for this serving size, 
+    # @option opts [Integer, String] :calories Calories for this serving size,
     #   valid only with foodName
     # @option opts [Integer, String] :mealTypeId Meal type id; (1 -
     #   Breakfast, 2 - Morning Snack, 3 - Lunch, 4 - Afternoon Snack, 5 - Dinner, 7 - Anytime)

data/lib/fitgem/friends.rb

@@ -12,18 +12,31 @@ module Fitgem
       get("/user/#{@user_id}/friends.json")
     end
 
-    # Get the weekly leaderboard of friends' activities
+    # Get the leaderboard of friends' weekly activities
     #
     # @return [Hash] Friends' information
-    def weekly_leaderboard
-      leaderboard('7d')
+    def leaderboard
+      get("/user/#{@user_id}/friends/leaderboard.json")
     end
 
-    # Get the monthly leaderboard of friends' activities
+    # Get the leaderboard of friends' weekly activities
     #
     # @return [Hash] Friends' information
+    #
+    # @deprecated Monthly leaderboards are no longer available from Fitbit. Please update to use {#leaderboard}
     def monthly_leaderboard
-      leaderboard('30d')
+      warn '[DEPRECATED] monthly_leaderboard will be removed in v1.0. Update to using leaderboard method.'
+      leaderboard
+    end
+
+    # Get the leaderboard of friends' weekly activities
+    #
+    # @return [Hash] Friends' information
+    #
+    # @deprecated Please update to use {#leaderboard}
+    def weekly_leaderboard
+      warn '[DEPRECATED] weekly_leaderboard will be removed in v1.0. Update to using leaderboard method.'
+      leaderboard
     end
 
     # ==========================================
@@ -70,10 +83,6 @@ module Fitgem
 
     private
 
-    def leaderboard(range)
-      get("/user/#{@user_id}/friends/leaders/#{range}.json")
-    end
-
     def respond_to_invite(requestor_id, does_accept)
       options = { :accept => does_accept.to_s }
       post("/user/#{@user_id}/friends/invitations/#{requestor_id}.json", options)

data/lib/fitgem/users.rb

@@ -15,11 +15,32 @@ module Fitgem
     # @option opts [DateTime, Date, String] :birthday Birthday, in
     #   "yyyy-MM-dd" if a String
     # @option opts [Decimal, Integer, String] :height Height, in format
-    #   "X.XX" if a string
+    #   "X.XX" if a String
     # @option opts [String] :nickname Nickname
+    # @option opts [String] :aboutMe About Me description
     # @option opts [String] :fullName Full name
+    # @option opts [String] :country; two-character code
+    # @option opts [String] :state; two-character code
+    # @option opts [String] :city
+    # @option opts [Decimal, Integer, String] :strideLengthWalking Walking
+    #   stride length, in format "X.XX" if a String
+    # @option opts [Decimal, Integer, String] :strideLengthRunning Running
+    #   stride length, in format "X.XX" if a String
+    # @option opts [String] :weightUnit Default water unit on website
+    #   (doesn't affect API); one of (en_US, en_GB, "any" for METRIC)
+    # @option opts [String] :heightUnit Default height/distance unit
+    #   on website (doesn't affect API); one of (en_US, "any" for METRIC)
+    # @option opts [String] :waterUnit Default water unit on website
+    #   (doesn't affect API); one of (en_US, "any" for METRIC)
+    # @option opts [String] :glucoseUnit Default glucose unit on website
+    #   (doesn't affect API); one of (en_US, "any" for METRIC)
     # @option opts [String] :timezone Time zone; in the format
     #   "America/Los Angelos"
+    # @option opts [String] :foodsLocale Food Database Locale; in the
+    #   format "xx_XX"
+    # @option opts [String] :locale Locale of website (country/language);
+    #   one of the locales, see https://wiki.fitbit.com/display/API/API-Update-User-Info
+    #   for the currently supported values.
     #
     # @return [Hash] Hash containing updated profile information
     def update_user_info(opts)

data/lib/fitgem/version.rb

@@ -1,3 +1,3 @@
 module Fitgem
-  VERSION = '0.8.0'
+  VERSION = '0.9.0'
 end

data/spec/fitgem_spec.rb

@@ -32,5 +32,33 @@ describe Fitgem do
     it 'should default to a user id of \'-\', the currently-logged in user' do
       @client.user_id.should == '-'
     end
+    
+    it "returns the protocol to be used" do
+      @client.protocol.should eq "http"
+    end
+    
+    describe "ssl" do
+      it "should expose the ssl setting" do
+        @client.ssl.should eq nil
+      end
+      
+      context "when true" do
+        let(:client) { Fitgem::Client.new({
+            :consumer_key => '12345', 
+            :consumer_secret => '67890',
+            :ssl => true
+          }) }
+          
+        it "can set the ssl setting to true" do
+          client.ssl.should be_true
+        end
+        
+        it "uses https protocol" do
+          client.protocol.should eq "https"
+        end
+        
+      end
+      
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fitgem
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Zachery Moneypenny
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-03 00:00:00.000000000 Z
+date: 2014-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oauth