human_api 0.1.6

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2a6cb0060e8a7c0d3ec9e4d79fdcdf4b5c101cdc
+  data.tar.gz: 6477af6b9a515d46c4ffb694d047b29af03a0257
+SHA512:
+  metadata.gz: c98f1172de428f932d2b35764b69232407696782c1954d89e91c79f6eff43efe00c57b2e7d5ac6fa62bb6db18196b3ca5336b1a06163c9e164e2fd03285a58a3
+  data.tar.gz: 2cf4e4a6426cf4f6aebaaccb55755b771255dd664ab75e457b967b31d21a1194946f7016424539301663f5e14f50d97b1dc8f6cd816d753694aab5a41e52c17b

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Pazienti.it
+
+MIT License
+
+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/README.md

@@ -0,0 +1,75 @@
+# HumanApi
+
+A Ruby client to [HumanApi](http://humanapi.co).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    # We're going to publish our gem soon...
+    gem 'human_api', :git => 'git://github.com/Pazienti/humanapi.git'
+
+## Configuration
+The gem is quite simple to configure. You can configure the gem using its home-made initializer:
+
+	HumanApi.config do |c|
+		c.app_id = "<YOUR_APP_ID>"
+		c.query_key = "<YOUR_QUERY_KEY>"
+		
+		# This is the part where the magics happen
+		c.human_model = User       # Tell me what is the model you want to use
+		c.token_method_name = :human_token   # Tell me the method you use to retrieve the token (Inside the human_model)
+	end
+
+## Usage
+Once you did the configuration, the usage of the gem is quite ridiculous:
+
+	# Somewhere in your model
+	u = User.first
+	u.human.profile    #=> Will return the humanapi user's profile
+	u.human.query(:activities) #=> Will return everything you asked for
+
+Just use the _human_ instance method from your User instance and that's it ;)
+
+###The query method
+The query method is meant to ask whatever you want whenever you want. Here are some permitted methods (according to humanapi) you can use to retrieve user's data:
+
+	profile 
+	activities
+	blood_glucose
+	blood_pressure
+	body_fat
+	genetic_traits
+	heart_rate
+	height
+	locations
+	sleeps
+	weight
+	bmi
+
+Mixin' up these methods with some options will give you what you want. 
+
+	u.human.query(:activities, :summary => true) #=> will give you a summary of the activities
+	u.human.query(:sleeps, :date => "2014-01-01") #=> Will give you a single sleep measurement
+	
+	# Getting KPIs (KPIs are just single values you get to retrieve a measurements average value)
+	u.human.query(:weight) #=> Will give you a single weight value (The avg I guess)
+	
+	# Getting readings (If you begin with a single avg value and you wanna go deeper)
+	u.human.query(:weight, :readings => true)
+	
+Lastly, as a common rule, I've identified a pattern in humanapis. 
+- If the method name is plural, it will give you multiple measurements when calling it. In addition, you can ask for a :summary => true, for a group of value in a specific :date => "DATE" or for a single known measurement :id => "measurement_id"
+- If the method name is singular, it will give you a single avg value for what you asked. In addition, you can ask for all :readings => true and for all readings => true in a specific :date=> "DATE".
+- If I'm missing something just send me a PM or open an issue.
+	
+
+###The alternative
+If you don't like that configuration, you can use a simple method right in your own user model:
+
+	humanizable :token_method
+
+That's it! Then you can do something like _u.human.profile_ like I said before.
+
+## Contributing
+Feel free to contribute with your pull requests and forks. Get in touch with us at team@pazienti.it or open an issue.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/human_api.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'human_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "human_api"
+  spec.version       = HumanApi::VERSION
+  spec.authors       = ["Alessio Santo"]
+  spec.email         = ["alessio.santo@pazienti.it"]
+  spec.description   = %q{API client for HumanAPI}
+  spec.summary       = %q{API client for HumanAPI}
+  spec.homepage      = "https://github.com/Pazienti/humanapi"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "nestful", "~> 1.0.4"
+  spec.add_dependency "json", "~> 1.8.1"
+
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end
+

data/lib/config/initializers/core_ext.rb

@@ -0,0 +1,16 @@
+class String
+  def is_singular?
+    self.pluralize != self and self.singularize == self
+  end
+end
+
+class ActiveRecord::Base
+
+	attr_accessor :human_var, :test
+
+	def self.humanizable(method)
+		define_method :human do
+			@human_var ||= HumanApi::Human.new(:access_token => self.send(method.to_sym))
+		end
+	end
+end

data/lib/human_api/app.rb

@@ -0,0 +1,38 @@
+
+# THE MODULE
+module HumanApi
+	# THE CLASS # TODO: Make it an instance of class HumanApi::App :(
+	class App < Nestful::Resource
+
+		# The host of the api
+		endpoint 'https://api.humanapi.co'
+
+		# The path of the api
+		path "/v1/apps/#{HumanApi.config.app_id}"
+
+		# This should be a private method
+		def self.authentication
+			Base64.encode64("#{HumanApi.config.query_key}:") 
+		end
+
+		# Get the humans of your app
+		def self.humans
+			get("users", {}, {:headers => {"Authorization" => "Basic #{authentication}"}})
+		end
+
+		# Create a new human
+		def self.create_human(id)
+			# Make a call to create the user
+			response = post("users", {:externalId => id}, {:headers => {"Authorization" => "Basic #{authentication}"}})
+
+			# If the response is true
+			if response.status >= 200 and response.status < 300 # Leave it for now
+				JSON.parse response.body
+			# Else tell me something went wrong
+			else
+				false # Nothing was created
+			end
+		end
+
+	end
+end

data/lib/human_api/config.rb

@@ -0,0 +1,48 @@
+
+# THE MODULE
+module HumanApi
+	# THE CLASS
+	class Config
+		attr_accessor :app_id, :query_key, :human_model, :token_method_name, :hardcore
+
+		CHECK_THE_GUIDE = "Read the guide for more information. (https://github.com/Pazienti/humanapi)"
+
+		# Init some vars
+		def initialize
+			@hardcore = false
+		end
+
+		# Init some vars
+		def configure
+			rewrite_human_model
+		end
+
+		# Rewrite the human model
+		def rewrite_human_model
+			# Check if the human_model to use and the method name are present
+			if human_model.present? and token_method_name.present?
+
+				# Check if the method given exists in the given class
+				if human_model.instance_methods.include?(token_method_name)	
+
+					# Rewrite the class adding a method
+					human_model.class_eval do 
+						attr_accessor :human_var
+
+						# The method in the human_model class instance
+						def human
+							# Initialize with the access token
+							@human_var ||= HumanApi::Human.new(:access_token => self.send(HumanApi.config.token_method_name.to_sym))
+						end
+					end
+				else
+					raise "Could not find '#{token_method_name}' in #{human_model}. #{CHECK_THE_GUIDE}"
+				end
+			else
+				# unless hardcore
+				# 	raise "You must set a human_model and a token_method_name. #{CHECK_THE_GUIDE}"
+				# end
+			end
+		end
+	end
+end

data/lib/human_api/human.rb

@@ -0,0 +1,92 @@
+
+# THE MODULE
+module HumanApi
+	# THE CLASS
+	class Human < Nestful::Resource
+
+		attr_reader :token
+
+		# The host of the api
+		endpoint 'https://api.humanapi.co'
+
+		# The path of the api
+		path '/v1/human'
+
+		# The available methods for this api
+		AVAILABLE_METHODS = [
+							:profile, 
+							:activities, 
+							:blood_glucose, 
+							:blood_pressure, 
+							:body_fat, 
+							:genetic_traits, 
+							:heart_rate, 
+							:height, 
+							:locations, 
+							:sleeps, 
+							:weight, 
+							:bmi
+							]
+
+		def initialize(options)
+			@token = options[:access_token]
+			super
+		end
+
+		# Profile =====================================
+
+		def summary
+			get('', :access_token => token)
+		end
+
+		def profile
+			query('profile')
+		end
+
+		# =============================================
+
+		def query(method, options = {})
+
+			# Is this method in the list?
+			if AVAILABLE_METHODS.include? method.to_sym
+				# From sym to string
+				method = method.to_s
+
+				# The base of the url
+				url = "#{method}"
+
+				# If it is a singular word prepare for readings
+				if method.is_singular?
+					if options[:readings] == true
+						url += "/readings"
+					end
+				else
+					if options[:summary] == true
+						url += "/summary"
+					end
+				end
+
+				# You passed a date
+				if options[:date].present?
+					# Make a request for a specific date
+					url += "/daily/#{options[:date]}"
+				# If you passed an id
+				elsif options[:id].present?
+					# Make a request for a single 
+					url += "/#{options[:id]}"
+				end
+
+				# Make the request finally
+				result = get(url, :access_token => token)
+
+				# Converting to json the body string
+				JSON.parse(result.body)
+			else
+				# Tell the developer the method is not there
+				"The method '#{method}' does not exist!"
+			end
+
+		end
+
+	end
+end

data/lib/human_api/version.rb

@@ -0,0 +1,3 @@
+module HumanApi
+  VERSION = "0.1.6"
+end

data/lib/human_api.rb

@@ -0,0 +1,25 @@
+require "json"
+require "nestful"
+require "human_api/version"
+require "human_api/config"
+require "config/initializers/core_ext"
+
+module HumanApi
+
+	@config = HumanApi::Config.new
+
+	def self.config
+
+		if block_given?
+			yield(@config)
+			@config.configure
+		else
+			@config
+		end
+
+	end
+
+	autoload :Human, 'human_api/human'
+	autoload :App, 'human_api/app'
+
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: human_api
+version: !ruby/object:Gem::Version
+  version: 0.1.6
+platform: ruby
+authors:
+- Alessio Santo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nestful
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.4
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: API client for HumanAPI
+email:
+- alessio.santo@pazienti.it
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- human_api.gemspec
+- lib/config/initializers/core_ext.rb
+- lib/human_api.rb
+- lib/human_api/app.rb
+- lib/human_api/config.rb
+- lib/human_api/human.rb
+- lib/human_api/version.rb
+homepage: https://github.com/Pazienti/humanapi
+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.2.2
+signing_key: 
+specification_version: 4
+summary: API client for HumanAPI
+test_files: []