validic 0.3.3 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ad0946cb134fc6c0f3cfacae4651b8c0b963c0a4
-  data.tar.gz: f43d9e397bfe891fcca689d48723a2930b8a1823
+  metadata.gz: c8852001360881e470bc390ff9e44d0c83f8c42c
+  data.tar.gz: e3494be76d5d6794db140f08a7228b8ed9788430
 SHA512:
-  metadata.gz: 0309253dd92b1d88408a37c9beb8b30a2dcaa7dfd5c613093abbd86284a763320c295573cffb87913a46781fd37e886cf54a6ed67a78f7d31c15f821c7ea92a2
-  data.tar.gz: f4c1f6a3ac30ed57f79592341a209fa49ce5385ae86814f8c97f7c88f6958a423a2f4b16bb70e7ca9c4ebf2885e7c3866262ac565f21735e390b5b10b7486b37
+  metadata.gz: 3ca048da5b89cbada497942557373b0b9d25bc25d296c238349edf72211caf5054a38832b3e26cc8477ea5c8ad36050476eb861e65791941ec0e867c1ab77394
+  data.tar.gz: 06ef87e636504d0db352769653d77bbb690e8e94d156a8c1dda454f99886f3a30897df85443aefd4e98dad4f47afb4de719b7555f81d598150668666f0157ded

data/.gitignore

@@ -8,7 +8,6 @@ lib/bundler/man
 pkg
 rdoc
 spec/reports
-spec/cassette
 test/tmp
 test/version_tmp
 tmp
@@ -20,3 +19,5 @@ tmp
 .yardoc
 _yardoc
 doc/
+bin/
+tags

data/.rspec

@@ -1,3 +1,2 @@
 --color
---format documentation
 --tty

data/Gemfile

@@ -1,4 +1,15 @@
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in validic.gemspec
+gem 'rake'
+gem 'yard'
+
+group :development do
+  gem 'pry'
+end
+
+group :test do
+  gem 'rspec', '~> 3.1.0'
+  gem 'webmock', '~> 1.20.4'
+end
+
 gemspec

data/Gemfile.lock

@@ -1,87 +1,57 @@
 PATH
   remote: .
   specs:
-    validic (0.3.3)
-      activesupport
+    validic (0.4.1)
       faraday_middleware (~> 0.9.0)
-      hashie (~> 2.0.3)
       multi_json
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (4.0.2)
-      i18n (~> 0.6, >= 0.6.4)
-      minitest (~> 4.2)
-      multi_json (~> 1.3)
-      thread_safe (~> 0.1)
-      tzinfo (~> 0.3.37)
-    addressable (2.3.5)
-    api_matchers (0.4.0)
-      activesupport (>= 3.2.5)
-      nokogiri (>= 1.5.2)
-      rspec (>= 2.10.0)
-    atomic (1.1.14)
-    crack (0.4.1)
-      safe_yaml (~> 0.9.0)
+    addressable (2.3.8)
+    coderay (1.1.0)
+    crack (0.4.2)
+      safe_yaml (~> 1.0.0)
     diff-lcs (1.2.5)
-    docile (1.1.2)
-    faraday (0.9.0)
+    faraday (0.9.1)
       multipart-post (>= 1.2, < 3)
     faraday_middleware (0.9.1)
       faraday (>= 0.7.4, < 0.10)
-    hashie (2.0.5)
-    i18n (0.6.9)
-    mini_portile (0.5.2)
-    minitest (4.7.5)
-    multi_json (1.8.4)
+    method_source (0.8.2)
+    multi_json (1.11.0)
     multipart-post (2.0.0)
-    nokogiri (1.6.1)
-      mini_portile (~> 0.5.0)
+    pry (0.10.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
     rake (10.1.1)
-    rspec (2.14.1)
-      rspec-core (~> 2.14.0)
-      rspec-expectations (~> 2.14.0)
-      rspec-mocks (~> 2.14.0)
-    rspec-core (2.14.7)
-    rspec-expectations (2.14.4)
-      diff-lcs (>= 1.1.3, < 2.0)
-    rspec-mocks (2.14.4)
-    safe_yaml (0.9.7)
-    shoulda (3.5.0)
-      shoulda-context (~> 1.0, >= 1.0.1)
-      shoulda-matchers (>= 1.4.1, < 3.0)
-    shoulda-context (1.1.6)
-    shoulda-matchers (2.5.0)
-      activesupport (>= 3.0.0)
-    simplecov (0.8.2)
-      docile (~> 1.1.0)
-      multi_json
-      simplecov-html (~> 0.8.0)
-    simplecov-html (0.8.0)
-    simplecov-rcov (0.2.3)
-      simplecov (>= 0.4.1)
-    thread_safe (0.1.3)
-      atomic
-    tzinfo (0.3.38)
-    vcr (2.8.0)
-    webmock (1.8.11)
-      addressable (>= 2.2.7)
-      crack (>= 0.1.7)
+    rspec (3.1.0)
+      rspec-core (~> 3.1.0)
+      rspec-expectations (~> 3.1.0)
+      rspec-mocks (~> 3.1.0)
+    rspec-core (3.1.7)
+      rspec-support (~> 3.1.0)
+    rspec-expectations (3.1.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.1.0)
+    rspec-mocks (3.1.3)
+      rspec-support (~> 3.1.0)
+    rspec-support (3.1.2)
+    safe_yaml (1.0.4)
+    slop (3.6.0)
+    webmock (1.20.4)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
     yard (0.8.7.3)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  api_matchers
   bundler
+  pry
   rake
-  rspec
-  shoulda
-  simplecov
-  simplecov-rcov
+  rspec (~> 3.1.0)
   validic!
-  vcr (~> 2.8.0)
-  webmock (~> 1.8.0)
+  webmock (~> 1.20.4)
   yard

data/README.md

@@ -1,15 +1,53 @@
-# Validic
-
-Ruby API Wrapper for [Validic](http://www.validic.com)
+# Validic #
 
 ## Build Status
 [![Codeship Status for Validic/validic](https://www.codeship.io/projects/cc4ff330-9f72-0130-3cf3-0e5a3e2104f7/status?branch=master)](https://www.codeship.io/projects/3456)
 
+## Stable Version: 0.4.1
 
-## Stable Version: 0.3.2
+Ruby API Wrapper for [Validic](http://www.validic.com/api/docs). It includes the
+following functionality:
 
-## Installation
+## Breaking Changes ##
+- Methods for user provisioning, suspending, and deleting have been renamed
+- Methods will now default to initialized values unless overridden in options
+
+### Organization ###
+- Organization metadata
+
+### Users ###
+- Provision new Validic users
+- Update, Suspend, or Delete users
+- Get users from organization credentials
+- Find user id from authentication token
+- Refresh user authentication token
+
+### Profiles ###
+- Get profile information from user authentication token
+- Create and modify user profiles
+
+### Apps ###
+- List available third party apps
+- List synced apps for a particular user
 
+### Activities ###
+- Fitness, Routine, Nutrition, Sleep, Weight, Diabetes, Biometrics, Tobacco
+  Cessation
+- Get activities scoped to user or organization
+- Activities from specific sources
+- Specified time ranges
+
+### Connect ###
+- Create activities as a Validic Connect partner
+- Post extra data
+- Update or Delete activities by Validic activity id
+
+### Latest Endpoint ###
+- Get latest data recorded, regardless of when the activity occurred
+- Scope to organization or user level
+- Specify start and end points
+
+## Installation
 Add this line to your application's Gemfile:
 
     gem 'validic'
@@ -24,35 +62,411 @@ Or install it yourself as:
 
 ## Usage
 
+##### Rails 3+
+First, instantiate the client.
+```ruby
+require 'validic'
+
+# config/initializers/validic.rb
+Validic.configure do |config|
+  config.api_url          = 'https://api.validic.com'
+  config.api_version      = 'v1'
+  config.access_token     = 'ORGANIZATION_ACCESS_TOKEN',
+  config.organization_id  = 'ORGANIZATION_ID'
+end
+
+# Create a Client Object provided you have an initializer
+client = Validic::Client.new
+```
+
+##### Plain ruby
+```ruby
+
+options = {
+  api_url:         'https://api.validic.com',
+  api_version:     'v1',
+  access_token:    'ORGANIZATION_ACCESS_TOKEN',
+  organization_id: 'ORGANIZATION_ID'
+}
+client = Validic::Client.new options
+```
+
+Now you can use the wrapper's helper methods to interface with the Validic API.
+```ruby
+# Get current organization metadata
+client.get_organization
+```
+
+When your requests return an object they are returned as a Validic::Response
+object. The Validic::Response typically includes summary metadata and an array
+of record objects.
+```ruby
+client.get_routine.summary.results
+client.get_routine.records.first.steps
+```
+
+You can pass a hash of options to calls that fetch data.
+```ruby
+client.get_routine(start_date: '2015-01-01T00:00:00+00:00')
+```
+
+### More Examples ###
+
+You can override initialized organization id and access tokens for all helper
+methods by passing parameters in an options hash as a final parameter.
+
+Below are examples of all helper methods.
+
+```ruby
+require 'validic'
+
+# Alternatively you can use an initializer
+options = {
+  api_url:         'https://api.validic.com',
+  api_version:     'v1',
+  access_token:    'ORGANIZATION_ACCESS_TOKEN',
+  organization_id: 'ORGANIZATION_ID'
+}
+client = Validic::Client.new options
+```
+
+## Organization methods
+
+### Get Requests
+Get requests will always return a Validic::Response object.  It will look like this:
+```ruby
+sleeps = client.get_sleep
+=> #<Validic::Response:0x007ff3c9e4daa8
+ @records=
+  [#<Validic::Sleep:0x007ff3c9e4eb60
+    @_id="54b9242798b4b18fff00000d",
+    @awake=12.0,
+    @deep=nil,
+    @last_updated="2015-01-16T14:45:59+00:00",
+    @light=nil,
+    @rem=nil,
+    @source="healthy_yet",
+    @source_name="HealthyYet",
+    @times_woken=nil,
+    @timestamp="2015-01-16T14:45:38+00:00",
+    @total_sleep=nil,
+    @user_id="54a2eda484626bb50a00002c",
+    @utc_offset="+00:00">
+ @summary=
+  #<Validic::Summary:0x007ff3c9e4eea8
+   @end_date="2015-01-17T23:59:59+00:00",
+   @limit=100,
+   @message="Ok",
+   @next=nil,
+   @offset=0,
+   @previous=nil,
+   @results=2,
+   @start_date="2015-01-15T00:00:00+00:00",
+   @status=200,
+   @timestamp=nil>>
+```
+
+Now you have access to a `Summary` object and an array of activity objects.  You can step through either object like so:
+
+```ruby
+sleeps.summary
+=> #<Validic::Summary:0x007ff3ca2d98d8
+ @end_date="2015-01-17T23:59:59+00:00",
+ @limit=100,
+ @message="Ok",
+ @next=nil,
+ @offset=0,
+ @previous=nil,
+ @results=2,
+ @start_date="2015-01-15T00:00:00+00:00",
+ @status=200,
+ @timestamp=nil>
+
+
+sleeps.summary.status
+=> 200
+
+
+sleeps.records.first
+=> #<Validic::Sleep:0x007ff3ca2d9590
+ @_id="54b9242798b4b18fff00000d",
+ @awake=12.0,
+ @deep=nil,
+ @last_updated="2015-01-16T14:45:59+00:00",
+ @light=nil,
+ @rem=nil,
+ @source="healthy_yet",
+ @source_name="HealthyYet",
+ @times_woken=nil,
+ @timestamp="2015-01-16T14:45:38+00:00",
+ @total_sleep=nil,
+ @user_id="54a2eda484626bb50a00002c",
+ @utc_offset="+00:00">
+
+
+sleeps.records.first.awake
+=> 12.0
+```
+
+##### Get current organization
+```ruby
+client.get_organization
+```
+
+##   [User methods](https://validic.com/api/docs#users)
+
+##### Get users from organization credentials
+```ruby
+client.get_users
+```
+
+Get user by Validic user id.
+```ruby
+client.get_users(user_id: '5499a29b84626b0339000094')
+```
+
+##### Refresh authentication token
+```ruby
+client.refresh_token(user_id: '5499a29b84626b0339000094')
+```
+
+##### Get user id from authentication token
+```ruby
+client.me(authentication_token: 'L9RFSRnJvkwfiZm8vEc4')
+```
+
+##### Provision new users
 ```ruby
-    require 'validic'
+client.provision_user(uid: '123')
+```
 
-    # If you're using Rails 3+
-    # config/initializers/validic.rb
-    Validic.configure do |config|
-      config.api_url        = 'https://api.validic.com'
-      config.api_version    = 'v1'
-    end
+With optional profile.
+```ruby
+client.provision_user(uid: '123', profile: { gender: 'M' })
+```
 
-    # If you're using plain RUBY
-    # Create Validic::Client Object
-    options = {
-      api_url: 'https://api.validic.com',
-      api_version: 'v1',
-      access_token: 'DEMO_KEY' # Replace this with your key
-    }
-    client = Validic::Client.new options
+##### Updating a user
+```ruby
+client.update_user(user_id: '5499a29b84626b0339000094', uid: '123')
+```
 
-    # Create a Client Object expecting you have an initializer in place
-    # Validic::Client Object
-    client = Validic::Client.new
+With optional profile.
+```ruby
+client.update_user(user_id: '5499a29b84626b0339000094', uid: '123', profile: { gender: 'M' })
+```
 
-    # => Get Account Fitness
-    client.get_fitness
+##### Suspend a user
+```ruby
+client.suspend_user(user_id: '5499a29b84626b0339000094')
+```
+
+##### Unsuspend a user
+```ruby
+client.unsuspend_user(user_id: '5499a29b84626b0339000094')
+```
+
+##### Delete a user
+```ruby
+client.delete_user(user_id: '5499a29b84626b0339000094')
+```
+
+##   [Profile methods](https://validic.com/api/docs#profile)
+
+##### Get a user profile
+```ruby
+client.get_profile(authentication_token: 'L9RFSRnJvkwfiZm8vEc4')
+```
 
-    # => Get Organization Fitness
-    client.get_fitness({organization_id: "YOUR_organization_id",
-                          access_token: "YOUR_ACCESS_TOKEN"})
+##### Create a user profile
+```ruby
+client.create_profile(authentication_token: 'L9RFSRnJvkwfiZm8vEc4', gender: 'M')
+```
+
+##   Apps methods
+
+##### Get a list of available third-party-apps
+```ruby
+client.get_org_apps
+```
+
+##### Get a list of apps a user is synced to
+```ruby
+client.get_user_synced_apps(authentication_token: 'L9RFSRnJvkwfiZm8vEc4')
+```
+
+##   Activity methods
+
+###### You can also filter the results of the following methods by passing an options hash
+
+##### Get an array of fitness records
+```ruby
+client.get_fitness
+```
+
+##### Get an array of routine records
+```ruby
+client.get_routine
+```
+
+##### Get an array of nutrition records
+```ruby
+client.get_nutritions
+```
+
+##### Get an array of weight records
+```ruby
+client.get_weight
+```
+
+##### Get an array of diabetes records
+```ruby
+client.get_diabetes
+```
+
+##### Get an array of biometrics records
+```ruby
+client.get_biometrics
+```
+
+##### Get an array of sleep records
+```ruby
+client.get_sleep
+```
+
+##### Get an array of tobacco cessation records
+```ruby
+client.get_tobacco_cessations
+```
+
+##   [Validic Connect](https://validic.com/api/partners)
+
+
+##### CRUD Operations
+As a Validic Connect partner you have access to all CRUD operations including create, update and delete.  The gem supports all 3 of these:
+
+**Create**
+```ruby
+client.create_sleep(user_id: 'VALIDIC_USER_ID, activity_id: 'UNIQUE_ACTIVITY_ID', awake: 2, rem: 1, deep: 7)
+=>  #<Validic::Sleep:0x007fafcc2cdd40
+ @_id="54b93e1b84626b0581000012",
+ @activity_id="22323",
+ @awake=2.0,
+ @deep=7.0,
+ @extras=nil,
+ @last_updated="2015-01-16T16:36:43+00:00",
+ @light=nil,
+ @rem=1.0,
+ @source="healthy_yet",
+ @source_name="Healthy Yet",
+ @times_woken=nil,
+ @timestamp="2015-01-16T16:36:43+00:00",
+ @total_sleep=nil,
+ @utc_offset=nil,
+ @validated=false>
+```
+
+**Update**
+
+```ruby
+client.update_sleep(user_id: 'VALIDIC_USER_ID', _id: 'VALIDIC_ACTIVITY_ID', timestamp: DateTime.now.new_offset(0).iso8601, rem: 4)
+
+=> #<Validic::Sleep:0x007fafcc38fd28
+ @_id="54b93e1b84626b0581000012",
+ @activity_id="22323",
+ @awake=2.0,
+ @deep=7.0,
+ @extras=nil,
+ @last_updated="2015-01-16T16:38:23+00:00",
+ @light=nil,
+ @rem=4.0,
+ @source="healthy_yet",
+ @source_name="Healthy Yet",
+ @times_woken=nil,
+ @timestamp="2015-01-16T16:38:02+00:00",
+ @total_sleep=nil,
+ @utc_offset=nil,
+ @validated=false>
+[13] pry(main)>
+```
+
+**Delete**
+
+```ruby
+client.delete_sleep(user_id: 'VALIDIC_USER_ID', _id: 'VALIDIC_ACTIVITY_ID')
+=> true
+```
+
+All objects have the same actions as outlined below.
+
+
+##### [Fitness](https://validic.com/api/docs/#fitness)
+```ruby
+client.create_fitness(user_id: 'VALIDIC_USER_ID', activity_id: 'UNIQUE_ACTIVITY_ID', options)
+client.update_fitness(user_id: 'VALIDIC_USER_ID', _id: 'VALIDIC_ACTIVITY_ID', options)
+client.delete_fitness(user_id: 'VALIDIC_USER_ID', _id: 'VALIDIC_ACTIVITY_ID')
+```
+
+##### [Routine](https://validic.com/api/docs/#routine)
+```ruby
+client.create_routine(user_id: 'VALIDIC_USER_ID', activity_id: 'UNIQUE_ACTIVITY_ID', options)
+client.update_routine(user_id: 'VALIDIC_USER_ID', _id: 'VALIDIC_ACTIVITY_ID', options)
+client.delete_routine(user_id: 'VALIDIC_USER_ID', _id: 'VALIDIC_ACTIVITY_ID')
+```
+
+##### [Nutrition](https://validic.com/api/docs/#nutrition)
+```ruby
+client.create_nutrition(user_id: 'VALIDIC_USER_ID', activity_id: 'UNIQUE_ENTRY_ID', options)
+client.update_nutrition(user_id: 'VALIDIC_USER_ID', _id: 'UNIQUE_ENTRY_ID', options)
+client.delete_nutrition(user_id: 'VALIDIC_USER_ID', _id: 'UNIQUE_ENTRY_ID')
+```
+
+##### [Weight](https://validic.com/api/docs/#weight)
+```ruby
+client.create_weight(user_id: 'VALIDIC_USER_ID', data_id: 'UNIQUE_ENTRY_ID', options)
+client.update_weight(user_id: 'VALIDIC_USER_ID', _id: 'UNIQUE_ENTRY_ID', options)
+client.delete_weight(user_id: 'VALIDIC_USER_ID', _id: 'UNIQUE_ENTRY_ID')
+```
+
+##### [Diabetes](https://validic.com/api/docs/#diabetes)
+```ruby
+client.create_diabetes(user_id: 'VALIDIC_USER_ID', activity_id: 'UNIQUE_ACTIVITY_ID', options)
+client.update_diabetes(user_id: 'VALIDIC_USER_ID', _id: 'VALIDIC_ACTIVITY_ID', options)
+client.delete_diabetes(user_id: 'VALIDIC_USER_ID', _id: 'VALIDIC_ACTIVITY_ID')
+```
+
+##### [Biometrics](https://validic.com/api/docs/#biometrics)
+```ruby
+client.create_biometrics(user_id: 'VALIDIC_USER_ID', data_id: 'UNIQUE_ENTRY_ID', options)
+client.update_biometrics(user_id: 'VALIDIC_USER_ID', _id: 'UNIQUE_ENTRY_ID', options)
+client.delete_biometrics(user_id: 'VALIDIC_USER_ID', _id: 'UNIQUE_ENTRY_ID')
+```
+
+##### [Sleep](https://validic.com/api/docs/#sleep)
+```ruby
+client.create_sleep(user_id: 'VALIDIC_USER_ID', activity_id: 'UNIQUE_ACTIVITY_ID', options)
+client.update_sleep(user_id: 'VALIDIC_USER_ID', _id: 'VALIDIC_SLEEP_ID', options)
+client.delete_sleep(user_id: 'VALIDIC_USER_ID', _id: 'VALIDIC_ACTIVITY_ID')
+```
+
+##### [Tobacco Cessation](https://validic.com/api/docs/#tobacco_cessation)
+```ruby
+client.create_tobacco_cessation(user_id: 'VALIDIC_USER_ID', activity_id: 'UNIQUE_ACTIVITY_ID' options)
+client.update_tobacco_cessation(user_id: 'VALIDIC_USER_ID', _id: 'VALIDIC_ACTIVITY_ID', options)
+client.delete_tobacco_cessation(user_id: 'VALIDIC_USER_ID', _id: 'VALIDIC_ACTIVITY_ID')
+```
+
+##### You can also create data with your own custom extras as JSON
+```ruby
+client.create_fitness(user_id: 'VALIDIC_USER_ID', activity_id: 'UNIQUE_ACTIVITY_ID', extras: "{\"stars\": 3}")
+```
+
+##   [Latest Records](https://validic.com/api/bulkdata/#latest)
+
+###### You can also pass an options hash to filter latest results
+
+##### Pull latest records for specified type
+```ruby
+client.latest_routine
 ```
 
 ## Contributing