starting on #82

paperboy/config/application.py

@@ -138,7 +138,7 @@ def _validate_auth(self, proposed):
     ##################
     # Output         #
     ##################
-    output = Instance(klass=LocalOutputConfig, args=(), kwargs={})
+    output = Instance(klass=LocalOutputConfig, args=(), kwargs={})  # TODO make configurable
     ##################
 
     def start(self):

paperboy/config/storage.py

@@ -1,5 +1,5 @@
 from traitlets import HasTraits, Unicode, Bool
-from ..storage.sqla import UserSQLStorage, NotebookSQLStorage, JobSQLStorage, ReportSQLStorage
+from ..storage.sqla import UserSQLStorage, NotebookSQLStorage, JobSQLStorage, ReportSQLStorage, OutputSQLStorage
 
 
 class StorageConfig(HasTraits):
@@ -23,3 +23,4 @@ class SQLAStorageConfig(StorageConfig):
     notebook_storage = NotebookSQLStorage
     job_storage = JobSQLStorage
     report_storage = ReportSQLStorage
+    output_storage = OutputSQLStorage

paperboy/server/api.py

@@ -25,7 +25,11 @@ def from_api(url):
     ###########
     # Storage #
     ###########
-    db = StorageEngine(config.storage.user_storage(config), config.storage.notebook_storage(config), config.storage.job_storage(config), config.storage.report_storage(config))
+    db = StorageEngine(config.storage.user_storage(config),
+                       config.storage.notebook_storage(config),
+                       config.storage.job_storage(config),
+                       config.storage.report_storage(config),
+                       config.storage.output_storage(config))
     api = falcon.API(middleware=[config.auth_required_middleware(config, db),
                                  config.load_user_middleware(config, db)] +
                      config.essential_middleware +

paperboy/storage/base.py

@@ -81,3 +81,8 @@ class ReportStorage(BaseStorage):
     def generate(self, *args, **kwargs):
         '''Generate reports from Job instance and JSONL papermill parameters'''
         pass
+
+
+class OutputStorage(BaseStorage):
+    '''Base class for Output storage. Output backends should inherit from this class'''
+    pass

paperboy/storage/manager.py

@@ -11,20 +11,23 @@ class StorageEngine(object):
     notebooks = property(lambda self: self._notebook_storage)
     jobs = property(lambda self: self._job_storage)
     reports = property(lambda self: self._report_storage)
+    outputs = property(lambda self: self._output_storage)
     ################################
 
-    def __init__(self, user_storage, notebook_storage, job_storage, report_storage):
+    def __init__(self, user_storage, notebook_storage, job_storage, report_storage, output_storage):
         # resources get with self.db
         self._user_storage = user_storage
         self._notebook_storage = notebook_storage
         self._job_storage = job_storage
         self._report_storage = report_storage
+        self._output_storage = output_storage
 
         # storage classes get with self.db
         self._user_storage.db = self
         self._notebook_storage.db = self
         self._job_storage.db = self
         self._report_storage.db = self
+        self._output_storage.db = self
 
     def get_things(self, marker, limit):
         return [{'id': str(uuid.uuid4()), 'color': 'green'}]

paperboy/storage/sqla/__init__.py

@@ -1,5 +1,6 @@
 from .models.base import Base  # noqa: F401
 from .job import JobSQLStorage  # noqa: F401
 from .notebook import NotebookSQLStorage  # noqa: F401
+from .output import OutputSQLStorage  # noqa: F401
 from .report import ReportSQLStorage  # noqa: F401
 from .user import UserSQLStorage  # noqa: F401

paperboy/storage/sqla/models/report.py

@@ -19,6 +19,8 @@ class ReportSQL(Base):
     jobId = Column(Integer, ForeignKey('jobs.id', ondelete='cascade'))
     job = relationship('JobSQL', back_populates='reports')
 
+    outputs = relationship('OutputSQL', cascade='all,delete,delete-orphan', back_populates='report')
+
     parameters = Column(String)
     type = Column(String)
     output = Column(String)

paperboy/storage/sqla/output.py

@@ -0,0 +1,62 @@
+import logging
+from datetime import datetime
+from paperboy.config import OutputConfig
+from paperboy.storage import OutputStorage
+from .base import BaseSQLStorageMixin, justid
+from .models.report import ReportSQL
+from .models.output import OutputSQL
+
+
+class OutputSQLStorage(BaseSQLStorageMixin, OutputStorage):
+    def status(self, user, params, session, *args, **kwargs):
+        base = session.query(OutputSQL) \
+            .filter(OutputSQL.userId == int(user.id))
+        return {'total': base.count()}
+
+    def form(self):
+        '''Pass through to shared method in BaseSQLStorageMixin'''
+        return self._form(OutputConfig)
+
+    def search(self, user, params, session, *args, **kwargs):
+        '''Pass through to shared method in BaseSQLStorageMixin'''
+        return self._search(OutputSQL, 'Output', user, params, session, *args, **kwargs)
+
+    def list(self, user, params, session, *args, **kwargs):
+        '''Pass through to shared method in BaseSQLStorageMixin'''
+        return self._list(OutputSQL, 'outputs', user, params, session, *args, **kwargs)
+
+    def detail(self, user, params, session, *args, **kwargs):
+        '''Pass through to shared method in BaseSQLStorageMixin'''
+        return self._detail(OutputSQL, user, params, session, *args, **kwargs)
+
+    def store(self, user, params, session, *args, **kwargs):
+        name = params.get('name')
+        reportid = params.get('report')
+        data = params.get('data')
+        report = session.query(ReportSQL).get(int(justid(reportid)))
+
+        created = datetime.now()
+
+        op = OutputSQL(name=name,
+                       reportId=reportid,
+                       report=report,
+                       created=created,
+                       data=data)
+
+        session.add(op)
+
+        # generate id
+        session.flush()
+        session.refresh(op)
+
+        store = op.to_config(self.config).store()
+        logging.critical("Storing output {}".format(op))
+        return store
+
+    def delete(self, user, params, session, *args, **kwargs):
+        # TODO only if allowed
+        id = justid(params.get('id'))
+        op = session.query(OutputSQL).filter(OutputSQL.id == id).first()
+        session.delete(op)
+        return [{"name": "", "type": "p", "value": "Success!", "required": False, "readonly": False, "hidden": False},
+                {"name": "", "type": "p", "value": "Successfully deleted output: " + id, "required": False, "readonly": False, "hidden": False}]

src/ts/define.ts

@@ -24,6 +24,10 @@ const COMMANDS = {
   browseReports: "browse-reports",
   newReport: "new-report",
 
+  // outputs
+  openOutputs: "open-output",
+  browseOutputs: "browse-outputs",
+
   // status
   openStatus: "open-status",
 
@@ -52,6 +56,10 @@ const COMMAND_ICONS = {
   browseReports: "fa fa-envelope",
   newReport: "fa fa-plus",
 
+  // outputs
+  openOutput: "fa fa-address-card",
+  browseOutputs: "fa fa-address-card",
+
   // status
   openStatus: "fa fa-clock-o",
 
@@ -80,6 +88,10 @@ const COMMAND_LABELS = {
   browseReports: "Browse Reports",
   newReport: "Add Report",
 
+  // outputs
+  openOutput: "Open Output",
+  browseOutputs: "Browse Outputs",
+
   // status
   openStatus: "Open Status",
 };

src/ts/main.ts

@@ -2,7 +2,7 @@ import {DockPanel, MenuBar, Widget} from "@phosphor/widgets";
 
 import "../src/style/index.css";
 import {hideLoader, showLoader} from "./utils/index";
-import {Browser, buildMenus, Header, Jobs, Notebooks, Reports, Status} from "./views/index";
+import {Browser, buildMenus, Header, Jobs, Notebooks, Reports, Outputs, Status} from "./views/index";
 
 export
 function main(): void {
@@ -25,8 +25,11 @@ function main(): void {
   const jobs = new Jobs(main, status);
   /* Create Reports page */
   const reports = new Reports(main, status);
+  /* Create Outputs page */
+  const outputs = new Outputs(main, status);
+
   /* Create Search browser page */
-  const browser = new Browser(notebooks, jobs, reports, status);
+  const browser = new Browser(notebooks, jobs, reports, outputs, status);
 
   browser.title.label = "Home";
   browser.title.closable = true;
@@ -44,6 +47,7 @@ function main(): void {
     main,
     notebooks,
     reports,
+    outputs,
     status,
   });
 

src/ts/views/browser.ts

@@ -6,7 +6,11 @@ import {Status} from "./status";
 
 export
 class Browser extends SplitPanel {
-    constructor(notebooks: PrimaryTab, jobs: PrimaryTab, reports: PrimaryTab, status: Status) {
+    constructor(notebooks: PrimaryTab,
+                jobs: PrimaryTab,
+                reports: PrimaryTab,
+                outputs: PrimaryTab,
+                status: Status) {
         super({ orientation: "vertical", spacing: 0 });
         this.node.classList.add("browser");
         const searchpanel = new BoxPanel();
@@ -70,6 +74,8 @@ class Browser extends SplitPanel {
                 resultspanel.addWidget(new PrimaryDetail(type, search.value, jobs, status));
             } else if (type === "reports") {
                 resultspanel.addWidget(new PrimaryDetail(type, search.value, reports, status));
+            } else if (type === "outputs") {
+                resultspanel.addWidget(new PrimaryDetail(type, search.value, outputs, status));
             }
             hideLoader();
         });

src/ts/views/menu.ts

@@ -12,6 +12,7 @@ export interface IMenuPages {
   notebooks: PrimaryTab;
   jobs: PrimaryTab;
   reports: PrimaryTab;
+  outputs: PrimaryTab;
   status: Widget;
 }
 
@@ -61,6 +62,16 @@ function buildFile(pages: IMenuPages): Menu {
     mnemonic: 2,
   });
 
+  commands.addCommand(COMMANDS.browseOutputs, {
+    execute: () => {
+      pages.main.addWidget(pages.outputs);
+      pages.main.selectWidget(pages.outputs);
+    },
+    iconClass: COMMAND_ICONS.browseOutputs,
+    label: COMMAND_LABELS.browseOutputs,
+    mnemonic: 2,
+  });
+
   commands.addCommand(COMMANDS.openStatus, {
     execute: () => {
       pages.main.addWidget(pages.status);
@@ -75,6 +86,7 @@ function buildFile(pages: IMenuPages): Menu {
   menu.addItem({ command: COMMANDS.browseNotebooks});
   menu.addItem({ command: COMMANDS.browseJobs});
   menu.addItem({ command: COMMANDS.browseReports});
+  menu.addItem({ command: COMMANDS.browseOutputs});
   return menu;
 }
 

src/ts/views/primary.ts

@@ -2,6 +2,8 @@ import {
     BoxPanel, DockPanel, Panel, Widget,
 } from "@phosphor/widgets";
 
+// tslint:disable: max-classes-per-file
+
 import {IRequestResult, request} from "requests-helper";
 import {apiurl,
         createConfigForm,
@@ -158,26 +160,30 @@ class PrimaryTab extends Panel {
     }
 }
 
-// tslint:disable-next-line: max-classes-per-file
 export
 class Notebooks extends PrimaryTab {
     constructor(home: DockPanel, status: Status) {
         super("uploader", "notebooks", status, home);
     }
 }
 
-// tslint:disable-next-line: max-classes-per-file
 export
 class Jobs extends PrimaryTab {
     constructor(home: DockPanel, status: Status) {
         super("scheduler", "jobs", status, home);
     }
 }
 
-// tslint:disable-next-line: max-classes-per-file
 export
 class Reports extends PrimaryTab {
     constructor(home: DockPanel, status: Status) {
         super("configurator", "reports", status, home);
     }
 }
+
+export
+class Outputs extends PrimaryTab {
+    constructor(home: DockPanel, status: Status) {
+        super("configurator", "outputs", status, home);
+    }
+}