arp_scan 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 34dd3d80cf5837da8b1fbaba13bdf550e7ce1cb7
-  data.tar.gz: 1192b2fbba626243f283c26c86f86ae14c3d42dc
+SHA256:
+  metadata.gz: 768a6997ecf0acffce32b3d52a16994e892b8f6fd93ec887613aebd478a6a86b
+  data.tar.gz: d8c053296aae885d75e79b70a71d4e7264fdc3f5cf61c84d65b3019b89e56262
 SHA512:
-  metadata.gz: 12f73da6dd9d7e339ca33b02d334015d736e1be0b65355450e78feffce5154df927914e7cb4d1a491b908db697723ce484693c1e1650a7e389a7b71f52eac794
-  data.tar.gz: 4fdfbb69b73022af9ebda830a85ea58bff8a06fc876e21e439884cf53c1d0d99cd8ea36ac671fc5fa46b3dccbe02761904a78df9d2c3bf71194712be068bb5fa
+  metadata.gz: 62d6e68337f32a52808e63dae880d09191b3b353c4338e4b05ee4349ed23572c594badb21af97a1336bba20dbad6b1d5aec23889acc16de63aa3e9e1ce8abbed
+  data.tar.gz: af52cd4506b2a847041e296fbf9d2483a0fb23a2c5e520b45168850ef986105736be7e0512832a88b39390c218a7eb5df5e10d233566af9107f9a8c1b745ebf6

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 group :test do
@@ -6,4 +8,4 @@ group :test do
 end
 
 # Specify your gem's dependencies in arp_scan.gemspec
-#gemspec
+# gemspec

data/Gemfile.lock

@@ -0,0 +1,26 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.4.4)
+    rspec (3.0.0)
+      rspec-core (~> 3.0.0)
+      rspec-expectations (~> 3.0.0)
+      rspec-mocks (~> 3.0.0)
+    rspec-core (3.0.4)
+      rspec-support (~> 3.0.0)
+    rspec-expectations (3.0.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.0.0)
+    rspec-mocks (3.0.4)
+      rspec-support (~> 3.0.0)
+    rspec-support (3.0.4)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  rspec
+  rspec-support (~> 3.0.0)
+
+BUNDLED WITH
+   2.2.15

data/README.md

@@ -1,7 +1,7 @@
 # ARPScan
 
-[![arp_scan API
-Documentation](https://www.omniref.com/ruby/gems/arp_scan.png)](https://www.omniref.com/ruby/gems/arp_scan)
+[![Gem Version](https://badge.fury.io/rb/arp_scan.svg)](http://badge.fury.io/rb/arp_scan)
+<a href="https://codeclimate.com/github/mikerodrigues/arp_scan"><img src="https://codeclimate.com/github/mikerodrigues/arp_scan/badges/gpa.svg" /></a>
 
 Very simple wrapper for using and parsing output from `arp-scan`.
 

data/arp_scan.gemspec

@@ -1,23 +1,22 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'arp_scan/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "arp_scan"
+  spec.name          = 'arp_scan'
   spec.version       = ARPScan::VERSION
-  spec.authors       = ["Michael Rodrigues"]
-  spec.email         = ["mikebrodrigues@gmail.com"]
-  spec.summary       = %q{A ruby wrapper for the arp-scan utility.}
-  spec.description   = %q{Easily use the arp-scan utility from within your ruby programs.}
-  spec.homepage      = "https://github.com/mikerodrigues/arp_scan"
-  spec.license       = "MIT"
+  spec.authors       = ['Michael Rodrigues']
+  spec.email         = ['mikebrodrigues@gmail.com']
+  spec.summary       = 'A ruby wrapper for the arp-scan utility.'
+  spec.description   = 'Use the arp-scan utility from your ruby programs.'
+  spec.homepage      = 'https://github.com/mikerodrigues/arp_scan'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.7"
-  spec.add_development_dependency "rake", "~> 10.0"
 end

data/lib/arp_scan.rb

@@ -1,8 +1,10 @@
-require_relative "./arp_scan/version"
-require_relative "./arp_scan/arp_scanner"
-require_relative "./arp_scan/scan_report"
-require_relative "./arp_scan/scan_result_processor"
-require_relative "./arp_scan/host"
+# frozen_string_literal: true
+
+require_relative './arp_scan/version'
+require_relative './arp_scan/arp_scanner'
+require_relative './arp_scan/scan_report'
+require_relative './arp_scan/scan_result_processor'
+require_relative './arp_scan/host'
 
 # This module just acts as a namespace for the gem.
 #

data/lib/arp_scan/arp_scanner.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative './scan_result_processor'
 
 module ARPScan
@@ -13,10 +15,10 @@ module ARPScan
     def self.which(cmd)
       exts = ENV['PATHEXT'] ? ENV['PATHEXT'].split(';') : ['']
       ENV['PATH'].split(File::PATH_SEPARATOR).each do |path|
-        exts.each { |ext|
+        exts.each do |ext|
           exe = File.join(path, "#{cmd}#{ext}")
           return exe if File.executable?(exe) && !File.directory?(exe)
-        }
+        end
       end
       raise 'arp-scan binary not found, make sure it is installed'
     end
@@ -33,4 +35,3 @@ module ARPScan
     private_class_method :which
   end
 end
-

data/lib/arp_scan/host.rb

@@ -1,8 +1,9 @@
+# frozen_string_literal: true
+
 module ARPScan
   # Abstracts replying hosts from the arp-scan output.
   #
   class Host
-
     # The IP address of the host.
     #
     attr_reader :ip_addr
@@ -27,19 +28,17 @@ module ARPScan
     # Returns a hash representation of the Host object.
     #
     def to_hash
-      { :ip_addr => @ip_addr,
-        :mac     => @mac,
-        :oui      => @oui
-      }
+      { ip_addr: @ip_addr,
+        mac: @mac,
+        oui: @oui }
     end
 
     # Returns an array representation of the Host object.
     #
     def to_array
-      [ @ip_addr,
-        @mac,
-        @oui
-      ]
+      [@ip_addr,
+       @mac,
+       @oui]
     end
   end
 end

data/lib/arp_scan/scan_report.rb

@@ -1,10 +1,10 @@
-module ARPScan
+# frozen_string_literal: true
 
+module ARPScan
   # This class abstracts the string output from arp-scan into an Object. A
   # ScanReports are usually created through the ScanResultProcessor module.
   #
   class ScanReport
-
     # Array of Host objects.
     #
     attr_reader :hosts
@@ -58,11 +58,11 @@ module ARPScan
     # scan, and an array of Host arrays comprise the array.
     #
     def to_array
-      self.instance_variables.map do |var|
+      instance_variables.map do |var|
         if var == :@hosts
-          self.instance_variable_get(var).map {|host| host.to_array}
+          instance_variable_get(var).map(&:to_array)
         else
-          self.instance_variable_get(var)
+          instance_variable_get(var)
         end
       end
     end
@@ -71,17 +71,15 @@ module ARPScan
     # and array of Host hashes comprise the hash.
     #
     def to_hash
-      { :hosts => @hosts.map {|host| host.to_hash},
-        :interface => @interface,
-        :datalink => @datalink,
-        :version => @version,
-        :range_size => @range_size,
-        :scan_time => @scan_time,
-        :scan_rate => @scan_rate,
-        :reply_count => @reply_count,
-        :arguments => @arguments
-      }
+      { hosts: @hosts.map(&:to_hash),
+        interface: @interface,
+        datalink: @datalink,
+        version: @version,
+        range_size: @range_size,
+        scan_time: @scan_time,
+        scan_rate: @scan_rate,
+        reply_count: @reply_count,
+        arguments: @arguments }
     end
-
   end
 end

data/lib/arp_scan/scan_result_processor.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative './host'
 require_relative './scan_report'
 
@@ -6,19 +8,18 @@ module ARPScan
   # output.
   #
   module ScanResultProcessor
-
     # 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(.*)/
-   
+    HOST_ENTRY_REGEX = /(\d+.\d+.\d+.\d+)\s(\w\w:\w\w:\w\w:\w\w:\w\w:\w\w)\s(.*)/.freeze
+
     # Regex to capture interface and datalink
     #
-    Interface_Summary_Regex = /Interface: (?<interface>.+), datalink type: (?<datalink>.*$)/
+    INTERFACE_SUMMARY_REGEX = /Interface: (?<interface>.+), datalink type: (?<datalink>.*$)/.freeze
 
     # 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/
+    SCAN_SUMMARY_REGEX = %r{Ending arp-scan (?<version>.*): (?<range_size>.*) hosts scanned in (?<scan_time>.*) seconds \((?<scan_rate>.*) hosts/sec\). (?<reply_count>.*) responded}.freeze
 
     # This method does the actual processing of the arp-scan result string. It
     # uses the Regexes to capture data then passes the results to ScanRepor.new
@@ -26,14 +27,14 @@ module ARPScan
     #
     def self.process(string, arguments)
       results = {}
-      results[:hosts] = string.scan(Host_Entry_Regex).map {|entry| Host.new(*entry)}
+      results[:hosts] = string.scan(HOST_ENTRY_REGEX).map { |entry| Host.new(*entry) }
       results[:interface],
-      results[:datalink] = string.scan(Interface_Summary_Regex)[0]
+      results[:datalink] = string.scan(INTERFACE_SUMMARY_REGEX)[0]
       results[:version],
       results[:range_size],
       results[:scan_time],
       results[:scan_rate],
-      results[:reply_count] = string.scan(Scan_Summary_Regex)[0]
+      results[:reply_count] = string.scan(SCAN_SUMMARY_REGEX)[0]
       results[:arguments] = arguments
       ScanReport.new(results)
     end

data/lib/arp_scan/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ARPScan
-  VERSION = "0.1.0"
+  VERSION = '0.1.1'
 end

data/spec/arp_scan_spec.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 require_relative './spec_helper.rb'
 
 RSpec.describe ARPScan do
-  report = ARPScan('-l')
-  it "is a method" do
+  ARPScan('-l')
+  it 'is a method' do
     expect(ARPScan.respond_to?('__send__')).to eq(true)
   end
 end

data/spec/arp_scanner_spec.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 require_relative './spec_helper'
 
 module ARPScan
   describe ARPScanner do
-    describe "#scan" do
-      it "accepts arp-scan arguments as a string" do
+    describe '#scan' do
+      it 'accepts arp-scan arguments as a string' do
         expect(ARPScanner.scan('-l').class).to eq(ScanReport)
       end
     end

data/spec/host_spec.rb

@@ -1,27 +1,27 @@
+# frozen_string_literal: true
+
 require_relative './spec_helper'
 
 module ARPScan
   describe Host do
+    host = Host.new('10.0.0.1', '00:11:22:33:44:55', 'NIC Manufacturer')
 
-    host = Host.new('10.0.0.1', '00:11:22:33:44:55', "NIC Manufacturer")
-
-    describe "#ip_addr" do
+    describe '#ip_addr' do
       it "returns the host's IP address" do
         expect(host.ip_addr).to eq('10.0.0.1')
       end
     end
 
-    describe "#mac" do
+    describe '#mac' do
       it "returns the host's MAC address" do
         expect(host.mac).to eq('00:11:22:33:44:55')
       end
     end
 
-    describe "#oui" do
+    describe '#oui' do
       it "returns the host's OUI information" do
         expect(host.oui).to eq('NIC Manufacturer')
       end
     end
-
   end
 end

data/spec/scan_report_spec.rb

@@ -1,73 +1,74 @@
+# frozen_string_literal: true
+
 require_relative './spec_helper'
 
 module ARPScan
   describe ScanReport do
-
     report_hash = {
-      :hosts => [Host.new(*['10.0.0.1', '00:11:22:33:44:55', 'NIC Manufacturer'])],
-      :interface => "eth0",
-      :datalink => "EN10MB (Ethernet)",
-      :version => "1.8.1",
-      :range_size => 256,
-      :scan_time => 1.503,
-      :scan_rate => 170.33,
-      :reply_count => 1,
-      :arguments => '-l'
+      hosts: [Host.new('10.0.0.1', '00:11:22:33:44:55', 'NIC Manufacturer')],
+      interface: 'eth0',
+      datalink: 'EN10MB (Ethernet)',
+      version: '1.8.1',
+      range_size: 256,
+      scan_time: 1.503,
+      scan_rate: 170.33,
+      reply_count: 1,
+      arguments: '-l'
     }
 
     scan_report = ScanReport.new(report_hash)
 
-    describe "#hosts" do
-      it "returns an Array of Host objects" do
+    describe '#hosts' do
+      it 'returns an Array of Host objects' do
         expect(scan_report.hosts.class).to eq(Array)
         expect(scan_report.hosts.first.class).to eq(Host)
       end
     end
 
-    describe "#interface" do
-      it "returns the network interface used to scan" do
-        expect(scan_report.interface).to eq("eth0")
+    describe '#interface' do
+      it 'returns the network interface used to scan' do
+        expect(scan_report.interface).to eq('eth0')
       end
     end
 
-    describe "#datalink" do
-      it "returns the datalink type of the network interface used to scan" do
+    describe '#datalink' do
+      it 'returns the datalink type of the network interface used to scan' do
         expect(scan_report.datalink).to eq('EN10MB (Ethernet)')
       end
     end
 
-    describe "#version" do
-      it "returns the version of `arp-scan` used for the scan" do
+    describe '#version' do
+      it 'returns the version of `arp-scan` used for the scan' do
         expect(scan_report.version).to eq('1.8.1')
       end
     end
 
-    describe "#range_size" do
-      it "returns the size of the range of scanned IPs" do
+    describe '#range_size' do
+      it 'returns the size of the range of scanned IPs' do
         expect(scan_report.range_size).to eq(256)
       end
     end
 
-    describe "#scan_time" do
-      it "returns the duration of the scan in seconds" do
+    describe '#scan_time' do
+      it 'returns the duration of the scan in seconds' do
         expect(scan_report.scan_time).to eq(1.503)
       end
     end
 
-    describe "#scan_rate" do
-      it "returns the scan rate in hosts per second" do
+    describe '#scan_rate' do
+      it 'returns the scan rate in hosts per second' do
         expect(scan_report.scan_rate).to eq(170.33)
       end
     end
 
-    describe "#reply_count" do
-      it "returns the number of hosts that responded" do
+    describe '#reply_count' do
+      it 'returns the number of hosts that responded' do
         expect(scan_report.reply_count).to eq(1)
       end
     end
 
-    describe "#arguments" do
-      it "returns the argument string used to scan" do
+    describe '#arguments' do
+      it 'returns the argument string used to scan' do
         expect(scan_report.arguments).to eq('-l')
       end
     end

data/spec/scan_result_processor_spec.rb

@@ -1,50 +1,51 @@
+# frozen_string_literal: true
+
 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, argument_string)
 
-    describe "#process" do
-      it "processes arp-scan output to create a ScanReport object" do
+    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
+      it 'builds an array of Host objects' do
         expect(report.hosts[0].class).to eq(ARPScan::Host)
       end
 
-      it "parses the scan interface name" do
-        expect(report.interface).to eq("eth0")
+      it 'parses the scan interface name' do
+        expect(report.interface).to eq('eth0')
       end
 
-      it "parses the datalink type information" do
-        expect(report.datalink).to eq("EN10MB (Ethernet)")
+      it 'parses the datalink type information' do
+        expect(report.datalink).to eq('EN10MB (Ethernet)')
       end
 
-      it "parses the version of arp-scan that ran the scan" do
+      it 'parses the version of arp-scan that ran the scan' do
         expect(report.version).to eq('1.8.1')
       end
 
-      it "parses the number of hosts scanned" do
+      it 'parses the number of hosts scanned' do
         expect(report.range_size).to eq(256)
       end
 
-      it "parses the duration of the scan in seconds" do
+      it 'parses the duration of the scan in seconds' do
         expect(report.scan_time).to eq(1.494)
       end
 
-      it "parses the rate of the scan in hosts per second" do
+      it 'parses the rate of the scan in hosts per second' do
         expect(report.scan_rate).to eq(171.35)
       end
 
-      it "parses the number of hosts that responded to the scan" do
+      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
+      it 'includes the argument string in the report' do
         expect(report.arguments).to eq('-l')
       end
     end

data/spec/spec_helper.rb

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 require '../lib/arp_scan'

metadata

@@ -1,44 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: arp_scan
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Michael Rodrigues
 autorequire: 
 bindir: bin
 cert_chain: []
-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.
+date: 2021-07-11 00:00:00.000000000 Z
+dependencies: []
+description: Use the arp-scan utility from your ruby programs.
 email:
 - mikebrodrigues@gmail.com
 executables: []
@@ -46,6 +18,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - arp_scan.gemspec
@@ -81,8 +54,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 3.2.3
 signing_key: 
 specification_version: 4
 summary: A ruby wrapper for the arp-scan utility.