network_tester 0.1.6 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 87dd6b11f63f3abcefce9efdea334272f816075104cd2e4066ce0db2734f031e
-  data.tar.gz: 4733da0cea9b8d0f9bbff93b59b0e947749c183728604c77a35adccd2331a4e6
+  metadata.gz: c34cef054f5d83352dc9ba90dede6ff13a591111718cce5690058c967b0eede7
+  data.tar.gz: 68ce2bb1b2b083d57362b221f1490ea9a73c7f315694232a3e5151910ab73f70
 SHA512:
-  metadata.gz: faffae1e9f29c2d1e27120d33f255a2f5c55f75e64bb9c1acc7edb8569b4079bd5b0640c43fb3cf744aba628d477c6ef5fa3cad22d563ab0b51ea185be7e0e25
-  data.tar.gz: 0b71fc503dc497bbb2ce1b5dbfd2c757cadf751ac69adedf886bd1490c5ee805de63b49d0b423583c7e89336b9983724227c01a71f25add00f35180e00a12312
+  metadata.gz: 442168411af60214c6e4250add31def93869268cc1c313bc8d5c2244223ffa386e087b0c891852388a118d3cb37054fec561ceadabaca7b0a2c598f1be01443b
+  data.tar.gz: 574afd62cc5a9b3914a2b3b651be6a1e607d46ce2d915f6b0bf3cd87cda2b3c810a91556917f3e4ca22ca4f5a65325395c2c0840a4fa97d39b63b470b815e782

data/.gitignore

@@ -7,3 +7,5 @@
 /pkg/
 /spec/reports/
 /tmp/
+.claude
+network_tester-*

data/README.md

@@ -1,21 +1,15 @@
 # NetworkTester
 
-Announces the number of milliseconds it takes for a ping response. Can pass the millisecond threshold before announcement.
+Announces the number of milliseconds it takes for a ping response. When the ping exceeds a configurable threshold, it alerts you audibly (speech on Mac, terminal bell on Linux).
 
 When diagnosing network issues, you may want to plug and unplug ethernet cables to search for a problem. The genesis of this project is I wanted a way to do this without carrying my laptop around and looking at it all the time.
 
-On a Mac, the number of milliseconds taken by the ping is announced. On Linux, I believe there is an audible beep when the ping takes longer than the threshold. (Untested.)
+On a Mac, the number of milliseconds taken by the ping is spoken aloud. On Linux, a terminal bell and text warning are printed when the ping exceeds the threshold.
 
 ## Installation
 
-Install it to get the bin file:
-
     $ gem install network_tester
 
-OR, if you don't have rvm/rbenv installed, you may need to get it this way:
-
-    $ sudo gem install network_tester
-
 Or add this line to your application's Gemfile:
 
 ```ruby
@@ -30,7 +24,27 @@ And then execute:
 
 After installing the gem, you may need to open a new shell, and then type:
 
-    network_tester [millisecond_threshold=70] [ipaddr=google.com]
+    network_tester [options]
+    network_tester [maxtime] [address]
+
+Positional arguments can be given in any order. Integers are treated as
+the alert threshold; anything else as the host.
+
+### Options
+
+    -a, --address ADDRESS   Host to ping (default: google.com)
+    -m, --maxtime MS        Alert threshold in ms (default: 70)
+    -h, --help              Show help message
+    -v, --version           Show version
+
+### Examples
+
+    network_tester                       # ping google.com, alert above 70ms
+    network_tester 100                   # ping google.com, alert above 100ms
+    network_tester yahoo.com             # ping yahoo.com, alert above 70ms
+    network_tester 100 yahoo.com        # ping yahoo.com, alert above 100ms
+    network_tester yahoo.com 100        # same as above
+    network_tester -a 8.8.8.8 -m 100   # using named options
 
 ## Development
 
@@ -40,10 +54,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/[USERNAME]/network_tester.
-
+Bug reports and pull requests are welcome on GitHub at https://github.com/brianmd/network_tester.
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/bin/network_tester

@@ -1,14 +1,56 @@
 #!/usr/bin/env ruby
-require 'pathname'
+require "optparse"
+require_relative "../lib/network_tester"
 
-$LOAD_PATH.unshift Pathname.new(__FILE__).dirname + '..'
+options = {
+  maxtime: 70,
+  address: "google.com"
+}
 
-require_relative '../lib/network_tester'
+OptionParser.new do |opts|
+  opts.banner = <<~BANNER
+    Usage: network_tester [options]
+           network_tester [maxtime] [address]
 
-default_maxtime = 70
-ipaddr = 'google.com'
+    Positional arguments can be given in any order. Integers are
+    treated as the alert threshold; anything else as the host.
 
-default_maxtime = Integer(ARGV[0]) if ARGV.size>0
-ipaddr = ARGV[1] if ARGV.size>1
+    Examples:
+      network_tester                  # ping google.com, alert above 70ms
+      network_tester 100              # ping google.com, alert above 100ms
+      network_tester yahoo.com        # ping yahoo.com, alert above 70ms
+      network_tester 100 yahoo.com   # ping yahoo.com, alert above 100ms
+      network_tester yahoo.com 100   # same as above
 
-NetworkTester::loop(nil, ipaddr, default_maxtime)
+    Options:
+  BANNER
+
+  opts.on("-a", "--address ADDRESS", "Host to ping (default: google.com)") do |addr|
+    options[:address] = addr
+  end
+
+  opts.on("-m", "--maxtime MS", Integer, "Alert threshold in ms (default: 70)") do |ms|
+    options[:maxtime] = ms
+  end
+
+  opts.on("-h", "--help", "Show this help message") do
+    puts opts
+    exit
+  end
+
+  opts.on("-v", "--version", "Show version") do
+    puts NetworkTester::VERSION
+    exit
+  end
+end.parse!
+
+# Positional args in any order: integers are maxtime, anything else is address
+ARGV.each do |arg|
+  if arg.match?(/\A\d+\z/)
+    options[:maxtime] = Integer(arg)
+  else
+    options[:address] = arg
+  end
+end
+
+NetworkTester.loop(nil, options[:address], options[:maxtime])

data/lib/network_tester/version.rb

@@ -1,3 +1,3 @@
 module NetworkTester
-  VERSION = "0.1.6"
+  VERSION = "0.1.8"
 end

data/lib/network_tester.rb

@@ -1,3 +1,4 @@
+require "shellwords"
 require_relative "network_tester/version"
 
 module NetworkTester
@@ -21,22 +22,12 @@ module NetworkTester
 
   def pingr(addr='google.com')
     timeout_arg = mac? ? '-t' : '-W'
-    cmd = "ping -c 1 #{timeout_arg} 1 #{addr} "
+    cmd = "ping -c 1 #{timeout_arg} 1 #{Shellwords.shellescape(addr)}"
     result = `#{cmd} 2>/dev/null`
-    timerow = nil
-    result.split("\n").detect do |r|
-      if r.match(/time/)
-        timerow = r.match(/cmp_seq.*time=([^ ]*)/)
-      end
-    end
-
-    if timerow.nil?
-      nil
-    else
-      timerow[1] 
-    end
+    match = result.match(/time=([^\s]+)/)
+    match&.[](1)
   end
- 
+
   def notifier(time, maxtime=70)
     if time.nil?
       return notify('error')
@@ -53,7 +44,7 @@ module NetworkTester
 
   def notify(msg='da', rate=600)
     if mac?
-      `say #{msg.inspect} -r #{[rate,400].max}`
+      system("say", msg.to_s, "-r", [rate, 400].max.to_s)
     else
       puts "\a#{' '*20}#{'-'*10} too long: #{msg.inspect}"
     end

data/network_tester.gemspec

@@ -10,16 +10,17 @@ Gem::Specification.new do |spec|
   spec.email         = ["brian@murphydye.com"]
 
   spec.summary       = %q{Test network with audible pings.}
-  spec.description   = %q{}
-  spec.homepage      = ''
+  spec.description   = %q{Continuously pings a host and announces response times. Alerts audibly when latency exceeds a threshold.}
+  spec.homepage      = "https://github.com/brianmd/network_tester"
   spec.license       = "MIT"
 
+  spec.required_ruby_version = ">= 2.7"
+
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.executables   = ['network_tester']
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", ">= 2.1"
+  spec.add_development_dependency "bundler", "~> 2.1"
   spec.add_development_dependency "rake", "~> 12.3.3"
-  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rspec", "~> 3.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: network_tester
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.8
 platform: ruby
 authors:
 - bmd
@@ -13,14 +13,14 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.1'
 - !ruby/object:Gem::Dependency
@@ -41,17 +41,18 @@ dependencies:
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-description: ''
+        version: '3.0'
+description: Continuously pings a host and announces response times. Alerts audibly
+  when latency exceeds a threshold.
 email:
 - brian@murphydye.com
 executables:
@@ -71,7 +72,7 @@ files:
 - lib/network_tester.rb
 - lib/network_tester/version.rb
 - network_tester.gemspec
-homepage: ''
+homepage: https://github.com/brianmd/network_tester
 licenses:
 - MIT
 metadata: {}
@@ -82,7 +83,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="