redlink 0.1.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.9.3
+

data/Gemfile

@@ -0,0 +1,17 @@
+source 'https://rubygems.org'
+
+# Gem dependencies
+gemspec
+
+# Development dependencies
+gem 'rake'
+gem 'yard'
+
+# Testing dependencies
+group :test do
+  gem 'minitest'
+  gem 'minitest-wscolor'
+  gem 'fakeweb'
+  gem 'vcr'
+  gem 'mocha', require: false
+end

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Sam Soffes
+
+MIT License
+
+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/Rakefile

@@ -0,0 +1,14 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+end
+
+desc "Open an irb session preloaded with this library"
+task :console do
+  sh "irb -rubygems -I lib -r redlink.rb"
+end
+
+task default: :test

data/Readme.markdown

@@ -0,0 +1 @@
+# Redlink

data/bin/redlink

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+lib = File.expand_path('../../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'redlink/cli'
+
+Redlink::Cli.start

data/lib/redlink/cli.rb

@@ -0,0 +1,50 @@
+require 'thor'
+require 'redlink'
+require 'redlink/endpoint'
+
+module Redlink
+  class Cli < Thor
+    desc 'init TOKEN', 'Stores the app token for your Redlink application'
+    def init(token)
+      Redlink::Configuration.app_token = token
+    end
+
+    desc 'login USERNAME PASSWORD', 'sign in'
+    def login(username, password)
+      Redlink::Endpoint.login(username, password)
+    end
+
+    desc 'logout', 'srsly'
+    def logout
+      Redlink::Endpoint.logout
+    end
+
+    desc 'locations', 'places'
+    def locations
+      Redlink::Location.all.each do |location|
+        s = [location]
+        if location.current_weather
+          s << location.current_weather
+        end
+
+        puts s.join(' - ')
+
+        location.thermostats.each do |thermostat|
+          puts "\t#{thermostat}"
+        end
+
+      end
+    end
+
+    desc 'operations', 'wfasd'
+    def operations
+      p Redlink::Endpoint.endpoint_client.operations
+    end
+
+    desc 'session_id SESSION_ID', 'blah'
+    def session_id(session_id)
+      Redlink::Configuration.session_id = session_id
+    end
+
+  end
+end

data/lib/redlink/configuration.rb

@@ -0,0 +1,89 @@
+require 'yaml'
+
+module Redlink
+  class Configuration
+    CONFIG_FILE = '~/.redlink'
+
+    def self.app_token
+      config_file['app_token']
+    end
+
+    def self.app_token=(val)
+      self.config_file['app_token'] = val
+      save
+    end
+
+    def self.session_id
+      config_file['session_id']
+    end
+
+    def self.session_id=(val)
+      config_file['session_id'] = val
+      if val
+        config_file['session_id_expires'] = Time.now + 3600 # one hour from now
+      else
+        config_file['session_id_expires'] = nil
+      end
+    end
+
+    def self.session_expired?
+      !config_file['session_id_expires'] && config_file['session_id_expires'] < Time.now
+    end
+
+    def self.user
+      config_file['user']
+    end
+
+    def self.user=(val)
+      config_file['user'] = val
+    end
+
+    def self.username
+      config_file['username']
+    end
+
+    def self.username=(val)
+      config_file['username'] = val
+    end
+
+    def self.password
+      config_file['password']
+    end
+
+    def self.password=(val)
+      config_file['password'] = val
+    end
+
+    def self.save
+      File.open(File.expand_path(CONFIG_FILE), 'w+') do |f|
+        f.write YAML.dump(@config_file)
+      end
+    end
+
+    def self.clear!
+      [:session_id, :user, :username, :password].each do |k|
+        self.send("#{k}=", nil)
+      end
+      self.save
+    end
+
+    private
+
+    def self.config_file
+      return @config_file if @config_file
+
+      @config_file = {}
+      if File.exists?(path = File.expand_path(CONFIG_FILE))
+        begin
+          @config_file = YAML.load(File.read(path)) || {}
+        rescue TypeError => ex
+
+        end
+      end
+
+      @config_file
+    end
+
+
+  end
+end

data/lib/redlink/endpoint.rb

@@ -0,0 +1,78 @@
+require 'savon'
+
+module Redlink
+  class Endpoint
+
+    def self.endpoint_client
+      @endpoint_client ||= Savon.client do
+        wsdl File.expand_path("../../../wsdl/MobileV2.xml", __FILE__)
+        log_level :warn
+        log false
+      end
+    end
+
+    def self.login(username = Configuration.username, password = Configuration.password)
+      raise "A username and password is required" unless username && password
+
+      params = {
+        username: username,
+        password: password,
+        applicationID: Redlink::Configuration.app_token,
+        applicationVersion: 2,
+        uiLanguage: 'Default'
+      }
+
+      body = endpoint_client.call(:authenticate_user_login, message: params).body
+      p body[:authenticate_user_login_response]
+      if body[:authenticate_user_login_response][:authenticate_user_login_result][:result] == 'Success'
+        user = body[:authenticate_user_login_response][:authenticate_user_login_result][:user_info]
+        session_id = body[:authenticate_user_login_response][:authenticate_user_login_result][:session_id]
+
+        Configuration.username = username
+        Configuration.password = password
+        Configuration.session_id = session_id
+        Configuration.user = user
+        Configuration.save
+
+        return true
+      else
+        return false
+      end
+    end
+
+    def self.logout
+      return unless Configuration.session_id
+      body = endpoint_client.call(:log_off, message: {sessionID: Configuration.session_id}).body
+
+      if body[:log_off_response][:log_off_result][:result] == 'Success'
+        Configuration.clear!
+      end
+    end
+
+    def self.locations
+      verify_token
+
+      body = endpoint_client.call(:get_locations, message: {sessionID: Configuration.session_id}).body
+      [body[:get_locations_response][:get_locations_result][:locations]].flatten.map do |loc|
+        loc[:location_info]
+      end
+    end
+
+    def self.get_volatile_thermostat_data(thermostat_id)
+      verify_token
+
+      body = endpoint_client.call(:get_volatile_thermostat_data, message: {sessionID: Configuration.session_id, thermostatID: thermostat_id}).body
+
+      body[:get_volatile_thermostat_data_response][:get_volatile_thermostat_data_result][:ui]
+    end
+
+    private
+
+    def self.verify_token
+      if Configuration.session_expired?
+        login
+      end
+    end
+
+  end
+end

data/lib/redlink/location.rb

@@ -0,0 +1,38 @@
+module Redlink
+  class Location < Redthing
+    attr_accessor :location_id, :name, :type, :country, :zip_code, :current_weather, :thermostats, :time_zone
+
+    def thermostats=(val)
+      @thermostats = val[:thermostat_info].map do |therm|
+        Thermostat.new(therm)
+      end
+    end
+
+    def thermostats
+      @thermostats
+    end
+
+    def current_weather=(val)
+      @current_weather = Weather.new(val)
+    end
+
+    def to_s
+      name
+    end
+
+    def self.all
+      @all ||= Endpoint.locations.map do |loc|
+        Location.new(loc)
+      end
+    end
+
+    def self.first
+      all[0]
+    end
+
+    def self.last
+      all[all.length - 1]
+    end
+
+  end
+end

data/lib/redlink/redthing.rb

@@ -0,0 +1,9 @@
+module Redlink
+  class Redthing
+    def initialize(raw)
+      raw.each do |k, v|
+        self.send("#{k}=", v) if self.respond_to?("#{k}=")
+      end
+    end
+  end
+end

data/lib/redlink/thermostat.rb

@@ -0,0 +1,23 @@
+module Redlink
+  class Thermostat < Redthing
+    attr_accessor :thermostat_id, :mac_id, :domain_id, :instance, :device_name,
+      :user_defined_device_name, :upgrading, :thermostats_alerts, :ui, :fan,
+      :humidification, :can_control_schedule, :will_support_schedule
+
+    def ui=(val)
+      @ui = Ui.new(val)
+    end
+
+    def name
+      user_defined_device_name || device_name
+    end
+
+    def to_s
+      "#{name} - #{ui}"
+    end
+
+    def refresh
+      @ui = Ui.new Endpoint.get_volatile_thermostat_data(self.thermostat_id)
+    end
+  end
+end

data/lib/redlink/ui.rb

@@ -0,0 +1,75 @@
+# Encoding: utf-8
+
+module Redlink
+  class Ui < Redthing
+    attr_accessor :created, :thermostat_locked, :outdoor_temp, :disp_temperature, :heat_setpoint,
+      :cool_setpoint, :displayed_units, :status_heat, :status_cool, :hold_until_capable,
+      :schedule_capable, :vacation_hold, :dual_setpoint_status, :heat_next_period, :cool_next_period,
+      :heat_lower_setpt_limit, :heat_upper_setpt_limit, :cool_lower_setpt_limit, :cool_upper_setpt_limit,
+      :sched_heat_sp, :sched_cool_sp, :system_switch_position, :can_set_switch_auto, :can_set_switch_cool,
+      :can_set_switch_off, :can_set_switch_heat, :can_set_switch_emergency_heat,
+      :can_set_switch_southern_away, :deadband, :outdoor_humidity, :indoor_humidity, :commercial
+
+
+    def outdoor_temp=(val)
+      @outdoor_temp = val.to_f
+    end
+
+    def heat_setpoint=(val)
+      @heat_setpoint = val.to_f
+    end
+
+    def cool_setpoint=(val)
+      @cool_setpoint = val.to_f
+    end
+
+    def sched_heat_sp=(val)
+      @sched_heat_sp = val.to_f
+    end
+
+    def sched_cool_sp=(val)
+      @sched_cool_sp = val.to_f
+    end
+
+    def outdoor_temp=(val)
+      @outdoor_temp = val.to_f
+    end
+
+    def disp_temperature=(val)
+      @disp_temperature = val.to_f
+    end
+
+    def heating?
+      status_heat.to_i == 1
+    end
+
+    def cooling?
+      status_cool.to_i == 1
+    end
+
+    def overridden?
+      heat_setpoint != sched_heat_sp && cool_setpoint != sched_cool_sp
+    end
+
+    def status
+      if heating?
+        if overridden?
+          return '(heating via override)'
+        else
+          return '(heating)'
+        end
+      elsif cooling?
+        if overridden?
+          return '(cooling via override)'
+        else
+          return '(cooling)'
+        end
+      end
+    end
+
+    def to_s
+      "#{disp_temperature.to_i}° / #{heat_setpoint}° #{status}"
+    end
+
+  end
+end

data/lib/redlink/version.rb

@@ -0,0 +1,3 @@
+module Redlink
+  VERSION = '0.1.0'
+end

data/lib/redlink/weather.rb

@@ -0,0 +1,24 @@
+# Encoding: utf-8
+
+module Redlink
+  class Weather < Redthing
+    attr_accessor :is_defined, :is_valid, :condition, :temperature, :temp_unit, :humidity, :phrase_key
+
+    def to_s
+      if is_defined && is_valid
+        "#{temperature.to_i}° #{condition}"
+      else
+        ""
+      end
+    end
+
+    def temperature=(val)
+      @temperature = val.to_f
+    end
+
+    def humidity=(val)
+      @humidity = val.to_f
+    end
+
+  end
+end

data/lib/redlink.rb

@@ -0,0 +1,12 @@
+require 'redlink/version'
+require 'redlink/configuration'
+require 'redlink/redthing'
+require 'redlink/location'
+require 'redlink/thermostat'
+require 'redlink/ui'
+require 'redlink/weather'
+require 'redlink/endpoint'
+
+module Redlink
+
+end

data/redlink.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'redlink/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = 'redlink'
+  gem.version       = Redlink::VERSION
+  gem.authors       = ['Aaron Gotwalt']
+  gem.email         = ['gotwalt@gmail.com']
+  gem.description   = 'Control Redlink home thermostats'
+  gem.summary       = gem.description
+  gem.homepage      = 'https://github.com/gotwalt/redlink'
+  gem.license       = 'MIT'
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ['lib']
+
+  gem.required_ruby_version = '>= 1.9.2'
+  gem.add_dependency 'savon', '~> 2.0.2'
+  gem.add_dependency 'nokogiri'
+  gem.add_dependency 'thor'
+end

data/test/support/vcr.rb

@@ -0,0 +1,4 @@
+VCR.configure do |c|
+  c.cassette_library_dir = 'test/cassettes'
+  c.hook_into :fakeweb
+end

data/test/test_helper.rb

@@ -0,0 +1,15 @@
+require 'rubygems'
+require 'bundler'
+Bundler.require :test
+require 'minitest/autorun'
+require 'mocha/setup'
+require 'redlink'
+
+# Support files
+Dir["#{File.expand_path(File.dirname(__FILE__))}/support/*.rb"].each do |file|
+  require file
+end
+
+class RedlinkTest < MiniTest::Unit::TestCase
+
+end