opensecret 0.0.2 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 86ac9e31e1cc902c7acb285bedb1ba5079b5f6ae
-  data.tar.gz: 93b0f8d56f778c8e1448b43bbbf587086945cd0e
+  metadata.gz: e0d63e217092bc721ad94dfb5ae966875a9fd17d
+  data.tar.gz: 87eff49362703bb87775686c8976398deeeb80f3
 SHA512:
-  metadata.gz: e4d7e2d75d0b5910e61754f290bf45d3f4f289f061055349127bbe4cc1c3ae44962c898bb7ae4c6b17825f323d6c7e58f63baed851571ce69f492710490f2287
-  data.tar.gz: 4fa24e78d89375ca01b654fd980a8dd19a214626ec57b3bc242e0ce1753c3455ef48f4acc2da0e69c02c3ce85e090a8f4ec69d4ec00daf2e4d887629adce7a06
+  metadata.gz: 66f8e8cc37da72a39d075b0e89e7786e4d6499212e165c60b8e66ad014418c8905277e478c743d4f138ee3d5396c30e52afa7f165cf3763c82e8540220efca66
+  data.tar.gz: 467e06826f0d175f88f50510da1f6c5c9dca4e5025c3da0f354bb29da5cef6277a8ef58fa92bd47090ab0f25ae2b3a2b5d6de06f99ff4b16147234b5be5ec687

data/Gemfile

@@ -1,3 +1,7 @@
+## ============================================
+## Try removing this file
+## See what happens
+## ============================================
 source "https://rubygems.org"
 
 git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }

data/README.md

@@ -1,4 +1,4 @@
-# Opensecret
+# OpenSecret
 
 Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/opensecret`. To experiment with that code, run `bin/console` for an interactive prompt.
 
@@ -40,4 +40,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Opensecret project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/opensecret/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the OpenSecret project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/opensecret/blob/master/CODE_OF_CONDUCT.md).

data/bin/opensecret

@@ -1,9 +1,6 @@
 #!/usr/bin/env ruby
  
-require 'opensecret/safe'
+# --> require 'opensecret/safe'
+require 'opensecret'
  
-puts "Hello World!"
-safe = OpenSecret::Safe.new
-safe.verbose_lock
-
-exit
+CommandProcessor.start(ARGV)

data/lib/opensecret-domain.ini

@@ -0,0 +1,23 @@
+
+
+
+
+
+opensecret configure mode="secure"
+opensecret configure mode="secure"
+
+
+
+
+[@[os|domain.id]]
+
+secrecy = play      # Options are play | secure | enterprise see website for details.
+
+
+
+[people]
+
+jack  = jackhiggins@blueyonder.com
+gaz   = gareth.southgate@gmail.com
+jiji  = johnjames23@yahoo.co.uk
+

data/lib/opensecret.rb

@@ -1,5 +1,33 @@
 require "opensecret/version"
+require "thor"
+
+module OpenSecret
+
+
+end
+
+#
+# This command line processor will
+#
+# - read the posted commands, options and switches
+# - maps the incoming string data to objects
+# - assert that the mandatory options exist
+# - assert the type of each parameter
+# - ensure that the parameter values are in range
+# - delegate processing to the registered handlers
+#
+# @note the Thor ruby gem is used for the heavy lifting
+#
+class CommandProcessor < Thor
+
+  # opensecret init lecturers@cambridge.university
+
+  desc "init DOMAIN", "DOMAIN identifies your team, friends, family or business."
+  def init( domain )
+
+    puts "You want to create the #{domain} domain.\n"
+    return "goodbye"
+
+  end
 
-module Opensecret
-  # Your code goes here...
 end

data/lib/opensecret/additions/array.rb

@@ -0,0 +1,117 @@
+#!/usr/bin/ruby
+
+# --
+# -- Reopen the core ruby Array class and add the below methods to it.
+# --
+# -- Case Sensitivity rules for [ALL] the below methods that are
+# -- added to the core Ruby string class.
+# --
+# -- For case insensitive behaviour make sure you downcase both the
+# -- string object and the parameter strings (or strings within
+# -- other parameter objects, like arrays and hashes).
+# --
+class Array
+
+  # --
+  # -- Get the text [in between] this and that delimeter [exclusively].
+  # -- Exclusively means the returned text [does not] include either of
+  # -- the matched delimeters (although an unmatched instance of [this]
+  # -- delimeter may appear in the in-between text).
+  # --
+  # -- --------------------
+  # -- Multiple Delimiters
+  # -- --------------------
+  # --
+  # -- When multiple delimiters exist, the text returned is in between the
+  # --
+  # --  [a] - first occurrence of [this] delimeter AND the
+  # --  [b] - 1st occurrence of [that] delimeter [AFTER] the 1st delimiter
+  # --
+  # -- Instances of [that] delimiter occurring before [this] are ignored.
+  # -- The text could contain [this] delimeter instances but is guaranteed
+  # -- not to contain a [that] delimeter.
+  # --
+  # -- -----------
+  # -- Parameters
+  # -- -----------
+  # --
+  # --   this_delimiter : begin delimeter (not included in returned string)
+  # --   that_delimiter : end delimeter (not included in returned string)
+  # --
+  # -- -----------
+  # -- Exceptions
+  # -- -----------
+  # --
+  # -- An exception (error) will be thrown if
+  # --
+  # --   => any nil (or empties) exist in the input parameters
+  # --   => [this] delimeter does not appear in the in_string
+  # --   => [that] delimeter does not appear after [this] one
+  # --
+  def before_and_after begin_delimeter, end_delimeter
+
+    Throw.if_nil_or_empty_strings [ self, begin_delimeter, end_delimeter ]
+
+    before_after_lines = []
+    in_middle_bit = false
+
+    self.each do |candidate_line|
+
+      is_middle_boundary = !in_middle_bit && candidate_line.downcase.include?(begin_delimeter.downcase)
+      if is_middle_boundary
+        in_middle_bit = true
+        next
+      end
+
+      unless in_middle_bit
+        before_after_lines.push candidate_line
+        next
+      end
+
+      #--
+      #-- Now we are definitely in the middle bit.
+      #-- Let's check for the middle end delimeter
+      #--
+      if candidate_line.downcase.include? end_delimeter.downcase
+        in_middle_bit = false
+      end
+
+    end
+
+    return before_after_lines
+
+  end
+
+
+  def middlle_bit begin_delimeter, end_delimeter
+
+    Throw.if_nil_or_empty_strings [ self, begin_delimeter, end_delimeter ]
+
+    middle_lines = []
+    in_middle_bit = false
+
+    self.each do |candidate_line|
+
+      is_middle_boundary = !in_middle_bit && candidate_line.downcase.include?(begin_delimeter.downcase)
+      if is_middle_boundary
+        in_middle_bit = true
+        next
+      end
+
+      end_of_middle = in_middle_bit && candidate_line.downcase.include?(end_delimeter.downcase)
+      return middle_lines if end_of_middle
+      
+      #--
+      #-- We are definitely in the middle bit.
+      #--
+      middle_lines.push(candidate_line) if in_middle_bit
+
+    end
+
+    unreachable_str = "This point should be unreachable unless facts are ended."
+    raise RuntimeError.new unreachable_str
+
+  end
+
+
+end

data/lib/opensecret/additions/dir.rb

@@ -0,0 +1,35 @@
+#!/usr/bin/ruby
+
+# --
+# -- Reopen the core ruby Dirctory class and add the below methods to it.
+# --
+class Dir
+
+  # --
+  # -- Put all the files starting with the given string in
+  # -- alphabetical ascending order and then return the file
+  # -- that comes last.
+  # --
+  # -- Throw an exception if no file in this folder starts
+  # -- with the given string
+  # --
+  def ascii_order_file_starting_with starts_with_string
+
+    recently_added_file = nil
+    filepath_leadstr = File.join self.path, starts_with_string
+    Dir.glob("#{filepath_leadstr}*").sort.each do |candidate_file|
+
+      next if File.directory? candidate_file
+      recently_added_file = candidate_file
+
+    end
+
+    Throw.if_nil recently_added_file
+    Throw.if_not_exists recently_added_file
+    return recently_added_file
+
+  end
+
+
+
+end

data/lib/opensecret/additions/string.rb

@@ -0,0 +1,312 @@
+#!/usr/bin/ruby
+
+# --
+# -- Reopen the core ruby String class and add the below methods to it.
+# --
+# -- Case Sensitivity rules for [ALL] the below methods that are
+# -- added to the core Ruby string class.
+# --
+# -- For case insensitive behaviour make sure you downcase both the
+# -- string object and the parameter strings (or strings within
+# -- other parameter objects, like arrays and hashes).
+# --
+class String
+
+  # --
+  # -- Get the text [in between] this and that delimeter [exclusively].
+  # -- Exclusively means the returned text [does not] include either of
+  # -- the matched delimeters (although an unmatched instance of [this]
+  # -- delimeter may appear in the in-between text).
+  # --
+  # -- --------------------
+  # -- Multiple Delimiters
+  # -- --------------------
+  # --
+  # -- When multiple delimiters exist, the text returned is in between the
+  # --
+  # --  [a] - first occurrence of [this] delimeter AND the
+  # --  [b] - 1st occurrence of [that] delimeter [AFTER] the 1st delimiter
+  # --
+  # -- Instances of [that] delimiter occurring before [this] are ignored.
+  # -- The text could contain [this] delimeter instances but is guaranteed
+  # -- not to contain a [that] delimeter.
+  # --
+  # -- -----------
+  # -- Parameters
+  # -- -----------
+  # --
+  # --   this_delimiter : begin delimeter (not included in returned string)
+  # --   that_delimiter : end delimeter (not included in returned string)
+  # --
+  # -- -----------
+  # -- Exceptions
+  # -- -----------
+  # --
+  # -- An exception (error) will be thrown if
+  # --
+  # --   => any nil (or empties) exist in the input parameters
+  # --   => [this] delimeter does not appear in the in_string
+  # --   => [that] delimeter does not appear after [this] one
+  # --
+  def in_between this_delimeter, that_delimeter
+
+    Throw.if_nil_or_empty_strings [ self, this_delimeter, that_delimeter ]
+
+    scanner_1 = StringScanner.new self
+    scanner_1.scan_until /#{this_delimeter}/
+    scanner_2 = StringScanner.new scanner_1.post_match
+    scanner_2.scan_until /#{that_delimeter}/
+
+    in_between_text = scanner_2.pre_match.strip
+    log.info(ere){ in_between_text }
+
+    return in_between_text
+
+# --> file_text = File.read "c:/Users/apollo13/mirror.techwiki/documents/collaboration-tech/gollum/gollum-certbot-ssl.md"
+
+# --> this_delimeter = "<!-- facts"
+# --> that_delimeter = "-->"
+
+# --> scanner = StringScanner.new file_text
+# --> log.info(ere){ "1st Delimiter => #{this_delimeter}" }
+# --> log.info(ere){ "2nd Delimiter => #{that_delimeter}" }
+# --> before_text = scanner.scan_until /#{this_delimeter}/
+# --> post_match_text = scanner.post_match
+# --> scanner2 = StringScanner.new post_match_text
+# --> scanner2.scan_until /#{that_delimeter}/
+# --> best_text = scanner2.pre_match.strip
+
+# --> best_text = Strings.in_between file_text, this_delimeter, that_delimeter
+
+# --> log.info(ere){ "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@" }
+# --> log.info(ere){ "What We Want" }
+# --> log.info(ere){ "======================================================" }
+# --> log.info(ere){ best_text }
+# --> log.info(ere){ "======================================================" }
+
+# --> exit
+
+  end
+
+
+  # --
+  # -- Return true if the [little string] within this
+  # -- string object is both
+  # --
+  # --  a] topped by the parameter prefix AND
+  # --  b] tailed by the parameter postfix
+  # --
+  # -- -----------------------------------------
+  # -- In the below example [true] is returned
+  # -- -----------------------------------------
+  # --
+  # --   This [String] => "Hey [<-secrets->] are juicy."
+  # --   little string => "secrets"
+  # --   topped string => "[<-"
+  # --   tailed string => "->]"
+  # --
+  # -- Why true? Because the little string "secret" is
+  # -- (wrapped) topped by "[<-" and tailed by "->]"
+  # --
+  # -- -----------------------------------------
+  # -- Assumptions | Constraints | Boundaries
+  # -- -----------------------------------------
+  # --
+  # --   - all matches are [case sensitive]
+  # --   - this string must contain little_str
+  # --   - one strike and its true
+  # --       (if little string appears more than once)
+  # --       so => "all secrets, most [<-secrets->] r juicy"
+  # --          => true as long as (at least) one is wrapped
+  # --
+  # --
+  def has_wrapped? little_str, prefix, postfix
+
+    return self.include?( prefix + little_str + postfix )
+
+  end
+
+  
+  # --
+  # -- Sandwich the first occurrence of a substring in
+  # -- this string with the specified pre and postfix.
+  # --
+  # -- This string contains the little string and an
+  # -- IN-PLACE change is performed with the first
+  # -- occurrence of the little string being prefixed
+  # -- and postfixed with the 2 parameter strings.
+  # --
+  # -- ----------------------------------
+  # -- Example of sandwiching [wrapping]
+  # -- ----------------------------------
+  # --
+  # --   [String]  => "Hey secrets are juicy."
+  # --   [To_Wrap] => "secrets"
+  # --   [Prefix]  => "[<-"
+  # --   [Postfix] => "->]"
+  # --
+  # --   [String]  => "Hey [<-secrets->] are juicy."
+  # --
+  # -- This string IS changed in place.
+  # --
+  def sandwich_substr to_wrap_str, prefix, postfix
+
+    occurs_index = self.downcase.index to_wrap_str.downcase
+    self.insert occurs_index, prefix
+    shifted_index = occurs_index + prefix.length + to_wrap_str.length
+    self.insert shifted_index, postfix
+
+  end
+
+  
+  # --
+  # -- Return [TRUE] if this string includes [every word] harboured
+  # -- by the parameter array, else return [FALSE]. The "include"
+  # -- is a case-sensitive search.
+  # --
+  # -- -----------
+  # -- Parameter
+  # -- -----------
+  # --
+  # --   word_array : array of string words for the inclusivity test
+  # --
+  # -- --------------------------------
+  # -- Dependencies and Assumptions
+  # -- --------------------------------
+  # --
+  # --   the parameter string is not nil
+  # --   array can be [empty] but not nil
+  # --   array contents are neither nil nor empty
+  # --
+  def includes_all? word_array
+
+    Throw.if_nil self
+    Throw.if_nil word_array
+
+    word_array.each do |word|
+
+      Throw.if_nil word
+      return false unless self.include? word
+
+    end
+
+    return true
+
+  end
+
+
+  # --
+  # -- return true if the string includes [ANY] word within the
+  # -- parameter array, else return false. The "include" is done
+  # -- as a case-sensitive search.
+  # --
+  # -- -----------
+  # -- Parameter
+  # -- -----------
+  # --
+  # --   word_array : array of string words for the inclusivity test
+  # --
+  # -- --------------------------------
+  # -- Dependencies and Assumptions
+  # -- --------------------------------
+  # --
+  # --   array can be [empty] but not nil
+  # --   array contents are neither nil nor empty
+  # --
+  def includes_any? word_array
+
+    Throw.if_nil self
+    Throw.if_nil word_array
+
+    word_array.each do |word|
+
+      Throw.if_nil word
+      return true if self.include? word
+
+    end
+
+    return false
+
+  end
+
+
+  # --
+  # -- Encrypt this string with the parameter encryption/decryption key
+  # -- and return the encrypted text as a new string.
+  # --
+  # --  decrypt_key  => the key that will decrypt the output string
+  # --
+  # --
+  def encrypt decrypt_key
+
+## ----> Write a RE-CRYPT method that goes through a folder - decrypting and recrypting
+## ----> Write a RE-CRYPT method that goes through a folder - decrypting and recrypting
+## ----> Write a RE-CRYPT method that goes through a folder - decrypting and recrypting
+## ----> Write a RE-CRYPT method that goes through a folder - decrypting and recrypting
+
+###### ON Linux improve by changing to OpenSSL::Cipher.new('DES-EDE3-CBC').encrypt
+###### ON Linux improve by changing to Digest::SHA2.hexdigest decrypt_key
+###### ON Linux improve by changing to OpenSSL::Cipher.new('DES-EDE3-CBC').encrypt
+###### ON Linux improve by changing to Digest::SHA2.hexdigest decrypt_key
+###### ON Linux improve by changing to OpenSSL::Cipher.new('DES-EDE3-CBC').encrypt
+###### ON Linux improve by changing to Digest::SHA2.hexdigest decrypt_key
+###### ON Linux improve by changing to OpenSSL::Cipher.new('DES-EDE3-CBC').encrypt
+###### ON Linux improve by changing to Digest::SHA2.hexdigest decrypt_key
+
+    cipher = OpenSSL::Cipher::Cipher.new('DES-EDE3-CBC').encrypt
+    cipher.key = Digest::SHA1.hexdigest decrypt_key
+    crypted = cipher.update(self) + cipher.final
+    encrypted_text = crypted.unpack('H*')[0].upcase
+
+    return encrypted_text
+
+  end
+
+
+  # --
+  # -- Decrypt this string with the parameter encryption/decryption key
+  # -- and return the decrypted text as a new string.
+  # --
+  # --  encrypt_key  => the key the input string was encrypted with
+  # --
+  # --
+  def decrypt encrypt_key
+
+## ----> Write a RE-CRYPT method that goes through a folder - decrypting and recrypting
+## ----> Write a RE-CRYPT method that goes through a folder - decrypting and recrypting
+## ----> Write a RE-CRYPT method that goes through a folder - decrypting and recrypting
+## ----> Write a RE-CRYPT method that goes through a folder - decrypting and recrypting
+
+###### ON Linux improve by changing to OpenSSL::Cipher.new('DES-EDE3-CBC').encrypt
+###### ON Linux improve by changing to Digest::SHA2.hexdigest decrypt_key
+###### ON Linux improve by changing to OpenSSL::Cipher.new('DES-EDE3-CBC').encrypt
+###### ON Linux improve by changing to Digest::SHA2.hexdigest decrypt_key
+###### ON Linux improve by changing to OpenSSL::Cipher.new('DES-EDE3-CBC').encrypt
+###### ON Linux improve by changing to Digest::SHA2.hexdigest decrypt_key
+
+    cipher = OpenSSL::Cipher::Cipher.new('DES-EDE3-CBC').decrypt
+    cipher.key = Digest::SHA1.hexdigest encrypt_key
+    uncrypted = [self].pack("H*").unpack("C*").pack("c*")
+    decrypted_text = cipher.update(uncrypted) + cipher.final
+
+    return decrypted_text
+
+  end
+
+
+  # --
+  # -- Log the string which is expected to be delineated.
+  # -- If the string originated from a file it will be logged
+  # -- line by line. If no line delineation the string will be
+  # -- dumped just as a blob.
+  # --
+  def log_lines
+
+    self.each_line do |line|
+      clean_line = line.chomp.gsub("\\n","")
+      log.info(ere) { line } if clean_line.length > 0
+    end
+
+  end
+
+end