Source code for ovl.connections.http_connection

from enum import Enum
from typing import Any, Union

from .connection import Connection


class HTTPRequestTypes(Enum):
    GET = "GET"
    POST = "POST"
    PUT = "PUT"
    DELETE = "DELETE"
    PATCH = "PATCH"
    HEAD = "HEAD"


class HTTPConnection(Connection):
    """
    A Connection that utilizes http

    HTTP is useful for communicating with HTTP Servers over the web, although slower than other more
    low level connection types
    """
    def __init__(self, session, default_url=None, headers=None, auth=None):
        import requests
        self.session = session or requests.Session()
        self.session.headers.update(headers)
        if auth:
            self.auth = auth
            self.session.auth(auth)
        self.url = default_url

    def send_request(self, data: Any, url: str, method: HTTPRequestTypes, **kwargs):
        """
        send_request is the function used to send a request using http protocol.
        This can be used to send request to servers running remotely in the internet or to a HTTP server in the LAN.


        Note: This is the inner function used by the Connection object to send and receive.
        The functions send, receive and interval_receive should be used instead!


        :param data: The data to be passed as the request's payload
        :param url: the url to send the request to
        :param method: the HTTP method to be used
        :param kwargs: any other parameters to requests.request
        :return: the response received for the request
        """
        import requests
        params = {"data": data}
        if "params" in kwargs.keys():
            params = {**kwargs["params"], "data": data}
        url = url or self.url
        response = requests.request(method.value, url, params=params, **kwargs)
        response.raise_for_status()
        return response

    def send(self, data: Any, url: str = None, method=HTTPRequestTypes.POST, **kwargs):
        """
        Sends an http requests, should be used to only send data and not receive any data
        as it represent the logical action of sending information

        :param data: the data to be send, passed
        :param url:
        :param method:
        :param kwargs:
        :return:
        """
        return self.send_request(data, url, method, **kwargs)

    def receive(self, data: Any = None, url: str = None, method: HTTPRequestTypes = HTTPRequestTypes.GET,
                interval: Union[float, bool] = False, **kwargs):
        """
        Receive for HTTPConnection is a bit different compared to other Connection in that it sends a request
        and returns a response which is the main usage, in addition the interval parameter allows for high
        interval sampling (for MultiVision for example) without sending many requests

        :param url: the url to send to, overrides self.url
        :param data: any data to pass with the requests
        :param method: determines what http method should the request use (GET, POST, PUT etc.)
        :param interval:
        :param kwargs: any other parameters passed to Request.request
        :return:
        """
        if interval:
            return self.interval_receive(data, url, method, **kwargs)
        else:
            self.send_request(data, url, method, **kwargs)

    def interval_receive(self, data: Any, url: str = None, method=HTTPRequestTypes.GET, **kwargs):
        pass