root / astakosclient / astakosclient / __init__.py @ 26498848
History | View | Annotate | Download (23.2 kB)
1 | 99165736 | Christos Stavrakakis | # Copyright (C) 2012, 2013 GRNET S.A. All rights reserved.
|
---|---|---|---|
2 | 99165736 | Christos Stavrakakis | #
|
3 | 99165736 | Christos Stavrakakis | # Redistribution and use in source and binary forms, with or
|
4 | 99165736 | Christos Stavrakakis | # without modification, are permitted provided that the following
|
5 | 99165736 | Christos Stavrakakis | # conditions are met:
|
6 | 99165736 | Christos Stavrakakis | #
|
7 | 99165736 | Christos Stavrakakis | # 1. Redistributions of source code must retain the above
|
8 | 99165736 | Christos Stavrakakis | # copyright notice, this list of conditions and the following
|
9 | 99165736 | Christos Stavrakakis | # disclaimer.
|
10 | 99165736 | Christos Stavrakakis | #
|
11 | 99165736 | Christos Stavrakakis | # 2. Redistributions in binary form must reproduce the above
|
12 | 99165736 | Christos Stavrakakis | # copyright notice, this list of conditions and the following
|
13 | 99165736 | Christos Stavrakakis | # disclaimer in the documentation and/or other materials
|
14 | 99165736 | Christos Stavrakakis | # provided with the distribution.
|
15 | 99165736 | Christos Stavrakakis | #
|
16 | 99165736 | Christos Stavrakakis | # THIS SOFTWARE IS PROVIDED BY GRNET S.A. ``AS IS'' AND ANY EXPRESS
|
17 | 99165736 | Christos Stavrakakis | # OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
|
18 | 99165736 | Christos Stavrakakis | # WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
19 | 99165736 | Christos Stavrakakis | # PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GRNET S.A OR
|
20 | 99165736 | Christos Stavrakakis | # CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
21 | 99165736 | Christos Stavrakakis | # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
22 | 99165736 | Christos Stavrakakis | # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
|
23 | 99165736 | Christos Stavrakakis | # USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
|
24 | 99165736 | Christos Stavrakakis | # AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
25 | 99165736 | Christos Stavrakakis | # LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
|
26 | 99165736 | Christos Stavrakakis | # ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
27 | 99165736 | Christos Stavrakakis | # POSSIBILITY OF SUCH DAMAGE.
|
28 | 99165736 | Christos Stavrakakis | #
|
29 | 99165736 | Christos Stavrakakis | # The views and conclusions contained in the software and
|
30 | 99165736 | Christos Stavrakakis | # documentation are those of the authors and should not be
|
31 | 99165736 | Christos Stavrakakis | # interpreted as representing official policies, either expressed
|
32 | 99165736 | Christos Stavrakakis | # or implied, of GRNET S.A.
|
33 | cbc0b438 | Ilias Tsitsimpis | |
34 | cbc0b438 | Ilias Tsitsimpis | import logging |
35 | cbc0b438 | Ilias Tsitsimpis | import urlparse |
36 | bc5032a4 | Ilias Tsitsimpis | import urllib |
37 | 6f64b6d0 | Ilias Tsitsimpis | import hashlib |
38 | 8f2d7ede | Ilias Tsitsimpis | from copy import copy |
39 | cbc0b438 | Ilias Tsitsimpis | |
40 | cbc0b438 | Ilias Tsitsimpis | import simplejson |
41 | 10797183 | Ilias Tsitsimpis | from astakosclient.utils import \ |
42 | 10797183 | Ilias Tsitsimpis | retry, scheme_to_class, parse_request, check_input |
43 | f93cc364 | Ilias Tsitsimpis | from astakosclient.errors import \ |
44 | 2377e7c2 | Ilias Tsitsimpis | AstakosClientException, Unauthorized, BadRequest, NotFound, Forbidden, \ |
45 | 0a2a342c | Ilias Tsitsimpis | NoUserName, NoUUID, BadValue, QuotaLimit, InvalidResponse |
46 | 00d2a0ee | Georgios D. Tsoukalas | from .keypath import get_path |
47 | 00d2a0ee | Georgios D. Tsoukalas | from .services import astakos_services |
48 | 00d2a0ee | Georgios D. Tsoukalas | |
49 | 00d2a0ee | Georgios D. Tsoukalas | |
50 | 00d2a0ee | Georgios D. Tsoukalas | # Customize astakos_services here?
|
51 | 8fe6475a | Ilias Tsitsimpis | |
52 | 8fe6475a | Ilias Tsitsimpis | |
53 | e3ff6830 | Georgios D. Tsoukalas | def join_urls(a, b): |
54 | e3ff6830 | Georgios D. Tsoukalas | """join_urls from synnefo.lib"""
|
55 | e3ff6830 | Georgios D. Tsoukalas | return a.rstrip("/") + "/" + b.lstrip("/") |
56 | e3ff6830 | Georgios D. Tsoukalas | |
57 | cbc0b438 | Ilias Tsitsimpis | # --------------------------------------------------------------------
|
58 | 7b5a37fd | Ilias Tsitsimpis | # Astakos API urls
|
59 | 00d2a0ee | Georgios D. Tsoukalas | ACCOUNTS_PREFIX = get_path(astakos_services, 'astakos_account.prefix')
|
60 | 389642a0 | Kostas Papadimitriou | ACCOUNTS_PREFIX = join_urls(ACCOUNTS_PREFIX, 'v1.0')
|
61 | e3ff6830 | Georgios D. Tsoukalas | API_AUTHENTICATE = join_urls(ACCOUNTS_PREFIX, "authenticate")
|
62 | e3ff6830 | Georgios D. Tsoukalas | API_USERCATALOGS = join_urls(ACCOUNTS_PREFIX, "user_catalogs")
|
63 | e3ff6830 | Georgios D. Tsoukalas | API_SERVICE_USERCATALOGS = join_urls(ACCOUNTS_PREFIX, "service/user_catalogs")
|
64 | e3ff6830 | Georgios D. Tsoukalas | API_GETSERVICES = join_urls(ACCOUNTS_PREFIX, "get_services")
|
65 | e3ff6830 | Georgios D. Tsoukalas | API_RESOURCES = join_urls(ACCOUNTS_PREFIX, "resources")
|
66 | e3ff6830 | Georgios D. Tsoukalas | API_QUOTAS = join_urls(ACCOUNTS_PREFIX, "quotas")
|
67 | e3ff6830 | Georgios D. Tsoukalas | API_SERVICE_QUOTAS = join_urls(ACCOUNTS_PREFIX, "service_quotas")
|
68 | e3ff6830 | Georgios D. Tsoukalas | API_COMMISSIONS = join_urls(ACCOUNTS_PREFIX, "commissions")
|
69 | e3ff6830 | Georgios D. Tsoukalas | API_COMMISSIONS_ACTION = join_urls(API_COMMISSIONS, "action")
|
70 | e3ff6830 | Georgios D. Tsoukalas | API_FEEDBACK = join_urls(ACCOUNTS_PREFIX, "feedback")
|
71 | e3ff6830 | Georgios D. Tsoukalas | |
72 | e3ff6830 | Georgios D. Tsoukalas | # --------------------------------------------------------------------
|
73 | e3ff6830 | Georgios D. Tsoukalas | # Astakos Keystone API urls
|
74 | 923e6582 | Georgios D. Tsoukalas | IDENTITY_PREFIX = get_path(astakos_services, 'astakos_identity.prefix')
|
75 | 923e6582 | Georgios D. Tsoukalas | API_TOKENS = join_urls(IDENTITY_PREFIX, "tokens")
|
76 | e3ff6830 | Georgios D. Tsoukalas | TOKENS_ENDPOINTS = join_urls(API_TOKENS, "endpoints")
|
77 | 7b5a37fd | Ilias Tsitsimpis | |
78 | 7b5a37fd | Ilias Tsitsimpis | |
79 | 7b5a37fd | Ilias Tsitsimpis | # --------------------------------------------------------------------
|
80 | 4490d7b5 | Ilias Tsitsimpis | # Astakos Client Class
|
81 | bc5032a4 | Ilias Tsitsimpis | |
82 | 794c94e6 | Ilias Tsitsimpis | def get_token_from_cookie(request, cookie_name): |
83 | bc5032a4 | Ilias Tsitsimpis | """Extract token from the cookie name provided
|
84 | bc5032a4 | Ilias Tsitsimpis |
|
85 | bc5032a4 | Ilias Tsitsimpis | Cookie should be in the same form as astakos
|
86 | bc5032a4 | Ilias Tsitsimpis | service sets its cookie contents:
|
87 | bc5032a4 | Ilias Tsitsimpis | <user_uniq>|<user_token>
|
88 | bc5032a4 | Ilias Tsitsimpis |
|
89 | bc5032a4 | Ilias Tsitsimpis | """
|
90 | bc5032a4 | Ilias Tsitsimpis | try:
|
91 | bc5032a4 | Ilias Tsitsimpis | cookie_content = urllib.unquote(request.COOKIE.get(cookie_name, None))
|
92 | bc5032a4 | Ilias Tsitsimpis | return cookie_content.split("|")[1] |
93 | bc5032a4 | Ilias Tsitsimpis | except:
|
94 | bc5032a4 | Ilias Tsitsimpis | return None |
95 | bc5032a4 | Ilias Tsitsimpis | |
96 | bc5032a4 | Ilias Tsitsimpis | |
97 | 4490d7b5 | Ilias Tsitsimpis | class AstakosClient(): |
98 | 4490d7b5 | Ilias Tsitsimpis | """AstakosClient Class Implementation"""
|
99 | 4490d7b5 | Ilias Tsitsimpis | |
100 | 4490d7b5 | Ilias Tsitsimpis | # ----------------------------------
|
101 | 996061fa | Ilias Tsitsimpis | def __init__(self, astakos_url, retry=0, |
102 | 996061fa | Ilias Tsitsimpis | use_pool=False, pool_size=8, logger=None): |
103 | c4644612 | Ilias Tsitsimpis | """Initialize AstakosClient Class
|
104 | 4490d7b5 | Ilias Tsitsimpis |
|
105 | 4490d7b5 | Ilias Tsitsimpis | Keyword arguments:
|
106 | 4490d7b5 | Ilias Tsitsimpis | astakos_url -- i.e https://accounts.example.com (string)
|
107 | 4490d7b5 | Ilias Tsitsimpis | use_pool -- use objpool for http requests (boolean)
|
108 | 949baf4d | Ilias Tsitsimpis | retry -- how many time to retry (integer)
|
109 | 4490d7b5 | Ilias Tsitsimpis | logger -- pass a different logger
|
110 | 4490d7b5 | Ilias Tsitsimpis |
|
111 | 4490d7b5 | Ilias Tsitsimpis | """
|
112 | 4490d7b5 | Ilias Tsitsimpis | if logger is None: |
113 | 7eb32034 | Ilias Tsitsimpis | logging.basicConfig( |
114 | 7eb32034 | Ilias Tsitsimpis | format='%(asctime)s [%(levelname)s] %(name)s %(message)s',
|
115 | 7eb32034 | Ilias Tsitsimpis | datefmt='%Y-%m-%d %H:%M:%S',
|
116 | 7eb32034 | Ilias Tsitsimpis | level=logging.INFO) |
117 | 4490d7b5 | Ilias Tsitsimpis | logger = logging.getLogger("astakosclient")
|
118 | 8f2d7ede | Ilias Tsitsimpis | logger.debug("Intialize AstakosClient: astakos_url = %s, "
|
119 | 4490d7b5 | Ilias Tsitsimpis | "use_pool = %s" % (astakos_url, use_pool))
|
120 | 4490d7b5 | Ilias Tsitsimpis | |
121 | 10797183 | Ilias Tsitsimpis | check_input("__init__", logger, astakos_url=astakos_url)
|
122 | 4490d7b5 | Ilias Tsitsimpis | |
123 | 4490d7b5 | Ilias Tsitsimpis | # Check for supported scheme
|
124 | 4490d7b5 | Ilias Tsitsimpis | p = urlparse.urlparse(astakos_url) |
125 | f93cc364 | Ilias Tsitsimpis | conn_class = scheme_to_class(p.scheme, use_pool, pool_size) |
126 | e169a337 | Ilias Tsitsimpis | if conn_class is None: |
127 | 4490d7b5 | Ilias Tsitsimpis | m = "Unsupported scheme: %s" % p.scheme
|
128 | 4490d7b5 | Ilias Tsitsimpis | logger.error(m) |
129 | 83f9157b | Ilias Tsitsimpis | raise BadValue(m)
|
130 | 4490d7b5 | Ilias Tsitsimpis | |
131 | 98752f06 | Ilias Tsitsimpis | # Save astakos_url etc. in our class
|
132 | 949baf4d | Ilias Tsitsimpis | self.retry = retry
|
133 | 4490d7b5 | Ilias Tsitsimpis | self.logger = logger
|
134 | 4490d7b5 | Ilias Tsitsimpis | self.netloc = p.netloc
|
135 | 4490d7b5 | Ilias Tsitsimpis | self.scheme = p.scheme
|
136 | c7027e2e | Kostas Papadimitriou | self.path = p.path.rstrip('/') |
137 | e169a337 | Ilias Tsitsimpis | self.conn_class = conn_class
|
138 | 4490d7b5 | Ilias Tsitsimpis | |
139 | 4490d7b5 | Ilias Tsitsimpis | # ----------------------------------
|
140 | 949baf4d | Ilias Tsitsimpis | @retry
|
141 | 25a04cdd | Ilias Tsitsimpis | def _call_astakos(self, token, request_path, headers=None, |
142 | 25a04cdd | Ilias Tsitsimpis | body=None, method="GET", log_body=True): |
143 | 4490d7b5 | Ilias Tsitsimpis | """Make the actual call to Astakos Service"""
|
144 | c4644612 | Ilias Tsitsimpis | if token is not None: |
145 | c4644612 | Ilias Tsitsimpis | hashed_token = hashlib.sha1() |
146 | c4644612 | Ilias Tsitsimpis | hashed_token.update(token) |
147 | c4644612 | Ilias Tsitsimpis | using_token = "using token %s" % (hashed_token.hexdigest())
|
148 | c4644612 | Ilias Tsitsimpis | else:
|
149 | c4644612 | Ilias Tsitsimpis | using_token = "without using token"
|
150 | 4490d7b5 | Ilias Tsitsimpis | self.logger.debug(
|
151 | c4644612 | Ilias Tsitsimpis | "Make a %s request to %s %s with headers %s and body %s"
|
152 | 25a04cdd | Ilias Tsitsimpis | % (method, request_path, using_token, headers, |
153 | 25a04cdd | Ilias Tsitsimpis | body if log_body else "(not logged)")) |
154 | 4490d7b5 | Ilias Tsitsimpis | |
155 | 98752f06 | Ilias Tsitsimpis | # Check Input
|
156 | 8f2d7ede | Ilias Tsitsimpis | if headers is None: |
157 | 8f2d7ede | Ilias Tsitsimpis | headers = {} |
158 | 8f2d7ede | Ilias Tsitsimpis | if body is None: |
159 | 8f2d7ede | Ilias Tsitsimpis | body = {} |
160 | 9848f747 | Ilias Tsitsimpis | path = self.path + "/" + request_path.strip('/') |
161 | 98752f06 | Ilias Tsitsimpis | |
162 | 4490d7b5 | Ilias Tsitsimpis | # Build request's header and body
|
163 | 4490d7b5 | Ilias Tsitsimpis | kwargs = {} |
164 | 8f2d7ede | Ilias Tsitsimpis | kwargs['headers'] = copy(headers)
|
165 | c4644612 | Ilias Tsitsimpis | if token is not None: |
166 | c4644612 | Ilias Tsitsimpis | kwargs['headers']['X-Auth-Token'] = token |
167 | 4490d7b5 | Ilias Tsitsimpis | if body:
|
168 | 8f2d7ede | Ilias Tsitsimpis | kwargs['body'] = copy(body)
|
169 | 4490d7b5 | Ilias Tsitsimpis | kwargs['headers'].setdefault(
|
170 | 4490d7b5 | Ilias Tsitsimpis | 'content-type', 'application/octet-stream') |
171 | 4490d7b5 | Ilias Tsitsimpis | kwargs['headers'].setdefault('content-length', |
172 | 4490d7b5 | Ilias Tsitsimpis | len(body) if body else 0) |
173 | 4490d7b5 | Ilias Tsitsimpis | |
174 | 4490d7b5 | Ilias Tsitsimpis | try:
|
175 | 6837f014 | Ilias Tsitsimpis | # Get the connection object
|
176 | 6837f014 | Ilias Tsitsimpis | with self.conn_class(self.netloc) as conn: |
177 | 6837f014 | Ilias Tsitsimpis | # Send request
|
178 | 21190887 | Ilias Tsitsimpis | (message, data, status) = \ |
179 | 9848f747 | Ilias Tsitsimpis | _do_request(conn, method, path, **kwargs) |
180 | 4490d7b5 | Ilias Tsitsimpis | except Exception as err: |
181 | 996061fa | Ilias Tsitsimpis | self.logger.error("Failed to send request: %s" % repr(err)) |
182 | 4490d7b5 | Ilias Tsitsimpis | raise AstakosClientException(str(err)) |
183 | 4490d7b5 | Ilias Tsitsimpis | |
184 | 4490d7b5 | Ilias Tsitsimpis | # Return
|
185 | 4490d7b5 | Ilias Tsitsimpis | self.logger.debug("Request returned with status %s" % status) |
186 | 8fe6475a | Ilias Tsitsimpis | if status == 400: |
187 | 21190887 | Ilias Tsitsimpis | raise BadRequest(message, data)
|
188 | be284f6a | Christos Stavrakakis | elif status == 401: |
189 | 21190887 | Ilias Tsitsimpis | raise Unauthorized(message, data)
|
190 | be284f6a | Christos Stavrakakis | elif status == 403: |
191 | 21190887 | Ilias Tsitsimpis | raise Forbidden(message, data)
|
192 | be284f6a | Christos Stavrakakis | elif status == 404: |
193 | 21190887 | Ilias Tsitsimpis | raise NotFound(message, data)
|
194 | be284f6a | Christos Stavrakakis | elif status < 200 or status >= 300: |
195 | 21190887 | Ilias Tsitsimpis | raise AstakosClientException(message, data, status)
|
196 | 0a2a342c | Ilias Tsitsimpis | |
197 | 0a2a342c | Ilias Tsitsimpis | try:
|
198 | 0a2a342c | Ilias Tsitsimpis | if data:
|
199 | 0a2a342c | Ilias Tsitsimpis | return simplejson.loads(unicode(data)) |
200 | 0a2a342c | Ilias Tsitsimpis | else:
|
201 | 10797183 | Ilias Tsitsimpis | return None |
202 | 0a2a342c | Ilias Tsitsimpis | except Exception as err: |
203 | 19198628 | Ilias Tsitsimpis | self.logger.error("Cannot parse response \"%s\" with simplejson: %s" |
204 | 19198628 | Ilias Tsitsimpis | % (data, str(err)))
|
205 | 0a2a342c | Ilias Tsitsimpis | raise InvalidResponse(str(err), data) |
206 | 4490d7b5 | Ilias Tsitsimpis | |
207 | 4490d7b5 | Ilias Tsitsimpis | # ------------------------
|
208 | 7b5a37fd | Ilias Tsitsimpis | # do a GET to ``API_AUTHENTICATE``
|
209 | 794c94e6 | Ilias Tsitsimpis | def get_user_info(self, token, usage=False): |
210 | f74d2b69 | Ilias Tsitsimpis | """Authenticate user and get user's info as a dictionary
|
211 | 4490d7b5 | Ilias Tsitsimpis |
|
212 | 4490d7b5 | Ilias Tsitsimpis | Keyword arguments:
|
213 | 98752f06 | Ilias Tsitsimpis | token -- user's token (string)
|
214 | 4490d7b5 | Ilias Tsitsimpis | usage -- return usage information for user (boolean)
|
215 | 4490d7b5 | Ilias Tsitsimpis |
|
216 | 4490d7b5 | Ilias Tsitsimpis | In case of success return user information (json parsed format).
|
217 | 4490d7b5 | Ilias Tsitsimpis | Otherwise raise an AstakosClientException.
|
218 | 4490d7b5 | Ilias Tsitsimpis |
|
219 | 4490d7b5 | Ilias Tsitsimpis | """
|
220 | 98752f06 | Ilias Tsitsimpis | # Send request
|
221 | 7b5a37fd | Ilias Tsitsimpis | auth_path = copy(API_AUTHENTICATE) |
222 | 4490d7b5 | Ilias Tsitsimpis | if usage:
|
223 | 4490d7b5 | Ilias Tsitsimpis | auth_path += "?usage=1"
|
224 | 794c94e6 | Ilias Tsitsimpis | return self._call_astakos(token, auth_path) |
225 | 4490d7b5 | Ilias Tsitsimpis | |
226 | 4490d7b5 | Ilias Tsitsimpis | # ----------------------------------
|
227 | 7b5a37fd | Ilias Tsitsimpis | # do a POST to ``API_USERCATALOGS`` (or ``API_SERVICE_USERCATALOGS``)
|
228 | c4644612 | Ilias Tsitsimpis | # with {'uuids': uuids}
|
229 | 794c94e6 | Ilias Tsitsimpis | def _uuid_catalog(self, token, uuids, req_path): |
230 | 1c26b500 | Ilias Tsitsimpis | req_headers = {'content-type': 'application/json'} |
231 | 19198628 | Ilias Tsitsimpis | req_body = parse_request({'uuids': uuids}, self.logger) |
232 | 794c94e6 | Ilias Tsitsimpis | data = self._call_astakos(
|
233 | 1c26b500 | Ilias Tsitsimpis | token, req_path, req_headers, req_body, "POST")
|
234 | 2377e7c2 | Ilias Tsitsimpis | if "uuid_catalog" in data: |
235 | 2377e7c2 | Ilias Tsitsimpis | return data.get("uuid_catalog") |
236 | 2377e7c2 | Ilias Tsitsimpis | else:
|
237 | 794c94e6 | Ilias Tsitsimpis | m = "_uuid_catalog request returned %s. No uuid_catalog found" \
|
238 | 2377e7c2 | Ilias Tsitsimpis | % data |
239 | 2377e7c2 | Ilias Tsitsimpis | self.logger.error(m)
|
240 | 2377e7c2 | Ilias Tsitsimpis | raise AstakosClientException(m)
|
241 | 1c26b500 | Ilias Tsitsimpis | |
242 | 794c94e6 | Ilias Tsitsimpis | def get_usernames(self, token, uuids): |
243 | 4490d7b5 | Ilias Tsitsimpis | """Return a uuid_catalog dictionary for the given uuids
|
244 | 4490d7b5 | Ilias Tsitsimpis |
|
245 | 4490d7b5 | Ilias Tsitsimpis | Keyword arguments:
|
246 | 98752f06 | Ilias Tsitsimpis | token -- user's token (string)
|
247 | 4490d7b5 | Ilias Tsitsimpis | uuids -- list of user ids (list of strings)
|
248 | 4490d7b5 | Ilias Tsitsimpis |
|
249 | 4490d7b5 | Ilias Tsitsimpis | The returned uuid_catalog is a dictionary with uuids as
|
250 | 4490d7b5 | Ilias Tsitsimpis | keys and the corresponding user names as values
|
251 | 4490d7b5 | Ilias Tsitsimpis |
|
252 | 4490d7b5 | Ilias Tsitsimpis | """
|
253 | 7b5a37fd | Ilias Tsitsimpis | req_path = copy(API_USERCATALOGS) |
254 | 794c94e6 | Ilias Tsitsimpis | return self._uuid_catalog(token, uuids, req_path) |
255 | 4490d7b5 | Ilias Tsitsimpis | |
256 | 794c94e6 | Ilias Tsitsimpis | def get_username(self, token, uuid): |
257 | 794c94e6 | Ilias Tsitsimpis | """Return the user name of a uuid (see get_usernames)"""
|
258 | 10797183 | Ilias Tsitsimpis | check_input("get_username", self.logger, uuid=uuid) |
259 | 794c94e6 | Ilias Tsitsimpis | uuid_dict = self.get_usernames(token, [uuid])
|
260 | 2377e7c2 | Ilias Tsitsimpis | if uuid in uuid_dict: |
261 | 2377e7c2 | Ilias Tsitsimpis | return uuid_dict.get(uuid)
|
262 | 2377e7c2 | Ilias Tsitsimpis | else:
|
263 | 794c94e6 | Ilias Tsitsimpis | raise NoUserName(uuid)
|
264 | 4490d7b5 | Ilias Tsitsimpis | |
265 | 794c94e6 | Ilias Tsitsimpis | def service_get_usernames(self, token, uuids): |
266 | 1c26b500 | Ilias Tsitsimpis | """Return a uuid_catalog dict using a service's token"""
|
267 | 7b5a37fd | Ilias Tsitsimpis | req_path = copy(API_SERVICE_USERCATALOGS) |
268 | 794c94e6 | Ilias Tsitsimpis | return self._uuid_catalog(token, uuids, req_path) |
269 | 1c26b500 | Ilias Tsitsimpis | |
270 | 794c94e6 | Ilias Tsitsimpis | def service_get_username(self, token, uuid): |
271 | 1c26b500 | Ilias Tsitsimpis | """Return the displayName of a uuid using a service's token"""
|
272 | 10797183 | Ilias Tsitsimpis | check_input("service_get_username", self.logger, uuid=uuid) |
273 | 794c94e6 | Ilias Tsitsimpis | uuid_dict = self.service_get_usernames(token, [uuid])
|
274 | 2377e7c2 | Ilias Tsitsimpis | if uuid in uuid_dict: |
275 | 2377e7c2 | Ilias Tsitsimpis | return uuid_dict.get(uuid)
|
276 | 2377e7c2 | Ilias Tsitsimpis | else:
|
277 | 794c94e6 | Ilias Tsitsimpis | raise NoUserName(uuid)
|
278 | 1c26b500 | Ilias Tsitsimpis | |
279 | aaf0a42c | Ilias Tsitsimpis | # ----------------------------------
|
280 | 7b5a37fd | Ilias Tsitsimpis | # do a POST to ``API_USERCATALOGS`` (or ``API_SERVICE_USERCATALOGS``)
|
281 | c4644612 | Ilias Tsitsimpis | # with {'displaynames': display_names}
|
282 | 794c94e6 | Ilias Tsitsimpis | def _displayname_catalog(self, token, display_names, req_path): |
283 | 1c26b500 | Ilias Tsitsimpis | req_headers = {'content-type': 'application/json'} |
284 | 19198628 | Ilias Tsitsimpis | req_body = parse_request({'displaynames': display_names}, self.logger) |
285 | 794c94e6 | Ilias Tsitsimpis | data = self._call_astakos(
|
286 | 1c26b500 | Ilias Tsitsimpis | token, req_path, req_headers, req_body, "POST")
|
287 | 2377e7c2 | Ilias Tsitsimpis | if "displayname_catalog" in data: |
288 | 2377e7c2 | Ilias Tsitsimpis | return data.get("displayname_catalog") |
289 | 2377e7c2 | Ilias Tsitsimpis | else:
|
290 | 794c94e6 | Ilias Tsitsimpis | m = "_displayname_catalog request returned %s. " \
|
291 | 2377e7c2 | Ilias Tsitsimpis | "No displayname_catalog found" % data
|
292 | 2377e7c2 | Ilias Tsitsimpis | self.logger.error(m)
|
293 | 2377e7c2 | Ilias Tsitsimpis | raise AstakosClientException(m)
|
294 | 1c26b500 | Ilias Tsitsimpis | |
295 | 794c94e6 | Ilias Tsitsimpis | def get_uuids(self, token, display_names): |
296 | aaf0a42c | Ilias Tsitsimpis | """Return a displayname_catalog for the given names
|
297 | aaf0a42c | Ilias Tsitsimpis |
|
298 | aaf0a42c | Ilias Tsitsimpis | Keyword arguments:
|
299 | aaf0a42c | Ilias Tsitsimpis | token -- user's token (string)
|
300 | aaf0a42c | Ilias Tsitsimpis | display_names -- list of user names (list of strings)
|
301 | aaf0a42c | Ilias Tsitsimpis |
|
302 | aaf0a42c | Ilias Tsitsimpis | The returned displayname_catalog is a dictionary with
|
303 | aaf0a42c | Ilias Tsitsimpis | the names as keys and the corresponding uuids as values
|
304 | aaf0a42c | Ilias Tsitsimpis |
|
305 | aaf0a42c | Ilias Tsitsimpis | """
|
306 | 7b5a37fd | Ilias Tsitsimpis | req_path = copy(API_USERCATALOGS) |
307 | 794c94e6 | Ilias Tsitsimpis | return self._displayname_catalog(token, display_names, req_path) |
308 | aaf0a42c | Ilias Tsitsimpis | |
309 | 794c94e6 | Ilias Tsitsimpis | def get_uuid(self, token, display_name): |
310 | aaf0a42c | Ilias Tsitsimpis | """Return the uuid of a name (see getUUIDs)"""
|
311 | 10797183 | Ilias Tsitsimpis | check_input("get_uuid", self.logger, display_name=display_name) |
312 | 794c94e6 | Ilias Tsitsimpis | name_dict = self.get_uuids(token, [display_name])
|
313 | 2377e7c2 | Ilias Tsitsimpis | if display_name in name_dict: |
314 | 2377e7c2 | Ilias Tsitsimpis | return name_dict.get(display_name)
|
315 | 2377e7c2 | Ilias Tsitsimpis | else:
|
316 | 2377e7c2 | Ilias Tsitsimpis | raise NoUUID(display_name)
|
317 | aaf0a42c | Ilias Tsitsimpis | |
318 | 794c94e6 | Ilias Tsitsimpis | def service_get_uuids(self, token, display_names): |
319 | 1c26b500 | Ilias Tsitsimpis | """Return a display_name catalog using a service's token"""
|
320 | 7b5a37fd | Ilias Tsitsimpis | req_path = copy(API_SERVICE_USERCATALOGS) |
321 | 794c94e6 | Ilias Tsitsimpis | return self._displayname_catalog(token, display_names, req_path) |
322 | 1c26b500 | Ilias Tsitsimpis | |
323 | 794c94e6 | Ilias Tsitsimpis | def service_get_uuid(self, token, display_name): |
324 | 1c26b500 | Ilias Tsitsimpis | """Return the uuid of a name using a service's token"""
|
325 | 10797183 | Ilias Tsitsimpis | check_input("service_get_uuid", self.logger, display_name=display_name) |
326 | 794c94e6 | Ilias Tsitsimpis | name_dict = self.service_get_uuids(token, [display_name])
|
327 | 2377e7c2 | Ilias Tsitsimpis | if display_name in name_dict: |
328 | 2377e7c2 | Ilias Tsitsimpis | return name_dict.get(display_name)
|
329 | 2377e7c2 | Ilias Tsitsimpis | else:
|
330 | 2377e7c2 | Ilias Tsitsimpis | raise NoUUID(display_name)
|
331 | 1c26b500 | Ilias Tsitsimpis | |
332 | 3f8d6b11 | Ilias Tsitsimpis | # ----------------------------------
|
333 | 7b5a37fd | Ilias Tsitsimpis | # do a GET to ``API_GETSERVICES``
|
334 | 794c94e6 | Ilias Tsitsimpis | def get_services(self): |
335 | 3f8d6b11 | Ilias Tsitsimpis | """Return a list of dicts with the registered services"""
|
336 | 7b5a37fd | Ilias Tsitsimpis | return self._call_astakos(None, copy(API_GETSERVICES)) |
337 | c4644612 | Ilias Tsitsimpis | |
338 | c4644612 | Ilias Tsitsimpis | # ----------------------------------
|
339 | 7b5a37fd | Ilias Tsitsimpis | # do a GET to ``API_RESOURCES``
|
340 | c4644612 | Ilias Tsitsimpis | def get_resources(self): |
341 | c4644612 | Ilias Tsitsimpis | """Return a dict of dicts with the available resources"""
|
342 | 7b5a37fd | Ilias Tsitsimpis | return self._call_astakos(None, copy(API_RESOURCES)) |
343 | 3f8d6b11 | Ilias Tsitsimpis | |
344 | baeb2ba5 | Ilias Tsitsimpis | # ----------------------------------
|
345 | 92683993 | Ilias Tsitsimpis | # do a POST to ``API_FEEDBACK``
|
346 | 92683993 | Ilias Tsitsimpis | def send_feedback(self, token, message, data): |
347 | 92683993 | Ilias Tsitsimpis | """Send feedback to astakos service
|
348 | 92683993 | Ilias Tsitsimpis |
|
349 | 92683993 | Ilias Tsitsimpis | keyword arguments:
|
350 | 92683993 | Ilias Tsitsimpis | token -- user's token (string)
|
351 | 92683993 | Ilias Tsitsimpis | message -- Feedback message
|
352 | 92683993 | Ilias Tsitsimpis | data -- Additional information about service client status
|
353 | 92683993 | Ilias Tsitsimpis |
|
354 | 92683993 | Ilias Tsitsimpis | In case of success return nothing.
|
355 | 92683993 | Ilias Tsitsimpis | Otherwise raise an AstakosClientException
|
356 | 92683993 | Ilias Tsitsimpis |
|
357 | 92683993 | Ilias Tsitsimpis | """
|
358 | 92683993 | Ilias Tsitsimpis | check_input("send_feedback", self.logger, message=message, data=data) |
359 | 92683993 | Ilias Tsitsimpis | path = copy(API_FEEDBACK) |
360 | 92683993 | Ilias Tsitsimpis | req_body = urllib.urlencode( |
361 | 92683993 | Ilias Tsitsimpis | {'feedback_msg': message, 'feedback_data': data}) |
362 | 108be31f | Ilias Tsitsimpis | self._call_astakos(token, path, None, req_body, "POST") |
363 | 108be31f | Ilias Tsitsimpis | |
364 | 108be31f | Ilias Tsitsimpis | # ----------------------------------
|
365 | 108be31f | Ilias Tsitsimpis | # do a GET to ``API_TOKENS``/<user_token>/``TOKENS_ENDPOINTS``
|
366 | 108be31f | Ilias Tsitsimpis | def get_endpoints(self, token, belongs_to=None, marker=None, limit=None): |
367 | 108be31f | Ilias Tsitsimpis | """Request registered endpoints from astakos
|
368 | 108be31f | Ilias Tsitsimpis |
|
369 | 108be31f | Ilias Tsitsimpis | keyword arguments:
|
370 | 108be31f | Ilias Tsitsimpis | token -- user's token (string)
|
371 | 108be31f | Ilias Tsitsimpis | belongs_to -- user's uuid (string)
|
372 | 108be31f | Ilias Tsitsimpis | marker -- return endpoints whose ID is higher than marker's (int)
|
373 | 108be31f | Ilias Tsitsimpis | limit -- maximum number of endpoints to return (int)
|
374 | 108be31f | Ilias Tsitsimpis |
|
375 | 108be31f | Ilias Tsitsimpis | Return a json formatted dictionary containing information
|
376 | 108be31f | Ilias Tsitsimpis | about registered endpoints.
|
377 | 108be31f | Ilias Tsitsimpis |
|
378 | 108be31f | Ilias Tsitsimpis | WARNING: This api call encodes the user's token inside the url.
|
379 | 108be31f | Ilias Tsitsimpis | It's thoughs security unsafe to use it (both astakosclient and
|
380 | 108be31f | Ilias Tsitsimpis | nginx tend to log requested urls).
|
381 | 25a04cdd | Ilias Tsitsimpis | Avoid the use of get_endpoints method and use
|
382 | 25a04cdd | Ilias Tsitsimpis | get_user_info_with_endpoints instead.
|
383 | 108be31f | Ilias Tsitsimpis |
|
384 | 108be31f | Ilias Tsitsimpis | """
|
385 | 108be31f | Ilias Tsitsimpis | params = {} |
386 | 108be31f | Ilias Tsitsimpis | if belongs_to is not None: |
387 | 108be31f | Ilias Tsitsimpis | params['belongsTo'] = str(belongs_to) |
388 | 108be31f | Ilias Tsitsimpis | if marker is not None: |
389 | 108be31f | Ilias Tsitsimpis | params['marker'] = str(marker) |
390 | 108be31f | Ilias Tsitsimpis | if limit is not None: |
391 | 108be31f | Ilias Tsitsimpis | params['limit'] = str(limit) |
392 | 108be31f | Ilias Tsitsimpis | path = API_TOKENS + "/" + token + "/" + \ |
393 | 108be31f | Ilias Tsitsimpis | TOKENS_ENDPOINTS + "?" + urllib.urlencode(params)
|
394 | 108be31f | Ilias Tsitsimpis | return self._call_astakos(token, path) |
395 | 92683993 | Ilias Tsitsimpis | |
396 | 92683993 | Ilias Tsitsimpis | # ----------------------------------
|
397 | 25a04cdd | Ilias Tsitsimpis | # do a POST to ``API_TOKENS``
|
398 | 25a04cdd | Ilias Tsitsimpis | def get_user_info_with_endpoints(self, token, uuid=None): |
399 | 25a04cdd | Ilias Tsitsimpis | """ Fallback call for authenticate
|
400 | 25a04cdd | Ilias Tsitsimpis |
|
401 | 25a04cdd | Ilias Tsitsimpis | Keyword arguments:
|
402 | 25a04cdd | Ilias Tsitsimpis | token -- user's token (string)
|
403 | 25a04cdd | Ilias Tsitsimpis | uuid -- user's uniq id
|
404 | 25a04cdd | Ilias Tsitsimpis |
|
405 | 25a04cdd | Ilias Tsitsimpis | It returns back the token as well as information about the token
|
406 | 25a04cdd | Ilias Tsitsimpis | holder and the services he/she can acess (in json format).
|
407 | 25a04cdd | Ilias Tsitsimpis | In case of error raise an AstakosClientException.
|
408 | 25a04cdd | Ilias Tsitsimpis |
|
409 | 25a04cdd | Ilias Tsitsimpis | """
|
410 | 25a04cdd | Ilias Tsitsimpis | req_path = copy(API_TOKENS) |
411 | 25a04cdd | Ilias Tsitsimpis | req_headers = {'content-type': 'application/json'} |
412 | 25a04cdd | Ilias Tsitsimpis | body = {'auth': {'token': {'id': token}}} |
413 | 25a04cdd | Ilias Tsitsimpis | if uuid is not None: |
414 | 25a04cdd | Ilias Tsitsimpis | body['auth']['tenantName'] = uuid |
415 | 25a04cdd | Ilias Tsitsimpis | req_body = parse_request(body, self.logger)
|
416 | 25a04cdd | Ilias Tsitsimpis | return self._call_astakos(token, req_path, req_headers, |
417 | 25a04cdd | Ilias Tsitsimpis | req_body, "POST", False) |
418 | 25a04cdd | Ilias Tsitsimpis | |
419 | 25a04cdd | Ilias Tsitsimpis | # ----------------------------------
|
420 | 7b5a37fd | Ilias Tsitsimpis | # do a GET to ``API_QUOTAS``
|
421 | baeb2ba5 | Ilias Tsitsimpis | def get_quotas(self, token): |
422 | fd420756 | Ilias Tsitsimpis | """Get user's quotas
|
423 | fd420756 | Ilias Tsitsimpis |
|
424 | fd420756 | Ilias Tsitsimpis | Keyword arguments:
|
425 | fd420756 | Ilias Tsitsimpis | token -- user's token (string)
|
426 | fd420756 | Ilias Tsitsimpis |
|
427 | fd420756 | Ilias Tsitsimpis | In case of success return a dict of dicts with user's current quotas.
|
428 | fd420756 | Ilias Tsitsimpis | Otherwise raise an AstakosClientException
|
429 | fd420756 | Ilias Tsitsimpis |
|
430 | fd420756 | Ilias Tsitsimpis | """
|
431 | 7b5a37fd | Ilias Tsitsimpis | return self._call_astakos(token, copy(API_QUOTAS)) |
432 | baeb2ba5 | Ilias Tsitsimpis | |
433 | fd420756 | Ilias Tsitsimpis | # ----------------------------------
|
434 | 7b5a37fd | Ilias Tsitsimpis | # do a GET to ``API_SERVICE_QUOTAS``
|
435 | 271d2c4c | Giorgos Korfiatis | def service_get_quotas(self, token, user=None): |
436 | 5b33b8e5 | Giorgos Korfiatis | """Get all quotas for resources associated with the service
|
437 | 5b33b8e5 | Giorgos Korfiatis |
|
438 | 5b33b8e5 | Giorgos Korfiatis | Keyword arguments:
|
439 | 5b33b8e5 | Giorgos Korfiatis | token -- service's token (string)
|
440 | db9f7a2b | Giorgos Korfiatis | user -- optionally, the uuid of a specific user
|
441 | 5b33b8e5 | Giorgos Korfiatis |
|
442 | 5b33b8e5 | Giorgos Korfiatis | In case of success return a dict of dicts of dicts with current quotas
|
443 | db9f7a2b | Giorgos Korfiatis | for all users, or of a specified user, if user argument is set.
|
444 | 5b33b8e5 | Giorgos Korfiatis | Otherwise raise an AstakosClientException
|
445 | 5b33b8e5 | Giorgos Korfiatis |
|
446 | 5b33b8e5 | Giorgos Korfiatis | """
|
447 | 7b5a37fd | Ilias Tsitsimpis | query = copy(API_SERVICE_QUOTAS) |
448 | db9f7a2b | Giorgos Korfiatis | if user is not None: |
449 | db9f7a2b | Giorgos Korfiatis | query += "?user=" + user
|
450 | db9f7a2b | Giorgos Korfiatis | return self._call_astakos(token, query) |
451 | 5b33b8e5 | Giorgos Korfiatis | |
452 | 5b33b8e5 | Giorgos Korfiatis | # ----------------------------------
|
453 | 7b5a37fd | Ilias Tsitsimpis | # do a POST to ``API_COMMISSIONS``
|
454 | fd420756 | Ilias Tsitsimpis | def issue_commission(self, token, request): |
455 | fd420756 | Ilias Tsitsimpis | """Issue a commission
|
456 | fd420756 | Ilias Tsitsimpis |
|
457 | fd420756 | Ilias Tsitsimpis | Keyword arguments:
|
458 | 925d0fee | Ilias Tsitsimpis | token -- service's token (string)
|
459 | fd420756 | Ilias Tsitsimpis | request -- commision request (dict)
|
460 | fd420756 | Ilias Tsitsimpis |
|
461 | fd420756 | Ilias Tsitsimpis | In case of success return commission's id (int).
|
462 | fd420756 | Ilias Tsitsimpis | Otherwise raise an AstakosClientException.
|
463 | fd420756 | Ilias Tsitsimpis |
|
464 | fd420756 | Ilias Tsitsimpis | """
|
465 | fd420756 | Ilias Tsitsimpis | req_headers = {'content-type': 'application/json'} |
466 | 19198628 | Ilias Tsitsimpis | req_body = parse_request(request, self.logger)
|
467 | fd420756 | Ilias Tsitsimpis | try:
|
468 | 7b5a37fd | Ilias Tsitsimpis | response = self._call_astakos(token, copy(API_COMMISSIONS),
|
469 | fd420756 | Ilias Tsitsimpis | req_headers, req_body, "POST")
|
470 | fd420756 | Ilias Tsitsimpis | except AstakosClientException as err: |
471 | fd420756 | Ilias Tsitsimpis | if err.status == 413: |
472 | fd420756 | Ilias Tsitsimpis | raise QuotaLimit(err.message, err.details)
|
473 | fd420756 | Ilias Tsitsimpis | else:
|
474 | fd420756 | Ilias Tsitsimpis | raise
|
475 | fd420756 | Ilias Tsitsimpis | |
476 | fd420756 | Ilias Tsitsimpis | if "serial" in response: |
477 | fd420756 | Ilias Tsitsimpis | return response['serial'] |
478 | fd420756 | Ilias Tsitsimpis | else:
|
479 | fd420756 | Ilias Tsitsimpis | m = "issue_commission_core request returned %s. No serial found" \
|
480 | fd420756 | Ilias Tsitsimpis | % response |
481 | fd420756 | Ilias Tsitsimpis | self.logger.error(m)
|
482 | fd420756 | Ilias Tsitsimpis | raise AstakosClientException(m)
|
483 | fd420756 | Ilias Tsitsimpis | |
484 | 12eab714 | Ilias Tsitsimpis | def issue_one_commission(self, token, holder, source, provisions, |
485 | 3a1bed03 | Giorgos Korfiatis | name="", force=False, auto_accept=False): |
486 | 12eab714 | Ilias Tsitsimpis | """Issue one commission (with specific holder and source)
|
487 | 12eab714 | Ilias Tsitsimpis |
|
488 | 12eab714 | Ilias Tsitsimpis | keyword arguments:
|
489 | 12eab714 | Ilias Tsitsimpis | token -- service's token (string)
|
490 | 12eab714 | Ilias Tsitsimpis | holder -- user's id (string)
|
491 | 12eab714 | Ilias Tsitsimpis | source -- commission's source (ex system) (string)
|
492 | 8b68fa76 | Giorgos Korfiatis | provisions -- resources with their quantity (dict from string to int)
|
493 | 3a1bed03 | Giorgos Korfiatis | name -- description of the commission (string)
|
494 | 12eab714 | Ilias Tsitsimpis | force -- force this commission (boolean)
|
495 | 12eab714 | Ilias Tsitsimpis | auto_accept -- auto accept this commission (boolean)
|
496 | 12eab714 | Ilias Tsitsimpis |
|
497 | 12eab714 | Ilias Tsitsimpis | In case of success return commission's id (int).
|
498 | 12eab714 | Ilias Tsitsimpis | Otherwise raise an AstakosClientException.
|
499 | 12eab714 | Ilias Tsitsimpis | (See also issue_commission)
|
500 | 12eab714 | Ilias Tsitsimpis |
|
501 | 12eab714 | Ilias Tsitsimpis | """
|
502 | d5f086f2 | Ilias Tsitsimpis | check_input("issue_one_commission", self.logger, |
503 | d5f086f2 | Ilias Tsitsimpis | holder=holder, source=source, |
504 | d5f086f2 | Ilias Tsitsimpis | provisions=provisions) |
505 | 12eab714 | Ilias Tsitsimpis | |
506 | 12eab714 | Ilias Tsitsimpis | request = {} |
507 | 12eab714 | Ilias Tsitsimpis | request["force"] = force
|
508 | 12eab714 | Ilias Tsitsimpis | request["auto_accept"] = auto_accept
|
509 | 3a1bed03 | Giorgos Korfiatis | request["name"] = name
|
510 | 12eab714 | Ilias Tsitsimpis | try:
|
511 | 12eab714 | Ilias Tsitsimpis | request["provisions"] = []
|
512 | 567f49a2 | Giorgos Korfiatis | for resource, quantity in provisions.iteritems(): |
513 | 12eab714 | Ilias Tsitsimpis | t = {"holder": holder, "source": source, |
514 | 12eab714 | Ilias Tsitsimpis | "resource": resource, "quantity": quantity} |
515 | 12eab714 | Ilias Tsitsimpis | request["provisions"].append(t)
|
516 | 12eab714 | Ilias Tsitsimpis | except Exception as err: |
517 | 12eab714 | Ilias Tsitsimpis | self.logger.error(str(err)) |
518 | 12eab714 | Ilias Tsitsimpis | raise BadValue(str(err)) |
519 | 12eab714 | Ilias Tsitsimpis | |
520 | 12eab714 | Ilias Tsitsimpis | return self.issue_commission(token, request) |
521 | 12eab714 | Ilias Tsitsimpis | |
522 | 7a0180ef | Ilias Tsitsimpis | # ----------------------------------
|
523 | 7b5a37fd | Ilias Tsitsimpis | # do a GET to ``API_COMMISSIONS``
|
524 | 7a0180ef | Ilias Tsitsimpis | def get_pending_commissions(self, token): |
525 | 7a0180ef | Ilias Tsitsimpis | """Get Pending Commissions
|
526 | 7a0180ef | Ilias Tsitsimpis |
|
527 | 7a0180ef | Ilias Tsitsimpis | Keyword arguments:
|
528 | 925d0fee | Ilias Tsitsimpis | token -- service's token (string)
|
529 | 7a0180ef | Ilias Tsitsimpis |
|
530 | 7a0180ef | Ilias Tsitsimpis | In case of success return a list of pending commissions' ids
|
531 | 7a0180ef | Ilias Tsitsimpis | (list of integers)
|
532 | 7a0180ef | Ilias Tsitsimpis |
|
533 | 7a0180ef | Ilias Tsitsimpis | """
|
534 | 7b5a37fd | Ilias Tsitsimpis | return self._call_astakos(token, copy(API_COMMISSIONS)) |
535 | 7a0180ef | Ilias Tsitsimpis | |
536 | 994f37b6 | Ilias Tsitsimpis | # ----------------------------------
|
537 | 7b5a37fd | Ilias Tsitsimpis | # do a GET to ``API_COMMISSIONS``/<serial>
|
538 | 994f37b6 | Ilias Tsitsimpis | def get_commission_info(self, token, serial): |
539 | 994f37b6 | Ilias Tsitsimpis | """Get Description of a Commission
|
540 | 994f37b6 | Ilias Tsitsimpis |
|
541 | 994f37b6 | Ilias Tsitsimpis | Keyword arguments:
|
542 | 925d0fee | Ilias Tsitsimpis | token -- service's token (string)
|
543 | 994f37b6 | Ilias Tsitsimpis | serial -- commission's id (int)
|
544 | 994f37b6 | Ilias Tsitsimpis |
|
545 | 994f37b6 | Ilias Tsitsimpis | In case of success return a dict of dicts containing
|
546 | 5c418e94 | Ilias Tsitsimpis | informations (details) about the requested commission
|
547 | 994f37b6 | Ilias Tsitsimpis |
|
548 | 994f37b6 | Ilias Tsitsimpis | """
|
549 | 10797183 | Ilias Tsitsimpis | check_input("get_commission_info", self.logger, serial=serial) |
550 | 994f37b6 | Ilias Tsitsimpis | |
551 | 7b5a37fd | Ilias Tsitsimpis | path = API_COMMISSIONS + "/" + str(serial) |
552 | 994f37b6 | Ilias Tsitsimpis | return self._call_astakos(token, path) |
553 | 994f37b6 | Ilias Tsitsimpis | |
554 | 805e294c | Ilias Tsitsimpis | # ----------------------------------
|
555 | 7b5a37fd | Ilias Tsitsimpis | # do a POST to ``API_COMMISSIONS``/<serial>/action"
|
556 | b5008ef0 | Ilias Tsitsimpis | def commission_action(self, token, serial, action): |
557 | b5008ef0 | Ilias Tsitsimpis | """Perform a commission action
|
558 | 805e294c | Ilias Tsitsimpis |
|
559 | 805e294c | Ilias Tsitsimpis | Keyword arguments:
|
560 | 925d0fee | Ilias Tsitsimpis | token -- service's token (string)
|
561 | 805e294c | Ilias Tsitsimpis | serial -- commission's id (int)
|
562 | 805e294c | Ilias Tsitsimpis | action -- action to perform, currently accept/reject (string)
|
563 | 805e294c | Ilias Tsitsimpis |
|
564 | 805e294c | Ilias Tsitsimpis | In case of success return nothing.
|
565 | 805e294c | Ilias Tsitsimpis |
|
566 | 805e294c | Ilias Tsitsimpis | """
|
567 | 10797183 | Ilias Tsitsimpis | check_input("commission_action", self.logger, |
568 | 10797183 | Ilias Tsitsimpis | serial=serial, action=action) |
569 | 805e294c | Ilias Tsitsimpis | |
570 | 7b5a37fd | Ilias Tsitsimpis | path = API_COMMISSIONS + "/" + str(serial) + "/action" |
571 | 805e294c | Ilias Tsitsimpis | req_headers = {'content-type': 'application/json'} |
572 | 19198628 | Ilias Tsitsimpis | req_body = parse_request({str(action): ""}, self.logger) |
573 | 805e294c | Ilias Tsitsimpis | self._call_astakos(token, path, req_headers, req_body, "POST") |
574 | 805e294c | Ilias Tsitsimpis | |
575 | b5008ef0 | Ilias Tsitsimpis | def accept_commission(self, token, serial): |
576 | b5008ef0 | Ilias Tsitsimpis | """Accept a commission (see commission_action)"""
|
577 | b5008ef0 | Ilias Tsitsimpis | self.commission_action(token, serial, "accept") |
578 | 805e294c | Ilias Tsitsimpis | |
579 | b5008ef0 | Ilias Tsitsimpis | def reject_commission(self, token, serial): |
580 | b5008ef0 | Ilias Tsitsimpis | """Reject a commission (see commission_action)"""
|
581 | b5008ef0 | Ilias Tsitsimpis | self.commission_action(token, serial, "reject") |
582 | 805e294c | Ilias Tsitsimpis | |
583 | 81875157 | Ilias Tsitsimpis | # ----------------------------------
|
584 | 7b5a37fd | Ilias Tsitsimpis | # do a POST to ``API_COMMISSIONS_ACTION``
|
585 | 81875157 | Ilias Tsitsimpis | def resolve_commissions(self, token, accept_serials, reject_serials): |
586 | 81875157 | Ilias Tsitsimpis | """Resolve multiple commissions at once
|
587 | 81875157 | Ilias Tsitsimpis |
|
588 | 81875157 | Ilias Tsitsimpis | Keyword arguments:
|
589 | 81875157 | Ilias Tsitsimpis | token -- service's token (string)
|
590 | 81875157 | Ilias Tsitsimpis | accept_serials -- commissions to accept (list of ints)
|
591 | 81875157 | Ilias Tsitsimpis | reject_serials -- commissions to reject (list of ints)
|
592 | 81875157 | Ilias Tsitsimpis |
|
593 | 81875157 | Ilias Tsitsimpis | In case of success return a dict of dicts describing which
|
594 | 81875157 | Ilias Tsitsimpis | commissions accepted, which rejected and which failed to
|
595 | 81875157 | Ilias Tsitsimpis | resolved.
|
596 | 81875157 | Ilias Tsitsimpis |
|
597 | 81875157 | Ilias Tsitsimpis | """
|
598 | d5f086f2 | Ilias Tsitsimpis | check_input("resolve_commissions", self.logger, |
599 | d5f086f2 | Ilias Tsitsimpis | accept_serials=accept_serials, |
600 | d5f086f2 | Ilias Tsitsimpis | reject_serials=reject_serials) |
601 | 81875157 | Ilias Tsitsimpis | |
602 | 7b5a37fd | Ilias Tsitsimpis | path = copy(API_COMMISSIONS_ACTION) |
603 | 81875157 | Ilias Tsitsimpis | req_headers = {'content-type': 'application/json'} |
604 | 81875157 | Ilias Tsitsimpis | req_body = parse_request({"accept": accept_serials,
|
605 | 81875157 | Ilias Tsitsimpis | "reject": reject_serials},
|
606 | 81875157 | Ilias Tsitsimpis | self.logger)
|
607 | 81875157 | Ilias Tsitsimpis | return self._call_astakos(token, path, req_headers, req_body, "POST") |
608 | 81875157 | Ilias Tsitsimpis | |
609 | f54cf5e4 | Ilias Tsitsimpis | |
610 | f54cf5e4 | Ilias Tsitsimpis | # --------------------------------------------------------------------
|
611 | cbc0b438 | Ilias Tsitsimpis | # Private functions
|
612 | f93cc364 | Ilias Tsitsimpis | # We want _doRequest to be a distinct function
|
613 | f93cc364 | Ilias Tsitsimpis | # so that we can replace it during unit tests.
|
614 | 794c94e6 | Ilias Tsitsimpis | def _do_request(conn, method, url, **kwargs): |
615 | f8388a90 | Ilias Tsitsimpis | """The actual request. This function can easily be mocked"""
|
616 | f8388a90 | Ilias Tsitsimpis | conn.request(method, url, **kwargs) |
617 | f8388a90 | Ilias Tsitsimpis | response = conn.getresponse() |
618 | f8388a90 | Ilias Tsitsimpis | length = response.getheader('content-length', None) |
619 | f8388a90 | Ilias Tsitsimpis | data = response.read(length) |
620 | f8388a90 | Ilias Tsitsimpis | status = int(response.status)
|
621 | 21190887 | Ilias Tsitsimpis | message = response.reason |
622 | 21190887 | Ilias Tsitsimpis | return (message, data, status) |