diff --git a/modules/archive/api.py b/modules/archive/api.py index 98e861a9..45fb4c56 100644 --- a/modules/archive/api.py +++ b/modules/archive/api.py @@ -9,8 +9,7 @@ from sanic_ext.extensions.openapi import openapi from wrolpi.common import logger, wrol_mode_check, api_param_limiter from wrolpi.root_api import get_blueprint, json_response from wrolpi.schema import JSONErrorResponse -from . import lib -from .schema import ArchiveSearchRequest, ArchiveSearchResponse +from . import lib, schema NAME = 'archive' @@ -48,12 +47,12 @@ archive_offset_limiter = api_param_limiter(100, 0) @bp.post('/search') @openapi.definition( summary='Search archive contents and titles', - body=ArchiveSearchRequest, + body=schema.ArchiveSearchRequest, ) -@openapi.response(HTTPStatus.OK, ArchiveSearchResponse) +@openapi.response(HTTPStatus.OK, schema.ArchiveSearchResponse) @openapi.response(HTTPStatus.NOT_FOUND, JSONErrorResponse) -@validate(ArchiveSearchRequest) -async def search_archives(_: Request, body: ArchiveSearchRequest): +@validate(schema.ArchiveSearchRequest) +async def search_archives(_: Request, body: schema.ArchiveSearchRequest): search_str = body.search_str domain = body.domain limit = archive_limit_limiter(body.limit) diff --git a/modules/inventory/api.py b/modules/inventory/api.py index f9f455ad..a4b61750 100644 --- a/modules/inventory/api.py +++ b/modules/inventory/api.py @@ -8,11 +8,7 @@ from sanic_ext.extensions.openapi import openapi from wrolpi.common import run_after, remove_dict_value_whitespace from wrolpi.errors import ValidationError from wrolpi.root_api import get_blueprint, json_response -from .common import get_inventory_by_category, get_inventory_by_subcategory, get_inventory_by_name, \ - save_inventories_file -from .inventory import get_items, save_item, delete_items, \ - get_inventories, save_inventory, delete_inventory, update_inventory, update_item, get_categories, get_brands -from .schema import ItemPostRequest, InventoryPostRequest, InventoryPutRequest, ItemPutRequest +from . import common, inventory, schema NAME = 'inventory' @@ -21,109 +17,109 @@ bp = get_blueprint('Inventory', '/api/inventory') @bp.get('/categories') def _get_categories(_: Request): - categories = get_categories() + categories = inventory.get_categories() return json_response(dict(categories=categories)) @bp.get('/brands') def _get_brands(_: Request): - brands = get_brands() + brands = inventory.get_brands() return json_response(dict(brands=brands)) @bp.get('/') def inventories_get(_: Request): - inventories = get_inventories() + inventories = inventory.get_inventories() return json_response(dict(inventories=inventories)) @bp.get('/') def inventory_get(_: Request, inventory_id: int): - by_category = get_inventory_by_category(inventory_id) - by_subcategory = get_inventory_by_subcategory(inventory_id) - by_name = get_inventory_by_name(inventory_id) + by_category = common.get_inventory_by_category(inventory_id) + by_subcategory = common.get_inventory_by_subcategory(inventory_id) + by_name = common.get_inventory_by_name(inventory_id) return json_response(dict(by_category=by_category, by_subcategory=by_subcategory, by_name=by_name)) @bp.post('/') @openapi.definition( summary='Save a new inventory', - body=InventoryPostRequest, + body=schema.InventoryPostRequest, ) -@validate(InventoryPostRequest) -@run_after(save_inventories_file) +@validate(schema.InventoryPostRequest) +@run_after(common.save_inventories_file) def post_inventory(_: Request, data: dict): # Cleanup the whitespace. data = remove_dict_value_whitespace(data) - save_inventory(data) + inventory.save_inventory(data) return response.empty(HTTPStatus.CREATED) @bp.put('/') @openapi.definition( summary='Update an inventory', - body=InventoryPutRequest, + body=schema.InventoryPutRequest, ) -@validate(InventoryPutRequest) -@run_after(save_inventories_file) +@validate(schema.InventoryPutRequest) +@run_after(common.save_inventories_file) def put_inventory(_: Request, inventory_id: int, data: dict): # Cleanup the whitespace. data = remove_dict_value_whitespace(data) - update_inventory(inventory_id, data) + inventory.update_inventory(inventory_id, data) return response.empty() @bp.delete('/') @openapi.description('Delete an inventory.') -@run_after(save_inventories_file) +@run_after(common.save_inventories_file) def inventory_delete(_: Request, inventory_id: int): - delete_inventory(inventory_id) + inventory.delete_inventory(inventory_id) return response.empty() @bp.get('//item') @openapi.description('Get all items from an inventory.') def items_get(_: Request, inventory_id: int): - items = get_items(inventory_id) + items = inventory.get_items(inventory_id) return json_response({'items': items}) @bp.post('//item') @openapi.definition( summary="Save an item into it's inventory.", - body=ItemPostRequest, + body=schema.ItemPostRequest, ) -@validate(ItemPostRequest) -@run_after(save_inventories_file) +@validate(schema.ItemPostRequest) +@run_after(common.save_inventories_file) def post_item(_: Request, inventory_id: int, data: dict): # Cleanup the whitespace. data = remove_dict_value_whitespace(data) - save_item(inventory_id, data) + inventory.save_item(inventory_id, data) return response.empty() @bp.put('/item/') @openapi.definition( summary='Update an item.', - body=ItemPutRequest, + body=schema.ItemPutRequest, ) -@validate(ItemPutRequest) -@run_after(save_inventories_file) +@validate(schema.ItemPutRequest) +@run_after(common.save_inventories_file) def put_item(_: Request, item_id: int, data: dict): # Cleanup the whitespace. data = remove_dict_value_whitespace(data) - update_item(item_id, data) + inventory.update_item(item_id, data) return response.empty() @bp.delete('/item/') @bp.delete('/item/') @openapi.description('Delete items from an inventory.') -@run_after(save_inventories_file) +@run_after(common.save_inventories_file) def item_delete(_: Request, item_ids: str): try: if isinstance(item_ids, int): @@ -133,5 +129,5 @@ def item_delete(_: Request, item_ids: str): except ValueError: raise ValidationError('Could not parse item_ids') - delete_items(item_ids) + inventory.delete_items(item_ids) return response.empty() diff --git a/modules/otp/api.py b/modules/otp/api.py index fa03aea3..f786f4c6 100644 --- a/modules/otp/api.py +++ b/modules/otp/api.py @@ -8,8 +8,7 @@ from sanic_ext import validate from sanic_ext.extensions.openapi import openapi from wrolpi.root_api import get_blueprint -from .common import generate_pdf, encrypt_otp, decrypt_otp -from .schema import EncryptOTPRequest, DecryptOTPRequest +from . import lib, schema bp = get_blueprint('OTP', '/api/otp') @@ -17,22 +16,22 @@ bp = get_blueprint('OTP', '/api/otp') @bp.post('/encrypt_otp') @openapi.definition( summary='Encrypt a message with OTP.', - body=EncryptOTPRequest, + body=schema.EncryptOTPRequest, ) -@validate(EncryptOTPRequest) +@validate(schema.EncryptOTPRequest) async def post_encrypt_otp(_: Request, data: dict): - data = encrypt_otp(data['otp'], data['plaintext']) + data = lib.encrypt_otp(data['otp'], data['plaintext']) return response.json(data) @bp.post('/decrypt_otp') @openapi.definition( summary='Decrypt a message with OTP.', - body=DecryptOTPRequest, + body=schema.DecryptOTPRequest, ) -@validate(DecryptOTPRequest) +@validate(schema.DecryptOTPRequest) async def post_decrypt_otp(_: Request, data: dict): - data = decrypt_otp(data['otp'], data['ciphertext']) + data = lib.decrypt_otp(data['otp'], data['ciphertext']) return response.json(data) @@ -44,5 +43,5 @@ async def get_new_otp_pdf(_: Request): 'Content-type': 'application/pdf', 'Content-Disposition': f'attachment;filename={filename}' } - contents = generate_pdf() + contents = lib.generate_pdf() return response.raw(contents, HTTPStatus.OK, headers) diff --git a/modules/otp/common.py b/modules/otp/lib.py similarity index 100% rename from modules/otp/common.py rename to modules/otp/lib.py diff --git a/modules/otp/test/test_otp.py b/modules/otp/test/test_otp.py index 42a247e6..f97ea89f 100644 --- a/modules/otp/test/test_otp.py +++ b/modules/otp/test/test_otp.py @@ -1,6 +1,6 @@ import pytest -from modules.otp.common import format_message, encrypt_otp, decrypt_otp, generate_pdf +from modules.otp.lib import format_message, encrypt_otp, decrypt_otp, generate_pdf @pytest.mark.parametrize( diff --git a/modules/videos/api.py b/modules/videos/api.py index f779f061..91a8aa7a 100644 --- a/modules/videos/api.py +++ b/modules/videos/api.py @@ -14,11 +14,9 @@ from wrolpi.root_api import add_blueprint, json_response from wrolpi.schema import JSONErrorResponse from .channel import lib as channel_lib from .channel.api import channel_bp -from .lib import _refresh_videos, get_statistics -from .schema import StreamResponse, \ - FavoriteRequest, FavoriteResponse, VideosStatisticsResponse from .video import lib as video_lib from .video.api import video_bp +from . import lib, schema content_bp = Blueprint('VideoContent', '/api/videos') bp = Blueprint('Videos', '/api/videos').group( @@ -36,7 +34,7 @@ refresh_queue, refresh_event = create_websocket_feed('refresh', '/feeds/refresh' @content_bp.post('/refresh') @content_bp.post('/refresh/') @openapi.description('Search for videos that have previously been downloaded and stored.') -@openapi.response(HTTPStatus.OK, StreamResponse) +@openapi.response(HTTPStatus.OK, schema.StreamResponse) @openapi.response(HTTPStatus.BAD_REQUEST, JSONErrorResponse) @wrol_mode_check async def refresh(_, link: str = None): @@ -74,7 +72,7 @@ download_queue, download_event = create_websocket_feed('download', '/feeds/downl @content_bp.post('/download') @content_bp.post('/download/') @openapi.description('Update channel catalogs, download any missing videos') -@openapi.response(HTTPStatus.OK, StreamResponse) +@openapi.response(HTTPStatus.OK, schema.StreamResponse) @openapi.response(HTTPStatus.BAD_REQUEST, JSONErrorResponse) @wrol_mode_check def download(_, link: str = None): @@ -93,27 +91,27 @@ def download(_, link: str = None): return response.json({'code': 'stream-started', 'stream_url': stream_url}) -@wraps(_refresh_videos) +@wraps(lib.refresh_videos) async def refresh_videos(channel_links: list = None): - return _refresh_videos(channel_links=channel_links) + return lib.refresh_videos(channel_links=channel_links) @content_bp.post('/favorite') @openapi.definition( description='Toggle the favorite flag on a video', - body=FavoriteRequest, + body=schema.FavoriteRequest, ) -@validate(FavoriteRequest) -@openapi.response(HTTPStatus.OK, FavoriteResponse) +@validate(schema.FavoriteRequest) +@openapi.response(HTTPStatus.OK, schema.FavoriteResponse) @openapi.response(HTTPStatus.BAD_REQUEST, JSONErrorResponse) -async def favorite(_: Request, body: FavoriteRequest): +async def favorite(_: Request, body: schema.FavoriteRequest): _favorite = video_lib.set_video_favorite(body.video_id, body.favorite) ret = {'video_id': body.video_id, 'favorite': _favorite} return json_response(ret, HTTPStatus.OK) @content_bp.get('/statistics') -@openapi.response(HTTPStatus.OK, VideosStatisticsResponse) +@openapi.response(HTTPStatus.OK, schema.VideosStatisticsResponse) async def statistics(_: Request): - ret = await get_statistics() + ret = await lib.get_statistics() return json_response(ret, HTTPStatus.OK) diff --git a/modules/videos/channel/api.py b/modules/videos/channel/api.py index 013f0e5a..07d8169a 100644 --- a/modules/videos/channel/api.py +++ b/modules/videos/channel/api.py @@ -10,9 +10,8 @@ from wrolpi.common import logger, wrol_mode_check, make_media_directory, \ get_media_directory from wrolpi.root_api import json_response from wrolpi.schema import JSONErrorResponse -from .lib import get_minimal_channels, delete_channel, update_channel, get_channel, create_channel -from ..schema import ChannelsResponse, ChannelResponse, ChannelPostRequest, \ - ChannelPostResponse, ChannelPutRequest +from . import lib +from .. import schema channel_bp = Blueprint('Channel', url_prefix='/api/videos/channels') @@ -21,17 +20,17 @@ logger = logger.getChild(__name__) @channel_bp.get('/') @openapi.description('Get a list of all Channels') -@openapi.response(HTTPStatus.OK, ChannelsResponse) +@openapi.response(HTTPStatus.OK, schema.ChannelsResponse) async def get_channels(_: Request): - channels = await get_minimal_channels() + channels = await lib.get_minimal_channels() return json_response({'channels': channels}) @channel_bp.get('/') @openapi.description('Get a Channel') -@openapi.response(HTTPStatus.OK, ChannelResponse) +@openapi.response(HTTPStatus.OK, schema.ChannelResponse) def channel_get(_: Request, link: str): - channel = get_channel(link=link) + channel = lib.get_channel(link=link) channel.pop('info_json') return json_response({'channel': channel}) @@ -39,18 +38,18 @@ def channel_get(_: Request, link: str): @channel_bp.post('/') @openapi.definition( description='Insert a Channel', - body=ChannelPostRequest, + body=schema.ChannelPostRequest, ) -@openapi.response(HTTPStatus.OK, ChannelPostResponse) +@openapi.response(HTTPStatus.OK, schema.ChannelPostResponse) @openapi.response(HTTPStatus.BAD_REQUEST, JSONErrorResponse) -@validate(ChannelPostRequest) +@validate(schema.ChannelPostRequest) @wrol_mode_check -def channel_post(_: Request, body: ChannelPostRequest): +def channel_post(_: Request, body: schema.ChannelPostRequest): body.directory = get_media_directory() / body.directory if not body.directory.is_dir() and body.mkdir: make_media_directory(body.directory) - channel = create_channel(body.__dict__) # TODO don't use the dataclass as a dict. + channel = lib.create_channel(body.__dict__) # TODO don't use the dataclass as a dict. # Refresh the videos asynchronously from ..api import refresh_videos @@ -64,14 +63,14 @@ def channel_post(_: Request, body: ChannelPostRequest): @channel_bp.put('/') @openapi.definition( description='Update a Channel', - body=ChannelPutRequest, + body=schema.ChannelPutRequest, ) @openapi.response(HTTPStatus.NO_CONTENT) @openapi.response(HTTPStatus.BAD_REQUEST, JSONErrorResponse) -@validate(ChannelPutRequest) +@validate(schema.ChannelPutRequest) @wrol_mode_check -def channel_update(_: Request, link: str, body: ChannelPutRequest): - channel = update_channel(body.__dict__, link) # TODO don't use the dataclass as a dict. +def channel_update(_: Request, link: str, body: schema.ChannelPutRequest): + channel = lib.update_channel(body.__dict__, link) # TODO don't use the dataclass as a dict. return response.raw('', HTTPStatus.NO_CONTENT, headers={'Location': f'/api/videos/channels/{channel.link}'}) @@ -81,5 +80,5 @@ def channel_update(_: Request, link: str, body: ChannelPutRequest): @openapi.response(HTTPStatus.NOT_FOUND, JSONErrorResponse) @wrol_mode_check def channel_delete(_: Request, link: str): - delete_channel(link) + lib.delete_channel(link) return response.raw('', HTTPStatus.NO_CONTENT) diff --git a/modules/videos/lib.py b/modules/videos/lib.py index f6cb4fab..a10fb93a 100644 --- a/modules/videos/lib.py +++ b/modules/videos/lib.py @@ -247,7 +247,7 @@ def convert_or_generate_poster(video: Video) -> Optional[pathlib.Path]: logger.error(f'Failed to generate poster for {video}', exc_info=e) -def _refresh_videos(channel_links: list = None): +def refresh_videos(channel_links: list = None): """ Find any videos in the channel directories and add them to the DB. Delete DB records of any videos not in the file system. diff --git a/modules/videos/video/api.py b/modules/videos/video/api.py index 60d83a14..7dfcf39b 100644 --- a/modules/videos/video/api.py +++ b/modules/videos/video/api.py @@ -11,11 +11,8 @@ from wrolpi.db import get_db_session from wrolpi.errors import InvalidOrderBy from wrolpi.root_api import json_response from wrolpi.schema import JSONErrorResponse -from .lib import get_video, VIDEO_ORDERS, video_search, get_video_for_app -from ..common import get_matching_directories -from ..lib import save_channels_config -from ..schema import VideoResponse, VideoSearchRequest, VideoSearchResponse, \ - DirectoriesResponse, DirectoriesRequest +from . import lib +from .. import common, schema video_bp = Blueprint('Video', '/api/videos') @@ -24,26 +21,26 @@ logger = logger.getChild(__name__) @video_bp.get('/video/') @openapi.description('Get Video information') -@openapi.response(HTTPStatus.OK, VideoResponse) +@openapi.response(HTTPStatus.OK, schema.VideoResponse) @openapi.response(HTTPStatus.NOT_FOUND, JSONErrorResponse) def video_get(_: Request, video_id: int): - video, previous_video, next_video = get_video_for_app(video_id) + video, previous_video, next_video = lib.get_video_for_app(video_id) return json_response({'video': video, 'prev': previous_video, 'next': next_video}) @video_bp.post('/search') @openapi.definition( summary='Search Video titles and captions', - body=VideoSearchRequest, + body=schema.VideoSearchRequest, ) -@openapi.response(HTTPStatus.OK, VideoSearchResponse) +@openapi.response(HTTPStatus.OK, schema.VideoSearchResponse) @openapi.response(HTTPStatus.NOT_FOUND, JSONErrorResponse) -@validate(VideoSearchRequest) -async def search(_: Request, body: VideoSearchRequest): - if body.order_by not in VIDEO_ORDERS: +@validate(schema.VideoSearchRequest) +async def search(_: Request, body: schema.VideoSearchRequest): + if body.order_by not in lib.VIDEO_ORDERS: raise InvalidOrderBy('Invalid order by') - videos, videos_total = video_search( + videos, videos_total = lib.video_search( body.search_str, body.offset, body.limit, @@ -59,14 +56,14 @@ async def search(_: Request, body: VideoSearchRequest): @video_bp.post('/directories') @openapi.definition( summary='Get all directories that match the search_str, prefixed by the media directory.', - body=DirectoriesRequest, + body=schema.DirectoriesRequest, ) -@openapi.response(HTTPStatus.OK, DirectoriesResponse) +@openapi.response(HTTPStatus.OK, schema.DirectoriesResponse) @openapi.response(HTTPStatus.NOT_FOUND, JSONErrorResponse) -@validate(DirectoriesRequest) -def directories(_, body: DirectoriesRequest): +@validate(schema.DirectoriesRequest) +def directories(_, body: schema.DirectoriesRequest): search_str = str(get_media_directory() / (body.search_str or '')) - dirs = get_matching_directories(search_str) + dirs = common.get_matching_directories(search_str) dirs = [str(get_relative_to_media_directory(i)) for i in dirs] return response.json({'directories': dirs}) @@ -76,9 +73,9 @@ def directories(_, body: DirectoriesRequest): @openapi.response(HTTPStatus.NO_CONTENT) @openapi.response(HTTPStatus.NOT_FOUND, JSONErrorResponse) @wrol_mode_check -@run_after(save_channels_config) +@run_after(lib.save_channels_config) def video_delete(_: Request, video_id: int): with get_db_session(commit=True) as session: - video = get_video(session, video_id) + video = lib.get_video(session, video_id) video.delete() return response.raw('', HTTPStatus.NO_CONTENT)