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
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
|
# The MIT License (MIT)
#
# Copyright (c) Frederic Guillot
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE.
import json
import base64
import functools
import asyncio
import ssl
from typing import Dict, Optional
from urllib import request as http
DEFAULT_AUTH_HEADER = 'Authorization'
ASYNC_FUNCNAME_MARKER = "_async"
class ClientError(Exception):
pass
class Client:
"""
Kanboard API client
Example:
from kanboard import Client
kb = Client(url="http://localhost/jsonrpc.php",
username="jsonrpc",
password="your_api_token")
project_id = kb.create_project(name="My project")
"""
def __init__(self,
url: str,
username: str,
password: str,
auth_header: str = DEFAULT_AUTH_HEADER,
cafile: Optional[str] = None,
insecure: bool = False,
ignore_hostname_verification: bool = False,
user_agent: str = 'Kanboard Python API Client',
loop: Optional[asyncio.AbstractEventLoop] = None):
"""
Constructor
Args:
url: API url endpoint
username: API username or real username
password: API token or user password
auth_header: API HTTP header
cafile: Path to a custom CA certificate
insecure: Ignore SSL certificate errors and ignore hostname mismatches
ignore_hostname_verification: Ignore SSL certificate hostname verification
user_agent: Use a personalized user agent
loop: An asyncio event loop. Default: asyncio.get_event_loop()
"""
self._url = url
self._username = username
self._password = password
self._auth_header = auth_header
self._cafile = cafile
self._insecure = insecure
self._user_agent = user_agent
self._ignore_hostname_verification = ignore_hostname_verification
if not loop:
try:
self._event_loop = asyncio.get_event_loop()
except RuntimeError:
self._event_loop = asyncio.new_event_loop()
def __getattr__(self, name: str):
if self.is_async_method_name(name):
async def function(*args, **kwargs):
return await self._event_loop.run_in_executor(
None,
functools.partial(
self.execute,
method=self._to_camel_case(self.get_funcname_from_async_name(name)), **kwargs))
return function
else:
def function(*args, **kwargs):
return self.execute(method=self._to_camel_case(name), **kwargs)
return function
@staticmethod
def is_async_method_name(funcname: str) -> bool:
return funcname.endswith(ASYNC_FUNCNAME_MARKER)
@staticmethod
def get_funcname_from_async_name(funcname: str) -> str:
return funcname[:len(funcname) - len(ASYNC_FUNCNAME_MARKER)]
@staticmethod
def _to_camel_case(snake_str: str) -> str:
components = snake_str.split('_')
return components[0] + ''.join(x.title() for x in components[1:])
@staticmethod
def _parse_response(response: bytes):
try:
body = json.loads(response.decode(errors='ignore'))
if 'error' in body:
message = body.get('error').get('message')
raise ClientError(message)
return body.get('result')
except ValueError:
return None
def _do_request(self, headers: Dict[str, str], body: Dict):
try:
request = http.Request(self._url,
headers=headers,
data=json.dumps(body).encode())
ssl_context = ssl.create_default_context(cafile=self._cafile)
if self._insecure:
ssl_context.check_hostname = False
ssl_context.verify_mode = ssl.CERT_NONE
if self._ignore_hostname_verification:
ssl_context.check_hostname = False
response = http.urlopen(request, context=ssl_context).read()
except Exception as e:
raise ClientError(str(e))
return self._parse_response(response)
def execute(self, method: str, **kwargs):
"""
Call remote API procedure
Args:
method: Procedure name
kwargs: Procedure named arguments
Returns:
Procedure result
Raises:
urllib.error.HTTPError: Any HTTP error (Python 3)
"""
payload = {
'id': 1,
'jsonrpc': '2.0',
'method': method,
'params': kwargs
}
credentials = base64.b64encode('{}:{}'.format(self._username, self._password).encode())
auth_header_prefix = 'Basic ' if self._auth_header == DEFAULT_AUTH_HEADER else ''
headers = {
self._auth_header: auth_header_prefix + credentials.decode(),
'Content-Type': 'application/json',
'User-Agent': self._user_agent,
}
return self._do_request(headers, payload)
|
