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
184
185
186
187
188
189
190
191
192
|
"""
Base engine that defines common behaviour and settings for all engines.
"""
import json
import warnings
from .. import exceptions
class BaseEngine:
chunk = 100
def __init__(self, **options):
"""
:param string key: (optional). API key used for authentication.
:param string username: (optional). Username used for authentication.
:param string password: (optional). Password used for authentication.
:param dict requests: (optional). Connection options.
:param string impersonate: (optional). Username to impersonate.
:param bool ignore_response (optional). If True no response processing will be done at all.
:param bool return_response (optional). Whether to return response or None.
:param bool return_raw_response (optional). Whether to return raw or json encoded responses.
"""
self.ignore_response = options.pop('ignore_response', False)
self.return_response = options.pop('return_response', True)
self.return_raw_response = options.pop('return_raw_response', False)
self.requests = dict(dict(headers={}, params={}), **options.get('requests', {}))
if self.ignore_response:
self.requests['stream'] = True
if options.get('impersonate') is not None:
self.requests['headers']['X-Redmine-Switch-User'] = options['impersonate']
# We would like to be authenticated by API key by default
if options.get('key') is not None:
self.requests['headers']['X-Redmine-API-Key'] = options['key']
elif options.get('username') is not None and options.get('password') is not None:
self.requests['auth'] = (options['username'], options['password'])
self.session = self.create_session(**self.requests)
@staticmethod
def create_session(**params):
"""
Creates a session object that will be used to make requests to Redmine.
:param dict params: (optional). Session params.
"""
raise NotImplementedError
@staticmethod
def construct_request_kwargs(method, headers, params, data):
"""
Constructs kwargs that will be used in all requests to Redmine.
:param string method: (required). HTTP verb to use for the request.
:param dict headers: (required). HTTP headers to send with the request.
:param dict params: (required). Params to send in the query string.
:param data: (required). Data to send in the body of the request.
:type data: dict, bytes or file-like object
"""
kwargs = {'data': data or {}, 'params': params or {}, 'headers': headers or {}}
if method in ('post', 'put', 'patch') and 'Content-Type' not in kwargs['headers']:
kwargs['data'] = json.dumps(data)
kwargs['headers']['Content-Type'] = 'application/json'
return kwargs
def request(self, method, url, headers=None, params=None, data=None):
"""
Makes a single request to Redmine and returns processed response.
:param string method: (required). HTTP verb to use for the request.
:param string url: (required). URL of the request.
:param dict headers: (optional). HTTP headers to send with the request.
:param dict params: (optional). Params to send in the query string.
:param data: (optional). Data to send in the body of the request.
:type data: dict, bytes or file-like object
"""
kwargs = self.construct_request_kwargs(method, headers, params, data)
return self.process_response(self.session.request(method, url, **kwargs))
def bulk_request(self, method, url, container, **params):
"""
Makes needed preparations before launching the active engine's request process.
:param string method: (required). HTTP verb to use for the request.
:param string url: (required). URL of the request.
:param string container: (required). Key in the response that should be used to access retrieved resources.
:param dict params: (optional). Params that should be used for resource retrieval.
"""
limit = params.get('limit') or 0
offset = params.get('offset') or 0
response = self.request(method, url, params=dict(params, limit=limit or self.chunk, offset=offset))
# Resource supports limit/offset on Redmine level
if all(response.get(param) is not None for param in ('total_count', 'limit', 'offset')):
total_count = response['total_count']
results = response[container]
limit = limit or total_count
if limit > self.chunk:
bulk_params = []
for num in range(limit - self.chunk, 0, -self.chunk):
offset += self.chunk
limit -= self.chunk
bulk_params.append(dict(params, offset=offset, limit=limit))
# If we need to make just one more request, there's no point in async
if len(bulk_params) == 1:
results.extend(self.request(method, url, params=bulk_params[0])[container])
else:
results.extend(self.process_bulk_request(method, url, container, bulk_params))
# We have to mimic limit/offset if a resource
# doesn't support this feature on Redmine level
else:
total_count = len(response[container])
results = response[container][offset:None if limit == 0 else limit + offset]
return results, total_count
def process_bulk_request(self, method, url, container, bulk_params):
"""
Makes several requests in blocking or non-blocking fashion depending on the engine.
:param string method: (required). HTTP verb to use for the request.
:param string url: (required). URL of the request.
:param string container: (required). Key in the response that should be used to access retrieved resources.
:param list bulk_params: (required). Params that should be used for resource retrieval.
"""
raise NotImplementedError
def process_response(self, response):
"""
Processes response received from Redmine.
:param obj response: (required). Response object with response details.
"""
if self.ignore_response:
return None
if response.history:
r = response.history[0]
if 300 <= r.status_code <= 399:
url1, url2 = str(r.request.url), str(response.request.url)
if (url1[:5] == 'http:' and url2[:6] == 'https:') or (url1[:6] == 'https:' and url2[:5] == 'http:'):
raise exceptions.HTTPProtocolError
else:
warnings.warn('Redirect detected during request-response, normally there should be no redirects, '
'so please check your Redmine URL for things like prepending www which redirects to '
'a no www domain and vice versa or using an old domain which redirects to a new one',
exceptions.PerformanceWarning)
status_code = response.status_code
if status_code in (200, 201, 204):
if not self.return_response:
return None
elif self.return_raw_response:
return response
elif not response.content.strip():
return True
else:
try:
return response.json()
except (ValueError, TypeError):
raise exceptions.JSONDecodeError(response)
elif status_code == 401:
raise exceptions.AuthError
elif status_code == 403:
raise exceptions.ForbiddenError
elif status_code == 404:
raise exceptions.ResourceNotFoundError
elif status_code == 409:
raise exceptions.ConflictError
elif status_code == 412:
raise exceptions.ImpersonateError
elif status_code == 413:
raise exceptions.RequestEntityTooLargeError
elif status_code == 422:
errors = response.json()['errors']
raise exceptions.ValidationError(', '.join(': '.join(e) if isinstance(e, list) else e for e in errors))
elif status_code == 500:
raise exceptions.ServerError
raise exceptions.UnknownError(status_code)
|
