Browse Source

[ADD] easy_my_coop_connector

pull/115/head
robin.keunen 5 years ago
parent
commit
7af6ed82bf
  1. 30
      easy_my_coop_api/models/external_id_mixin.py
  2. 65
      easy_my_coop_connector/README.rst
  3. 1
      easy_my_coop_connector/__init__.py
  4. 26
      easy_my_coop_connector/__manifest__.py
  5. 24
      easy_my_coop_connector/demo/demo.xml
  6. 3
      easy_my_coop_connector/models/__init__.py
  7. 84
      easy_my_coop_connector/models/emc_backend.py
  8. 48
      easy_my_coop_connector/models/emc_bindings.py
  9. 73
      easy_my_coop_connector/models/subscription_request.py
  10. 92
      easy_my_coop_connector/models/subscription_request_adapter.py
  11. 2
      easy_my_coop_connector/readme/CONTRIBUTORS.rst
  12. 1
      easy_my_coop_connector/readme/DESCRIPTION.rst
  13. 0
      easy_my_coop_connector/readme/ROADMAP.rst
  14. 22
      easy_my_coop_connector/readme/USAGE.rst
  15. 4
      easy_my_coop_connector/security/ir.model.access.csv
  16. 423
      easy_my_coop_connector/static/description/index.html
  17. 1
      easy_my_coop_connector/tests/__init__.py
  18. 101
      easy_my_coop_connector/tests/test_subscription_request.py
  19. 25
      easy_my_coop_connector/views/actions.xml
  20. 47
      easy_my_coop_connector/views/emc_backend.xml
  21. 62
      easy_my_coop_connector/views/emc_bindings.xml
  22. 35
      easy_my_coop_connector/views/menus.xml

30
easy_my_coop_api/models/external_id_mixin.py

@ -2,6 +2,8 @@
# Robin Keunen <robin@coopiteasy.be> # Robin Keunen <robin@coopiteasy.be>
# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html). # License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html).
from psycopg2 import IntegrityError
from odoo import api, fields, models from odoo import api, fields, models
@ -9,6 +11,14 @@ class ExternalIdMixin(models.AbstractModel):
_name = "external.id.mixin" _name = "external.id.mixin"
_description = "External ID Mixin" _description = "External ID Mixin"
_sql_constraints = [
(
"_api_external_id_uniq",
"unique(_api_external_id)",
"API External ID must be unique!",
)
]
# do not access directly, always use get_api_external_id method # do not access directly, always use get_api_external_id method
_api_external_id = fields.Integer( _api_external_id = fields.Integer(
string="External ID", index=True, required=False string="External ID", index=True, required=False
@ -28,7 +38,7 @@ class ExternalIdMixin(models.AbstractModel):
sequence = Sequence.search([("code", "=", code)]) sequence = Sequence.search([("code", "=", code)])
if not sequence: if not sequence:
sequence = Sequence.sudo().create( sequence = Sequence.sudo().create(
{"name": code, "code": code, "number_next": 1}
{"name": code, "code": code, "number_next": 100}
) )
self.sudo().write({"external_id_sequence_id": sequence.id}) self.sudo().write({"external_id_sequence_id": sequence.id})
@ -40,9 +50,21 @@ class ExternalIdMixin(models.AbstractModel):
if not self.external_id_sequence_id: if not self.external_id_sequence_id:
self.set_external_sequence() self.set_external_sequence()
if not self._api_external_id: if not self._api_external_id:
self.sudo().write(
{"_api_external_id": self.external_id_sequence_id._next()}
)
# pass already allocated ids
n = 100
while True:
try:
self.sudo().write(
{
"_api_external_id": self.external_id_sequence_id._next()
}
)
break
except IntegrityError as e:
if n > 0:
continue
else:
raise e
return self._api_external_id return self._api_external_id

65
easy_my_coop_connector/README.rst

@ -0,0 +1,65 @@
======================
Easy My Coop Connector
======================
.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! 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-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-coopiteasy%2Fvertical--cooperative-lightgray.png?logo=github
:target: https://github.com/coopiteasy/vertical-cooperative/tree/12.0/easy_my_coop_connector
:alt: coopiteasy/vertical-cooperative
|badge1| |badge2| |badge3|
Connect to Easy My Coop RESTful API.
**Table of contents**
.. contents::
:local:
Usage
=====
Get an API token from the Eeasy My Copp API you wish to connect to
and setup a backend at
- Settings > Technical (debug mode) > EMC Backend
Bug Tracker
===========
Bugs are tracked on `GitHub Issues <https://github.com/coopiteasy/vertical-cooperative/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/coopiteasy/vertical-cooperative/issues/new?body=module:%20easy_my_coop_connector%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
~~~~~~~
* Coop IT Easy SCRLfs
Contributors
~~~~~~~~~~~~
* Coop IT Easy SCRLfs
* Robin Keunen <robin@coopiteasy.be>
Maintainers
~~~~~~~~~~~
This module is part of the `coopiteasy/vertical-cooperative <https://github.com/coopiteasy/vertical-cooperative/tree/12.0/easy_my_coop_connector>`_ project on GitHub.
You are welcome to contribute.

1
easy_my_coop_connector/__init__.py

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

26
easy_my_coop_connector/__manifest__.py

@ -0,0 +1,26 @@
# Copyright 2020 Coop IT Easy SCRL fs
# Robin Keunen <robin@coopiteasy.be>
# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html).
{
"name": "Easy My Coop Connector",
"version": "12.0.0.0.1",
"depends": ["easy_my_coop"],
"author": "Coop IT Easy SCRLfs",
"category": "Connector",
"website": "www.coopiteasy.be",
"license": "AGPL-3",
"summary": """
Connect to Easy My Coop RESTful API.
""",
"data": [
"security/ir.model.access.csv",
"views/emc_backend.xml",
"views/emc_bindings.xml",
"views/actions.xml",
"views/menus.xml",
],
"demo": ["demo/demo.xml"],
"installable": True,
"application": False,
}

24
easy_my_coop_connector/demo/demo.xml

@ -0,0 +1,24 @@
<?xml version="1.0" encoding="utf-8"?>
<!--
Copyright 2020 Coop IT Easy
License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
-->
<odoo>
<record id="emc_backend_demo" model="emc.backend">
<field name="name">IWP backend</field>
<field name="location">http://localhost:9876</field>
<field name="api_key">cbd07f57-c903-43b4-b668-436b3bec5f15</field>
</record>
<record id="emc_binding_product_template_A_demo" model="emc.binding.product.template">
<field name="backend_id" ref="emc_backend_demo"/>
<field name="internal_id" ref="easy_my_coop.product_template_share_type_1_demo"/>
<field name="external_id">37</field>
</record>
<record id="emc_binding_product_template_B_demo" model="emc.binding.product.template">
<field name="backend_id" ref="emc_backend_demo"/>
<field name="internal_id" ref="easy_my_coop.product_template_share_type_2_demo"/>
<field name="external_id">38</field>
</record>
</odoo>

3
easy_my_coop_connector/models/__init__.py

@ -0,0 +1,3 @@
from . import emc_backend
from . import emc_bindings
from . import subscription_request

84
easy_my_coop_connector/models/emc_backend.py

@ -0,0 +1,84 @@
# Copyright 2020 Coop IT Easy SCRL fs
# Robin Keunen <robin@coopiteasy.be>
# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html).
import json
import logging
import requests
from werkzeug.exceptions import NotFound
from odoo import _, api, fields, models
_logger = logging.getLogger(__name__)
class EMCBackend(models.Model):
_name = "emc.backend"
_description = "EMC Backend"
name = fields.Char(string="Name", required=True)
location = fields.Char(string="Location")
api_key = fields.Char(string="API Key")
description = fields.Text(string="Description", required=False)
active = fields.Boolean(string="active", default=True)
@api.multi
def http_get(self, url, params=None, headers=None):
self.ensure_one()
headers = self._add_api_key(headers)
if url.startswith("/"):
url = self.location + url
return requests.get(url, params=params, headers=headers)
@api.multi
def http_get_content(self, url, params=None, headers=None):
self.ensure_one()
response = self.http_get(url, params=params, headers=headers)
if response.status_code == 200:
content = response.content.decode("utf-8")
return json.loads(content)
else:
# todo handle different codes (at least 404, 403, 500)
raise NotFound(
_("request returned status code %s" % response.status_code)
)
@api.multi
def http_post(self, url, data, headers=None):
self.ensure_one()
headers = self._add_api_key(headers)
if url.startswith("/"):
url = self.location + url
return requests.post(url, json=data, headers=headers)
@api.multi
def _add_api_key(self, headers):
self.ensure_one()
key_dict = {"API-KEY": self.api_key}
if headers:
headers.update(key_dict)
else:
headers = key_dict
return headers
@api.multi
def action_ping(self):
self.ensure_one()
url = self.location + "/api/ping/test"
try:
response = requests.get(url)
except Exception as e:
_logger.error(e)
raise Warning(_("Failed to connect to backend: %s" % str(e)))
if response.status_code == 200:
content = json.loads(response.content.decode("utf-8"))
raise Warning(_("Success: %s") % content["message"])
else:
raise Warning(
_("Failed to connect to backend: %s" % str(response.content))
)

48
easy_my_coop_connector/models/emc_bindings.py

@ -0,0 +1,48 @@
# Copyright 2020 Coop IT Easy SCRL fs
# Robin Keunen <robin@coopiteasy.be>
# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html).
from odoo import api, fields, models
class EMCBinding(models.AbstractModel):
_name = "emc.binding"
_description = "EMC Binding (abstract)"
backend_id = fields.Many2one(
comodel_name="emc.backend", string="EMC Backend", ondelete="restrict"
)
external_id = fields.Integer(string="ID in Platform", index=True)
# odoo_id = fields.Many2one # implement in concrete class
@api.model
def search_binding(self, backend, external_id):
return self.search(
[
("backend_id", "=", backend.id),
("external_id", "=", external_id),
]
)
class SubscriptionRequestBinding(models.Model):
_name = "emc.binding.subscription.request"
_inherit = "emc.binding"
internal_id = fields.Many2one(
comodel_name="subscription.request",
string="Internal ID",
required=True,
)
class ProductTemplateBinding(models.Model):
_name = "emc.binding.product.template"
_inherit = "emc.binding"
internal_id = fields.Many2one(
comodel_name="product.template",
string="Internal ID",
domain="[('is_share', '=', True)]",
required=True,
)

73
easy_my_coop_connector/models/subscription_request.py

@ -0,0 +1,73 @@
# Copyright 2020 Coop IT Easy SCRL fs
# Robin Keunen <robin@coopiteasy.be>
# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html).
from odoo import api, fields, models
from .subscription_request_adapter import SubscriptionRequestAdapter
class SubscriptionRequest(models.Model):
_inherit = "subscription.request"
source = fields.Selection(selection_add=[("emc_api", "Easy My Coop API")])
binding_id = fields.One2many(
comodel_name="emc.binding.subscription.request",
inverse_name="internal_id",
string="Binding ID",
required=False,
)
@api.model
def fetch_subscription_requests(self, date_from=None, date_to=None):
SRBinding = self.env["emc.binding.subscription.request"]
backend = self.env["emc.backend"].search([("active", "=", True)])
backend.ensure_one()
adapter = SubscriptionRequestAdapter(backend=backend)
requests_dict = adapter.search(date_from=date_from, date_to=date_to)
for request_dict in requests_dict["rows"]:
external_id = request_dict["id"]
request_values = adapter.to_write_values(request_dict)
sr_binding = SRBinding.search_binding(backend, external_id)
if sr_binding: # update request
sr_binding.internal_id.write(request_values)
else:
srequest = self.env["subscription.request"].create(
request_values
)
SRBinding.create(
{
"backend_id": backend.id,
"external_id": external_id,
"internal_id": srequest.id,
}
)
@api.model
def backend_read(self, external_id):
SRBinding = self.env["emc.binding.subscription.request"]
backend = self.env["emc.backend"].search([("active", "=", True)])
backend.ensure_one()
adapter = SubscriptionRequestAdapter(backend)
sr_data = adapter.read(external_id)
# todo 404
request_values = adapter.to_write_values(sr_data)
sr_binding = SRBinding.search_binding(backend, external_id)
if sr_binding: # update request
srequest = sr_binding.internal_id.write(request_values)
else:
srequest = self.env["subscription.request"].create(request_values)
SRBinding.create(
{
"backend_id": backend.id,
"external_id": external_id,
"internal_id": srequest.id,
}
)
return srequest

92
easy_my_coop_connector/models/subscription_request_adapter.py

@ -0,0 +1,92 @@
# Copyright 2020 Coop IT Easy SCRL fs
# Robin Keunen <robin@coopiteasy.be>
# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html).
from os.path import join
from odoo import _
from odoo.exceptions import UserError
from odoo.fields import Date
class SubscriptionRequestAdapter:
_model = "subscription.request"
_root = "api"
_service = "subscription-request"
def __init__(self, backend):
self.backend = backend
def get_url(self, args):
"""args is a list of path elements
:return the complete route to the service
"""
return join("/", self._root, self._service, *args)
def create(self):
# pylint: disable=method-required-super
raise NotImplementedError
def search(self, date_from=None, date_to=None):
url = self.get_url([])
params = {}
if date_from:
params.update({"date_from": Date.to_string(date_from)})
if date_to:
params.update({"date_to": Date.to_string(date_to)})
sr_list = self.backend.http_get_content(url, params=params)
return sr_list
def read(self, id_):
# pylint: disable=method-required-super
url = self.get_url([str(id_)])
sr = self.backend.http_get_content(url)
return sr
def update(self):
raise NotImplementedError
def delete(self):
raise NotImplementedError
def to_write_values(self, request):
"""
:return a writable dictionary of values from the dictionary
received from the api
"""
address = request["address"]
Country = self.backend.env["res.country"]
country = Country.search([("code", "=", address["country"])])
ProductTemplateBinding = self.backend.env[
"emc.binding.product.template"
]
external_product_id = request["share_product"]["id"]
share_product_binding = ProductTemplateBinding.search_binding(
self.backend, external_product_id
)
if not share_product_binding:
raise UserError(
_(
"No binding exists for share product %s. Please contact "
"system administrator "
)
% request["share_product"]["name"]
)
return {
"email": request["email"],
"name": request["name"],
"date": request["date"],
"state": request["state"],
"lang": request["lang"],
"ordered_parts": request["ordered_parts"],
"address": address["street"],
"zip_code": address["zip_code"],
"city": address["city"],
"country_id": country.id,
"share_product_id": share_product_binding.internal_id.id,
"source": "emc_api",
}

2
easy_my_coop_connector/readme/CONTRIBUTORS.rst

@ -0,0 +1,2 @@
* Coop IT Easy SCRLfs
* Robin Keunen <robin@coopiteasy.be>

1
easy_my_coop_connector/readme/DESCRIPTION.rst

@ -0,0 +1 @@
Connect to Easy My Coop RESTful API.

0
easy_my_coop_connector/readme/ROADMAP.rst

22
easy_my_coop_connector/readme/USAGE.rst

@ -0,0 +1,22 @@
## Configuration
Get an API token from the Easy My Coop API you wish to connect to
and setup a backend at
- Settings > Technical (debug mode) > EMC Backend
## Concepts
The models are heavily influenced by the odoo connector:
- emc_backend
- connects to the API, sends HTTP requests, converts json to dictionaries
- <model>_adapter
- uses the backend to send query for model it's responsible for.
- adapts the objects to api format dictionaries
- adapts the result dictionaries to writable dictionaries
- <model>_binding
- links an internal record with an external record for each backend
The <model> is responsible for the orchestration of these components.
In the current implementation, only one backend is allowed.

4
easy_my_coop_connector/security/ir.model.access.csv

@ -0,0 +1,4 @@
id,name,model_id:id,group_id:id,perm_read,perm_write,perm_create,perm_unlink
access_emc_backend_administrator,access_emc_backend_administrator,model_emc_backend,base.group_system,1,1,1,1
access_emc_binding_subscription_request_administrator,access_emc_binding_subscription_request_administrator,model_emc_binding_subscription_request,base.group_system,1,1,1,1
access_emc_binding_product_template_administrator,access_emc_binding_product_template_administrator,model_emc_binding_product_template,base.group_system,1,1,1,1

423
easy_my_coop_connector/static/description/index.html

@ -0,0 +1,423 @@
<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="Docutils 0.15.1: http://docutils.sourceforge.net/" />
<title>Easy My Coop Connector</title>
<style type="text/css">
/*
:Author: David Goodger (goodger@python.org)
:Id: $Id: html4css1.css 7952 2016-07-26 18:15:59Z milde $
:Copyright: This stylesheet has been placed in the public domain.
Default cascading style sheet for the HTML output of Docutils.
See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to
customize this style sheet.
*/
/* used to remove borders from tables and images */
.borderless, table.borderless td, table.borderless th {
border: 0 }
table.borderless td, table.borderless th {
/* Override padding for "table.docutils td" with "! important".
The right padding separates the table cells. */
padding: 0 0.5em 0 0 ! important }
.first {
/* Override more specific margin styles with "! important". */
margin-top: 0 ! important }
.last, .with-subtitle {
margin-bottom: 0 ! important }
.hidden {
display: none }
.subscript {
vertical-align: sub;
font-size: smaller }
.superscript {
vertical-align: super;
font-size: smaller }
a.toc-backref {
text-decoration: none ;
color: black }
blockquote.epigraph {
margin: 2em 5em ; }
dl.docutils dd {
margin-bottom: 0.5em }
object[type="image/svg+xml"], object[type="application/x-shockwave-flash"] {
overflow: hidden;
}
/* Uncomment (and remove this text!) to get bold-faced definition list terms
dl.docutils dt {
font-weight: bold }
*/
div.abstract {
margin: 2em 5em }
div.abstract p.topic-title {
font-weight: bold ;
text-align: center }
div.admonition, div.attention, div.caution, div.danger, div.error,
div.hint, div.important, div.note, div.tip, div.warning {
margin: 2em ;
border: medium outset ;
padding: 1em }
div.admonition p.admonition-title, div.hint p.admonition-title,
div.important p.admonition-title, div.note p.admonition-title,
div.tip p.admonition-title {
font-weight: bold ;
font-family: sans-serif }
div.attention p.admonition-title, div.caution p.admonition-title,
div.danger p.admonition-title, div.error p.admonition-title,
div.warning p.admonition-title, .code .error {
color: red ;
font-weight: bold ;
font-family: sans-serif }
/* Uncomment (and remove this text!) to get reduced vertical space in
compound paragraphs.
div.compound .compound-first, div.compound .compound-middle {
margin-bottom: 0.5em }
div.compound .compound-last, div.compound .compound-middle {
margin-top: 0.5em }
*/
div.dedication {
margin: 2em 5em ;
text-align: center ;
font-style: italic }
div.dedication p.topic-title {
font-weight: bold ;
font-style: normal }
div.figure {
margin-left: 2em ;
margin-right: 2em }
div.footer, div.header {
clear: both;
font-size: smaller }
div.line-block {
display: block ;
margin-top: 1em ;
margin-bottom: 1em }
div.line-block div.line-block {
margin-top: 0 ;
margin-bottom: 0 ;
margin-left: 1.5em }
div.sidebar {
margin: 0 0 0.5em 1em ;
border: medium outset ;
padding: 1em ;
background-color: #ffffee ;
width: 40% ;
float: right ;
clear: right }
div.sidebar p.rubric {
font-family: sans-serif ;
font-size: medium }
div.system-messages {
margin: 5em }
div.system-messages h1 {
color: red }
div.system-message {
border: medium outset ;
padding: 1em }
div.system-message p.system-message-title {
color: red ;
font-weight: bold }
div.topic {
margin: 2em }
h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
h4.section-subtitle, h5.section-subtitle, h6.section-subtitle {
margin-top: 0.4em }
h1.title {
text-align: center }
h2.subtitle {
text-align: center }
hr.docutils {
width: 75% }
img.align-left, .figure.align-left, object.align-left, table.align-left {
clear: left ;
float: left ;
margin-right: 1em }
img.align-right, .figure.align-right, object.align-right, table.align-right {
clear: right ;
float: right ;
margin-left: 1em }
img.align-center, .figure.align-center, object.align-center {
display: block;
margin-left: auto;
margin-right: auto;
}
table.align-center {
margin-left: auto;
margin-right: auto;
}
.align-left {
text-align: left }
.align-center {
clear: both ;
text-align: center }
.align-right {
text-align: right }
/* reset inner alignment in figures */
div.align-right {
text-align: inherit }
/* div.align-center * { */
/* text-align: left } */
.align-top {
vertical-align: top }
.align-middle {
vertical-align: middle }
.align-bottom {
vertical-align: bottom }
ol.simple, ul.simple {
margin-bottom: 1em }
ol.arabic {
list-style: decimal }
ol.loweralpha {
list-style: lower-alpha }
ol.upperalpha {
list-style: upper-alpha }
ol.lowerroman {
list-style: lower-roman }
ol.upperroman {
list-style: upper-roman }
p.attribution {
text-align: right ;
margin-left: 50% }
p.caption {
font-style: italic }
p.credits {
font-style: italic ;
font-size: smaller }
p.label {
white-space: nowrap }
p.rubric {
font-weight: bold ;
font-size: larger ;
color: maroon ;
text-align: center }
p.sidebar-title {
font-family: sans-serif ;
font-weight: bold ;
font-size: larger }
p.sidebar-subtitle {
font-family: sans-serif ;
font-weight: bold }
p.topic-title {
font-weight: bold }
pre.address {
margin-bottom: 0 ;
margin-top: 0 ;
font: inherit }
pre.literal-block, pre.doctest-block, pre.math, pre.code {
margin-left: 2em ;
margin-right: 2em }
pre.code .ln { color: grey; } /* line numbers */
pre.code, code { background-color: #eeeeee }
pre.code .comment, code .comment { color: #5C6576 }
pre.code .keyword, code .keyword { color: #3B0D06; font-weight: bold }
pre.code .literal.string, code .literal.string { color: #0C5404 }
pre.code .name.builtin, code .name.builtin { color: #352B84 }
pre.code .deleted, code .deleted { background-color: #DEB0A1}
pre.code .inserted, code .inserted { background-color: #A3D289}
span.classifier {
font-family: sans-serif ;
font-style: oblique }
span.classifier-delimiter {
font-family: sans-serif ;
font-weight: bold }
span.interpreted {
font-family: sans-serif }
span.option {
white-space: nowrap }
span.pre {
white-space: pre }
span.problematic {
color: red }
span.section-subtitle {
/* font-size relative to parent (h1..h6 element) */
font-size: 80% }
table.citation {
border-left: solid 1px gray;
margin-left: 1px }
table.docinfo {
margin: 2em 4em }
table.docutils {
margin-top: 0.5em ;
margin-bottom: 0.5em }
table.footnote {
border-left: solid 1px black;
margin-left: 1px }
table.docutils td, table.docutils th,
table.docinfo td, table.docinfo th {
padding-left: 0.5em ;
padding-right: 0.5em ;
vertical-align: top }
table.docutils th.field-name, table.docinfo th.docinfo-name {
font-weight: bold ;
text-align: left ;
white-space: nowrap ;
padding-left: 0 }
/* "booktabs" style (no vertical lines) */
table.docutils.booktabs {
border: 0px;
border-top: 2px solid;
border-bottom: 2px solid;
border-collapse: collapse;
}
table.docutils.booktabs * {
border: 0px;
}
table.docutils.booktabs th {
border-bottom: thin solid;
text-align: left;
}
h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
font-size: 100% }
ul.auto-toc {
list-style-type: none }
</style>
</head>
<body>
<div class="document" id="easy-my-coop-connector">
<h1 class="title">Easy My Coop Connector</h1>
<!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! This file is generated by oca-gen-addon-readme !!
!! changes will be overwritten. !!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
<p><a class="reference external" href="https://odoo-community.org/page/development-status"><img alt="Beta" src="https://img.shields.io/badge/maturity-Beta-yellow.png" /></a> <a class="reference external" href="http://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.png" /></a> <a class="reference external" href="https://github.com/coopiteasy/vertical-cooperative/tree/12.0/easy_my_coop_connector"><img alt="coopiteasy/vertical-cooperative" src="https://img.shields.io/badge/github-coopiteasy%2Fvertical--cooperative-lightgray.png?logo=github" /></a></p>
<blockquote>
Connect to Easy My Coop RESTful API.</blockquote>
<p><strong>Table of contents</strong></p>
<div class="contents local topic" id="contents">
<ul class="simple">
<li><a class="reference internal" href="#usage" id="id1">Usage</a></li>
<li><a class="reference internal" href="#bug-tracker" id="id2">Bug Tracker</a></li>
<li><a class="reference internal" href="#credits" id="id3">Credits</a><ul>
<li><a class="reference internal" href="#authors" id="id4">Authors</a></li>
<li><a class="reference internal" href="#contributors" id="id5">Contributors</a></li>
<li><a class="reference internal" href="#maintainers" id="id6">Maintainers</a></li>
</ul>
</li>
</ul>
</div>
<div class="section" id="usage">
<h1><a class="toc-backref" href="#id1">Usage</a></h1>
<p>Get an API token from the Eeasy My Copp API you wish to connect to
and setup a backend at
- Settings &gt; Technical (debug mode) &gt; EMC Backend</p>
</div>
<div class="section" id="bug-tracker">
<h1><a class="toc-backref" href="#id2">Bug Tracker</a></h1>
<p>Bugs are tracked on <a class="reference external" href="https://github.com/coopiteasy/vertical-cooperative/issues">GitHub Issues</a>.
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
<a class="reference external" href="https://github.com/coopiteasy/vertical-cooperative/issues/new?body=module:%20easy_my_coop_connector%0Aversion:%2012.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p>
<p>Do not contact contributors directly about support or help with technical issues.</p>
</div>
<div class="section" id="credits">
<h1><a class="toc-backref" href="#id3">Credits</a></h1>
<div class="section" id="authors">
<h2><a class="toc-backref" href="#id4">Authors</a></h2>
<ul class="simple">
<li>Coop IT Easy SCRLfs</li>
</ul>
</div>
<div class="section" id="contributors">
<h2><a class="toc-backref" href="#id5">Contributors</a></h2>
<ul class="simple">
<li>Coop IT Easy SCRLfs</li>
<li>Robin Keunen &lt;<a class="reference external" href="mailto:robin&#64;coopiteasy.be">robin&#64;coopiteasy.be</a>&gt;</li>
</ul>
</div>
<div class="section" id="maintainers">
<h2><a class="toc-backref" href="#id6">Maintainers</a></h2>
<p>This module is part of the <a class="reference external" href="https://github.com/coopiteasy/vertical-cooperative/tree/12.0/easy_my_coop_connector">coopiteasy/vertical-cooperative</a> project on GitHub.</p>
<p>You are welcome to contribute.</p>
</div>
</div>
</div>
</body>
</html>

1
easy_my_coop_connector/tests/__init__.py

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

101
easy_my_coop_connector/tests/test_subscription_request.py

@ -0,0 +1,101 @@
# Copyright 2020 Coop IT Easy SCRL fs
# Robin Keunen <robin@coopiteasy.be>
# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html).
import datetime
import json
from unittest.mock import Mock, patch
import requests
from odoo.tests.common import TransactionCase
NOT_FOUND_ERROR = {"name": "Not Found", "code": 404}
FORBIDDEN_ERROR = {"name": "Forbidden", "code": 403}
SERVER_ERROR = {"name": "Server Error", "code": 500}
NO_RESULT = {"count": 0, "rows": []}
SEARCH_RESULT = {
"count": 1,
"rows": [
{
"id": 1,
"date": "2020-05-14",
"email": "manuel@demo.net",
"address": {
"city": "Brussels",
"street": "schaerbeekstraat",
"zip_code": "1111",
"country": "BE",
},
"lang": "en_US",
"ordered_parts": 3,
"name": "Manuel Dublues",
"share_product": {"name": "Part B - Worker", "id": 38},
"state": "draft",
}
],
}
GET_RESULT = {
"id": 1,
"name": "Robin Des Bois",
"date": "2020-05-14",
"email": "manuel@demo.net",
"address": {
"city": "Brussels",
"street": "schaerbeekstraat",
"zip_code": "1111",
"country": "BE",
},
"lang": "en_US",
"ordered_parts": 3,
"share_product": {"name": "Part B - Worker", "id": 38},
"state": "draft",
}
def dict_to_dump(content):
return json.dumps(content).encode("utf-8")
class TestCase(TransactionCase):
def setUp(self):
super().setUp()
self.backend = self.browse_ref(
"easy_my_coop_connector.emc_backend_demo"
)
def test_search_requests(self):
SubscriptionRequest = self.env["subscription.request"]
SRBinding = self.env["emc.binding.subscription.request"]
date_to = datetime.date.today()
date_from = date_to - datetime.timedelta(days=1)
with patch.object(requests, "get") as mock_get:
mock_get.return_value = mock_response = Mock()
mock_response.status_code = 200
mock_response.content = dict_to_dump(SEARCH_RESULT)
SubscriptionRequest.fetch_subscription_requests(
date_from=date_from, date_to=date_to
)
external_id = 1
binding = SRBinding.search_binding(self.backend, external_id)
self.assertTrue(
bool(binding),
"no binding created when searching subscription requests",
)
srequest = binding.internal_id
self.assertEquals(srequest.name, "Manuel Dublues")
with patch.object(requests, "get") as mock_get:
mock_get.return_value = mock_response = Mock()
mock_response.status_code = 200
mock_response.content = dict_to_dump(GET_RESULT)
SubscriptionRequest.backend_read(external_id)
self.assertEquals(srequest.name, "Robin Des Bois")

25
easy_my_coop_connector/views/actions.xml

@ -0,0 +1,25 @@
<?xml version="1.0" encoding="utf-8"?>
<!--
Copyright 2020 Coop IT Easy
License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
-->
<odoo>
<record id="emc_backend_action" model="ir.actions.act_window">
<field name="name">EMC Backend</field>
<field name="res_model">emc.backend</field>
<field name="view_mode">tree,form</field>
</record>
<record id="emc_binding_subscription_request_action" model="ir.actions.act_window">
<field name="name">Subscription Request Bindings</field>
<field name="res_model">emc.binding.subscription.request</field>
<field name="view_mode">tree,form</field>
</record>
<record id="emc_binding_product_template_action" model="ir.actions.act_window">
<field name="name">Share Product Bindings</field>
<field name="res_model">emc.binding.product.template</field>
<field name="view_mode">tree,form</field>
</record>
</odoo>

47
easy_my_coop_connector/views/emc_backend.xml

@ -0,0 +1,47 @@
<?xml version="1.0" encoding="utf-8"?>
<!--
Copyright 2020 Coop IT Easy
License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
-->
<odoo>
<record id="emc_backend_view_form" model="ir.ui.view">
<field name="name">emc_backend_view_form</field>
<field name="model">emc.backend</field>
<field name="arch" type="xml">
<form string="emc_backend_form">
<sheet>
<div class="oe_button_box" name="button_box">
<button name="toggle_active" type="object"
class="oe_stat_button" icon="fa-archive">
<field name="active" widget="boolean_button"
options="{'terminology': 'active'}"/>
</button>
</div>
<group>
<field name="location"/>
<field name="api_key"/>
<field name="description"/>
</group>
<footer>
<button name="action_ping"
string="Ping the API (no authentication)"
type="object"
class="oe_highlight"/>
</footer>
</sheet>
</form>
</field>
</record>
<record id="emc_backend_view_tree" model="ir.ui.view">
<field name="name">emc_backend_view_tree</field>
<field name="model">emc.backend</field>
<field name="arch" type="xml">
<tree string="emc_backend_tree">
<field name="location"/>
<field name="api_key"/>
</tree>
</field>
</record>
</odoo>

62
easy_my_coop_connector/views/emc_bindings.xml

@ -0,0 +1,62 @@
<?xml version="1.0" encoding="utf-8"?>
<!--
Copyright 2020 Coop IT Easy
License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
-->
<odoo>
<record id="emc_binding_subscription_request_view_form" model="ir.ui.view">
<field name="name">emc_binding_subscription_request_view_form</field>
<field name="model">emc.binding.subscription.request</field>
<field name="arch" type="xml">
<form string="emc_binding_subscription_request_form">
<sheet>
<group>
<field name="backend_id"/>
<field name="internal_id"/>
<field name="external_id"/>
</group>
</sheet>
</form>
</field>
</record>
<record id="emc_binding_subscription_request_view_tree" model="ir.ui.view">
<field name="name">emc_binding_subscription_request_view_tree</field>
<field name="model">emc.binding.subscription.request</field>
<field name="arch" type="xml">
<tree string="emc_binding_subscription_request_tree">
<field name="backend_id"/>
<field name="internal_id"/>
<field name="external_id"/>
</tree>
</field>
</record>
<record id="emc_binding_product_template_view_form" model="ir.ui.view">
<field name="name">emc_binding_product_template_view_form</field>
<field name="model">emc.binding.product.template</field>
<field name="arch" type="xml">
<form string="emc_binding_product_template_form">
<sheet>
<group>
<field name="backend_id"/>
<field name="internal_id"/>
<field name="external_id"/>
</group>
</sheet>
</form>
</field>
</record>
<record id="emc_binding_product_template_view_tree" model="ir.ui.view">
<field name="name">emc_binding_product_template_view_tree</field>
<field name="model">emc.binding.product.template</field>
<field name="arch" type="xml">
<tree string="emc_binding_product_template_tree">
<field name="backend_id"/>
<field name="internal_id"/>
<field name="external_id"/>
</tree>
</field>
</record>
</odoo>

35
easy_my_coop_connector/views/menus.xml

@ -0,0 +1,35 @@
<?xml version="1.0" encoding="utf-8"?>
<!--
Copyright 2020 Coop IT Easy
License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
-->
<odoo>
<menuitem id="emc_connector_menu_menu"
name="EMC Connector Configuration"
parent="easy_my_coop.menu_easy_my_coop_config"
groups="base.group_user"
sequence="1000"/>
<menuitem id="emc_backend_action_menu"
name="EMC Backend"
parent="emc_connector_menu_menu"
action="emc_backend_action"
groups="base.group_user"
sequence="1000"/>
<menuitem id="emc_binding_subscription_request_action_menu"
name="Subscription Request Bindings"
parent="emc_connector_menu_menu"
action="emc_binding_subscription_request_action"
groups="base.group_user"
sequence="1000"/>
<menuitem id="emc_binding_product_template_action_menu"
name="Share Product Bindings"
parent="emc_connector_menu_menu"
action="emc_binding_product_template_action"
groups="base.group_user"
sequence="1000"/>
</odoo>
Loading…
Cancel
Save