ff-ruby-server-sdk 1.2.1 → 1.3.0

data/lib/ff/ruby/server/generated/lib/openapi_client/models/proxy_config_all_of_environments.rb

@@ -0,0 +1,251 @@
+=begin
+#Harness feature flag service client apis
+
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+The version of the OpenAPI document: 1.0.0
+Contact: cf@harness.io
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.2.1
+
+=end
+
+require 'date'
+require 'time'
+
+module OpenapiClient
+  class ProxyConfigAllOfEnvironments
+    attr_accessor :id
+
+    attr_accessor :api_keys
+
+    attr_accessor :feature_configs
+
+    attr_accessor :segments
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id' => :'id',
+        :'api_keys' => :'apiKeys',
+        :'feature_configs' => :'featureConfigs',
+        :'segments' => :'segments'
+      }
+    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
+      {
+        :'id' => :'String',
+        :'api_keys' => :'Array<String>',
+        :'feature_configs' => :'Array<FeatureConfig>',
+        :'segments' => :'Array<Segment>'
+      }
+    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 `OpenapiClient::ProxyConfigAllOfEnvironments` 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 `OpenapiClient::ProxyConfigAllOfEnvironments`. 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?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.key?(:'api_keys')
+        if (value = attributes[:'api_keys']).is_a?(Array)
+          self.api_keys = value
+        end
+      end
+
+      if attributes.key?(:'feature_configs')
+        if (value = attributes[:'feature_configs']).is_a?(Array)
+          self.feature_configs = value
+        end
+      end
+
+      if attributes.key?(:'segments')
+        if (value = attributes[:'segments']).is_a?(Array)
+          self.segments = 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
+      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?
+      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 &&
+          id == o.id &&
+          api_keys == o.api_keys &&
+          feature_configs == o.feature_configs &&
+          segments == o.segments
+    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, api_keys, feature_configs, segments].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)
+      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 = OpenapiClient.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/ff/ruby/server/generated/lib/openapi_client/models/segment.rb

@@ -14,28 +14,38 @@ require 'date'
 require 'time'
 
 module OpenapiClient
+  # A Target Group (Segment) response
   class Segment
-    # Unique identifier for the segment.
+    # Unique identifier for the target group.
     attr_accessor :identifier
 
-    # Name of the segment.
+    # Name of the target group.
     attr_accessor :name
 
+    # The environment this target group belongs to
     attr_accessor :environment
 
+    # Tags for this target group
     attr_accessor :tags
 
+    # A list of Targets who belong to this target group
     attr_accessor :included
 
+    # A list of Targets who are excluded from this target group
     attr_accessor :excluded
 
-    # An array of rules that can cause a user to be included in this segment.
     attr_accessor :rules
 
+    # An array of rules that can cause a user to be included in this segment.
+    attr_accessor :serving_rules
+
+    # The data and time in milliseconds when the group was created
     attr_accessor :created_at
 
+    # The data and time in milliseconds when the group was last modified
     attr_accessor :modified_at
 
+    # The version of this group.  Each time it is modified the version is incremented
     attr_accessor :version
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -48,6 +58,7 @@ module OpenapiClient
         :'included' => :'included',
         :'excluded' => :'excluded',
         :'rules' => :'rules',
+        :'serving_rules' => :'servingRules',
         :'created_at' => :'createdAt',
         :'modified_at' => :'modifiedAt',
         :'version' => :'version'
@@ -69,6 +80,7 @@ module OpenapiClient
         :'included' => :'Array<Target>',
         :'excluded' => :'Array<Target>',
         :'rules' => :'Array<Clause>',
+        :'serving_rules' => :'Array<GroupServingRule>',
         :'created_at' => :'Integer',
         :'modified_at' => :'Integer',
         :'version' => :'Integer'
@@ -132,6 +144,12 @@ module OpenapiClient
         end
       end
 
+      if attributes.key?(:'serving_rules')
+        if (value = attributes[:'serving_rules']).is_a?(Array)
+          self.serving_rules = value
+        end
+      end
+
       if attributes.key?(:'created_at')
         self.created_at = attributes[:'created_at']
       end
@@ -180,6 +198,7 @@ module OpenapiClient
           included == o.included &&
           excluded == o.excluded &&
           rules == o.rules &&
+          serving_rules == o.serving_rules &&
           created_at == o.created_at &&
           modified_at == o.modified_at &&
           version == o.version
@@ -194,7 +213,7 @@ module OpenapiClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [identifier, name, environment, tags, included, excluded, rules, created_at, modified_at, version].hash
+      [identifier, name, environment, tags, included, excluded, rules, serving_rules, created_at, modified_at, version].hash
     end
 
     # Builds the object from hash

data/lib/ff/ruby/server/generated/lib/openapi_client/models/serve.rb

@@ -14,6 +14,7 @@ require 'date'
 require 'time'
 
 module OpenapiClient
+  # Describe the distribution rule and the variation that should be served to the target
   class Serve
     attr_accessor :distribution
 

data/lib/ff/ruby/server/generated/lib/openapi_client/models/serving_rule.rb

@@ -14,11 +14,15 @@ require 'date'
 require 'time'
 
 module OpenapiClient
+  # The rule used to determine what variation to serve to a target
   class ServingRule
+    # The unique identifier for this rule
     attr_accessor :rule_id
 
+    # The rules priority relative to other rules.  The rules are evaluated in order with 1 being the highest
     attr_accessor :priority
 
+    # A list of clauses to use in the rule
     attr_accessor :clauses
 
     attr_accessor :serve
@@ -92,10 +96,6 @@ module OpenapiClient
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
-      if @rule_id.nil?
-        invalid_properties.push('invalid value for "rule_id", rule_id cannot be nil.')
-      end
-
       if @priority.nil?
         invalid_properties.push('invalid value for "priority", priority cannot be nil.')
       end
@@ -114,7 +114,6 @@ module OpenapiClient
     # 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 @rule_id.nil?
       return false if @priority.nil?
       return false if @clauses.nil?
       return false if @serve.nil?

data/lib/ff/ruby/server/generated/lib/openapi_client/models/tag.rb

@@ -14,17 +14,19 @@ require 'date'
 require 'time'
 
 module OpenapiClient
-  # A name and value pair.
+  # A Tag object used to tag feature flags - consists of name and identifier
   class Tag
+    # The name of the tag
     attr_accessor :name
 
-    attr_accessor :value
+    # The identifier of the tag
+    attr_accessor :identifier
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'name' => :'name',
-        :'value' => :'value'
+        :'identifier' => :'identifier'
       }
     end
 
@@ -37,7 +39,7 @@ module OpenapiClient
     def self.openapi_types
       {
         :'name' => :'String',
-        :'value' => :'String'
+        :'identifier' => :'String'
       }
     end
 
@@ -66,8 +68,8 @@ module OpenapiClient
         self.name = attributes[:'name']
       end
 
-      if attributes.key?(:'value')
-        self.value = attributes[:'value']
+      if attributes.key?(:'identifier')
+        self.identifier = attributes[:'identifier']
       end
     end
 
@@ -79,6 +81,10 @@ module OpenapiClient
         invalid_properties.push('invalid value for "name", name cannot be nil.')
       end
 
+      if @identifier.nil?
+        invalid_properties.push('invalid value for "identifier", identifier cannot be nil.')
+      end
+
       invalid_properties
     end
 
@@ -86,6 +92,7 @@ module OpenapiClient
     # @return true if the model is valid
     def valid?
       return false if @name.nil?
+      return false if @identifier.nil?
       true
     end
 
@@ -95,7 +102,7 @@ module OpenapiClient
       return true if self.equal?(o)
       self.class == o.class &&
           name == o.name &&
-          value == o.value
+          identifier == o.identifier
     end
 
     # @see the `==` method
@@ -107,7 +114,7 @@ module OpenapiClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [name, value].hash
+      [name, identifier].hash
     end
 
     # Builds the object from hash

data/lib/ff/ruby/server/generated/lib/openapi_client/models/target.rb

@@ -14,25 +14,36 @@ require 'date'
 require 'time'
 
 module OpenapiClient
+  # A Target object
   class Target
+    # The unique identifier for this target
     attr_accessor :identifier
 
+    # The account ID that the target belongs to
     attr_accessor :account
 
+    # The identifier for the organization that the target belongs to
     attr_accessor :org
 
+    # The identifier for the environment that the target belongs to
     attr_accessor :environment
 
+    # The identifier for the project that this target belongs to
     attr_accessor :project
 
+    # The name of this Target
     attr_accessor :name
 
+    # Indicates if this target is anonymous
     attr_accessor :anonymous
 
+    # a JSON representation of the attributes for this target
     attr_accessor :attributes
 
+    # The date and time in milliseconds when this Target was created
     attr_accessor :created_at
 
+    # A list of Target Groups (Segments) that this Target belongs to
     attr_accessor :segments
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/ff/ruby/server/generated/lib/openapi_client/models/target_map.rb

@@ -14,9 +14,12 @@ require 'date'
 require 'time'
 
 module OpenapiClient
+  # Target map provides the details of a target that belongs to a flag
   class TargetMap
+    # The identifier for the target
     attr_accessor :identifier
 
+    # The name of the target
     attr_accessor :name
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -74,6 +77,10 @@ module OpenapiClient
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
+      if @identifier.nil?
+        invalid_properties.push('invalid value for "identifier", identifier cannot be nil.')
+      end
+
       if @name.nil?
         invalid_properties.push('invalid value for "name", name cannot be nil.')
       end
@@ -84,6 +91,7 @@ module OpenapiClient
     # 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 @identifier.nil?
       return false if @name.nil?
       true
     end

data/lib/ff/ruby/server/generated/lib/openapi_client/models/variation.rb

@@ -14,13 +14,18 @@ require 'date'
 require 'time'
 
 module OpenapiClient
+  # A variation of a flag that can be returned to a target
   class Variation
+    # The unique identifier for the variation
     attr_accessor :identifier
 
+    # The variation value to serve such as true or false for a boolean flag
     attr_accessor :value
 
+    # The user friendly name of the variation
     attr_accessor :name
 
+    # A description of the variation
     attr_accessor :description
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/ff/ruby/server/generated/lib/openapi_client/models/variation_map.rb

@@ -14,11 +14,15 @@ require 'date'
 require 'time'
 
 module OpenapiClient
+  # A mapping of variations to targets and target groups (segments).  The targets listed here should receive this variation.
   class VariationMap
+    # The variation identifier
     attr_accessor :variation
 
+    # A list of target mappings
     attr_accessor :targets
 
+    # A list of target groups (segments)
     attr_accessor :target_segments
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/ff/ruby/server/generated/lib/openapi_client/models/weighted_variation.rb

@@ -14,9 +14,12 @@ require 'date'
 require 'time'
 
 module OpenapiClient
+  # A variation and the weighting it should receive as part of a percentage rollout
   class WeightedVariation
+    # The variation identifier
     attr_accessor :variation
 
+    # The weight to be given to the variation in percent
     attr_accessor :weight
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/ff/ruby/server/generated/lib/openapi_client.rb

@@ -26,11 +26,16 @@ require 'openapi_client/models/error'
 require 'openapi_client/models/evaluation'
 require 'openapi_client/models/feature_config'
 require 'openapi_client/models/feature_state'
+require 'openapi_client/models/group_serving_rule'
+require 'openapi_client/models/inline_object'
 require 'openapi_client/models/key_value'
 require 'openapi_client/models/metrics'
 require 'openapi_client/models/metrics_data'
 require 'openapi_client/models/pagination'
 require 'openapi_client/models/prerequisite'
+require 'openapi_client/models/proxy_config'
+require 'openapi_client/models/proxy_config_all_of'
+require 'openapi_client/models/proxy_config_all_of_environments'
 require 'openapi_client/models/segment'
 require 'openapi_client/models/serve'
 require 'openapi_client/models/serving_rule'
@@ -45,6 +50,7 @@ require 'openapi_client/models/weighted_variation'
 # APIs
 require 'openapi_client/api/client_api'
 require 'openapi_client/api/metrics_api'
+require 'openapi_client/api/proxy_api'
 
 module OpenapiClient
   class << self

data/lib/ff/ruby/server/sdk/api/config.rb

@@ -35,7 +35,7 @@ class Config
 
     @frequency = @@min_frequency
 
-    @buffer_size = 2048
+    @buffer_size = 10000
 
     @all_attributes_private = false