From 9b3193aace9a45a6aeff3c7810876bfa3fdddae6 Mon Sep 17 00:00:00 2001
From: Christian Holm <holm@podio.com>
Date: Mon, 1 Sep 2014 16:37:51 +0200
Subject: [PATCH] Support sharing link to a folder

---
 box/client.py        | 40 +++++++++++++++++++++++++++++++++++++++-
 tests/test_client.py | 26 ++++++++++++++++++++++++++
 2 files changed, 65 insertions(+), 1 deletion(-)

diff --git a/box/client.py b/box/client.py
index dd62c5a..56d926b 100644
--- a/box/client.py
+++ b/box/client.py
@@ -477,6 +477,37 @@ def get_folder_collaborations(self, folder_id):
         """
         return self._request("get", 'folders/{0}/collaborations'.format(folder_id)).json()
 
+    def share_link_to_folder(self, folder_id, access=ShareAccess.OPEN, expire_at=None, can_download=None, can_preview=None):
+        """
+        Creates a share link for the folder_id
+        Args:
+            - folder_id: the id of the folder we want to share
+            - access: one of the values of ShareAccess
+            - expire_at: (optional) a datetime representing the time the link will expire. Timestamps are rounded off
+              to the given day.
+            - can_download: Whether this link allows downloads. Can only be used with Open and Company
+            - can_preview: Whether this link allows previewing. Can only be used with Open and Company
+
+        Returns:
+            - a dictionary containing the various urls. Example:
+            {
+                "url": "https://www.box.com/s/rh935iit6ewrmw0unyul",
+                "download_url": "https://www.box.com/shared/static/rh935iit6ewrmw0unyul.jpeg",
+                "vanity_url": null,
+                "is_password_enabled": false,
+                "unshared_at": null,
+                "download_count": 0,
+                "preview_count": 0,
+                "access": "open",
+                "permissions": {
+                    "can_download": true,
+                    "can_preview": true
+                }
+            }
+        """
+
+        return self._share_link('folders/{0}'.format(folder_id), access=access, expire_at=expire_at, can_download=can_download, can_preview=can_preview)
+
     def get_file_metadata(self, file_id):
         """
         Fetches the metadata of the given file_id
@@ -715,6 +746,13 @@ def share_link(self, file_id, access=ShareAccess.OPEN, expire_at=None, can_downl
                 }
             }
         """
+
+        return self._share_link('files/{0}'.format(file_id), access=access, expire_at=expire_at, can_download=can_download, can_preview=can_preview)
+
+    def _share_link(self, path, access=ShareAccess.OPEN, expire_at=None, can_download=None, can_preview=None):
+        """
+        Creates a share link for the given path
+        """
         data = {
             'access': access
         }
@@ -729,7 +767,7 @@ def share_link(self, file_id, access=ShareAccess.OPEN, expire_at=None, can_downl
         if expire_at:
             data['unshared_at'] = expire_at.isoformat()
 
-        result = self._request("put", 'files/{0}'.format(file_id), data={'shared_link': data}).json()
+        result = self._request("put", path, data={'shared_link': data}).json()
         return result['shared_link']
 
     def get_events(self, stream_position='0', stream_type=EventFilter.ALL, limit=1000):
diff --git a/tests/test_client.py b/tests/test_client.py
index 47ea401..6c4f8af 100644
--- a/tests/test_client.py
+++ b/tests/test_client.py
@@ -914,6 +914,32 @@ def test_share_link(self):
                                  can_preview=False)
         self.assertEqual('http://www.foo.org/bla?x=y', link)
 
+    def test_share_link_to_folder(self):
+        # defaults
+        args = {
+            'access': 'open'
+        }
+
+        client = self.make_client("put", "folders/123", data={'shared_link': args}, result={'shared_link': 'http://www.foo.org/bla?x=y'})
+        link = client.share_link_to_folder(123)
+        self.assertEqual('http://www.foo.org/bla?x=y', link)
+
+        # with expiration time
+        args = {
+            'permissions': {
+                'can_preview': False,
+                'can_download': False,
+            },
+            'access': 'company',
+            'unshared_at': '2006-05-04T03:02:01+00:00'
+        }
+        client = self.make_client("put", "folders/123", data={'shared_link': args}, result={'shared_link': 'http://www.foo.org/bla?x=y'})
+        link = client.share_link_to_folder(123, access=ShareAccess.COMPANY,
+                                           expire_at=datetime(2006, 5, 4, 3, 2, 1, 0, tzinfo=UTC()),
+                                           can_download=False,
+                                           can_preview=False)
+        self.assertEqual('http://www.foo.org/bla?x=y', link)
+
     def test_get_events(self):
         # defaults
         args = {