pymasmovil 0.0.31

Python client for the Más Móvil's B2B API

Más Móvil Python API client

This Python API client provides access to Más Móvil's B2B REST API.

Installation

Requirements

• Python 3.8+

Usage

Login

To authenticate, you need to specify credentials which need to be set as environment variables with the following names:

'MM_BASEURL': 'https://<host>/cableOperadores/services/apexrest/api'
'MM_USER': 'user'
'MM_PASSWORD': 'pwd'
'MM_DOMAIN': 'domain'

MM_BASEURL must point to the MásMóvili's API environment, either testing or production. Pymasmovil will only append API routes to it like /v0/accounts to perform requests. In the case of testing, check with them as this surely changes per customer.

MM_USER and MM_PASSWORD must be replaced with your actual user credentials, and MM_DOMAIN must point to either "test" or "login" depending on which MM environment need to be called (test/production).

Session creation

The login is done when we create a session using the Session.create method:

from pymasmovil.models.session import Session

session = Session.create()

print('Session created with id : {}'.format(session.session_id))
 

This returns the API key needed to authenticate all subsequent requests. That is why the Session instance has to be passed in to other all other objects methods.

Account

from pymasmovil.models.account import Account

account_id = '0017E000017pEo3QAE'
account = Account.get(session, account_id)

To create a new account we need to use Account.create passing the account data as keyword arguments. The Account attributes are listed bellow. Note they are all strings.

town, surname, stair, roadType, roadNumber, roadName, region, province, postalCode, phone, name, id, flat, email, door, donorCountry, documentType, documentNumber, corporateName, buildingPortal

No attribute is mandatory for the client leaving parameter validation to the API.

from pymasmovil.models.account import Account

account = Account.create(session, town='Barcelona', surname='Garcia', phone='616010101')

OrderItem

Order items can be accessed the same way as accounts:

from pymasmovil.models.order_items.py import OrderItem

order_item_id = '8028E34500215wgQAA'
order_item = OrderItem.get(session, order_item_id)

Currently, order items can be created following the account creation example, but the structure of their attributes is a bit more complex.

Since GET /order-item/:id response and the POST /accounts/:id/order-items request don't match except for a few attributes, order item creation is then designed to opimistically build an OrderItem instance based on the attributes inferred from the POST body. MásMóvil's API doesn't return the whole resource as one would expect with a REST API. That is why OrderItem's create input data structure won't directly match an OrderItem attributes.

The minimum structure is presented as the variable sample-order-item-post-request:

from pymasmovil.models.order_items.py import OrderItem

order_item_data = {
    'lineInfo': [
        {
            'name': 'Antonio',
            'surname': 'Garcia',
            'phoneNumber': '616010101',
            'documentType': 'NIF',
            'iccid_donante': '8934046318031035245',
            'iccid': '8934046318031035250',
        }
    ]
}

order_item = OrderItem.create(session, order_item_data)

Development

Python version

We use Pyenv to fix the Python version and the virtualenv to develop the package.

You need to:

• Install and configure pyenv
• Install and configure pyenv-virtualenv
• Install the required Python version:

$ pyenv install 3.8.2

• Create the virtualenv:

$ pyenv virtualenv 3.8.2 pymasmovil

Python packages requirements

Install the Python packages in the virtual environment:

$ pyenv exec pip install -r requirements.txt

Formatting

We use Pre-commit to execute Black as formatter before commiting.

Install pre-commit configuration (found in file .pre-commit-config.yaml)

$ pre-commit install

After this, any time we apply a commit black will run with the modified files within the commit.

We can also execute black at any moment, choosing a file or a path to format all the files in there:

$ black .
All done! ✨ 🍰 ✨
24 files left unchanged.

Releasing

Update CHANGELOG.md following this steps:

1. Add any entries missing from merged merge requests.
2. Duplicate the [Unreleased] header.
3. Replace the second Unreleased with a version number followed by the current date. Copy the exact format from previous releases.

Then, you can release and publish the package to PyPi:

1. Update the VERSION var in setup.py matching the version you specified in the CHANGELOG.
2. Open a merge request with these changes for the team to approve
3. Merge it, add a git tag on that merge commit and push it.
4. Once the pipeline has successfully passed, go approve the publish step.

License

TBD