""" SoftLayer.API ~~~~~~~~~~~~~ SoftLayer API bindings :license: MIT, see LICENSE for more details. """ import time from SoftLayer import auth as slauth from SoftLayer import config from SoftLayer import consts from SoftLayer import transports API_PUBLIC_ENDPOINT = consts.API_PUBLIC_ENDPOINT API_PRIVATE_ENDPOINT = consts.API_PRIVATE_ENDPOINT __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 proxy: proxy to be used to make API calls :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, proxy=None): settings = config.get_client_settings(username=username, api_key=api_key, endpoint_url=endpoint_url, timeout=timeout, auth=auth, proxy=proxy, config_file=config_file) self.auth = settings.get('auth') self.endpoint_url = ( settings.get('endpoint_url') or API_PUBLIC_ENDPOINT).rstrip('/') self.timeout = None if settings.get('timeout'): self.timeout = float(settings.get('timeout')) self.proxy = None if settings.get('proxy'): self.proxy = settings.get('proxy') def authenticate_with_password(self, username, password, security_question_id=None, security_question_answer=None): """Performs Username/Password Authentication :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 = slauth.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'] """ 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 headers = kwargs.get('headers', {}) if self.auth: headers.update(self.auth.get_headers()) if kwargs.get('id') is not None: headers[service + 'InitParameters'] = {'id': kwargs.get('id')} if kwargs.get('mask') is not None: headers.update(self.__format_object_mask(kwargs.get('mask'), service)) if kwargs.get('filter') is not None: headers['%sObjectFilter' % service] = kwargs.get('filter') if kwargs.get('limit'): headers['resultLimit'] = { 'limit': kwargs.get('limit'), 'offset': kwargs.get('offset', 0), } http_headers = { 'User-Agent': consts.USER_AGENT, 'Content-Type': 'application/xml', } if kwargs.get('compress', True): http_headers['Accept'] = '*/*' http_headers['Accept-Encoding'] = 'gzip, deflate, compress' if kwargs.get('raw_headers'): http_headers.update(kwargs.get('raw_headers')) uri = '/'.join([self.endpoint_url, service]) return transports.make_xml_rpc_api_call(uri, method, args, headers=headers, http_headers=http_headers, timeout=self.timeout, proxy=self.proxy) __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 "" % (self.endpoint_url, self.auth) __str__ = __repr__ def __len__(self): return 0 class TimedClient(Client): """Client that records API call timings. 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. """ def __init__(self, *args, **kwargs): self.last_calls = [] super(TimedClient, self).__init__(*args, **kwargs) 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): """A SoftLayer Service. :param client: A SoftLayer.API.Client instance :param name str: The service name """ 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): " Handler that actually makes the API call " return self(name, *args, **kwargs) return call_handler def __repr__(self): return "" % (self.name,) __str__ = __repr__