em_ws_discovery 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 93d68c56aa005b016b846239e46d917572eca2ae
+  data.tar.gz: a72c499cae86b83efac040c6dfbbaebc76a14643
+SHA512:
+  metadata.gz: bdd03e310cb58aa1559e35f0c07b688cd18b5212dd341386dddaa228388fec0ab7372af1da98fbc1a24d34cdedfdd9cf6f22546214f6ac87561a57096ba937b8
+  data.tar.gz: bdb1976aba0ec6160ff7246a5a53ceafc86bce9615b2679385b8d72345fb77c30e4c8be1bfcb6fb1694c3d74c34d45c266b46734318f1f19907d1c4e379e1e5a

data/Gemfile

@@ -0,0 +1,2 @@
+source :rubygems
+gemspec

data/History.rdoc

@@ -0,0 +1,7 @@
+=== 0.0.2 / 2013-03-25
+
+* Updated to be compatible with Nori 2.0.0.
+
+=== 0.0.1 / 2012-11-12
+
+* Initial release.

data/README.rdoc

@@ -0,0 +1,77 @@
+= ws_discovery
+
+* {Homepage}[https://github.com/pelco-automation/ws-discovery]
+* {WS-Discovery 1.0 Specification}[http://specs.xmlsoap.org/ws/2005/04/discovery/ws-discovery.pdf]
+* {SOAP-over-UDP Specification}[http://specs.xmlsoap.org/ws/2004/09/soap-over-udp/soap-over-udp.pdf]
+
+== Description
+
+This gem aims to provide the ability to search for WS-Discovery compatible target
+services.
+
+This uses EventMachine[http://github.com/eventmachine/eventmachine], so if
+you're not already, getting familiar with its concepts will be helpful here.
+
+== Features
+
+* Search for WS-Discovery compatible target services.
+
+== Examples
+
+=== WS-Discovery Searches
+
+A WS-Discovery search simply sends the probe out to the multicast group and
+listens for responses for a given (or default of 5 seconds) amount of time.  The
+return from this depends on if you're running it within an EventMachine reactor
+or not.  If not, it returns an Array of responses as WSDiscovery::Responses.
+Take a look at the WSDiscovery#search docs for more on the options here.
+
+  require 'ws_discovery'
+
+  # Search for all devices (do a probe with Types left unspecified)
+  all_devices = WSDiscovery.search                         # this is default
+
+  # Search for devices of a specific Type
+  network_video_transmitters = WSDiscovery.search(
+    env_namespaces: { "xmlns:dn" => "http://www.onvif.org/ver10/network/wsdl" },
+    types: "dn:NetworkVideoTransmitter")
+
+  # These searches will return an Array of WSDiscovery::Responses.  See the
+  # WSDiscovery::Response documentation for more information.
+
+If you do the search inside of an EventMachine reactor, as the
+WSDiscovery::Searcher receives and parses responses, it adds them to the accessor
+#discovery_responses, which is an EventMachine::Channel.  This lets you subscribe
+to the responses and do what you want with them.
+
+== Requirements
+
+* Ruby
+  * 1.9.3
+* Gems
+  * builder
+  * eventmachine
+  * log_switch
+  * nokogiri
+  * nori
+  * uuid
+* Gems (development)
+  * bundler
+  * rake
+  * rspec
+  * simplecov
+  * simplecov-rcov
+  * yard
+
+== Install
+
+  $ gem install ws_discovery
+
+== THANKS
+
+The initial core of this gem came from https://github.com/turboladen/upnp due to
+the similarities in how SSDP and WS-Discovery searches are performed.
+
+The WSDiscovery::Response class reuses parts of https://github.com/savonrb/savon.
+It made sense to me that WSDiscovery::Responses would behave similarly to
+Savon::SOAP::Responses.

data/Rakefile

@@ -0,0 +1,16 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'yard'
+
+YARD::Rake::YardocTask.new
+RSpec::Core::RakeTask.new
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task default: :install
+
+# Alias for rubygems-test
+task test: :spec

data/em_ws_discovery.gemspec

@@ -0,0 +1,32 @@
+$:.push File.expand_path("../lib", __FILE__)
+require 'ws_discovery/version'
+
+Gem::Specification.new do |s|
+  s.name = "em_ws_discovery"
+  s.version = WSDiscovery::VERSION
+  s.homepage = "https://github.com/jimxl/em-ws-discovery"
+  s.author = "jimxl"
+  s.email = "tianxiaxl@gmail.com"
+  s.description = "ruby实现的ws_discovery, 基于ws-discovery项目"
+  s.summary = "ruby实现的ws_discovery, 基于ws-discovery项目"
+
+  s.required_rubygems_version = ">=1.8.0"
+  s.required_ruby_version = Gem::Requirement.new(">= 1.9.3")
+  s.files = Dir.glob("{lib,spec}/**/*") + Dir.glob("*.rdoc") +
+    %w(Gemfile em_ws_discovery.gemspec Rakefile)
+  s.require_paths = ["lib"]
+
+  s.add_dependency("builder")
+  s.add_dependency("eventmachine")
+  s.add_dependency("log_switch", ">=0.1.4")
+  s.add_dependency("nokogiri")
+  s.add_dependency("nori", '>=2.0.0')
+  s.add_dependency("uuid")
+
+  s.add_development_dependency("bundler", ">= 1.0.21")
+  s.add_development_dependency("rake", ">= 0")
+  s.add_development_dependency("rspec", "~> 2.6")
+  s.add_development_dependency("simplecov", ">= 0")
+  s.add_development_dependency("simplecov-rcov", ">= 0")
+  s.add_development_dependency("yard", ">= 0.7.2")
+end

data/lib/ws_discovery.rb

@@ -0,0 +1,61 @@
+require_relative 'ws_discovery/core_ext/socket_patch'
+require 'eventmachine'
+
+require_relative 'ws_discovery/error'
+require_relative 'ws_discovery/network_constants'
+require_relative 'ws_discovery/searcher'
+
+module WSDiscovery
+  include NetworkConstants
+
+  DEFAULT_WAIT_TIME = 5
+
+  # Opens a UDP socket on 0.0.0.0, on an ephemeral port, has WSDiscovery::Searcher
+  # build and send the search request, then receives the responses.  The search
+  # will stop after +response_wait_time+.
+  #
+  # @param [Hash] options The options for the probe.
+  # @option options [Hash<String>] :env_namespaces Additional envelope namespaces.
+  # @option options [Hash<String>] :type_attributes Type attributes.
+  # @option options [String] :types Types.
+  # @option options [Hash<String>] :scope_attributes Scope attributes.
+  # @option options [String] :scopes Scopes.
+  # @return [Array<WSDiscovery::Response>,WSDiscovery::Searcher] Returns an
+  #   Array of probe responses. If the reactor is already running this will return
+  #   a WSDiscovery::Searcher which will make its accessors available so you can
+  #   get responses in real time.
+  def self.search(options={})
+    response_wait_time = options[:response_wait_time] || DEFAULT_WAIT_TIME
+    responses = []
+
+    multicast_searcher = proc do
+      EM.open_datagram_socket('0.0.0.0', 0, WSDiscovery::Searcher, options)
+    end
+
+    if EM.reactor_running?
+      return multicast_searcher.call
+    else
+      EM.run do
+        ms = multicast_searcher.call
+
+        ms.discovery_responses.subscribe do |notification|
+          responses << notification
+        end
+
+        EM.add_timer(response_wait_time) { EM.stop }
+        trap_signals
+      end
+    end
+
+    responses.flatten
+  end
+
+  private
+
+  # Traps INT, TERM, and HUP signals and stops the reactor.
+  def self.trap_signals
+    trap('INT') { EM.stop }
+    trap('TERM') { EM.stop }
+    trap('HUP') { EM.stop } if RUBY_PLATFORM !~ /mswin|mingw/
+  end
+end

data/lib/ws_discovery/core_ext/socket_patch.rb

@@ -0,0 +1,16 @@
+require 'socket'
+
+# Workaround for missing constants on Windows
+module Socket::Constants
+  IP_ADD_MEMBERSHIP = 12 unless defined? IP_ADD_MEMBERSHIP
+  IP_MULTICAST_LOOP = 11 unless defined? IP_MULTICAST_LOOP
+  IP_MULTICAST_TTL  = 10 unless defined? IP_MULTICAST_TTL
+  IP_TTL            =  4 unless defined? IP_TTL
+end
+
+class Socket
+  IP_ADD_MEMBERSHIP = 12 unless defined? IP_ADD_MEMBERSHIP
+  IP_MULTICAST_LOOP = 11 unless defined? IP_MULTICAST_LOOP
+  IP_MULTICAST_TTL  = 10 unless defined? IP_MULTICAST_TTL
+  IP_TTL            =  4 unless defined? IP_TTL
+end

data/lib/ws_discovery/error.rb

@@ -0,0 +1,4 @@
+module WSDiscovery
+  class Error < StandardError
+  end
+end

data/lib/ws_discovery/multicast_connection.rb

@@ -0,0 +1,77 @@
+require_relative 'core_ext/socket_patch'
+require_relative 'network_constants'
+require_relative 'error'
+require 'ipaddr'
+require 'socket'
+require 'eventmachine'
+
+module WSDiscovery
+  class MulticastConnection < EventMachine::Connection
+    include WSDiscovery::NetworkConstants
+
+    # @param [Fixnum] ttl The TTL value to use when opening the UDP socket
+    #   required for WSDiscovery actions.
+    def initialize ttl=TTL
+      @ttl = ttl
+      @discovery_responses = EM::Channel.new
+
+      setup_multicast_socket
+    end
+
+    private
+
+    # Gets the IP and port from the peer that just sent data.
+    #
+    # @return [Array<String,Fixnum>] The IP and port.
+    def peer_info
+      peer_bytes = get_peername[2, 6].unpack("nC4")
+      port = peer_bytes.first.to_i
+      ip = peer_bytes[1, 4].join(".")
+
+      [ip, port]
+    end
+
+    # Sets Socket options to allow for multicasting.  If ENV["RUBY_TESTING_ENV"]
+    # is equal to "testing", then it doesn't turn off multicast looping.
+    def setup_multicast_socket
+      set_membership(IPAddr.new(MULTICAST_IP).hton + IPAddr.new('0.0.0.0').hton)
+      set_multicast_ttl(@ttl)
+      set_ttl(@ttl)
+
+      unless ENV["RUBY_TESTING_ENV"] == "testing"
+        switch_multicast_loop :off
+      end
+    end
+
+    # @param [String] membership The network byte ordered String that represents
+    #   the IP(s) that should join the membership group.
+    def set_membership(membership)
+      set_sock_opt(Socket::IPPROTO_IP, Socket::IP_ADD_MEMBERSHIP, membership)
+    end
+
+    # @param [Fixnum] ttl TTL to set IP_MULTICAST_TTL to.
+    def set_multicast_ttl(ttl)
+      set_sock_opt(Socket::IPPROTO_IP, Socket::IP_MULTICAST_TTL, [ttl].pack('i'))
+    end
+
+    # @param [Fixnum] ttl TTL to set IP_TTL to.
+    def set_ttl(ttl)
+      set_sock_opt(Socket::IPPROTO_IP, Socket::IP_TTL, [ttl].pack('i'))
+    end
+
+    # @param [Symbol] on_off Turn on/off multicast looping.  Supply :on or :off.
+    # @raise [WSDiscovery::Error] If invalid option is given.
+    def switch_multicast_loop(on_off)
+      hex_value = case on_off
+      when :on, "\001"
+        "\001"
+      when :off, "\000"
+        "\000"
+      else
+        raise WSDiscovery::Error, "Can't switch IP_MULTICAST_LOOP to '#{on_off}'"
+      end
+
+      set_sock_opt(Socket::IPPROTO_IP, Socket::IP_MULTICAST_LOOP, hex_value)
+    end
+  end
+end

data/lib/ws_discovery/network_constants.rb

@@ -0,0 +1,13 @@
+module WSDiscovery
+  module NetworkConstants
+
+    # Default multicast IP address
+    MULTICAST_IP = '239.255.255.250'
+
+    # Default multicast port
+    MULTICAST_PORT = 3702
+
+    # Default TTL
+    TTL = 1
+  end
+end

data/lib/ws_discovery/response.rb

@@ -0,0 +1,104 @@
+require 'nokogiri'
+require 'nori'
+require_relative 'error'
+
+module WSDiscovery
+
+  # Represents the probe response.
+  class Response
+
+    attr_accessor :response
+
+    # @param [String] response Text of the response to a WSDiscovery probe.
+    def initialize(response)
+      @response = response
+    end
+
+    # Shortcut accessor for the SOAP response body Hash.
+    #
+    # @param [Symbol] key The key to access in the body Hash.
+    # @return [Hash,String] The accessed value.
+    def [](key)
+      body[key]
+    end
+
+    # Returns the SOAP response header as a Hash.
+    #
+    # @return [Hash] SOAP response header.
+    # @raise [WSDiscovery::Error] If unable to parse response.
+    def header
+      unless hash.has_key? :envelope
+        raise WSDiscovery::Error, "Unable to parse response body '#{to_xml}'"
+      end
+
+      hash[:envelope][:header]
+    end
+
+    # Returns the SOAP response body as a Hash.
+    #
+    # @return [Hash] SOAP response body.
+    # @raise [WSDiscovery::Error] If unable to parse response.
+    def body
+      unless hash.has_key? :envelope
+        raise WSDiscovery::Error, "Unable to parse response body '#{to_xml}'"
+      end
+
+      hash[:envelope][:body]
+    end
+
+    alias to_hash body
+
+    # Returns the complete SOAP response XML without normalization.
+    #
+    # @return [Hash] Complete SOAP response Hash.
+    def hash
+      @hash ||= nori.parse(to_xml)
+    end
+
+    # Returns the SOAP response XML.
+    #
+    # @return [String] Raw SOAP response XML.
+    def to_xml
+      response
+    end
+
+    # Returns a Nokogiri::XML::Document for the SOAP response XML.
+    #
+    # @return [Nokogiri::XML::Document] Document for the SOAP response.
+    def doc
+      @doc ||= Nokogiri::XML(to_xml)
+    end
+
+    # Returns an Array of Nokogiri::XML::Node objects retrieved with the given +path+.
+    # Automatically adds all of the document's namespaces unless a +namespaces+ hash is provided.
+    #
+    # @param [String] path XPath to search.
+    # @param [Hash<String>] namespaces Namespaces to append.
+    def xpath(path, namespaces = nil)
+      doc.xpath(path, namespaces || xml_namespaces)
+    end
+
+    private
+
+    # XML Namespaces from the Document.
+    #
+    # @return [Hash] Namespaces from the Document.
+    def xml_namespaces
+      @xml_namespaces ||= doc.collect_namespaces
+    end
+
+    # Returns a Nori parser.
+    #
+    # @return [Nori] Nori parser.
+    def nori
+      return @nori if @nori
+
+      nori_options = {
+        strip_namespaces: true,
+        convert_tags_to: lambda { |tag| tag.snakecase.to_sym }
+      }
+
+      @nori = Nori.new(nori_options)
+    end
+  end
+end

data/lib/ws_discovery/searcher.rb

@@ -0,0 +1,93 @@
+require_relative 'multicast_connection'
+require_relative 'response'
+require 'builder'
+require 'log_switch'
+require 'uuid'
+
+class WSDiscovery::Searcher < WSDiscovery::MulticastConnection
+    extend LogSwitch
+    self.logger.datetime_format = "%Y-%m-%d %H:%M:%S "
+
+    # @return [EventMachine::Channel] Provides subscribers with responses from
+    #   their search request.
+    attr_reader :discovery_responses
+
+    # @param [Hash] options The options for the probe.
+    # @option options [Hash<String>] :env_namespaces Additional envelope namespaces.
+    # @option options [Hash<String>] :type_attributes Type attributes.
+    # @option options [String] :types Types.
+    # @option options [Hash<String>] :scope_attributes Scope attributes.
+    # @option options [String] :scopes Scopes.
+    # @option options [Fixnum] :ttl TTL for the probe.
+    def initialize(options={})
+        options[:ttl] ||= TTL
+
+        @search = probe(options)
+
+        super options[:ttl]
+    end
+
+    # This is the callback called by EventMachine when it receives data on the
+    # socket that's been opened for this connection.  In this case, the method
+    # parses the probe matches into WSDiscovery::Responses and adds them to the
+    # appropriate EventMachine::Channel (provided as accessor methods).  This
+    # effectively means that in each Channel, you get a WSDiscovery::Response
+    # for each response that comes in on the socket.
+    #
+    # @param [String] response The data received on this connection's socket.
+    def receive_data(response)
+        ip, port = peer_info
+        #WSDiscovery::Searcher.log "<#{self.class}> Response from #{ip}:#{port}:\n#{response}\n"
+        parsed_response = parse(response)
+        @discovery_responses << parsed_response
+    end
+
+    # Converts the headers to a set of key-value pairs.
+    #
+    # @param [String] data The data to convert.
+    # @return [WSDiscovery::Response] The converted data.
+    def parse(data)
+        WSDiscovery::Response.new(data)
+    end
+
+    # Sends the probe that was built during init.  Logs what was sent if the
+    # send was successful.
+    def post_init
+        if send_datagram(@search, MULTICAST_IP, MULTICAST_PORT) > 0
+            WSDiscovery::Searcher.log("Sent datagram search:\n#{@search}")
+        end
+    end
+
+    # Probe for target services supporting WS-Discovery.
+    #
+    # @param [Hash] options The options for the probe.
+    # @option options [Hash<String>] :env_namespaces Additional envelope namespaces.
+    # @option options [Hash<String>] :type_attributes Type attributes.
+    # @option options [String] :types Types.
+    # @option options [Hash<String>] :scope_attributes Scope attributes.
+    # @option options [String] :scopes Scopes.
+    # @return [String] Probe SOAP message.
+    def probe(options={})
+        namespaces = {
+            'xmlns:a' => 'http://schemas.xmlsoap.org/ws/2004/08/addressing',
+            'xmlns:d' => 'http://schemas.xmlsoap.org/ws/2005/04/discovery',
+            'xmlns:s' => 'http://www.w3.org/2003/05/soap-envelope'
+        }
+        namespaces.merge! options[:env_namespaces] if options[:env_namespaces]
+
+        Builder::XmlMarkup.new.s(:Envelope, namespaces) do |xml|
+            xml.s(:Header) do
+                xml.a(:Action, 'http://schemas.xmlsoap.org/ws/2005/04/discovery/Probe')
+                xml.a(:MessageID, "uuid:#{UUID.generate}")
+                xml.a(:To, 'urn:schemas-xmlsoap-org:ws:2005:04:discovery')
+            end
+
+            xml.s(:Body) do
+                xml.d(:Probe) do 
+                    xml.d(:Types, options[:type_attributes], options[:types])
+                    xml.d(:Scopes, options[:scope_attributes], options[:scopes])
+                end
+            end
+        end
+    end
+end

data/lib/ws_discovery/version.rb

@@ -0,0 +1,3 @@
+module WSDiscovery
+  VERSION = '0.0.2'
+end

data/spec/spec_helper.rb

@@ -0,0 +1,26 @@
+require 'simplecov'
+require 'simplecov-rcov'
+
+class SimpleCov::Formatter::MergedFormatter
+  def format(result)
+    SimpleCov::Formatter::HTMLFormatter.new.format(result)
+    SimpleCov::Formatter::RcovFormatter.new.format(result)
+  end
+end
+
+SimpleCov.formatter = SimpleCov::Formatter::MergedFormatter
+
+SimpleCov.start do
+  add_filter "/spec"
+  add_filter "/lib/deps"
+end
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |file| require file }
+
+ENV["RUBY_TESTING_ENV"] = "testing"

data/spec/ws_discovery/multicast_connection_spec.rb

@@ -0,0 +1,108 @@
+require 'spec_helper'
+require 'ws_discovery/multicast_connection'
+
+describe WSDiscovery::MulticastConnection do
+  around(:each) do |example|
+    EM.run do
+      example.run
+      EM.stop
+    end
+  end
+
+  subject { WSDiscovery::MulticastConnection.new(1) }
+
+  describe "#peer_info" do
+    before do
+      WSDiscovery::MulticastConnection.any_instance.stub(:setup_multicast_socket)
+      subject.stub_chain(:get_peername, :[], :unpack).and_return(%w(1234 1 2 3 4))
+    end
+
+    it "returns an Array with IP and port" do
+      subject.send(:peer_info).should == ['1.2.3.4', 1234]
+    end
+
+    it "returns IP as a String" do
+      subject.send(:peer_info).first.should be_a String
+    end
+
+    it "returns port as a Fixnum" do
+      subject.send(:peer_info).last.should be_a Fixnum
+    end
+  end
+
+  describe "#setup_multicast_socket" do
+    before do
+      WSDiscovery::MulticastConnection.any_instance.stub(:set_membership)
+      WSDiscovery::MulticastConnection.any_instance.stub(:switch_multicast_loop)
+      WSDiscovery::MulticastConnection.any_instance.stub(:set_multicast_ttl)
+      WSDiscovery::MulticastConnection.any_instance.stub(:set_ttl)
+    end
+
+    it "adds 0.0.0.0 and 239.255.255.250 to the membership group" do
+      subject.should_receive(:set_membership).with(
+        IPAddr.new('239.255.255.250').hton + IPAddr.new('0.0.0.0').hton
+      )
+      subject.send(:setup_multicast_socket)
+    end
+
+    it "sets multicast TTL to 1" do
+      subject.should_receive(:set_multicast_ttl).with(1)
+      subject.send(:setup_multicast_socket)
+    end
+
+    it "sets TTL to 1" do
+      subject.should_receive(:set_ttl).with(1)
+      subject.send(:setup_multicast_socket)
+    end
+
+    context "ENV['RUBY_TESTING_ENV'] != testing" do
+      after { ENV['RUBY_TESTING_ENV'] = "testing" }
+
+      it "turns multicast loop off" do
+        ENV['RUBY_TESTING_ENV'] = "development"
+        subject.should_receive(:switch_multicast_loop).with(:off)
+        subject.send(:setup_multicast_socket)
+      end
+    end
+  end
+
+  describe "#switch_multicast_loop" do
+    before do
+      WSDiscovery::MulticastConnection.any_instance.stub(:setup_multicast_socket)
+    end
+
+    it "passes '\\001' to the socket option call when param == :on" do
+      subject.should_receive(:set_sock_opt).with(
+        0, Socket::IP_MULTICAST_LOOP, "\001"
+      )
+      subject.send(:switch_multicast_loop, :on)
+    end
+
+    it "passes '\\001' to the socket option call when param == '\\001'" do
+      subject.should_receive(:set_sock_opt).with(
+        0, Socket::IP_MULTICAST_LOOP, "\001"
+      )
+      subject.send(:switch_multicast_loop,"\001")
+    end
+
+    it "passes '\\000' to the socket option call when param == :off" do
+      subject.should_receive(:set_sock_opt).with(
+        0, Socket::IP_MULTICAST_LOOP, "\000"
+      )
+      subject.send(:switch_multicast_loop,:off)
+    end
+
+    it "passes '\\000' to the socket option call when param == '\\000'" do
+      subject.should_receive(:set_sock_opt).with(
+        0, Socket::IP_MULTICAST_LOOP, "\000"
+      )
+      subject.send(:switch_multicast_loop,"\000")
+    end
+
+    it "raises when not :on, :off, '\\000', or '\\001'" do
+      expect { subject.send(:switch_multicast_loop, 12312312) }.
+        to raise_error(WSDiscovery::Error)
+    end
+  end
+end
+

data/spec/ws_discovery/response_spec.rb

@@ -0,0 +1,118 @@
+require 'spec_helper'
+require 'ws_discovery/response'
+
+describe WSDiscovery::Response do
+  let(:probe_response) do
+    <<-PROBE
+      <s:Envelope xmlns:s="http://www.w3.org/2003/05/soap-envelope"
+        xmlns:a="http://schemas.xmlsoap.org/ws/2004/08/addressing"
+        xmlns:d="http://schemas.xmlsoap.org/ws/2005/04/discovery">
+        <s:Header>
+          <a:To>http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous</a:To>
+          <a:Action>http://schemas.xmlsoap.org/ws/2005/04/discovery/ProbeMatches</a:Action>
+          <a:MessageID>urn:uuid:18523f7e-7a54-d92d-a18d-e7165bec8e7e</a:MessageID>
+          <a:RelatesTo>uuid:7dbdede0-0f2b-0130-5861-002564b29b24</a:RelatesTo>
+          <d:AppSequence MessageNumber="42" InstanceId="2"/>
+        </s:Header>
+        <s:Body>
+          <d:ProbeMatches>
+            <d:ProbeMatch>
+              <a:EndpointReference>
+                <a:Address>urn:uuid:0b679890-fc54-14ba-d428-f73b3e7c2400</a:Address>
+              </a:EndpointReference>
+              <d:Types xmlns:dn="http://www.onvif.org/ver10/network/wsdl">dn:NetworkVideoTransmitter</d:Types>
+              <d:Scopes>onvif://www.onvif.org/Profile/Streaming onvif://www.onvif.org/hardware/NET5404T onvif://www.onvif.org/type/ptz onvif://www.onvif.org/type/video_encoder onvif://www.onvif.org/location/country/usa onvif://www.onvif.org/name/NET5404T-ABEPZH7</d:Scopes>
+              <d:XAddrs>http://10.221.222.74/onvif/device_service</d:XAddrs>
+              <d:MetadataVersion>1</d:MetadataVersion>
+            </d:ProbeMatch>
+          </d:ProbeMatches>
+        </s:Body>
+      </s:Envelope>
+    PROBE
+  end
+
+  let(:probe_body_hash) do
+    { probe_matches: {
+      probe_match: {
+        endpoint_reference: {
+          address: "urn:uuid:0b679890-fc54-14ba-d428-f73b3e7c2400" },
+        types: "dn:NetworkVideoTransmitter",
+        scopes: "onvif://www.onvif.org/Profile/Streaming onvif://www.onvif.org/hardware/NET5404T onvif://www.onvif.org/type/ptz onvif://www.onvif.org/type/video_encoder onvif://www.onvif.org/location/country/usa onvif://www.onvif.org/name/NET5404T-ABEPZH7",
+        x_addrs: "http://10.221.222.74/onvif/device_service",
+        metadata_version: "1" } } }
+  end
+
+  let(:probe_header_hash) do
+    { to: "http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous",
+      action: "http://schemas.xmlsoap.org/ws/2005/04/discovery/ProbeMatches",
+      message_id: "urn:uuid:18523f7e-7a54-d92d-a18d-e7165bec8e7e",
+      relates_to: "uuid:7dbdede0-0f2b-0130-5861-002564b29b24",
+      app_sequence: {
+        :@message_number => "42",
+        :@instance_id => "2" } }
+  end
+
+  let(:probe_full_hash) do
+    { envelope: { header: probe_header_hash, body: probe_body_hash,
+      :"@xmlns:s" => "http://www.w3.org/2003/05/soap-envelope",
+      :"@xmlns:a" => "http://schemas.xmlsoap.org/ws/2004/08/addressing",
+      :"@xmlns:d" => "http://schemas.xmlsoap.org/ws/2005/04/discovery" } }
+  end
+
+  subject { WSDiscovery::Response.new(probe_response) }
+
+  describe "#[]" do
+    it "should return the SOAP response body as a Hash" do
+      subject[:probe_matches].should == probe_body_hash[:probe_matches]
+    end
+
+    it "should throw an exception when the response body isn't parsable" do
+      expect { WSDiscovery::Response.new('').body }.to raise_error WSDiscovery::Error
+    end
+  end
+
+  describe "#header" do
+    it "should return the SOAP response header as a Hash" do
+      subject.header[:app_sequence].should == probe_header_hash[:app_sequence]
+    end
+
+    it "should throw an exception when the response header isn't parsable" do
+      expect { WSDiscovery::Response.new('').header }.to raise_error WSDiscovery::Error
+    end
+  end
+
+  %w(body to_hash).each do |method|
+    describe "##{method}" do
+      it "should return the SOAP response body as a Hash" do
+        subject.send(method)[:probe_matches].should == probe_body_hash[:probe_matches]
+      end
+    end
+  end
+
+  describe "#hash" do
+    it "should return the complete SOAP response XML as a Hash" do
+      subject.hash.should == probe_full_hash
+    end
+  end
+
+  describe "#to_xml" do
+    it "should return the raw SOAP response body" do
+      subject.to_xml.should == probe_response
+    end
+  end
+
+  describe "#doc" do
+    it "returns a Nokogiri::XML::Document for the SOAP response XML" do
+      subject.doc.should be_a(Nokogiri::XML::Document)
+    end
+  end
+
+  describe "#xpath" do
+    it "permits XPath access to elements in the request" do
+      subject.xpath("//a:Address").first.inner_text.
+        should == "urn:uuid:0b679890-fc54-14ba-d428-f73b3e7c2400"
+      subject.xpath("//d:ProbeMatch/d:XAddrs").first.inner_text.
+        should == "http://10.221.222.74/onvif/device_service"
+    end
+  end
+end

data/spec/ws_discovery/searcher_spec.rb

@@ -0,0 +1,85 @@
+require 'spec_helper'
+require 'ws_discovery/searcher'
+
+describe WSDiscovery::Searcher do
+  let(:default_probe) do
+    "<s:Envelope xmlns:a=\"http://schemas.xmlsoap.org/ws/2004/08/addressing\" " +
+      "xmlns:d=\"http://schemas.xmlsoap.org/ws/2005/04/discovery\" xmlns:s=\"h" +
+      "ttp://www.w3.org/2003/05/soap-envelope\"><s:Header><a:Action>http://sch" +
+      "emas.xmlsoap.org/ws/2005/04/discovery/Probe</a:Action><a:MessageID>uuid" +
+      ":a-uuid</a:MessageID><a:To>urn:schemas-xmlsoap-org:ws:2005:04:discovery" +
+      "</a:To></s:Header><s:Body><d:Types/><d:Scopes/></s:Body></s:Envelope>"
+  end
+
+  around(:each) do |example|
+    EM.run do
+      example.run
+      EM.stop
+    end
+  end
+
+  before do
+    WSDiscovery::Searcher.log = false
+    WSDiscovery::MulticastConnection.any_instance.stub(:setup_multicast_socket)
+    UUID.stub(:generate).and_return('a-uuid')
+  end
+
+  subject do
+    WSDiscovery::Searcher.new(1)
+  end
+
+  describe "#initialize" do
+    it "does a #probe" do
+      WSDiscovery::Searcher.any_instance.should_receive(:probe)
+
+      subject
+    end
+  end
+
+  describe "#receive_data" do
+    let(:parsed_response) do
+      double 'parsed response'
+    end
+
+    it "takes a response and adds it to the list of responses" do
+      response = double 'response'
+      subject.stub(:peer_info).and_return(['0.0.0.0', 4567])
+
+      subject.should_receive(:parse).with(response).exactly(1).times.
+        and_return(parsed_response)
+      subject.instance_variable_get(:@discovery_responses).should_receive(:<<).
+        with(parsed_response)
+
+      subject.receive_data(response)
+    end
+  end
+
+  describe "#parse" do
+    before do
+      WSDiscovery::MulticastConnection.any_instance.stub(:setup_multicast_socket)
+    end
+
+    it "turns probe matches into WSDiscovery::Responses" do
+      result = subject.parse "<Envelope />"
+      result.should be_a WSDiscovery::Response
+    end
+  end
+
+  describe "#post_init" do
+    before { WSDiscovery::Searcher.any_instance.stub(:m_search).and_return("hi") }
+
+    it "sends a probe as a datagram over 239.255.255.250:3702" do
+      subject.should_receive(:send_datagram).
+        with(default_probe, '239.255.255.250', 3702).
+        and_return 0
+      subject.post_init
+    end
+  end
+
+  describe "#probe" do
+    it "builds the MSEARCH string using the given parameters" do
+      subject.probe.should == default_probe
+    end
+  end
+end
+

data/spec/ws_discovery_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+require 'ws_discovery'
+
+describe WSDiscovery do
+  subject { WSDiscovery }
+
+  describe '.search' do
+    let(:multicast_searcher) do
+      searcher = double "WSDiscovery::Searcher"
+      searcher.stub_chain(:discovery_responses, :subscribe).and_yield(%w[one two])
+
+      searcher
+    end
+
+    before do
+      EM.stub(:run).and_yield
+      EM.stub(:add_timer)
+      EM.stub(:open_datagram_socket).and_return multicast_searcher
+    end
+
+    context "reactor is already running" do
+      it "returns a WSDiscovery::Searcher" do
+        EM.stub(:reactor_running?).and_return true
+        subject.search.should == multicast_searcher
+      end
+    end
+
+    context "reactor is not already running" do
+      it "returns an Array of responses" do
+        EM.stub(:add_shutdown_hook).and_yield
+        subject.search.should == %w[one two]
+      end
+
+      it "opens a UDP socket on '0.0.0.0', port 0" do
+        EM.stub(:add_shutdown_hook)
+        EM.should_receive(:open_datagram_socket).with('0.0.0.0', 0,
+          WSDiscovery::Searcher, {})
+        subject.search
+      end
+    end
+  end
+end
+

metadata

@@ -0,0 +1,229 @@
+--- !ruby/object:Gem::Specification
+name: em_ws_discovery
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- jimxl
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: builder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: eventmachine
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: log_switch
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.1.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.1.4
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: nori
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: uuid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.21
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.21
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov-rcov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.7.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.7.2
+description: ruby实现的ws_discovery, 基于ws-discovery项目
+email: tianxiaxl@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/ws_discovery.rb
+- lib/ws_discovery/error.rb
+- lib/ws_discovery/multicast_connection.rb
+- lib/ws_discovery/searcher.rb
+- lib/ws_discovery/network_constants.rb
+- lib/ws_discovery/version.rb
+- lib/ws_discovery/response.rb
+- lib/ws_discovery/core_ext/socket_patch.rb
+- spec/spec_helper.rb
+- spec/ws_discovery_spec.rb
+- spec/ws_discovery/multicast_connection_spec.rb
+- spec/ws_discovery/searcher_spec.rb
+- spec/ws_discovery/response_spec.rb
+- History.rdoc
+- README.rdoc
+- Gemfile
+- em_ws_discovery.gemspec
+- Rakefile
+homepage: https://github.com/jimxl/em-ws-discovery
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 1.8.0
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: ruby实现的ws_discovery, 基于ws-discovery项目
+test_files: []
+has_rdoc: