Add Plex service to refresh a library (#39094)

* Add Plex service to refresh a library

* Clean up rebase leftovers

* Re-run black

* Fix docstring

Co-authored-by: Charles Garwood <cgarwood@newdealmultimedia.com>

Co-authored-by: Charles Garwood <cgarwood@newdealmultimedia.com>
This commit is contained in:
jjlawrenandCharles Garwood authored and GitHub committed 2020-09-02 13:56:41 -05:00
1 parent 97602a127a
commit cb1cf2238d
6 files changed
+195 -2

No files matched your search

@@ -43,6 +43,7 @@ from .const import (
)
from .errors import ShouldUpdateConfigEntry
from .server import PlexServer
from .services import async_setup_services
_LOGGER = logging.getLogger(__package__)
@@ -54,6 +55,8 @@ async def async_setup(hass, config):
{SERVERS: {}, DISPATCHERS: {}, WEBSOCKETS: {}, PLATFORMS_COMPLETED: {}},
)
await async_setup_services(hass)
return True
+1
View File
@@ -45,3 +45,4 @@ AUTOMATIC_SETUP_STRING = "Obtain a new token from plex.tv"
MANUAL_SETUP_STRING = "Configure Plex server manually"
SERVICE_PLAY_ON_SONOS = "play_on_sonos"
SERVICE_REFRESH_LIBRARY = "refresh_library"
+75
View File
@@ -0,0 +1,75 @@
"""Services for the Plex integration."""
import logging
from plexapi.exceptions import NotFound
import voluptuous as vol
from .const import DOMAIN, SERVERS, SERVICE_REFRESH_LIBRARY
REFRESH_LIBRARY_SCHEMA = vol.Schema(
{vol.Optional("server_name"): str, vol.Required("library_name"): str}
)
_LOGGER = logging.getLogger(__package__)
async def async_setup_services(hass):
"""Set up services for the Plex component."""
async def async_refresh_library_service(service_call):
await hass.async_add_executor_job(refresh_library, hass, service_call)
hass.services.async_register(
DOMAIN,
SERVICE_REFRESH_LIBRARY,
async_refresh_library_service,
schema=REFRESH_LIBRARY_SCHEMA,
)
return True
def refresh_library(hass, service_call):
"""Scan a Plex library for new and updated media."""
plex_server_name = service_call.data.get("server_name")
library_name = service_call.data.get("library_name")
plex_server = get_plex_server(hass, plex_server_name)
if not plex_server:
return
try:
library = plex_server.library.section(title=library_name)
except NotFound:
_LOGGER.error(
"Library with name '%s' not found in %s",
library_name,
list(map(lambda x: x.title, plex_server.library.sections())),
)
return
_LOGGER.info("Scanning %s for new and updated media", library_name)
library.update()
def get_plex_server(hass, plex_server_name=None):
"""Retrieve a configured Plex server by name."""
plex_servers = hass.data[DOMAIN][SERVERS].values()
if plex_server_name:
plex_server = [x for x in plex_servers if x.friendly_name == plex_server_name]
if not plex_server:
_LOGGER.error(
"Requested Plex server '%s' not found in %s",
plex_server_name,
list(map(lambda x: x.friendly_name, plex_servers)),
)
return None
elif len(plex_servers) == 1:
return next(iter(plex_servers))
_LOGGER.error(
"Multiple Plex servers configured and no selection made: %s",
list(map(lambda x: x.friendly_name, plex_servers)),
)
return None
@@ -11,3 +11,13 @@ play_on_sonos:
media_content_type:
description: The type of content to play. Must be "music".
example: "music"
refresh_library:
description: Refresh a Plex library to scan for new and updated media.
fields:
server_name:
description: Name of a Plex server if multiple Plex servers configured.
example: "My Plex Server"
library_name:
description: Name of the Plex library to refresh.
example: "TV Shows"