Skip to content
Navigation Menu
{{ message }}
forked from softlayer/softlayer-python
-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathAPI.py
More file actions
359 lines (282 loc) · 11.9 KB
/
Copy pathAPI.py
File metadata and controls
359 lines (282 loc) · 11.9 KB
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
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
"""
SoftLayer.API
~~~~~~~~~~~~~
SoftLayer API bindings
:copyright: (c) 2013, SoftLayer Technologies, Inc. All rights reserved.
:license: MIT, see LICENSE for more details.
"""
import time
from consts import API_PUBLIC_ENDPOINT, API_PRIVATE_ENDPOINT, USER_AGENT
from transports import make_xml_rpc_api_call
from auth import TokenAuthentication
from config import get_client_settings
__all__ = ['Client', 'TimedClient', 'API_PUBLIC_ENDPOINT',
'API_PRIVATE_ENDPOINT']
VALID_CALL_ARGS = set([
'id',
'mask',
'filter',
'headers',
'compress',
'raw_headers',
'limit',
'offset',
])
class Client(object):
""" A SoftLayer API client.
:param username: an optional API username if you wish to bypass the
package's built-in username
:param api_key: an optional API key if you wish to bypass the package's
built in API key
:param endpoint_url: the API endpoint base URL you wish to connect to.
Set this to API_PRIVATE_ENDPOINT to connect via SoftLayer's private
network.
:param integer timeout: timeout for API requests
:param auth: an object which responds to get_headers() to be inserted into
the xml-rpc headers. Example: `BasicAuthentication`
:param config_file: A path to a configuration file used to load settings
Usage:
>>> import SoftLayer
>>> client = SoftLayer.Client(username="username", api_key="api_key")
>>> resp = client['Account'].getObject()
>>> resp['companyName']
'Your Company'
"""
_prefix = "SoftLayer_"
def __init__(self, username=None, api_key=None, endpoint_url=None,
timeout=None, auth=None, config_file=None):
settings = get_client_settings(username=username,
api_key=api_key,
endpoint_url=endpoint_url,
timeout=timeout,
auth=auth,
config_file=config_file)
self.auth = settings.get('auth')
self.endpoint_url = (
settings.get('endpoint_url') or API_PUBLIC_ENDPOINT).rstrip('/')
self.timeout = None
self.last_calls = []
if settings.get('timeout'):
self.timeout = float(settings.get('timeout'))
def authenticate_with_password(self, username, password,
security_question_id=None,
security_question_answer=None):
""" Performs Username/Password Authentication and gives back an auth
handler to use to create a client that uses token-based auth.
:param string username: your SoftLayer username
:param string password: your SoftLayer password
:param int security_question_id: The security question id to answer
:param string security_question_answer: The answer to the security
question
"""
self.auth = None
res = self['User_Customer'].getPortalLoginToken(
username,
password,
security_question_id,
security_question_answer)
self.auth = TokenAuthentication(res['userId'], res['hash'])
return (res['userId'], res['hash'])
def __getitem__(self, name):
""" Get a SoftLayer Service.
:param name: The name of the service. E.G. Account
Usage:
>>> import SoftLayer
>>> client = SoftLayer.Client()
>>> client['Account']
<Service: Account>
"""
return Service(self, name)
def call(self, service, method, *args, **kwargs):
""" Make a SoftLayer API call
:param service: the name of the SoftLayer API service
:param method: the method to call on the service
:param \*args: same optional arguments that ``Service.call`` takes
:param \*\*kwargs: same optional keyword arguments that
``Service.call`` takes
:param service: the name of the SoftLayer API service
Usage:
>>> import SoftLayer
>>> client = SoftLayer.Client()
>>> client['Account'].getVirtualGuests(mask="id", limit=10)
[...]
"""
if kwargs.pop('iter', False):
return self.iter_call(service, method, *args, **kwargs)
invalid_kwargs = set(kwargs.keys()) - VALID_CALL_ARGS
if invalid_kwargs:
raise TypeError(
'Invalid keyword arguments: %s' % ','.join(invalid_kwargs))
if not service.startswith(self._prefix):
service = self._prefix + service
objectid = kwargs.get('id')
objectmask = kwargs.get('mask')
objectfilter = kwargs.get('filter')
headers = kwargs.get('headers', {})
compress = kwargs.get('compress', True)
raw_headers = kwargs.get('raw_headers')
limit = kwargs.get('limit')
offset = kwargs.get('offset', 0)
if self.auth:
headers.update(self.auth.get_headers())
if objectid is not None:
headers[service + 'InitParameters'] = {'id': objectid}
if objectmask is not None:
headers.update(self.__format_object_mask(objectmask, service))
if objectfilter is not None:
headers['%sObjectFilter' % service] = objectfilter
if limit:
headers['resultLimit'] = {
'limit': limit,
'offset': offset,
}
http_headers = {
'User-Agent': USER_AGENT,
'Content-Type': 'application/xml',
}
if compress:
http_headers['Accept'] = '*/*'
http_headers['Accept-Encoding'] = 'gzip, deflate, compress'
if raw_headers:
http_headers.update(raw_headers)
uri = '/'.join([self.endpoint_url, service])
return make_xml_rpc_api_call(uri, method, args,
headers=headers,
http_headers=http_headers,
timeout=self.timeout)
__call__ = call
def iter_call(self, service, method,
chunk=100, limit=None, offset=0, *args, **kwargs):
""" A generator that deals with paginating through results.
:param service: the name of the SoftLayer API service
:param method: the method to call on the service
:param integer chunk: result size for each API call
:param \*args: same optional arguments that ``Service.call`` takes
:param \*\*kwargs: same optional keyword arguments that
``Service.call`` takes
"""
if chunk <= 0:
raise AttributeError("Chunk size should be greater than zero.")
if limit:
chunk = min(chunk, limit)
result_count = 0
kwargs['iter'] = False
while True:
if limit:
# We've reached the end of the results
if result_count >= limit:
break
# Don't over-fetch past the given limit
if chunk + result_count > limit:
chunk = limit - result_count
results = self.call(service, method,
offset=offset, limit=chunk, *args, **kwargs)
# It looks like we ran out results
if not results:
break
# Apparently this method doesn't return a list.
# Why are you even iterating over this?
if not isinstance(results, list):
yield results
break
for item in results:
yield item
result_count += 1
offset += chunk
if len(results) < chunk:
break
def __format_object_mask(self, objectmask, service):
""" Format new and old style object masks into proper headers.
:param objectmask: a string- or dict-based object mask
:param service: a SoftLayer API service name
"""
if isinstance(objectmask, dict):
mheader = '%sObjectMask' % service
else:
mheader = self._prefix + 'ObjectMask'
objectmask = objectmask.strip()
if not objectmask.startswith('mask') \
and not objectmask.startswith('['):
objectmask = "mask[%s]" % objectmask
return {mheader: {'mask': objectmask}}
def __repr__(self):
return "<Client: endpoint=%s, user=%r>" \
% (self.endpoint_url, self.auth)
__str__ = __repr__
class TimedClient(Client):
""" Subclass of Client()
Using this class will time every call to the API and store it in an
internal list. This will have a slight impact on your client's memory
usage and performance. You should only use this for debugging.
"""
last_calls = []
def call(self, service, method, *args, **kwargs):
""" See Client.call for documentation. """
start_time = time.time()
result = super(TimedClient, self).call(service, method, *args,
**kwargs)
end_time = time.time()
diff = end_time - start_time
self.last_calls.append((service + '.' + method, start_time, diff))
return result
def get_last_calls(self):
""" Retrieves the last_calls property.
This property will contain a list of tuples in the form
('SERVICE.METHOD', initiated_utc_timestamp, execution_time)
"""
last_calls = self.last_calls
self.last_calls = []
return last_calls
class Service(object):
def __init__(self, client, name):
self.client = client
self.name = name
def call(self, name, *args, **kwargs):
""" Make a SoftLayer API call
:param method: the method to call on the service
:param \*args: (optional) arguments for the remote call
:param id: (optional) id for the resource
:param mask: (optional) object mask
:param dict filter: (optional) filter dict
:param dict headers: (optional) optional XML-RPC headers
:param boolean compress: (optional) Enable/Disable HTTP compression
:param dict raw_headers: (optional) HTTP transport headers
:param int limit: (optional) return at most this many results
:param int offset: (optional) offset results by this many
:param boolean iter: (optional) if True, returns a generator with the
results
Usage:
>>> import SoftLayer
>>> client = SoftLayer.Client()
>>> client['Account'].getVirtualGuests(mask="id", limit=10)
[...]
"""
return self.client.call(self.name, name, *args, **kwargs)
__call__ = call
def iter_call(self, name, *args, **kwargs):
""" A generator that deals with paginating through results.
:param method: the method to call on the service
:param integer chunk: result size for each API call
:param \*args: same optional arguments that ``Service.call`` takes
:param \*\*kwargs: same optional keyword arguments that
``Service.call`` takes
Usage:
>>> import SoftLayer
>>> client = SoftLayer.Client()
>>> gen = client['Account'].getVirtualGuests(iter=True)
>>> for virtual_guest in gen:
... virtual_guest['id']
...
1234
4321
"""
return self.client.iter_call(self.name, name, *args, **kwargs)
def __getattr__(self, name):
if name in ["__name__", "__bases__"]:
raise AttributeError("'Obj' object has no attribute '%s'" % name)
def call_handler(*args, **kwargs):
return self(name, *args, **kwargs)
return call_handler
def __repr__(self):
return "<Service: %s>" % (self.name,)
__str__ = __repr__
You can’t perform that action at this time.