MShealth 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6d19a145943a23c74d08ac17534027279d74cf0e
+  data.tar.gz: 92184e6a9223cf664c609120e3f4564d4ff749db
+SHA512:
+  metadata.gz: 93e4568e8c4d16097ee593d6b4d338679129ece7773cf4a700f0c563cba52920519f41f95cb72a67a8cae8778a5cbb5aff4bcb6059640709a8980ad993714948
+  data.tar.gz: 52bb607990a149d4c1a9d989d670a820276a78e601b460bafec5438ea64a050e265e28683795f91d536f4cec9634de100ad4b26604f9ffe34737d41eb903a372

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.1
+before_install: gem install bundler -v 1.10.5

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in MShealth.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 TODO: Write your name
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/MShealth.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'MShealth/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "MShealth"
+  spec.version       = MShealth::VERSION
+  spec.authors       = ["WH Lu"]
+  spec.email         = ["luwh364@gmail.com"]
+
+  spec.summary       = "Ruby API wrapper for the Microsoft Health Cloud"
+  spec.description   = "Ruby API wrapper for the Microsoft Health Cloud"
+  spec.homepage      = "https://github.com/yielder/mshealth"
+  spec.license       = "MIT"
+
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "httparty"
+  spec.add_dependency "hashie"
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "vcr"
+  spec.add_development_dependency "webmock"
+end

data/README.md

@@ -0,0 +1,98 @@
+# MShealth
+
+Ruby API wrapper for the [Microsoft Health Cloud](http://developer.microsoftband.com/cloudAPI).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'MShealth'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install MShealth
+
+## Usage
+Check [get started](http://developer.microsoftband.com/Content/docs/MS%20Health%20API%20Getting%20Started.pdf) on how to register application and the application authentication scheme.
+
+Set the token:
+
+```ruby
+MShealth.configure do |c|
+  c.token = "your token"
+end
+```
+
+Then get client:
+
+```ruby
+client = MShealth.client
+```
+
+### Profile
+
+```ruby
+client.profile #Get the details about this user from their Microsoft Health profile.
+```
+
+### Devices
+
+```ruby
+client.device(id:'FFFF1700-FFFF-FFFF-8529-454E11000210') #Get the single device info
+client.devices #Return a list devices
+```
+
+### Activities
+
+```ruby
+# Get the single activity. "details,minute_summaries,map_points" are optional.
+activity = client.activity(id:"2519647921241112976",details:1,minute_summaries:1,map_points:1)
+# Get all activities during the period in an array. "details,minute_summaries,map_points,activity_types" are optional.
+activities = client.activities(start_time:Time.new(2015,5,27),
+  end_time:Time.new(2015,7,29),
+  activity_types:"Run,Sleep",
+  details:1,
+  minute_summaries:1,
+  map_points:1)
+```
+
+### Summary
+
+```ruby
+# Get all summaries during the period in an array. "end_time,device_id" are optional.
+summary = client.summary(period:'hourly',
+  start_time:Time.new(2015,6,27),
+  end_time:Time.new(2015,7,20),
+  device_id:"FFFF1700-FFFF-FFFF-8529-454E11000210")
+```
+
+### Return object
+
+All returns are stored in a hash-like Mash object. All naming of parameters are ruby-ish.(eg:firstName -> first_name)
+
+```ruby
+profile = client.profile
+profile.first_name
+# You can check the whole structure using to_yaml:
+puts profile.to_yaml
+```
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/yielder/MShealth.
+
+## Todo
+
+- Add documentation
+- Add oauth2 support
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+  t.verbose = true
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "MShealth"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/MShealth.rb

@@ -0,0 +1,20 @@
+require "MShealth/version"
+require "MShealth/client"
+require "MShealth/configuration"
+require "MShealth/mash"
+require "MShealth/errors"
+
+
+require 'time'
+
+module MShealth
+  class << self
+    def client
+      @client ||= Client.new
+    end
+
+    def configure(&block)
+      client.configure(&block)
+    end
+  end
+end

data/lib/MShealth/client.rb

@@ -0,0 +1,169 @@
+require 'httparty'
+
+module MShealth
+
+  class Client
+
+
+    include HTTParty
+    base_uri 'https://api.microsofthealth.net'
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield configuration
+    end
+
+    def profile
+      response = handle_response("/"+configuration.api_version+"/me/Profile",
+      :headers => {"Authorization" => "bearer "+configuration.token})
+      MShealth::Mash.new(response)
+    end
+
+    def devices
+      response = handle_response("/"+configuration.api_version+"/me/Devices",
+      :headers => {"Authorization" => "bearer "+configuration.token})
+      devices = []
+      response['deviceProfiles'].each do |device|
+        devices << MShealth::Mash.new(device)
+      end
+      devices
+    end
+
+    def device(id:)
+      response = handle_response("/"+configuration.api_version+"/me/Devices/"+id,
+      :headers => {"Authorization" => "bearer "+configuration.token})
+      MShealth::Mash.new(response)
+    end
+
+    def summary(period:,start_time:,**options)
+      query = {}
+      query['startTime'] = start_time.iso8601
+      query['endTime'] = options[:end_time].iso8601 if options.key?(:end_time)
+      query['deviceIds'] = options[:device_id] if options.key?(:device_id)
+
+      period_str = nil
+      response = nil
+
+      case period
+      when "hourly"
+        period_str = 'Hourly'
+      when "daily"
+        period_str = 'Daily'
+      else
+      end
+
+      response = handle_response("/"+configuration.api_version+"/me/Summaries/"+period_str,
+      :headers => {"Authorization" => "bearer "+configuration.token},
+      :query => query)
+
+      result = []
+
+      response['summaries'].each do |summary|
+        result << MShealth::Mash.new(summary)
+      end
+
+      while response.key?("nextPage")
+        response = handle_response(response['nextPage'],:headers => {"Authorization" => "bearer "+configuration.token})
+        response['summaries'].each do |summary|
+          result << MShealth::Mash.new(summary)
+        end
+      end
+
+      result
+    end
+
+    def activity(id:,**options)
+      query = {}
+      query = handle_activity_include(query,options)
+
+      response = handle_response("/"+configuration.api_version+"/me/Activities/"+id,
+      :headers => {"Authorization" => "bearer "+configuration.token},
+      :query => query)
+
+      MShealth::Mash.new(response)
+
+    end
+
+    def activities(start_time:,end_time:,**options)
+      query = {}
+
+      query['startTime'] = start_time.iso8601
+      query['endTime'] = end_time.iso8601
+      query['activityTypes'] = options[:activity_types] if options.key?(:activity_types)
+      query = handle_activity_include(query,options)
+
+      response = response = handle_response("/"+configuration.api_version+"/me/Activities",
+      :headers => {"Authorization" => "bearer "+configuration.token},
+      :query => query)
+
+      result = []
+
+      types = ['bike','freePlay','golf','guidedWorkout','run','sleep']
+
+      result = extract_activities(types,response,result)
+
+      while response.key?("nextPage")
+        response = handle_response(response['nextPage'],:headers => {"Authorization" => "bearer "+configuration.token})
+        result = extract_activities(types,response,result)
+      end
+
+      result
+    end
+
+    private
+    def handle_response(*args)
+      response = self.class.get(*args)
+
+      case response.code.to_s
+      when "401"
+        raise MShealth::Errors::UnauthorizedError.new, response
+      when "400"
+        raise MShealth::Errors::BadRequestError.new, response
+      when "403"
+        raise MShealth::Errors::ForbiddenError.new, response
+      when "404"
+        raise MShealth::Errors::NotFoundError.new, response
+      when "429"
+        raise MShealth::Errors::TooManyRequestsError.new, response
+      when "500"
+        raise MShealth::Errors::ServerError.new, response
+      when "200"
+        return response
+      else
+        puts response.code.to_s
+      end
+
+    end
+
+    def handle_activity_include(query,options)
+      query['activityIncludes'] = ""
+      query['activityIncludes'] += "Details," if options.key?(:details)
+      query['activityIncludes'] += "MinuteSummaries," if options.key?(:minute_summaries)
+      query['activityIncludes'] += "MapPoints," if options.key?(:map_points)
+      if query['activityIncludes'] == ""
+        query.delete('activityIncludes')
+      else
+        query['activityIncludes'] = query['activityIncludes'][0...-1]
+      end
+      query
+    end
+
+    def extract_activities(types,response,result)
+      types.each do |type|
+        name = type + 'Activities'
+        if !response[name].nil?
+          response[name].each do |activity|
+            result << MShealth::Mash.new(activity)
+          end
+        end
+      end
+      result
+    end
+
+
+  end
+
+end

data/lib/MShealth/configuration.rb

@@ -0,0 +1,13 @@
+module MShealth
+  DEFAULT_VERSION = "V1"
+
+  class Configuration
+
+    attr_accessor :token, :api_version
+
+    def initialize
+      @api_version = DEFAULT_VERSION
+    end
+  end
+
+end

data/lib/MShealth/errors.rb

@@ -0,0 +1,18 @@
+module MShealth
+  module Errors
+    class MShealthError < StandardError; end
+
+    class UnauthorizedError < MShealthError; end
+
+    class BadRequestError < MShealthError; end
+
+    class ForbiddenError < MShealthError; end
+
+    class NotFoundError < MShealthError; end
+
+    class TooManyRequestsError < MShealthError; end
+
+    class ServerError < MShealthError; end
+
+  end
+end

data/lib/MShealth/mash.rb

@@ -0,0 +1,37 @@
+require 'hashie'
+
+module MShealth
+  class Mash < Hashie::Mash
+    def initialize(hash)
+      mash = super(hash)
+      convert_time(mash)
+      mash
+
+    end
+
+    private
+    def convert_time(mash)
+      dic = ['birthdate','last_successful_sync','day_id']
+      mash.each do |k,v|
+        if dic.include?(k.to_s) or k.to_s.include?("time")
+          mash[k] = Time.iso8601(v)
+        end
+      end
+    end
+
+    protected
+    def convert_key(key)
+      underscore(key)
+    end
+
+    def underscore(camel_cased_word)
+      word = camel_cased_word.to_s.dup
+      word.gsub!(/::/, '/')
+      word.gsub!(/([A-Z]+)([A-Z][a-z])/,'\1_\2')
+      word.gsub!(/([a-z\d])([A-Z])/,'\1_\2')
+      word.tr!("-", "_")
+      word.downcase!
+      word
+    end
+  end
+end

data/lib/MShealth/version.rb

@@ -0,0 +1,3 @@
+module MShealth
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,157 @@
+--- !ruby/object:Gem::Specification
+name: MShealth
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- WH Lu
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-07-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby API wrapper for the Microsoft Health Cloud
+email:
+- luwh364@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- MShealth.gemspec
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/MShealth.rb
+- lib/MShealth/client.rb
+- lib/MShealth/configuration.rb
+- lib/MShealth/errors.rb
+- lib/MShealth/mash.rb
+- lib/MShealth/version.rb
+homepage: https://github.com/yielder/mshealth
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: Ruby API wrapper for the Microsoft Health Cloud
+test_files: []