algolia 3.0.0.beta.3 → 3.0.0.beta.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 55b1f581a3ca4f6ef59d05989130f89559c010f4e114c749a4b9dc523bf45fa6
-  data.tar.gz: 8b6e80f68129c52f05c2ce91f05a93c4436831f4c3ea450be2351ad6e5c964a5
+  metadata.gz: d8a5616a1aa9d89d365371c04b20236bd153937bc86549a340c90f2f996c467b
+  data.tar.gz: f07daa4f630934d9fee7a49d30ec1aaa48ad207799db4e754dad39b0fede65d2
 SHA512:
-  metadata.gz: 698e012f76df7596ceec8b4200bc77f4e4b889b535a9f015b1b69ad9d780c1a53cb4750ad4a4670908dc931152bdd869f80d961c4c305364cbf9ee8bac8549c2
-  data.tar.gz: 98c728722f3b2fdc67162b2b4cd6695dac5c1e22d5f5f6c35114ae5c7e3243d64cd43b7bc3a733b751a9acfe5f59f6fa37f228322184a107b2599df4f9ba2951
+  metadata.gz: 45af977700dd17bca72b31970899b2e790a6b51c599177fa254babced3e460ee0d67ca4e7cc6b6f1486a7856b0a275527fe30e44aaf3221c421f4a4b0042cd59
+  data.tar.gz: e8e4fc306aea4b38a5b842061530e4c305900d1b64ba54f701e7f32cdd019a9187076520c640010a1bcf04c79b323ff6e122488e0244c3a63a2b92bd885c6c5f

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## [3.0.0.beta.4](https://github.com/algolia/algoliasearch-client-ruby/compare/3.0.0.beta.3...3.0.0.beta.4)
+
+- [b2a464a2b](https://github.com/algolia/api-clients-automation/commit/b2a464a2b) feat(clients): add generate_secured_api_key to ruby ([#3166](https://github.com/algolia/api-clients-automation/pull/3166)) by [@millotp](https://github.com/millotp/)
+- [de4090789](https://github.com/algolia/api-clients-automation/commit/de4090789) fix(clients): safer replaceAllObjects + metis compliant ([#3164](https://github.com/algolia/api-clients-automation/pull/3164)) by [@shortcuts](https://github.com/shortcuts/)
+
 ## [3.0.0.beta.3](https://github.com/algolia/algoliasearch-client-ruby/compare/3.0.0.beta.2...3.0.0.beta.3)
 
 - [072c38b9a](https://github.com/algolia/api-clients-automation/commit/072c38b9a) fix(clients): remove unused models from lite clients ([#3159](https://github.com/algolia/api-clients-automation/pull/3159)) by [@shortcuts](https://github.com/shortcuts/)

data/Gemfile.lock

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

data/README.md

@@ -19,7 +19,7 @@
   <a href="http://stackoverflow.com/questions/tagged/algolia" target="_blank">Stack Overflow</a>  •
   <a href="https://github.com/algolia/algoliasearch-client-ruby/issues" target="_blank">Report a bug</a>  •
   <a href="https://www.algolia.com/doc/api-client/troubleshooting/faq/ruby/" target="_blank">FAQ</a>  •
-  <a href="https://www.algolia.com/support" target="_blank">Support</a>
+  <a href="https://alg.li/support" target="_blank">Support</a>
 </p>
 
 ## ✨ Features

data/lib/algolia/api/search_client.rb

@@ -1,5 +1,8 @@
 # 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 'openssl'
+require 'base64'
+
 module Algolia
   class SearchClient
     attr_accessor :api_client
@@ -3129,5 +3132,53 @@ module Algolia
 
       synonyms unless block_given?
     end
+
+    # Helper: Generates a secured API key based on the given `parent_api_key` and given `restrictions`.
+    #
+    # @param parent_api_key [String] Parent API key used the generate the secured key
+    # @param restrictions [SecuredApiKeyRestrictions] Restrictions to apply on the secured key
+    #
+    # @return [String]
+    #
+    def generate_secured_api_key(parent_api_key, restrictions = {})
+      restrictions = restrictions.to_hash
+      if restrictions.key?(:searchParams)
+        # merge searchParams with the root of the restrictions
+
+        restrictions.merge!(restrictions[:searchParams])
+        restrictions.delete(:searchParams)
+      end
+
+      url_encoded_restrictions = Algolia::Transport.stringify_query_params(restrictions).sort.to_h.map do |key, value|
+        "#{key}=#{value}"
+      end.join('&')
+
+      hmac = OpenSSL::HMAC.hexdigest(OpenSSL::Digest.new('sha256'), parent_api_key, url_encoded_restrictions)
+
+      puts "hmac: #{hmac}"
+      puts "url_encoded_restrictions: #{url_encoded_restrictions}"
+      Base64.encode64("#{hmac}#{url_encoded_restrictions}").gsub("\n", '')
+    end
+
+    # Helper: Retrieves the remaining validity of the previous generated `secured_api_key`, the `validUntil` parameter must have been provided.
+    #
+    # @param secured_api_key [String]
+    #
+    # @return [Integer]
+    #
+    def get_secured_api_key_remaining_validity(secured_api_key)
+      now         = Time.now.to_i
+      decoded_key = Base64.decode64(secured_api_key)
+      regex       = 'validUntil=(\d+)'
+      matches     = decoded_key.match(regex)
+
+      if matches.nil?
+        raise AlgoliaError, 'The SecuredApiKey doesn\'t have a validUntil parameter.'
+      end
+
+      valid_until = matches[1].to_i
+
+      valid_until - now
+    end
   end
 end

data/lib/algolia/transport/transport.rb

@@ -9,6 +9,13 @@ module Algolia
       CGI.escape(uri).gsub('+', '%20')
     end
 
+    def self.stringify_query_params(query_params)
+      query_params.to_h do |key, value|
+        value = value.join(',') if value.is_a?(Array)
+        [encode_uri(key.to_s).to_sym, encode_uri(value.to_s)]
+      end
+    end
+
     class Transport
       include RetryOutcomeType
       include CallType
@@ -79,7 +86,7 @@ module Algolia
         request[:method]          = method.downcase
         request[:path]            = path
         request[:body]            = build_body(body, request_options)
-        request[:query_params]    = stringify_query_params(request_options.query_params)
+        request[:query_params]    = Algolia::Transport.stringify_query_params(request_options.query_params)
         request[:header_params]   = generate_header_params(body, request_options)
         request[:timeout]         = request_options.timeout
         request[:connect_timeout] = request_options.connect_timeout
@@ -128,13 +135,6 @@ module Algolia
           @config.write_timeout
         end
       end
-
-      def stringify_query_params(query_params)
-        query_params.to_h do |key, value|
-          value = value.join(',') if value.is_a?(Array)
-          [Algolia::Transport.encode_uri(key.to_s).to_sym, Algolia::Transport.encode_uri(value.to_s)]
-        end
-      end
     end
   end
 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.beta.3'.freeze
+  VERSION = '3.0.0.beta.4'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: algolia
 version: !ruby/object:Gem::Version
-  version: 3.0.0.beta.3
+  version: 3.0.0.beta.4
 platform: ruby
 authors:
 - https://alg.li/support
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-06-11 00:00:00.000000000 Z
+date: 2024-06-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday