rupnp 0.1.0

data/spec/spec_helper.rb

@@ -0,0 +1,70 @@
+$:.unshift '../lib'
+require 'rupnp'
+require 'em-spec/rspec'
+
+
+class FakeMulticast < RUPNP::SSDP::MulticastConnection
+  attr_reader :handshake_response, :packets
+
+  def onclose(&blk); @onclose = blk; end
+  def onmessage(&blk); @onmessage = blk; end
+
+  def initialize
+    @packets = []
+  end
+
+  def receive_data(data)
+      @onmessage.call(data) if defined? @onmessage
+      @packets << data
+  end
+
+  def unbind
+    @onclose.call if defined? @onclose
+  end
+
+end
+
+
+NOTIFY_REGEX = {
+  :alive => [/^NOTIFY \* HTTP\/1.1\r\n/,
+             /HOST: 239\.255\.255\.250:1900\r\n/,
+             /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/,
+             /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,
+}
+
+RSpec::Matchers.define :be_a_notify_packet do |type|
+  match do |packet|
+    success = NOTIFY_REGEX[type].all? { |r| packet.match(r) }
+    success && packet[-4..-1] == "\r\n\r\n"
+  end
+end
+
+
+SEARCH_REGEX = [/^M-SEARCH \* HTTP\/1\.1\r\n/,
+                /HOST: 239\.255\.255\.250:1900\r\n/,
+                /MAN:\s+"ssdp:discover"\r\n/,
+                /MX:\s+\d+\r\n/,
+                /ST:\s+(ssdp:all|upnp:rootdevice|uuid:.+|urn:[\w:-]+)\r\n/,
+               ].freeze
+
+RSpec::Matchers.define :be_a_msearch_packet do
+  match do |packet|
+    success = SEARCH_REGEX.all? { |r| packet.match(r) }
+    success && packet[-4..-1] == "\r\n\r\n"
+  end
+end

data/spec/ssdp/listener_spec.rb

@@ -0,0 +1,102 @@
+require_relative '../spec_helper'
+
+module RUPNP
+  module SSDP
+
+    describe Listener do
+      include EM::SpecHelper
+
+      it "should receive alive and byebye notifications" do
+        RUPNP.log_level = :failure
+        em do
+          notifications = []
+          listener = SSDP.listen
+          listener.notifications.subscribe do |notification|
+            notifications << notification
+          end
+
+          EM.add_timer(1) do
+            options = {
+              max_age: 10,
+              ip: '127.0.0.1',
+              port: 65534,
+              uuid: UUID.generate,
+              boot_id: 1,
+              config_id: 1,
+              u_search_port: DISCOVERY_PORT,
+              try_number: 1
+            }
+            SSDP.notify :root, :alive, options
+            SSDP.notify :root, :byebye, options
+          end
+
+          EM.add_timer(2) do
+            listener.close_connection
+            expect(notifications).to have(2).items
+            expect(notifications[0]['nts']).to eq('ssdp:alive')
+            expect(notifications[1]['nts']).to eq('ssdp:byebye')
+            done
+          end
+        end
+      end
+
+      it "should ignore M-SEARCH requests" do
+        rd_io, wr_io = IO.pipe
+        begin
+          RUPNP.logdev = wr_io
+          RUPNP.log_level = :warn
+          em do
+            listener = SSDP.listen
+            listener.notifications.subscribe do |notification|
+              fail
+            end
+
+            searcher = SSDP.search(:all, :try_number => 1)
+
+            EM.add_timer(1) do
+              begin
+                warn = rd_io.read_nonblock(127)
+                expect(warn).to be_empty
+              rescue IO::WaitReadable
+              end
+              done
+            end
+          end
+        ensure
+         rd_io.close
+         wr_io.close
+        end
+      end
+
+      it "should ignore and log unknown requests" do
+        rd_io, wr_io = IO.pipe
+        begin
+          RUPNP.logdev = wr_io
+          RUPNP.log_level = :warn
+          em do
+            listener = SSDP.listen
+            listener.notifications.subscribe do |notification|
+              fail
+            end
+
+            fake = EM.open_datagram_socket(MULTICAST_IP, DISCOVERY_PORT,
+                                           FakeMulticast)
+            cmd = "GET / HTTP/1.1\r\n\r\n"
+            fake.send_datagram(cmd, MULTICAST_IP, DISCOVERY_PORT)
+
+            EM.add_timer(1) do
+              warn = rd_io.readline
+              expect(warn).to eq("[warn] Unknown HTTP command: #{cmd[0..-3]}")
+              done
+            end
+          end
+        ensure
+         rd_io.close
+         wr_io.close
+        end
+      end
+
+    end
+
+  end
+end

data/spec/ssdp/notifier_spec.rb

@@ -0,0 +1,61 @@
+require_relative '../spec_helper'
+
+module RUPNP
+  module SSDP
+
+    describe Notifier do
+      include EM::SpecHelper
+
+      let(:config) do
+        {max_age: 18000,
+          ip: '127.0.0.1',
+          port: 3001,
+          uuid: UUID.generate,
+          boot_id: 1,
+          config_id: 1,
+          u_search_port: 1900}
+      end
+
+      [:alive, :byebye].each do |type|
+        it "should send 2 #{type} notify packets" do
+          em do
+            receiver = EM.open_datagram_socket(MULTICAST_IP, DISCOVERY_PORT,
+                                               FakeMulticast)
+            notifier = RUPNP::SSDP.notify(:root, type, config)
+
+            EM.add_timer(1) do
+              expect(receiver.packets).to have(2).items
+              receiver.packets.each do |packet|
+                expect(packet).to be_a_notify_packet(type)
+              end
+              receiver.close_connection
+              done
+            end
+          end
+        end
+      end
+
+        it 'should send configured number of notify packets' do
+        em do
+          foreach = Proc.new do |n, iter|
+            receiver = EM.open_datagram_socket(MULTICAST_IP, DISCOVERY_PORT,
+                                               FakeMulticast)
+            cfg = config.merge!(try_number: n)
+            notifier = RUPNP::SSDP.notify(:root, :alive, cfg)
+
+            EM.add_timer(1) do
+              expect(receiver.packets).to have(n).items
+              receiver.close_connection
+              iter.next
+            end
+          end
+          after = Proc.new { done }
+
+          EM::Iterator.new(3..5, 1).each(foreach, after)
+        end
+      end
+
+    end
+
+  end
+end

data/spec/ssdp/searcher_spec.rb

@@ -0,0 +1,53 @@
+require_relative '../spec_helper'
+
+module RUPNP
+  module SSDP
+
+    describe Searcher do
+      include EM::SpecHelper
+
+      let(:config) do
+        {response_wait_time: RUPNP::ControlPoint::DEFAULT_RESPONSE_WAIT_TIME}
+      end
+
+      it "should send 2 M-SEARCH packets" do
+        em do
+          receiver = EM.open_datagram_socket(MULTICAST_IP, DISCOVERY_PORT,
+                                             FakeMulticast)
+          searcher = RUPNP::SSDP.search(:all, config)
+
+          EM.add_timer(1) do
+            expect(receiver.packets).to have(2).items
+            receiver.packets.each do |packet|
+              expect(packet).to be_a_msearch_packet
+            end
+            receiver.close_connection
+            done
+          end
+        end
+      end
+
+      it 'should send configured number of M-SEARCH packets' do
+        em do
+          foreach = Proc.new do |n, iter|
+            receiver = EM.open_datagram_socket(MULTICAST_IP, DISCOVERY_PORT,
+                                               FakeMulticast)
+            cfg = config.merge!(try_number: n)
+            searcher = RUPNP::SSDP.search(:root, cfg)
+
+            EM.add_timer(1) do
+              expect(receiver.packets).to have(n).items
+              receiver.close_connection
+              iter.next
+            end
+          end
+          after = Proc.new { done }
+
+          EM::Iterator.new(3..5, 1).each(foreach, after)
+        end
+      end
+
+    end
+
+  end
+end

data/tasks/gem.rake

@@ -0,0 +1,39 @@
+require 'rubygems/package_task'
+require_relative '../lib/rupnp.rb'
+
+spec = Gem::Specification.new do |s|
+  s.name = 'rupnp'
+  s.version = RUPNP::VERSION
+  s.summary = "RUPNP, a ruby UPnP framework"
+  s.description = <<-EOF
+RUPNP is a Ruby UPnP framework. For now, only control points (clients)
+are supported. Devices (servers) will be later.
+EOF
+
+  s.authors << 'Sylvain Daubert'
+  s.email = 'sylvain.daubert@laposte.net'
+  s.homepage = 'https://github.com/sdaubert/rupnp'
+
+  files = Dir['{spec,lib,bin,tasks}/**/*']
+  files += ['README.md', 'MIT-LICENSE', 'Rakefile']
+  # For now, device is not in gem.
+  files -= ['lib/rupnp/device.rb', 'spec/device_spec.rb']
+  s.files = files
+  s.executables = "discover"
+
+  s.add_dependency 'uuid', '~>2.3.0'
+  s.add_dependency 'eventmachine-le', '~> 1.1.6'
+  s.add_dependency 'em-http-request', '~> 1.1.1'
+  s.add_dependency 'nori', '~> 2.3.0'
+  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 'em-spec', '~>0.2.6'
+end
+
+
+Gem::PackageTask.new(spec) do |pkg|
+  pkg.need_zip = true
+  pkg.need_tar = true
+end

data/tasks/spec.rake

@@ -0,0 +1,3 @@
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new

data/tasks/yard.rake

@@ -0,0 +1,6 @@
+require 'yard'
+
+YARD::Rake::YardocTask.new do |t|
+  t.options = ['--no-private']
+  t.files = ['lib/**/*.rb']
+end

metadata

@@ -0,0 +1,209 @@
+--- !ruby/object:Gem::Specification
+name: rupnp
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Sylvain Daubert
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: uuid
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+- !ruby/object:Gem::Dependency
+  name: eventmachine-le
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.6
+- !ruby/object:Gem::Dependency
+  name: em-http-request
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.1
+- !ruby/object:Gem::Dependency
+  name: nori
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+- !ruby/object:Gem::Dependency
+  name: savon
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.12
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.12
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.7
+- !ruby/object:Gem::Dependency
+  name: em-spec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.2.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.2.6
+description: ! 'RUPNP is a Ruby UPnP framework. For now, only control points (clients)
+
+  are supported. Devices (servers) will be later.
+
+'
+email: sylvain.daubert@laposte.net
+executables:
+- discover
+extensions: []
+extra_rdoc_files: []
+files:
+- spec/ssdp/listener_spec.rb
+- spec/ssdp/notifier_spec.rb
+- spec/ssdp/searcher_spec.rb
+- spec/spec_helper.rb
+- lib/rupnp.rb
+- lib/rupnp/constants.rb
+- lib/rupnp/ssdp/usearch_responder.rb
+- lib/rupnp/ssdp/searcher.rb
+- lib/rupnp/ssdp/listener.rb
+- lib/rupnp/ssdp/multicast_connection.rb
+- 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
+- lib/rupnp/cp/event_server.rb
+- lib/rupnp/cp/remote_device.rb
+- lib/rupnp/cp/event_subscriber.rb
+- lib/rupnp/discover.rb
+- lib/rupnp/ssdp.rb
+- lib/rupnp/log_mixin.rb
+- lib/rupnp/tools.rb
+- lib/rupnp/event.rb
+- bin/discover
+- tasks/spec.rake
+- tasks/yard.rake
+- tasks/gem.rake
+- README.md
+- MIT-LICENSE
+- Rakefile
+homepage: https://github.com/sdaubert/rupnp
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: RUPNP, a ruby UPnP framework
+test_files: []