Produits Entr'ouvert » Passerelle

# Generated by Django 2.2.24 on 2022-02-09 11:10

import django.contrib.postgres.fields

from django.db import migrations, models

import passerelle.sms.models

class Migration(migrations.Migration):

    initial = True

    dependencies = [

        ('base', '0029_auto_20210202_1627'),

    ]

    operations = [

        migrations.CreateModel(

            name='SfrDmcGateway',

            fields=[

                (

                    'id',

                    models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID'),

                ),

                ('title', models.CharField(max_length=50, verbose_name='Title')),

                ('slug', models.SlugField(unique=True, verbose_name='Identifier')),

                ('description', models.TextField(verbose_name='Description')),

                (

                    'default_country_code',

                    models.CharField(default='33', max_length=3, verbose_name='Default country code'),

                ),

                (

                    'default_trunk_prefix',

                    models.CharField(default='0', max_length=2, verbose_name='Default trunk prefix'),

                ),

                (

                    'max_message_length',

                    models.IntegerField(

                        default=2000,

                        help_text='Messages over this limit will be truncated.',

                        verbose_name='Maximum message length',

                    ),

                ),

                (

                    'authorized',

                    django.contrib.postgres.fields.ArrayField(

                        base_field=models.CharField(

                            choices=[

                                ('fr-metro', 'France mainland (+33 [67])'),

                                ('fr-domtom', 'France DOM/TOM (+262, etc.)'),

                                ('be', 'Belgian (+32 4[5-9]) '),

                                ('all', 'All'),

                            ],

                            max_length=32,

                            null=True,

                        ),

                        default=passerelle.sms.models.authorized_default,

                        size=None,

                        verbose_name='Authorized Countries',

                    ),

                ),

                (

                    'allow_premium_rate',

                    models.BooleanField(

                        default=False,

                        help_text='This option is only applyed to France mainland',

                        verbose_name='Allow premium rate numbers',

                    ),

                ),

                ('service_id', models.CharField(max_length=15, verbose_name='Service ID')),

                ('service_password', models.CharField(max_length=15, verbose_name='Service Password')),

                ('space_id', models.IntegerField(verbose_name='Space ID')),

                (

                    'users',

                    models.ManyToManyField(

                        blank=True,

                        related_name='_sfrdmcgateway_users_+',

                        related_query_name='+',

                        to='base.ApiUser',

                    ),

                ),

            ],

            options={

                'verbose_name': 'SFR DMC',

            },

        ),

    ]

# passerelle - uniform access to multiple data sources and services

# Copyright (C) 2022  Entr'ouvert

#

# 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/>.

import json

from django.db import models

from django.utils.translation import ugettext_lazy as _

from passerelle.sms.models import SMSResource

from passerelle.utils.jsonresponse import APIError

class SfrDmcGateway(SMSResource):

    service_id = models.CharField(verbose_name=_('Service ID'), max_length=15)

    service_password = models.CharField(verbose_name=_('Service Password'), max_length=15)

    space_id = models.IntegerField(verbose_name=_('Space ID'))

    TEST_DEFAULTS = {

        'create_kwargs': {

            'service_id': '1234',

            'service_password': 'krascuky',

            'space_id': '1234',

        },

        'test_vectors': [

            {

                'response': '',

                'result': {

                    'err': 1,

                    'err_desc': 'Bad JSON response',

                    'data': None,

                },

            },

            {

                'response': {'bad_json': True},

                'result': {

                    'err': 1,

                    'err_desc': 'Bad JSON response',

                    'data': None,

                },

            },

            {

                'response': {'success': False, 'no_error_detail_field': 'bad_json'},

                'result': {'err': 1, 'err_desc': 'Bad JSON response', 'data': None},

            },

            {

                'response': {'success': False, 'errorDetail': 'sfr error description'},

                'result': {

                    'err': 1,

                    'err_desc': 'sfr error description',

                    'data': None,

                },

            },

            {

                'response': {'success': True, 'response': ['1234', '5678']},

                'result': {

                    'err': 0,

                    'data': [

                        ['0033688888888', {'result': 'Envoi terminé', 'sms_id': 1234}],

                        ['0033677777777', {'result': 'Envoi terminé', 'sms_id': 1234}],

                    ],

                },

            },

        ],

    }

    URL = 'https://www.dmc.sfr-sh.fr/DmcWS/1.5.7'

    class Meta:

        verbose_name = _('SFR DMC')

    def send_msg(self, text, sender, destinations, **kwargs):

        """Send a SMS using the SFR DMC provider"""

        if len(destinations) > 20:

            raise APIError('you can\'t send more than 20 sms at once.')

        sfr_format_destinations = []

        for dest in destinations:

            sfr_format_destinations.append(f'+{dest[2:]}')  # SFR API only accepts '+' prefix

        response = self.requests.get(

            f'{self.URL}/JsonService/MessagesUnitairesWS/batchSingleCall',

            params={

                'authenticate': json.dumps(

                    {

                        'serviceId': self.service_id,

                        'servicePassword': self.service_password,

                        'spaceId': self.space_id,

                    }

                ),

                'messageUnitaires': json.dumps(

                    [

                        {'media': 'SMS', 'textMsg': text, 'from': sender, 'to': dest}

                        for dest in sfr_format_destinations

                    ]

                ),

            },

        )

        try:

            json_data = response.json()

        except ValueError:

            raise APIError('Bad JSON response')

        if 'success' not in json_data:

            raise APIError('Bad JSON response')

        elif not json_data['success']:

            if not 'errorDetail' in json_data:

                raise APIError('Bad JSON response')

            else:

                raise APIError(json_data['errorDetail'])

    'passerelle.apps.sfr_dmc',

    'passerelle.apps.sp_fr',

from utils import FakedResponse

from passerelle.apps.sfr_dmc.models import SfrDmcGateway

@pytest.mark.parametrize('connector', [SfrDmcGateway], indirect=True)

def test_sfr_max_message_error(connector):

    with pytest.raises(APIError, match='you can\'t send more than 20 sms at once.'):

        connector.send_msg('hello', '0033699999999', [f'00336888888{suffix:02d}' for suffix in range(0, 21)])

@pytest.mark.parametrize('connector', [SfrDmcGateway], indirect=True)

def test_sfr_prefix(connector):

    json_response = {

        'success': True,

        'response': {

            0: '4500283767',

            1: '4500283767',

        },

    }

    with mock.patch('passerelle.utils.Request.get') as mocked_get:

        mocked_get.return_value = FakedResponse(content=json.dumps(json_response), status_code=200)

        connector.send_msg('hello', '0033699999999', ['0033688888888'])

        mocked_get.assert_called_once_with(

            'https://www.dmc.sfr-sh.fr/DmcWS/1.5.7/JsonService/MessagesUnitairesWS/batchSingleCall',

            params={

                'authenticate': json.dumps(

                    {'serviceId': '1234', 'servicePassword': 'krascuky', 'spaceId': '1234'}

                ),

                'messageUnitaires': json.dumps(

                    [

                        {'media': 'SMS', 'textMsg': 'hello', 'from': '0033699999999', 'to': '+33688888888'},

                    ]

                ),

            },

        )