fitgem 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5aaeb0e1f4c0baea6b4d4b4e3a49625b8263d18f
-  data.tar.gz: e89fd2e5c2fb3694bfca85a311ef13dff614f7f2
+  metadata.gz: 0093dff6f708728ec192e7dd062940d0091d856b
+  data.tar.gz: da17edef7d5d5b62529eae6f0afad4a7b3ba7fc4
 SHA512:
-  metadata.gz: 5b7334843303227af479383f16a012a8445ca6ccf584ace5c54cf34f9dc23bb883e586e48dbd02657922c03d27e984f0600fb925a6d64c614364ff2c26039655
-  data.tar.gz: 8611b499e6fd9108d4d5fefca76226a296ff88d7695015423b8315fb937916af0cebc6bedf3173e345dc0bcef2c822e791641d468cc074e892ce386a3aff449a
+  metadata.gz: 88e9581a93d35371073e55e41bc612fb0db45b5f46c4113f9354dbc1e63bf8e8475e0ce0a7f2c7f169d5f18d3312a1b9a7a47f96bc3c97b27e6bbdc3c30c1671
+  data.tar.gz: 0f650a3fb149884f52ddab2e6c731ff58da874455a7e3b2ae43258bfb73b5b73a84a0d26daf71beb09ba93ee7ed221ee79e04ae8002f109eb5e05c79b40217d3

data/README.md

@@ -1,23 +1,38 @@
 # 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 API](http://dev.fitbit.com).  Fitgem can pull data with or without usernauthentication. 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.
+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.
 
-The [Fitbit API](https://wiki.fitbit.com/display/API/Fitbit+API) is currently in BETA and is under development to extend its reach.  Since it is early in the lifecycle of the API I expect this gem to go through a number of revisions as we attempt to match the functionality of their platform.
+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.
 
 # Usage
 
-Install fitgem:
+Install fitgem
 
 ```bash
 $ gem install fitgem
 ```
+
+or add it to your Gemfile
+
+```ruby
+gem 'fitgem'
+```
+
 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.
 
-**Go to [http://fitbitclient.com](http://fitbitclient.com) to view online documentation on how to use fitgem**. The reference app includes information on how to use some bench test tools to get acquainted with the library, and the application code itself (Rails 3.2 + Backbone.js) is also [available online](https://github.com/whazzmaster/fitgem-client) to illustrate how the live data from Fitbit is manipulated by the application.
+## Reference Application
+
+To learn more about how to use fitgem in a Rails application, go to [http://fitbitclient.com](http://fitbitclient.com) or see the code at [https://github.com/whazzmaster/fitgem-client](https://github.com/whazzmaster/fitgem-client).
+
+The reference app is written using Rails 3.2 and [Backbone.js](http://backbonejs.org) and includes examples on how to:
+
+* Integrate OAuth logins [omniauth-fitbit](https://github.com/tkgospodinov/omniauth-fitbit)
+* Store and use OAuth access tokens
+* Create and use instances of `Fitgem::Client` using the stored OAuth access token
 
 # Subscriptions
 
@@ -32,8 +47,8 @@ The Fitbit REST API is in BETA right now, and so it will quite likely change ove
 * Fork the project
 * Start a feature/bugfix branch
 * Commit and push until you are happy with your contribution
-* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
-* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise
+* **Make sure to add tests for it**. This is important so I don't break it in a future version unintentionally.
+* **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
@@ -42,5 +57,5 @@ necessary, that is fine, but please isolate to its own commit so I can cherry-pi
 
 # Copyright & Disclaimer
 
-Copyright © 2011-2013 Zachery Moneypenny. See LICENSE for further details. __I am not employed by 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.
+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,40 @@
 
 # fitgem changelog
 
+## v0.8.0
+
+#### 2013-08-03 Zachery Moneypenny <fitgem@whazzmaster.com>
+
+* Add support for weekly goals
+* Add support for silent alarms (including updates)
+* Add support for intraday distance
+* Add time zone support for usage of times
+* Add support for badges
+
+## v0.7.0
+
+#### 2013-05-17 Zachery Moneypenny <fitgem@whazzmaster.com>
+
+* Add support for intraday time series retrieval of various resources
+* Removed rvmrc from project- use whatever ruby you want!
+* Updated Travis CI configuration
+
+## v0.6.1
+
+#### 2013-02-28 Zachery Moneypenny <fitgem@whazzmaster.com>
+
+* More unit tests
+* Fix an issue where we weren't applying the `format_date` helper when constructing a date range fragment
+
+## v0.6.0
+
+* Streamline the README; add contributors link
+* Removed FAQs from README
+* Added support for daily activity goals
+* Moved testing-focused gemspec dependencies to the Gemfile
+
+#### 2013-02-13 Zachery Moneypenny <fitgem@whazzmaster.com>
+
 ## v0.5.2
 
 #### 2012-03-04 Zachery Moneypenny <fitgem@whazzmaster.com>

data/fitgem.gemspec

@@ -24,7 +24,7 @@ Gem::Specification.new do |s|
 
   s.files         = [
     '.gitignore',
-    '.rvmrc',
+    # '.rvmrc',
     '.yardopts',
     '.travis.yml',
     'Gemfile',
@@ -37,6 +37,8 @@ Gem::Specification.new do |s|
     'lib/fitgem.rb',
     'lib/fitgem/version.rb',
     'lib/fitgem/activities.rb',
+    'lib/fitgem/alarms.rb',
+    'lib/fitgem/badges.rb',
     'lib/fitgem/body_measurements.rb',
     'lib/fitgem/client.rb',
     'lib/fitgem/devices.rb',

data/lib/fitgem/activities.rb

@@ -71,6 +71,14 @@ module Fitgem
       get("/user/#{@user_id}/activities/goals/daily.json")
     end
 
+    # Get the weekly activity goals for the current user
+    #
+    # @return [Hash] Hash containing the distance, floors and step goals
+    # for the current user
+    def weekly_goals
+      get("/user/#{@user_id}/activities/goals/weekly.json")
+    end
+
     # ==========================================
     #         Activity Update Methods
     # ==========================================
@@ -158,8 +166,8 @@ module Fitgem
     #
     # @return [Hash] A hash containing time series data
     def intraday_time_series(opts)
-      unless opts[:resource] && [:calories, :steps, :floors, :elevation].include?(opts[:resource])
-        raise Fitgem::InvalidArgumentError, 'Must specify resource to fetch intraday time series data for. One of (:calories, :steps, :floors, or :elevation) is required.'
+      unless opts[:resource] && [:calories, :steps, :distance, :floors, :elevation].include?(opts[:resource])
+        raise Fitgem::InvalidArgumentError, 'Must specify resource to fetch intraday time series data for. One of (:calories, :steps, :distance, :floors, or :elevation) is required.'
       end
 
       unless opts[:date]

data/lib/fitgem/alarms.rb

@@ -0,0 +1,67 @@
+module Fitgem
+  class Client
+    # Add a silent alarm to your profile
+    #
+    # @param [Hash] opts Alarm options
+    # @option opts [Integer, String] device_id The id of the device you would like
+    #   to manage the alarm on
+    # @option opts [String] :time Time of the alarm in the format XX:XX+XX:XX, time
+    #   with timezone
+    # @option opts [TrueClass, FalseClass] :enabled
+    # @option opts [TrueClass, FalseClass] :recurring One time or recurring alarm
+    # @option opts [String] :weekDays The days the alarm is active on as a list of
+    #   comma separated values: MONDAY, WEDNESDAY, SATURDAY. For recurring only
+    # @option opts [Integer] :snoozeLength Minutes between the alarms
+    # @option opts [Integer] :snoozeCount Maximum snooze count
+    # @option opts [String] :label Label for the alarm
+    #
+    # @return [Hash] Hash containing the alarm settings
+    def add_alarm(opts)
+      device_id = opts[:device_id]
+      post("/user/#{@user_id}/devices/tracker/#{device_id}/alarms.json", opts)
+    end
+
+    # Retrieve the silent alarms of your device
+    #
+    # @param [Integer, String] device_id The id of the device you would like to
+    #   manage the alarms of
+    #
+    # @return [Hash] Hash containing the alarms and it's settings
+    def get_alarms(device_id)
+      get("/user/#{@user_id}/devices/tracker/#{device_id}/alarms.json")
+    end
+
+    # Remove a silent alarm from your profile
+    #
+    # @param [Integer, String] alarm_id The id of the alarm
+    # @param [Integer, String] device_id The id of the device you would like to
+    #   manage the alarm on
+    #
+    # @return [Hash] Empty hash denotes success
+    def delete_alarm(alarm_id, device_id)
+      delete("/user/#{@user_id}/devices/tracker/#{device_id}/alarms/#{alarm_id}.json")
+    end
+
+    # Update an existing alarm
+    #
+    # @param [Integer, String] alarm_id The id of the alarm
+    # @param [Integer, String] device_id The id of the device you would like to
+    #   manage the alarm on
+    # @param [Hash] opts Alarm settings
+    # @option opts [DateTime, Time, String] :time Time of the alarm
+    # @option opts [TrueClass, FalseClass] :enabled
+    # @option opts [TrueClass, FalseClass] :recurring One time or recurring alarm
+    # @option opts [String] :weekDays The days the alarm is active on as a list of
+    #   comma separated values: MONDAY, WEDNESDAY, SATURDAY. For recurring only
+    # @option opts [Integer] :snoozeLength Minutes between the alarms
+    # @option opts [Integer] :snoozeCount Maximum snooze count
+    # @option opts [String] :label Label for the alarm
+    #
+    # @return [Hash] Hash containing updated alarm settings
+    def update_alarm(alarm_id, device_id, opts)
+      opts[:time] = format_time opts[:time], include_timezone: true
+      post("/user/#{@user_id}/devices/tracker/#{device_id}/alarms/#{alarm_id}.json", opts)
+    end
+
+  end
+end

data/lib/fitgem/badges.rb

@@ -0,0 +1,12 @@
+module Fitgem
+  class Client
+
+    # Get a list of all badges earned
+    #
+    # @return [Hash] Hash containing an array of badges
+    def badges
+      get("/user/#{@user_id}/badges.json")
+    end
+
+  end
+end

data/lib/fitgem/client.rb

@@ -15,6 +15,8 @@ require 'fitgem/body_measurements'
 require 'fitgem/time_range'
 require 'fitgem/devices'
 require 'fitgem/notifications'
+require 'fitgem/alarms'
+require 'fitgem/badges'
 require 'date'
 require 'uri'
 

data/lib/fitgem/helpers.rb

@@ -43,22 +43,26 @@ module Fitgem
     # indicate that the time value used is the current localtime.
     #
     # @param [DateTime, Time, String] time The object to format into a time string
+    # @param [Hash] opts format time options
+    # @option opts [TrueClass, FalseClass] :include_timezone Include timezone in the output or not
     # @raise [Fitgem::InvalidTimeArgument] Raised when the parameter object is not a
     #   DateTime, Time, or a valid ("HH:mm" or "now") string object
     # @return [String] Date in "HH:mm" string format
-    def format_time(time)
+    def format_time(time, opts = {})
+      format = opts[:include_timezone] ? "%H:%M%:z" : "%H:%M"
       if time.is_a? String
         case time
           when 'now'
-            return DateTime.now.strftime("%H:%M")
+            return DateTime.now.strftime format
           else
-            unless time =~ /\d{2}\:\d{2}/
+            unless time =~ /^\d{2}\:\d{2}$/
               raise Fitgem::InvalidTimeArgument, "Invalid time (#{time}), must be in HH:mm format"
             end
-            return time
+            timezone = DateTime.now.strftime("%:z")
+            return opts[:include_timezone] ? [ time, timezone ].join : time
         end
       elsif DateTime === time || Time === time
-        return time.strftime("%H:%M")
+        return time.strftime format
       else
         raise Fitgem::InvalidTimeArgument, "Date used must be a valid time object or a string in the format HH:mm; supplied argument is a #{time.class}"
       end

data/lib/fitgem/version.rb

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

data/spec/fitgem_helper_spec.rb

@@ -84,24 +84,51 @@ describe Fitgem::Client do
   end
 
   describe "#format_time" do
-    it "accepts DateTime objects" do
-      time = DateTime.parse("3rd Feb 2001 04:05:06 PM")
-      @client.format_time(time).should == "16:05"
-    end
+    context "without a timezone" do
+      it "accepts DateTime objects" do
+        time = DateTime.parse("3rd Feb 2001 04:05:06 PM")
+        @client.format_time(time).should == "16:05"
+      end
 
-    it "accepts Time objects" do
-      time = Time.mktime 2012, 1, 20, 13, 33, 30
-      @client.format_time(time).should == "13:33"
-    end
+      it "accepts Time objects" do
+        time = Time.mktime 2012, 1, 20, 13, 33, 30
+        @client.format_time(time).should == "13:33"
+      end
+
+      it "accepts the string 'now' to denote the current localtime" do
+        now = DateTime.now
+        @client.format_time('now').should == now.strftime("%H:%M")
+      end
 
-    it "accepts the string 'now' to denote the current localtime" do
-      now = DateTime.now
-      @client.format_time('now').should == now.strftime("%H:%M")
+      it "accepts strings in HH:mm format" do
+        time = "04:20"
+        @client.format_time(time).should == "04:20"
+      end
     end
 
-    it "accepts strings in HH:mm format" do
-      time = "04:20"
-      @client.format_time(time).should == "04:20"
+    context "with a timezone" do
+      it "accepts DateTime objects" do
+        time = DateTime.parse("3rd Feb 2001 04:05:06 PM UTC")
+        @client.format_time(time, include_timezone: true).should == "16:05+00:00"
+      end
+
+      it "accepts Time objects" do
+        time = Time.new 2012, 1, 20, 13, 33, 30, "+00:00"
+        @client.format_time(time, include_timezone: true).should == "13:33+00:00"
+      end
+
+      it "accepts the string 'now' to denote the current localtime" do
+        now = DateTime.now
+        @client.format_time('now', include_timezone: true).should == now.strftime("%H:%M%:z")
+      end
+
+      it "accepts strings in HH:mm format" do
+        datetime = DateTime.parse("26th Apr 2000 09:27:00 +08:00")
+        DateTime.stub(:now).and_return datetime
+
+        time = "04:20"
+        @client.format_time(time, include_timezone: true).should == "04:20+08:00"
+      end
     end
 
     it "rejects Date objects" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fitgem
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Zachery Moneypenny
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-17 00:00:00.000000000 Z
+date: 2013-08-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oauth
@@ -89,7 +89,6 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
-- .rvmrc
 - .yardopts
 - .travis.yml
 - Gemfile
@@ -102,6 +101,8 @@ files:
 - lib/fitgem.rb
 - lib/fitgem/version.rb
 - lib/fitgem/activities.rb
+- lib/fitgem/alarms.rb
+- lib/fitgem/badges.rb
 - lib/fitgem/body_measurements.rb
 - lib/fitgem/client.rb
 - lib/fitgem/devices.rb