rubytcc 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cd4ab81de10386a81907d23388107f1320985e7f
+  data.tar.gz: f9312ad2387f4c092f8c7cdb57b8c9b3f33201f1
+SHA512:
+  metadata.gz: 12008d5f17df703b1ee11b6084b8ba98315768a5c8abea545d4965253bf74378c45d7bb2fc88b5d4bdd97f73a099c7b98be3045c9933fe3175e8cd847965d3d3
+  data.tar.gz: 92fc9385fd560c96bf4620f2920963028a5114b0f43fa944497b1c6b7bee9c8c75b2456be7ef4745e5e4db819c0b6675e7f327e8831b1a3caada75193e83f23b

data/.gitignore

@@ -0,0 +1,37 @@
+/spec/variables.rb
+/spec/fixtures/* 
+
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,118 @@
+PATH
+  remote: .
+  specs:
+    rubytcc (0.0.1)
+      faraday (~> 0.9.0)
+      nori (~> 2.4.0)
+      savon (~> 2.5.1)
+      xml-mapping (~> 0.10.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.3.6)
+    akami (1.2.2)
+      gyoku (>= 0.4.0)
+      nokogiri
+    builder (3.2.2)
+    celluloid (0.16.0)
+      timers (~> 4.0.0)
+    coderay (1.1.0)
+    crack (0.4.2)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.2.5)
+    faraday (0.9.0)
+      multipart-post (>= 1.2, < 3)
+    ffi (1.9.6)
+    formatador (0.2.5)
+    growl (1.0.3)
+    guard (2.6.1)
+      formatador (>= 0.2.4)
+      listen (~> 2.7)
+      lumberjack (~> 1.0)
+      pry (>= 0.9.12)
+      thor (>= 0.18.1)
+    guard-rspec (4.3.1)
+      guard (~> 2.1)
+      rspec (>= 2.14, < 4.0)
+    gyoku (1.1.1)
+      builder (>= 2.1.2)
+    hitimes (1.2.2)
+    httpi (2.1.1)
+      rack
+      rubyntlm (~> 0.3.2)
+    listen (2.7.11)
+      celluloid (>= 0.15.2)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9)
+    lumberjack (1.0.9)
+    macaddr (1.7.1)
+      systemu (~> 2.6.2)
+    method_source (0.8.2)
+    mini_portile (0.6.0)
+    multipart-post (2.0.0)
+    nokogiri (1.6.3.1)
+      mini_portile (= 0.6.0)
+    nori (2.4.0)
+    pry (0.10.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rack (1.5.2)
+    rake (10.3.2)
+    rb-fsevent (0.9.4)
+    rb-inotify (0.9.5)
+      ffi (>= 0.5.0)
+    rspec (3.1.0)
+      rspec-core (~> 3.1.0)
+      rspec-expectations (~> 3.1.0)
+      rspec-mocks (~> 3.1.0)
+    rspec-core (3.1.7)
+      rspec-support (~> 3.1.0)
+    rspec-expectations (3.1.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.1.0)
+    rspec-mocks (3.1.3)
+      rspec-support (~> 3.1.0)
+    rspec-support (3.1.2)
+    ruby_gntp (0.3.4)
+    rubyntlm (0.3.4)
+    safe_yaml (1.0.4)
+    savon (2.5.1)
+      akami (~> 1.2.0)
+      builder (>= 2.1.2)
+      gyoku (~> 1.1.0)
+      httpi (~> 2.1.0)
+      nokogiri (>= 1.4.0)
+      nori (~> 2.4.0)
+      uuid (~> 2.3.7)
+      wasabi (~> 3.3.0)
+    slop (3.6.0)
+    systemu (2.6.4)
+    thor (0.19.1)
+    timers (4.0.1)
+      hitimes
+    uuid (2.3.7)
+      macaddr (~> 1.0)
+    vcr (2.9.3)
+    wasabi (3.3.1)
+      httpi (~> 2.0)
+      nokogiri (>= 1.4.0)
+    webmock (1.19.0)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+    xml-mapping (0.10.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  growl (~> 1.0.0)
+  guard (~> 2.6.0)
+  guard-rspec (~> 4.3.0)
+  rake (~> 10.3.2)
+  rspec (~> 3.1.0)
+  ruby_gntp (~> 0.3.4)
+  rubytcc!
+  vcr (~> 2.9.3)
+  webmock (~> 1.19.0)

data/Guardfile

@@ -0,0 +1,22 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rsspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separetly)
+#  * 'just' rspec: 'rspec'
+guard :rspec, cmd: 'bundle exec rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^spec/lib/.+_spec\.rb$})
+  watch(%r{^spec/lib/rubytcc/.+_spec\.rb$})
+  watch(%r{^spec/lib/rubytcc/rest/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { "spec" }
+  watch(%r{^lib/rubytcc/(.+)\.rb$})     { "spec" }
+  watch(%r{^lib/rubytcc/rest/(.+)\.rb$})     { |m| "spec/lib/rubytcc/rest/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Austin
+
+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,10 @@
+#!/usr/bin/env rake
+
+require 'bundler/setup'
+Bundler::GemHelper.install_tasks
+
+# @source: http://simonecarletti.com/blog/2009/09/rake-console/
+desc "Open an irb session preloaded with this library"
+task :console do
+  sh "irb -rubygems -I lib -r rubytcc.rb"
+end

data/Readme.md

@@ -0,0 +1,107 @@
+ruby-tcc
+================
+
+Ruby client for the Honeywell Total Connect Comfort API.
+
+[![Code Climate](https://codeclimate.com/github/auzroz/ruby-tcc/badges/gpa.svg)](https://codeclimate.com/github/auzroz/ruby-tcc)
+## Installation
+
+In your Gemfile:
+
+```ruby
+gem "ruby-tcc", "~> 0.0.1"
+```
+
+or
+
+```ruby
+gem 'ruby-tcc', :git => 'https://github.com/auzroz/ruby-tcc'
+```
+
+## Usage
+First create a Client: 
+```ruby
+client = RubyTCC::REST::Client.new(:username => USERNAME, :password => PASSWORD)
+```
+Second, authenticate the login:
+```ruby
+client.authenticate_user_login
+```
+Next, calls can be made using the client object to availble APIs.
+
+```ruby
+client.get_locations
+```
+
+## Currently Supported APIs
+* AuthenticateUserLogin
+* ChangeThermostatFan
+* ChangeThermostatUI
+* CreateLocation
+* EditLocation
+* GetCommTaskState
+* GetLocations
+* GetSchedule
+* GetShortLocationInfo
+* GetSystemGeoInfo
+* GetThermostat
+* GetThermostatFan
+* GetThermostatHumidification
+* GetThermostatUI
+* GetVolatileThermostatData
+* GetWeatherForecast
+* KeepAlive
+* LogOff
+
+## APIs In Progress
+* CancelScheduleChanges
+* ChangeSchedule
+* SubmitScheduleChanges
+
+## APIs Currently Unable to Test 
+
+Based on the [Honeywell 7-Day Wifi Thermostat (RTH6580WF1001/W)](http://smile.amazon.com/gp/product/B00A97FIG0/ref=oh_details_o00_s00_i00?ie=UTF8&psc=1), the following APIs are not available to test. Any pull requests that can verify the function would be appreciated.
+
+* AcceptInvitation
+* ChangeThermostatHumidification
+* DeclineInvitation
+* DismissSiteAlert
+* DismissThermostatAlert
+* DismissCommunicationAlert
+* EditDealerInformation
+* Edit PreferredDealerInformation
+* EmailDealer
+* GetDREvent
+* GetDealerInformation
+* GetPendingInvitations
+* HideDREvent
+* OptOutDREvent
+* RequestDealerInvitation
+* WiringToolGetThermostats
+* WiringToolGetWireMapWithAnswer
+
+## APIs That Are Outside of Scope
+
+These functions are best left to the official app and website.
+
+* CreateAccount
+* GetSecurityQuestions
+* RegisterGateway
+* ResendAccountActivationEmail
+* ResetPassword
+* UnregisterGateway
+* UpdateLocationLevelOfAccess
+
+## Contributing
+
+Feel free to contribute, there are several options available that I don't have the ability to test with a home thermostat.
+
+You need to update your login and thermostat credentials in spec/spec_helper.rb before running them:
+
+```bash
+bundle exec rspec spec
+```
+- or -
+```bash
+bundle exec guard
+```

data/lib/rubytcc.rb

@@ -0,0 +1,9 @@
+require 'savon'
+require 'faraday'
+require 'xml/mapping'
+
+require 'rubytcc/rest/client'
+
+require 'rubytcc/helper'
+
+require 'rubytcc/version'

data/lib/rubytcc/authenticate_login_result.rb

@@ -0,0 +1,11 @@
+require 'rubytcc/user_info'
+
+module RubyTCC
+  class AuthenticateLoginResult
+    include XML::Mapping
+
+    text_node :result, "Result" 
+    object_node :user_info, "UserInfo", :class => RubyTCC::UserInfo
+    text_node :session_id, "SessionID"
+  end
+end

data/lib/rubytcc/change_request_result.rb

@@ -0,0 +1,8 @@
+module RubyTCC
+  class ChangeRequestResult
+    include XML::Mapping
+
+    text_node :result, "Result"
+    numeric_node :comm_task_id, "CommTaskID"
+	end
+end

data/lib/rubytcc/change_thermostat_ui_result.rb

@@ -0,0 +1,8 @@
+module RubyTCC
+  class ChangeThermostatUIResult
+    include XML::Mapping
+
+    	text_node :result, "Result"
+    	numeric_node :comm_task_id, "CommTaskID"
+	end
+end

data/lib/rubytcc/client.rb

@@ -0,0 +1,72 @@
+require 'rubytcc/error'
+
+module RubyTCC
+	class Client
+		attr_accessor :username, :password, :application_id, :application_version, :ui_language, :proxy
+		attr_writer :user_agent
+
+
+	    # Initializes a new Client object
+	    #
+	    # @param options [Hash]
+	    # @return [RubyTCC::Client]
+		def initialize(options = {})
+			options.each do |key, value|
+				send(:"#{key}=", value)
+			end
+			yield(self) if block_given?
+			validate_credential_type!
+		end
+
+		# @return [String]
+		def user_agent
+			@user_agent ||= 'Apache-HttpClient/UNAVAILABLE (java 1.4)'
+		end
+
+		# @return [String]
+		def application_id
+			@application_id ||= 'a0c7a795-ff44-4bcd-9a99-420fac57ff04'
+		end
+
+		# @return [String]
+		def application_version
+			@application_version ||= '2'
+		end
+
+		# @return [String]
+		def ui_language
+			@ui_language ||= 'English'
+		end
+
+		# @return [Hash]
+		def credentials
+			{
+				:username => username,
+				:password => password,
+				:ApplicationId => self.application_id,
+				:ApplicationVersion => self.application_version,
+				:UiLanguage => self.ui_language
+			}
+		end
+
+		# @return [Boolean]
+		def credentials?
+			credentials.values.all?
+		end
+
+	private
+
+	    # Ensures that all credentials set during configuration are of a
+	    # valid type. Valid types are String and Symbol.
+	    #
+	    # @raise [RubyTCC::Error::ConfigurationError] Error is raised when
+	    #   supplied twitter credentials are not a String or Symbol.
+		def validate_credential_type!
+			credentials.each do |credential, value|
+				next if value.nil?
+				fail(RubyTCC::Error::ConfigurationError.new("Invalid #{credential} specified: #{value.inspect} must be a string or symbol.")) unless value.is_a?(String) || value.is_a?(Symbol)
+			end
+		end
+
+	end
+end