Enforce plugin contract purity: single import surface via shopdb.api
Plugins were reaching into internal core paths (shopdb.core.models.*, shopdb.extensions, shopdb.utils.*), coupling them to core's file layout and violating the ADR-001 contract. Consolidate onto one versioned surface. - shopdb.api: expand from 2 helpers to the full plugin import surface - db, cache; BaseModel, AuditMixin; core models (Asset, AssetType, AssetStatus, Vendor, Model, Communication, CommunicationType, Location, Setting, AuditLog, Application, AppVersion, OperatingSystem); response + pagination helpers; employee_connection. Documented in PLUGIN-HOOKS.md. - Migrate all 22 plugin source files to import only from shopdb.api (plus shopdb.plugins.base for the ABC). - Drop the printers plugin's legacy MachineType dependency: remove _ensure_legacy_machine_types and the seed_supplies machinetypeid lookup (Model.machinetypeid is nullable; printers carry type via PrinterType). - Guard test test_plugins_only_import_contract_surface scans plugin source and fails on any core import outside shopdb.api / shopdb.plugins.base. - Scaffold templates updated so generated plugins are contract-pure. - Bump __contract_version__ 0.2.0 -> 0.3.0 (additive surface expansion; manifests pin <1.0.0 so they still satisfy). 145 tests pass, naming/style green, app factory boots all 6 plugins. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
This commit is contained in:
cproudlock
@@ -4,15 +4,7 @@ from flask import Blueprint, request
|
||||
from flask_jwt_extended import jwt_required, get_jwt_identity
|
||||
from datetime import datetime
|
||||
|
||||
from shopdb.extensions import db
|
||||
from shopdb.core.models import AuditLog
|
||||
from shopdb.utils.responses import (
|
||||
success_response,
|
||||
error_response,
|
||||
paginated_response,
|
||||
ErrorCodes
|
||||
)
|
||||
from shopdb.utils.pagination import get_pagination_params, paginate_query
|
||||
from shopdb.api import db, AuditLog, success_response, error_response, paginated_response, ErrorCodes, get_pagination_params, paginate_query
|
||||
|
||||
from ..models import USBDevice, USBDeviceType, USBCheckout
|
||||
|
||||
|
||||
@@ -1,167 +1,166 @@
|
||||
"""USB device plugin models."""
|
||||
|
||||
from datetime import datetime
|
||||
from shopdb.extensions import db
|
||||
from shopdb.core.models.base import BaseModel, AuditMixin
|
||||
|
||||
|
||||
class USBDeviceType(BaseModel):
|
||||
"""
|
||||
USB device type classification.
|
||||
|
||||
Examples: Flash Drive, External HDD, External SSD, Card Reader
|
||||
"""
|
||||
__tablename__ = 'usbdevicetypes'
|
||||
|
||||
usbdevicetypeid = db.Column(db.Integer, primary_key=True)
|
||||
typename = db.Column(db.String(50), unique=True, nullable=False)
|
||||
description = db.Column(db.Text)
|
||||
icon = db.Column(db.String(50), default='usb', comment='Icon name for UI')
|
||||
|
||||
def __repr__(self):
|
||||
return f"<USBDeviceType {self.typename}>"
|
||||
|
||||
|
||||
class USBDevice(BaseModel, AuditMixin):
|
||||
"""
|
||||
USB device model.
|
||||
|
||||
Tracks USB storage devices that can be checked out by users.
|
||||
"""
|
||||
__tablename__ = 'usbdevices'
|
||||
|
||||
usbdeviceid = db.Column(db.Integer, primary_key=True)
|
||||
|
||||
# Identification
|
||||
serialnumber = db.Column(db.String(100), unique=True, nullable=False)
|
||||
label = db.Column(db.String(100), nullable=True, comment='Human-readable label')
|
||||
assetnumber = db.Column(db.String(50), nullable=True, comment='Optional asset tag')
|
||||
|
||||
# Classification
|
||||
usbdevicetypeid = db.Column(
|
||||
db.Integer,
|
||||
db.ForeignKey('usbdevicetypes.usbdevicetypeid'),
|
||||
nullable=True
|
||||
)
|
||||
|
||||
# Specifications
|
||||
capacitygb = db.Column(db.Integer, nullable=True, comment='Capacity in GB')
|
||||
vendorid = db.Column(db.String(10), nullable=True, comment='USB Vendor ID (hex)')
|
||||
productid = db.Column(db.String(10), nullable=True, comment='USB Product ID (hex)')
|
||||
manufacturer = db.Column(db.String(100), nullable=True)
|
||||
productname = db.Column(db.String(100), nullable=True)
|
||||
|
||||
# Current status
|
||||
ischeckedout = db.Column(db.Boolean, default=False)
|
||||
currentuserid = db.Column(db.String(50), nullable=True, comment='SSO of current user')
|
||||
currentusername = db.Column(db.String(100), nullable=True, comment='Name of current user')
|
||||
currentcheckoutdate = db.Column(db.DateTime, nullable=True)
|
||||
|
||||
# Location
|
||||
storagelocation = db.Column(db.String(200), nullable=True, comment='Where device is stored when not checked out')
|
||||
|
||||
# Security
|
||||
pin = db.Column(db.String(50), nullable=True, comment='PIN for encrypted devices')
|
||||
|
||||
# Notes
|
||||
notes = db.Column(db.Text, nullable=True)
|
||||
|
||||
# Relationships
|
||||
devicetype = db.relationship('USBDeviceType', backref='devices')
|
||||
|
||||
# Indexes
|
||||
__table_args__ = (
|
||||
db.Index('idx_usb_serial', 'serialnumber'),
|
||||
db.Index('idx_usb_checkedout', 'ischeckedout'),
|
||||
db.Index('idx_usb_type', 'usbdevicetypeid'),
|
||||
db.Index('idx_usb_currentuser', 'currentuserid'),
|
||||
)
|
||||
|
||||
def __repr__(self):
|
||||
return f"<USBDevice {self.label or self.serialnumber}>"
|
||||
|
||||
@property
|
||||
def display_name(self):
|
||||
"""Get display name (label if set, otherwise serial number)."""
|
||||
return self.label or self.serialnumber
|
||||
|
||||
def to_dict(self):
|
||||
"""Convert to dictionary with related data."""
|
||||
result = super().to_dict()
|
||||
|
||||
# Add type info
|
||||
if self.devicetype:
|
||||
result['typename'] = self.devicetype.typename
|
||||
result['typeicon'] = self.devicetype.icon
|
||||
|
||||
# Add computed property
|
||||
result['displayname'] = self.display_name
|
||||
|
||||
return result
|
||||
|
||||
|
||||
class USBCheckout(BaseModel):
|
||||
"""
|
||||
USB device checkout history.
|
||||
|
||||
Tracks when devices are checked out and returned.
|
||||
Maps to existing usbcheckouts table from classic ShopDB.
|
||||
"""
|
||||
__tablename__ = 'usbcheckouts'
|
||||
|
||||
checkoutid = db.Column(db.Integer, primary_key=True)
|
||||
|
||||
# Device reference (new column linking to usbdevices table)
|
||||
usbdeviceid = db.Column(
|
||||
db.Integer,
|
||||
db.ForeignKey('usbdevices.usbdeviceid', ondelete='CASCADE'),
|
||||
nullable=True
|
||||
)
|
||||
|
||||
# Legacy reference to machines table (kept for backward compatibility)
|
||||
machineid = db.Column(db.Integer, nullable=False)
|
||||
|
||||
# User info
|
||||
sso = db.Column(db.String(20), nullable=False, comment='SSO of user')
|
||||
checkoutname = db.Column(db.String(100), nullable=True, comment='Name of user')
|
||||
|
||||
# Checkout details
|
||||
checkouttime = db.Column(db.DateTime, nullable=False, default=datetime.utcnow)
|
||||
checkintime = db.Column(db.DateTime, nullable=True)
|
||||
|
||||
# Metadata
|
||||
checkoutreason = db.Column(db.Text, nullable=True, comment='Reason for checkout')
|
||||
checkinnotes = db.Column(db.Text, nullable=True)
|
||||
waswiped = db.Column(db.Boolean, nullable=True, comment='Was device wiped after return')
|
||||
|
||||
# Relationships
|
||||
device = db.relationship('USBDevice', backref=db.backref('checkouts', lazy='dynamic'))
|
||||
|
||||
def __repr__(self):
|
||||
return f"<USBCheckout device={self.usbdeviceid} user={self.sso}>"
|
||||
|
||||
@property
|
||||
def is_active(self):
|
||||
"""Check if this checkout is currently active (not returned)."""
|
||||
return self.checkintime is None
|
||||
|
||||
@property
|
||||
def duration_days(self):
|
||||
"""Get duration of checkout in days."""
|
||||
end = self.checkintime or datetime.utcnow()
|
||||
delta = end - self.checkouttime
|
||||
return delta.days
|
||||
|
||||
def to_dict(self):
|
||||
"""Convert to dictionary with computed fields."""
|
||||
result = super().to_dict()
|
||||
|
||||
result['isactivecheckout'] = self.is_active
|
||||
result['durationdays'] = self.duration_days
|
||||
|
||||
# Add device info if loaded
|
||||
if self.device:
|
||||
result['devicelabel'] = self.device.label
|
||||
result['deviceserialnumber'] = self.device.serialnumber
|
||||
|
||||
return result
|
||||
"""USB device plugin models."""
|
||||
|
||||
from datetime import datetime
|
||||
from shopdb.api import db, BaseModel, AuditMixin
|
||||
|
||||
|
||||
class USBDeviceType(BaseModel):
|
||||
"""
|
||||
USB device type classification.
|
||||
|
||||
Examples: Flash Drive, External HDD, External SSD, Card Reader
|
||||
"""
|
||||
__tablename__ = 'usbdevicetypes'
|
||||
|
||||
usbdevicetypeid = db.Column(db.Integer, primary_key=True)
|
||||
typename = db.Column(db.String(50), unique=True, nullable=False)
|
||||
description = db.Column(db.Text)
|
||||
icon = db.Column(db.String(50), default='usb', comment='Icon name for UI')
|
||||
|
||||
def __repr__(self):
|
||||
return f"<USBDeviceType {self.typename}>"
|
||||
|
||||
|
||||
class USBDevice(BaseModel, AuditMixin):
|
||||
"""
|
||||
USB device model.
|
||||
|
||||
Tracks USB storage devices that can be checked out by users.
|
||||
"""
|
||||
__tablename__ = 'usbdevices'
|
||||
|
||||
usbdeviceid = db.Column(db.Integer, primary_key=True)
|
||||
|
||||
# Identification
|
||||
serialnumber = db.Column(db.String(100), unique=True, nullable=False)
|
||||
label = db.Column(db.String(100), nullable=True, comment='Human-readable label')
|
||||
assetnumber = db.Column(db.String(50), nullable=True, comment='Optional asset tag')
|
||||
|
||||
# Classification
|
||||
usbdevicetypeid = db.Column(
|
||||
db.Integer,
|
||||
db.ForeignKey('usbdevicetypes.usbdevicetypeid'),
|
||||
nullable=True
|
||||
)
|
||||
|
||||
# Specifications
|
||||
capacitygb = db.Column(db.Integer, nullable=True, comment='Capacity in GB')
|
||||
vendorid = db.Column(db.String(10), nullable=True, comment='USB Vendor ID (hex)')
|
||||
productid = db.Column(db.String(10), nullable=True, comment='USB Product ID (hex)')
|
||||
manufacturer = db.Column(db.String(100), nullable=True)
|
||||
productname = db.Column(db.String(100), nullable=True)
|
||||
|
||||
# Current status
|
||||
ischeckedout = db.Column(db.Boolean, default=False)
|
||||
currentuserid = db.Column(db.String(50), nullable=True, comment='SSO of current user')
|
||||
currentusername = db.Column(db.String(100), nullable=True, comment='Name of current user')
|
||||
currentcheckoutdate = db.Column(db.DateTime, nullable=True)
|
||||
|
||||
# Location
|
||||
storagelocation = db.Column(db.String(200), nullable=True, comment='Where device is stored when not checked out')
|
||||
|
||||
# Security
|
||||
pin = db.Column(db.String(50), nullable=True, comment='PIN for encrypted devices')
|
||||
|
||||
# Notes
|
||||
notes = db.Column(db.Text, nullable=True)
|
||||
|
||||
# Relationships
|
||||
devicetype = db.relationship('USBDeviceType', backref='devices')
|
||||
|
||||
# Indexes
|
||||
__table_args__ = (
|
||||
db.Index('idx_usb_serial', 'serialnumber'),
|
||||
db.Index('idx_usb_checkedout', 'ischeckedout'),
|
||||
db.Index('idx_usb_type', 'usbdevicetypeid'),
|
||||
db.Index('idx_usb_currentuser', 'currentuserid'),
|
||||
)
|
||||
|
||||
def __repr__(self):
|
||||
return f"<USBDevice {self.label or self.serialnumber}>"
|
||||
|
||||
@property
|
||||
def display_name(self):
|
||||
"""Get display name (label if set, otherwise serial number)."""
|
||||
return self.label or self.serialnumber
|
||||
|
||||
def to_dict(self):
|
||||
"""Convert to dictionary with related data."""
|
||||
result = super().to_dict()
|
||||
|
||||
# Add type info
|
||||
if self.devicetype:
|
||||
result['typename'] = self.devicetype.typename
|
||||
result['typeicon'] = self.devicetype.icon
|
||||
|
||||
# Add computed property
|
||||
result['displayname'] = self.display_name
|
||||
|
||||
return result
|
||||
|
||||
|
||||
class USBCheckout(BaseModel):
|
||||
"""
|
||||
USB device checkout history.
|
||||
|
||||
Tracks when devices are checked out and returned.
|
||||
Maps to existing usbcheckouts table from classic ShopDB.
|
||||
"""
|
||||
__tablename__ = 'usbcheckouts'
|
||||
|
||||
checkoutid = db.Column(db.Integer, primary_key=True)
|
||||
|
||||
# Device reference (new column linking to usbdevices table)
|
||||
usbdeviceid = db.Column(
|
||||
db.Integer,
|
||||
db.ForeignKey('usbdevices.usbdeviceid', ondelete='CASCADE'),
|
||||
nullable=True
|
||||
)
|
||||
|
||||
# Legacy reference to machines table (kept for backward compatibility)
|
||||
machineid = db.Column(db.Integer, nullable=False)
|
||||
|
||||
# User info
|
||||
sso = db.Column(db.String(20), nullable=False, comment='SSO of user')
|
||||
checkoutname = db.Column(db.String(100), nullable=True, comment='Name of user')
|
||||
|
||||
# Checkout details
|
||||
checkouttime = db.Column(db.DateTime, nullable=False, default=datetime.utcnow)
|
||||
checkintime = db.Column(db.DateTime, nullable=True)
|
||||
|
||||
# Metadata
|
||||
checkoutreason = db.Column(db.Text, nullable=True, comment='Reason for checkout')
|
||||
checkinnotes = db.Column(db.Text, nullable=True)
|
||||
waswiped = db.Column(db.Boolean, nullable=True, comment='Was device wiped after return')
|
||||
|
||||
# Relationships
|
||||
device = db.relationship('USBDevice', backref=db.backref('checkouts', lazy='dynamic'))
|
||||
|
||||
def __repr__(self):
|
||||
return f"<USBCheckout device={self.usbdeviceid} user={self.sso}>"
|
||||
|
||||
@property
|
||||
def is_active(self):
|
||||
"""Check if this checkout is currently active (not returned)."""
|
||||
return self.checkintime is None
|
||||
|
||||
@property
|
||||
def duration_days(self):
|
||||
"""Get duration of checkout in days."""
|
||||
end = self.checkintime or datetime.utcnow()
|
||||
delta = end - self.checkouttime
|
||||
return delta.days
|
||||
|
||||
def to_dict(self):
|
||||
"""Convert to dictionary with computed fields."""
|
||||
result = super().to_dict()
|
||||
|
||||
result['isactivecheckout'] = self.is_active
|
||||
result['durationdays'] = self.duration_days
|
||||
|
||||
# Add device info if loaded
|
||||
if self.device:
|
||||
result['devicelabel'] = self.device.label
|
||||
result['deviceserialnumber'] = self.device.serialnumber
|
||||
|
||||
return result
|
||||
|
||||
@@ -8,7 +8,7 @@ from typing import List, Dict, Optional, Type
|
||||
from flask import Flask, Blueprint
|
||||
|
||||
from shopdb.plugins.base import BasePlugin, PluginMeta
|
||||
from shopdb.extensions import db
|
||||
from shopdb.api import db
|
||||
|
||||
from .models import USBDevice, USBDeviceType, USBCheckout
|
||||
from .api import usb_bp
|
||||
|
||||
Reference in New Issue
Block a user