Skip to content

Api

Nowplaying ApiServer.

ApiServer

The API server.

Source code in nowplaying/api.py 
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
class ApiServer:
    """The API server."""

    def __init__(
        self: Self,
        options: Options,
        event_queue: Queue,
        realm: str = "nowplaying",
    ) -> None:
        """Create ApiServer."""
        self.options = options
        self.event_queue = event_queue
        self.realm = realm

        self.url_map = Map([Rule("/webhook", endpoint="webhook")])
        self._server = None

    def run_server(self: Self) -> None:
        """Run the API server."""
        if self.options.debug:
            from werkzeug.serving import run_simple  # noqa: PLC0415

            run_simple(
                self.options.api_bind_address,
                self.options.api_port,
                self,
                use_debugger=True,
                use_reloader=True,
            )
        else:  # pragma: no cover
            cherrypy.tree.graft(self, "/")
            cherrypy.server.unsubscribe()

            self._server = cherrypy._cpserver.Server()  # noqa: SLF001

            self._server.socket_host = self.options.api_bind_address
            self._server.socket_port = self.options.api_port

            self._server.subscribe()

            cherrypy.engine.start()
            cherrypy.engine.block()

    def stop_server(self: Self) -> None:
        """Stop the server."""
        if self._server is not None:
            self._server.stop()
        cherrypy.engine.exit()

    def __call__(
        self: Self,
        environ: WSGIEnvironment,
        start_response: StartResponse,
    ) -> Iterable[bytes]:
        """Forward calls to wsgi_app."""
        return self.wsgi_app(environ, start_response)

    def wsgi_app(
        self: Self,
        environ: WSGIEnvironment,
        start_response: StartResponse,
    ) -> Iterable[bytes]:
        """Return a wsgi app."""
        request = Request(environ)
        auth = request.authorization
        if auth and self.check_auth(auth.username, auth.password):
            response = self.dispatch_request(request)
        else:
            response = self.auth_required(request)
        return response(environ, start_response)

    def check_auth(self: Self, username: str | None, password: str | None) -> bool:
        """Check if auth is valid."""
        return str(
            username,
        ) in self.options.api_auth_users and self.options.api_auth_users[
            str(username)
        ] == str(
            password,
        )

    def auth_required(self: Self, _: Request) -> Response:
        """Check if auth is required."""
        return Response(
            "Could not verify your access level for that URL.\n"
            "You have to login with proper credentials",
            401,
            {"WWW-Authenticate": f'Basic realm="{self.realm}"'},
        )

    def dispatch_request(self: Self, request: Request) -> Response | HTTPException:
        """Dispatch requests to handlers."""
        adapter = self.url_map.bind_to_environ(request.environ)
        try:
            endpoint, values = adapter.match()
            return getattr(self, f"on_{endpoint}")(request, **values)
        except HTTPException as e:
            return Response(
                json.dumps(e.description),
                e.code,
                {"Content-Type": "application/json"},
            )

    def on_webhook(self: Self, request: Request) -> Response:
        """Receive a CloudEvent and put it into the event queue."""
        logger.warning("Received a webhook")
        if (
            request.headers.get("Content-Type")
            not in _RABE_CLOUD_EVENTS_SUPPORTED_MEDIA_TYPES
        ):
            raise UnsupportedMediaType
        try:
            event = from_http(request.headers, request.data)  # type: ignore[arg-type]
        except CloudEventException as error:
            raise BadRequest(description=str(error)) from error

        try:
            crid = cridlib.parse(event["id"])
            logger.debug("Detected CRID: %s", crid)
        except cridlib.CRIDError as error:
            raise BadRequest(
                description=f"CRID '{event['id']}' is not a RaBe CRID",
            ) from error

        logger.info("Received event: %s", event)

        if event["type"] in _RABE_CLOUD_EVENTS_SUBS:
            self.event_queue.put(event)

        return Response(status="200 Event Received")

__call__(environ, start_response)

Forward calls to wsgi_app.

Source code in nowplaying/api.py 
86
87
88
89
90
91
92
def __call__(
    self: Self,
    environ: WSGIEnvironment,
    start_response: StartResponse,
) -> Iterable[bytes]:
    """Forward calls to wsgi_app."""
    return self.wsgi_app(environ, start_response)

__init__(options, event_queue, realm='nowplaying')

Create ApiServer.

Source code in nowplaying/api.py 
40
41
42
43
44
45
46
47
48
49
50
51
52
def __init__(
    self: Self,
    options: Options,
    event_queue: Queue,
    realm: str = "nowplaying",
) -> None:
    """Create ApiServer."""
    self.options = options
    self.event_queue = event_queue
    self.realm = realm

    self.url_map = Map([Rule("/webhook", endpoint="webhook")])
    self._server = None

auth_required(_)

Check if auth is required.

Source code in nowplaying/api.py 
118
119
120
121
122
123
124
125
def auth_required(self: Self, _: Request) -> Response:
    """Check if auth is required."""
    return Response(
        "Could not verify your access level for that URL.\n"
        "You have to login with proper credentials",
        401,
        {"WWW-Authenticate": f'Basic realm="{self.realm}"'},
    )

check_auth(username, password)

Check if auth is valid.

Source code in nowplaying/api.py 
108
109
110
111
112
113
114
115
116
def check_auth(self: Self, username: str | None, password: str | None) -> bool:
    """Check if auth is valid."""
    return str(
        username,
    ) in self.options.api_auth_users and self.options.api_auth_users[
        str(username)
    ] == str(
        password,
    )

dispatch_request(request)

Dispatch requests to handlers.

Source code in nowplaying/api.py 
127
128
129
130
131
132
133
134
135
136
137
138
def dispatch_request(self: Self, request: Request) -> Response | HTTPException:
    """Dispatch requests to handlers."""
    adapter = self.url_map.bind_to_environ(request.environ)
    try:
        endpoint, values = adapter.match()
        return getattr(self, f"on_{endpoint}")(request, **values)
    except HTTPException as e:
        return Response(
            json.dumps(e.description),
            e.code,
            {"Content-Type": "application/json"},
        )

on_webhook(request)

Receive a CloudEvent and put it into the event queue.

Source code in nowplaying/api.py 
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
def on_webhook(self: Self, request: Request) -> Response:
    """Receive a CloudEvent and put it into the event queue."""
    logger.warning("Received a webhook")
    if (
        request.headers.get("Content-Type")
        not in _RABE_CLOUD_EVENTS_SUPPORTED_MEDIA_TYPES
    ):
        raise UnsupportedMediaType
    try:
        event = from_http(request.headers, request.data)  # type: ignore[arg-type]
    except CloudEventException as error:
        raise BadRequest(description=str(error)) from error

    try:
        crid = cridlib.parse(event["id"])
        logger.debug("Detected CRID: %s", crid)
    except cridlib.CRIDError as error:
        raise BadRequest(
            description=f"CRID '{event['id']}' is not a RaBe CRID",
        ) from error

    logger.info("Received event: %s", event)

    if event["type"] in _RABE_CLOUD_EVENTS_SUBS:
        self.event_queue.put(event)

    return Response(status="200 Event Received")

run_server()

Run the API server.

Source code in nowplaying/api.py 
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
def run_server(self: Self) -> None:
    """Run the API server."""
    if self.options.debug:
        from werkzeug.serving import run_simple  # noqa: PLC0415

        run_simple(
            self.options.api_bind_address,
            self.options.api_port,
            self,
            use_debugger=True,
            use_reloader=True,
        )
    else:  # pragma: no cover
        cherrypy.tree.graft(self, "/")
        cherrypy.server.unsubscribe()

        self._server = cherrypy._cpserver.Server()  # noqa: SLF001

        self._server.socket_host = self.options.api_bind_address
        self._server.socket_port = self.options.api_port

        self._server.subscribe()

        cherrypy.engine.start()
        cherrypy.engine.block()

stop_server()

Stop the server.

Source code in nowplaying/api.py 
80
81
82
83
84
def stop_server(self: Self) -> None:
    """Stop the server."""
    if self._server is not None:
        self._server.stop()
    cherrypy.engine.exit()

wsgi_app(environ, start_response)

Return a wsgi app.

Source code in nowplaying/api.py 
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
def wsgi_app(
    self: Self,
    environ: WSGIEnvironment,
    start_response: StartResponse,
) -> Iterable[bytes]:
    """Return a wsgi app."""
    request = Request(environ)
    auth = request.authorization
    if auth and self.check_auth(auth.username, auth.password):
        response = self.dispatch_request(request)
    else:
        response = self.auth_required(request)
    return response(environ, start_response)