fitgem 0.6.1 → 0.7.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5aaeb0e1f4c0baea6b4d4b4e3a49625b8263d18f
+  data.tar.gz: e89fd2e5c2fb3694bfca85a311ef13dff614f7f2
+SHA512:
+  metadata.gz: 5b7334843303227af479383f16a012a8445ca6ccf584ace5c54cf34f9dc23bb883e586e48dbd02657922c03d27e984f0600fb925a6d64c614364ff2c26039655
+  data.tar.gz: 8611b499e6fd9108d4d5fefca76226a296ff88d7695015423b8315fb937916af0cebc6bedf3173e345dc0bcef2c822e791641d468cc074e892ce386a3aff449a

data/.gitignore

@@ -6,4 +6,5 @@ pkg/*
 test*.rb
 *.dmp
 .fitgem.yml
-.idea
+.idea
+.rvmrc

data/.rvmrc

@@ -1 +1 @@
-rvm ruby-1.9.3-p327@fitgem --create
+rvm use 2.0.0@fitgem --create

data/.travis.yml

@@ -1,3 +1,3 @@
 rvm:
-  - 1.9.2
   - 1.9.3
+  - 2.0.0

data/README.md

@@ -1,50 +1,31 @@
 # Fitgem [![Build Status](https://secure.travis-ci.org/whazzmaster/fitgem.png)](http://travis-ci.org/whazzmaster/fitgem)
 
-Provides access to fitbit.com data through their OAuth/REST API.  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.
+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.
 
-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.  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.
 
 # Usage
 
 Install fitgem:
-```
+
+```bash
 $ gem install fitgem
 ```
-
 Comprehensive method documentation is [available online](http://www.rubydoc.info/github/whazzmaster/fitgem/frames).
 
-[The wiki has information](https://github.com/whazzmaster/fitgem/wiki/The-OAuth-Process) on how to use fitgem in the
-OAuth handshake with [fitbit.com](http://www.fitbit.com). You may also be interested in using
-[omniauth-fitbit](https://github.com/tkgospodinov/omniauth-fitbit) to integrate Fitbit accounts into your web
-application.
+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.
 
-## Usage in a Rails Application
-
-We've started to develop an example app using the fitgem client.
-See [https://github.com/whazzmaster/fitgem-client](https://github.com/whazzmaster/fitgem-client) for more information or
-check out [the hosted version](http://www.fitbitclient.com). The fitgem-client project is evolving more slowly than the
-library itself, but work continues.
+**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.
 
 # Subscriptions
 
-The Fitbit API allows for you to set up notification subscription so that when values change (via automatic syncs with
-the fitbit device) your applications can be notified automatically.  You can set up a default subscription callback URL
-via the [Fitbit dev site](https://dev.fitbit.com/ 'Fitbit Developer Site') and then use the Subscriptions API to add or
-remove subscriptions for individual users.
-
-__Currently, notification management is experimental in this gem__.  There is currently code to add, remove, and list
-subscriptions (foods, activities, sleep, body, and all collections).
+The Fitbit API allows for you to set up notification subscription so that when values change (via automatic syncs with the fitbit device) your applications can be notified automatically.  You can set up a default subscription callback URL via the [Fitbit dev site](https://dev.fitbit.com/ 'Fitbit Developer Site') and then use the Subscriptions API to add or remove subscriptions for individual users.
 
-# Contributing to fitgem #
+# Help Improve Fitgem!
 
-The Fitbit REST API is in BETA right now, and so it will quite likely change over time (though I can't be sure whether
-it will be additive change or change of the non-backwards-compatible variety).  I aim to keep as up-to-date as I can but
-if you absolutely need functionality that isn't included here, feel free to fork and implement it, then send me a pull
-request.
+The Fitbit REST API is in BETA right now, and so it will quite likely change over time (though I can't be sure whether it will be additive change or change of the non-backwards-compatible variety).  I aim to keep as up-to-date as I can but if you absolutely need functionality that isn't included here, **feel free to fork and implement it, then send me a pull request**.
 
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
 * Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
@@ -57,13 +38,9 @@ necessary, that is fine, but please isolate to its own commit so I can cherry-pi
 
 ## Contributors
 
-Many thanks to everyone that has contributed to improve fitgem!
-
-[https://github.com/whazzmaster/fitgem/graphs/contributors](https://github.com/whazzmaster/fitgem/graphs/contributors)
+**Many, many thanks** to [everyone that has contributed to improve fitgem](https://github.com/whazzmaster/fitgem/graphs/contributors)!
 
 # Copyright & Disclaimer
 
-Copyright (c) 2011-2012 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.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/lib/fitgem/activities.rb

@@ -89,7 +89,7 @@ module Fitgem
     # @option opts [String, Integer] :durationMillis Activity duration in milliseconds.
     #   Must be a numeric value in Integer or String format. This value is REQUIRED for all calls.
     # @option opts [String] :startTime Activity start time, in the format "HH:mm" using hours
-    #   and seconds. Thie value is REQUIRED for all calls.
+    #   and seconds. This value is REQUIRED for all calls.
     # @option opts [String] :date Activity date, in "yyyy-MM-dd" format. This value is REQUIRED for all calls.
     #
     # @option opts [String] :distance Distance traveled, a string in the format "X.XX".  This value is 
@@ -139,5 +139,52 @@ module Fitgem
     def remove_favorite_activity(activity_id)
       delete("/user/#{@user_id}/activities/log/favorite/#{activity_id}.json")
     end
+
+    # ==========================================
+    #      Intraday Activity Data Methods
+    # ==========================================
+
+    # Get intraday time series data for the specified resource
+    #
+    # @option opts [Symbol] :resource The sub-resource you want to retrieve time series data for; must
+    #   be one of :calories, :steps, :floors, or :elevation. This value is REQUIRED for all calls.
+    # @option opts [String, Datetime, Date] :date The date to retrieve a time series on. This value is
+    #   REQUIRED for all calls.
+    # @option opts [String] :detailLevel The resolution of the time series data; must be one of "1min"
+    #   or "15min".
+    #
+    # @options opts [DateTime, Time, String] :startTime The start of the time period to request data for.
+    # @options opts [DateTime, Time, String] :endTime The end of the time period to request data for.
+    #
+    # @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.'
+      end
+
+      unless opts[:date]
+        raise Fitgem::InvalidArgumentError, 'Must specify the date to fetch intraday time series data for.'
+      end
+
+      unless opts[:detailLevel] && %w(1min 15min).include?(opts[:detailLevel])
+        raise Fitgem::InvalidArgumentError, 'Must specify the data resolution to fetch intraday time series data for. One of (\"1d\" or \"15min\") is required.'
+      end
+
+      resource = opts.delete(:resource)
+      date = format_date(opts.delete(:date))
+      detail_level = opts.delete(:detailLevel)
+      time_window_specified = opts[:startTime] || opts[:endTime]
+      resource_path = "/user/#{@user_id}/activities/"
+
+      if time_window_specified
+        start_time = format_time(opts.delete(:startTime))
+        end_time = format_time(opts.delete(:endTime))
+        resource_path += "#{resource}/date/#{date}/1d/#{detail_level}/time/#{start_time}/#{end_time}.json"
+      else
+        resource_path += "#{resource}/date/#{date}/1d/#{detail_level}.json"
+      end
+
+      get(resource_path, opts)
+    end
   end
 end

data/lib/fitgem/client.rb

@@ -39,7 +39,7 @@ module Fitgem
     #     :consumer_key => my_key,
     #     :consumer_secret => my_secret,
     #     :token => fitbit_oauth_token,
-    #     :secret => :fitbit_oauth_secret,
+    #     :secret => fitbit_oauth_secret,
     #     :unit_system => Fitgem::ApiUnitSystem.METRIC
     #   }
     attr_accessor :api_unit_system

data/lib/fitgem/version.rb

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

data/spec/fitgem_spec.rb

@@ -8,7 +8,7 @@ describe Fitgem do
     })
   end
 
-  describe "global settings" do
+  describe 'global settings' do
     it 'should expose the api_version' do
       @client.api_version.should == "1"
     end

metadata

@@ -1,94 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: fitgem
 version: !ruby/object:Gem::Version
-  version: 0.6.1
-  prerelease: 
+  version: 0.7.0
 platform: ruby
 authors:
 - Zachery Moneypenny
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-28 00:00:00.000000000 Z
+date: 2013-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oauth
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rdiscount
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: A client library to send and retrieve workout, weight, and diet data
@@ -137,33 +126,26 @@ files:
 - spec/fitgem_constructor_spec.rb
 homepage: http://github.com/whazzmaster/fitgem
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 3756517255535395412
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 3756517255535395412
 requirements: []
 rubyforge_project: fitgem
-rubygems_version: 1.8.24
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: OAuth client library to the data on fitbit.com
 test_files:
 - spec/fitgem_spec.rb