forked from softlayer/softlayer-python
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathtransports.py
More file actions
204 lines (158 loc) · 6.45 KB
/
transports.py
File metadata and controls
204 lines (158 loc) · 6.45 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
"""
SoftLayer.transports
~~~~~~~~~~~~~~~~~~~~
XML-RPC transport layer that uses the requests library.
:license: MIT, see LICENSE for more details.
"""
from SoftLayer import exceptions
from SoftLayer import utils
import json
import logging
import requests
LOGGER = logging.getLogger(__name__)
# transports.Request does have a lot of instance attributes. :(
# pylint: disable=too-many-instance-attributes
class Request(object):
"""Transport request object."""
def __init__(self):
#: The SoftLayer endpoint address.
self.endpoint = None
#: API service name. E.G. SoftLayer_Account
self.service = None
#: API method name. E.G. getObject
self.method = None
#: API Parameters.
self.args = tuple()
#: API headers, used for authentication, masks, limits, offsets, etc.
self.headers = {}
#: Transport headers.
self.transport_headers = {}
#: Integer timeout.
self.timeout = None
#: URL to proxy API requests to.
self.proxy = None
#: Boolean specifying if the server certificate should be verified.
self.verify = True
#: Client certificate file path.
self.cert = None
#: InitParameter/identifier of an object.
self.identifier = None
#: SoftLayer mask (dict or string).
self.mask = None
#: SoftLayer Filter (dict).
self.filter = None
#: Integer result limit.
self.limit = None
#: Integer result offset.
self.offset = None
def make_xml_rpc_api_call(request):
"""Makes a SoftLayer API call against the XML-RPC endpoint.
:param request request: Request object
"""
try:
largs = list(request.args)
headers = request.headers
if request.identifier is not None:
header_name = request.service + 'InitParameters'
headers[header_name] = {'id': request.identifier}
if request.mask is not None:
headers.update(__format_object_mask(request.mask, request.service))
if request.filter is not None:
headers['%sObjectFilter' % request.service] = request.filter
if request.limit:
headers['resultLimit'] = {
'limit': request.limit,
'offset': request.offset or 0,
}
largs.insert(0, {'headers': headers})
url = '/'.join([request.endpoint, request.service])
payload = utils.xmlrpc_client.dumps(tuple(largs),
methodname=request.method,
allow_none=True)
LOGGER.debug("=== REQUEST ===")
LOGGER.info('POST %s', url)
LOGGER.debug(request.transport_headers)
LOGGER.debug(payload)
response = requests.request('POST', url,
data=payload,
headers=request.transport_headers,
timeout=request.timeout,
verify=request.verify,
cert=request.cert,
proxies=__proxies_dict(request.proxy))
LOGGER.debug("=== RESPONSE ===")
LOGGER.debug(response.headers)
LOGGER.debug(response.content)
response.raise_for_status()
result = utils.xmlrpc_client.loads(response.content,)[0][0]
return result
except utils.xmlrpc_client.Fault as ex:
# These exceptions are formed from the XML-RPC spec
# http://xmlrpc-epi.sourceforge.net/specs/rfc.fault_codes.php
error_mapping = {
'-32700': exceptions.NotWellFormed,
'-32701': exceptions.UnsupportedEncoding,
'-32702': exceptions.InvalidCharacter,
'-32600': exceptions.SpecViolation,
'-32601': exceptions.MethodNotFound,
'-32602': exceptions.InvalidMethodParameters,
'-32603': exceptions.InternalError,
'-32500': exceptions.ApplicationError,
'-32400': exceptions.RemoteSystemError,
'-32300': exceptions.TransportError,
}
raise error_mapping.get(ex.faultCode, exceptions.SoftLayerAPIError)(
ex.faultCode, ex.faultString)
except requests.HTTPError as ex:
raise exceptions.TransportError(ex.response.status_code, str(ex))
except requests.RequestException as ex:
raise exceptions.TransportError(0, str(ex))
def make_rest_api_call(request):
"""Makes a SoftLayer API call against the REST endpoint.
This currently only works with GET requests
:param request request: Request object
"""
url_parts = [request.endpoint,
request.service,
request.method]
if request.identifier is not None:
url_parts.append(str(request.identifier))
url = '%s.%s' % ('/'.join(url_parts), 'json')
LOGGER.debug("=== REQUEST ===")
LOGGER.info(url)
LOGGER.debug(request.transport_headers)
try:
resp = requests.request('GET', url,
headers=request.transport_headers,
timeout=request.timeout,
proxies=__proxies_dict(request.proxy))
LOGGER.debug("=== RESPONSE ===")
LOGGER.debug(resp.headers)
LOGGER.debug(resp.content)
resp.raise_for_status()
return json.loads(resp.content)
except requests.HTTPError as ex:
content = json.loads(ex.response.content)
raise exceptions.SoftLayerAPIError(ex.response.status_code,
content['error'])
except requests.RequestException as ex:
raise exceptions.TransportError(0, str(ex))
def __proxies_dict(proxy):
"""Makes a proxy dict appropriate to pass to requests."""
if not proxy:
return None
return {'http': proxy, 'https': proxy}
def __format_object_mask(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 = 'SoftLayer_ObjectMask'
objectmask = objectmask.strip()
if (not objectmask.startswith('mask')
and not objectmask.startswith('[')):
objectmask = "mask[%s]" % objectmask
return {mheader: {'mask': objectmask}}