Updating code to support endpoints per reigon and __global__

base-config.yaml

@@ -2,12 +2,9 @@
 # DO NOT CHANGE THIS UNLESS YOU KNOW WHAT YOU ARE DOING
 command_prefix: report
 
-# Which regions the bot should pay attention to.
+# Which reigons the bot should pay attention to
-# Pass through empty list to allow all senders for a region.
+# Additionally, optionally whitelist specific accounts for each reigon
-# Add a list of MatrixIDs to whitelist senders for a region.
+allowed_reigons:
-# Use __global__ to refer to all regions.
-# Code looks to see if a sender is allowed for either a specific region or __global__.
-allowed_regions:
     foo:
         - "@reports:fiftyfiftyonerarizona.org"
     bar:
@@ -16,22 +13,18 @@ allowed_regions:
     buzz:
     aaa:
 
-# Bot-specific configurations per region
+# Bot-specific configurations per reigon
-# Code will assume no authentication if either username or password are missing.
+reigon_configs:
-# Use __global__ to specify an endpoint for all regions.
-# Code will push to both __global__ and region-specific endpoint.
-region_configs:
     arizona:
         # Where and how the plugin will send the data to
         server_url: "https://ntfy.sh"
         server_topic: "changeme"
 
         # If the plugin should use a username and password to send notifications
-        username: "no"
+        server_use_authentication: true
-        password: "way"
+        server_username: "no"
+        server_password: "way"
 
 # If this bot should send a reaction to the message
-# Will send 👍 on successful POST to NTFY, and 👎 on failiure.
+# if the notification was successful
-# Failiure to post to either the region specific, or __global__ endpoint is
-# considered complete failiure.
 send_reaction: true

compile.bash

@@ -1,9 +0,0 @@
-#!/bin/bash
-
-# Get filename
-id=$(cat maubot.yaml | grep "id:" | tr ' ' '\n' | tail -n1)
-version=$(cat maubot.yaml | grep "version:" | tr ' ' '\n' | tail -n1)
-filename="$id-$version.mbp"
-
-# Compress to zip
-zip $filename *

consumerntfy.py

@@ -11,8 +11,8 @@ import aiohttp
 class Config(BaseProxyConfig):
 	def do_update(self, helper: ConfigUpdateHelper) -> None:
 		helper.copy("command_prefix")
-		helper.copy("allowed_regions")
+		helper.copy("allowed_reigons")
-		helper.copy("region_configs")
+		helper.copy("reigon_configs")
 		helper.copy("send_reaction")
 
 class ConsumerNTFY(Plugin):
@@ -29,45 +29,40 @@ class ConsumerNTFY(Plugin):
 	def get_command_name(self) -> str:
 		return self.config["command_prefix"]
 	
-	# Checks if a sender if allowed to send for a particular region
+	# Checks if a sender if allowed to send for a particular reigon
-	def validate_sender(self, region: str, sender: str):
+	def validateSender(self, reigon: str, sender: str):
-		# Mautrix isn't documented, like at all, so I'm just gonna catch the
+		# Check that config value exists
-		# error because IDK how to see if a map is inside a map.
+		if not self.config["allowed_reigons"]: return False
-		try: allowed_list = self.config["allowed_regions"][region]
+		# Check that reigon is allowed
-		except: return False
+		if not self.config["allowed_reigons"][reigon]: return False
-		
+		# All senders allowed for this reigon
-		if allowed_list is None: return True # Empty list
+		if len(self.config["allowed_reigons"][reigon]) == 0: return True
-		if sender in allowed_list: return True
+		# Check that sender is allowed for reigon
-		
+		if not sender in self.config["allowed_reigons"][reigon]: return False
-		# Sender not allowed in region config
+		return True
-		return False
 	
-	# Does the necessary config checks for the given event
+	# Does the necesary config checks for the given event
-	# Returns list of recursive configs to process
+	# Returns list of reigons to process (strings)
-	def validate_report(self, evt: MessageEvent, message: str):
+	# Currently just the specified reigon and "__global__"
+	def validateReport(self, evt: MessageEvent, message: str):
 		# Split command (minus !command_name) into tokens
 		tokens = message.split()
-		region = tokens[0].lower()
+		reigon = tokens[0].lower()
 		
 		# Each command must have a state/territory designation and a message
-		if len(tokens) < 2: return []
+		if len(tokens) < 2: return None
-		# And we must have self.config["region_configs"]
-		try: trashvariable = self.config["region_configs"]
-		except: return []
 		
-		configs = [] # To be returned
+		self.log.debug(reigon)
 		
-		allowed_globally = self.validate_sender("__global__", evt.sender)
+		# This is a list of reigons to process for this specific message
-		allowed_region = self.validate_sender(region, evt.sender)
+		# This is only used to consider __global__
+		reigons_to_process = []
+		if (self.validateSender("__global__", evt.sender)):
+			reigons_to_process.append("__global__")
+		if (self.validateSender(reigon, evt.sender)):
+			reigons_to_process.append(reigon)
 		
-		# If user is allowed globally and/or for a region,
+		return reigons_to_process
-		# the plugin should process both the region and __global__ configs
-		if allowed_globally or allowed_region:
-			for i in ["__global__", region]:
-				try: configs.append(self.config["region_configs"][i])
-				except: trashvariable = None
-		
-		return configs
 	
 	# What gets called when !command_name message is sent
 	@command.new(name=get_command_name, help="Report Something")
@@ -78,26 +73,27 @@ class ConsumerNTFY(Plugin):
 		
 		# Iterate through each endpoint that the message should be pushed to
 		# (if any)
-		for region_config in self.validate_report(evt, message):
+		for reigon in self.validateReport(evt, message):
-			# Detect no regions in reaction
+			# Detect no reigons in reaction
 			if ntfy_posts_passed is None: ntfy_posts_passed = True
 			
-			self.log.debug(region_config)
+			# Grab reigon-specific conrfig
+			reigon_config = self.config["reigon_configs"][reigon]
 			
 			# Create notification text
 			split_message = message.split()
 			text = "[" + split_message[0] + "] " + ' '.join(message.split()[1:])
 			
 			# Build URL
-			url = region_config["server_url"] + "/" + region_config["server_topic"]
+			url = reigon_config["server_url"] + "/" + reigon_config["server_topic"]
 			
 			# Consider authentication
-			auth = None
+			authentication = None
-			if "username" in region_config and "password" in region_config:
+			if reigon_config["server_use_authentication"]:
-				auth = aiohttp.BasicAuth(region_config["username"], region_config["password"])
+				authentication = aiohttp.BasicAuth(reigon_config["server_username"], reigon_config["server_password"])
 			
 			# Send notification
-			async with self.http.post(url, data=text, auth=auth) as response:
+			async with self.http.post(url, data=text, auth=authentication) as response:
 				if not response.status == 200:
 					ntfy_posts_passed = False
 		

maubot.yaml

@@ -1,6 +1,6 @@
 maubot: 0.1.0
 id: org.fiftyfiftyonearizona.reports.consumerntfy
-version: 1.2.0
+version: 1.1.0
 license: MIT
 modules:
   - consumerntfy

readme.md

@@ -2,12 +2,4 @@
 
 Please see https://git.fiftyfiftyonearizona.org/webmaster/matrix-report-documentation
 
-This plugin supports the following:
+This plugin supports whitelisting state/territory designators, allowed senders, reaction receipt, and authenticated NTFY posting.
-
-* whitelisting regions, or allowing all regions.
-* allowed senders per region, or all regions.
-* reaction receipt upon successful POST to NTFY.
-* authenticated NTFY POSTing.
-* Different NTFY endpoint, topic, and authentication per region.
-
-Please see [base-config.yaml](base-config.yaml) for explanation of behavior.