giancarlopro / drapion Goto Github PK

PyTest
responses

References:

• OpenAPI Especification
• Example

Authentication

Currently you can authenticate only passing a headers attribute when calling a Drapion instance method.

Would be nice to support ways to authenticate using other ways of authentication.

How drapion works

Drapion can be used with any web api.
with a drapion instance, you can call methods and pass parameters and the library will know how to connect to the api and parse the response.
e.g.

from drapion import Drapion

api = Drapion('http://some.api/')

response = api.status()
# When you call this status function
# drapion will parse the response from http://some.api/status
# and give it to you as an GenericObject instance
# let's say this is the response: {"api_v1": true}
# the response object will have a 'api_v1' attribute

response.api_v1 # True

How to add new public API's

Check this repo for api's suggestion

1. Create a file inside drapion/api/ with your api name.
2. Create a class that inherit's Drapion class.
3. Call super().__init__() inside your __init__ method, and pass the api root endpoint.
4. Add a docstring to your class and add your api documentation url inside it

You can check drapion/api/telegram.py for example.

Take this as a skeleton:

# drapion/api/myapi.py

from drapion import Drapion


class MyApi(Drapion)
    """Does something
    
    Check online documentation: http://my.api/docs
    """

    def __init__(self):
        super().__init__('http://my.api/root/')

You can add your class to the __all__ list inside drapion/api/__init__.py file, so your class can be imported directly from drapion.api module. e.g.:

"""
drapion.api
~~~~~~~~~~~~~~~
This module contains specific implementations for public API's
:copyright: (c) 2018 Giancarlo Rocha
:license: Apache 2.0, see LICENSE for more details.
"""

from .telegram import TelegramBotAPI
from .myapi import MyApi


__all__ = ['TelegramBotAPI', 'MyApi']

Now you can do this

from drapion.api import MyApi

Instead of that

from drapion.api.myapi import MyApi

Currently supported

Currently we only support api's that respond to methods on the URL and accept urlencoded parameters

e.g.

http://example.api/method?param1=value1&param2=value2

Resources

Currently we can only parse json responses.

Would be nice to parse other resources

It would be nice to have feedback and alternatives to the project architecture

A GenericObject instance is created from it's parse class method.
I need to separate this function and create another logic to parse objects into GenericObject.

I want a generic parser that can be inherited by others parsers. That way will be possible to create specific parsers for specific apis.

e.g.
Using drapion with Telegram Bot API, i have responses like this one:
{ "ok":true, "result":{ "id":111111111,"is_bot":true,"first_name":"examplebot","username":"examplebot" }}
so, i want a parser to return only what's inside result key when ok is true, and i want it to raise exceptions, when ok is false, based on the API's response.

retrieve JSON from webhook and load instances of DObject