misfit_gem 0.1.0 → 0.1.1

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MDZmZjZjZDI3OGQxYmYzYjMyYTBmODAxNmM5ZTI1ZjNlZDBkMGFhOQ==
+    ZjEzYzczODk4M2NhMjdhYTIxZTdhZWFlYjU4NmJjMjRmMDJlMDU0YQ==
   data.tar.gz: !binary |-
-    ZjAyY2Q1NWE3NmFiY2JiMDgyZGYyNjc0YjVhZTljMzEwMzMyMzQ3NQ==
+    YmNmNmM1YTdhNmM2OWQxZTcyMzQwNGNiZTFlNDk0YzRmNGI1NDE2Ng==
 SHA512:
   metadata.gz: !binary |-
-    NjVmMWViOGNhMzdkY2Y2ZTQ3MTM1MWRkM2NmY2UyYTI4NGU4MmUyMTA5Zjhl
-    MDkyOGRkZDJjYjY0NzRhMmYyMGRiMjdjZDM5ZGQwMTk3YTE2NzZlZjFmNGFm
-    ZTkyMzYyMjI2ZTViMzBhZjVhNjdkMmIwNjMyZjgyMzg5ZDg2Yjk=
+    NjlmMDQ2NzBhZmUwNGMzMDAyOWViOTRhNmM5MzFiNWM5ZWQ2MGFmYzgxY2Vj
+    ZjFmNmIwZGZkY2VmNmY0ODFlODI3NjMzM2NlMDUyZDczZmRiYTFkYWFkNmM5
+    MWVlNWFhNDUyODIwNDliN2RlNmIyNzg1OGI1NzQ5YTRmMGJlMjM=
   data.tar.gz: !binary |-
-    OTUxYmYwZWM3Y2VjNzNiZjk0YjY0ODJhNDNkZjdkODYzNzIyMTUyNGQ4MTZk
-    MzQ5NWUwMTQxZTRmYTFiYzU1YmJkY2FmNDVkNTVjNDNkMDEwYmFkOTc0ZTk1
-    YWE3NzVhZjk3MmNmNGJiNDEzYmU1MGM3NmE0NTA2YWEyNjBjNWY=
+    Mzg0NTdmMTk3ZDE5OWI1NGNkYzhmMzhiYzdlNmY4NGRmMmE2ZDFjNDNjMzcz
+    Yjk2MDI1M2Q1NTViMTdkMGY0Zjk5OTk1YjE5ZjhmODJkZjNlODc5YmEyNDA2
+    MTM3OWM2ODZlMGJhYWIxYTc1NjMwMWUzNTBjNzM1Zjk1M2ZhMjc=

data/README.md

@@ -1,4 +1,103 @@
-misfit_gem
+MisfitGem
 ==========
 
-A client library to retrieve data from misfit shine
+Provides access to the Misfit Shine API (http://build.misfit.com) through oAuth.
+
+As the Misfit Shine API is currently in BETA and under development, pull requests are appreciated if API support starts to show gaps.
+
+## Installation
+
+Install misfit_gem
+
+```bash
+$ gem install misfit_gem
+```
+
+or add it to your Gemfile
+
+```ruby
+gem 'misfit_gem'
+```
+
+## Authentication
+
+Omniauth is the best way to connect your users to the Misfit API. Use [omniauth-shine](https://github.com/socialworkout/omniauth-shine) to integrate Misfit accounts into your web application. You will need the OAuth `access_token` as a minimum.
+
+## Configuration
+
+In order to use MisfitGem you'll first need to configure a client.
+
+```ruby
+@client ||= MisfitGem::Client.new(
+  consumer_key: ENV["MISFIT_API_KEY"],
+  consumer_secret: ENV["MISFIT_API_SECRET"],
+  token: oauth_access_token,
+  secret: oauth_secret
+  )
+```
+
+## Usage
+
+See the [Misfit Resource Reference](https://build.misfit.com/docs/references#APIReferences-ResourceServerAPIs) for more details on request and response parameters.
+
+### Profile
+
+Gets the current user's profile information
+
+```ruby
+@client.get_profile
+```
+
+### Device
+
+Get the current user's device information (only returns information about one - current - device)
+
+```ruby
+@client.get_device
+```
+
+### Goal
+
+Get the user's goals within a period. 
+
+**Required:** Start Date and End Date (Date object or "YYYY-MM-DD" string).
+
+```ruby
+@client.get_goals(start_date: Date.today - 1.week, end_date: Date.today)
+```
+
+### Summary
+
+Get a summary of the user's activity within a period.
+
+**Required:** Start Date and End Date (Date object or "YYYY-MM-DD" string).
+
+*Optional: Detail (true/false). Defaults to false.*
+
+```ruby
+@client.get_summary(start_date: Date.today - 1.week, end_date: Date.today, detail: true)
+```
+
+### Session
+
+Get the user's sessions within a period. 
+
+**Required:** Start Date and End Date (Date object or "YYYY-MM-DD" string).
+
+```ruby
+@client.get_sessions(start_date: Date.today - 1.week, end_date: Date.today)
+```
+
+### Sleep
+
+Get the user's sleeps within a period. 
+
+**Required:** Start Date and End Date (Date object or "YYYY-MM-DD" string).
+
+```ruby
+@client.get_sleeps(start_date: Date.today - 1.week, end_date: Date.today)
+```
+
+## Disclaimer
+
+I am not employed by Misfit. This gem was created to help ruby developers build applications on top of misfit.com's data.

data/lib/misfit_gem/client.rb

@@ -29,7 +29,6 @@ module MisfitGem
       @secret = opts[:secret]
 
       @proxy = opts[:proxy] if opts[:proxy]
-      @user_id = opts[:user_id] || '-'
 
       @api_version = API_VERSION
     end

data/lib/misfit_gem/sessions.rb

@@ -13,7 +13,7 @@ module MisfitGem
       
       check_date_range(start_date_string, end_date_string)
       
-      parameters = "start_date=#{start_date_string}&end_date=#{end_date_string}&detail=#{detail}"
+      parameters = "start_date=#{start_date_string}&end_date=#{end_date_string}"
             
       get("/user/me/activity/sessions?#{parameters}")
       

data/lib/misfit_gem/sleeps.rb

@@ -13,7 +13,7 @@ module MisfitGem
       
       check_date_range(start_date_string, end_date_string)
       
-      parameters = "start_date=#{start_date_string}&end_date=#{end_date_string}&detail=#{detail}"
+      parameters = "start_date=#{start_date_string}&end_date=#{end_date_string}"
             
       get("/user/me/activity/sleeps?#{parameters}")
       

data/lib/misfit_gem/version.rb

@@ -1,3 +1,3 @@
 module MisfitGem
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/misfit_gem.gemspec

@@ -16,7 +16,9 @@ Gem::Specification.new do |s|
   s.add_dependency 'oauth'
   s.add_development_dependency 'rake'
   s.add_development_dependency 'rspec',     '~> 3.0.0'
-
+  
+  s.rubyforge_project = 'misfit_gem'
+  
   s.files = [
     '.gitignore',
     'Gemfile',

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: misfit_gem
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Jay Whiting
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-12 00:00:00.000000000 Z
+date: 2014-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oauth
@@ -101,7 +101,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
+rubyforge_project: misfit_gem
 rubygems_version: 2.1.11
 signing_key: 
 specification_version: 4