opensecret 0.0.2 → 0.0.4

data/lib/opensecret/plugins.io/error/eco.exceptions.rb

@@ -0,0 +1,24 @@
+# --
+# -- Exception when the AWS credentials are not found.
+# --
+class AwsCredentialsError < StandardError
+
+###  attr_reader :action
+
+  # --
+  # -- Create this exception object
+  def initialize message, credential_name
+
+    # --
+    # -- Call the parent's constructor to set the message
+    # --
+    super( message + " Missing Credential => #{credential_name}" )
+
+    # --
+    # -- Store the action in an instance variable
+    # --
+###    @action = action
+
+  end
+
+end

data/lib/opensecret/plugins.io/facts/fact.chars.rb

@@ -0,0 +1,66 @@
+#!/usr/bin/ruby
+
+# --
+# -- Dot the I's and Cross the T's
+# --
+class Do
+
+  # --
+  # -- p => period (full stop)
+  # -- Deliver a "." period character
+  # --
+  def self.t
+    return "."
+  end
+
+  # --
+  # -- Note you do not need this method for declaration
+  # -- of a fact that contains just a single forward slash.
+  # -- The below will do.
+  # --
+  # -- fact.name = /
+  # --
+  # -- / => forward slash
+  # -- Deliver a "/" fwd slash character
+  # --
+  def self.f
+    return "/"
+  end
+
+  # --
+  # -- dq => double quote
+  # -- Deliver a \" (backslash double quote).
+  # -- Can solve the \\\ triple backslash problem.
+  # -- Use in Ruby and .ini fact files.
+  # --
+  def self.dq
+    return "\""
+  end
+
+end
+
+# --
+# -- Dot the I's and Cross the T's
+# -- DEPRECATED - Use the [Do] class instead.
+# --
+class Ch
+
+  # --
+  # -- p => period (full stop)
+  # -- Deliver a "." period character
+  # --
+  def self.p
+    return "."
+  end
+
+  # --
+  # -- dq => double quote
+  # -- Deliver a \" (backslash double quote).
+  # -- Can solve the \\\ triple backslash problem.
+  # -- Use in Ruby and .ini fact files.
+  # --
+  def self.dq
+    return "\""
+  end
+
+end

data/lib/opensecret/plugins.io/facts/fact.factor.rb

@@ -0,0 +1,156 @@
+#!/usr/bin/ruby
+
+class Refactor
+
+  # --
+  # --   Convert the parameter 2D map to a 1D map that respects
+  # --   the placeholder convention.
+  # --
+  # --   ------------------
+  # --   Original INI File
+  # --   ------------------
+  # --
+  # --   [windows]
+  # --   maker = Microsoft
+  # --   version = Windows 10 SP2
+  # --
+  # --   [ubuntu]
+  # --   maker = Canonical
+  # --   version = Ubuntu 16.04
+  # --
+  # --   -----------------
+  # --   Fact 2D Database
+  # --   -----------------
+  # --
+  # --   @f[:windows][:maker] => Microsoft
+  # --   @f[:windows][:version] => Windows 10 SP2
+  # --   @f[:ubuntu][:maker] => Canonical
+  # --   @f[:version][:version] => Ubuntu 16.04
+  # --
+  # --   ------------------------------------
+  # --   Flattened 1D Placeholder Key Values
+  # --   ------------------------------------
+  # --
+  # --   @flat[ '@[windows|maker]' ]   => Microsoft
+  # --   @flat[ '@[windows|version]' ] => Windows 10 SP2
+  # --   @flat[ '@[ubuntu|maker]' ]    => Canonical
+  # --   @flat[ '@[ubuntu|version]' ]  => Ubuntu 16.04
+  # --
+  def self.flatten fact_db
+
+    flat_db = {}
+
+    fact_db.each do |grp_name,list_db|
+      list_db.each do |key_name,key_value|
+        grp_str = grp_name.to_s.gsub("_", ".")
+        key_str = key_name.to_s.gsub("_", ".")
+
+        flat_db[ "@[#{grp_str}|#{key_str}]" ] = key_value
+      end
+
+    end
+
+    return flat_db
+
+  end
+
+
+  # --
+  # -- Produce a multiline [sandwiched] string with the
+  # -- prefix and postfix sandwiching the array element.
+  # -- Furthermore and the specified number of spaces by
+  # -- as an indent before the prefix of each line.
+  # --
+  # -- ---------
+  # -- Example
+  # -- ---------
+  # --
+  # --   x_array    : mon, tue, wed, thu, fri
+  # --   prefix     : <weekday>
+  # --   postfix    : </weekday>
+  # --   indent_len : 8
+  # --
+  # -- x_to_y changes horizontal x to multi-line y
+  # --
+  # --    <weekday>mon</weekday>
+  # --    <weekday>tue</weekday>
+  # --    <weekday>wed</weekday>
+  # --    <weekday>thu</weekday>
+  # --    <weekday>fri</weekday>
+  # --
+  # -- ------------
+  # -- Parameters
+  # -- ------------
+  # --
+  # --   str_array  : array of strings to enwrap
+  # --   prefix     : the lead element of the sandwich
+  # --   postfix    : the tail element of the sandwich
+  # --   indent_len : the length (spaces) of indent
+  # --
+  # -- Return
+  # --   the multiline enwrapped string
+  # --
+  def self.sandwich_lines in_array, prefix, postfix, indent_len
+
+    out_array = Array.new
+    indent_str = " " * indent_len
+    in_array.each do | str_to_wrap |
+      out_array.push( indent_str + prefix + str_to_wrap + postfix )
+    end
+
+    return out_array.join( "\n" )
+
+  end
+
+  # -- -------------------------------------------------- -- #
+  # -- Return an (out) array of [sandwiched] strings with -- #
+  # -- the [prefix] and [postfix] sandwiching each of the -- #
+  # -- (in) array elements.                               -- #
+  # --                                                    -- #
+  # -- -------------------------------------------------- -- #
+  # -- Example                                            -- #
+  # -- -------------------------------------------------- -- #
+  # --                                                    -- #
+  # --   x_array   : mon, tue, wed, thu, fri              -- #
+  # --   prefix    : <weekday>                            -- #
+  # --   postfix   : </weekday>                           -- #
+  # --                                                    -- #
+  # -- x_to_y changes horizontal x to multi-line y        -- #
+  # --                                                    -- #
+  # --    <weekday>mon</weekday>                          -- #
+  # --    <weekday>tue</weekday>                          -- #
+  # --    <weekday>wed</weekday>                          -- #
+  # --    <weekday>thu</weekday>                          -- #
+  # --    <weekday>fri</weekday>                          -- #
+  # --                                                    -- #
+  # -- -------------------------------------------------- -- #
+  # -- Parameters                                         -- #
+  # -- -------------------------------------------------- -- #
+  # --   in_array  : array of strings to enwrap           -- #
+  # --   prefix    : the lead element of the sandwich     -- #
+  # --   postfix   : the tail element of the sandwich     -- #
+  # --                                                    -- #
+  # -- Return                                             -- #
+  # --   an array of the sandwiched elements              -- #
+  # -- -------------------------------------------------- -- #
+  def self.sandwich_array in_array, prefix, postfix
+
+    out_array = Array.new
+    in_array.each do | wrap_str |
+      out_array.push prefix + wrap_str + postfix
+    end
+
+    log.info(ere) {"sandwiching array strings with supplied prefix and postfix."}
+    log.info(ere) {"sandwich prefix  => #{prefix}"}
+    log.info(ere) {"sandwich postfix => #{postfix}"}
+    log.info(ere) {"the incoming array (to sandwich) size => #{in_array.length}"}
+
+    log.debug(ere) { "IN ARRAY => #{pp in_array}" }
+    log.debug(ere) { "IN ARRAY => #{pp out_array}" }
+
+    return out_array
+
+  end
+
+
+end

data/lib/opensecret/plugins.io/facts/fact.locator.rb

@@ -0,0 +1,105 @@
+#!/usr/bin/ruby
+
+# --
+# -- Locate fact files using the stated convention when
+# -- given the name and path of a module.
+# --
+class FactLocator
+
+  @@eco_factdir = "eco.system.facts"
+  @@fact_endtag = "factbase.ini"
+
+  # --
+  # -- Find path to class hierarchy fact file by convention.
+  # --
+  # -- -----------
+  # -- Convention
+  # -- -----------
+  # --
+  # -- Logic => read the module full file path
+  # --       => go down 2 directories (parent of parent)
+  # --       => go into folder eco.system.facts
+  # --       => add database.ini to extensionless module name
+  # --
+  # -- -----------
+  # -- Example
+  # -- -----------
+  # --
+  # --  module_path => /home/dir/prj/street/my_house.rb
+  # --  module_dir  => /home/dir/prj
+  # --  fact folder => /home/dir/prj/eco.system.facts
+  # --  fact [file] => /home/dir/prj/eco.system.facts/my_house.factbase.ini
+  # --
+  # --  factdb_path => /home/dir/prj/street/eco.system.facts/my_house.factbase.ini
+  # --
+  def self.hierarchy_factdb_path module_path
+
+    module_name = File.basename module_path, File.extname(module_path)
+    factdb_name = "#{module_name}.#{@@fact_endtag}"
+    return File.join fact_base_dir(module_path), factdb_name
+  end
+
+
+  def self.keyfacts_factdb_path module_path
+
+    factdb_name = "facts.eco-instance.ini"
+    return File.join fact_base_dir(module_path), factdb_name
+
+  end
+
+
+  def self.workstation_factdb_path module_path
+
+    factdb_name = "facts.workstation.#{NetDns.instance.host_name}.ini"
+    return File.join fact_base_dir(module_path), factdb_name
+
+  end
+
+
+  # --
+  # -- Get the [fact databases] base directory given
+  # -- the full path to the requesting module.
+  # --
+  # -- ----------------------
+  # -- Acquire Base Dir Logic
+  # -- ----------------------
+  # --
+  # -- To acquire the base directory given the full
+  # -- path to the requesting module we
+  # --
+  # --   1 => go down 2 directories (parent of parent)
+  # --   2 => go into folder eco.system.facts
+  # --
+  def self.fact_base_dir module_path
+    fact_basedir = File.dirname( File.dirname( module_path ) )
+    return File.join fact_basedir, @@eco_factdir
+  end
+
+  # --
+  # -- --------------
+  # -- Use Case
+  # -- --------------
+  # -- Find path to method block scoped fact file by convention.
+  # --
+  # -- --------------
+  # -- Example
+  # -- --------------
+  # --  module_path => /home/dir/prj/street/my_flat.rb
+  # --  module_dir  => /home/dir/prj/street
+  # --  module_name => my_flat
+  # --  method_name => to_rooms
+  # --  fact_folder = module_dir / eco.system.facts
+  # --
+  # --  factdb_path => /home/dir/prj/eco.system.facts/my_flat.to.rooms.ini
+  # --
+  def self.block_factdb_path module_path, method_symbol
+
+    module_name = File.basename module_path, File.extname(module_path)
+    method_name = method_symbol.to_s.gsub("_", ".")
+    factdb_name = module_name + "." + method_name + ".ini"
+    return File.join fact_base_dir(module_path), factdb_name
+
+  end
+
+
+end

data/lib/opensecret/plugins.io/facts/fact.reader.rb

@@ -0,0 +1,137 @@
+#!/usr/bin/ruby
+
+    ## --- ---------------------------------------------------------------------- --- #
+    ## --- How to Use File to extract different parts of an [absolute] file path. --- #
+    ## --- ---------------------------------------------------------------------- --- #
+    ##       ====] file = "/path/to/xyz.mp4"
+    ## --- ---------------------------------------------------------------------- --- #
+    ##       ====] comp = File.basename file        # => "xyz.mp4"
+    ##       ====] extn = File.extname  file        # => ".mp4"
+    ##       ====] name = File.basename file, extn  # => "xyz"
+    ##       ====] path = File.dirname  file        # => "/path/to"
+    ## --- ---------------------------------------------------------------------- --- #
+
+# -- --------------------------------------------------------------------- -- #
+# -- Global (dictionary) fact manager.                                     -- #
+# -- --------------------------------------------------------------------- -- #
+class FactReader
+
+  attr_reader :f
+
+  # -
+  # -- Create a fact database given an INI file
+  # -- as well as an initial 2D database entry,
+  # -- and a parental fact database whose facts
+  # -- can be reused.
+  # -
+  # -- @f will be the referenciable object wide
+  # -- name for the created fact database.
+  # -
+  # -- Parameters
+  # --   fact_data     : parental fact database
+  # --   ini_filepath  : path to src INI factfile
+  # --   group_symbol  : for first param entry
+  # --   key_symbol    : for first param entry
+  # --   key_value     : for first param entry
+  # -
+  # -- Dependencies and Assumptions
+  # --   the [inifile] gem is installed
+  # --   file exists at the ini_filepath
+  # --   factory_facts are instantiated
+  # -
+  def initialize fact_data, ini_filepath, group_symbol, key_symbol, key_value
+
+    # -- ---------------------------------------------------- -- #
+    # -- This time use param fact database for instantiation. -- #
+    # -- ---------------------------------------------------- -- #
+    @f = fact_data.nil? ? {} : fact_data
+
+    # -- ------------------------------------------------ -- #
+    # -- Add initializr (parameter) fact to the database. -- #
+    # -- ------------------------------------------------ -- #
+    add_fact group_symbol, key_symbol, key_value unless group_symbol.nil? && key_symbol.nil? && key_value.nil?
+
+    # -- ------------------------------------------ -- #
+    # -- Assimilate all the facts in this INI file. -- #
+    # -- ------------------------------------------ -- #
+    assimilate_ini_file ini_filepath
+
+  end
+
+
+  # -- ------------------------------------------- -- #
+  # -- Read the PROPERTY file key/value pairs      -- #
+  # -- and store them in the fact database under   -- #
+  # -- the group symbol specified.                 -- #
+  # --                                             -- #
+  # -- Can be used to assimilate files like the    -- #
+  # -- ubiquitous application.properties into the  -- #
+  # -- fact database.                              -- #
+  # --                                             -- #
+  # -- Subsequently, the incoming facts can then   -- #
+  # -- be consumed, updated and deleted as per the -- #
+  # -- usual protocols.                            -- #
+  # -- ------------------------------------------- -- #
+  # -- property file facts are NOT evaluated they  -- #
+  # -- are simply assumed to be strings.           -- #
+  # -- ------------------------------------------- -- #
+  # -- Parameters                                  -- #
+  # --   property_filepath  : path to prop file    -- #
+  # --   group_symbol       : collection 4 facts   -- #
+  # --                                             -- #
+  # -- Dependencies and Assumptions                -- #
+  # --   properties file exists and formatted      -- #
+  # --   group symbol not added if already exists  -- #
+  # --   props are not eval'd - assumed 2b "strs"  -- #
+  # -- ------------------------------------------- -- #
+  def assimilate_property_file property_filepath, group_symbol
+
+    return unless File.exists? property_filepath
+
+    then_count = @f[group_symbol].nil? ? 0 : @f[group_symbol].length
+
+    IO.foreach( property_filepath ) do |dirty_file_line|
+
+      file_line = dirty_file_line.strip
+      next if file_line.empty?
+      next if file_line.start_with? "#"
+
+      segments = file_line.split("=")
+      raise_properrty_error if segments.length < 2
+      property_value = file_line[(segments.first.length+1)..-1]
+
+      key_symbol = segments.first.strip.gsub(".","_").to_sym
+      add_fact group_symbol, key_symbol, property_value
+
+    end
+
+    now_count = @f[group_symbol].nil? ? 0 : @f[group_symbol].length
+
+    log.info(ere) { "[fact reader] -------------------------------------------------------- -- #" }
+    log.info(ere) { "[fact reader] THEN => [#{then_count}] properties existed (and)" }
+    log.info(ere) { "[fact reader] NOW  => [#{now_count}] properties exist." }
+    log.info(ere) { "[fact reader] -------------------------------------------------------- -- #" }
+    LogObject.map @f[group_symbol]
+    log.info(ere) { "[fact reader] -------------------------------------------------------- -- #" }
+
+  end
+
+
+  # -- --------------------------------------------------------- -- #
+  # -- If a line in the property file contains less than two     -- #
+  # -- segments (using equals = as the divider), raise error.    -- #
+  # -- --------------------------------------------------------- -- #
+  def raise_properrty_error file_path, file_line, segments
+
+      error_desc = "Expected app properties file line to contain at least one equals."
+      error_vals = "Instead [#{segments.length}] parts were found in the array."
+      error_line = "file path => #{file_path}"
+      error_line = "file line => #{file_line}"
+      error_pair = "key value => #{segments.to_s}"
+      error_text = "\n\n#{error_desc}\n#{error_vals}\n\n#{error_line}\n\n#{error_pair}"
+      raise SyntaxError.new error_text
+  
+  end
+
+
+end