Module: Controls::Client::Coverage

Included in:
Controls::Client
Defined in:
lib/controls/client/coverage.rb

Overview

A module to encapsulate API methods related to coverage

todo

  • this version is obviously off

Since:

  • API v1.0

Version:

  • v1.0.0

Instance Method Summary collapse

Instance Method Details

#configuration_coverage(configuration_name = nil) ⇒ Array<Controls::ConfigurationCoverage>, Controls::ConfigurationCoverage

Either returns coverage for all configurations or one by name

Parameters:

  • configuration_name (String) (defaults to: nil) —

    the security control to return coverage for

Returns:

Since:

  • API v1.0



26
27
28
29
30
31
32
 
# File 'lib/controls/client/coverage.rb', line 26

def configuration_coverage(configuration_name = nil)
  if configuration_name
    get "/coverage/configurations/#{configuration_name}"
  else
    get '/coverage/configurations'
  end
end

#security_control_coverage(security_control_name = nil) ⇒ Array<Controls::SecurityControlCoverage>, Controls::SecurityControlCoverage

Either returns coverage for all security controls or one by name

Parameters:

  • security_control_name (String) (defaults to: nil) —

    the security control to return coverage for

Returns:

Since:

  • API v1.0



13
14
15
16
17
18
19
 
# File 'lib/controls/client/coverage.rb', line 13

def security_control_coverage(security_control_name = nil)
  if security_control_name
    get "/coverage/security_controls/#{security_control_name}"
  else
    get '/coverage/security_controls'
  end
end