igp 0.0.3 → 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 07b9c7b783789ada3d21617353f4470d5145856e2f555454e7f09e37de0ef5c9
+  data.tar.gz: e733c5f176d331afebfd2b4ff57546555767febc77d514961c6383a88706146a
+SHA512:
+  metadata.gz: 720507197bc6f4325574027108b77474053dd64c832d0462611214e74875608eb6c2f025d2d5eff53d4ae867e39697dc8cbdbaf48f7918f0bd728650d103f466
+  data.tar.gz: dc0e4f4da5bae955da232efe4353fc62286e49073f431f38c0fad0e4b1c34b428d54d01608a0eabc448feab509418a86af027f1b9c386d41c2db5cb0f82065d5

data/.github/workflows/ruby.yml

@@ -0,0 +1,34 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  push:
+    branches: [ '*' ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.7', '3.0']
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@473e4d8fe5dd94ee328fdfca9f8c9c7afc9dae5e
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+      - name: Install dependencies
+        run: bundle install
+      - name: Run tests
+        run: bundle exec rake

data/.gitignore

@@ -0,0 +1,56 @@
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# rcov generated
+coverage
+
+# jeweler generated
+pkg
+
+# logs
+log
+*.log
+
+# Have editor/IDE/OS specific files you need to ignore? Consider using a global gitignore:
+#
+# * Create a file at ~/.gitignore
+# * Include files you want ignored
+# * Run: git config --global core.excludesfile ~/.gitignore
+#
+# After doing this, these files will be ignored in all your git projects,
+# saving you from having to 'pollute' every project you touch with them
+#
+# Not sure what to needs to be ignored for particular editors/OSes? Here's some ideas to get you started. (Remember, remove the leading # of the line)
+#
+# For MacOS:
+#
+#.DS_Store
+#
+# For TextMate
+#*.tmproj
+#tmtags
+#
+# For emacs:
+#*~
+#\#*
+#.\#*
+#
+# For vim:
+#*.swp

data/.rubocop.yml

@@ -0,0 +1,35 @@
+inherit_from: .rubocop_todo.yml
+
+AllCops:
+  NewCops: enable
+
+Layout/CommentIndentation:
+  Exclude:
+    - 'lib/igp/base.rb'
+
+# Offense count: 1
+# Configuration parameters: CheckForMethodsWithNoSideEffects.
+Lint/Void:
+  Exclude:
+    - 'lib/igp/shell.rb'
+
+# Offense count: 3
+# Configuration parameters: IgnoredMethods, CountRepeatedAttributes.
+Metrics/AbcSize:
+  Max: 29
+
+# Offense count: 5
+# Configuration parameters: CountComments, CountAsOne, ExcludedMethods, IgnoredMethods.
+# IgnoredMethods: refine
+Metrics/BlockLength:
+  Max: 148
+
+# Offense count: 1
+# Configuration parameters: IgnoredMethods.
+Metrics/CyclomaticComplexity:
+  Max: 8
+
+# Offense count: 3
+# Configuration parameters: CountComments, CountAsOne, ExcludedMethods, IgnoredMethods.
+Metrics/MethodLength:
+  Max: 16

data/.rubocop_todo.yml

@@ -0,0 +1,86 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2022-03-01 12:54:50 UTC using RuboCop version 1.25.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+# Configuration parameters: Include.
+# Include: **/*.gemspec
+Gemspec/RequiredRubyVersion:
+  Exclude:
+    - 'igp.gemspec'
+
+# Offense count: 1
+Lint/RescueException:
+  Exclude:
+    - 'bin/igp'
+
+# Offense count: 1
+# Configuration parameters: ForbiddenDelimiters.
+# ForbiddenDelimiters: (?-mix:(^|\s)(EO[A-Z]{1}|END)(\s|$))
+Naming/HeredocDelimiterNaming:
+  Exclude:
+    - 'lib/igp/shell.rb'
+
+# Offense count: 2
+Security/Eval:
+  Exclude:
+    - 'spec/spec_helper.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: nested, compact
+Style/ClassAndModuleChildren:
+  Exclude:
+    - 'lib/igp/base.rb'
+    - 'lib/igp/shell.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/Encoding:
+  Exclude:
+    - 'igp.gemspec'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+Style/EvalWithLocation:
+  Exclude:
+    - 'spec/spec_helper.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/ExpandPathArguments:
+  Exclude:
+    - 'igp.gemspec'
+
+# Offense count: 13
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: always, always_true, never
+Style/FrozenStringLiteralComment:
+  Exclude:
+    - 'Gemfile'
+    - 'Guardfile'
+    - 'Rakefile'
+    - 'bin/igp'
+    - 'igp.gemspec'
+    - 'lib/igp.rb'
+    - 'lib/igp/base.rb'
+    - 'lib/igp/shell.rb'
+    - 'lib/igp/version.rb'
+    - 'spec/base_spec.rb'
+    - 'spec/format_spec.rb'
+    - 'spec/shell_spec.rb'
+    - 'spec/spec_helper.rb'
+
+# Offense count: 4
+# Cop supports --auto-correct.
+Style/StderrPuts:
+  Exclude:
+    - 'bin/igp'
+    - 'lib/igp/base.rb'
+    - 'lib/igp/shell.rb'

data/Gemfile

@@ -1,11 +1,3 @@
-source "http://rubygems.org"
+source 'https://rubygems.org'
 
-gem 'net-ping', '~> 1.5.0'
-gem 'getoptions', '~> 0.3'
-
-group :development do
-  gem 'rspec', '> 2.3.0', :require => 'spec'
-  gem 'bundler', '~> 1.0.0'
-  gem 'jeweler', '~> 1.5.2'
-  gem 'rcov', '>= 0'
-end
+gemspec

data/Guardfile

@@ -0,0 +1,16 @@
+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/Rakefile

@@ -1,49 +1,18 @@
-require 'rubygems'
-require 'bundler'
-begin
-  Bundler.setup(:default, :development)
-rescue Bundler::BundlerError => e
-  $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
-  exit e.status_code
-end
-require 'rake'
-$LOAD_PATH << './lib'
-require 'igp'
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
-    gem.name = "igp"
-    gem.version = Igp::VERSION
-    gem.homepage = "http://github.com/tardate/igp"
-    gem.license = "MIT"
-    gem.summary = %Q{It goes PING!}
-    gem.description = %Q{It goes PING! .. simple command-line server monitoring with a range of protocols: ICMP, TCP, UDP, HTTP/S, LDAP/S}
-    gem.email = "gallagher.paul@gmail.com"
-    gem.authors = ["Paul Gallagher"]
-  end
-  Jeweler::RubygemsDotOrgTasks.new
-rescue LoadError
-  puts "Jeweler not available. Install it with: sudo gem install jeweler"
-end
+RSpec::Core::RakeTask.new(:spec)
 
+task default: :spec
 
-require 'rspec'
-require 'rspec/core/rake_task'
-RSpec::Core::RakeTask.new do |t|
-  t.rspec_opts = ["-c", "-f progress"]
-  t.pattern = 'spec/**/*_spec.rb'
+desc 'Open an irb session preloaded with this library'
+task :console do
+  sh 'irb -rubygems -I lib -r cancannible.rb'
 end
 
+require 'rdoc/task'
 
-task :default  => :spec
-
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "igp #{Igp::VERSION}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
+RDoc::Task.new do |rdoc|
+  rdoc.main = 'README.rdoc'
+  rdoc.rdoc_files.include('README.rdoc', 'lib   /*.rb')
 end

data/bin/igp

@@ -6,11 +6,10 @@ require 'getoptions'
 
 begin
   options = GetOptions.new(Igp::Shell::OPTIONS)
-  Igp::Shell.new(options,ARGV).run
-rescue Interrupt,NoMethodError
-  $stderr.puts ""
+  Igp::Shell.new(options, ARGV).run
+rescue Interrupt, NoMethodError
+  $stderr.puts ''
 rescue Exception => e
   $stderr.puts "That wasn't meant to happen! #{e.message}"
   Igp::Shell.usage
 end
-

data/igp.gemspec

@@ -1,78 +1,33 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
-# -*- encoding: utf-8 -*-
+# coding: utf-8
 
-Gem::Specification.new do |s|
-  s.name = %q{igp}
-  s.version = "0.0.3"
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'igp/version'
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Paul Gallagher"]
-  s.date = %q{2011-05-07}
-  s.description = %q{It goes PING! .. simple command-line server monitoring with a range of protocols: ICMP, TCP, UDP, HTTP/S, LDAP/S}
-  s.email = %q{gallagher.paul@gmail.com}
-  s.executables = ["igp"]
-  s.extra_rdoc_files = [
-    "LICENSE",
-    "README.rdoc"
-  ]
-  s.files = [
-    "CHANGELOG",
-    "Gemfile",
-    "Gemfile.lock",
-    "LICENSE",
-    "README.rdoc",
-    "Rakefile",
-    "bin/igp",
-    "igp.gemspec",
-    "init.rb",
-    "lib/igp.rb",
-    "lib/igp/base.rb",
-    "lib/igp/shell.rb",
-    "lib/igp/version.rb",
-    "spec/base_spec.rb",
-    "spec/format_spec.rb",
-    "spec/shell_spec.rb",
-    "spec/spec_helper.rb"
-  ]
-  s.homepage = %q{http://github.com/tardate/igp}
-  s.licenses = ["MIT"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.7.2}
-  s.summary = %q{It goes PING!}
-  s.test_files = [
-    "spec/base_spec.rb",
-    "spec/format_spec.rb",
-    "spec/shell_spec.rb",
-    "spec/spec_helper.rb"
-  ]
+Gem::Specification.new do |spec|
+  spec.name          = 'igp'
+  spec.version       = Igp::VERSION
+  spec.authors       = ['Paul Gallagher']
+  spec.email         = ['gallagher.paul@gmail.com']
+  spec.summary       = 'It goes PING!'
+  spec.description   = 'Simple command-line server monitoring with a range of protocols: ICMP, TCP, UDP, HTTP/S, LDAP/S'
+  spec.homepage      = 'https://github.com/tardate/igp'
+  spec.license       = 'MIT'
 
-  if s.respond_to? :specification_version then
-    s.specification_version = 3
+  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']
 
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<net-ping>, ["~> 1.5.0"])
-      s.add_runtime_dependency(%q<getoptions>, ["~> 0.3"])
-      s.add_development_dependency(%q<rspec>, ["> 2.3.0"])
-      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
-      s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
-      s.add_development_dependency(%q<rcov>, [">= 0"])
-    else
-      s.add_dependency(%q<net-ping>, ["~> 1.5.0"])
-      s.add_dependency(%q<getoptions>, ["~> 0.3"])
-      s.add_dependency(%q<rspec>, ["> 2.3.0"])
-      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
-      s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
-      s.add_dependency(%q<rcov>, [">= 0"])
-    end
-  else
-    s.add_dependency(%q<net-ping>, ["~> 1.5.0"])
-    s.add_dependency(%q<getoptions>, ["~> 0.3"])
-    s.add_dependency(%q<rspec>, ["> 2.3.0"])
-    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
-    s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
-    s.add_dependency(%q<rcov>, [">= 0"])
-  end
-end
+  spec.add_runtime_dependency 'getoptions', '~> 0.3'
+  spec.add_runtime_dependency 'net-ping', '~> 2.0.8'
 
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'guard-rspec'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rb-fsevent'
+  spec.add_development_dependency 'rdoc'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rubocop'
+  spec.metadata['rubygems_mfa_required'] = 'true'
+end

data/lib/igp/base.rb

@@ -1,6 +1,5 @@
 # main class that runs the ping task
 class Igp::Base
-
   # holds the parsed options
   attr_reader :options
   # the output formatter
@@ -27,58 +26,56 @@ class Igp::Base
     @interval = options[:interval] || 5
     case options[:type]
     when :icmp
-      @ping_handler = Net::Ping::External.new(@options[:host],@options[:port])
+      @ping_handler = Net::Ping::External.new(@options[:host], @options[:port])
     when :udp
-      @ping_handler = Net::Ping::UDP.new(@options[:host],@options[:port])
+      @ping_handler = Net::Ping::UDP.new(@options[:host], @options[:port])
     when :tcp
-      @ping_handler = Net::Ping::TCP.new(@options[:host],@options[:port])
+      @ping_handler = Net::Ping::TCP.new(@options[:host], @options[:port])
     when :http, :https
       @ping_handler = Net::Ping::HTTP.new(@options[:url])
-    when :ldap, :ldaps
-      @ping_handler = Net::Ping::LDAP.new(@options[:url])
+    # TODO: LDAP was retired from net-ping. to add back in one way or another
+    # when :ldap, :ldaps
+    #   @ping_handler = Net::Ping::LDAP.new(@options[:url])
     end
   end
 
   # main routine to run a complete ping test
   def run
     return unless ping_handler && formatter
+
     formatter.header(
-      '# It goes PING! .. testing',options[:url],
+      '# It goes PING! .. testing', options[:url],
       (limit ? "#{limit} times - once" : nil),
-      'every',interval,'seconds'
+      'every', interval, 'seconds'
     )
-    ping_count=0
-    while (limit.nil? || ping_count < limit) do
+    ping_count = 0
+    while limit.nil? || ping_count < limit
       status = ping_handler.ping?
-      formatter.log(status,formatter.duration(ping_handler.duration),ping_handler.exception)
+      formatter.log(status, formatter.duration(ping_handler.duration), ping_handler.exception)
       ping_count += 1
-      sleep interval if (limit.nil? || ping_count < limit)
+      sleep interval if limit.nil? || ping_count < limit
     end
   end
 
   # handle output formating tasks
   class Format
-
-    # the time format - in 1.8 strftime doesn't understand milliseconds
-    TIME_FORMAT = (RUBY_VERSION =~ /^1\.9/) ? "%Y-%m-%dT%H:%M:%S.%LZ" : "%Y-%m-%dT%H:%M:%SZ"
+    TIME_FORMAT = '%Y-%m-%dT%H:%M:%S.%LZ'.freeze
 
     # prints the header structure to STDERR
     def header(*args)
       $stderr.puts(args.compact.join(' '))
     end
-      
+
     # logs ping result to STDOUT
     # +args+ is an array of values to log
     def log(*args)
-      $stdout.puts(([Time.now.utc.strftime( TIME_FORMAT )] + args).join(','))
+      $stdout.puts(([Time.now.utc.strftime(TIME_FORMAT)] + args).join(','))
       $stdout.flush
     end
-    
+
     # formats the duration for output. nil duration remains nil
     def duration(duration)
-      "%.6f" % duration if duration
+      format('%.6f', duration) if duration
     end
-
   end
-
-end
+end

data/lib/igp/shell.rb

@@ -2,7 +2,6 @@ require 'uri'
 
 # class that groks the igp command line options and invokes the ping task
 class Igp::Shell
-
   # holds the parsed options
   attr_reader :options
   # holds the URI object representing the ping target
@@ -14,12 +13,13 @@ class Igp::Shell
   #
   # +args+ is the remaining command line arguments
   #
-  def initialize(options,args)
+  def initialize(options, args)
     defaults = {
-      :interval => 1
+      interval: 1
     }
-    @options = defaults.merge( (options||{}).each{|k,v| {k => v} } )
+    @options = defaults.merge((options || {}).each { |k, v| { k => v } })
     return unless args.first
+
     resolve_addressing args.first
     normalise_options
   end
@@ -32,7 +32,7 @@ class Igp::Shell
     unless uri.scheme
       @options[:type] = :icmp
       @options[:host] = uri.to_s
-      @options[:url] = "#{@options[:type].to_s}://#{@options[:host]}"
+      @options[:url] = "#{@options[:type]}://#{@options[:host]}"
       return
     end
     @options[:url] = uri.to_s
@@ -52,7 +52,8 @@ class Igp::Shell
   # runs the ping task
   def run
     case options[:type]
-    when :icmp,:http,:https,:tcp,:udp,:ldap,:ldaps
+    # TODO: LDAP was retired from net-ping. to add back in one way or another
+    when :icmp, :http, :https, :tcp, :udp # :ldap, :ldaps
       Igp::Base.new(options).run
     else
       usage
@@ -60,49 +61,50 @@ class Igp::Shell
   end
 
   # defines the valid command line options
-  OPTIONS = %w(help verbose interval=i limit=i)
+  OPTIONS = %w[help verbose interval=i limit=i].freeze
 
   # prints usage/help information
   def usage
     self.class.usage
   end
+
   # prints usage/help information
   def self.usage
-    $stderr.puts <<-EOS
+    $stderr.puts <<~EOS
 
-It goes PING! v#{Igp::VERSION}
-===================================
+      It goes PING! v#{Igp::VERSION}
+      ===================================
 
-Usage:
-  igp [options] uri
-  
-Options:
-  -h | --help    :shows command help
-  -i= | --interval=seconds (default: 1 second)
-  -l= | --limit=number of tests (default: infinite)
+      Usage:
+        igp [options] uri
 
-The uri specifies the protocol, hostname and port.
-The ICMP protocol is assumed if not specified.
-The default well-known port is assumed if not specified.
+      Options:
+        -h | --help    :shows command help
+        -i= | --interval=seconds (default: 1 second)
+        -l= | --limit=number of tests (default: infinite)
 
-Examples:
+      The uri specifies the protocol, hostname and port.
+      The ICMP protocol is assumed if not specified.
+      The default well-known port is assumed if not specified.
 
-  ICMP ping:
-    igp localhost
-    igp icmp://localhost
+      Examples:
 
-  UDP/TCP ping:
-    igp udp://localhost:123
-    igp tcp://localhost:843
+        ICMP ping:
+          igp localhost
+          igp icmp://localhost
 
-  HTTP/S ping:
-    igp http://localhost:8080
-    igp https://localhost:4443
+        UDP/TCP ping:
+          igp udp://localhost:123
+          igp tcp://localhost:843
 
-  LDAP/S ping:
-    igp ldap://localhost
-    igp ldaps://localhost:6636
+        HTTP/S ping:
+          igp http://localhost:8080
+          igp https://localhost:4443
 
     EOS
+    # TODO: LDAP was retired from net-ping. to add back in one way or another
+    # LDAP/S ping:
+    #   igp ldap://localhost
+    #   igp ldaps://localhost:6636
   end
-end
+end

data/lib/igp/version.rb

@@ -1,3 +1,3 @@
 class Igp
-  VERSION = "0.0.3"
+  VERSION = '1.0.0'.freeze
 end

data/lib/igp.rb

@@ -1,4 +1,3 @@
-require 'rubygems' if (RUBY_VERSION =~ /^1\.8/)
 require 'net/ping'
 require 'igp/version'
 require 'igp/shell'