algolia 3.0.0.alpha.7 → 3.0.0.alpha.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f178243d901a09bdc7e4c0e3b47e2c2c7f0ca3d20db76e7b310f16f6e1b9f3d0
-  data.tar.gz: c1d301f0c071472df043614b2d7cce87aa809694c0fba5c790abec1e17483fa1
+  metadata.gz: 3d10bc5a4416ac58ae021790e9690899657e2bb99bdb2db0545d0e66071768e7
+  data.tar.gz: 8ba97103d301846b9dac5a00b6e3438865b6f7754e2f105142557ada23a21ba1
 SHA512:
-  metadata.gz: 51da927c52fb523660c1b45718517cfc805d235fec4f4da35294f93d5cb93dc9a56ec9750bd9086fa23d4a54c9bcd7c6ad0afa672634577b4edca45784220e75
-  data.tar.gz: 8cd4e5732f6721eadfeb595b7928b21f152734fa8cfcdedc0a53bfb938f887bd7b99173759c72c1c95e08215e6218ff618fd6fe32d402af41ab6338de3d33e92
+  metadata.gz: 97eee1cc7661f4c159b9254f1c1355a37b3394bb306ba68f26165f027ae8f49fb5b6f6c287d1d62a3e9c50d63e160a63564f11b00f9ecaf4247d2efeceed907e
+  data.tar.gz: 65a63a9ba144c499d608e86efb1e92715433a80a68620079c8c66be96fafc238fd75ffed2bf7ffa4614a5f34727acbe534933fff5870d809e37ac748ede06b5a

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## [3.0.0.alpha.8](https://github.com/algolia/algoliasearch-client-ruby/compare/3.0.0.alpha.7...3.0.0.alpha.8)
+
+- [6624759e1](https://github.com/algolia/api-clients-automation/commit/6624759e1) feat(specs): add CustomFields to CT Source Input ([#2742](https://github.com/algolia/api-clients-automation/pull/2742)) by [@damcou](https://github.com/damcou/)
+- [ef37e65b7](https://github.com/algolia/api-clients-automation/commit/ef37e65b7) fix(clients): add e2e tests for analytics API ([#2737](https://github.com/algolia/api-clients-automation/pull/2737)) by [@millotp](https://github.com/millotp/)
+
 ## [3.0.0.alpha.7](https://github.com/algolia/algoliasearch-client-ruby/compare/3.0.0.alpha.6...3.0.0.alpha.7)
 
 - [28b34ffb6](https://github.com/algolia/api-clients-automation/commit/28b34ffb6) feat(ruby): add browse helpers ([#2669](https://github.com/algolia/api-clients-automation/pull/2669)) by [@millotp](https://github.com/millotp/)

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    algolia (3.0.0.alpha.7)
+    algolia (3.0.0.alpha.8)
       faraday (>= 1.0.1, < 3.0)
       faraday-net_http_persistent (>= 0.15, < 3)
       net-http-persistent

data/lib/algolia/models/ingestion/authentication.rb

@@ -5,7 +5,7 @@ require 'time'
 
 module Algolia
   module Ingestion
-    # An authentication is used to login into a Source or a Destination.
+    # An authentication is used to login into a Source or a Destination, with obfuscated input.
     class Authentication
       # The authentication UUID.
       attr_accessor :authentication_id
@@ -72,7 +72,7 @@ module Algolia
           :type => :AuthenticationType,
           :name => :String,
           :platform => :Platform,
-          :input => :AuthInput,
+          :input => :AuthInputPartial,
           :created_at => :String,
           :updated_at => :String
         }
@@ -80,7 +80,9 @@ module Algolia
 
       # List of attributes with nullable: true
       def self.openapi_nullable
-        Set.new([])
+        Set.new([
+                  :platform
+                ])
       end
 
       # Initializes the object

data/lib/algolia/models/ingestion/authentication_create.rb

@@ -65,7 +65,9 @@ module Algolia
 
       # List of attributes with nullable: true
       def self.openapi_nullable
-        Set.new([])
+        Set.new([
+                  :platform
+                ])
       end
 
       # Initializes the object

data/lib/algolia/models/ingestion/authentication_update.rb

@@ -65,7 +65,9 @@ module Algolia
 
       # List of attributes with nullable: true
       def self.openapi_nullable
-        Set.new([])
+        Set.new([
+                  :platform
+                ])
       end
 
       # Initializes the object

data/lib/algolia/models/ingestion/commercetools_custom_fields.rb

@@ -0,0 +1,224 @@
+# 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 Ingestion
+    # Custom fields from Commercetools to index in the records (see https://docs.commercetools.com/tutorials/custom-types).
+    class CommercetoolsCustomFields
+      # Inventory custom fields.
+      attr_accessor :inventory
+
+      # Price custom fields.
+      attr_accessor :price
+
+      # Category custom fields.
+      attr_accessor :category
+
+      # Attribute mapping from ruby-style variable name to JSON key.
+      def self.attribute_map
+        {
+          :inventory => :inventory,
+          :price => :price,
+          :category => :category
+        }
+      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
+        {
+          :inventory => :'Array<String>',
+          :price => :'Array<String>',
+          :category => :'Array<String>'
+        }
+      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::CommercetoolsCustomFields` 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::CommercetoolsCustomFields`. 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?(:inventory)
+          if (value = attributes[:inventory]).is_a?(Array)
+            self.inventory = value
+          end
+        end
+
+        if attributes.key?(:price)
+          if (value = attributes[:price]).is_a?(Array)
+            self.price = value
+          end
+        end
+
+        if attributes.key?(:category)
+          if (value = attributes[:category]).is_a?(Array)
+            self.category = value
+          end
+        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 &&
+          inventory == other.inventory &&
+          price == other.price &&
+          category == other.category
+      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
+        [inventory, price, category].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_sym] = 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_sym] = attributes[attribute_map[key]].map { |v| _deserialize(::Regexp.last_match(1), v) }
+            end
+          elsif !attributes[attribute_map[key]].nil?
+            transformed_hash[key.to_sym] = _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::Ingestion.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
+
+      def to_json(*_args)
+        to_hash.to_json
+      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/ingestion/destination.rb

@@ -23,6 +23,7 @@ module Algolia
       # Date of last update (RFC3339 format).
       attr_accessor :updated_at
 
+      # The authentication UUID.
       attr_accessor :authentication_id
 
       class EnumAttributeValidator

data/lib/algolia/models/ingestion/destination_update.rb

@@ -14,6 +14,7 @@ module Algolia
 
       attr_accessor :input
 
+      # The authentication UUID.
       attr_accessor :authentication_id
 
       class EnumAttributeValidator

data/lib/algolia/models/ingestion/source_big_commerce.rb

@@ -68,6 +68,8 @@ module Algolia
 
         if attributes.key?(:store_hash)
           self.store_hash = attributes[:store_hash]
+        else
+          self.store_hash = nil
         end
 
         if attributes.key?(:channel)

data/lib/algolia/models/ingestion/source_commercetools.rb

@@ -18,6 +18,8 @@ module Algolia
       # Determines the value that will be stored in the Algolia record if there's no inventory information on the product.
       attr_accessor :fallback_is_in_stock_value
 
+      attr_accessor :custom_fields
+
       # Attribute mapping from ruby-style variable name to JSON key.
       def self.attribute_map
         {
@@ -25,7 +27,8 @@ module Algolia
           :locales => :locales,
           :url => :url,
           :project_key => :projectKey,
-          :fallback_is_in_stock_value => :fallbackIsInStockValue
+          :fallback_is_in_stock_value => :fallbackIsInStockValue,
+          :custom_fields => :customFields
         }
       end
 
@@ -41,7 +44,8 @@ module Algolia
           :locales => :'Array<String>',
           :url => :String,
           :project_key => :String,
-          :fallback_is_in_stock_value => :Boolean
+          :fallback_is_in_stock_value => :Boolean,
+          :custom_fields => :CommercetoolsCustomFields
         }
       end
 
@@ -94,6 +98,10 @@ module Algolia
         if attributes.key?(:fallback_is_in_stock_value)
           self.fallback_is_in_stock_value = attributes[:fallback_is_in_stock_value]
         end
+
+        if attributes.key?(:custom_fields)
+          self.custom_fields = attributes[:custom_fields]
+        end
       end
 
       # Checks equality by comparing each attribute.
@@ -106,7 +114,8 @@ module Algolia
           locales == other.locales &&
           url == other.url &&
           project_key == other.project_key &&
-          fallback_is_in_stock_value == other.fallback_is_in_stock_value
+          fallback_is_in_stock_value == other.fallback_is_in_stock_value &&
+          custom_fields == other.custom_fields
       end
 
       # @see the `==` method
@@ -118,7 +127,7 @@ module Algolia
       # Calculates hash code according to all attributes.
       # @return [Integer] Hash code
       def hash
-        [store_keys, locales, url, project_key, fallback_is_in_stock_value].hash
+        [store_keys, locales, url, project_key, fallback_is_in_stock_value, custom_fields].hash
       end
 
       # Builds the object from hash

data/lib/algolia/models/ingestion/source_update_commercetools.rb

@@ -12,11 +12,14 @@ module Algolia
       # Array of locales that must match the following pattern: ^[a-z]{2}(-[A-Z]{2})?$. For example [\"fr-FR\", \"en\"].
       attr_accessor :locales
 
+      attr_accessor :custom_fields
+
       # Attribute mapping from ruby-style variable name to JSON key.
       def self.attribute_map
         {
           :store_keys => :storeKeys,
-          :locales => :locales
+          :locales => :locales,
+          :custom_fields => :customFields
         }
       end
 
@@ -29,7 +32,8 @@ module Algolia
       def self.types_mapping
         {
           :store_keys => :'Array<String>',
-          :locales => :'Array<String>'
+          :locales => :'Array<String>',
+          :custom_fields => :CommercetoolsCustomFields
         }
       end
 
@@ -66,6 +70,10 @@ module Algolia
             self.locales = value
           end
         end
+
+        if attributes.key?(:custom_fields)
+          self.custom_fields = attributes[:custom_fields]
+        end
       end
 
       # Checks equality by comparing each attribute.
@@ -75,7 +83,8 @@ module Algolia
 
         self.class == other.class &&
           store_keys == other.store_keys &&
-          locales == other.locales
+          locales == other.locales &&
+          custom_fields == other.custom_fields
       end
 
       # @see the `==` method
@@ -87,7 +96,7 @@ module Algolia
       # Calculates hash code according to all attributes.
       # @return [Integer] Hash code
       def hash
-        [store_keys, locales].hash
+        [store_keys, locales, custom_fields].hash
       end
 
       # Builds the object from hash

data/lib/algolia/transport/http/http_requester.rb

@@ -56,7 +56,8 @@ module Algolia
       # @return [Faraday::Connection]
       #
       def connection(host)
-        @connections[build_url(host)] ||= Faraday.new(build_url(host)) do |f|
+        url = build_url(host)
+        @connections[url] ||= Faraday.new(url) do |f|
           f.adapter @adapter.to_sym
         end
       end

data/lib/algolia/transport/transport.rb

@@ -1,6 +1,7 @@
 require 'faraday'
 # this is the default adapter and it needs to be required to be registered.
 require 'faraday/net_http_persistent' unless Faraday::VERSION < '1'
+require 'zlib'
 
 module Algolia
   module Transport
@@ -77,24 +78,38 @@ module Algolia
         request                   = {}
         request[:method]          = method.downcase
         request[:path]            = path
-        request[:body]            = body
+        request[:body]            = build_body(body, request_options)
         request[:query_params]    = stringify_query_params(request_options.query_params)
-        request[:header_params]   = generate_header_params(request_options)
+        request[:header_params]   = generate_header_params(body, request_options)
         request[:timeout]         = request_options.timeout
         request[:connect_timeout] = request_options.connect_timeout
         request
       end
 
+      # Builds the body of the request, with gzip compression if needed
+      def build_body(body, request_options)
+        return nil if body.nil?
+
+        if request_options.compression_type == 'gzip'
+          body = Zlib.gzip(body)
+        end
+
+        body
+      end
+
       # Generates headers from config headers and optional parameters
       #
       # @param request_options [RequestOptions]
       #
       # @return [Hash] merged headers
       #
-      def generate_header_params(request_options = {})
+      def generate_header_params(body, request_options)
         header_params = request_options.header_params.transform_keys(&:downcase)
         header_params = @config.header_params.merge(header_params)
         header_params['accept-encoding'] = 'gzip' if request_options.compression_type == 'gzip'
+        if request_options.compression_type == 'gzip' && body.is_a?(String) && !body.to_s.strip.empty?
+          header_params['content-encoding'] = 'gzip'
+        end
 
         header_params
       end

data/lib/algolia/version.rb

@@ -1,5 +1,5 @@
 # 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.
 
 module Algolia
-  VERSION = '3.0.0.alpha.7'.freeze
+  VERSION = '3.0.0.alpha.8'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: algolia
 version: !ruby/object:Gem::Version
-  version: 3.0.0.alpha.7
+  version: 3.0.0.alpha.8
 platform: ruby
 authors:
 - Algolia
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-02-16 00:00:00.000000000 Z
+date: 2024-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -221,6 +221,7 @@ files:
 - lib/algolia/models/ingestion/big_commerce_channel.rb
 - lib/algolia/models/ingestion/big_commerce_metafield.rb
 - lib/algolia/models/ingestion/big_query_data_type.rb
+- lib/algolia/models/ingestion/commercetools_custom_fields.rb
 - lib/algolia/models/ingestion/delete_response.rb
 - lib/algolia/models/ingestion/destination.rb
 - lib/algolia/models/ingestion/destination_create.rb