netchk 0.0.1.beta → 0.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4af327a7ff918c38cb651ae7dbd06e6ce031e8f09f8f389972ecb2fa60caacfa
-  data.tar.gz: 54c330ab7509d734e4814ae8621324ba663f5014f868a35138f4768447be9f44
+  metadata.gz: 5079145cee4710e0517016a89fcc1a8a94003578621d78735b9afcf326619aaa
+  data.tar.gz: 2d6e638cc1487e033d3339927f3aa3dcf930f9b33f54ac07544aff14f38808aa
 SHA512:
-  metadata.gz: c8e950c0eec0ee1c76378bcccda3c234f9e5f0288a94ad4aeabcc64a3e24f6e3f5f23a966d387f63086545e47552d892cafe9cc9477de5c2b0b0053e3e06a233
-  data.tar.gz: 6f301bf1526f13a0263624bbe33c3b65d3aa045adcceff2ff45bef2dc3a1bd41066ecf257b9332bc4e1da26099d4742359de4ef2bb3f143a08278c79430b52f2
+  metadata.gz: 3d7c8588a927c08e854bde76ece5f05b7a33a39addbd4022ce7f1ae2f2ccaf483417a7a825ab53da2e919451cd70f8de74fc303494561d212926aabda810faa3
+  data.tar.gz: 47a7c0624cd73a6bbab35811d49c7cfae60f0f90139bd045f6ca35aff7088bb7e396758a737be2ee99d0a0a6329e434c310653aca6d402587ee91a8692237986

data/.gitignore

@@ -6,3 +6,6 @@
 /pkg/
 /spec/reports/
 /tmp/
+.idea
+vendor
+*.gem

data/.rubocop.yml

@@ -0,0 +1,200 @@
+require:
+  - rubocop-performance
+
+AllCops:
+  TargetRubyVersion: 2.7
+  DisabledByDefault: true
+  Exclude:
+    - '**/vendor/**/*'
+    - 'db/schema.rb'
+    - 'bin/**'
+    - 'docs/**/*'
+
+Bundler/DuplicatedGem:
+  Enabled: true
+
+Bundler/InsecureProtocolSource:
+  Enabled: true
+
+Bundler/OrderedGems:
+  Enabled: true
+
+# Prefer &&/|| over and/or.
+Style/AndOr:
+  Enabled: true
+
+# Align `when` with `case`.
+Layout/CaseIndentation:
+  Enabled: true
+
+# Align comments with method definitions.
+Layout/CommentIndentation:
+  Enabled: true
+
+# No extra empty lines.
+Layout/EmptyLines:
+  Enabled: true
+
+# In a regular class definition, no empty lines around the body.
+Layout/EmptyLinesAroundClassBody:
+  Enabled: true
+
+# In a regular method definition, no empty lines around the body.
+Layout/EmptyLinesAroundMethodBody:
+  Enabled: true
+
+# In a regular module definition, no empty lines around the body.
+Layout/EmptyLinesAroundModuleBody:
+  Enabled: true
+
+# Use Ruby >= 1.9 syntax for hashes. Prefer { a: :b } over { :a => :b }.
+Style/HashSyntax:
+  Enabled: true
+
+# Method definitions after `private` or `protected` isolated calls need one
+# extra level of indentation.
+Layout/IndentationConsistency:
+  Enabled: true
+  EnforcedStyle: indented_internal_methods
+
+# Two spaces, no tabs (for indentation).
+Layout/IndentationWidth:
+  Enabled: true
+
+Layout/SpaceAfterColon:
+  Enabled: true
+
+Layout/SpaceAfterComma:
+  Enabled: true
+
+Layout/SpaceAroundEqualsInParameterDefault:
+  Enabled: true
+
+Layout/SpaceAroundKeyword:
+  Enabled: true
+
+Layout/SpaceAroundOperators:
+  Enabled: true
+
+Layout/SpaceBeforeFirstArg:
+    Enabled: true
+
+# Defining a method with parameters needs parentheses.
+Style/MethodDefParentheses:
+  Enabled: true
+
+# Use `foo {}` not `foo{}`.
+Layout/SpaceBeforeBlockBraces:
+  Enabled: true
+
+# Use `foo { bar }` not `foo {bar}`.
+Layout/SpaceInsideBlockBraces:
+  Enabled: true
+
+# Use `{ a: 1 }` not `{a:1}`.
+Layout/SpaceInsideHashLiteralBraces:
+  Enabled: true
+
+Layout/SpaceInsideParens:
+  Enabled: true
+
+Style/FrozenStringLiteralComment:
+  Enabled: true
+
+# Check quotes usage according to lint rule below.
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: single_quotes
+
+# Detect hard tabs, no hard tabs.
+Layout/IndentationStyle:
+  Enabled: true
+
+# Blank lines should not have any spaces.
+Layout/TrailingEmptyLines:
+  Enabled: true
+
+# No trailing whitespace.
+Layout/TrailingWhitespace:
+  Enabled: true
+
+# Use quotes for string literals when they are enough.
+Style/RedundantPercentQ:
+  Enabled: true
+
+# Use my_method(my_arg) not my_method( my_arg ) or my_method my_arg.
+Lint/RequireParentheses:
+  Enabled: true
+
+Performance/Casecmp:
+  Enabled: true
+
+Performance/ChainArrayAllocation:
+  Enabled: true
+
+Performance/CompareWithBlock:
+  Enabled: true
+
+Performance/Count:
+  Enabled: true
+
+Performance/Detect:
+  Enabled: true
+
+Performance/DoubleStartEndWith:
+  Enabled: true
+
+Performance/EndWith:
+  Enabled: true
+
+Performance/FixedSize:
+  Enabled: true
+
+Performance/InefficientHashSearch:
+  Enabled: true
+
+Performance/OpenStruct:
+  Enabled: true
+
+Performance/RedundantBlockCall:
+  Enabled: true
+
+Performance/RedundantMatch:
+  Enabled: true
+
+Performance/RedundantMerge:
+  Enabled: true
+
+Performance/RegexpMatch:
+  Enabled: true
+
+Performance/ReverseEach:
+  Enabled: true
+
+Performance/StartWith:
+  Enabled: true
+
+Performance/StringReplacement:
+  Enabled: true
+
+Performance/TimesMap:
+  Enabled: true
+
+Performance/UriDefaultParser:
+  Enabled: true
+
+Security/Eval:
+  Enabled: true
+
+Security/JSONLoad:
+  Enabled: true
+
+Security/MarshalLoad:
+  Enabled: true
+
+Security/Open:
+  Enabled: true
+
+Security/YAMLLoad:
+  Enabled: true
+

data/Gemfile

@@ -1,3 +1,4 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
+source 'https://rubygems.org'
 
 gemspec

data/Gemfile.lock

@@ -0,0 +1,44 @@
+PATH
+  remote: .
+  specs:
+    netchk (0.0.1)
+      net-ping (~> 2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.1)
+    net-ping (2.0.8)
+    parallel (1.19.2)
+    parser (2.7.1.4)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    regexp_parser (1.7.1)
+    rexml (3.2.4)
+    rubocop (0.86.0)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.7)
+      rexml
+      rubocop-ast (>= 0.0.3, < 1.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.1.0)
+      parser (>= 2.7.0.1)
+    rubocop-performance (1.6.1)
+      rubocop (>= 0.71.0)
+    ruby-progressbar (1.10.1)
+    unicode-display_width (1.7.0)
+
+PLATFORMS
+  ruby
+  x86_64-darwin-19
+
+DEPENDENCIES
+  netchk!
+  rubocop
+  rubocop-performance
+
+BUNDLED WITH
+   2.1.2

data/LICENSE.txt

@@ -1,21 +1,13 @@
-The MIT License (MIT)
+        DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
+                    Version 2, December 2004
 
-Copyright (c) 2020 Moray Baruh
+ Copyright (C) 2004 Sam Hocevar <sam@hocevar.net>
 
-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:
+ Everyone is permitted to copy and distribute verbatim or modified
+ copies of this license document, and changing it is allowed as long
+ as the name is changed.
 
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
+            DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
+   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
 
-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.
+  0. You just DO WHAT THE FUCK YOU WANT TO.

data/README.md

@@ -1,40 +1,68 @@
 # Netchk
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/netchk`. To experiment with that code, run `bin/console` for an interactive prompt.
+Simple tool to troubleshoot internet connectivity issues. This tool verifies:
 
-TODO: Delete this and the text above, and describe your gem
+- your computer has at least one IP address
+- you have at least one DNS configured
+- you can reach the configured nameservers
+- the nameservers can resolve hosts
 
-## Installation
+Finally, some ICMP ping statistics are presented with average durations and error rates. 
 
-Add this line to your application's Gemfile:
+## Installation
 
-```ruby
-gem 'netchk'
+```sh
+gem install netchk
 ```
 
-And then execute:
-
-    $ bundle install
-
-Or install it yourself as:
-
-    $ gem install netchk
-
 ## Usage
 
-TODO: Write usage instructions here
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+Just run `netchk` from your terminal and basic diagnosis will start showing you progress and
+any error if present.
+
+Note: On Linux system, this gem requires `sudo` to perform the ICMP ping operations. On macOS, this is not needed.
+
+You also can configure how netchk verifies your connections by configuring a `~/.netchk.yaml` or `~/.netchk.yml` file
+like below.
+
+```yaml
+# Settings to test DNS server connectivity.
+dns:
+  # Path to resolv.conf file to check presence and connectivity of DNS.
+  # Path should be absolute to avoid issues when running netchk
+  # from different directories.
+  resolv.conf: /etc/resolv.conf
+
+# Settings to test DNS resolution.
+resolv:
+  # Path to resolv.conf file to use for testing DNS resolution.
+  # Path should be absolute to avoid issues when running netchk
+  # from different directories. It is advised to be the same
+  # as dns.resolv.conf.
+  resolv.conf: /etc/resolv.conf
+  # The list of domains to test for DNS resolution.
+  domains:
+    - google.com
+    - youtube.com
+    - facebook.com 
+
+# Settings to test icmp ping.
+icmp:
+  # A list of hosts to ping with ICMP. It is advised to use
+  # IP addresses instead of domains to rule out any issues with
+  # DNS resolution, which is tested separately.
+  hosts:
+    - 1.1.1.1
+    - 8.8.8.8
+  # The number of ping to issue each host.
+  count: 20
+  # The duration in seconds to wait between each ping.
+  # Setting this value too low might cause timeouts.
+  interval: 0.2
+```     
+
+Each value is optional. If one is missing the default value will be used. The file above shows the default values.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/netchk.
-
-
-## License
-
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+Bug reports and pull requests are welcome on GitHub at https://github.com/moray95/netchk.

data/Rakefile

@@ -1,10 +1,11 @@
-require "bundler/gem_tasks"
-require "rake/testtask"
+# frozen_string_literal: true
+require 'bundler/gem_tasks'
+require 'rake/testtask'
 
 Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
-  t.libs << "lib"
-  t.test_files = FileList["test/**/*_test.rb"]
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
 end
 
-task :default => :test
+task default: :test

data/bin/netchk

@@ -4,9 +4,20 @@ require "netchk"
 require 'netchk/ip_verifier'
 require 'netchk/dns_server_verifier'
 require 'netchk/dns_resolv_verifier'
-require 'netchk/tcp_ping_verifier'
+require 'netchk/icmp_ping_verifier'
+require 'yaml'
+
+config_files = %w[.netchk.yaml .netchk.yml].map { |f| File.join(Dir.home, f) }
+
+config_file = config_files.find(&File.method(:exists?))
+
+config = config_file
+           &.then(&File.method(:read))
+           &.then(&YAML.method(:load))
+
+config = config || {}
 
 Netchk::IpVerifier.new.verify
-Netchk::DNSServerVerifier.new.verify
-Netchk::DNSResolvVerifier.new.verify
-Netchk::TcpPingVerifier.new.verify
+Netchk::DNSServerVerifier.new(**(config['dns'] || {})).verify
+Netchk::DNSResolvVerifier.new(**(config['resolv'] || {})).verify
+Netchk::ICMPPingVerifier.new(**(config['icmp'] || {})).verify

data/lib/netchk.rb

@@ -1,4 +1,5 @@
-require "netchk/version"
+# frozen_string_literal: true
+require 'netchk/version'
 
 module Netchk
 end

data/lib/netchk/dns_resolv_verifier.rb

@@ -1,12 +1,13 @@
 # frozen_string_literal: true
 module Netchk
   class DNSResolvVerifier
-    def initialize
-      @domains = %w[google.com facebook.com]
+    def initialize(**options)
+      @domains = options['domains'] || %w[google.com youtube.com facebook.com]
+      @resolv_conf = options['resolv.conf']
     end
 
     def verify
-      ::Resolv::DNS.open do |dns|
+      ::Resolv::DNS.open(@resolv_conf) do |dns|
         @domains.each do |domain|
           begin
             dns.getaddress(domain)

data/lib/netchk/dns_server_verifier.rb

@@ -5,10 +5,14 @@ require 'net/ping/tcp'
 
 module Netchk
   class DNSServerVerifier
+    def initialize(**options)
+      @resolve_conf = options['resolv.conf']
+    end
+
     def verify
       nameservers = self.nameservers
       if nameservers.empty?
-        $stderr.puts "No DNS server found. Verify your configuration."
+        $stderr.puts 'No DNS server found. Verify your configuration.'
       else
         puts "Using DNS servers #{nameservers.map { |ns| ns.join('#') }.join(', ')}"
         nameservers.map do |ns|
@@ -17,21 +21,20 @@ module Netchk
       end
     end
 
-
     private
       def verify_nameserver(ip, port)
         ping = Net::Ping::TCP.new(ip, port)
         unless ping.ping?
-          $stderr.puts "Failed to ping DNS server #{ip}:#{port}"
+          $stderr.puts "Failed to ping DNS server #{ip}##{port}"
         end
       end
 
       def nameservers
         # Dirty trick to get default nameserver list from /etc/resolv.conf
         # without parsing the file manually.
-        ::Resolv::DNS.open do |dns|
+        ::Resolv::DNS.open(@resolve_conf) do |dns|
           dns.lazy_initialize
-          dns.instance_variable_get("@config").instance_variable_get("@nameserver_port")
+          dns.instance_variable_get('@config').instance_variable_get('@nameserver_port')
         end
       end
   end

data/lib/netchk/icmp.rb

@@ -1,3 +1,4 @@
+# rubocop:disable  Style/FrozenStringLiteralComment:
 require 'net/ping/ping'
 
 if File::ALT_SEPARATOR
@@ -6,8 +7,9 @@ end
 
 # The Net module serves as a namespace only.
 module Netchk
-
-  # The Net::Ping::ICMP class encapsulates an icmp ping.
+  # Modified version of Net::Ping::ICMP that does
+  # not check for root privileges and uses a DGRAM
+  # socket instead of a raw socket.
   class ICMP < ::Net::Ping
     ICMP_ECHOREPLY = 0 # Echo reply
     ICMP_ECHO      = 8 # Echo request
@@ -24,23 +26,15 @@ module Netchk
     attr_reader :data_size
 
     # Creates and returns a new Ping::ICMP object.  This is similar to its
-    # superclass constructor, but must be created with root privileges (on
-    # UNIX systems), and the port value is ignored.
-    #
-    def initialize(host=nil, port=nil, timeout=5)
-      if File::ALT_SEPARATOR
-        unless Win32::Security.elevated_security?
-          raise 'requires elevated security'
-        end
-      end
-
+    # superclass constructor, and the port value is ignored.
+    def initialize(host = nil, port = nil, timeout = 5)
       @seq = 0
       @bind_port = 0
       @bind_host = nil
       @data_size = 56
       @data = ''
 
-      0.upto(@data_size){ |n| @data << (n % 256).chr }
+      0.upto(@data_size) { |n| @data << (n % 256).chr }
 
       @ping_id = (Thread.current.object_id ^ Process.pid) & 0xffff
 
@@ -53,7 +47,7 @@ module Netchk
     def data_size=(size)
       @data_size = size
       @data = ''
-      0.upto(size){ |n| @data << (n % 256).chr }
+      0.upto(size) { |n| @data << (n % 256).chr }
     end
 
     # Associates the local end of the socket connection with the given
@@ -105,7 +99,7 @@ module Netchk
       socket.send(msg, 0, saddr) # Send the message
 
       begin
-        Timeout.timeout(@timeout){
+        Timeout.timeout(@timeout) {
           while true
             io_array = select([socket], nil, nil, timeout)
 
@@ -149,24 +143,24 @@ module Netchk
 
     private
 
-    # Perform a checksum on the message.  This is the sum of all the short
-    # words and it folds the high order bits into the low order bits.
-    #
-    def checksum(msg)
-      length    = msg.length
-      num_short = length / 2
-      check     = 0
+      # Perform a checksum on the message.  This is the sum of all the short
+      # words and it folds the high order bits into the low order bits.
+      #
+      def checksum(msg)
+        length    = msg.length
+        num_short = length / 2
+        check     = 0
 
-      msg.unpack("n#{num_short}").each do |short|
-        check += short
-      end
+        msg.unpack("n#{num_short}").each do |short|
+          check += short
+        end
 
-      if length % 2 > 0
-        check += msg[length-1, 1].unpack('C').first << 8
-      end
+        if length % 2 > 0
+          check += msg[length - 1, 1].unpack('C').first << 8
+        end
 
-      check = (check >> 16) + (check & 0xffff)
-      return (~((check >> 16) + check) & 0xffff)
-    end
+        check = (check >> 16) + (check & 0xffff)
+        return (~((check >> 16) + check) & 0xffff)
+      end
   end
 end

data/lib/netchk/{tcp_ping_verifier.rb → icmp_ping_verifier.rb}

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 require_relative 'icmp'
+require 'net/ping/icmp'
 
 class Array
   def avg
@@ -8,18 +9,18 @@ class Array
 end
 
 module Netchk
-  class TcpPingVerifier
-    def initialize
-      @hosts = %w[1.1.1.1 8.8.8.8]
-      @count = 20
-      @interval = 0.2
+  class ICMPPingVerifier
+    def initialize(**options)
+      @hosts = options['hosts'] || %w[1.1.1.1 8.8.8.8]
+      @count = options['count'] || 20
+      @interval = options['interval'] || 0.2
     end
 
     def verify
       stats = @hosts.map do |host|
         host_stats = ping(host, @count)
 
-        average = host_stats[:durations].empty? ? "N/A" : (host_stats[:durations].avg * 1000).round(2)
+        average = host_stats[:durations].empty? ? 'N/A' : (host_stats[:durations].avg * 1000).round(2)
         errors = host_stats[:failures].to_f / (host_stats[:failures] + host_stats[:durations].count) * 100
         puts "Stats for #{host} ping - average: #{average} ms, error rate: #{errors.round(2)}%"
 
@@ -27,9 +28,9 @@ module Netchk
       end.to_h
 
       all_durations = stats.values.flat_map { |host_stats| host_stats[:durations] }
-      overall_average = all_durations.empty? ? "N/A" : (all_durations.avg * 1000).round(2)
+      overall_average = all_durations.empty? ? 'N/A' : (all_durations.avg * 1000).round(2)
       overall_errors = stats.values.flat_map { |host_stats| host_stats[:failures].to_f / host_stats[:count] * 100 }.avg
-      puts "Overall stats for ping - average: #{overall_average} ms, errors: #{overall_errors.round(2)}%"
+      puts "Overall stats for ping - average: #{overall_average} ms, error rate: #{overall_errors.round(2)}%"
     end
 
     private
@@ -39,7 +40,9 @@ module Netchk
           failures: 0,
           count: count
         }
-        ping = ::Netchk::ICMP.new(host, nil, 1)
+
+        pingClass = /darwin/.match?(RUBY_PLATFORM) ? ::Netchk::ICMP : ::Net::Ping::ICMP
+        ping = pingClass.new(host, nil, 1)
 
         count.times do
           sleep @interval
@@ -55,4 +58,3 @@ module Netchk
       end
   end
 end
-

data/lib/netchk/ip_verifier.rb

@@ -6,12 +6,12 @@ module Netchk
     def verify
       socket = Socket.ip_address_list
       addresses = socket.reject(&:ipv4_loopback?)
-                    .reject(&:ipv6_loopback?)
-                    .filter(&:ipv4?)
-                    .map(&:inspect_sockaddr)
+      addresses.reject!(&:ipv6_loopback?)
+      addresses.filter!(&:ipv4?)
+      addresses.map!(&:inspect_sockaddr)
 
       if addresses.empty?
-        $stderr.puts "No IPv4 address found. Verify your connection to your router."
+        $stderr.puts 'No IPv4 address found. Verify your connection to your router.'
       else
         puts "Found IP addresses #{addresses.join(', ')}."
       end

data/lib/netchk/version.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Netchk
-  VERSION = "0.0.1.beta"
+  VERSION = '0.0.1'
 end

data/netchk.gemspec

@@ -1,35 +1,30 @@
+# frozen_string_literal: true
 require_relative 'lib/netchk/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "netchk"
+  spec.name          = 'netchk'
   spec.version       = Netchk::VERSION
-  spec.authors       = ["Moray Baruh"]
+  spec.authors       = ['Moray Baruh']
 
-  spec.summary       = "Simple internet troubleshooter."
-  spec.description   = <<~EOF
-    Find issues with your internet connection step by step. This script verifies:
-      - your computer has at least one IP assigned 
-      - has access to at least one DNS server
-      - the configured DNS servers are reachable
-      - the configured DNS server are able to resolve host names
-     
-    And finally, pings some hosts to show you average durations and error rates.
-  EOF
-  spec.homepage      = "https://moraybaruh.com"
-  spec.license       = "MIT"
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+  spec.summary       = 'Simple internet troubleshooter.'
+  spec.description   = File.read('README.md')
+  spec.homepage      = 'https://github.com/moray95/netchk'
+  spec.license       = 'WTFPL'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
 
-  # spec.metadata["homepage_uri"] = spec.homepage
-  # spec.metadata["source_code_uri"] = "https://moraybaruh.com"
-  # spec.metadata["changelog_uri"] = "https://moraybaruh.com"
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+  spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
-  spec.bindir        = "bin"
+  spec.bindir        = 'bin'
   spec.executables   = ['netchk']
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
   spec.add_dependency 'net-ping', '~> 2.0'
+
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'rubocop-performance'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: netchk
 version: !ruby/object:Gem::Version
-  version: 0.0.1.beta
+  version: 0.0.1
 platform: ruby
 authors:
 - Moray Baruh
@@ -24,11 +24,60 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
-description: "Find issues with your internet connection step by step. This script
-  verifies:\n  - your computer has at least one IP assigned \n  - has access to at
-  least one DNS server\n  - the configured DNS servers are reachable\n  - the configured
-  DNS server are able to resolve host names\n \nAnd finally, pings some hosts to show
-  you average durations and error rates.\n"
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: "# Netchk\n\nSimple tool to troubleshoot internet connectivity issues.
+  This tool verifies:\n\n- your computer has at least one IP address\n- you have at
+  least one DNS configured\n- you can reach the configured nameservers\n- the nameservers
+  can resolve hosts\n\nFinally, some ICMP ping statistics are presented with average
+  durations and error rates. \n\n## Installation\n\n```sh\ngem install netchk\n```\n\n##
+  Usage\n\nJust run `netchk` from your terminal and basic diagnosis will start showing
+  you progress and\nany error if present.\n\nNote: On Linux system, this gem requires
+  `sudo` to perform the ICMP ping operations. On macOS, this is not needed.\n\nYou
+  also can configure how netchk verifies your connections by configuring a `~/.netchk.yaml`
+  or `~/.netchk.yml` file\nlike below.\n\n```yaml\n# Settings to test DNS server connectivity.\ndns:\n
+  \ # Path to resolv.conf file to check presence and connectivity of DNS.\n  # Path
+  should be absolute to avoid issues when running netchk\n  # from different directories.\n
+  \ resolv.conf: /etc/resolv.conf\n\n# Settings to test DNS resolution.\nresolv:\n
+  \ # Path to resolv.conf file to use for testing DNS resolution.\n  # Path should
+  be absolute to avoid issues when running netchk\n  # from different directories.
+  It is advised to be the same\n  # as dns.resolv.conf.\n  resolv.conf: /etc/resolv.conf\n
+  \ # The list of domains to test for DNS resolution.\n  domains:\n    - google.com\n
+  \   - youtube.com\n    - facebook.com \n\n# Settings to test icmp ping.\nicmp:\n
+  \ # A list of hosts to ping with ICMP. It is advised to use\n  # IP addresses instead
+  of domains to rule out any issues with\n  # DNS resolution, which is tested separately.\n
+  \ hosts:\n    - 1.1.1.1\n    - 8.8.8.8\n  # The number of ping to issue each host.\n
+  \ count: 20\n  # The duration in seconds to wait between each ping.\n  # Setting
+  this value too low might cause timeouts.\n  interval: 0.2\n```     \n\nEach value
+  is optional. If one is missing the default value will be used. The file above shows
+  the default values.\n\n## Contributing\n\nBug reports and pull requests are welcome
+  on GitHub at https://github.com/moray95/netchk.\n"
 email:
 executables:
 - netchk
@@ -36,10 +85,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
-- ".idea/$CACHE_FILE$"
-- ".idea/workspace.xml"
-- ".travis.yml"
+- ".rubocop.yml"
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -50,15 +98,16 @@ files:
 - lib/netchk/dns_resolv_verifier.rb
 - lib/netchk/dns_server_verifier.rb
 - lib/netchk/icmp.rb
+- lib/netchk/icmp_ping_verifier.rb
 - lib/netchk/ip_verifier.rb
-- lib/netchk/tcp_ping.rb
-- lib/netchk/tcp_ping_verifier.rb
 - lib/netchk/version.rb
 - netchk.gemspec
-homepage: https://moraybaruh.com
+homepage: https://github.com/moray95/netchk
 licenses:
-- MIT
-metadata: {}
+- WTFPL
+metadata:
+  homepage_uri: https://github.com/moray95/netchk
+  source_code_uri: https://github.com/moray95/netchk
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -70,9 +119,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.1.2
 signing_key:

data/.idea/$CACHE_FILE$

@@ -1,6 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="NodePackageJsonFileManager">
-    <packageJsonPaths />
-  </component>
-</project>

data/.idea/workspace.xml

@@ -1,162 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="ChangeListManager">
-    <list default="true" id="2567b485-a0a4-477d-9983-3cf1b15b4c80" name="Default Changelist" comment="">
-      <change afterPath="$PROJECT_DIR$/.gitignore" afterDir="false" />
-      <change afterPath="$PROJECT_DIR$/.idea/$CACHE_FILE$" afterDir="false" />
-      <change afterPath="$PROJECT_DIR$/.idea/workspace.xml" afterDir="false" />
-      <change afterPath="$PROJECT_DIR$/.travis.yml" afterDir="false" />
-      <change afterPath="$PROJECT_DIR$/Gemfile" afterDir="false" />
-      <change afterPath="$PROJECT_DIR$/LICENSE.txt" afterDir="false" />
-      <change afterPath="$PROJECT_DIR$/README.md" afterDir="false" />
-      <change afterPath="$PROJECT_DIR$/Rakefile" afterDir="false" />
-      <change afterPath="$PROJECT_DIR$/bin/console" afterDir="false" />
-      <change afterPath="$PROJECT_DIR$/bin/netchk" afterDir="false" />
-      <change afterPath="$PROJECT_DIR$/bin/setup" afterDir="false" />
-      <change afterPath="$PROJECT_DIR$/lib/netchk.rb" afterDir="false" />
-      <change afterPath="$PROJECT_DIR$/lib/netchk/dns_resolv_verifier.rb" afterDir="false" />
-      <change afterPath="$PROJECT_DIR$/lib/netchk/dns_server_verifier.rb" afterDir="false" />
-      <change afterPath="$PROJECT_DIR$/lib/netchk/icmp.rb" afterDir="false" />
-      <change afterPath="$PROJECT_DIR$/lib/netchk/ip_verifier.rb" afterDir="false" />
-      <change afterPath="$PROJECT_DIR$/lib/netchk/tcp_ping.rb" afterDir="false" />
-      <change afterPath="$PROJECT_DIR$/lib/netchk/tcp_ping_verifier.rb" afterDir="false" />
-      <change afterPath="$PROJECT_DIR$/lib/netchk/version.rb" afterDir="false" />
-      <change afterPath="$PROJECT_DIR$/netchk.gemspec" afterDir="false" />
-      <change afterPath="$PROJECT_DIR$/test/netchk_test.rb" afterDir="false" />
-      <change afterPath="$PROJECT_DIR$/test/test_helper.rb" afterDir="false" />
-    </list>
-    <option name="SHOW_DIALOG" value="false" />
-    <option name="HIGHLIGHT_CONFLICTS" value="true" />
-    <option name="HIGHLIGHT_NON_ACTIVE_CHANGELIST" value="false" />
-    <option name="LAST_RESOLUTION" value="IGNORE" />
-  </component>
-  <component name="FileTemplateManagerImpl">
-    <option name="RECENT_TEMPLATES">
-      <list>
-        <option value="Ruby Class" />
-        <option value="Ruby File" />
-      </list>
-    </option>
-  </component>
-  <component name="Git.Settings">
-    <option name="RECENT_GIT_ROOT_PATH" value="$PROJECT_DIR$" />
-  </component>
-  <component name="ProjectId" id="1duf1zfYnsOoG9lsTWCRHRpTQmG" />
-  <component name="ProjectLevelVcsManager" settingsEditedManually="true" />
-  <component name="ProjectViewState">
-    <option name="hideEmptyMiddlePackages" value="true" />
-    <option name="showLibraryContents" value="true" />
-  </component>
-  <component name="PropertiesComponent">
-    <property name="RunOnceActivity.OpenProjectViewOnStart" value="true" />
-    <property name="RunOnceActivity.ShowReadmeOnStart" value="true" />
-    <property name="TERMINAL_CUSTOM_COMMANDS_GOT_IT" value="true" />
-    <property name="WebServerToolWindowFactoryState" value="false" />
-    <property name="nodejs_interpreter_path.stuck_in_default_project" value="undefined stuck path" />
-    <property name="nodejs_npm_path_reset_for_default_project" value="true" />
-    <property name="nodejs_package_manager_path" value="npm" />
-  </component>
-  <component name="RecentsManager">
-    <key name="MoveFile.RECENT_KEYS">
-      <recent name="$PROJECT_DIR$/bin" />
-    </key>
-  </component>
-  <component name="RunManager">
-    <configuration name="netchk" type="RubyRunConfigurationType" factoryName="Ruby" temporary="true">
-      <module name="netchk" />
-      <RUBY_RUN_CONFIG NAME="RUBY_ARGS" VALUE="-I lib" />
-      <RUBY_RUN_CONFIG NAME="WORK DIR" VALUE="$MODULE_DIR$" />
-      <RUBY_RUN_CONFIG NAME="SHOULD_USE_SDK" VALUE="true" />
-      <RUBY_RUN_CONFIG NAME="ALTERN_SDK_NAME" VALUE="ruby-2.7.1-p83" />
-      <RUBY_RUN_CONFIG NAME="myPassParentEnvs" VALUE="true" />
-      <EXTENSION ID="BundlerRunConfigurationExtension" bundleExecEnabled="true" />
-      <EXTENSION ID="JRubyRunConfigurationExtension" NailgunExecEnabled="false" />
-      <EXTENSION ID="RubyCoverageRunConfigurationExtension" track_test_folders="true" runner="rcov">
-        <COVERAGE_PATTERN ENABLED="true">
-          <PATTERN REGEXPS="/.rvm/" INCLUDED="false" />
-        </COVERAGE_PATTERN>
-      </EXTENSION>
-      <EXTENSION ID="org.jetbrains.plugins.ruby.rails.run.RailsRunConfigurationExtension" SCRATCH_USE_RAILS_RUNNER="false" />
-      <RUBY_RUN_CONFIG NAME="SCRIPT_PATH" VALUE="$MODULE_DIR$/bin/netchk" />
-      <RUBY_RUN_CONFIG NAME="SCRIPT_ARGS" VALUE="" />
-      <method v="2" />
-    </configuration>
-    <recent_temporary>
-      <list>
-        <item itemvalue="Ruby.netchk" />
-      </list>
-    </recent_temporary>
-  </component>
-  <component name="SpringUtil" SPRING_PRE_LOADER_OPTION="true" RAKE_SPRING_PRE_LOADER_OPTION="true" RAILS_SPRING_PRE_LOADER_OPTION="true" />
-  <component name="SvnConfiguration">
-    <configuration />
-  </component>
-  <component name="TaskManager">
-    <task active="true" id="Default" summary="Default task">
-      <changelist id="2567b485-a0a4-477d-9983-3cf1b15b4c80" name="Default Changelist" comment="" />
-      <created>1593279687801</created>
-      <option name="number" value="Default" />
-      <option name="presentableId" value="Default" />
-      <updated>1593279687801</updated>
-      <workItem from="1593279689105" duration="8923000" />
-      <workItem from="1593337253458" duration="6021000" />
-    </task>
-    <servers />
-  </component>
-  <component name="TypeScriptGeneratedFilesManager">
-    <option name="version" value="2" />
-  </component>
-  <component name="WindowStateProjectService">
-    <state x="744" y="462" key="#com.intellij.execution.impl.EditConfigurationsDialog" timestamp="1593282010067">
-      <screen x="0" y="0" width="2560" height="1600" />
-    </state>
-    <state x="744" y="462" key="#com.intellij.execution.impl.EditConfigurationsDialog/0.0.2560.1600@0.0.2560.1600" timestamp="1593282010067" />
-    <state x="1043" y="424" width="970" height="751" key="#xdebugger.evaluate" timestamp="1593282162463">
-      <screen x="0" y="0" width="2560" height="1600" />
-    </state>
-    <state x="1043" y="424" width="970" height="751" key="#xdebugger.evaluate/0.0.2560.1600@0.0.2560.1600" timestamp="1593282162463" />
-    <state width="2518" height="460" key="GridCell.Tab.0.bottom" timestamp="1593342482167">
-      <screen x="0" y="0" width="2560" height="1600" />
-    </state>
-    <state width="2518" height="460" key="GridCell.Tab.0.bottom/0.0.2560.1600@0.0.2560.1600" timestamp="1593342482167" />
-    <state width="2518" height="460" key="GridCell.Tab.0.bottom/0.23.2560.1577@0.23.2560.1577" timestamp="1593342310722" />
-    <state width="2518" height="460" key="GridCell.Tab.0.center" timestamp="1593342482166">
-      <screen x="0" y="0" width="2560" height="1600" />
-    </state>
-    <state width="2518" height="460" key="GridCell.Tab.0.center/0.0.2560.1600@0.0.2560.1600" timestamp="1593342482166" />
-    <state width="2518" height="460" key="GridCell.Tab.0.center/0.23.2560.1577@0.23.2560.1577" timestamp="1593342310721" />
-    <state width="2518" height="460" key="GridCell.Tab.0.left" timestamp="1593342482165">
-      <screen x="0" y="0" width="2560" height="1600" />
-    </state>
-    <state width="2518" height="460" key="GridCell.Tab.0.left/0.0.2560.1600@0.0.2560.1600" timestamp="1593342482165" />
-    <state width="2518" height="460" key="GridCell.Tab.0.left/0.23.2560.1577@0.23.2560.1577" timestamp="1593342310720" />
-    <state width="2518" height="460" key="GridCell.Tab.0.right" timestamp="1593342482167">
-      <screen x="0" y="0" width="2560" height="1600" />
-    </state>
-    <state width="2518" height="460" key="GridCell.Tab.0.right/0.0.2560.1600@0.0.2560.1600" timestamp="1593342482167" />
-    <state width="2518" height="460" key="GridCell.Tab.0.right/0.23.2560.1577@0.23.2560.1577" timestamp="1593342310721" />
-    <state width="2518" height="526" key="GridCell.Tab.1.bottom" timestamp="1593337783301">
-      <screen x="0" y="0" width="2560" height="1600" />
-    </state>
-    <state width="2518" height="526" key="GridCell.Tab.1.bottom/0.0.2560.1600@0.0.2560.1600" timestamp="1593337783301" />
-    <state width="2518" height="526" key="GridCell.Tab.1.center" timestamp="1593337783300">
-      <screen x="0" y="0" width="2560" height="1600" />
-    </state>
-    <state width="2518" height="526" key="GridCell.Tab.1.center/0.0.2560.1600@0.0.2560.1600" timestamp="1593337783300" />
-    <state width="2518" height="526" key="GridCell.Tab.1.left" timestamp="1593337783300">
-      <screen x="0" y="0" width="2560" height="1600" />
-    </state>
-    <state width="2518" height="526" key="GridCell.Tab.1.left/0.0.2560.1600@0.0.2560.1600" timestamp="1593337783300" />
-    <state width="2518" height="526" key="GridCell.Tab.1.right" timestamp="1593337783301">
-      <screen x="0" y="0" width="2560" height="1600" />
-    </state>
-    <state width="2518" height="526" key="GridCell.Tab.1.right/0.0.2560.1600@0.0.2560.1600" timestamp="1593337783301" />
-    <state x="945" y="371" width="670" height="676" key="search.everywhere.popup" timestamp="1593343800681">
-      <screen x="0" y="0" width="2560" height="1600" />
-    </state>
-    <state x="945" y="371" width="670" height="676" key="search.everywhere.popup/0.0.2560.1600@0.0.2560.1600" timestamp="1593343800681" />
-  </component>
-  <component name="com.intellij.coverage.CoverageDataManagerImpl">
-    <SUITE FILE_PATH="coverage/netchk@netchk.rcov" NAME="netchk Coverage Results" MODIFIED="1593342318395" SOURCE_PROVIDER="com.intellij.coverage.DefaultCoverageFileProvider" RUNNER="rcov" COVERAGE_BY_TEST_ENABLED="true" COVERAGE_TRACING_ENABLED="false" WORKING_DIRECTORY="$PROJECT_DIR$" MODULE_NAME="netchk" />
-  </component>
-</project>

data/.travis.yml

@@ -1,6 +0,0 @@
----
-language: ruby
-cache: bundler
-rvm:
-  - 2.7.1
-before_install: gem install bundler -v 2.1.2

data/lib/netchk/tcp_ping.rb

@@ -1,72 +0,0 @@
-# frozen_string_literal: true
-module Netchk
-  def ping(host, count = 1, interval = 1, timeout = 5)
-
-    raise "Count must be an integer" unless count.is_a? Integer
-    raise "Timeout must be a number" unless timeout.is_a? Numeric
-
-    unless interval.is_a?(Numeric) && interval >= 0.2
-      raise "Interval must be a decimal greater than or equal to 0.2"
-    end
-
-    super(host)
-
-    pcmd = ['ping']
-
-    case RbConfig::CONFIG['host_os']
-    when /linux/i
-      pcmd += ['-c', count.to_s, '-W', timeout.to_s, host]
-      pcmd += ['-i', interval.to_s] unless RbConfig::CONFIG['busybox']
-    when /aix/i
-      pcmd += ['-c', count.to_s, '-w', timeout.to_s, host]
-    when /bsd|osx|mach|darwin/i
-      pcmd += ['-c', count.to_s, '-t', timeout.to_s, host]
-    when /solaris|sunos/i
-      pcmd += [host, timeout.to_s]
-    when /hpux/i
-      pcmd += [host, "-n#{count.to_s}", '-m', timeout.to_s]
-    when /win32|windows|msdos|mswin|cygwin|mingw/i
-      pcmd += ['-n', count.to_s, '-w', (timeout * 1000).to_s, host]
-    else
-      pcmd += [host]
-    end
-
-    begin
-      Open3.popen3(*pcmd) do |stdin, stdout, stderr, thread|
-        stdin.close
-        err = stderr.gets # Can't chomp yet, might be nil
-
-        case thread.value.exitstatus
-        when 0
-          info = stdout.read
-          if info =~ /unreachable/ix # Windows
-            raise StandardError, "Host unreachable"
-          else
-            # ignored
-          end
-
-          if err & (err =~ /warning/i)
-            @warning = err.chomp # TODO
-          end
-        when 2
-          raise StandardError, err&.chomp
-        else
-          if err
-            raise StandardError, err.chomp
-          else
-            stdout.each_line do |line|
-              if line =~ /(timed out|could not find host|packet loss)/i
-                @exception = line.chomp
-                raise StandardError, line.chomp
-              end
-            end
-            raise StandardError, "Unknown error"
-          end
-        end
-      end
-    rescue Exception => error
-      @exception = error.message
-    end
-
-  end
-end