caronc / apprise

Apprise - Push Notifications that work with just about every platform!
https://hub.docker.com/r/caronc/apprise
BSD 2-Clause "Simplified" License
10.9k stars 384 forks source link

WxPusher Support Added #1135

Open caronc opened 1 month ago

caronc commented 1 month ago

Description:

Related issue (if applicable): #1133

Added WxPusher

Account Setup

  1. Create an account with WxPusher.
  2. Acquire your App Token from your profile
    appToken
    Note: The above image was taken from WxPusher's Help Page

Targets can be either a User (UID_DATA) or a Topic (<integer>). i.e:

Syntax

Valid syntax is as follows:

You can also mix/match topic's and user ids:

Parameter Breakdown

Variable Required Description
app_token Yes The App Token associated with your WxPusher account. It always starts with AT_

New Service Completion Status

Checklist

Testing

Anyone can help test this source code as follows:

# Create a virtual environment to work in as follows:
python3 -m venv apprise

# Change into our new directory
cd apprise

# Activate our virtual environment
source bin/activate

# Install the branch
pip install git+https://github.com/caronc/apprise.git@1133-wxpusher-support

# Test out the changes with the following command:
apprise -t "Test Title" -b "Test Message" \
 "wxpusher://apptoken/targets"

Here is an example of notifying a topic:

# Assuming our {app_key} is AT_12345
# Assuming our {topic} is 987
apprise -vv -t "Test Message Title" -b "Test Message Body" -n failure  \
   wxpusher://AT_12345/987

Here is an example of notifying a user:

# Assuming our {app_key} is AT_12345
# Assuming our {user} is UID_123
apprise -vv -t "Test Message Title" -b "Test Message Body" -n failure  \
   wxpusher://AT_12345/UID_123

We can notify a variety of users/topics by just specifying htem on the path:

# Assuming our {app_key} is AT_12345
# Assuming our {user} is UID_123 and UID_456
# Assuming our {topic} is 5555 and 4444
apprise -vv -t "Test Message Title" -b "Test Message Body" -n failure  \
   wxpusher://AT_12345/UID_123/5555/4444/UID_456
codecov-commenter commented 1 month ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 99.29%. Comparing base (6733953) to head (254bbc5). Report is 1 commits behind head on master.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #1135 +/- ## ======================================= Coverage 99.28% 99.29% ======================================= Files 142 143 +1 Lines 18440 18536 +96 Branches 3763 3778 +15 ======================================= + Hits 18309 18405 +96 Misses 121 121 Partials 10 10 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

caronc commented 4 hours ago

I made another change to completely drop https and swap it for http. I'm running out of things to test right now as i'm still 100% confident the payload is correct.

This format now matches that of what is posted in their own plugin they have on github here