ecobee 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 33dcdf5851524cede3343a450c2af5914571141b
+  data.tar.gz: 4d142c7539b33ab29a1c019831d64e600786597c
+SHA512:
+  metadata.gz: f6372f328df92b21c7da563126019b7f61e663fac9d28c933def8b9e6706aad77422f9c3a6a76c2a8e7fa82e343156c717c0491879f8da031c76ce9c4f033ce4
+  data.tar.gz: 770ce9ccde8db9ad2575e5ecc0e2fe7cf2b23870297e3a1c7265439cdd8980ff4da37e22cf3f4b39ad349d81b041b0121235ca0b8bd3131da5a32a02f67776b7

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.sw[p-z]
+.*.sw[p-z]

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.12.5

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ecobee.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Rob Zwissler
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,38 @@
+# Ecobee
+
+Ecobee API Ruby Gem.  Handles OAuth PIN-based token registration & renewal, and methods for working with Ecobee GET & PUSH.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ecobee'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ecobee
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/robzr/ecobee.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ecobee"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/ecobee.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ecobee/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ecobee"
+  spec.version       = Ecobee::VERSION
+  spec.authors       = ["Rob Zwissler"]
+  spec.email         = ["rob@zwissler.org"]
+
+  spec.summary       = %q{Ecobee API - token registration, persistent HTTP GET/PUSH }
+  spec.description   = %q{Implements Ecobee API with PIN-based token registration & renewal, persistent HTTP connections }
+  spec.homepage      = "https://github.com/robzr/ecobee"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/examples/set_mode.rb

@@ -0,0 +1,93 @@
+#!/usr/bin/env ruby
+
+require 'pp'
+require_relative '../lib/ecobee'
+
+HVAC_MODES = ['auto', 'auxHeatOnly', 'cool', 'heat', 'off', 'quit']
+
+class TestFunctions
+  def initialize(client)
+    @client = client
+  end
+
+  def print_summary
+    http_response = @client.get(
+      'thermostat', 
+      { 
+        'selection' => {
+          'selectionType' => 'registered',
+          'selectionMatch' => '', 
+          'includeEquipmentStatus' => 'true',
+          'includeSettings' => 'true'
+        }
+      }
+    )
+    response = JSON.parse(http_response.body)
+
+    puts "Found %d thermostats." % response['thermostatList'].length
+
+    response['thermostatList'].each do |stat|
+      printf(
+        " -> %s (%s %s) Mode: %s Status: %s\n",
+        stat['name'],
+        stat['brand'],
+        Ecobee::Model(stat['modelNumber']),
+        stat['settings']['hvacMode'],
+        stat['equipmentStatus']
+      )
+    end
+  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
+
+
+token = Ecobee::Token.new(
+  api_key: ENV['ECOBEE_API_KEY'],
+  scope: :smartWrite,
+  token_file: '~/.ecobee_token'
+)
+
+puts token.pin_message if token.pin
+token.wait
+
+test_functions = TestFunctions.new(Ecobee::Client.new(token: token))
+
+loop do
+  test_functions.print_summary
+
+  answer = -1
+  while !answer.between?(0, HVAC_MODES.length)
+    puts
+    (1..HVAC_MODES.length).each do |num|
+      printf "%d) %s\n", num, HVAC_MODES[num - 1]
+    end
+    print "Enter mode: "
+    answer = gets.to_i - 1
+    abort if answer == (HVAC_MODES.length - 1)
+  end
+  puts
+
+  result = test_functions.update_mode(HVAC_MODES[answer])
+
+  unless result.key?('status') && (result['status']['code'] == 0)
+    puts "Unknown result: #{result.to_s}\n" 
+  end
+end

data/examples/test_token.rb

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby
+
+require 'pp'
+
+#require 'ecobee'
+require_relative '../lib/ecobee'
+
+token = Ecobee::Token.new(
+  api_key: ENV['ECOBEE_API_KEY'],
+  token_file: '~/.ecobee_token'
+)
+
+puts token.pin_message if token.pin
+token.wait
+
+puts "Access Token: #{token.access_token}"
+puts "Refresh Token: #{token.refresh_token}"
+puts "Expires At: #{token.expires_at}"
+puts "Scope: #{token.scope}"
+puts "Type: #{token.type}"

data/lib/ecobee.rb

@@ -0,0 +1,62 @@
+require 'pp'
+require 'json'
+require 'net/http'
+
+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_APP_NAME = 'ecobee-gem'
+
+  REFRESH_INTERVAL_PAD = 60
+  REFRESH_TOKEN_CHECK = 10 
+
+  SCOPES = [:smartRead, :smartWrite]
+  
+  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',
+      'siSmart'     => 'ecobee Si Smart',
+      'siEms'       => 'ecobee Si EMS',
+      'athenaSmart' => 'ecobee3 Smart',
+      'athenaEms'   => 'ecobee3 EMS',
+      'corSmart'    => 'Carrier or Bryant Cor',
+    }[model] || 'Unknown'
+  end
+
+  def self.ResponseCode(code)
+    {  0 => 'Success',
+       1 => 'Authentication failed.', 
+       2 => 'Not authorized.',
+       3 => 'Processing error.',
+       4 => 'Serialization error.',
+       5 => 'Invalid request format.',
+       6 => 'Too many thermostat in selection match criteria.',
+       7 => 'Validation error.',
+       8 => 'Invalid function.',
+       9 => 'Invalid selection.',
+      10 => 'Invalid page.',
+      11 => 'Function error.',
+      12 => 'Post not supported for request.',
+      13 => 'Get not supported for request.',
+      14 => 'Authentication token has expired. Refresh your tokens.',
+      15 => 'Duplicate data violation.',
+      16 => 'Invalid token. Token has been deauthorized by user. You must ' +
+            're-request authorization.'
+    }[core] || 'Unknown Error.'
+  end
+
+end
+

data/lib/ecobee/client.rb

@@ -0,0 +1,42 @@
+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.sub(/^\//, '')
+      new_uri += '?json=' + options.to_json if options
+      request = Net::HTTP::Get.new(URI new_uri)
+      request['Content-Type'] = *CONTENT_TYPE
+      request['Authorization'] = @token.authorization
+      http.request(request)
+    end
+
+    def post(arg, options: {}, body: nil)
+      new_uri = URL_API + arg.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.request(request)
+    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
+
+end

data/lib/ecobee/register.rb

@@ -0,0 +1,47 @@
+module Ecobee
+
+  class Register
+    attr_reader :result
+
+    def initialize(api_key: nil, scope: SCOPES[0])
+      raise ArgumentError.new('Missing api_key') unless api_key
+
+      @result = get_pin(api_key: api_key, scope: scope)
+    end
+
+    def code
+      @result['code']
+    end
+
+    def interval
+      @result['interval']
+    end
+
+    def pin
+      @result['ecobeePin']
+    end
+
+    private 
+
+    def get_pin(api_key: nil, scope: nil)
+      uri_pin = URI(URL_GET_PIN % [api_key, scope.to_s])
+      result = JSON.parse Net::HTTP.get(uri_pin)
+      if result.key? 'error'
+        raise Ecobee::RegisterError.new(
+          "Result Error: (%s) %s" % [result['error'], result['error_description']]
+        )
+      end
+      result
+    rescue SocketError => msg
+      raise Ecobee::RegisterError.new("GET failed: #{msg}")
+    rescue JSON::ParserError => msg
+      raise Ecobee::RegisterError.new("Result parsing: #{msg}")
+    rescue Exception => msg
+      raise Ecobee::RegisterError.new("Unknown Error: #{msg}")
+    end
+  end
+
+  class RegisterError < StandardError
+  end
+
+end

data/lib/ecobee/token.rb

@@ -0,0 +1,169 @@
+module Ecobee
+
+  class Token
+    attr_reader :access_token, 
+                :expires_at, 
+                :pin,
+                :pin_message,
+                :refresh_token,
+                :result,
+                :status,
+                :scope,
+                :type
+
+    def initialize(
+      api_key: nil, 
+      app_name: DEFAULT_APP_NAME,
+      code: nil,
+      refresh_token: nil,
+      scope: SCOPES[0],
+      token_file: nil
+    )
+      @api_key = api_key
+      @app_name = app_name
+      @code = code
+      @access_token, @expires_at, @pin, @type = nil
+      @refresh_token = refresh_token
+      @scope = scope
+      @status = :authorization_pending
+      @token_file = File.expand_path(token_file)
+      read_token_file unless @refresh_token
+      if @refresh_token
+        refresh
+      else
+        register unless code
+        check_for_token
+        launch_monitor_thread unless @status == :ready
+      end
+    end
+
+    def access_token
+      refresh if Time.now + REFRESH_INTERVAL_PAD > @expires_at
+      @access_token
+    end
+
+    def authorization
+      "#{@type} #{@access_token}"
+    end
+
+    def pin_message
+      "Log into Ecobee web portal, select My Apps widget, Add Application, " +
+      "enter the PIN #{@pin || ''}"
+    end
+
+    def refresh
+      response = Net::HTTP.post_form(
+        URI(URL_TOKEN),
+        'grant_type' => 'refresh_token',
+        'refresh_token' => @refresh_token,
+        'client_id' => @api_key
+      )
+      result = JSON.parse(response.body)
+      if result.key? 'error'
+#        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']
+        @refresh_token = result['refresh_token']
+        @scope = result['scope']
+        @type = result['token_type']
+        @status = :ready
+        write_token_file
+      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 wait
+      sleep 0.05 while @status == :authorization_pending
+      @status
+    end
+
+    private
+
+    def check_for_token
+      response = Net::HTTP.post_form(
+        URI(URL_TOKEN),
+        'grant_type' => 'ecobeePin',
+        'code' => @code,
+        'client_id' => @api_key
+      )
+      result = JSON.parse(response.body)
+      if result.key? 'error'
+        unless ['slow_down', 'authorization_pending'].include? result['error']
+pp result
+          raise Ecobee::TokenError.new(
+            "Result Error: (%s) %s" % [result['error'],
+                                       result['error_description']]
+          )
+        end
+      else
+        @status = :ready
+        @access_token = result['access_token']
+        @type = result['token_type']
+        @expires_at = Time.now + result['expires_in']
+        @refresh_token = result['refresh_token']
+        @scope = result['scope']
+        write_token_file
+      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 launch_monitor_thread
+      Thread.new {
+        loop do
+          sleep REFRESH_TOKEN_CHECK
+          break if @status == :ready
+          check_for_token 
+        end
+      }
+    end
+
+    def read_token_file
+      tf = File.open(@token_file, 'r').read(16 * 1024)
+      config = JSON.parse(tf)
+      if config.key? @app_name
+        @app_key ||= config[@app_name]['app_key']
+        @refresh_token = config[@app_name]['refresh_token']
+      end
+    rescue Errno::ENOENT
+    end
+
+    def register
+      result = Register.new(api_key: @api_key, scope: @scope)
+      @pin = result.pin
+      @code = result.code
+      result
+    end
+
+    def write_token_file
+      return unless @token_file
+      File.open(@token_file, 'w') do |tf|
+        tf.puts JSON.pretty_generate({
+          @app_name => {
+            'app_key' => @app_key,
+            'refresh_token' => @refresh_token
+          }
+        })
+      end
+    end
+
+  end
+
+  class TokenError < StandardError
+  end
+
+end

data/lib/ecobee/version.rb

@@ -0,0 +1,3 @@
+module Ecobee
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: ecobee
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Rob Zwissler
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-08-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 'Implements Ecobee API with PIN-based token registration & renewal, persistent
+  HTTP connections '
+email:
+- rob@zwissler.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- ecobee.gemspec
+- examples/set_mode.rb
+- examples/test_token.rb
+- lib/ecobee.rb
+- lib/ecobee/client.rb
+- lib/ecobee/register.rb
+- lib/ecobee/token.rb
+- lib/ecobee/version.rb
+homepage: https://github.com/robzr/ecobee
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Ecobee API - token registration, persistent HTTP GET/PUSH
+test_files: []