Module: Covert

Defined in:
lib/covert.rb,
lib/covert/config.rb,
lib/covert/version.rb,
lib/covert/obfuscate.rb,
lib/covert/obfuscation.rb,
lib/covert/unobfuscate.rb

Overview

Covert - makes your string securely obfuscated.

Defined Under Namespace

Classes: Config, Error, Obfuscate, Obfuscation, Unobfuscate

Constant Summary collapse

VERSION = 
"0.1.0"

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.config ⇒ Config

Returns:



20
21
22
 
# File 'lib/covert.rb', line 20

def config
  @config ||= Config.new
end

Class Method Details

.configure {|config| ... } ⇒ Object

Yields:



29
30
31
 
# File 'lib/covert.rb', line 29

def configure
  yield(config)
end

.obfuscate(str) ⇒ String

Returns Obfuscated string.

Examples:

Obfuscate a String

Covert.obfuscate("mystring") #=> "7hSfzDwp2JXZcieFpGCndA=="

Parameters:

  • str (String) —

    String to obfuscate

Returns:

  • (String) —

    Obfuscated string



38
39
40
 
# File 'lib/covert.rb', line 38

def self.obfuscate(str)
  Obfuscate.call(value: str)
end

.reset ⇒ Config

Returns:



25
26
27
 
# File 'lib/covert.rb', line 25

def reset
  @config = Config.new
end

.unobfuscate(str) ⇒ String

Returns Unobfuscated string.

Examples:

Unobfuscate a String

Covert.unobfuscate("7hSfzDwp2JXZcieFpGCndA==") #=> "mystring"

Parameters:

  • str (String) —

    Obfuscated string

Returns:

  • (String) —

    Unobfuscated string



46
47
48
 
# File 'lib/covert.rb', line 46

def self.unobfuscate(str)
  Unobfuscate.call(value: str)
end