algolia 2.3.4 → 3.0.0.alpha.2

data/lib/algolia/models/recommend/highlight_result_option.rb

@@ -0,0 +1,253 @@
+# Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
+
+require 'date'
+require 'time'
+
+module Algolia
+  module Recommend
+    # Show highlighted section and words matched on a query.
+    class HighlightResultOption
+      # Markup text with `facetQuery` matches highlighted.
+      attr_accessor :value
+
+      attr_accessor :match_level
+
+      # List of words from the query that matched the object.
+      attr_accessor :matched_words
+
+      # Whether the entire attribute value is highlighted.
+      attr_accessor :fully_highlighted
+
+      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
+        {
+          :value => :value,
+          :match_level => :matchLevel,
+          :matched_words => :matchedWords,
+          :fully_highlighted => :fullyHighlighted
+        }
+      end
+
+      # Returns all the JSON keys this model knows about
+      def self.acceptable_attributes
+        attribute_map.values
+      end
+
+      # Attribute type mapping.
+      def self.types_mapping
+        {
+          :value => :String,
+          :match_level => :MatchLevel,
+          :matched_words => :'Array<String>',
+          :fully_highlighted => :Boolean
+        }
+      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 = {})
+        unless attributes.is_a?(Hash)
+          raise ArgumentError, "The input argument (attributes) must be a hash in `Algolia::HighlightResultOption` initialize method"
+        end
+
+        # check to see if the attribute exists and convert string to symbol for hash key
+        attributes = attributes.each_with_object({}) do |(k, v), h|
+          unless self.class.attribute_map.key?(k.to_sym)
+            raise ArgumentError,
+                  "`#{k}` is not a valid attribute in `Algolia::HighlightResultOption`. 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
+        end
+
+        if attributes.key?(:value)
+          self.value = attributes[:value]
+        else
+          self.value = nil
+        end
+
+        if attributes.key?(:match_level)
+          self.match_level = attributes[:match_level]
+        else
+          self.match_level = nil
+        end
+
+        if attributes.key?(:matched_words)
+          if (value = attributes[:matched_words]).is_a?(Array)
+            self.matched_words = value
+          end
+        else
+          self.matched_words = nil
+        end
+
+        if attributes.key?(:fully_highlighted)
+          self.fully_highlighted = attributes[:fully_highlighted]
+        end
+      end
+
+      # Checks equality by comparing each attribute.
+      # @param [Object] Object to be compared
+      def ==(other)
+        return true if equal?(other)
+
+        self.class == other.class &&
+          value == other.value &&
+          match_level == other.match_level &&
+          matched_words == other.matched_words &&
+          fully_highlighted == other.fully_highlighted
+      end
+
+      # @see the `==` method
+      # @param [Object] Object to be compared
+      def eql?(other)
+        self == other
+      end
+
+      # Calculates hash code according to all attributes.
+      # @return [Integer] Hash code
+      def hash
+        [value, match_level, matched_words, fully_highlighted].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 = {}
+        types_mapping.each_pair do |key, type|
+          if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+            transformed_hash[key.to_s] = 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.to_s] = attributes[attribute_map[key]].map { |v| _deserialize(::Regexp.last_match(1), v) }
+            end
+          elsif !attributes[attribute_map[key]].nil?
+            transformed_hash[key.to_s] = _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 = Algolia::Recommend.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 = 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
+end

data/lib/algolia/models/recommend/ignore_plurals.rb

@@ -0,0 +1,97 @@
+# Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
+
+require 'date'
+require 'time'
+
+module Algolia
+  module Recommend
+    # Treats singular, plurals, and other forms of declensions as matching terms. `ignorePlurals` is used in conjunction with the `queryLanguages` setting. _list_: language ISO codes for which ignoring plurals should be enabled. This list will override any values that you may have set in `queryLanguages`. _true_: enables the ignore plurals feature, where singulars and plurals are considered equivalent (\"foot\" = \"feet\"). The languages supported here are either [every language](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages/) (this is the default) or those set by `queryLanguages`. _false_: turns off the ignore plurals feature, so that singulars and plurals aren't considered to be the same (\"foot\" will not find \"feet\").
+    module IgnorePlurals
+      class << self
+        # List of class defined in oneOf (OpenAPI v3)
+        def openapi_one_of
+          [
+            :'Array<String>',
+            :Boolean
+          ]
+        end
+
+        # Builds the object
+        # @param [Mixed] Data to be matched against the list of oneOf items
+        # @return [Object] Returns the model or the data itself
+        def build(data)
+          # Go through the list of oneOf items and attempt to identify the appropriate one.
+          # Note:
+          # - We do not attempt to check whether exactly one item matches.
+          # - No advanced validation of types in some cases (e.g. "x: { type: string }" will happily match { x: 123 })
+          #   due to the way the deserialization is made in the base_object template (it just casts without verifying).
+          # - TODO: scalar values are de facto behaving as if they were nullable.
+          # - TODO: logging when debugging is set.
+          openapi_one_of.each do |klass|
+            next if klass == :AnyType # "nullable: true"
+
+            typed_data = find_and_cast_into_type(klass, data)
+            return typed_data if typed_data
+          rescue # rescue all errors so we keep iterating even if the current item lookup raises
+          end
+
+          openapi_one_of.include?(:AnyType) ? data : nil
+        end
+
+        private
+
+        SchemaMismatchError = Class.new(StandardError)
+
+        # NOTE: 'File' is missing here because in the regular case we get the data _after_ a call to JSON.parse.
+        def find_and_cast_into_type(klass, data)
+          return if data.nil?
+
+          case klass.to_s
+          when 'Boolean'
+            return data if data.instance_of?(TrueClass) || data.instance_of?(FalseClass)
+          when 'Float'
+            return data if data.instance_of?(Float)
+          when 'Integer'
+            return data if data.instance_of?(Integer)
+          when 'Time'
+            return Time.parse(data)
+          when 'Date'
+            return Date.parse(data)
+          when 'String'
+            return data if data.instance_of?(String)
+          when 'Object' # "type: object"
+            return data if data.instance_of?(Hash)
+          when /\AArray<(?<sub_type>.+)>\z/ # "type: array"
+            if data.instance_of?(Array)
+              sub_type = Regexp.last_match[:sub_type]
+              return data.map { |item| find_and_cast_into_type(sub_type, item) }
+            end
+          when /\AHash<String, (?<sub_type>.+)>\z/ # "type: object" with "additionalProperties: { ... }"
+            if data.instance_of?(Hash) && data.keys.all? { |k| k.instance_of?(Symbol) || k.instance_of?(String) }
+              sub_type = Regexp.last_match[:sub_type]
+              return data.each_with_object({}) { |(k, v), hsh| hsh[k] = find_and_cast_into_type(sub_type, v) }
+            end
+          else # model
+            const = Algolia.const_get(klass)
+            if const
+              if const.respond_to?(:openapi_one_of) # nested oneOf model
+                model = const.build(data)
+              else
+                # raise if data contains keys that are not known to the model
+                raise unless (data.keys - const.acceptable_attributes).empty?
+
+                model = const.build_from_hash(data)
+              end
+
+              return model if model
+            end
+          end
+
+          raise # if no match by now, raise
+        rescue
+          raise SchemaMismatchError, "#{data} doesn't match the #{klass} type"
+        end
+      end
+    end
+  end
+end