opensecret 0.0.962 → 0.0.988

data/lib/session/attributes.rb

@@ -1,279 +0,0 @@
-#!/usr/bin/ruby
-# coding: utf-8
-
-# opensession contains basic behaviour for managing a client only
-# (serverless) session. Configuration directives are read and written
-# from an INI off the home directory that is created when the session
-# is first initiated.
-#
-# The session is expected to be formally closed down and that is
-# reflected by explicitly deleting the configuration file. If this
-# "session over" command is not issued a reasonable time limit is
-# then invoked when the next session command is issued.
-#
-# This "session awakening" wipes the slate clean and starts afresh
-# with regard to the two dimensional array of configuration directive
-# pointers.
-module OpenSession
-
-  require 'inifile'
-  require 'singleton'
-
-
- ## ---> Cleaning User Input - Use Me
- ## ---> Cleaning User Input - Use Me
- ## ---> Cleaning User Input - Use Me
- ## ---> Cleaning User Input - Use Me
- ## ---> Cleaning User Input - Use Me
- ## ---> Cleaning User Input - Use Me
- ## ---> Cleaning User Input - Use Me
- ## ---> Cleaning User Input - Use Me
- ## ---> Cleaning User Input - Use Me
- ## ---> Cleaning User Input - Use Me
- ## ---> Cleaning User Input - Use Me
- ## ---> Cleaning User Input - Use Me
-
-
-  def generate_username(fullname)
-    ActiveSupport::Inflector.transliterate(fullname) # change ñ => n
-      .downcase              # only lower case
-      .strip                 # remove spaces around the string
-      .gsub(/[^a-z]/, '_')   # any character that is not a letter or a number will be _
-      .gsub(/\A_+/, '')      # remove underscores at the beginning
-      .gsub(/_+\Z/, '')      # remove underscores at the end
-      .gsub(/_+/, '_')       # maximum an underscore in a row
-  end
-
-
- ## ---> Cleaning User Input - Did You Use Me?
- ## ---> Cleaning User Input - Did You Use Me?
- ## ---> Cleaning User Input - Did You Use Me?
- ## ---> Cleaning User Input - Did You Use Me?
- ## ---> Cleaning User Input - Did You Use Me?
- ## ---> Cleaning User Input - Did You Use Me?
- ## ---> Cleaning User Input - Did You Use Me?
- ## ---> Cleaning User Input - Did You Use Me?
- ## ---> Cleaning User Input - Did You Use Me?
- ## ---> Cleaning User Input - Did You Use Me?
- ## ---> Cleaning User Input - Did You Use Me?
- ## ---> Cleaning User Input - Did You Use Me?
- ## ---> Cleaning User Input - Did You Use Me?
- ## ---> Cleaning User Input - Did You Use Me?
-
-
-  # opensession contains basic behaviour for managing a client only
-  # (serverless) session. Configuration directives are read and written
-  # from an INI off the home directory that is created when the session
-  # is first initiated.
-  #
-  # The session is expected to be formally closed down and that is
-  # reflected by explicitly deleting the configuration file. If this
-  # "session over" command is not issued a reasonable time limit is
-  # then invoked when the next session command is issued.
-  #
-  # This "session awakening" wipes the slate clean and starts afresh
-  # with regard to the two dimensional array of configuration directive
-  # pointers.
-  class Attributes
-    include Singleton
-
-    @@filename_tail = "-session.ini"
-    attr_reader :time_stamp
-
-
-
-    # Stash the attribute within the session's configuration file and
-    # print out the current state of the configuration.
-    #
-    # @param context_name [String] the context will define the folder and filepath
-    # @param section_name [String] name grouping the section of config values
-    # @param key_name [String] the name of the key whose value is to be written
-    # @param key_value [String] the data item value of the key specified
-    def self.stash context_name, section_name, key_name, key_value
-
-      the_session = OpenSession::Attributes.instance
-      the_session.write_keyvalue context_name, section_name, key_name, key_value
-
-      puts ""
-      puts File.read(the_session.get_filepath(context_name))
-      puts ""
-
-    end
-
-
-
-    # This singleton (one instance) class initializes by getting
-    # the current timestamp.
-    def initialize
-
-      @time_stamp = OpenSession::Stamp.instance
-
-    end
-
-
-    #
-    # Write the key/value pair in the parameter into the session's
-    # configuration INI file that lives in a context-named folder
-    # off the home directory.
-    #
-    # The session file will be in a folder whose name is simply
-    # the dot prefixed context_name. The session file itself will
-    # be named using context_name + @@filename_tail
-    #
-    # @example ~/.openbox/openbox-session.ini is the filepath for context "openbox"
-    #
-    # If neither the folder nor file exist, both are created.
-    # If the file did not exist a new one will with the contents
-    # (if the key is length and the value is 2m).
-    #
-    # [openbox]
-    # length = 2m
-    #
-    # If the file does already exist, an appropriate merge will be
-    # performed to create or update the section name, key name and
-    # value. The file may end up looking like
-    #
-    # [closedbox]
-    # shape = cuboid
-    # color = blue
-    #
-    # [openbox]
-    # length = 2m
-    # width = 3m
-    #
-    # @param context_name [String] name of program writing a session attribute
-    # @param section_name [String] name grouping the section of config values
-    # @param key [String] the key name of config directive to be written into the file
-    # @param value [String] value of the config directive to be written into the file
-    #
-    def write_keyvalue context_name, section_name, key, value
-
-      config_file_dir = get_filedir(context_name)
-      FileUtils.mkdir_p config_file_dir unless File.exists? config_file_dir
-      config_filepath = get_filepath(context_name)
-
-      config_map = IniFile.new( :filename => config_filepath, :encoding => 'UTF-8' )
-      config_map = IniFile.load( config_filepath ) if File.exists? config_filepath
-
-      config_map[section_name][key] = value
-      config_map.write
-
-    end
-
-
-    # Given the configuration key name and the context name, get the
-    # corresponding key value from the configuration file whose path
-    # is acquired using the {self#get_filepath} method.
-    #
-    # @param context_name [String] name of program writing a session attribute
-    # @param key_name [String] the key whose value is to be retrieved
-    #
-    # @return [String] the value configured for the parameter key
-    #
-    # @raise ArgumentError for any one of a long list of reasons that
-    #     cause the key value to not be retrieved. This can range from
-    #     non-existent directories and files, non readable files, incorrect
-    #     configurations right down to missing keys or even missing values.
-    def get_value context_name, section_name, key_name
-
-      the_file = get_filepath context_name
-      raise ArgumentError.new "No configuration file found => [ #{the_file} ]" unless File.exists? the_file
-
-      the_text = File.read the_file
-      raise ArgumentError.new "Configuration file is empty => [ #{the_file} ]" if the_text.empty?
-
-      the_data = IniFile.load the_file
-      key_exists = the_data[ section_name ].has_key?( key_name )
-      raise ArgumentError.new "Key [#{key_name}] not found in section [#{section_name}] => #{the_data.to_s}" unless key_exists
-
-      rawvalue = the_data[section_name][key_name]
-      raise ArgumentError.new "Empty value 4 key [#{section_name}][#{key_name}] => #{the_data.to_s}" if rawvalue.empty?
-
-      keyvalue = rawvalue.chomp.strip
-      raise ArgumentError.new "Whitespace value 4 key [#{section_name}][#{key_name}] => #{the_data.to_s}" if keyvalue.empty?
-
-      return keyvalue
-
-    end
-
-
-    #
-    # Get the path to the session context file.
-    # This file will be in a folder whose name is simply the dot
-    # prefixed context_name. The session context file itself will
-    # be named using context_name + @@filename_tail
-    #
-    # @example ~/.openbox/openbox-session.ini is the filepath for context "openbox"
-    #
-    # @param context_name [String] name of program writing a session attribute
-    # @return [String] full path to the context configuration file
-    def get_filepath context_name
-
-      return File.join( get_filedir(context_name), "#{context_name}#{@@filename_tail}" )
-
-    end
-
-
-    #
-    # Get the directory that the session context file either does
-    # or will sit inside.
-    #
-    # The directory hangs off the home directory and is named simply
-    # as the dot prefixed context_name.
-    #
-    # @example ~/.openbox is the directory for context "openbox"
-    #
-    # @param context_name [String] name of program (or use case) context
-    # @return [String] path to directory holding context configuration file
-    def get_filedir context_name
-
-      return File.join home_directory, ".#{context_name}"
-
-    end
-
-
-    # On non-windows systems the home directory is defined
-    # perfectly by Ruby's Dir object.
-    #
-    # On Windows we sometimes get /AppData/Roaming appended
-    # onto the actual home directory. In these cases this
-    # method removes it.
-    #
-    # @return [String] the path to the machine user's home directory
-    def home_directory
-
-      return Dir.home unless Gem.win_platform?
-
-      extraneous_path = "/AppData/Roaming"
-      if Dir.home.end_with? extraneous_path then
-        return Dir.home.gsub( extraneous_path, "" )
-      end
-
-      return Dir.home
-
-    end
-
-
-    #
-    # Get the username of the logged in user. This name should
-    # not contain spaces (and should be just alphanumeric).
-    #
-    # The current implementation uses environment variables and
-    # crudely states that the username is
-    #
-    # - ENV['USERNAME'] for the Windows platform
-    # - ENV['USER'] for Linux (and everything else)
-    #
-    # @return [String] the username of the machine user
-    def username
-
-      return ENV['USERNAME'] if Gem.win_platform?
-      return ENV['USER']
-
-    end
-
-
-  end
-
-
-end

data/lib/session/dictionary.rb

@@ -1,191 +0,0 @@
-#!/usr/bin/ruby
-# coding: utf-8
-
-module OpenSession
-
-  require 'inifile'
-
-
-  # An OpenSession dictionary is a +2D (two dimensional) hash+ data
-  # structure backed by a file that can optionally be +encrypted+.
-  #
-  # It supports operations to +read from+ and +write to+ a known filepath
-  # and can optionally be given a crypt key so that it can
-  #
-  # - decrypt +after reading from+ a file
-  # - encrypt +before writing to+ a file
-  #
-  # This dictionary extends {Hash} in order to deliver on its core key value
-  # store, report and retrieve use cases.
-  #
-  # @example
-  #    This dictionary implementation is backed by an INI file
-  #    that could initially look like this.
-  #
-  #    [openbox]
-  #    length = 2m
-  #
-  #    Then we add a section called closedbox with two key value pairs.
-  #    And we add width key with a value of 3m to the openbox section.
-  #    The result will look like this.
-  #
-  #    [closedbox]
-  #    shape = cuboid
-  #    color = blue
-  #
-  #    [openbox]
-  #    length = 2m
-  #    width = 3m
-  #
-  class Dictionary < Hash
-
-
-    # Write the data in this dictionary hash map into a file-system
-    # backed mirror whose path was specified in the {self.read} method.
-    #
-    # Technology for encryption at rest is supported by this dictionary
-    # and a non-nil encryption key parameter is expected if this dictionary
-    # has been configured to encrypt data at rest.
-    #
-    # An argument error will result if a suitable key is not provided
-    # when encryption at rest is desired.
-    #
-    # Calling this {self.write} method when the file at the prescribed path
-    # does not exist results in the directory structure being created
-    # (if necessary) and then the (possibly encrypted) file being written.
-    #
-    # @param encrypt_key [String]
-    #     if encryption at rest is required this parameter must contain a
-    #     robust symmetric decryption key. The symmetric key will be used
-    #     for the decryption after the read. Note that the decryption key
-    #     does not linger meaning it isn't cached in an instance variable.
-    #
-    # @raise [ArgumentError] if +encryption at rest+ is prescribed for the
-    #     dictionary but no encryption key is provided. The +converse+
-    #     assertion will also be made.
-    def write encrypt_key = nil
-
-      file_exists = File.exists? @filepath
-      folder_path = File.dirname(@filepath) unless file_exists
-      FileUtils.mkdir_p folder_path unless file_exists
-
-      crypt_assertion encrypt_key
-      ini_file = IniFile.new
-
-      self.each_key do |section_name|
-        ini_file[section_name] = self[section_name]
-      end
-
-      ini_string = ini_file.to_s
-
-      puts ""
-      puts "============================"
-      puts "Before Encryption"
-      puts "============================"
-      puts ini_string
-      puts "============================"
-      puts ""
-
-      ini_string = Base64.encode64( OpenSecret::Blowfish.new.encryptor(ini_string,encrypt_key) ) if @encrypt_at_rest
-
-      File.write @filepath, ini_string
-
-    end
-
-
-    # Read and inject into this dictionary, map data found in a fle
-    # at the path specified in the first parameter.
-    #
-    # Technology for encryption at rest is supported by this dictionary
-    # and the second parameter being TRUE denotes that we are required
-    # to encrypt before writing and decrypt after reading.
-    #
-    # An argument error will result if a suitable key is not provided
-    # when encryption at rest is desired.
-    #
-    # If the file does not exist (boundary condition) - this read method
-    # remembers the file path as well as remembering the need for encryption
-    # at rest.
-    #
-    # @param the_filepath [String] absolute path to the file mirroring this dictionary
-    # @param is_encrypted_at_rest [Boolean] true if dictionary encryption at rest is desired
-    # @param decrypt_key [String]
-    #     if encryption at rest is required this parameter must contain a
-    #     robust symmetric decryption key. The symmetric key will be used
-    #     for the decryption after the read. Note that the decryption key
-    #     does not linger meaning it isn't cached in an instance variable.
-    #
-    # @raise [ArgumentError] if +encryption at rest+ is prescribed for the
-    #     dictionary but no encryption key is provided and the +converse+
-    #     is also true.
-    def read the_filepath, is_encrypted_at_rest, decrypt_key = nil
-
-      @filepath = the_filepath
-      @encrypt_at_rest = is_encrypted_at_rest
-      return unless File.exists? @filepath
-      crypt_assertion decrypt_key
-
-      file_contents = File.read( @filepath ).strip
-      if @encrypt_at_rest then
-        file_contents = OpenSecret::Blowfish.new.decryptor( Base64.decode64(file_contents), decrypt_key )
-      end
-
-      puts ""
-      puts "==========================="
-      puts "After Decryption"
-      puts "==========================="
-      puts file_contents
-      puts "==========================="
-      puts ""
-
-      ingest_contents file_contents
-
-    end
-
-
-    private
-
-
-    def ingest_contents the_contents
-      
-      ini_file = IniFile.new( :content => the_contents )
-      ini_file.each do | data_group, data_key, data_value |
-        ingest_entry data_group, data_key, data_value
-      end
-
-    end
-
-
-    def ingest_entry section_name, key_name, value
-
-      msg = "A NIL object detected during ingestion of file [#{@filepath}]."
-      raise RuntimetError.new msg if section_name.nil? || key_name.nil? || value.nil?
-
-      if self.has_key? section_name then
-        self[section_name][key_name] = value
-      else
-        self.store section_name, { key_name => value }
-      end
-
-    end
-
-
-    def crypt_assertion  with_crypt_key
-
-      if @encrypt_at_rest
-        msg1 = "Encryption at rest required but no (none whitespace) encryption key provided."
-        raise ArgumentError, msg1 unless !with_crypt_key.nil?
-        return
-      end
-
-      msg2 = "Encryption at rest not required but an encryption key was provided."
-      raise ArgumentError, msg2 unless with_crypt_key.nil?
-      return
-
-    end
-
-
-  end
-
-
-end