ip_in_range 1.02 → 1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ec5922add07e46af01522764899f20e12bf53d593fbf0f75285cb56f69446cde
-  data.tar.gz: 0adcc4c8363a5f7204dc76821abb6c9d3fe9fa99385080f2c94f24d5406ea621
+  metadata.gz: 14fcdba5f28330e02f702f945be58cc57d16fa9aca8f87bb036b3668e083eec0
+  data.tar.gz: 6426fb83a768e16cc97848efae637fa14f60e49e7120b63f9ff86ca3ee924853
 SHA512:
-  metadata.gz: 6d74db379a62121a15dc2b492829aec897d2f6e57095eb33009fee2719523bc16eaa383be8828912a681769857476ed67494d485cac9ee27bab3eb8296c7788a
-  data.tar.gz: f65083f6148ee1c6bed6cec741bcb90c2fd163e07cbcd300174cd0052b15e58292b4beb98b126afbab666256749878a516c14e8ce81c8f08670174bc86137326
+  metadata.gz: 2c2d55f1c00f4f791b9dd51828e5d9119e3cf92e03c36169f5a0529d8c0e613b63a156bc5c10e4c79395f61aeacc5d493e5d8a70a2e3e0d128a3a3466ff5e5c8
+  data.tar.gz: 8165148076f882ce6405fff236cce3aa77613bc9e147bf8f68138f174dcfe1cd2ad21baa980c8ddcdc26679962b973880a50489ac351b2319256e9c03443f860

data/bin/ip_in_range

@@ -15,10 +15,10 @@
  ***************************************************************************/
 =end
 
+require_relative '../lib/color_output'
 require_relative '../lib/ip_range'
 require_relative '../lib/email'
 require_relative '../lib/basic_logging'
-require_relative '../lib/file_checking'
 
 # log on class level
 extend BasicLogging
@@ -48,7 +48,7 @@ elsif ARGV.length == 2
   if(!STDIN.tty?)
     mail = FMail.new(ARGF.read)
   else
-    error('No data to compare from STDIN – aborting!')
+    error red('No data to compare from STDIN – aborting!')
     exit false
   end
   ips = mail.received.collect{|r| r.scan(IPR)}
@@ -67,12 +67,17 @@ elsif ARGV.length == 1
     if(!STDIN.tty?)
       mail = FMail.new(ARGF.read)
     else
-      error('No data waiting on STDIN – aborting!')
+      error red('No data waiting on STDIN – aborting!')
       exit false
     end
-    msg = File_Checking::file_check(list_file, [:file, :exist, :readable])
-    if msg 
-      error( "File #{list_file} is unuseable: #{msg}. Aborting!" )
+    msg = ''
+    [:file?, :exist?, :readable?].each do |cond|
+      if !File.send(cond, list_file)
+        msg << "\n\tnot " << cond.to_s.split('?')[0]
+      end
+    end
+    if ! msg.strip.empty?
+      error red( "File #{list_file} is unuseable: #{msg}. Aborting!" )
       exit false
     end
     ranges = File.readlines(list_file)
@@ -82,13 +87,13 @@ elsif ARGV.length == 1
         begin 
           debug 'trying to extract an IP-range'
           range = l.scan(IPR).flatten
-          debug('testing range ' << range.to_s)
+          debug('have extracted range ' << range.to_s)
         rescue ArgumentError => msg
-          er = 'Cannot interpret IP-range ' << l
+          er = 'Cannot interpret IP-range in ' << l
           er << ': ' << msg
-          error(er)
+          error red(er)
         rescue Exception => msg
-          error(msg)
+          error red(msg)
         else 
           debug( "range is " << range.to_s )
           ip_range = IPRange.new(range) 
@@ -100,7 +105,7 @@ elsif ARGV.length == 1
             isso = ip_range.in_range?(ip)
             msg = 'ip ' << ip << (isso ? ' is ' : ' is not ' ) << 'in range: ' << l
             if isso
-              info("\nidentified IP: " + msg)
+              info cyan("\nidentified IP: " + msg)
             else
               debug(msg)
             end
@@ -111,10 +116,10 @@ elsif ARGV.length == 1
     end
     exit false
   else 
-    puts usage
+    puts green(usage)
   end
 else
-  warn( "ERROR! Arguments missing" )
+  warn yellow("ERROR! Arguments missing" )
   info( usage)
   exit false
 end

data/ip_in_range.gemspec

@@ -9,9 +9,14 @@ Gem::Specification.new do |s|
   s.description = "Verify that an IP is in a range"
   s.authors     = AUTHORS.join ','
   s.email       = AUTHORS_MAIL.join ','
-  s.files  	=  %w~ip_in_range~.collect{|f| 'bin/' << f} + %w~ip_range.rb version.rb file_checking.rb basic_logging.rb email.rb~.collect{|f| 'lib/' << f} + ['doc/license.txt','ip_in_range.gemspec'] + ["README.md"]
+  s.files  	=  %w~ip_in_range~.collect{|f| 'bin/' << f} + %w~ip_range.rb color_output.rb version.rb basic_logging.rb email.rb~.collect{|f| 'lib/' << f} + ['doc/license.txt','ip_in_range.gemspec'] + ["README.md"]
   s.homepage    = ''
   s.executables = 'ip_in_range'
-  s.license     = 'Nonstandard'
-  s.required_ruby_version = '>= 3.0'
+  s.license     = 'WTFPL'
+  s.required_ruby_version = '>= 4.0'
+  s.requirements = 'mail'
+  s.add_runtime_dependency 'mail', '~> 2.8', '>= 2.8.1'
+  s.metadata = {
+    "homepage_uri" => 'https://www.uplawski.eu/software',
+    }
 end

data/lib/basic_logging.rb

@@ -2,8 +2,7 @@
 #encoding: UTF-8
 =begin
 /***************************************************************************
- *   ©2013-2023, Michael Uplawski <michael.uplawski@uplawski.eu>           *
- *                                                                         *
+ *   2023-2026, Michael Uplawski <michael.uplawski@uplawski.eu>            *
  *   This program is free software; you can redistribute it and/or modify  *
  *   it under the terms of the WTFPL 2.0 or later, see                     * 
  *   http://www.wtfpl.net/about/                                           *
@@ -19,10 +18,6 @@
 # Simplified logging. 
 # See example code at the bottom of this file.
 # Execute this file to see the output.
-#
-
-#require 'time'
-
 module BasicLogging
 
   DEBUG = 0
@@ -53,14 +48,19 @@ module BasicLogging
 
   # set the log level 
   def set_level(lv)
-    if lv.respond_to?(:to_str)
+    if lv.respond_to?(:to_str) && Levels.keys.include?(lv.strip.to_sym)
       lv = Levels[lv.to_sym]
+    elsif lv.respond_to?(:to_sym) && Levels.keys.include?(lv)
+      lv = Levels[lv]
     end
+
     if(!lv || (lv.respond_to?(:to_int) && lv >= DEBUG && lv <= FATAL) )
       @@log_level = lv
     else
-      STDERR.puts __FILE__.dup << ": ERROR : invalid log level \"" << lv.to_s << "\""
-      STDERR.puts "Keepinng old log level " << Levels.keys.detect {| k| Levels[k] == @@log_level}.to_s
+      msg = calling_method << ": ERROR : invalid log level \"" << lv.to_s << "\""
+      msg << "\n" << "Keepinng old log level " << Levels.keys.detect {| k| Levels[k] == @@log_level}.to_s
+      STDERR.puts msg
+      puts msg
     end
   end
 
@@ -70,15 +70,17 @@ module BasicLogging
       @@target = tg
     elsif(!File::exist?(tg) || ( File.file?(tg) && File.writable?(tg) ) )
       @@target = File.open(tg, 'w+')  
+    elsif !tg || tg.respond_to?(:to_str) && tg.strip.empty?
+      @@target = nil
     else
-      STDERR.puts __FILE__.dup << ': ERROR : target ' << tg << ' cannot be set'
+      STDERR.puts calling_method << ': ERROR : target ' << tg.to_str << ' cannot be set'
       STDERR.puts "Keeping old target " << @@target.inspect
       return
     end
   end
 
-  # Output of log messages, depending on the log level set for the calling class
-  # and the name of the alias method which is actually called.
+  # Output of log messages, depending on the set log level and the name of the
+  # alias method which is actually called.
   def log(message)
     if !BasicLogging.is_muted?(self)
       # how has this method been called?
@@ -88,28 +90,105 @@ module BasicLogging
         # the calling alias.
         format_log( message, mlevel) if @@log_level && Levels[mlevel] >= @@log_level 
       else
-        STDERR.puts __FILE__.dup << ": ERROR : invalid log level \"" << mlevel.to_s << "\""
+        STDERR.puts calling_method << ": ERROR : invalid log level \"" << mlevel.to_s << "\""
       end
     end
   end
 
+  def target
+    @@target.path if @@target
+  end
+
+  def level
+    @@level.to_s if @@level
+  end
+
+  # Clear the log (-file)
+  def clear_log
+    if @@target && @@target.respond_to?(:truncate)
+      lock_target{ @@target.truncate(0) }
+    end
+  end
+
+  # find the name of the calling object's class or the file name in case of the
+  # top level object... or any dumb instance of Object
+  def log_name()
+    if !@log_name
+      clname = self.class.name
+      # limit analysis of the call stack to 'Object'.
+      if clname == 'Object'
+        @log_name = File::basename(caller.last.split(':')[0])
+      else 
+        @log_name = self.class == Class ? self.name.dup << ' [class]' : clname 
+      end
+    end
+    @log_name 
+  end
+
   alias :debug :log
   alias :info :log
   alias :warn :log
   alias :error :log
   alias :fatal :log
 
-  attr_reader :target, :log_level
-
   private 
 
+  # Find the method that called, or 'main' in case of a top level Object.
+  # This needs a bunch of memory and slows down the process.
+  # Use of this method should be limited.
+  def calling_method()
+    # find instances other than the current module.
+    stack_item = caller.detect do |item|
+      item.split(':')[0] != __FILE__
+    end
+    if stack_item
+      if stack_item.include?('#')
+        m = stack_item.split(':').last.split("#")[1] 
+        m.gsub!("'", '') if m && m.include?("'")
+        # looks cooler with a class name in front.
+        return '#' << m << '()'
+      else
+        # top level Object
+        return stack_item.split(':').last
+      end
+    else
+      # This is dumb but won't hurt a lot.
+      return 'from main'
+    end
+  end
+  
+  # could be useful
+  def lock_target(&block)
+    begin
+      if @@target.respond_to?(:flock) 
+        @@target.flock(File::LOCK_EX)
+        block.call
+        @@target.flock(File::LOCK_UN)
+      elsif @@target.respond_to?(:to_io)
+        block.call
+      end
+    rescue => ex
+      STDERR.puts calling_method  << ": ERROR : cannot lock target (" << ex.message << ")"
+    end
+  end
+
   # 1 format_log for all loggers.
   def format_log(message, mlevel)
-    # indicate if a registered class or the registered object of a class is calling.
-    name = self.class == Class ? self.name.dup << ' [class]' : self.class.name
-    @@target.puts '' << name << ' ' << mlevel.to_s << ' ' << Time.now.strftime("%H:%M:%S:%6N")  << ': ' << message
+    if @@target
+      location = log_name().dup << ' ' 
+      # Limit the memory-hungry analysis of the call stack
+      # This also takes about 2.5 times as long.
+      if mlevel != :info 
+        location = log_name().dup << ' ' << calling_method << ' ' 
+      end
+      # indicate if a registered class or the registered object of a class is calling.
+      lock_target{@@target.puts '' << location << mlevel.to_s << ' ' << Time.now.strftime("%H:%M:%S:%6N")  << ': ' << message.gsub("\n", "\n |")}
+    end
   end
-end
+end # Module end
+
+
+
 #---------test: execute file----------
 if $0 == __FILE__
   Array.extend(BasicLogging)
@@ -155,14 +234,14 @@ if $0 == __FILE__
   obj.warn('warn')
   obj.error('error')
   obj.fatal('fatal')
-  puts " ------ Output into file ----"
+  # ---- into file ---
   obj.set_target "/tmp/test_log.log"
-  puts " ------ INFO -----------"
+  puts "------ INFO into #{obj.target}-----------"
   obj.set_level BasicLogging::INFO
   obj.info('info output')
 
   obj.info('info output 2') 
-  puts "---------- invalid -------"
+  puts "---------- invalid (fails) -------"
   obj.set_target "/dev/sr0"
   obj.set_level "power"
 end

data/lib/color_output.rb

@@ -0,0 +1,65 @@
+#encoding: UTF-8
+=begin
+/***************************************************************************
+ *   2023-2024, Michael Uplawski <michael.uplawski@uplawski.eu>            *
+ *   This program is free software; you can redistribute it and/or modify  *
+ *   it under the terms of the WTFPL 2.0 or later, see                     * 
+ *   http://www.wtfpl.net/about/                                           *
+ *                                                                         *
+ *   This program is distributed in the hope that it will be useful,       *
+ *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
+ *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.                  *
+ *                                                                         *
+ ***************************************************************************/
+=end
+
+# Functions to apply colors to terminal output.
+# This is stolen from the Internet and I have lost track of my own additions
+# and modifications.
+
+COLORS = {:default => 9, :black => 0, :red => 1, :green => 2, :yellow => 3, :blue => 4, :purple => 5, :cyan => 6, :white => 7 }
+
+BG = 4
+FG = 3
+REGULAR = 0
+BOLD = 1
+UNDERLINE = 4
+BLINK = 5
+SWAP = 7
+NEUTRAL = 0
+
+STYLES = {:regular => REGULAR, :bold => BOLD, :underline => UNDERLINE, :blink => BLINK, :swap => SWAP, :neutral => NEUTRAL}
+
+# Colorizes the given text. Color-code is either an escape-sequence or one of
+# the symbols representing color-names in the COLORS hash.
+def colorize(text, color_code)
+  if (COLORS.keys.include?(color_code) )
+    "\033[3#{COLORS[color_code]}m#{text}\033[0m"
+  else
+    "#{color_code}#{text}\033[0m"
+  end
+end
+
+def style(text, style_code)
+  "#{style_code}#{text}\033[0m"
+end
+# a function which allows to manipulate every known aspect of the ansi-output.
+def colored_output(output_text, fg_color = :default, bg_color = :default, style = :regular , mode = :neutral )
+  "\033[%i;%i;%i%i;%i%im%s\033[0m" %[STYLES[mode.to_sym], STYLES[style.to_sym], FG, COLORS[fg_color.to_sym], BG, COLORS[bg_color.to_sym], output_text]
+end
+
+# convenience functions
+def red(text); colorize(text, "\033[31m"); end
+def green(text); colorize(text, "\033[32m"); end
+def yellow(text); colorize(text, "\033[33m"); end
+def purple(text); colorize(text, "\033[35m"); end
+def cyan(text); colorize(text, "\033[36m"); end
+def blue(text); colorize(text, "\033[34m"); end
+def white(text); colorize(text, "\033[37m"); end
+
+def black_on_white(text); colorize(colorize(text, "\033[30m"), "\033[47m");end
+def white_on_black(text); colorize(colorize(text, "\033[37m"), "\033[40m");end
+
+def bold(text); style(text, "\033[01m");end
+def underline(text); style(text, "\033[04m");end
+

data/lib/ip_range.rb

@@ -16,7 +16,9 @@
 =end
 
 
+require_relative '../lib/color_output'
 require_relative 'basic_logging'
+
 class IPRange 
   include BasicLogging  
 
@@ -29,7 +31,7 @@ class IPRange
     if nibbles.size == 4
       ( (nibbles[0] * 256 + nibbles[1] ) * 256 + nibbles[2] ) * 256 + nibbles[3]
     else
-      error(ip.dup << " is not an IP-address!")
+      error red(ip.dup << " is not an IP-address!")
       return nil 
     end
   end
@@ -54,8 +56,8 @@ class IPRange
       #last IP
       @last = ip_to_number args[1]
       if @last && @first && ( @last < @first )
-        error('ERROR! Last IP is smaller than the first (' << @first.to_s << ' - ' << @last.to_s << ')')
-        error('Aborting!') 
+        error red('ERROR! Last IP is smaller than the first (' << @first.to_s << ' - ' << @last.to_s << ')')
+        error red('Aborting!') 
         exit false
       end
       @vrange = args[0,2] 

data/lib/version.rb

@@ -13,9 +13,9 @@
  ***************************************************************************/
 =end
 
-VERSION = 1.02
-SUMMARY="better error message when last IP < first IP in a range"
+VERSION = 1.6
+SUMMARY="Verify that an IPv4 address is in a range"
 AUTHORS=["Michael Uplawski@uplawski.eu"]
 EMAIL="michael.uplawski@uplawski.eu"
 AUTHORS_MAIL=["<michael.uplawski@uplawski.eu>"]
-YEARS= "2021-2024"
+YEARS= "2021-2026"

metadata

@@ -1,52 +1,77 @@
 --- !ruby/object:Gem::Specification
 name: ip_in_range
 version: !ruby/object:Gem::Version
-  version: '1.02'
+  version: "1.6"
 platform: ruby
 authors:
-- Michael Uplawski@uplawski.eu
-autorequire:
+  - Michael Uplawski@uplawski.eu
 bindir: bin
 cert_chain: []
-date: 2024-04-13 00:00:00.000000000 Z
-dependencies: []
+date: 2026-08-15 00:00:00.000000000 Z
+dependencies:
+  - !ruby/object:Gem::Dependency
+    name: mail
+    requirement: !ruby/object:Gem::Requirement
+      requirements:
+        -
+          - ~>
+          - !ruby/object:Gem::Version
+            version: "2.8"
+        -
+          - ">="
+          - !ruby/object:Gem::Version
+            version: 2.8.1
+    type: :runtime
+    prerelease: false
+    version_requirements: !ruby/object:Gem::Requirement
+      requirements:
+        -
+          - ~>
+          - !ruby/object:Gem::Version
+            version: "2.8"
+        -
+          - ">="
+          - !ruby/object:Gem::Version
+            version: 2.8.1
 description: Verify that an IP is in a range
 email: "<michael.uplawski@uplawski.eu>"
 executables:
-- ip_in_range
+  - ip_in_range
 extensions: []
 extra_rdoc_files: []
 files:
-- README.md
-- bin/ip_in_range
-- doc/license.txt
-- ip_in_range.gemspec
-- lib/basic_logging.rb
-- lib/email.rb
-- lib/file_checking.rb
-- lib/ip_range.rb
-- lib/version.rb
-homepage: ''
+  - README.md
+  - bin/ip_in_range
+  - doc/license.txt
+  - ip_in_range.gemspec
+  - lib/basic_logging.rb
+  - lib/color_output.rb
+  - lib/email.rb
+  - lib/ip_range.rb
+  - lib/version.rb
+homepage: ""
 licenses:
-- Nonstandard
-metadata: {}
-post_install_message:
+  - WTFPL
+metadata:
+  homepage_uri: "https://www.uplawski.eu/software"
 rdoc_options: []
 require_paths:
-- lib
+  - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
-    - !ruby/object:Gem::Version
-      version: '3.0'
+    -
+      - ">="
+      - !ruby/object:Gem::Version
+        version: "4.0"
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
-    - !ruby/object:Gem::Version
-      version: '0'
-requirements: []
-rubygems_version: 3.4.20
-signing_key:
+    -
+      - ">="
+      - !ruby/object:Gem::Version
+        version: "0"
+requirements:
+  - mail
+rubygems_version: 4.1.0.dev
 specification_version: 4
-summary: better error message when last IP < first IP in a range
+summary: Verify that an IPv4 address is in a range
 test_files: []

data/lib/file_checking.rb

@@ -1,113 +0,0 @@
-#encoding: UTF-8
-=begin
-/***************************************************************************
- *   ©2021-2024, Michael Uplawski <michael.uplawski@uplawski.eu>           *
- *                                                                         *
- *   This program is free software; you can redistribute it and/or modify  *
- *   it under the terms of the WTFPL 2.0 or later, see                     * 
- *   http://www.wtfpl.net/about/                                           *
- *                                                                         *
- *   This program is distributed in the hope that it will be useful,       *
- *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
- *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.                  *
- *                                                                         *
- ***************************************************************************/
-=end
-
-require 'filemagic'
-
-=begin
-A module to facilitate frequently occuring checks on
-file-system objects
-=end
-module File_Checking
-
-  @@text_messages  = {
-    :exist? => "does not exist!",
-    :exist => "does not exist!",
-    :readable? => "is not readable!",
-    :readable => "is not readable!",
-    :executable? => "is not executable!",
-    :executable => "is not executable!",
-    :writable? => "is not writable!",
-    :writable => "is not writable!",
-    :directory? => "is not a directory!",
-    :directory => "is not a directory!",
-    :file? => "is not a file!",
-    :file => "is not a file!",
-# different thing
-    :type => "is not of the sought file-type (not '%s', but '%s')!",
-    :mime => "does not have the sought mime-type (not '%s', but '%s')!",
-  }
-
-  # Checks if the file with the name from the first
-  # parameter has the properties, listed in the second. 
-  # The messages parameter is an array of one or several
-  # of :exist?, :readable?, :writable?, :directory?  or 
-  # their string-representations, respectively. 
-  # Returns nil in case of success, otherwise an 
-  # informative message, describing the first negative
-  # test-result.
-  def file_check(file, *messages)
-    File_Checking.file_check(file, *messages)
-  end
-
-  # Checks if the file with the name from the first
-  # parameter has the properties, listed in the second. 
-  # The messages parameter is an array of one or all
-  # of :exist?, :readable?, :writable?, :directory? or
-  # their string-representations, respectively. 
-  # Returns nil in case of success, otherwise an 
-  # informative message, describing the first negative
-  # test-result.
-  def self.file_check(file, *messages)
-    msg = nil
-    if(file && messages.respond_to?(:to_ary) && !messages.empty?)
-      messages.each do |k|
-        if( k != :mime && k != :type) 
-          if(! k.to_s.end_with?('?'))	
-            k = (k.to_s << '?').to_sym
-          end
-          @log.debug ('checking ' << k.to_s) if @log
-          if(msg == nil && File.respond_to?(k) && ! File.send(k, file.to_s))
-            msg = "#{file} #{@@text_messages[k.to_sym]}"
-          end
-        end
-      end
-    end
-    msg
-  end
-
-  def self.mime_check(file, mime_type)
-    fm = FileMagic.mime
-    fd = fm.fd(File.new(file) ).split(';')[0]
-    if fd != mime_type.strip  
-      return file.dup << ' ' << (@@text_messages[:mime] %[mime_type, fd])
-    end
-    return nil
-  end
-
-  def self.magic_check(file, magic)
-    fm = FileMagic.fm
-    fd = fm.fd(File.new(file) ).split(';')[0]
-    if fd != magic.strip  
-      return file.dup << ' ' << (@@text_messages[:type] %[magic, fd])
-    end
-    return nil
-  end
-
-end # module
-
-=begin
-# example
-
-include File_Checking
-msg = file_check('some_file.txt', [:exist?, :readable?, 'writable'])
-# same as 
-# msg = file_check('some_file.txt', [:exist, :readable, 'writable?'])
-
-msg ||= magic_check('some_file.txt', [:type?], 'OpenDocument Text'
-msg ||= mime_check('some_file.txt', [:mime?], 'application/vnd.oasis.opendocument.text'
-puts msg if msg
-=end
-# E O F