Merge PR #85 into 13.0

Signed-off-by dreispt

base_external_system/README.rst

@@ -0,0 +1,121 @@
+====================
+Base External System
+====================
+
+.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+   !! This file is generated by oca-gen-addon-readme !!
+   !! changes will be overwritten.                   !!
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+.. |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-LGPL--3-blue.png
+    :target: http://www.gnu.org/licenses/lgpl-3.0-standalone.html
+    :alt: License: LGPL-3
+.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fserver--backend-lightgray.png?logo=github
+    :target: https://github.com/OCA/server-backend/tree/12.0/base_external_system
+    :alt: OCA/server-backend
+.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
+    :target: https://translation.odoo-community.org/projects/server-backend-12-0/server-backend-12-0-base_external_system
+    :alt: Translate me on Weblate
+.. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png
+    :target: https://runbot.odoo-community.org/runbot/253/12.0
+    :alt: Try me on Runbot
+
+|badge1| |badge2| |badge3| |badge4| |badge5| 
+
+This module provides an interface/adapter mechanism for the definition of remote
+systems.
+
+Note that this module stores everything in plain text. In the interest of security,
+it is recommended you use another module (such as `keychain` or `red_october` to
+encrypt things like the password and private key). This is not done here in order
+to not force a specific security method.
+
+**Table of contents**
+
+.. contents::
+   :local:
+
+Configuration
+=============
+
+Configure external systems in Settings => Technical => External Systems
+
+Usage
+=====
+
+The credentials for systems are stored in the ``external.system`` model, and are to
+be configured by the user. This model is the unified interface for the underlying
+adapters.
+
+Using the Interface
+~~~~~~~~~~~~~~~~~~~
+
+Given an ``external.system`` singleton called ``external_system``, you would do the
+following to get the underlying system client:
+
+.. code-block:: python
+
+   with external_system.client() as client:
+       client.do_something()
+
+The client will be destroyed once the context has completed. Destruction takes place
+in the adapter's ``external_destroy_client`` method.
+
+The only unified aspect of this interface is the client connection itself. Other more
+opinionated interface/adapter mechanisms can be implemented in other modules, such as
+the file system interface in `OCA/server-tools/external_file_location
+<https://github.com/OCA/server-tools/tree/9.0/external_file_location>`_.
+
+Creating an Adapter
+~~~~~~~~~~~~~~~~~~~
+
+Modules looking to add an external system adapter should inherit the
+``external.system.adapter`` model and override the following methods:
+
+* ``external_get_client``: Returns a usable client for the system
+* ``external_destroy_client``: Destroy the connection, if applicable. Does not need
+  to be defined if the connection destroys itself.
+
+Bug Tracker
+===========
+
+Bugs are tracked on `GitHub Issues <https://github.com/OCA/server-backend/issues>`_.
+In case of trouble, please check there if your issue has already been reported.
+If you spotted it first, help us smashing it by providing a detailed and welcomed
+`feedback <https://github.com/OCA/server-backend/issues/new?body=module:%20base_external_system%0Aversion:%2012.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
+~~~~~~~
+
+* LasLabs
+
+Contributors
+~~~~~~~~~~~~
+
+* Dave Lasley <dave@laslabs.com>
+* Alexandre Díaz <alexandre.diaz@tecnativa.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-backend <https://github.com/OCA/server-backend/tree/12.0/base_external_system>`_ project on GitHub.
+
+You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

base_external_system/__init__.py

@@ -0,0 +1,4 @@
+# Copyright 2017 LasLabs Inc.
+# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl.html).
+
+from . import models

base_external_system/__manifest__.py

@@ -0,0 +1,20 @@
+# Copyright 2017 LasLabs Inc.
+# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl.html).
+
+{
+    "name": "Base External System",
+    "summary": "Data models allowing for connection to external systems.",
+    "version": "13.0.1.0.0",
+    "category": "Base",
+    "website": "https://github.com/OCA/server-backend",
+    "author": "LasLabs, " "Odoo Community Association (OCA)",
+    "license": "LGPL-3",
+    "application": False,
+    "installable": True,
+    "depends": ["base"],
+    "data": [
+        "demo/external_system_os_demo.xml",
+        "security/ir.model.access.csv",
+        "views/external_system_view.xml",
+    ],
+}

base_external_system/demo/external_system_os_demo.xml

@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<!--
+    Copyright 2017 LasLabs Inc.
+    License LGPL-3.0 or later (https://www.gnu.org/licenses/lgpl).
+-->
+<odoo>
+    <record id="external_system_os" model="external.system.os">
+        <field name="name">Example OS Connection</field>
+        <field name="system_type">external.system.os</field>
+        <field name="remote_path">/tmp</field>
+        <field name="company_ids" eval="[(5, 0), (4, ref('base.main_company'))]" />
+    </record>
+</odoo>