Add attachments to simplepush by tymm · Pull Request #81033 · home-assistant/core

tymm · 2022-10-26T15:07:47Z

Breaking change

Proposed change

This PR adds attachments for the Simplepush component.
Attachments can be pictures, GIFs or video files defined by an URL.

I will update the documentation (https://www.home-assistant.io/integrations/simplepush/), after this PR gets merged. If preferred I can also do it beforehand.

The new functionality can be tested with the following automation:

alias: Test
description: >-
  Send a notification with two attachments
trigger: []
condition: []
action:
  - service: notify.simplepush
    data:
      message: test
      data:
        attachments:
          - image: https://upload.wikimedia.org/wikipedia/commons/e/ee/Sample_abc.jpg
          - video: http://commondatastorage.googleapis.com/gtv-videos-bucket/sample/ElephantsDream.mp4
            thumbnail: http://commondatastorage.googleapis.com/gtv-videos-bucket/sample/images/ForBiggerEscapes.jpg
mode: restart

Type of change

Dependency upgrade
Bugfix (non-breaking change which fixes an issue)
New integration (thank you!)
New feature (which adds functionality to an existing integration)
Deprecation (breaking change to happen in the future)
Breaking change (fix/feature causing existing functionality to break)
Code quality improvements to existing code or addition of tests

Additional information

This PR fixes or closes issue: fixes #
This PR is related to issue: Add action callbacks to simplepush #80744
Link to documentation pull request:

Checklist

The code change is tested and works locally.
Local tests pass. Your PR cannot be merged unless tests pass
There is no commented out code in this PR.
I have followed the development checklist
The code has been formatted using Black (black --fast homeassistant tests)
Tests have been added to verify that the new code works.

If user exposed functionality or configuration variables are added/changed:

Documentation added/updated for www.home-assistant.io

If the code communicates with devices, web services, or third-party tools:

The manifest file has all fields filled out correctly.
Updated and included derived files by running: python3 -m script.hassfest.
New or updated dependencies have been added to requirements_all.txt.
Updated by running python3 -m script.gen_requirements_all.
For the updated dependencies - a link to the changelog, or at minimum a diff between library versions is added to the PR description.
Untested files have been added to .coveragerc.

To help with the load of incoming pull requests:

I have reviewed two other open pull requests in this repository.

home-assistant · 2022-10-26T15:07:53Z

Hey there @engrbm87, mind taking a look at this pull request as it has been labeled with an integration (simplepush) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of simplepush can trigger bot actions by commenting:

@home-assistant close Closes the issue.
@home-assistant rename Awesome new title Change the title of the issue.
@home-assistant unassign simplepush Removes the current integration label and assignees on the issue, add the integration domain after the command.

engrbm87 · 2022-12-28T12:44:39Z

+            attachments_data = data.get(ATTR_ATTACHMENTS)
+            if isinstance(attachments_data, list) and attachments_data:
+                attachments = []
+                for attachment in attachments_data:
+                    if "attachment" in attachment and "thumbnail" in attachment:
+                        attachments.append(
+                            {
+                                "video": attachment["attachment"],
+                                "thumbnail": attachment["thumbnail"],
+                            }
+                        )
+                    elif "attachment" in attachment:
+                        attachments.append(attachment["attachment"])


Can't we have the user mention "video" and "thumbnail" instead of "attachment" and "thumbnail" when adding a video under "attachments"? This way you can directly use the "attachments" key.
If I am not mistaken the "attachments" key entered by the user would be like this:

attachments: - https://upload.wikimedia.org/wikipedia/commons/e/ee/Sample_abc.jpg - video: http://commondatastorage.googleapis.com/gtv-videos-bucket/sample/ElephantsDream.mp4 thumbnail: http://commondatastorage.googleapis.com/gtv-videos-bucket/sample/images/ForBiggerEscapes.jpg

@engrbm87, thanks a lot for your review!

Your suggestion makes a lot of sense to me.

@engrbm87 I implemented your suggestion in commit 9bc18c3.

Added a comment based on the last commit

engrbm87 · 2023-01-06T08:42:49Z

+            attachments_data = data.get(ATTR_ATTACHMENTS)
+            if isinstance(attachments_data, list) and attachments_data:
+                attachments = []
+                for attachment in attachments_data:
+                    if (
+                        isinstance(attachment, dict)
+                        and "video" in attachment.keys()
+                        and "thumbnail" in attachment.keys()
+                    ):
+                        attachments.append(
+                            {
+                                "video": attachment["video"],
+                                "thumbnail": attachment["thumbnail"],
+                            }
+                        )
+                    elif isinstance(attachment, dict) and "video" in attachment.keys():
+                        attachments.append(attachment["video"])
+                    else:
+                        attachments.append(attachment)
+


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.

Thanks, makes a lot of sense.

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

emontnemery

Instead of supporting attachments which are either strings or dicts:

        attachments:
          - https://upload.wikimedia.org/wikipedia/commons/e/ee/Sample_abc.jpg
          - video: http://commondatastorage.googleapis.com/gtv-videos-bucket/sample/ElephantsDream.mp4
            thumbnail: http://commondatastorage.googleapis.com/gtv-videos-bucket/sample/images/ForBiggerEscapes.jpg

Just make them dicts always:

        attachments:
          - image: https://upload.wikimedia.org/wikipedia/commons/e/ee/Sample_abc.jpg
          - video: http://commondatastorage.googleapis.com/gtv-videos-bucket/sample/ElephantsDream.mp4
            thumbnail: http://commondatastorage.googleapis.com/gtv-videos-bucket/sample/images/ForBiggerEscapes.jpg

This will simplify the Python implementation and IMHO is also clearer for the user.

home-assistant · 2023-03-30T09:35:11Z

Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍

Learn more about our pull request process.

… emontnemery

emontnemery

LGTM, can be merged when a documentation PR has been opened

tymm · 2023-03-31T12:04:13Z

LGTM, can be merged when a documentation PR has been opened

Thank you for your review!

Here is a link to the documentation PR: home-assistant/home-assistant.io#26813

home-assistant Bot added cla-signed Hacktoberfest integration: simplepush new-feature small-pr PRs with less than 30 lines. Quality Scale: No score labels Oct 26, 2022

tymm mentioned this pull request Oct 26, 2022

Add action callbacks to simplepush #80744

Closed

19 tasks

frenck added the hacktoberfest-accepted label Oct 30, 2022

frenck added the smash Indicator this PR is close to finish for merging or closing label Dec 20, 2022

engrbm87 reviewed Dec 28, 2022

View reviewed changes

engrbm87 reviewed Jan 6, 2023

View reviewed changes

tymm added 4 commits March 15, 2023 22:45

Add attachments

40231ba

Fix looking for attachment keywords in values

2848e76

Improve attachment input format

f8283f3

Implement better approach to attachment parsing

4387c8d

tymm force-pushed the add-simplepush-attachments branch from d753f4e to 4387c8d Compare March 15, 2023 21:45

Make ruff happy

fd99749

emontnemery added the docs-missing label Mar 30, 2023

emontnemery requested changes Mar 30, 2023

View reviewed changes

home-assistant Bot marked this pull request as draft March 30, 2023 09:35

Adjust attachment format and implementation according to comment from…

2af97eb

… emontnemery

tymm marked this pull request as ready for review March 30, 2023 14:49

home-assistant Bot requested a review from emontnemery March 30, 2023 14:49

emontnemery approved these changes Mar 31, 2023

View reviewed changes

This was referenced Mar 31, 2023

Add attachments to Simplepush documentation home-assistant/home-assistant.io#26812

Closed

Add attachment documentation for Simplepush home-assistant/home-assistant.io#26813

Merged

emontnemery removed the docs-missing label Mar 31, 2023

emontnemery merged commit 2e26b6e into home-assistant:dev Mar 31, 2023

github-actions Bot locked and limited conversation to collaborators Apr 1, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Add attachments to simplepush#81033

Add attachments to simplepush#81033
emontnemery merged 6 commits into
home-assistant:devfrom
tymm:add-simplepush-attachments

tymm commented Oct 26, 2022 •

edited

Loading

Uh oh!

home-assistant Bot commented Oct 26, 2022

Uh oh!

engrbm87 Dec 28, 2022

Uh oh!

tymm Dec 28, 2022

Uh oh!

tymm Dec 28, 2022

Uh oh!

engrbm87 Jan 6, 2023

Uh oh!

engrbm87 Jan 6, 2023

Uh oh!

tymm Jan 6, 2023

Uh oh!

emontnemery left a comment

Uh oh!

home-assistant Bot commented Mar 30, 2023

Uh oh!

emontnemery left a comment

Uh oh!

tymm commented Mar 31, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Uh oh!

Conversation

tymm commented Oct 26, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Breaking change

Proposed change

Type of change

Additional information

Checklist

Uh oh!

home-assistant Bot commented Oct 26, 2022

Uh oh!

engrbm87 Dec 28, 2022

Choose a reason for hiding this comment

Uh oh!

tymm Dec 28, 2022

Choose a reason for hiding this comment

Uh oh!

tymm Dec 28, 2022

Choose a reason for hiding this comment

Uh oh!

engrbm87 Jan 6, 2023

Choose a reason for hiding this comment

Uh oh!

engrbm87 Jan 6, 2023

Choose a reason for hiding this comment

Uh oh!

tymm Jan 6, 2023

Choose a reason for hiding this comment

Uh oh!

emontnemery left a comment

Choose a reason for hiding this comment

Uh oh!

home-assistant Bot commented Mar 30, 2023

Uh oh!

emontnemery left a comment

Choose a reason for hiding this comment

Uh oh!

tymm commented Mar 31, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

tymm commented Oct 26, 2022 •

edited

Loading