rupnp 0.2.1 → 0.2.2

data/lib/rupnp/control_point.rb

@@ -48,6 +48,7 @@ module RUPNP
       @devices = []
       @new_device_channel = EM::Channel.new
       @bye_device_channel = EM::Channel.new
+      @add_event_url = EM::Channel.new
     end
 
     # Start control point.
@@ -78,7 +79,6 @@ module RUPNP
     # @return [void]
     def start_event_server(port=EVENT_SUB_DEFAULT_PORT)
       @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

data/lib/rupnp/cp/event_subscriber.rb

@@ -31,17 +31,15 @@ module RUPNP
       io = StringIO.new(data)
 
       status = io.readline
-      status =~ /HTTP\/1\.1 (\d+) (.+)/
-      resp[:status] = $2
-      resp[:status_code] = $1
-
-      io.each_line do |line|
-        if line =~ /(\w+):\s*(.*)/
-          resp[$1.downcase.to_sym] = $2.chomp
-        end
-      end
 
-      @response << resp
+      if status =~ /HTTP\/1\.1 (\d+) (.+)/
+        resp[:status] = $2
+        resp[:status_code] = $1
+
+        resp.merge!(get_http_headers(io))
+
+        @response << resp
+      end
     end
 
   end

data/lib/rupnp/cp/remote_device.rb

@@ -248,6 +248,10 @@ module RUPNP
           @description[:root][:device][:service_list][:service]
         sl = @description[:root][:device][:service_list][:service]
 
+        if sl.is_a? Hash
+          sl = [sl]
+        end
+
         proc_each = Proc.new do |s, iter|
           service = CP::RemoteService.new(self, @url_base, s)
 

data/lib/rupnp/cp/remote_service.rb

@@ -28,7 +28,7 @@ module RUPNP
   # a +#action_name+ method is created. This method requires a hash with
   # an element named +argument_name_in+.
   # If no <i>in</i> argument is required, an empty hash (<code>{}</code>)
-  # must be passed to the method.
+  # must be passed to the method. Hash keys may not be symbols.
   #
   # A Hash is returned, with a key for each <i>out</i> argument.
   #
@@ -111,23 +111,14 @@ module RUPNP
     # Get service from its description
     # @return [void]
     def fetch
-      if @scpd_url.empty?
-        fail 'no SCPD URL'
-        return
-      end
-
       scpd_getter = EM::DefaultDeferrable.new
 
       scpd_getter.errback do
         fail "cannot get SCPD from #@scpd_url"
+        next
       end
 
       scpd_getter.callback do |scpd|
-        if !scpd or scpd.empty?
-          fail "SCPD from #@scpd_url is empty"
-          next
-        end
-
         if bad_description?(scpd)
           fail 'not a UPNP 1.0/1.1 SCPD'
           next
@@ -146,6 +137,8 @@ module RUPNP
     # @param [Hash] options
     # @option options [Integer] timeout
     # @yieldparam [Event] event event received
+    # @yieldparam [Object] msg message received
+    # @return [Integer] subscribe id. May be used to unsubscribe on event
     def subscribe_to_event(options={}, &blk)
       cp = device.control_point
 
@@ -157,33 +150,33 @@ module RUPNP
 
       uri = URI(@event_sub_url)
       options[:timeout] ||= EVENT_SUB_DEFAULT_TIMEOUT
-      subscribe_req = <<EOR
-SUSCRIBE #{uri.path} HTTP/1.1\r
-HOST: #{HOST_IP}:#{port}\r
-USER-AGENT: #{RUPNP::USER_AGENT}\r
-CALLBACK: #@callback_url\r
-NT: upnp:event
-TIMEOUT: Second-#{options[:timeout]}\r
-\r
-EOR
-
-      server = uri.host
-      port = (uri.port || 80).to_i
-      ap @event_sub_url
-      ap server
-      ap port
-      con = EM.connect(server, port, CP::EventSubscriber, subscribe_req)
-
-      con.response.subscribe do |resp|
-        if resp[:status_code] != 200
-          log :warn, "Cannot subscribe to event #@event_sub_url: #{resp[:status]}"
+
+      log :info, "send SUBSCRIBE request to #{uri}"
+      con = EM::HttpRequest.new(@event_sub_url)
+      http = con.setup_request(:subscribe, :head => {
+                                 'HOST' => "#{uri.host}:#{uri.port}",
+                                 'USER-AGENT' => RUPNP::USER_AGENT,
+                                 'CALLBACK' => @callback_url,
+                                 'NT' => 'upnp:event',
+                                 'TIMEOUT' => "Second-#{options[:timeout]}"})
+
+      http.errback do |client|
+        log :warn, "Cannot subscribe to event: #{client.error}"
+      end
+
+      http.callback do
+        log :debug, 'Close connection to subscribe event URL'
+        con.close
+        if http.response_header.status != 200
+          log :warn, "Cannot subscribe to event #@event_sub_url:" +
+            " #{http.response_header.http_reason}"
         else
-          event = Event.new(resp[:sid], resp[:timeout].match(/(\d+)/)[1].to_i)
+          timeout = http.response_header['TIMEOUT'].match(/(\d+)/)[1] || 1800
+          event = Event.new(@event_sub_url, @callback_url,
+                            http.response_header['SID'], timeout.to_i)
           cp.add_event_url << ["/event#{num}", event]
-          event.subscribe(event, blk)
+          event.subscribe &blk
         end
-        log :info, 'Close connection to subscribe event URL'
-        con.close_connection
       end
     end
 
@@ -208,8 +201,10 @@ EOR
     def extract_service_state_table(scpd)
       if scpd[:scpd][:service_state_table][:state_variable]
         @state_table = scpd[:scpd][:service_state_table][:state_variable]
-        # ease debug print
-        @state_table.each { |s| s.each { |k, v| s[k] = v.to_s } }
+
+        if @state_table.is_a? Hash
+          @state_table = [@state_table]
+        end
       end
     end
 
@@ -217,6 +212,7 @@ EOR
       if scpd[:scpd][:action_list] and scpd[:scpd][:action_list][:action]
         log :info, "extract actions for service #@type"
         @actions = scpd[:scpd][:action_list][:action]
+        @actions = [@actions] unless @actions.is_a? Array
         @actions.each do |action|
           action[:arguments] = action[:argument_list][:argument]
           action.delete :argument_list
@@ -229,16 +225,17 @@ EOR
       action[:name] = action[:name].to_s
       action_name = action[:name]
       name = snake_case(action_name).to_sym
+
       define_singleton_method(name) do |params|
+        if params
+          unless params.is_a? Hash
+            raise ArgumentError, 'only hash arguments are accepted'
+          end
+        end
         response = @soap.call(action_name) do |locals|
           locals.attributes 'xmlns:u' => @type
           locals.soap_action "#{type}##{action_name}"
-          if params
-            unless params.is_a? Hash
-              raise ArgumentError, 'only hash arguments are accepted'
-            end
-            locals.message params
-          end
+          locals.message params
         end
 
         if action[:arguments].is_a? Hash
@@ -248,11 +245,12 @@ EOR
           end
         else
           log :debug, 'true argument list'
-          action[:arguments].map do |arg|
-            if params arg[:direction] == 'out'
-              process_soap_response name, response, arg
-            end
+          hsh = {}
+          outer = action[:arguments].select { |arg| arg[:direction] == 'out' }
+          outer.each do |arg|
+            hsh.merge! process_soap_response(name, response, arg)
           end
+          hsh
         end
       end
     end

data/lib/rupnp/event.rb

@@ -9,9 +9,13 @@ module RUPNP
     # @return [Integer]
     attr_reader :sid
 
+    # @param [String] event_suburl Event subscription URL
+    # @param [String] callback_url Callback URL to receive events
     # @param [#to_i] sid
     # @param [Integer] timeout for event (in seconds)
-    def initialize(sid, timeout)
+    def initialize(event_suburl, callback_url, sid, timeout)
+      super()
+      @event_suburl = event_suburl
       @sid, @timeout = sid, timeout
 
       @timeout_timer = EM.add_timer(@timeout) { self << :timeout }

data/lib/rupnp/http.rb

@@ -0,0 +1,43 @@
+module RUPNP
+
+  # HTTP module to provide some helper methods
+  # @author Sylvain Daubert
+  module HTTP
+
+    # Return status from HTTP response
+    # @param [IO] sock
+    # @return [Booelan]
+    def is_http_status_ok?(sock)
+      sock.readline =~ /\s*HTTP\/1.1 200 OK\r\n\z/i
+    end
+
+    # Get HTTP headers from response
+    # @param [IO] sock
+    # @return [Hash] keys are downcase header name strings
+    def get_http_headers(sock)
+      headers = {}
+      sock.each_line do |l|
+        l =~ /([\w\.-]+):\s*(.*)/
+        if $1
+          headers[$1.downcase] = $2.strip
+        end
+      end
+      headers
+    end
+
+    # Get HTTP verb from HTTP request
+    # @param [IO] sock
+    # @return [nil,Hash] keys are +:verb+, +:path+, +:http_version+ and
+    #   +:cmd+ (all line)
+    def get_http_verb(sock)
+      str = sock.readline
+      if str =~ /([\w-]+)\s+(.*)\s+HTTP\/(\d\.\d)/
+        {:verb => $1, :path => $2, :http_version => $3, :cmd => str}
+      else
+        nil
+      end
+    end
+
+  end
+
+end

data/lib/rupnp/ssdp/listener.rb

@@ -3,7 +3,7 @@ module RUPNP
   # Listener class for listening for devices' notifications
   # @author Sylvain Daubert
   class SSDP::Listener < SSDP::MulticastConnection
-    include SSDP::HTTP
+    include HTTP
 
     # Channel to receive notifications
     # @return [EM::Channel]

data/lib/rupnp/ssdp/multicast_connection.rb

@@ -2,47 +2,50 @@ require 'socket'
 require 'ipaddr'
 
 module RUPNP
+  module SSDP
 
-  # Base class for multicast connections (mainly SSDP search and listen)
-  # @abstract
-  class SSDP::MulticastConnection < EM::Connection
-    include LogMixin
+    # Base class for multicast connections (mainly SSDP search and listen)
+    # @abstract
+    class MulticastConnection < EM::Connection
+      include LogMixin
 
-    # @param [Integer] ttl
-    def initialize(ttl=nil)
-      @ttl = ttl || DEFAULT_TTL
-      setup_multicast_socket
-    end
+      # @param [Integer] ttl
+      def initialize(ttl=nil)
+        @ttl = ttl || DEFAULT_TTL
+        setup_multicast_socket
+      end
 
-    # Get peer info
-    # @return [Array] [port, hostname]
-    def peer_info
-      Socket.unpack_sockaddr_in(get_peername)
-    end
+      # Get peer info
+      # @return [Array] [port, hostname]
+      def peer_info
+        Socket.unpack_sockaddr_in(get_peername)
+      end
 
 
-    private
+      private
 
-    def setup_multicast_socket
-      set_membership IPAddr.new(MULTICAST_IP).hton + IPAddr.new('0.0.0.0').hton
-      set_ttl
-      set_reuse_addr
-    end
+      def setup_multicast_socket
+        set_membership(IPAddr.new(MULTICAST_IP).hton +
+                       IPAddr.new('0.0.0.0').hton)
+        set_ttl
+        set_reuse_addr
+      end
 
-    def set_membership(value)
-      set_sock_opt Socket::IPPROTO_IP, Socket::IP_ADD_MEMBERSHIP, value
-    end
+      def set_membership(value)
+        set_sock_opt Socket::IPPROTO_IP, Socket::IP_ADD_MEMBERSHIP, value
+      end
 
-    def set_ttl
-      value = [@ttl].pack('i')
-      set_sock_opt Socket::IPPROTO_IP, Socket::IP_MULTICAST_TTL, value
-      set_sock_opt Socket::IPPROTO_IP, Socket::IP_TTL, value
-    end
+      def set_ttl
+        value = [@ttl].pack('i')
+        set_sock_opt Socket::IPPROTO_IP, Socket::IP_MULTICAST_TTL, value
+        set_sock_opt Socket::IPPROTO_IP, Socket::IP_TTL, value
+      end
+
+      def set_reuse_addr
+        set_sock_opt Socket::SOL_SOCKET, Socket::SO_REUSEADDR, true
+      end
 
-    def set_reuse_addr
-      set_sock_opt Socket::SOL_SOCKET, Socket::SO_REUSEADDR, true
     end
 
   end
-
 end

data/lib/rupnp/ssdp/notifier.rb

@@ -4,7 +4,7 @@ module RUPNP
   # Searcher class for searching devices
   # @author Sylvain Daubert
   class SSDP::Notifier < SSDP::MulticastConnection
-    include SSDP::HTTP
+    include HTTP
 
     # Number of SEARCH datagrams to send
     DEFAULT_NOTIFY_TRY = 2

data/lib/rupnp/ssdp/search_responder.rb

@@ -3,7 +3,7 @@ module RUPNP
   # M-SEARCH responder for M-SEARCH multicast requests from control points.
   # @author Sylvain Daubert
   module SSDP::SearchResponder
-    include SSDP::HTTP
+    include HTTP
 
     def receive_data(data)
       port, ip = peer_info

data/lib/rupnp/ssdp/searcher.rb

@@ -4,7 +4,7 @@ module RUPNP
   # Searcher class for searching devices
   # @author Sylvain Daubert
   class SSDP::Searcher < SSDP::MulticastConnection
-    include SSDP::HTTP
+    include HTTP
 
     # Number of SEARCH datagrams to send
     DEFAULT_M_SEARCH_TRY = 2

data/lib/rupnp/ssdp.rb

@@ -1,4 +1,3 @@
-require_relative 'ssdp/http'
 require_relative 'ssdp/multicast_connection'
 require_relative 'ssdp/searcher'
 require_relative 'ssdp/listener'

data/lib/rupnp.rb

@@ -6,7 +6,7 @@ require 'eventmachine-le'
 module RUPNP
 
   # RUPNP version
-  VERSION = '0.2.1'
+  VERSION = '0.2.2'
 
   @logdev = STDERR
   @log_level = :info
@@ -49,6 +49,7 @@ end
 
 require_relative 'rupnp/constants'
 require_relative 'rupnp/tools'
+require_relative 'rupnp/http'
 require_relative 'rupnp/log_mixin'
 require_relative 'rupnp/event'
 require_relative 'rupnp/control_point'

data/spec/control_point_spec.rb

@@ -33,10 +33,10 @@ module RUPNP
 
           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)
+          }, :body => generate_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)
+          }, :body => generate_device_description(uuid2)
 
           cp.send meth
 
@@ -53,7 +53,7 @@ module RUPNP
         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)
+        }, :body => generate_device_description(uuid)
 
         cp.search_only
 
@@ -74,7 +74,7 @@ module RUPNP
         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])
+          }, :body => generate_device_description(notify_options[:uuid])
 
         EM.add_timer(2) do
           expect(cp.devices).to be_empty
@@ -94,7 +94,7 @@ module RUPNP
         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])
+          }, :body => generate_device_description(notify_options[:uuid])
 
         EM.add_timer(2) do
           expect(cp.devices).to be_empty
@@ -118,7 +118,7 @@ module RUPNP
         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])
+          }, :body => generate_device_description(notify_options[:uuid])
 
         EM.add_timer(2) do
           expect(cp.devices).to be_empty
@@ -147,6 +147,9 @@ module RUPNP
       expect(cp.find_device_by_udn(uuid2)).to eq(cp.devices[1])
       expect(cp.find_device_by_udn(uuid3)).to be_nil
     end
+
+    it '#start_event_server should only start server if not already running'
+    it '#stopt_event_server should stop event server'
   end
 
 end

data/spec/cp/remote_device_spec.rb

@@ -14,7 +14,7 @@ module RUPNP
          '<?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>',]
+         '<?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' }
@@ -54,7 +54,7 @@ module RUPNP
           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))
+                          :body => generate_device_description(uuid))
             rd.errback { fail 'RemoteDevice#fetch should work' }
             rd.callback { done }
             rd.fetch
@@ -75,10 +75,10 @@ module RUPNP
         end
 
         it "should fail when description header is not a UPnP 1.x response" do
-          desc = generate_xml_device_description(uuid)
+          desc = generate_device_description(uuid)
           em do
             stub_request(:get, location).
-              to_return(:body => generate_xml_device_description(uuid),
+              to_return(:body => generate_device_description(uuid),
                         :headers => { 'SERVER' => 'Linux/1.2 Apache/1.0' },
                         :body => desc)
 
@@ -124,7 +124,7 @@ module RUPNP
           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))
+                          :body => generate_device_description(uuid))
             rd.errback { fail 'RemoteDevice#fetch should work' }
             rd.callback do
               done
@@ -133,8 +133,46 @@ module RUPNP
           end
         end
 
-        it "should extract services if any"
-        it "should not fail when a service cannot be extracted"
+        it "should extract services if any" do
+          dev_desc = generate_device_description(uuid, :device_type => 'MediaServer')
+          scpd = generate_scpd
+          em do
+            stub_request(:get, location).
+              to_return(:headers => { 'SERVER' => 'OS/1.0 UPnP/1.1 TEST/1.0'},
+                        :body => dev_desc)
+            stub_request(:get, 'http://127.0.0.1:1234/cd/description.xml').
+              to_return(:headers => { 'SERVER' => 'OS/1.0 UPnP/1.1 TEST/1.0'},
+                        :body => scpd)
+            stub_request(:get, 'http://127.0.0.1:1234/cd/control').
+              to_return(:status => 404)
+
+            rd.errback { |d, msg| fail msg }
+            rd.callback do
+              expect(rd.services).to have(1).item
+              done
+            end
+            rd.fetch
+          end
+        end
+
+        it "should not fail when a service cannot be extracted" do
+          dev_desc = generate_device_description(uuid, :device_type => 'MediaServer')
+          em do
+            stub_request(:get, location).
+              to_return(:headers => { 'SERVER' => 'OS/1.0 UPnP/1.1 TEST/1.0'},
+                        :body => dev_desc)
+            stub_request(:get, 'http://127.0.0.1:1234/cd/description.xml').
+              to_return(:status => 404)
+
+            rd.errback { |d, msg| fail msg }
+            rd.callback do
+              expect(rd.services).to have(0).item
+              done
+            end
+            rd.fetch
+          end
+        end
+
       end
 
       context "#update" do
@@ -142,7 +180,7 @@ module RUPNP
           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))
+                        :body => generate_device_description(uuid))
             rd.errback { fail 'RemoteDevice#fetch should work' }
             rd.callback do
               not2 = notification.dup
@@ -164,7 +202,7 @@ module RUPNP
           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))
+                        :body => generate_device_description(uuid))
             rd.errback { fail 'RemoteDevice#fetch should work' }
             rd.callback do
               not2 = notification.merge('nextbootid.upnp.org' => 15)
@@ -180,7 +218,7 @@ module RUPNP
           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))
+                        :body => generate_device_description(uuid))
             rd.errback { fail 'RemoteDevice#fetch should work' }
             rd.callback do
               not2 = notification.merge('configid.upnp.org' => 47)

data/spec/cp/remote_service_spec.rb

@@ -0,0 +1,197 @@
+require_relative '../spec_helper'
+module RUPNP
+  module CP
+
+    describe RemoteService do
+      include EM::SpecHelper
+      include RUPNP::Tools
+
+      let(:url_base) { 'http://127.0.0.1:1234/' }
+      let(:sd) { {
+          :service_type => 'urn:schemas-upnp-org:service:Service:1-0',
+          :service_id => 'urn:upnp-org:serviceId:Service',
+          :scpdurl => '/service/description.xml',
+          :control_url => '/service/control',
+          :event_sub_url => '/service/event' } }
+      let(:rs){ RemoteService.new(double('rdevice'), url_base, sd)}
+
+      context '#fetch' do
+
+        it 'should fetch SCPD' do
+          stub_request(:get, build_url(url_base, sd[:scpdurl])).
+            to_return(:headers => { 'SERVER' => 'OS/1.0 UPnP/1.1 TEST/1.0'},
+                      :body => generate_scpd)
+          em do
+            rs.errback { fail 'RemoteService#fetch should work' }
+            rs.callback do
+              done
+            end
+            rs.fetch
+          end
+        end
+
+        it 'should set state table' do
+          stub_request(:get, build_url(url_base, sd[:scpdurl])).
+            to_return(:headers => { 'SERVER' => 'OS/1.0 UPnP/1.1 TEST/1.0'},
+                      :body => generate_scpd(:nb_state_var => 4))
+          em do
+            rs.errback { fail 'RemoteService#fetch should work' }
+            rs.callback do
+              expect(rs.state_table).to have(4).items
+              expect(rs.state_table[0][:name]).to eq('X_variableName1')
+              expect(rs.state_table[1][:data_type]).to eq('ui4')
+              expect(rs.state_table[2][:default_value]).to eq('2')
+              expect(rs.state_table[3][:allowed_value_range][:maximum]).
+                to eq('255')
+              done
+            end
+            rs.fetch
+          end
+        end
+
+        it 'should define actions as methods from description' do
+          stub_request(:get, build_url(url_base, sd[:scpdurl])).
+            to_return(:headers => { 'SERVER' => 'OS/1.0 UPnP/1.1 TEST/1.0'},
+                      :body => generate_scpd(:nb_state_var => 2,
+                                             :define_action => true))
+          stub_request(:post, build_url(url_base, sd[:control_url])).
+            to_return(:headers => { 'SERVER' => 'OS/1.0 UPnP/1.1 TEST/1.0'},
+                      :body => action_response(var2: 1))
+          em do
+            rs.errback { fail 'RemoteService#fetch should work' }
+            rs.callback do
+              expect(rs).to respond_to(:test_action)
+              res = rs.test_action('var1' => 10)
+              expect(res[:var2]).to eq(1)
+              done
+            end
+            rs.fetch
+          end
+        end
+
+        it 'should fail when SCPDURL is unreachable' do
+          stub_request(:get, build_url(url_base, sd[:scpdurl])).to_timeout
+
+          em do
+            rs.errback  do |msg|
+              expect(msg).to match(/cannot get SCPD/)
+              done
+            end
+            rs.callback { fail 'RemoteService#fetch should not work' }
+            rs.fetch
+          end
+        end
+
+        it 'should fail when SCPDURL does not return a SCPD' do
+          stub_request(:get, build_url(url_base, sd[:scpdurl])).
+            to_return(:headers => { 'SERVER' => 'OS/1.0 UPnP/1.1 TEST/1.0'},
+                      :body => 'This is only text!')
+
+          em do
+            rs.errback do |msg|
+              expect(msg).to match(/not a UPNP .* SCPD/)
+              done
+            end
+            rs.callback { fail 'RemoteService#fetch should not work' }
+            rs.fetch
+          end
+        end
+
+        it "should fail when SCPD does not conform to UPnP spec" do
+          stub_request(:get, build_url(url_base, sd[:scpdurl])).
+            to_return(:headers => { 'SERVER' => 'OS/1.0 UPnP/1.1 TEST/1.0'},
+                      :body => generate_scpd(:version_major => 2))
+
+          em do
+            rs.errback do |msg|
+              expect(msg).to match(/not a UPNP .* SCPD/)
+              done
+            end
+            rs.callback { fail 'RemoteService#fetch should not work' }
+            rs.fetch
+          end
+        end
+      end
+
+      context '#subscribe_to_event' do
+
+        before(:each) do
+          stub_request(:get, build_url(url_base, sd[:scpdurl])).
+            to_return(:headers => { 'SERVER' => 'OS/1.0 UPnP/1.1 TEST/1.0'},
+                      :body => generate_scpd)
+          @webstub = stub_request(:subscribe,
+                                  build_url(url_base, sd[:event_sub_url])).
+            with(:headers => { 'NT' => 'upnp:event'}).
+            to_return(:headers => {
+                        'SERVER' => 'OS/1.0 UPnP/1.1 TEST/1.0',
+                        'SID' => "uuid:#{UUID.generate}",
+                        'CONTENT-LENGTH' => 0,
+                        'TIMEOUT' => 'Second-1800'})
+          rs.device.stub(:control_point => ControlPoint.new(:root))
+        end
+
+        it 'should start event server' do
+          em do
+            rs.errback { fail 'RemoteService#fetch should work' }
+            rs.callback do
+              expect(rs.device.control_point.event_port).to be_nil
+              rs.subscribe_to_event {}
+              expect(rs.device.control_point.event_port).to be_a(Integer)
+              done
+            end
+            rs.fetch
+          end
+        end
+
+        it 'should subscribe to an event' do
+          em do
+            rs.errback { fail 'RemoteService#fetch should work' }
+            rs.callback do
+              rs.subscribe_to_event do |msg|
+                done
+              end
+            end
+            rs.fetch
+
+            rs.device.control_point.add_event_url.subscribe do |url, event|
+              EM.add_timer(0) { event << 'message' }
+            end
+          end
+        end
+
+        it 'should not fail if subscribtion is not possible' do
+          rd_io, wr_io = IO.pipe
+          begin
+            RUPNP.logdev = wr_io
+            RUPNP.log_level = :warn
+
+            remove_request_stub(@webstub)
+            stub_request(:subscribe, build_url(url_base, sd[:event_sub_url])).
+              with(:headers => { 'NT' => 'upnp:event'}).
+              to_timeout.then.
+              to_return(:status => 404)
+
+            em do
+              rs.errback { fail 'RemoteService#fetch should work' }
+              rs.callback do
+                expect { rs.subscribe_to_event { fail } }.to_not raise_error
+                expect { rs.subscribe_to_event { fail } }.to_not raise_error
+                EM.add_timer(1) do
+                  expect(rd_io.readline).to match(/timeout/)
+                  expect(rd_io.readline).to match(/Not Found/)
+                  done
+                end
+              end
+              rs.fetch
+            end
+          ensure
+            rd_io.close
+            wr_io.close
+          end
+        end
+      end
+
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -58,7 +58,7 @@ EOR
 end
 
 
-def generate_xml_device_description(uuid, options={})
+def generate_device_description(uuid, options={})
   opt = {
     :version_major => 1,
     :version_minor => 1,
@@ -67,7 +67,7 @@ def generate_xml_device_description(uuid, options={})
 
   desc=<<EOD
 <?xml version="1.0"?>
-<root xmlns="urn:schemas-upnp-org:device-1-0" configId="1">
+<root xmlns="urn:schemas-upnp-org:device-1-0" configId="23">
   <specVersion>
     <major>#{opt[:version_major]}</major>
     <minor>#{opt[:version_minor]}</minor>
@@ -84,8 +84,10 @@ EOD
     <serviceList>
       <service>
         <serviceType>usrn:schemas-upnp-org:service:ContentDirectory:1</serviceType>
-        <serviceId>urn:upnp-org:serviceId:</serviceId>
-
+        <serviceId>urn:upnp-org:serviceId:ContentDirectory</serviceId>
+        <SCPDURL>/cd/description.xml</SCPDURL>
+        <ControlURL>/cd/control</ControlURL>
+        <EventURL></EventURL>
       </service>
     </serviceList>
 EOD
@@ -94,6 +96,85 @@ EOD
 end
 
 
+def generate_scpd(options={})
+  opt = {
+    :version_major => 1,
+    :version_minor => 1,
+    :nb_state_var => 1,
+    :define_action => false,
+    :send_event => false
+  }.merge(options)
+
+  scpd=<<EOD
+<?xml version="1.0"?>
+<scpd xmlns="urn:schemas-upnp-org:service-1-0" configId="23">
+  <specVersion>
+    <major>#{opt[:version_major]}</major>
+    <minor>#{opt[:version_minor]}</minor>
+  </specVersion>
+EOD
+
+  if opt[:define_action]
+    scpd << <<EOAL
+  <actionList>
+    <action>
+      <name>testAction</name>
+      <argumentList>
+        <argument>
+          <name>var1</name>
+          <direction>in</direction>
+          <relatedStateVariable>X_variableName1</relatedStateVariable>
+        </argument>
+        <argument>
+          <name>var2</name>
+          <direction>out</direction>
+          <retval/>
+          <relatedStateVariable>X_variableName2</relatedStateVariable>
+        </argument>
+      </argumentList>
+    </action>
+  </actionList>
+EOAL
+  end
+
+  scpd << '  <serviceStateTable>'
+  opt[:nb_state_var].times do |i|
+    scpd << <<EOSV
+    <stateVariable sendEvents="#{opt[:send_event] ? 'yes' : 'no'}">
+      <name>X_variableName#{i+1}</name>
+      <dataType>ui4</dataType>
+      <defaultValue>#{i}</defaultValue>
+      <allowedValueRange>
+        <minimum>0</minimum>
+        <maximum>#{64*(i+1) - 1}</maximum>
+      </allowedValueRange>
+    </stateVariable>
+EOSV
+  end
+  scpd << "  </serviceStateTable>\n</scpd>\n"
+end
+
+
+def action_response(hash)
+  r = <<EOD
+<?xml version="1.0"?>
+<s:Envelope
+ xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"
+ s:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
+  <s:Body>
+    <u:testActionResponse xmlns:u="urn:schemas-upnp-org:service:service:1">
+EOD
+
+  hash.each { |k, v| r << "      <#{k}>#{v}</#{k}>\n"}
+
+  r << <<EOD
+    </u:testActionResponse>
+  </s:Body>
+</s:Envelope>
+EOD
+end
+
+
 NOTIFY_REGEX = {
   :common => [
               /^NOTIFY \* HTTP\/1.1\r\n/,

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rupnp
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-20 00:00:00.000000000 Z
+date: 2014-02-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: uuid
@@ -185,6 +185,7 @@ files:
 - spec/ssdp/listener_spec.rb
 - spec/ssdp/notifier_spec.rb
 - spec/ssdp/searcher_spec.rb
+- spec/cp/remote_service_spec.rb
 - spec/cp/remote_device_spec.rb
 - spec/control_point_spec.rb
 - spec/spec_helper.rb
@@ -197,7 +198,6 @@ files:
 - lib/rupnp/ssdp/msearch_responder.rb
 - lib/rupnp/ssdp/search_responder.rb
 - lib/rupnp/ssdp/notifier.rb
-- lib/rupnp/ssdp/http.rb
 - lib/rupnp/control_point.rb
 - lib/rupnp/cp/remote_service.rb
 - lib/rupnp/cp/base.rb
@@ -208,6 +208,7 @@ files:
 - lib/rupnp/ssdp.rb
 - lib/rupnp/log_mixin.rb
 - lib/rupnp/tools.rb
+- lib/rupnp/http.rb
 - lib/rupnp/event.rb
 - bin/discover
 - tasks/spec.rake

data/lib/rupnp/ssdp/http.rb

@@ -1,45 +0,0 @@
-module RUPNP
-  module SSDP
-
-    # HTTP module to provide some helper methods
-    # @author Sylvain Daubert
-    module SSDP::HTTP
-
-      # Return status from HTTP response
-      # @param [IO] sock
-      # @return [Booelan]
-      def is_http_status_ok?(sock)
-        sock.readline =~ /\s*HTTP\/1.1 200 OK\r\n\z/i
-      end
-
-      # Get HTTP headers from response
-      # @param [IO] sock
-      # @return [Hash] keys are downcase header name strings
-      def get_http_headers(sock)
-        headers = {}
-        sock.each_line do |l|
-          l =~ /([\w\.-]+):\s*(.*)/
-          if $1
-            headers[$1.downcase] = $2.strip
-          end
-        end
-        headers
-      end
-
-      # Get HTTP verb from HTTP request
-      # @param [IO] sock
-      # @return [nil,Hash] keys are +:verb+, +:path+, +:http_version+ and
-      #   +:cmd+ (all line)
-      def get_http_verb(sock)
-        str = sock.readline
-        if str =~ /([\w-]+)\s+(.*)\s+HTTP\/(\d\.\d)/
-          {:verb => $1, :path => $2, :http_version => $3, :cmd => str}
-        else
-          nil
-        end
-      end
-
-    end
-
-  end
-end