soffes/sonos

View on GitHub
lib/sonos/endpoint/alarm.rb

Summary

Maintainability
A
2 hrs
Test Coverage
module Sonos::Endpoint::Alarm
  ALARM_CLOCK_ENDPOINT = '/AlarmClock/Control'
  ALARM_CLOCK_XMLNS = 'urn:schemas-upnp-org:service:AlarmClock:1'

  # List the alarms that have been defined
  def list_alarms
    hash_of_alarm_hashes = {}
    response = send_alarm_message('ListAlarms')
    alarm_list_reader = Nokogiri::XML::Reader(response.to_hash[:list_alarms_response][:current_alarm_list])
    alarm_list_reader.each do |alarm_node|
      id = alarm_node.attribute('ID')
      unless id.nil?
        alarm_hash = {
            :ID => id,
            # UpdateAlarm expects 'StartLocalTime', but the ListAlarm response attribute is 'StartTime'
            :StartLocalTime => alarm_node.attribute('StartTime'),
            :Duration => alarm_node.attribute('Duration'),
            :Recurrence => alarm_node.attribute('Recurrence'),
            :Enabled => alarm_node.attribute('Enabled'),
            :RoomUUID => alarm_node.attribute('RoomUUID'),
            :PlayMode => alarm_node.attribute('PlayMode'),
            :Volume => alarm_node.attribute('Volume'),
            :IncludeLinkedZones => alarm_node.attribute('IncludeLinkedZones'),
            :ProgramURI => alarm_node.attribute('ProgramURI'),
            :ProgramMetaData => alarm_node.attribute('ProgramMetaData')
        }
        hash_of_alarm_hashes[id] = alarm_hash
      end
    end
    hash_of_alarm_hashes
  end

  def create_alarm(startLocalTime, duration, recurrence, enabled, roomUuid, playMode, volume, includeLinkedZones, programUri, programMetaData)
    options = {:StartLocalTime => startLocalTime, :Duration => duration,
               :Recurrence => recurrence, :Enabled => enabled, :RoomUUID => roomUuid,
               :PlayMode => playMode, :Volume => volume, :IncludeLinkedZones => includeLinkedZones,
               :ProgramURI => programUri, :ProgramMetaData => programMetaData}
    parse_response send_alarm_message('CreateAlarm', convert_hash_to_xml(options))
  end

  def destroy_alarm(id)
    parse_response send_alarm_message('DestroyAlarm', "<ID>#{id}</ID>")
  end

  def update_alarm(id, startLocalTime, duration, recurrence, enabled, roomUuid, playMode, volume, includeLinkedZones, programUri, programMetaData)
    alarm_hash = {:ID => id, :StartLocalTime => startLocalTime, :Duration => duration,
                  :Recurrence => recurrence, :Enabled => enabled, :RoomUUID => roomUuid,
                  :PlayMode => playMode, :Volume => volume, :IncludeLinkedZones => includeLinkedZones,
                  :ProgramURI => programUri, :ProgramMetaData => programMetaData}
    parse_response send_alarm_message('UpdateAlarm', convert_hash_to_xml(alarm_hash))
  end

  def is_alarm_enabled?(id)
    list_alarms[id][:Enabled]
  end

  def enable_alarm(id)
    alarm_hash = list_alarms[id]
    alarm_hash[:Enabled] = '1'
    parse_response send_alarm_message('UpdateAlarm', convert_hash_to_xml(alarm_hash))
  end

  def disable_alarm(id)
    alarm_hash = list_alarms[id]
    alarm_hash[:Enabled] = '0'
    parse_response send_alarm_message('UpdateAlarm', convert_hash_to_xml(alarm_hash))
  end

  def set_alarm_volume(id, volume)
    alarm_hash = list_alarms[id]
    alarm_hash[:Volume] = volume
    parse_response send_alarm_message('UpdateAlarm', convert_hash_to_xml(alarm_hash))
  end

  private

  def alarm_client
    @alarm_client ||= Savon.client endpoint: "http://#{self.ip}:#{Sonos::PORT}#{ALARM_CLOCK_ENDPOINT}", namespace: Sonos::NAMESPACE, log: Sonos.logging_enabled
  end

  def send_alarm_message(name, part = '')
    action = "#{ALARM_CLOCK_XMLNS}##{name}"
    message = %Q{<u:#{name} xmlns:u="#{ALARM_CLOCK_XMLNS}">#{part}</u:#{name}>}
    alarm_client.call(name, soap_action: action, message: message)
  end

  def convert_hash_to_xml(options = {})
    updatePart = ''
    options.each do |optionKey, optionValue|
      updatePart += "<#{optionKey}>#{optionValue}</#{optionKey}>"
    end
    updatePart
  end
end