Merge lp:~camptocamp/openerp-connector/7.0-next-release-related-action into lp:~openerp-connector-core-editors/openerp-connector/7.0-next-release

[Guewen Baconnier @ Camptocamp]

Add Related Actions.

A related action can be attached to a job. It is shown to the user as a button on the form view of the jobs.
When the button is used, the related action is called and must return an OpenERP "client action".

Examples of related actions:
* Open the form view of the record that is concerned by the job.
* Open a browser on the URL of the record on an external system.

Implements Related Actions
==========================

A related action can be attached to a job. It is shown to the user as a button on the form view of the jobs.
When the button is used, the related action is called and must return an OpenERP "client action".

Examples of related actions:
* Open the form view of the record that is concerned by the job.
* Open a browser on the URL of the record on an external system.

See this branch for the implementation of related actions on the Magento connector: https://code.launchpad.net/~camptocamp/openerp-connector-magento/7.0-next-release-related-actions/

I would like to include this branch in the upcoming release, please test and give me your feedback!

[lp:~camptocamp/openerp-connector/7.0-next-release-related-action]

635. By Guewen Baconnier @ Camptocamp on 2014-05-19

rename unwrap_record to unwrap_binding

=== modified file 'connector/connector.py'
--- connector/connector.py	2013-10-30 15:42:11 +0000
+++ connector/connector.py	2014-05-19 11:41:42 +0000
@@ -304,3 +304,22 @@
         :type binding_id: int
         """
         raise NotImplementedError
+
+    def unwrap_binding(self, binding_id, browse=False):
+        """ For a binding record, gives the normal record.
+
+        Example: when called with a ``magento.product.product`` id,
+        it will return the corresponding ``product.product`` id.
+
+        :param browse: when True, returns a browse_record instance
+                       rather than an ID
+        """
+        raise NotImplementedError
+
+    def unwrap_model(self):
+        """ For a binding model, gives the normal model.
+
+        Example: when called on a binder for ``magento.product.product``,
+        it will return ``product.product``.
+        """
+        raise NotImplementedError

=== modified file 'connector/queue/job.py'
--- connector/queue/job.py	2014-05-01 11:33:33 +0000
+++ connector/queue/job.py	2014-05-19 11:41:42 +0000
@@ -19,10 +19,11 @@
 #
 ##############################################################################
 
-import sys
+import inspect
+import functools
 import logging
-import inspect
 import uuid
+import sys
 from datetime import datetime, timedelta, MINYEAR
 from pickle import loads, dumps, UnpicklingError
 
@@ -598,6 +599,11 @@
         if result is not None:
             self.result = result
 
+    def related_action(self, session):
+        if not hasattr(self.func, 'related_action'):
+            return None
+        return self.func.related_action(session, self)
+
 
 def job(func):
     """ Decorator for jobs.
@@ -630,7 +636,7 @@
                     infinite retries. Default is 5.
      * eta: the job can be executed only after this datetime
             (or now + timedelta if a timedelta or integer is given)
-     
+
      * description : a human description of the job,
                      intended to discriminate job instances
                      (Default is the func.__doc__ or 'Function %s' % func.__name__)
@@ -655,6 +661,9 @@
         # => the job will be executed with a low priority and not before a
         # delay of 5 hours from now
 
+    See also: :py:func:`related_action` a related action can be attached
+    to a job
+
     """
     def delay(session, model_name, *args, **kwargs):
         """Enqueue the function. Return the uuid of the created job."""
@@ -665,3 +674,61 @@
             **kwargs)
     func.delay = delay
     return func
+
+
+def related_action(action=lambda session, job: None, **kwargs):
+    """ Attach a *Related Action* to a job.
+
+    A *Related Action* will appear as a button on the OpenERP view.
+    The button will execute the action, usually it will open the
+    form view of the record related to the job.
+
+    The ``action`` must be a callable that responds to arguments::
+
+        session, job, **kwargs
+
+    Example usage:
+
+    .. code-block:: python
+
+        def related_action_partner(session, job):
+            model = job.args[0]
+            partner_id = job.args[1]
+            # eventually get the real ID if partner_id is a binding ID
+            action = {
+                'name': _("Partner"),
+                'type': 'ir.actions.act_window',
+                'res_model': model,
+                'view_type': 'form',
+                'view_mode': 'form',
+                'res_id': partner_id,
+            }
+            return action
+
+        @job
+        @related_action(action=related_action_partner)
+        def export_partner(session, model_name, partner_id):
+            # ...
+
+    The kwargs are transmitted to the action:
+
+    .. code-block:: python
+
+        def related_action_product(session, job, extra_arg=1):
+            assert extra_arg == 2
+            model = job.args[0]
+            product_id = job.args[1]
+
+        @job
+        @related_action(action=related_action_product, extra_arg=2)
+        def export_product(session, model_name, product_id):
+            # ...
+
+    """
+    def decorate(func):
+        if kwargs:
+            func.related_action = functools.partial(action, **kwargs)
+        else:
+            func.related_action = action
+        return func
+    return decorate

=== modified file 'connector/queue/model.py'
--- connector/queue/model.py	2014-05-01 11:33:33 +0000
+++ connector/queue/model.py	2014-05-19 11:41:42 +0000
@@ -80,6 +80,22 @@
         'active': True,
     }
 
+    def open_related_action(self, cr, uid, ids, context=None):
+        """ Open the related action associated to the job """
+        if hasattr(ids, '__iter__'):
+            assert len(ids) == 1, "1 ID expected, got %s" % ids
+            ids = ids[0]
+        session = ConnectorSession(cr, uid, context=context)
+        storage = OpenERPJobStorage(session)
+        job = self.browse(cr, uid, ids, context=context)
+        job = storage.load(job.uuid)
+        action = job.related_action(session)
+        if action is None:
+            raise orm.except_orm(
+                _('Error'),
+                _('No action available for this job'))
+        return action
+
     def _change_job_state(self, cr, uid, ids, state, result=None, context=None):
         """ Change the state of the `Job` object itself so it
         will change the other fields (date, result, ...)

=== modified file 'connector/queue/model_view.xml'
--- connector/queue/model_view.xml	2014-05-01 11:33:33 +0000
+++ connector/queue/model_view.xml	2014-05-19 11:41:42 +0000
@@ -66,6 +66,10 @@
                             string="Set to 'Done'"
                             type="object"
                             groups="connector.group_connector_manager"/>
+                        <button name="open_related_action"
+                            string="Related"
+                            type="object"
+                            />
                         <field name="state"
                             widget="statusbar"
                             statusbar_visible="pending,enqueued,started,done"

=== added file 'connector/related_action.py'
--- connector/related_action.py	1970-01-01 00:00:00 +0000
+++ connector/related_action.py	2014-05-19 11:41:42 +0000
@@ -0,0 +1,75 @@
+# -*- coding: utf-8 -*-
+##############################################################################
+#
+#    Author: Guewen Baconnier
+#    Copyright 2014 Camptocamp SA
+#
+#    This program is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU Affero General Public License as
+#    published by the Free Software Foundation, either version 3 of the
+#    License, or (at your option) any later version.
+#
+#    This program is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU Affero General Public License for more details.
+#
+#    You should have received a copy of the GNU Affero General Public License
+#    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+##############################################################################
+
+"""
+Related Actions
+
+Related actions are associated with jobs.
+When called on a job, they will return an action to the client.
+
+"""
+
+from openerp.tools.translate import _
+from .connector import Environment, Binder
+
+
+def unwrap_binding(session, job, id_pos=2, binder_class=Binder):
+    """ Open a form view with the unwrapped record.
+
+    For instance, for a job on a ``magento.product.product``,
+    it will open a ``product.product`` form view with the unwrapped
+    record.
+
+    :param id_pos: position of the binding ID in the args
+    :param binder_class: base class to search for the binder
+    """
+    binding_model = job.args[0]
+    # shift one to the left because session is not in job.args
+    binding_id = job.args[id_pos - 1]
+    action = {
+        'name': _('Related Record'),
+        'type': 'ir.actions.act_window',
+        'view_type': 'form',
+        'view_mode': 'form',
+    }
+    # try to get an unwrapped record
+    binding = session.browse(binding_model, binding_id)
+    if not binding.exists():
+        # it has been deleted
+        return None
+    env = Environment(binding.backend_id, session, binding_model)
+    binder = env.get_connector_unit(binder_class)
+    try:
+        model = binder.unwrap_model()
+        record_id = binder.unwrap_binding(binding_id)
+    except ValueError:
+        # the binding record will be displayed
+        action.update({
+            'res_model': binding_model,
+            'res_id': binding_id,
+        })
+    else:
+        # the unwrapped record will be displayed
+        action.update({
+            'res_model': model,
+            'res_id': record_id,
+        })
+    return action

=== modified file 'connector/session.py'
--- connector/session.py	2013-09-13 13:22:49 +0000
+++ connector/session.py	2014-05-19 11:41:42 +0000
@@ -138,7 +138,7 @@
         :param values: values to apply on the context
         :type values: dict
         """
-        original_context = self._context
+        original_context = self.context
         self._context = original_context.copy()
         self._context.update(values)
         yield

=== modified file 'connector/tests/__init__.py'
--- connector/tests/__init__.py	2013-02-21 12:57:12 +0000
+++ connector/tests/__init__.py	2014-05-19 11:41:42 +0000
@@ -28,6 +28,7 @@
 import test_producer
 import test_connector
 import test_mapper
+import test_related_action
 
 fast_suite = [
 ]
@@ -42,4 +43,5 @@
     test_producer,
     test_connector,
     test_mapper,
+    test_related_action,
 ]

=== added file 'connector/tests/test_related_action.py'
--- connector/tests/test_related_action.py	1970-01-01 00:00:00 +0000
+++ connector/tests/test_related_action.py	2014-05-19 11:41:42 +0000
@@ -0,0 +1,143 @@
+# -*- coding: utf-8 -*-
+
+import mock
+import unittest2
+
+import openerp
+import openerp.tests.common as common
+from ..backend import Backend, BACKENDS
+from ..connector import Binder
+from ..queue.job import (Job,
+                         OpenERPJobStorage,
+                         related_action)
+from ..session import ConnectorSession
+from ..related_action import unwrap_binding
+
+
+def task_no_related(session, model_name):
+    pass
+
+
+def task_related_none(session, model_name):
+    pass
+
+
+def task_related_return(session, model_name):
+    pass
+
+
+def task_related_return_kwargs(session, model_name):
+    pass
+
+
+def open_url(session, job, url=None):
+    subject = job.args[0]
+    return {
+        'type': 'ir.actions.act_url',
+        'target': 'new',
+        'url': url.format(subject=subject),
+    }
+
+
+@related_action(action=open_url, url='https://en.wikipedia.org/wiki/{subject}')
+def task_wikipedia(session, subject):
+    pass
+
+
+@related_action(action=unwrap_binding)
+def test_unwrap_binding(session, model_name, binding_id):
+    pass
+
+
+class test_related_action(unittest2.TestCase):
+    """ Test Related Actions """
+
+    def setUp(self):
+        super(test_related_action, self).setUp()
+        self.session = mock.MagicMock()
+
+    def test_no_related_action(self):
+        """ Job without related action """
+        job = Job(func=task_no_related)
+        self.assertIsNone(job.related_action(self.session))
+
+    def test_return_none(self):
+        """ Job with related action returning None """
+        # default action returns None
+        job = Job(func=related_action()(task_related_none))
+        self.assertIsNone(job.related_action(self.session))
+
+    def test_return(self):
+        """ Job with related action check if action returns correctly """
+        def action(session, job):
+            return session, job
+        job = Job(func=related_action(action=action)(task_related_return))
+        act_session, act_job = job.related_action(self.session)
+        self.assertEqual(act_session, self.session)
+        self.assertEqual(act_job, job)
+
+    def test_kwargs(self):
+        """ Job with related action check if action propagates kwargs """
+        def action(session, job, a=1, b=2):
+            return a, b
+        job_func = related_action(action=action, b=4)(task_related_return_kwargs)
+        job = Job(func=job_func)
+        self.assertEqual(job.related_action(self.session), (1, 4))
+
+    def test_unwrap_binding(self):
+        """ Call the unwrap binding related action """
+        class TestBinder(Binder):
+            _model_name = 'binding.res.users'
+
+            def unwrap_binding(self, binding_id, browse=False):
+                return 42
+
+            def unwrap_model(self):
+                return 'res.users'
+
+        job = Job(func=test_unwrap_binding, args=('res.users', 555))
+        session = mock.Mock(name='session')
+        backend_record = mock.Mock(name='backend_record')
+        backend = mock.Mock(name='backend')
+        browse_record = mock.Mock(name='browse_record')
+        backend.get_class.return_value = TestBinder
+        backend_record.get_backend.return_value = backend
+        browse_record.exists.return_value = True
+        browse_record.backend_id = backend_record
+        session.browse.return_value = browse_record
+        action = unwrap_binding(session, job)
+        expected = {
+            'name': mock.ANY,
+            'type': 'ir.actions.act_window',
+            'view_type': 'form',
+            'view_mode': 'form',
+            'res_id': 42,
+            'res_model': 'res.users',
+        }
+        self.assertEquals(action, expected)
+
+
+
+class test_related_action_storage(common.TransactionCase):
+    """ Test related actions on stored jobs """
+
+    def setUp(self):
+        super(test_related_action_storage, self).setUp()
+        self.pool = openerp.modules.registry.RegistryManager.get(common.DB)
+        self.session = ConnectorSession(self.cr, self.uid)
+        self.queue_job = self.registry('queue.job')
+
+    def test_store_related_action(self):
+        """ Call the related action on the model """
+        job = Job(func=task_wikipedia, args=('Discworld',))
+        storage = OpenERPJobStorage(self.session)
+        storage.store(job)
+        stored_ids = self.queue_job.search(self.cr, self.uid,
+                                           [('uuid', '=', job.uuid)])
+        self.assertEqual(len(stored_ids), 1)
+        stored = self.queue_job.browse(self.cr, self.uid, stored_ids[0])
+        expected = {'type': 'ir.actions.act_url',
+                    'target': 'new',
+                    'url': 'https://en.wikipedia.org/wiki/Discworld',
+                    }
+        self.assertEquals(stored.open_related_action(), expected)

=== modified file 'connector/tests/test_session.py'
--- connector/tests/test_session.py	2013-05-02 14:01:27 +0000
+++ connector/tests/test_session.py	2014-05-19 11:41:42 +0000
@@ -85,3 +85,19 @@
         res_users = self.registry('res.users')
 
         self.assertEqual(self.session.pool.get('res.users'), res_users)
+
+    def test_change_context(self):
+        """
+        Change the context and check if it is reverted correctly at the end
+        """
+        test_key = 'test_key'
+        self.assertNotIn(test_key, self.session.context)
+        with self.session.change_context({test_key: 'value'}):
+            self.assertIn(test_key, self.session.context)
+        self.assertNotIn(test_key, self.session.context)
+
+        #change the context on a session not initialized with a context
+        session = ConnectorSession(self.cr, self.uid)
+        with session.change_context({test_key: 'value'}):
+            self.assertIn(test_key, session.context)
+        self.assertNotIn(test_key, session.context)