fitbyte 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 224202239ccc8345b4cced0077f4f6deb3aac0e6
-  data.tar.gz: 172d0d9768c89d91514612791138db1a16471ef6
+  metadata.gz: a32301ec7ebc23f284d69bf208224560907ca0b1
+  data.tar.gz: 1f31799f033bd22b5994712bca93131e44e3a747
 SHA512:
-  metadata.gz: 1a31ebbfaec0c459045ab8c7d7a358ec8e2abc52e980f9f3d31162ff7177ac044aef48d2cc99efe816e52b70265490a1a617f2e537d6865c03e045d6c3b2cd72
-  data.tar.gz: 3d301be5aa02e6800c2715212187654e208aa5e8f4644f88e3d784f7a497108a75a49be57d0675876a4a1915288801403d803d3f38f0255c7e3b2a3dbab63236
+  metadata.gz: 9e3f5ef3548894d0acd1fb0380e8cf91df985885709d35584727c3336364ab20926ce42b4bace452ecedfc47057ed1ed93c99c79cbc20b41889d149f0d6ec7c8
+  data.tar.gz: cc11b65e4b42bcf77e45294d7b127d1b6ed517234bf1397e9d7d79c737df91b5a049288922e361b6efa82ac07d6738e9b2aabf82ca0d41feda3c69ae59d90ec6

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+0.6.0
+-----
+- A `refresh_token` option can be passed in to retrieve an existing access token.
+- A configuration block can now be passed in to Fitbyte, to allow for the setting of default instance attributes.
+- File/code reorganization.
+
 0.5.0
 -----
 - Add Heart Rate endpoint support. Add support for Time Series endpoints.

data/README.md

@@ -55,7 +55,7 @@ To make the response more easily suited for attribute-assignment, it can be pars
 
 ```ruby
 client.snake_case = true
-client.food_logs Date.today, snake_case: true
+client.food_logs Date.today
 # => { "foods" => [{ "is_favorite" => true, "log_date" => "2015-06-26", "log_id" => 1820, "logged_food" => { "access_level" => "PUBLIC", "amount" => 132.57, "brand" => "", "calories" => 752, ...}] }
 ```
 

data/lib/fitbyte.rb

@@ -1,6 +1,5 @@
 require "oauth2"
 require "date"
-require "ostruct"
 require "fitbyte/version"
 require "fitbyte/client"
 

data/lib/fitbyte/activities.rb

@@ -16,24 +16,24 @@ module Fitbyte
     #   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)
+      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)
+      get("user/#{user_id}/activities/frequent.json", opts)
     end
 
     def recent_activities(opts={})
-      get("user/#{@user_id}/activities/recent.json", 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)
+      get("user/#{user_id}/activities/favorite.json", opts)
     end
 
     # Gets a tree of all valid Fitbit public activities from
@@ -54,7 +54,7 @@ module Fitbyte
     # * +:limit+ - the max of the number of entries returned (max: 100)
 
     def activity_logs_list(opts={})
-      get("user/#{@user_id}/activities/list.json", 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.
@@ -70,7 +70,7 @@ module Fitbyte
     #   My Achievements tile on the website dashboard.
 
     def lifetime_stats(opts={})
-      get("user/#{@user_id}/activities.json", opts)
+      get("user/#{user_id}/activities.json", opts)
     end
 
     def activity_time_series(resource, opts={})
@@ -91,20 +91,14 @@ module Fitbyte
       end
 
       if period
-        result = get("user/#{@user_id}/activities/#{resource}/date/#{format_date(end_date)}/#{period}.json", opts)
+        result = get("user/#{user_id}/activities/#{resource}/date/#{format_date(end_date)}/#{period}.json", opts)
       else
-        result = get("user/#{@user_id}/activities/#{resource}/date/#{format_date(start_date)}/#{format_date(end_date)}.json", opts)
+        result = get("user/#{user_id}/activities/#{resource}/date/#{format_date(start_date)}/#{format_date(end_date)}.json", opts)
       end
       # remove root key from response
       result.values[0]
     end
 
-    # ACTIVITY_RESOURCES.each do |resource_path|
-    #   define_method("activity_#{to_snake_case(resource_path).gsub('/', '_')}_series") do |opts={}|
-    #     activity_time_series(resource_path, opts={})
-    #   end
-    # end
-
     # POST Activities
     # ===============
 
@@ -122,13 +116,13 @@ module Fitbyte
     # * +:distanceUnit+ - distance measurement unit
 
     def log_activity(opts)
-      post("user/#{@user_id}/activities.json", 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")
+      post("user/#{user_id}/activities/favorite/#{activity_id}.json")
     end
 
     # DELETE Activities
@@ -137,13 +131,13 @@ module Fitbyte
     # 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")
+      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")
+      delete("user/#{user_id}/activities/favorite/#{activity_id}.json")
     end
   end
 end

data/lib/fitbyte/alarms.rb

@@ -6,7 +6,7 @@ module Fitbyte
     # Returns a list of the set alarms connected to a user's account.
 
     def alarms(tracker_id, opts={})
-      get("user/#{@user_id}/devices/tracker/#{tracker_id}/alarms.json", opts)
+      get("user/#{user_id}/devices/tracker/#{tracker_id}/alarms.json", opts)
     end
 
     # POST Alarms
@@ -21,7 +21,7 @@ module Fitbyte
     # * +:weekDays+ - comma separated list of days of the week on which the alarm vibrates (MONDAY,TUESDAY)
 
     def add_alarm(tracker_id, opts={})
-      post("user/#{@user_id}/devices/tracker/#{tracker_id}/alarms.json", opts)
+      post("user/#{user_id}/devices/tracker/#{tracker_id}/alarms.json", opts)
     end
 
     # Updates the alarm entry with a given ID for a given device.
@@ -37,7 +37,7 @@ module Fitbyte
     # * +:vibe+ - vibe pattern; only one value for now (DEFAULT)
 
     def update_alarm(tracker_id, alarm_id, opts={})
-      post("user/#{@user_id}/devices/tracker/#{tracker_id}/alarms/#{alarm_id}.json", opts)
+      post("user/#{user_id}/devices/tracker/#{tracker_id}/alarms/#{alarm_id}.json", opts)
     end
 
     # DELETE Alarms
@@ -46,7 +46,7 @@ module Fitbyte
     # Deletes the user's device alarm entry with the given ID for a given device.
 
     def delete_alarm(tracker_id, alarm_id, opts={})
-      delete("user/#{@user_id}/devices/tracker/#{tracker_id}/alarms/#{alarm_id}.json", opts)
+      delete("user/#{user_id}/devices/tracker/#{tracker_id}/alarms/#{alarm_id}.json", opts)
     end
   end
 end

data/lib/fitbyte/base.rb

@@ -0,0 +1,24 @@
+require "fitbyte/helpers/configuration"
+require "fitbyte/helpers/utils"
+require "fitbyte/helpers/exceptions"
+
+module Fitbyte
+  extend Configuration
+
+  define_setting :client_id
+  define_setting :client_secret
+  define_setting :redirect_uri
+
+  define_setting :site_url,       "https://api.fitbit.com"
+  define_setting :authorize_url,  "https://www.fitbit.com/oauth2/authorize"
+  define_setting :token_url,      "https://api.fitbit.com/oauth2/token"
+
+  define_setting :unit_system,    "en_US"
+  define_setting :locale,         "en_US"
+  define_setting :scope,          "activity nutrition profile settings sleep social weight heartrate"
+
+  define_setting :api_version,    "1"
+
+  define_setting :snake_case,     false
+  define_setting :symbolize_keys, false
+end

data/lib/fitbyte/body.rb

@@ -36,9 +36,9 @@ module Fitbyte
       end
 
       if period
-        result = get("user/#{@user_id}/body/#{resource}/date/#{format_date(end_date)}/#{period}.json", opts)
+        result = get("user/#{user_id}/body/#{resource}/date/#{format_date(end_date)}/#{period}.json", opts)
       else
-        result = get("user/#{@user_id}/body/#{resource}/date/#{format_date(start_date)}/#{format_date(end_date)}.json", opts)
+        result = get("user/#{user_id}/body/#{resource}/date/#{format_date(start_date)}/#{format_date(end_date)}.json", opts)
       end
       # remove root key from response
       result.values[0]

data/lib/fitbyte/client.rb

@@ -1,5 +1,4 @@
-require "fitbyte/helpers"
-require "fitbyte/exceptions"
+require "fitbyte/base"
 require "fitbyte/activities"
 require "fitbyte/heart_rate"
 require "fitbyte/goals"
@@ -15,31 +14,21 @@ require "fitbyte/water"
 module Fitbyte
   class Client
     attr_accessor :api_version, :unit_system, :locale, :scope, :snake_case, :symbolize_keys
+    attr_reader   :user_id
 
     def initialize(opts)
-      missing_args = [:client_id, :client_secret, :redirect_uri] - opts.keys
+      missing_args = [:client_id, :client_secret] - opts.keys
       raise Fitbyte::InvalidArgumentError, "Required arguments: #{missing_args.join(', ')}" if missing_args.size > 0
 
-      opts = defaults.merge(opts)
-
-      @client_id = opts[:client_id]
-      @client_secret = opts[:client_secret]
-
-      @redirect_uri = opts[:redirect_uri]
-      @site_url = opts[:site_url]
-      @authorize_url = opts[:authorize_url]
-      @token_url = opts[:token_url]
-
-      @unit_system = opts[:unit_system]
-      @locale = opts[:locale]
-      @scope = format_scope(opts[:scope])
-
-      @api_version = opts[:api_version]
-      @snake_case = opts[:snake_case]
-      @symbolize_keys = opts[:symbolize_keys]
+      %w(client_id client_secret redirect_uri site_url authorize_url token_url
+      unit_system locale scope api_version snake_case symbolize_keys).each do |attr|
+        instance_variable_set("@#{attr}", (opts[attr.to_sym] || Fitbyte.send(attr)))
+      end
 
       @client = OAuth2::Client.new(@client_id, @client_secret, site: @site_url,
                                    authorize_url: @authorize_url, token_url: @token_url)
+
+      restore_token(opts[:refresh_token]) if opts[:refresh_token]
     end
 
     def auth_page_link
@@ -52,6 +41,12 @@ module Fitbyte
       return @token
     end
 
+    def restore_token(refresh_token)
+      @token = OAuth2::AccessToken.from_hash(@client, refresh_token: refresh_token).refresh!(headers: auth_header)
+      @user_id = @token.params["user_id"]
+      return @token
+    end
+
     def token
       @token.expired? ? refresh_token : @token
     end
@@ -95,19 +90,5 @@ module Fitbyte
       deep_symbolize_keys!(object) if (opts[:symbolize_keys] || symbolize_keys)
       return object
     end
-
-    def defaults
-      {
-        site_url: "https://api.fitbit.com",
-        authorize_url: "https://www.fitbit.com/oauth2/authorize",
-        token_url: "https://api.fitbit.com/oauth2/token",
-        scope: "activity nutrition profile settings sleep social weight heartrate",
-        unit_system: "en_US",
-        locale: "en_US",
-        api_version: "1",
-        snake_case: false,
-        symbolize_keys: false
-      }
-    end
   end
 end

data/lib/fitbyte/devices.rb

@@ -1,7 +1,7 @@
 module Fitbyte
   class Client
     def devices(opts={})
-      get("user/#{@user_id}/devices.json", opts)
+      get("user/#{user_id}/devices.json", opts)
     end
   end
 end

data/lib/fitbyte/food.rb

@@ -3,23 +3,23 @@ module Fitbyte
     FOOD_RESOURCES = %w(caloriesIn water)
 
     def food_logs(date=Date.today, opts={})
-      get("user/#{@user_id}/foods/log/date/#{format_date(date)}.json", opts)
+      get("user/#{user_id}/foods/log/date/#{format_date(date)}.json", opts)
     end
 
     def recent_foods(opts={})
-      get("user/#{@user_id}/foods/log/recent.json", opts)
+      get("user/#{user_id}/foods/log/recent.json", opts)
     end
 
     def frequent_foods(opts={})
-      get("user/#{@user_id}/foods/log/frequent.json", opts)
+      get("user/#{user_id}/foods/log/frequent.json", opts)
     end
 
     def favorite_foods(opts={})
-      get("user/#{@user_id}/foods/log/favorite.json", opts)
+      get("user/#{user_id}/foods/log/favorite.json", opts)
     end
 
     def food_goals(opts={})
-      get("user/#{@user_id}/foods/log/goal.json", opts)
+      get("user/#{user_id}/foods/log/goal.json", opts)
     end
 
     def food_time_series(resource, opts={})
@@ -40,9 +40,9 @@ module Fitbyte
       end
 
       if period
-        result = get("user/#{@user_id}/foods/log/#{resource}/date/#{format_date(end_date)}/#{period}.json", opts)
+        result = get("user/#{user_id}/foods/log/#{resource}/date/#{format_date(end_date)}/#{period}.json", opts)
       else
-        result = get("user/#{@user_id}/foods/log/#{resource}/date/#{format_date(start_date)}/#{format_date(end_date)}.json", opts)
+        result = get("user/#{user_id}/foods/log/#{resource}/date/#{format_date(start_date)}/#{format_date(end_date)}.json", opts)
       end
       # remove root key from response
       result.values[0]

data/lib/fitbyte/friends.rb

@@ -1,11 +1,11 @@
 module Fitbyte
   class Client
     def friends(opts={})
-      get("user/#{@user_id}/friends.json", opts)
+      get("user/#{user_id}/friends.json", opts)
     end
 
     def friends_leaderboard(opts={})
-      get("user/#{@user_id}/friends/leaderboard.json", opts)
+      get("user/#{user_id}/friends/leaderboard.json", opts)
     end
   end
 end

data/lib/fitbyte/goals.rb

@@ -2,17 +2,17 @@ module Fitbyte
   class Client
     # GET Goals
     # =========
-    
+
     # Retrieves a user's current daily activity goals.
 
     def daily_goals(opts={})
-      get("user/#{@user_id}/activities/goals/daily.json", 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)
+      get("user/#{user_id}/activities/goals/weekly.json", opts)
     end
 
     # POST Goals
@@ -29,7 +29,7 @@ module Fitbyte
     # * +:steps+ - steps goal value; integer
 
     def create_or_update_daily_goals(opts={})
-      post("user/#{@user_id}/activities/goals/daily.json", 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
@@ -43,7 +43,7 @@ module Fitbyte
     # * +:steps+ - steps goal value; integer
 
     def create_or_update_weekly_goals(opts={})
-      post("user/#{@user_id}/activities/goals/weekly.json", opts)
+      post("user/#{user_id}/activities/goals/weekly.json", opts)
     end
   end
 end

data/lib/fitbyte/heart_rate.rb

@@ -14,9 +14,9 @@ module Fitbyte
       end
 
       if period
-        result = get("user/#{@user_id}/activities/heart/date/#{format_date(end_date)}/#{period}.json", opts)
+        result = get("user/#{user_id}/activities/heart/date/#{format_date(end_date)}/#{period}.json", opts)
       else
-        result = get("user/#{@user_id}/activities/heart/date/#{format_date(start_date)}/#{format_date(end_date)}.json", opts)
+        result = get("user/#{user_id}/activities/heart/date/#{format_date(start_date)}/#{format_date(end_date)}.json", opts)
       end
       # remove root key from response
       result.values[0]

data/lib/fitbyte/helpers/configuration.rb

@@ -0,0 +1,25 @@
+module Configuration
+  def configure
+    yield self
+  end
+
+  def define_setting(name, default = nil)
+    class_variable_set("@@#{name}", default)
+
+    define_class_method "#{name}=" do |value|
+      class_variable_set("@@#{name}", value)
+    end
+
+    define_class_method name do
+      class_variable_get("@@#{name}")
+    end
+  end
+
+  private
+
+  def define_class_method(name, &block)
+    (class << self; self; end).instance_eval do
+      define_method name, &block
+    end
+  end
+end

data/lib/fitbyte/sleep.rb

@@ -4,7 +4,7 @@ module Fitbyte
                          minutesAwake minutesToFallAsleep minutesAfterWakeup efficiency)
 
     def sleep_logs(date=Date.today, opts={})
-      get("user/#{@user_id}/sleep/date/#{format_date(date)}.json", opts)
+      get("user/#{user_id}/sleep/date/#{format_date(date)}.json", opts)
     end
 
     def sleep_time_series(resource, opts={})
@@ -25,9 +25,9 @@ module Fitbyte
       end
 
       if period
-        result = get("user/#{@user_id}/activities/#{resource}/date/#{format_date(end_date)}/#{period}.json", opts)
+        result = get("user/#{user_id}/activities/#{resource}/date/#{format_date(end_date)}/#{period}.json", opts)
       else
-        result = get("user/#{@user_id}/activities/#{resource}/date/#{format_date(start_date)}/#{format_date(end_date)}.json", opts)
+        result = get("user/#{user_id}/activities/#{resource}/date/#{format_date(start_date)}/#{format_date(end_date)}.json", opts)
       end
       # remove root key from response
       result.values[0]

data/lib/fitbyte/user.rb

@@ -1,11 +1,11 @@
 module Fitbyte
   class Client
     def profile(opts={})
-      get("user/#{@user_id}/profile.json", opts)
+      get("user/#{user_id}/profile.json", opts)
     end
 
     def badges(opts={})
-      get("user/#{@user_id}/badges.json", opts)
+      get("user/#{user_id}/badges.json", opts)
     end
   end
 end

data/lib/fitbyte/version.rb

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

data/lib/fitbyte/water.rb

@@ -1,7 +1,7 @@
 module Fitbyte
   class Client
     def water_logs(date=Date.today, opts={})
-      get("user/#{@user_id}/foods/log/water/date/#{format_date(date)}.json", opts)
+      get("user/#{user_id}/foods/log/water/date/#{format_date(date)}.json", opts)
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fitbyte
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Zoran Pesic
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-04-10 00:00:00.000000000 Z
+date: 2016-04-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oauth2
@@ -81,21 +81,21 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- bin/console
-- bin/setup
 - fitbyte.gemspec
 - lib/fitbyte.rb
 - lib/fitbyte/activities.rb
 - lib/fitbyte/alarms.rb
+- lib/fitbyte/base.rb
 - lib/fitbyte/body.rb
 - lib/fitbyte/client.rb
 - lib/fitbyte/devices.rb
-- lib/fitbyte/exceptions.rb
 - lib/fitbyte/food.rb
 - lib/fitbyte/friends.rb
 - lib/fitbyte/goals.rb
 - lib/fitbyte/heart_rate.rb
-- lib/fitbyte/helpers.rb
+- lib/fitbyte/helpers/configuration.rb
+- lib/fitbyte/helpers/exceptions.rb
+- lib/fitbyte/helpers/utils.rb
 - lib/fitbyte/sleep.rb
 - lib/fitbyte/user.rb
 - lib/fitbyte/version.rb

data/bin/console

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "fitbyte"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start

data/bin/setup

@@ -1,7 +0,0 @@
-#!/bin/bash
-set -euo pipefail
-IFS=$'\n\t'
-
-bundle install
-
-# Do any other automated setup that you need to do here