[17.0][MIG] auth_oauth_environment: Migration to 17.0

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 <https://github.com/OCA/server-env/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 <https://github.com/OCA/server-env/issues/new?body=module:%20auth_oauth_environment%0Aversion:%2017.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
+
+Do not contact contributors directly about support or help with technical issues.
+
+Credits
+=======
+
+Authors
+-------
+
+* Camptocamp SA
+
+Contributors
+------------
+
+-  `Camptocamp <https://www.camptocamp.com>`__
+
+   -  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 <https://github.com/OCA/server-env/tree/17.0/auth_oauth_environment>`_ project on GitHub.
+
+You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

auth_oauth_environment/__init__.py

@@ -0,0 +1 @@
+from . import models

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,
+}

auth_oauth_environment/data/auth_oauth_provider.xml

@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<odoo noupdate="1">
+    <record id="auth_oauth.provider_openerp" model="auth.oauth.provider">
+        <field name="tech_name">provider_openerp</field>
+    </record>
+    <record id="auth_oauth.provider_facebook" model="auth.oauth.provider">
+        <field name="tech_name">provider_facebook</field>
+    </record>
+    <record id="auth_oauth.provider_google" model="auth.oauth.provider">
+        <field name="tech_name">provider_google</field>
+    </record>
+</odoo>

auth_oauth_environment/models/__init__.py

@@ -0,0 +1 @@
+from . import auth_oauth_provider

auth_oauth_environment/models/auth_oauth_provider.py

@@ -0,0 +1,36 @@
+# Copyright 2017 Camptocamp SA
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
+
+
+from odoo import _, api, fields, models
+from odoo.exceptions import UserError
+
+
+class AuthOAuthProvider(models.Model):
+    _name = "auth.oauth.provider"
+    _inherit = ["auth.oauth.provider", "server.env.techname.mixin", "server.env.mixin"]
+
+    enabled = fields.Boolean(search="_search_enabled")
+
+    @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"
+
+    @api.model
+    def _search_enabled(self, operator, value):
+        if operator not in ["=", "!="] or not isinstance(value, bool):
+            raise UserError(_("Operation not supported"))
+        if operator != "=":
+            value = not value
+        enabled = self.search([]).filtered(lambda p: p.enabled)
+        return [("id", "in" if value else "not in", enabled.ids)]

auth_oauth_environment/pyproject.toml

@@ -0,0 +1,3 @@
+[build-system]
+requires = ["whool"]
+build-backend = "whool.buildapi"

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]``.

auth_oauth_environment/readme/CONTRIBUTORS.md

@@ -0,0 +1,3 @@
+- [Camptocamp](https://www.camptocamp.com)
+  - Akim Juillerat <akim.juillerat@camptocamp.com>
+  - Vincent Van Rossem <vincent.vanrossem@camptocamp.com>>

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)

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.

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``)