From dbd8e057160e81d27ee5f80172c30a47356d43e3 Mon Sep 17 00:00:00 2001 From: mutantsan Date: Mon, 19 Aug 2024 11:52:26 +0300 Subject: [PATCH] refactor: move dashboard to a separate ext, part 2 --- ckanext/mailcraft/mailcraft/README | 1 + ckanext/mailcraft/mailcraft/alembic.ini | 74 +++++++++++++++ ckanext/mailcraft/mailcraft/env.py | 84 +++++++++++++++++ ckanext/mailcraft/mailcraft/script.py.mako | 24 +++++ .../9f83e5bfff72_add_mailcraft_mail_table.py | 40 ++++++++ ckanext/mailcraft/mailer.py | 6 +- ckanext/mailcraft/model.py | 94 ------------------- ckanext/mailcraft_dashboard/logic/action.py | 4 +- .../mailcraft_dashboard/logic/validators.py | 2 +- 9 files changed, 231 insertions(+), 98 deletions(-) create mode 100644 ckanext/mailcraft/mailcraft/README create mode 100644 ckanext/mailcraft/mailcraft/alembic.ini create mode 100644 ckanext/mailcraft/mailcraft/env.py create mode 100644 ckanext/mailcraft/mailcraft/script.py.mako create mode 100644 ckanext/mailcraft/mailcraft/versions/9f83e5bfff72_add_mailcraft_mail_table.py delete mode 100644 ckanext/mailcraft/model.py diff --git a/ckanext/mailcraft/mailcraft/README b/ckanext/mailcraft/mailcraft/README new file mode 100644 index 0000000..98e4f9c --- /dev/null +++ b/ckanext/mailcraft/mailcraft/README @@ -0,0 +1 @@ +Generic single-database configuration. \ No newline at end of file diff --git a/ckanext/mailcraft/mailcraft/alembic.ini b/ckanext/mailcraft/mailcraft/alembic.ini new file mode 100644 index 0000000..fc6aa1b --- /dev/null +++ b/ckanext/mailcraft/mailcraft/alembic.ini @@ -0,0 +1,74 @@ +# A generic, single database configuration. + +[alembic] +# path to migration scripts +script_location = %(here)s + +# template used to generate migration files +# file_template = %%(rev)s_%%(slug)s + +# timezone to use when rendering the date +# within the migration file as well as the filename. +# string value is passed to dateutil.tz.gettz() +# leave blank for localtime +# timezone = + +# max length of characters to apply to the +# "slug" field +#truncate_slug_length = 40 + +# set to 'true' to run the environment during +# the 'revision' command, regardless of autogenerate +# revision_environment = false + +# set to 'true' to allow .pyc and .pyo files without +# a source .py file to be detected as revisions in the +# versions/ directory +# sourceless = false + +# version location specification; this defaults +# to /home/berry/projects/master/ckanext-mailcraft/ckanext/mailcraft/migration/mailcraft/versions. When using multiple version +# directories, initial revisions must be specified with --version-path +# version_locations = %(here)s/bar %(here)s/bat /home/berry/projects/master/ckanext-mailcraft/ckanext/mailcraft/migration/mailcraft/versions + +# the output encoding used when revision files +# are written from script.py.mako +# output_encoding = utf-8 + +sqlalchemy.url = driver://user:pass@localhost/dbname + + +# Logging configuration +[loggers] +keys = root,sqlalchemy,alembic + +[handlers] +keys = console + +[formatters] +keys = generic + +[logger_root] +level = WARN +handlers = console +qualname = + +[logger_sqlalchemy] +level = WARN +handlers = +qualname = sqlalchemy.engine + +[logger_alembic] +level = INFO +handlers = +qualname = alembic + +[handler_console] +class = StreamHandler +args = (sys.stderr,) +level = NOTSET +formatter = generic + +[formatter_generic] +format = %(levelname)-5.5s [%(name)s] %(message)s +datefmt = %H:%M:%S diff --git a/ckanext/mailcraft/mailcraft/env.py b/ckanext/mailcraft/mailcraft/env.py new file mode 100644 index 0000000..29b79e3 --- /dev/null +++ b/ckanext/mailcraft/mailcraft/env.py @@ -0,0 +1,84 @@ +# -*- coding: utf-8 -*- + +from __future__ import with_statement +from alembic import context +from sqlalchemy import engine_from_config, pool +from logging.config import fileConfig + +import os + +# this is the Alembic Config object, which provides +# access to the values within the .ini file in use. +config = context.config + +# Interpret the config file for Python logging. +# This line sets up loggers basically. +fileConfig(config.config_file_name) + +# add your model's MetaData object here +# for 'autogenerate' support +# from myapp import mymodel +# target_metadata = mymodel.Base.metadata +target_metadata = None + +# other values from the config, defined by the needs of env.py, +# can be acquired: +# my_important_option = config.get_main_option("my_important_option") +# ... etc. + +name = os.path.basename(os.path.dirname(__file__)) + + +def run_migrations_offline(): + """Run migrations in 'offline' mode. + + This configures the context with just a URL + and not an Engine, though an Engine is acceptable + here as well. By skipping the Engine creation + we don't even need a DBAPI to be available. + + Calls to context.execute() here emit the given string to the + script output. + + """ + + url = config.get_main_option("sqlalchemy.url") + context.configure( + url=url, + target_metadata=target_metadata, + literal_binds=True, + version_table="{}_alembic_version".format(name), + ) + + with context.begin_transaction(): + context.run_migrations() + + +def run_migrations_online(): + """Run migrations in 'online' mode. + + In this scenario we need to create an Engine + and associate a connection with the context. + + """ + connectable = engine_from_config( + config.get_section(config.config_ini_section), + prefix="sqlalchemy.", + poolclass=pool.NullPool, + ) + + with connectable.connect() as connection: + context.configure( + connection=connection, + target_metadata=target_metadata, + version_table="{}_alembic_version".format(name), + ) + + with context.begin_transaction(): + context.run_migrations() + + +if context.is_offline_mode(): + run_migrations_offline() +else: + run_migrations_online() diff --git a/ckanext/mailcraft/mailcraft/script.py.mako b/ckanext/mailcraft/mailcraft/script.py.mako new file mode 100644 index 0000000..2c01563 --- /dev/null +++ b/ckanext/mailcraft/mailcraft/script.py.mako @@ -0,0 +1,24 @@ +"""${message} + +Revision ID: ${up_revision} +Revises: ${down_revision | comma,n} +Create Date: ${create_date} + +""" +from alembic import op +import sqlalchemy as sa +${imports if imports else ""} + +# revision identifiers, used by Alembic. +revision = ${repr(up_revision)} +down_revision = ${repr(down_revision)} +branch_labels = ${repr(branch_labels)} +depends_on = ${repr(depends_on)} + + +def upgrade(): + ${upgrades if upgrades else "pass"} + + +def downgrade(): + ${downgrades if downgrades else "pass"} diff --git a/ckanext/mailcraft/mailcraft/versions/9f83e5bfff72_add_mailcraft_mail_table.py b/ckanext/mailcraft/mailcraft/versions/9f83e5bfff72_add_mailcraft_mail_table.py new file mode 100644 index 0000000..ede1dd0 --- /dev/null +++ b/ckanext/mailcraft/mailcraft/versions/9f83e5bfff72_add_mailcraft_mail_table.py @@ -0,0 +1,40 @@ +"""Add mailcraft_mail table + +Revision ID: 9f83e5bfff72 +Revises: +Create Date: 2023-09-14 11:53:58.371935 + +""" +import sqlalchemy as sa + +from alembic import op +from sqlalchemy.dialects import postgresql + +# revision identifiers, used by Alembic. +revision = "9f83e5bfff72" +down_revision = None +branch_labels = None +depends_on = None + + +def upgrade(): + op.create_table( + "mailcraft_mail", + sa.Column("id", sa.Integer, primary_key=True, autoincrement=True), + sa.Column("subject", sa.Text), + sa.Column( + "timestamp", + sa.DateTime, + nullable=False, + server_default=sa.func.current_timestamp(), + ), + sa.Column("sender", sa.Text), + sa.Column("recipient", sa.Text), + sa.Column("message", sa.Text), + sa.Column("state", sa.Text, server_default="success"), + sa.Column("extras", postgresql.JSONB(astext_type=sa.Text()), nullable=True), + ) + + +def downgrade(): + op.drop_table("mailcraft_mail") diff --git a/ckanext/mailcraft/mailer.py b/ckanext/mailcraft/mailer.py index fce4595..2a43c83 100644 --- a/ckanext/mailcraft/mailer.py +++ b/ckanext/mailcraft/mailer.py @@ -11,11 +11,12 @@ from time import time from typing import Any, Iterable, Optional, cast +import ckan.plugins as p import ckan.model as model import ckan.plugins.toolkit as tk import ckanext.mailcraft.config as mc_config -import ckanext.mailcraft.model as mc_model +import ckanext.mailcraft_dashboard.model as mc_model from ckanext.mailcraft.exception import MailerException from ckanext.mailcraft.types import ( Attachment, @@ -200,6 +201,9 @@ def _save_email( body_html: str, state: str = mc_model.Email.State.success, ) -> None: + if not p.plugin_loaded("mailcraft_dashboard"): + return + mc_model.Email.save_mail(email_data, body_html, state) def _send_email(self, recipients, msg: EmailMessage): diff --git a/ckanext/mailcraft/model.py b/ckanext/mailcraft/model.py deleted file mode 100644 index b03cc55..0000000 --- a/ckanext/mailcraft/model.py +++ /dev/null @@ -1,94 +0,0 @@ -from __future__ import annotations - -import logging -from datetime import datetime -from typing import Any - -from sqlalchemy import Column, DateTime, Integer, Text -from sqlalchemy.orm import Query -from sqlalchemy.dialects.postgresql import JSONB -from sqlalchemy.ext.mutable import MutableDict -from typing_extensions import Self - -import ckan.model as model -from ckan.plugins import toolkit as tk - -from ckanext.mailcraft.types import EmailData - -log = logging.getLogger(__name__) - - -class Email(tk.BaseModel): - __tablename__ = "mailcraft_mail" - - class State: - failed = "failed" - success = "success" - stopped = "stopped" - - id = Column(Integer, primary_key=True) - - subject = Column(Text) - timestamp = Column(DateTime, nullable=False, default=datetime.utcnow) - sender = Column(Text) - recipient = Column(Text) - message = Column(Text) - state = Column(Text, nullable=False, default=State.success) - extras = Column("extras", MutableDict.as_mutable(JSONB)) - - @classmethod - def all(cls) -> list[dict[str, Any]]: - query: Query = model.Session.query.query(cls).order_by(cls.timestamp.desc()) - - return [mail.dictize({}) for mail in query.all()] - - @classmethod - def save_mail( - cls, - email_data: EmailData, - body_html: str, - state: str, - ) -> Email: - mail = cls( - subject=email_data["Subject"], - timestamp=email_data["Date"], - sender=email_data["From"], - recipient=email_data["To"], - message=body_html, - state=state, - extras=email_data, - ) - - model.Session.add(mail) - model.Session.commit() - - return mail - - def dictize(self, context): - return { - "id": self.id, - "subject": self.subject, - "timestamp": self.timestamp, - "sender": self.sender, - "recipient": self.recipient, - "message": self.message, - "state": self.state, - "extras": self.extras or {}, - } - - @classmethod - def clear_emails(cls) -> int: - rows_deleted = model.Session.query(cls).delete() - model.Session.commit() - - return rows_deleted - - @classmethod - def get(cls, mail_id: str) -> Self | None: - query: Query = model.Session.query(cls).filter(cls.id == mail_id) - - return query.one_or_none() - - def delete(self) -> None: - model.Session().autoflush = False - model.Session.delete(self) diff --git a/ckanext/mailcraft_dashboard/logic/action.py b/ckanext/mailcraft_dashboard/logic/action.py index 92efbd2..4e8e481 100644 --- a/ckanext/mailcraft_dashboard/logic/action.py +++ b/ckanext/mailcraft_dashboard/logic/action.py @@ -6,8 +6,8 @@ import ckan.model as model from ckan.logic import validate -import ckanext.mailcraft.model as mc_model -from ckanext.mailcraft.logic import schema +import ckanext.mailcraft_dashboard.model as mc_model +from ckanext.mailcraft_dashboard.logic import schema @tk.side_effect_free diff --git a/ckanext/mailcraft_dashboard/logic/validators.py b/ckanext/mailcraft_dashboard/logic/validators.py index 10df960..4ef0795 100644 --- a/ckanext/mailcraft_dashboard/logic/validators.py +++ b/ckanext/mailcraft_dashboard/logic/validators.py @@ -4,7 +4,7 @@ import ckan.plugins.toolkit as tk -import ckanext.mailcraft.model as mc_model +import ckanext.mailcraft_dashboard.model as mc_model def mc_mail_exists(v: str, context) -> Any: