Merge pull request #382 from meilisearch/keys

Addition related to API keys

Author: alallema

meilisearch/_httprequests.py

@@ -60,6 +60,14 @@ def post(
     ) -> Any:
         return self.send_request(requests.post, path, body, content_type)
 
+    def patch(
+        self,
+        path: str,
+        body: Optional[Union[Dict[str, Any], List[Dict[str, Any]], List[str], str]] = None,
+        content_type: Optional[str] = 'application/json',
+    ) -> Any:
+        return self.send_request(requests.patch, path, body, content_type)
+
     def put(
         self,
         path: str,

meilisearch/client.py

@@ -217,15 +217,34 @@ def is_healthy(self) -> bool:
             return False
         return True
 
-    def get_keys(self) -> Dict[str, str]:
-        """Get all keys.
+    def get_key(self, key: str) -> Dict[str, Any]:
+        """Gets information about a specific API key.
 
-        Get the public and private keys.
+        Parameters
+        ----------
+        key:
+            The key for which to retrieve the information.
+
+        Returns
+        -------
+        key:
+            The API key.
+            https://docs.meilisearch.com/reference/api/keys.html#get-key
+
+        Raises
+        ------
+        MeiliSearchApiError
+            An error containing details about why MeiliSearch can't process your request. MeiliSearch error codes are described here: https://docs.meilisearch.com/errors/#meilisearch-errors
+        """
+        return self.http.get(f'{self.config.paths.keys}/{key}')
+
+    def get_keys(self) -> List[Dict[str, Any]]:
+        """Gets the MeiliSearch API keys.
 
         Returns
         -------
         keys:
-            Dictionary of keys and their information.
+            API keys.
             https://docs.meilisearch.com/reference/api/keys.html#get-keys
 
         Raises
@@ -235,6 +254,85 @@ def get_keys(self) -> Dict[str, str]:
         """
         return self.http.get(self.config.paths.keys)
 
+    def create_key(
+        self,
+        options: Dict[str, Any]
+    ) -> Dict[str, Any]:
+        """Creates a new API key.
+
+        Parameters
+        ----------
+        options:
+            Options, the information to use in creating the key (ex: { 'actions': ['*'], 'indexes': ['movies'], 'description': 'Search Key', 'expiresAt': '22-01-01' }).
+            An `actions`, an `indexes` and a `expiresAt` fields are mandatory,`None` should be specified for no expiration date.
+            `actions`: A list of actions permitted for the key. ["*"] for all actions.
+            `indexes`: A list of indexes permitted for the key. ["*"] for all indexes.
+            Note that if an expires_at value is included it should be in UTC time.
+
+        Returns
+        -------
+        keys:
+            The new API key.
+            https://docs.meilisearch.com/reference/api/keys.html#get-keys
+
+        Raises
+        ------
+        MeiliSearchApiError
+            An error containing details about why MeiliSearch can't process your request. MeiliSearch error codes are described here: https://docs.meilisearch.com/errors/#meilisearch-errors
+        """
+        return self.http.post(f'{self.config.paths.keys}', options)
+
+    def udpate_key(
+        self,
+        key: str,
+        options: Dict[str, Any]
+    ) -> Dict[str, Any]:
+        """Update an API key.
+
+        Parameters
+
+        ----------
+        key:
+            The key for which to update the information.
+        options:
+            The information to use in creating the key (ex: { 'description': 'Search Key', 'expiresAt': '22-01-01' }). Note that if an
+            expires_at value is included it should be in UTC time.
+
+        Returns
+        -------
+        key:
+            The updated API key.
+            https://docs.meilisearch.com/reference/api/keys.html#get-keys
+
+        Raises
+        ------
+        MeiliSearchApiError
+            An error containing details about why MeiliSearch can't process your request. MeiliSearch error codes are described here: https://docs.meilisearch.com/errors/#meilisearch-errors
+        """
+        url = f'{self.config.paths.keys}/{key}'
+        return self.http.patch(url, options)
+
+    def delete_key(self, key: str) -> Dict[str, int]:
+        """Deletes an API key.
+
+        Parameters
+        ----------
+        key:
+            The key to delete.
+
+        Returns
+        -------
+        keys:
+            The Response status code. 204 signifies a successful delete.
+            https://docs.meilisearch.com/reference/api/keys.html#get-keys
+
+        Raises
+        ------
+        MeiliSearchApiError
+            An error containing details about why MeiliSearch can't process your request. MeiliSearch error codes are described here: https://docs.meilisearch.com/errors/#meilisearch-errors
+        """
+        return self.http.delete(f'{self.config.paths.keys}/{key}')
+
     def get_version(self) -> Dict[str, str]:
         """Get version MeiliSearch
 

tests/client/test_client_key_meilisearch.py

@@ -0,0 +1,80 @@
+import pytest
+from tests import common
+from datetime import datetime
+from meilisearch.errors import MeiliSearchApiError
+
+def test_get_keys_default(client):
+    """Tests if public and private keys have been generated and can be retrieved."""
+    keys = client.get_keys()
+    assert isinstance(keys, list)
+    assert len(keys) == 2
+    assert 'actions' in keys[0]
+    assert 'indexes' in keys[0]
+    assert keys[0]['key'] is not None
+    assert keys[1]['key'] is not None
+
+def test_get_key(client, test_key):
+    """Tests if a key can be retrieved."""
+    key = client.get_key(test_key['key'])
+    assert isinstance(key, dict)
+    assert 'actions' in key
+    assert 'indexes' in key
+    assert key['createdAt'] is not None
+
+def test_get_key_inexistent(client):
+    """Tests getting a key that does not exists."""
+    with pytest.raises(Exception):
+        client.get_key('No existing key')
+
+def test_create_keys_default(client, test_key_info):
+    """Tests the creation of a key with no optional argument."""
+    key = client.create_key(test_key_info)
+    assert isinstance(key, dict)
+    assert 'key' in key
+    assert 'actions' in key
+    assert 'indexes' in key
+    assert key['key'] is not None
+    assert key['expiresAt'] is None
+    assert key['createdAt'] is not None
+    assert key['updatedAt'] is not None
+    assert key['key'] is not None
+    assert key['actions'] == test_key_info['actions']
+    assert key['indexes'] == test_key_info['indexes']
+
+def test_create_keys_with_options(client, test_key_info):
+    """Tests the creation of a key with arguments."""
+    key = client.create_key(options={'description': test_key_info['description'], 'actions': test_key_info['actions'], 'indexes': test_key_info['indexes'], 'expiresAt': datetime(2030, 6, 4, 21, 8, 12, 32).isoformat()[:-3]+'Z' })
+    assert isinstance(key, dict)
+    assert key['key'] is not None
+    assert key['description'] == test_key_info['description']
+    assert key['expiresAt'] is not None
+    assert key['createdAt'] is not None
+    assert key['updatedAt'] is not None
+    assert key['actions'] == test_key_info['actions']
+    assert key['indexes'] == test_key_info['indexes']
+
+def test_create_keys_without_actions(client):
+    """Tests the creation of a key with missing arguments."""
+    with pytest.raises(MeiliSearchApiError):
+        client.create_key(options={'indexes': [common.INDEX_UID]})
+
+def test_update_keys(client, test_key_info):
+    """Tests updating a key."""
+    key = client.create_key(test_key_info)
+    assert key['actions'] == test_key_info['actions']
+    update_key = client.udpate_key(key=key['key'], options={ 'actions': ['search'] })
+    assert update_key['key'] is not None
+    assert update_key['expiresAt'] is None
+    assert update_key['actions'] == ['search']
+
+def test_delete_key(client, test_key):
+    """Tests deleting a key."""
+    resp = client.delete_key(test_key['key'])
+    assert resp.status_code == 204
+    with pytest.raises(MeiliSearchApiError):
+        client.get_key(test_key['key'])
+
+def test_delete_key_inexisting(client):
+    """Tests deleting a key that does not exists."""
+    with pytest.raises(MeiliSearchApiError):
+        client.delete_key('No existing key')

tests/conftest.py

@@ -4,6 +4,7 @@
 
 from tests import common
 import meilisearch
+from meilisearch.errors import MeiliSearchApiError
 
 @fixture(scope='session')
 def client():
@@ -81,3 +82,30 @@ def index_maker(index_name=common.INDEX_UID, documents=small_movies):
         index.wait_for_task(task['uid'])
         return index
     return index_maker
+
+@fixture(scope='function')
+def test_key(client):
+    key_info = {'description': 'test', 'actions': ['search'], 'indexes': ['movies'], 'expiresAt': None}
+
+    key = client.create_key(key_info)
+
+    yield key
+
+    try:
+        client.delete_key(key['key'])
+    except MeiliSearchApiError:
+        pass
+
+
+@fixture(scope='function')
+def test_key_info(client):
+    key_info = {'description': 'test', 'actions': ['search'], 'indexes': [common.INDEX_UID], 'expiresAt': None}
+
+    yield key_info
+
+    try:
+        keys = client.get_keys()
+        key = next(x for x in keys if x['description'] == key_info['description'])
+        client.delete_key(key['key'])
+    except MeiliSearchApiError:
+        pass