Skip to content

Add attachments to simplepush #81033

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
emontnemery merged 6 commits into from
Mar 31, 2023
Merged

Add attachments to simplepush #81033

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
40231ba
Add attachments
tymm Oct 17, 2022
2848e76
Fix looking for attachment keywords in values
tymm Dec 28, 2022
f8283f3
Improve attachment input format
tymm Dec 28, 2022
4387c8d
Implement better approach to attachment parsing
tymm Jan 6, 2023
fd99749
Make ruff happy
tymm Mar 18, 2023
2af97eb
Adjust attachment format and implementation according to comment from…
tymm Mar 30, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions homeassistant/components/simplepush/const.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
DEFAULT_NAME: Final = "simplepush"
DATA_HASS_CONFIG: Final = "simplepush_hass_config"

ATTR_ATTACHMENTS: Final = "attachments"
ATTR_ENCRYPTED: Final = "encrypted"
ATTR_EVENT: Final = "event"

Expand Down
25 changes: 23 additions & 2 deletions homeassistant/components/simplepush/notify.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
from homeassistant.helpers.issue_registry import IssueSeverity, async_create_issue
from homeassistant.helpers.typing import ConfigType, DiscoveryInfoType

from .const import ATTR_EVENT, CONF_DEVICE_KEY, CONF_SALT, DOMAIN
from .const import ATTR_ATTACHMENTS, ATTR_EVENT, CONF_DEVICE_KEY, CONF_SALT, DOMAIN

# Configuring Simplepush under the notify has been removed in 2022.9.0
PLATFORM_SCHEMA = BASE_PLATFORM_SCHEMA
Expand Down Expand Up @@ -61,11 +61,25 @@ def send_message(self, message: str, **kwargs: Any) -> None:
"""Send a message to a Simplepush user."""
title = kwargs.get(ATTR_TITLE, ATTR_TITLE_DEFAULT)

attachments = None
# event can now be passed in the service data
event = None
if data := kwargs.get(ATTR_DATA):
event = data.get(ATTR_EVENT)

attachments_data = data.get(ATTR_ATTACHMENTS)
if isinstance(attachments_data, list):
for attachment in attachments_data:
if not (
isinstance(attachment, dict)
and "video" in attachment
and "thumbnail" in attachment
) and not isinstance(attachment, str):
_LOGGER.error("Attachment format is incorrect")
return

attachments = attachments_data

Comment on lines +70 to +91

@engrbm87 engrbm87 Jan 6, 2023

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A better approach would be to raise an error if the attachments key values are not as per the documentation. If no errors are raised then simply use attachments=attachments_data.
for lines 85 and 86 I believe a video key should only be provided with a thumbnail. The documentation should mentions this clearly so no need to check for a video only key in the attachments.

@tymm tymm Jan 6, 2023

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, makes a lot of sense.

Please see my latest commit for the implementation of your comment.

# use event from config until YAML config is removed
event = event or self._event

Expand All @@ -77,10 +91,17 @@ def send_message(self, message: str, **kwargs: Any) -> None:
salt=self._salt,
title=title,
message=message,
attachments=attachments,
event=event,
)
else:
send(key=self._device_key, title=title, message=message, event=event)
send(
key=self._device_key,
title=title,
message=message,
attachments=attachments,
event=event,
)

except BadRequest:
_LOGGER.error("Bad request. Title or message are too long")
Expand Down