arp_scan 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b7b960cabf68bf289134ad75739ab76573745ed6
-  data.tar.gz: 9b5cce94f3350b24e70053d6e0e4aa8045436403
+  metadata.gz: a0da554d94d3c4a4ad2f5e0f8f8d8715a3d2f577
+  data.tar.gz: 8fe6d25d5d0db6f24dc38a5b0da2221d15ccaabb
 SHA512:
-  metadata.gz: 42b6b7058c6dd4d2f5fbae4c0a3a3c0dca2f1fbf09bf52151f9c3a11191d0b43a06bbe927794611637a424155cae7924f671b501d51d8e536e7627633d976289
-  data.tar.gz: b9a8177864994bb4eef7993f638e1a6772f54ff5e4febe0211e691fb6a366c3b2700719a8a6f277f7a86717987dfd7624bff738e217f9e1f271e7a6ad478f496
+  metadata.gz: c511bd3dd089abe3b23146222906d592694b1fede141ef48d211eeaee431a6c3a362846dadd0733d91b60ed978197b78c5984c8679ca2f0dedbffbf9833a0882
+  data.tar.gz: 91db2dd695ac6c36580ec84f19bbbd22c19821559b45580aa4b2a19df2fc510abb053699688932d6d85779f9c77d30c2ea8c3da7fdd6b539a0db00da36a9f4df

data/lib/arp_scan/host.rb

@@ -2,7 +2,18 @@ module ARPScan
   # Abstracts replying hosts from the arp-scan output.
   #
   class Host
-    attr_reader :ip_addr, :mac, :oui
+
+    # The IP address of the host.
+    #
+    attr_reader :ip_addr
+
+    # The MAC address of the host.
+    #
+    attr_reader :mac
+
+    # OUI information about the host.
+    #
+    attr_reader :oui
 
     # Create a new hsot. IP address, MAC address and OUI information are
     # expected.

data/lib/arp_scan/scan_report.rb

@@ -5,7 +5,36 @@ module ARPScan
   #
   class ScanReport
 
-    attr_reader :hosts, :interface, :datalink, :version, :range_size, :scan_time, :scan_rate, :reply_count
+    # Array of Host objects.
+    #
+    attr_reader :hosts
+
+    # Name of the interface used for the scan.
+    #
+    attr_reader :interface
+
+    # Information about the interface type.
+    #
+    attr_reader :datalink
+
+    # `arp-scan` version number.
+    #
+    attr_reader :version
+
+    # Size of the scan range ( # of hosts scanned ).
+    #
+    attr_reader :range_size
+
+    # Duration of the scan in seconds, returns a Float.
+    #
+    attr_reader :scan_time
+
+    # The rate of the scan in hosts per second, returns a Float.
+    #
+    attr_reader :scan_rate
+
+    # The number of hosts that replied to the scan, returns a Fixnum
+    attr_reader :reply_count
 
     # Create a new scan report, passing in every attribute. The best way to do
     # this is with the ScanResultProcessor module.

data/lib/arp_scan/scan_result_processor.rb

@@ -7,10 +7,17 @@ module ARPScan
   #
   module ScanResultProcessor
 
-    # Regexes for parsing the arp-scan output.
+    # Regex to capture IP address, MAC address, and OUI information
     #
     Host_Entry_Regex = /(\d+.\d+.\d+.\d+)\s(\w\w:\w\w:\w\w:\w\w:\w\w:\w\w)\s(.*)/
+   
+    # Regex to capture interface and datalink
+    #
     Interface_Summary_Regex = /Interface: (?<interface>.+), datalink type: (?<datalink>.*$)/
+
+    # Regex to capture arp-scan version, scan range size, scan time, scan rate,
+    # and the number of responding hosts.
+    #
     Scan_Summary_Regex = /Ending arp-scan (?<version>.*): (?<range_size>.*) hosts scanned in (?<scan_time>.*) seconds \((?<scan_rate>.*) hosts\/sec\). (?<reply_count>.*) responded/
 
     # This method does the actual processing of the arp-scan result string. It

data/lib/arp_scan/version.rb

@@ -1,3 +1,3 @@
 module ARPScan
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: arp_scan
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Michael Rodrigues
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-18 00:00:00.000000000 Z
+date: 2014-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler