diff --git a/crm_reminder_email_activities/README.rst b/crm_reminder_email_activities/README.rst new file mode 100644 index 00000000000..8b9c02838b0 --- /dev/null +++ b/crm_reminder_email_activities/README.rst @@ -0,0 +1,85 @@ +============================= +CRM Reminder email activities +============================= + +.. + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! This file is generated by oca-gen-addon-readme !! + !! changes will be overwritten. !! + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! source digest: sha256:f3971269550a898135a10a05b02486c5ab0e969791ce164fc0eb37f9cbdfa6a8 + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + +.. |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-OCA%2Fcrm-lightgray.png?logo=github + :target: https://github.com/OCA/crm/tree/18.0/crm_reminder_email_activities + :alt: OCA/crm +.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png + :target: https://translation.odoo-community.org/projects/crm-18-0/crm-18-0-crm_reminder_email_activities + :alt: Translate me on Weblate +.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png + :target: https://runboat.odoo-community.org/builds?repo=OCA/crm&target_branch=18.0 + :alt: Try me on Runboat + +|badge1| |badge2| |badge3| |badge4| |badge5| + +This module introduces email reminders that summarize for users the +active activities due in the following 7 days. + +**Table of contents** + +.. contents:: + :local: + +Known issues / Roadmap +====================== + +A possible improvement is the implementation of the ability to customize +the time interval of reminders. + +Bug Tracker +=========== + +Bugs are tracked on `GitHub Issues `_. +In case of trouble, please check there if your issue has already been reported. +If you spotted it first, help us to smash it by providing a detailed and welcomed +`feedback `_. + +Do not contact contributors directly about support or help with technical issues. + +Credits +======= + +Authors +------- + +* PyTech SRL + +Contributors +------------ + +- `PyTech SRL `__: + + - Alessandro Pecchini + +Maintainers +----------- + +This module is maintained by the OCA. + +.. image:: https://odoo-community.org/logo.png + :alt: Odoo Community Association + :target: https://odoo-community.org + +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. + +This module is part of the `OCA/crm `_ project on GitHub. + +You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. diff --git a/crm_reminder_email_activities/__init__.py b/crm_reminder_email_activities/__init__.py new file mode 100644 index 00000000000..0650744f6bc --- /dev/null +++ b/crm_reminder_email_activities/__init__.py @@ -0,0 +1 @@ +from . import models diff --git a/crm_reminder_email_activities/__manifest__.py b/crm_reminder_email_activities/__manifest__.py new file mode 100644 index 00000000000..cdb4b36d096 --- /dev/null +++ b/crm_reminder_email_activities/__manifest__.py @@ -0,0 +1,20 @@ +{ + "name": "CRM Reminder email activities", + "summary": """ + This module periodically sends a reminder email for + activities related to leads that expire within 7 days. + """, + "version": "18.0.1.0.0", + "author": "PyTech SRL, Odoo Community Association (OCA)", + "license": "AGPL-3", + "website": "https://github.com/OCA/crm", + "application": False, + "installable": True, + "depends": [ + "crm", + ], + "data": [ + "data/ir_cron.xml", + "data/mail_template_reminder.xml", + ], +} diff --git a/crm_reminder_email_activities/data/ir_cron.xml b/crm_reminder_email_activities/data/ir_cron.xml new file mode 100644 index 00000000000..24c1d7daaea --- /dev/null +++ b/crm_reminder_email_activities/data/ir_cron.xml @@ -0,0 +1,14 @@ + + + + Reminder CRM planned activities + + + code + model.cron_send_crm_reminder_activities() + 1 + weeks + + + + diff --git a/crm_reminder_email_activities/data/mail_template_reminder.xml b/crm_reminder_email_activities/data/mail_template_reminder.xml new file mode 100644 index 00000000000..76238441bac --- /dev/null +++ b/crm_reminder_email_activities/data/mail_template_reminder.xml @@ -0,0 +1,91 @@ + + + + Reminder CRM planned activities + + {{object.env.user.email_formatted}} + {{object.partner_id.id}} + + Reminder CRM planned activities + +
+ + + Reminder CRM planned activities + +
+ + User + +
+ + + +
+

Dear User, +

+

Below are your active CRM app tasks due in the next 7 days: +

+
    + +
  • + +

    Deadline: + +

    +

    + + - + +

    +
    • +     +
+
+
+ + +

+

+
+ + + diff --git a/crm_reminder_email_activities/models/__init__.py b/crm_reminder_email_activities/models/__init__.py new file mode 100644 index 00000000000..e66f0d6cf4e --- /dev/null +++ b/crm_reminder_email_activities/models/__init__.py @@ -0,0 +1 @@ +from . import crm_lead diff --git a/crm_reminder_email_activities/models/crm_lead.py b/crm_reminder_email_activities/models/crm_lead.py new file mode 100644 index 00000000000..e5835d103f4 --- /dev/null +++ b/crm_reminder_email_activities/models/crm_lead.py @@ -0,0 +1,34 @@ +from dateutil.relativedelta import relativedelta + +from odoo import api, fields, models + + +class CrmLead(models.Model): + _inherit = "crm.lead" + + @api.model + def cron_send_crm_reminder_activities(self): + users = self._get_crm_activities().mapped("user_id") + try: + mail_template = self.env.ref( + "crm_reminder_email_activities.email_template_crm_reminder_activities" + ) + for user in users: + mail_template.with_context(activity_owner=user).send_mail( + self.id, email_values={"email_to": user.email} + ) + except ValueError as err: + raise ValueError( + self.env._("CRM Reminder Activities Mail Template not found.") + ) from err + + def _get_crm_activities(self, user=None): + today = fields.Date.context_today(self) + domain = [ + ("res_model", "=", "crm.lead"), + ("date_deadline", ">=", today), + ("date_deadline", "<=", today + relativedelta(days=+7)), + ] + if user: + domain.append(("user_id", "=", user.id)) + return self.env["mail.activity"].search(domain, order="date_deadline asc") diff --git a/crm_reminder_email_activities/pyproject.toml b/crm_reminder_email_activities/pyproject.toml new file mode 100644 index 00000000000..4231d0cccb3 --- /dev/null +++ b/crm_reminder_email_activities/pyproject.toml @@ -0,0 +1,3 @@ +[build-system] +requires = ["whool"] +build-backend = "whool.buildapi" diff --git a/crm_reminder_email_activities/readme/CONTRIBUTORS.md b/crm_reminder_email_activities/readme/CONTRIBUTORS.md new file mode 100644 index 00000000000..729c9e6d899 --- /dev/null +++ b/crm_reminder_email_activities/readme/CONTRIBUTORS.md @@ -0,0 +1,2 @@ +- [PyTech SRL](https://pytech.it): + - Alessandro Pecchini \<\> diff --git a/crm_reminder_email_activities/readme/DESCRIPTION.md b/crm_reminder_email_activities/readme/DESCRIPTION.md new file mode 100644 index 00000000000..d089b3cd157 --- /dev/null +++ b/crm_reminder_email_activities/readme/DESCRIPTION.md @@ -0,0 +1 @@ +This module introduces email reminders that summarize for users the active activities due in the following 7 days. diff --git a/crm_reminder_email_activities/readme/ROADMAP.md b/crm_reminder_email_activities/readme/ROADMAP.md new file mode 100644 index 00000000000..e3b284169e6 --- /dev/null +++ b/crm_reminder_email_activities/readme/ROADMAP.md @@ -0,0 +1 @@ +A possible improvement is the implementation of the ability to customize the time interval of reminders. diff --git a/crm_reminder_email_activities/static/description/index.html b/crm_reminder_email_activities/static/description/index.html new file mode 100644 index 00000000000..a104cb6f2e8 --- /dev/null +++ b/crm_reminder_email_activities/static/description/index.html @@ -0,0 +1,433 @@ + + + + + +CRM Reminder email activities + + + +
+

CRM Reminder email activities

+ + +

Beta License: AGPL-3 OCA/crm Translate me on Weblate Try me on Runboat

+

This module introduces email reminders that summarize for users the +active activities due in the following 7 days.

+

Table of contents

+ +
+

Known issues / Roadmap

+

A possible improvement is the implementation of the ability to customize +the time interval of reminders.

+
+
+

Bug Tracker

+

Bugs are tracked on GitHub Issues. +In case of trouble, please check there if your issue has already been reported. +If you spotted it first, help us to smash it by providing a detailed and welcomed +feedback.

+

Do not contact contributors directly about support or help with technical issues.

+
+
+

Credits

+
+

Authors

+
    +
  • PyTech SRL
    • +
+
+
+

Contributors

+ +
+
+

Maintainers

+

This module is maintained by the OCA.

+ +Odoo Community Association + +

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.

+

This module is part of the OCA/crm project on GitHub.

+

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

+
+
+
+ + diff --git a/crm_reminder_email_activities/tests/__init__.py b/crm_reminder_email_activities/tests/__init__.py new file mode 100644 index 00000000000..313ea032e9e --- /dev/null +++ b/crm_reminder_email_activities/tests/__init__.py @@ -0,0 +1 @@ +from . import test_email_reminder_planned_activity diff --git a/crm_reminder_email_activities/tests/test_email_reminder_planned_activity.py b/crm_reminder_email_activities/tests/test_email_reminder_planned_activity.py new file mode 100644 index 00000000000..eda9051d1b0 --- /dev/null +++ b/crm_reminder_email_activities/tests/test_email_reminder_planned_activity.py @@ -0,0 +1,144 @@ +from dateutil.relativedelta import relativedelta + +from odoo import fields +from odoo.tests.common import new_test_user + +from odoo.addons.base.tests.common import BaseCommon + + +class TestEmailReminderPlannedActivity(BaseCommon): + @classmethod + def setUpClass(cls): + super().setUpClass() + + cls.env = cls.env(context=dict(cls.env.context, tracking_disable=True)) + cls.user_a = new_test_user( + cls.env, + login="user_a", + name="Reminder User A", + groups="base.group_user,sales_team.group_sale_salesman", + ) + cls.user_b = new_test_user( + cls.env, + login="user_b", + name="Reminder User B", + groups="base.group_user,sales_team.group_sale_salesman", + ) + + cls.activity_type = cls.env.ref("mail.mail_activity_data_todo") + + cls.lead_1 = cls.env["crm.lead"].create( + { + "name": "Reminder Lead 1", + "type": "opportunity", + } + ) + cls.lead_2 = cls.env["crm.lead"].create( + { + "name": "Reminder Lead 2", + "type": "opportunity", + } + ) + + cls.today = fields.Date.context_today(cls.env.user) + + def _create_activity(self, lead, user, deadline): + return self.env["mail.activity"].create( + { + "res_model_id": self.env.ref("crm.model_crm_lead").id, + "res_id": lead.id, + "activity_type_id": self.activity_type.id, + "user_id": user.id, + "date_deadline": deadline, + } + ) + + def test_get_crm_activities_date_boundaries(self): + """Check that the `_get_crm_activities` function + selects the right activities related to the correct user + """ + # Correct + act_today = self._create_activity(self.lead_1, self.user_a, self.today) + act_day7 = self._create_activity( + self.lead_1, self.user_a, self.today + relativedelta(days=7) + ) + + # Not correct + act_day8 = self._create_activity( + self.lead_1, self.user_a, self.today + relativedelta(days=8) + ) + act_yesterday = self._create_activity( + self.lead_1, self.user_a, self.today - relativedelta(days=1) + ) + act_today_user_b = self._create_activity(self.lead_1, self.user_b, self.today) + act_day8_user_b = self._create_activity( + self.lead_1, self.user_b, self.today + relativedelta(days=8) + ) + + result = self.env["crm.lead"]._get_crm_activities(user=self.user_a) + + self.assertIn(act_today, result) + self.assertIn(act_day7, result) + self.assertNotIn(act_day8, result) + self.assertNotIn(act_yesterday, result) + self.assertNotIn(act_today_user_b, result) + self.assertNotIn(act_day8_user_b, result) + self.assertEqual(len(result), 2) + + def test_get_crm_activities_filters_res_model(self): + """Check that function `_get_crm_activities` + correctly checks the res_model of the activity + """ + partner = self.env["res.partner"].create({"name": "Test Partner"}) + + partner_activity = self.env["mail.activity"].create( + { + "res_model_id": self.env.ref("base.model_res_partner").id, + "res_id": partner.id, + "activity_type_id": self.activity_type.id, + "user_id": self.user_a.id, + "date_deadline": self.today, + } + ) + + lead_activity = self._create_activity(self.lead_1, self.user_a, self.today) + + result = self.env["crm.lead"]._get_crm_activities(user=self.user_a) + + self.assertIn(lead_activity, result) + self.assertNotIn(partner_activity, result) + self.assertEqual(len(result), 1) + + def test_get_crm_activities_without_user(self): + """Check that function `_get_crm_activities` works + correctly even without specifying a specific user + """ + act_in = self._create_activity(self.lead_1, self.user_a, self.today) + act_out = self._create_activity( + self.lead_1, self.user_b, self.today + relativedelta(days=8) + ) + + result = self.env["crm.lead"]._get_crm_activities() + + self.assertIn(act_in, result) + self.assertNotIn(act_out, result) + + def test_send_reminder_mail_without_template(self): + """check behaviour of sending crm activities + reminder mail when mail template not exist""" + self.env.ref( + "crm_reminder_email_activities.email_template_crm_reminder_activities" + ).unlink() + error_msg = "CRM Reminder Activities Mail Template not found." + with self.assertRaisesRegex(ValueError, error_msg): + self.env["crm.lead"].cron_send_crm_reminder_activities() + + def test_send_mail(self): + self._create_activity(self.lead_1, self.user_a, self.today) + self.env["crm.lead"].cron_send_crm_reminder_activities() + mail = self.env["mail.mail"].search( + [("email_to", "=", self.user_a.email)], order="id desc", limit=1 + ) + self.assertTrue(mail) + self.assertIn("Dear Reminder User A", mail.body_html) + self.assertIn("Reminder Lead 1", mail.body_html)