actions.py

'''
Created on 22 jul. 2013

@author: patveck
'''

import json


def _serialize(my_str):
    """Return a JSON version of str."""
    return json.dumps(my_str, sort_keys=True, separators=(',', ':'))


def add_point(chart_id, x_coord, y_coord):
    """Create message that adds point to graph in dashboard"""
    if not type(chart_id) is str:
        return message("Python function add_point called with wrong chart_id "
                       "type.")
    if chart_id == "":
        return message("Python function add_point called with empty chart_id.")
    if not (type(x_coord) is int or type(x_coord) is float):
        return message("Python function add_point called with wrong x_coord "
                       "type.")
    if not (type(y_coord) is int or type(y_coord) is float):
        return message("Python function add_point called with wrong y_coord "
                       "type.")
    return {"event": "addpoint",
            "data": [_serialize({"chartID": chart_id,
                                 "X": x_coord, "Y": y_coord})]}


def message(message_text):
    """Create message that displays a message (not an alert) in dashboard"""
    return {"event": "message",
            "data": [_serialize({"messageText": message_text})]}


def alert(alert_text):
    """Create message that displays an alert (not a message) in dashboard"""
    return {"event": "alert",
            "data": [_serialize({"alertText": alert_text})]}


def create_general_chart(chart_id, chart_options):
    """Create message that creates a new chart in dashboard"""
    return {"event": "createChart",
            "data": [_serialize({"chartID": chart_id,
                                 "chartOptions": chart_options})]}


if __name__ == '__main__':
    pass