fitgem_oauth2 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2c0baa9844ef7be0f66170042cec30385ab5d2e5
-  data.tar.gz: e1ccdc69b6a1763cf642532dab7494655b075b28
+  metadata.gz: 1852c3213510047e298bee0f2c887227a4d4b0bc
+  data.tar.gz: ca21defb34de418a6449654c5e080deb417174ee
 SHA512:
-  metadata.gz: cc2840e23217566f0e460b54d4d4ba4c9c88f4251a8ac387e3403aedb6db10d76298cd7db1e244cacc8e232b1431d434b6dbedef79cce1cca3df17571cc7be1a
-  data.tar.gz: 5364ff2b8515a6472cc4246397e39451400138d9aea9977d5e17137f96420e4e4e029f25107be69d41627a7dc8f076a3e0462bc46d70d6a8c50575e1b3171ea3
+  metadata.gz: 61604a94c8b95c1c38c2b33cf695b5dc1c9e3cd2dc42fc1694f055ed78e5481e13c012ecad21f0b092d6ab84aee31e1ee1d13a82e5460c0ee0c0b8e0a9415244
+  data.tar.gz: 78aca4f698224ea58dfe1c43e1a925c7a26d40559c6b2e8ac324c904889f30aa0d9346e0a91f8ae855376cf1ca57620adf7b1caa0216bc25b4a2af1c25c594ab

data/lib/fitgem_oauth2/activity.rb

@@ -5,6 +5,8 @@ module FitgemOauth2
 
     ACTIVITY_PERIODS = %w(1d 7d 30d 1w 1m 3m 6m 1y max)
 
+    # retrieves daily activity summary for a date
+    # @param date the date for which the summary is retrieved
     def daily_activity_summary(date)
       get_call("user/#{user_id}/activities/date/#{format_date(date)}.json")
     end
@@ -13,6 +15,12 @@ module FitgemOauth2
     #   Activity Time Series
     # ==================================
 
+    # retrieves activity time series, based on the arguments provided
+    # @param resource the resource for which the series needs to be retrieved. one of ALLOWED_RESOURCES
+    # @param start_date the start date for the series
+    # @param end_date the end date for the series. If specifying end_date, do not specify period
+    # @param period the period starting from start_date for which the series needs to be retrieved. If specifying period,
+    #             do not use end_date
     def activity_time_series(resource: nil, start_date: nil, end_date: nil, period: nil)
 
       unless resource && ACTIVITY_RESOURCES.include?(resource)
@@ -37,8 +45,13 @@ module FitgemOauth2
       get_call(url + '.json')
     end
 
-
-
+    # retrieves intraday activity time series.
+    # @param resource (required) for which the intrady series is retrieved. one of 'calories', 'steps', 'distance', 'floors', 'elevation'
+    # @param start_date (required) start date for the series
+    # @param end_date (optional) end date for the series, if not specified, the series is for 1 day
+    # @param detail_level (required) level of detail for the series
+    # @param start_time (optional)start time for the series
+    # @param end_time the (optional)end time for the series. specify both start_time and end_time, if using either
     def intraday_activity_time_series(resource: nil, start_date: nil, end_date: nil, detail_level: nil,
                                       start_time: nil, end_time: nil)
 
@@ -82,18 +95,25 @@ module FitgemOauth2
     #      Activity Logging Methods
     # ======================================
 
+    # logs activity using the params.
+    # @param params Hash to be posted. Refer https://dev.fitbit.com/docs/activity/#activity-logging for accepted
+    #     POST parameters
     def log_activity(params)
       post_call("user/#{user_id}/activities.json", params)
     end
 
+    # deletes a logged activity
+    # @param id id of the activity log to be deleted
     def delete_logged_activity(id)
       delete_call("user/#{user_id}/activities/#{id}.json")
     end
 
+    # retrieves activity list for the user
     def activity_list
       get_call("user/#{user_id}/activities/list.json")
     end
 
+    # retrieves activity list in the tcx format
     def activity_tcx(id)
       get_call("user/#{user_id}/activities/#{id}.tcx")
     end
@@ -102,30 +122,43 @@ module FitgemOauth2
     # ======================================
     #      Activity Types
     # ======================================
+
+    # Get a tree of all valid Fitbit public activities from the activities catalog as well
+    # as private custom activities the user created in the format requested. If the activity
+    # has levels, also get a list of activity level details
     def activities
-      get_call("activities.json")
+      get_call('activities.json')
     end
 
+    # Returns the details of a specific activity in the Fitbit activities database in the format requested.
+    # @param id id of the activity for which the details need to be retrieved
     def activity(id)
       get_call("activities/#{id}.json")
     end
 
+    # gets frequent activities
     def frequent_activities
       get_call("user/#{user_id}/activities/frequent.json")
     end
 
+    # gets recent activities
     def recent_activities
       get_call("user/#{user_id}/activities/recent.json")
     end
 
+    # gets favorite activities
     def favorite_activities
       get_call("user/#{user_id}/activities/favorite.json")
     end
 
+    # adds the activity with the given ID to user's list of favorite activities.
+    # @param activity_id ID of the activity to be added to the list of favorite activities
     def add_favorite_activity(activity_id)
       post_call("user/#{user_id}/activities/log/favorite/#{activity_id}.json")
     end
 
+    # removes the activity with given ID from list of favorite activities.
+    # @param activity_id ID of the activity to be removed from favorite activity
     def remove_favorite_activity(activity_id)
       delete_call("user/#{user_id}/activities/log/favorite/#{activity_id}.json")
     end
@@ -134,6 +167,8 @@ module FitgemOauth2
     #      Activity Goals
     # ======================================
 
+    # retrieve activity goals for a period
+    # @period the period for which the goals need to be retrieved. either 'weekly' or 'daily'
     def goals(period)
       unless period && %w(daily weekly).include?(period)
         raise FitgemOauth2::InvalidArgumentError, "Goal period should either be 'daily' or 'weekly'"
@@ -141,6 +176,9 @@ module FitgemOauth2
       get_call("user/#{user_id}/activities/goals/#{period}.json")
     end
 
+    # update activity goals
+    # @param period period for the goal ('weekly' or 'daily')
+    # @param params the POST params for the request. Refer to Fitbit documentation for accepted format
     def update_activity_goals(period, params)
       unless period && %w(daily weekly).include?(period)
         raise FitgemOauth2::InvalidArgumentError, "Goal period should either be 'daily' or 'weekly'"
@@ -148,6 +186,7 @@ module FitgemOauth2
       post_call("user/#{user_id}/activities/goals/#{period}.json", params)
     end
 
+    # retrieves lifetime statistics for the user
     def lifetime_stats
       get_call("user/#{user_id}/activities.json")
     end

data/lib/fitgem_oauth2/body_measurements.rb

@@ -9,6 +9,11 @@ module FitgemOauth2
     #      Boday Fat
     # ======================================
 
+    # retrieves a list of all user's body fat log entries
+    # note: provide either end_date or period
+    # @param start_date start date for the logs
+    # @param end_date (optional)end date for the logs
+    # @param period (optional) period for the logs
     def body_fat_logs(start_date: nil, end_date: nil, period: nil)
       unless start_date
         raise FitgemOauth2::InvalidArgumentError, 'must specify start_date'
@@ -31,10 +36,14 @@ module FitgemOauth2
       get_call(url)
     end
 
+    # logs body fat
+    # @param params POST parameters for logging body fat
     def log_body_fat(params)
       post_call("user/#{user_id}/body/log/fat.json", params)
     end
 
+    # delete logged body fat
+    # @param id ID of the log to be deleted.
     def delete_logged_body_fat(id)
       delete_call("user/#{user_id}/body/log/fat/#{id}.json")
     end
@@ -44,6 +53,11 @@ module FitgemOauth2
     #   Body Time Series
     # ==================================
 
+    # retrieve body time series for the user; provide at least one of end_date and period
+    # @param resource (required)the resource requested ['bmi', 'fat', or 'weight']
+    # @param start_date (required)the start date for the series
+    # @param end_date (optional)the end date for the series
+    # @param period (optional)period for the time series. valid periods are BODY_TIME_SERIES_PERIODS
     def body_time_series(resource: nil, start_date: nil, end_date: nil, period: nil)
       unless resource && start_date
         raise FitgemOauth2::InvalidArgumentError, 'resource and start_date are required parameters. Please specify both.'
@@ -78,6 +92,8 @@ module FitgemOauth2
     #      Body Goals
     # ======================================
 
+    # retrieves body goals based on the type specified
+    # @param type 'fat' or 'weight'
     def body_goals(type)
       if type && BODY_GOALS.include?(type)
         get_call("user/#{user_id}/body/log/#{type}/goal.json")
@@ -86,10 +102,14 @@ module FitgemOauth2
       end
     end
 
+    # update body fat goal
+    # @param params POST params for updating body fat goal
     def update_body_fat_goal(params)
       post_call("user/#{user_id}/body/log/fat/goal.json", params)
     end
 
+    # update weight goal
+    # @param params POST params for updating weight goal
     def update_weight_goal(params)
       post_call("user/#{user_id}/body/log/weight/goal.json", params)
     end
@@ -98,6 +118,10 @@ module FitgemOauth2
     #      Body Weight
     # ======================================
 
+    # retrieve weight logs; specify either the end_date or period
+    # @param start_date start date for the logs
+    # @param end_date (optional)end_date for the logs
+    # @param period (optional)period for the logs
     def weight_logs(start_date: nil, end_date: nil, period: nil)
       unless start_date
         raise FitgemOauth2::InvalidArgumentError, 'start_date not specified.'
@@ -123,11 +147,14 @@ module FitgemOauth2
       get_call(url + '.json')
     end
 
-
+    # logs weight for the user
+    # @param params POST message for logging weight
     def log_weight(params)
       post_call("user/#{user_id}/body/log/weight.json", params)
     end
 
+    # delete logged weight
+    # @param id ID of the weight log to be deleted
     def delete_logged_weight(id)
       delete_call("user/#{user_id}/body/log/weight/#{id}.json")
     end

data/lib/fitgem_oauth2/devices.rb

@@ -4,6 +4,8 @@ module FitgemOauth2
     # ==================================
     #   Devices
     # ==================================
+
+    # return list of Fitbit devices linked to the account
     def devices
       get_call("user/#{user_id}/devices.json")
     end
@@ -11,18 +13,31 @@ module FitgemOauth2
     # ==================================
     #   Alarams
     # ==================================
+
+    # returns list of alarams for the tracker ID
+    # @param tracker_id ID for the tracker for which alarams need to be retrieved
     def alarms(tracker_id)
       get_call("user/#{user_id}/devices/tracker/#{tracker_id}/alarms.json")
     end
 
+    # adds an alaram
+    # @param tracker_id ID of the tracker to which the alaram needs to be added
+    # @param params POST parameters for adding the alarm
     def add_alarm(tracker_id, params)
       post_call("user/#{user_id}/devices/tracker/#{tracker_id}/alarms.json", params)
     end
 
+    # update an existing alarm
+    # @param tracker_id ID of the tracker to which alaram needs to be added.
+    # @param alarm_id ID of the alarm that needs to be updated
+    # @param params POST parameters for updating the alarm
     def update_alarm(tracker_id, alarm_id, params)
       post_call("user/#{user_id}/devices/tracker/#{tracker_id}/alarms/#{alarm_id}.json", params)
     end
 
+    # removes an existing alaram
+    # @param tracker_id ID of the tracker from which alaram needs to be removed
+    # @params alarm_id ID of the alaram that needs to be removed
     def remove_alarm(tracker_id, alarm_id)
       delete_call("user/#{user_id}/devices/tracker/#{tracker_id}/alarms/#{alarm_id}.json")
     end

data/lib/fitgem_oauth2/friends.rb

@@ -1,9 +1,11 @@
 module FitgemOauth2
   class Client
+    # retrieves list of friends for the current user
     def friends
       get_call("user/#{user_id}/friends.json")
     end
 
+    # retrieves leaderboard for the user
     def friends_leaderboard
       get_call("user/#{user_id}/friends/leaderboard.json")
     end
@@ -12,14 +14,20 @@ module FitgemOauth2
     #   Friend Invitations
     # ==================================
 
+    # send an invitation to a friend
+    # @param params POST parameters for sending friend invite.
     def invite_friend(params)
       post_call("user/#{user_id}/friends/invitations.json", params)
     end
 
+    # retrieve list of friend invitations
     def friend_invitations
       get_call("user/#{user_id}/friends/invitations.json")
     end
 
+    # respond to a friend invite
+    # @param from_user_id the ID of the friend
+    # @param params POST parameters for responding to the invite.
     def respond_to_invitation(from_user_id, params)
       post_call("user/#{user_id}/friends/invitations/#{from_user_id}.json", params)
     end
@@ -28,6 +36,7 @@ module FitgemOauth2
     #   Badges
     # ==================================
 
+    # retrieve badges for the user
     def badges
       get_call("user/#{user_id}/badges.json")
     end

data/lib/fitgem_oauth2/heartrate.rb

@@ -4,6 +4,7 @@ module FitgemOauth2
     HR_PERIODS = %w(1d 7d 30d 1w 1m)
     HR_DETAIL_LEVELS = %w(1sec 1min)
 
+    # retrieve heartrate time series
     def heartrate_time_series(start_date: nil, end_date: nil, period: nil)
       unless start_date
         raise FitgemOauth2::InvalidArgumentError, 'Start date not provided.'
@@ -28,6 +29,7 @@ module FitgemOauth2
       get_call(url + '.json')
     end
 
+    # retrieve intraday series for heartrate
     def intraday_heartrate_time_series(start_date: nil, end_date: nil, detail_level: nil, start_time: nil, end_time: nil)
       unless start_date
         raise FitgemOauth2::InvalidArgumentError, 'Start date not provided.'

data/lib/fitgem_oauth2/sleep.rb

@@ -5,18 +5,28 @@ module FitgemOauth2
     SLEEP_RESOURCES = %w(startTime  timeInBed  minutesAsleep  awakeningsCount  minutesAwake  minutesToFallAsleep  minutesAfterWakeup  efficiency)
     SLEEP_PERIODS = %w(1d 7d 30d 1w 1m 3m 6m 1y max)
 
+    # retrieve sleep logs for a date
+    # @param date date for which sleep logs needs to be accessed
     def sleep_logs(date)
       get_call("user/#{user_id}/sleep/date/#{format_date(date)}.json")
     end
 
+    # retrieve sleep goal for the user
     def sleep_goal
       get_call("user/#{user_id}/sleep/goal.json")
     end
 
+    # update sleep goal
+    # @param params POST parameters for updating sleep goal
     def update_sleep_goal(params)
       post_call("user/#{user_id}/sleep/goal.json", params)
     end
 
+    # retrieve time series data for sleep
+    # @param resource sleep resource to be requested
+    # @param start_date starting date for sleep time series
+    # @param end_date ending date for sleep time series
+    # @param period period for sleep time series
     def sleep_time_series(resource: nil, start_date: nil, end_date: nil, period: nil)
       unless start_date
         raise FitgemOauth2::InvalidArgumentError, 'Start date not provided.'
@@ -41,10 +51,14 @@ module FitgemOauth2
       get_call(url + '.json')
     end
 
+    # log sleep
+    # @param params POST params for creating sleep log
     def log_sleep(params)
       post_call("user/#{user_id}/sleep.json", params)
     end
 
+    # deleted sleep log
+    # @param log_id ID of the sleep log that needs to be removed.
     def delete_logged_sleep(log_id)
       delete_call("user/#{user_id}/sleep/#{log_id}.json")
     end

data/lib/fitgem_oauth2/version.rb

@@ -1,3 +1,3 @@
 module FitgemOauth2
-  VERSION = '1.0.2'
+  VERSION = '1.0.3'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fitgem_oauth2
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - Ankit Gupta
@@ -112,3 +112,4 @@ signing_key:
 specification_version: 4
 summary: Fitbit API client library
 test_files: []
+has_rdoc: