[16.0][MIG] connector_ecommerce

connector_ecommerce/README.rst

@@ -0,0 +1,84 @@
+.. image:: https://img.shields.io/badge/licence-AGPL--3-blue.svg
+    :alt: License
+
+Connector for E-Commerce
+========================
+
+This modules aims to be a common layer for the connectors dealing with
+e-commerce.
+
+It sits on top of the `connector`_ framework and is used by the
+e-commerce connectors, like `magentoerpconnect`_ or
+`prestashoperpconnect`_.
+
+That's a technical module, which include amongst other things:
+
+Events
+
+  On which the connectors can subscribe listeners.
+  The events it adds are:
+
+   * ``on_invoice_paid(self, record)``
+   * ``on_invoice_validated(self, record)``
+   * ``on_invoice_validated(self, record)``
+   * ``on_picking_out_done(self, record, method)`` where method is
+     'partial' or 'complete'
+   * ``on_tracking_number_added(self, record)``
+   * ``on_product_price_changed(self, record)``
+
+ Components
+
+  A piece of code which allows to play all the ``onchanges`` required
+  when we create a sales order.
+
+  Another one which allows to add special lines in imported sales orders
+  such as Shipping fees, Cash on Delivery or Discounts.
+
+Data Model
+
+  Add structures shared for e-commerce connectors
+
+.. _`connector`: http://odoo-connector.com
+.. _`magentoerpconnect`: http://odoo-magento-connector.com
+.. _`prestashoperpconnect`: https://github.com/OCA/connector-prestashop
+
+Installation
+============
+
+This module is a dependency for more advanced connectors. It does
+nothing on its own and there is no reason to install it alone.
+
+
+Bug Tracker
+===========
+
+Bugs are tracked on `GitHub Issues <https://github.com/OCA/connector-ecommerce/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
+`here <https://github.com/OCA/connector-ecommerce/issues/new?body=module:%20connector_ecommerce%0Aversion:%208.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
+
+
+Credits
+=======
+
+Contributors
+------------
+
+See `contributors' list`_
+
+.. _contributors' list: ./AUTHORS
+
+Maintainer
+----------
+
+.. image:: http://odoo-community.org/logo.png
+   :alt: Odoo Community Association
+   :target: http://odoo-community.org
+
+This module is maintained by the OCA.
+
+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.
+
+To contribute to this module, please visit http://odoo-community.org.

connector_ecommerce/__init__.py

@@ -0,0 +1,3 @@
+from . import components
+from . import models
+from . import wizard

connector_ecommerce/__manifest__.py

@@ -0,0 +1,30 @@
+# © 2013-2016 Camptocamp SA
+# © 2013-2016 Akretion
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl.html)
+
+{
+    "name": "Connector for E-Commerce",
+    "version": "16.0.1.0.0",
+    "category": "Hidden",
+    "author": "Camptocamp,Akretion,Odoo Community Association (OCA)",
+    "website": "https://github.com/OCA/connector-ecommerce",
+    "license": "AGPL-3",
+    "depends": [
+        "connector",
+        "sale_automatic_workflow_payment_mode",
+        "sale_exception",
+        "delivery",
+        "connector_base_product",
+    ],
+    "data": [
+        "security/security.xml",
+        "security/ir.model.access.csv",
+        "wizard/sale_ignore_cancel_view.xml",
+        "data/ecommerce_data.xml",
+        "views/sale_view.xml",
+        "views/invoice_view.xml",
+        "views/stock_view.xml",
+        "views/payment_mode_view.xml",
+    ],
+    "installable": True,
+}

connector_ecommerce/components/__init__.py

@@ -0,0 +1,2 @@
+from . import line_builder
+from . import sale_order_onchange

connector_ecommerce/components/line_builder.py

@@ -0,0 +1,110 @@
+# © 2013-2016 Camptocamp SA
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl.html)
+
+from odoo import models
+
+from odoo.addons.component.core import Component
+
+
+class SpecialOrderLineBuilder(Component):
+    """Base class to build a sales order line for a sales order
+
+    Used when extra order lines have to be added in a sales order
+    but we only know some parameters (product, price, ...), for instance,
+    a line for the shipping costs or the gift coupons.
+
+    It can be subclassed to customize the way the lines are created.
+
+    Usage::
+
+        builder = self.components(usage='shipping.line.builder',
+                                  model_name='sale.order.line')
+        builder.price_unit = 100
+        builder.get_line()
+
+    """
+
+    _name = "ecommerce.order.line.builder"
+    _inherit = "base.connector"
+    _usage = "order.line.builder"
+
+    def __init__(self, work_context):
+        super().__init__(work_context)
+        self.product = None  # id or browse_record
+        # when no product_id, fallback to a product_ref
+        self.product_ref = None  # tuple (module, xmlid)
+        self.price_unit = None
+        self.quantity = 1
+        self.sign = 1
+        self.sequence = 980
+
+    def get_line(self):
+        assert self.product_ref or self.product
+        assert self.price_unit is not None
+
+        product = self.product
+        if product is None:
+            product = self.env.ref(".".join(self.product_ref))
+
+        if not isinstance(product, models.BaseModel):
+            product = self.env["product.product"].browse(product)
+        return {
+            "product_id": product.id,
+            "name": product.name,
+            "product_uom": product.uom_id.id,
+            "product_uom_qty": self.quantity,
+            "price_unit": self.price_unit * self.sign,
+            "sequence": self.sequence,
+        }
+
+
+class ShippingLineBuilder(Component):
+    """Return values for a Shipping line"""
+
+    _name = "ecommerce.order.line.builder.shipping"
+    _inherit = "ecommerce.order.line.builder"
+    _usage = "order.line.builder.shipping"
+
+    def __init__(self, work_context):
+        super().__init__(work_context)
+        self.product_ref = ("connector_ecommerce", "product_product_shipping")
+        self.sequence = 999
+
+    def get_line(self):
+        values = super().get_line()
+        values["is_delivery"] = True
+        return values
+
+
+class CashOnDeliveryLineBuilder(Component):
+    """Return values for a Cash on Delivery line"""
+
+    _name = "ecommerce.order.line.builder.cod"
+    _inherit = "ecommerce.order.line.builder"
+    _usage = "order.line.builder.cod"
+
+    def __init__(self, work_context):
+        super().__init__(work_context)
+        self.product_ref = ("connector_ecommerce", "product_product_cash_on_delivery")
+        self.sequence = 995
+
+
+class GiftOrderLineBuilder(Component):
+    """Return values for a Gift line"""
+
+    _name = "ecommerce.order.line.builder.gift"
+    _inherit = "ecommerce.order.line.builder"
+    _usage = "order.line.builder.gift"
+
+    def __init__(self, work_context):
+        super().__init__(work_context)
+        self.product_ref = ("connector_ecommerce", "product_product_gift")
+        self.sign = -1
+        self.gift_code = None
+        self.sequence = 990
+
+    def get_line(self):
+        line = super().get_line()
+        if self.gift_code:
+            line["name"] = "{} [{}]".format(line["name"], self.gift_code)
+        return line

connector_ecommerce/components/sale_order_onchange.py

@@ -0,0 +1,112 @@
+# © 2013-TODAY Akretion (Sébastien Beau)
+# © 2016 Camptocamp SA
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl.html)
+
+from odoo.addons.component.core import Component
+
+
+class OnChangeManager(Component):
+    _name = "ecommerce.onchange.manager"
+    _inherit = "base.connector"
+
+    def get_new_values(self, record, on_change_result, model=None):
+        vals = on_change_result.get("value", {})
+        new_values = {}
+        for fieldname, value in vals.items():
+            if fieldname not in record:
+                if model:
+                    column = self.env[model]._fields[fieldname]
+                    if column.type == "many2one":
+                        value = value[0]  # many2one are tuple (id, name)
+                new_values[fieldname] = value
+        return new_values
+
+    def play_onchanges(self, model, values, onchange_fields):
+        model = self.env[model]
+        onchange_specs = model._onchange_spec()
+
+        # we need all fields in the dict even the empty ones
+        # otherwise 'onchange()' will not apply changes to them
+        all_values = {k: v for k, v in values.items() if k in model._fields}
+        not_values = {k: v for k, v in values.items() if k not in model._fields}
+        for field in model._fields:
+            if field not in all_values:
+                all_values[field] = False
+
+        # we work on a temporary record
+        new_record = model.new(all_values)
+
+        new_values = {}
+        for field in onchange_fields:
+            onchange_values = new_record.onchange(all_values, field, onchange_specs)
+            new_values.update(
+                self.get_new_values(values, onchange_values, model=model._name)
+            )
+            all_values.update(new_values)
+
+        for fld in not_values:
+            if fld not in all_values:
+                all_values[fld] = not_values[fld]
+        res = {f: v for f, v in all_values.items() if f in values or f in new_values}
+        return res
+
+
+class SaleOrderOnChange(Component):
+    _name = "ecommerce.onchange.manager.sale.order"
+    _inherit = "ecommerce.onchange.manager"
+    _usage = "ecommerce.onchange.manager.sale.order"
+
+    order_onchange_fields = ["partner_id"]
+
+    line_onchange_fields = ["order_id", "product_id"]
+
+    def play(self, order, order_lines):
+        """Play the onchange of the sales order and it's lines
+
+        :param order: sales order values
+        :type: dict
+        :param order_lines: data of the sales order lines
+        :type: list of dict
+
+        :return: the sales order updated by the onchanges
+        :rtype: dict
+        """
+        # play onchange on sales order
+        order = self.play_onchanges("sale.order", order, self.order_onchange_fields)
+
+        # play onchange on sales order line
+        processed_order_lines = []
+        line_lists = [order_lines]
+        if "order_line" in order and order["order_line"] is not order_lines:
+            # we have both backend-dependent and oerp-native order lines.
+            # oerp-native lines can have been added to map
+            # shipping fees with an Odoo Product
+            line_lists.append(order["order_line"])
+
+        for line_list in line_lists:
+            for idx, command_line in enumerate(line_list):
+                # line_list format:[(0, 0, {...}), (0, 0, {...})]
+                if command_line[0] in (0, 1):  # create or update values
+                    # we work on a temporary record
+                    order_model = self.env["sale.order"]
+
+                    all_values = {
+                        k: v for k, v in order.items() if k in order_model._fields
+                    }
+                    for field in order_model._fields:
+                        if field not in all_values:
+                            all_values[field] = False
+                    new_record = order_model.new(all_values)
+                    # keeps command number and ID (or 0)
+                    old_line_data = command_line[2]
+                    # passing order_id also so order_id.company_id based onchange will
+                    # also work
+                    old_line_data["order_id"] = new_record
+                    new_line_data = self.play_onchanges(
+                        "sale.order.line", old_line_data, self.line_onchange_fields
+                    )
+                    new_line = (command_line[0], command_line[1], new_line_data)
+                    processed_order_lines.append(new_line)
+                    # in place modification of the sales order line in the list
+                    line_list[idx] = new_line
+        return order