sonos 0.3.4 → 0.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f3ea780abc6b1575275463a67745acf4283db680
-  data.tar.gz: 7be54b8d1474a567b8e069f95b46ddd7b168b928
+  metadata.gz: 2500064f1c4f07a8064c691be658195d7245c15f
+  data.tar.gz: 30d941094b116b5c4998c8f6f2cbdf8862de11b9
 SHA512:
-  metadata.gz: 4c31701f021123f74e93189c7348e5a79ce774384fd2c87613f919fcd8b9a3387c5fe1eaaeeeb3c0e3e3f6c33f5fdb09462fb3e9046cbb20ca3b6fe0adf2460f
-  data.tar.gz: 92b8c154f0c759f54e4d24fb51580668bad8b727244c8b51f1594b3f733081fec13d6d3de43592bd0058f3c3ad7826c181b7783f5d95355a62ab2e4d1902aa6e
+  metadata.gz: ae738d359b88707fbb0913d26f8760690ba497d3c7d1d9bc8cc4675e637e4e6c9f9617e2906c1aef23b407f710c15761746372d299445c8209f34116cbcb1df7
+  data.tar.gz: 438b11f8ffa8033572c44e99bfe91540a3e634558030a248540ec130f1e73b606dc53025fd641371de1e4a8aad151b943b071f09cdf2a4d07c4b1e167e862693

data/Gemfile

@@ -6,12 +6,3 @@ 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

@@ -1,4 +1,4 @@
-Copyright (c) 2012-2013 Sam Soffes, http://soff.es
+Copyright (c) 2012-2014 Sam Soffes, http://soff.es
 
 MIT License
 

data/Rakefile

@@ -1,10 +1,4 @@
 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 API"
 task :console do
@@ -14,5 +8,3 @@ task :console do
   ARGV.clear
   IRB.start
 end
-
-task default: :test

data/Readme.markdown

@@ -6,6 +6,8 @@ Huge thanks to [Rahim Sonawalla](https://github.com/rahims) for making [SoCo](ht
 
 [![Code Climate](https://codeclimate.com/github/soffes/sonos.png)](https://codeclimate.com/github/soffes/sonos)
 
+**Note: Currently discovery is broken in Ruby 2.1**
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/lib/sonos.rb

@@ -18,4 +18,16 @@ module Sonos
   # def self.system
   #   @system ||= Sonos::System.new
   # end
+
+  unless defined? @@logging_enabled
+    @@logging_enabled = false
+  end
+
+  def self.logging_enabled
+    @@logging_enabled
+  end
+
+  def self.logging_enabled=(logging)
+    @@logging_enabled = logging
+  end
 end

data/lib/sonos/device/base.rb

@@ -4,7 +4,7 @@ require 'nokogiri'
 module Sonos::Device
   class Base
     attr_reader :ip, :name, :uid, :serial_number, :software_version, :hardware_version,
-      :zone_type, :model_number, :mac_address, :group, :icon
+      :zone_type, :model_number, :mac_address, :group, :icon, :services
 
     attr_accessor :group_master
 
@@ -40,6 +40,7 @@ module Sonos::Device
       @hardware_version = data[:hardware_version]
       @zone_type = data[:zone_type]
       @model_number = data[:model_number]
+      @services = data[:services]
     end
 
     def data
@@ -50,7 +51,8 @@ module Sonos::Device
         software_version: @software_version,
         hardware_version: @hardware_version,
         zone_type: @zone_type,
-        model_number: @model_number
+        model_number: @model_number,
+        services: @services
       }
     end
 
@@ -68,6 +70,10 @@ module Sonos::Device
 
   protected
 
+    def parse_response(response)
+      response.success? ? :success : :failed
+    end
+
     def self.retrieve_information(ip)
       url = "http://#{ip}:#{Sonos::PORT}/xml/device_description.xml"
       parse_description(Nokogiri::XML(open(url)))
@@ -82,7 +88,9 @@ module Sonos::Device
         software_version: doc.xpath('/xmlns:root/xmlns:device/xmlns:hardwareVersion').inner_text,
         hardware_version: doc.xpath('/xmlns:root/xmlns:device/xmlns:softwareVersion').inner_text,
         zone_type: doc.xpath('/xmlns:root/xmlns:device/xmlns:zoneType').inner_text,
-        model_number: doc.xpath('/xmlns:root/xmlns:device/xmlns:modelNumber').inner_text
+        model_number: doc.xpath('/xmlns:root/xmlns:device/xmlns:modelNumber').inner_text,
+        services: doc.xpath('/xmlns:root/xmlns:device/xmlns:serviceList/xmlns:service/xmlns:serviceId').
+          collect(&:inner_text)
       }
     end
   end

data/lib/sonos/device/speaker.rb

@@ -29,7 +29,7 @@ module Sonos::Device
     end
 
     def speaker?
-      true
+      services.include?('urn:upnp-org:serviceId:MusicServices')
     end
 
     def shuffle_on

data/lib/sonos/discovery.rb

@@ -16,14 +16,13 @@ module Sonos
   class Discovery
     MULTICAST_ADDR = '239.255.255.250'
     MULTICAST_PORT = 1900
-    DEFAULT_TIMEOUT = 1
-    DEFAULT_IP = nil
+    DEFAULT_TIMEOUT = 2
 
     attr_reader :timeout
     attr_reader :first_device_ip
     attr_reader :default_ip
 
-    def initialize(timeout = DEFAULT_TIMEOUT,default_ip = DEFAULT_IP)
+    def initialize(timeout = DEFAULT_TIMEOUT, default_ip = nil)
       @timeout = timeout
       @default_ip = default_ip
       initialize_socket
@@ -65,7 +64,8 @@ module Sonos
           end
         end
       rescue Timeout::Error => ex
-        puts "Timeout error; switching to the default IP"
+        puts 'Timed out...'
+        puts 'Switching to the default IP' if @default_ip
         return @default_ip
       end
     end
@@ -74,8 +74,8 @@ module Sonos
       # Create a socket
       @socket = UDPSocket.open
 
-      # We're going to use IP with the multicast TTL. Mystery third parameter is a mystery.
-      @socket.setsockopt(Socket::IPPROTO_IP, Socket::IP_MULTICAST_TTL, 2)
+      # We're going to use IP with the multicast TTL
+      @socket.setsockopt(Socket::Option.new(:INET, :IPPROTO_IP, :IP_MULTICAST_TTL, 2.chr))
     end
 
     def search_message

data/lib/sonos/endpoint/a_v_transport.rb

@@ -36,9 +36,21 @@ module Sonos::Endpoint::AVTransport
     !now_playing.nil?
   end
 
+  # Get information about the state the player is in.
+  def get_player_state
+    response = send_transport_message('GetTransportInfo')
+    body = response.body[:get_transport_info_response]
+
+    {
+      status: body[:current_transport_status],
+      state:  body[:current_transport_state],
+      speed:  body[:current_speed],
+    }
+  end
+
   # Pause the currently playing track.
   def pause
-    send_transport_message('Pause')
+    parse_response send_transport_message('Pause')
   end
 
   # Play the currently selected track or play a stream.
@@ -48,22 +60,26 @@ module Sonos::Endpoint::AVTransport
     set_av_transport_uri(uri) and return if uri
 
     # Play the currently selected track
-    send_transport_message('Play')
+    parse_response send_transport_message('Play')
   end
 
   # Stop playing.
   def stop
-    send_transport_message('Stop')
+    parse_response send_transport_message('Stop')
   end
 
   # Play the next track.
   def next
-    send_transport_message('Next')
+    parse_response send_transport_message('Next')
   end
 
   # Play the previous track.
   def previous
-    send_transport_message('Previous')
+    parse_response send_transport_message('Previous')
+  end
+  
+  def line_in(speaker)
+    set_av_transport_uri('x-rincon-stream:' + speaker.uid.sub('uuid:', ''))
   end
 
   # Seeks to a given timestamp in the current track
@@ -71,24 +87,25 @@ module Sonos::Endpoint::AVTransport
   def seek(seconds = 0)
     # Must be sent in the format of HH:MM:SS
     timestamp = Time.at(seconds).utc.strftime('%H:%M:%S')
-    send_transport_message('Seek', "<Unit>REL_TIME</Unit><Target>#{timestamp}</Target>")
+    parse_response send_transport_message('Seek', "<Unit>REL_TIME</Unit><Target>#{timestamp}</Target>")
   end
 
   # Clear the queue
   def clear_queue
-    send_transport_message('RemoveAllTracksFromQueue')
+    parse_response parse_response send_transport_message('RemoveAllTracksFromQueue')
   end
 
   # Save queue
   def save_queue(title)
-    send_transport_message('SaveQueue', "<Title>#{title}</Title><ObjectID></ObjectID>")
+    parse_response send_transport_message('SaveQueue', "<Title>#{title}</Title><ObjectID></ObjectID>")
   end
 
   # Adds a track to the queue
   # @param[String] uri Uri of track
+  # @param[String] didl Stanza of DIDL-Lite metadata (generally created by #add_spotify_to_queue)
   # @return[Integer] Queue position of the added track
-  def add_to_queue(uri)
-    response = send_transport_message('AddURIToQueue', "<EnqueuedURI>#{uri}</EnqueuedURI><EnqueuedURIMetaData></EnqueuedURIMetaData><DesiredFirstTrackNumberEnqueued>0</DesiredFirstTrackNumberEnqueued><EnqueueAsNext>1</EnqueueAsNext>")
+  def add_to_queue(uri, didl = '')
+    response = send_transport_message('AddURIToQueue', "<EnqueuedURI>#{uri}</EnqueuedURI><EnqueuedURIMetaData>#{didl}</EnqueuedURIMetaData><DesiredFirstTrackNumberEnqueued>0</DesiredFirstTrackNumberEnqueued><EnqueueAsNext>1</EnqueueAsNext>")
     # TODO yeah, this error handling is a bit soft. For consistency's sake :)
     pos = response.xpath('.//FirstTrackNumberEnqueued').text
     if pos.length != 0
@@ -96,16 +113,59 @@ module Sonos::Endpoint::AVTransport
     end
   end
 
+  # Adds a Spotify track to the queue along with extra data for better metadata retrieval
+  # @param[Hash] opts Various options (id, user, region and type)
+  # @return[Integer] Queue position of the added track(s)
+  def add_spotify_to_queue(opts = {})
+    opts = {
+      :id     => '',
+      :user   => nil,
+      :region => nil,
+      :type   => 'track'
+    }.merge(opts)
+
+    # Basic validation of the accepted types; playlists need an associated user
+    # and the toplist (for tracks and albums) need to specify a region.
+    return nil if opts[:type] == 'playlist' and opts[:user].nil?
+    return nil if opts[:type] =~ /toplist_tracks/ and opts[:region].nil?
+
+    # In order for the player to retrieve track duration, artist, album etc
+    # we need to pass it some metadata ourselves.
+    didl_metadata = "&lt;DIDL-Lite xmlns:dc=&quot;http://purl.org/dc/elements/1.1/&quot; xmlns:upnp=&quot;urn:schemas-upnp-org:metadata-1-0/upnp/&quot; xmlns:r=&quot;urn:schemas-rinconnetworks-com:metadata-1-0/&quot; xmlns=&quot;urn:schemas-upnp-org:metadata-1-0/DIDL-Lite/&quot;&gt;&lt;item id=&quot;#{rand(10000000..99999999)}spotify%3a#{opts[:type]}%3a#{opts[:id]}&quot; restricted=&quot;true&quot;&gt;&lt;dc:title&gt;&lt;/dc:title&gt;&lt;upnp:class&gt;object.item.audioItem.musicTrack&lt;/upnp:class&gt;&lt;desc id=&quot;cdudn&quot; nameSpace=&quot;urn:schemas-rinconnetworks-com:metadata-1-0/&quot;&gt;SA_RINCON2311_X_#Svc2311-0-Token&lt;/desc&gt;&lt;/item&gt;&lt;/DIDL-Lite&gt;"
+
+    r_id = rand(10000000..99999999)
+
+    case opts[:type]
+    when /playlist/
+      uri = "x-rincon-cpcontainer:#{r_id}spotify%3auser%3a#{opts[:user]}%3aplaylist%3a#{opts[:id]}"
+    when /toplist_(tracks)/
+      subtype = opts[:type].sub('toplist_', '') # only 'tracks' are supported right now by Sonos.
+      uri = "x-rincon-cpcontainer:#{r_id}toplist%2f#{subtype}%2fregion%2f#{opts[:region]}"
+    when /album/
+      uri = "x-rincon-cpcontainer:#{r_id}spotify%3aalbum%3a#{opts[:id]}"
+    when /artist/
+      uri = "x-rincon-cpcontainer:#{r_id}tophits%3aspotify%3aartist%3a#{opts[:id]}"
+    when /starred/
+      uri = "x-rincon-cpcontainer:#{r_id}starred"
+    when /track/
+      uri = "x-sonos-spotify:spotify%3a#{opts[:type]}%3a#{opts[:id]}"
+    else
+      return nil
+    end
+
+    add_to_queue(uri, didl_metadata)
+   end
+
   # Removes a track from the queue
   # @param[String] object_id Track's queue ID
   def remove_from_queue(object_id)
-    send_transport_message('RemoveTrackFromQueue', "<ObjectID>#{object_id}</ObjectID><UpdateID>0</UpdateID></u:RemoveTrackFromQueue>")
+    parse_response send_transport_message('RemoveTrackFromQueue', "<ObjectID>#{object_id}</ObjectID><UpdateID>0</UpdateID></u:RemoveTrackFromQueue>")
   end
 
   # Join another speaker's group.
   # Trying to call this on a stereo pair slave will fail.
   def join(master)
-    set_av_transport_uri('x-rincon:' + master.uid.sub('uuid:', ''))
+    parse_response set_av_transport_uri('x-rincon:' + master.uid.sub('uuid:', ''))
   end
 
   # Add another speaker to this group.
@@ -117,7 +177,7 @@ module Sonos::Endpoint::AVTransport
   # Ungroup from its current group.
   # Trying to call this on a stereo pair slave will fail.
   def ungroup
-    send_transport_message('BecomeCoordinatorOfStandaloneGroup')
+    parse_response send_transport_message('BecomeCoordinatorOfStandaloneGroup')
   end
 
   private
@@ -128,7 +188,7 @@ module Sonos::Endpoint::AVTransport
   end
 
   def transport_client
-    @transport_client ||= Savon.client endpoint: "http://#{self.group_master.ip}:#{Sonos::PORT}#{TRANSPORT_ENDPOINT}", namespace: Sonos::NAMESPACE, log_level: :error
+    @transport_client ||= Savon.client endpoint: "http://#{self.group_master.ip}:#{Sonos::PORT}#{TRANSPORT_ENDPOINT}", namespace: Sonos::NAMESPACE, log: Sonos.logging_enabled
   end
 
   def send_transport_message(name, part = '<Speed>1</Speed>')

data/lib/sonos/endpoint/alarm.rb

@@ -1,25 +1,3 @@
-# POST /AlarmClock/Control HTTP/1.1
-# SOAPACTION: "urn:schemas-upnp-org:service:AlarmClock:1#ListAlarms"
-
-# Request
-#<?xml version="1.0" encoding="UTF-8"?>
-#<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/" s:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
-#    <s:Body>
-#      <u:ListAlarms xmlns:u="urn:schemas-upnp-org:service:AlarmClock:1" />
-#    </s:Body>
-#</s:Envelope>
-
-# Response
-#<?xml version="1.0" encoding="UTF-8"?>
-#<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/" s:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
-#  <s:Body>
-#    <u:ListAlarmsResponse xmlns:u="urn:schemas-upnp-org:service:AlarmClock:1">
-#      <CurrentAlarmList>&lt;Alarms&gt;&lt;Alarm ID="8" StartTime="19:21:00" Duration="02:00:00" Recurrence="ONCE" Enabled="0" RoomUUID="RINCON_000E583564A601400" ProgramURI="x-rincon-buzzer:0" ProgramMetaData="" PlayMode="SHUFFLE_NOREPEAT" Volume="25" IncludeLinkedZones="0"/&gt;&lt;/Alarms&gt;</CurrentAlarmList>
-#      <CurrentAlarmListVersion>RINCON_000E583564A601400:26</CurrentAlarmListVersion>
-#    </u:ListAlarmsResponse>
-#  </s:Body>
-#</s:Envelope>
-
 module Sonos::Endpoint::Alarm
   ALARM_CLOCK_ENDPOINT = '/AlarmClock/Control'
   ALARM_CLOCK_XMLNS = 'urn:schemas-upnp-org:service:AlarmClock:1'
@@ -49,7 +27,7 @@ module Sonos::Endpoint::Alarm
         hash_of_alarm_hashes[id] = alarm_hash
       end
     end
-    return hash_of_alarm_hashes
+    hash_of_alarm_hashes
   end
 
   def create_alarm(startLocalTime, duration, recurrence, enabled, roomUuid, playMode, volume, includeLinkedZones, programUri, programMetaData)
@@ -57,15 +35,11 @@ module Sonos::Endpoint::Alarm
                :Recurrence => recurrence, :Enabled => enabled, :RoomUUID => roomUuid,
                :PlayMode => playMode, :Volume => volume, :IncludeLinkedZones => includeLinkedZones,
                :ProgramURI => programUri, :ProgramMetaData => programMetaData}
-    #options = {:StartLocalTime => '13:19:00', :Duration => '02:00:00',
-    #           :Recurrence => 'ONCE', :Enabled => 1, :RoomUUID => 'RINCON_000E583564A601400',
-    #           :PlayMode => 'SHUFFLE_NOREPEAT', :Volume => 25, :IncludeLinkedZones => 0,
-    #           :ProgramURI => 'x-rincon-buzzer:0', :ProgramMetaData => ""}
-    send_alarm_message('CreateAlarm', convert_hash_to_xml(options))
+    parse_response send_alarm_message('CreateAlarm', convert_hash_to_xml(options))
   end
 
   def destroy_alarm(id)
-    send_alarm_message('DestroyAlarm', "<ID>#{id}</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)
@@ -73,11 +47,7 @@ module Sonos::Endpoint::Alarm
                   :Recurrence => recurrence, :Enabled => enabled, :RoomUUID => roomUuid,
                   :PlayMode => playMode, :Volume => volume, :IncludeLinkedZones => includeLinkedZones,
                   :ProgramURI => programUri, :ProgramMetaData => programMetaData}
-    #options = {:ID => 8, :StartLocalTime => '13:19:00', :Duration => '02:00:00',
-    #           :Recurrence => 'ONCE', :Enabled => 1, :RoomUUID => 'RINCON_000E583564A601400',
-    #           :PlayMode => 'SHUFFLE_NOREPEAT', :Volume => 25, :IncludeLinkedZones => 0,
-    #           :ProgramURI => 'x-rincon-buzzer:0', :ProgramMetaData => ""}
-    send_alarm_message('UpdateAlarm', convert_hash_to_xml(alarm_hash))
+    parse_response send_alarm_message('UpdateAlarm', convert_hash_to_xml(alarm_hash))
   end
 
   def is_alarm_enabled?(id)
@@ -87,25 +57,25 @@ module Sonos::Endpoint::Alarm
   def enable_alarm(id)
     alarm_hash = list_alarms[id]
     alarm_hash[:Enabled] = '1'
-    send_alarm_message('UpdateAlarm', convert_hash_to_xml(alarm_hash))
+    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'
-    send_alarm_message('UpdateAlarm', convert_hash_to_xml(alarm_hash))
+    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
-    send_alarm_message('UpdateAlarm', convert_hash_to_xml(alarm_hash))
+    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
+    @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 = '')
@@ -121,5 +91,4 @@ module Sonos::Endpoint::Alarm
     end
     updatePart
   end
-
-end
+end

data/lib/sonos/endpoint/content_directory.rb

@@ -31,7 +31,7 @@ module Sonos::Endpoint::ContentDirectory
   private
 
   def content_directory_client
-    @content_directory_client ||= Savon.client endpoint: "http://#{self.ip}:#{Sonos::PORT}#{CONTENT_DIRECTORY_ENDPOINT}", namespace: Sonos::NAMESPACE, log_level: :error
+    @content_directory_client ||= Savon.client endpoint: "http://#{self.ip}:#{Sonos::PORT}#{CONTENT_DIRECTORY_ENDPOINT}", namespace: Sonos::NAMESPACE, log: Sonos.logging_enabled
   end
 
   def parse_items(string)

data/lib/sonos/endpoint/device.rb

@@ -2,16 +2,24 @@ module Sonos::Endpoint::Device
   DEVICE_ENDPOINT = '/DeviceProperties/Control'
   DEVICE_XMLNS = 'urn:schemas-upnp-org:service:DeviceProperties:1'
 
+  # Retrieve the status light state; true if on, false otherwise.
+  def status_light_enabled?
+    response = send_device_message('GetLEDState', '')
+    body = response.body[:get_led_state_response]
+
+    body[:current_led_state] == 'On' ? true : false
+  end
+
   # Turn the white status light on or off
   # @param [Boolean] True to turn on the light. False to turn off the light.
   def status_light_enabled=(enabled)
-    send_device_message('SetLEDState', enabled ? 'On' : 'Off')
+    parse_response send_device_message('SetLEDState', enabled ? 'On' : 'Off')
   end
 
 private
 
   def device_client
-    @device_client ||= Savon.client endpoint: "http://#{self.ip}:#{Sonos::PORT}#{DEVICE_ENDPOINT}", namespace: Sonos::NAMESPACE, log_level: :error
+    @device_client ||= Savon.client endpoint: "http://#{self.ip}:#{Sonos::PORT}#{DEVICE_ENDPOINT}", namespace: Sonos::NAMESPACE, log: Sonos.logging_enabled
   end
 
   def send_device_message(name, value)