New Resources - Endpoint and Webhook by andreshndz · Pull Request #215 · cuenca-mx/cuenca-python

andreshndz · 2022-01-21T02:51:34Z

This is the first approach of Endpoint and Webhook resources.
There are classes that are not defined in this PR, but they will be defined in cuenca-validations.

Our goal is to use the resources as below:

import cuenca

# Endpoint
cuenca.Endpoint.create(url='https://yoururl.com')
cuenca.Endpoint.retrieve('id')
cuenca.Endpoint.all()  # This will retrieve all endpoints 
cuenca.Endpoint.update('id', is_active=False)
cuenca.Endpoint.deactivate('id')

# Webhook
cuenca.Webhook.retrieve('id')
cuenca.Webhook.all()  # This will retrieve all webhooks from his platform

codecov · 2022-02-09T19:22:14Z

Codecov Report

Merging #215 (c250e0a) into main (f122b4c) will not change coverage.
The diff coverage is 100.00%.

@@            Coverage Diff            @@
##              main      #215   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           37        39    +2     
  Lines          927       961   +34     
=========================================
+ Hits           927       961   +34

Flag	Coverage Δ
unittests	`100.00% <100.00%> (ø)`

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
cuenca/__init__.py	`100.00% <ø> (ø)`
cuenca/resources/__init__.py	`100.00% <100.00%> (ø)`
cuenca/resources/base.py	`100.00% <100.00%> (ø)`
cuenca/resources/endpoints.py	`100.00% <100.00%> (ø)`
cuenca/resources/webhooks.py	`100.00% <100.00%> (ø)`

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update f122b4c...c250e0a. Read the comment docs.

alexviquez

Agrega un tes de cuando ya existe el endpoint, no te permita volver a crearlo si no solo actualizarlo

alexviquez · 2022-02-28T17:38:37Z

cuenca/resources/endpoints.py

+    @classmethod
+    def deactivate(
+        cls, endpoint_id: str, *, session: Session = global_session
+    ) -> 'Endpoint':
+        """
+        Deactivates an Endpoint
+        """
+        url = f'{cls._resource}/{endpoint_id}'
+        resp = session.delete(url)
+        return cast('Endpoint', cls._from_dict(resp))


reusa el que ya tenemos, se llama 'Deactivable' y esta emplementado en fast-agave

cuenca-python/cuenca/resources/base.py

Line 83 in f22c4ba

class Deactivable(Resource):

Tengo problemas para usarlo porque posee un campo deactivated_at que no es opcional

cuenca/resources/endpoints.py

alexviquez · 2022-02-28T17:42:32Z

requirements.txt

@@ -1,3 +1,3 @@
 requests==2.27.1
-cuenca-validations==0.9.18
+cuenca-validations==0.9.22.dev1


alexviquez · 2022-02-28T18:14:05Z

tests/resources/test_endpoints.py

+    id_endpoint = 'EN02'
+    endpoint: Endpoint = Endpoint.update(
+        endpoint_id=id_endpoint, url='https://url.io', is_active=False
+    )
+    assert endpoint.id == id_endpoint
+    assert endpoint.events
+    assert endpoint.url == 'https://url.io'
+    assert not endpoint.is_active
+    assert not endpoint.deactivated_at


puedes agregar validación de que cambio el url a url.io

Está en la línea 34

alexviquez · 2022-02-28T18:14:36Z

tests/resources/test_webhooks.py

+@pytest.mark.vcr
+def test_webhook_retrieve():
+    id_webhook = 'WE01'
+    webhook: Webhook = Webhook.retrieve(id_webhook)
+    assert webhook.id == id_webhook
+    assert webhook.payload
+    assert webhook.event


puedes hacer un webhook all con más de un webhook en test porfa

alexviquez · 2022-02-28T18:15:54Z

cuenca/resources/endpoints.py

+        """
+        Deactivates an Endpoint
+        """


agrega más contexto

alexviquez

Lo de deactivable, y cuidar la info del cassete

alexviquez · 2022-03-07T19:14:32Z

tests/resources/test_webhooks.py

+
+
+@pytest.mark.vcr
+def test_webhook_all():
+    assert list(Webhook.all())


de un user nadamas, no todos, los cassetrs son gigantes y aparte tiene info de usuarios de stage con teléfonos

alexviquez · 2022-03-07T19:14:53Z

cuenca/resources/endpoints.py

        """
-        Deactivates an Endpoint
+        Deactivates an Endpoint. There is no way to activate this endpoint
+        again
+
+        :param endpoint_id: existing endpoint_id
+        :param session
+        :return: Deactivated endpoint object
        """
-        url = f'{cls._resource}/{endpoint_id}'
-        resp = session.delete(url)
+        resp = session.delete(f'{cls._resource}/{endpoint_id}')
        return cast('Endpoint', cls._from_dict(resp))


no comprendo porque no puedes usar Deactivable, para eso se diseño con la idea de no repetir código

Ya le investigué un poco más y es que Deactivable trae una propiedad llamada is_active, al igual que Endpoint tiene un atributo llamado is_active

Al correr los tests pasa este error:

FAILED tests/resources/test_endpoints.py::test_endpoint_retrieve - AttributeError: can't set attribute FAILED tests/resources/test_endpoints.py::test_endpoint_create - AttributeError: can't set attribute FAILED tests/resources/test_endpoints.py::test_endpoint_update - AttributeError: can't set attribute FAILED tests/resources/test_endpoints.py::test_endpoint_deactivate - AttributeError: can't set attribute

alexviquez

validations version

requirements.txt

cuenca/resources/endpoints.py

tests/resources/test_endpoints.py

andreshndz added the enhancement New feature or request label Jan 21, 2022

andreshndz requested review from alexviquez, matin and rogelioLpz January 21, 2022 02:51

andreshndz self-assigned this Jan 21, 2022

andreshndz force-pushed the webhook branch from 4c85395 to d9904ca Compare February 9, 2022 19:21

andreshndz marked this pull request as ready for review February 9, 2022 19:25

andreshndz force-pushed the webhook branch from 723c1d9 to c2e9794 Compare February 26, 2022 02:21

alexviquez suggested changes Feb 28, 2022

View reviewed changes

alexviquez suggested changes Mar 7, 2022

View reviewed changes

Andres Hernandez added 11 commits March 7, 2022 17:26

First approach of Endpoint and Webhook

2b29a32

Changing some comments for better understanding

1cca58a

Little changes

d32ebb5

Endpoint and Webhook tested and ready for review

8905811

Lint

fb01cfa

Secret Field added

f0de3f0

Some diferences on responses

caf09b0

Reviews done

49cadad

Lint

e967df0

Changing for is_enable in Endpoints and making shorter vcrs

4ad74e3

Lint

c91cc55

andreshndz force-pushed the webhook branch from b07a7c5 to c91cc55 Compare March 7, 2022 23:29

alexviquez suggested changes Mar 7, 2022

View reviewed changes

requirements.txt Outdated Show resolved Hide resolved

CV new version

9765e0e

rogelioLpz reviewed Mar 7, 2022

View reviewed changes

cuenca/resources/endpoints.py Outdated Show resolved Hide resolved

rogelioLpz reviewed Mar 8, 2022

View reviewed changes

cuenca/resources/endpoints.py Outdated Show resolved Hide resolved

rogelioLpz reviewed Mar 8, 2022

View reviewed changes

tests/resources/test_endpoints.py Outdated Show resolved Hide resolved

Reviews Done

c250e0a

rogelioLpz self-requested a review March 8, 2022 00:21

alexviquez approved these changes Mar 8, 2022

View reviewed changes

rogelioLpz approved these changes Mar 8, 2022

View reviewed changes

alexviquez merged commit 336b14e into cuenca-mx:main Mar 8, 2022

Conversation

andreshndz commented Jan 21, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov bot commented Feb 9, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

alexviquez left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

alexviquez left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

alexviquez left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

andreshndz commented Jan 21, 2022 •

edited

Loading

codecov bot commented Feb 9, 2022 •

edited

Loading