safedb 0.5.1002 → 0.5.1003

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 34b23980c41abb1e67618bd929f7ad6f5cfcb94e9ba4e544f1705de0cc6a373f
-  data.tar.gz: f18424a4b24e4b2e3567636965808ca50dac2f9d67162881bc10e91d6b97d368
+  metadata.gz: fc97d7955c363f290d97994018b73806d1d465fdc8628bc299069bc0b4c2a43c
+  data.tar.gz: a0885f01b7fd396cf0860df2ba1383fb58222e62ebd298febf5c2aaa898ab071
 SHA512:
-  metadata.gz: b0e55ef10dbddd910a847133be163013318af044298b7caf430004c1da74df858e8891d4a1b578711cd0f628d91ed532d5febdf376369af535e3cb3e57424a1f
-  data.tar.gz: ab6db9f7ad3dbb068adb99afd533117770bb695cf1fd16a8f9030c08446679ae45004a91517e92288eef7173415617513a71427cb3410772a7aea4920adc5e09
+  metadata.gz: 989bd998cc21841345b12f8bb2d3a74191203ce11d9895cd54e000fc597804988fe80cf76d0874a2d3c60e8e3a1d1bc1addf36f1db7a8c8edaef815b4c78091a
+  data.tar.gz: 35856adea81b13c0940c2ef8ce122fdfa19ebbdfad734a8eb6dad08f3e430c7b803c68afd54a68a88abb0b8ec91a74b2c58797c631233b8f1729ca484b54eb21

data/lib/cli.rb

@@ -72,7 +72,7 @@ class CLI < Thor
 
     puts ""
     puts "safedb gem version => v#{SafeDb::VERSION}"
-    puts "time and date now  => #{SafeDb::KeyNow.human_readable()}"
+    puts "time and date now  => #{SafeDb::TimeStamp.human_readable()}"
     puts "safedb @github.com => https://github.com/devops4me/safedb.net"
     puts "safe @rubygems.org => https://rubygems.org/gems/safedb"
     puts ""
@@ -325,6 +325,25 @@ class CLI < Thor
 
 
 
+  # Description of the generate command.
+  desc "generate <line>", "generate a string password that conforms to configured properties"
+
+  # The <b>generate use case</b> generates a random string credential that abides by
+  # the laws set out by configured and/or default parameter properties. These properties
+  # include the character superset to which all credential characters belong, the median
+  # length of the credential and the (give or take) span denoting the shortest and
+  # longest possible credentials.
+  #
+  # @param line [String] name of line the credential is stored against. Defaults to @password
+  def generate( line = "@password" )
+    log.info(x) { "generate a string credential and store it against line [#{line}]." }
+    generate_uc = SafeDb::Generate.new()
+    generate_uc.line = line
+    generate_uc.flow()
+  end
+
+
+
   # Description of the remove command.
   desc "remove <line_id>", "remove a line (key/value pair), or a verse, chapter and even a book"
 
@@ -341,6 +360,22 @@ class CLI < Thor
 
 
 
+  # Description of the rename command.
+  desc "rename <now_name> <new_name>", "rename an existing chapter, verse or line"
+
+  # The <b>rename use case</b> can rename an existing chapter, verse or line.
+  # @param now_name [String] the existing name of the chapter, verse or line
+  # @param new_name [String] the new name the chapter, verse or line goes by
+  def rename now_name, new_name
+    log.info(x) { "rename the existing chapter, verse or line from [ #{now_name} ] to [ #{new_name} ]." }
+    rename_uc = SafeDb::Rename.new()
+    rename_uc.now_name = now_name
+    rename_uc.new_name = new_name
+    rename_uc.flow()
+  end
+
+
+
   # Description of the read command.
   desc "read <file_url>", "read file into the open chapter and verse for safe keeping."
 

data/lib/controller/admin/{access.rb → auth.rb}

@@ -4,8 +4,10 @@ module SafeDb
 
   # Parent to use cases like Init and Login that perform early
   # initialize workflows.
-  class AccessUc < Controller
+  class Auth < Controller
 
+    # This authorization use case should always have a book name
+    # provided and sometimes may have a password parameter.
     attr_writer :password, :book_name
 
 
@@ -29,7 +31,6 @@ module SafeDb
 
     end
 
-
     def contains_all_master_book_indices( data_map )
       return false unless data_map.contains?( Indices::CONTENT_RANDOM_IV )
       return false unless data_map.contains?( Indices::CONTENT_IDENTIFIER )

data/lib/controller/admin/commit.rb

@@ -39,7 +39,7 @@ module SafeDb
 
       StateMigrate.commit( @book )
 
-      puts "The commit was on #{KeyNow.readable()}\n"
+      puts "The commit was on #{TimeStamp.readable()}\n"
       puts "Commit from branch to master was successful.\n"
       puts ""
 

data/lib/controller/admin/export.rb

@@ -23,7 +23,7 @@ module SafeDb
       puts " Open Verse   := #{@book.get_open_verse_name()}\n"   if @book.has_open_verse_name?()
       puts ""
 
-      export_filename = "safedb.#{KeyNow.yyjjj_hhmm_ss_nanosec()}.#{@book.book_id()}.json"
+      export_filename = "safedb.#{TimeStamp.yyjjj_hhmm_ss_nanosec()}.#{@book.book_id()}.json"
       export_filepath = File.join( Dir.pwd, export_filename )
 
       exported_struct = {}

data/lib/controller/admin/import.rb

@@ -26,7 +26,7 @@ module SafeDb
       puts " Book Name   := #{@book.book_name()}\n"
       puts " Book Id     := #{@book.book_id()}\n"
       puts " Import from := #{@import_filepath}\n"
-      puts " Import time := #{KeyNow.readable()}\n"
+      puts " Import time := #{TimeStamp.readable()}\n"
       puts ""
 
       new_verse_count = 0

data/lib/controller/admin/init.rb

@@ -28,7 +28,7 @@ module SafeDb
   # - the book name ( maybe from SAFE_BOOK_NAME ) follows convention
   # - the shell must have a SAFE_TTY_TOKEN environment variable
   #
-  class Init < AccessUc
+  class Init < Auth
 
 
     def execute
@@ -71,7 +71,7 @@ module SafeDb
     def virginal_book()
 
       initial_db = DataStore.new()
-      initial_db.store( Indices::SAFE_BOOK_INITIALIZE_TIME, KeyNow.readable() )
+      initial_db.store( Indices::SAFE_BOOK_INITIALIZE_TIME, TimeStamp.readable() )
       initial_db.store( Indices::SAFE_BOOK_NAME, @book_name )
       initial_db.store( Indices::SAFE_BOOK_INIT_VERSION, Indices::SAFE_VERSION_STRING )
       initial_db.store( Indices::SAFE_BOOK_CHAPTER_KEYS, {} )

data/lib/controller/admin/login.rb

@@ -23,7 +23,7 @@ module SafeDb
   # - a file in the present directory (with a pre-agreed name)
   # - a URL from a parameter or pre-agreed
   # - the shell's secure password reader
-  class Login < AccessUc
+  class Login < Auth
 
     # If the clip switch is present it signifies that the password should
     # be read in from the clipboard. Any text selection puts text into the

data/lib/controller/edit/generate.rb

@@ -0,0 +1,76 @@
+#!/usr/bin/ruby
+	
+module SafeDb
+
+  # The <b>generate use case</b> generates a random string credential that abides by
+  # the laws set out by configured and/or default parameter properties. These properties
+  # include the character superset to which all credential characters belong, the median
+  # length of the credential and the (give or take) span denoting the shortest and
+  # longest possible credentials.
+  #
+  # If the parameter line already exists in the verse, it is backed up by appending
+  # it with a timestamp to prevent overwriting (and losing) the old value forever. This
+  # no clobber behaviour can be switched off by passing the --overwrite flag.
+  class Generate < EditVerse
+
+    # This is the name of the key the generated randomized string will be
+    # stored against within the current opened chapter and verse.
+    attr_writer :line
+
+    # A default median length of 14 characters with a give or take
+    # span of two means that the resulting password length could be
+    # one of either 12, 13, 14, 15 or 16 characters.
+    MEDIAN_LENGTH = 14
+
+    # If a median length of 15 is required with give or take set
+    # at 3 - the resulting password length could be anything from
+    # a minimum of 12 (15 - 3) to a maximum of 18 (15 + 3).
+    GIVE_OR_TAKE_SIZE = 2
+
+    # The length range typifies the set of possible credential lengths
+    # that can be produced by this class. The lower bound is the median
+    # length less give or take, the upper bound is the median length
+    # plus the give or take size.
+    LENGTH_RANGE = (MEDIAN_LENGTH - GIVE_OR_TAKE_SIZE) .. ( MEDIAN_LENGTH + GIVE_OR_TAKE_SIZE)
+
+    # The super strong non alpha-numeric character set has a large
+    # set of characters configured for the most secure credentials
+    # protecting security concious application states.
+    STRONG_CHARACTERS = "?@=$~%/+^.,][\{\}\<\>\&\(\)_\-"
+
+    # The widely accepted non alpha-numeric character set contains
+    # these characters
+    #
+    # - an @ sign
+    # - a percent sign
+    # - plus sign
+    # - a period
+    # - a comma
+    # - an (open) square bracket
+    # - a (close) square bracket
+    # - an underscore
+    # - a hyphen
+    WIDELY_ACCEPTED_CHARS = "@%+.,][_\-"
+
+    # This is the command used to generate the credentials stream.
+    GENERATE_CMD = "head /dev/urandom | tr -dc A-Za-z0-9#{WIDELY_ACCEPTED_CHARS} | head -c 258"
+
+    # The <b>generate use case</b> generates random strings that abide by a configured
+    # median length, span size, and a configured superset of characters that the generated
+    # credentials characters will be a subset of.
+    def edit_verse()
+
+      credential_length = Random.new().rand( LENGTH_RANGE )
+      credential_stream = %x[ #{GENERATE_CMD} ]
+      credential_string = credential_stream.chomp()[ 0 .. ( credential_length - 1 ) ]
+      
+      @verse.store( "#{@line}-#{TimeStamp.yyjjj_hhmm_sst()}", @verse[ @line ] ) if @verse.has_key?( @line )
+      @verse.store( @line, credential_string )
+
+    end
+
+
+  end
+
+
+end

data/lib/controller/edit/remove.rb

@@ -17,6 +17,9 @@ module SafeDb
     # wants to delete only one line (key/value pair).
     def edit_verse()
 
+      # @todo refactor to recognise file values using isMap rather than the string prefix
+      # @todo refactor the Rename, Show, Read and Write use cases as well as this one.
+
       @verse.delete( @line_id )
       @verse.delete( "#{Indices::INGESTED_FILE_LINE_NAME_KEY}#{@line_id}" )
 

data/lib/controller/edit/rename.rb

@@ -0,0 +1,57 @@
+#!/usr/bin/ruby
+	
+module SafeDb
+
+  # The <b>rename use case</b> when applied at the verse level changes the
+  # stated <em>line keyname</em>.
+  #
+  class Rename < EditVerse
+
+    # The id of the current chapter, verse or line entity to be renamed is
+    # the now_name and its new name is the new_name.
+    attr_writer :now_name, :new_name
+
+    # Find the line key named now_name and replace it with the provided
+    # new_name. The validation for keynames applies, both must be provided and
+    # the now_name must exist. This use case also renames file keys.
+    def edit_verse()
+
+# @todo refactor to recognise file values using isMap rather than the string prefix
+# @todo refactor the Remove, Show, Read and Write use cases as well as this one.
+
+      exit(100) unless has_line?()
+
+      current_value = @verse[ @now_name ]
+
+# @todo instead of store and delete use the hash key rename method
+      @verse.store( @new_name, current_value ) unless is_file?()
+      @verse.store( "#{Indices::INGESTED_FILE_LINE_NAME_KEY}#{@new_name}", current_value ) if is_file?()
+
+      @verse.delete( "#{Indices::INGESTED_FILE_LINE_NAME_KEY}#{@now_name}" )
+      @verse.delete( @now_name )
+
+    end
+
+
+    private
+
+
+    def is_file?()
+      return @verse.has_key?( "#{Indices::INGESTED_FILE_LINE_NAME_KEY}#{@now_name}" )
+    end
+
+    def has_line?()
+
+      return true if( @verse.has_key?( @now_name ) || @verse.has_key?( "#{Indices::INGESTED_FILE_LINE_NAME_KEY}#{@now_name}" ) )
+      @book.print_book_mark()
+      puts ""
+      puts "Line [ #{@now_name} ] is not in this chapter/verse."
+      puts ""
+      return false
+
+    end
+
+  end
+
+
+end

data/lib/controller/files/write.rb

@@ -32,7 +32,7 @@ module SafeDb
       destination_dir = @to_dir unless @to_dir.nil?
 
       file_full_path = File.join( destination_dir, simple_filename )
-      backup_filename = KeyNow.yyjjj_hhmm_sst() + "-" + simple_filename
+      backup_filename = TimeStamp.yyjjj_hhmm_sst() + "-" + simple_filename
       backup_file_path = File.join( destination_dir, backup_filename )
       will_clobber = File.file?( file_full_path )
 

data/lib/controller/id.rb

@@ -9,8 +9,8 @@ module SafeDb
     def execute
 
       puts ""
-      puts KeyNow.grab()
-      puts KeyNow.fetch()
+      puts TimeStamp.grab()
+      puts TimeStamp.fetch()
       puts ""
 
       return

data/lib/controller/requirer.rb

@@ -87,16 +87,11 @@ module SafeDb
 
       require_relative "../version"
       require_relative "../controller/controller"
-      require_relative "../controller/admin/access"
+      require_relative "../controller/admin/auth"
       require_relative "../controller/edit/editverse"
       require_relative "../controller/query/queryverse"
 
       gem_basepath = File.expand_path "..", gem_filepath
-
-      log.debug(x) { "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@" }
-      log.debug(x) { "@@@@ Require Gems In or Under [#{gem_basepath}]" }
-      log.debug(x) { "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@" }
-
       Dir["#{gem_basepath}/**/*.rb"].each do |gem_path|
 
         log.debug(x) { "@@@@ => #{gem_path}" }
@@ -104,8 +99,6 @@ module SafeDb
 
       end
 
-      log.debug(x) { "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@" }
-
     end
 
   end

data/lib/model/state.inspect.rb

@@ -137,6 +137,7 @@ module SafeDb
     private
 
 
+
     def self.data_differences( this_data, that_data )
 
       this_data.each_pair do | chapter_name, master_verse_data |
@@ -171,6 +172,7 @@ module SafeDb
 
     end
 
+
     def self.drop_differences( this_data, that_data )
 
       this_data.each_pair do | chapter_name, master_verse_data |
@@ -200,6 +202,7 @@ module SafeDb
 
     end
 
+
     def self.print_chapter_2b_added( fq_chap_name )
       puts " + Chapter 2b added -> #{fq_chap_name}"
     end

data/lib/model/state.migrate.rb

@@ -243,7 +243,7 @@ module SafeDb
 
       keypairs = DataMap.new( Indices::MASTER_INDICES_FILEPATH )
       keypairs.use( book_identifier )
-      keypairs.set( Indices::SAFE_BOOK_INITIALIZE_TIME, KeyNow.readable() )
+      keypairs.set( Indices::SAFE_BOOK_INITIALIZE_TIME, TimeStamp.readable() )
       keypairs.set( Indices::COMMIT_IDENTIFIER, Identifier.get_random_identifier( 16 ) )
     end
 
@@ -314,14 +314,14 @@ module SafeDb
       branch_exists = File.exists? FileTree.branch_indices_filepath( branch_id )
       branch_keys = DataMap.new( FileTree.branch_indices_filepath( branch_id ) )
       branch_keys.use( Indices::BRANCH_DATA )
-      branch_keys.set( Indices::BRANCH_INITIAL_LOGIN_TIME, KeyNow.readable() ) unless branch_exists
-      branch_keys.set( Indices::BRANCH_LAST_ACCESSED_TIME, KeyNow.readable() )
+      branch_keys.set( Indices::BRANCH_INITIAL_LOGIN_TIME, TimeStamp.readable() ) unless branch_exists
+      branch_keys.set( Indices::BRANCH_LAST_ACCESSED_TIME, TimeStamp.readable() )
       branch_keys.set( Indices::CURRENT_BRANCH_BOOK_ID, book_id )
 
       logged_in = branch_keys.has_section?( book_id )
       branch_keys.use( book_id )
-      branch_keys.set( Indices::BOOK_BRANCH_LOGIN_TIME, KeyNow.readable() ) unless logged_in
-      branch_keys.set( Indices::BOOK_LAST_ACCESSED_TIME, KeyNow.readable() )
+      branch_keys.set( Indices::BOOK_BRANCH_LOGIN_TIME, TimeStamp.readable() ) unless logged_in
+      branch_keys.set( Indices::BOOK_LAST_ACCESSED_TIME, TimeStamp.readable() )
 
       return branch_keys
 

data/lib/model/text_chunk.rb

@@ -20,7 +20,7 @@ module SafeDb
 #{Indices::SAFE_URL_NAME} ciphertext block
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 Safe Book Id := #{book_id}
-Time Created := #{KeyNow.readable()}
+Time Created := #{TimeStamp.readable()}
 Safe Version := #{Indices::SAFE_VERSION_STRING}
 Safe Website := #{Indices::SAFE_GEM_WEBSITE}
 RubyGems.org := https://rubygems.org/gems/safedb

data/lib/utils/time/timestamp.rb

@@ -10,7 +10,7 @@ module SafeDb
   # The central idea behind the pattern is to link every infrastructure
   # object created during a branch with a reference accurate to the nearest
   # centi-second denoting the moment the software runtime (branch) began.
-  class KeyNow
+  class TimeStamp
     include Singleton
 
     attr_reader :time_now
@@ -19,7 +19,7 @@ module SafeDb
     # @example 02 => in February
     #
     def self.mo
-      return KeyNow.instance.time_now.strftime "%m"
+      return TimeStamp.instance.time_now.strftime "%m"
     end
 
 
@@ -27,7 +27,7 @@ module SafeDb
     # @example feb => in February
     #
     def self.mmm
-      return KeyNow.instance.time_now.strftime( "%b" ).downcase
+      return TimeStamp.instance.time_now.strftime( "%b" ).downcase
     end
 
 
@@ -36,7 +36,7 @@ module SafeDb
     # @example tue => on Tuesday
     #
     def self.ddd
-      return KeyNow.instance.time_now.strftime( "%a" ).downcase
+      return TimeStamp.instance.time_now.strftime( "%a" ).downcase
     end
 
 
@@ -45,7 +45,7 @@ module SafeDb
     # @example 22 => between 22.00.00 and 22.59.59 inclusive
     #
     def self.hh
-      return KeyNow.instance.time_now.strftime "%H"
+      return TimeStamp.instance.time_now.strftime "%H"
     end
 
 
@@ -53,7 +53,7 @@ module SafeDb
     # Return two digit minute of hour from [00] to [59].
     #
     def self.mm
-      return KeyNow.instance.time_now.strftime "%M"
+      return TimeStamp.instance.time_now.strftime "%M"
     end
 
 
@@ -61,7 +61,7 @@ module SafeDb
     # Return two digit second of minute from [00] to [59].
     #
     def self.ss
-      return KeyNow.instance.time_now.strftime "%S"
+      return TimeStamp.instance.time_now.strftime "%S"
     end
 
 
@@ -93,7 +93,7 @@ module SafeDb
     #
     #
     def self.sst
-      millisec_string = KeyNow.instance.time_now.strftime "%L"
+      millisec_string = TimeStamp.instance.time_now.strftime "%L"
       return "#{ss}#{millisec_string[0]}"
     end
 
@@ -103,7 +103,7 @@ module SafeDb
     # that we are currently in.
     #
     def self.yy
-      return KeyNow.instance.time_now.strftime("%Y")[2..-1]
+      return TimeStamp.instance.time_now.strftime("%Y")[2..-1]
     end
 
 
@@ -112,7 +112,7 @@ module SafeDb
     # that we are currently in.
     #
     def self.yyyy
-      return KeyNow.instance.time_now.strftime("%Y")
+      return TimeStamp.instance.time_now.strftime("%Y")
     end
 
 
@@ -120,7 +120,7 @@ module SafeDb
     # Return 3 digit julian day of year [001] to [366]. -- #
     # ------------------------------------------------- -- #
     def self.jjj
-      return KeyNow.instance.time_now.strftime "%j"
+      return TimeStamp.instance.time_now.strftime "%j"
     end
 
 
@@ -257,11 +257,6 @@ module SafeDb
     # hour, 2 digit minute, 2 digit second and 1 digit rounded
     # down tenth of second.
     #
-    # @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.
@@ -311,7 +306,7 @@ module SafeDb
     #    23 characters are always returned with three (3) period
     #    separators at the 6th, 11th and 14th positions.
     def self.yyjjj_hhmm_ss_nanosec
-      nanosec_str = KeyNow.instance.time_now.strftime "%9N"
+      nanosec_str = TimeStamp.instance.time_now.strftime "%9N"
       return "#{yyjjj}.#{hhmm}.#{ss}.#{nanosec_str}"
     end
 
@@ -375,7 +370,7 @@ module SafeDb
 
     # Return the Rubyfied time zone being used.
     def self.zone
-      return KeyNow.instance.time_now.zone
+      return TimeStamp.instance.time_now.zone
     end
 
 
@@ -385,7 +380,7 @@ module SafeDb
     def self.log_instance_time
 
       log.debug(x) { "[stamp] -------------- => -------------------------------- #" }
-      log.debug(x) { "[stamp] eco time stamp => [#{KeyNow.instance.time_now.ctime}]" }
+      log.debug(x) { "[stamp] eco time stamp => [#{TimeStamp.instance.time_now.ctime}]" }
       log.debug(x) { "[stamp] -------------- => -------------------------------- #" }
       log.debug(x) { "[stamp] Univ Time Zone => #{zone}"  }
       log.debug(x) { "[stamp] Month Index is => #{mo}"    }
@@ -413,7 +408,7 @@ module SafeDb
     end
 
 
-    KeyNow.log_instance_time
+    TimeStamp.log_instance_time
 
 
   end

data/lib/version.rb

@@ -1,3 +1,3 @@
 module SafeDb
-  VERSION = "0.5.1002"
+  VERSION = "0.5.1003"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: safedb
 version: !ruby/object:Gem::Version
-  version: 0.5.1002
+  version: 0.5.1003
 platform: ruby
 authors:
 - Apollo Akora
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-25 00:00:00.000000000 Z
+date: 2019-04-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bcrypt
@@ -129,7 +129,7 @@ files:
 - bin/safe
 - lib/cli.rb
 - lib/controller/admin/README.md
-- lib/controller/admin/access.rb
+- lib/controller/admin/auth.rb
 - lib/controller/admin/commit.rb
 - lib/controller/admin/diff.rb
 - lib/controller/admin/export.rb
@@ -156,9 +156,11 @@ files:
 - lib/controller/controller.rb
 - lib/controller/edit/README.md
 - lib/controller/edit/editverse.rb
+- lib/controller/edit/generate.rb
 - lib/controller/edit/put.rb
 - lib/controller/edit/remove.rb
 - lib/controller/edit/rename.md
+- lib/controller/edit/rename.rb
 - lib/controller/files/README.md
 - lib/controller/files/read.rb
 - lib/controller/files/write.rb