projectal.entities.file

  1from projectal.entity import Entity
  2from projectal.linkers import *
  3from projectal import api
  4
  5
  6class File(Entity, CompanyLinker, CustomerLinker, FolderLinker, ProjectLinker,
  7           StaffLinker, TaskLinker, TaskTemplateLinker, NoteLinker, TagLinker):
  8    """
  9    Implementation of the [File](https://projectal.com/docs/latest/#tag/File) API.
 10    """
 11    _path = 'file'
 12    _name = 'file'
 13    _links = [NoteLinker, TagLinker]
 14    _links_reverse = [CompanyLinker, CustomerLinker, FolderLinker, ProjectLinker,
 15                      StaffLinker, TaskLinker, TaskTemplateLinker]
 16
 17    @classmethod
 18    def create(cls, file_data, entity):
 19        """
 20        Create a File entity with file data.
 21
 22        `file_data` is the raw file data in bytes
 23
 24        `entity` is the File entity and its fields.
 25        """
 26        payload = entity
 27        url = '/api/file/upload'
 28        file = {'file': file_data}
 29        response = api.post(url, payload, file=file)
 30        entity['uuId'] = response['jobClue']['uuId']
 31        return cls(entity)
 32
 33    @classmethod
 34    def get(cls, uuId, links=None):
 35        """Get the File entity. No file data is included."""
 36        link_set = cls._get_linkset(links)
 37        url = '/api/file/get?uuId={}'.format(uuId)
 38        if link_set:
 39            url += '&links=' + ','.join(link_set)
 40        return cls(api.get(url))
 41
 42    @classmethod
 43    def update(cls, entity, file_data=None):
 44        """
 45        Update the File entity. Optionally, also update the
 46        file data that this File holds.
 47        """
 48        payload = entity
 49        url = '/api/file/update'
 50        if file_data:
 51            file = {'file': file_data}
 52            api.put(url, payload, file=file)
 53        else:
 54            api.put(url, payload, form=True)
 55
 56    @classmethod
 57    def get_file_data(cls, uuId):
 58        """
 59        Get the file data that is held by the file with `uuId`.
 60        Returns the raw content of the response.
 61        """
 62        url = '/api/file/{}'.format(uuId)
 63        response = api.get(url, is_json=False)
 64        return response.content
 65
 66    @classmethod
 67    def download_to_browser(cls, uuId):
 68        """
 69        Get the file data that is held by the file with `uuId`.
 70        Returns the response object which will have headers suitable
 71        to initiate a download by the user agent.
 72        """
 73        url = '/api/file/download'
 74        payload = {'uuId': uuId}
 75        response = api.post(url, payload, is_json=False)
 76        return response
 77
 78    @classmethod
 79    def delete(cls, uuId):
 80        """
 81        Delete the File entity and its file data.
 82        """
 83        url = '/api/file/delete/{}'.format(uuId)
 84        api.delete(url)
 85        return True
 86
 87    @classmethod
 88    def download_multiple(cls, list):
 89        """
 90        Given a list of File entities, return the file data held by
 91        each as a `.zip` file.
 92        """
 93        url = '/api/file/multidownload'
 94        response = api.post(url, list, is_json=False)
 95        return response.content
 96
 97    @classmethod
 98    def list(cls, expand=True):
 99        """Return all files as a list"""
100        files = api.get('/api/file/list')
101        return [cls(f) for f in files]