rupnp 0.1.0 → 0.2.0

data/lib/rupnp.rb

@@ -6,7 +6,7 @@ require 'eventmachine-le'
 module RUPNP
 
   # RUPNP version
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 
   @logdev = STDERR
   @log_level = :info
@@ -59,4 +59,4 @@ require_relative 'rupnp/cp/event_server'
 require_relative 'rupnp/cp/event_subscriber'
 require_relative 'rupnp/ssdp'
 
-#require_relative 'rupnp/device'
+require_relative 'rupnp/device'

data/lib/rupnp/control_point.rb

@@ -60,9 +60,13 @@ module RUPNP
     # @return [void]
     def start
       search_devices_and_listen @search_target, @search_options
-      yield @new_device_channel, @bye_device_channel
+      yield @new_device_channel, @bye_device_channel if block_given?
     end
 
+    # Start a search for devices. No listen for update is made.
+    #
+    # Found devices are accessible through {#devices}.
+    # @return [void]
     def search_only
       options = @search_options.dup
       options[:search_only] = true
@@ -73,8 +77,8 @@ module RUPNP
     # @param [Integer] port port to listen for
     # @return [void]
     def start_event_server(port=EVENT_SUB_DEFAULT_PORT)
-      @event_port = port
-      @add_event_url = EM::Channel.new
+      @event_port ||= port
+      @add_event_url ||= EM::Channel.new
       @event_server ||= EM.start_server('0.0.0.0', port, CP::EventServer,
                                         @add_event_url)
     end
@@ -83,7 +87,9 @@ module RUPNP
     # @see #start_event_server
     # @return [void]
     def stop_event_server
+      @event_port = nil
       EM.stop_server @event_server
+      @event_server = nil
     end
 
     # Add a device to the control point
@@ -129,14 +135,19 @@ module RUPNP
           listener = SSDP.listen
 
           listener.notifications.subscribe do |notification|
+            udn = usn2udn(notification['usn'])
+
             case notification['nts']
-            when 'ssdp:alive'
-              create_device notification
+            when 'ssdp:alive', 'ssdp:update'
+              d = @devices.find { |d| d.udn == udn }
+              if d
+                d.update notification
+              else
+                create_device notification
+              end
             when 'ssdp:byebye'
-              udn = usn2udn(notification['usn'])
               log :info, "byebye notification sent by device #{udn}"
-              rejected = @devices.reject! { |d| d.udn == udn }
-              log :info, "#{rejected.udn} device removed" if rejected
+              @devices.reject! { |d| d.udn == udn }
             else
               log :warn, "Unknown notification type: #{notification['nts']}"
             end

data/lib/rupnp/cp/remote_device.rb

@@ -7,6 +7,12 @@ module RUPNP
   # A device is a UPnP service provider.
   # @author Sylvain Daubert.
   class CP::RemoteDevice < CP::Base
+
+    # Number of seconds the advertisement is valid.
+    # Used when +ssdp:update+ advertisement is received but no
+    # previuous +ssdp:alive+ was received.
+    DEFAULT_MAX_AGE = 600
+
     # Get control point which controls this device
     # @return [ControlPoint]
     attr_reader :control_point
@@ -34,6 +40,12 @@ module RUPNP
     # Expiration time for the advertisement
     # @return [Time]
     attr_reader :expiration
+    # BOOTID.UPNP.ORG field value
+    # @return [Integer]
+    attr_reader :boot_id
+    # CONFIGID.UPNP.ORG field value
+    # @return [nil, Integer]
+    attr_reader :config_id
 
     # UPnP version used by the device
     # @return [String]
@@ -106,6 +118,16 @@ module RUPNP
     # Get device from its description
     # @return [void]
     def fetch
+      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
+        fail self, 'no BOOTID.UPNP.ORG field. Message discarded.'
+      end
+      @config_id = @notification['confgid.upnp.org']
+      @config_id = @config_id.to_i if @config_id
+
       description_getter = EM::DefaultDeferrable.new
 
       description_getter.errback do
@@ -143,6 +165,17 @@ module RUPNP
       end
     end
 
+    # Update a device from a ssdp:update notification
+    # @param [String] notification
+    # @return [void]
+    def update(notification)
+      update_expiration notification
+      @boot_id = notification['nextbootid.upnp.org'].to_i
+      if notification['configid.upnp.org']
+        @config_id = notification['configid.upnp.org'].to_i
+      end
+    end
+
 
     private
 
@@ -153,15 +186,8 @@ module RUPNP
       @server = @notification['server']
       @location = @notification['location']
       @ext = @notification['ext']
-      @date = @notification['date'] || ''
-      @cache_control = @notification['cache-control'] || ''
 
-      max_age = @cache_control.match(/max-age\s*=\s*(\d+)/)[1].to_i
-      @expiration = if @date.empty?
-                      Time.now + max_age
-                    else
-                      Time.parse(@date) + max_age
-                    end
+      update_expiration @notification
 
       if @location
         get_description @location, getter
@@ -204,12 +230,13 @@ module RUPNP
       @model_number = device[:model_number] || ''
       @model_url = device[:model_url] || ''
       @serial_umber = device[:serial_number] || ''
-      @udn = device[:udn]
+      @udn = device[:udn].gsub(/uuid:/, '')
       @upc = device[:upc] || ''
       @presentation_url = device[:presentation_url] || ''
     end
 
     def extract_icons
+      return unless @description[:root][:device][:icon_list]
       @description[:root][:device][:icon_list][:icon].each do |h|
         icon = OpenStruct.new(h)
         icon.url = build_url(@url_base, icon.url)
@@ -266,6 +293,18 @@ module RUPNP
       end
     end
 
+    def update_expiration(notification)
+      @date = @notification['date'] || ''
+      @cache_control = @notification['cache-control'] || ''
+
+      if @notification['nts'] == 'ssdp:alive'
+        max_age = @cache_control.match(/max-age\s*=\s*(\d+)/)[1].to_i
+      else
+        max_age = DEFAULT_MAX_AGE
+      end
+      @expiration = (@date.empty? ? Time.now : Time.parse(@date)) + max_age
+    end
+
   end
 
 end

data/spec/control_point_spec.rb

@@ -0,0 +1,143 @@
+require_relative 'spec_helper'
+
+module RUPNP
+
+  describe ControlPoint do
+    include EM::SpecHelper
+
+    let(:cp) { ControlPoint.new(:all, :response_wait_time => 1) }
+    let(:notify_options) { {
+        max_age: 10,
+        ip: '127.0.0.1',
+        port: 1234,
+        uuid: UUID.generate,
+        boot_id: 1,
+        config_id: 1,
+        u_search_port: DISCOVERY_PORT,
+        try_number: 1
+      } }
+
+    it 'should initialize a new instance' do
+      expect(cp.devices).to be_a(Array)
+      expect(cp.devices).to be_empty
+    end
+
+    [:search_only, :start].each do |meth|
+      it "##{meth} should detect devices" do
+        em do
+          uuid1 = UUID.generate
+          generate_search_responder uuid1, 1234
+          generate_search_responder uuid1, 1234
+          uuid2 = UUID.generate
+          generate_search_responder uuid2, 1235
+
+          stub_request(:get, '127.0.0.1:1234').to_return :headers => {
+            'SERVER' => 'OS/1.0 UPnP/1.1 TEST/1.0'
+          }, :body => generate_xml_device_description(uuid1)
+          stub_request(:get, '127.0.0.1:1235').to_return :headers => {
+            'SERVER' => 'OS/1.0 UPnP/1.1 TEST/1.0'
+          }, :body => generate_xml_device_description(uuid2)
+
+          cp.send meth
+
+          EM.add_timer(1) do
+            expect(cp.devices).to have(2).item
+            done
+          end
+        end
+      end
+    end
+
+    it '#search_only should not register devices after wait time is expired' do
+      em do
+        uuid = UUID.generate
+        stub_request(:get, '127.0.0.1:1234').to_return :headers => {
+          'SERVER' => 'OS/1.0 UPnP/1.1 TEST/1.0'
+        }, :body => generate_xml_device_description(uuid)
+
+        cp.search_only
+
+        EM.add_timer(2) do
+          expect(cp.devices).to be_empty
+          generate_search_responder uuid, 1234
+          EM.add_timer(1) do
+            expect(cp.devices).to be_empty
+            done
+          end
+        end
+      end
+    end
+
+    it '#start should listen for alive notifications' do
+      em do
+        cp.start
+        stub_request(:get, '127.0.0.1:1234/root_description.xml').
+          to_return :headers => {
+            'SERVER' => 'OS/1.0 UPnP/1.1 TEST/1.0'
+          }, :body => generate_xml_device_description(notify_options[:uuid])
+
+        EM.add_timer(2) do
+          expect(cp.devices).to be_empty
+          SSDP.notify :root, :alive, notify_options
+          EM.add_timer(1) do
+            expect(cp.devices).to have(1).item
+            expect(cp.devices[0].udn).to eq(notify_options[:uuid])
+            done
+          end
+        end
+      end
+    end
+
+    it '#start should listen for update notifications' do
+      em do
+        cp.start
+        stub_request(:get, '127.0.0.1:1234/root_description.xml').
+          to_return :headers => {
+            'SERVER' => 'OS/1.0 UPnP/1.1 TEST/1.0'
+          }, :body => generate_xml_device_description(notify_options[:uuid])
+
+        EM.add_timer(2) do
+          expect(cp.devices).to be_empty
+          SSDP.notify :root, :alive, notify_options
+          EM.add_timer(1) do
+            SSDP.notify :root, :update, notify_options.merge(boot_id: 2)
+            EM.add_timer(1) do
+              expect(cp.devices).to have(1).item
+              expect(cp.devices[0].udn).to eq(notify_options[:uuid])
+              expect(cp.devices[0].boot_id).to eq(2)
+              done
+            end
+          end
+        end
+      end
+    end
+
+    it '#start should listen for byebye notifications' do
+      em do
+        cp.start
+        stub_request(:get, '127.0.0.1:1234/root_description.xml').
+          to_return :headers => {
+            'SERVER' => 'OS/1.0 UPnP/1.1 TEST/1.0'
+          }, :body => generate_xml_device_description(notify_options[:uuid])
+
+        EM.add_timer(2) do
+          expect(cp.devices).to be_empty
+          SSDP.notify :root, :alive, notify_options
+          EM.add_timer(1) do
+            expect(cp.devices).to have(1).item
+            expect(cp.devices[0].udn).to eq(notify_options[:uuid])
+            SSDP.notify :root, :byebye, notify_options
+            EM.add_timer(1) do
+              expect(cp.devices).to be_empty
+              done
+            end
+          end
+        end
+      end
+    end
+
+    it '#find_device_by_udn should get known devices'
+  end
+
+end
+

data/spec/spec_helper.rb

@@ -1,6 +1,14 @@
+require 'simplecov'
+SimpleCov.start do
+  add_filter "/spec/"
+end
+
 $:.unshift '../lib'
 require 'rupnp'
 require 'em-spec/rspec'
+require 'webmock/rspec'
+
+RUPNP.log_level = :failure
 
 
 class FakeMulticast < RUPNP::SSDP::MulticastConnection
@@ -25,31 +33,80 @@ class FakeMulticast < RUPNP::SSDP::MulticastConnection
 end
 
 
+def generate_search_responder(uuid, port)
+  responder = EM.open_datagram_socket(RUPNP::MULTICAST_IP,
+                                      RUPNP::DISCOVERY_PORT,
+                                      FakeMulticast)
+  responder.onmessage do |data|
+    data =~ /ST: (.*)\r\n/
+    target = $1
+    response =<<EOR
+HTTP/1.1 200 OK\r
+CACHE-CONTROL: max-age = 1800\r
+DATE: #{Time.now}\r
+EXT:\r
+LOCATION: http://127.0.0.1:#{port}\r
+SERVER: OS/1.0 UPnP/1.1 Test/1.0\r
+ST: #{target}\r
+USN: uuid:#{uuid}::upnp:rootdevice\r
+BOOTID.UPNP.ORG: 1\r
+CONFIGID.UPNP.ORG: 1\r
+\r
+EOR
+    responder.send_data response
+  end
+end
+
+
+def generate_xml_device_description(uuid)
+  <<EOD
+<?xml version="1.0"?>
+<root xmlns="urn:schemas-upnp-org:device-1-0" configId="1">
+  <specVersion>
+    <major>1</major>
+    <minor>1</minor>
+  </specVersion>
+  <device>
+    <deviceType>urn:schemas-upnp-org:device:Base:1-0</deviceType>
+    <friendlyName>Friendly name</friendlyName>
+    <manufacturer>RUPNP</manufacturer>
+    <modelName>Model name</modelName>
+    <UDN>uuid:#{uuid}</UDN>
+  </device>
+</root>
+EOD
+end
+
+
 NOTIFY_REGEX = {
-  :alive => [/^NOTIFY \* HTTP\/1.1\r\n/,
-             /HOST: 239\.255\.255\.250:1900\r\n/,
+  :common => [
+              /^NOTIFY \* HTTP\/1.1\r\n/,
+              /HOST: 239\.255\.255\.250:1900\r\n/,
+              /NT: [0-9A-Za-z:-]+\r\n/,
+              /USN: uuid:(.*)\r\n/,
+              /BOOTID.UPNP.ORG: \d+\r\n/,
+              /CONFIGID.UPNP.ORG: \d+\r\n/,
+             ].freeze,
+  :alive => [
              /CACHE-CONTROL:\s+max-age\s+=\s+\d+\r\n/,
              /LOCATION: http:\/\/(.*)\r\n/,
-             /NT: [0-9A-Za-z:-]+\r\n/,
-             /NTS: ssdp:(alive|byebye)\r\n/,
+             /NTS: ssdp:alive\r\n/,
              /SERVER: (.*)\r\n/,
-             /USN: uuid:(.*)\r\n/,
-             /BOOTID.UPNP.ORG: \d+\r\n/,
-             /CONFIGID.UPNP.ORG: \d+\r\n/,
-            ].freeze,
-  :byebye => [/^NOTIFY \* HTTP\/1.1\r\n/,
-             /HOST: 239\.255\.255\.250:1900\r\n/,
-             /NT: [0-9A-Za-z:-]+\r\n/,
-             /NTS: ssdp:(alive|byebye)\r\n/,
-             /USN: uuid:(.*)\r\n/,
-             /BOOTID.UPNP.ORG: \d+\r\n/,
-             /CONFIGID.UPNP.ORG: \d+\r\n/,
             ].freeze,
+  :byebye => [
+              /NTS: ssdp:byebye\r\n/,
+             ].freeze,
+  :update => [
+              /LOCATION: http:\/\/(.*)\r\n/,
+              /NTS: ssdp:update\r\n/,
+              /NEXTBOOTID.UPNP.ORG: \d+\r\n/,
+             ].freeze
 }
 
 RSpec::Matchers.define :be_a_notify_packet do |type|
   match do |packet|
-    success = NOTIFY_REGEX[type].all? { |r| packet.match(r) }
+    success = NOTIFY_REGEX[:common].all? { |r| packet.match(r) }
+    success &&= NOTIFY_REGEX[type].all? { |r| packet.match(r) }
     success && packet[-4..-1] == "\r\n\r\n"
   end
 end
@@ -68,3 +125,4 @@ RSpec::Matchers.define :be_a_msearch_packet do
     success && packet[-4..-1] == "\r\n\r\n"
   end
 end
+

data/spec/ssdp/notifier_spec.rb

@@ -16,7 +16,7 @@ module RUPNP
           u_search_port: 1900}
       end
 
-      [:alive, :byebye].each do |type|
+      [:alive, :update, :byebye].each do |type|
         it "should send 2 #{type} notify packets" do
           em do
             receiver = EM.open_datagram_socket(MULTICAST_IP, DISCOVERY_PORT,

data/spec/ssdp/searcher_spec.rb

@@ -47,6 +47,37 @@ module RUPNP
         end
       end
 
+      it "should discard and log bad responses" do
+        reader, writer = IO.pipe
+        begin
+          RUPNP.logdev = writer
+          em do
+            receiver = EM.open_datagram_socket(MULTICAST_IP, DISCOVERY_PORT,
+                                               FakeMulticast)
+            receiver.onmessage do
+              receiver.send_data "HTTP/1.1 404 Not Found\r\n\r\n"
+              receiver.send_data "this is not an HTTP message!"
+            end
+            searcher = RUPNP::SSDP.search(:all, config.merge(:try_number => 1))
+            searcher.discovery_responses.subscribe do |n|
+              next unless n['server'] =~ /RUPNP/
+              fail
+            end
+
+            EM.add_timer(1) do
+              expect(reader.readline).to match(/\[error\] bad HTTP response/)
+              expect(reader.readline).to match(/404/)
+              reader.readline
+              expect(reader.readline).to match(/\[error\] bad HTTP response/)
+              expect(reader.readline).to match(/not/)
+              done
+            end
+          end
+        ensure
+          reader.close
+          writer.close
+        end
+      end
     end
 
   end

data/tasks/gem.rake

@@ -19,7 +19,7 @@ EOF
   # For now, device is not in gem.
   files -= ['lib/rupnp/device.rb', 'spec/device_spec.rb']
   s.files = files
-  s.executables = "discover"
+  s.executables = ["discover"]
 
   s.add_dependency 'uuid', '~>2.3.0'
   s.add_dependency 'eventmachine-le', '~> 1.1.6'
@@ -30,6 +30,8 @@ EOF
 
   s.add_development_dependency 'rspec', '~>2.14.7'
   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'
 end
 
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rupnp
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-08 00:00:00.000000000 Z
+date: 2014-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: uuid
@@ -139,6 +139,38 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.2.6
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.2
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.16.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.16.1
 description: ! 'RUPNP is a Ruby UPnP framework. For now, only control points (clients)
 
   are supported. Devices (servers) will be later.
@@ -153,6 +185,7 @@ files:
 - spec/ssdp/listener_spec.rb
 - spec/ssdp/notifier_spec.rb
 - spec/ssdp/searcher_spec.rb
+- spec/control_point_spec.rb
 - spec/spec_helper.rb
 - lib/rupnp.rb
 - lib/rupnp/constants.rb