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'])
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="******", 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__
