firescan 0.07 → 0.08

data/lib/firebind/portspec.rb

@@ -1,3 +1,4 @@
+#--
 # Firebind -- Path Scan Client Software
 # Copyright (C) 2013 Firebind Inc. All rights reserved.
 # Authors - Jay Houghton
@@ -13,6 +14,7 @@
 # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 # License for the specific language governing permissions and limitations under
 # the License.
+#++
 
 module Firebind
 

data/lib/firebind/scan.rb

@@ -1,3 +1,4 @@
+#--
 # Firebind -- Path Scan Client Software
 # Copyright (C) 2013 Firebind Inc. All rights reserved.
 # Authors - Jay Houghton
@@ -13,6 +14,7 @@
 # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 # License for the specific language governing permissions and limitations under
 # the License.
+#++
 
 require 'net/http'
 require 'uri'
@@ -35,12 +37,14 @@ module Firebind
     include Observable
     include Tools
 
+    attr_accessor :tag
+
     # Create a new Scan
     #
     #--
     # @param [Object] command_server
     # @param [Object] ports
-    def initialize (command_server, ports, transport, timeout=5000, protocol=:SimpleProtocol, username=NIL, password=NIL)
+    def initialize (command_server, ports, transport, timeout=5000, protocol=:SimpleProtocol, username=nil, password=nil, tag=nil)
       @command_server = command_server
       @portspec = Firebind::Portspec.new(ports)
       @timeout = timeout
@@ -48,6 +52,7 @@ module Firebind
       @username = username
       @password = password
       @transport = transport
+      @tag = tag
       @done = false
       @state = ScanState.new(command_server,protocol,transport,@portspec,timeout)
 
@@ -136,13 +141,14 @@ module Firebind
 
       end
 
+      @state.on_scan_complete($client_scan_completed)
+
       api_update
 
-      if @portspec.size == @state.ports_scanned
-        @state.on_scan_complete($client_scan_completed)
-        changed
-        notify_observers(@state)
-      end
+      #if @portspec.size == @state.ports_scanned
+      changed
+      notify_observers(@state)
+
 
       #update
       @state
@@ -182,13 +188,13 @@ module Firebind
       request = Net::HTTP::Post.new(uri.request_uri)
       request.basic_auth(@username, @password)
 
-      transport_proto = if @transport == :UDP then 'udp' else 'tcp' end
+      transport_proto = if @transport == :UDP then 'UDP' else 'TCP' end
 
-      data = {portSpec:@portspec.to_s,protocol:transport_proto}
+      data = {portSpec:@portspec.to_s,transport:transport_proto,scanTimeout:@timeout,tag:@tag}
       request.body = data.to_json
 
       #noinspection RubyStringKeysInHashInspection
-      #request.set_form_data({'portSpec' => @portspec.to_s, 'protocol' => 'TCP'})
+      #request.set_form_data({'portSpec' => @portspec.to_s, 'transport' => 'TCP'})
 
       begin
         response = http.request(request)
@@ -265,12 +271,18 @@ module Firebind
         data << { guid:@state.guid, serverId:@state.echo_server, portSpec:ps.to_s, statusCode:code, status:status}
       end
 
+      debug(@state.to_s)
       test_status = if @state.current_state == :SCAN_COMPLETE then 'Success' else 'Failed' end
 
       #build json payload with results
       report = { clientReport: { guid:@state.guid, serverId:@state.echo_server, testStatus:test_status, uid:@username},
                  clientReportData: data }
-      #jj report
+
+      if $debug
+        debug('Scan update composed:')
+        jj report
+      end
+
       json = report.to_json
       request.body = json
 

data/lib/firebind/scan_error.rb

@@ -1,3 +1,4 @@
+#--
 # Firebind -- Path Scan Client Software
 # Copyright (C) 2013 Firebind Inc. All rights reserved.
 # Authors - Jay Houghton
@@ -13,6 +14,7 @@
 # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 # License for the specific language governing permissions and limitations under
 # the License.
+#++
 
 module Firebind
   class ScanError < IOError

data/lib/firebind/scan_state.rb

@@ -1,3 +1,4 @@
+#--
 # Firebind -- Path Scan Client Software
 # Copyright (C) 2013 Firebind Inc. All rights reserved.
 # Authors - Jay Houghton
@@ -13,6 +14,7 @@
 # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 # License for the specific language governing permissions and limitations under
 # the License.
+#++
 
 require_relative 'tools'
 module Firebind
@@ -43,13 +45,13 @@ module Firebind
       @transport = transport
       @portspec = portspec
       @timeout = timeout
-      @guid = NIL
-      @echo_server = NIL
+      @guid = nil
+      @echo_server = nil
       @port = 0
       @last_duration = 0
       @ports_scanned = 0
       @result_map = Hash.new {|hash,key| hash[key]=[]}  # block form
-      @message = NIL
+      @message = nil
     end
 
     def to_s

data/lib/firebind/simple_protocol.rb

@@ -1,3 +1,4 @@
+#--
 # Firebind -- Path Scan Client Software
 # Copyright (C) 2013 Firebind Inc. All rights reserved.
 # Authors - Jay Houghton
@@ -13,6 +14,7 @@
 # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 # License for the specific language governing permissions and limitations under
 # the License.
+#++
 
 require_relative 'tcp_transport'
 require_relative 'udp_transport'
@@ -27,7 +29,7 @@ module Firebind
     include Tools
 
     # @param [Object] transport
-    def initialize(guid,echo_host,transport,timeout,state=NIL)
+    def initialize(guid,echo_host,transport,timeout,state=nil)
       @guid = guid
       @echo_host = echo_host
       @state = state

data/lib/firebind/tcp_transport.rb

@@ -1,3 +1,4 @@
+#--
 # Firebind -- Path Scan Client Software
 # Copyright (C) 2013 Firebind Inc. All rights reserved.
 # Authors - Jay Houghton
@@ -13,6 +14,7 @@
 # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 # License for the specific language governing permissions and limitations under
 # the License.
+#++
 
 require_relative 'transport'
 require_relative 'tools'
@@ -51,9 +53,9 @@ module Firebind
         readables,writables,errors = IO.select([@socket], [@socket], [@socket], @timeout_seconds)
         debug "readables=#{readables} writables=#{writables} errors=#{errors}"
 
-        readable = readables != NIL && readables.length > 0
-        writable = writables != NIL && writables.length > 0
-        error = errors != NIL && errors.length > 0
+        readable = readables != nil && readables.length > 0
+        writable = writables != nil && writables.length > 0
+        error = errors != nil && errors.length > 0
 
         if error
           raise Firebind::ScanError.new(:HANDSHAKE_CONNECTION_REFUSED)

data/lib/firebind/tools.rb

@@ -1,3 +1,4 @@
+#--
 # Firebind -- Path Scan Client Software
 # Copyright (C) 2013 Firebind Inc. All rights reserved.
 # Authors - Jay Houghton
@@ -13,6 +14,7 @@
 # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 # License for the specific language governing permissions and limitations under
 # the License.
+#++
 
 # Utility module for translating socket and result codes.
 module Tools

data/lib/firebind/transport.rb

@@ -1,3 +1,4 @@
+#--
 # Firebind -- Path Scan Client Software
 # Copyright (C) 2013 Firebind Inc. All rights reserved.
 # Authors - Jay Houghton
@@ -13,6 +14,7 @@
 # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 # License for the specific language governing permissions and limitations under
 # the License.
+#++
 
 require_relative 'tools'
 require 'socket'

data/lib/firebind/udp_transport.rb

@@ -1,3 +1,4 @@
+#--
 # Firebind -- Path Scan Client Software
 # Copyright (C) 2013 Firebind Inc. All rights reserved.
 # Authors - Jay Houghton
@@ -13,6 +14,7 @@
 # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 # License for the specific language governing permissions and limitations under
 # the License.
+#++
 
 require_relative 'transport'
 require_relative 'tools'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: firescan
 version: !ruby/object:Gem::Version
-  version: '0.07'
+  version: '0.08'
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-02 00:00:00.000000000 Z
+date: 2014-01-10 00:00:00.000000000 Z
 dependencies: []
 description: ! "firescan-ruby\n=============\n\nRuby reference implementation for
   the Firebind Firescan path scan client This code has been tested to work\nwith Ruby
@@ -31,7 +31,6 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- build
 - LICENSE.txt
 - test/portspec_test.rb
 - test/runner.rb
@@ -78,7 +77,6 @@ files:
 - doc/LICENSE_txt.html
 - doc/Example.html
 - doc/Runner.html
-- doc/build.html
 - doc/Firebind/SimpleProtocol.html
 - doc/Firebind/Portspec.html
 - doc/Firebind/Transport.html

data/build

@@ -1,7 +0,0 @@
-#!/bin/bash
-rm *.gem
-rm -rf doc
-rdoc
-gem uninstall -x firescan
-gem build firescan.gemspec
-gem install firescan-*.gem

data/doc/build.html

@@ -1,125 +0,0 @@
-<!DOCTYPE html>
-
-<html>
-<head>
-<meta content="text/html; charset=UTF-8" http-equiv="Content-Type">
-
-<title>build - RDoc Documentation</title>
-
-<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet">
-
-<script type="text/javascript">
-  var rdoc_rel_prefix = "./";
-</script>
-
-<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script>
-<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script>
-<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script>
-<script type="text/javascript" charset="utf-8" src="./js/search.js"></script>
-<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script>
-<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script>
-
-
-<body class="file">
-<nav id="metadata">
-  <nav id="home-section" class="section">
-  <h3 class="section-header">
-    <a href="./index.html">Home</a>
-    <a href="./table_of_contents.html#classes">Classes</a>
-    <a href="./table_of_contents.html#methods">Methods</a>
-  </h3>
-</nav>
-
-
-  <nav id="search-section" class="section project-section" class="initially-hidden">
-  <form action="#" method="get" accept-charset="utf-8">
-    <h3 class="section-header">
-      <input type="text" name="search" placeholder="Search" id="search-field"
-             title="Type to search, Up and Down to navigate, Enter to load">
-    </h3>
-  </form>
-
-  <ul id="search-results" class="initially-hidden"></ul>
-</nav>
-
-
-  
-
-  <div id="project-metadata">
-    <nav id="fileindex-section" class="section project-section">
-  <h3 class="section-header">Pages</h3>
-
-  <ul>
-  
-    <li class="file"><a href="./LICENSE_txt.html">LICENSE</a>
-  
-    <li class="file"><a href="./README_txt.html">README</a>
-  
-    <li class="file"><a href="./USAGE_txt.html">USAGE</a>
-  
-    <li class="file"><a href="./VERSION_txt.html">VERSION</a>
-  
-    <li class="file"><a href="./build.html">build</a>
-  
-    <li class="file"><a href="./doc/created_rid.html">created.rid</a>
-  
-    <li class="file"><a href="./firescan_gemspec.html">firescan.gemspec</a>
-  
-  </ul>
-</nav>
-
-    <nav id="classindex-section" class="section project-section">
-  <h3 class="section-header">Class and Module Index</h3>
-
-  <ul class="link-list">
-  
-    <li><a href="./Example.html">Example</a>
-  
-    <li><a href="./Firebind.html">Firebind</a>
-  
-    <li><a href="./Firebind/Client.html">Firebind::Client</a>
-  
-    <li><a href="./Firebind/Portspec.html">Firebind::Portspec</a>
-  
-    <li><a href="./Firebind/Scan.html">Firebind::Scan</a>
-  
-    <li><a href="./Firebind/ScanError.html">Firebind::ScanError</a>
-  
-    <li><a href="./Firebind/ScanState.html">Firebind::ScanState</a>
-  
-    <li><a href="./Firebind/SimpleProtocol.html">Firebind::SimpleProtocol</a>
-  
-    <li><a href="./Firebind/TcpTransport.html">Firebind::TcpTransport</a>
-  
-    <li><a href="./Firebind/Transport.html">Firebind::Transport</a>
-  
-    <li><a href="./Firebind/UdpTransport.html">Firebind::UdpTransport</a>
-  
-    <li><a href="./Runner.html">Runner</a>
-  
-    <li><a href="./TestPortspec.html">TestPortspec</a>
-  
-    <li><a href="./Tools.html">Tools</a>
-  
-  </ul>
-</nav>
-
-  </div>
-</nav>
-
-<div id="documentation" class="description">
-  
-<p>#!/bin/bash rm *.gem rm -rf doc rdoc gem uninstall -x firescan gem build <a
-href="firescan_gemspec.html">firescan.gemspec</a> gem install
-firescan-*.gem</p>
-
-</div>
-
-
-
-<footer id="validator-badges">
-  <p><a href="http://validator.w3.org/check/referer">[Validate]</a>
-  <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 4.0.1.
-  <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3.
-</footer>
-