fitbyte 0.2.5 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2288b2aa276802af1ee13b8203f7f95bb58c871d
-  data.tar.gz: 15e907b187d26a2faaeb8132506edc32830ca9ab
+  metadata.gz: d593e9552bee3c7dc1319f3f9ba196e7d4064b29
+  data.tar.gz: 87c7a205b3131164a185c2d7423ec8695f40fce5
 SHA512:
-  metadata.gz: c5c642754e899b14be4b0ffc9e5013920e35d5903e47e5f10c5d5b063daf53c8f53e50f9d2353ec1c77c2f51fca25f74bce70c8f04b150d2802e706189012dd4
-  data.tar.gz: 490c4ce5f77788c5f011d683f16dd8afdc36394186987233d185e2f3efd1332caf5bf4c95a772f178381edfe9bdf943ee101c57140b1cfc48baa788c868ea676
+  metadata.gz: a6b484d18dc864cbc1485e7b53f88f42008051f3f763fe41b60170305506564cd3c554ceed1d663d546fb7a8aabd19a063b2de9dab544e56fc2001d5095b4023
+  data.tar.gz: 992028f7008f2fac652494b120b6bf6aef90c5c96c50056df7b71535bc410b768e3e9c814b4d091b79b4262fe501ca9f0022c6036c2dba932eaccf4325d24730

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+0.2.6
+-----
+- Expand API endpoint support for the following actions:
+  - Add activity to favorites
+  - Retrieve list of activity log entries
+  - Create/update daily/weekly goals
+  - Delete activity
+  - Remove activity from favorites
+
 0.2.5
 -----
 - Responses now return FitStruct objects (inherit from OpenStruct).

data/README.md

@@ -59,6 +59,26 @@ client.food_logs Date.today, raw: true
 # => { :foods => [{ :isFavorite => true, :logDate => "2015-06-26", :logId => 1820, :loggedFood => { :accessLevel => "PUBLIC", :amount => 132.57, :brand => "", :calories => 752, ...}] }
 ```
 
+### Options
+
+When initializing a `Fitbyte::Client` instance, you're given access to a handful of options:
+
+- `:api_version` - API version to be used when making requests (default: "1")
+
+---
+- `:unit_system` - The measurement unit system to use for response values (default: "en_US" | available: "en_US", "en_GB", and "any" for metric)
+
+---
+- `:locale` - The locale to use for response values (default: "en_US" | available: "en_US", "fr_FR", "de_DE", "es_ES", "en_GB", "en_AU", "en_NZ" and "ja_JP")
+
+---
+- `:scope` - A space-delimited list of the permissions you are requesting (default: "activity nutrition profile settings sleep social weight" | available: "activity", "heartrate", "location", "nutrition", "profile", "settings" "sleep", "social" and "weight")
+
+---
+- `:raw_response` - Setting this option to `true` returns response values on subsequent calls as parsed JSON; by default, response values use FitStruct objects, for convenient method-like attribute access (default: false | available: true, false)
+
+---
+
 ## License
 
 This gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/lib/fitbyte/activities.rb

@@ -1,31 +1,148 @@
 module Fitbyte
   class Client
+    # GET Activities
+    # ==============
+
+    # Retrieves a summary and list of a user's activities and activity log entries for a given day
+    #   in the format requested using units in the unit system which corresponds to the Accept-Language header provided.
+
     def daily_activity_summary(date=Date.today, opts={})
       get("user/#{@user_id}/activities/date/#{format_date(date)}.json", opts)
     end
 
+    # Retrieves a list of a user's frequent activities in the format requested using units
+    #   in the unit system which corresponds to the Accept-Language header provided.
+
     def frequent_activities(opts={})
       get("user/#{@user_id}/activities/frequent.json", opts)
     end
 
+    def recent_activities(opts={})
+      get("user/#{@user_id}/activities/recent.json", opts)
+    end
+
+    # Returns a list of a user's favorite activities.
+
     def favorite_activities(opts={})
       get("user/#{@user_id}/activities/favorite.json", opts)
     end
 
+    # Gets a tree of all valid Fitbit public activities from
+    #   the activities catalog as well as private custom activities the user created.
+
     def all_activities(opts={})
       get("activities.json", opts)
     end
 
+    # Retrieves a list of a user's activity log entries before or after a given day with
+    #   offset and limit using units in the unit system which corresponds to the Accept-Language header provided.
+
+    # ==== Parameters
+    # * +:beforeDate+ - the date; formatted in yyyy-MM-ddTHH:mm:ss
+    # * +:afterDate+ - the date; formatted in yyyy-MM-ddTHH:mm:ss
+    # * +:sort+ - the sort order of entries by date (asc or desc)
+    # * +:offset+ - the offset number of entries
+    # * +:limit+ - the max of the number of entries returned (max: 100)
+
+    def activity_logs_list(opts={})
+      get("user/#{@user_id}/activities/list.json", opts)
+    end
+
+    # Returns the details of a specific activity in the Fitbit activities database in the format requested.
+    #   If activity has levels, also returns a list of activity level details.
+
+    def activity(activity_id)
+      get("activities/#{activity_id}.json")
+    end
+
+    # Retrieves the user's activity statistics in the format requested using units
+    #   in the unit system which corresponds to the Accept-Language header provided.
+    #   Activity statistics includes Lifetime and Best achievement values from the
+    #   My Achievements tile on the website dashboard.
+
     def lifetime_stats(opts={})
       get("user/#{@user_id}/activities.json", opts)
     end
 
+    # Retrieves a user's current daily activity goals.
+
     def daily_goals(opts={})
       get("user/#{@user_id}/activities/goals/daily.json", opts)
     end
 
+    # Retrieves a user's current weekly activity goals.
+
     def weekly_goals(opts={})
       get("user/#{@user_id}/activities/goals/weekly.json", opts)
     end
+
+    # POST Activities
+    # ===============
+
+    # Creates log entry for an activity or user's private custom activity using units
+    #   in the unit system which corresponds to the Accept-Language header provided.
+
+    # ==== POST Parameters
+    # * +:activityId+ - activity id
+    # * +:activityName+ - custom activity name. Either activity ID or activityName must be provided
+    # * +:manualCalories+ - calories burned, specified manually. Required with activityName, otherwise optional
+    # * +:startTime+ - activity start time; formatted in HH:mm:ss
+    # * +:durationMillis+ - duration in milliseconds
+    # * +:date+ - log entry date; formatted in yyyy-MM-dd
+    # * +:distance+ - distance; required for logging directory activity; formatted in X.XX
+    # * +:distanceUnit+ - distance measurement unit
+
+    def log_activity(opts)
+      post("user/#{@user_id}/activities.json", opts)
+    end
+
+    # Adds the activity with the given ID to user's list of favorite activities.
+
+    def add_favorite_activity(activity_id)
+      post("user/#{@user_id}/activities/favorite/#{activity_id}.json")
+    end
+
+    # Creates or updates a user's daily activity goals and returns a response using units
+    #   in the unit system which corresponds to the Accept-Language header provided.
+
+    # ==== POST Parameters
+    # * +:caloriesOut+ - calories output goal value; integer
+    # * +:activeMinutes+ - active minutes goal value; integer
+    # * +:floors+ - floor goal value; integer
+    # * +:distance+ - distance goal value; X.XX or integer
+    # * +:steps+ - steps goal value; integer
+
+    def create_or_update_daily_goals(opts={})
+      post("user/#{@user_id}/activities/goals/daily.json", opts)
+    end
+
+    # Creates or updates a user's weekly activity goals and returns a response using units
+    #   in the unit system which corresponds to the Accept-Language header provided.
+
+    # ==== POST Parameters
+    # * +:caloriesOut+ - calories output goal value; integer
+    # * +:activeMinutes+ - active minutes goal value; integer
+    # * +:floors+ - floor goal value; integer
+    # * +:distance+ - distance goal value; X.XX or integer
+    # * +:steps+ - steps goal value; integer
+
+    def create_or_update_weekly_goals(opts={})
+      post("user/#{@user_id}/activities/goals/weekly.json", opts)
+    end
+
+    # DELETE Activities
+    # =================
+
+    # Deletes a user's activity log entry with the given ID.
+
+    def delete_activity(activity_log_id)
+      delete("user/#{@user_id}/activities/#{activity_log_id}.json")
+    end
+
+    # Removes the activity with the given ID from a user's list of favorite activities.
+
+    def delete_favorite_activity(activity_id)
+      delete("user/#{@user_id}/activities/favorite/#{activity_id}.json")
+    end
   end
 end

data/lib/fitbyte/client.rb

@@ -71,8 +71,20 @@ module Fitbyte
 
     def get(path, opts={})
       raw = opts[:raw].nil? ? @raw_response : opts[:raw]
-      MultiJson.load(token.get(("#{@api_version}/" + path), headers: request_headers).response.body,
-                     symbolize_keys: true, object_class: (FitStruct unless raw))
+      response = token.get(("#{@api_version}/" + path), headers: request_headers).response
+      MultiJson.load(response.body, symbolize_keys: true, object_class: (FitStruct unless raw)) unless response.status == 204
+    end
+
+    def post(path, opts={})
+      raw = opts[:raw].nil? ? @raw_response : opts[:raw]
+      response = token.post(("#{@api_version}/" + path), body: opts, headers: request_headers).response
+      MultiJson.load(response.body, symbolize_keys: true, object_class: (FitStruct unless raw)) unless response.status == 204
+    end
+
+    def delete(path, opts={})
+      raw = opts[:raw].nil? ? @raw_response : opts[:raw]
+      response = token.delete(("#{@api_version}/" + path), headers: request_headers).response
+      MultiJson.load(response.body, symbolize_keys: true, object_class: (FitStruct unless raw)) unless response.status == 204
     end
 
     def defaults

data/lib/fitbyte/version.rb

@@ -1,4 +1,4 @@
 module Fitbyte
-  VERSION = "0.2.5"
+  VERSION = "0.2.6"
   REPO_URL = "https://github.com/zokioki/fitbyte"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fitbyte
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.2.6
 platform: ruby
 authors:
 - Zoran Pesic
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-10-18 00:00:00.000000000 Z
+date: 2015-12-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oauth2