restiny 0.2.1__py3-none-any.whl → 0.5.0__py3-none-any.whl

restiny/httpx_auths.py

@@ -0,0 +1,52 @@
+from collections.abc import Generator
+
+import httpx
+
+
+class BearerAuth(httpx.Auth):
+    """
+    Adds a Bearer token to the Authorization header of each request.
+    """
+
+    def __init__(self, token: str) -> None:
+        self._token = token
+
+    def auth_flow(
+        self, request: httpx.Request
+    ) -> Generator[httpx.Request, httpx.Response]:
+        request.headers['authorization'] = f'Bearer {self._token}'
+        yield request
+
+
+class APIKeyHeaderAuth(httpx.Auth):
+    """
+    Adds an API key to the request headers.
+    """
+
+    def __init__(self, key: str, value: str) -> None:
+        self._key = key
+        self._value = value
+
+    def auth_flow(
+        self, request: httpx.Request
+    ) -> Generator[httpx.Request, httpx.Response]:
+        request.headers[self._key] = self._value
+        yield request
+
+
+class APIKeyParamAuth(httpx.Auth):
+    """
+    Adds an API key as a query parameter to the request URL.
+    """
+
+    def __init__(self, key: str, value: str) -> None:
+        self._key = key
+        self._value = value
+
+    def auth_flow(
+        self, request: httpx.Request
+    ) -> Generator[httpx.Request, httpx.Response]:
+        request.url = request.url.copy_with(
+            params=request.url.params.set(self._key, self._value)
+        )
+        yield request

restiny/ui/__init__.py

@@ -0,0 +1,15 @@
+"""
+This module contains the specific sections of the DataFox user interface (UI).
+"""
+
+from restiny.ui.collections_area import CollectionsArea
+from restiny.ui.request_area import RequestArea
+from restiny.ui.response_area import ResponseArea
+from restiny.ui.url_area import URLArea
+
+__all__ = [
+    'RequestArea',
+    'ResponseArea',
+    'URLArea',
+    'CollectionsArea',
+]

restiny/ui/app.py

@@ -0,0 +1,500 @@
+import asyncio
+from http import HTTPStatus
+
+import httpx
+import pyperclip
+from textual import on
+from textual.app import App, ComposeResult
+from textual.binding import Binding
+from textual.containers import Horizontal, Vertical
+from textual.events import DescendantFocus
+from textual.widget import Widget
+from textual.widgets import Footer, Header
+
+from restiny.__about__ import __version__
+from restiny.assets import STYLE_TCSS
+from restiny.consts import CUSTOM_THEMES
+from restiny.data.repos import FoldersSQLRepo, RequestsSQLRepo, SettingsSQLRepo
+from restiny.entities import Request, Settings
+from restiny.enums import (
+    AuthMode,
+    BodyMode,
+    BodyRawLanguage,
+    ContentType,
+    CustomThemes,
+)
+from restiny.ui import (
+    CollectionsArea,
+    RequestArea,
+    ResponseArea,
+    URLArea,
+)
+from restiny.ui.response_area import ResponseAreaData
+from restiny.ui.settings_screen import SettingsScreen
+from restiny.widgets.custom_text_area import CustomTextArea
+
+
+class RESTinyApp(App, inherit_bindings=False):
+    TITLE = f'RESTiny v{__version__}'
+    SUB_TITLE = 'Minimal HTTP client, no bullshit'
+    ENABLE_COMMAND_PALETTE = False
+    CSS_PATH = STYLE_TCSS
+    BINDINGS = [
+        Binding(
+            key='escape', action='quit', description='Quit the app', show=True
+        ),
+        Binding(
+            key='ctrl+b',
+            action='toggle_collections',
+            description='Toggle collections',
+            show=True,
+        ),
+        Binding(
+            key='ctrl+n',
+            action='prompt_add',
+            description='Add req/folder',
+            show=True,
+        ),
+        Binding(
+            key='f2',
+            action='prompt_update',
+            description='Update req/folder',
+            show=True,
+        ),
+        Binding(
+            key='delete',
+            action='prompt_delete',
+            description='Delete req/folder',
+            show=True,
+        ),
+        Binding(
+            key='ctrl+s',
+            action='save',
+            description='Save request',
+            show=True,
+        ),
+        Binding(
+            key='f9',
+            action='copy_as_curl',
+            description='Copy as curl',
+            show=True,
+        ),
+        Binding(
+            key='f10',
+            action='maximize_or_minimize_area',
+            description='Maximize/Minimize area',
+            show=True,
+        ),
+        Binding(
+            key='f12',
+            action='open_settings',
+            description='Settings',
+            show=True,
+        ),
+    ]
+    # theme = 'textual-dark'
+
+    def __init__(
+        self,
+        folders_repo: FoldersSQLRepo,
+        requests_repo: RequestsSQLRepo,
+        settings_repo: SettingsSQLRepo,
+        *args,
+        **kwargs,
+    ) -> None:
+        super().__init__(*args, **kwargs)
+        self.folders_repo = folders_repo
+        self.requests_repo = requests_repo
+        self.settings_repo = settings_repo
+
+        self.active_request_task: asyncio.Task | None = None
+        self.selected_request: Request | None = None
+        self.last_focused_widget: Widget | None = None
+        self.last_focused_maximizable_area: Widget | None = None
+
+    def compose(self) -> ComposeResult:
+        yield Header(show_clock=True)
+        with Horizontal():
+            yield CollectionsArea(classes='w-1fr')
+            with Vertical(classes='w-6fr'):
+                with Horizontal(classes='h-auto'):
+                    yield URLArea()
+                with Horizontal(classes='h-1fr'):
+                    yield RequestArea()
+                    yield ResponseArea()
+        yield Footer()
+
+    def on_mount(self) -> None:
+        self.collections_area = self.query_one(CollectionsArea)
+        self.url_area = self.query_one(URLArea)
+        self.request_area = self.query_one(RequestArea)
+        self.response_area = self.query_one(ResponseArea)
+
+        self.url_area.disabled = True
+        self.request_area.disabled = True
+
+        self._register_themes()
+        self._apply_settings()
+
+    def action_toggle_collections(self) -> None:
+        if self.collections_area.display:
+            self.collections_area.display = False
+        else:
+            self.collections_area.display = True
+
+    def action_prompt_add(self) -> None:
+        self.collections_area.prompt_add()
+
+    def action_prompt_update(self) -> None:
+        self.collections_area.prompt_update()
+
+    def action_prompt_delete(self) -> None:
+        self.collections_area.prompt_delete()
+
+    def action_save(self) -> None:
+        req = self.get_request()
+        self.requests_repo.update(request=req)
+        self.collections_area._populate_children(
+            self.collections_area.collections_tree.current_parent_folder
+        )
+        self.notify('Saved changes', severity='information')
+
+    def action_maximize_or_minimize_area(self) -> None:
+        if not self.last_focused_maximizable_area:
+            self.notify('No area focused', severity='warning')
+            return
+
+        if self.screen.maximized:
+            self.screen.minimize()
+        else:
+            self.screen.maximize(self.last_focused_maximizable_area)
+
+    def action_copy_as_curl(self) -> None:
+        if not self.selected_request:
+            self.notify(
+                'Select a request before copying as CURL.',
+                severity='warning',
+            )
+            return
+
+        request = self.get_request()
+        self.copy_to_clipboard(request.to_curl())
+        self.notify(
+            'Command CURL copied to clipboard',
+            severity='information',
+        )
+
+    def action_open_settings(self) -> None:
+        def on_settings_result(result: dict | None) -> None:
+            if not result:
+                return
+
+            self.settings_repo.set(Settings(theme=result['theme']))
+            self._apply_settings()
+
+        settings: Settings = self.settings_repo.get().data
+        self.push_screen(
+            screen=SettingsScreen(
+                themes=[theme.value for theme in CustomThemes],
+                theme=settings.theme,
+            ),
+            callback=on_settings_result,
+        )
+
+    def copy_to_clipboard(self, text: str) -> None:
+        super().copy_to_clipboard(text)
+        try:
+            # Also copy to the system clipboard (outside of the app)
+            pyperclip.copy(text)
+        except Exception:
+            pass
+
+    @on(DescendantFocus)
+    def _on_focus(self, event: DescendantFocus) -> None:
+        self.last_focused_widget = event.widget
+        last_focused_maximizable_area = self._find_maximizable_area_by_widget(
+            widget=event.widget
+        )
+        if last_focused_maximizable_area:
+            self.last_focused_maximizable_area = last_focused_maximizable_area
+
+    @on(URLArea.SendRequest)
+    def _on_send_request(self, message: URLArea.SendRequest) -> None:
+        self.active_request_task = asyncio.create_task(self._send_request())
+
+    @on(URLArea.CancelRequest)
+    def _on_cancel_request(self, message: URLArea.CancelRequest) -> None:
+        if self.active_request_task and not self.active_request_task.done():
+            self.active_request_task.cancel()
+
+    @on(CollectionsArea.RequestSelected)
+    def _on_request_selected(
+        self, message: CollectionsArea.RequestSelected
+    ) -> None:
+        self.url_area.disabled = False
+        self.request_area.disabled = False
+        req = self.requests_repo.get_by_id(id=message.request_id).data
+        self.selected_request = req
+        self.set_request(request=req)
+        self.response_area.set_data(None)
+        self.response_area.is_showing_response = False
+
+    def _apply_settings(self) -> None:
+        settings = self.settings_repo.get().data
+        self.theme = settings.theme
+        for text_area in self.query(CustomTextArea):
+            text_area.theme = settings.theme
+
+    def _register_themes(self) -> None:
+        for theme in CUSTOM_THEMES.values():
+            self.register_theme(theme=theme['global'])
+
+        for text_area in self.query(CustomTextArea):
+            for theme in CUSTOM_THEMES.values():
+                text_area.register_theme(theme=theme['text_area'])
+
+    def _find_maximizable_area_by_widget(
+        self, widget: Widget
+    ) -> Widget | None:
+        while widget is not None:
+            if (
+                isinstance(widget, CollectionsArea)
+                or isinstance(widget, URLArea)
+                or isinstance(widget, RequestArea)
+                or isinstance(widget, ResponseArea)
+            ):
+                return widget
+            widget = widget.parent
+
+    def get_request(self) -> Request:
+        method = self.url_area.method
+        url = self.url_area.url
+
+        headers = [
+            Request.Header(
+                enabled=header['enabled'],
+                key=header['key'],
+                value=header['value'],
+            )
+            for header in self.request_area.headers
+        ]
+
+        params = [
+            Request.Param(
+                enabled=param['enabled'],
+                key=param['key'],
+                value=param['value'],
+            )
+            for param in self.request_area.params
+        ]
+
+        auth_enabled = self.request_area.auth_enabled
+        auth_mode = self.request_area.auth_mode
+        auth = None
+        if auth_mode == AuthMode.BASIC:
+            auth = Request.BasicAuth(
+                username=self.request_area.auth_basic_username,
+                password=self.request_area.auth_basic_password,
+            )
+        elif auth_mode == AuthMode.BEARER:
+            auth = Request.BearerAuth(
+                token=self.request_area.auth_bearer_token
+            )
+        elif auth_mode == AuthMode.API_KEY:
+            auth = Request.ApiKeyAuth(
+                key=self.request_area.auth_api_key_key,
+                value=self.request_area.auth_api_key_value,
+                where=self.request_area.auth_api_key_where,
+            )
+        elif auth_mode == AuthMode.DIGEST:
+            auth = Request.DigestAuth(
+                username=self.request_area.auth_digest_username,
+                password=self.request_area.auth_digest_password,
+            )
+
+        body_enabled = self.request_area.body_enabled
+        body_mode = self.request_area.body_mode
+        body = None
+        if body_mode == BodyMode.RAW:
+            body = Request.RawBody(
+                language=BodyRawLanguage(self.request_area.body_raw_language),
+                value=self.request_area.body_raw,
+            )
+        elif body_mode == BodyMode.FILE:
+            body = Request.FileBody(file=self.request_area.body_file)
+        elif body_mode == BodyMode.FORM_URLENCODED:
+            body = Request.UrlEncodedFormBody(
+                fields=[
+                    Request.UrlEncodedFormBody.Field(
+                        enabled=form_field['enabled'],
+                        key=form_field['key'],
+                        value=form_field['value'],
+                    )
+                    for form_field in self.request_area.body_form_urlencoded
+                ]
+            )
+        elif body_mode == BodyMode.FORM_MULTIPART:
+            body = Request.MultipartFormBody(
+                fields=[
+                    Request.MultipartFormBody.Field(
+                        enabled=form_field['enabled'],
+                        key=form_field['key'],
+                        value=form_field['value'],
+                        value_kind=form_field['value_kind'],
+                    )
+                    for form_field in self.request_area.body_form_multipart
+                ]
+            )
+
+        options = Request.Options(
+            timeout=self.request_area.option_timeout,
+            follow_redirects=self.request_area.option_follow_redirects,
+            verify_ssl=self.request_area.option_verify_ssl,
+        )
+
+        return Request(
+            id=self.selected_request.id,
+            folder_id=self.selected_request.folder_id,
+            name=self.selected_request.name,
+            method=method,
+            url=url,
+            headers=headers,
+            params=params,
+            body_enabled=body_enabled,
+            body_mode=body_mode,
+            body=body,
+            auth_enabled=auth_enabled,
+            auth_mode=auth_mode,
+            auth=auth,
+            options=options,
+        )
+
+    def set_request(self, request: Request) -> None:
+        self.url_area.method = request.method
+        self.url_area.url = request.url
+
+        self.request_area.headers = [
+            {
+                'enabled': header.enabled,
+                'key': header.key,
+                'value': header.value,
+            }
+            for header in request.headers
+        ]
+        self.request_area.params = [
+            {'enabled': param.enabled, 'key': param.key, 'value': param.value}
+            for param in request.params
+        ]
+
+        self.request_area.auth_enabled = request.auth_enabled
+        self.request_area.auth_mode = request.auth_mode
+        if request.auth is not None:
+            if request.auth_mode == AuthMode.BASIC:
+                self.request_area.auth_basic_username = request.auth.username
+                self.request_area.auth_basic_password = request.auth.password
+            elif request.auth_mode == AuthMode.BEARER:
+                self.request_area.auth_bearer_token = request.auth.token
+            elif request.auth_mode == AuthMode.API_KEY:
+                self.request_area.auth_api_key_key = request.auth.key
+                self.request_area.auth_api_key_value = request.auth.value
+                self.request_area.auth_api_key_where = request.auth.where
+            elif request.auth_mode == AuthMode.DIGEST:
+                self.request_area.auth_digest_username = request.auth.username
+                self.request_area.auth_digest_password = request.auth.password
+
+        self.request_area.body_enabled = request.body_enabled
+        self.request_area.body_mode = request.body_mode
+        if request.body is not None:
+            if request.body_mode == BodyMode.RAW:
+                self.request_area.body_raw_language = request.body.language
+                self.request_area.body_raw = request.body.value
+            elif request.body_mode == BodyMode.FILE:
+                self.request_area.body_file = request.body.file
+            elif request.body_mode == BodyMode.FORM_URLENCODED:
+                self.request_area.body_form_urlencoded = [
+                    {
+                        'enabled': form_field.enabled,
+                        'key': form_field.key,
+                        'value': form_field.value,
+                    }
+                    for form_field in request.body.fields
+                ]
+            elif request.body_mode == BodyMode.FORM_MULTIPART:
+                self.request_area.body_form_multipart = [
+                    {
+                        'enabled': form_field.enabled,
+                        'key': form_field.key,
+                        'value': form_field.value,
+                        'value_kind': form_field.value_kind,
+                    }
+                    for form_field in request.body.fields
+                ]
+
+        self.request_area.option_follow_redirects = (
+            request.options.follow_redirects
+        )
+        self.request_area.option_verify_ssl = request.options.verify_ssl
+        self.request_area.option_timeout = str(request.options.timeout)
+
+    async def _send_request(self) -> None:
+        self.response_area.set_data(data=None)
+        self.response_area.loading = True
+        self.url_area.request_pending = True
+        try:
+            request = self.get_request()
+            async with httpx.AsyncClient(
+                timeout=request.options.timeout,
+                follow_redirects=request.options.follow_redirects,
+                verify=request.options.verify_ssl,
+            ) as http_client:
+                response = await http_client.send(
+                    request=request.to_httpx_req(),
+                    auth=request.to_httpx_auth(),
+                )
+                self._display_response(response=response)
+                self.response_area.is_showing_response = True
+        except httpx.RequestError as error:
+            error_name = type(error).__name__
+            error_message = str(error)
+            if error_message:
+                self.notify(f'{error_name}: {error_message}', severity='error')
+            else:
+                self.notify(f'{error_name}', severity='error')
+            self.response_area.set_data(data=None)
+            self.response_area.is_showing_response = False
+        except asyncio.CancelledError:
+            self.response_area.set_data(data=None)
+            self.response_area.is_showing_response = False
+        finally:
+            self.response_area.loading = False
+            self.url_area.request_pending = False
+
+    def _display_response(self, response: httpx.Response) -> None:
+        status = HTTPStatus(response.status_code)
+        size = response.num_bytes_downloaded
+        elapsed_time = round(response.elapsed.total_seconds(), 2)
+        headers = {
+            header_key: header_value
+            for header_key, header_value in response.headers.multi_items()
+        }
+        content_type_to_body_language = {
+            ContentType.TEXT: BodyRawLanguage.PLAIN,
+            ContentType.HTML: BodyRawLanguage.HTML,
+            ContentType.JSON: BodyRawLanguage.JSON,
+            ContentType.YAML: BodyRawLanguage.YAML,
+            ContentType.XML: BodyRawLanguage.XML,
+        }
+        body_raw_language = content_type_to_body_language.get(
+            response.headers.get('Content-Type'), BodyRawLanguage.PLAIN
+        )
+        body_raw = response.text
+        self.response_area.set_data(
+            data=ResponseAreaData(
+                status=status,
+                size=size,
+                elapsed_time=elapsed_time,
+                headers=headers,
+                body_raw_language=body_raw_language,
+                body_raw=body_raw,
+            )
+        )