Merge lp:~openerp-connector-core-editors/openerp-connector/7.0-e-commerce-addons-refactor-so-extra-lines into lp:openerp-connector/7.0-e-commerce-addons

[Guewen Baconnier @ Camptocamp]

Refactoring of the legacy code for shipping costs, cash on delivery, gift certificates.

[Guewen Baconnier @ Camptocamp (gbaconnier-c2c)]

Branch is now sufficiently stable to be tested and used for development.

[lp:~openerp-connector-core-editors/openerp-connector/7.0-e-commerce-addons-refactor-so-extra-lines]

344. By Guewen Baconnier @ Camptocamp on 2013-12-10

[FIX] 'int' object is not iterable error

345. By Guewen Baconnier @ Camptocamp on 2013-12-10

[FIX] 'int' object is not iterable error, again

[Guewen Baconnier @ Camptocamp (gbaconnier-c2c)]

Has been included in the new branch lp:openerp-connector-ecommerce

Unmerged revisions

345. By Guewen Baconnier @ Camptocamp on 2013-12-10

[FIX] 'int' object is not iterable error, again

344. By Guewen Baconnier @ Camptocamp on 2013-12-10

[FIX] 'int' object is not iterable error

343. By Guewen Baconnier @ Camptocamp on 2013-12-09

[MRG] sync with master branch

342. By Guewen Baconnier @ Camptocamp on 2013-12-02

[MRG] propagate the 'shop_id' in the context if it exists so the fiscal position rules (from openerp-fiscal-rules' project) can apply automatically

(in line with https://code.launchpad.net/\~camptocamp/openerp-connector/7.0-e-commerce-addons-fiscal-rules-compat/+merge/197384\)

341. By Guewen Baconnier @ Camptocamp on 2013-11-26

[FIX] in lines builders, product_ref is not mandatory if we provide a product, renames 'product_id' to 'product', keeping ambiguity as we can have an int or browse_record.

340. By Guewen Baconnier @ Camptocamp on 2013-11-13

[MRG] from master

339. By Guewen Baconnier @ Camptocamp on 2013-11-12

[FIX] simplify last change

338. By Guewen Baconnier @ Camptocamp on 2013-11-12

[FIX] Sales Orders onchanges: allow to have lines with other commands than (0, 0, {values}).

337. By Guewen Baconnier @ Camptocamp on 2013-11-09

[IMP] allow to use a product id or a product browse_record in lines builders

336. By Guewen Baconnier @ Camptocamp on 2013-11-09

[ADD] deprecation warning

=== modified file 'connector_ecommerce/product.py'
--- connector_ecommerce/product.py	2013-11-01 16:11:23 +0000
+++ connector_ecommerce/product.py	2013-12-10 10:13:58 +0000
@@ -82,6 +82,8 @@
                                               prod_id)
 
     def write(self, cr, uid, ids, vals, context=None):
+        if isinstance(ids, (int, long)):
+            ids = [ids]
         result = super(product_template, self).write(cr, uid, ids,
                                                      vals, context=context)
         self._price_changed(cr, uid, ids, vals, context=context)
@@ -134,6 +136,8 @@
     def write(self, cr, uid, ids, vals, context=None):
         if context is None:
             context = {}
+        if isinstance(ids, (int, long)):
+            ids = [ids]
         context = context.copy()
         context['from_product_ids'] = ids
         result = super(product_product, self).write(
 
=== modified file 'connector_ecommerce/sale.py'
--- connector_ecommerce/sale.py	2013-07-15 14:29:14 +0000
+++ connector_ecommerce/sale.py	2013-12-10 10:13:58 +0000
@@ -21,9 +21,14 @@
 #
 ##############################################################################
 
+import logging
+
 from openerp.osv import orm, fields, osv
 from openerp.tools.translate import _
 from openerp import netsvc
+from openerp.addons.connector.connector import ConnectorUnit
+
+_logger = logging.getLogger(__name__)
 
 
 class sale_shop(orm.Model):
@@ -301,6 +306,9 @@
         :return: the value for the sale order with the special field converted
         :rtype: dict
         """
+        _logger.warning('sale_order._convert_special_fields() has been '
+                        'deprecated. Use a specialized '
+                        'SpecialOrderLineBuilder class instead.')
         shipping_fields = ['shipping_amount_tax_excluded',
                            'shipping_amount_tax_included',
                            'shipping_tax_amount']
@@ -396,7 +404,6 @@
             extra_line['name'] = "%s [%s]" % (extra_line['name'],
                                               vals[ext_code_field])
         vals['order_line'].append((0, 0, extra_line))
-
         return self._clean_special_fields(option, vals)
 
     def _clean_special_fields(self, option, vals):
@@ -406,3 +413,90 @@
             if option.get(key) and option[key] in vals:
                 del vals[option[key]]
         return vals  # if there is no price, we have nothing to import
+
+
+class SpecialOrderLineBuilder(ConnectorUnit):
+    """ Base class to build a sale order line for a sale order
+
+    Used when extra order lines have to be added in a sale 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.get_connector_for_unit(ShippingLineBuilder,
+                                              model='sale.order.line')
+        builder.price_unit = 100
+        builder.get_line()
+
+    """
+    _model_name = None
+
+    def __init__(self, environment):
+        super(SpecialOrderLineBuilder, self).__init__(environment)
+        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
+
+    def get_line(self):
+        assert self.product_ref or self.product
+        assert self.price_unit is not None
+        line = {}
+        session = self.session
+
+        product = product_id = self.product
+        if product_id is None:
+            model_data_obj = session.pool.get('ir.model.data')
+            __, product_id = model_data_obj.get_object_reference(
+                session.cr, session.uid, *self.product_ref)
+
+        if not isinstance(product_id, orm.browse_record):
+            product = session.browse('product.product', product_id)
+        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}
+
+
+class ShippingLineBuilder(SpecialOrderLineBuilder):
+    """ Return values for a Shipping line """
+    _model_name = None
+
+    def __init__(self, environment):
+        super(ShippingLineBuilder, self).__init__(environment)
+        self.product_ref = ('connector_ecommerce', 'product_product_shipping')
+
+
+class CashOnDeliveryLineBuilder(SpecialOrderLineBuilder):
+    """ Return values for a Cash on Delivery line """
+    _model_name = None
+    _model_name = None
+
+    def __init__(self, environment):
+        super(CashOnDeliveryLineBuilder, self).__init__(environment)
+        self.product_ref = ('connector_ecommerce',
+                            'product_product_cash_on_delivery')
+
+
+class GiftOrderLineBuilder(SpecialOrderLineBuilder):
+    """ Return values for a Gift line """
+    _model_name = None
+
+    def __init__(self, environment):
+        super(GiftOrderLineBuilder, self).__init__(environment)
+        self.product_ref = ('connector_ecommerce',
+                            'product_product_gift')
+        self.sign = -1
+        self.gift_code = None
+
+    def get_line(self):
+        line = super(GiftOrderLineBuilder, self).get_line()
+        if self.gift_code:
+            line['name'] = "%s [%s]" % (line['name'], self.gift_code)
+        return line