algolia 3.0.0.beta.8 → 3.0.0.beta.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: df1df29d4bb320313ff2e7f0c05a4b76a3d6188b9f08a692af7403dc6d99472b
-  data.tar.gz: 9b18848ff6241cde6f18523aa706303a4c74c4ec067631c922eecadc28d4c0be
+  metadata.gz: 5fcea9c4cdc2e5fe4b4bbefdd10a24ef88aac0da2032a4637e2d8c7b26637ac5
+  data.tar.gz: 178c675d48ffb5ed60b6432af57d75e033612b4b1f10af4d7b478dd3e30b3886
 SHA512:
-  metadata.gz: 78c85cc136bdf8d52e43bc14a98c1c7ed54b0c0aa79ebf064610b0a658cb1eca4ec895fc31afbef3f7a8f618303336e339a09b82decc9c2fd2e4d5e91fd1978e
-  data.tar.gz: e13c8fcbc458cbaf053f88e3ccf6e87c1744d6dc91947f62a443b3d73aa3c254dc5ccc14adfe8b33c1648a50cd64ecef96f3b6a9975f4d66eb3c0767c5064bbb
+  metadata.gz: 4a2a2f15b69fff7582e8de983d6525403daa1179693b2f0362d576dbc8c34ce75ca13c742874def1ea9788d38feaad376d8c8cd00e8a80671dac157eb430ebd4
+  data.tar.gz: 71e9d8baf51f1a2b67eb684897e289b581259ee5ea28f9bebb6374f7f253af3e8b61d55c2d9ad411fc891be8d8c7e9425659e38b8d65b47f5fc41a9f4315c7c2

data/.github/workflows/release.yml

@@ -25,3 +25,5 @@ jobs:
           bundler-cache: true
 
       - uses: rubygems/release-gem@612653d273a73bdae1df8453e090060bb4db5f31
+        with:
+          await-release: false

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## [3.0.0.beta.9](https://github.com/algolia/algoliasearch-client-ruby/compare/3.0.0.beta.8...3.0.0.beta.9)
+
+- [a009967f6](https://github.com/algolia/api-clients-automation/commit/a009967f6) fix(specs): browse response required properties ([#3348](https://github.com/algolia/api-clients-automation/pull/3348)) by [@millotp](https://github.com/millotp/)
+- [04a799417](https://github.com/algolia/api-clients-automation/commit/04a799417) fix(specs): ingestion task and transformation ([#3347](https://github.com/algolia/api-clients-automation/pull/3347)) by [@shortcuts](https://github.com/shortcuts/)
+- [83badf20c](https://github.com/algolia/api-clients-automation/commit/83badf20c) fix(ruby): add the base64 dependency ([#3345](https://github.com/algolia/api-clients-automation/pull/3345)) by [@millotp](https://github.com/millotp/)
+- [586e13a54](https://github.com/algolia/api-clients-automation/commit/586e13a54) fix(ruby): use rubyfmt instead of rubocop ([#3334](https://github.com/algolia/api-clients-automation/pull/3334)) by [@millotp](https://github.com/millotp/)
+- [dcb1b59dc](https://github.com/algolia/api-clients-automation/commit/dcb1b59dc) fix(specs): clarify browse parameters ([#3333](https://github.com/algolia/api-clients-automation/pull/3333)) by [@kai687](https://github.com/kai687/)
+
 ## [3.0.0.beta.8](https://github.com/algolia/algoliasearch-client-ruby/compare/3.0.0.beta.7...3.0.0.beta.8)
 
 - [9776cb3ba](https://github.com/algolia/api-clients-automation/commit/9776cb3ba) feat(specs): add redirect to renderingContent ([#3296](https://github.com/algolia/api-clients-automation/pull/3296)) by [@shortcuts](https://github.com/shortcuts/)

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    algolia (3.0.0.beta.8)
+    algolia (3.0.0.beta.9)
+      base64 (>= 0.2.0, < 1)
       faraday (>= 1.0.1, < 3.0)
       faraday-net_http_persistent (>= 0.15, < 3)
       net-http-persistent
@@ -9,7 +10,7 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    ast (2.4.2)
+    base64 (0.2.0)
     connection_pool (2.4.1)
     faraday (2.9.0)
       faraday-net_http (>= 2.0, < 3.2)
@@ -18,38 +19,11 @@ GEM
     faraday-net_http_persistent (2.1.0)
       faraday (~> 2.5)
       net-http-persistent (~> 4.0)
-    json (2.7.2)
-    language_server-protocol (3.17.0.3)
     net-http (0.4.1)
       uri
     net-http-persistent (4.0.2)
       connection_pool (~> 2.2)
-    parallel (1.24.0)
-    parser (3.3.1.0)
-      ast (~> 2.4.1)
-      racc
-    racc (1.7.3)
-    rainbow (3.1.1)
     rake (13.2.1)
-    regexp_parser (2.9.1)
-    rexml (3.2.8)
-      strscan (>= 3.0.9)
-    rubocop (1.63.5)
-      json (~> 2.3)
-      language_server-protocol (>= 3.17.0)
-      parallel (~> 1.10)
-      parser (>= 3.3.0.2)
-      rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.31.1, < 2.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.31.3)
-      parser (>= 3.3.1.0)
-    ruby-progressbar (1.13.0)
-    strscan (3.1.0)
-    unicode-display_width (2.5.0)
     uri (0.13.0)
 
 PLATFORMS
@@ -60,7 +34,6 @@ DEPENDENCIES
   algolia!
   bundler
   rake
-  rubocop
 
 BUNDLED WITH
    2.4.10

data/Rakefile

@@ -1,6 +1,4 @@
 require 'bundler/gem_tasks'
-require 'rubocop/rake_task'
 
 task(:default) { system 'rake --tasks' }
 
-RuboCop::RakeTask.new

data/algolia.gemspec

@@ -26,10 +26,10 @@ Gem::Specification.new do |s|
 
   s.add_dependency 'faraday', '>= 1.0.1', '< 3.0'
   s.add_dependency 'faraday-net_http_persistent', ['>= 0.15', '< 3']
+  s.add_dependency 'base64', '>= 0.2.0', '< 1'
 
   s.add_dependency 'net-http-persistent'
 
   s.add_development_dependency 'bundler'
   s.add_development_dependency 'rake'
-  s.add_development_dependency 'rubocop'
 end

data/lib/algolia/api/abtesting_client.rb

@@ -5,28 +5,33 @@ module Algolia
     attr_accessor :api_client
 
     def initialize(config = nil)
-      raise '`config` is missing.' if config.nil?
-      raise '`app_id` is missing.' if config.app_id.nil? || config.app_id == ''
-      raise '`api_key` is missing.' if config.api_key.nil? || config.api_key == ''
+      raise "`config` is missing." if config.nil?
+      raise "`app_id` is missing." if config.app_id.nil? || config.app_id == ""
+      raise "`api_key` is missing." if config.api_key.nil? || config.api_key == ""
 
       @api_client = Algolia::ApiClient.new(config)
     end
 
     def self.create(app_id, api_key, region = nil, opts = {})
       hosts = []
-      regions = ['de', 'us']
+      regions = ["de", "us"]
 
       if region.is_a?(Hash) && (opts.nil? || opts.empty?)
         opts = region
         region = nil
       end
 
-      raise "`region` must be one of the following: #{regions.join(', ')}" if !region.nil? && (!region.is_a?(String) || !regions.include?(region))
+      if !region.nil? && (!region.is_a?(String) || !regions.include?(region))
+        raise "`region` must be one of the following: #{regions.join(", ")}"
+      end
 
-      hosts << Transport::StatefulHost.new(region.nil? ? 'analytics.algolia.com' : 'analytics.{region}.algolia.com'.sub!('{region}', region),
-                                           accept: CallType::READ | CallType::WRITE)
+      hosts <<
+        Transport::StatefulHost.new(
+          region.nil? ? "analytics.algolia.com" : "analytics.{region}.algolia.com".sub!("{region}", region),
+          accept: CallType::READ | CallType::WRITE
+        )
 
-      config = Algolia::Configuration.new(app_id, api_key, hosts, 'Abtesting', opts)
+      config = Algolia::Configuration.new(app_id, api_key, hosts, "Abtesting", opts)
       create_with_config(config)
     end
 
@@ -47,7 +52,7 @@ module Algolia
         raise ArgumentError, "Parameter `add_ab_tests_request` is required when calling `add_ab_tests`."
       end
 
-      path = '/2/abtests'
+      path = "/2/abtests"
       query_params = {}
       query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
       header_params = {}
@@ -56,7 +61,7 @@ module Algolia
       post_body = request_options[:debug_body] || @api_client.object_to_http_body(add_ab_tests_request)
 
       new_options = request_options.merge(
-        :operation => :'AbtestingClient.add_ab_tests',
+        :operation => :"AbtestingClient.add_ab_tests",
         :header_params => header_params,
         :query_params => query_params,
         :body => post_body,
@@ -75,7 +80,7 @@ module Algolia
     # @return [ABTestResponse]
     def add_ab_tests(add_ab_tests_request, request_options = {})
       response = add_ab_tests_with_http_info(add_ab_tests_request, request_options)
-      @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Abtesting::ABTestResponse')
+      @api_client.deserialize(response.body, request_options[:debug_return_type] || "Abtesting::ABTestResponse")
     end
 
     # This method allow you to send requests to the Algolia REST API.
@@ -90,7 +95,7 @@ module Algolia
         raise ArgumentError, "Parameter `path` is required when calling `custom_delete`."
       end
 
-      path = '/{path}'.sub('{' + 'path' + '}', path.to_s)
+      path = "/{path}".sub("{" + "path" + "}", path.to_s)
       query_params = {}
       query_params = query_params.merge(parameters) unless parameters.nil?
       query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
@@ -100,7 +105,7 @@ module Algolia
       post_body = request_options[:debug_body]
 
       new_options = request_options.merge(
-        :operation => :'AbtestingClient.custom_delete',
+        :operation => :"AbtestingClient.custom_delete",
         :header_params => header_params,
         :query_params => query_params,
         :body => post_body,
@@ -118,7 +123,7 @@ module Algolia
     # @return [Object]
     def custom_delete(path, parameters = nil, request_options = {})
       response = custom_delete_with_http_info(path, parameters, request_options)
-      @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Object')
+      @api_client.deserialize(response.body, request_options[:debug_return_type] || "Object")
     end
 
     # This method allow you to send requests to the Algolia REST API.
@@ -133,7 +138,7 @@ module Algolia
         raise ArgumentError, "Parameter `path` is required when calling `custom_get`."
       end
 
-      path = '/{path}'.sub('{' + 'path' + '}', path.to_s)
+      path = "/{path}".sub("{" + "path" + "}", path.to_s)
       query_params = {}
       query_params = query_params.merge(parameters) unless parameters.nil?
       query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
@@ -143,7 +148,7 @@ module Algolia
       post_body = request_options[:debug_body]
 
       new_options = request_options.merge(
-        :operation => :'AbtestingClient.custom_get',
+        :operation => :"AbtestingClient.custom_get",
         :header_params => header_params,
         :query_params => query_params,
         :body => post_body,
@@ -161,7 +166,7 @@ module Algolia
     # @return [Object]
     def custom_get(path, parameters = nil, request_options = {})
       response = custom_get_with_http_info(path, parameters, request_options)
-      @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Object')
+      @api_client.deserialize(response.body, request_options[:debug_return_type] || "Object")
     end
 
     # This method allow you to send requests to the Algolia REST API.
@@ -177,7 +182,7 @@ module Algolia
         raise ArgumentError, "Parameter `path` is required when calling `custom_post`."
       end
 
-      path = '/{path}'.sub('{' + 'path' + '}', path.to_s)
+      path = "/{path}".sub("{" + "path" + "}", path.to_s)
       query_params = {}
       query_params = query_params.merge(parameters) unless parameters.nil?
       query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
@@ -187,7 +192,7 @@ module Algolia
       post_body = request_options[:debug_body] || @api_client.object_to_http_body(body)
 
       new_options = request_options.merge(
-        :operation => :'AbtestingClient.custom_post',
+        :operation => :"AbtestingClient.custom_post",
         :header_params => header_params,
         :query_params => query_params,
         :body => post_body,
@@ -206,7 +211,7 @@ module Algolia
     # @return [Object]
     def custom_post(path, parameters = nil, body = nil, request_options = {})
       response = custom_post_with_http_info(path, parameters, body, request_options)
-      @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Object')
+      @api_client.deserialize(response.body, request_options[:debug_return_type] || "Object")
     end
 
     # This method allow you to send requests to the Algolia REST API.
@@ -222,7 +227,7 @@ module Algolia
         raise ArgumentError, "Parameter `path` is required when calling `custom_put`."
       end
 
-      path = '/{path}'.sub('{' + 'path' + '}', path.to_s)
+      path = "/{path}".sub("{" + "path" + "}", path.to_s)
       query_params = {}
       query_params = query_params.merge(parameters) unless parameters.nil?
       query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
@@ -232,7 +237,7 @@ module Algolia
       post_body = request_options[:debug_body] || @api_client.object_to_http_body(body)
 
       new_options = request_options.merge(
-        :operation => :'AbtestingClient.custom_put',
+        :operation => :"AbtestingClient.custom_put",
         :header_params => header_params,
         :query_params => query_params,
         :body => post_body,
@@ -251,7 +256,7 @@ module Algolia
     # @return [Object]
     def custom_put(path, parameters = nil, body = nil, request_options = {})
       response = custom_put_with_http_info(path, parameters, body, request_options)
-      @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Object')
+      @api_client.deserialize(response.body, request_options[:debug_return_type] || "Object")
     end
 
     # Deletes an A/B test by its ID.
@@ -267,7 +272,7 @@ module Algolia
         raise ArgumentError, "Parameter `id` is required when calling `delete_ab_test`."
       end
 
-      path = '/2/abtests/{id}'.sub('{' + 'id' + '}', Transport.encode_uri(id.to_s))
+      path = "/2/abtests/{id}".sub("{" + "id" + "}", Transport.encode_uri(id.to_s))
       query_params = {}
       query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
       header_params = {}
@@ -276,7 +281,7 @@ module Algolia
       post_body = request_options[:debug_body]
 
       new_options = request_options.merge(
-        :operation => :'AbtestingClient.delete_ab_test',
+        :operation => :"AbtestingClient.delete_ab_test",
         :header_params => header_params,
         :query_params => query_params,
         :body => post_body,
@@ -295,7 +300,7 @@ module Algolia
     # @return [ABTestResponse]
     def delete_ab_test(id, request_options = {})
       response = delete_ab_test_with_http_info(id, request_options)
-      @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Abtesting::ABTestResponse')
+      @api_client.deserialize(response.body, request_options[:debug_return_type] || "Abtesting::ABTestResponse")
     end
 
     # Retrieves the details for an A/B test by its ID.
@@ -311,7 +316,7 @@ module Algolia
         raise ArgumentError, "Parameter `id` is required when calling `get_ab_test`."
       end
 
-      path = '/2/abtests/{id}'.sub('{' + 'id' + '}', Transport.encode_uri(id.to_s))
+      path = "/2/abtests/{id}".sub("{" + "id" + "}", Transport.encode_uri(id.to_s))
       query_params = {}
       query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
       header_params = {}
@@ -320,7 +325,7 @@ module Algolia
       post_body = request_options[:debug_body]
 
       new_options = request_options.merge(
-        :operation => :'AbtestingClient.get_ab_test',
+        :operation => :"AbtestingClient.get_ab_test",
         :header_params => header_params,
         :query_params => query_params,
         :body => post_body,
@@ -339,7 +344,7 @@ module Algolia
     # @return [ABTest]
     def get_ab_test(id, request_options = {})
       response = get_ab_test_with_http_info(id, request_options)
-      @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Abtesting::ABTest')
+      @api_client.deserialize(response.body, request_options[:debug_return_type] || "Abtesting::ABTest")
     end
 
     # Lists all A/B tests you configured for this application.
@@ -352,12 +357,21 @@ module Algolia
     # @param index_suffix [String] Index name suffix. Only A/B tests for indices ending with this string are included in the response.
     # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
     # @return [Http::Response] the response
-    def list_ab_tests_with_http_info(offset = nil, limit = nil, index_prefix = nil, index_suffix = nil, request_options = {})
+    def list_ab_tests_with_http_info(
+      offset = nil,
+      limit = nil,
+      index_prefix = nil,
+      index_suffix = nil,
+      request_options = {}
+    )
       if @api_client.config.client_side_validation && !offset.nil? && offset < 0
-        raise ArgumentError, 'invalid value for ""offset"" when calling AbtestingClient.list_ab_tests, must be greater than or equal to 0.'
+        raise(
+          ArgumentError,
+          "invalid value for \"\"offset\"\" when calling AbtestingClient.list_ab_tests, must be greater than or equal to 0."
+        )
       end
 
-      path = '/2/abtests'
+      path = "/2/abtests"
       query_params = {}
       query_params[:offset] = offset unless offset.nil?
       query_params[:limit] = limit unless limit.nil?
@@ -370,7 +384,7 @@ module Algolia
       post_body = request_options[:debug_body]
 
       new_options = request_options.merge(
-        :operation => :'AbtestingClient.list_ab_tests',
+        :operation => :"AbtestingClient.list_ab_tests",
         :header_params => header_params,
         :query_params => query_params,
         :body => post_body,
@@ -392,7 +406,7 @@ module Algolia
     # @return [ListABTestsResponse]
     def list_ab_tests(offset = nil, limit = nil, index_prefix = nil, index_suffix = nil, request_options = {})
       response = list_ab_tests_with_http_info(offset, limit, index_prefix, index_suffix, request_options)
-      @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Abtesting::ListABTestsResponse')
+      @api_client.deserialize(response.body, request_options[:debug_return_type] || "Abtesting::ListABTestsResponse")
     end
 
     # Stops an A/B test by its ID.  You can&#39;t restart stopped A/B tests.
@@ -408,7 +422,7 @@ module Algolia
         raise ArgumentError, "Parameter `id` is required when calling `stop_ab_test`."
       end
 
-      path = '/2/abtests/{id}/stop'.sub('{' + 'id' + '}', Transport.encode_uri(id.to_s))
+      path = "/2/abtests/{id}/stop".sub("{" + "id" + "}", Transport.encode_uri(id.to_s))
       query_params = {}
       query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
       header_params = {}
@@ -417,7 +431,7 @@ module Algolia
       post_body = request_options[:debug_body]
 
       new_options = request_options.merge(
-        :operation => :'AbtestingClient.stop_ab_test',
+        :operation => :"AbtestingClient.stop_ab_test",
         :header_params => header_params,
         :query_params => query_params,
         :body => post_body,
@@ -436,7 +450,8 @@ module Algolia
     # @return [ABTestResponse]
     def stop_ab_test(id, request_options = {})
       response = stop_ab_test_with_http_info(id, request_options)
-      @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Abtesting::ABTestResponse')
+      @api_client.deserialize(response.body, request_options[:debug_return_type] || "Abtesting::ABTestResponse")
     end
+
   end
 end