[Dragos]: feat implement api client

[flavienSindou]

Proposed changes

• implement Dragos V1 API client to be later used in an adapter, implementing report interface
• Implement fake API server for dev purpose
• ASIDE: fix a typing error in report interface

Related issues

• [Dragos] Create the connector #2570

Checklist

• I consider the submitted work as finished
• I tested the code for its functionality using different use cases
• I added/update the relevant documentation (either on github or on notion)
• Where necessary I refactored code to improve the overall quality

Further comments

Related Notion Page : https://www.notion.so/filigran/Integration-Dragos-Create-the-connector-1528fce17f2a80dda61ed990b8e78b75?pvs=4

[flavienSindou]

ASIDE : Minor typing fix

[flavienSindou]

Core of the PR

[Powlinett]

✅ code is clear
✅ dev server is really cool 🙌
✅ tests pass
✅ I succeed to do a minimal use case with ProductClientAPIV1 (once with dev server and once with Dragos API)👍

Minimal use case:

from datetime import timedelta

import asyncio
from yarl import URL

from client_api.v1.product import ProductClientAPIV1

client = ProductClientAPIV1(
    base_url=URL("http://localhost:4000"),
    token="dev",
    secret="dev",
    timeout=timedelta(seconds=10),
    retry=3,
    backoff=timedelta(seconds=2),
)

async def get_products():
    products = client.iter_products()
    async for product in products:
        print(product)

asyncio.run(get_products())

[Powlinett]

Did you want to display images here?

[flavienSindou]

I just wanted to provide a link to keep README readable

[Powlinett]

Crystal clear and the examples work fine 👍

[Powlinett]

I would probably used PermissiveBaseModel instead of its alias ResponseModel, as ResponseModel makes me think of a whole response and it doesn't explicitly expose its intent. What do you think?

[flavienSindou]

That’s an interesting point. I generally prefer to hide technical details that might be implied by naming in public methods and classes. I’d say the "Permissive" aspect (not raising a technical error) is more of a concern for the client developer, whereas the end-user is concerned with the possibility of receiving a None value, accompanied by a warning log.

This is why I introduced a user-oriented alias, ResponseModel, for the technical PermissiveBaseModel object. However, I do agree that the term might not be ideal, as it is also used in the context of "Sub Response Elements" modeling.

I would prefer to keep an alias and I’d be happy to consider any naming suggestions you might have !

[Powlinett]

Could it be called first_page_data or equivalent to have consistent naming with pages_data ?

[flavienSindou]

This is later extended to gather all the indicator.

[Powlinett]

Hardcoded BASE_URL in links lead to this error:

products.0.report_link
  Input should be a valid URL, relative URL without a base [type=url_parsing, input_value='BASE_URL/api/v1/products/DEMO_SERIAL/report', input_type=str]
    For further information visit https://errors.pydantic.dev/2.10/v/url_parsing
products.0.ioc_csv_link
  Input should be a valid URL, relative URL without a base [type=url_parsing, input_value='BASE_URL/api/v1/products/DEMO_SERIAL/csv', input_type=str]
    For further information visit https://errors.pydantic.dev/2.10/v/url_parsing
products.0.ioc_stix2_link
  Input should be a valid URL, relative URL without a base [type=url_parsing, input_value='BASE_URL/api/v1/products/DEMO_SERIAL/stix2', input_type=str]
    For further information visit https://errors.pydantic.dev/2.10/v/url_parsing

[flavienSindou]

Thank you for your remark, I correct this !

[Powlinett]

Should be stored in the client_api/dev/fake_server/v1/data directory

[flavienSindou]

Thank you for noticing this mistake !

[Powlinett]

Zero warnings 😉-> https://english.stackexchange.com/questions/38293/why-is-zero-followed-by-a-plural-noun