sonos 0.1.0 → 0.1.1

data/Changelog.markdown

@@ -1,3 +1,10 @@
+### Version 0.1.1 — Unreleased
+
+* **Feature:** Queue
+* **Feature:** Clear Queue
+* **Feature:** Save Queue
+* **Feature:** Device Description URL
+
 ### Version 0.1.0 — December 24, 2012
 
 * **Feature:** Stop

data/lib/sonos/content_directory.rb

@@ -0,0 +1,55 @@
+module Sonos
+  module ContentDirectory
+    CONTENT_DIRECTORY_ENDPOINT = '/MediaServer/ContentDirectory/Control'
+    CONTENT_DIRECTORY_XMLNS = 'urn:schemas-upnp-org:service:ContentDirectory:1'
+
+    # Get the current queue
+    def queue(starting_index = 0, requested_count = 100)
+      name = 'Browse'
+      action = "#{CONTENT_DIRECTORY_XMLNS}##{name}"
+      message = %Q{<u:#{name} xmlns:u="#{CONTENT_DIRECTORY_XMLNS}"><ObjectID>Q:0</ObjectID><BrowseFlag>BrowseDirectChildren</BrowseFlag><Filter>dc:title,res,dc:creator,upnp:artist,upnp:album,upnp:albumArtURI</Filter><StartingIndex>#{starting_index}</StartingIndex><RequestedCount>#{requested_count}</RequestedCount><SortCriteria></SortCriteria></u:Browse>}
+      result = content_directory_client.call name, soap_action: action, message: message
+      body = result.body[:browse_response]
+
+      hash = {
+        total: body[:total_matches].to_i,
+        items: parse_items(body[:result])
+      }
+
+      # Paginate
+      # TODO: This is ugly and inflexible
+      if starting_index == 0
+        start = starting_index
+        while hash[:items].count < hash[:total]
+          start += requested_count
+          hash[:items] += browse(start, requested_count)[:items]
+        end
+      end
+
+      hash
+    end
+
+  private
+
+    def content_directory_client
+      @content_directory_client ||= Savon.client endpoint: "http://#{self.ip}:#{PORT}#{CONTENT_DIRECTORY_ENDPOINT}", namespace: NAMESPACE
+    end
+
+    def parse_items(string)
+      result = []
+      doc = Nokogiri::XML(string)
+      doc.css('item').each do |item|
+        res = item.css('res').first
+        result << {
+          title: item.xpath('dc:title').inner_text,
+          artist: item.xpath('dc:creator').inner_text,
+          album: item.xpath('upnp:album').inner_text,
+          album_art: "http://#{self.ip}:#{PORT}#{item.xpath('upnp:albumArtURI').inner_text}",
+          duration: res['duration'],
+          id: res.inner_text
+        }
+      end
+      result
+    end
+  end
+end

data/lib/sonos/speaker.rb

@@ -2,12 +2,14 @@ require 'savon'
 require 'sonos/transport'
 require 'sonos/rendering'
 require 'sonos/device'
+require 'sonos/content_directory'
 
 module Sonos
   class Speaker
     include Transport
     include Rendering
     include Device
+    include ContentDirectory
 
     attr_reader :ip, :zone_name, :zone_icon, :uid, :serial_number, :software_version, :hardware_version, :mac_address
 
@@ -18,6 +20,11 @@ module Sonos
       get_status
     end
 
+    # URL for giant dump of device information
+    def device_description_url
+      "http://#{self.ip}:#{PORT}/xml/device_description.xml"
+    end
+
   private
 
     # Get information about the speaker.

data/lib/sonos/transport.rb

@@ -52,6 +52,19 @@ module Sonos
       send_transport_message('Previous')
     end
 
+    # Clear the queue
+    def clear_queue
+      send_transport_message('RemoveAllTracksFromQueue')
+    end
+
+    # 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)
+    end
+
   private
 
     # Play a stream.

data/lib/sonos/version.rb

@@ -1,3 +1,3 @@
 module Sonos
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

data/sonos.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |gem|
   gem.version       = Sonos::VERSION
   gem.authors       = ['Sam Soffes']
   gem.email         = ['sam@soff.es']
-  gem.description   = 'Sonos Controller'
-  gem.summary       = 'Control Sonos speakers with Ruby'
+  gem.description   = 'Control Sonos speakers with Ruby'
+  gem.summary       = gem.description
   gem.homepage      = 'https://github.com/soffes/sonos'
 
   gem.files         = `git ls-files`.split($/)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sonos
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -27,7 +27,7 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 2.0.2
-description: Sonos Controller
+description: Control Sonos speakers with Ruby
 email:
 - sam@soff.es
 executables: []
@@ -41,6 +41,7 @@ files:
 - Rakefile
 - Readme.markdown
 - lib/sonos.rb
+- lib/sonos/content_directory.rb
 - lib/sonos/device.rb
 - lib/sonos/rendering.rb
 - lib/sonos/speaker.rb
@@ -61,7 +62,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1995798408343589310
+      hash: -921214504657487484
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -70,7 +71,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1995798408343589310
+      hash: -921214504657487484
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23