sonos 0.2.1 → 0.3.0

data/.travis.yml

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

data/Changelog.markdown

@@ -1,3 +1,10 @@
+### Version 0.3.0 — February 2, 2012
+
+* System owns groups that reflect the topology
+* Group and ungroup speakers
+* Rename `playlist_position` to `queue_position` for consistency
+* Add `seek`
+
 ### Version 0.2.1 — December 24, 2012
 
 * Fix album art in now playing

data/Gemfile

@@ -1,7 +1,17 @@
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in control.gemspec
+# 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/Rakefile

@@ -1 +1,8 @@
 require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+end
+task default: :test

data/Readme.markdown

@@ -4,6 +4,8 @@ Control Sonos speakers with Ruby.
 
 Huge thanks to [Rahim Sonawalla](https://github.com/rahims) for making [SoCo](https://github.com/rahims/SoCo). This gem would not be possible without his work.
 
+[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/soffes/sonos) [![Dependency Status](https://gemnasium.com/soffes/sonos.png)](https://gemnasium.com/soffes/sonos)
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -36,7 +38,8 @@ $ irb
 ``` ruby
 require 'rubygems'
 require 'sonos'
-speaker = Sonos.discover
+system = Sonos::System.new # Auto-discovers your system
+speaker = system.speakers.first
 ```
 
 Now that we have a reference to the speaker, we can do all kinds of stuff.
@@ -56,41 +59,48 @@ speaker.clear_queue
 
 ### Topology
 
-`Sonos.discover` finds the first speaker it can. We can get all of the Sonos devices (including Bridges, etc) by calling `speaker.topology`. This is going to get refactored a bit. Right now everything is nested under speaker which is kinda messy and confusing.
+`Sonos.discover` finds the first speaker it can. We can get all of the Sonos devices (including Bridges, etc) by calling `Sonos.system.devices`. To get the groups, call `Sonos.system.groups`.
+
+All of this is based off of the raw `Sonos.system.topology`.
 
 ### CLI
 
-There is a very limited CLI right now. You can run `sonos discover` to get the IP of one of your devices. Run `sonos discover --all` to get all of them.
+There is a very limited CLI right now. You can run `sonos devices` to get the IP of all of your devices.
+
+You can also run `sonos pause_all` to pause all your Sonos groups.
 
 ## To Do
 
 ### General
 
-* Refactor all of the things
-* Nonblocking calls with Celluloid::IO
-* List other speakers
 * Handle errors better
 * Handle line-in in `now_playing`
-* Better support for stero pairs
+* Detect fixed volume
+* Detect stereo pair
 * CLI client for everything
+* Nonblocking calls with Celluloid::IO
 
 ### Features
 
-* Alarm clock
+* Manipulating groups doesn't update `System#groups`
 * Pause all (there is no play all in the controller, we could loop through and do it though)
-* Group management
-    * Party Mode
-    * Join
+* Party Mode
 * Line-in
 * Toggle cross fade
 * Toggle shuffle
 * Set repeat mode
-* Scrub
 * Search music library
 * Browse music library
 * Add songs to queue
 * Skip to song in queue
+* Alarm clock
 * Sleep timer
+* Pandora doesn't use the Queue. I bet things are all jacked up.
+* CONNECT (and possibly PLAY:5) line in settings
+    * Source name
+    * Level
+    * Autoplay room
+    * Autoplay include grouped rooms
 
 ### Maybe
 
@@ -98,14 +108,16 @@ If we are implementing everything the official Sonos Controller does, here's som
 
 * Set zone name and icon
 * Create stero pair
-* Support for BRIDGE
+* Support for SUB
 * Support for DOCK
+* Support for CONNECT:AMP (not sure if this is any different from CONNECT)
 * Manage services
 * Date and time
 * Wireless channel
 * Audio compression
 * Automatically check for updates (not sure if this is a controller only preference)
 * Local music servers
+* Add component
 
 ## Contributing
 

data/lib/sonos/cli.rb

@@ -3,18 +3,29 @@ require 'sonos'
 
 module Sonos
   class Cli < Thor
-    desc 'discover', 'Finds the IP address of a Sonos device on your network'
-    method_option :all, type: :boolean, aliases: '-a', desc: 'Find all of the IP address instead of the first one discoverd'
-    def discover
-      speaker = Sonos.discover
+    desc 'devices', 'Finds the IP address of all of the Sonos devices on your network'
+    def devices
+      system.devices.each do |device|
+        puts device.name.ljust(20) + device.ip
+      end
+    end
 
-      if options[:all]
-        speaker.topology.each do |node|
-          puts "#{node.name.ljust(20)} #{node.ip}"
-        end
-      else
-        puts "#{speaker.zone_name.ljust(20)} #{speaker.ip}"
+    desc 'speakers', 'Finds the IP address of all of the Sonos speakers on your network'
+    def speakers
+      system.speakers.each do |speaker|
+        puts speaker.name.ljust(20) + speaker.ip
       end
     end
+
+    desc 'pause_all', 'Pauses all Sonos speaker groups'
+    def pause_all
+    	system.pause_all
+    end
+
+  private
+
+    def system
+      @system ||= Sonos::System.new
+    end
   end
 end

data/lib/sonos/device/base.rb

@@ -0,0 +1,79 @@
+require 'open-uri'
+require 'nokogiri'
+
+module Sonos::Device
+  class Base
+    attr_reader :ip, :name, :uid, :serial_number, :software_version, :hardware_version, :mac_address, :group
+
+    def self.detect(ip)
+      data = retrieve_information(ip)
+      model_number = data[:model_number]
+
+      if Bridge.model_numbers.include?(model_number)
+        Bridge.new(ip, data)
+      elsif Speaker.model_numbers.include?(model_number)
+        Speaker.new(ip, data)
+      else
+        raise ArgumentError.new("#{self.data[:model_number]} not supported")
+      end
+    end
+
+    def initialize(ip, data = nil)
+      @ip = ip
+
+      if data.nil?
+        self.data = Base.retrieve_information(ip)
+      else
+        self.data = data
+      end
+    end
+
+    def data=(data)
+      @name = data[:name]
+      @uid = data[:uid]
+      @serial_number = data[:serial_number]
+      @software_version = data[:software_version]
+      @hardware_version = data[:hardware_version]
+      @zone_type = data[:zone_type]
+      @model_number = data[:model_number]
+    end
+
+    def data
+      {
+        name: @name,
+        uid: @uid,
+        serial_number: @serial_number,
+        software_version: @software_version,
+        hardware_version: @hardware_version,
+        zone_type: @zone_type,
+        model_number: @model_number
+      }
+    end
+
+    # Can this device play music?
+    # @return [Boolean] a boolean indicating if it can play music
+    def speaker?
+      false
+    end
+
+  protected
+
+    def self.retrieve_information(ip)
+      url = "http://#{ip}:#{Sonos::PORT}/xml/device_description.xml"
+      parse_description(Nokogiri::XML(open(url)))
+    end
+
+    # Get information about the device
+    def self.parse_description(doc)
+      {
+        name: doc.xpath('/xmlns:root/xmlns:device/xmlns:roomName').inner_text,
+        uid: doc.xpath('/xmlns:root/xmlns:device/xmlns:UDN').inner_text,
+        serial_number: doc.xpath('/xmlns:root/xmlns:device/xmlns:serialNum').inner_text,
+        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
+      }
+    end
+  end
+end

data/lib/sonos/device/bridge.rb

@@ -0,0 +1,17 @@
+require 'savon'
+require 'sonos/endpoint'
+
+module Sonos::Device
+
+  # Used for Zone Bridge
+  class Bridge < Base
+
+    MODEL_NUMBERS = ['ZB100']
+
+    attr_reader :icon
+
+    def self.model_numbers
+      MODEL_NUMBERS
+    end
+  end
+end

data/lib/sonos/device/speaker.rb

@@ -0,0 +1,25 @@
+require 'savon'
+require 'sonos/endpoint'
+
+module Sonos::Device
+
+  # Used for PLAY:3, PLAY:5, and CONNECT
+  class Speaker < Base
+    include Sonos::Endpoint::AVTransport
+    include Sonos::Endpoint::Rendering
+    include Sonos::Endpoint::Device
+    include Sonos::Endpoint::ContentDirectory
+
+    MODEL_NUMBERS = ['S3', 'S5', 'ZP90']
+
+    attr_reader :icon
+
+    def self.model_numbers
+      MODEL_NUMBERS
+    end
+
+    def speaker?
+      true
+    end
+  end
+end

data/lib/sonos/device.rb

@@ -0,0 +1,8 @@
+module Sonos
+  module Device
+  end
+end
+
+require 'sonos/device/base'
+require 'sonos/device/speaker'
+require 'sonos/device/bridge'

data/lib/sonos/discovery.rb

@@ -1,6 +1,7 @@
 require 'socket'
 require 'ipaddr'
 require 'timeout'
+require 'sonos/topology_node'
 
 #
 # Inspired by https://github.com/rahims/SoCo, https://github.com/turboladen/upnp,
@@ -18,17 +19,29 @@ module Sonos
     DEFAULT_TIMEOUT = 1
 
     attr_reader :timeout
+    attr_reader :first_device_ip
 
-    def initialize(timeout = nil)
-      @timeout = timeout || DEFAULT_TIMEOUT
-
+    def initialize(timeout = DEFAULT_TIMEOUT)
+      @timeout = timeout
       initialize_socket
     end
 
+    # Look for Sonos devices on the network and return the first IP address found
+    # @return [String] the IP address of the first Sonos device found
     def discover
       send_discovery_message
-      result = listen_for_responses
-      Sonos::Speaker.new(result) if result
+      @first_device_ip = listen_for_responses
+    end
+
+    # Find all of the Sonos devices on the network
+    # @return [Array] an array of TopologyNode objects
+    def topology
+      self.discover unless @first_device_ip
+
+      doc = Nokogiri::XML(open("http://#{@first_device_ip}:#{Sonos::PORT}/status/topology"))
+      doc.xpath('//ZonePlayers/ZonePlayer').map do |node|
+        TopologyNode.new(node)
+      end
     end
 
   private

data/lib/sonos/endpoint/{transport.rb → a_v_transport.rb}

@@ -1,6 +1,6 @@
 require 'uri'
 
-module Sonos::Endpoint::Transport
+module Sonos::Endpoint::AVTransport
   TRANSPORT_ENDPOINT = '/MediaRenderer/AVTransport/Control'
   TRANSPORT_XMLNS = 'urn:schemas-upnp-org:service:AVTransport:1'
 
@@ -20,7 +20,7 @@ module Sonos::Endpoint::Transport
       title: doc.xpath('//dc:title').inner_text,
       artist: doc.xpath('//dc:creator').inner_text,
       album: doc.xpath('//upnp:album').inner_text,
-      playlist_position: body[:track],
+      queue_position: body[:track],
       track_duration: body[:track_duration],
       current_position: body[:rel_time],
       uri: body[:track_uri],
@@ -58,6 +58,16 @@ module Sonos::Endpoint::Transport
     send_transport_message('Previous')
   end
 
+  # Seeks to a given timestamp in the current track
+  # @param [Fixnum] seconds
+  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>")
+
+  end
+
   # Clear the queue
   def clear_queue
     send_transport_message('RemoveAllTracksFromQueue')
@@ -65,30 +75,41 @@ module Sonos::Endpoint::Transport
 
   # Save queue
   def save_queue(title)
-    name = 'SaveQueue'
-    action = "#{TRANSPORT_XMLNS}##{name}"
-    message = %Q{<u:#{name} xmlns:u="#{TRANSPORT_XMLNS}"><InstanceID>0</InstanceID><Title>#{title}</Title><ObjectID></ObjectID></u:#{name}>}
-    transport_client.call(name, soap_action: action, message: message)
+    send_transport_message('SaveQueue', "<Title>#{title}</Title><ObjectID></ObjectID>")
+  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:', ''))
+  end
+
+  # Add another speaker to this group.
+  # Trying to call this on a stereo pair slave will fail.
+  def group(slave)
+    slave.join(self)
+  end
+
+  # Ungroup from its current group.
+  # Trying to call this on a stereo pair slave will fail.
+  def ungroup
+    send_transport_message('BecomeCoordinatorOfStandaloneGroup')
   end
 
 private
 
   # Play a stream.
   def set_av_transport_uri(uri)
-    name = 'SetAVTransportURI'
-    action = "#{TRANSPORT_XMLNS}##{name}"
-    message = %Q{<u:#{name} xmlns:u="#{TRANSPORT_XMLNS}"><InstanceID>0</InstanceID><CurrentURI>#{uri}</CurrentURI><CurrentURIMetaData></CurrentURIMetaData></u:#{name}>}
-    transport_client.call(name, soap_action: action, message: message)
-    self.play
+    send_transport_message('SetAVTransportURI', "<CurrentURI>#{uri}</CurrentURI><CurrentURIMetaData></CurrentURIMetaData>")
   end
 
   def transport_client
     @transport_client ||= Savon.client endpoint: "http://#{self.ip}:#{Sonos::PORT}#{TRANSPORT_ENDPOINT}", namespace: Sonos::NAMESPACE
   end
 
-  def send_transport_message(name)
+  def send_transport_message(name, part = '<Speed>1</Speed>')
     action = "#{TRANSPORT_XMLNS}##{name}"
-    message = %Q{<u:#{name} xmlns:u="#{TRANSPORT_XMLNS}"><InstanceID>0</InstanceID><Speed>1</Speed></u:#{name}>}
+    message = %Q{<u:#{name} xmlns:u="#{TRANSPORT_XMLNS}"><InstanceID>0</InstanceID>#{part}</u:#{name}>}
     transport_client.call(name, soap_action: action, message: message)
   end
 end

data/lib/sonos/endpoint/rendering.rb

@@ -3,6 +3,7 @@ module Sonos::Endpoint::Rendering
   RENDERING_XMLNS = 'urn:schemas-upnp-org:service:RenderingControl:1'
 
   # Get the current volume.
+  # Fixed volume speakers will always return 100.
   # @return [Fixnum] the volume from 0 to 100
   def volume
     response = send_rendering_message('GetVolume')
@@ -10,6 +11,7 @@ module Sonos::Endpoint::Rendering
   end
 
   # Set the volume from 0 to 100.
+  # Trying to set the volume of a fixed volume speaker will fail.
   # @param [Fixnum] the desired volume from 0 to 100
   def volume=(value)
     send_rendering_message('SetVolume', value)

data/lib/sonos/endpoint.rb

@@ -6,4 +6,4 @@ end
 require 'sonos/endpoint/content_directory'
 require 'sonos/endpoint/device'
 require 'sonos/endpoint/rendering'
-require 'sonos/endpoint/transport'
+require 'sonos/endpoint/a_v_transport'

data/lib/sonos/group.rb

@@ -0,0 +1,48 @@
+module Sonos
+  # Represents a Sonos group. A group can contain one or more speakers. All speakers in a group
+  # play the same music in sync.
+  class Group
+    # The master speaker in the group
+    attr_reader :master_speaker
+
+    # All other speakers in the group
+    attr_reader :slave_speakers
+
+    def initialize(master_speaker, slave_speakers)
+      @master_speaker = master_speaker
+      @slave_speakers = (slave_speakers or [])
+    end
+
+    # All of the speakers in the group
+    def speakers
+      [self.master_speaker] + self.slave_speakers
+    end
+
+    # Remove all speakers from the group
+    def disband
+      self.slave_speakers.each do |speaker|
+        speaker.ungroup
+      end
+    end
+
+    # Full group name
+    def name
+      self.speakers.collect(&:name).uniq.join(', ')
+    end
+
+    # Forward AVTransport methods to the master speaker
+    %w{now_playing pause stop next previous queue clear_queue}.each do |method|
+      define_method(method) do
+        self.master_speaker.send(method.to_sym)
+      end
+    end
+
+    def play(uri = nil)
+      self.master_speaker.play(uri)
+    end
+
+    def save_queue(name)
+      self.master_speaker.save_queue(name)
+    end
+  end
+end

data/lib/sonos/system.rb

@@ -0,0 +1,59 @@
+module Sonos
+  # The Sonos system. The root object to manage the collection of groups and devices. This is
+  # intended to be a singleton accessed from `Sonos.system`.
+  class System
+    attr_reader :topology
+    attr_reader :groups
+    attr_reader :devices
+
+    # Initialize the system
+    # @param [Array] the system topology. If this is nil, it will autodiscover.
+    def initialize(topology = Discovery.new.topology)
+      @topology = topology
+      @groups = []
+      @devices = @topology.collect(&:device)
+
+      construct_groups
+    end
+
+    # Returns all speakers
+    def speakers
+      @devices.select(&:speaker?)
+    end
+
+    # Pause all speakers
+    def pause_all
+      self.groups.each do |group|
+        group.pause
+      end
+    end
+
+  private
+
+    def construct_groups
+      # Loop through all of the unique groups
+      @topology.collect(&:group).uniq.each do |group_uid|
+        master_uuid = group_uid.split(':').first
+        nodes = []
+        master = nil
+
+        @topology.each do |node|
+          # Select all of the nodes with this group uid
+          next unless node.group == group_uid
+
+          if node.uuid == master_uuid
+            master = node
+          else
+            nodes << node
+          end
+        end
+
+        # Skip this group if there are no nodes or master
+        next if nodes.empty? or master.nil?
+
+        # Add the group
+        @groups << Group.new(master.device, nodes.collect(&:device))
+      end
+    end
+  end
+end

data/lib/sonos/topology_node.rb

@@ -0,0 +1,21 @@
+module Sonos
+  class TopologyNode
+    attr_accessor :name, :group, :coordinator, :location, :version, :uuid
+
+    def initialize(node)
+      node.attributes.each do |k, v|
+        self.send("#{k}=", v.inner_text) if self.respond_to?(k.to_sym)
+      end
+
+      self.name = node.inner_text
+    end
+
+    def ip
+      @ip ||= URI.parse(location).host
+    end
+
+    def device
+      @device || Device::Base.detect(ip)
+    end
+  end
+end

data/lib/sonos/version.rb

@@ -1,3 +1,3 @@
 module Sonos
-  VERSION = '0.2.1'
+  VERSION = '0.3.0'
 end

data/lib/sonos.rb

@@ -1,16 +1,21 @@
 require 'sonos/version'
-require 'sonos/speaker'
+require 'sonos/system'
 require 'sonos/discovery'
+require 'sonos/device'
+require 'sonos/group'
 
 module Sonos
   PORT = 1400
   NAMESPACE = 'http://www.sonos.com/Services/1.1'
 
-  def self.Speaker(ip)
-    Speaker.new(ip)
-  end
+  # # Create a new speaker with it's IP address
+  # # @param [String] the speaker's IP address
+  # def self.speaker(ip)
+  #   Device::Speaker.new(ip)
+  # end
 
-  def self.discover
-    Sonos::Discovery.new.discover
-  end
+  # # Get the Sonos system
+  # def self.system
+  #   @system ||= Sonos::System.new
+  # end
 end

data/sonos.gemspec

@@ -11,12 +11,14 @@ Gem::Specification.new do |gem|
   gem.description   = 'Control Sonos speakers with Ruby'
   gem.summary       = gem.description
   gem.homepage      = 'https://github.com/soffes/sonos'
+  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'