Odoo Developer Training
=======================
From Basis to First Module

OCA Days - 2020
----------------

.. image:: images/oca-days-logo.png
    :align: center

Luis Felipe Miléo
-----------------
- Co-founder and CEO at KMEE;
- Odoo Consultant and Developer since 2012;
- `PSC, team leader, of Brazilian Localization: <https://odoo-community.org/psc-teams/brazil-66>`_
- Delegate member of Odoo Community Association;
- Computer Engineer;
- `twitter @luisfelipemileo <https://twitter.com/luisfelipemileo>`_
- `instagram.com/luisfelipemileo <https://www.instagram.com/luisfelipemileo/>`_
- `linkedin.com/in/luisfelipemileo <https://linkedin.com/in/luisfelipemileo>`_
- `github.com/mileo <https://github.com/mileo>`_
- www.kmee.com.br

.. note::

     * Fell free to contact me after the presentation at OCA discord channel. I will be glad to clarify any remaining doubts.

Agenda
------

1. Intro: Odoo + Odoo Community;
2. Setup Project: Odoo and Docker Environment;
3. Coding;
4. Q&A session.


Intro: Odoo + Odoo Community
============================

The Odoo
--------

Odoo is an Open Source ERP + CRM:

- Great Framework to create Business APPs;
- Uses Python + Javascript + PostgreSQL;
- Source Code: https://github.com/odoo/odoo
- Technical Doc: https://www.odoo.com/documentation
- User Doc: https://www.odoo.com/documentation/user/
- User Training Videos: https://www.odoo.com/slides/all
- Great Community: OCA =D

.. note::

    * TIP: A good developer must seek functional understanding. If you know a module that has functionality similar to the one you want to develop, you can get good ideas by reading it.

The Odoo Community Association
------------------------------

The Odoo Community Association, or OCA, is a nonprofit organization whose mission is to
promote the widespread use of Odoo and to support the collaborative development
of Odoo features.

- Website: https://odoo-community.org/
- Discord Channel: https://discord.gg/tNby4ku
- Mailing Lists: https://odoo-community.org/groups

.. nextslide::

- 3000+ Odoo Modules with high quality code:
    - Search here: https://odoo-community.org/shop
    - Find the code: https://github.com/oca

.. warning::

    * OCA contributors use Twitter a lot! Find who they are here: https://github.com/orgs/OCA/people and follow them.

Odoo + OCA:
-----------

.. image:: images/eco.png
    :align: center

Docker environment
==================

Docker environment
------------------

Although there are many ways to run Odoo, it’s important to know how to deploy it manually, because if you have a problem with docker, you will really need to know the basics.

If you don't know it very well, check the Odoo doc:

.. code-block:: python

    https://www.odoo.com/documentation/14.0/setup/install.html
    https://www.odoo.com/documentation/14.0/setup/deploy.html


.. nextslide::

There are a lot of good docker implementations:

.. code-block:: python

    http://github.com/odoo/docker
    https://github.com/acsone/odoo-bedrock
    https://github.com/Tecnativa/doodba
    https://github.com/camptocamp/docker-odoo-project

Camptocamp - Docker Odoo project
################################

Main components:

1. **Docker project**: https://github.com/camptocamp/docker-odoo-project
2. **Marabunta** (Used to provide an easy way to create Updates for Odoo fast and run easily): https://github.com/camptocamp/marabunta
3. **Anthem** (Help scripting Odoo instances for automated setup, upgrades, testing and more): https://github.com/camptocamp/anthem

Akretion - AK
#############

The toolbelt for odoo: https://github.com/akretion/ak

It does a lot of things, but in this training we will use it for only two:

1. Download the addons
2. Generate addons path

.. code-block:: shell

    #Install with a normal user
    python3 -m pip install git+https://github.com/akretion/ak --user

Before start
------------

You will need to ensure a few things:

1. Docker installed and running: https://docs.docker.com/get-docker/
2. Docker Compose: https://docs.docker.com/compose/install/
3. Python 3
4. Python Pip https://pip.pypa.io/en/stable/installing/
5. Install Akretion AK


Setup Odoo Environment
----------------------

We will start from a pre-configured repository. To know more about it you must study a
little about the camptocamp docker-odoo-project, docker itself and other used components
like postgresql and traefik.

.. code-block:: shell

    git clone https://github.com/kmee/oca-days-2020-odoo-developer.git --branch=template
    cd oca-days-2020-odoo-developer-source

.. nextslide::

You will have the folder structure above:

.. code-block:: shell

    |-- dev.docker-compose.yml
    |── docker-compose.yml
    |── odoo
        |── data
        |── dev_oca_days.egg-info
        |── Dockerfile
        |── external-src  # Downloaded OCA repositories source code
        |── links
        |── local-src   # Your customer modules
        |── MANIFEST.in
        |── migration.yml  # Migration Scripts
        |── repo.yaml
        |── requirements.txt  # Extra requirements for your project
        |── setup.py
        |── songs  #  Scripts with antherm
        |── spec.yaml  # Source Code specification: Where download Odoo and OCA repos.
        |── src  # Downloaded Odoo Source Code
        |── VERSION

Setup the project
#################

.. code-block:: shell

    # Inside de project go to Odoo folder
    cd training
    cd odoo
    # Run **ak build** to download the sources
    ak build
    # To know more about what this command is doing read the file spec.yml
    #
    # Go back to the main folder
    cd ..
    # Build the Odoo Docker
    docker-compose build
    # To know more about what this command is doing read the file odoo/Dockerfile

Running Odoo
------------

.. code-block:: shell

    # In the project's root folder
    docker-compose up
    # To stop press CTRL + C

Check https://odoo.localhost


Adding OCA projects / modules
-----------------------------

Now that we have the Odoo up and running, let’s add a new project to improve it.

1. Go to https://odoo-community.org/shop and search for **Responsive**;
2. Open the module **web_responsive**, from Tecnativa and LasLabs, go to the website(https://github.com/OCA/web)
3. Copy the link.
4. Edit spec.yml

.. note::

    You can use Odoo SA shop to search modules too, but take a special attention in the author of the module.

.. nextslide::

Editing spec.yml:

.. code-block:: shell
    :emphasize-lines: 5-7

    odoo:
        modules: []
        src: https://github.com/odoo/odoo 13.0

    web:
        modules: []
        src: https://github.com/OCA/web 13.0

.. nextslide::

When **ak build** has finished running it displays new addons path that you can must put in your docker-compose file

.. code-block:: shell
    :emphasize-lines: 4

    ak build
    [...]
    (INFO) [07:21:45] git_aggregator.repo  src   End aggregation of /home/mileo/Projects/oca-days-2020/oca-days-2020-odoo-developer-source/odoo/src
    Addons path for your config file:  /odoo/links,/odoo/local-src,/odoo/src/odoo/addons,/odoo/src/addons,/odoo/external-src/web


TIP: This will add all the modules of the project OCA/web, if you just want the web_responsive you can use the following syntax:

.. code-block:: shell
    :emphasize-lines: 6

    odoo:
        modules: []
        src: https://github.com/odoo/odoo 13.0

    web:
        modules: ['web_responsive']
        src: https://github.com/OCA/web 13.0

.. nextslide::

Edit your docker compose to update the ADDONS_PATH

.. code-block:: shell
    :emphasize-lines: 12

    services:
      odoo:
        environment:
          - PYTHONDONTWRITEBYTECODE=True
          - LOCAL_USER_ID=$UID
          [...]
          - DB_PASS=$PGPASSWORD
          - PGHOST=$PGHOST
          - PGDATABASE=$PGDATABASE
          - PGUSER=$PGUSER
          - PGPASSWORD=$PGPASSWORD
          - ADDONS_PATH=/odoo/links,/odoo/local-src,/odoo/src/odoo/addons,/odoo/src/addons,/odoo/external-src/web
        hostname: ${ENV}-${COMPOSE_PROJECT_NAME}
        labels:
          docky.main.service: true
          docky.user: odoo
        volumes:
          - ./odoo:/odoo
          - ./data/addons:/data/odoo/addons
          [...]

.. nextslide::

To auto install web_responsive with a migration script, edit you PROJECT_ROOT/odoo/migration.yml

.. code-block:: shell
    :emphasize-lines: 12-16

    migration:
      options:
        install_command: odoo
      versions:
        - version: 13.0.0.0.0
          [...]
          modes:
            demo:
              operations:
                post:
                  - anthem songs.install.demo::main
        - version: 13.0.0.0.1
          addons:
            upgrade:
              - web_responsive

Coding our first module
=======================

Coding our first module
-----------------------

In our example module we will create an application for customer service management:
with Kanban and personalized workflow, integration with email and sms.

To help us we will use the https://github.com/acsone/bobtemplates.odoo install it
in your local user:

.. code-block:: shell

    pip install bobtemplates.odoo


Create your module skeletton
############################

Run bob the command inside de folder local-src and answer the questions:

.. code-block:: shell
    :emphasize-lines: 2,10-17

    cd PROJECT_ROOT/odoo/local-src
    mrbob bobtemplates.odoo:addon

    Welcome to mr.bob interactive mode. Before we generate directory structure,
    some questions need to be answered.

    Answer with a question mark to display help.
    Values in square brackets at the end of the questions show the
    default value if there is no answer.

    --> Addon name (with underscores): customer_service
    --> Is it an OCA addon [n]:
    --> Summary: ACME Customer Service
    --> Version [12.0.1.0.0]: 13.0.1.0.0
    --> Copyright holder name: KMEE
    --> Copyright year: 2020
    --> Website: www.kmee.com.br

    Generated file structure at PROJECT_ROOT/odoo/local-src

.. nextslide::

You will have the following file structure:

.. code-block:: shell

    |── customer_service
    │   |── __init__.py  # All Odoo modules are python modules
    │   |── __manifest__.py  # Module manifest: Here you will have the name, dependencies, authors and etc
    |── README.md  # Description of the module, as displayed on github or OCA website.

Add our module to the migration file, in a new version.

.. code-block:: shell
    :emphasize-lines: 19-21

        [...]
        - version: 13.0.0.0.1
          addons:
              - web_responsive
        - version: 13.0.0.0.2
          addons:
              - customer_service

Run Odoo an check that our module ir already installed.

TIP: When you are starting developing, the best way to go further is with little baby steps.

.. note::

    To learn more:
        * You can see a complete Odoo manifest here: https://github.com/OCA/maintainer-tools/blob/master/template/module/__manifest__.py
        * The official documentation: https://www.odoo.com/documentation/14.0/reference/module.html

Adding a new Business Model to our module
#########################################

A model will represent the Business process, the data that you want to store and
behaviors of the data you’re storing.

The basics:

- Each model is a Python class that subclasses odoo.models.Model.
- Each model is generally maps to a single database table.
- Each attribute of the model represents a database field.
- With all of this, Odoo gives you an automatically-generated database-access API; see Making queries.

.. note::

    To learn more:
        * Check the Odoo documentation: https://www.odoo.com/documentation/14.0/reference/orm.html
        * Please read the Odoo code:
            - odoo/src/odoo/models.py
            - odoo/src/odoo/fields.py

.. nextslide::

For example a CRM LEAD of Odoo Core crm module:

.. code-block:: python

    class Lead(models.Model):
        _name = "crm.lead"
        _description = "Lead/Opportunity"
        #[...]
        name = fields.Char('Opportunity', required=True, index=True)
        partner_id = fields.Many2one('res.partner', string='Customer',
            help="Linked partner (optional). Usually created when converting the lead. You can find a partner by its Name, TIN, Email or Internal Reference.")
        active = fields.Boolean('Active', default=True)
        email_from = fields.Char('Email', help="Email address of the contact")
        description = fields.Text('Notes')
        #[...]


.. nextslide::

With the help o bob.odoo we will create our first Odoo model with accompanying form, tree, action, menu, demo data and ACL

.. code-block:: shell
    :emphasize-lines: 2,8-18

    cd customer_service # Go inside de module folder that you want to create the model
    mrbob bobtemplates.odoo:model

    Welcome to mr.bob interactive mode. Before we generate directory structure, some questions
    need to be answered. Answer with a question mark to display help. Values in square
    brackets at the end of the questions show the default value if there is no answer.
    --> Odoo version (8|9|10|11|12) [12]: 13
    --> Model name (dotted notation): customer.service.ticket
    --> Inherit [y]: n
    --> Form view [y]: y
    --> Search view [y]: y
    --> Tree view [y]: y
    --> Action and menu entry [y]: y
    --> ACL [y]: y
    --> Demo data [y]: y
    --> Copyright holder name: KMEE
    --> Copyright year: 2020
    Generated file structure at PROJECT_ROOT/odoo/local-src/customer_service

.. nextslide::

You will have the following file structure:

.. code-block:: shell

    |── customer_service
    │   |── demo
    │   │   |── customer_service_ticket.xml
    │   |── __init__.py  # Updated with the model import
    │   |── __manifest__.py  # Update with the imports of demo/security and views.
    │   |── models
    │   │   |── customer_service_ticket.py # Your module definition.
    │   │   |── __init__.py
    │   |── security
    │   │   |── customer_service_ticket.xml # User access rules
    │   |── views
    │       |── customer_service_ticket.xml # Our views: tree, form, search, kanban.
    |── README.md

.. note::

    To learn more:
        * You can see here a complete Odoo module: https://github.com/OCA/maintainer-tools/blob/master/template/module/

.. nextslide::

Before install it we need to fix some settings:

1. Create a main menu
2. Relate customer service menu with main menu
3. Ensure create / write / delete user access rules

.. nextslide::

To create a main menu we need a icon, for that we will use a standard item, download from Odoo webiste:
https://www.odoo.com/pt_BR/page/brand-assets

Create the following folder structure inside the module and save it: **odoo/local-src/customer_service/static/description/icon.png**

Inside de folder views, create a new file: **customer_service/views/customer_service_menu.xml**

.. code-block:: xml

    <?xml version="1.0" encoding="utf-8"?>
    <odoo>
        <record model="ir.ui.menu" id="customer_service_main_menu">
            <field name="name">Customer Service</field>
            <field name="sequence" eval="40"/>
            <field name="web_icon">customer_service,static/description/icon.png</field>
        </record>
    </odoo>

.. note::

    To learn more:
        * Read more about the views at the official documentation: https://www.odoo.com/documentation/14.0/reference/views.html

.. nextslide::

Edit the module manifest to import the main menu:

.. code-block:: python
    :emphasize-lines: 13

    {
        'name': 'Customer Service',
        'description': """
            ACME Customer Service""",
        'version': '13.0.1.0.0',
        'license': 'AGPL-3',
        'author': 'KMEE',
        'website': 'www.kmee.com.br',
        'depends': [
        ],
        'data': [
            'security/customer_service_ticket.xml',
            'views/customer_service_menu.xml',
            'views/customer_service_ticket.xml',
        ],
        [...]


Ensure that you put it before the customer_service_ticket, **the order matters**.

.. nextslide::

Let's relate the service ticket menu with our new main menu, open the file: **odoo/local-src/customer_service/views/customer_service_ticket.xml** and edit the last section:

.. code-block:: xml
    :emphasize-lines: 4

    [...]
    <record model="ir.ui.menu" id="customer_service_ticket_menu">
        <field name="name">Customer Service Ticket</field>
        <field name="parent_id" ref="customer_service_main_menu"/> <!-- The id of the main menu -->
        <field name="action" ref="customer_service_ticket_act_window"/>
        <field name="sequence" eval="16"/>
    </record>

.. note::

    To learn more:
        * You can see here a complete Odoo module: https://github.com/OCA/maintainer-tools/blob/master/template/module/

.. nextslide::

Edit
**odoo/local-src/customer_service/security/customer_service_ticket.xml**
changing all the permissions to **ONE**

.. code-block:: xml
    :emphasize-lines: 9-11

    <?xml version="1.0" encoding="utf-8"?>
    <odoo>
        <record model="ir.model.access" id="customer_service_ticket_access_name"> <!-- TODO acl id -->
            <field name="name">customer.service.ticket access name</field> <!-- TODO acl name -->
            <field name="model_id" ref="model_customer_service_ticket"/>
            <!-- TODO review and adapt -->
            <field name="group_id" ref="base.group_user"/>
            <field name="perm_read" eval="1"/>
            <field name="perm_create" eval="1"/>
            <field name="perm_write" eval="1"/>
            <field name="perm_unlink" eval="1"/>
        </record>
    </odoo>

Updating your Odoo module manually
##################################

If your docker-composed is already running, stop it. Run it with the folllowing parameters:

.. code-block:: shell

     docker-compose run --rm -e DB_NAME=dev-oca-days odoo odoo -u customer_service --stop-after-init
     # This command will run Odoo, update the module customer_service,
     # installed on the database dev-oca-days and when finished will stop the Odoo.
     # Start Odoo again as normally
     docker-compose up


.. note::

    The Odoo command line interface: https://www.odoo.com/documentation/14.0/reference/cmdline.html

Adding fields to our model
--------------------------

At this moment you must we have a basic module, that we can install, save and edit data. With a tree view and a form view.
But we need more, let's edit *odoo/local-src/customer_service/models/customer_service_ticket.py* and add some fields.

.. code-block:: python
    :emphasize-lines: 9-12

    from odoo import api, fields, models, _

    class CustomerServiceTicket(models.Model):

        _name = 'customer.service.ticket'
        _description = 'Customer Service Ticket'  # TODO

        name = fields.Char()
        description = fields.Html(sanitize_style=True)
        user_id = fields.Many2one('res.users')
        partner_id = fields.Many2one('res.partner')
        partner_email = fields.Char(related='partner_id.email')

.. note::

    * Check more about the Odoo fields: https://www.odoo.com/documentation/14.0/reference/orm.html#fields
    * odoo/src/odoo/fields.py <------- There is nothing better than reading the source code!!!!

.. nextslide::

We need to add this new fields to the view, check your **odoo/local-src/customer_service/views/customer_service_ticket.xml**, you will see
that are five blocks of code:

1. Form view;
2. Search / Filter View (Add Filter, Group and Favorites search);
3. Tree / List view;
4. Action (Speaking in a very simple way, links the menu with the views);
5. Menu;

.. nextslide::

Add the all the new fields to the form view:

.. code-block:: xml
    :emphasize-lines: 11-14

    <record model="ir.ui.view" id="customer_service_ticket_form_view">
        <field name="name">customer.service.ticket.form (in customer_service)</field>
        <field name="model">customer.service.ticket</field>
        <field name="arch" type="xml">
            <form>
                <header>
                </header>
                <sheet>
                    <group>
                        <field name="name"/>
                        <field name="description"/>
                        <field name="user_id"/>
                        <field name="partner_id"/>
                        <field name="partner_email"/>
                    </group>
                </sheet>
                <div class="oe_chatter"></div>
            </form>
        </field>
    </record>

.. nextslide::

Add the some fields to the tree view:

.. code-block:: xml
    :emphasize-lines: 7-8

    <record model="ir.ui.view" id="customer_service_ticket_tree_view">
        <field name="name">customer.service.ticket.tree (in customer_service)</field>
        <field name="model">customer.service.ticket</field>
        <field name="arch" type="xml">
            <tree>
                <field name="name"/>
                <field name="user_id"/>
                <field name="partner_id"/>
            </tree>
        </field>
    </record>

Add a Kanban / Workflow
-----------------------

To quick add a Kanban without coding a lot we will use a very nice OCA module: **base_kanban_stage**

In the moment of this talk the module isn't migrated wet to version 13.0, then we will use a pull request instead of the main branch.
This is a good way to review other contributors work. Just be careful if you will gonna use it for production enviroment.

https://github.com/OCA/server-tools/pull/1799

.. nextslide::

Lets add it to spec.yaml:

.. code-block:: yaml
    :emphasize-lines: 7-9

    odoo:
        modules: []
        src: https://github.com/odoo/odoo 13.0

    web:
        modules: []
        src: https://github.com/OCA/web 13.0

    kmee-server-tools:
        modules: ['base_kanban_stage']
        src: https://github.com/kmee/server-tools 13.0-mig-base_kanban_stage

Add base_kanban_stage to our module dependencies
################################################

The first step is to add base_kanban_stage to our module dependencies list. To do that we need to change the module manifest, by editing the **odoo/local-src/customer_service/__manifest__.py**

.. code-block:: python
    :emphasize-lines: 10

    {
        'name': 'Customer Service',
        'description': """
            ACME Customer Service""",
        'version': '13.0.1.0.0',
        'license': 'AGPL-3',
        'author': 'KMEE',
        'website': 'www.kmee.com.br',
        'depends': [
            'base_kanban_stage',
        ],
        'data': [
            'security/customer_service_ticket.xml',
            'views/customer_service_menu.xml',
            'views/customer_service_ticket.xml',
        ],


Inherit base.kanban.abstract in our model
#########################################

Inherit from ``base.kanban.abstract`` to add Kanban stage functionality to
  the customer.service.ticket:

.. code-block:: python
    :emphasize-lines: 4

    class CustomerServiceTicket(models.Model):

        _name = 'customer.service.ticket'
        _inherit = 'base.kanban.abstract'

By doing that we add all the functionalists of the model 'base.kanban.abstract' in our model.

.. note::

    To learn more:
        * Odoo provides two inheritance mechanisms to extend an existing model in a modular way. https://www.odoo.com/documentation/14.0/howtos/backend.html?highlight=inherit#inheritance

.. nextslide::

Add a new view record at **customer_service_ticket.xml** and the **kanban** to the view_mode

.. code-block:: xml
    :emphasize-lines: 1-11,16

    <record id="customer_service_ticket_kanban_view" model="ir.ui.view">
        <field name="name">customer.service.ticket.kanban (in customer_service)</field>
        <field name="model">customer.service.ticket</field>
        <field name="mode">primary</field>
        <field name="inherit_id" ref="base_kanban_stage.base_kanban_abstract_view_kanban"/>
        <field name="arch" type="xml">
            <xpath expr="//div[@name='card_body']">
                <field name="partner_id"/>
            </xpath>
        </field>
    </record>

    <record model="ir.actions.act_window" id="customer_service_ticket_act_window">
        <field name="name">Customer Service Ticket</field> <!-- TODO -->
        <field name="res_model">customer.service.ticket</field>
        <field name="view_mode">kanban,tree,form</field>
        <field name="domain">[]</field>
        <field name="context">{}</field>
    </record>


.. nextslide::

We need to change the form view too, to add the field stage_id to the header:

.. code-block:: xml
    :emphasize-lines: 7

    <record model="ir.ui.view" id="customer_service_ticket_form_view">
        <field name="name">customer.service.ticket.form (in customer_service)</field>
        <field name="model">customer.service.ticket</field>
        <field name="arch" type="xml">
            <form>
                <header>
                    <field name="stage_id" widget="statusbar"/>
                </header>
                <sheet>
                    <group>
                        <field name="name"/>
                        <field name="description"/>
                        <field name="user_id"/>
                        <field name="partner_id"/>
                        <field name="partner_email"/>
                    </group>
                </sheet>
                <div class="oe_chatter"></div>
            </form>



Add Email features
------------------

To add email features to our model, first we need to:

1. Add mail module to our module dependencies;
2. Add **mail.thread** to the inherit list of your model, same as we did with **base.kanban.abstract**
3. Improve the view to display the email fields;

.. note::

    To learn more:
        * Odoo implements some useful classes and mixins that make it easy for you to add often-used behaviours on your objects. This guide will details most of them, with examples and use cases. https://www.odoo.com/documentation/14.0/reference/mixins.html?highlight=inherit

.. nextslide::

1. Add dependence:

.. code-block:: python
    :emphasize-lines: 11

    {
        'name': 'Customer Service',
        'description': """
            ACME Customer Service""",
        'version': '13.0.1.0.0',
        'license': 'AGPL-3',
        'author': 'KMEE',
        'website': 'www.kmee.com.br',
        'depends': [
            'base_kanban_stage',
            'mail,
        ],
        'data': [
            'security/customer_service_ticket.xml',
            'views/customer_service_menu.xml',
            'views/customer_service_ticket.xml',
        ],
        'demo': [
            'demo/customer_service_ticket.xml',
        ],
    }

.. nextslide::

2. Add **mail.thread** to the inherit list of your model:

.. code-block:: python
    :emphasize-lines: 4

    class CustomerServiceTicket(models.Model):

        _name = 'customer.service.ticket'
        _inherit = ['base.kanban.abstract', 'mail.thread']

.. nextslide::

3. Improve the view;

.. code-block:: xml
    :emphasize-lines:  19-20

    <record model="ir.ui.view" id="customer_service_ticket_form_view">
        <field name="name">customer.service.ticket.form (in customer_service)</field>
        <field name="model">customer.service.ticket</field>
        <field name="arch" type="xml">
            <form>
                <header>
                    <field name="stage_id" widget="statusbar"/>
                </header>
                <sheet>
                    <group>
                        <field name="name"/>
                        <field name="description"/>
                        <field name="user_id"/>
                        <field name="partner_id"/>
                        <field name="partner_email"/>
                    </group>
                </sheet>
                <div class="oe_chatter">
                    <field name="message_follower_ids" widget="mail_followers" groups="base.group_user"/>
                    <field name="message_ids" widget="mail_thread"/>
                </div>
            </form>
        </field>
    </record>

Sending SMS
-----------

Odoo and Odoo SA has his own provider to send SMS, but we will override this behavior to
send SMS with the provider of our choice.

To do that we will create a new module called **sms_nexmo** and we will propose it to OCA.

Here is an example of how to send SMS via nexmo:

.. code-block:: python

    from nexmo import Client
    from nexmo.sms import Sms

    sms = Sms(Client(key='60e5d109', secret='************NMX'))

    sms.send_message({
        'from': 'Vonage APIs',
        'to': '5535988763663',
        'text': 'Hello from Vonage SMS API',
    })

.. nextslide::

Odoo SA has a module **sms** which has two methods that we need to override, here is the Odoo SA code:

.. code-block:: python
    :emphasize-lines: 13,18

    class SmsApi(models.AbstractModel):
        _name = 'sms.api'
        _description = 'SMS API'

        @api.model
        def _contact_iap(self, local_endpoint, params):
            account = self.env['iap.account'].get('sms')
            params['account_token'] = account.account_token
            endpoint = self.env['ir.config_parameter'].sudo().get_param('sms.endpoint', DEFAULT_ENDPOINT)
            return iap.jsonrpc(endpoint + local_endpoint, params=params)

        @api.model
        def _send_sms(self, numbers, message):
            params = {'numbers': numbers, 'message': message}
            return self._contact_iap('/iap/message_send', params)

        @api.model
        def _send_sms_batch(self, messages):
            params = {'messages': messages}
            return self._contact_iap('/iap/sms/1/send', params)


Creating a module to be sent to OCA
-----------------------------------

This time we will not create the module **sms_nexmo** at local-src folder.
We will create and send a pull request at OCA project: https://github.com/OCA/connector-telephony

But to To do that, we need to ensure a feel things:

1. A fork of this project.
2. Add our fork to spec.yml
3. Start coding
4. Make a pull request

Adding a Fork to our project
############################

Go to the project, find the fork button on the upper right side of the screen.
Fork it to your user/organization, and add your remote fork url to spec.yml

.. code-block:: yaml

    odoo:
        modules: []
        src: https://github.com/odoo/odoo 13.0

    web:
        modules: []
        src: https://github.com/OCA/web 13.0

    kmee-server-tools:
        modules: ['base_kanban_stage']
        src: https://github.com/kmee/server-tools 13.0-mig-base_kanban_stage

    connector-telephony:
        modules: []
        src: https://github.com/YOUR_REMOTE_HERE/connector-telephony 13.0

Run **ak build** and update the **addons path**

Easy creating a OCA module with bobtemplates.odoo
#################################################

.. code-block:: shell
    :emphasize-lines: 2,10-17

    cd PROJECT_ROOT/odoo/external-src/connector-telephony
    mrbob bobtemplates.odoo:addon

    Welcome to mr.bob interactive mode. Before we generate directory structure,
    some questions need to be answered.

    Answer with a question mark to display help.
    Values in square brackets at the end of the questions show the
    default value if there is no answer.

    --> Addon name (with underscores): sms_nexmo
    --> Is it an OCA addon [n]: Y
    --> Summary: Send SMS with Nexmo instead of Odoo SA IAP.
    --> Version [12.0.1.0.0]: 13.0.1.0.0
    --> Copyright holder name: KMEE
    --> Copyright year: 2020
    --> Website: https://github.com/OCA/connector-telephony

.. nextslide::

You module sms_nexmo must depend of Odoo SA sms module:

.. code-block:: python

    {
        'name': 'Sms Nexmo',
        'summary': """
            Send SMS with Nexmo instead of Odoo SA IAP.""",
        'version': '13.0.1.0.0',
        'license': 'AGPL-3',
        'author': 'KMEE,Odoo Community Association (OCA)',
        'website': 'https://github.com/OCA/connector-telephony',
        'depends': [
            'sms',
        ],
        'data': [
            'views/iap_account.xml',
        ],
        'demo': [
        ],
    }


Extending Odoo models
#####################

We will need to change the behavior of two Odoo models:

1. **iap.account**: To save the nexmo key and secret;
2. **sms.api**: To overwrite the methods: _send_sms and _send_sms_batch

Extending Odoo models: iap.account
##################################

We need to create two new fields at the model iap.account and add it to the form screen.

.. code-block:: shell

    cd PROJECT_ROOT/odoo/external-src/connector-telephony/sms_nexmo
    mrbob bobtemplates.odoo:model

    Welcome to mr.bob interactive mode. Before we generate directory structure,
    some questions need to be answered. Answer with a question mark to display help.
    Values in square brackets at the end of the questions show the
    default value if there is no answer.

        --> Odoo version (8|9|10|11|12) [12]: 13
        --> Model name (dotted notation): iap.account
        --> Inherit [y]: Y
        --> Form view [y]: Y
        --> Search view [y]: n
        --> Tree view [y]: n
        --> Action and menu entry [y]: n
        --> ACL [y]: n
        --> Demo data [y]: n
        --> Copyright holder name: KMEE
        --> Copyright year: 2020

.. nextslide::

Adding the two fields to the model is very easy, edit the file: **PROJECT_ROOT/odoo/external-src/connector-telephony/sms_nexmo/models/iap_account.py**

.. code-block:: python

    from odoo import api, fields, models, _

    class IapAccount(models.Model):

        _inherit = 'iap.account'
        key = fields.Char()
        secret = fields.Char()

.. nextslide::

To add them to form view, the easy way is to find the view and at developer mode click on View Form View to discover the external id of the main view.

Only with the external id in hand can we edit the inherited view.

.. code-block:: xml

    <record model="ir.ui.view" id="iap_account_form_view">
        <field name="name">iap.account.form (in sms_nexmo)</field>
        <field name="model">iap.account</field>
        <field name="inherit_id" ref="iap.iap_account_view_form"/>
        <field name="arch" type="xml">
            <field name="account_token" position="after">
                <field name="key"/>
                <field name="secret"/>
            </field>
        </field>
    </record>

.. note::

    * TIP: Always remember to use the complete name: <MODULE><DOT><RECORD_ID>
    * Check the documentation about the view inheritance: https://www.odoo.com/documentation/14.0/reference/views.html?highlight=inherit#inheritance

Overwriting Odoo model: sms.api
###############################

.. code-block:: shell

    cd PROJECT_ROOT/odoo/external-src/connector-telephony/sms_nexmo
    mrbob bobtemplates.odoo:model

    Welcome to mr.bob interactive mode. Before we generate directory structure,
    some questions need to be answered. Answer with a question mark to display help.
    Values in square brackets at the end of the questions show the
    default value if there is no answer.

        --> Odoo version (8|9|10|11|12) [12]: 13
        --> Model name (dotted notation): sms.api
        --> Inherit [y]: Y
        --> Form view [y]: n
        --> Search view [y]: n
        --> Tree view [y]: n
        --> Action and menu entry [y]: n
        --> ACL [y]: n
        --> Demo data [y]: n
        --> Copyright holder name: KMEE
        --> Copyright year: 2020

.. nextslide::

To send sms we will need an external library: https://pypi.org/project/nexmo/

We must also not forget to add it to requirements.txt and run the build command again.

odoo/requirements.txt

.. code-block:: shell

    nexmo==2.5.2

And from the PROJECT_ROOT

.. code-block:: shell

    docker-compose build

.. nextslide::

Now we can use it on our python class:

.. code-block:: python

    from odoo import api, fields, models, _
    from nexmo import Client
    from nexmo.sms import Sms

    class SmsApi(models.AbstractModel):

        _inherit = 'sms.api'

        def _send_sms_nexmo(self, sms, params):
            sms.send_message(params)

        @api.model
        def _send_sms(self, numbers, message):
            account = self.env['iap.account'].get('nexmo.sms')
            if not account:
                return super(SmsApi, self)._send_sms(numbers, message)

            sms = Sms(Client(key=account.key, secret=account.secret))
            self._send_sms_nexmo(sms, {
                'from': 'Odoo',
                'to': numbers,
                'text': message,
            })

.. nextslide::

.. code-block:: python

    @api.model
    def _send_sms_batch(self, messages):
        account = self.env['iap.account'].get('nexmo.sms')
        if not account:
            return super(SmsApi, self)._send_sms_batch(messages)

        sms = Sms(Client(key=account.key, secret=account.secret))

        for record in messages:
            result = self._send_sms_nexmo(sms, {
                'from': 'Odoo',
                'to': record['number'],
                'text': record['content'],
            })
            if result['messages'][0]['status'] == '0':
                record['state'] = 'success'
            else:
                record['state'] = 'error'
        return messages


Integrate Customer Service with SMS
-----------------------------------

Before getting your hands dirty and integrating our module with sms it is important that you understand some things.

1. When we changed the definition of our model so that it inherited from mail.thread. We made him acquire all the functionality of the email module.

.. code-block:: python
    :emphasize-lines: 4

    class CustomerServiceTicket(models.Model):

        _name = 'customer.service.ticket'
        _inherit = ['base.kanban.abstract', 'mail.thread']


.. nextslide::

2. When installing the Odoo SA **sms** module we added new features to the mail.thread model, making Odoo records able to communicate via sms as well.
3. When we create a module sms_nexmo we change de default behavior of sending sms via Odoo SA IAP to send it via Nexmo.


Send customer service number by SMS
###################################

We will create a button to allow user to send ticket number to the partner by sms. But before that we will need the ticket number.

Lets add a sequence to our model, by creating:

1. Folder data at **PROJECT_ROOT/odoo/local-src/customer_service/data**
2. A file: **PROJECT_ROOT/odoo/local-src/customer_service/data/ir_sequence_data.xml**

.. nextslide::

3. Add it to the module manifest.

.. code-block:: xml
    :emphasize-lines: 4

    <?xml version="1.0" encoding="utf-8"?>
    <odoo>
        <data noupdate="1">

            <record id="customer_service_sequence" model="ir.sequence">
                <field name="name">CustomerService</field>
                <field name="code">customer.service</field>
                <field name="prefix">CS/</field>
                <field name="padding">7</field>
            </record>

        </data>
    </odoo>

.. nextslide::

Auto create a sequence when creating a new record:

.. code-block:: python
    :emphasize-lines: 10

    from odoo import api, fields, models, _

    class CustomerServiceTicket(models.Model):

        _name = 'customer.service.ticket'
        _inherit = ['base.kanban.abstract', 'mail.thread']

        _description = 'Customer Service Ticket'  # TODO

        code = fields.Char(
            readonly=True,
            default=lambda self: self.env['ir.sequence'].next_by_code('customer.service'))
        )
        name = fields.Char()
        description = fields.Html(sanitize_style=True)
        user_id = fields.Many2one('res.users')
        partner_id = fields.Many2one('res.partner')
        partner_email = fields.Char(related='partner_id.email')

.. nextslide::

Add the new field to the form view:

.. code-block:: xml
    :emphasize-lines: 11

    <record model="ir.ui.view" id="customer_service_ticket_form_view">
        <field name="name">customer.service.ticket.form (in customer_service)</field>
        <field name="model">customer.service.ticket</field>
        <field name="arch" type="xml">
            <form>
                <header>
                    <field name="stage_id" widget="statusbar"/>
                </header>
                <sheet>
                    <group>
                        <field name="code"/>
                        <field name="name"/>
                        <field name="description"/>
                        <field name="user_id"/>
                        <field name="partner_id"/>
                        <field name="partner_email"/>
                    </group>
                </sheet>
                <div class="oe_chatter">
                    <field name="message_follower_ids" widget="mail_followers" groups="base.group_user"/>
                    <field name="message_ids" widget="mail_thread"/>
                </div>


.. nextslide::

Add the new field to the tree view:

.. code-block:: xml
    :emphasize-lines: 6

    <record model="ir.ui.view" id="customer_service_ticket_tree_view">
        <field name="name">customer.service.ticket.tree (in customer_service)</field>
        <field name="model">customer.service.ticket</field>
        <field name="arch" type="xml">
            <tree>
                <field name="code"/>
                <field name="name"/>
                <field name="user_id"/>
                <field name="partner_id"/>
            </tree>
        </field>
    </record>


Creating a button to send sms
#############################

1. Add the button to the view
2. Create the method at the model

.. code-block:: xml
    :emphasize-lines: 8

    <record model="ir.ui.view" id="customer_service_ticket_form_view">
        <field name="name">customer.service.ticket.form (in customer_service)</field>
        <field name="model">customer.service.ticket</field>
        <field name="arch" type="xml">
            <form>
                <header>
                    <field name="stage_id" widget="statusbar"/>
                    <button name="send_number_by_sms" type="object" string="Send Object by SMS"/>
                </header>
                <sheet>
                    <group>
                        <field name="code"/>
                        <field name="name"/>
                        <field name="description"/>
                        <field name="user_id"/>
                        <field name="partner_id"/>
                        <field name="partner_email"/>
                    </group>


.. nextslide::

.. code-block:: python
    :emphasize-lines: 10-13

    from odoo import api, fields, models, _

    class CustomerServiceTicket(models.Model):

        _name = 'customer.service.ticket'
        _inherit = ['base.kanban.abstract', 'mail.thread']

        _description = 'Customer Service Ticket'  # TODO

        code = fields.Char(
            readonly=True,
            default=lambda self: self.env['ir.sequence'].next_by_code('customer.service'))
        )
        name = fields.Char()
        description = fields.Html(sanitize_style=True)
        user_id = fields.Many2one('res.users')
        partner_id = fields.Many2one('res.partner')
        partner_email = fields.Char(related='partner_id.email')

        def send_number_by_sms(self):
            for record in self:
                record._message_sms(
                    'OCA days: Your ticket number is {}'.format(record.code),
                    partner_ids=record.partner_id.ids
                )



Seding your module to the OCA
-----------------------------

1. Commit
2. Push to the fork
3. Create a pull request

.. note::

    To learn more:
        * Check the OCA guidelines: https://github.com/OCA/odoo-community.org/blob/master/website/Contribution/CONTRIBUTING.rst

Review
------

1. Setup your project from a project template;
2. Use OCA modules;
3. Create your own module;
4. Create an OCA module;


Questions and answers
=====================

Thank you to the OCA Sponsors
-----------------------------

.. image:: images/sponsors.jpg
    :align: center
    :height: 500px
    :width: 550px