gage_new_samples()

Complexity

Conditions

5

Size

Total Lines

109

Duplication

Lines	0
Ratio	0 %

Importance

Changes	3
Bugs	0	Features	0

"""
@api.route('/gages/<int:gid>/sample', methods=['POST'])
def gage_new_samples(gid):
    """
    Submit new samples to gage *id*

    Parameters:
        id (int): Primary id key number of a gage

    Samples are formatted in body of request as a JSON Web Signature using the
    ``Gage.key``

    Example sample submitter: ::

        from itsdangerous import JSONWebSignatureSerializer
        import requests

        payload = {'samples':[
            {'type':'level',
             'value':16.7,
             'datetime': str(datetime.datetime.now())
             },
            {'type':'amps',
             'value':367.3,
             'datetime': str(datetime.datetime.now())
             },
            {'type':'voltage',
             'value':14.3,
             'datetime': str(datetime.datetime.now())
             },
            {'type':'discharge',
             'value':480,
             'datetime': str(datetime.datetime.now())
            }
            ],
            'gage':{
            'id':5
            }}

        s = JSONWebSignatureSerializer('<gage.key>')

        def submit(payload):
            data = s.dumps(payload)
            url = "http://riverflo.ws/api/1.0/gages/<gage.id>/sample"
            r = requests.post(url, data=data)
            if r.status_code is 200:
                return True
            else:
                return False

    If the key matches the stored key for the gage id in the url, \
    the server will iterate over the samples and add them to the database \
    creating new sensors for the gage if a new sample type is found. \
    Then the server will return JSON with a status code of 200.

    Example response: ::

        { 'gage': {u'id': 5,
            'location': 'Androscoggin River downstream of I-95 in Auburn ME',
            'name': 'Androscoggin River at Auburn',
            'url': 'http://riverflo.ws/api/1.0/gages/5'},
         'result': 'created',
         'samples': [{'datetime': 'Tue, 04 Nov 2014 20:43:39 GMT',
           'id': 10781,
           'url': 'http://riverflo.ws/api/1.0/samples/10781',
           'value': 16.7},
          {'datetime': 'Tue, 04 Nov 2014 20:43:39 GMT',
           'id': 10782,
           'url': 'http://riverflo.ws/api/1.0/samples/10782',
           'value': 367.3},
          {'datetime': 'Tue, 04 Nov 2014 20:43:39 GMT',
           'id': 10783,
           'url': 'http://riverflo.ws/api/1.0/samples/10783',
           'value': 14.3},
          {'datetime': 'Tue, 04 Nov 2014 20:43:39 GMT',
           'id': 10784,
           'url': 'http://riverflo.ws/api/1.0/samples/10784',
           'value': 480.0}]}

    If the signature does not match, the server will return JSON \
    with a status code of 401 - Unauthorized: ::

        {'error': 'unauthorized', 'message': 'bad signature'}

    """
    gage = Gage.query.get_or_404(gid)
    s = JSONWebSignatureSerializer(gage.key)
    try:
        req_json = s.loads(request.data)
    except BadSignature:  # If the signature doesn't match
        return unauthorized('bad signature')
    except TypeError:  # Return unauthorized if no key defined for gage
        return unauthorized('bad signature')
    else:
        samples = req_json['samples']
        output = []
        print(samples)
        for sample in samples:
            result = gage.new_sample(stype=sample['type'].lower(),
                                     value=sample['value'],
                                     sdatetime=sample['datetime'])
            result_json = result.to_sensor_json()
            print(result_json)
            result_json['sender_id'] = sample['sender_id']
            print(result_json)
            output.append(result_json)
        return jsonify({
            'gage': gage.to_json(),
            'samples': output,
            'result': 'created'
        })