Merge pull request '2020.12.10' (#8) from 2020.12.10 into 2020.12

Reviewed-on: sh-edraft.de/sh_common_py_lib#8

src/build.json

@@ -29,7 +29,7 @@
         "Version": {
           "Major": 2020,
           "Minor": 12,
-          "Micro": 9
+          "Micro": 10
         }
       },
       {
@@ -46,7 +46,7 @@
         "Version": {
           "Major": 2020,
           "Minor": 12,
-          "Micro": 9
+          "Micro": 10
         }
       }
     ],

src/setup.py

@@ -18,7 +18,8 @@ setuptools.setup(
         'SQLAlchemy',
         'termcolor',
         'pyfiglet',
-        'tabulate'
+        'tabulate',
+        'smtplib'
     ],
     entry_points={
         'console_scripts': [

src/sh_edraft/cli/__init__.py

@@ -15,11 +15,11 @@ __title__ = 'sh_edraft.cli'
 __author__ = 'Sven Heidemann'
 __license__ = 'MIT'
 __copyright__ = 'Copyright (c) 2020 sh-edraft.de'
-__version__ = '2020.12.9'
+__version__ = '2020.12.10'
 
 from collections import namedtuple
 
 # imports:
 
 VersionInfo = namedtuple('VersionInfo', 'major minor micro')
-version_info = VersionInfo(major=2020, minor=12, micro=9)
+version_info = VersionInfo(major=2020, minor=12, micro=10)

src/sh_edraft/cli/command/__init__.py

@@ -15,11 +15,11 @@ __title__ = 'sh_edraft.cli.command'
 __author__ = 'Sven Heidemann'
 __license__ = 'MIT'
 __copyright__ = 'Copyright (c) 2020 sh-edraft.de'
-__version__ = '2020.12.9'
+__version__ = '2020.12.10'
 
 from collections import namedtuple
 
 # imports:
 
 VersionInfo = namedtuple('VersionInfo', 'major minor micro')
-version_info = VersionInfo(major=2020, minor=12, micro=9)
+version_info = VersionInfo(major=2020, minor=12, micro=10)

src/sh_edraft/cli/command/base/__init__.py

@@ -15,7 +15,7 @@ __title__ = 'sh_edraft.cli.command.base'
 __author__ = 'Sven Heidemann'
 __license__ = 'MIT'
 __copyright__ = 'Copyright (c) 2020 sh-edraft.de'
-__version__ = '2020.12.9'
+__version__ = '2020.12.10'
 
 from collections import namedtuple
 
@@ -23,4 +23,4 @@ from collections import namedtuple
 from .command_base import CommandBase
 
 VersionInfo = namedtuple('VersionInfo', 'major minor micro')
-version_info = VersionInfo(major=2020, minor=12, micro=9)
+version_info = VersionInfo(major=2020, minor=12, micro=10)

src/sh_edraft/cli/cpl_cli/__init__.py

@@ -15,7 +15,7 @@ __title__ = 'sh_edraft.cli.cpl_cli'
 __author__ = 'Sven Heidemann'
 __license__ = 'MIT'
 __copyright__ = 'Copyright (c) 2020 sh-edraft.de'
-__version__ = '2020.12.9'
+__version__ = '2020.12.10'
 
 from collections import namedtuple
 
@@ -23,4 +23,4 @@ from collections import namedtuple
 from .cli import CLI
 
 VersionInfo = namedtuple('VersionInfo', 'major minor micro')
-version_info = VersionInfo(major=2020, minor=12, micro=9)
+version_info = VersionInfo(major=2020, minor=12, micro=10)

src/sh_edraft/cli/cpl_cli/commands/__init__.py

@@ -15,7 +15,7 @@ __title__ = 'sh_edraft.cli.cpl_cli.commands'
 __author__ = 'Sven Heidemann'
 __license__ = 'MIT'
 __copyright__ = 'Copyright (c) 2020 sh-edraft.de'
-__version__ = '2020.12.9'
+__version__ = '2020.12.10'
 
 from collections import namedtuple
 
@@ -25,4 +25,4 @@ from .help import Help
 from .new import New
 
 VersionInfo = namedtuple('VersionInfo', 'major minor micro')
-version_info = VersionInfo(major=2020, minor=12, micro=9)
+version_info = VersionInfo(major=2020, minor=12, micro=10)

src/sh_edraft/cli/cpl_cli/commands/publish/__init__.py

@@ -15,7 +15,7 @@ __title__ = 'sh_edraft.cli.cpl_cli.commands.publish'
 __author__ = 'Sven Heidemann'
 __license__ = 'MIT'
 __copyright__ = 'Copyright (c) 2020 sh-edraft.de'
-__version__ = '2020.12.9'
+__version__ = '2020.12.10'
 
 from collections import namedtuple
 
@@ -24,4 +24,4 @@ from .app import PublishApp
 from .publish import Publish
 
 VersionInfo = namedtuple('VersionInfo', 'major minor micro')
-version_info = VersionInfo(major=2020, minor=12, micro=9)
+version_info = VersionInfo(major=2020, minor=12, micro=10)

src/sh_edraft/cli/interpreter/__init__.py

@@ -15,7 +15,7 @@ __title__ = 'sh_edraft.cli.interpreter'
 __author__ = 'Sven Heidemann'
 __license__ = 'MIT'
 __copyright__ = 'Copyright (c) 2020 sh-edraft.de'
-__version__ = '2020.12.9'
+__version__ = '2020.12.10'
 
 from collections import namedtuple
 
@@ -23,4 +23,4 @@ from collections import namedtuple
 from .interpreter import Interpreter
 
 VersionInfo = namedtuple('VersionInfo', 'major minor micro')
-version_info = VersionInfo(major=2020, minor=12, micro=9)
+version_info = VersionInfo(major=2020, minor=12, micro=10)

src/sh_edraft/mailing/__init__.py

@@ -15,11 +15,11 @@ __title__ = 'sh_edraft.mailing'
 __author__ = 'Sven Heidemann'
 __license__ = 'MIT'
 __copyright__ = 'Copyright (c) 2020 sh-edraft.de'
-__version__ = '2020.12.9'
+__version__ = '2020.12.10'
 
 from collections import namedtuple
 
 
 
 VersionInfo = namedtuple('VersionInfo', 'major minor micro')
-version_info = VersionInfo(major=2020, minor=12, micro=9)
+version_info = VersionInfo(major=2020, minor=12, micro=10)

src/sh_edraft/mailing/base/__init__.py

@@ -0,0 +1,25 @@
+# -*- coding: utf-8 -*-
+
+"""
+sh_edraft.mailing.base 
+~~~~~~~~~~~~~~~~~~~
+
+
+
+:copyright: (c) 2020 sh-edraft.de
+:license: MIT, see LICENSE for more details.
+
+"""
+
+__title__ = 'sh_edraft.mailing.base'
+__author__ = 'Sven Heidemann'
+__license__ = 'MIT'
+__copyright__ = 'Copyright (c) 2020 sh-edraft.de'
+__version__ = '2020.12.10'
+
+from collections import namedtuple
+
+# imports:
+
+VersionInfo = namedtuple('VersionInfo', 'major minor micro')
+version_info = VersionInfo(major=2020, minor=12, micro=10)

src/sh_edraft/mailing/base/email_client_base.py

@@ -0,0 +1,17 @@
+from abc import abstractmethod
+
+from sh_edraft.mailing.model.email import EMail
+from sh_edraft.service.base.service_base import ServiceBase
+
+
+class EMailClientBase(ServiceBase):
+
+    @abstractmethod
+    def __init__(self):
+        ServiceBase.__init__(self)
+
+    @abstractmethod
+    def connect(self): pass
+
+    @abstractmethod
+    def send_mail(self, email: EMail): pass

src/sh_edraft/mailing/email_client.py

@@ -0,0 +1,71 @@
+import ssl
+from smtplib import SMTP
+from typing import Optional
+
+from sh_edraft.environment.base.environment_base import EnvironmentBase
+from sh_edraft.logging.base.logger_base import LoggerBase
+from sh_edraft.mailing.base.email_client_base import EMailClientBase
+from sh_edraft.mailing.model.email import EMail
+from sh_edraft.mailing.model.email_client_settings import EMailClientSettings
+from sh_edraft.service.base.service_base import ServiceBase
+from sh_edraft.utils.credential_manager import CredentialManager
+
+
+class EMailClient(EMailClientBase):
+
+    def __init__(self, environment: EnvironmentBase, logger: LoggerBase, mail_settings: EMailClientSettings):
+        ServiceBase.__init__(self)
+
+        self._environment = environment
+        self._mail_settings = mail_settings
+        self._logger = logger
+
+        self._server: Optional[SMTP] = None
+
+        self.create()
+
+    def create(self):
+        self._logger.trace(__name__, f'Started {__name__}.create')
+        self.connect()
+        self._logger.trace(__name__, f'Stopped {__name__}.create')
+
+    def connect(self):
+        self._logger.trace(__name__, f'Started {__name__}.connect')
+        try:
+            self._logger.debug(__name__, f'Try to connect to {self._mail_settings.host}:{self._mail_settings.port}')
+            self._server = SMTP(self._mail_settings.host, self._mail_settings.port)
+            self._logger.info(__name__, f'Connected to {self._mail_settings.host}:{self._mail_settings.port}')
+
+            self._logger.debug(__name__, 'Try to start tls')
+            self._server.starttls(context=ssl.create_default_context())
+            self._logger.info(__name__, 'Started tls')
+        except Exception as e:
+            self._logger.error(__name__, 'Cannot connect to mail server', e)
+
+        self._logger.trace(__name__, f'Stopped {__name__}.connect')
+
+    def login(self):
+        self._logger.trace(__name__, f'Started {__name__}.login')
+        try:
+            self._logger.debug(__name__, f'Try to login {self._mail_settings.user_name}@{self._mail_settings.host}:{self._mail_settings.port}')
+            self._server.login(self._mail_settings.user_name, CredentialManager.decrypt(self._mail_settings.credentials))
+            self._logger.info(__name__, f'Logged on as {self._mail_settings.user_name} to {self._mail_settings.host}:{self._mail_settings.port}')
+        except Exception as e:
+            self._logger.error(__name__, 'Cannot login to mail server', e)
+
+        self._logger.trace(__name__, f'Stopped {__name__}.login')
+
+    def send_mail(self, email: EMail):
+        self._logger.trace(__name__, f'Started {__name__}.send_mail')
+        try:
+            self.login()
+            email.body += f'\n\nDies ist eine automatische E-Mail.' \
+                          f'\nGesendet von {self._environment.application_name}-{self._environment.environment_name}@{self._environment.host_name} für ' \
+                          f'{self._environment.customer}.'
+
+            self._logger.debug(__name__, f'Try to send email to {email.receiver_list}')
+            self._server.sendmail(self._mail_settings.user_name, email.receiver_list, email.get_content(self._mail_settings.user_name))
+            self._logger.info(__name__, f'Sent email to {email.receiver_list}')
+        except Exception as e:
+            self._logger.error(__name__, f'Cannot send mail to {email.receiver_list}', e)
+        self._logger.trace(__name__, f'Stopped {__name__}.send_mail')

src/sh_edraft/mailing/model/__init__.py

@@ -0,0 +1,25 @@
+# -*- coding: utf-8 -*-
+
+"""
+sh_edraft.mailing.model 
+~~~~~~~~~~~~~~~~~~~
+
+
+
+:copyright: (c) 2020 sh-edraft.de
+:license: MIT, see LICENSE for more details.
+
+"""
+
+__title__ = 'sh_edraft.mailing.model'
+__author__ = 'Sven Heidemann'
+__license__ = 'MIT'
+__copyright__ = 'Copyright (c) 2020 sh-edraft.de'
+__version__ = '2020.12.10'
+
+from collections import namedtuple
+
+# imports:
+
+VersionInfo = namedtuple('VersionInfo', 'major minor micro')
+version_info = VersionInfo(major=2020, minor=12, micro=10)

src/sh_edraft/mailing/model/email.py

@@ -0,0 +1,86 @@
+import re
+
+
+class EMail:
+
+    def __init__(self, header: list[str] = None, subject: str = None, body: str = None, transceiver: str = None, receiver: list[str] = None):
+        self._header: list[str] = header
+
+        self._subject: str = subject
+        self._body: str = body
+
+        self._transceiver: str = transceiver
+        self._receiver: list[str] = receiver
+
+    @property
+    def header(self) -> str:
+        return '\r\n'.join(self._header)
+
+    @property
+    def header_list(self) -> list[str]:
+        return self._header
+
+    @header.setter
+    def header(self, header: list[str]):
+        self._header = header
+
+    @property
+    def subject(self) -> str:
+        return self._subject
+
+    @subject.setter
+    def subject(self, subject: str):
+        self._subject = subject
+
+    @property
+    def body(self) -> str:
+        return self._body
+
+    @body.setter
+    def body(self, body: str):
+        self._body = body
+
+    @property
+    def transceiver(self) -> str:
+        return self._transceiver
+
+    @transceiver.setter
+    def transceiver(self, transceiver: str):
+        if self.check_mail(transceiver):
+            self._transceiver = transceiver
+        else:
+            raise Exception(f'Invalid email: {transceiver}')
+
+    @property
+    def receiver(self) -> str:
+        return ','.join(self._receiver)
+
+    @property
+    def receiver_list(self) -> list[str]:
+        return self._receiver
+
+    @receiver.setter
+    def receiver(self, receiver: list[str]):
+        self._receiver = receiver
+
+    @staticmethod
+    def check_mail(address: str) -> bool:
+        return bool(re.search('^\\w+([.-]?\\w+)*@\\w+([.-]?\\w+)*(.\\w{2,3})+$', address))
+
+    def add_header(self, header: str):
+        if self._header is None:
+            self._header = []
+
+        self._header.append(header)
+
+    def add_receiver(self, receiver: str):
+        if self._receiver is None:
+            self._receiver = []
+
+        if self.check_mail(receiver):
+            self._receiver.append(receiver)
+        else:
+            raise Exception(f'Invalid email: {receiver}')
+
+    def get_content(self, transceiver: str):
+        return str(f'From: {transceiver}\r\nTo: {self.receiver}\r\n{self.header}\r\nSubject: {self.subject}\r\n{self.body}').encode('utf-8')

src/sh_edraft/mailing/model/email_client_settings.py

@@ -0,0 +1,59 @@
+import traceback
+
+from sh_edraft.configuration.base.configuration_model_base import ConfigurationModelBase
+from sh_edraft.console.console import Console
+from sh_edraft.mailing.model.email_client_settings_name import EMailClientSettingsName
+
+
+class EMailClientSettings(ConfigurationModelBase):
+
+    def __init__(self):
+        ConfigurationModelBase.__init__(self)
+
+        self._host: str = ''
+        self._port: int = 0
+        self._user_name: str = ''
+        self._credentials: str = ''
+
+    @property
+    def host(self) -> str:
+        return self._host
+
+    @host.setter
+    def host(self, host: str) -> None:
+        self._host = host
+
+    @property
+    def port(self) -> int:
+        return self._port
+
+    @port.setter
+    def port(self, port: int) -> None:
+        self._port = port
+
+    @property
+    def user_name(self) -> str:
+        return self._user_name
+
+    @user_name.setter
+    def user_name(self, user_name: str) -> None:
+        self._user_name = user_name
+
+    @property
+    def credentials(self) -> str:
+        return self._credentials
+
+    @credentials.setter
+    def credentials(self, credentials: str) -> None:
+        self._credentials = credentials
+
+    def from_dict(self, settings: dict):
+        try:
+            self._host = settings[EMailClientSettingsName.host.value]
+            self._port = settings[EMailClientSettingsName.port.value]
+            self._user_name = settings[EMailClientSettingsName.user_name.value]
+            self._credentials = settings[EMailClientSettingsName.credentials.value]
+        except Exception as e:
+            Console.error(f'[ ERROR ] [ {__name__} ]: Reading error in {self.__name__} settings')
+            Console.error(f'[ EXCEPTION ] [ {__name__} ]: {e} -> {traceback.format_exc()}')
+

src/sh_edraft/mailing/model/email_client_settings_name.py

@@ -0,0 +1,9 @@
+from enum import Enum
+
+
+class EMailClientSettingsName(Enum):
+
+    host = 'Host'
+    port = 'Port'
+    user_name = 'UserName'
+    credentials = 'Credentials'

src/sh_edraft/publishing/__init__.py

@@ -15,7 +15,7 @@ __title__ = 'sh_edraft.publishing'
 __author__ = 'Sven Heidemann'
 __license__ = 'MIT'
 __copyright__ = 'Copyright (c) 2020 sh-edraft.de'
-__version__ = '2020.12.9'
+__version__ = '2020.12.10'
 
 from collections import namedtuple
 
@@ -23,4 +23,4 @@ from collections import namedtuple
 from .publisher import Publisher
 
 VersionInfo = namedtuple('VersionInfo', 'major minor micro')
-version_info = VersionInfo(major=2020, minor=12, micro=9)
+version_info = VersionInfo(major=2020, minor=12, micro=10)

src/sh_edraft/publishing/base/__init__.py

@@ -15,7 +15,7 @@ __title__ = 'sh_edraft.publishing.base'
 __author__ = 'Sven Heidemann'
 __license__ = 'MIT'
 __copyright__ = 'Copyright (c) 2020 sh-edraft.de'
-__version__ = '2020.12.9'
+__version__ = '2020.12.10'
 
 from collections import namedtuple
 
@@ -23,4 +23,4 @@ from collections import namedtuple
 from .publisher_base import PublisherBase
 
 VersionInfo = namedtuple('VersionInfo', 'major minor micro')
-version_info = VersionInfo(major=2020, minor=12, micro=9)
+version_info = VersionInfo(major=2020, minor=12, micro=10)

src/sh_edraft/publishing/model/__init__.py

@@ -15,7 +15,7 @@ __title__ = 'sh_edraft.publishing.model'
 __author__ = 'Sven Heidemann'
 __license__ = 'MIT'
 __copyright__ = 'Copyright (c) 2020 sh-edraft.de'
-__version__ = '2020.12.9'
+__version__ = '2020.12.10'
 
 from collections import namedtuple
 
@@ -26,4 +26,4 @@ from .publish_settings_model import PublishSettings
 from .publish_settings_name import PublishSettingsName
 
 VersionInfo = namedtuple('VersionInfo', 'major minor micro')
-version_info = VersionInfo(major=2020, minor=12, micro=9)
+version_info = VersionInfo(major=2020, minor=12, micro=10)

src/sh_edraft/publishing/publisher.py

@@ -64,14 +64,20 @@ class Publisher(PublisherBase):
 
                 for r, d, f in os.walk(included):
                     for file in f:
+                        rel_path = os.path.relpath(r)
+                        if not rel_path.startswith('.'):
+                            rel_path = f'./{rel_path}'
+
                         file_path = os.path.join(self._publish_settings.source_path, r, file)
                         if os.path.isfile(file_path):
                             self._included_files.append(file_path)
+                        elif os.path.isfile(os.path.join(rel_path, file)):
+                            self._included_files.append(os.path.join(rel_path, file))
                         else:
                             self._logger.fatal(__name__, f'File not found: {file}')
 
             elif os.path.isfile(included):
-                self._included_files.append(os.path.join(self._publish_settings.source_path, included))
+                self._included_files.append(included)
             else:
                 self._logger.fatal(__name__, f'File not found: {included}')
 

src/sh_edraft/service/providing/__init__.py

@@ -15,7 +15,7 @@ __title__ = 'sh_edraft.service.providing'
 __author__ = 'Sven Heidemann'
 __license__ = 'MIT'
 __copyright__ = 'Copyright (c) 2020 sh-edraft.de'
-__version__ = '2020.12.9'
+__version__ = '2020.12.10'
 
 from collections import namedtuple
 
@@ -24,4 +24,4 @@ from .service_provider import ServiceProvider
 from .service_provider import ServiceProviderBase
 
 VersionInfo = namedtuple('VersionInfo', 'major minor micro')
-version_info = VersionInfo(major=2020, minor=12, micro=9)
+version_info = VersionInfo(major=2020, minor=12, micro=10)

src/sh_edraft/service/providing/service_provider.py

@@ -4,6 +4,7 @@ from typing import Type, Optional
 
 from sh_edraft.configuration.base.configuration_model_base import ConfigurationModelBase
 from sh_edraft.database.context.base.database_context_base import DatabaseContextBase
+from sh_edraft.environment.base import EnvironmentBase
 from sh_edraft.hosting.base.application_runtime_base import ApplicationRuntimeBase
 from sh_edraft.service.providing.base.service_provider_base import ServiceProviderBase
 from sh_edraft.service.base.service_base import ServiceBase
@@ -31,6 +32,9 @@ class ServiceProvider(ServiceProviderBase):
                 if issubclass(parameter.annotation, ApplicationRuntimeBase):
                     params.append(self._app_runtime)
 
+                elif issubclass(parameter.annotation, EnvironmentBase):
+                    params.append(self._app_runtime.configuration.environment)
+
                 elif issubclass(parameter.annotation, DatabaseContextBase):
                     params.append(self._database_context)
 

src/tests_dev/appsettings.edrafts-pc.json

@@ -11,6 +11,12 @@
     "ConsoleLogLevel": "TRACE",
     "FileLogLevel": "TRACE"
   },
+  "EMailClientSettings": {
+    "Host": "mail.sh-edraft.de",
+    "Port": "587",
+    "UserName": "dev-srv@sh-edraft.de",
+    "Credentials": "RmBOQX1eNFYiYjgsSid3fV1nelc2WA=="
+  },
   "PublishSettings": {
     "SourcePath": "../",
     "DistPath": "../../dist",

src/tests_dev/program.py

@@ -1,13 +1,15 @@
 from typing import Optional
 
 from sh_edraft.configuration.base import ConfigurationBase
-from sh_edraft.console import Console
 from sh_edraft.database.context import DatabaseContext
 from sh_edraft.database.model import DatabaseSettings
 from sh_edraft.hosting import ApplicationHost
 from sh_edraft.hosting.base import ApplicationBase
 from sh_edraft.logging import Logger
 from sh_edraft.logging.base import LoggerBase
+from sh_edraft.mailing.base.email_client_base import EMailClientBase
+from sh_edraft.mailing.email_client import EMailClient
+from sh_edraft.mailing.model.email import EMail
 from sh_edraft.service.providing.base import ServiceProviderBase
 from sh_edraft.utils import CredentialManager
 
@@ -24,6 +26,7 @@ class Program(ApplicationBase):
         self._services: Optional[ServiceProviderBase] = None
         self._configuration: Optional[ConfigurationBase] = None
         self._logger: Optional[LoggerBase] = None
+        self._mailer: Optional[EMailClientBase] = None
 
     def create_application_host(self):
         self._app_host = ApplicationHost()
@@ -51,28 +54,21 @@ class Program(ApplicationBase):
         self._services.add_singleton(LoggerBase, Logger)
         self._logger = self._services.get_service(LoggerBase)
 
+        self._services.add_singleton(EMailClientBase, EMailClient)
+        self._mailer = self._services.get_service(EMailClientBase)
+
     def main(self):
         self._logger.header(f'{self._configuration.environment.application_name}:')
         self._logger.debug(__name__, f'Host: {self._configuration.environment.host_name}')
         self._logger.debug(__name__, f'Environment: {self._configuration.environment.environment_name}')
         self._logger.debug(__name__, f'Customer: {self._configuration.environment.customer}')
         self._services.get_service(UserRepoBase).add_test_user()
-
+        mail = EMail()
-        Console.clear()
+        mail.add_header('Mime-Version: 1.0')
-        Console.write_line('Hello', 'World')
+        mail.add_header('Content-Type: text/plain; charset=utf-8')
-        # name = Console.read_line('Name: ')
+        mail.add_header('Content-Transfer-Encoding: quoted-printable')
-        # Console.write_line('Hello', name)
+        mail.add_receiver('edraft.sh@gmail.com')
-        Console.set_foreground_color('red')
+        mail.add_receiver('edraft@sh-edraft.de')
-        Console.set_background_color('green')
+        mail.subject = f'Test - {self._configuration.environment.host_name}'
-        Console.set_cursor_position(5, 5)
+        mail.body = 'Dies ist ein Test :D'
-        Console.write_line('Error')
+        self._mailer.send_mail(mail)
-        Console.write_line_at(10, 5, 'Error')
-        Console.write_at(15, 5, 'Error')
-        Console.reset_cursor_position()
-        Console.set_foreground_color('green')
-        Console.set_background_color('default')
-        Console.write_line('Test')
-        Console.write('1')
-        # Console.write('x: ')
-        # Console.read_line('Test> ')
-        Console.write_line(Console.foreground_color)