health_hero-human_api 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c217c0cffdebec2223cde421f673e1f2d1d09f5a
-  data.tar.gz: fe4ff9bc5a2acd4eec99aa834308492d6d95ada3
+  metadata.gz: 0ed77a15aa9a4f4d52a1ad6b147bb4d5e08c84cc
+  data.tar.gz: ea9e5d872a2af3485f6485d0684f303bb5a5ac65
 SHA512:
-  metadata.gz: 3179c496a64c1ff76be72a1c3eebdd36f5ee33ae80af1cf28d8b5f7822e49fe031aebd075143c2be141c9eea68610ddfe53d4ceb973f88f83d77bec6db926b49
-  data.tar.gz: 25020943baadec2724ff7be0ecad68db82fbee7ab2e451560ed9d171b060639205a8cf268a1c76a7baf1e1e088324dd2d6f4513f56ecab386c11c5a80f2b2311
+  metadata.gz: 7ffeb1730dedef35efb285c1ddd034a2ad485df7a46f591b6db049c5b3c0ab448f7a683f7a9c15721aef8f7551affbfaa508970f69cb670f83be77872975cd95
+  data.tar.gz: ac9a87898529735646086ded69d9393dc5552769d382aaeb286796ac3bc08d40403030db06c4dcc5d83cf578533ee98789f0f0b426ba534c1c9620af8c4e640a

data/README.md

@@ -21,7 +21,25 @@ gem 'health_hero-human_api'
 
 ## Configuration
 
-Let's say you have an User model as follows:
+### Initializer
+
+```ruby
+HumanApi.config do |c|
+  c.app_id        = ENV['HUMANAPI_KEY']
+  c.query_key     = ENV['HUMANAPI_SECRET']
+  c.client_secret = ENV['HUMANAPI_CLIENT_SECRET']  
+
+  # Optional:
+  # If a Nestful::UnauthorizedAccess error occurs, this proc will handle it:
+  c.handle_access_error = ->e,context { Airbrake.notify e; do_something_with(context) }
+
+  # If you don't want to handle it, and want it raised:
+  # (Note - if you set a proc above, this setting is ignored)
+  c.raise_access_errors = true # Default is false
+end
+```
+
+### User model
 
 ```ruby
 class User < ActiveRecord::Base
@@ -35,34 +53,18 @@ class User < ActiveRecord::Base
 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']
-  c.client_secret = ENV['HUMANAPI_CLIENT_SECRET']
-end
-```
-
-### The alternative
-
-If you don't like that configuration, you can use a different one, writing right into the initializer:
+You can also configure it the initializer:
 
 ```ruby
 HumanApi.config do |c|
-  c.app_id        = "<YOUR_APP_ID>"
-  c.query_key     = "<YOUR_QUERY_KEY>"
-  c.client_secret = "<YOUR__CLIENT_SECRET>"
-
+  ...
   # 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.
+It should work both ways, the choice is yours.
 
 ## Usage
 Once you did the configuration, the usage of the gem is quite easy:
@@ -116,6 +118,9 @@ u.human.query(:activities, limit: 3, offset: 50).count #=> 3
 # Return all of a user's data jammed together, despite being across multiple pages:
 u.human.query(:activities).count                  #=> 50
 u.human.query(:activities, fetch_all: true).count #=> 321
+
+# Return all of a user's data jammed together, and handle unauthorized errors:
+u.human.query(:activities, fetch_all: true, handle_access_error: ->error, context { do_something_with(error, context)})
 ```
 
 Lastly, as a common rule, I've identified a pattern in humanapis.
@@ -124,7 +129,7 @@ Lastly, as a common rule, I've identified a pattern in humanapis.
 
 ## 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.
+- `rewrite_human_model`: Could not find `token` in `User`
+  - Causes: It means that the method you suggested as `:humanizable` 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.

data/lib/human_api/app.rb

@@ -10,7 +10,7 @@ module HumanApi
       get 'users'
     rescue Nestful::UnauthorizedAccess => e
       if HumanApi.config.handle_access_error
-        HumanApi.config.handle_access_error.call e
+        HumanApi.config.handle_access_error.call e, self
       else
         raise if HumanApi.config.raise_access_errors
         []
@@ -30,7 +30,7 @@ module HumanApi
       end
     rescue Nestful::UnauthorizedAccess => e
       if HumanApi.config.handle_access_error
-        HumanApi.config.handle_access_error.call e
+        HumanApi.config.handle_access_error.call e, self
       else
         raise if HumanApi.config.raise_access_errors
         false
@@ -44,7 +44,7 @@ module HumanApi
       response.status >= 200 && response.status < 300
     rescue Nestful::UnauthorizedAccess => e
       if HumanApi.config.handle_access_error
-        HumanApi.config.handle_access_error.call e
+        HumanApi.config.handle_access_error.call e, self
       else
         raise if HumanApi.config.raise_access_errors
         false

data/lib/human_api/human.rb

@@ -13,8 +13,8 @@ module HumanApi
       heart_rate height locations sleeps weight bmi sources
     }.freeze
 
-    def initialize(options)
-      @token   = options[:access_token]
+    def initialize(initial_options)
+      @token   = initial_options[:access_token]
       @success = true
       @results = []
       super
@@ -78,14 +78,13 @@ module HumanApi
         @params.merge!(limit: options[:limit])   if options[:limit].present?
         @params.merge!(offset: options[:offset]) if options[:offset].present?
         result = fetch_page url
-        options[:return_metadata] ? result : JSON.parse(result.body)
-      end
-    rescue Nestful::UnauthorizedAccess => e
-      if HumanApi.config.handle_access_error
-        HumanApi.config.handle_access_error.call e
-      else
-        raise if HumanApi.config.raise_access_errors
-        false
+        if options[:return_metadata]
+          result
+        elsif result.present? && result.respond_to?(:body)
+          JSON.parse result.body
+        else
+          Hash.new
+        end
       end
     end
 
@@ -110,6 +109,17 @@ module HumanApi
         @results = @results + JSON.parse(page.body) if options[:fetch_all]
         page
       end
+    rescue Nestful::UnauthorizedAccess => e
+      @success = false
+      if options[:handle_access_error]
+        options[:handle_access_error].call e, self
+      elsif HumanApi.config.handle_access_error
+        HumanApi.config.handle_access_error.call e, self
+      else
+        raise if HumanApi.config.raise_access_errors
+      end
+
+      false
     end
   end
 end

data/lib/human_api/user.rb

@@ -11,7 +11,7 @@ module HumanApi
       JSON.parse(response.body)['publicToken']
     rescue Nestful::UnauthorizedAccess => e
       if HumanApi.config.handle_access_error
-        HumanApi.config.handle_access_error.call e
+        HumanApi.config.handle_access_error.call e, self
       else
         raise if HumanApi.config.raise_access_errors
         nil

data/lib/human_api/version.rb

@@ -1,3 +1,3 @@
 module HumanApi
-  VERSION = "0.3.1"
+  VERSION = "0.3.2"
 end

data/spec/lib/human_api/app_spec.rb

@@ -35,7 +35,7 @@ describe HumanApi::App do
 
     context "when unauthorized" do
       context "with a proc set" do
-        before { expect(HumanApi.config).to receive(:handle_access_error).exactly(:twice).and_return ->e { e.class.to_s } }
+        before { expect(HumanApi.config).to receive(:handle_access_error).exactly(:twice).and_return ->e,_ { e.class.to_s } }
 
         it 'calls the proc' do
           expect(app.create_human 'joe').to eq 'Nestful::UnauthorizedAccess'

data/spec/lib/human_api/human_spec.rb

@@ -38,6 +38,16 @@ describe HumanApi::Human do
         expect(profile['defaultTimeZone']).to eq 'name' => "UTC"
       end
     end
+
+    context "with an error handler" do
+      let(:profile) { human.profile handle_access_error: ->e,h { @error = e; @human = h} }
+
+      it "calls it" do
+        expect(profile).to eq Hash.new
+        expect(@error).to be_an_instance_of Nestful::UnauthorizedAccess
+        expect(@human.attributes).to eq 'access_token' => 'token'
+      end
+    end
   end
 
   describe "#activities" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: health_hero-human_api
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Justin Aiken
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-02 00:00:00.000000000 Z
+date: 2015-09-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nestful