rename send_items method as it only accept a unique item

The method send_items is still available but deprecated.
 the documentation has been updated to clearly indicate this.

The column in the table has not been changed as xbus-odoo would need to be changed too.

NEWS.rst

-11.0.1.0.0 - UNRELEASED
-=======================
+*********
+Changelog
+*********
+
+11.0.1.1.1
+==========
+
+Indicate clearly that send_items only send a unique item, unlike what the documentation indicated before and the name implied.
+
+11.0.1.0.0
+==========
 
 * Port to Odoo 11.0
 

__init__.py

-# flake8: noqa
-
-from . import models
+from . import models  # noqa: F401

__manifest__.py

@@ -39,7 +39,7 @@
 
 - Follow ``xbus-odoo`` <https://bitbucket.org/xcg/xbus-odoo> setup docs.
 """,
-    "version": "11.0.1.1.0",
+    "version": "11.0.1.1.1",
     "category": "",
     "author": "XCG Consulting",
     "website": "http://odoo.consulting/",

i18n/fr.po

 # Translation of Odoo Server.
 # This file contains the translation of the following modules:
-# 	* xbus_emitter
-#
+# * xbus_emitter
+# Vincent Hatakeyama <vincent.hatakeyama@xcg-consulting.fr>, 2020.
 msgid ""
 msgstr ""
 "Project-Id-Version: Odoo Server 8.0\n"
 "Report-Msgid-Bugs-To: \n"
@@ -5,12 +5,12 @@
 msgid ""
 msgstr ""
 "Project-Id-Version: Odoo Server 8.0\n"
 "Report-Msgid-Bugs-To: \n"
-"POT-Creation-Date: 2020-03-23 17:40+0000\n"
-"PO-Revision-Date: 2020-03-23 18:42+0100\n"
-"Last-Translator: Houzéfa Abbasbhay <houzefa.abba@xcg-consulting.fr>\n"
-"Language-Team: \n"
-"Language: fr_FR\n"
+"POT-Creation-Date: 2020-06-03 10:25+0000\n"
+"PO-Revision-Date: 2020-06-03 12:26+0200\n"
+"Last-Translator: Vincent Hatakeyama <vincent.hatakeyama@xcg-consulting.fr>\n"
+"Language-Team: XCG Consulting\n"
+"Language: fr\n"
 "MIME-Version: 1.0\n"
 "Content-Type: text/plain; charset=UTF-8\n"
 "Content-Transfer-Encoding: 8bit\n"
@@ -14,7 +14,8 @@
 "MIME-Version: 1.0\n"
 "Content-Type: text/plain; charset=UTF-8\n"
 "Content-Transfer-Encoding: 8bit\n"
-"X-Generator: Poedit 2.0.6\n"
+"Plural-Forms: nplurals=2; plural=(n > 1);\n"
+"X-Generator: Virtaal 0.7.1\n"
 
 #. module: xbus_emitter
 #: model:ir.ui.view,arch_db:xbus_emitter.xbus_emitter_job_form
@@ -18,8 +19,7 @@
 
 #. module: xbus_emitter
 #: model:ir.ui.view,arch_db:xbus_emitter.xbus_emitter_job_form
-msgid ""
-"<span class=\"o_stat_value\">1</span>\n"
+msgid "<span class=\"o_stat_value\">1</span>\n"
 "                                <span class=\"o_stat_text\">Record</span>"
 msgstr ""
 "<span class=\"o_stat_value\">1</span>\n"
@@ -23,8 +23,8 @@
 "                                <span class=\"o_stat_text\">Record</span>"
 msgstr ""
 "<span class=\"o_stat_value\">1</span>\n"
-"                                <span class=\"o_stat_text\">Enregistrement</"
-"span>"
+"                                <span class=\"o_stat_text\""
+">Enregistrement</span>"
 
 #. module: xbus_emitter
 #: model:ir.model.fields,help:xbus_emitter.field_xbus_emitter_name
@@ -34,8 +34,8 @@
 #. module: xbus_emitter
 #: selection:xbus.emitter.job,chunking:0
 msgid "Auto"
-msgstr ""
+msgstr "Automatique"
 
 #. module: xbus_emitter
 #: model:ir.model.fields,field_description:xbus_emitter.field_xbus_emitter_job_chunking
 msgid "Chunking"
@@ -38,8 +38,8 @@
 
 #. module: xbus_emitter
 #: model:ir.model.fields,field_description:xbus_emitter.field_xbus_emitter_job_chunking
 msgid "Chunking"
-msgstr ""
+msgstr "Découpage"
 
 #. module: xbus_emitter
 #: model:ir.model.fields,field_description:xbus_emitter.field_xbus_emitter_create_uid
@@ -62,8 +62,8 @@
 #. module: xbus_emitter
 #: model:ir.model.fields,field_description:xbus_emitter.field_xbus_emitter_job_envelope_id
 msgid "Envelope ID"
-msgstr ""
+msgstr "Identifiant de l'enveloppe"
 
 #. module: xbus_emitter
 #: model:ir.model.fields,field_description:xbus_emitter.field_xbus_emitter_job_date_sent
 msgid "Envelope sending date"
@@ -66,10 +66,10 @@
 
 #. module: xbus_emitter
 #: model:ir.model.fields,field_description:xbus_emitter.field_xbus_emitter_job_date_sent
 msgid "Envelope sending date"
-msgstr "Date d'envoi de l'enveloppe"
+msgstr "Date d'envoi de l’enveloppe"
 
 #. module: xbus_emitter
 #: model:ir.model.fields,field_description:xbus_emitter.field_xbus_emitter_id
 #: model:ir.model.fields,field_description:xbus_emitter.field_xbus_emitter_job_id
 msgid "ID"
@@ -71,10 +71,10 @@
 
 #. module: xbus_emitter
 #: model:ir.model.fields,field_description:xbus_emitter.field_xbus_emitter_id
 #: model:ir.model.fields,field_description:xbus_emitter.field_xbus_emitter_job_id
 msgid "ID"
-msgstr "ID"
+msgstr "Identifiant"
 
 #. module: xbus_emitter
 #: model:ir.model.fields,help:xbus_emitter.field_xbus_emitter_job_log
 msgid "Information about the emission of this message."
@@ -77,8 +77,8 @@
 
 #. module: xbus_emitter
 #: model:ir.model.fields,help:xbus_emitter.field_xbus_emitter_job_log
 msgid "Information about the emission of this message."
-msgstr "Information à propos de l'émission de ce message."
+msgstr "Information à propos de l’émission de ce message."
 
 #. module: xbus_emitter
 #: model:ir.model.fields,field_description:xbus_emitter.field_xbus_emitter_job_items
@@ -82,8 +82,8 @@
 
 #. module: xbus_emitter
 #: model:ir.model.fields,field_description:xbus_emitter.field_xbus_emitter_job_items
-msgid "Items"
-msgstr "Items"
+msgid "Item"
+msgstr "Élément"
 
 #. module: xbus_emitter
 #: model:ir.model.fields,field_description:xbus_emitter.field_xbus_emitter___last_update
@@ -106,8 +106,8 @@
 #. module: xbus_emitter
 #: selection:xbus.emitter.job,chunking:0
 msgid "Legacy"
-msgstr ""
+msgstr "Ancien"
 
 #. module: xbus_emitter
 #: model:ir.model.fields,field_description:xbus_emitter.field_xbus_emitter_job_log
 msgid "Logs"
@@ -110,8 +110,8 @@
 
 #. module: xbus_emitter
 #: model:ir.model.fields,field_description:xbus_emitter.field_xbus_emitter_job_log
 msgid "Logs"
-msgstr "Logs"
+msgstr "Journaux"
 
 #. module: xbus_emitter
 #: model:ir.model.fields,field_description:xbus_emitter.field_xbus_emitter_name
@@ -125,7 +125,5 @@
 
 #. module: xbus_emitter
 #: model:ir.model.fields,help:xbus_emitter.field_xbus_emitter_priority
-msgid ""
-"Priority to sort emitter configuration objects; the lowest priority is the "
-"most important."
+msgid "Priority to sort emitter configuration objects; the lowest priority is the most important."
 msgstr ""
@@ -131,7 +129,7 @@
 msgstr ""
-"Priorité pour trier les objets de configuration d'émetteurs ; la priorité la "
+"Priorité pour trier les objets de configuration d’émetteurs ; la priorité la "
 "plus basse est la plus importante."
 
 #. module: xbus_emitter
 #: model:ir.model.fields,field_description:xbus_emitter.field_xbus_emitter_job_process_id
 msgid "Process ID"
@@ -133,9 +131,9 @@
 "plus basse est la plus importante."
 
 #. module: xbus_emitter
 #: model:ir.model.fields,field_description:xbus_emitter.field_xbus_emitter_job_process_id
 msgid "Process ID"
-msgstr ""
+msgstr "Identifiant du processus"
 
 #. module: xbus_emitter
 #: model:ir.model.fields,field_description:xbus_emitter.field_xbus_emitter_job_date_done
@@ -145,8 +143,8 @@
 #. module: xbus_emitter
 #: model:ir.model.fields,field_description:xbus_emitter.field_xbus_emitter_job_record_id
 msgid "Record ID"
-msgstr "Enregistrement - ID"
+msgstr "Identifiant de l’enregistrement"
 
 #. module: xbus_emitter
 #: model:ir.model.fields,field_description:xbus_emitter.field_xbus_emitter_job_record_model
 msgid "Record model"
@@ -149,8 +147,8 @@
 
 #. module: xbus_emitter
 #: model:ir.model.fields,field_description:xbus_emitter.field_xbus_emitter_job_record_model
 msgid "Record model"
-msgstr "Enregistrement - Modèle"
+msgstr "Modèle de l’enregistrement"
 
 #. module: xbus_emitter
 #: selection:xbus.emitter.job,state:0
@@ -165,8 +163,8 @@
 #. module: xbus_emitter
 #: selection:xbus.emitter.job,state:0
 msgid "Sent, process done and successful"
-msgstr "Envoyé, process terminé avec succès"
+msgstr "Envoyé, processus terminé avec succès"
 
 #. module: xbus_emitter
 #: selection:xbus.emitter.job,state:0
 msgid "Sent, process error"
@@ -169,9 +167,9 @@
 
 #. module: xbus_emitter
 #: selection:xbus.emitter.job,state:0
 msgid "Sent, process error"
-msgstr "Envoyé, process en erreur"
+msgstr "Envoyé, processus en erreur"
 
 #. module: xbus_emitter
 #: selection:xbus.emitter.job,state:0
 msgid "Sent, process paused"
@@ -174,9 +172,9 @@
 
 #. module: xbus_emitter
 #: selection:xbus.emitter.job,state:0
 msgid "Sent, process paused"
-msgstr "Envoyé, process en pause"
+msgstr "Envoyé, processus en pause"
 
 #. module: xbus_emitter
 #: selection:xbus.emitter.job,state:0
 msgid "Sent, process running"
@@ -179,9 +177,9 @@
 
 #. module: xbus_emitter
 #: selection:xbus.emitter.job,state:0
 msgid "Sent, process running"
-msgstr "Envoyé, process en cours"
+msgstr "Envoyé, processus en cours"
 
 #. module: xbus_emitter
 #: selection:xbus.emitter.job,chunking:0
 msgid "Single"
@@ -184,9 +182,9 @@
 
 #. module: xbus_emitter
 #: selection:xbus.emitter.job,chunking:0
 msgid "Single"
-msgstr ""
+msgstr "Unique"
 
 #. module: xbus_emitter
 #: model:ir.model.fields,help:xbus_emitter.field_xbus_emitter_job_chunking
 msgid "Specify how the item can or cannot be chunked."
@@ -189,8 +187,8 @@
 
 #. module: xbus_emitter
 #: model:ir.model.fields,help:xbus_emitter.field_xbus_emitter_job_chunking
 msgid "Specify how the item can or cannot be chunked."
-msgstr ""
+msgstr "Spécifier comment l’élément peut être ou non découpé."
 
 #. module: xbus_emitter
 #: model:ir.model.fields,field_description:xbus_emitter.field_xbus_emitter_job_state
@@ -199,10 +197,9 @@
 
 #. module: xbus_emitter
 #: model:ir.model.fields,help:xbus_emitter.field_xbus_emitter_job_envelope_id
-msgid ""
-"The ID of the envelope that was forged by xbus-odoo and sent into the bus"
-msgstr ""
+msgid "The ID of the envelope that was forged by xbus-odoo and sent into the bus"
+msgstr "L’identifiant de l’enveloppe créé par xbus-odoo et envoyée au bus"
 
 #. module: xbus_emitter
 #: model:ir.model.fields,help:xbus_emitter.field_xbus_emitter_job_process_id
 msgid "The ID of the process that was created by the sending of the envelope"
@@ -205,9 +202,9 @@
 
 #. module: xbus_emitter
 #: model:ir.model.fields,help:xbus_emitter.field_xbus_emitter_job_process_id
 msgid "The ID of the process that was created by the sending of the envelope"
-msgstr ""
+msgstr "L’identifiant du processus qui a été créé par l’envoi de l’enveloppe"
 
 #. module: xbus_emitter
 #: model:ir.model.fields,help:xbus_emitter.field_xbus_emitter_job_emitter_id
 msgid "The Xbus emitter profile to send the message with."
@@ -210,8 +207,8 @@
 
 #. module: xbus_emitter
 #: model:ir.model.fields,help:xbus_emitter.field_xbus_emitter_job_emitter_id
 msgid "The Xbus emitter profile to send the message with."
-msgstr "Le profil d'émission Xbus à utiliser pour envoyer le message."
+msgstr "Le profil d’émission Xbus à utiliser pour envoyer le message."
 
 #. module: xbus_emitter
 #: model:ir.model.fields,help:xbus_emitter.field_xbus_emitter_job_items
@@ -220,8 +217,8 @@
 
 #. module: xbus_emitter
 #: model:ir.model.fields,help:xbus_emitter.field_xbus_emitter_job_event_type
-msgid "The event type to use when sending items to Xbus."
-msgstr "Le type de message à utiliser lors de l'envoi des items vers Xbus."
+msgid "The event type to use when sending the item to Xbus."
+msgstr "Le type de message à utiliser lors de l’envoi de l’élément vers Xbus."
 
 #. module: xbus_emitter
 #: model:ir.model.fields,help:xbus_emitter.field_xbus_emitter_job_record_id
@@ -254,7 +251,7 @@
 #. module: xbus_emitter
 #: model:ir.model,name:xbus_emitter.model_xbus_emitter_job
 msgid "Xbus emitter job"
-msgstr "Job d'émission Xbus"
+msgstr "Job d’émission Xbus"
 
 #. module: xbus_emitter
 #: model:ir.actions.act_window,name:xbus_emitter.xbus_emitter_job_action
@@ -282,3 +279,9 @@
 #: model:ir.model,name:xbus_emitter.model_ir_autovacuum
 msgid "ir.autovacuum"
 msgstr "ir.autovacuum"
+
+#~ msgid "The event type to use when sending items to Xbus."
+#~ msgstr "Le type de message à utiliser lors de l’envoi de l’élément vers Xbus."
+
+#~ msgid "Items"
+#~ msgstr "Items"

models/__init__.py

-# flake8: noqa
-
-from . import ir_autovacuum, xbus_emitter, xbus_emitter_job
+from . import ir_autovacuum, xbus_emitter, xbus_emitter_job  # noqa: F401

models/xbus_emitter.py

 ##############################################################################
 #
 #    Xbus emitter for Odoo
-#    Copyright (C) 2015 XCG Consulting <http://odoo.consulting>
+#    Copyright (C) 2015, 2020 XCG Consulting <http://odoo.consulting>
 #
 #    This program is free software: you can redistribute it and/or modify
 #    it under the terms of the GNU Affero General Public License as
@@ -19,8 +19,10 @@
 ##############################################################################
 
 import json
+import logging
+from typing import Optional
 
 from odoo import api, fields, models
 
 from ..util.odoo_context import get_clean_context
 
@@ -22,8 +24,10 @@
 
 from odoo import api, fields, models
 
 from ..util.odoo_context import get_clean_context
 
+_logger = logging.getLogger(__name__)
+
 
 class XbusEmitter(models.Model):
     """Configuration profile to emit Xbus messages from Odoo.
@@ -47,8 +51,32 @@
     )
 
     @api.multi
-    def send_items(self, event_type, items, chunking="legacy", record=None):
+    def send_items(
+        self,
+        event_type: str,
+        item,
+        chunking: str = "legacy",
+        record: Optional[models.Model] = None,
+    ) -> models.Model:
+        """
+        .. deprecated: since 11.0.1.1.1
+
+        Use the ``send_item()`` function instead.
+        """
+        _logger.warning(
+            "Deprecated: Call send_item directly when sending a unique item"
+        )
+        return self.send_item(event_type, item, chunking, record)
+
+    @api.multi
+    def send_item(
+        self,
+        event_type: str,
+        item,
+        chunking: str = "legacy",
+        record: Optional[models.Model] = None,
+    ) -> models.Model:
         """Send the data to Xbus, inside one event with the specified event
         type.
 
         :param event_type: Name of an Xbus event type.
@@ -51,6 +79,5 @@
         """Send the data to Xbus, inside one event with the specified event
         type.
 
         :param event_type: Name of an Xbus event type.
-        :type event_type: String.
 
@@ -56,4 +83,4 @@
 
-        :type items: Iterable.
+        :param item: a single item
 
         :param chunking: a default chunking to use to split big items.
@@ -58,6 +85,6 @@
 
         :param chunking: a default chunking to use to split big items.
-        :type chunking: String. Values ("auto", "legacy", "single").
+        Values ("auto", "legacy", "single").
 
         :param record: A record this message is for. Allows navigating between
         records and their Xbus messages. Optional.
@@ -61,5 +88,4 @@
 
         :param record: A record this message is for. Allows navigating between
         records and their Xbus messages. Optional.
-        :type record: Odoo record set.
 
@@ -65,6 +91,5 @@
 
-        :return: The new job.
-        :rtype: Odoo "xbus.emitter.job" record set.
+        :return: The new job. Odoo "xbus.emitter.job" record set.
         """
 
         self.ensure_one()
@@ -76,7 +101,7 @@
         job_values = {
             "emitter_id": self.id,
             "event_type": event_type,
-            "items": json.dumps(items),
+            "items": json.dumps(item),
             "chunking": chunking,
         }
         if record:

models/xbus_emitter_job.py

 ##############################################################################
 #
 #    Xbus emitter for Odoo
-#    Copyright (C) 2015 XCG Consulting <http://odoo.consulting>
+#    Copyright (C) 2015, 2020 XCG Consulting <http://odoo.consulting>
 #
 #    This program is free software: you can redistribute it and/or modify
 #    it under the terms of the GNU Affero General Public License as
@@ -49,7 +49,7 @@
 
     event_type = fields.Char(
         string="Xbus event type",
-        help="The event type to use when sending items to Xbus.",
+        help="The event type to use when sending the item to Xbus.",
         required=True,
     )
 
@@ -60,7 +60,7 @@
     )
 
     items = fields.Text(
-        string="Items",
+        string="Item",
         help="The data to sent to Xbus, JSON encoded.",
         required=True,
     )

tests/__init__.py

-# flake8: noqa
-
-from . import test_export, test_xbus_emitter, test_xbus_emitter_job
+from . import (  # noqa: F401
+    test_export,
+    test_xbus_emitter,
+    test_xbus_emitter_job,
+)

tests/test_xbus_emitter.py

@@ -53,7 +53,7 @@
             EVENT_TYPE = genUuid()
             DATA = {"foo": "bar"}
 
-            job = emitter.send_items(EVENT_TYPE, DATA)
+            job = emitter.send_item(EVENT_TYPE, DATA)
             self.assertTrue(job)
             self.assertEqual(job.event_type, EVENT_TYPE)
             self.assertFalse(job.log)  # Not processed yet.

tests/test_xbus_emitter_job.py

@@ -139,7 +139,7 @@
         """
 
         # Some of this gets tested in test_xbus_emitter.
-        job = self.env.ref("xbus_emitter.default_xbus_emitter").send_items(
+        job = self.env.ref("xbus_emitter.default_xbus_emitter").send_item(
             "test-event", {"foo": "bar"}, record=self.env.user
         )
         self.assertTrue(job)