jasmin-mongo-configuration 0.1.0.dev3

Links Jasmin SMS Gateway to MongoDB cluster's Change Stream (can be one node).

Jasmin Mongo Configuration

Links Jasmin SMS Gateway's configuration to MongoDB cluster's Change Stream (can be a one-node cluster). This package is using MongoDB cluster's Change Stream which allow applications to access realtime data changes.

Table of Contents

1. Installation Instructions
   • PYPI
   • From Source
   • Docker
2. Setup MongoDB CLuster
3. Usage Instructions
   • Data Structure
   • Start the Service
   • Billing Management

Installation Instructions

PYPI

pip3 install -U jasmin-mongo-configuration

From Source

git clone https://github.com/BlackOrder/jasmin_mongo_configuration.git
cd jasmin_mongo_configuration
pip3 install .

Docker

docker compose -f ./docker/docker-compose.yml up -d

Be sure to change the JASMIN_CLI_HOST and MONGO_HOST in the docker-compose.yml file to your desired values. and also finish the setup of the MongoDB cluster and import all of your configurations into a MongoDB database before running the docker-compose file.

Setup MongoDB CLuster

To setup a MongoDB cluster with Docker, You can use this open source Docker Custom MongoDB Image

Usage Instructions

Jasmin Mongo Configuration sync all configurations [Smppccm, Httpccm, Group, User, Filter, MoRouter, MtRouter, MoInterceptor, and MtInterceptor] from a MongoDB cluster to a jasmin instance. All settings can be read from OS ENV when run from console or passed as arguments. if you want to import it in you code, you can supply the settings on initialization.

Data Structure

The Database supplied should have a collection for each module:

smppccm
group
user
filter
httpccm
morouter
mointerceptor
mtrouter
mtinterceptor

Each collection should contains your desired jasmin's settings in a key value format. and should have a valid format for Jasmin. for example the user collection should have documents in this format:

{
    "_id": "$UID",
    "gid": "$GID",
    "mt_messaging_cred authorization dlr_level": "True",
    "mt_messaging_cred authorization hex_content": "True",
    "mt_messaging_cred authorization http_balance": "True",
    "mt_messaging_cred authorization http_bulk": "True",
    "mt_messaging_cred authorization http_dlr_method": "True",
    "mt_messaging_cred authorization http_long_content": "True",
    "mt_messaging_cred authorization http_rate": "True",
    "mt_messaging_cred authorization http_send": "True",
    "mt_messaging_cred authorization priority": "True",
    "mt_messaging_cred authorization schedule_delivery_time": "True",
    "mt_messaging_cred authorization smpps_send": "True",
    "mt_messaging_cred authorization src_addr": "True",
    "mt_messaging_cred authorization validity_period": "True",
    "mt_messaging_cred defaultvalue src_addr": "None",
    "mt_messaging_cred quota balance": "None",
    "mt_messaging_cred quota early_percent": "None",
    "mt_messaging_cred quota http_throughput": "None",
    "mt_messaging_cred quota smpps_throughput": "None",
    "mt_messaging_cred quota sms_count": 4000,
    "mt_messaging_cred valuefilter content": ".*",
    "mt_messaging_cred valuefilter dst_addr": ".*",
    "mt_messaging_cred valuefilter priority": "^[0-3]$",
    "mt_messaging_cred valuefilter src_addr": "^()$",
    "mt_messaging_cred valuefilter validity_period": "^d+$",
    "password": "$PASSWORD",
    "smpps_cred authorization bind": "True",
    "smpps_cred quota max_bindings": "1",
    "status": true,
    "uid": "$UID",
    "username": "$USERNAME"
}

Keep in mind, to not include mt_messaging_cred quota balance, and mt_messaging_cred quota sms_count keys in your user collection if you have jasmin internal billing enabled. Also notice there is an extra key status. This key is a special bool field. You have to include it in all user, group, and smppccm documents. The package will use the value of this key to Enable if True, Disable if False the user, and group. In case of smppccm the package will start the smppccm if True and stop it if False.

Also keep in mind the package will not copy any files to the jasmin instance. all communications are done through Telnet. So, in case of MoInterceptor, and MtInterceptor. You will have to make the script accessible to the jasmin server. Example of a MtInterceptor document:

{
    "_id": "$ORDER",
    "filters": "premium_numbers",
    "order": "$ORDER",
    "script": "python3(/tmp/premium.py)",
    "type": "StaticMTInterceptor"
}

You will have to make the sure jasmin have access to /tmp/premium.py before adding the document to MongoDB cluster.

Start the service

There is multiple ways to setup the package from CLI.

1. By exporting ENV variables you can export the fallowing variables before execution

   JASMIN_CLI_HOST                         =       **REQUIRED:NoDefault**
   JASMIN_CLI_PORT                         =               8990
   JASMIN_CLI_TIMEOUT                      =                30
   JASMIN_CLI_AUTH                         =                yes
   JASMIN_CLI_USERNAME                     =             jcliadmin
   JASMIN_CLI_PASSWORD                     =              jclipwd
   JASMIN_CLI_STANDARD_PROMPT              =             "jcli : "
   JASMIN_CLI_INTERACTIVE_PROMPT           =               "> "
   MONGO_CONNECTION_STRING                 =       **REQUIRED:NoDefault**
   MONGO_CONFIGURATION_DATABASE            =       **REQUIRED:NoDefault**
   SYNC_CURRENT_FIRST                      =                yes
   JASMIN_MONGO_CONFIGURATION_LOG_PATH     =          /var/log/jasmin/
   

   Then execute:

   jasminmongoconfd
   

2. you can pass arguments to the package on execution. execute jasminmongoconfd -h to see all possible arguments. Then execute:

   jasminmongoconfd --cli-host $JASMIN_CLI_HOST --connection-string $MONGO_CONNECTION_STRING --configuration-database $MONGO_CONFIGURATION_DATABASE
   

3. Mix the previous two methods. you can set the ENV variables and pass some arguments. for example:

   JASMIN_CLI_HOST=127.0.0.1 jasminmongoconfd --connection-string $MONGO_CONNECTION_STRING --configuration-database $MONGO_CONFIGURATION_DATABASE
   

Billing Management

Billing managment if enabled it will disable jasmin internal billing. The user's mt_messaging_cred quota balance and mt_messaging_cred quota sms_count keys in their documents will be ignored by the sync configuration and a value of None will always be passed to jasmin for both. The package provides a MT and a MO interceptor blueprints that could be installed for the users to be billed. The interceptors will accept ENV variables or you can change them to a static values. You can use these or write your own interceptors.

You can get the MO and MT interceptors from the jasminmongoconfd package. The interceptors are located in the jasminmongoconfd/interceptors directory or you can get them from the jasminmongoconfd package installed in your system. Example:

jasminmongoconfd -get-interceptor mo > /tmp/mo.py
jasminmongoconfd -get-interceptor mt > /tmp/mt.py

You will have to make sure the jasmin instance have access to the interceptors files. You can use scp to copy the files to the jasmin instance. Example:

scp /tmp/mo.py jasmin:/tmp/mo.py
scp /tmp/mt.py jasmin:/tmp/mt.py

Then add the interceptors to you configuration collection.