ecobee 0.2.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6e5259700881085205481c34338397602ab0c167
-  data.tar.gz: 6595615983c9aa45463c4ecc6b38edb1c049852e
+  metadata.gz: 48dab0a8186e1abe5f05115a744bf06a6167b718
+  data.tar.gz: d76e8de7fbf97ae44095436197f1d7085a324d9d
 SHA512:
-  metadata.gz: 6bfd85b6e3e227d5366585fc467d97593eeaba79147b69fdbca978e9f7f3023a9c1ea62a5b93615c3a2ca6e7ede24d5d9ba95df9ed902a1389918f8f6f938371
-  data.tar.gz: ad7c7b641b5262038958ca581a396d75e40468366e4c79ae688fa9ee778a67665f1225e27a13392559117b41cf6a48e2c581c5a8bd2585d04de104c6e24ca949
+  metadata.gz: 7e5ca066357160e4f43a67d90f6186437cf98f7a1105f1dba652eac447c588cec03c43f8c2e44f3caf791a0eabca9fc4b64f213f4a588e32c0ad9411cade0c05
+  data.tar.gz: 0bbc4eb430f37858787f915b10ab4af799fac335651344357e41becf7a883e3dd090d9359438e04ab0b9de50671df6cd4ab084b051b8ed244be8b777142c157a

data/README.md

@@ -5,17 +5,14 @@ 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
+- Storage uses iCloud Drive if available for shared computer use
 - Block/Proc hooks for token storage load/save to add app config data
-- Abstraction class for simple thermostat interaction
+- Thermostat abstraction class for simple thermostat interaction
 - Example usage scripts (see /examples/\*)
 
 TODO:
-- Add dedicated symbol class to Thermostat
 - Add RDoc documentation
-- Add timeout to Ecobee::Token#wait
 - Add redirect based registration
-- Implement throttling algorithm based on API feedback 
-- Create examples of proper error handling
 
 ## Installation
 

data/examples/set_mode.rb

@@ -1,25 +1,25 @@
 #!/usr/bin/env ruby
 #
+# Example of using the Ecobee::HTTP API directly (bypassing the
+# Ecobee::Thermostat abstraction class).
+#
 # Loops through menu showing current thermostat mode, with option
-# to change the mode.       -- @robzr
+# to change the mode.
 
 require 'pp'
-
 require_relative '../lib/ecobee'
-
 @hvac_modes = Ecobee::HVAC_MODES + ['quit']
 
 class TestFunctions
-  def initialize(client)
-    @client = client
+  def initialize(token)
+    @http = token.http
   end
 
   def print_summary
-    response = @client.get(:thermostat, 
-                           Ecobee::Selection(
-                             includeEquipmentStatus: true,
-                             includeSettings: true
-                           ))
+    response = @http.get(arg: :thermostat, 
+                         options: Ecobee::Selection(
+                                    includeEquipmentStatus: true,
+                                    includeSettings: true))
 
     puts "Found %d thermostats." % response['thermostatList'].length
 
@@ -36,12 +36,12 @@ class TestFunctions
   end
 
   def update_mode(mode)
-    @client.post('thermostat',
-                 body: { 
-                   'thermostat' => {
-                     'settings' => { 'hvacMode' => mode }
-                   }
-                 }.merge(Ecobee::Selection()))
+    @http.post(arg: :thermostat,
+               body: { 
+                       'thermostat' => {
+                         'settings' => { 'hvacMode' => mode } 
+                       } 
+                     }.merge(Ecobee::Selection()))
   end
 end
 
@@ -52,9 +52,7 @@ if token.pin
   token.wait 
 end
 
-test_functions = TestFunctions.new(
-  Ecobee::Client.new(token: token)
-)
+test_functions = TestFunctions.new(token)
 
 loop do
   test_functions.print_summary

data/lib/ecobee.rb

@@ -2,18 +2,26 @@ require 'pp'
 require 'json'
 require 'net/http'
 
-require_relative 'ecobee/client'
+require_relative 'ecobee/http'
 require_relative 'ecobee/register'
 require_relative 'ecobee/thermostat'
 require_relative 'ecobee/token'
 require_relative 'ecobee/version'
 
 module Ecobee
+
+  class HTTPError < StandardError ; end
+
+  class AuthError < HTTPError ; end
+
   API_HOST = 'api.ecobee.com'
   API_PORT = 443
+  API_URI_BASE= "https://#{API_HOST}:#{API_PORT}"
 
   CONTENT_TYPE = ['application/json', { 'charset' => 'UTF-8' }]
 
+  DEFAULT_POLL_INTERVAL = 30 
+
   DEFAULT_FILES = [
     '~/Library/Mobile Documents/com~apple~CloudDocs/.ecobee_token',
     '~/.ecobee_token'
@@ -30,16 +38,12 @@ module Ecobee
 
   HVAC_MODES = %w{auto auxHeatOnly cool heat off}
 
+  MAX_LOG_LENGTH = 1200
+
   REFRESH_PAD = 30
-  REFRESH_TOKEN_CHECK = 10 
 
   SCOPES = [:smartWrite, :smartRead]
-
-  URL_BASE= "https://#{API_HOST}:#{API_PORT}"
-  URL_API = "#{URL_BASE}/1/"
-  URL_GET_PIN = URL_BASE + 
-    '/authorize?response_type=ecobeePin&client_id=%s&scope=%s'
-  URL_TOKEN = "#{URL_BASE}/token"
+  DEFAULT_SCOPE = SCOPES[1]
 
   def self.FanMode(mode)
     { 'auto'        => 'Auto',

data/lib/ecobee/http.rb

@@ -0,0 +1,143 @@
+module Ecobee
+
+  class HTTPError < StandardError ; end
+  class AuthError < HTTPError ; end
+
+  class HTTP
+
+    def initialize(log_file: nil, token: nil)
+      raise ArgumentError.new('Missing token') unless token
+      @token = token
+      open_log log_file
+      http
+    end
+
+    def get(
+      arg: nil,
+      no_auth: false,
+      resource_prefix: '1/',
+      retries: 3,
+      options: nil,
+      validate_status: true
+    )
+      uri = URI.escape(sprintf("#{Ecobee::API_URI_BASE}/%s%s%s",
+                               resource_prefix,
+                               arg.to_s.sub(/^\//, ''),
+                               options ? "?json=#{options.to_json}" : ''))
+      log "http.get uri=#{uri}"
+      request = Net::HTTP::Get.new(URI(uri))
+      request['Content-Type'] = *CONTENT_TYPE
+      request['Authorization'] = @token.authorization unless no_auth
+      response = nil
+      retries.times do
+        http_response = http.request request
+        response = JSON.parse(http_response.body)
+        log "http.get response=#{response.pretty_inspect}"
+        response = validate_status(response) if validate_status
+        break unless response == :retry
+        sleep 3
+      end
+      case response
+      when :retry
+        raise Ecobee::HTTPError.new('HTTP.get: retries exhausted')
+      else
+        response
+      end
+    rescue SocketError => msg
+      raise Ecobee::HTTPError.new("HTTP.get SocketError => #{msg}")
+    rescue JSON::ParserError => msg
+      raise Ecobee::HTTPError.new("HTTP.get JSON::ParserError => #{msg}")
+    end
+
+    def log(arg)
+      return unless @log_fh
+      if arg.length > MAX_LOG_LENGTH
+        arg = arg.slice(0, MAX_LOG_LENGTH).chomp + "\n ...truncated..."
+      end
+      @log_fh.puts "#{Time.now} #{arg.chomp}"
+      @log_fh.flush
+    end
+
+    def post(
+      arg: nil,
+      body: nil,
+      no_auth: false,
+      resource_prefix: '1/',
+      retries: 3,
+      options: {},
+      validate_status: true
+    )
+      uri = URI.escape(sprintf("#{Ecobee::API_URI_BASE}/%s%s%s",
+                               resource_prefix,
+                               arg.to_s.sub(/^\//, ''),
+                               options.length > 0 ? "?json=#{options.to_json}" : ''))
+      log "http.post uri=#{uri}"
+      request = Net::HTTP::Post.new(URI(uri))
+      request['Content-Type'] = *CONTENT_TYPE
+      request['Authorization'] = @token.authorization unless no_auth
+      if body
+        log "http.post body=#{body.pretty_inspect}"
+        request.body = JSON.generate(body)
+      elsif options.length > 0
+        request.set_form_data({ 'format' => 'json' }.merge(options))
+      end
+      response = nil
+      retries.times do
+        http_response = http.request request
+        response = JSON.parse(http_response.body)
+        log "http.post response=#{response.pretty_inspect}"
+        response = validate_status(response) if validate_status
+        break unless response == :retry
+        sleep 3
+      end
+      case response
+      when :retry
+        raise Ecobee::HTTPError.new('HTTP.get: retries exhausted')
+      else
+        response
+      end
+    rescue SocketError => msg
+      raise Ecobee::HTTPError.new("HTTP.get SocketError => #{msg}")
+    rescue JSON::ParserError => msg
+      raise Ecobee::HTTPError.new("HTTP.get JSON::ParserError => #{msg}")
+    end
+
+    private
+
+    def http
+      @http ||= Net::HTTP.new(API_HOST, API_PORT)
+      unless @http.active?
+        @http.use_ssl = true
+        Net::HTTP.start(API_HOST, API_PORT)
+      end
+      @http
+    end
+
+    def open_log(log_file)
+      return unless log_file
+      log_file = File.expand_path log_file
+      @log_fh = File.new(log_file, 'a')
+    rescue Exception => msg 
+      raise Ecobee::HTTPError.new("open_log: #{msg}")
+    end
+
+    def validate_status(response)
+      if !response.key? 'status'
+        raise Ecobee::HTTPError.new('Validate Error: Missing Status')
+      elsif !response['status'].key? 'code'
+        raise Ecobee::HTTPError.new('Validate Error: Missing Status Code')
+      elsif response['status']['code'] == 14
+        :retry
+      elsif response['status']['code'] != 0
+        raise Ecobee::HTTPError.new(
+          "Validate Error: (Code #{response['status']['code']}) " +
+          "#{response['status']['message']}"
+        )
+      else
+        response
+      end
+    end
+
+  end
+
+end

data/lib/ecobee/register.rb

@@ -1,12 +1,15 @@
 module Ecobee
 
   class Register
-    attr_reader :expires_at, :result
-
-    def initialize(app_key: nil, scope: SCOPES[0])
-      raise ArgumentError.new('Missing app_key') unless app_key
-      @result = get_pin(app_key: app_key, scope: scope)
-      @expires_at = Time.now.to_i + result['expires_in'] * 60
+    attr_reader :expire, :result
+
+    def initialize(
+      app_key: nil,
+      http: nil,
+      scope: DEFAULT_SCOPE
+    )
+      @result = get_pin(app_key: app_key, http: http, scope: scope)
+      @expire = Time.now.to_i + result['expires_in'] * 60
     end
 
     def code
@@ -25,26 +28,22 @@ module Ecobee
       @result['scope']
     end
 
-    private 
+    private
 
-    def get_pin(app_key: nil, scope: nil)
-      uri_pin = URI(URL_GET_PIN % [app_key, scope.to_s])
-      result = JSON.parse Net::HTTP.get(uri_pin)
+    def get_pin(app_key: nil, http: nil, scope: nil)
+      scope = scope.to_s if scope.is_a? Symbol
+      arg = "?response_type=ecobeePin&client_id=#{app_key}&scope=#{scope}"
+      result = http.get(arg: arg,
+                        no_auth: true,
+                        resource_prefix: 'authorize',
+                        validate_status: false)
       if result.key? 'error'
-        raise Ecobee::TokenError.new(
-          sprintf("Register Error: (%s) %s",
-                  result['error'],
-                  result['error_description'])
+        raise Ecobee::AuthError.new(
+          "Register Error: (#{result['error']}) #{result['error_description']}"
         )
       else
         result
       end
-    rescue SocketError => msg
-      raise Ecobee::TokenError.new("GET failed: #{msg}")
-    rescue JSON::ParserError => msg
-      raise Ecobee::TokenError.new("Parse Error: #{msg}")
-#    rescue Exception => msg
-#      raise Ecobee::TokenError.new("Unknown Error: #{msg}")
     end
 
   end

data/lib/ecobee/thermostat.rb

@@ -24,12 +24,10 @@ module Ecobee
       includeSensors: true
     }
 
-    attr_accessor :client
-    attr_reader :auto_refresh
+    attr_reader :auto_refresh, :http
 
     def initialize(
       auto_refresh: 0,
-      client: nil,
       fake_index: nil,
       index: 0,
       fake_max_index: 0,
@@ -37,9 +35,11 @@ module Ecobee
       selection_args: {},
       token: nil
     )
-      @auto_refresh = auto_refresh
       # TODO: add auto-refresh thread handling
-      @client = client || Ecobee::Client.new(token: token)
+      @auto_refresh = auto_refresh
+
+      raise ArgumentError.new('No token: specified') unless token
+      @http = token.http
       @fake_index = fake_index
       @fake_max_index = fake_max_index
       @index = index
@@ -156,7 +156,7 @@ module Ecobee
     end
 
     def refresh
-      response = @client.get(:thermostat, @selection)
+      response = @http.get(arg: :thermostat, options: @selection)
       if @index + 1 > response['thermostatList'].length
         raise ThermostatError.new('No such thermostat')
       end
@@ -240,7 +240,7 @@ module Ecobee
       body = my_selection
       body.merge!({ 'functions' => functions }) if functions
       body.merge!({ 'thermostat' => thermostat }) if thermostat
-      @client.post(:thermostat, body: body)
+      @http.post(:thermostat, body: body)
     end
 
   end

data/lib/ecobee/token.rb

@@ -5,15 +5,21 @@ module Ecobee
                 :access_token_expire, 
                 :app_key,
                 :callbacks,
+                :http,
                 :pin,
                 :refresh_token,
                 :result,
                 :status,
                 :scope,
+                :token_file,
                 :token_type
 
     #AUTH_ERRORS = %w(slow_down authorization_pending authorization_expired)
-    #VALID_STATUS = [:authorization_pending, :ready]
+
+    @STATUSES = {
+      authorization_pending: 'Registration begun but has not been approved.',
+      ready:                 'Registration approved and valid token received.'
+    }
 
     def initialize(
       access_token: nil,
@@ -33,6 +39,8 @@ module Ecobee
       @token_file = expand_files token_file
 
       @authorization_thread, @pin, @status, @token_type = nil
+      @poll_interval = DEFAULT_POLL_INTERVAL
+      @http = Ecobee::HTTP.new(log_file: "/tmp/token.log", token: self)
 
       @refresh_pad = REFRESH_PAD + rand(REFRESH_PAD)
 
@@ -41,15 +49,33 @@ module Ecobee
     end
 
     def access_token
-      if(@access_token && @access_token_expire && !access_token_expired?)
-        @status = (@refresh_token ? :ready : :authorization_pending)
-        @access_token
-      else
-        refresh_access_token
-      end
+     if @access_token
+       if access_token_expired?
+         if @refresh_token
+           refresh_access_token
+         else
+           token_register 
+         end
+       else
+         desired_status = (@refresh_token ? :ready : :authorization_pending)
+         if @refresh_token
+           if @status != desired_status
+             puts "Status: MISMATCH: #{@status} vs #{desired_status}" if @status
+             @status = desired_status
+           end
+           @access_token
+         else
+           check_for_authorization
+         end
+       end
+     else
+       @status = :authorization_pending
+       token_register 
+     end
     end
 
     def access_token_expired?
+      return true unless @access_token_expire
       Time.now.to_i > @access_token_expire - @refresh_pad
     end
 
@@ -85,27 +111,20 @@ module Ecobee
     end
 
     def refresh_access_token
-      response = Net::HTTP.post_form(
-        URI(URL_TOKEN),
-        'grant_type' => 'refresh_token',
-        'refresh_token' => @refresh_token || 0,
-        'client_id' => @app_key
-      )
-      result = JSON.parse(response.body)
+      arg = sprintf("?grant_type=refresh_token&refresh_token=%s&client_id=%s",
+                    @refresh_token,
+                    @app_key)
+      result = @http.post(arg: arg,
+                          no_auth: true,
+                          resource_prefix: 'token',
+                          validate_status: false)
       if result.key? 'error'
-        if result['error'] == 'invalid_grant'
-          if access_token_expired?
-            register
-          else
-            check_for_authorization
-          end
-        else
-          puts "DUMPING(result): #{result.pretty_inspect}"
-          raise Ecobee::TokenError.new(
-            "Result Error: (%s) %s" % [result['error'],
-                                       result['error_description']]
-          )
-        end
+        @access_token, @access_token_expire, @pin, @scope, @refresh_token = nil
+        config_save
+        raise Ecobee::AuthError.new(
+          "Result Error: (%s) %s" % [result['error'],
+                                     result['error_description']]
+        )
       else
         @access_token = result['access_token']
         @access_token_expire = Time.now.to_i + result['expires_in']
@@ -117,12 +136,6 @@ module Ecobee
         config_save
         @access_token
       end 
-    rescue SocketError => msg
-      raise Ecobee::TokenError.new("POST failed: #{msg}")
-    rescue JSON::ParserError => msg
-      raise Ecobee::TokenError.new("Result parsing: #{msg}")
-#    rescue Exception => msg
-#      raise Ecobee::TokenError.new("Unknown Error: #{msg}")
     end
 
     def register_callback(type, *callback, &block)
@@ -134,8 +147,14 @@ module Ecobee
       end
     end
 
-    def wait
-      sleep 0.05 while @status == :authorization_pending
+    def wait(timeout: nil)
+      if timeout
+        Timeout::timeout(timeout) { wait(timeout: nil) }
+      else
+        sleep 0.01 while @status == :authorization_pending
+      end
+    rescue Timeout::Error
+    ensure
       @status
     end
 
@@ -148,9 +167,10 @@ module Ecobee
         unless @authorization_thread && @authorization_thread.alive?
           @authorization_thread = Thread.new {
             loop do
-              # TODO: consider some intelligent throttling
-              sleep REFRESH_TOKEN_CHECK
+              puts "Sleeping for #{@poll_interval}"
+              sleep @poll_interval
               break if @status == :ready
+              puts "check_for_authorization_single"
               check_for_authorization_single
             end
           }
@@ -159,21 +179,23 @@ module Ecobee
     end
 
     def check_for_authorization_single
-      response = Net::HTTP.post_form(
-        URI(URL_TOKEN),
-        'grant_type' => 'ecobeePin',
-        'code' => @access_token,
-        'client_id' => @app_key
-      )
-      result = JSON.parse(response.body)
+      arg = sprintf("?grant_type=ecobeePin&code=%s&client_id=%s",
+                    @access_token,
+                    @app_key)
+      result = @http.post(arg: arg,
+                          no_auth: true,
+                          resource_prefix: 'token',
+                          validate_status: false)
       if result.key? 'error'
         @status = :authorization_pending
         if result['error'] == 'invalid_client'
-          register 
-        elsif !['slow_down', 'authorization_pending'].include? result['error']
-          # TODO: throttle or just ignore...?
-          pp result
-          raise Ecobee::TokenError.new(
+          token_register 
+        elsif ['slow_down', 'authorization_pending'].include? result['error']
+          nil
+        else
+          @access_token, @access_token_expire, @pin, @scope, @refresh_token = nil
+          config_save
+          raise Ecobee::AuthError.new(
             "Result Error: (%s) %s" % [result['error'],
                                        result['error_description']]
           )
@@ -189,12 +211,6 @@ module Ecobee
         config_save
         @access_token
       end
-    rescue SocketError => msg
-      raise Ecobee::TokenError.new("POST failed: #{msg}")
-    rescue JSON::ParserError => msg
-      raise Ecobee::TokenError.new("Result parsing: #{msg}")
-#    rescue Exception => msg
-#      raise Ecobee::TokenError.new("Unknown Error: #{msg}")
     end
 
     def config_load_to_memory(config)
@@ -246,7 +262,7 @@ module Ecobee
         File.open(file, 'r').read(16 * 1024)
       )
     rescue JSON::ParserError => msg
-      raise Ecobee::TokenError.new("Result parsing: #{msg}")
+      raise Ecobee::AuthError.new("Result parsing: #{msg}")
     rescue Errno::ENOENT
       {}
     end
@@ -295,21 +311,22 @@ module Ecobee
       end
     end
 
-    def register
+    def token_register
       @status = :authorization_pending
-      result = Register.new(app_key: @app_key, scope: @scope)
+      result = Ecobee::Register.new(app_key: @app_key,
+                                    http: @http,
+                                    scope: @scope)
+      @poll_interval = result.interval
       @pin = result.pin
       @access_token = result.code
-      @access_token_expire = result.expires_at
+      @access_token_expire = result.expire
       @refresh_token = nil
       @scope = result.scope
       check_for_authorization
       config_save
-      @access_token if @status == :ready
+      @access_token
     end
 
   end
 
-  class TokenError < StandardError ; end
-
 end

data/lib/ecobee/version.rb

@@ -1,3 +1,3 @@
 module Ecobee
-  VERSION = "0.2.3"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ecobee
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.0
 platform: ruby
 authors:
 - Rob Zwissler
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-08-18 00:00:00.000000000 Z
+date: 2016-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -75,7 +75,7 @@ files:
 - examples/test_thermostat_object.rb
 - examples/test_token.rb
 - lib/ecobee.rb
-- lib/ecobee/client.rb
+- lib/ecobee/http.rb
 - lib/ecobee/register.rb
 - lib/ecobee/thermostat.rb
 - lib/ecobee/token.rb

data/lib/ecobee/client.rb

@@ -1,75 +0,0 @@
-module Ecobee
-
-  class Client
-    def initialize(token: nil)
-      raise ArgumentError.new('Missing token') unless token
-      @token = token
-    end
-
-    def get(arg, options = nil)
-      new_uri = URL_API + arg.to_s.sub(/^\//, '')
-      new_uri += '?json=' + options.to_json if options
-      request = Net::HTTP::Get.new(URI(URI.escape(new_uri)))
-      request['Content-Type'] = *CONTENT_TYPE
-      request['Authorization'] = @token.authorization
-      http_response = http.request request
-      response = validate_status JSON.parse(http_response.body)
-#      if response == :retry
-#        get(arg, options)
-#      else
-#        response
-#      end
-    rescue JSON::ParserError => msg
-      raise ClientError.new("JSON::ParserError => #{msg}")
-    end
-
-    def post(arg, options: {}, body: nil)
-      new_uri = URL_API + arg.to_s.sub(/^\//, '')
-      request = Net::HTTP::Post.new(URI new_uri)
-      request.set_form_data({ 'format' => 'json' }.merge(options))
-      request.body = JSON.generate(body) if body
-      request['Content-Type'] = *CONTENT_TYPE
-      request['Authorization'] = @token.authorization
-      http_response = http.request request
-      response = validate_status JSON.parse http_response.body
-#      if response == :retry
-#        post(arg, options: options, body: body)
-#      else
-#        response
-#      end
-    rescue JSON::ParserError => msg
-      raise ClientError.new("JSON::ParserError => #{msg}")
-    end
-
-    def validate_status(response)
-      if !response.key? 'status'
-        raise ClientError.new('Missing Status')
-      elsif !response['status'].key? 'code'
-        raise ClientError.new('Missing Status Code')
-      elsif response['status']['code'] == 14 
-        :retry
-      elsif response['status']['code'] != 0
-        raise ClientError.new(
-          "GET Error: #{response['status']['code']} " +
-          "Message: #{response['status']['message']}"
-        )
-      else
-        response
-      end
-    end
-
-    private
-
-    def http
-      @http ||= Net::HTTP.new(API_HOST, API_PORT)
-      unless @http.active? 
-        @http.use_ssl = true
-        Net::HTTP.start(API_HOST, API_PORT)
-      end
-      @http
-    end
-  end
-
-  class ClientError < StandardError ; end
-
-end