Skip to content

fix(ruby): expose static helper [skip-bc] #4191

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Dec 2, 2024
Merged

fix(ruby): expose static helper [skip-bc] #4191

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b686410
fix(ruby): expose static helper
millotp Dec 2, 2024
afebf70
Merge branch 'main' into fix/ruby-static
millotp Dec 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 24 additions & 2 deletions templates/ruby/search_helpers.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -169,7 +169,7 @@ end
#
# @return [String]
#
def generate_secured_api_key(parent_api_key, restrictions = {})
def self.generate_secured_api_key(parent_api_key, restrictions = {})
restrictions = restrictions.to_hash
if restrictions.key?(:searchParams)
# merge searchParams with the root of the restrictions
Expand All @@ -186,13 +186,25 @@ def generate_secured_api_key(parent_api_key, restrictions = {})
Base64.encode64("#{hmac}#{url_encoded_restrictions}").gsub("\n", '')
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 = {})
self.class.generate_secured_api_key(parent_api_key, restrictions)
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)
def self.get_secured_api_key_remaining_validity(secured_api_key)
now = Time.now.to_i
decoded_key = Base64.decode64(secured_api_key)
regex = 'validUntil=(\d+)'
Expand All @@ -207,6 +219,16 @@ def get_secured_api_key_remaining_validity(secured_api_key)
valid_until - now
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)
self.class.get_secured_api_key_remaining_validity(secured_api_key)
end

# Helper: Saves the given array of objects in the given index. The `chunked_batch` helper is used under the hood, which creates a `batch` requests with at most 1000 objects in it.
#
# @param index_name [String]: The `index_name` to save `objects` in.
Expand Down