Coverage for custom_components/supernotify/transports/media_player.py: 100%

1import logging 

2import urllib.parse 

3from typing import TYPE_CHECKING, Any 

4 

5from homeassistant.const import ( 

6 ATTR_ENTITY_ID, 

7) 

8 

9from custom_components.supernotify.const import ( 

10 ATTR_MEDIA, 

11 ATTR_MEDIA_SNAPSHOT_URL, 

12 OPTION_TARGET_CATEGORIES, 

13 OPTION_TARGET_SELECT, 

14 TRANSPORT_MEDIA, 

15) 

16from custom_components.supernotify.model import DebugTrace, TransportConfig, TransportFeature 

17from custom_components.supernotify.transport import Transport 

18 

19if TYPE_CHECKING: 

20 from custom_components.supernotify.envelope import Envelope 

21 

22RE_VALID_MEDIA_PLAYER = r"media_player\.[A-Za-z0-9_]+" 

23 

24_LOGGER = logging.getLogger(__name__) 

25 

26 

27class MediaPlayerTransport(Transport): 

28 name = TRANSPORT_MEDIA 

29 

30 def __init__(self, *args: Any, **kwargs: Any) -> None: 

31 super().__init__(*args, **kwargs) 

32 

33 @property 

34 def supported_features(self) -> TransportFeature: 

35 return TransportFeature.IMAGES | TransportFeature.VIDEO 

36 

37 @property 

38 def default_config(self) -> TransportConfig: 

39 config = TransportConfig() 

40 config.delivery_defaults.action = "media_player.play_media" 

41 config.delivery_defaults.options = { 

42 OPTION_TARGET_SELECT: [RE_VALID_MEDIA_PLAYER], 

43 OPTION_TARGET_CATEGORIES: [ATTR_ENTITY_ID], 

44 } 

45 return config 

46 

47 async def deliver(self, envelope: Envelope, debug_trace: DebugTrace | None = None) -> bool: # noqa: ARG002 

48 _LOGGER.debug("SUPERNOTIFY notify_media: %s", envelope.data) 

49 

50 data: dict[str, Any] = envelope.data or {} 

51 media_players: list[str] = envelope.target.entity_ids or [] 

52 media_type: str = data.get("media_content_type", "image") 

53 if not media_players: 

54 _LOGGER.debug("SUPERNOTIFY skipping media show, no targets") 

55 return False 

56 

57 snapshot_url = data.get(ATTR_MEDIA, {}).get(ATTR_MEDIA_SNAPSHOT_URL) 

58 if snapshot_url is None: 

59 # fallback to older idiosyncratic way for backward compatibility 

60 snapshot_url = data.get(ATTR_MEDIA_SNAPSHOT_URL) 

61 if snapshot_url is None: 

62 _LOGGER.debug("SUPERNOTIFY skipping media player, no snapshot url") 

63 return False 

64 # absolutize relative URL for external URl, probably preferred by Alexa Show etc 

65 snapshot_url = urllib.parse.urljoin(self.hass_api.external_url, snapshot_url) 

66 

67 action_data: dict[str, Any] = {"media": {"media_content_id": snapshot_url, "media_content_type": media_type}} 

68 if data and data.get("announce"): 

69 action_data["announce"] = data.get("announce") 

70 if data and data.get("enqueue"): 

71 action_data["enqueue"] = data.get("enqueue") 

72 

73 return await self.call_action(envelope, action_data=action_data, target_data={ATTR_ENTITY_ID: media_players})