Rename "reset_api_key" to "generate_api_key"

This method is now also used to generate an initial key for users who do not yet have an API key.

aleph/model/role.py

@@ -142,7 +142,7 @@ def check_password(self, secret):
         digest = self.password_digest or ""
         return check_password_hash(digest, secret)
 
-    def reset_api_key(self):
+    def generate_api_key(self):
         """Resets the API key"""
         self.api_key = make_token()
 

aleph/tests/test_role_model.py

@@ -80,7 +80,7 @@ def test_remove_role(self):
 
     def test_role_by_api_key(self):
         role_ = self.create_user()
-        role_.reset_api_key()
+        role_.generate_api_key()
         db.session.add(role_)
         db.session.commit()
         assert role_.api_key is not None

aleph/tests/test_roles_api.py

@@ -84,7 +84,7 @@ def test_view_api_key(self):
         assert res.status_code == 200
         assert res.json["has_api_key"] is False
 
-        role.reset_api_key()
+        role.generate_api_key()
         db.session.add(role)
         db.session.commit()
 
@@ -201,8 +201,8 @@ def test_create_on_existing_email(self):
 
         self.assertEqual(res.status_code, 409)
 
-    def test_reset_api_key_auth(self):
-        url = f"/api/2/roles/{self.rolex.id}/reset_api_key"
+    def test_generate_api_key_auth(self):
+        url = f"/api/2/roles/{self.rolex.id}/generate_api_key"
 
         # Anonymous request
         res = self.client.post(url)
@@ -213,11 +213,11 @@ def test_reset_api_key_auth(self):
         res = self.client.post(url, headers=headers)
         self.assertEqual(res.status_code, 403)
 
-    def test_reset_api_key(self):
+    def test_generate_api_key(self):
         role, headers = self.login()
         old_key = role.api_key
 
-        url = f"/api/2/roles/{role.id}/reset_api_key"
+        url = f"/api/2/roles/{role.id}/generate_api_key"
         res = self.client.post(url, headers=headers)
         new_key = res.json["api_key"]
 

aleph/tests/test_view_context.py

@@ -7,7 +7,7 @@ def setUp(self):
         super().setUp()
         self.role = self.create_user(email="[email protected]")
         self.role.set_password("12345678")
-        self.role.reset_api_key()
+        self.role.generate_api_key()
 
         self.other_role = self.create_user(
             foreign_id="other",

aleph/views/roles_api.py

@@ -241,8 +241,8 @@ def update(id):
     return RoleSerializer.jsonify(role)
 
 
-@blueprint.route("/api/2/roles/<int:id>/reset_api_key", methods=["POST"])
-def reset_api_key(id):
+@blueprint.route("/api/2/roles/<int:id>/generate_api_key", methods=["POST"])
+def generate_api_key(id):
     """Reset the role’s API key.
     ---
     post:
@@ -270,7 +270,7 @@ def reset_api_key(id):
     role = obj_or_404(Role.by_id(id))
     require(request.authz.can_write_role(role.id))
 
-    role.reset_api_key()
+    role.generate_api_key()
     db.session.add(role)
     db.session.commit()
     update_role(role)

ui/src/actions/index.js

@@ -5,7 +5,7 @@ export {
   fetchRole,
   suggestRoles,
   updateRole,
-  resetApiKey,
+  generateApiKey,
 } from './roleActions';
 export { createAlert, deleteAlert, queryAlerts } from './alertActions';
 export { queryNotifications } from './notificationActions';

ui/src/actions/roleActions.js

@@ -33,10 +33,10 @@ export const updateRole = asyncActionCreator(
   { name: 'UPDATE_ROLE' }
 );
 
-export const resetApiKey = asyncActionCreator(
+export const generateApiKey = asyncActionCreator(
   (role) => async () => {
-    const response = await endpoint.post(`roles/${role.id}/reset_api_key`);
+    const response = await endpoint.post(`roles/${role.id}/generate_api_key`);
     return { id: role.id, data: response.data };
   },
-  { name: 'RESET_API_KEY' }
+  { name: 'GENERATE_API_KEY' }
 );

ui/src/components/Settings/ApiKeySettings.tsx

@@ -3,7 +3,7 @@ import { useSelector, useDispatch } from 'react-redux';
 import { Button, Intent, Dialog, DialogBody, Card } from '@blueprintjs/core';
 import { ClipboardInput } from 'components/common';
 import { selectCurrentRole } from 'selectors';
-import { resetApiKey } from 'actions';
+import { generateApiKey as generateApiKeyAction } from 'actions';
 import { FormattedMessage } from 'react-intl';
 
 const GENERATE_MESSAGE = (
@@ -79,7 +79,7 @@ export default function ApiKeySettings() {
   const [{ state, apiKey }, dispatch] = useReducer(reducer, { state: 'START' });
 
   const generateApiKey = async () => {
-    const { data } = await reduxDispatch(resetApiKey(role));
+    const { data } = await reduxDispatch(generateApiKeyAction(role));
     return data.api_key;
   };
 

ui/src/reducers/roles.js

@@ -1,6 +1,6 @@
 import { createReducer } from 'redux-act';
 
-import { queryRoles, fetchRole, updateRole, resetApiKey } from 'actions';
+import { queryRoles, fetchRole, updateRole, generateApiKey } from 'actions';
 import {
   resultObjects,
   objectLoadStart,
@@ -20,7 +20,7 @@ export default createReducer(
       objectLoadComplete(state, id, data),
     [updateRole.COMPLETE]: (state, { id, data }) =>
       objectLoadComplete(state, id, data),
-    [resetApiKey.COMPLETE]: (state, { id, data }) =>
+    [generateApiKey.COMPLETE]: (state, { id, data }) =>
       objectLoadComplete(state, id, { ...data, api_key: null }),
   },
   initialState