summary refs log tree commit diff
path: root/clients/py/flipdot_gschichtler/__init__.py
blob: cb6b7b108b1edbb3c29b8dd3d3a1670a61e6cdac (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
# -*- coding: utf-8 -*-
import requests

class FlipdotGschichtlerError(Exception):
    """Error from the REST API"""
    def __init__(self, endpoint, status, message):
        # make this a proper exception
        super().__init__(message)

        self.endpoint = endpoint
        self.status = status
        self.message = message

    def __str__(self):
        return "Endpoint {} returned {} with message \"{}\"".format(
            self.endpoint, str(self.status), self.message)

class FlipdotGschichtlerClient():
    def __init__(self, base_url, api_token = None):
        self.base_url = base_url
        self.api_token = api_token

    def __get_error_message(self, r):
        try:
            return r.json()['error']
        except KeyError:
            return 'no message given'
        except ValueError:
            return 'no json response'

    def add(self, text):
        endpoint = '/api/v2/queue/add'
        r = requests.post(self.base_url + endpoint, data = { 'text' : text })

        if r.status_code == 200:
            return r.json()['id']
        else:
            message = self.__get_error_message(r)
            raise FlipdotGschichtlerError(endpoint, r.status_code, message)

    def delete(self, queue_id):
        if self.api_token is None:
            raise FlipdotGschichtlerNoToken

        endpoint = '/api/v2/queue/' + str(queue_id)
        r = requests.delete(self.base_url + endpoint, data = { 'token': self.api_token })

        if r.status_code != 204:
            message = self.__get_error_message(r)
            raise FlipdotGschichtlerError(endpoint, r.status_code, message)

    def queue(self):
        endpoint = '/api/v2/queue'
        r = requests.get(self.base_url + endpoint)

        if r.status_code == 200:
            return r.json()['queue']
        else:
            message = self.__get_error_message(r)
            raise FlipdotGschichtlerClient(endpoint, r.status_code, message)

    def queue_length(self):
        endpoint = '/api/v2/queue'
        r = requests.get(self.base_url + endpoint)

        if r.status_code == 200:
            return r.json()['length']
        else:
            message = self.__get_error_message(r)
            raise FlipdotGschichtlerClient(endpoint, r.status_code, message)

    def announcement(self, with_expiry = False):
        endpoint = '/api/v2/announcement'
        r = requests.get(self.base_url + endpoint)

        if r.status_code == 200:
            j = r.json()
            if with_expiry:
                return { 'text' : j['announcement'], 'expiry' : j['expiry_utc'] }
            else:
                return j['announcement']
        elif r.status_code == 404:
            # no / empty announcement
            assert 'announcement' in r.json()
            return None
        else:
            message = self.__get_error_message(r)
            raise FlipdotGschichtlerError(endpoint, r.status_code, message)

    def set_announcement(self, text, expiry = None):
        if self.api_token == None:
            raise FlipdotGschichtlerNoToken

        request = {
            'text': text,
            'token': self.api_token
        }

        if expiry != None:
            if type(expiry) is int:
                request['expiry_utc'] = expiry
            else:
                raise TypeError('expiry is expected to be an integer')

        endpoint = '/api/v2/announcement'
        r = requests.put(self.base_url + endpoint, data = request)

        if r.status_code != 200:
            message = self.__get_error_message(r)
            raise FlipdotGschichtlerError(endpoint, r.status_code, message)

    def delete_announcement(self):
        if self.api_token == None:
            raise FlipdotGschichtlerNoToken

        endpoint = '/api/v2/announcement'
        r = requests.delete(self.base_url + endpoint, data = { 'token': self.api_token })

        if r.status_code != 204:
            message = self.__get_error_message(r)
            raise FlipdotGschichtlerError(endpoint, r.status_code, message)