Class: Backspin::Configuration

Inherits:
Object
  • Object
show all
Defined in:
lib/backspin/configuration.rb

Overview

Configuration for Backspin

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Configuration

Returns a new instance of Configuration.



19
20
21
22
23
24
25
 
# File 'lib/backspin/configuration.rb', line 19

def initialize
  @scrub_credentials = true
  @raise_on_verification_failure = true
  @credential_patterns = default_credential_patterns
  @backspin_dir = Pathname(Dir.pwd).join("fixtures", "backspin")
  @logger = default_logger
end

Instance Attribute Details

#backspin_dir ⇒ Object

The directory where backspin will store its files - defaults to fixtures/backspin



11
12
13
 
# File 'lib/backspin/configuration.rb', line 11

def backspin_dir
  @backspin_dir
end

#credential_patterns ⇒ Object (readonly)

Regex patterns to scrub from saved output



17
18
19
 
# File 'lib/backspin/configuration.rb', line 17

def credential_patterns
  @credential_patterns
end

#logger ⇒ Object

Logger for Backspin diagnostics - defaults to WARN level, logfmt-lite format



15
16
17
 
# File 'lib/backspin/configuration.rb', line 15

def logger
  @logger
end

#raise_on_verification_failure ⇒ Object

Whether to raise an exception when verification fails in run/capture - defaults to true



13
14
15
 
# File 'lib/backspin/configuration.rb', line 13

def raise_on_verification_failure
  @raise_on_verification_failure
end

#scrub_credentials ⇒ Object

Returns the value of attribute scrub_credentials.



9
10
11
 
# File 'lib/backspin/configuration.rb', line 9

def scrub_credentials
  @scrub_credentials
end

Instance Method Details

#add_credential_pattern(pattern) ⇒ Object 



27
28
29
 
# File 'lib/backspin/configuration.rb', line 27

def add_credential_pattern(pattern)
  @credential_patterns << pattern
end

#clear_credential_patterns ⇒ Object 



31
32
33
 
# File 'lib/backspin/configuration.rb', line 31

def clear_credential_patterns
  @credential_patterns = []
end

#reset_credential_patterns ⇒ Object 



35
36
37
 
# File 'lib/backspin/configuration.rb', line 35

def reset_credential_patterns
  @credential_patterns = default_credential_patterns
end