Added the stoplight prism mock server as a server selection

Author: georgedias

.github/workflows/generate_docs.yml

@@ -1,6 +1,6 @@
 name: generate-docs
 
-# Run on each push to master
+# Run on each push to main
 on:
   push:
     branches: [ main ]

.rubocop.yml

@@ -14,6 +14,7 @@ AllCops:
     - Gemfile
     - Rakefile
     - 'test/**/*'
+    - '*.gemspec'
 
 #Cops in Metrics might need to be adjusted to past their defaults depending on how restrictive the requirements feel
 Style/Documentation:

.rubocop_todo.yml

@@ -1,19 +1,11 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2021-12-14 05:55:09 UTC using RuboCop version 1.20.0.
+# on 2021-12-22 16:48:47 UTC using RuboCop version 1.23.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 4
-# Cop supports --auto-correct.
-Lint/RedundantCopDisableDirective:
-  Exclude:
-    - 'lib/emasser/help.rb'
-    - 'lib/emasser/post.rb'
-    - 'lib/emasser/put.rb'
-
 # Offense count: 21
 # Configuration parameters: IgnoredMethods, CountRepeatedAttributes.
 Metrics/AbcSize:

emass_client/eMASSRestOpenApi.yaml

@@ -9,9 +9,10 @@ info:
   description: |
       The Enterprise Mission Assurance Support Service (eMASS) Representational State
       Transfer (REST) Application Programming Interface (API) enables users to perform
-      assessments and complete actions associated with system records. This command-line
-      interface (CLI) tool implements all of the eMASS endpoints defined in the eMASS 
-      REST API v3.2, dated October 21, 2021.</br><br>
+      assessments and complete actions associated with system records. 
+      
+      The `emasser` is a command-line interface (CLI) tool that implements all of the 
+      eMASS endpoints defined in the eMASS REST API v3.2, dated October 21, 2021.</br><br>
 
       <strong>Register CLI</strong></br>
       New users will need to register an API key with the eMASS development team prior to
@@ -75,8 +76,8 @@ externalDocs:
 servers:
   - url: "http://localhost:4010"
     description: Use localhost mock server
-  - url: "https://localhost:4433"
-    description: Use localhost secure mock server
+  - url: "https://stoplight.io/mocks/mitre/emasser/32836028"
+    description: Use the hosted Prism mock server
 
 #-------------------------------------------------------------------------------
 # T A G S - A list of tags used by the specification with additional metadata.
@@ -2547,12 +2548,12 @@ components:
     role:
       name: role
       in: query
-      description: "**Role**: Required parameter. Accepts single value from available options."
+      description: "**Role**: Accepts single value from options available at base system-roles endpoint e.g., SCA."
       required: true
       schema:
         type: string
-        enum: ["AO","Auditor","Artifact Manager","C&A Team","IAO","ISSO","PM/IAM","SCA","User Rep (View Only)", "Validator (IV&V)"]
-        default: "Validator (IV&V)"
+        enum: ["AO","Auditor","Artifact Manager","C&A Team","IAO","ISSO","PM/IAM","SCA","User Rep", "Validator"]
+        default: "IAO"
     exportfilename:
       name: filename
       in: query
@@ -5400,7 +5401,6 @@ components:
         packageName:
           type: string
           description: "[Read-Only] The package name."
-          x-faker:
           example: "Test RMF Step 1 package"
           enum: ["Test POA&M Approval","Test RMF Step 1 package","Test RMF Step 2 package","Test RMF Step 3 package"]
         systemName:
@@ -5670,25 +5670,34 @@ components:
   securitySchemes:
     apikey:
       type: apiKey
-      #type: https
-      #scheme: basic
       in: header
       name: api-key
       description: >
-        The API key must be provided in the request header for all endpoint calls.<br>
-        See the
+        The API key must be provided in the request header for all eMASS endpoint calls.</br></br>
+        **For connecting to a mock server, any value is acceptable, e.g., 123**
     userid:
       type: apiKey
       in: header
       name: user-uid
       description: >
         This User unique identifier key must be provided in the request header for all PUT,
-        POST, and DELETE endpoint calls.
-
+        POST, and DELETE endpoint calls.</br>
+        Note: For DoD users this is the DoD ID Number (EIDIPI) on their DoD CAC.</br></br>
+        **For connecting to a mock server, any value is acceptable, e.g., 123**
+    mockType:
+      type: apiKey
+      in: header
+      name: Prefer
+      description: >
+        This header parameter is ony utilized when interacting with the mock server.</br>
+        Options are (enter in the **Value** textbox): 
+          - For random response values `code=200, dynamic=true`
+          - For static response values `code=200` 
 #-------------------------------------------------------------------------------
 # S E C U R I T Y
 #-------------------------------------------------------------------------------
 security:
   - apikey: []
   - userid: []
+  - mockType: []
 ...

emass_client/ruby_client/lib/swagger_client/api/system_roles_api.rb

@@ -104,8 +104,8 @@ def get_system_roles_by_category_id_with_http_info(role_category, role, opts = {
         fail ArgumentError, "Missing the required parameter 'role' when calling SystemRolesApi.get_system_roles_by_category_id"
       end
       # verify enum value
-      if @api_client.config.client_side_validation && !['AO', 'Auditor', 'Artifact Manager', 'C&A Team', 'IAO', 'ISSO', 'PM/IAM', 'SCA', 'User Rep (View Only)', 'Validator (IV&V)'].include?(role)
-        fail ArgumentError, "invalid value for 'role', must be one of AO, Auditor, Artifact Manager, C&A Team, IAO, ISSO, PM/IAM, SCA, User Rep (View Only), Validator (IV&V)"
+      if @api_client.config.client_side_validation && !['AO', 'Auditor', 'Artifact Manager', 'C&A Team', 'IAO', 'ISSO', 'PM/IAM', 'SCA', 'User Rep', 'Validator'].include?(role)
+        fail ArgumentError, "invalid value for 'role', must be one of AO, Auditor, Artifact Manager, C&A Team, IAO, ISSO, PM/IAM, SCA, User Rep, Validator"
       end
       if @api_client.config.client_side_validation && opts[:'policy'] && !['diacap', 'rmf', 'reporting'].include?(opts[:'policy'])
         fail ArgumentError, 'invalid value for "policy", must be one of diacap, rmf, reporting'

lib/emasser/get.rb

@@ -182,7 +182,7 @@ def all
     option :roleCategory, type: :string, required: true, enum: %w[PAC CAC Other]
     option :role,         type: :string, required: true,
                           enum: ['AO', 'Auditor', 'Artifact Manager', 'C&A Team', 'IAO',
-                                 'ISSO', 'PM/IAM', 'SCA', 'User Rep (View Only)', 'Validator (IV&V)']
+                                 'ISSO', 'PM/IAM', 'SCA', 'User Rep', 'Validator']
     # Optional parameters/fields
     option :policy, type: :string, required: false, enum: %w[diacap rmf reporting]
     option :includeDecommissioned, type: :boolean, required: false, desc: 'BOOLEAN - true or false.'

lib/emasser/help.rb

@@ -1,13 +1,11 @@
 # frozen_string_literal: true
 
-# rubocop:disable Style/ClassAndModuleChildren
 module Emasser::Help
   class << self
     def text(namespaced_command)
       path = namespaced_command.to_s.tr(':', '/')
       path = File.expand_path("../help/#{path}.md", __FILE__)
-      IO.read(path) if File.exist?(path)
+      File.read(path) if File.exist?(path)
     end
   end
 end
-# rubocop:enable Style/ClassAndModuleChildren

lib/emasser/help/approvalCac_post_mapper.md

@@ -17,4 +17,4 @@ role of the CAC. Comments cannot exceed 10,000 characters.
 
 Example:
 
-bundle exec exe/emasser post cac add --systemId [value] --controlAcronym [value] --comments [value]
+bundle exec exe/emasser post cac add --systemId [value] --controlAcronym [value] --comments [value]

lib/emasser/help/approvalPac_post_mapper.md

@@ -17,4 +17,4 @@ totalSteps    Integer    [Read-Only] Total number of steps in Package Approval C
 
 Example:
 
-bundle exec exe/emasser post pac add --systemId [value] --workflow [value] --name [value] --comments [value]
+bundle exec exe/emasser post pac add --systemId [value] --workflow [value] --name [value] --comments [value]

lib/emasser/help/artifacts_post_mapper.md

@@ -56,4 +56,4 @@ Example:
 
 bundle exec exe/emasser post artifacts upload --systemId [value] [--isTemplate or --no-isTemplate] --type [value] --category [value] --files[value...value]
 
-Note: The example does not list any optional fields
+Note: The example does not list any optional fields

lib/emasser/help/cmmc_get_mapper.md

@@ -1,4 +1,4 @@
 The Cybersecurity Maturity Model Certification (CMMC) Assessments endpoint provides
 the ability to view CMMC assessment information. 
 
-**It is available to CMMC eMASS only.**
+**It is available to CMMC eMASS only.**

lib/emasser/post.rb

@@ -87,7 +87,6 @@ def add
   #
   # Endpoint:
   #   /api/systems/{systemId}/poams - Add one or many poa&m items in a system
-  # rubocop:disable Metrics/ClassLength
   class Poams < SubCommandBase
     def self.exit_on_failure?
       true
@@ -299,7 +298,6 @@ def print_milestone_help
     end
     # rubocop:enable Metrics/BlockLength, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
   end
-  # rubocop:enable Metrics/ClassLength
 
   # The Milestones endpoints provide the ability add milestones that are associated with
   # Plan of Action and Milestones (POA&M) items for a system.

lib/emasser/put.rb

@@ -41,7 +41,7 @@ module Emasser
   #
   # Endpoint:
   #    /api/systems/{systemId}/controls - Update control information in a system for one or many controls
-  # rubocop:disable Metrics/ClassLength, Style/WordArray
+  # rubocop:disable Style/WordArray
   class Controls < SubCommandBase
     def self.exit_on_failure?
       true
@@ -233,13 +233,12 @@ def process_business_logic(body)
     end
     # rubocop:enable Style/CaseLikeIf, Style/StringLiterals, Metrics/BlockLength, Metrics/CyclomaticComplexity
   end
-  # rubocop:enable Metrics/ClassLength, Style/WordArray
+  # rubocop:enable Style/WordArray
 
   # Update Plan of Action (POA&M) items to a system.
   #
   # Endpoint:
   #   /api/systems/{systemId}/poams - Update one or many poa&m items in a system
-  # rubocop:disable Metrics/ClassLength
   class Poams < SubCommandBase
     def self.exit_on_failure?
       true
@@ -460,7 +459,6 @@ def print_milestone_help
     end
     # rubocop:enable Metrics/BlockLength, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
   end
-  # rubocop:enable Metrics/ClassLength
 
   # Update Milestones items to a system.
   #