ecobee 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4e2b2a04ef326e3e40a7e7c4191de520a5792d4d
-  data.tar.gz: 88ff1e1a5805e3a157b0c7b5ce093210d3ab8393
+  metadata.gz: a99a3623251e1d3a912fe40894936a22b14fb1b1
+  data.tar.gz: 1340b44c08f9a2367b1da7e999fbbea6f46e10a1
 SHA512:
-  metadata.gz: 5b902bc54d038513952d96a1e0b962a65b2748d8ff80447c700eb62ba6b793c15fb9bc907db76fff960ae656b08a4c3f3610699331fc5783f2902a37a9fe0a89
-  data.tar.gz: 445de99fe41e275297d56859752c232e940da0604e43ec13881d09a4d6ab3b3f0fc2b3f3ce9a91b4cebf044c470881f6847b66d26d33841575df17edd096c2cc
+  metadata.gz: 12e17299139449ac3a03380e58df09517d933cb289b14793568ded8fc06ce7df51a0c64a5d25c84523addf447912a4b4deadafd62f28a621e906e6c468acc8f9
+  data.tar.gz: 1cd46185bde20e5bb5caff189c283dc61ad17da6ffbbc44f956ebf79574ec1a0f8cff8ee13ccb8b1715370f04e0e01dbf3cb9c80edaf4196f0bf941f0b186586

data/README.md

@@ -5,19 +5,16 @@ Ecobee API Ruby Gem.  Implements:
 - Persistent HTTP connection management
 - Methods for GET & POST requests w/ JSON parsing & error handling
 - Persistent storage for API key & refresh tokens
+- Block/Proc hooks for token storage load/save to add app config data
+- Abstraction class for simple thermostat interaction
 - Example usage scripts (see /examples/\*)
 
 TODO:
-- Move all HTTP interaction to a dedicated/shared class
-- Add and test more robust Status != 0 handling via Exceptions; document
-- Add retries for specific !0 statuses
-- Add random timeout padding to avoid race conditions with multiple clients when refreshing tokens
+- Add dedicated symbol class to Thermostat
 - Add RDoc documentation
-- Add block/proc support to token storage routines
 - Add timeout to Ecobee::Token#wait
 - Add redirect based registration
 - Implement throttling algorithm based on API feedback 
-- Create helper methods/classes with more abstraction
 - Create examples of proper error handling
 
 ## Installation
@@ -38,9 +35,11 @@ gem install ecobee
   - Give user Ecobee::Token#pin and instructions to register your Application via the [Ecobee My Apps Portal](https://www.ecobee.com/consumerportal/index.html#/my-apps).
   - You can call Ecobee::Token#wait to block until the user confirms the PIN code.
 
-3. Instantiate Ecobee::Client with the token object.
+3. Instantiate Ecobee::Thermostat with the token object.
 
-4. Call Ecobee::Client#get or Ecobee::Client#post to interact with [Ecobee's API](https://www.ecobee.com/home/developer/api/introduction/index.shtml).
+4. Use the simplified methods for common interactions, access the Thermostat object directly as a Hash to read values, or use the update method to post changes.
+
+5. Ecobee::Client#get or Ecobee::Client#post can be used for advanced interaction with [Ecobee's API](https://www.ecobee.com/home/developer/api/introduction/index.shtml).
 
 ## Development
 

data/lib/ecobee.rb

@@ -2,11 +2,6 @@ require 'pp'
 require 'json'
 require 'net/http'
 
-#require 'ecobee/client'
-#require 'ecobee/register'
-#require 'ecobee/token'
-#require 'ecobee/version'
-
 require_relative 'ecobee/client'
 require_relative 'ecobee/register'
 require_relative 'ecobee/thermostat'
@@ -35,7 +30,7 @@ module Ecobee
 
   HVAC_MODES = %w{auto auxHeatOnly cool heat off}
 
-  REFRESH_PAD = 120
+  REFRESH_PAD = 30
   REFRESH_TOKEN_CHECK = 10 
 
   SCOPES = [:smartWrite, :smartRead]

data/lib/ecobee/client.rb

@@ -1,7 +1,6 @@
 module Ecobee
 
   class Client
-
     def initialize(token: nil)
       raise ArgumentError.new('Missing token') unless token
       @token = token
@@ -69,7 +68,6 @@ module Ecobee
       end
       @http
     end
-
   end
 
   class ClientError < StandardError ; end

data/lib/ecobee/register.rb

@@ -1,4 +1,5 @@
 module Ecobee
+
   class Register
     attr_reader :expires_at, :result
 
@@ -47,4 +48,5 @@ module Ecobee
     end
 
   end
+
 end

data/lib/ecobee/thermostat.rb

@@ -1,4 +1,5 @@
 module Ecobee
+
   class ThermostatError < StandardError ; end
 
   class Thermostat < Hash
@@ -209,4 +210,5 @@ module Ecobee
     end
 
   end
+
 end

data/lib/ecobee/token.rb

@@ -1,4 +1,5 @@
 module Ecobee
+
   class Token
     attr_reader :access_token, 
                 :access_token_expire, 
@@ -40,15 +41,18 @@ module Ecobee
     end
 
     def access_token
-      if(@access_token && @access_token_expire &&
-         Time.now.to_i + @refresh_pad < @access_token_expire)
-        @status = :ready
+      if(@access_token && @access_token_expire && !access_token_expired?)
+        @status = (@refresh_token ? :ready : :authorization_pending)
         @access_token
       else
         refresh_access_token
       end
     end
 
+    def access_token_expired?
+      Time.now.to_i > @access_token_expire - @refresh_pad
+    end
+
     def authorization
       "#{@token_type} #{access_token}"
     end
@@ -90,8 +94,11 @@ module Ecobee
       result = JSON.parse(response.body)
       if result.key? 'error'
         if result['error'] == 'invalid_grant'
-          @status = :authorization_pending
-          check_for_authorization
+          if access_token_expired?
+            register
+          else
+            check_for_authorization
+          end
         else
           puts "DUMPING(result): #{result.pretty_inspect}"
           raise Ecobee::TokenError.new(
@@ -134,6 +141,7 @@ module Ecobee
 
     private
 
+    # arrives here, expired
     def check_for_authorization
       check_for_authorization_single
       if @status == :authorization_pending
@@ -160,7 +168,6 @@ module Ecobee
       result = JSON.parse(response.body)
       if result.key? 'error'
         @status = :authorization_pending
-
         if result['error'] == 'invalid_client'
           register 
         elsif !['slow_down', 'authorization_pending'].include? result['error']
@@ -294,6 +301,7 @@ module Ecobee
       @pin = result.pin
       @access_token = result.code
       @access_token_expire = result.expires_at
+      @refresh_token = nil
       @scope = result.scope
       check_for_authorization
       config_save
@@ -302,7 +310,6 @@ module Ecobee
 
   end
 
-  class TokenError < StandardError
-  end
+  class TokenError < StandardError ; end
 
 end

data/lib/ecobee/version.rb

@@ -1,3 +1,3 @@
 module Ecobee
-  VERSION = "0.2.1"
+  VERSION = "0.2.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ecobee
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Rob Zwissler
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-08-17 00:00:00.000000000 Z
+date: 2016-08-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler