From 09013efd3bc78bdc4f2fb6370ad52f755265393b Mon Sep 17 00:00:00 2001 From: Marcin Kuzminski Date: Wed, 28 Nov 2018 13:42:28 +0100 Subject: [PATCH] auth-plugins: some code cleanup + added docs for main plugin. --- rhodecode/authentication/plugins/auth_crowd.py | 2 +- rhodecode/authentication/plugins/auth_headers.py | 2 +- rhodecode/authentication/plugins/auth_jasig_cas.py | 2 +- rhodecode/authentication/plugins/auth_ldap.py | 2 +- rhodecode/authentication/plugins/auth_pam.py | 2 +- rhodecode/authentication/plugins/auth_rhodecode.py | 6 +++++- rhodecode/authentication/plugins/auth_token.py | 2 +- 7 files changed, 11 insertions(+), 7 deletions(-) diff --git a/rhodecode/authentication/plugins/auth_crowd.py b/rhodecode/authentication/plugins/auth_crowd.py index 6d2240d9..35cf9e38 100644 --- a/rhodecode/authentication/plugins/auth_crowd.py +++ b/rhodecode/authentication/plugins/auth_crowd.py @@ -40,7 +40,7 @@ from rhodecode.model.db import User log = logging.getLogger(__name__) -def plugin_factory(plugin_id, *args, **kwds): +def plugin_factory(plugin_id, *args, **kwargs): """ Factory function that is called during plugin discovery. It returns the plugin instance. diff --git a/rhodecode/authentication/plugins/auth_headers.py b/rhodecode/authentication/plugins/auth_headers.py index b9183f5a..ece09512 100644 --- a/rhodecode/authentication/plugins/auth_headers.py +++ b/rhodecode/authentication/plugins/auth_headers.py @@ -34,7 +34,7 @@ from rhodecode.model.db import User log = logging.getLogger(__name__) -def plugin_factory(plugin_id, *args, **kwds): +def plugin_factory(plugin_id, *args, **kwargs): """ Factory function that is called during plugin discovery. It returns the plugin instance. diff --git a/rhodecode/authentication/plugins/auth_jasig_cas.py b/rhodecode/authentication/plugins/auth_jasig_cas.py index ba1949d7..52f0a14d 100644 --- a/rhodecode/authentication/plugins/auth_jasig_cas.py +++ b/rhodecode/authentication/plugins/auth_jasig_cas.py @@ -42,7 +42,7 @@ from rhodecode.model.db import User log = logging.getLogger(__name__) -def plugin_factory(plugin_id, *args, **kwds): +def plugin_factory(plugin_id, *args, **kwargs): """ Factory function that is called during plugin discovery. It returns the plugin instance. diff --git a/rhodecode/authentication/plugins/auth_ldap.py b/rhodecode/authentication/plugins/auth_ldap.py index b6830385..a4cbf3c9 100644 --- a/rhodecode/authentication/plugins/auth_ldap.py +++ b/rhodecode/authentication/plugins/auth_ldap.py @@ -53,7 +53,7 @@ class LdapError(Exception): pass -def plugin_factory(plugin_id, *args, **kwds): +def plugin_factory(plugin_id, *args, **kwargs): """ Factory function that is called during plugin discovery. It returns the plugin instance. diff --git a/rhodecode/authentication/plugins/auth_pam.py b/rhodecode/authentication/plugins/auth_pam.py index bc54b870..8d46081d 100644 --- a/rhodecode/authentication/plugins/auth_pam.py +++ b/rhodecode/authentication/plugins/auth_pam.py @@ -40,7 +40,7 @@ from rhodecode.lib.colander_utils import strip_whitespace log = logging.getLogger(__name__) -def plugin_factory(plugin_id, *args, **kwds): +def plugin_factory(plugin_id, *args, **kwargs): """ Factory function that is called during plugin discovery. It returns the plugin instance. diff --git a/rhodecode/authentication/plugins/auth_rhodecode.py b/rhodecode/authentication/plugins/auth_rhodecode.py index 2e3dce7a..05efc8a9 100644 --- a/rhodecode/authentication/plugins/auth_rhodecode.py +++ b/rhodecode/authentication/plugins/auth_rhodecode.py @@ -34,7 +34,7 @@ from rhodecode.model.db import User log = logging.getLogger(__name__) -def plugin_factory(plugin_id, *args, **kwds): +def plugin_factory(plugin_id, *args, **kwargs): plugin = RhodeCodeAuthPlugin(plugin_id) return plugin @@ -67,6 +67,10 @@ class RhodeCodeAuthPlugin(RhodeCodeAuthPluginBase): def get_display_name(self): return _('RhodeCode Internal') + @classmethod + def docs(cls): + return "https://docs.rhodecode.com/RhodeCode-Enterprise/auth/auth.html" + @hybrid_property def name(self): return "rhodecode" diff --git a/rhodecode/authentication/plugins/auth_token.py b/rhodecode/authentication/plugins/auth_token.py index cf2c2b5d..4dae4107 100644 --- a/rhodecode/authentication/plugins/auth_token.py +++ b/rhodecode/authentication/plugins/auth_token.py @@ -34,7 +34,7 @@ from rhodecode.model.db import User, UserApiKeys, Repository log = logging.getLogger(__name__) -def plugin_factory(plugin_id, *args, **kwds): +def plugin_factory(plugin_id, *args, **kwargs): plugin = RhodeCodeAuthPlugin(plugin_id) return plugin