lan_scanner 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3b03b665db6f858b32fd78d0fa4349ddb272493f86ee947c03ffa6540ee4f950
+  data.tar.gz: 719c9f103d2b88365308fd5cea1a67156ba822f34e3ab82f2193d9e86a85b23c
+SHA512:
+  metadata.gz: ff053ab65a6ea8c93586ff9adb74cc0293bca5caf0415074e6a4ae70cb3340a717d0759836515f71e21b39be125d355859dced101d16c4295f2e31b36869167d
+  data.tar.gz: 3bcf333729f6b09ce19daa4731c86981bb29f741c0d358e83a2f04ea73f7e434247039eb0f7027678d2320b1b8add626d94f45bc34153c22b264d37e9b2e72f0

data/.gitignore

@@ -0,0 +1,19 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.vscode/
+/.idea/
+*.gem
+
+# rspec failure tracking
+.rspec_status
+
+
+/playground
+/playground.rb

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# 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 lan_scanner.gemspec@mail.magynhard.de. 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 [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in lan_scanner.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Matthäus J. N. Beyrle
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,95 @@
+# lan_scanner
+[![Gem](https://img.shields.io/gem/v/lan_scanner?color=default&style=plastic&logo=ruby&logoColor=red)](https://rubygems.org/gems/lan_scanner)
+![downloads](https://img.shields.io/gem/dt/lan_scanner?color=blue&style=plastic)
+[![License: MIT](https://img.shields.io/badge/License-MIT-gold.svg?style=plastic&logo=mit)](LICENSE)
+
+> The very basic ruby gem to scan your LAN for devices
+
+Based on nmap.
+
+# Contents
+
+* [Usage](#usage)
+* [Installation](#installation)
+* [Documentation](#documentation)
+* [Contributing](#contributing)
+
+
+
+
+<a name="usage"></a>
+## Usage
+
+### Find devices in LAN
+```ruby
+require 'lan_scanner'
+
+# examples with explicit default parameters
+devices = LanScanner.scan_devices network: '192.168.178.0/24'
+# => [LanScanner::Device, LanScanner::Device, ...]
+
+devices.each do |d|
+  puts "=================================================="
+  puts "Found device on #{d.remote_address}"
+  puts
+  puts "Hostname: #{d.host_name}"
+  puts
+  # =================================================="
+  # Found device on 192.168.178.20
+  # 
+  # Hostname: Windows-PC
+  # 
+end
+
+```
+
+
+<a name="installation"></a>
+## Installation
+
+### NMAP
+
+This gem is based on nmap. So you need to [install nmap](https://nmap.org/download.html) before and ensure it is available via command line (added to PATH environment variable).
+
+To check if you have installed nmap correctly, run the following command on a terminal
+
+```
+nmap --version
+```
+
+and you should get some version information. After, you are ready to install the ruby gem.
+
+### Gem
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'lan_scanner'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself by:
+
+    $ gem install lan_scanner
+
+
+
+
+  
+<a name="documentation"></a>    
+## Documentation
+Check out the doc at RubyDoc
+<a href="https://www.rubydoc.info/gems/lan_scanner">https://www.rubydoc.info/gems/lan_scanner</a>
+
+
+
+
+
+<a name="contributing"></a>    
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/magynhard/lan_scanner. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+

data/Rakefile

@@ -0,0 +1,15 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+#
+# run default task to see tasks to build and publish gem
+#
+task :default do
+  system 'rake --tasks'
+end
+
+task :test do
+  system 'rspec'
+end
+
+RSpec::Core::RakeTask.new(:spec)

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "lucky_case"
+
+# 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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lan_sacnner.gemspec

@@ -0,0 +1,41 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'lan_scanner/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "lan_scanner"
+  spec.version       = LanScanner::VERSION
+  spec.authors       = ["Matthäus J. N. Beyrle"]
+  spec.email         = ["lan_scanner.gemspec@mail.magynhard.de"]
+
+  spec.summary       = %q{The ruby gem to scan your LAN for devices}
+  spec.homepage      = "https://github.com/magynhard/lan_scanner"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = '>= 2.3'
+
+  spec.add_runtime_dependency     'tty-which',  '~> 0.5'
+  spec.add_runtime_dependency     'tmpdir',     '~> 0.1.3'
+  spec.add_runtime_dependency     'nokogiri',   '~> 1.15'
+
+  spec.add_development_dependency 'bundler',    '~> 2.0'
+  spec.add_development_dependency 'rake',       '>= 10.0'
+  spec.add_development_dependency 'rspec',      '>= 3.0'
+end

data/lib/custom_errors/custom_error.rb

@@ -0,0 +1,2 @@
+class CustomError < StandardError
+end

data/lib/lan_scanner/device.rb

@@ -0,0 +1,13 @@
+module LanScanner
+
+  class Device
+    attr_reader :host_name
+    attr_reader :remote_address
+
+    def initialize(remote_address:, host_name: nil)
+      @host_name = host_name
+      @remote_address = remote_address
+    end
+  end
+
+end

data/lib/lan_scanner/version.rb

@@ -0,0 +1,3 @@
+module LanScanner
+  VERSION = '0.0.1'.freeze
+end

data/lib/lan_scanner.rb

@@ -0,0 +1,76 @@
+
+require 'socket'
+require 'ostruct'
+require 'tty-which'
+require 'tmpdir'
+require 'nokogiri'
+
+
+require_relative 'lan_scanner/device'
+require_relative 'lan_scanner/version'
+
+module LanScanner
+
+  # @return [Array<LanScanner::Device>] list of devices
+  def self.scan_devices(network: nil)
+    _ensure_nmap_available
+    if network.nil?
+      network = my_networks
+    end
+    network = [network] unless network.is_a? Array
+    xml_results = []
+    tmp_file = "#{Dir.tmpdir}/nmap_scan.xml"
+    network.each do |n|
+      ['-sL','-sn'].each do |nmap_type|
+        `nmap #{nmap_type} #{n} -oX "#{tmp_file}"`
+        xml_results.push File.read tmp_file
+        File.delete tmp_file
+      end
+    end
+    _parse_nmap_xml xml_results
+  end
+
+  def self.my_networks
+    my_ip_addresses.map do |a|
+      if a.include?('.')
+        a.split('.')[0..2].join('.') + '.0/24'
+      else
+        raise "No support for IPv6 devices"
+      end
+    end
+  end
+
+  def self.my_ip_addresses
+    Socket.ip_address_list.select { |ai| ai.ipv4? && !ai.ipv4_loopback? }.map(&:ip_address).uniq
+  end
+
+  private
+
+  def self._ensure_nmap_available
+    unless TTY::Which.exist?("nmap")
+      raise "Command 'nmap' not available. Ensure nmap is installed and added to your PATH variable. https://nmap.org'"
+    end
+  end
+
+  def self._parse_nmap_xml(xml_contents)
+    results = {} # use special hash to avoid duplicates easier
+    xml_contents.each do |xml_data|
+      xml_obj = Nokogiri::XML(xml_data)
+      xml_obj.xpath('//nmaprun/host').each do |host|
+        remote_address = host.at('address')['addr']
+        host_name = host.at('hostnames/hostname')&.[]('name')
+        state = host.at('status')&.[]('state')
+        if !results.key?(remote_address) || (results.key?(remote_address) && host_name || state == 'up')
+          old_host_name = results[remote_address]&.host_name
+          results[remote_address] = OpenStruct.new(remote_address: remote_address, host_name: host_name || old_host_name, state: state)
+        end
+      end
+    end
+    puts
+    results.values.select do |r|
+      r.state == 'up' || r.host_name
+    end.map do |r|
+      LanScanner::Device.new host_name: r.host_name, remote_address: r.remote_address
+    end
+  end
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: lan_scanner
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Matthäus J. N. Beyrle
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-10-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: tty-which
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: tmpdir
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.3
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description:
+email:
+- lan_scanner.gemspec@mail.magynhard.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lan_sacnner.gemspec
+- lib/custom_errors/custom_error.rb
+- lib/lan_scanner.rb
+- lib/lan_scanner/device.rb
+- lib/lan_scanner/version.rb
+homepage: https://github.com/magynhard/lan_scanner
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: The ruby gem to scan your LAN for devices
+test_files: []