cyber_trackr_live 1.0.0

data/lib/cyber_trackr_client/models/requirement_detail.rb

@@ -0,0 +1,580 @@
+=begin
+#Cyber Trackr API
+
+#Complete OpenAPI 3.1.1 specification for cyber.trackr.live API. This API provides access to DISA STIGs, SRGs, RMF controls, CCIs, and SCAP data.  ## DISA Cybersecurity Ecosystem Hierarchy  ``` NIST RMF Controls (high-level policy framework)     ↓ (decomposed into atomic, testable statements) CCIs (Control Correlation Identifiers - bridge policy to implementation)     ↓ (grouped by technology class into generic requirements)   SRGs (Security Requirements Guides - technology class \"what\" to do)     ↓ (implemented as vendor-specific \"how\" to do it) STIGs (Security Technical Implementation Guides - vendor/product specific)     ↓ (automated versions for scanning tools) SCAP (Security Content Automation Protocol documents) ```  ## Critical Relationships  - **RMF Controls** contain assessment procedures that reference **CCIs** - **CCIs** map back to **RMF Controls** and forward to **STIG/SRG requirements** - **SRGs** define generic technology requirements that **STIGs** implement specifically - **V-IDs** can appear in both SRG and corresponding STIG (same requirement, different specificity) - **SV-IDs** are XCCDF rule identifiers with revision tracking across document releases 
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.14.0
+
+=end
+
+require 'date'
+require 'time'
+
+module CyberTrackrClient
+  # Complete requirement details with implementation guidance
+  class RequirementDetail
+    attr_accessor :id
+
+    attr_accessor :rule
+
+    attr_accessor :severity
+
+    attr_accessor :requirement_title
+
+    attr_accessor :requirement_description
+
+    attr_accessor :mitigation_statement
+
+    attr_accessor :identifiers
+
+    attr_accessor :check_text
+
+    attr_accessor :fix_text
+
+    # Check procedure identifier
+    attr_accessor :check_id
+
+    # Fix procedure identifier
+    attr_accessor :fix_id
+
+    # Requirement group identifier
+    attr_accessor :group
+
+    # Requirement version
+    attr_accessor :version
+
+    # Parent STIG identifier
+    attr_accessor :stig
+
+    # Parent STIG title
+    attr_accessor :stig_title
+
+    # Parent STIG description
+    attr_accessor :stig_description
+
+    # Parent STIG publication date
+    attr_accessor :stig_published
+
+    # Parent STIG status
+    attr_accessor :stig_status
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id' => :'id',
+        :'rule' => :'rule',
+        :'severity' => :'severity',
+        :'requirement_title' => :'requirement-title',
+        :'requirement_description' => :'requirement-description',
+        :'mitigation_statement' => :'mitigation-statement',
+        :'identifiers' => :'identifiers',
+        :'check_text' => :'check-text',
+        :'fix_text' => :'fix-text',
+        :'check_id' => :'check-id',
+        :'fix_id' => :'fix-id',
+        :'group' => :'group',
+        :'version' => :'version',
+        :'stig' => :'stig',
+        :'stig_title' => :'stig-title',
+        :'stig_description' => :'stig-description',
+        :'stig_published' => :'stig-published',
+        :'stig_status' => :'stig-status'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'id' => :'String',
+        :'rule' => :'String',
+        :'severity' => :'String',
+        :'requirement_title' => :'String',
+        :'requirement_description' => :'String',
+        :'mitigation_statement' => :'String',
+        :'identifiers' => :'Array<String>',
+        :'check_text' => :'String',
+        :'fix_text' => :'String',
+        :'check_id' => :'String',
+        :'fix_id' => :'String',
+        :'group' => :'String',
+        :'version' => :'String',
+        :'stig' => :'String',
+        :'stig_title' => :'String',
+        :'stig_description' => :'String',
+        :'stig_published' => :'String',
+        :'stig_status' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'mitigation_statement',
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `CyberTrackrClient::RequirementDetail` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `CyberTrackrClient::RequirementDetail`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
+      else
+        self.id = nil
+      end
+
+      if attributes.key?(:'rule')
+        self.rule = attributes[:'rule']
+      else
+        self.rule = nil
+      end
+
+      if attributes.key?(:'severity')
+        self.severity = attributes[:'severity']
+      else
+        self.severity = nil
+      end
+
+      if attributes.key?(:'requirement_title')
+        self.requirement_title = attributes[:'requirement_title']
+      else
+        self.requirement_title = nil
+      end
+
+      if attributes.key?(:'requirement_description')
+        self.requirement_description = attributes[:'requirement_description']
+      end
+
+      if attributes.key?(:'mitigation_statement')
+        self.mitigation_statement = attributes[:'mitigation_statement']
+      end
+
+      if attributes.key?(:'identifiers')
+        if (value = attributes[:'identifiers']).is_a?(Array)
+          self.identifiers = value
+        end
+      end
+
+      if attributes.key?(:'check_text')
+        self.check_text = attributes[:'check_text']
+      else
+        self.check_text = nil
+      end
+
+      if attributes.key?(:'fix_text')
+        self.fix_text = attributes[:'fix_text']
+      else
+        self.fix_text = nil
+      end
+
+      if attributes.key?(:'check_id')
+        self.check_id = attributes[:'check_id']
+      end
+
+      if attributes.key?(:'fix_id')
+        self.fix_id = attributes[:'fix_id']
+      end
+
+      if attributes.key?(:'group')
+        self.group = attributes[:'group']
+      end
+
+      if attributes.key?(:'version')
+        self.version = attributes[:'version']
+      end
+
+      if attributes.key?(:'stig')
+        self.stig = attributes[:'stig']
+      end
+
+      if attributes.key?(:'stig_title')
+        self.stig_title = attributes[:'stig_title']
+      end
+
+      if attributes.key?(:'stig_description')
+        self.stig_description = attributes[:'stig_description']
+      end
+
+      if attributes.key?(:'stig_published')
+        self.stig_published = attributes[:'stig_published']
+      end
+
+      if attributes.key?(:'stig_status')
+        self.stig_status = attributes[:'stig_status']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      if @id.nil?
+        invalid_properties.push('invalid value for "id", id cannot be nil.')
+      end
+
+      pattern = Regexp.new(/^V-\d{6}$/)
+      if @id !~ pattern
+        invalid_properties.push("invalid value for \"id\", must conform to the pattern #{pattern}.")
+      end
+
+      if @rule.nil?
+        invalid_properties.push('invalid value for "rule", rule cannot be nil.')
+      end
+
+      pattern = Regexp.new(/^SV-\d+r\d+_rule$/)
+      if @rule !~ pattern
+        invalid_properties.push("invalid value for \"rule\", must conform to the pattern #{pattern}.")
+      end
+
+      if @severity.nil?
+        invalid_properties.push('invalid value for "severity", severity cannot be nil.')
+      end
+
+      if @requirement_title.nil?
+        invalid_properties.push('invalid value for "requirement_title", requirement_title cannot be nil.')
+      end
+
+      if @requirement_title.to_s.length < 1
+        invalid_properties.push('invalid value for "requirement_title", the character length must be greater than or equal to 1.')
+      end
+
+      if !@requirement_description.nil? && @requirement_description.to_s.length < 1
+        invalid_properties.push('invalid value for "requirement_description", the character length must be greater than or equal to 1.')
+      end
+
+      if @check_text.nil?
+        invalid_properties.push('invalid value for "check_text", check_text cannot be nil.')
+      end
+
+      if @check_text.to_s.length < 1
+        invalid_properties.push('invalid value for "check_text", the character length must be greater than or equal to 1.')
+      end
+
+      if @fix_text.nil?
+        invalid_properties.push('invalid value for "fix_text", fix_text cannot be nil.')
+      end
+
+      if @fix_text.to_s.length < 1
+        invalid_properties.push('invalid value for "fix_text", the character length must be greater than or equal to 1.')
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @id.nil?
+      return false if @id !~ Regexp.new(/^V-\d{6}$/)
+      return false if @rule.nil?
+      return false if @rule !~ Regexp.new(/^SV-\d+r\d+_rule$/)
+      return false if @severity.nil?
+      severity_validator = EnumAttributeValidator.new('String', ["high", "medium", "low"])
+      return false unless severity_validator.valid?(@severity)
+      return false if @requirement_title.nil?
+      return false if @requirement_title.to_s.length < 1
+      return false if !@requirement_description.nil? && @requirement_description.to_s.length < 1
+      return false if @check_text.nil?
+      return false if @check_text.to_s.length < 1
+      return false if @fix_text.nil?
+      return false if @fix_text.to_s.length < 1
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] id Value to be assigned
+    def id=(id)
+      if id.nil?
+        fail ArgumentError, 'id cannot be nil'
+      end
+
+      pattern = Regexp.new(/^V-\d{6}$/)
+      if id !~ pattern
+        fail ArgumentError, "invalid value for \"id\", must conform to the pattern #{pattern}."
+      end
+
+      @id = id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] rule Value to be assigned
+    def rule=(rule)
+      if rule.nil?
+        fail ArgumentError, 'rule cannot be nil'
+      end
+
+      pattern = Regexp.new(/^SV-\d+r\d+_rule$/)
+      if rule !~ pattern
+        fail ArgumentError, "invalid value for \"rule\", must conform to the pattern #{pattern}."
+      end
+
+      @rule = rule
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] severity Object to be assigned
+    def severity=(severity)
+      validator = EnumAttributeValidator.new('String', ["high", "medium", "low"])
+      unless validator.valid?(severity)
+        fail ArgumentError, "invalid value for \"severity\", must be one of #{validator.allowable_values}."
+      end
+      @severity = severity
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] requirement_title Value to be assigned
+    def requirement_title=(requirement_title)
+      if requirement_title.nil?
+        fail ArgumentError, 'requirement_title cannot be nil'
+      end
+
+      if requirement_title.to_s.length < 1
+        fail ArgumentError, 'invalid value for "requirement_title", the character length must be greater than or equal to 1.'
+      end
+
+      @requirement_title = requirement_title
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] requirement_description Value to be assigned
+    def requirement_description=(requirement_description)
+      if requirement_description.nil?
+        fail ArgumentError, 'requirement_description cannot be nil'
+      end
+
+      if requirement_description.to_s.length < 1
+        fail ArgumentError, 'invalid value for "requirement_description", the character length must be greater than or equal to 1.'
+      end
+
+      @requirement_description = requirement_description
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] check_text Value to be assigned
+    def check_text=(check_text)
+      if check_text.nil?
+        fail ArgumentError, 'check_text cannot be nil'
+      end
+
+      if check_text.to_s.length < 1
+        fail ArgumentError, 'invalid value for "check_text", the character length must be greater than or equal to 1.'
+      end
+
+      @check_text = check_text
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] fix_text Value to be assigned
+    def fix_text=(fix_text)
+      if fix_text.nil?
+        fail ArgumentError, 'fix_text cannot be nil'
+      end
+
+      if fix_text.to_s.length < 1
+        fail ArgumentError, 'invalid value for "fix_text", the character length must be greater than or equal to 1.'
+      end
+
+      @fix_text = fix_text
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          id == o.id &&
+          rule == o.rule &&
+          severity == o.severity &&
+          requirement_title == o.requirement_title &&
+          requirement_description == o.requirement_description &&
+          mitigation_statement == o.mitigation_statement &&
+          identifiers == o.identifiers &&
+          check_text == o.check_text &&
+          fix_text == o.fix_text &&
+          check_id == o.check_id &&
+          fix_id == o.fix_id &&
+          group == o.group &&
+          version == o.version &&
+          stig == o.stig &&
+          stig_title == o.stig_title &&
+          stig_description == o.stig_description &&
+          stig_published == o.stig_published &&
+          stig_status == o.stig_status
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [id, rule, severity, requirement_title, requirement_description, mitigation_statement, identifiers, check_text, fix_text, check_id, fix_id, group, version, stig, stig_title, stig_description, stig_published, stig_status].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_hash)
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def self._deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        # models (e.g. Pet) or oneOf
+        klass = CyberTrackrClient.const_get(type)
+        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+
+end