node-red-contrib-snap4city-user/tpl-routes-by-line.html

Nodes for Snap4city project, targeted to standard user (no developer)

<!--/* NODE-RED-CONTRIB-SNAP4CITY-USER
   Copyright (C) 2018 DISIT Lab http://www.disit.org - University of Florence

   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/>. */-->
<script type="text/javascript">
    RED.nodes.registerType('tpl-routes-by-line', {
        category: 'S4CSearch',
        color: '#b0dfe3',
        defaults: {
            name: {
                value: ""
            },
            authentication: {
                type: "snap4city-authentication",
                required: false
            },
            agency: {
                value: "",
                required: false
            },
            line: {
                value: "",
                required: false
            }
        },
        outputs: 1,
        inputs: 1,
        outputLabels: ["routes"],
        icon: "tpl.png",
        label: function () {
            return this.name || "tpl-routes-by-line";
        },
        oneditprepare: function () {

            var node = this;
            $("#node-input-agency").empty();
            var domain = (RED.nodes.node($("#node-input-authentication").val()) != null ? RED.nodes.node($("#node-input-authentication").val()).domain: "");

            $.ajax({
                url: (domain ? domain : (RED.settings.ascapiUrl ? RED.settings.ascapiUrl : "https://www.snap4city.org/")) + "/superservicemap/api/v1/tpl/agencies/",
                type: "GET",
                async: false,
                dataType: "json",
                success: function (data) {
                    var agencies = data.Agencies;
                    for (var i = 0; i < agencies.length; i++) {
                        $("<option value=\"" + agencies[i].agency + "\">" + agencies[i].name +
                            "</option>").appendTo($("#node-input-agency"));
                    }
                    $("#node-input-agency").val("");
                },
                error: function (err) {
                    console.log(err);
                }
            });

            $("#node-input-agency").change(function () {
                if ($("#node-input-agency").val() != null) {
                    $("#node-input-line").empty();
                    var domain = (RED.nodes.node($("#node-input-authentication").val()) != null ? RED.nodes.node($("#node-input-authentication").val()).domain: "");

                    $.ajax({
                        url: (domain ? domain : (RED.settings.ascapiUrl ? RED.settings.ascapiUrl : "https://www.snap4city.org/")) + "/superservicemap/api/v1/tpl/bus-lines/?agency=" +
                            $("#node-input-agency").val(),
                        type: "GET",
                        async: false,
                        dataType: "json",
                        success: function (data) {
                            var lines = data.BusLines;
                            for (var i = 0; i < lines.length; i++) {
                                $("<option value=\"" + lines[i].uri + "\">" + lines[i].shortName +
                                    ": " + lines[i].longName + "</option>").appendTo(
                                        $("#node-input-line"));
                            }
                            $("#node-input-line").val("");
                        },
                        error: function (err) {
                            console.log(err);
                        }
                    });
                }
            });
        }
    });
</script>

<script type="text/x-red" data-template-name="tpl-routes-by-line">
    <div class="form-row" id="rowAuthentication">
        <label for="node-input-authentication">Authentication</label>
        <input type="text" id="node-input-authentication">
    </div>
    <div class="form-tips"  id="tipAuthentication" style="margin-bottom: 10px;">
        If you have private data and you want to access them, you must have to insert you account data. You can register for one account 
        <a href="https://www.snap4city.org"
            target="_blank">here</a>.
    </div>
    <div class="form-row">
        <label for="node-input-name">Name</label>
        <input type="text" autocomplete="off" id="node-input-name" placeholder="Name">
    </div>
    <div class="form-row">
        <label for="node-input-agency">Agency</label>
        <select id="node-input-agency">
        </select>
    </div>
    <div class="form-row">
        <label for="node-input-line">Line</label>
        <select id="node-input-line">
        </select>
    </div>
</script>

<script type="text/x-red" data-help-name="tpl-routes-by-line">
    <p>provide a list of the public transport routes available for a given agency, line or passing by a specific stop.</p>

    <h3>Inputs</h3>
    A JSON with these parameters:

    <dl class="message-properties">
        <dt>agency
            <span class="property-type">string</span>
        </dt>
        <dd>URI of the agency whose lines are to be retrieved</dd>
        <dt>line
            <span class="property-type">string</span>
        </dt>
        <dd>URI or shortName of a line (if URI is provided the agency is not needed)</dd>
    </dl>

    <h3>Outputs</h3>
    <dl class="message-properties">
        <dd> It provides an array of JSON objects of the routes available, for each route is provided: • line: line shot name
            • route: the route URI • routeName: optional route name • wktGeometry: the WKT geometry of the route • firstBusStop:
            name of the first bus stop • lastBusStop: name of the last bus stop</dd>
    </dl>

    <h3>Details</h3>
    <p>The node can receive a JSON with the parameters described in the Inputs section and with them generate the output JSON.
        If the values are not present in the input JSON, these are read by those in the configuration. If they are not present
        in either part, an error is generated for the necessary parameters.</p>

</script>