UPnP 1.1.0 → 1.2.0

data.tar.gz.sig

@@ -1,2 +1,5 @@
-j*��-��:�8&H�Aبe��(Ƹ$�q��"�	����c�8�N�/6���@ു�Y�]J�%79rF���M�yŽŚ��G�����*���� �-�#��|շu�x\=��GR	T�#�8��N'
-�b��Meg��s�i����{,��$��ifa�A����;1�j1ANK���ΤW��إ��G�JE!&�(��\"�
ˤ$��ԙ�R_�MLbGs��|;'��%rB>1��H�6Q)�c���ڛ����
+���%2v��Py;�٦��pH���]�z�Thj�*��6�O)��J�^X :�٠ݷ)(9��Ĝ������$B�8C�Ľ�a��*L��o��~ٓ�6:�Qm�
+�+q��́w;�
+�1(NU����X�
+��qה
+�w.�a��M��4\��sD���:��堼�z�")X����r]

data/History.txt

@@ -1,3 +1,16 @@
+=== 1.2.0 / 2009-06-16
+
+* 2 minor enhancements
+  * Workaround for missing socket constants on Windows.  Reported by Yuri.
+  * upnp_discover now shows action argument and return value names.
+
+* 4 bug fixes
+  * Method name must not include entire URI.  Reported by Ian Macdonald.
+  * Step in allowedValueRange is optional.  Reported by Ian Macdonald.
+  * upnp_listen works with all notification types.  Reported by Ian Macdonald.
+  * upnp_discover now warns when a device failed to instantiate.  Reported by
+    Ian Macdonald.
+
 === 1.1.0 / 2008-07-23
 
 * 2 major enhancements
@@ -9,6 +22,5 @@
 === 1.0.0 / 2008-06-25
 
 * 1 major enhancement
-
   * Birthday!
 

data/Manifest.txt

@@ -14,6 +14,7 @@ lib/UPnP/control/service.rb
 lib/UPnP/device.rb
 lib/UPnP/root_server.rb
 lib/UPnP/service.rb
+lib/UPnP/test_utilities.rb
 test/test_UPnP_SSDP.rb
 test/test_UPnP_SSDP_notification.rb
 test/test_UPnP_SSDP_response.rb

data/Rakefile

@@ -2,14 +2,15 @@
 
 require 'rubygems'
 require 'hoe'
-require './lib/upnp.rb'
 
-Hoe.new('UPnP', UPnP::VERSION) do |p|
-  p.rubyforge_name = 'seattlerb'
-  p.developer('Eric Hodel', 'drbrain@segment7.net')
+Hoe.plugin :perforce
 
-  p.extra_deps << 'soap4r'
-  p.extra_deps << 'builder'
+Hoe.spec 'UPnP' do
+  self.rubyforge_name = 'seattlerb'
+  developer 'Eric Hodel', 'drbrain@segment7.net'
+
+  extra_deps << 'soap4r'
+  extra_deps << 'builder'
 end
 
 # vim: syntax=Ruby

data/bin/upnp_discover

@@ -22,8 +22,13 @@ Prints information about UPnP internet gateway devices
 ssdp.timeout = timeout
 
 devices = ssdp.search(:root).map do |resource|
-  UPnP::Control::Device.new resource.location
-end
+  begin
+    UPnP::Control::Device.new resource.location
+  rescue UPnP::Error => e
+    puts "Error creating device:\n\t#{e}"
+    nil
+  end
+end.compact
 
 if devices.empty? then
   puts 'No UPnP devices found'
@@ -72,8 +77,12 @@ devices.each do |device|
     puts "    Event subscription URL: #{service.event_sub_url}"
     puts
     puts "    Actions:"
-    service.driver.methods(false).sort.each do |method|
-      puts "      #{method}"
+    service.actions.sort.each do |method, arguments|
+      inn, out = arguments.partition { |dir,| dir == 'in' }
+      out = out.map { |dir, name,| name }
+      out = out.empty? ? '' : " => #{out.join ', '}"
+      inn = inn.map { |dir, name,| name }
+      puts "      #{method}(#{inn.join ', '})#{out}"
     end
 
     puts

data/bin/upnp_listen

@@ -8,19 +8,31 @@ ssdp = UPnP::SSDP.new
 ssdp.discover do |notification|
   schemas = Regexp.union UPnP::DEVICE_SCHEMA_PREFIX, UPnP::SERVICE_SCHEMA_PREFIX
 
-  type = notification.type.sub(/#{schemas}:/, '')
+  case notification
+  when UPnP::SSDP::Notification then
+    type = notification.type.sub(/#{schemas}:/, '')
+
+    if notification.alive? then
+      puts "#{type} is alive"
+      puts "Description: #{notification.location}"
+    else
+      puts "#{type} says byebye"
+    end
+
+    puts "USN: #{notification.name}"
+  when UPnP::SSDP::Response then
+    puts "Response from #{target}" 
+    puts "Description: #{location}"
+    puts "USN: #{notification.name}"
+  when UPnP::SSDP::Search then
+    puts "Search for #{notification.target}"
+  end
 
-  if notification.alive? then
-    puts "#{type} is alive"
-    puts "Description: #{notification.location}"
+  if notification.expiration then
     expiration = notification.expiration.strftime '%c'
     puts "Valid until #{expiration}"
-  else
-    puts "#{type} says byebye"
   end
 
-  puts "USN: #{notification.name}"
-
   puts
 end
 

data/lib/UPnP.rb

@@ -23,7 +23,7 @@ module UPnP
   ##
   # The version of UPnP you are using
 
-  VERSION = '1.1.0'
+  VERSION = '1.2.0'
 
   ##
   # UPnP error base class

data/lib/UPnP/SSDP.rb

@@ -45,14 +45,14 @@ class UPnP::SSDP
     # Expiration time of this advertisement
 
     def expiration
-      date + max_age
+      date + max_age if date and max_age
     end
 
     ##
     # True if this advertisement has expired
 
     def expired?
-      Time.now > expiration
+      Time.now > expiration if expiration
     end
 
   end
@@ -303,6 +303,13 @@ class UPnP::SSDP
       @wait_time = wait_time
     end
 
+    ##
+    # Expiration time of this advertisement
+
+    def expiration
+      date + wait_time
+    end
+
     ##
     # A friendlier inspect
 
@@ -536,11 +543,11 @@ class UPnP::SSDP
           adv = parse response
 
           info = case adv
-          when Notification then adv.type
-          when Response     then adv.target
-          when Search       then adv.target
-          else                   'unknown'
-          end
+                 when Notification then adv.type
+                 when Response     then adv.target
+                 when Search       then adv.target
+                 else                   'unknown'
+                 end
 
           response =~ /\A(\S+)/
           log :debug, "SSDP recv #{$1} #{hostname}:#{port} #{info}"
@@ -756,3 +763,24 @@ ST: #{search_target}\r
 
 end
 
+# :stopdoc:
+
+##
+# Workaround for mising constants on Windows
+
+module Socket::Constants
+  IP_ADD_MEMBERSHIP = 12 unless defined? IP_ADD_MEMBERSHIP
+  IP_MULTICAST_LOOP = 11 unless defined? IP_MULTICAST_LOOP
+  IP_MULTICAST_TTL  = 10 unless defined? IP_MULTICAST_TTL
+  IP_TTL            =  4 unless defined? IP_TTL
+end
+
+class Socket
+  IP_ADD_MEMBERSHIP = 12 unless defined? IP_ADD_MEMBERSHIP
+  IP_MULTICAST_LOOP = 11 unless defined? IP_MULTICAST_LOOP
+  IP_MULTICAST_TTL  = 10 unless defined? IP_MULTICAST_TTL
+  IP_TTL            =  4 unless defined? IP_TTL
+end
+
+# :startdoc:
+

data/lib/UPnP/control/service.rb

@@ -175,6 +175,16 @@ class UPnP::Control::Service
 
   end
 
+  ##
+  # Hash mapping UPnP Actions to arguments
+  #
+  #   {
+  #     'GetTotalPacketsSent' =>
+  #       [['out', 'NewTotalPacketsSent', 'TotalPacketsSent']]
+  #   }
+
+  attr_reader :actions
+
   ##
   # Control URL
 
@@ -259,7 +269,7 @@ class UPnP::Control::Service
 
     @actions.each do |name, arguments|
       soapaction = "#{@type}##{name}"
-      qname = XSD::QName.new @type, soapaction
+      qname = XSD::QName.new @type, name
 
       # TODO map ranges, enumerations
       arguments = arguments.map do |direction, arg_name, variable|
@@ -278,7 +288,6 @@ class UPnP::Control::Service
 
     @driver.mapping_registry = mapping_registry
 
-    @actions = nil
     @variables = nil
   end
 
@@ -385,7 +394,8 @@ class UPnP::Control::Service
     maximum = range.elements['maximum']
     step    = range.elements['step']
 
-    range = [minimum, maximum, step]
+    range = [minimum, maximum]
+    range << step if step
 
     range.map do |value|
       value = value.text
@@ -405,6 +415,8 @@ class UPnP::Control::Service
 
     service_state_table = description.elements['scpd/serviceStateTable']
     parse_service_state_table service_state_table
+  rescue OpenURI::HTTPError
+    raise Error, "Unable to open SCPD at #{@scpd_url.inspect} from device #{@url.inspect}"
   end
 
   ##

data/lib/UPnP/device.rb

@@ -190,8 +190,12 @@ class UPnP::Device
   @option_parser = nil
   @options = nil
 
-  def self.add_service_id(service, id)
-    SERVICE_IDS[self][service] = id
+  ##
+  # Sets the serivceId for +service+ using +domain+ and +id+.  Used in
+  # UPnP::Service#description via #description.
+
+  def self.add_service_id(service, id, domain = 'upnp.org')
+    SERVICE_IDS[self][service] = "urn:#{domain.tr '.', '-'}:serviceId:#{id}"
   end
 
   ##
@@ -374,6 +378,8 @@ class UPnP::Device
     @sub_services ||= []
     @parent ||= parent_device
 
+    @cache_dir = nil
+
     yield self if block_given?
 
     @name ||= "uuid:#{UPnP::UUID.generate}"
@@ -438,6 +444,20 @@ class UPnP::Device
     end
   end
 
+  ##
+  # A directory for storing device-specific persistent data
+
+  def cache_dir
+    return @cache_dir if @cache_dir
+
+    @cache_dir = File.join '~', '.UPnP', '_cache', @name
+    @cache_dir = File.expand_path @cache_dir
+
+    FileUtils.mkdir_p @cache_dir
+
+    @cache_dir
+  end
+
   ##
   # Returns an XML document describing the root device
 

data/lib/UPnP/service.rb

@@ -156,6 +156,8 @@ class UPnP::Service < SOAP::RPC::StandaloneServer
     @device = device
     @type = type
 
+    @cache_dir = nil
+
     # HACK PS3 disobeys spec
     SOAP::NS::KNOWN_TAG[type_urn] = 'u'
     SOAP::NS::KNOWN_TAG[SOAP::EnvelopeNamespace] = 's'
@@ -194,6 +196,20 @@ class UPnP::Service < SOAP::RPC::StandaloneServer
     end
   end
 
+  ##
+  # A directory for storing service-specific persistent data
+
+  def cache_dir
+    return @cache_dir if @cache_dir
+
+    @cache_dir = File.join '~', '.UPnP', '_cache', "#{@device.name}-#{@type}"
+    @cache_dir = File.expand_path @cache_dir
+
+    FileUtils.mkdir_p @cache_dir
+
+    @cache_dir
+  end
+
   ##
   # The control URL for this service
 
@@ -216,7 +232,7 @@ class UPnP::Service < SOAP::RPC::StandaloneServer
   def description(xml)
     xml.service do
       xml.serviceType type_urn
-      xml.serviceId   "urn:upnp-org:serviceId:#{root_device.service_id self}"
+      xml.serviceId   root_device.service_id(self)
       xml.SCPDURL     scpd_url
       xml.controlURL  control_url
       xml.eventSubURL event_sub_url

data/lib/UPnP/test_utilities.rb

@@ -0,0 +1,13 @@
+require 'UPnP/device'
+require 'UPnP/service'
+
+class UPnP::Service::TestService < UPnP::Service
+  VERSION = '1.0'
+end
+
+class UPnP::Device::TestDevice < UPnP::Device
+  VERSION = '1.0'
+
+  add_service_id UPnP::Service::TestService, 'TestService', 'example.com'
+end
+

data/test/test_UPnP_SSDP.rb

@@ -2,6 +2,7 @@ require 'test/unit'
 require 'test/utilities'
 require 'UPnP/SSDP'
 require 'UPnP/device'
+require 'UPnP/test_utilities'
 
 class TestUPnPSSDP < UPnP::TestCase
 
@@ -293,7 +294,7 @@ ST: bunnies\r
   end
 
   def util_device_version
-    "UPnP::Device::TestDevice/#{UPnP::VERSION}"
+    "UPnP::Device::TestDevice/#{UPnP::Device::TestDevice::VERSION}"
   end
 
 end

data/test/test_UPnP_device.rb

@@ -1,6 +1,7 @@
 require 'test/unit'
 require 'test/utilities'
 require 'UPnP/device'
+require 'UPnP/test_utilities'
 
 class TestUPnPDevice < UPnP::TestCase
 
@@ -18,6 +19,11 @@ class TestUPnPDevice < UPnP::TestCase
     @service = @device.add_service 'TestService'
   end
 
+  def test_self_add_serivce_id
+    assert_equal 'urn:example-com:serviceId:TestService',
+                 @device.service_id(@service)
+  end
+
   def test_self_create
     device1 = UPnP::Device.create 'TestDevice', 'test device'
 
@@ -98,6 +104,13 @@ class TestUPnPDevice < UPnP::TestCase
     assert @device.sub_services.include?(@service)
   end
 
+  def test_cache_dir
+    assert_match %r%.UPnP/_cache/uuid:.{8}-.{4}-.{4}-.{4}-.{12}$%,
+                 @device.cache_dir
+
+    assert File.exist?(@device.cache_dir)
+  end
+
   def test_description
     desc = @device.description
 
@@ -120,7 +133,7 @@ class TestUPnPDevice < UPnP::TestCase
     <serviceList>
       <service>
         <serviceType>urn:schemas-upnp-org:service:TestService:1</serviceType>
-        <serviceId>urn:upnp-org:serviceId:TestService</serviceId>
+        <serviceId>urn:example-com:serviceId:TestService</serviceId>
         <SCPDURL>/TestDevice/TestService</SCPDURL>
         <controlURL>/TestDevice/TestService/control</controlURL>
         <eventSubURL>/TestDevice/TestService/event_sub</eventSubURL>
@@ -235,11 +248,15 @@ class TestUPnPDevice < UPnP::TestCase
   end
 
   def test_service_id
-    assert_equal 'TestService', @device.service_id(@service)
+    assert_equal 'urn:example-com:serviceId:TestService',
+                 @device.service_id(@service)
   end
 
   def test_service_ids
-    expected = { UPnP::Service::TestService => 'TestService' }
+    expected = {
+      UPnP::Service::TestService => 'urn:example-com:serviceId:TestService'
+    }
+
     assert_equal expected, @device.service_ids
   end
 

data/test/test_UPnP_service.rb

@@ -1,6 +1,7 @@
 require 'test/unit'
 require 'test/utilities'
 require 'UPnP/service'
+require 'UPnP/test_utilities'
 
 class TestUPnPService < UPnP::TestCase
 
@@ -47,6 +48,13 @@ class TestUPnPService < UPnP::TestCase
     assert_equal [qname], operations.keys
   end
 
+  def test_cache_dir
+    assert_match %r%.UPnP/_cache/uuid:.{8}-.{4}-.{4}-.{4}-.{12}-TestService$%,
+                 @service.cache_dir
+
+    assert File.exist?(@service.cache_dir)
+  end
+
   def test_control_url
     assert_equal '/TestDevice/TestService/control', @service.control_url
   end
@@ -64,7 +72,7 @@ class TestUPnPService < UPnP::TestCase
     expected = <<-XML
 <service>
   <serviceType>urn:schemas-upnp-org:service:TestService:1</serviceType>
-  <serviceId>urn:upnp-org:serviceId:TestService</serviceId>
+  <serviceId>urn:example-com:serviceId:TestService</serviceId>
   <SCPDURL>/TestDevice/TestService</SCPDURL>
   <controlURL>/TestDevice/TestService/control</controlURL>
   <eventSubURL>/TestDevice/TestService/event_sub</eventSubURL>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: UPnP
 version: !ruby/object:Gem::Version 
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors: 
 - Eric Hodel
@@ -30,7 +30,7 @@ cert_chain:
   x52qPcexcYZR7w==
   -----END CERTIFICATE-----
 
-date: 2008-07-23 00:00:00 -07:00
+date: 2009-06-16 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -61,7 +61,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.7.0
+        version: 2.1.0
     version: 
 description: An implementation of the UPnP protocol
 email: 
@@ -92,6 +92,7 @@ files:
 - lib/UPnP/device.rb
 - lib/UPnP/root_server.rb
 - lib/UPnP/service.rb
+- lib/UPnP/test_utilities.rb
 - test/test_UPnP_SSDP.rb
 - test/test_UPnP_SSDP_notification.rb
 - test/test_UPnP_SSDP_response.rb
@@ -104,6 +105,8 @@ files:
 - test/utilities.rb
 has_rdoc: true
 homepage: http://seattlerb.org/UPnP
+licenses: []
+
 post_install_message: 
 rdoc_options: 
 - --main
@@ -125,9 +128,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: seattlerb
-rubygems_version: 1.2.0
+rubygems_version: 1.3.4.2217
 signing_key: 
-specification_version: 2
+specification_version: 3
 summary: An implementation of the UPnP protocol
 test_files: 
 - test/test_UPnP_control_device.rb