UPnP 1.0.0 → 1.1.0

data/test/test_UPnP_root_server.rb

@@ -0,0 +1,99 @@
+require 'stringio'
+require 'test/unit'
+require 'test/utilities'
+require 'UPnP/root_server'
+
+class TestUPnPRootServer < UPnP::TestCase
+
+  def setup
+    super
+
+    @device = UPnP::Device.new 'TestDevice', 'test device'
+    @device.manufacturer = 'UPnP Manufacturer'
+    @device.model_name = 'UPnP Model'
+
+    @service = @device.add_service 'TestService'
+
+    @root_server = UPnP::RootServer.new @device
+
+    @req = WEBrick::HTTPRequest.new :Logger => nil
+    @res = WEBrick::HTTPResponse.new :HTTPVersion => '1.0'
+  end
+
+  def test_initialize
+    assert_equal @device, @root_server.root_device
+    assert @root_server.scpds.empty?
+    assert_equal WEBrick::BasicLog::FATAL, @root_server.logger.level,
+                 'default log level'
+
+    assert util_mount_tab['/description']
+  end
+
+  def test_description
+    data = StringIO.new "GET /description HTTP/1.0\r\n\r\n"
+    @req.parse data
+
+    @root_server.description @req, @res
+
+    assert_equal 200, @res.status, @res.body
+    assert_equal 'text/xml', @res['content-type']
+    assert_equal @device.description, @res.body
+  end
+
+  def test_description_other
+    data = StringIO.new "GET /description/other HTTP/1.0\r\n\r\n"
+    @req.parse data
+
+    assert_raise WEBrick::HTTPStatus::NotFound do
+      @root_server.description @req, @res
+    end
+  end
+
+  def test_mount_server
+    assert_nil util_mount_tab['/TestDevice/TestService/control']
+
+    @root_server.mount_server @service.control_url, @service.server
+
+    assert_equal @root_server.logger, @service.server.config[:Logger]
+    assert util_mount_tab['/TestDevice/TestService/control']
+  end
+
+  def test_mount_service
+    @root_server.mount_service @service
+
+    assert_equal [@service.scpd_url], @root_server.scpds.keys
+
+    assert util_mount_tab['/TestDevice/TestService']
+    assert util_mount_tab['/TestDevice/TestService/control']
+  end
+
+  def test_scpd
+    @root_server.mount_service @service
+
+    data = StringIO.new "GET #{@service.scpd_url} HTTP/1.0\r\n\r\n"
+    @req.parse data
+
+    @root_server.scpd @req, @res
+
+    assert_equal 200, @res.status, @res.body
+    assert_equal 'text/xml', @res['content-type']
+    assert_equal @service.scpd, @res.body
+  end
+
+  def test_scpd_other
+    @root_server.mount_service @service
+
+    data = StringIO.new "GET /TestDevice/TestOtherService HTTP/1.0\r\n\r\n"
+    @req.parse data
+
+    assert_raise WEBrick::HTTPStatus::NotFound do
+      @root_server.description @req, @res
+    end
+  end
+
+  def util_mount_tab
+    @root_server.instance_variable_get :@mount_tab
+  end
+
+end
+

data/test/test_UPnP_service.rb

@@ -0,0 +1,171 @@
+require 'test/unit'
+require 'test/utilities'
+require 'UPnP/service'
+
+class TestUPnPService < UPnP::TestCase
+
+  def setup
+    super
+
+    @device = UPnP::Device.new 'TestDevice', 'test device'
+    @service = @device.add_service 'TestService'
+  end
+
+  def test_initialize
+    assert_equal @device, @service.device
+    assert_equal 'TestService', @service.type
+
+    assert_equal 'TestService', @service.appname
+    assert_equal "#{UPnP::SERVICE_SCHEMA_PREFIX}:TestService:1",
+                 @service.default_namespace
+
+    router = @service.instance_variable_get :@router
+    operations = router.instance_variable_get :@operation_by_qname
+
+    qname = XSD::QName.new @service.type_urn, 'TestAction'
+
+    assert operations.key?(qname)
+  end
+
+  def test_actions
+    expected = {
+      'TestAction' => [
+        %w[in  TestInput  TestInVar],
+        %w[out TestOutput TestOutVar],
+      ],
+    }
+
+    assert_equal expected, @service.actions
+  end
+
+  def test_add_actions
+    router = @service.instance_variable_get :@router
+    operations = router.instance_variable_get :@operation_by_qname
+
+    qname = XSD::QName.new @service.type_urn, 'TestAction'
+
+    assert_equal [qname], operations.keys
+  end
+
+  def test_control_url
+    assert_equal '/TestDevice/TestService/control', @service.control_url
+  end
+
+  def test_create_config
+    assert_equal true, @service.create_config[:DoNotListen]
+  end
+
+  def test_description
+    desc = ''
+    xml = Builder::XmlMarkup.new :indent => 2, :target => desc
+
+    @service.description xml
+
+    expected = <<-XML
+<service>
+  <serviceType>urn:schemas-upnp-org:service:TestService:1</serviceType>
+  <serviceId>urn:upnp-org:serviceId:TestService</serviceId>
+  <SCPDURL>/TestDevice/TestService</SCPDURL>
+  <controlURL>/TestDevice/TestService/control</controlURL>
+  <eventSubURL>/TestDevice/TestService/event_sub</eventSubURL>
+</service>
+    XML
+
+    assert_equal expected, desc
+  end
+
+  def test_device_path
+    assert_equal '/TestDevice', @service.device_path
+  end
+
+  def test_event_sub_url
+    assert_equal '/TestDevice/TestService/event_sub', @service.event_sub_url
+  end
+
+  def test_marshal_dump
+    assert_equal [@device, 'TestService'], @service.marshal_dump
+  end
+
+  def test_marshal_load
+    data = [@device, 'TestService']
+
+    service = UPnP::Service.allocate
+
+    service.marshal_load data
+
+    assert_equal 'TestService', @service.type
+    assert_equal 'TestService', @service.appname
+
+    assert data.empty?, 'unconsumed data'
+  end
+
+  def test_root_device
+    assert_equal @device, @service.root_device
+  end
+
+  def test_scpd
+    scpd = @service.scpd
+
+    expected = <<-XML
+<?xml version="1.0" encoding="UTF-8"?>
+<scpd xmlns="urn:schemas-upnp-org:service-1-0">
+  <specVersion>
+    <major>1</major>
+    <minor>0</minor>
+  </specVersion>
+  <actionList>
+    <action>
+      <name>TestAction</name>
+      <argumentList>
+        <argument>
+          <direction>in</direction>
+          <name>TestInput</name>
+          <relatedStateVariable>TestInVar</relatedStateVariable>
+        </argument>
+        <argument>
+          <direction>out</direction>
+          <name>TestOutput</name>
+          <relatedStateVariable>TestOutVar</relatedStateVariable>
+        </argument>
+      </argumentList>
+    </action>
+  </actionList>
+  <serviceStateTable>
+    <stateVariable sendEvents="no">
+      <name>TestOutVar</name>
+      <dataType>string</dataType>
+    </stateVariable>
+    <stateVariable sendEvents="no">
+      <name>TestInVar</name>
+      <dataType>string</dataType>
+    </stateVariable>
+  </serviceStateTable>
+</scpd>
+    XML
+
+    assert_equal expected, scpd
+  end
+
+  def test_scpd_url
+    assert_equal '/TestDevice/TestService', @service.scpd_url
+  end
+
+  def test_service_path
+    assert_equal '/TestDevice/TestService', @service.service_path
+  end
+
+  def test_type_urn
+    assert_equal 'urn:schemas-upnp-org:service:TestService:1', @service.type_urn
+  end
+
+  def test_variables
+    expected = {
+      'TestOutVar' => ['string', nil, nil, false],
+      'TestInVar'  => ['string', nil, nil, false],
+    }
+
+    assert_equal expected, @service.variables
+  end
+
+end
+

data/test/utilities.rb

@@ -1,4 +1,8 @@
+require 'fileutils'
+require 'tmpdir'
 require 'test/unit'
+require 'UPnP'
+require 'UPnP/device'
 
 module UPnP
 
@@ -67,23 +71,30 @@ module UPnP
 
   class TestCase < Test::Unit::TestCase
 
+    undef_method :default_test
+
+    def setup
+      @tempdir = File.join Dir.tmpdir, "test_UPnP_#{$$}"
+      FileUtils.mkdir_p @tempdir
+
+      @home = File.join @tempdir, 'home'
+      FileUtils.mkdir_p @home
+
+      @orig_ENV_HOME = ENV['HOME']
+      ENV['HOME'] = @home
+    end
+
     def teardown
+      if @orig_ENV_HOME then
+        ENV['HOME'] = @orig_ENV_HOME
+      else
+        ENV.delete 'HOME'
+      end
+
+      FileUtils.rm_rf @tempdir
       UPnP::OpenStub::FILES.clear
     end
 
-  def util_search_response
-    <<-SEARCH_RESPONSE
-HTTP/1.1 200 OK\r
-CACHE-CONTROL: max-age = 10\r
-EXT:\r
-LOCATION: http://example.com/root_device.xml\r
-SERVER: OS/5 UPnP/1.0 product/7\r
-ST: upnp:rootdevice\r
-USN: uuid:BOGUS::upnp:rootdevice\r
-\r
-    SEARCH_RESPONSE
-  end
-
   def util_notify
     <<-NOTIFY
 NOTIFY * HTTP/1.1\r
@@ -109,7 +120,28 @@ USN: uuid:BOGUS::upnp:rootdevice\r
     NOTIFY_BYEBYE
   end
 
-    undef_method :default_test
+  def util_search
+    <<-SEARCH
+M-SEARCH * HTTP/1.1
+HOST: 239.255.255.250:1900
+MAN: "ssdp:discover"
+MX: 2
+ST: upnp:rootdevice
+    SEARCH
+  end
+
+  def util_search_response
+    <<-SEARCH_RESPONSE
+HTTP/1.1 200 OK\r
+CACHE-CONTROL: max-age = 10\r
+EXT:\r
+LOCATION: http://example.com/root_device.xml\r
+SERVER: OS/5 UPnP/1.0 product/7\r
+ST: upnp:rootdevice\r
+USN: uuid:BOGUS::upnp:rootdevice\r
+\r
+    SEARCH_RESPONSE
+  end
 
     IGD_XML = <<-XML
 <?xml version="1.0"?>
@@ -1024,5 +1056,20 @@ USN: uuid:BOGUS::upnp:rootdevice\r
 
   end
 
+  class Service::TestService < Service
+    add_action 'TestAction',
+      [IN,  'TestInput',  'TestInVar'],
+      [OUT, 'TestOutput', 'TestOutVar']
+
+    add_variable 'TestInVar', 'string'
+    add_variable 'TestOutVar', 'string'
+  end
+
+  class Device::TestDevice < Device
+
+    add_service_id UPnP::Service::TestService, 'TestService'
+
+  end
+
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: UPnP
 version: !ruby/object:Gem::Version 
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors: 
 - Eric Hodel
@@ -30,18 +30,38 @@ cert_chain:
   x52qPcexcYZR7w==
   -----END CERTIFICATE-----
 
-date: 2008-06-29 00:00:00 -07:00
+date: 2008-07-23 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: hoe
+  name: soap4r
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: builder
   type: :runtime
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.5.3
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.7.0
     version: 
 description: An implementation of the UPnP protocol
 email: 
@@ -65,14 +85,22 @@ files:
 - bin/upnp_listen
 - lib/UPnP.rb
 - lib/UPnP/SSDP.rb
+- lib/UPnP/UUID.rb
 - lib/UPnP/control.rb
 - lib/UPnP/control/device.rb
 - lib/UPnP/control/service.rb
+- lib/UPnP/device.rb
+- lib/UPnP/root_server.rb
+- lib/UPnP/service.rb
 - test/test_UPnP_SSDP.rb
 - test/test_UPnP_SSDP_notification.rb
 - test/test_UPnP_SSDP_response.rb
+- test/test_UPnP_SSDP_search.rb
 - test/test_UPnP_control_device.rb
 - test/test_UPnP_control_service.rb
+- test/test_UPnP_device.rb
+- test/test_UPnP_root_server.rb
+- test/test_UPnP_service.rb
 - test/utilities.rb
 has_rdoc: true
 homepage: http://seattlerb.org/UPnP
@@ -104,6 +132,10 @@ summary: An implementation of the UPnP protocol
 test_files: 
 - test/test_UPnP_control_device.rb
 - test/test_UPnP_control_service.rb
+- test/test_UPnP_device.rb
+- test/test_UPnP_root_server.rb
+- test/test_UPnP_service.rb
 - test/test_UPnP_SSDP.rb
 - test/test_UPnP_SSDP_notification.rb
 - test/test_UPnP_SSDP_response.rb
+- test/test_UPnP_SSDP_search.rb