rubytcc 0.0.1

data/lib/rubytcc/country_info.rb

@@ -0,0 +1,11 @@
+require 'rubytcc/state_info'
+
+module RubyTCC
+  class CountryInfo
+    include XML::Mapping
+
+    	text_node :country_code, "CountryCode"
+    	text_node :name, "Name"
+    	array_node :states, "States", "StateInfo", :class => RubyTCC::StateInfo
+	end
+end

data/lib/rubytcc/create_location_result.rb

@@ -0,0 +1,9 @@
+module RubyTCC
+	class CreateLocationResult
+    	include XML::Mapping
+
+    	text_node :result, "Result"
+    	text_node :location_name, "LocationName"
+    	numeric_node :location_id, "LocationID"	
+	end
+end

data/lib/rubytcc/current_weather.rb

@@ -0,0 +1,13 @@
+module RubyTCC
+  class CurrentWeather
+    include XML::Mapping
+
+    boolean_node :is_defined, "IsDefined"
+    boolean_node :is_valid, "IsValid"
+    text_node :condition, "Condition"
+    numeric_node :temperature, "Temperature"
+    text_node :temp_unit, "TempUnit"
+    numeric_node :humidity, "Humidity"
+    text_node :phrase_key, "PhraseKey", :default_value => ""
+  end
+end

data/lib/rubytcc/demand_response_event.rb

@@ -0,0 +1,16 @@
+module RubyTCC
+  class DemandResponseEvent
+    include XML::Mapping
+
+    numeric_node :dr_event_id, "DREventId"
+    text_node :start_time, "StartTime"
+    text_node :end_time, "EndTime"
+    boolean_node :opted_out, "OptedOut"
+    boolean_node :optoutable, "Optoutable"
+    text_node :phase, "Phase"
+    numeric_node :heat_setpoint_limit, "HeatSetpointLimit"
+    numeric_node :cool_setpoint_limit, "CoolSetpointLimit"
+    # array_node :intervals, "Intervals", ?, ? <-- Unable to determine the contents of the interval model
+    boolean_node :hidden, "Hidden"
+  end
+end

data/lib/rubytcc/edit_location_result.rb

@@ -0,0 +1,9 @@
+module RubyTCC
+	class EditLocationResult
+    	include XML::Mapping
+
+    	text_node :result, "Result"
+    	text_node :location_name, "LocationName"
+    	numeric_node :location_id, "LocationID"	
+	end
+end

data/lib/rubytcc/enumberable.rb

@@ -0,0 +1,26 @@
+# Credit: https://github.com/sferik/twitter/blob/master/lib/twitter/enumerable.rb
+module RubyTCC
+  module Enumerable
+    include ::Enumerable
+
+    # @return [Enumerator]
+    def each(start = 0)
+      return to_enum(:each, start) unless block_given?
+      Array(@collection[start..-1]).each do |element|
+        yield(element)
+      end
+      unless last?
+        start = [@collection.size, start].max
+        fetch_next_page
+        each(start, &Proc.new)
+      end
+      self
+    end
+
+  private
+
+    # @return [Boolean]
+    def last?
+      true
+    end
+  end

data/lib/rubytcc/error.rb

@@ -0,0 +1,60 @@
+module RubyTCC
+  # Custom error class for rescuing from all RubyTCC errors
+  class Error < StandardError
+    # @return [Integer]
+    attr_reader :code
+
+    class << self
+      # Create a new error from an HTTP response
+      #
+      # @param response [RestClient::Response]
+      # @return [RubyTCC::Error]
+      def from_response(response)
+        message, code = parse_error(response.body)
+        new(message, response.response_headers, code)
+      end
+
+    private
+
+      def parse_error(body)
+        if body.nil?
+          ['', nil]
+        elsif body[:error]
+          [body[:error], nil]
+        elsif body[:errors]
+          extract_message_from_errors(body)
+        end
+      end
+
+      def extract_message_from_errors(body)
+        first = Array(body[:errors]).first
+        if first.is_a?(Hash)
+          [first[:message].chomp, first[:code]]
+        else
+          [first.chomp, nil]
+        end
+      end
+    end
+
+    # Initializes a new Error object
+    #
+    # @param message [Exception, String]
+    # @param code [Integer]
+    # @return [RubyTCC::Error]
+    def initialize(message = '', code = nil)
+      super(message)
+      @code = code
+    end
+
+    ConfigurationError = Class.new(::ArgumentError)
+
+    # Raised when RubyTCC returns a 4xx HTTP status code
+    ClientError = Class.new(self)
+
+    # Raised when RubyTCC returns the HTTP status code 408
+    RequestTimeout = Class.new(ClientError)
+
+    # Raised when the result is not "Success"
+    ResultError = Class.new(self)
+  end
+end

data/lib/rubytcc/fan.rb

@@ -0,0 +1,12 @@
+module RubyTCC
+  class Fan
+    include XML::Mapping
+
+    boolean_node :can_control, "CanControl"
+    text_node :position, "Position"
+    boolean_node :can_set_auto, "CanSetAuto"
+    boolean_node :can_set_circulate, "CanSetCirculate"
+    boolean_node :can_follow_schedule, "CanFollowSchedule"
+    boolean_node :can_set_on, "CanSetOn"
+  end
+end

data/lib/rubytcc/forecast_day_info.rb

@@ -0,0 +1,13 @@
+module RubyTCC
+  class ForecastDayInfo
+  	include XML::Mapping
+
+  	text_node :date, "Date"
+    text_node :condition, "Condition"
+    numeric_node :low, "Low"
+    text_node :low_unit, "LowUnit"
+    numeric_node :high, "High"
+    text_node :high_unit, "HighUnit"
+    text_node :phrase, "Phrase"
+  end
+end

data/lib/rubytcc/get_comm_task_state_result.rb

@@ -0,0 +1,10 @@
+module RubyTCC
+  	class GetCommTaskStateResult
+    	include XML::Mapping
+
+    	text_node :result, "Result"
+    	numeric_node :comm_task_id, "CommTaskID"
+    	text_node :state, "State"
+    	text_node :fault_reason, "FaultReason"
+	end
+end

data/lib/rubytcc/get_locations_result.rb

@@ -0,0 +1,10 @@
+require 'rubytcc/location_info'
+
+module RubyTCC
+  class GetLocationsResult
+    include XML::Mapping
+
+    text_node :result, "Result"
+    array_node :locations, "Locations", "LocationInfo", :class => RubyTCC::LocationInfo
+  end
+end

data/lib/rubytcc/get_schedule_result.rb

@@ -0,0 +1,11 @@
+require 'rubytcc/schedule'
+
+module RubyTCC
+  class GetScheduleResult
+    include XML::Mapping
+
+    	text_node :result, "Result"
+	    object_node :schedule, "Schedule", :class => RubyTCC::Schedule
+	    boolean_node :loading, "Loading"
+	end
+end

data/lib/rubytcc/get_short_location_info_result.rb

@@ -0,0 +1,10 @@
+require 'rubytcc/short_location_info'
+
+module RubyTCC
+  class GetShortLocationInfoResult
+    include XML::Mapping
+
+    text_node :result, "Result"
+    array_node :locations, "Locations", "ShortLocationInfo", :class => RubyTCC::ShortLocationInfo
+	end
+end

data/lib/rubytcc/get_system_geo_info_result.rb

@@ -0,0 +1,10 @@
+require 'rubytcc/country_info'
+
+module RubyTCC
+  class GetSystemGeoInfoResult
+    include XML::Mapping
+
+    text_node :result, "Result"
+    array_node :countries, "Countries", "CountryInfo", :class => RubyTCC::CountryInfo
+	end
+end

data/lib/rubytcc/get_thermostat_fan_result.rb

@@ -0,0 +1,10 @@
+require 'rubytcc/fan'
+
+module RubyTCC
+  class GetThermostatFanResult
+    include XML::Mapping
+
+    text_node :result, "Result"
+    object_node :fan, "Fan", :class => RubyTCC::Fan
+  end
+end

data/lib/rubytcc/get_thermostat_humidification_result.rb

@@ -0,0 +1,10 @@
+require 'rubytcc/humidification'
+
+module RubyTCC
+  class GetThermostatHumidificationResult
+    include XML::Mapping
+
+    text_node :result, "Result"
+    object_node :humidification, "Humidification", :class => RubyTCC::Humidification
+  end
+end

data/lib/rubytcc/get_thermostat_result.rb

@@ -0,0 +1,10 @@
+require 'rubytcc/thermostat'
+
+module RubyTCC
+  class GetThermostatResult
+    include XML::Mapping
+
+    text_node :result, "Result"
+    object_node :thermostat, "Thermostat", :class => RubyTCC::Thermostat
+  end
+end

data/lib/rubytcc/get_thermostat_ui_result.rb

@@ -0,0 +1,8 @@
+module RubyTCC
+  	class GetThermostatUIResult
+    	include XML::Mapping
+
+    	text_node :result, "Result"
+    	object_node :ui, "UI", :class => RubyTCC::UI
+	end
+end

data/lib/rubytcc/get_user_address_info_result.rb

@@ -0,0 +1,10 @@
+require 'rubytcc/user_address_info'
+
+module RubyTCC
+  class GetUserAddressInfoResult
+    include XML::Mapping
+
+    	text_node :result, "Result"
+    	object_node :user_address_info, "UserAddressInfo", :class => RubyTCC::UserAddressInfo
+	end
+end

data/lib/rubytcc/get_volatile_thermostat_data_result.rb

@@ -0,0 +1,11 @@
+require 'rubytcc/ui'
+
+module RubyTCC
+  class GetVolatileThermostatDataResult
+    include XML::Mapping
+
+    text_node :result, "Result"
+    object_node :ui, "UI", :class => RubyTCC::UI
+    text_node :upgrading, "Upgrading"
+	end
+end

data/lib/rubytcc/get_weather_forecast_result.rb

@@ -0,0 +1,10 @@
+require 'rubytcc/forecast_day_info'
+
+module RubyTCC
+  class GetWeatherForecastResult
+    include XML::Mapping
+
+    	text_node :result, "Result"
+    	array_node :forecast, "Forecast", "ForecastDayInfo", :class => RubyTCC::ForecastDayInfo
+	end
+end

data/lib/rubytcc/helper.rb

@@ -0,0 +1,14 @@
+module RubyTCC
+	module Helper 
+		class << self
+			def to_period(time)
+				time = Time.parse(time).to_i
+				(time - Time.parse("00:00").to_i) / (15 * 60)
+			end
+
+			def camelize underscored_word
+		      underscored_word.to_s.gsub(/(?:^|_)(.)/) { $1.upcase }
+		    end
+		end
+	end
+end

data/lib/rubytcc/humidification.rb

@@ -0,0 +1,17 @@
+module RubyTCC
+  class Humidification
+    include XML::Mapping
+
+    boolean_node :can_control_humidification, "CanControlHumidification"
+    boolean_node :can_control_dehumidification, "CanControlDehumidification"
+    numeric_node :humidification_set_point, "HumidificationSetPoint"
+    numeric_node :humidification_upper_limit, "HumidificationUpperLimit"
+    numeric_node :humidification_lower_limit, "HumidificationLowerLimit"
+    text_node :humidification_mode, "HumidificationMode"
+    numeric_node :dehumidification_set_point, "DehumidificationSetPoint"
+    numeric_node :dehumidification_upper_limit, "DehumidificationUpperLimit"
+    numeric_node :dehumidification_lower_limit, "DehumidificationLowerLimit"
+    text_node :dehumidification_mode, "DehumidificationMode"  
+    numeric_node :deadband, "Deadband"
+  end
+end

data/lib/rubytcc/keep_alive_result.rb

@@ -0,0 +1,7 @@
+module RubyTCC
+  class KeepAliveResult
+    include XML::Mapping
+
+    	text_node :result, "Result"
+	end
+end

data/lib/rubytcc/location_info.rb

@@ -0,0 +1,18 @@
+require 'rubytcc/current_weather'
+require 'rubytcc/thermostat_info'
+
+module RubyTCC
+  class LocationInfo
+  	include XML::Mapping
+
+  	numeric_node :location_id, "LocationID"
+  	boolean_node :can_control, "CanControl"
+  	text_node :name, "Name"
+  	text_node :type, "Type"
+  	text_node :country, "Country"
+  	numeric_node :zip_code, "ZipCode"
+  	object_node :current_weather, "CurrentWeather", :class => RubyTCC::CurrentWeather
+  	array_node :thermostats, "Thermostats", "ThermostatInfo", :class => RubyTCC::ThermostatInfo
+  	text_node :time_zone, "TimeZone"
+  end
+end

data/lib/rubytcc/log_off_result.rb

@@ -0,0 +1,7 @@
+module RubyTCC
+  class LogOffResult
+    include XML::Mapping
+
+    	text_node :result, "Result"
+	end
+end

data/lib/rubytcc/rest/api.rb

@@ -0,0 +1,45 @@
+require 'rubytcc/rest/authenticate_user_login'
+require 'rubytcc/rest/change_thermostat_fan'
+require 'rubytcc/rest/change_thermostat_ui'
+require 'rubytcc/rest/create_location'
+require 'rubytcc/rest/edit_location'
+require 'rubytcc/rest/get_comm_task_state'
+require 'rubytcc/rest/get_locations'
+require 'rubytcc/rest/get_schedule'
+require 'rubytcc/rest/get_short_location_info'
+require 'rubytcc/rest/get_system_geo_info'
+require 'rubytcc/rest/get_thermostat'
+require 'rubytcc/rest/get_thermostat_fan'
+require 'rubytcc/rest/get_thermostat_humidification'
+require 'rubytcc/rest/get_thermostat_ui'
+require 'rubytcc/rest/get_user_address_info'
+require 'rubytcc/rest/get_volatile_thermostat_data'
+require 'rubytcc/rest/get_weather_forecast'
+require 'rubytcc/rest/keep_alive'
+require 'rubytcc/rest/log_off'
+
+module RubyTCC
+	module REST
+		module API
+			include RubyTCC::REST::AuthenticateUserLogin
+			include RubyTCC::REST::ChangeThermostatFan
+			include RubyTCC::REST::ChangeThermostatUI
+			include RubyTCC::REST::CreateLocation
+			include RubyTCC::REST::EditLocation
+			include RubyTCC::REST::GetCommTaskState
+			include RubyTCC::REST::GetLocations
+			include RubyTCC::REST::GetSchedule
+			include RubyTCC::REST::GetShortLocationInfo
+			include RubyTCC::REST::GetSystemGeoInfo
+			include RubyTCC::REST::GetThermostat
+			include RubyTCC::REST::GetThermostatFan
+			include RubyTCC::REST::GetThermostatHumidification
+			include RubyTCC::REST::GetThermostatUI
+			include RubyTCC::REST::GetUserAddressInfo
+			include RubyTCC::REST::GetVolatileThermostatData
+			include RubyTCC::REST::GetWeatherForecast
+			include RubyTCC::REST::KeepAlive
+			include RubyTCC::REST::LogOff
+		end
+	end
+end

data/lib/rubytcc/rest/authenticate_user_login.rb

@@ -0,0 +1,14 @@
+require 'rubytcc/authenticate_login_result'
+
+module RubyTCC
+	module REST
+		module AuthenticateUserLogin
+			def authenticate_user_login(options = self.credentials)
+				module_name = Module.nesting[0].to_s.split("::").last
+				result = complete_post(module_name, "AuthenticateLogin", options)
+				self.session_id = result.session_id
+				result
+			end
+		end
+	end
+end