human_api 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2a6cb0060e8a7c0d3ec9e4d79fdcdf4b5c101cdc
-  data.tar.gz: 6477af6b9a515d46c4ffb694d047b29af03a0257
+  metadata.gz: a6ab6c2cd49330c1ef7ef58c6745a0aebfcf4189
+  data.tar.gz: f2720245384449386a078641d576913bb2650981
 SHA512:
-  metadata.gz: c98f1172de428f932d2b35764b69232407696782c1954d89e91c79f6eff43efe00c57b2e7d5ac6fa62bb6db18196b3ca5336b1a06163c9e164e2fd03285a58a3
-  data.tar.gz: 2cf4e4a6426cf4f6aebaaccb55755b771255dd664ab75e457b967b31d21a1194946f7016424539301663f5e14f50d97b1dc8f6cd816d753694aab5a41e52c17b
+  metadata.gz: 6943708f160360c960e2d692513a16dee483dac9513d549c01e8ae0e5652fb9a6ee85f518e1b441f882acba124737b5357d89d71639c6083be87762aa06d9d06
+  data.tar.gz: c3423fb32e4c35db07695c941c0438018e36cb4f890661995007591cf41d122fb3132359da4e6ec9d5254e2c7610f075e3ff9716e36761cc9e598f39dfcdaede

data/README.md

@@ -1,75 +1,109 @@
-# HumanApi
-
+# HumanApi [![Gem Version](https://badge.fury.io/rb/human_api.png)](http://badge.fury.io/rb/human_api)
 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'
-
+```ruby
+gem 'human_api'
+```
 ## 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)
+Let's say you have an User model as follows:
+```ruby
+class User<ActiveRecord::Base
+	# Some attributes here
+	
+	def get_the_token
+		# the code to reach the token
 	end
+end
+```
+Then you can do this:
+```ruby
+class User<ActiveRecord::Base
+	# Some attributes here
+	
+	humanizable :get_the_token
+	
+	def get_the_token
+		# the code to reach the token
+	end
+end
+```
+This configuration is really simple. I suggest it over the second one.
+
+Always remember to configure the initializer with the access keys:
+```ruby
+HumanApi.config do |c|
+	c.app_id = ENV['HUMANAPI_KEY']
+	c.query_key = ENV['HUMANAPI_SECRET']
+	end
+```
+###The alternative
+If you don't like that configuration, you can use a different one, writing right into the initializer:
+```ruby
+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
+```
+It should work in both ways, the choice is yours.
 
 ## 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
-
+```ruby
+# 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
-
+```ruby
+:profile 
+:activities
+:blood_glucose
+:blood_pressure
+:body_fat
+:genetic_traits
+:heart_rate
+:height
+:locations
+:sleeps
+:weight
+:bmi
+:sources
+:human
+```
 Mixin' up these methods with some options will give you what you want. 
+```ruby
+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
 
-	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)
-	
+# 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.
 	
+## Common errors and troubleshooting
+###'rewrite_human_model': Could not find 'token' in User
+- Causes: it does mean that the method you suggested does not exist!
+- What to check: check if you misspelled the method name or the attribute does not exist.
+- Solving: if this does not solve, try using the humanizable function passing a method you can create in your model to retrieve manually just the token.
+Still having problems? Open an issue or contact us.
 
-###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.
+Feel free to contribute with your pull requests and forks. Get in touch with us at dev@pazienti.it or open an issue.

data/lib/human_api/human.rb

@@ -25,7 +25,9 @@ module HumanApi
 							:locations, 
 							:sleeps, 
 							:weight, 
-							:bmi
+							:bmi,
+              :sources,
+              :human
 							]
 
 		def initialize(options)

data/lib/human_api/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: human_api
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors:
 - Alessio Santo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-16 00:00:00.000000000 Z
+date: 2014-08-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nestful
@@ -105,8 +105,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.0.6
 signing_key: 
 specification_version: 4
 summary: API client for HumanAPI
 test_files: []
+has_rdoc: