Module: Covert

Defined in:
lib/covert.rb,
lib/covert/hmac.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, Hmac, Obfuscate, Obfuscation, Unobfuscate

Constant Summary collapse

VERSION = 
"0.2.0"

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.config ⇒ Config

Returns:



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

def config
  @config ||= Config.new
end

Class Method Details

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

Yields:



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

def configure
  yield(config)
end

.hmac(str) ⇒ String

Returns HMAC encoded string.

Examples:

Generate HMAC code

Covert.hmac("mystring") #=> "cddb0db23f469c8bf072b21fd837149bd6ace9ab771cceef14c9e517cc93282e"

Parameters:

  • str (String) —

    String for HMAC encoding

Returns:

  • (String) —

    HMAC encoded string



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

def self.hmac(str)
  Hmac.call(value: str)
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



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

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

.reset ⇒ Config

Returns:



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

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



55
56
57
 
# File 'lib/covert.rb', line 55

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