rjawbone 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 20c6aa273e95e88d99b8085af177d680046f29eb
-  data.tar.gz: f69457d42f818b7947680afc9ac08183a4802c5f
+  metadata.gz: cfc7014b01b14972ce975bdbae8d42b48fa540d6
+  data.tar.gz: d25108a6faba246f304309765b29fdcec79a1c1b
 SHA512:
-  metadata.gz: dc502bf2b1e94b3d7137ccac6780b3d49a636a779d97b668f231899694957d77cdebf928d57ae3bfc002c8c614b6d8b6fa0ae631c1bd601c23868b500dd973ea
-  data.tar.gz: b3ca3c4e3e457f55ab57ecb1b1d9c2abed8bcd9172789304d068995dde44e4db3b379eb463be8e121e37f15f4d9c823f69c3736ad1c4b98fa50e1760afcb6c9b
+  metadata.gz: c1874eef6085d99dd154f5b10a81b7c0d3b5936d158206c3012b551da3f25e8b30c53e6015de697204099e84bbc94dabea93f2d203c3e35d3d0fc8b49b6ab64e
+  data.tar.gz: 8b6b146bc4b92976c25dcd6bca235d65bfad5cc7117242976faeede0fe05d2d4ba312362e2c34bd764fe3cd4c1386b52e274075f532c2298a8cd44415eb24346

data/README.md

@@ -1,7 +1,128 @@
 # Rjawbone
 
+<dl>
+  <dt>Homepage</dt><dd><a href="#">homepage</a></dd>
+  <dt>Author</dt><dd><a href="">Taylor Daugherty</a></dd>
+  <dt>Documentation</dt><dd><a href="#">Ruby Gems</a></dd>
+</dl>
+
+[![Gem Version](https://badge.fury.io/rb/rjawbone.svg)](https://badge.fury.io/rb/rjawbone)
 [![Build Status](https://travis-ci.org/tylrd/rjawbone.svg?branch=master)](https://travis-ci.org/tylrd/rjawbone)
 [![Code Climate](https://codeclimate.com/github/tylrd/rjawbone/badges/gpa.svg)](https://codeclimate.com/github/tylrd/rjawbone)
 [![Test Coverage](https://codeclimate.com/github/tylrd/rjawbone/badges/coverage.svg)](https://codeclimate.com/github/tylrd/rjawbone/coverage)
 [![Inline docs](http://inch-ci.org/github/tylrd/rjawbone.svg?branch=master)](http://inch-ci.org/github/tylrd/rjawbone)
 [![Dependency Status](https://gemnasium.com/tylrd/rjawbone.svg)](https://gemnasium.com/tylrd/rjawbone)
+
+## Installation
+
+```ruby
+gem install rjawbone
+```
+
+
+## Configuration
+
+```ruby
+Rjawbone.configure do |config|
+  config.client_id = ENV['JAWBONE_CLIENT']
+  config.client_secret = ENV['JAWBONE_SECRET']
+  config.redirect_uri = redirect_uri
+  config.scope = %w(basic_read sleep_read move_read) # any scope you need here
+end
+```
+
+For a rails project, you can put this in `config/initializers/rjawbone.rb`.
+
+
+## Authentication
+
+This gem provides two helper methods for following the OAuth 2.0 flow.
+
+```ruby
+# Returns a url for your configured jawbone application
+Rjawbone::Oauth.authorization_url 
+
+# Exchanges the authorization code for an access token
+Rjawbone::Oauth.exchange_code(code)
+```
+
+After obtaining an access token, you will need to persist it.
+
+[Here](https://jawbone.com/up/developer/authentication) you can read about the authorization flow.
+
+## Client
+
+The API calls are made by initializing a Rjawbone client object. 
+
+The ACCESS_TOKEN is retrieved from the Authentication step.
+
+```ruby
+Rjawbone::Client.new(access_token: ACCESS_TOKEN, refresh_token: REFRESH)
+
+# OR
+
+Rjawbone::Client.new do |config|
+  config.access_token = TOKEN
+  config.refresh_token = REFRESH
+end
+```
+
+After initializing the client object, you can retrieve any object allowed by your configured scope.
+
+
+## Resources
+
+#### Lists
+
+```ruby
+# Returns a Rjawbone::Model::List object
+list = client.moves
+
+# The list has a collection attribute, composed of Rjawbone::Model::Item objects
+# The list object has methods that assist in retrieving information
+
+# Pagination
+list.next_page
+
+# Enumerability
+list.map {|move| move.xid }
+list.select {|move| move.details.distance >= 5000}
+```
+
+#### Items
+
+```ruby
+# The item object has all the fields from the raw API response
+# When a "sleep" or "move" type, the Rjawbone::Model::Item can implement the #ticks method
+
+list = client.moves
+move = list.first
+
+# Returns a Rjawbone::Model::List of objects of "ticks"
+# The ticks associated with that move resource
+ticks = move.ticks
+
+# These ticks are a list, so include enumerablity and pagination methods
+ticks.reject {|tick| tick.steps <= 50}
+ticks = client.moves.map {|item| item.ticks}
+```
+
+#### Resources
+
+Implemented endpoints:
+- moves
+- sleeps
+- heartrates
+
+## TODO
+
+- band_events
+- body_events
+- goals
+- meals
+- mood
+- settings
+- timezone
+- trends
+- friends
+

data/app/helpers/jawbone/rails/jawbone_helper.rb

@@ -0,0 +1,11 @@
+module Rjawbone
+  module Rails
+    module JawboneHelper
+
+      def jawbone_url
+        Rjawbone::Oauth.authorization_url
+      end
+
+    end
+  end
+end

data/lib/rjawbone/api/moves.rb

@@ -2,7 +2,7 @@ module Rjawbone
   module API
     module Moves
 
-      def move_list(params = {})
+      def moves(params = {})
         get_object(build_endpoint(Rjawbone::MOVES_USER, params), Rjawbone::Model::List)
       end
 

data/lib/rjawbone/api/sleeps.rb

@@ -2,10 +2,25 @@ module Rjawbone
   module API
     module Sleeps
 
-      def sleep_list
+      def sleeps
         get_object(Rjawbone::SLEEPS_USER, Rjawbone::Model::List)
       end
 
+      def sleep_details(xid, params = {})
+        url = "#{Rjawbone::SLEEPS_ENDPOINT}/#{xid}"
+        get_object(build_endpoint(url, params), Rjawbone::Model::Details)
+      end
+
+      def sleeps_graph(xid, params = {})
+        endpoint = "#{Rjawbone::MOVES_ENDPOINT}/#{xid}/image"
+        # TODO
+      end
+
+      def sleep_ticks(xid, params = {})
+        url = "#{Rjawbone::MOVES_ENDPOINT}/#{xid}/ticks"
+        get_object(build_endpoint(url, params), Rjawbone::Model::List)
+      end
+
     end
   end
 end

data/lib/rjawbone/rails.rb

@@ -0,0 +1,6 @@
+module Rjawbone
+  module Rails
+    class Engine < ::Rails::Engine
+    end
+  end
+end

data/lib/rjawbone/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rjawbone
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Taylor Daugherty
@@ -166,6 +166,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- app/helpers/jawbone/rails/jawbone_helper.rb
 - bin/console
 - bin/setup
 - exe/jawbone
@@ -183,6 +184,7 @@ files:
 - lib/rjawbone/models/list.rb
 - lib/rjawbone/models/sleeps.rb
 - lib/rjawbone/oauth.rb
+- lib/rjawbone/rails.rb
 - lib/rjawbone/utils.rb
 - lib/rjawbone/version.rb
 - rjawbone.gemspec