Add Document download feature

.gitignore

@@ -1,4 +1,5 @@
 __pycache__/
 .venv/
+build/
 dist/
 connectpyse.egg-info/

connectpyse/CHANGES.md

@@ -63,4 +63,12 @@
 
 0.7.1
 ---
-- Added support for Opportunity Teams
+- Added support for Opportunity Teams
+
+0.7.2
+---
+- Added support for gathering object _info
+
+0.7.5
+---
+- Added support for Document Download

connectpyse/README.md

@@ -69,6 +69,23 @@ their appropriate sections. Import the API class(es) you want to leverage and th
     >>>   print(doc.title)
     >>> 
 
+### To download the documents attached to an opportunity:
+
+    >>> from connectpyse.system import document_api
+    >>> from connectpyse.system import document_download_api
+    >>> from connectpyse.sales import opportunity_api
+    >>> o = opportunity_api.OpportunityAPI(url=URL, auth=AUTH)
+    >>> d = document_api.DocumentAPI(url=URL, auth=AUTH)
+
+    >>> a_opp = o.get_opportunity_by_id(1234)
+    >>> myDocs = d.get_documents(a_pp)
+    >>> for doc in myDocs:
+    >>>   doc_download = document_download_api.DocumentDownloadAPI(doc.id, url=URL, auth=AUTH)
+    >>>   ## Option 1: Get the BytesIO object
+    >>>   bytes = doc_download.download_document()
+    >>>   ## Option 2: Download directly to disk
+    >>>   doc_download.save_to_file("/path/to/file.txt")
+
 ### For example to get a Member's office phone number you would:
 
     >>> from connectpyse.system import members_api

connectpyse/cw_controller.py

@@ -1,4 +1,5 @@
 # Parent class for module controller classes
+from io import BytesIO
 from .config import API_URL, basic_auth, ENSURE_ASCII
 from .restapi import Client
 
@@ -33,6 +34,11 @@ def _get(self):
         for json in json_results:
             yield self._class(json)
 
+    def _get_bytes(self):
+        results_str = getattr(self, self.module).get(user_headers=self.basic_auth,
+                                                      user_params=self._format_user_params())
+        return self._class({"bytes": BytesIO(results_str.encode("iso-8859-1"))})
+
     def _create(self, a_object):
         # Ideally take the_item and submit that as the user_data
         try:

connectpyse/system/document_download.py

@@ -0,0 +1,10 @@
+from ..cw_model import CWModel
+
+
+class DocumentDownload(CWModel):
+
+    def __init__(self, json_dict=None):
+        self.bytes = None  # (BytesIO)
+
+        # initialize object with bytes
+        super().__init__(json_dict)

connectpyse/system/document_download_api.py

@@ -0,0 +1,22 @@
+from ..cw_controller import CWController
+# Class for /system/document/:id/download
+from . import document_download
+
+
+class DocumentDownloadAPI(CWController):
+    def __init__(self, parent, **kwargs):
+        self.module_url = 'system'
+        self.module = 'documents/{}/download'.format(parent)
+        self._class = document_download.DocumentDownload
+        super().__init__(**kwargs)  # instance gets passed to parent object
+
+    def download_document(self):
+        return super()._get_bytes()
+
+    def save_to_file(self, path=""):
+        document = self.download_document()
+        if path == "":
+            raise ValueError("A valid path is required to save the document.")
+        with open(path, 'wb') as f:
+            f.write(document.bytes.getvalue())
+        return True

setup.py

@@ -5,7 +5,7 @@
     long_description = f.read()
 
 setup(name='connectpyse',
-      version='0.7.3',
+      version='0.7.5',
       description='A ConnectWise API tool for the rest of us.',
       long_description=long_description,
       long_description_content_type="text/markdown",