diff --git a/auth_oauth_environment/README.rst b/auth_oauth_environment/README.rst new file mode 100644 index 000000000..e13a6b8ed --- /dev/null +++ b/auth_oauth_environment/README.rst @@ -0,0 +1,129 @@ +================================================ +Auth oauth configuration with server_environment +================================================ + +.. + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! This file is generated by oca-gen-addon-readme !! + !! changes will be overwritten. !! + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! source digest: sha256:b787e16c08c7d8d3b53118cafeba8c96756be4e4b2a8405d57a351b746ea021e + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + +.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png + :target: https://odoo-community.org/page/development-status + :alt: Beta +.. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png + :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html + :alt: License: AGPL-3 +.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fserver--env-lightgray.png?logo=github + :target: https://github.com/OCA/server-env/tree/17.0/auth_oauth_environment + :alt: OCA/server-env +.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png + :target: https://translation.odoo-community.org/projects/server-env-17-0/server-env-17-0-auth_oauth_environment + :alt: Translate me on Weblate +.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png + :target: https://runboat.odoo-community.org/builds?repo=OCA/server-env&target_branch=17.0 + :alt: Try me on Runboat + +|badge1| |badge2| |badge3| |badge4| |badge5| + +This module extends the functionality of server environment to support +OAuth providers, and allows you to enable providers and set client_id +key according to environment. (Refer to module server_environment for +more informations) + +**Table of contents** + +.. contents:: + :local: + +Installation +============ + +To install this module, you need to have the server_environment module +installed and properly configured. + +Configuration +============= + +To configure this module, you need to add a section +``[auth_oauth.provider_name]`` to you server_environment_files +configurations, where 'provider_name' match the tech_name field on +auth.oauth.provider. + +'provider_name' is the first part (until first space character) in lower +case of provider name. Using existing providers, it could be either +``provider_google``, ``provider_openerp``, or ``provider_facebook``. + +For example, if you want to activate Google and Odoo.com, your +server_environment_files should look like this: + +:: + + [auth_oauth.provider_google] + client_id=123456789101-abcdefghijklmnopqrstuvwxyz000000 + enabled=True + + [auth_oauth.provider_openerp] + enabled=True + +Any provider not being enabled through server_environment_files will be +set as disabled automatically. + +If you want to define a new custom provider, you should pay attention to +the tech name to use in the server_environment_files. If you create a +provider with 'provider_dummy' as its tech_name, then the section should +be named ``[auth_oauth.provider_dummy]``. + +Usage +===== + +Once configured, Odoo will read from server_environment_files the +following fields of auth.oauth.provider : + +- Allowed (``enabled``) +- Client ID (``client_id``) + +Bug Tracker +=========== + +Bugs are tracked on `GitHub Issues `_. +In case of trouble, please check there if your issue has already been reported. +If you spotted it first, help us to smash it by providing a detailed and welcomed +`feedback `_. + +Do not contact contributors directly about support or help with technical issues. + +Credits +======= + +Authors +------- + +* Camptocamp SA + +Contributors +------------ + +- `Camptocamp `__ + + - Akim Juillerat akim.juillerat@camptocamp.com + - Vincent Van Rossem vincent.vanrossem@camptocamp.com> + +Maintainers +----------- + +This module is maintained by the OCA. + +.. image:: https://odoo-community.org/logo.png + :alt: Odoo Community Association + :target: https://odoo-community.org + +OCA, or the Odoo Community Association, is a nonprofit organization whose +mission is to support the collaborative development of Odoo features and +promote its widespread use. + +This module is part of the `OCA/server-env `_ project on GitHub. + +You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. diff --git a/auth_oauth_environment/__init__.py b/auth_oauth_environment/__init__.py new file mode 100644 index 000000000..0650744f6 --- /dev/null +++ b/auth_oauth_environment/__init__.py @@ -0,0 +1 @@ +from . import models diff --git a/auth_oauth_environment/__manifest__.py b/auth_oauth_environment/__manifest__.py new file mode 100644 index 000000000..d754a386b --- /dev/null +++ b/auth_oauth_environment/__manifest__.py @@ -0,0 +1,18 @@ +# Copyright 2017 Camptocamp SA +# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). +{ + "name": "Auth oauth configuration with server_environment", + "version": "17.0.1.0.0", + "category": "Tools", + "summary": "Configure mail servers with server_environment_files", + "author": "Camptocamp SA, Odoo Community Association (OCA)", + "license": "AGPL-3", + "website": "https://github.com/OCA/server-env", + "depends": [ + "auth_oauth", + "server_environment", + ], + "data": ["data/auth_oauth_provider.xml"], + "auto_install": False, + "installable": True, +} diff --git a/auth_oauth_environment/data/auth_oauth_provider.xml b/auth_oauth_environment/data/auth_oauth_provider.xml new file mode 100644 index 000000000..0927d0f96 --- /dev/null +++ b/auth_oauth_environment/data/auth_oauth_provider.xml @@ -0,0 +1,12 @@ + + + + provider_openerp + + + provider_facebook + + + provider_google + + diff --git a/auth_oauth_environment/models/__init__.py b/auth_oauth_environment/models/__init__.py new file mode 100644 index 000000000..4bc62d3ab --- /dev/null +++ b/auth_oauth_environment/models/__init__.py @@ -0,0 +1 @@ +from . import auth_oauth_provider diff --git a/auth_oauth_environment/models/auth_oauth_provider.py b/auth_oauth_environment/models/auth_oauth_provider.py new file mode 100644 index 000000000..65ba5ddfb --- /dev/null +++ b/auth_oauth_environment/models/auth_oauth_provider.py @@ -0,0 +1,24 @@ +# Copyright 2017 Camptocamp SA +# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). + + +from odoo import api, models + + +class AuthOAuthProvider(models.Model): + _name = "auth.oauth.provider" + _inherit = ["auth.oauth.provider", "server.env.techname.mixin", "server.env.mixin"] + + @property + def _server_env_fields(self): + base_fields = super()._server_env_fields + oauth_fields = { + "client_id": {}, + "enabled": {}, + } + oauth_fields.update(base_fields) + return oauth_fields + + @api.model + def _server_env_global_section_name(self): + return "auth_oauth" diff --git a/auth_oauth_environment/pyproject.toml b/auth_oauth_environment/pyproject.toml new file mode 100644 index 000000000..4231d0ccc --- /dev/null +++ b/auth_oauth_environment/pyproject.toml @@ -0,0 +1,3 @@ +[build-system] +requires = ["whool"] +build-backend = "whool.buildapi" diff --git a/auth_oauth_environment/readme/CONFIGURE.md b/auth_oauth_environment/readme/CONFIGURE.md new file mode 100644 index 000000000..9ac4dcd74 --- /dev/null +++ b/auth_oauth_environment/readme/CONFIGURE.md @@ -0,0 +1,27 @@ +To configure this module, you need to add a section +``[auth_oauth.provider_name]`` to you server_environment_files +configurations, where 'provider_name' match the tech_name field on +auth.oauth.provider. + +'provider_name' is the first part (until first space character) in +lower case of provider name. Using existing providers, it could be either +``provider_google``, ``provider_openerp``, or ``provider_facebook``. + +For example, if you want to activate Google and Odoo.com, your +server_environment_files should look like this: +``` + [auth_oauth.provider_google] + client_id=123456789101-abcdefghijklmnopqrstuvwxyz000000 + enabled=True + + [auth_oauth.provider_openerp] + enabled=True +``` + +Any provider not being enabled through server_environment_files will be set as +disabled automatically. + +If you want to define a new custom provider, you should pay attention to the +tech name to use in the server_environment_files. If you create a provider with +'provider_dummy' as its tech_name, then the section should be named +``[auth_oauth.provider_dummy]``. diff --git a/auth_oauth_environment/readme/CONTRIBUTORS.md b/auth_oauth_environment/readme/CONTRIBUTORS.md new file mode 100644 index 000000000..a8a8313d1 --- /dev/null +++ b/auth_oauth_environment/readme/CONTRIBUTORS.md @@ -0,0 +1,3 @@ +- [Camptocamp](https://www.camptocamp.com) + - Akim Juillerat + - Vincent Van Rossem > diff --git a/auth_oauth_environment/readme/DESCRIPTION.md b/auth_oauth_environment/readme/DESCRIPTION.md new file mode 100644 index 000000000..d4a49f689 --- /dev/null +++ b/auth_oauth_environment/readme/DESCRIPTION.md @@ -0,0 +1,3 @@ +This module extends the functionality of server environment to support OAuth +providers, and allows you to enable providers and set client_id key according +to environment. (Refer to module server_environment for more informations) diff --git a/auth_oauth_environment/readme/INSTALL.md b/auth_oauth_environment/readme/INSTALL.md new file mode 100644 index 000000000..9b4807850 --- /dev/null +++ b/auth_oauth_environment/readme/INSTALL.md @@ -0,0 +1,2 @@ +To install this module, you need to have the server_environment module +installed and properly configured. diff --git a/auth_oauth_environment/readme/USAGE.md b/auth_oauth_environment/readme/USAGE.md new file mode 100644 index 000000000..dd4e95b7f --- /dev/null +++ b/auth_oauth_environment/readme/USAGE.md @@ -0,0 +1,5 @@ +Once configured, Odoo will read from server_environment_files the following +fields of auth.oauth.provider : + +* Allowed (``enabled``) +* Client ID (``client_id``) diff --git a/auth_oauth_environment/static/description/icon.png b/auth_oauth_environment/static/description/icon.png new file mode 100644 index 000000000..3a0328b51 Binary files /dev/null and b/auth_oauth_environment/static/description/icon.png differ diff --git a/auth_oauth_environment/static/description/index.html b/auth_oauth_environment/static/description/index.html new file mode 100644 index 000000000..273af186a --- /dev/null +++ b/auth_oauth_environment/static/description/index.html @@ -0,0 +1,473 @@ + + + + + +Auth oauth configuration with server_environment + + + +
+

Auth oauth configuration with server_environment

+ + +

Beta License: AGPL-3 OCA/server-env Translate me on Weblate Try me on Runboat

+

This module extends the functionality of server environment to support +OAuth providers, and allows you to enable providers and set client_id +key according to environment. (Refer to module server_environment for +more informations)

+

Table of contents

+ +
+

Installation

+

To install this module, you need to have the server_environment module +installed and properly configured.

+
+
+

Configuration

+

To configure this module, you need to add a section +[auth_oauth.provider_name] to you server_environment_files +configurations, where ‘provider_name’ match the tech_name field on +auth.oauth.provider.

+

‘provider_name’ is the first part (until first space character) in lower +case of provider name. Using existing providers, it could be either +provider_google, provider_openerp, or provider_facebook.

+

For example, if you want to activate Google and Odoo.com, your +server_environment_files should look like this:

+
+[auth_oauth.provider_google]
+client_id=123456789101-abcdefghijklmnopqrstuvwxyz000000
+enabled=True
+
+[auth_oauth.provider_openerp]
+enabled=True
+
+

Any provider not being enabled through server_environment_files will be +set as disabled automatically.

+

If you want to define a new custom provider, you should pay attention to +the tech name to use in the server_environment_files. If you create a +provider with ‘provider_dummy’ as its tech_name, then the section should +be named [auth_oauth.provider_dummy].

+
+
+

Usage

+

Once configured, Odoo will read from server_environment_files the +following fields of auth.oauth.provider :

+
    +
  • Allowed (enabled)
    • +
  • Client ID (client_id)
    • +
+
+
+

Bug Tracker

+

Bugs are tracked on GitHub Issues. +In case of trouble, please check there if your issue has already been reported. +If you spotted it first, help us to smash it by providing a detailed and welcomed +feedback.

+

Do not contact contributors directly about support or help with technical issues.

+
+
+

Credits

+
+

Authors

+
    +
  • Camptocamp SA
    • +
+
+ +
+

Maintainers

+

This module is maintained by the OCA.

+ +Odoo Community Association + +

OCA, or the Odoo Community Association, is a nonprofit organization whose +mission is to support the collaborative development of Odoo features and +promote its widespread use.

+

This module is part of the OCA/server-env project on GitHub.

+

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

+
+
+
+ + diff --git a/auth_oauth_environment/tests/__init__.py b/auth_oauth_environment/tests/__init__.py new file mode 100644 index 000000000..8656ffddb --- /dev/null +++ b/auth_oauth_environment/tests/__init__.py @@ -0,0 +1 @@ +from . import test_auth_oauth_environment diff --git a/auth_oauth_environment/tests/test_auth_oauth_environment.py b/auth_oauth_environment/tests/test_auth_oauth_environment.py new file mode 100644 index 000000000..ea9719405 --- /dev/null +++ b/auth_oauth_environment/tests/test_auth_oauth_environment.py @@ -0,0 +1,19 @@ +# Copyright 2024 Camptocamp (https://www.camptocamp.com). +# License LGPL-3.0 or later (https://www.gnu.org/licenses/lgpl.html) + + +from odoo.addons.server_environment.tests.common import ServerEnvironmentCase + +custom_config = """ +[auth_oauth.provider_google] +client_id = YOUR_OAUTH_GOOGLE_CLIENT_ID +enabled = True +""" + + +class TestAuthOAuthEnvironment(ServerEnvironmentCase): + def test_auth_oauth_provider(self): + provider_google = self.env.ref("auth_oauth.provider_google", False) + with self.load_config(public=custom_config): + self.assertEqual(provider_google.client_id, "YOUR_OAUTH_GOOGLE_CLIENT_ID") + self.assertTrue(provider_google.enabled)