ecobee 0.1.6 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 50df9ac248431f92cafec6438d42aa0bb04d964f
-  data.tar.gz: 1928432f79c576e9d6f88a04a00a5a8a8ca1d511
+  metadata.gz: f15c138cad29178c3935acfdffc88446ca994d35
+  data.tar.gz: 58581cf67d84e8e0e43b83b2375069aa70d41a9b
 SHA512:
-  metadata.gz: dd700da725bca1f2b2cd79e371cbc14e9b8a85b2852c2433852d473fc561ec39b67a6dc90d454ef8235fc55a5fdb1945044535a14257a4ce5a6cdd627a2f13bb
-  data.tar.gz: d06a3c81087115ef8d741c749bcc99ea52efd0cc668c2543f10c4b524bfec85ac65c4dfb715a62b327136e4c536f834133207e120aee6246f24ba4cefac05a63
+  metadata.gz: 6cb824a3793ecd6582479f00c94fad5d3819d4a7da373abdadbed6fdf7bb108a9072e7091780fb6f42842d60c648e827750a53e4a77c9455d3b59bc09faf325d
+  data.tar.gz: 5f8afab66b9bb155caf5b6f4691a72a8ada13765cfe64d3f83555bfcd910473d6f9d51115d87e81fbb8804593f90ed17d5f01c5ef0ecc04cd06c2d994358e9ed

data/ecobee.gemspec

@@ -19,6 +19,8 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.required_ruby_version = '>= 2.0.0'
+
   spec.add_development_dependency "bundler", "~> 1.12"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"

data/examples/set_mode.rb

@@ -4,7 +4,9 @@
 # to change the mode.       -- @robzr
 
 require 'pp'
-require 'ecobee'
+
+#require 'ecobee'
+require_relative '../lib/ecobee.rb'
 
 @hvac_modes = Ecobee::HVAC_MODES + ['quit']
 
@@ -14,7 +16,7 @@ class TestFunctions
   end
 
   def print_summary
-    http_response = @client.get(
+    response = @client.get(
       'thermostat', 
       { 
         'selection' => {
@@ -25,7 +27,6 @@ class TestFunctions
         }
       }
     )
-    response = JSON.parse(http_response.body)
 
     puts "Found %d thermostats." % response['thermostatList'].length
 
@@ -42,7 +43,7 @@ class TestFunctions
   end
 
   def update_mode(mode)
-    http_response = @client.post(
+    @client.post(
       'thermostat', 
       body: { 
         'selection' => {
@@ -56,18 +57,16 @@ class TestFunctions
         }
       }
     )
-    response = JSON.parse(http_response.body)
   end
 end
 
 token = Ecobee::Token.new(
   app_key: ENV['ECOBEE_APP_KEY'],
-  app_name: 'set_mode',
-  scope: :smartWrite,
-  token_file: '~/.ecobee_token'
+  app_name: 'ecobee-gem'
 )
 
-puts token.pin_message if token.pin token.wait 
+puts token.pin_message if token.pin
+token.wait 
 test_functions = TestFunctions.new(
   Ecobee::Client.new(token: token)
 )

data/examples/test_token.rb

@@ -3,14 +3,11 @@
 # Refreshes token; displays details on saved token.  -- @robzr
 
 require 'pp'
-require 'ecobee'
-require_relative '/Users/robzr/GitHub/ecobee/lib/ecobee/token.rb'
-require_relative '/Users/robzr/GitHub/ecobee/lib/ecobee/register.rb'
+require_relative '../lib/ecobee.rb'
 
 token = Ecobee::Token.new(
-  app_key: ENV['ECOBEE_API_KEY'],
-  app_name: 'ecobee-gem',
-  token_file: '~/.ecobee_token'
+  app_key: ENV['ECOBEE_APP_KEY'],
+  app_name: 'ecobee-gem'
 )
 
 puts token.pin_message if token.pin
@@ -18,6 +15,6 @@ token.wait
 
 puts "Access Token: #{token.access_token}"
 puts "Refresh Token: #{token.refresh_token}"
-puts "Expires At: #{token.expires_at}"
+puts "Expires At: #{token.access_expires_at}"
 puts "Scope: #{token.scope}"
 puts "Type: #{token.type}"

data/lib/ecobee.rb

@@ -2,31 +2,33 @@ require 'pp'
 require 'json'
 require 'net/http'
 
-require "ecobee/client"
-require "ecobee/register"
-require "ecobee/token"
-require "ecobee/version"
+require 'ecobee/client'
+require 'ecobee/register'
+require 'ecobee/token'
+require 'ecobee/version'
+#require_relative 'ecobee/client'
+#require_relative 'ecobee/register'
+#require_relative 'ecobee/token'
+#require_relative 'ecobee/version'
 
 module Ecobee
   API_HOST = 'api.ecobee.com'
   API_PORT = 443
   CONTENT_TYPE = ['application/json', { 'charset' => 'UTF-8' }]
-
+  DEFAULT_FILES = [
+    '~/Library/Mobile Documents/com~apple~CloudDocs/.ecobee_token',
+    '~/.ecobee_token'
+  ]
   HVAC_MODES = ['auto', 'auxHeatOnly', 'cool', 'heat', 'off']
-
-  REFRESH_INTERVAL_PAD = 60
+  REFRESH_INTERVAL_PAD = 120
   REFRESH_TOKEN_CHECK = 10 
-
-  SCOPES = [:smartRead, :smartWrite]
-  
+  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"
 
-
   def self.Model(model)
     { 'idtSmart'    => 'ecobee Smart',
       'idtEms'      => 'ecobee Smart EMS',

data/lib/ecobee/client.rb

@@ -14,7 +14,10 @@ module Ecobee
       request = Net::HTTP::Get.new(URI(URI.escape(new_uri)))
       request['Content-Type'] = *CONTENT_TYPE
       request['Authorization'] = @token.authorization
-      http.request(request)
+      http_response = http.request request
+      validate_status JSON.parse(http_response.body)
+    rescue JSON::ParserError => msg
+      raise ClientError.new("JSON::ParserError => #{msg}")
     end
 
     def post(arg, options: {}, body: nil)
@@ -24,7 +27,25 @@ module Ecobee
       request.body = JSON.generate(body) if body
       request['Content-Type'] = *CONTENT_TYPE
       request['Authorization'] = @token.authorization
-      http.request(request)
+      http_response = http.request request
+      validate_status JSON.parse http_response.body
+    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'] != 0
+        raise ClientError.new(
+          "GET Error: #{response['status']['code']} " +
+          "Message: #{response['status']['message']}"
+        )
+      else
+        response
+      end
     end
 
     private
@@ -40,4 +61,6 @@ module Ecobee
 
   end
 
+  class ClientError < StandardError ; end
+
 end

data/lib/ecobee/register.rb

@@ -44,6 +44,7 @@ module Ecobee
     rescue Exception => msg
       raise Ecobee::TokenError.new("Unknown Error: #{msg}")
     end
+
   end
 
 end

data/lib/ecobee/token.rb

@@ -2,8 +2,8 @@ module Ecobee
   require 'date' 
 
   class Token
-    attr_reader :access_token, 
-                :expires_at, 
+    attr_reader :access_expires_at, 
+                :access_token, 
                 :pin,
                 :pin_message,
                 :refresh_token,
@@ -13,22 +13,28 @@ module Ecobee
                 :type
 
     def initialize(
-      app_key: nil, 
+      access_expires_at: nil,
+      access_token: nil,
+      app_key: nil,
       app_name: nil,
       code: nil,
       refresh_token: nil,
       scope: SCOPES[0],
-      token_file: nil
+      token_file: DEFAULT_FILES
     )
+      @access_expires_at = access_expires_at
+      @access_token = access_token
       @app_key = app_key
       @app_name = app_name
       @code = code
-      @access_token, @code_expires_at, @expires_at, @pin, @type = nil
       @refresh_token = refresh_token
       @scope = scope
-      @status = :authorization_pending
-      @token_file = File.expand_path(token_file)
-      parse_token_file unless @refresh_token
+      @token_file = expand_files token_file
+
+      @code_expires_at, @pin, @type = nil
+      parse_token_file
+      @status = @refresh_token ? :ready : :authorization_pending
+
       if @refresh_token
         refresh
       else
@@ -39,7 +45,7 @@ module Ecobee
     end
 
     def access_token
-      refresh if Time.now + REFRESH_INTERVAL_PAD > @expires_at
+      refresh
       @access_token
     end
 
@@ -61,6 +67,7 @@ module Ecobee
     end
 
     def refresh
+      return if Time.now.to_i + REFRESH_INTERVAL_PAD < @access_expires_at
       response = Net::HTTP.post_form(
         URI(URL_TOKEN),
         'grant_type' => 'refresh_token',
@@ -69,14 +76,14 @@ module Ecobee
       )
       result = JSON.parse(response.body)
       if result.key? 'error'
-#        pp result
+        pp result
         raise Ecobee::TokenError.new(
           "Result Error: (%s) %s" % [result['error'],
                                      result['error_description']]
         )
       else
         @access_token = result['access_token']
-        @expires_at = Time.now + result['expires_in']
+        @access_expires_at = Time.now.to_i + result['expires_in']
         @refresh_token = result['refresh_token']
         @pin, @code, @code_expires_at = nil
         @scope = result['scope']
@@ -120,7 +127,7 @@ module Ecobee
         @status = :ready
         @access_token = result['access_token']
         @type = result['token_type']
-        @expires_at = Time.now + result['expires_in']
+        @access_expires_at = Time.now.to_i + result['expires_in']
         @refresh_token = result['refresh_token']
         @scope = result['scope']
         @pin, @code, @code_expires_at = nil
@@ -134,6 +141,14 @@ module Ecobee
       raise Ecobee::TokenError.new("Unknown Error: #{msg}")
     end
 
+    def expand_files(token_file)
+      if token_file.is_a? Array
+        token_file.map { |tf| File.expand_path tf }
+      else
+        expand_files [token_file]
+      end
+    end
+
     def launch_monitor_thread
       Thread.new {
         loop do
@@ -145,34 +160,41 @@ module Ecobee
     end
 
     def parse_token_file
-#puts "Before Parse: app_key:#{@app_key} refresh_token:#{@refresh_token} pin:#{pin}"
-      return unless (config = read_token_file).is_a? Hash
-      section = (@app_name && config.key?(@app_name)) ? @app_name : @app_key
-      if config.key?(section)
-        @app_key ||= if config[section].key?('app_key') 
-                       config[section]['app_key']
-                     else
-                       @app_name
-                     end
-        if config[section].key?('refresh_token')
-          @refresh_token ||= config[section]['refresh_token']
-        elsif config[section].key?('pin')
-          @pin ||= config[section]['pin']
-          @code ||= config[section]['code']
-          @code_expires_at ||= config[section]['code_expires_at'].to_i
-        end
+      return unless (all_config = read_token_file).is_a? Hash
+      section = (@app_name && all_config.key?(@app_name)) ? @app_name : @app_key
+      return unless all_config.key?(section)
+      config = all_config[section]
+      @app_key ||= config.key?('app_key') ? config['app_key'] : @app_name
+      if config.key?('refresh_token')
+        @access_expires_at ||= config['access_expires_at'].to_i
+        @access_token ||= config['access_token']
+        @refresh_token ||= config['refresh_token']
+        @scope ||= config['scope']
+        @type ||= config['token_type']
+      elsif config.key?('pin')
+        @code ||= config['code']
+        @code_expires_at ||= config['code_expires_at'].to_i
+        @pin ||= config['pin']
       end
-#puts "After Parse: app_key:#{@app_key} refresh_token:#{@refresh_token} pin:#{pin}"
     end
 
-    def read_token_file
+    def read_json_file(file)
       JSON.parse(
-        File.open(@token_file, 'r').read(16 * 1024)
+        File.open(file, 'r').read(16 * 1024)
       )
+    rescue JSON::ParserError => msg
+      raise Ecobee::TokenError.new("Result parsing: #{msg}")
     rescue Errno::ENOENT
       {}
     end
 
+    def read_token_file
+      @token_file.each do |tf|
+         result = read_json_file(tf)
+         return result if result.length > 0
+      end
+    end
+
     def register
       result = Register.new(app_key: @app_key, scope: @scope)
       @pin = result.pin
@@ -184,7 +206,12 @@ module Ecobee
     end
 
     def write_token_file
-      return unless @token_file
+      @token_file.each do |file|
+        return if write_json_file file
+      end
+    end
+
+    def write_json_file(file)
       if config = read_token_file
         config.delete(@app_name)
         config.delete(@app_key)
@@ -193,15 +220,22 @@ module Ecobee
       config[section] = {}
       config[section]['app_key'] = @app_key if @app_key && section != @app_key
       if @refresh_token
+        config[section]['access_token'] = @access_token 
+        config[section]['access_expires_at'] = @access_expires_at
         config[section]['refresh_token'] = @refresh_token 
+        config[section]['token_type'] = @type
+        config[section]['scope'] = @scope
       elsif @pin
         config[section]['pin'] = @pin
         config[section]['code'] = @code
         config[section]['code_expires_at'] = @code_expires_at
       end
-      File.open(@token_file, 'w') do |tf|
+      File.open(file, 'w') do |tf|
         tf.puts JSON.pretty_generate(config)
       end
+      true
+    rescue Errno::ENOENT
+      nil
     end
 
   end

data/lib/ecobee/version.rb

@@ -1,3 +1,3 @@
 module Ecobee
-  VERSION = "0.1.6"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ecobee
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.2.0
 platform: ruby
 authors:
 - Rob Zwissler
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-08-06 00:00:00.000000000 Z
+date: 2016-08-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -70,7 +70,6 @@ files:
 - bin/console
 - bin/setup
 - ecobee.gemspec
-- examples/bitbar_plugin.rb
 - examples/set_mode.rb
 - examples/test_token.rb
 - lib/ecobee.rb
@@ -90,7 +89,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/examples/bitbar_plugin.rb

@@ -1,252 +0,0 @@
-#!/usr/bin/env ruby
-#
-# Allows for display and control of your Ecobee in the Mac OS X 
-# menubar, using BitBar (http://getbitbar.com).   -- @robzr
-#
-# <bitbar.title>EcobeeStat</bitbar.title>
-# <bitbar.version>v1.0</bitbar.version>
-# <bitbar.author>Rob Zwissler</bitbar.author>
-# <bitbar.author.github>robzr</bitbar.author.github>
-# <bitbar.desc>Ecobee Thermostat Control</bitbar.desc>
-# <bitbar.image>http://github.com/robzr/ecobee</bitbar.image>
-# <bitbar.dependencies>ruby</bitbar.dependencies>
-# <bitbar.abouturl>http://github.com/robzr/ecobee</bitbar.abouturl>
-
-require 'pp'
-require 'ecobee'
-#require_relative '/Users/robzr/GitHub/ecobee/lib/ecobee.rb'
-#require_relative '/Users/robzr/GitHub/ecobee/lib/ecobee/client.rb'
-#require_relative '/Users/robzr/GitHub/ecobee/lib/ecobee/token.rb'
-#require_relative '/Users/robzr/GitHub/ecobee/lib/ecobee/register.rb'
-
-API_KEY = 'u2Krw0OumeliB0OnwiaogySvgExhy2K4'
-HVAC_MODES = ['auto', 'auxHeatOnly', 'cool', 'heat', 'off', 'quit']
-DEG = '°'
-
-module Ecobee
-  class ResponseError < StandardError ; end
-
-  class BitBar
-    def initialize(client)
-      @client = client
-    end
-
-    def get_thermostat(args = {})
-      index = args.delete(:index) || 0
-      http_response = @client.get('thermostat', 
-                                  Ecobee::Selection(args))
-      response = JSON.parse(http_response.body)
-      get_thermostat_list_index(index: index,
-                                response: validate_status(response))
-    rescue JSON::ParserError => msg
-      raise ResponseError.new("JSON::ParserError => #{msg}")
-    end
-
-    def get_thermostat_list_index(index: 0, response: nil)
-      if !response.key? 'thermostatList'
-        raise ResponseError.new('Missing thermostatList')
-      elsif index >= response['thermostatList'].length
-        raise ResponseError.new(
-          "Missing thermostatList Index #{index} (Max Found: " +
-          "#{response['thermostatList'].length - 1})"
-        )
-      else
-        response['thermostatList'][index]
-      end
-    end
-
-    def validate_status(response)
-      if !response.key? 'status'
-        raise ResponseError.new('Missing Status') 
-      elsif !response['status'].key? 'code'
-        raise ResponseError.new('Missing Status Code') 
-      elsif response['status']['code'] != 0
-        raise ResponseError.new(
-          "GET Error: #{response['status']['code']} " +
-          "Message: #{response['status']['message']}"
-        )
-      else
-        response
-      end
-    end
-
-#      puts "Heat: #{info['runtime']['desiredHeat'] / 10}#{DEG} | color=red"
-
-    def set_hold(cool_hold: nil, heat_hold: nil)
-      functions = [{
-        'type' => 'setHold',
-        'params' => {
-          'holdType' => 'nextTransition',
-        }
-      }]
-      functions[0]['params']['coolHoldTemp'] = cool_hold
-      functions[0]['params']['heatHoldTemp'] = heat_hold
-      http_response = @client.post(
-        'thermostat', 
-        body: { 
-          'selection' => {
-            'selectionType' => 'registered',
-            'selectionMatch' => '',
-          },
-          'functions' => functions
-        }
-      )
-      response = JSON.parse(http_response.body)
-    end
-
-    def update_mode(mode)
-      http_response = @client.post(
-        'thermostat', 
-        body: { 
-          'selection' => {
-            'selectionType' => 'registered',
-            'selectionMatch' => '',
-          },
-          'thermostat' => {
-            'settings' => {
-              'hvacMode' => mode
-            }
-          }
-        }
-      )
-      response = JSON.parse(http_response.body)
-    end
-  end
-end
-
-def header(info)
-  puts "#{info['runtime']['actualTemperature'] / 10.0}#{DEG}"
-  puts '---'
-end
-
-def cool_menu(info)
-  present_mode = info['settings']['hvacMode']
-  return unless ['auto', 'cool'].include? present_mode
-  puts "Cool: #{info['runtime']['desiredCool'] / 10}#{DEG} | color=blue"
-  cool_low = info['settings']['coolRangeLow'] / 10
-  cool_high = info['settings']['coolRangeHigh'] / 10
-  (cool_low..cool_high).reverse_each do |temp|
-    flag, color = ''
-    flag = ' :arrow_left:' if temp == info['runtime']['actualTemperature'] / 10
-    color = ' color=blue' if temp == info['runtime']['desiredCool'] / 10
-    puts("--#{temp}#{DEG}#{flag}|#{color} bash=\"#{$0}\" " +
-         "param1=\"set_cool=#{temp}\" refresh=true terminal=false")
-  end
-end
-
-def heat_menu(info)
-  present_mode = info['settings']['hvacMode']
-  return unless ['auto', 'auxHeatOnly', 'heat'].include? present_mode
-  puts "Heat: #{info['runtime']['desiredHeat'] / 10}#{DEG} | color=red"
-  heat_low = info['settings']['heatRangeLow'] / 10
-  heat_high = info['settings']['heatRangeHigh'] / 10
-  (heat_low..heat_high).reverse_each do |temp|
-    flag, color = ''
-    flag = ' :arrow_left:' if temp == info['runtime']['actualTemperature'] / 10
-    color = ' color=red' if temp == info['runtime']['desiredHeat'] / 10
-    puts("--#{temp}#{DEG}#{flag}|#{color} bash=\"#{$0}\" " +
-         "param1=\"set_heat=#{temp}\" refresh=true terminal=false")
-  end
-end
-
-def mode_menu(info)
-  puts "Mode: #{info['settings']['hvacMode']}"
-  Ecobee::HVAC_MODES.reject { |mode| mode == info['settings']['hvacMode'] }
-    .each do |mode|
-      puts("--#{mode} | bash=\"#{$0}\" param1=\"set_mode=#{mode}\" " +
-           "refresh=true terminal=false")
-  end
-end
-
-def separator
-  puts '---'
-end
-
-def stat_info(info)
-  puts info['name'] 
-  info['remoteSensors'].each do |sensor|
-    temp = sensor['capability'].select do |cap|
-      cap['type'] == 'temperature'
-    end
-    temp = temp[0]['value'].to_i / 10.0
-    puts "--#{sensor['name']}: #{temp}#{DEG}"
-  end
-  puts "#{info['brand']} #{Ecobee::Model(info['modelNumber'])}"
-  puts "Status: #{info['equipmentStatus']}"
-end
-
-def website
-  puts 'Ecobee Web Portal|href="https://www.ecobee.com/consumerportal/index.html"'
-end
-
-token = Ecobee::Token.new(
-  app_key: API_KEY, app_name: API_KEY,
-  scope: :smartWrite,
-  token_file: '~/.ecobee_token'
-)
-if token.pin
-  puts "Ecobee | color=red"
-  puts "---"
-  puts "Registration Needed | color=red"
-  puts "---"
-  puts 'Login to Ecobee | href=\'https://www.ecobee.com/consumerportal/index.html\''
-  puts 'Select \'My Apps\' from the drop-down menu'
-  puts 'Press the \'Add Application\' button'
-  puts "Enter authorization code: #{token.pin}"
-  exit
-end
-
-ecobar = Ecobee::BitBar.new Ecobee::Client.new(token: token)
-
-case arg = ARGV.shift 
-when /^dump/
-  pp ecobar.get_thermostat(
-    :includeRuntime => true,
-    :includeExtendedRuntime => true,
-    :includeElectricity => true,
-    :includeSettings => true,
-    :includeLocation => true,
-    :includeProgram => true,
-    :includeEvents => true,
-    :includeDevice => true,
-    :includeTechnician => true,
-    :includeUtility => true,
-    :includeAlerts => true,
-    :includeWeather => true,
-    :includeOemConfig => true,
-    :includeEquipmentStatus => true,
-    :includeNotificationSettings => true,
-    :includeVersion => true,
-    :includeSensors => true
-  )
-when /^set_mode=/
-  mode = arg.sub(/^.*=/, '')
-  ecobar.update_mode mode
-when /^set_cool=/
-  info = ecobar.get_thermostat(includeRuntime: true,
-                               includeSettings: true)
-  cool_hold = arg.sub(/^.*=/, '').to_i * 10
-  heat_hold = info['runtime']['desiredHeat']
-
-  ecobar.set_hold(cool_hold: cool_hold, heat_hold: heat_hold)
-when /^set_heat=/
-  info = ecobar.get_thermostat(includeRuntime: true,
-                               includeSettings: true)
-  cool_hold = info['runtime']['desiredCool']
-  heat_hold = arg.sub(/^.*=/, '').to_i * 10
-
-  ecobar.set_hold(cool_hold: cool_hold, heat_hold: heat_hold)
-else
-  info = ecobar.get_thermostat(includeRuntime: true,
-                               includeSettings: true,
-                               includeEquipmentStatus: true,
-                               includeSensors: true)
-  header info
-  cool_menu info
-  heat_menu info
-  separator
-  stat_info info
-  mode_menu info
-  separator
-  website
-end