From b6ec4cb577d5a5048e5f675e6da99e6dc265884c Mon Sep 17 00:00:00 2001 From: cproudlock Date: Fri, 26 Jun 2026 20:50:32 -0400 Subject: [PATCH] Extract slideshow into a plugin (blueprint-only display plugin) Second core feature pulled into a plugin. Slides is the minimal plugin shape: a blueprint only - no model, no AssetType, no nav (it is purely an API surface consumed by the TV dashboard). - plugins/slides/: manifest (api_prefix /api/slides, no deps), api/ (moved blueprint, contract-pure imports via shopdb.api, same /api/slides route so the TV dashboard is unchanged), plugin.py (get_blueprint, get_models -> []). - Fixed a latent bug in the move: error path used ErrorCodes.SERVER_ERROR which does not exist -> ErrorCodes.INTERNAL_ERROR. - De-cored: deleted shopdb/core/api/slides.py, removed from CORE_BLUEPRINT_NAMES + core/api/__init__ import/__all__. Registered in instance/plugins.json. Pinned with a characterization test first; passes unchanged against the plugin blueprint. 174 tests pass, naming green, app boots 8 bundled plugins, /api/slides verified live. Note: the shopfloor dashboard is NOT extractable - it is a frontend-only Vue view aggregating the businessunits + notifications APIs, with no backend to move and no frontend plugin system. Co-Authored-By: Claude Opus 4.8 --- plugins/slides/__init__.py | 5 + plugins/slides/api/__init__.py | 5 + .../slides.py => plugins/slides/api/routes.py | 145 +++++++++--------- plugins/slides/manifest.json | 12 ++ plugins/slides/plugin.py | 62 ++++++++ shopdb/__init__.py | 1 - shopdb/core/api/__init__.py | 2 - tests/test_core/test_slides.py | 14 ++ tests/test_plugin_contract.py | 2 +- tests/test_smoke.py | 1 + 10 files changed, 171 insertions(+), 78 deletions(-) create mode 100644 plugins/slides/__init__.py create mode 100644 plugins/slides/api/__init__.py rename shopdb/core/api/slides.py => plugins/slides/api/routes.py (82%) create mode 100644 plugins/slides/manifest.json create mode 100644 plugins/slides/plugin.py create mode 100644 tests/test_core/test_slides.py diff --git a/plugins/slides/__init__.py b/plugins/slides/__init__.py new file mode 100644 index 0000000..86e8787 --- /dev/null +++ b/plugins/slides/__init__.py @@ -0,0 +1,5 @@ +"""Slides plugin package.""" + +from .plugin import SlidesPlugin + +__all__ = ['SlidesPlugin'] diff --git a/plugins/slides/api/__init__.py b/plugins/slides/api/__init__.py new file mode 100644 index 0000000..74cc348 --- /dev/null +++ b/plugins/slides/api/__init__.py @@ -0,0 +1,5 @@ +"""Slides plugin API.""" + +from .routes import slides_bp + +__all__ = ['slides_bp'] diff --git a/shopdb/core/api/slides.py b/plugins/slides/api/routes.py similarity index 82% rename from shopdb/core/api/slides.py rename to plugins/slides/api/routes.py index 69e8801..7c27b03 100644 --- a/shopdb/core/api/slides.py +++ b/plugins/slides/api/routes.py @@ -1,74 +1,71 @@ -"""Slides API for TV dashboard slideshow.""" - -import os -from flask import Blueprint, current_app -from shopdb.utils.responses import success_response, error_response, ErrorCodes - -slides_bp = Blueprint('slides', __name__) - -# Valid image extensions -VALID_EXTENSIONS = {'.jpg', '.jpeg', '.png', '.gif', '.bmp', '.webp'} - - -@slides_bp.route('', methods=['GET']) -def get_slides(): - """ - Get list of slides for TV dashboard. - - Returns image files from the static/slides directory. - """ - # Look for slides in static folder - static_folder = current_app.static_folder - if not static_folder: - static_folder = os.path.join(current_app.root_path, 'static') - - slides_folder = os.path.join(static_folder, 'slides') - - # Also check frontend public folder - frontend_slides = os.path.join( - os.path.dirname(os.path.dirname(os.path.dirname(current_app.root_path))), - 'frontend', 'public', 'slides' - ) - - # Try multiple possible locations - possible_paths = [ - slides_folder, - frontend_slides, - '/home/camp/projects/shopdb-flask/shopdb/static/slides', - '/home/camp/projects/shopdb-flask/frontend/public/slides', - ] - - slides_path = None - for path in possible_paths: - if os.path.isdir(path): - slides_path = path - break - - if not slides_path: - return success_response({ - 'slides': [], - 'basepath': '/static/slides/', - 'message': 'Slides folder not found' - }) - - # Get list of image files - slides = [] - try: - for filename in sorted(os.listdir(slides_path)): - ext = os.path.splitext(filename)[1].lower() - if ext in VALID_EXTENSIONS: - slides.append({'filename': filename}) - except Exception as e: - return error_response( - ErrorCodes.SERVER_ERROR, - f'Error reading slides: {str(e)}', - http_code=500 - ) - - # Determine base path for serving files - basepath = '/static/slides/' - - return success_response({ - 'slides': slides, - 'basepath': basepath - }) +"""Slides API for the TV dashboard slideshow.""" + +import os +from flask import Blueprint, current_app + +from shopdb.api import success_response, error_response, ErrorCodes + +slides_bp = Blueprint('slides', __name__) + +# Valid image extensions +VALID_EXTENSIONS = {'.jpg', '.jpeg', '.png', '.gif', '.bmp', '.webp'} + + +@slides_bp.route('', methods=['GET']) +def get_slides(): + """Get list of slides for the TV dashboard. + + Returns image files from the static/slides directory. + """ + # Look for slides in static folder + static_folder = current_app.static_folder + if not static_folder: + static_folder = os.path.join(current_app.root_path, 'static') + + slides_folder = os.path.join(static_folder, 'slides') + + # Also check frontend public folder + frontend_slides = os.path.join( + os.path.dirname(os.path.dirname(os.path.dirname(current_app.root_path))), + 'frontend', 'public', 'slides' + ) + + # Try multiple possible locations + possible_paths = [ + slides_folder, + frontend_slides, + '/home/camp/projects/shopdb-flask/shopdb/static/slides', + '/home/camp/projects/shopdb-flask/frontend/public/slides', + ] + + slides_path = None + for path in possible_paths: + if os.path.isdir(path): + slides_path = path + break + + if not slides_path: + return success_response({ + 'slides': [], + 'basepath': '/static/slides/', + 'message': 'Slides folder not found' + }) + + # Get list of image files + slides = [] + try: + for filename in sorted(os.listdir(slides_path)): + ext = os.path.splitext(filename)[1].lower() + if ext in VALID_EXTENSIONS: + slides.append({'filename': filename}) + except Exception as e: + return error_response( + ErrorCodes.INTERNAL_ERROR, + f'Error reading slides: {str(e)}', + http_code=500 + ) + + return success_response({ + 'slides': slides, + 'basepath': '/static/slides/' + }) diff --git a/plugins/slides/manifest.json b/plugins/slides/manifest.json new file mode 100644 index 0000000..32a34c8 --- /dev/null +++ b/plugins/slides/manifest.json @@ -0,0 +1,12 @@ +{ + "name": "slides", + "version": "1.0.0", + "description": "TV dashboard slideshow images served from a static folder", + "author": "ShopDB Team", + "dependencies": [], + "core_version": ">=0.1.0,<1.0.0", + "api_prefix": "/api/slides", + "provides": { + "features": ["slideshow"] + } +} diff --git a/plugins/slides/plugin.py b/plugins/slides/plugin.py new file mode 100644 index 0000000..3aae8bf --- /dev/null +++ b/plugins/slides/plugin.py @@ -0,0 +1,62 @@ +"""Slides plugin main class. + +Display/service plugin: contributes a blueprint only (no model, no AssetType, +no nav). Serves TV-dashboard slideshow images. Demonstrates the minimal plugin +shape - a feature that is purely an API surface. +""" + +import json +import logging +from pathlib import Path +from typing import List, Dict, Optional, Type + +from flask import Flask, Blueprint + +from shopdb.plugins.base import BasePlugin, PluginMeta + +from .api import slides_bp + +logger = logging.getLogger(__name__) + + +class SlidesPlugin(BasePlugin): + """Slides plugin - TV dashboard slideshow images.""" + + def __init__(self): + self._manifest = self._load_manifest() + + def _load_manifest(self) -> Dict: + """Load plugin manifest from JSON file.""" + manifest_path = Path(__file__).parent / 'manifest.json' + if manifest_path.exists(): + with open(manifest_path, 'r') as f: + return json.load(f) + return {} + + @property + def meta(self) -> PluginMeta: + """Return plugin metadata.""" + return PluginMeta( + name=self._manifest.get('name', 'slides'), + version=self._manifest.get('version', '1.0.0'), + description=self._manifest.get( + 'description', + 'TV dashboard slideshow images' + ), + author=self._manifest.get('author', 'ShopDB Team'), + dependencies=self._manifest.get('dependencies', []), + core_version=self._manifest.get('core_version', '>=0.1.0,<1.0.0'), + api_prefix=self._manifest.get('api_prefix', '/api/slides'), + ) + + def get_blueprint(self) -> Optional[Blueprint]: + """Return Flask Blueprint with API routes.""" + return slides_bp + + def get_models(self) -> List[Type]: + """No models - slides are read from the filesystem.""" + return [] + + def init_app(self, app: Flask, db_instance) -> None: + """Initialize plugin with Flask app.""" + logger.info(f"Slides plugin initialized (v{self.meta.version})") diff --git a/shopdb/__init__.py b/shopdb/__init__.py index 89daaff..cd4a803 100644 --- a/shopdb/__init__.py +++ b/shopdb/__init__.py @@ -106,7 +106,6 @@ CORE_BLUEPRINT_NAMES = ( 'reports', 'collector', 'employees', - 'slides', 'settings', 'auditlogs', 'users', diff --git a/shopdb/core/api/__init__.py b/shopdb/core/api/__init__.py index 8b55dd3..97b049d 100644 --- a/shopdb/core/api/__init__.py +++ b/shopdb/core/api/__init__.py @@ -15,7 +15,6 @@ from .search import search_bp from .reports import reports_bp from .collector import collector_bp from .employees import employees_bp -from .slides import slides_bp from .settings import settings_bp from .auditlogs import auditlogs_bp from .users import users_bp @@ -36,7 +35,6 @@ __all__ = [ 'reports_bp', 'collector_bp', 'employees_bp', - 'slides_bp', 'settings_bp', 'auditlogs_bp', 'users_bp', diff --git a/tests/test_core/test_slides.py b/tests/test_core/test_slides.py new file mode 100644 index 0000000..ff7aeb0 --- /dev/null +++ b/tests/test_core/test_slides.py @@ -0,0 +1,14 @@ +"""Characterization test for the slides (TV slideshow) endpoint. + +Written before extracting slides into a plugin: /api/slides must behave +identically as a plugin blueprint (same prefix, same response shape). +""" + + +def test_slides_endpoint_shape(client, db): + """GET /api/slides returns a slides list and a basepath (no auth required).""" + resp = client.get('/api/slides') + assert resp.status_code == 200 + data = resp.get_json()['data'] + assert isinstance(data['slides'], list) + assert 'basepath' in data diff --git a/tests/test_plugin_contract.py b/tests/test_plugin_contract.py index 3d37732..3b39101 100644 --- a/tests/test_plugin_contract.py +++ b/tests/test_plugin_contract.py @@ -17,7 +17,7 @@ from shopdb.plugins import plugin_manager from shopdb.plugins.base import BasePlugin, PluginMeta -BUNDLED_PLUGINS = ('computers', 'equipment', 'knowledgebase', 'network', 'notifications', 'printers', 'usb') +BUNDLED_PLUGINS = ('computers', 'equipment', 'knowledgebase', 'network', 'notifications', 'printers', 'slides', 'usb') @pytest.fixture diff --git a/tests/test_smoke.py b/tests/test_smoke.py index 392e4bf..6477f42 100644 --- a/tests/test_smoke.py +++ b/tests/test_smoke.py @@ -99,6 +99,7 @@ def test_plugin_loader_discovers_bundled_plugins(app): 'network', 'notifications', 'printers', + 'slides', 'usb', }