ip_in_range 0.9 → 1.02

data/ip_in_range.gemspec

@@ -7,13 +7,11 @@ Gem::Specification.new do |s|
   s.date        = Date.today.strftime('%F')
   s.summary     = SUMMARY
   s.description = "Verify that an IP is in a range"
-  s.authors     = AUTHORS
-  s.email       = EMAIL
-  s.files  	=  %w~ip_in_range~.collect{|f| 'bin/' << f} + %w~log.conf ip_range.rb version.rb file_checking.rb logging.rb email.rb~.collect{|f| 'lib/' << f} + ['doc/license.txt','ip_in_range.gemspec']
+  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.homepage    = ''
-  #s.requirements = ''
-  #s.add_runtime_dependency ''
   s.executables = 'ip_in_range'
-  s.license     = 'GPL-3.0'
-  s.required_ruby_version = '>= 2.7'
+  s.license     = 'Nonstandard'
+  s.required_ruby_version = '>= 3.0'
 end

data/lib/basic_logging.rb

@@ -0,0 +1,170 @@
+#!/bin/env ruby
+#encoding: UTF-8
+=begin
+/***************************************************************************
+ *   ©2013-2023, 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
+
+#
+# Simplified logging. 
+# See example code at the bottom of this file.
+# Execute this file to see the output.
+#
+
+#require 'time'
+
+module BasicLogging
+
+  DEBUG = 0
+  INFO =  1
+  WARN =  2
+  ERROR = 3
+  FATAL = 4
+  UNKNOWN = nil
+  
+  # this is mainly for the translation of method calls into log levels
+  Levels = {:debug => DEBUG, :info => INFO, :warn => WARN, :error => ERROR,
+            :fatal => FATAL, :unknown => UNKNOWN}
+
+  @@log_level = UNKNOWN
+  @@target = STDOUT
+  @@muted = []
+
+  # do not log, if caller is obj (class or instance)
+  def self.mute(obj)
+    name = obj.class == Class ? obj.name.dup : obj.class.name
+    @@muted << name
+  end
+
+  def self.is_muted?(obj)
+    name = obj.class == Class ? obj.name.dup : obj.class.name
+    @@muted.include?(name)  
+  end
+
+  # set the log level 
+  def set_level(lv)
+    if lv.respond_to?(:to_str)
+      lv = Levels[lv.to_sym]
+    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
+    end
+  end
+
+  # set the log target 
+  def set_target(tg)
+    if tg.respond_to?(:to_io) 
+      @@target = tg
+    elsif(!File::exist?(tg) || ( File.file?(tg) && File.writable?(tg) ) )
+      @@target = File.open(tg, 'w+')  
+    else
+      STDERR.puts __FILE__.dup << ': ERROR : target ' << tg << ' 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.
+  def log(message)
+    if !BasicLogging.is_muted?(self)
+      # how has this method been called?
+      mlevel = __callee__
+      if Levels.has_key?(mlevel) && Levels[mlevel] <=  FATAL
+        # output only for levels equal or above the value that corresponds to
+        # 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 << "\""
+      end
+    end
+  end
+
+  alias :debug :log
+  alias :info :log
+  alias :warn :log
+  alias :error :log
+  alias :fatal :log
+
+  attr_reader :target, :log_level
+
+  private 
+
+  # 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
+  end
+end
+#---------test: execute file----------
+if $0 == __FILE__
+  Array.extend(BasicLogging)
+  Array.set_level(BasicLogging::INFO)
+  Array.info('TEST')
+  ar = Array.new
+  ar.extend(BasicLogging)
+  # --- no output : 
+  l = __LINE__
+  ar.debug(l.next.to_s << ': debug-test 0')
+  # output
+  ar.set_level(BasicLogging::DEBUG)
+  l = __LINE__
+  ar.debug(l.next.to_s << ': debug-test 1')
+
+  obj = Object.new
+  obj.extend(BasicLogging)
+  obj.set_level(BasicLogging::DEBUG)
+  puts "--------debug-----------"
+  obj.debug('debug')
+  obj.info('info')
+  obj.warn('warn')
+  obj.error('error')
+  obj.fatal('fatal')
+  puts "--------info-----------"
+  obj.set_level("info")
+  obj.debug('debug')
+  obj.info('info')
+  obj.warn('warn')
+  obj.error('error')
+  obj.fatal('fatal')
+  puts "--------fatal-----------"
+  obj.set_level("fatal")
+  obj.debug('debug')
+  obj.info('info')
+  obj.warn('warn')
+  obj.error('error')
+  obj.fatal('fatal')
+  puts "--------UNKNOWN-----------"
+  obj.set_level(nil)
+  obj.debug('debug')
+  obj.info('info')
+  obj.warn('warn')
+  obj.error('error')
+  obj.fatal('fatal')
+  puts " ------ Output into file ----"
+  obj.set_target "/tmp/test_log.log"
+  puts " ------ INFO -----------"
+  obj.set_level BasicLogging::INFO
+  obj.info('info output')
+
+  obj.info('info output 2') 
+  puts "---------- invalid -------"
+  obj.set_target "/dev/sr0"
+  obj.set_level "power"
+end
+
+# EOF 

data/lib/email.rb

@@ -2,40 +2,32 @@
 #encoding: UTF-8
 =begin
 /***************************************************************************
- *   ©2021-2021, Michael Uplawski <michael.uplawski@uplawski.eu>           *
+ *   ©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 GNU General Public License as published by  *
- *   the Free Software Foundation; either version 3 of the License, or     *
- *   (at your option) any later version.                                   *
+ *   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.  See the         *
- *   GNU General Public License for more details.                          *
+ *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.                  *
  *                                                                         *
- *   You should have received a copy of the GNU General Public License     *
- *   along with this program; if not, write to the                         *
- *   Free Software Foundation, Inc.,                                       *
- *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
  ***************************************************************************/
 =end
 
-require_relative 'logging'
+require_relative 'basic_logging'
 require 'mail'
 
 class FMail
-  extend Logging
-  @@log = init_logger(STDOUT)
+  include BasicLogging
 
   def initialize(mail_text)
-    @log = @@log
     if !mail_text || mail_text.empty?
-      @log.error('No mail-text provided. Aborting!')
+      error('No mail-text provided. Aborting!')
       exit false
     end
     @mail_text = mail_text
-    # @log.debug('mail text is ' << @mail_text)
+    # debug('mail text is ' << @mail_text)
     extr_received
   end
 
@@ -47,13 +39,13 @@ class FMail
     begin
       @mail = Mail::read_from_string(@mail_text)
     rescue Exception => ex
-      @log.error("cannot analyze this mail: " << ex.message)
-      @log.error("Aborting!")
+      error("cannot analyze this mail: " << ex.message)
+      error("Aborting!")
       exit false;
     end
     headers = @mail.header_fields
     @received = headers.filter{|h| h.name == 'Received'}.collect{|h| h.unparsed_value}
-    @log.debug("found received-headers: " << @received.to_s)
+    debug("found received-headers: " << @received.to_s)
   end
 
 end

data/lib/file_checking.rb

@@ -1,22 +1,16 @@
 #encoding: UTF-8
 =begin
 /***************************************************************************
- *   ©2011-2021 Michael Uplawski <michael.uplawski@uplawski.eu>            *
+ *   ©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 GNU General Public License as published by  *
- *   the Free Software Foundation; either version 3 of the License, or     *
- *   (at your option) any later version.                                   *
+ *   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.  See the         *
- *   GNU General Public License for more details.                          *
+ *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.                  *
  *                                                                         *
- *   You should have received a copy of the GNU General Public License     *
- *   along with this program; if not, write to the                         *
- *   Free Software Foundation, Inc.,                                       *
- *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
  ***************************************************************************/
 =end
 

data/lib/ip_range.rb

@@ -2,29 +2,23 @@
 #encoding: UTF-8
 =begin
 /***************************************************************************
- *   ©2021-2021, Michael Uplawski <michael.uplawski@uplawski.eu>           *
+ *   ©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 GNU General Public License as published by  *
- *   the Free Software Foundation; either version 3 of the License, or     *
- *   (at your option) any later version.                                   *
+ *   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.  See the         *
- *   GNU General Public License for more details.                          *
+ *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.                  *
  *                                                                         *
- *   You should have received a copy of the GNU General Public License     *
- *   along with this program; if not, write to the                         *
- *   Free Software Foundation, Inc.,                                       *
- *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
  ***************************************************************************/
 =end
 
-require_relative 'logging'
+
+require_relative 'basic_logging'
 class IPRange 
-  extend Logging  
-  @@log = init_logger(STDOUT)
+  include BasicLogging  
 
   private
   
@@ -35,7 +29,7 @@ class IPRange
     if nibbles.size == 4
       ( (nibbles[0] * 256 + nibbles[1] ) * 256 + nibbles[2] ) * 256 + nibbles[3]
     else
-      @log.error(ip.dup << " is not an IP-address!")
+      error(ip.dup << " is not an IP-address!")
       return nil 
     end
   end
@@ -53,7 +47,6 @@ class IPRange
 
   # create an IP-range
   def initialize(args) 
-    @log = @@log
     if args && args.length >= 2
 
       #first IP
@@ -61,7 +54,8 @@ class IPRange
       #last IP
       @last = ip_to_number args[1]
       if @last && @first && ( @last < @first )
-        @log.error('ERROR! Last IP is smaller than first. Aborting!') 
+        error('ERROR! Last IP is smaller than the first (' << @first.to_s << ' - ' << @last.to_s << ')')
+        error('Aborting!') 
         exit false
       end
       @vrange = args[0,2] 
@@ -73,6 +67,8 @@ end
 ######### TEST #############
 if __FILE__ == $0
   rg = IPRange.new(['192.168.2.33', '192.168.255.150'])
+  #### ERROR :
+  # rg = IPRange.new(['23.122.9.11', '23.122.8.11'])
   puts rg.first
   puts rg.last
   puts rg.in_range? '192.168.1.35' 

data/lib/version.rb

@@ -1,4 +1,21 @@
-VERSION = 0.9
-SUMMARY="Ranges and text can be commented with a leading '#' "
+=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
+
+VERSION = 1.02
+SUMMARY="better error message when last IP < first IP in a range"
 AUTHORS=["Michael Uplawski@uplawski.eu"]
 EMAIL="michael.uplawski@uplawski.eu"
+AUTHORS_MAIL=["<michael.uplawski@uplawski.eu>"]
+YEARS= "2021-2024"

metadata

@@ -1,34 +1,34 @@
 --- !ruby/object:Gem::Specification
 name: ip_in_range
 version: !ruby/object:Gem::Version
-  version: '0.9'
+  version: '1.02'
 platform: ruby
 authors:
 - Michael Uplawski@uplawski.eu
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-07 00:00:00.000000000 Z
+date: 2024-04-13 00:00:00.000000000 Z
 dependencies: []
 description: Verify that an IP is in a range
-email: michael.uplawski@uplawski.eu
+email: "<michael.uplawski@uplawski.eu>"
 executables:
 - 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/log.conf
-- lib/logging.rb
 - lib/version.rb
 homepage: ''
 licenses:
-- GPL-3.0
+- Nonstandard
 metadata: {}
 post_install_message:
 rdoc_options: []
@@ -38,15 +38,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.15
+rubygems_version: 3.4.20
 signing_key:
 specification_version: 4
-summary: Ranges and text can be commented with a leading '#'
+summary: better error message when last IP < first IP in a range
 test_files: []

data/lib/log.conf

@@ -1,56 +0,0 @@
-#encoding: UTF-8 
-=begin
-/***************************************************************************
- *   ©2013 - 2019 Michael Uplawski <michael.uplawski@uplawski.eu>          *
- *                                                                         *
- *   This program is free software; you can redistribute it and/or modify  *
- *   it under the terms of the GNU General Public License as published by  *
- *   the Free Software Foundation; either version 3 of the License, or     *
- *   (at your option) any later version.                                   *
- *                                                                         *
- *   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.  See the         *
- *   GNU General Public License for more details.                          *
- *                                                                         *
- *   You should have received a copy of the GNU General Public License     *
- *   along with this program; if not, write to the                         *
- *   Free Software Foundation, Inc.,                                       *
- *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
- ***************************************************************************/
-
-A simplified logger configuration. Set the level for each individual logger
-below. Choose a different log-device or log-file if you like. Keep the 
-formatting intact.  Do not change other sections of this file.
-=end
-
-# Do not touch from here ----->
-require 'logger'
-
-debug = Logger::DEBUG
-info = Logger::INFO
-error = Logger::ERROR
-fatal = Logger::FATAL
-warn = Logger::WARN
-unknown = Logger::UNKNOWN
-{
-# <---------------- to here !
-
-# Enter your settings here, but take into consideration that not all 
-# the named classes will really produce readable output. Well, you can 
-# always try... Either name just the log-level or make the log-level
-# precede the output-device or output-file like in the examples.
-
-# Example: naming a log-file
-#
-# :HtmlBuilder => [info, 'C:\temp\htmlbuilder.log'],
-#
-# :HtmlBuilder => [debug, '/tmp/htmlbuilder.log'],
-
-:FMail => info,
-:IPRange => info,
-:TopLevel => debug,
-
-# And ignore the remainder, too.
-}
-#eof