Merge branch 'pr/366'

Author: Hellowlol

plexapi/library.py

@@ -386,7 +386,7 @@ def all(self, sort=None, **kwargs):
         sortStr = ''
         if sort is not None:
             sortStr = '?sort=' + sort
-        
+
         key = '/library/sections/%s/all%s' % (self.key, sortStr)
         return self.fetchItems(key, **kwargs)
 
@@ -994,6 +994,8 @@ def _loadData(self, data):
         self.childCount = utils.cast(int, data.attrib.get('childCount'))
         self.minYear = utils.cast(int, data.attrib.get('minYear'))
         self.maxYear = utils.cast(int, data.attrib.get('maxYear'))
+        self.collectionMode = data.attrib.get('collectionMode')
+        self.collectionSort = data.attrib.get('collectionSort')
 
     @property
     def children(self):
@@ -1006,5 +1008,48 @@ def delete(self):
         part = '/library/metadata/%s' % self.ratingKey
         return self._server.query(part, method=self._server._session.delete)
 
+    def modeUpdate(self, mode=None):
+        """ Update Collection Mode
+
+            Parameters:
+                mode: default     (Library default)
+                      hide        (Hide Collection)
+                      hideItems   (Hide Items in this Collection)
+                      showItems   (Show this Collection and its Items)
+            Example:
+
+                collection = 'plexapi.library.Collections'
+                collection.updateMode(mode="hide")
+        """
+        mode_dict = {'default': '-2',
+                     'hide': '0',
+                     'hideItems': '1',
+                     'showItems': '2'}
+        key = mode_dict.get(mode)
+        if key is None:
+            raise BadRequest('Unknown collection mode : %s. Options %s' % (mode, list(mode_dict)))
+        part = '/library/metadata/%s/prefs?collectionMode=%s' % (self.ratingKey, key)
+        return self._server.query(part, method=self._server._session.put)
+
+    def sortUpdate(self, sort=None):
+        """ Update Collection Sorting
+
+            Parameters:
+                sort: realease     (Order Collection by realease dates)
+                      alpha        (Order Collection Alphabetically)
+
+            Example:
+
+                colleciton = 'plexapi.library.Collections'
+                collection.updateSort(mode="alpha")
+        """
+        sort_dict = {'release': '0',
+                     'alpha': '1'}
+        key = sort_dict.get(sort)
+        if key is None:
+            raise BadRequest('Unknown sort dir: %s. Options: %s' % (sort, list(sort_dict)))
+        part = '/library/metadata/%s/prefs?collectionSort=%s' % (self.ratingKey, key)
+        return self._server.query(part, method=self._server._session.put)
+
     # def edit(self, **kwargs):
     #    TODO

tests/conftest.py

@@ -187,6 +187,11 @@ def movie(movies):
     return movies.get('Elephants Dream')
 
 
+@pytest.fixture()
+def collection(plex):
+    return plex.library.section('Movies').collection()[0]
+
+
 @pytest.fixture()
 def artist(music):
     return music.get('Infinite State')

tests/test_library.py

@@ -201,6 +201,41 @@ def test_library_and_section_search_for_movie(plex):
     assert l_search == s_search
 
 
+def test_library_Colletion_modeUpdate_hide(collection):
+    collection.modeUpdate(mode='hide')
+    collection.reload()
+    assert collection.collectionMode == '0'
+
+
+def test_library_Colletion_modeUpdate_default(collection):
+    collection.modeUpdate(mode='default')
+    collection.reload()
+    assert collection.collectionMode == '-2'
+
+
+def test_library_Colletion_modeUpdate_hideItems(collection):
+    collection.modeUpdate(mode='hideItems')
+    collection.reload()
+    assert collection.collectionMode == '1'
+
+
+def test_library_Colletion_modeUpdate_showItems(collection):
+    collection.modeUpdate(mode='showItems')
+    collection.reload()
+    assert collection.collectionMode == '2'
+
+
+def test_library_Colletion_sortAlpha(collection):
+    collection.sortUpdate(sort='alpha')
+    collection.reload()
+    assert collection.collectionSort == '1'
+
+
+def test_library_Colletion_sortRelease(collection):
+    collection.sortUpdate(sort='release')
+    collection.reload()
+    assert collection.collectionSort == '0'
+
 # This started failing on more recent Plex Server builds
 @pytest.mark.xfail
 def test_search_with_apostrophe(plex):