wifimap 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6954b6a9459e13bad3bc1ee5b0a41e85e8483b7babbd6f39c164522f4c567b7d
-  data.tar.gz: 5bcad22af3b701ba63814135aa74c92fbf1ddee53369056ae5df7704883807d1
+  metadata.gz: faaa8901db0fadf9f467ec4a447ce877bfbd1f9cc1ccd24785423c7677c5c838
+  data.tar.gz: 5b9a580245f96c3ccc6a1254ea0571d82d5afe77d8ff0db360685103b6ea0c01
 SHA512:
-  metadata.gz: b47191cb870ac0ed58c5897a778a35c10cdb52be880789b7296e0c0ede1ce415abc47bdfe56a9bbd692ba7fe10dc387089f92fdaf28343956b862bf6f4ed592c
-  data.tar.gz: f196cea86d4bb6385e1284621a992726367c75058873c671b2c7b5e84482d38ed0e6ad3cb4d91410ab11a1fc875da69584d2689ce8df40f657f2e67b99090bac
+  metadata.gz: 7a26c406095c9b9f8627f456ea49cf11d74f645d912df1a496d75c9cd1c55a1eed0083c8559716a6a3b5387c783a72d3ab787e9d752c770c090d354cfea88013
+  data.tar.gz: a04a5a7d0121bb09957f97d4b922ae9b5c40bbead9322a222e6631f7f3d0c2acdb7b72595c166031559d02b7d1ce666700df08100ee9527f7555ee86e8b6bcb0

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+# v0.2.2
+- Refactoring.
+
 # v0.2.1
 - Fix bug with sniff-probes parse method.
 

data/Gemfile

@@ -1,8 +1,11 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
 
 # Specify your gem's dependencies in wifimap.gemspec
 gemspec
 
-gem "rake", "~> 12.3"
-gem "rspec", "~> 3.0"
-gem 'coveralls', require: false
+gem 'coveralls', require: false
+gem 'guard-rspec'
+gem 'rake', '~> 12.3'
+gem 'rspec', '~> 3.0'

data/Gemfile.lock

@@ -1,12 +1,13 @@
 PATH
   remote: .
   specs:
-    wifimap (0.2.1)
+    wifimap (0.2.2)
       louis
 
 GEM
   remote: https://rubygems.org/
   specs:
+    coderay (1.1.3)
     coveralls (0.8.23)
       json (>= 1.8, < 3)
       simplecov (~> 0.16.1)
@@ -15,9 +16,40 @@ GEM
       tins (~> 1.6)
     diff-lcs (1.3)
     docile (1.3.2)
+    ffi (1.13.1)
+    formatador (0.2.5)
+    guard (2.16.2)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
     json (2.3.0)
+    listen (3.2.1)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
     louis (2.2.4)
+    lumberjack (1.2.5)
+    method_source (1.0.0)
+    nenv (0.3.0)
+    notiffany (0.1.3)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
     rake (12.3.3)
+    rb-fsevent (0.10.4)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
       rspec-expectations (~> 3.9.0)
@@ -31,6 +63,7 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-support (3.9.0)
+    shellany (0.0.1)
     simplecov (0.16.1)
       docile (~> 1.1)
       json (>= 1.8, < 3)
@@ -48,6 +81,7 @@ PLATFORMS
 
 DEPENDENCIES
   coveralls
+  guard-rspec
   rake (~> 12.3)
   rspec (~> 3.0)
   wifimap!

data/Guardfile

@@ -0,0 +1,42 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exist?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end

data/README.md

@@ -1,4 +1,5 @@
 # Wifimap
+
 [![Build Status](https://travis-ci.com/gpaddis/wifimap.svg?branch=master)](https://travis-ci.com/gpaddis/wifimap)
 [![Coverage Status](https://coveralls.io/repos/github/gpaddis/wifimap/badge.svg?branch=master)](https://coveralls.io/github/gpaddis/wifimap?branch=master)
 
@@ -67,13 +68,8 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/gpaddis/wifimap. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/wifimap/blob/master/CODE_OF_CONDUCT.md).
-
+Bug reports and pull requests are welcome on GitHub at https://github.com/gpaddis/wifimap.
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
-
-## Code of Conduct
-
-Everyone interacting in the Wifimap project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/wifimap/blob/master/CODE_OF_CONDUCT.md).
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -1,6 +1,8 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/bin/console

@@ -1,7 +1,8 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require "bundler/setup"
-require "wifimap"
+require 'bundler/setup'
+require 'wifimap'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -10,5 +11,5 @@ require "wifimap"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/lib/wifimap.rb

@@ -1,26 +1,30 @@
 # frozen_string_literal: true
 
+require 'wifimap/access_point'
+require 'wifimap/mac'
+require 'wifimap/parsable'
+require 'wifimap/parser_factory'
+require 'wifimap/station'
 require 'wifimap/version'
-require 'wifimap/parser'
+
 require 'wifimap/parser/airodump'
 require 'wifimap/parser/sniff_probes'
 
 module Wifimap
   class Error < StandardError; end
 
-  # Parse the content of a dump file and return a hash of APs, stations and probes.
+  # Parse the content of a dump file and return a parser instance.
+  #
+  # @param [String] file_content
+  # @return [Wifimap::Parser::*] a parser instance
   def self.parse(file_content)
-    case Wifimap::Parser.dump_format(file_content)
-    when :airodump
-      Wifimap::Parser::Airodump.new(file_content)
-    when :sniff_probes
-      Wifimap::Parser::SniffProbes.new(file_content)
-    else
-      raise Error, 'Unsupported dump format'
-    end
+    Wifimap::ParserFactory.create(file_content)
   end
 
   # A wrapper on .parse to read directly from a file.
+  #
+  # @param [String] filename
+  # @return [Wifimap::Parser::*] a parser instance
   def self.parse_file(filename)
     file_content = File.read(filename)
     parse(file_content)

data/lib/wifimap/access_point.rb

@@ -11,6 +11,8 @@ module Wifimap
     end
 
     # Get the device manufacturer based on the bssid.
+    #
+    # @return [String]
     def manufacturer
       Mac.manufacturer(bssid)
     end

data/lib/wifimap/mac.rb

@@ -5,11 +5,17 @@ require 'louis'
 module Wifimap
   class Mac
     # Return true if the mac format is correct, false otherwise.
+    #
+    # @param [String] mac
+    # @return [Boolean]
     def self.valid?(mac)
       mac =~ /([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})/ ? true : false
     end
 
     # Get the manufacturer for the given mac address.
+    #
+    # @param [String] mac
+    # @return [String]
     def self.manufacturer(mac)
       Louis.lookup(mac)['long_vendor']
     end

data/lib/wifimap/parsable.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Wifimap
+  # The parsable module contains some helper methods and must-implement
+  # directives for parser classes.
+  module Parsable
+    # Get the dump property for further processing.
+    #
+    # @return [String]
+    def dump
+      raise 'Error: the dump is empty' if @dump.nil?
+
+      @dump
+    end
+
+    # Split the dump by newline to get an array of all rows.
+    #
+    # @return [Array]
+    def dump_rows
+      dump.split("\n")
+    end
+
+    # To be implemented in the class.
+    def stations
+      raise ::NotImplementedError
+    end
+
+    # To be implemented in the class.
+    def access_points
+      raise ::NotImplementedError
+    end
+  end
+end

data/lib/wifimap/parser/airodump.rb

@@ -1,54 +1,67 @@
 # frozen_string_literal: true
 
-require 'wifimap/mac'
-require 'wifimap/station'
-require 'wifimap/access_point'
-
 module Wifimap
   module Parser
     # Parse the content of an airodump.csv file.
     class Airodump
+      include Wifimap::Parsable
+
       def initialize(dump)
         @dump = dump
       end
 
       # Get the list of access points from the dump.
+      #
+      # @return [Array] of Wifimap::AccessPoint
       def access_points
-        aps = @dump.split("\n").filter do |row|
-          fields = row.split(',')
-          channel = fields[3].to_i
-          Mac.valid?(fields.first) && channel.between?(1, 16)
-        end
-
-        aps.map do |ap|
-          fields = ap.split(',')
-          AccessPoint.new(
-            bssid: fields.first,
-            privacy: fields[5].strip,
-            essid: fields[13].strip
-          )
-        end
+        dump_row_fields
+          .filter { |row| valid_access_point?(row) }
+          .map do |fields|
+            AccessPoint.new(
+              bssid: fields.first,
+              privacy: fields[5].strip,
+              essid: fields[13].strip
+            )
+          end
       end
 
       # Get the list of stations from the dump.
+      #
+      # @return [Array] of Wifimap::Station
       def stations
-        stations = @dump.split("\n").filter do |row|
-          fields = row.split(',')
-          power = fields[3].to_i
-          Mac.valid?(fields.first) && power.negative?
-        end
-
-        stations.map do |row|
-          fields = row.split(',')
-          station = Station.new(mac: fields.first)
-          unless fields[5].include?('(not associated)')
-            station.associations << fields[5].strip
+        dump_row_fields
+          .filter { |row| valid_station?(row) }
+          .map do |fields|
+            station = Station.new(mac: fields.first)
+            station.associations << fields[5].strip unless fields[5].include?('(not associated)')
+            station.probes << fields[6].strip unless fields[6].strip.empty?
+            station
           end
+      end
+
+      # Get an array of all dump rows split by comma.
+      #
+      # @return [Array]
+      private def dump_row_fields
+        dump_rows.each.map { |row| row.split(',') }
+      end
 
-          station.probes << fields[6].strip unless fields[6].strip.empty?
+      # Check if the fields correspond to a valid access point.
+      #
+      # @param [Array] fields
+      # @return [Boolean]
+      private def valid_access_point?(fields)
+        channel = fields[3].to_i
+        Mac.valid?(fields.first) && channel.between?(1, 16)
+      end
 
-          station
-        end
+      # Check if the fields correspond to a valid access station.
+      #
+      # @param [Array] fields
+      # @return [Boolean]
+      private def valid_station?(fields)
+        power = fields[3].to_i
+        Mac.valid?(fields.first) && power.negative?
       end
     end
   end

data/lib/wifimap/parser/sniff_probes.rb

@@ -1,23 +1,26 @@
 # frozen_string_literal: true
 
-require 'wifimap/station'
-
 module Wifimap
   module Parser
     # Parse the content of a sniff-probes file.
     class SniffProbes
+      include Wifimap::Parsable
+
       attr_reader :access_points
 
+      # @param [String] dump
       def initialize(dump)
         @dump = dump
         @access_points = []
       end
 
       # Get the list of stations from the dump.
+      #
+      # @return [Array] of Wifimap::Station
       def stations
         unique_macs.map do |mac|
           station = Station.new(mac: mac)
-          rows.each do |row|
+          dump_rows.each do |row|
             fields = row.split('"')
             unless station.probes.include?(fields[1])
               station.probes << fields[1] if fields[0].include?(mac)
@@ -27,16 +30,11 @@ module Wifimap
         end
       end
 
-      private
-
-      # Return an array of lines from the dump content.
-      def rows
-        @dump.split("\n")
-      end
-
       # Return all unique mac addresses.
-      def unique_macs
-        rows.map { |row| row.split[2] }.uniq
+      #
+      # @return [Array]
+      private def unique_macs
+        dump_rows.map { |row| row.split[2] }.uniq
       end
     end
   end

data/lib/wifimap/parser_factory.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Wifimap
+  # Instantiate the correct parser class according to the dump format.
+  module ParserFactory
+    class << self
+      # Instantiate the parser factory or raise an error
+      # if the dump is not supported.
+      def create(file_content)
+        case dump_format(file_content)
+        when :airodump
+          Wifimap::Parser::Airodump.new(file_content)
+        when :sniff_probes
+          Wifimap::Parser::SniffProbes.new(file_content)
+        else
+          raise Error, 'Unsupported dump format'
+        end
+      end
+
+      # Check the file content and identify the correct dump format.
+      #
+      # @param [String] file_content
+      # @return [Symbol|Nil]
+      def dump_format(file_content)
+        return :airodump if airodump_format?(file_content)
+        return :sniff_probes if sniff_probes_format?(file_content)
+      end
+
+      # @param [String] file_content
+      # @return [Boolean]
+      private def airodump_format?(file_content)
+        airodump_header = 'BSSID, First time seen, Last time seen, channel, Speed, Privacy, Cipher, Authentication, Power'
+        file_content.include?(airodump_header)
+      end
+
+      # @param [String] file_content
+      # @return [Boolean]
+      private def sniff_probes_format?(file_content)
+        file_content.split("\n").all? do |row|
+          fields = row.split
+          fields[1].include?('dBm') && Wifimap::Mac.valid?(fields[2])
+        end
+      end
+    end
+  end
+end

data/lib/wifimap/station.rb

@@ -5,6 +5,7 @@ module Wifimap
     attr_reader :mac
     attr_accessor :associations, :probes
 
+    # @param [String] mac
     def initialize(mac:)
       @mac = mac
       @associations = []
@@ -12,6 +13,8 @@ module Wifimap
     end
 
     # Get the device manufacturer based on the mac.
+    #
+    # @return [String]
     def manufacturer
       Mac.manufacturer(mac)
     end

data/lib/wifimap/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Wifimap
-  VERSION = "0.2.1"
+  VERSION = '0.2.2'
 end

data/wifimap.gemspec

@@ -6,7 +6,6 @@ Gem::Specification.new do |spec|
   spec.name          = 'wifimap'
   spec.version       = Wifimap::VERSION
   spec.authors       = ['Gianpiero Addis']
-  spec.email         = ['gianpiero.addis@gmail.com']
 
   spec.summary       = 'Parse wifi sniffer dump files.'
   spec.homepage      = 'https://github.com/gpaddis/wifimap'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wifimap
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Gianpiero Addis
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-04-18 00:00:00.000000000 Z
+date: 2020-06-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: louis
@@ -25,8 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 description: 
-email:
-- gianpiero.addis@gmail.com
+email: 
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -35,9 +34,9 @@ files:
 - ".rspec"
 - ".travis.yml"
 - CHANGELOG.md
-- CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
+- Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -46,9 +45,10 @@ files:
 - lib/wifimap.rb
 - lib/wifimap/access_point.rb
 - lib/wifimap/mac.rb
-- lib/wifimap/parser.rb
+- lib/wifimap/parsable.rb
 - lib/wifimap/parser/airodump.rb
 - lib/wifimap/parser/sniff_probes.rb
+- lib/wifimap/parser_factory.rb
 - lib/wifimap/station.rb
 - lib/wifimap/version.rb
 - wifimap.gemspec

data/CODE_OF_CONDUCT.md

@@ -1,74 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-In the interest of fostering an open and welcoming environment, we as
-contributors and maintainers pledge to making participation in our project and
-our community a harassment-free experience for everyone, regardless of age, body
-size, disability, ethnicity, gender identity and expression, level of experience,
-nationality, personal appearance, race, religion, or sexual identity and
-orientation.
-
-## Our Standards
-
-Examples of behavior that contributes to creating a positive environment
-include:
-
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
-
-Examples of unacceptable behavior by participants include:
-
-* The use of sexualized language or imagery and unwelcome sexual attention or
-advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic
-  address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Our Responsibilities
-
-Project maintainers are responsible for clarifying the standards of acceptable
-behavior and are expected to take appropriate and fair corrective action in
-response to any instances of unacceptable behavior.
-
-Project maintainers have the right and responsibility to remove, edit, or
-reject comments, commits, code, wiki edits, issues, and other contributions
-that are not aligned to this Code of Conduct, or to ban temporarily or
-permanently any contributor for other behaviors that they deem inappropriate,
-threatening, offensive, or harmful.
-
-## Scope
-
-This Code of Conduct applies both within project spaces and in public spaces
-when an individual is representing the project or its community. Examples of
-representing a project or community include using an official project e-mail
-address, posting via an official social media account, or acting as an appointed
-representative at an online or offline event. Representation of a project may be
-further defined and clarified by project maintainers.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at gianpiero.addis@gmail.com. All
-complaints will be reviewed and investigated and will result in a response that
-is deemed necessary and appropriate to the circumstances. The project team is
-obligated to maintain confidentiality with regard to the reporter of an incident.
-Further details of specific enforcement policies may be posted separately.
-
-Project maintainers who do not follow or enforce the Code of Conduct in good
-faith may face temporary or permanent repercussions as determined by other
-members of the project's leadership.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
-available at [https://contributor-covenant.org/version/1/4][version]
-
-[homepage]: https://contributor-covenant.org
-[version]: https://contributor-covenant.org/version/1/4/

data/lib/wifimap/parser.rb

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-
-require 'wifimap/mac'
-
-module Wifimap
-  module Parser
-    # Check the file content and identify the correct dump format.
-    def self.dump_format(file_content)
-      return :airodump if airodump_format?(file_content)
-      return :sniff_probes if sniff_probes_format?(file_content)
-    end
-
-    class << self
-      private
-
-      def airodump_format?(file_content)
-        airodump_header = 'BSSID, First time seen, Last time seen, channel, Speed, Privacy, Cipher, Authentication, Power'
-        file_content.include?(airodump_header)
-      end
-
-      def sniff_probes_format?(file_content)
-        file_content.split("\n").all? do |row|
-          fields = row.split
-          fields[1].include?('dBm') && Wifimap::Mac.valid?(fields[2])
-        end
-      end
-    end
-  end
-end