[bug]: generate_secured_api_key fails on Python versions > 3.12, dict and None objects do not have the encode method

[bsmith8457]

Description

This code:

apiKey = str(current_app.config['ALGOLIA_API_KEY'])
restrictions = dict({
    'userToken': str(userId)
})
key = SearchClientSync.generate_secured_api_key(apiKey,restrictions)

Fails with the error Error Message: 'dict' object has no attribute 'encode'

Which, when looking in your code I notice:

secured_key = hmac.new(
    parent_api_key.encode(encoding="utf-8"),
    query_parameters.encode(encoding="utf-8"),
    hashlib.sha256,
).hexdigest()

Where it's expecting a dict object to have the encode method, which it does not.

This is your API documentation:

public_key = SearchClient.generate_secured_api_key(
    'YourSearchOnlyApiKey',
    {'userToken': 'user_42'}
)

Note that when I switch this argument to a string, it works, supposedly:

apiKey = str(current_app.config['ALGOLIA_API_KEY'])
restrictions = str({
    'userToken': str(userId)
})
key = SearchClientSync.generate_secured_api_key(apiKey,restrictions)

The documentation is pretty misleading or out of date.

Client

Search

Version

4.11.2

Relevant log output

No response

[shortcuts]

Hey, thanks for opening the issue!

Indeed the documentation is wrong, it shouldn't use SearchClient.generate_secured_api, the client should've been initialized before, As self is the first parameter of the generate_secured_api_key client, otherwise the order of parameter is wrong. The correct usage is:

    client = SearchClientSync("app_id", "api_key")
    apiKey = str("foo")
    restrictions = dict({'userToken': str("bar")})
    key = client.generate_secured_api_key(apiKey, restrictions)

I'll fix the documentation

[shortcuts]

Ah actually the documentation of the v4 version is correct, you can find it here https://www.algolia.com/doc/libraries/python/v4/helpers/#create-secured-api-keys, the documentation you've shared is for the v3 version, which did not required the client to be initialized first.

[shortcuts]

cc @kai687 fyi in case there's something to improve on the docs here