Update api key (#105)

* Adding Updateable to api_keys

* Lint

* Lint

* Tests

* Lint

* This is a way to solve it...

* This one is clearer

* Lint and test

* Another lint

* Fix test

* Add another test just in case and its corresponding fix

* To be clear

* Add customized session

* Customized session for ApiKey creation

* Bump versions

* version

* remove validate method

* tests

* lint

* remove metadata

* test

* fix

* casseettes

* cassettes

* updated dependency

* updated cuenca-validations

* added local session

Co-authored-by: Felipe López <flh.1989@gmail.com>
Co-authored-by: EC2 Default User <ec2-user@ip-10-5-163-56.us-east-2.compute.internal>

Author: 3 people

cuenca/resources/api_keys.py

@@ -1,20 +1,21 @@
 import datetime as dt
 from typing import ClassVar, Optional, cast
 
-from cuenca_validations.types import ApiKeyQuery
+from cuenca_validations.types import ApiKeyQuery, ApiKeyUpdateRequest
 from pydantic.dataclasses import dataclass
 
-from ..http import session
-from .base import Creatable, Queryable, Retrievable
+from ..http import Session, session as global_session
+from .base import Creatable, Queryable, Retrievable, Updateable
 
 
 @dataclass
-class ApiKey(Creatable, Queryable, Retrievable):
+class ApiKey(Creatable, Queryable, Retrievable, Updateable):
     _resource: ClassVar = 'api_keys'
     _query_params: ClassVar = ApiKeyQuery
 
     secret: str
     deactivated_at: Optional[dt.datetime]
+    user_id: Optional[str]
 
     @property
     def active(self) -> bool:
@@ -24,11 +25,17 @@ def active(self) -> bool:
         )
 
     @classmethod
-    def create(cls) -> 'ApiKey':
-        return cast('ApiKey', cls._create())
+    def create(cls, *, session: Session = global_session) -> 'ApiKey':
+        return cast('ApiKey', cls._create(session=session))
 
     @classmethod
-    def deactivate(cls, api_key_id: str, minutes: int = 0) -> 'ApiKey':
+    def deactivate(
+        cls,
+        api_key_id: str,
+        minutes: int = 0,
+        *,
+        session: Session = global_session,
+    ) -> 'ApiKey':
         """
         deactivate an ApiKey in a certain number of minutes. If minutes is
         negative, the API will treat it the same as 0. You can't deactivate
@@ -39,3 +46,20 @@ def deactivate(cls, api_key_id: str, minutes: int = 0) -> 'ApiKey':
         url = cls._resource + f'/{api_key_id}'
         resp = session.delete(url, dict(minutes=minutes))
         return cast('ApiKey', cls._from_dict(resp))
+
+    @classmethod
+    def update(
+        cls,
+        api_key_id: str,
+        metadata: Optional[dict] = None,
+        user_id: Optional[str] = None,
+        *,
+        session: Session = global_session,
+    ) -> 'ApiKey':
+        """
+        If the current user has enough permissions, it associates an ApiKey to
+        the `user_id` or updates the correspoding metadata
+        """
+        req = ApiKeyUpdateRequest(metadata=metadata, user_id=user_id)
+        resp = cls._update(api_key_id, **req.dict(), session=session)
+        return cast('ApiKey', resp)

cuenca/resources/cards.py

@@ -51,7 +51,7 @@ def update(
         status: Optional[CardStatus] = None,
         *,
         session: Session = global_session,
-    ):
+    ) -> 'Card':
         """
         Updates card properties that are not sensitive or fixed data. It allows
         reconfigure properties like status, and manufacturer.
@@ -65,9 +65,7 @@ def update(
         req = CardUpdateRequest(
             user_id=user_id, ledger_account_id=ledger_account_id, status=status
         )
-        resp = cls._update(
-            card_id, session=session, **req.dict(exclude_none=True)
-        )
+        resp = cls._update(card_id, session=session, **req.dict())
         return cast('Card', resp)
 
     @classmethod

cuenca/version.py

@@ -1,3 +1,3 @@
-__version__ = '0.6.1'
+__version__ = '0.6.2'
 CLIENT_VERSION = __version__
 API_VERSION = '2020-03-19'

requirements.txt

@@ -1,3 +1,3 @@
 requests==2.25.0
-cuenca-validations==0.7.2
+cuenca-validations==0.7.5
 dataclasses>=0.7;python_version<"3.7"

tests/resources/cassettes/test_api_key_deactivate.yaml

@@ -1,6 +1,6 @@
 interactions:
 - request:
-    body: null
+    body: '{}'
     headers:
       Accept:
       - '*/*'
@@ -10,41 +10,39 @@ interactions:
       - DUMMY
       Connection:
       - keep-alive
+      Content-Length:
+      - '2'
+      Content-Type:
+      - application/json
       User-Agent:
-      - cuenca-python/0.0.1dev0
+      - cuenca-python/0.6.2.dev1
       X-Cuenca-Api-Version:
       - '2020-03-19'
-    method: GET
-    uri: https://sandbox.cuenca.com/api_keys/test
+    method: POST
+    uri: https://sandbox.cuenca.com/api_keys
   response:
     body:
-      string: '{"id":"test","created_at":"2020-05-11T17:20:25.603000","secret":"********","deactivated_at":null}'
+      string: '{"id":"AK65Xx4QRmSp-kY-svK_kW6g","created_at":"2021-02-11T20:06:17.348677","secret":"vZKDb2BFb17lmAQTaljKd5whcncJ0TihswF2iKxpHPvaJv7z-R12WwMrAuobko0VXlmTUxVPqDP3TGBlKS_Hyw","deactivated_at":"2212-10-08T19:54:42.308379","user":{"id":"USJaz512A7ROOh7N3pqKGMZg","created_at":"2021-02-11T19:44:54.016164"},"updated_at":"2021-02-11T19:54:42.308426","user_id":"USJaz512A7ROOh7N3pqKGMZg"}'
     headers:
       Connection:
       - keep-alive
       Content-Length:
-      - '119'
+      - '381'
       Content-Type:
       - application/json
       Date:
-      - Mon, 11 May 2020 18:30:32 GMT
-      Via:
-      - 1.1 d8c8706cff3de7db4b8e8b9726774938.cloudfront.net (CloudFront)
-      X-Amz-Cf-Id:
-      - AKuzZDU7v-hmyGu-9zB9VHgy9S4pbSGqKNIJJMcPnRqzIm8Crk1fWQ==
-      X-Amz-Cf-Pop:
-      - DFW3-C1
+      - Thu, 11 Feb 2021 20:06:17 GMT
+      Server:
+      - nginx/1.18.0
       X-Amzn-Trace-Id:
-      - Root=1-5eb999c8-e36f1e7c4aa751f8ce4452c0;Sampled=0
-      X-Cache:
-      - Miss from cloudfront
+      - Root=1-60258e39-e3ac93f6c3a844adbb028c86;Sampled=0
       x-amz-apigw-id:
-      - MYT3VGxDoAMFbZQ=
+      - amMo8HWMiYcF8Mw=
       x-amzn-RequestId:
-      - d1f6ab21-3e4f-493e-8d9b-d1aff4ef82a9
+      - 14929ccd-1f3b-4e5a-9364-fedc0e0051c3
     status:
-      code: 200
-      message: OK
+      code: 201
+      message: Created
 - request:
     body: '{"minutes": 0}'
     headers:
@@ -61,37 +59,31 @@ interactions:
       Content-Type:
       - application/json
       User-Agent:
-      - cuenca-python/0.0.1dev0
+      - cuenca-python/0.6.2.dev1
       X-Cuenca-Api-Version:
       - '2020-03-19'
     method: DELETE
-    uri: https://sandbox.cuenca.com/api_keys/test
+    uri: https://sandbox.cuenca.com/api_keys/AK65Xx4QRmSp-kY-svK_kW6g
   response:
     body:
-      string: '{"id":"test","created_at":"2020-05-11T17:20:25.603000","secret":"********","deactivated_at":"2020-05-11T18:30:35.210967"}'
+      string: '{"id":"AK65Xx4QRmSp-kY-svK_kW6g","created_at":"2021-02-11T20:06:17.348677","secret":"********","deactivated_at":"2021-02-11T20:06:17.391434","user":{"id":"USJaz512A7ROOh7N3pqKGMZg","created_at":"2021-02-11T19:44:54.016164"},"updated_at":"2021-02-11T20:06:17.391471","user_id":"USJaz512A7ROOh7N3pqKGMZg"}'
     headers:
       Connection:
       - keep-alive
       Content-Length:
-      - '143'
+      - '303'
       Content-Type:
       - application/json
       Date:
-      - Mon, 11 May 2020 18:30:35 GMT
-      Via:
-      - 1.1 d8c8706cff3de7db4b8e8b9726774938.cloudfront.net (CloudFront)
-      X-Amz-Cf-Id:
-      - DFKQoRapavD6PEHAapEf_BvZiywXiIK3Yi3Fh-kkCJe6Yu1lKX8IvA==
-      X-Amz-Cf-Pop:
-      - DFW3-C1
+      - Thu, 11 Feb 2021 20:06:17 GMT
+      Server:
+      - nginx/1.18.0
       X-Amzn-Trace-Id:
-      - Root=1-5eb999cb-890940501ec67728f7f59fa0;Sampled=0
-      X-Cache:
-      - Miss from cloudfront
+      - Root=1-60258e39-de7477cedab1524a0f820190;Sampled=0
       x-amz-apigw-id:
-      - MYT3wGh9oAMFTSQ=
+      - amMo-F9aCYcFUMw=
       x-amzn-RequestId:
-      - b87437d5-18f4-4e7b-adf3-4302d3f144b3
+      - 39d35856-da34-4e97-b249-06c3eb396ad1
     status:
       code: 200
       message: OK
@@ -107,37 +99,31 @@ interactions:
       Connection:
       - keep-alive
       User-Agent:
-      - cuenca-python/0.0.1dev0
+      - cuenca-python/0.6.2.dev1
       X-Cuenca-Api-Version:
       - '2020-03-19'
     method: GET
-    uri: https://sandbox.cuenca.com/api_keys/test
+    uri: https://sandbox.cuenca.com/api_keys/AK65Xx4QRmSp-kY-svK_kW6g
   response:
     body:
-      string: '{"id":"test","created_at":"2020-05-11T17:20:25.603000","secret":"********","deactivated_at":"2020-05-11T18:30:35.210000"}'
+      string: '{"id":"AK65Xx4QRmSp-kY-svK_kW6g","created_at":"2021-02-11T20:06:17.348677","secret":"********","deactivated_at":"2021-02-11T20:06:17.391434","user":{"id":"USJaz512A7ROOh7N3pqKGMZg","created_at":"2021-02-11T19:44:54.016164"},"updated_at":"2021-02-11T20:06:17.391471","user_id":"USJaz512A7ROOh7N3pqKGMZg"}'
     headers:
       Connection:
       - keep-alive
       Content-Length:
-      - '143'
+      - '303'
       Content-Type:
       - application/json
       Date:
-      - Mon, 11 May 2020 18:30:35 GMT
-      Via:
-      - 1.1 d8c8706cff3de7db4b8e8b9726774938.cloudfront.net (CloudFront)
-      X-Amz-Cf-Id:
-      - Q6iMsqOj5TZMk9XnoMk1Pj_bfQ2ycqs1CrTcZPsUk5VXaUMVeaprIA==
-      X-Amz-Cf-Pop:
-      - DFW3-C1
+      - Thu, 11 Feb 2021 20:06:17 GMT
+      Server:
+      - nginx/1.18.0
       X-Amzn-Trace-Id:
-      - Root=1-5eb999cb-ae60e1a60989f617bbbb1675;Sampled=0
-      X-Cache:
-      - Miss from cloudfront
+      - Root=1-60258e39-158b9de5eb2b3d7bc6695c95;Sampled=0
       x-amz-apigw-id:
-      - MYT3yEZqIAMFyvw=
+      - amMo_E6-CYcFaxw=
       x-amzn-RequestId:
-      - 7f4b362f-6e5d-4867-883a-2b2b44e12852
+      - 9017ff70-2871-431e-9c96-f75041573e60
     status:
       code: 200
       message: OK

tests/resources/cassettes/test_api_keys_create.yaml

@@ -15,37 +15,31 @@ interactions:
       Content-Type:
       - application/json
       User-Agent:
-      - cuenca-python/0.0.1dev0
+      - cuenca-python/0.6.2.dev1
       X-Cuenca-Api-Version:
       - '2020-03-19'
     method: POST
     uri: https://sandbox.cuenca.com/api_keys
   response:
     body:
-      string: '{"id":"PKjtv8Qn-3Tp2Eh1bBzXphOg==","created_at":"2020-05-11T18:25:36.369866","secret":"fcLkDkymPF9nJloQfEbYwnBthMtrwFssxyuzpMs-qIDEnmJNAr8nC3_xkC-MY-reV6WjT10DLwpF_v_G4MqBPw","deactivated_at":null}'
+      string: '{"id":"AKEvJ9OckUTFCN77vkQRLPIA","created_at":"2021-02-11T20:07:55.891354","secret":"Vl6FcGMjWj9MULfOwKdSR-X3NRX97m1o2EJ2Aej_18PQNLwHcU5KGAPHikiiLpTJTZ3Z_EnxJZKL9OlfKveq5Q","deactivated_at":"2212-10-08T19:54:42.308379","user":{"id":"USJaz512A7ROOh7N3pqKGMZg","created_at":"2021-02-11T19:44:54.016164"},"updated_at":"2021-02-11T19:54:42.308426","user_id":"USJaz512A7ROOh7N3pqKGMZg"}'
     headers:
       Connection:
       - keep-alive
       Content-Length:
-      - '197'
+      - '381'
       Content-Type:
       - application/json
       Date:
-      - Mon, 11 May 2020 18:25:38 GMT
-      Via:
-      - 1.1 991cddfa34f7096aab42079b287a0629.cloudfront.net (CloudFront)
-      X-Amz-Cf-Id:
-      - C3GZwW0t28QJ75J-3Md6RzRHjehrab6-GVSBYzCli7UMhu6rsPoY0w==
-      X-Amz-Cf-Pop:
-      - DFW3-C1
+      - Thu, 11 Feb 2021 20:07:55 GMT
+      Server:
+      - nginx/1.18.0
       X-Amzn-Trace-Id:
-      - Root=1-5eb998a0-5b85148fe075039e951ce376;Sampled=0
-      X-Cache:
-      - Miss from cloudfront
+      - Root=1-60258e9b-d1e9ed255cca393920a29b81;Sampled=0
       x-amz-apigw-id:
-      - MYTJEE4iIAMFyDA=
+      - amM4WHXDiYcFcog=
       x-amzn-RequestId:
-      - 98c2462c-9c8f-4f04-a590-fc76d96cdca2
+      - 3c0c47f8-198d-4bab-a592-009f362f5c1c
     status:
       code: 201
       message: Created

tests/resources/cassettes/test_api_keys_retrieve.yaml

@@ -11,37 +11,31 @@ interactions:
       Connection:
       - keep-alive
       User-Agent:
-      - cuenca-python/0.0.1dev0
+      - cuenca-python/0.6.2.dev1
       X-Cuenca-Api-Version:
       - '2020-03-19'
     method: GET
-    uri: https://sandbox.cuenca.com/api_keys/test
+    uri: https://sandbox.cuenca.com/api_keys/AKMPSxy2UeSKqU1J6spDNwqA
   response:
     body:
-      string: '{"id":"test","created_at":"2020-05-04T19:43:40.439000","secret":"********","deactivated_at":null}'
+      string: '{"id":"AKMPSxy2UeSKqU1J6spDNwqA","created_at":"2021-02-11T19:45:52.826286","secret":"********","deactivated_at":"2212-10-08T19:37:22.722505","user":{"id":"USJaz512A7ROOh7N3pqKGMZg","created_at":"2021-02-11T19:44:54.016164"},"updated_at":"2021-02-11T19:54:42.308426","user_id":"USJaz512A7ROOh7N3pqKGMZg"}'
     headers:
       Connection:
       - keep-alive
       Content-Length:
-      - '119'
+      - '303'
       Content-Type:
       - application/json
       Date:
-      - Mon, 11 May 2020 18:25:38 GMT
-      Via:
-      - 1.1 e11ff5647028a0e212255f92e5436d8b.cloudfront.net (CloudFront)
-      X-Amz-Cf-Id:
-      - ZXFzIAdYi9neivcMO1KZ1Lpq2SBf-9Q-bJDPujzzryBSvb8mxAxgCQ==
-      X-Amz-Cf-Pop:
-      - DFW3-C1
+      - Thu, 11 Feb 2021 20:09:25 GMT
+      Server:
+      - nginx/1.18.0
       X-Amzn-Trace-Id:
-      - Root=1-5eb998a2-be6c915eeb0eee745d58beb2;Sampled=0
-      X-Cache:
-      - Miss from cloudfront
+      - Root=1-60258ef5-e8d47a2a59f540b54f612e7e;Sampled=0
       x-amz-apigw-id:
-      - MYTJZGfToAMFm4w=
+      - amNGaEI7iYcFtdw=
       x-amzn-RequestId:
-      - 9c5352f0-f3df-41f2-9618-07c095ff4f71
+      - 35f3a24b-e9d9-4923-8442-a88722fbc5da
     status:
       code: 200
       message: OK