athenian 2.1.81

data/lib/athenian/models/filtered_deployment.rb

@@ -0,0 +1,436 @@
+=begin
+This is an automatically generated file. DO NOT EDIT.
+
+Generated from version 2.1.81 of the OpenAPI specification at
+https://github.com/athenianco/api-spec/releases/tag/2.1.81.
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.4.0
+=end
+
+require 'date'
+require 'time'
+
+module Athenian
+  # Everything we know about the deployment.
+  class FilteredDeployment
+    # List of deployed software version. Each item identifies a Git reference in a repository, either a tag or a commit hash. 
+    attr_accessor :components
+
+    # Name of the environment where the deployment happened.
+    attr_accessor :environment
+
+    # Name of the deployment. If is not specified, we generate our own by the template `<environment shortcut>-<date>-<hash of the components>`. The value may not contain \\n - new line character, and ' - single quote.
+    attr_accessor :name
+
+    # URL pointing at the internal details of the deployment.
+    attr_accessor :url
+
+    # Timestamp of when the deployment procedure launched.
+    attr_accessor :date_started
+
+    # Timestamp of when the deployment procedure completed.
+    attr_accessor :date_finished
+
+    attr_accessor :conclusion
+
+    # Arbitrary key-value metadata that associates with the deployment.
+    attr_accessor :labels
+
+    attr_accessor :code
+
+    # List of deployed pull requests.
+    attr_accessor :prs
+
+    # Deployed releases. The format matches `FilteredRelease` except that `prs` is the number of released pull requests instead of a list.
+    attr_accessor :releases
+
+    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
+      {
+        :'components' => :'components',
+        :'environment' => :'environment',
+        :'name' => :'name',
+        :'url' => :'url',
+        :'date_started' => :'date_started',
+        :'date_finished' => :'date_finished',
+        :'conclusion' => :'conclusion',
+        :'labels' => :'labels',
+        :'code' => :'code',
+        :'prs' => :'prs',
+        :'releases' => :'releases'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'components' => :'Array<DeployedComponent>',
+        :'environment' => :'String',
+        :'name' => :'String',
+        :'url' => :'String',
+        :'date_started' => :'Time',
+        :'date_finished' => :'Time',
+        :'conclusion' => :'DeploymentConclusion',
+        :'labels' => :'Object',
+        :'code' => :'DeploymentAnalysisCode',
+        :'prs' => :'Array<DeployedPullRequest>',
+        :'releases' => :'Array<DeployedRelease>'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'name',
+      ])
+    end
+
+    # List of class defined in allOf (OpenAPI v3)
+    def self.openapi_all_of
+      [
+      :'DeploymentAnalysis',
+      :'DeploymentNotification'
+      ]
+    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 `Athenian::FilteredDeployment` initialize method'
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Athenian::FilteredDeployment`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'components')
+        if (value = attributes[:'components']).is_a?(Array)
+          self.components = value
+        end
+      end
+
+      if attributes.key?(:'environment')
+        self.environment = attributes[:'environment']
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'url')
+        self.url = attributes[:'url']
+      end
+
+      if attributes.key?(:'date_started')
+        self.date_started = attributes[:'date_started']
+      end
+
+      if attributes.key?(:'date_finished')
+        self.date_finished = attributes[:'date_finished']
+      end
+
+      if attributes.key?(:'conclusion')
+        self.conclusion = attributes[:'conclusion']
+      end
+
+      if attributes.key?(:'labels')
+        self.labels = attributes[:'labels']
+      end
+
+      if attributes.key?(:'code')
+        self.code = attributes[:'code']
+      end
+
+      if attributes.key?(:'prs')
+        if (value = attributes[:'prs']).is_a?(Array)
+          self.prs = value
+        end
+      end
+
+      if attributes.key?(:'releases')
+        if (value = attributes[:'releases']).is_a?(Array)
+          self.releases = value
+        end
+      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
+      invalid_properties = Array.new
+      if @components.nil?
+        invalid_properties.push('invalid value for "components", components cannot be nil.')
+      end
+
+      if @components.length < 1
+        invalid_properties.push('invalid value for "components", number of items must be greater than or equal to 1.')
+      end
+
+      if @environment.nil?
+        invalid_properties.push('invalid value for "environment", environment cannot be nil.')
+      end
+
+      if @environment.to_s.length < 1
+        invalid_properties.push('invalid value for "environment", the character length must be great than or equal to 1.')
+      end
+
+      pattern = Regexp.new(/^([^'\s]| ){1,100}$/)
+      if !@name.nil? && @name !~ pattern
+        invalid_properties.push("invalid value for \"name\", must conform to the pattern #{pattern}.")
+      end
+
+      if @date_started.nil?
+        invalid_properties.push('invalid value for "date_started", date_started cannot be nil.')
+      end
+
+      if @date_finished.nil?
+        invalid_properties.push('invalid value for "date_finished", date_finished cannot be nil.')
+      end
+
+      if @conclusion.nil?
+        invalid_properties.push('invalid value for "conclusion", conclusion cannot be nil.')
+      end
+
+      if @code.nil?
+        invalid_properties.push('invalid value for "code", code cannot be nil.')
+      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?
+      return false if @components.nil?
+      return false if @components.length < 1
+      return false if @environment.nil?
+      return false if @environment.to_s.length < 1
+      return false if !@name.nil? && @name !~ Regexp.new(/^([^'\s]| ){1,100}$/)
+      return false if @date_started.nil?
+      return false if @date_finished.nil?
+      return false if @conclusion.nil?
+      return false if @code.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] components Value to be assigned
+    def components=(components)
+      if components.nil?
+        fail ArgumentError, 'components cannot be nil'
+      end
+
+      if components.length < 1
+        fail ArgumentError, 'invalid value for "components", number of items must be greater than or equal to 1.'
+      end
+
+      @components = components
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] environment Value to be assigned
+    def environment=(environment)
+      if environment.nil?
+        fail ArgumentError, 'environment cannot be nil'
+      end
+
+      if environment.to_s.length < 1
+        fail ArgumentError, 'invalid value for "environment", the character length must be great than or equal to 1.'
+      end
+
+      @environment = environment
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] name Value to be assigned
+    def name=(name)
+      pattern = Regexp.new(/^([^'\s]| ){1,100}$/)
+      if !name.nil? && name !~ pattern
+        fail ArgumentError, "invalid value for \"name\", must conform to the pattern #{pattern}."
+      end
+
+      @name = name
+    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 &&
+          components == o.components &&
+          environment == o.environment &&
+          name == o.name &&
+          url == o.url &&
+          date_started == o.date_started &&
+          date_finished == o.date_finished &&
+          conclusion == o.conclusion &&
+          labels == o.labels &&
+          code == o.code &&
+          prs == o.prs &&
+          releases == o.releases
+    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
+      [components, environment, name, url, date_started, date_finished, conclusion, labels, code, prs, releases].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)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      self.class.openapi_types.each_pair do |key, type|
+        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+          self.send("#{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[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _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 = Athenian.const_get(type)
+        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

data/lib/athenian/models/filtered_deployments.rb

@@ -0,0 +1,237 @@
+=begin
+This is an automatically generated file. DO NOT EDIT.
+
+Generated from version 2.1.81 of the OpenAPI specification at
+https://github.com/athenianco/api-spec/releases/tag/2.1.81.
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.4.0
+=end
+
+require 'date'
+require 'time'
+
+module Athenian
+  # Found deployments, response from `/filter/deployments`.
+  class FilteredDeployments
+    attr_accessor :include
+
+    # List of matched deployments.
+    attr_accessor :deployments
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'include' => :'include',
+        :'deployments' => :'deployments'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'include' => :'FilteredDeploymentsInclude',
+        :'deployments' => :'Array<FilteredDeployment>'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    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 `Athenian::FilteredDeployments` initialize method'
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Athenian::FilteredDeployments`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'include')
+        self.include = attributes[:'include']
+      end
+
+      if attributes.key?(:'deployments')
+        if (value = attributes[:'deployments']).is_a?(Array)
+          self.deployments = value
+        end
+      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
+      invalid_properties = Array.new
+      if @include.nil?
+        invalid_properties.push('invalid value for "include", include cannot be nil.')
+      end
+
+      if @deployments.nil?
+        invalid_properties.push('invalid value for "deployments", deployments cannot be nil.')
+      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?
+      return false if @include.nil?
+      return false if @deployments.nil?
+      true
+    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 &&
+          include == o.include &&
+          deployments == o.deployments
+    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
+      [include, deployments].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)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      self.class.openapi_types.each_pair do |key, type|
+        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+          self.send("#{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[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _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 = Athenian.const_get(type)
+        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