Merge pull request #410 from pkkid/new_hubs

new_hubs

Author: blacktwin

plexapi/library.py

@@ -1001,6 +1001,7 @@ def _loadData(self, data):
         self.size = utils.cast(int, data.attrib.get('size'))
         self.title = data.attrib.get('title')
         self.type = data.attrib.get('type')
+        self.key = data.attrib.get('key')
         self.items = self.findItems(data)
 
     def __len__(self):

plexapi/myplex.py

@@ -1,18 +1,19 @@
 # -*- coding: utf-8 -*-
 import copy
-import requests
 import time
-from requests.status_codes import _codes as codes
-from plexapi import BASE_HEADERS, CONFIG, TIMEOUT, X_PLEX_IDENTIFIER, X_PLEX_ENABLE_FAST_CONNECT
-from plexapi import log, logfilter, utils
+
+import requests
+from plexapi import (BASE_HEADERS, CONFIG, TIMEOUT, X_PLEX_ENABLE_FAST_CONNECT,
+                     X_PLEX_IDENTIFIER, log, logfilter, utils)
 from plexapi.base import PlexObject
 from plexapi.exceptions import BadRequest, NotFound, Unauthorized
 from plexapi.client import PlexClient
 from plexapi.compat import ElementTree
 from plexapi.library import LibrarySection
 from plexapi.server import PlexServer
-from plexapi.sync import SyncList, SyncItem
+from plexapi.sync import SyncItem, SyncList
 from plexapi.utils import joinArgs
+from requests.status_codes import _codes as codes
 
 
 class MyPlexAccount(PlexObject):
@@ -73,6 +74,12 @@ class MyPlexAccount(PlexObject):
     REQUESTS = 'https://plex.tv/api/invites/requests'                                           # get
     SIGNIN = 'https://plex.tv/users/sign_in.xml'                                                # get with auth
     WEBHOOKS = 'https://plex.tv/api/v2/user/webhooks'                                           # get, post with data
+    # Hub sections
+    VOD = 'https://vod.provider.plex.tv/'                                                       # get
+    WEBSHOWS = 'https://webshows.provider.plex.tv/'                                             # get
+    NEWS = 'https://news.provider.plex.tv/'                                                     # get
+    PODCASTS = 'https://podcasts.provider.plex.tv/'                                             # get
+    MUSIC = 'https://music.provider.plex.tv/'                                                   # get
     # Key may someday switch to the following url. For now the current value works.
     # https://plex.tv/api/v2/user?X-Plex-Token={token}&X-Plex-Client-Identifier={clientId}
     key = 'https://plex.tv/users/account'
@@ -388,8 +395,8 @@ def updateFriend(self, user, server, sections=None, removeSections=False, allowS
             params = {'server_id': machineId, 'shared_server': {'library_section_ids': sectionIds}}
             url = self.FRIENDSERVERS.format(machineId=machineId, serverId=serverId)
         else:
-            params = {'server_id': machineId, 'shared_server': {'library_section_ids': sectionIds,
-                      'invited_id': user.id}}
+            params = {'server_id': machineId,
+                      'shared_server': {'library_section_ids': sectionIds, 'invited_id': user.id}}
             url = self.FRIENDINVITE.format(machineId=machineId)
         # Remove share sections, add shares to user without shares, or update shares
         if not user_servers or sectionIds:
@@ -433,7 +440,7 @@ def user(self, username):
                 return user
 
             elif (user.username and user.email and user.id and username.lower() in
-                 (user.username.lower(), user.email.lower(), str(user.id))):
+                  (user.username.lower(), user.email.lower(), str(user.id))):
                 return user
 
         raise NotFound('Unable to find user %s' % username)
@@ -617,6 +624,41 @@ def history(self, maxresults=9999999, mindate=None):
             hist.extend(conn.history(maxresults=maxresults, mindate=mindate, accountID=1))
         return hist
 
+    def videoOnDemand(self):
+        """ Returns a list of VOD Hub items :class:`~plexapi.library.Hub`
+        """
+        req = requests.get(self.VOD + 'hubs/', headers={'X-Plex-Token': self._token})
+        elem = ElementTree.fromstring(req.text)
+        return self.findItems(elem)
+
+    def webShows(self):
+        """ Returns a list of Webshow Hub items :class:`~plexapi.library.Hub`
+        """
+        req = requests.get(self.WEBSHOWS + 'hubs/', headers={'X-Plex-Token': self._token})
+        elem = ElementTree.fromstring(req.text)
+        return self.findItems(elem)
+
+    def news(self):
+        """ Returns a list of News Hub items :class:`~plexapi.library.Hub`
+        """
+        req = requests.get(self.NEWS + 'hubs/sections/all', headers={'X-Plex-Token': self._token})
+        elem = ElementTree.fromstring(req.text)
+        return self.findItems(elem)
+
+    def podcasts(self):
+        """ Returns a list of Podcasts Hub items :class:`~plexapi.library.Hub`
+        """
+        req = requests.get(self.PODCASTS + 'hubs/', headers={'X-Plex-Token': self._token})
+        elem = ElementTree.fromstring(req.text)
+        return self.findItems(elem)
+
+    def tidal(self):
+        """ Returns a list of tidal Hub items :class:`~plexapi.library.Hub`
+        """
+        req = requests.get(self.MUSIC + 'hubs/', headers={'X-Plex-Token': self._token})
+        elem = ElementTree.fromstring(req.text)
+        return self.findItems(elem)
+
 
 class MyPlexUser(PlexObject):
     """ This object represents non-signed in users such as friends and linked

plexapi/video.py

@@ -352,7 +352,7 @@ def download(self, savepath=None, keep_original_name=False, **kwargs):
             else:
                 self._server.url('%s?download=1' % location.key)
             filepath = utils.download(url, self._server._token, filename=name,
-                savepath=savepath, session=self._server._session)
+                                      savepath=savepath, session=self._server._session)
             if filepath:
                 filepaths.append(filepath)
         return filepaths
@@ -722,3 +722,28 @@ def show(self):
     def _defaultSyncTitle(self):
         """ Returns str, default title for a new syncItem. """
         return '%s - %s - (%s) %s' % (self.grandparentTitle, self.parentTitle, self.seasonEpisode, self.title)
+
+
+@utils.registerPlexObject
+class Clip(Playable, Video):
+    """ Represents a single Clip."""
+
+    TAG = 'Video'
+    TYPE = 'clip'
+    METADATA_TYPE = 'clip'
+
+    def _loadData(self, data):
+        self._data = data
+        self.addedAt = data.attrib.get('addedAt')
+        self.duration = data.attrib.get('duration')
+        self.guid = data.attrib.get('guid')
+        self.key = data.attrib.get('key')
+        self.originallyAvailableAt = data.attrib.get('originallyAvailableAt')
+        self.ratingKey = data.attrib.get('ratingKey')
+        self.skipDetails = utils.cast(int, data.attrib.get('skipDetails'))
+        self.subtype = data.attrib.get('subtype')
+        self.thumb = data.attrib.get('thumb')
+        self.thumbAspectRatio = data.attrib.get('thumbAspectRatio')
+        self.title = data.attrib.get('title')
+        self.type = data.attrib.get('type')
+        self.year = data.attrib.get('year')