rupnp 0.2.0 → 0.2.1

data/lib/rupnp/control_point.rb

@@ -156,7 +156,7 @@ module RUPNP
       end
 
       searcher.discovery_responses.subscribe do |notification|
-        log :debug, 'receive a notification'
+        log :debug, "receive a notification:\n#{notification}"
         create_device notification
       end
     end

data/lib/rupnp/cp/base.rb

@@ -50,6 +50,7 @@ module RUPNP
           unless h['SERVER'] =~ /UPnP\/1\.\d/
             log :error, "Not a supported UPnP response : #{h['SERVER']}"
             http.cancel_callback callback
+            http.fail
           end
         end
 

data/lib/rupnp/cp/remote_device.rb

@@ -118,14 +118,16 @@ module RUPNP
     # Get device from its description
     # @return [void]
     def fetch
+      upnp_minor_ver = @notification['server'].match(/UPnP\/1\.(\d)/)[1].to_i
       if @notification['nextbootid.upnp.org']
         @boot_id = @notification['nextbootid.upnp.org'].to_i
       elsif @notification['bootid.upnp.org']
         @boot_id = @notification['bootid.upnp.org'].to_i
-      else
+      elsif upnp_minor_ver > 0
         fail self, 'no BOOTID.UPNP.ORG field. Message discarded.'
+        return
       end
-      @config_id = @notification['confgid.upnp.org']
+      @config_id = @notification['configid.upnp.org']
       @config_id = @config_id.to_i if @config_id
 
       description_getter = EM::DefaultDeferrable.new
@@ -134,34 +136,30 @@ module RUPNP
         msg = "Failed getting description"
         log :error, "Fetching device: #{msg}"
         fail self, msg
+        next
       end
 
       extract_from_ssdp_notification description_getter
 
       description_getter.callback do |description|
         @description = description
-        unless description
-          fail self, 'Blank description returned'
-          next
-        end
-
-        if bad_description?
+      if bad_description?
           fail self, "Bad description returned: #@description"
           next
-        end
-
-        extract_url_base
-        extract_device_info
-        extract_icons
+        else
+          extract_url_base
+          extract_device_info
+          extract_icons
 
-        @services_extracted = @devices_extracted = false
-        extract_services
-        extract_devices
+          @services_extracted = @devices_extracted = false
+          extract_services
+          extract_devices
 
-        tick_loop = EM.tick_loop do
-          :stop if @services_extracted and @devices_extracted
+          tick_loop = EM.tick_loop do
+            :stop if @services_extracted and @devices_extracted
+          end
+          tick_loop.on_stop { succeed self }
         end
-        tick_loop.on_stop { succeed self }
       end
     end
 
@@ -198,13 +196,14 @@ module RUPNP
 
     def bad_description?
       if @description[:root]
-        bd = false
         @xmlns = @description[:root][:@xmlns]
-        bd |= @xmlns != 'urn:schemas-upnp-org:device-1-0'
-        bd |= @description[:root][:spec_version][:major].to_i != 1
+        return true unless @xmlns == 'urn:schemas-upnp-org:device-1-0'
+        return true unless @description[:root][:spec_version]
+        return true unless @description[:root][:spec_version][:major].to_i == 1
         @upnp_version = @description[:root][:spec_version][:major] + '.'
         @upnp_version += @description[:root][:spec_version][:minor]
-        bd |= !@description[:root][:device]
+        return true unless @description[:root][:device]
+        false
       else
         true
       end
@@ -294,10 +293,10 @@ module RUPNP
     end
 
     def update_expiration(notification)
-      @date = @notification['date'] || ''
-      @cache_control = @notification['cache-control'] || ''
+      @date = notification['date'] || ''
+      @cache_control = notification['cache-control'] || ''
 
-      if @notification['nts'] == 'ssdp:alive'
+      if notification['nts'] == 'ssdp:alive' or @cache_control != ''
         max_age = @cache_control.match(/max-age\s*=\s*(\d+)/)[1].to_i
       else
         max_age = DEFAULT_MAX_AGE

data/lib/rupnp/cp/remote_service.rb

@@ -64,6 +64,9 @@ module RUPNP
     # Get service type
     # @return [String]
     attr_reader :type
+    # Get service id
+    # @return [String]
+    attr_reader :id
     # URL for service description
     # @return [String]
     attr_reader :scpd_url
@@ -96,6 +99,7 @@ module RUPNP
       @description = service
 
       @type = service[:service_type].to_s
+      @id = service[:service_id].to_s
       @scpd_url = build_url(url_base,  service[:scpdurl].to_s)
       @control_url =  build_url(url_base, service[:control_url].to_s)
       @event_sub_url =  build_url(url_base, service[:event_sub_url].to_s)

data/lib/rupnp/ssdp/searcher.rb

@@ -39,7 +39,8 @@ module RUPNP
     # @private
     def receive_data(data)
       port, ip = peer_info
-      log :debug, "Response from #{ip}:#{port}"
+      log :debug, "Response from #{ip}:#{port}:"
+      log :debug, data
 
       response = StringIO.new(data)
       if !is_http_status_ok?(response)

data/lib/rupnp.rb

@@ -6,7 +6,7 @@ require 'eventmachine-le'
 module RUPNP
 
   # RUPNP version
-  VERSION = '0.2.0'
+  VERSION = '0.2.1'
 
   @logdev = STDERR
   @log_level = :info

data/spec/control_point_spec.rb

@@ -136,7 +136,17 @@ module RUPNP
       end
     end
 
-    it '#find_device_by_udn should get known devices'
+    it '#find_device_by_udn should get known devices' do
+      uuid1 = UUID.generate
+      cp.devices << double('rdevice1', :udn => uuid1)
+      uuid2 = UUID.generate
+      cp.devices << double('rdevice2', :udn => uuid2)
+      uuid3 = UUID.generate
+
+      expect(cp.find_device_by_udn(uuid1)).to eq(cp.devices[0])
+      expect(cp.find_device_by_udn(uuid2)).to eq(cp.devices[1])
+      expect(cp.find_device_by_udn(uuid3)).to be_nil
+    end
   end
 
 end

data/spec/cp/remote_device_spec.rb

@@ -0,0 +1,199 @@
+require_relative '../spec_helper'
+
+module RUPNP
+  module CP
+
+    describe RemoteDevice do
+      include EM::SpecHelper
+
+      DESCRIPTIONS =
+        ['this is not a UPnP description',
+         '<?xml version="1.0"?><tag>UPnP</tag>',
+         '<?xml version="1.0"?><root xmlns="urn:schemas-upnp-org:device-0-9" configId="1"></root>',
+         '<?xml version="1.0"?><root xmlns="urn:schemas-upnp-org:device-1-0" configId="1"></root>',
+         '<?xml version="1.0"?><root xmlns="urn:schemas-upnp-org:device-1-0" configId="1"><spec_version></spec_version></root>',
+         '<?xml version="1.0"?><root xmlns="urn:schemas-upnp-org:device-1-0" configId="1"><spec_version><major>0</major><minor>9</minor></spec_version></root>',
+         '<?xml version="1.0"?><root xmlns="urn:schemas-upnp-org:device-1-0" configId="1"><spec_version><major>1</major><minor>9</minor></spec_version></root>',
+         '<?xml version="1.0"?><root xmlns="urn:schemas-upnp-org:device-1-0" configId="1"><spec_version><major>1</major><minor>9</minor></spec_version><device></device></root>',]
+
+
+      let(:location) { 'http://127.0.0.1:1234/root_description.xml' }
+      let(:uuid) { UUID.generate }
+      let(:max_age) { 1800 }
+      let(:notification) { {
+          'cache-control' => "max-age=#{max_age}",
+          'date' => Time.now.strftime("%a, %d %b %Y %H:%M:%S %Z"),
+          'ext' => '',
+          'location' => location,
+          'server' => 'OS/1.0 UPnP/1.1 TEST/1.0',
+          'st' => 'upnp:rootdevice',
+          'usn' =>  "uuid:#{uuid}::upnp:rootdevice",
+          'bootid.upnp.org' => 10,
+          'configid.upnp.org' => 23,
+        } }
+      let(:rd) { RemoteDevice.new(double('control_point'), notification)}
+
+      context '#fetch' do
+
+        it "should fail when notification has no BOOTID.UPNP.ORG field" do
+          notification.delete 'bootid.upnp.org'
+          em do
+            rd.errback do |dev, msg|
+              expect(dev).to eq(rd)
+              expect(msg).to match(/no BOOTID/)
+              done
+            end
+            rd.callback { fail 'RemoteDevice#fetch should not work' }
+            rd.fetch
+          end
+        end
+
+        it "should accept headers without BOOTID for UPnP 1.0 response" do
+          notification.delete 'bootid.upnp.org'
+          notification['server'] = 'OS/1.0 UPnP/1.0 TEST/1.0'
+          em do
+            stub_request(:get, location).
+              to_return(:headers => { 'SERVER' => 'OS/1.0 UPnP/1.0 TEST/1.0'},
+                          :body => generate_xml_device_description(uuid))
+            rd.errback { fail 'RemoteDevice#fetch should work' }
+            rd.callback { done }
+            rd.fetch
+          end
+        end
+
+        it "should fail when location is unreachable" do
+          em do
+            stub_request(:get, location).to_timeout
+            rd.errback do |dev, msg|
+              expect(dev).to eq(rd)
+              expect(msg).to match(/Failed getting description/)
+              done
+            end
+            rd.callback { fail 'RemoteDevice#fetch should not work' }
+            rd.fetch
+          end
+        end
+
+        it "should fail when description header is not a UPnP 1.x response" do
+          desc = generate_xml_device_description(uuid)
+          em do
+            stub_request(:get, location).
+              to_return(:body => generate_xml_device_description(uuid),
+                        :headers => { 'SERVER' => 'Linux/1.2 Apache/1.0' },
+                        :body => desc)
+
+            rd.errback do |dev, msg|
+              expect(dev).to eq(rd)
+              expect(msg).to match(/Failed getting description/)
+
+              stub_request(:get, location).
+                to_return(:headers => { 'SERVER' => 'OS/1.0 UPnP/0.9 TEST/1.0'},
+                          :body => desc)
+
+              rd.errback do |dev, msg|
+                expect(dev).to eq(rd)
+                expect(msg).to match(/Failed getting description/)
+                done
+              end
+              rd.fetch
+            end
+            rd.callback { fail 'RemoteDevice#fetch should not work' }
+            rd.fetch
+          end
+        end
+
+        it "should fail when description does not conform to UPnP spec" do
+          DESCRIPTIONS.each do |desc|
+            em do
+              stub_request(:get, location).
+                to_return(:headers => { 'SERVER' => 'OS/1.0 UPnP/1.1 TEST/1.0'},
+                          :body => desc)
+
+              rd.errback do |dev, msg|
+                expect(dev).to eq(rd)
+                expect(msg).to match(/Bad description/)
+                done
+              end
+              rd.callback { fail 'RemoteDevice#fetch should not work' }
+              rd.fetch
+            end
+          end
+        end
+
+        it "should fetch its description" do
+          em do
+            stub_request(:get, location).
+              to_return(:headers => { 'SERVER' => 'OS/1.0 UPnP/1.1 TEST/1.0'},
+                          :body => generate_xml_device_description(uuid))
+            rd.errback { fail 'RemoteDevice#fetch should work' }
+            rd.callback do
+              done
+            end
+            rd.fetch
+          end
+        end
+
+        it "should extract services if any"
+        it "should not fail when a service cannot be extracted"
+      end
+
+      context "#update" do
+        it 'should update expiration date' do
+          em do
+            stub_request(:get, location).
+              to_return(:headers => { 'SERVER' => 'OS/1.0 UPnP/1.1 TEST/1.0'},
+                        :body => generate_xml_device_description(uuid))
+            rd.errback { fail 'RemoteDevice#fetch should work' }
+            rd.callback do
+              not2 = notification.dup
+              expiration_old = Time.parse(notification['date']) + max_age
+
+              not2['date'] = (Time.now + 5).strftime("%a, %d %b %Y %H:%M:%S %Z")
+              expiration_new = Time.parse(not2['date']) + max_age
+
+              expect(not2['date']).not_to eq(notification['date'])
+              expect { rd.update(not2) }.to change { rd.expiration }.
+                from(expiration_old).to(expiration_new)
+              done
+            end
+            rd.fetch
+          end
+        end
+
+        it 'should update BOOTID' do
+          em do
+            stub_request(:get, location).
+              to_return(:headers => { 'SERVER' => 'OS/1.0 UPnP/1.1 TEST/1.0' },
+                        :body => generate_xml_device_description(uuid))
+            rd.errback { fail 'RemoteDevice#fetch should work' }
+            rd.callback do
+              not2 = notification.merge('nextbootid.upnp.org' => 15)
+              expect { rd.update(not2) }.to change{ rd.boot_id }.from(10).to(15)
+              done
+            end
+            rd.fetch
+          end
+        end
+
+
+        it 'should update CONFIGID.UPNP.ORG' do
+          em do
+            stub_request(:get, location).
+              to_return(:headers => { 'SERVER' => 'OS/1.0 UPnP/1.1 TEST/1.0' },
+                        :body => generate_xml_device_description(uuid))
+            rd.errback { fail 'RemoteDevice#fetch should work' }
+            rd.callback do
+              not2 = notification.merge('configid.upnp.org' => 47)
+              expect { rd.update(not2) }.to change{ rd.config_id }.
+                from(23).to(47)
+              done
+            end
+            rd.fetch
+          end
+        end
+      end
+
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -58,23 +58,39 @@ EOR
 end
 
 
-def generate_xml_device_description(uuid)
-  <<EOD
+def generate_xml_device_description(uuid, options={})
+  opt = {
+    :version_major => 1,
+    :version_minor => 1,
+    :device_type => :base,
+  }.merge(options)
+
+  desc=<<EOD
 <?xml version="1.0"?>
 <root xmlns="urn:schemas-upnp-org:device-1-0" configId="1">
   <specVersion>
-    <major>1</major>
-    <minor>1</minor>
+    <major>#{opt[:version_major]}</major>
+    <minor>#{opt[:version_minor]}</minor>
   </specVersion>
   <device>
-    <deviceType>urn:schemas-upnp-org:device:Base:1-0</deviceType>
+    <deviceType>urn:schemas-upnp-org:device:#{opt[:device_type].capitalize}:1-0</deviceType>
     <friendlyName>Friendly name</friendlyName>
     <manufacturer>RUPNP</manufacturer>
     <modelName>Model name</modelName>
     <UDN>uuid:#{uuid}</UDN>
-  </device>
-</root>
 EOD
+  if opt[:device_type] != :base
+    desc << <<EOD
+    <serviceList>
+      <service>
+        <serviceType>usrn:schemas-upnp-org:service:ContentDirectory:1</serviceType>
+        <serviceId>urn:upnp-org:serviceId:</serviceId>
+
+      </service>
+    </serviceList>
+EOD
+  end
+  desc << "  </device>\n</root>\n"
 end
 
 

data/tasks/gem.rake

@@ -28,7 +28,7 @@ EOF
   s.add_dependency 'savon', '~>2.3.0'
   s.add_dependency 'pry', '~>0.9.12'
 
-  s.add_development_dependency 'rspec', '~>2.14.7'
+  s.add_development_dependency 'rspec', '~>2.14.0'
   s.add_development_dependency 'em-spec', '~>0.2.6'
   s.add_development_dependency 'simplecov', '~>0.8.2'
   s.add_development_dependency 'webmock', '~>1.16.1'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rupnp
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-13 00:00:00.000000000 Z
+date: 2014-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: uuid
@@ -114,7 +114,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.14.7
+        version: 2.14.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -122,7 +122,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.14.7
+        version: 2.14.0
 - !ruby/object:Gem::Dependency
   name: em-spec
   requirement: !ruby/object:Gem::Requirement
@@ -185,6 +185,7 @@ files:
 - spec/ssdp/listener_spec.rb
 - spec/ssdp/notifier_spec.rb
 - spec/ssdp/searcher_spec.rb
+- spec/cp/remote_device_spec.rb
 - spec/control_point_spec.rb
 - spec/spec_helper.rb
 - lib/rupnp.rb