RubyGems - ws_discovery - Versions diffs - 0.0.1 - Mend

ws_discovery 0.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (60) hide show

data/spec/ws_discovery/coverage/assets/0.7.1/fancybox/blank.gif ADDED Viewed

Binary file

data/spec/ws_discovery/coverage/assets/0.7.1/fancybox/fancy_close.png ADDED Viewed

Binary file

data/spec/ws_discovery/coverage/assets/0.7.1/fancybox/fancy_loading.png ADDED Viewed

Binary file

data/spec/ws_discovery/coverage/assets/0.7.1/fancybox/fancy_nav_left.png ADDED Viewed

Binary file

data/spec/ws_discovery/coverage/assets/0.7.1/fancybox/fancy_nav_right.png ADDED Viewed

Binary file

data/spec/ws_discovery/coverage/assets/0.7.1/fancybox/fancy_shadow_e.png ADDED Viewed

Binary file

data/spec/ws_discovery/coverage/assets/0.7.1/fancybox/fancy_shadow_n.png ADDED Viewed

Binary file

data/spec/ws_discovery/coverage/assets/0.7.1/fancybox/fancy_shadow_ne.png ADDED Viewed

Binary file

data/spec/ws_discovery/coverage/assets/0.7.1/fancybox/fancy_shadow_nw.png ADDED Viewed

Binary file

data/spec/ws_discovery/coverage/assets/0.7.1/fancybox/fancy_shadow_s.png ADDED Viewed

Binary file

data/spec/ws_discovery/coverage/assets/0.7.1/fancybox/fancy_shadow_se.png ADDED Viewed

Binary file

data/spec/ws_discovery/coverage/assets/0.7.1/fancybox/fancy_shadow_sw.png ADDED Viewed

Binary file

data/spec/ws_discovery/coverage/assets/0.7.1/fancybox/fancy_shadow_w.png ADDED Viewed

Binary file

data/spec/ws_discovery/coverage/assets/0.7.1/fancybox/fancy_title_left.png ADDED Viewed

Binary file

data/spec/ws_discovery/coverage/assets/0.7.1/fancybox/fancy_title_main.png ADDED Viewed

Binary file

data/spec/ws_discovery/coverage/assets/0.7.1/fancybox/fancy_title_over.png ADDED Viewed

Binary file

data/spec/ws_discovery/coverage/assets/0.7.1/fancybox/fancy_title_right.png ADDED Viewed

Binary file

data/spec/ws_discovery/coverage/assets/0.7.1/fancybox/fancybox-x.png ADDED Viewed

Binary file

data/spec/ws_discovery/coverage/assets/0.7.1/fancybox/fancybox-y.png ADDED Viewed

Binary file

data/spec/ws_discovery/coverage/assets/0.7.1/fancybox/fancybox.png ADDED Viewed

Binary file

data/spec/ws_discovery/coverage/assets/0.7.1/favicon_green.png ADDED Viewed

Binary file

data/spec/ws_discovery/coverage/assets/0.7.1/favicon_red.png ADDED Viewed

Binary file

data/spec/ws_discovery/coverage/assets/0.7.1/favicon_yellow.png ADDED Viewed

Binary file

data/spec/ws_discovery/coverage/assets/0.7.1/loading.gif ADDED Viewed

Binary file

data/spec/ws_discovery/coverage/assets/0.7.1/magnify.png ADDED Viewed

Binary file

data/spec/ws_discovery/coverage/assets/0.7.1/smoothness/images/ui-bg_flat_0_aaaaaa_40x100.png ADDED Viewed

Binary file

data/spec/ws_discovery/coverage/assets/0.7.1/smoothness/images/ui-bg_flat_75_ffffff_40x100.png ADDED Viewed

Binary file

data/spec/ws_discovery/coverage/assets/0.7.1/smoothness/images/ui-bg_glass_55_fbf9ee_1x400.png ADDED Viewed

Binary file

data/spec/ws_discovery/coverage/assets/0.7.1/smoothness/images/ui-bg_glass_65_ffffff_1x400.png ADDED Viewed

Binary file

data/spec/ws_discovery/coverage/assets/0.7.1/smoothness/images/ui-bg_glass_75_dadada_1x400.png ADDED Viewed

Binary file

data/spec/ws_discovery/coverage/assets/0.7.1/smoothness/images/ui-bg_glass_75_e6e6e6_1x400.png ADDED Viewed

Binary file

data/spec/ws_discovery/coverage/assets/0.7.1/smoothness/images/ui-bg_glass_95_fef1ec_1x400.png ADDED Viewed

Binary file

data/spec/ws_discovery/coverage/assets/0.7.1/smoothness/images/ui-bg_highlight-soft_75_cccccc_1x100.png ADDED Viewed

Binary file

data/spec/ws_discovery/coverage/assets/0.7.1/smoothness/images/ui-icons_222222_256x240.png ADDED Viewed

Binary file

data/spec/ws_discovery/coverage/assets/0.7.1/smoothness/images/ui-icons_2e83ff_256x240.png ADDED Viewed

Binary file

data/spec/ws_discovery/coverage/assets/0.7.1/smoothness/images/ui-icons_454545_256x240.png ADDED Viewed

Binary file

data/spec/ws_discovery/coverage/assets/0.7.1/smoothness/images/ui-icons_888888_256x240.png ADDED Viewed

Binary file

data/spec/ws_discovery/coverage/assets/0.7.1/smoothness/images/ui-icons_cd0a0a_256x240.png ADDED Viewed

Binary file

data/spec/ws_discovery/coverage/index.html ADDED Viewed

@@ -0,0 +1,72 @@
+<!DOCTYPE html>
+<html xmlns='http://www.w3.org/1999/xhtml'>
+  <head>
+    <title>Code coverage for Ws discovery</title>
+    <meta http-equiv="content-type" content="text/html; charset=utf-8" />
+    <script src='./assets/0.7.1/application.js' type='text/javascript'></script>
+    <link href='./assets/0.7.1/application.css' media='screen, projection, print' rel='stylesheet' type='text/css'>
+    <link rel="shortcut icon" type="image/png" href="./assets/0.7.1/favicon_green.png" />
+    <link rel="icon" type="image/png" href="./assets/0.7.1/favicon.png" />
+  </head>
+  <body>
+    <div id="loading">
+      <img src="./assets/0.7.1/loading.gif" alt="loading"/>
+    </div>
+    <div id="wrapper" style="display:none;">
+      <div class="timestamp">Generated <abbr class="timeago" title="2012-11-12T13:50:26-08:00">2012-11-12T13:50:26-08:00</abbr></div>
+      <ul class="group_tabs"></ul>
+      <div id="content">
+        <div class="file_list_container" id="AllFiles">
+  <h2>
+    <span class="group_name">All Files</span>
+    (<span class="covered_percent"><span class="green">100.0%</span></span>
+     covered at
+     <span class="covered_strength">
+       <span class="red">
+         0.0
+       </span>
+    </span> hits/line)
+  </h2>
+  <a name="AllFiles"></a>
+  <div>
+    <b>0</b> files in total.
+    <b>0.0</b> relevant lines.
+    <span class="green"><b>0.0</b> lines covered</span> and
+    <span class="red"><b>0.0</b> lines missed </span>
+  </div>
+  <table class="file_list">
+    <thead>
+      <tr>
+        <th>File</th>
+        <th>% covered</th>
+        <th>Lines</th>
+        <th>Relevant Lines</th>
+        <th>Lines covered</th>
+        <th>Lines missed</th>
+        <th>Avg. Hits / Line</th>
+      </tr>
+    </thead>
+    <tbody>
+    </tbody>
+  </table>
+</div>
+      </div>
+      <div id="footer">
+        Generated by <a href="http://github.com/colszowka/simplecov">simplecov</a> v0.7.1
+        and simplecov-html v0.7.1<br/>
+        using RSpec
+      </div>
+      <div class="source_files">
+      </div>
+    </div>
+  </body>
+</html>

data/spec/ws_discovery/multicast_connection_spec.rb ADDED Viewed

@@ -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 ADDED Viewed

@@ -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 ADDED Viewed

@@ -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 ADDED Viewed

@@ -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

data/ws_discovery.gemspec ADDED Viewed

@@ -0,0 +1,32 @@
+$:.push File.expand_path("../lib", __FILE__)
+require 'ws_discovery/version'
+Gem::Specification.new do |s|
+  s.name = "ws_discovery"
+  s.version = WSDiscovery::VERSION
+  s.homepage = "https://github.com/pelco-automation/ws-discovery"
+  s.author = "tindron"
+  s.email = "rstoller@gmail.com"
+  s.description = "Perform a multicast search for devices using WS-Discovery"
+  s.summary = "Search for devices using 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 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")
+  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