sonos 0.0.1 → 0.1.0

data/Changelog.markdown

@@ -0,0 +1,21 @@
+### Version 0.1.0 — December 24, 2012
+
+* **Feature:** Stop
+* **Feature:** Next
+* **Feature:** Previous
+* **Feature:** Mute
+* **Feature:** Status Light
+* **Feature:** Bass
+* **Feature:** Treble
+* Remove some method aliases
+
+### Version 0.0.1 — December 23, 2012
+
+Initial release.
+
+* **Feature:** Volume
+* **Feature:** Play
+* **Feature:** Play Stream
+* **Feature:** Pause
+* **Feature:** Now Playing
+

data/Gemfile

@@ -4,3 +4,4 @@ source 'https://rubygems.org'
 gemspec
 
 gem 'rake'
+gem 'yard'

data/Readme.markdown

@@ -2,21 +2,27 @@
 
 Control Sonos speakers with Ruby.
 
-Huge thanks to [Rahim Sonawalla](https://github.com/rahims) for making [SoCo](https://github.com/rahims/SoCo). Control would not be possible without his work.
+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.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'sonos'
+``` ruby
+gem 'sonos'
+```
 
 And then execute:
 
-    $ bundle
+``` shell
+$ bundle
+```
 
 Or install it yourself as:
 
-    $ gem install sonos
+``` shell
+$ gem install sonos
+```
 
 ## Usage
 
@@ -28,25 +34,30 @@ $ irb
 ```
 
 ``` ruby
-> require 'rubygems'
-> require 'sonos'
-> speaker = Sonos::Speaker('10.0.1.10') # or whatever the IP is
+require 'rubygems'
+require 'sonos'
+speaker = Sonos::Speaker('10.0.1.10') # or whatever the IP is
 ```
 
 Now that we have a reference to the speaker, we can do all kinds of stuff.
 
 ``` ruby
-> speaker.pause # Pause whatever is playing
-> speaker.play  # Resumes the playlist
-> speaker.play 'http://assets.samsoff.es/music/Airports.mp3' # Stream!
-> speaker.now_playing
-> speaker.volume
-> speaker.volume = 70
-> speaker.volume -= 10
+speaker.pause # Pause whatever is playing
+speaker.play  # Resumes the playlist
+speaker.play 'http://assets.samsoff.es/music/Airports.mp3' # Stream!
+speaker.now_playing
+speaker.volume
+speaker.volume = 70
+speaker.volume -= 10
 ```
 
-## Todo
+## To Do
 
+* Loudness
+* Party Mode
+* Join
+* Line-in
+* Handle errors better
 * Fix album art in `now_playing`
 * Handle line-in in `now_playing`
 * Auto-discovery

data/lib/sonos.rb

@@ -2,8 +2,8 @@ require 'sonos/version'
 require 'sonos/speaker'
 
 module Sonos
-  PORT = 1400.freeze
-  NAMESPACE = 'http://www.sonos.com/Services/1.1'.freeze
+  PORT = 1400
+  NAMESPACE = 'http://www.sonos.com/Services/1.1'
 
   def self.Speaker(ip)
     Speaker.new(ip)

data/lib/sonos/device.rb

@@ -0,0 +1,25 @@
+module Sonos
+  module Device
+    DEVICE_ENDPOINT = '/DeviceProperties/Control'
+    DEVICE_XMLNS = 'urn:schemas-upnp-org:service:DeviceProperties:1'
+
+    # 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')
+    end
+
+  private
+
+    def device_client
+      @device_client ||= Savon.client endpoint: "http://#{self.ip}:#{PORT}#{DEVICE_ENDPOINT}", namespace: NAMESPACE
+    end
+
+    def send_device_message(name, value)
+      action = "#{DEVICE_XMLNS}##{name}"
+      attribute = name.sub('Set', '')
+      message = %Q{<u:#{name} xmlns:u="#{DEVICE_XMLNS}"><Desired#{attribute}>#{value}</Desired#{attribute}>}
+      device_client.call(name, soap_action: action, message: message)
+    end
+  end
+end

data/lib/sonos/rendering.rb

@@ -0,0 +1,88 @@
+module Sonos
+  module Rendering
+    RENDERING_ENDPOINT = '/MediaRenderer/RenderingControl/Control'
+    RENDERING_XMLNS = 'urn:schemas-upnp-org:service:RenderingControl:1'
+
+    # Get the current volume.
+    # @return [Fixnum] the volume from 0 to 100
+    def volume
+      response = send_rendering_message('GetVolume')
+      response.body[:get_volume_response][:current_volume].to_i
+    end
+
+    # Set the volume from 0 to 100.
+    # @param [Fixnum] the desired volume from 0 to 100
+    def volume=(value)
+      send_rendering_message('SetVolume', value)
+    end
+
+    # Get the current bass EQ.
+    # @return [Fixnum] the base EQ from -10 to 10
+    def bass
+      response = send_rendering_message('GetBass')
+      response.body[:get_bass_response][:current_bass].to_i
+    end
+
+    # Set the bass EQ from -10 to 10.
+    # @param [Fixnum] the desired bass EQ from -10 to 10
+    def bass=(value)
+      send_rendering_message('SetBass', value)
+    end
+
+    # Get the current treble EQ.
+    # @return [Fixnum] the treble EQ from -10 to 10
+    def treble
+      response = send_rendering_message('GetTreble')
+      response.body[:get_treble_response][:current_treble].to_i
+    end
+
+    # Set the treble EQ from -10 to 10.
+    # @param [Fixnum] the desired treble EQ from -10 to 10
+    def treble=(value)
+      send_rendering_message('SetTreble', value)
+    end
+
+    # Mute the speaker
+    def mute
+      set_mute(true)
+    end
+
+    # Unmute the speaker
+    def unmute
+      set_mute(false)
+    end
+
+    # Is the speaker muted?
+    # @return [Boolean] true if the speaker is muted and false if it is not
+    def muted?
+      response = send_rendering_message('GetMute')
+      response.body[:get_mute_response][:current_mute] == '1'
+    end
+
+  private
+
+    # Sets the speaker's mute
+    # @param [Boolean] if the speaker is muted or not
+    def set_mute(value)
+      send_rendering_message('SetMute', value ? 1 : 0)
+    end
+
+    def rendering_client
+      @rendering_client ||= Savon.client endpoint: "http://#{self.ip}:#{PORT}#{RENDERING_ENDPOINT}", namespace: NAMESPACE
+    end
+
+    def send_rendering_message(name, value = nil)
+      action = "#{RENDERING_XMLNS}##{name}"
+      message = %Q{<u:#{name} xmlns:u="#{RENDERING_XMLNS}"><InstanceID>0</InstanceID><Channel>Master</Channel>}
+
+      if value
+        attribute = name.sub('Set', '')
+        message += %Q{<Desired#{attribute}>#{value}</Desired#{attribute}></u:#{name}>}
+      else
+        message += %Q{</u:#{name}>}
+      end
+
+      rendering_client.call(name, soap_action: action, message: message)
+    end
+  end
+end

data/lib/sonos/speaker.rb

@@ -1,124 +1,37 @@
 require 'savon'
+require 'sonos/transport'
+require 'sonos/rendering'
+require 'sonos/device'
 
 module Sonos
   class Speaker
-    TRANSPORT_ENDPOINT = '/MediaRenderer/AVTransport/Control'.freeze
-    RENDERING_ENDPOINT = '/MediaRenderer/RenderingControl/Control'.freeze
-    DEVICE_ENDPOINT = '/DeviceProperties/Control'.freeze
+    include Transport
+    include Rendering
+    include Device
 
-    attr_accessor :zone_name, :zone_icon, :uid, :serial_number, :software_version, :hardware_version, :mac_address
+    attr_reader :ip, :zone_name, :zone_icon, :uid, :serial_number, :software_version, :hardware_version, :mac_address
 
     def initialize(ip)
       @ip = ip
 
-      # Get meta data
-      self.get_speaker_info
+      # Get the speaker's status
+      get_status
     end
 
-    #
-    # Get information about the currently playing track.
-    #
-    def get_position_info
-      action = 'urn:schemas-upnp-org:service:AVTransport:1#GetPositionInfo'
-      message = '<u:GetPositionInfo xmlns:u="urn:schemas-upnp-org:service:AVTransport:1"><InstanceID>0</InstanceID><Channel>Master</Channel></u:GetPositionInfo>'
-      response = transport_client.call(:get_position_info, soap_action: action, message: message)
-      body = response.body[:get_position_info_response]
-      doc = Nokogiri::XML(body[:track_meta_data])
-
-      {
-        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],
-        track_duration: body[:track_duration],
-        current_position: body[:rel_time],
-        uri: body[:track_uri],
-        album_art: "http://#{@ip}:#{PORT}#{doc.xpath('//upnp:albumArtURI').inner_text}"
-      }
-    end
-    alias_method :now_playing, :get_position_info
-
-    #
-    # Pause the currently playing track.
-    #
-    def pause
-      action = 'urn:schemas-upnp-org:service:AVTransport:1#Pause'
-      message = '<u:Pause xmlns:u="urn:schemas-upnp-org:service:AVTransport:1"><InstanceID>0</InstanceID><Speed>1</Speed></u:Pause>'
-      transport_client.call(:play, soap_action: action, message: message)
-    end
-
-    #
-    # Play the currently selected track or play a stream.
-    #
-    def play(uri = nil)
-      # Play a song from the uri
-      if uri
-        self.set_av_transport_uri(uri)
-        return
-      end
-
-      # Play the currently selected track
-      action = 'urn:schemas-upnp-org:service:AVTransport:1#Play'
-      message = '<u:Play xmlns:u="urn:schemas-upnp-org:service:AVTransport:1"><InstanceID>0</InstanceID><Speed>1</Speed></u:Play>'
-      transport_client.call(:play, soap_action: action, message: message)
-    end
-
-    #
-    # Play a stream.
-    #
-    def set_av_transport_uri(uri)
-      action = 'urn:schemas-upnp-org:service:AVTransport:1#SetAVTransportURI'
-      message = %Q{<u:SetAVTransportURI xmlns:u="urn:schemas-upnp-org:service:AVTransport:1"><InstanceID>0</InstanceID><CurrentURI>#{uri}</CurrentURI><CurrentURIMetaData></CurrentURIMetaData></u:SetAVTransportURI>}
-      transport_client.call(:set_av_transport_uri, soap_action: action, message: message)
-      self.play
-    end
-    alias_method :play_stream, :set_av_transport_uri
+  private
 
-    #
-    # Get information about the Sonos speaker.
-    #
-    def get_speaker_info
+    # Get information about the speaker.
+    def get_status
       doc = Nokogiri::XML(open("http://#{@ip}:1400/status/zp"))
 
-      self.zone_name = doc.xpath('.//ZoneName').inner_text
-      self.zone_icon = doc.xpath('.//ZoneIcon').inner_text
-      self.uid = doc.xpath('.//LocalUID').inner_text
-      self.serial_number = doc.xpath('.//SerialNumber').inner_text
-      self.software_version = doc.xpath('.//SoftwareVersion').inner_text
-      self.hardware_version = doc.xpath('.//HardwareVersion').inner_text
-      self.mac_address = doc.xpath('.//MACAddress').inner_text
+      @zone_name = doc.xpath('.//ZoneName').inner_text
+      @zone_icon = doc.xpath('.//ZoneIcon').inner_text
+      @uid = doc.xpath('.//LocalUID').inner_text
+      @serial_number = doc.xpath('.//SerialNumber').inner_text
+      @software_version = doc.xpath('.//SoftwareVersion').inner_text
+      @hardware_version = doc.xpath('.//HardwareVersion').inner_text
+      @mac_address = doc.xpath('.//MACAddress').inner_text
       self
     end
-
-    #
-    # Get the current volume.
-    #
-    def get_volume
-      action = 'urn:schemas-upnp-org:service:RenderingControl:1#GetVolume'
-      message = '<u:GetVolume xmlns:u="urn:schemas-upnp-org:service:RenderingControl:1"><InstanceID>0</InstanceID><Channel>Master</Channel></u:GetVolume>'
-      response = rendering_client.call(:get_volume, soap_action: action, message: message)
-      response.body[:get_volume_response][:current_volume].to_i
-    end
-    alias_method :volume, :get_volume
-
-    #
-    # Set the volume from 0 to 100.
-    #
-    def set_volume(level)
-      action = 'urn:schemas-upnp-org:service:RenderingControl:1#SetVolume'
-      message = %Q{<u:SetVolume xmlns:u="urn:schemas-upnp-org:service:RenderingControl:1"><InstanceID>0</InstanceID><Channel>Master</Channel><DesiredVolume>#{level}</DesiredVolume></u:SetVolume>}
-      rendering_client.call(:set_volume, soap_action: action, message: message)
-    end
-    alias_method :volume=, :set_volume
-
-  private
-
-    def transport_client
-      @transport_client ||= Savon.client endpoint: "http://#{@ip}:#{PORT}#{TRANSPORT_ENDPOINT}", namespace: NAMESPACE
-    end
-
-    def rendering_client
-      @rendering_client ||= Savon.client endpoint: "http://#{@ip}:#{PORT}#{RENDERING_ENDPOINT}", namespace: NAMESPACE
-    end
   end
 end

data/lib/sonos/transport.rb

@@ -0,0 +1,76 @@
+module Sonos
+  module Transport
+    TRANSPORT_ENDPOINT = '/MediaRenderer/AVTransport/Control'
+    TRANSPORT_XMLNS = 'urn:schemas-upnp-org:service:AVTransport:1'
+
+    # Get information about the currently playing track.
+    # @return [Hash] information about the current track.
+    def now_playing
+      response = send_transport_message('GetPositionInfo')
+      body = response.body[:get_position_info_response]
+      doc = Nokogiri::XML(body[:track_meta_data])
+
+      {
+        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],
+        track_duration: body[:track_duration],
+        current_position: body[:rel_time],
+        uri: body[:track_uri],
+        album_art: "http://#{self.ip}:#{PORT}#{doc.xpath('//upnp:albumArtURI').inner_text}"
+      }
+    end
+
+    # Pause the currently playing track.
+    def pause
+      send_transport_message('Pause')
+    end
+
+    # Play the currently selected track or play a stream.
+    # @param [String] optional uri of the track to play. Leaving this blank, plays the current track.
+    def play(uri = nil)
+      # Play a song from the uri
+      set_av_transport_uri(uri) and return if uri
+
+      # Play the currently selected track
+      send_transport_message('Play')
+    end
+
+    # Stop playing.
+    def stop
+      send_transport_message('Stop')
+    end
+
+    # Play the next track.
+    def next
+      send_transport_message('Next')
+    end
+
+    # Play the previous track.
+    def previous
+      send_transport_message('Previous')
+    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
+    end
+
+    def transport_client
+      @transport_client ||= Savon.client endpoint: "http://#{self.ip}:#{PORT}#{TRANSPORT_ENDPOINT}", namespace: NAMESPACE
+    end
+
+    def send_transport_message(name)
+      action = "#{TRANSPORT_XMLNS}##{name}"
+      message = %Q{<u:#{name} xmlns:u="#{TRANSPORT_XMLNS}"><InstanceID>0</InstanceID><Speed>1</Speed></u:#{name}>}
+      transport_client.call(name, soap_action: action, message: message)
+    end
+  end
+end

data/lib/sonos/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sonos
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-23 00:00:00.000000000 Z
+date: 2012-12-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: savon
@@ -35,12 +35,16 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- Changelog.markdown
 - Gemfile
 - LICENSE
 - Rakefile
 - Readme.markdown
 - lib/sonos.rb
+- lib/sonos/device.rb
+- lib/sonos/rendering.rb
 - lib/sonos/speaker.rb
+- lib/sonos/transport.rb
 - lib/sonos/version.rb
 - sonos.gemspec
 homepage: https://github.com/soffes/sonos
@@ -57,7 +61,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -970140811595000206
+      hash: -1995798408343589310
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -66,7 +70,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -970140811595000206
+      hash: -1995798408343589310
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -74,3 +78,4 @@ signing_key:
 specification_version: 3
 summary: Control Sonos speakers with Ruby
 test_files: []
+has_rdoc: