Source code for pysnow.resource

# -*- coding: utf-8 -*-

import logging

from copy import copy, deepcopy

from .request import SnowRequest
from .attachment import Attachment
from .url_builder import URLBuilder
from .exceptions import InvalidUsage

logger = logging.getLogger('pysnow')

[docs]class Resource(object): """Creates a new :class:`Resource` object Resources provides a natural way of interfacing with ServiceNow APIs. :param base_path: Base path :param api_path: API path :param chunk_size: Response stream parser chunk size (in bytes) :param \*\*kwargs: Arguments to pass along to :class:`Request` """ def __init__(self, base_url=None, base_path=None, api_path=None, parameters=None, **kwargs): self._base_url = base_url self._base_path = base_path self._api_path = api_path self._url_builder = URLBuilder(base_url, base_path, api_path) self.kwargs = kwargs self.parameters = deepcopy(parameters) logger.debug('(RESOURCE_ADD) Object: %s, chunk_size: %d' % (self, kwargs.get('chunk_size'))) def __repr__(self): return '<%s [%s] at %s>' % (self.__class__.__name__, self.path, hex(id(self))) @property def path(self): """Get current path relative to base URL :return: resource path """ return "%s" % self._base_path + self._api_path @property def attachments(self): """Provides an `Attachment` API for this resource. Enables easy listing, deleting and creating new attachments. :return: Attachment object """ resource = copy(self) resource._url_builder = URLBuilder(self._base_url, self._base_path, '/attachment') path = self._api_path.strip('/').split('/') if path[0] != 'table': raise InvalidUsage('The attachment API can only be used with the table API') return Attachment(resource, path[1]) @property def _request(self): """Request wrapper :return: SnowRequest object """ parameters = copy(self.parameters) return SnowRequest(url_builder=self._url_builder, parameters=parameters, resource=self, **self.kwargs)
[docs] def get(self, *args, **kwargs): """Queries the API resource :param args: - :param query: Dictionary, string or :class:`QueryBuilder` object defaults to empty dict (all) :param kwargs: - :param limit: Limits the number of records returned - :param fields: List of fields to include in the response created_on in descending order. - :param offset: Number of records to skip before returning records - :param stream: Whether or not to use streaming / generator response interface :return: - :class:`Response` object """ return self._request.get(*args, **kwargs)
[docs] def create(self, payload): """Creates a new record in the API resource :param payload: Dictionary containing key-value fields of the new record :return: - Dictionary of the inserted record """ return self._request.create(payload)
[docs] def update(self, query, payload): """Updates a record in the API resource :param query: Dictionary, string or :class:`QueryBuilder` object :param payload: Dictionary containing key-value fields of the record to be updated :return: - Dictionary of the updated record """ return self._request.update(query, payload)
[docs] def delete(self, query): """Deletes matching record :param query: Dictionary, string or :class:`QueryBuilder` object :return: - Dictionary containing information about deletion result """ return self._request.delete(query)
[docs] def request(self, method, path_append=None, headers=None, **kwargs): """Create a custom request :param method: HTTP method to use :param path_append: (optional) relative to :attr:`api_path` :param headers: (optional) Dictionary of headers to add or override :param kwargs: kwargs to pass along to :class:`requests.Request` :return: - :class:`Response` object """ return self._request.custom(method, path_append=path_append, headers=headers, **kwargs)