fitbyte 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3868d5e912a5ea9c97364b68b5185a12af3a510a
-  data.tar.gz: 10077bcf8477ba026a4af634a448502f734602a5
+  metadata.gz: 5d0655317d528786ceaf0f17b6c784cc8b5efeb1
+  data.tar.gz: 619f36cf862d95e9ddde9e8d1f77e6bd9cbfb7e3
 SHA512:
-  metadata.gz: f5c5289e461ebf1349d26035ae81615754a9354b08b17a1f137fd90a38e8a29f82bf6d322f4d12a05335aedc09f6c63079fcfec01f3a77aed351118d57a49643
-  data.tar.gz: dce52e6d3ad1dbecf34ee0376bd95945ad5c3aaa26455628e6bf4b37e59f8881a4b5a257af58388a0f732eb576da9fe9afa0434183768fef80b19f941d4bcf74
+  metadata.gz: 09a3f33748d49d7bfcc248fb72a776c80bc4051fb3b894230d67c0f07e01c202729aef6fef5b89fbaa265ca0f81574bcbeaa20312915654b4ed3a3352e35fc1d
+  data.tar.gz: 30275329df704750b1b8178bfedd01d022e949c8a382b29a2e21ae42ca7528f8a57c99f42513e8844b66f6219eeb9ecd85e3dd68c86bb83a80e58bba52d5da86

data/README.md

@@ -1,51 +1,51 @@
 # Fitbyte
 
-Fitbyte is a gem that allows interaction with Fitbit's REST API, using the OAuth 2.0 protocol for user authorization.
+Fitbyte is a gem that allows interaction with [Fitbit's REST API](https://dev.fitbit.com/docs/basics/), using the OAuth 2.0 protocol for user authorization.
 
-**Please Note:** Fitbit's API is currently in beta, and is in active/rapid development.
+**Note:** Fitbit's API is currently in beta, and is in active/rapid development. Breaking changes to certain endpoints may be introduced during early development of this gem, until Fitbit's API solidifies.
 
 ## Installation
 
-Add the following line to your application's Gemfile:
+To install the latest release:
+
+    $ gem install fitbyte
+
+To include in a Rails project, add it to the Gemfile:
 
 ```ruby
 gem "fitbyte"
 ```
 
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install fitbyte
-
 ## Usage
 
-Create a client instance:
+To use the Fitbit API, you must register your application at [dev.fitbit.com](https://dev.fitbit.com/apps). After registering, you should have access to **CLIENT ID**, **CLIENT SECRET**, and **REDIRECT URI** values for use in instantiating a *Fitbyte::Client* object.
+
+- Create a client instance:
 
 ```ruby
-client = Fitbyte::Client.new(client_id: my_client_id, client_secret: my_client_secret, redirect_uri: "http://example.com")
+client = Fitbyte::Client.new(client_id: my_client_id,
+                             client_secret: my_client_secret,
+                             redirect_uri: "http://example.com")
 ```
 
-Generate a link for the Fitbit authorization page:
+- Generate a link for the Fitbit authorization page:
 
 ```ruby
 client.auth_page_link
 # => https://fitbit.com/oauth2/authorize?client_id=123XYZ&redirect_uri=...
 ```
 
-Follow generated link to Fitbit's authorization page. Once the given permissions prompt has been approved, you're sent to the `redirect_uri`, along with an authorization `code` query param. This authorization code can be exchanged for an access token:
+- Follow generated link to Fitbit's authorization page. After approving your app, you're sent to the `redirect_uri`, with an appended authorization `code` param, which you'll exchange for an access token:
 
 ```ruby
 client.get_token(auth_code)
 ```
 
-You are now authenticated and can make calls to Fitbit's API:
+You're now authenticated and can make calls to Fitbit's API:
 
 ```ruby
 client.food_logs
-# => returns JSON of today's food logs
+# => returns JSON of current day's food logs
 ```
 
 ## License

data/fitbyte.gemspec

@@ -6,7 +6,7 @@ require 'fitbyte/version'
 Gem::Specification.new do |spec|
   spec.name          = "fitbyte"
   spec.version       = Fitbyte::VERSION
-  spec.authors       = ["Zoran"]
+  spec.authors       = ["Zoran Pesic"]
   spec.email         = ["zoran1991@gmail.com"]
 
   spec.summary       = %q{A gem that allows interaction with Fitbit's REST API, using OAuth2 for user authorization.}

data/lib/fitbyte/activities.rb

@@ -1,31 +1,31 @@
 module Fitbyte
   class Client
     def daily_activity_summary(date=Date.today)
-      get("1/user/-/activities/date/#{format_date(date)}.json")
+      get("user/-/activities/date/#{format_date(date)}.json")
     end
 
     def frequent_activities
-      get("1/user/-/activities/frequent.json")
+      get("user/-/activities/frequent.json")
     end
 
     def favorite_activities
-      get("1/user/-/activities/favorite.json")
+      get("user/-/activities/favorite.json")
     end
 
     def all_activities
-      get("1/activities.json")
+      get("activities.json")
     end
 
     def lifetime_stats
-      get("1/user/-/activities.json")
+      get("user/-/activities.json")
     end
 
     def daily_goals
-      get("1/user/-/activities/goals/daily.json")
+      get("user/-/activities/goals/daily.json")
     end
 
     def weekly_goals
-      get("1/user/-/activities/goals/weekly.json")
+      get("user/-/activities/goals/weekly.json")
     end
   end
 end

data/lib/fitbyte/alarms.rb

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

data/lib/fitbyte/body.rb

@@ -1,19 +1,19 @@
 module Fitbyte
   class Client
     def weight_logs(date=Date.today)
-      get("1/user/-/body/log/weight/date/#{format_date(date)}.json")
+      get("user/-/body/log/weight/date/#{format_date(date)}.json")
     end
 
     def body_fat_logs(date=Date.today)
-      get("1/user/-/body/log/fat/date/#{format_date(date)}.json")
+      get("user/-/body/log/fat/date/#{format_date(date)}.json")
     end
 
     def weight_goals
-      get("1/user/-/body/log/weight/goal.json")
+      get("user/-/body/log/weight/goal.json")
     end
 
     def body_fat_goals
-      get("1/user/-/body/log/fat/goal.json")
+      get("user/-/body/log/fat/goal.json")
     end
   end
 end

data/lib/fitbyte/client.rb

@@ -11,22 +11,25 @@ require "fitbyte/water"
 
 module Fitbyte
   class Client
+    attr_accessor :api_version, :unit_system, :locale, :scope
+
     def initialize(options)
-      missing_args = [:client_id, :client_secret] - options.keys
-      if missing_args.size > 0
-        raise ArgumentError, "Missing required options: #{missing.join(', ')}"
-      end
+      missing_args = [:client_id, :client_secret, :redirect_uri] - options.keys
+
+      raise ArgumentError, "Required arguments: #{missing.join(', ')}" if missing_args.size > 0
+
       @client_id = options[:client_id]
       @client_secret = options[:client_secret]
 
       @redirect_uri = options[:redirect_uri]
-      @site_url = options[:site_url] || "https://api.fitbit.com"
-      @authorize_url = options[:authorize_url] || "https://www.fitbit.com/oauth2/authorize"
-      @token_url = options[:token_url] || "https://api.fitbit.com/oauth2/token"
+      @site_url = options[:site_url] || defaults[:site_url]
+      @authorize_url = options[:authorize_url] || defaults[:authorize_url]
+      @token_url = options[:token_url] || defaults[:token_url]
 
-      @scope = options[:scope].join(" ") || "activity nutrition profile settings sleep social weight"
-      @unit_system = options[:unit_system] || "en_US"
-      @locale = options[:locale] || "en_US"
+      @scope = format_scope(options[:scope]) || defaults[:scope]
+      @unit_system = options[:unit_system] || defaults[:unit_system]
+      @locale = options[:locale] || defaults[:locale]
+      @api_version = "1"
 
       @client = OAuth2::Client.new(@client_id, @client_secret, site: @site_url,
                                    authorize_url: @authorize_url, token_url: @token_url)
@@ -54,14 +57,25 @@ module Fitbyte
 
     def request_headers
       {
-        "User-Agent" => "fitbyte-#{Fitbyte::VERSION} gem(#{Fitbyte::REPO_URL})",
+        "User-Agent" => "fitbyte-#{Fitbyte::VERSION} gem (#{Fitbyte::REPO_URL})",
         "Accept-Language" => @unit_system,
         "Accept-Locale" => @locale
       }
     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",
+        unit_system: "en_US",
+        locale: "en_US"
+      }
+    end
+
     def get(path)
-      JSON.parse(token.get(path, headers: request_headers).response.body)
+      JSON.parse(token.get(("#{@api_version}/" + path), headers: request_headers).response.body)
     end
   end
 end

data/lib/fitbyte/devices.rb

@@ -1,7 +1,7 @@
 module Fitbyte
   class Client
     def devices
-      get("1/user/-/devices.json")
+      get("user/-/devices.json")
     end
   end
 end

data/lib/fitbyte/food.rb

@@ -1,23 +1,23 @@
 module Fitbyte
   class Client
     def food_logs(date=Date.today)
-      get("1/user/-/foods/log/date/#{format_date(date)}.json")
+      get("user/-/foods/log/date/#{format_date(date)}.json")
     end
 
     def recent_foods
-      get("1/user/-/foods/recent.json")
+      get("user/-/foods/recent.json")
     end
 
     def frequent_foods
-      get("1/user/-/foods/log/frequent.json")
+      get("user/-/foods/log/frequent.json")
     end
 
     def favorite_foods
-      get("1/user/-/foods/log/favorite.json")
+      get("user/-/foods/log/favorite.json")
     end
 
     def food_goals
-      get("1/user/-/foods/log/goal.json")
+      get("user/-/foods/log/goal.json")
     end
   end
 end

data/lib/fitbyte/friends.rb

@@ -1,11 +1,11 @@
 module Fitbyte
   class Client
     def friends
-      get("1/user/-/friends.json")
+      get("user/-/friends.json")
     end
 
     def friends_leaderboard
-      get("1/user/-/friends/leaderboard.json")
+      get("user/-/friends/leaderboard.json")
     end
   end
 end

data/lib/fitbyte/helpers.rb

@@ -13,5 +13,9 @@ module Fitbyte
         raise ArgumentError, "Invalid type [#{date.class}] - provide a Date/Time/DateTime or a String(yyyy-MM-dd format)."
       end
     end
+
+    def format_scope(scope)
+      scope.is_a?(Array) ? scope.join(" ") : scope
+    end
   end
 end

data/lib/fitbyte/sleep.rb

@@ -1,7 +1,7 @@
 module Fitbyte
   class Client
     def sleep_logs(date=Date.today)
-      get("1/user/-/sleep/date/#{format_date(date)}.json")
+      get("user/-/sleep/date/#{format_date(date)}.json")
     end
   end
 end

data/lib/fitbyte/user.rb

@@ -1,11 +1,11 @@
 module Fitbyte
   class Client
     def profile
-      get("1/user/-/profile.json")
+      get("user/-/profile.json")
     end
 
     def badges
-      get("1/user/-/badges.json")
+      get("user/-/badges.json")
     end
   end
 end

data/lib/fitbyte/version.rb

@@ -1,4 +1,4 @@
 module Fitbyte
-  VERSION = "0.1.0"
+  VERSION = "0.2.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)
-      get("1/user/-/foods/log/water/date/#{format_date(date)}.json")
+      get("user/-/foods/log/water/date/#{format_date(date)}.json")
     end
   end
 end

metadata

@@ -1,10 +1,10 @@
 --- !ruby/object:Gem::Specification
 name: fitbyte
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
-- Zoran
+- Zoran Pesic
 autorequire: 
 bindir: exe
 cert_chain: []