Merge branch 'master' of github.com:custom-components/authenticated

Author: ludeeus

.github/workflows/release.yaml

@@ -0,0 +1,65 @@
+# This GitHub action workflow is meant to be copyable to any repo that have the same structure.
+# - Your integration exist under custom_components/{INTEGRATION_NAME}/[integration files]
+# - You are using GitHub releases to publish new versions
+# - You have a INTEGRATION_VERSION constant in custom_components/{INTEGRATION_NAME}/const.py
+
+name: Release Workflow
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  release:
+    name: Release
+    runs-on: ubuntu-latest
+    steps:
+      - name: 📥 Checkout the repository
+        uses: actions/checkout@v2
+
+      - name: 🔢 Get release version
+        id: version
+        uses: home-assistant/actions/helpers/version@master
+
+      - name: ℹ️ Get integration information
+        id: information
+        run: |
+          name=$(find custom_components/ -type d -maxdepth 1 | tail -n 1 | cut -d "/" -f2)
+          echo "::set-output name=name::$name"
+      
+      - name: 🖊️ Set version number
+        run: |
+          sed -i '/INTEGRATION_VERSION = /c\INTEGRATION_VERSION = "${{ steps.version.outputs.version }}"' \
+            "${{ github.workspace }}/custom_components/${{ steps.information.outputs.name }}/const.py"
+          jq '.version = "${{ steps.version.outputs.version }}"' \
+            "${{ github.workspace }}/custom_components/${{ steps.information.outputs.name }}/manifest.json" > tmp \
+            && mv -f tmp "${{ github.workspace }}/custom_components/${{ steps.information.outputs.name }}/manifest.json"
+      
+      - name: 👀 Validate data
+        run: |
+          if ! grep -q 'INTEGRATION_VERSION = "${{ steps.version.outputs.version }}"' ${{ github.workspace }}/custom_components/${{ steps.information.outputs.name }}/const.py; then
+            echo "The version in custom_components/${{ steps.information.outputs.name }}/const.py was not correct"
+            cat ${{ github.workspace }}/custom_components/${{ steps.information.outputs.name }}/const.py | grep INTEGRATION_VERSION
+            exit 1
+          fi
+          manifestversion=$(jq -r '.version' ${{ github.workspace }}/custom_components/${{ steps.information.outputs.name }}/manifest.json)
+          if [ "$manifestversion" != "${{ steps.version.outputs.version }}" ]; then
+            echo "The version in custom_components/${{ steps.information.outputs.name }}/manifest.json was not correct"
+            echo "$manifestversion"
+            exit 1
+          fi
+      
+      - name: 📦 Create zip file for the integration
+        run: |
+          cd "${{ github.workspace }}/custom_components/${{ steps.information.outputs.name }}"
+          zip ${{ steps.information.outputs.name }}.zip -r ./
+      
+      - name: 📤 Upload the zip file as a release asset
+        uses: actions/upload-release-asset@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          upload_url: ${{ github.event.release.upload_url }}
+          asset_path: "${{ github.workspace }}/custom_components/${{ steps.information.outputs.name }}/${{ steps.information.outputs.name }}.zip"
+          asset_name: ${{ steps.information.outputs.name }}.zip
+          asset_content_type: application/zip

custom_components/authenticated/const.py

@@ -0,0 +1,24 @@
+"""Constants for authenticated."""
+
+DOMAIN = "authenticated"
+INTEGRATION_VERSION = "main"
+ISSUE_URL = "https://github.com/custom-components/authenticated/issues"
+
+STARTUP = f"""
+-------------------------------------------------------------------
+{DOMAIN}
+Version: {INTEGRATION_VERSION}
+This is a custom component
+If you have any issues with this you need to open an issue here:
+https://github.com/custom-components/authenticated/issues
+-------------------------------------------------------------------
+"""
+
+
+CONF_NOTIFY = "enable_notification"
+CONF_EXCLUDE = "exclude"
+CONF_EXCLUDE_CLIENTS = "exclude_clients"
+CONF_PROVIDER = "provider"
+CONF_LOG_LOCATION = "log_location"
+
+OUTFILE = ".ip_authenticated.yaml"

custom_components/authenticated/manifest.json

@@ -1,8 +1,9 @@
 {
   "domain": "authenticated",
   "name": "Authenticated",
+  "version": "v0.0.0",
   "documentation": "https://github.com/custom-components/authenticated",
   "dependencies": [],
   "codeowners": ["@ludeeus"],
   "requirements": []
-}
+}

custom_components/authenticated/sensor.py

@@ -18,14 +18,10 @@
 from homeassistant.helpers.entity import Entity
 
 from .providers import PROVIDERS
+from .const import OUTFILE, CONF_NOTIFY, CONF_EXCLUDE, CONF_EXCLUDE_CLIENTS, CONF_PROVIDER, CONF_LOG_LOCATION, STARTUP
 
 _LOGGER = logging.getLogger(__name__)
 
-CONF_NOTIFY = "enable_notification"
-CONF_EXCLUDE = "exclude"
-CONF_PROVIDER = "provider"
-CONF_LOG_LOCATION = "log_location"
-
 ATTR_HOSTNAME = "hostname"
 ATTR_COUNTRY = "country"
 ATTR_REGION = "region"
@@ -38,10 +34,6 @@
 SCAN_INTERVAL = timedelta(minutes=1)
 
 PLATFORM_NAME = "authenticated"
-
-LOGFILE = "home-assistant.log"
-OUTFILE = ".ip_authenticated.yaml"
-
 PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend(
     {
         vol.Optional(CONF_PROVIDER, default="ipapi"): vol.In(
@@ -50,6 +42,7 @@
         vol.Optional(CONF_LOG_LOCATION, default=""): cv.string,
         vol.Optional(CONF_NOTIFY, default=True): cv.boolean,
         vol.Optional(CONF_EXCLUDE, default=[]): vol.All(cv.ensure_list, [cv.string]),
+        vol.Optional(CONF_EXCLUDE_CLIENTS, default=[]): vol.All(cv.ensure_list, [cv.string]),
     }
 )
 
@@ -60,17 +53,21 @@ def humanize_time(timestring):
 
 
 def setup_platform(hass, config, add_devices, discovery_info=None):
+    # Print startup message
+    _LOGGER.info(STARTUP)
+
     """Create the sensor"""
     notify = config.get(CONF_NOTIFY)
     exclude = config.get(CONF_EXCLUDE)
+    exclude_clients = config.get(CONF_EXCLUDE_CLIENTS)
     hass.data[PLATFORM_NAME] = {}
 
-    if not load_authentications(hass.config.path(".storage/auth"), exclude):
+    if not load_authentications(hass.config.path(".storage/auth"), exclude, exclude_clients):
         return False
 
     out = str(hass.config.path(OUTFILE))
 
-    sensor = AuthenticatedSensor(hass, notify, out, exclude, config[CONF_PROVIDER])
+    sensor = AuthenticatedSensor(hass, notify, out, exclude, exclude_clients, config[CONF_PROVIDER])
     sensor.initial_run()
 
     add_devices([sensor], True)
@@ -79,21 +76,22 @@ def setup_platform(hass, config, add_devices, discovery_info=None):
 class AuthenticatedSensor(Entity):
     """Representation of a Sensor."""
 
-    def __init__(self, hass, notify, out, exclude, provider):
+    def __init__(self, hass, notify, out, exclude, exclude_clients, provider):
         """Initialize the sensor."""
         self.hass = hass
         self._state = None
         self.provider = provider
         self.stored = {}
         self.last_ip = None
         self.exclude = exclude
+        self.exclude_clients = exclude_clients
         self.notify = notify
         self.out = out
 
     def initial_run(self):
         """Run this at startup to initialize the platform data."""
         users, tokens = load_authentications(
-            self.hass.config.path(".storage/auth"), self.exclude
+            self.hass.config.path(".storage/auth"), self.exclude, self.exclude_clients
         )
 
         if os.path.isfile(self.out):
@@ -155,7 +153,7 @@ def update(self):
         """Method to update sensor value"""
         updated = False
         users, tokens = load_authentications(
-            self.hass.config.path(".storage/auth"), self.exclude
+            self.hass.config.path(".storage/auth"), self.exclude, self.exclude_clients
         )
         _LOGGER.debug("Users %s", users)
         _LOGGER.debug("Access %s", tokens)
@@ -296,7 +294,7 @@ def get_hostname(ip_address):
     return hostname
 
 
-def load_authentications(authfile, exclude):
+def load_authentications(authfile, exclude, exclude_clients):
     """Load info from auth file."""
     if not os.path.exists(authfile):
         _LOGGER.critical("File is missing %s", authfile)
@@ -318,6 +316,8 @@ def load_authentications(authfile, exclude):
                     excludeaddress, False
                 ):
                     raise Exception("IP in excluded address configuration")
+            if token["client_id"] in exclude_clients:
+                raise Exception("Client in excluded clients configuration")
             if token.get("last_used_at") is None:
                 continue
             if token["last_used_ip"] in tokens_cleaned:
@@ -397,6 +397,10 @@ def notify(self, hass):
             country = "**Country:**   {}".format(self.country)
         else:
             country = ""
+        if self.hostname is not None:
+            hostname = "**Hostname:**   {}".format(self.hostname)
+        else:
+            hostname = ""
         if self.region is not None:
             region = "**Region:**   {}".format(self.region)
         else:
@@ -420,6 +424,7 @@ def notify(self, hass):
             self.ip_address,
             self.username,
             country,
+            hostname,
             region,
             city,
             last_used_at.replace("T", " "),