opensecret 0.0.2 → 0.0.4

data/lib/opensecret/plugins.io/logs/logging.rb

@@ -0,0 +1,203 @@
+# --
+# -- [MIXIN] magic is deployed to hand out DevOps quality logging
+# -- features to any class that includes the logging module.
+# --
+# -- When logging facilities are not ready we need to log just to
+# -- stdout but when they are we need to use them.
+# --
+# -- mixin power enables one class to give the logfile path and all
+# -- classes will suddenly retrieve a another logger and use that.
+# --
+# --   include Logging
+# --   def doImportant
+# --     log.warn(ere) "unhappy about doing this"
+# --     do_anyway
+# --     log.debug(ere) "all good it was okay"
+# --   end
+# --
+# -- -----------------------
+# -- What are Mixins?
+# -- -----------------------
+# --
+# -- Refer to the below link for excellent coverage of mixins.
+# -- http://ruby-doc.com/docs/ProgrammingRuby/html/tut_modules.html
+# --
+module Logging
+
+  @@log_path = nil
+  @@log_class = nil
+
+  # --
+  # -- Classes that include (MIXIN) this logging module will
+  # -- have access to this logger method.
+  # --
+  # -- [memoization] is implemented here for performance and
+  # -- will only initiate a logger under 2 circumstances
+  # --
+  # --   [1] - the first call (returns a STDOUT logger)
+  # --   [2] - the call after the logfile path is set
+  # --          (returns a more sophisticated logger)
+  # --
+  def log
+
+    @@log_class ||= get_logger
+
+  end
+
+
+  # --
+  # -- log.info(ere) {i woz ere}
+  # --
+  # -- [ere] is borrowed from the common graffiti phrase (i woz ere)
+  # --
+  # -- In software terms it allows the logger to print 3 crucial
+  # -- pieces of information for the troubleshooter (detective) to
+  # -- determine who called the logger (who was here). The
+  # --
+  # --  [1] - [module name] of the caller
+  # --  [2] - [method name] the call came from
+  # --  [3] - [line number] of the call
+  # --
+  # --
+  def ere
+
+    module_name = File.basename caller_locations(1,1).first.absolute_path, ".rb"
+    method_name = caller_locations(1,1).first.base_label
+    line_number = caller_locations(1,1).first.lineno
+
+    "#{module_name} | #{method_name} | (line #{line_number}) "
+
+  end
+
+  # --
+  # -- If logger is used at the [BEGINNING] when
+  # -- the runtime logfile path has not yet been
+  # -- ascertained then STDOUT is used.
+  # --
+  # -- However if we have been informed (via the
+  # -- set_logfile_path) that the logfile path is
+  # -- now known the logger returned will be set
+  # -- to log to the specified file.
+  # --
+  # -- [memoization] should be used so that this
+  # -- method gets called only [TWICE].
+  # --
+  # --   [1] - at the [beginning] when the logfile path is not known
+  # --   [2] - just [after] the logfile dir is evaluated and created
+  # --
+  def get_logger
+
+    expensive_initializr = "EXPENSIVE(x2) => This log message should only appear [TWICE]."
+    Logger.new(STDOUT).warn "#{expensive_initializr}"
+
+    return get_stdout_logger if @@log_path.nil?
+
+    file_logger = Logger.new( Logging.initializr_str )
+    original_formatter = Logger::Formatter.new
+
+    file_logger.formatter = proc { |severity, datetime, progname, msg|
+########      original_formatter.call(severity, datetime, progname, msg.dump.chomp.strip.delete("\"\\"))
+      original_formatter.call( severity, datetime, progname, msg.dump.chomp.strip )
+    }
+
+    if CmdLine.has? "--debug" then
+      file_logger.level = Logger::DEBUG
+    else
+      file_logger.level = Logger::INFO
+    end
+
+    return file_logger
+
+  end
+
+
+  # --
+  # -- Get the logger class initiaze string.
+  # -- The OS platform "Windows" vs "Linux" dictates
+  # -- what is returned as the "tee" command used to
+  # -- redirect logging output bot the console and a
+  # -- standard log file is not available on Windows.
+  # --
+  # -- Return the initializer for the logging statement.
+  # --
+  # -- ------------
+  # -- Windows
+  # -- ------------
+  # --
+  # -- Continue logging solely to STANDARD OUT.
+  # -- We could log to a file but not to both.
+  # --
+  # -- ------------
+  # -- Linux
+  # -- ------------
+  # --
+  # -- Send back TEE command so that logs pipe to
+  # -- both standard out and the designated logfile.
+  # --
+  def self.initializr_str
+
+    return STDOUT if Gem.win_platform?
+    return "| tee #{@@log_path}"
+
+  end
+
+
+  # --
+  # -- Get a simple STDOUT logger using the
+  # -- designated log level.
+  # --
+  # -- As the early stage when we do not have a
+  # -- log file destination the logs are set to
+  # -- the DEBUG (max) level.
+  # --
+  # -- If you need just INFO level logs right
+  # -- from the get go - go amend this method.
+  # --
+  def get_stdout_logger
+
+    stdout_logger = Logger.new(STDOUT)
+    stdout_logger.level = Logger::DEBUG
+    return stdout_logger
+
+  end
+
+
+  #--
+  #-- Set logfile path and [INVALIDATE] the
+  #-- cache so that memoization reads the new
+  #-- @log_class object.
+  #--
+  def set_logfile_path path_to_set
+
+    @@log_path = path_to_set
+    @@log_class = nil
+
+  end
+
+
+  #--
+  #-- Return the filename and its two immediate
+  #-- parent folders (parent and grandparent).
+  #--
+  #-- When this is not possible when the filepath
+  #-- is near the filesystem's root - it returns
+  #-- whatever is possible.
+  #--
+  #-- IMPLEMENT ABOVE FUNCTIONALITY WHEN NEEDED.
+  #-- CURRENTLY IT JUST BLUNDERS IN WITH NEITHER
+  #-- RHYME NOR REASON.
+  #--
+  def nickname object_path
+
+    object_name   = File.basename object_path
+    parent_folder = File.dirname  object_path
+    parent_name   = File.basename parent_folder
+    granny_folder = File.dirname  parent_folder
+    granny_name   = File.basename granny_folder
+
+    return [granny_name,parent_name,object_name].join("/")
+
+  end
+
+
+end

data/lib/opensecret/plugins.io/time/time.stamp.rb

@@ -0,0 +1,425 @@
+#!/usr/bin/ruby
+
+# -- ----------------------------------------------------------------- -- #
+# -- the eco stamp                                                       -- #
+# -- ----------------------------------------------------------          -- #
+# --                                                                     -- #
+# -- The eco-system stamp is at the centre of a fundamental iaas pattern. -- #
+# -- known as the "infrastructure provisioning reference pattern (iprp)". -- #
+# -- The central idea behind the pattern is to link every infrastructure -- #
+# -- object created for an eco-system with an embedded reference that -- #
+# -- contains a "minute accurate" time.                                  -- #
+# --                                                                     -- #
+# -- ----------------------------------------------------------          -- #
+# -- which infrastructure [objects] are eco-stamped?                       -- #
+# -- ----------------------------------------------------------          -- #
+# -- eco-system stamps are used when referencing provisioned            -- #
+# --   - files and folders                                            -- #
+# --   - database user names                                            -- #
+# --   - Docker containers                                            -- #
+# --   - virtual machines                                            -- #
+# --   - s3 buckets and their contents                                  -- #
+# --   - aws ec2 machines                                              -- #
+# --   - aws acl lists                                              -- #
+# --   - hostnames and urls                                              -- #
+# --
+# -- --------------------------
+# -- the eco-stamp [segments]
+# -- --------------------------
+# --
+# -- Typical eco-system stamps comprise of a few of the [segments] that
+# -- are listed below. Periods (and at times underscores) are used to
+# -- delineate each segment.
+# --
+# --   | mo       | months index      | from 01 to 12   | 2 |
+# --   | mmm      | abbrv month name  | eg feb          | 3 |
+# --   | ddd      | abbrv day of week | eg tue          | 3 |
+# --   | yy       | two digit year    | eg 19 for 2019  | 2 |
+# --   | jjj      | julian day        | from 001 to 366 | 3 |
+# --   | hh       | hour of day       | from 001 to 366 | 2 |
+# --   | mm       | minute of hour    | from 00 to 59   | 2 |
+# --
+# -- -----------------------------------
+# -- eco-stamp [prefix] and [postfix]
+# -- -----------------------------------
+# --
+# -- eco stamps are not just about time. Yes time is at the core but
+# -- the eco reference will usually be pre or post-fixed with
+# --
+# --    - an eco plugin descriptor
+# --    - a repository [revision]
+# --    - the executors [username]
+# --    - the machine's [hostname]
+# --    - middleware service name
+# --
+class Stamp
+  include Singleton
+
+  attr_reader :time_now
+
+  # --
+  # -- Return two digit [mo] month index from [01] to [12].
+  # --
+  def self.mo
+    return Stamp.instance.time_now.strftime "%m"
+  end
+
+
+  # -- ------------------------------------------------------- -- #
+  # -- Return three character abbreviated month name (eg feb). -- #
+  # -- ------------------------------------------------------- -- #
+  def self.mmm
+    return Stamp.instance.time_now.strftime( "%b" ).downcase
+  end
+
+
+  # -- -------------------------------------------------------- -- #
+  # -- Return three character abbreviated day of week (eg wed). -- #
+  # -- -------------------------------------------------------- -- #
+  def self.ddd
+    return Stamp.instance.time_now.strftime( "%a" ).downcase
+  end
+
+
+  # --
+  # -- Return two digit hour of day from [00] to [23].
+  # --
+  def self.hh
+    return Stamp.instance.time_now.strftime "%H"
+  end
+
+
+  # --
+  # -- Return two digit minute of hour from [00] to [59].
+  # --
+  def self.mm
+    return Stamp.instance.time_now.strftime "%M"
+  end
+
+
+  # --
+  # -- Return two digit second of minute from [00] to [59].
+  # --
+  def self.ss
+    return Stamp.instance.time_now.strftime "%S"
+  end
+
+
+  # --
+  # -- Return a [3 digit] second and tenth of second
+  # -- representation.
+  # --
+  # -- The final digit is derived from the 1000 sliced
+  # -- millisecond of second running from 000 to 999.
+  # --
+  # -- ---------------------------
+  # -- Truncation (Not Rounding)
+  # -- ---------------------------
+  # --
+  # -- The [final] digit is acquired by TRUNCATING
+  # -- (chopping off) the last 2 of the 3 millisecond
+  # -- digits. No rounding is applied.
+  # --
+  # -- The 3 returned digits comprise of the
+  # --
+  # --  - second of minute => 2 digits | [00] to [59] (and)
+  # --  - tenth of second  => 1 digit from [0] to [9]
+  # --
+  # -- ---------
+  # -- Example
+  # -- ---------
+  # --  => The time at the 562nd millisecond  of the 49th
+  # --     second of the minute.
+  # --
+  # --  => 3 chars
+  # --  => 495
+  # --
+  # --
+  def self.sst
+    millisec_string = Stamp.instance.time_now.strftime "%L"
+    return "#{ss}#{millisec_string[0]}"
+  end
+
+
+  # --
+  # -- Return the [two] digit year (eg 19 for 2019).
+  # -- that we are currently in.
+  # --
+  def self.yy
+    return Stamp.instance.time_now.strftime("%Y")[2..-1]
+  end
+
+
+  # --
+  # -- Return the [four] digit year (eg 2019)
+  # -- that we are currently in.
+  # --
+  def self.yyyy
+    return Stamp.instance.time_now.strftime("%Y")
+  end
+
+
+  # -- ------------------------------------------------- -- #
+  # -- Return 3 digit julian day of year [001] to [366]. -- #
+  # -- ------------------------------------------------- -- #
+  def self.jjj
+    return Stamp.instance.time_now.strftime "%j"
+  end
+
+
+  # --
+  # -- [yymo_mmm] returns an amalgam of
+  # --
+  # --    => the two-digit year
+  # --    => the two-digit month index (starting at 01)
+  # --    => a period (separator)
+  # --    => the abbreviated month name
+  # --
+  # -- ---------
+  # -- Example
+  # -- ---------
+  # --  => 1908.aug
+  # --  => for August 2019
+  # --
+  def self.yymo_mmm
+    return "#{yy}#{mo}.#{mmm}"
+  end
+
+
+  # --
+  # -- Given two integer parameters (month index and 4 digit year) representing
+  # -- the month in question this method returns the [PREVIOUS MONTHS] character
+  # -- amalgam in the format [yymo_mmm] where
+  # --
+  # --    => yy  | previous month's two-digit year
+  # --    => mo  | previous month's two-digit month index
+  # --    => .   | a period (separator)
+  # --    => mmm | previous month's abbreviated month name
+  # --
+  # -- -------------------
+  # -- Example 1 (Simple)
+  # -- -------------------
+  # --
+  # --  returns char => 1907.jul
+  # --  4 parameters => 8, 2019
+  # --  representing => August, 2019
+  # --
+  # -- ----------------------
+  # -- Example 2 (Last Year)
+  # -- ----------------------
+  # --
+  # --  returns char => 1812.dec
+  # --  4 parameters => 1, 2019
+  # --  representing => January, 2019
+  # --
+  def self.previous_month_chars this_month_index, this_4digit_year
+
+    prev_month_index = this_month_index == 1 ? 12 : ( this_month_index - 1 )
+    prev_2dig_mn_pad = sprintf '%02d', prev_month_index
+    prev_4digit_year = this_month_index == 1 ? ( this_4digit_year - 1 ) : this_4digit_year
+    prev_twodigit_yr = "#{prev_4digit_year.to_s}"[2..-1]
+    prev_months_name = Date::ABBR_MONTHNAMES[prev_month_index].downcase
+
+    return "#{prev_twodigit_yr}#{prev_2dig_mn_pad}.#{prev_months_name}"
+
+  end
+
+  # --
+  # -- Using the current class time this method returns
+  # -- the character amalgam for the [PREVIOUS MONTH] in
+  # -- the format [yymo_mmm] where
+  # --
+  # --    => yy  | last month's two-digit year
+  # --    => mo  | last month's two-digit month index
+  # --    => .   | a period (separator)
+  # --    => mmm | last month's abbreviated month name
+  # --
+  # -- -------------------
+  # -- Example 1 (Simple)
+  # -- -------------------
+  # --
+  # --  returns => 1907.jul
+  # --  if this month is => August 2019
+  # --
+  # -- ----------------------
+  # -- Example 2 (Last Year)
+  # -- ----------------------
+  # --
+  # --  returns => 1812.dec
+  # --  if this month is => January 2019
+  # --
+  def self.yymo_mmm_prev
+    return previous_month_chars mo.to_i, yyyy.to_i
+  end
+
+
+  # -- ---------------------------------------------- -- #
+  # -- Return 5 digit amalgam of year and julian day. -- #
+  # --  eg [19003] for [January 3rd 2019]             -- #
+  # -- ---------------------------------------------- -- #
+  def self.yyjjj
+    return "#{yy}#{jjj}"
+  end
+
+
+  # --
+  # -- Return the 4 digit amalgam of the hour and minute
+  # -- using the 24 hour clock.
+  # --
+  # -- ---------
+  # -- Example
+  # -- ---------
+  # --  => 1525
+  # --  => 03:25 pm
+  # --
+  def self.hhmm
+    return "#{hh}#{mm}"
+  end
+
+
+  # --
+  # -- Return the time of day to a TENTH of a second accuracy.
+  # -- [8] characters will always be returned with the 5th one
+  # -- being the (period) separator.
+  # --
+  # -- The first (separated) segment delivers a hhmm 24 hour
+  # -- clock representation of the stamped time.
+  # --
+  # -- The 3 digits of the second segment comprise of
+  # --
+  # --   second of minute => 2 digits | [00] to [59]
+  # --   tenth of second  => 1 digit from [0] to [9]
+  # --
+  # -- ---------
+  # -- Example
+  # -- ---------
+  # --  => The time at the 562nd millisecond  of the 49th
+  # --     second of the 23rd minute of the 17th hour of
+  # --     the day ( 17:23:49.562 )
+  # --
+  # --  => 8 chars
+  # --  => 1723.495
+  # --
+  def self.hhmm_sst
+    return "#{hhmm}.#{sst}"
+  end
+
+
+  # --
+  # -- Return a period separated amalgam of the
+  # --
+  # --  => 2 digit year and 3 digit julian day
+  # --  => 4 digit hour/minute
+  # --
+  # -- ---------
+  # -- Example
+  # -- ---------
+  # --  => 19003.1025
+  # --  => 10:25 am on January 3rd 2019
+  # --
+  # --
+  # -- Return the time of day to a TENTH of a second accuracy.
+  # -- [8] characters will always be returned with the 5th one
+  # -- being the (period) separator.
+  # --
+  # -- The first (separated) segment delivers a hhmm 24 hour
+  # -- clock representation of the stamped time.
+  # --
+  # -- The 3 digits of the second segment comprise of
+  # --
+  # --   second of minute => 2 digits | [00] to [59]
+  # --   tenth of second  => 1 digit from [0] to [9]
+  # --
+  # -- ---------
+  # -- Example
+  # -- ---------
+  # --  => The time at the 562nd millisecond  of the 49th
+  # --     second of the 23rd minute of the 17th hour of
+  # --     the day ( 17:23:49.562 )
+  # --
+  # --  => 8 chars
+  # --  => 1723.495
+  # --
+  def self.yyjjj_hhmm_sst
+    return "#{yyjjj}.#{hhmm}.#{sst}"
+  end
+
+
+  # -- ----------------------------------------- -- #
+  # -- Return the Rubyfied time zone being used. -- #
+  # -- ----------------------------------------- -- #
+  def self.zone
+    return Stamp.instance.time_now.zone
+  end
+
+
+  # -- -------------------------------------------------- -- #
+  # -- Log segments of time pertaining to the time stamp. -- #
+  # -- -------------------------------------------------- -- #
+  def self.log_instance_time
+
+    log.info(ere) { "[stamp] -------------- => -------------------------------- #" }
+    log.info(ere) { "[stamp] eco time stamp => [#{Stamp.instance.time_now.ctime}]" }
+    log.info(ere) { "[stamp] -------------- => -------------------------------- #" }
+    log.info(ere) { "[stamp] Univ Time Zone => #{zone}"  }
+    log.info(ere) { "[stamp] Month Index is => #{mo}"    }
+    log.info(ere) { "[stamp] Month Name is  => #{mmm}"   }
+    log.info(ere) { "[stamp] Day Of Week is => #{ddd}"   }
+    log.info(ere) { "[stamp] -------------- => -------------------------------- #" }
+    log.info(ere) { "[stamp] Two Digit Year => #{yy}"    }
+    log.info(ere) { "[stamp] Julian Cal Day => #{jjj}"   }
+    log.info(ere) { "[stamp] Yr and Jul Day => #{yyjjj}" }
+    log.info(ere) { "[stamp] Hour of Theday => #{hh}"    }
+    log.info(ere) { "[stamp] Minute of Hour => #{mm}"    }
+    log.info(ere) { "[stamp] Hour + Minute  => #{hhmm}"  }
+    log.info(ere) { "[stamp] Second of Min  => #{ss}"    }
+    log.info(ere) { "[stamp] 600 Min Slices => #{sst}"   }
+    log.info(ere) { "[stamp] -------------- => -------------------------------- #" }
+    log.info(ere) { "[stamp] The Time Stamp => #{yyjjj_hhmm_sst}" }
+    log.info(ere) { "[stamp] -------------- => -------------------------------- #" }
+
+  end
+
+
+  # -- ------------------------------------------------------------ -- #
+  # -- This singleton (one instance) class sets the time just once. -- #
+  # -- ------------------------------------------------------------ -- #
+  def initialize
+
+    @time_now = Time.now;
+
+  end
+
+
+  # --
+  # -- This method tests the previous month behaviour.
+  # -- Simply set the year index to the desired integer and roll.
+  # --
+  # -- Example Call
+  # --
+  # --   Stamp.test_previous_month 2015
+  # --
+  def self.test_previous_month year_index
+
+    month_index = 1
+
+    log.info(ere) { "This Month Char Amalgam => #{yymo_mmm}" }
+    log.info(ere) { "Prev Month Char Amalgam => #{yymo_mmm_prev}" }
+
+    until month_index == 13  do
+      prev_month_chars = Stamp.previous_month_chars month_index, year_index
+      log.info(ere) { "Char Amalgam | #{prev_month_chars} => month #{month_index} | year #{year_index}" }
+      month_index +=1
+    end
+
+  end
+
+
+  # -- -------------------------------------------------------------------- -- #
+  # -- [Cold Call Pattern] - If class has no [internal] dependencies it can -- #
+  # --                       initialize itself ignoring any require [order] -- #
+  # -- -------------------------------------------------------------------- -- #
+  Stamp.log_instance_time
+  Stamp.test_previous_month yyyy.to_i
+
+end