Source code for janua.actions.sendsms

# -*- Mode: Python; coding: utf-8; indent-tabs-mode: nil; tab-width: 4 -*-
#
# Copyright (c) 2016 Cédric Clerget - HPC Center of Franche-Comté University
#
# This file is part of Janua-SMS
#
# http://github.com/mesocentrefc/Janua-SMS
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation v2.
#
# 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 General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.
#

from janua.actions.action import Action
from janua.actions.action import argument
from janua.ws import json_error, json_success
from janua.ws.services import urlconfig

[docs]class SendSms(Action):
    """
    Send SMS to contacts and/or groups.
    
    **to** parameter can take a list of contacts phone number and/or groups
    separated by comma.

    Sample request for sending to all my contacts with special group 'all':

    .. code-block:: javascript

       POST /sendsms HTTP/1.1
       Host: janua.mydomain.com
       Content-Type: application/json
       JanuaAuthToken: abcdef123456789

       {
         "message": "Test",
         "to": "all"
       }

    Sample response:

    .. code-block:: javascript

       HTTP/1.1 200

       {
         "message": "SMS message has been queued",
         "success": true
       }

    Send message to group **MESO** and contact with phone number **+33123456789**
    with Curl:
    
    .. code-block:: bash

       /usr/bin/curl -H "Content-Type: application/json" \\
                     -X POST -d '{"message": "Test", "to": "+33123456789,MESO"}' \\
                     -u "+33763140817:myuberpwd" \\
                     https://janua.mydomain.com/sendsms
    """

    category = '__INTERNAL__'

    def console(self):
        return self.send_sms(message=self.message(), to=self.to())

    @urlconfig('/sendsms')
    def web(self):
        success, message = self.send_sms(message=self.message(), to=self.to())
        if success:
            return json_success(message)
        else:
            return json_error(message)

    @argument(required=True)
    def message(self):
        """Your message"""
        return str()

    @argument(required=True)
    def to(self):
        """Recipient(s), mix phone and group separa"""
        return str()