arp_scan 0.0.6 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a0da554d94d3c4a4ad2f5e0f8f8d8715a3d2f577
-  data.tar.gz: 8fe6d25d5d0db6f24dc38a5b0da2221d15ccaabb
+  metadata.gz: 34dd3d80cf5837da8b1fbaba13bdf550e7ce1cb7
+  data.tar.gz: 1192b2fbba626243f283c26c86f86ae14c3d42dc
 SHA512:
-  metadata.gz: c511bd3dd089abe3b23146222906d592694b1fede141ef48d211eeaee431a6c3a362846dadd0733d91b60ed978197b78c5984c8679ca2f0dedbffbf9833a0882
-  data.tar.gz: 91db2dd695ac6c36580ec84f19bbbd22c19821559b45580aa4b2a19df2fc510abb053699688932d6d85779f9c77d30c2ea8c3da7fdd6b539a0db00da36a9f4df
+  metadata.gz: 12f73da6dd9d7e339ca33b02d334015d736e1be0b65355450e78feffce5154df927914e7cb4d1a491b908db697723ce484693c1e1650a7e389a7b71f52eac794
+  data.tar.gz: 4fdfbb69b73022af9ebda830a85ea58bff8a06fc876e21e439884cf53c1d0d99cd8ea36ac671fc5fa46b3dccbe02761904a78df9d2c3bf71194712be068bb5fa

data/README.md

@@ -1,5 +1,8 @@
 # ARPScan
 
+[![arp_scan API
+Documentation](https://www.omniref.com/ruby/gems/arp_scan.png)](https://www.omniref.com/ruby/gems/arp_scan)
+
 Very simple wrapper for using and parsing output from `arp-scan`.
 
 You will need to make sure `arp-scan` is installed. See the arp-scan homepage at http://www.nta-monitor.com/tools/arp-scan/
@@ -70,6 +73,7 @@ report.reply_count 	=> 2
 report.scan_rate 	=> 169.99 # hosts/sec
 report.scan_time 	=> 1.586 # seconds
 report.version 		=> "1.8.1" # arp-scan version
+report.arguments	=> "--localnet"
 ```
 
 Each `ScanReport` also holds zero or more `Host` objects representing founds

data/lib/arp_scan/arp_scanner.rb

@@ -18,7 +18,7 @@ module ARPScan
           return exe if File.executable?(exe) && !File.directory?(exe)
         }
       end
-      return nil
+      raise 'arp-scan binary not found, make sure it is installed'
     end
 
     # This method runs the actual scan by passing the arguments to the arp-scan
@@ -27,7 +27,7 @@ module ARPScan
     #
     def self.scan(argument_string = nil)
       result_string = `#{which 'arp-scan'} #{argument_string}`
-      ScanResultProcessor.process(result_string)
+      ScanResultProcessor.process(result_string, argument_string)
     end
 
     private_class_method :which

data/lib/arp_scan/scan_report.rb

@@ -36,6 +36,9 @@ module ARPScan
     # The number of hosts that replied to the scan, returns a Fixnum
     attr_reader :reply_count
 
+    # The argument string passed to ARPScan
+    attr_reader :arguments
+
     # Create a new scan report, passing in every attribute. The best way to do
     # this is with the ScanResultProcessor module.
     #
@@ -48,6 +51,7 @@ module ARPScan
       @scan_time = Float(hash[:scan_time])
       @scan_rate = Float(hash[:scan_rate])
       @reply_count = Integer(hash[:reply_count])
+      @arguments = hash[:arguments]
     end
 
     # Returns an array representation of the ScanReport. Metadata about the
@@ -74,7 +78,8 @@ module ARPScan
         :range_size => @range_size,
         :scan_time => @scan_time,
         :scan_rate => @scan_rate,
-        :reply_count => @reply_count
+        :reply_count => @reply_count,
+        :arguments => @arguments
       }
     end
 

data/lib/arp_scan/scan_result_processor.rb

@@ -24,7 +24,7 @@ module ARPScan
     # uses the Regexes to capture data then passes the results to ScanRepor.new
     # to return a ScanReport object.
     #
-    def self.process(string)
+    def self.process(string, arguments)
       results = {}
       results[:hosts] = string.scan(Host_Entry_Regex).map {|entry| Host.new(*entry)}
       results[:interface],
@@ -34,6 +34,7 @@ module ARPScan
       results[:scan_time],
       results[:scan_rate],
       results[:reply_count] = string.scan(Scan_Summary_Regex)[0]
+      results[:arguments] = arguments
       ScanReport.new(results)
     end
   end

data/lib/arp_scan/version.rb

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

data/spec/scan_report_spec.rb

@@ -11,7 +11,8 @@ module ARPScan
       :range_size => 256,
       :scan_time => 1.503,
       :scan_rate => 170.33,
-      :reply_count => 1
+      :reply_count => 1,
+      :arguments => '-l'
     }
 
     scan_report = ScanReport.new(report_hash)
@@ -64,5 +65,11 @@ module ARPScan
         expect(scan_report.reply_count).to eq(1)
       end
     end
+
+    describe "#arguments" do
+      it "returns the argument string used to scan" do
+        expect(scan_report.arguments).to eq('-l')
+      end
+    end
   end
 end

data/spec/scan_result_processor_spec.rb

@@ -3,15 +3,15 @@ require_relative './spec_helper'
 module ARPScan
   describe ScanResultProcessor do
 
+    argument_string = '-l'
     report_string = File.read './test_output.txt'
-    report = ARPScan::ScanResultProcessor.process(report_string)
+    report = ARPScan::ScanResultProcessor.process(report_string, argument_string)
 
     describe "#process" do
       it "processes arp-scan output to create a ScanReport object" do
         expect(report.class).to eq(ARPScan::ScanReport)
       end
 
-
       it "builds an array of Host objects" do
         expect(report.hosts[0].class).to eq(ARPScan::Host)
       end
@@ -43,6 +43,10 @@ module ARPScan
       it "parses the number of hosts that responded to the scan" do
         expect(report.reply_count).to eq(1)
       end
+
+      it "includes the argument string in the report" do
+        expect(report.arguments).to eq('-l')
+      end
     end
   end
 end

metadata

@@ -1,41 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: arp_scan
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.1.0
 platform: ruby
 authors:
 - Michael Rodrigues
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-26 00:00:00.000000000 Z
+date: 2015-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.7'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
 description: Easily use the arp-scan utility from within your ruby programs.
@@ -72,17 +72,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.1
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: A ruby wrapper for the arp-scan utility.