merge: create release 0.5.2-beta (#43)

laszlojakab · web-flow · commit e9e3869a0faf · 2022-03-03T22:26:38.000+01:00
feat: create release 0.5.2-beta
diff --git a/README.md b/README.md
@@ -8,5 +8,35 @@
 
 [Dijnet](https://www.dijnet.hu/) integration for [Home Assistant](https://www.home-assistant.io/)
 
-## Usage:
-Install integration from HACS and add integration from UI.
+## Installation
+
+You can install this integration via [HACS](#hacs) or [manually](#manual).
+
+### HACS
+
+This integration is included in HACS. Search for the `Dijnet` integration and choose install. Reboot Home Assistant and configure the 'Dijnet' integration via the integrations page or press the blue button below.
+
+[![Open your Home Assistant instance and start setting up a new integration.](https://my.home-assistant.io/badges/config_flow_start.svg)](https://my.home-assistant.io/redirect/config_flow_start/?domain=dijnet)
+
+### Manual
+
+Copy the `custom_components/dijnet` to your `custom_components` folder. Reboot Home Assistant and configure the 'Dijnet' integration via the integrations page or press the blue button below.
+
+[![Open your Home Assistant instance and start setting up a new integration.](https://my.home-assistant.io/badges/config_flow_start.svg)](https://my.home-assistant.io/redirect/config_flow_start/?domain=dijnet)
+
+## Features
+
+- The integration provides services for every invoice issuer. Every invoice issuer could have multiple providers. For example DBH Zrt. invoice issuer handles invoices for FV Zrt. and FCSM Zrt. In that case the integration creates separate sensors for these providers.
+- For all providers an invoice amount sensor is created. It contains the sum of unpaid amount for a provider. The details of the unpaid invoices can be read out from `unpaid_invoices` attribute of the sensor.
+<!-- - For all providers a calendar entity is created. These entities are disabled by default. You can enable them by selecting 'Enable entity' toggle. The calendar entity registers an event for every incoming invoice. The event start date is the issuance date of the invoice. The event end date is the deadline of the invoice. If the invoices is paid before deadline, the end date of the event became the payment date. If the invoice is not paid until deadline the event end date will be today. -->
+
+## Enable debug logging
+
+The [logger](https://www.home-assistant.io/integrations/logger/) integration lets you define the level of logging activities in Home Assistant. Turning on debug mode will show more information about the running of the integration in the homeassistant.log file.
+
+```yaml
+logger:
+  default: error
+  logs:
+    custom_components.dijnet: debug
+```
diff --git a/custom_components/dijnet/__init__.py b/custom_components/dijnet/__init__.py
@@ -1,14 +1,21 @@
 '''Dijnet component.'''
 
+import logging
+
 from homeassistant.config_entries import ConfigEntry
 from homeassistant.const import CONF_PASSWORD, CONF_USERNAME
 from homeassistant.helpers.typing import ConfigType, HomeAssistantType
 
-from .const import CONF_DOWNLOAD_DIR, DATA_CONTROLLER, DOMAIN
-from .controller import is_controller_exists, set_controller, DijnetController
+from .const import (CONF_DOWNLOAD_DIR,
+                    CONF_ENCASHMENT_REPORTED_AS_PAID_AFTER_DEADLINE,
+                    DATA_CONTROLLER, DOMAIN)
+from .controller import DijnetController, is_controller_exists, set_controller
 
+_LOGGER = logging.getLogger(__name__)
 
 # pylint: disable=unused-argument
+
+
 async def async_setup(hass: HomeAssistantType, config: ConfigType) -> bool:
     '''
     Set up the Dijnet component.
@@ -53,7 +60,8 @@ async def async_setup_entry(hass: HomeAssistantType, config_entry: ConfigEntry)
             DijnetController(
                 config_entry.data[CONF_USERNAME],
                 config_entry.data[CONF_PASSWORD],
-                config_entry.data[CONF_DOWNLOAD_DIR]
+                config_entry.data[CONF_DOWNLOAD_DIR],
+                config_entry.data[CONF_ENCASHMENT_REPORTED_AS_PAID_AFTER_DEADLINE]
             )
         )
 
@@ -62,3 +70,19 @@ async def async_setup_entry(hass: HomeAssistantType, config_entry: ConfigEntry)
     )
 
     return True
+
+
+async def async_migrate_entry(hass: HomeAssistantType, config_entry: ConfigEntry):
+    """Migrate old entry."""
+    _LOGGER.debug("Migrating from version %s", config_entry.version)
+
+    if config_entry.version == 1:
+        new_config_entry = {**config_entry.data}
+        new_config_entry[CONF_ENCASHMENT_REPORTED_AS_PAID_AFTER_DEADLINE] = False
+
+        config_entry.version = 2
+        hass.config_entries.async_update_entry(config_entry, data=new_config_entry)
+
+    _LOGGER.info("Migration to version %s successful", config_entry.version)
+
+    return True
diff --git a/custom_components/dijnet/config_flow.py b/custom_components/dijnet/config_flow.py
@@ -12,7 +12,7 @@
 from homeassistant.core import callback
 from homeassistant.data_entry_flow import FlowResult
 
-from .const import CONF_DOWNLOAD_DIR, DOMAIN
+from .const import CONF_DOWNLOAD_DIR, CONF_ENCASHMENT_REPORTED_AS_PAID_AFTER_DEADLINE, DOMAIN
 from .dijnet_session import DijnetSession
 
 _LOGGER = logging.getLogger(__name__)
@@ -56,7 +56,11 @@ async def async_step_init(
             vol.Optional(
                 CONF_DOWNLOAD_DIR,
                 default=self.config_entry.data.get(CONF_DOWNLOAD_DIR)
-            ): str
+            ): str,
+            vol.Required(
+                CONF_ENCASHMENT_REPORTED_AS_PAID_AFTER_DEADLINE,
+                default=self.config_entry.data[CONF_ENCASHMENT_REPORTED_AS_PAID_AFTER_DEADLINE]
+            ): bool
         })
 
         if user_input is not None:
@@ -85,7 +89,7 @@ class DijnetConfigFlow(ConfigFlow, domain=DOMAIN):
     '''
     Configuration flow handler for Dijnet integration.
     '''
-    VERSION = 1
+    VERSION = 2
 
     @staticmethod
     @callback
@@ -112,12 +116,16 @@ async def async_step_user(self, user_input: Dict[str, Any]) -> FlowResult:
         data_schema = vol.Schema({
             vol.Required(CONF_USERNAME): str,
             vol.Required(CONF_PASSWORD): str,
-            vol.Optional(CONF_DOWNLOAD_DIR): str
+            vol.Optional(CONF_DOWNLOAD_DIR): str,
+            vol.Required(CONF_ENCASHMENT_REPORTED_AS_PAID_AFTER_DEADLINE): bool
         })
 
         if user_input is not None:
             async with DijnetSession() as session:
-                if not await session.post_login(user_input[CONF_USERNAME], user_input[CONF_PASSWORD]):
+                if not await session.post_login(
+                    user_input[CONF_USERNAME],
+                    user_input[CONF_PASSWORD]
+                ):
                     return self.async_show_form(
                         step_id='user',
                         data_schema=data_schema,
@@ -130,7 +138,10 @@ async def async_step_user(self, user_input: Dict[str, Any]) -> FlowResult:
             data = {
                 CONF_USERNAME: user_input[CONF_USERNAME],
                 CONF_PASSWORD: user_input[CONF_PASSWORD],
-                CONF_DOWNLOAD_DIR: user_input.get(CONF_DOWNLOAD_DIR, '')
+                CONF_DOWNLOAD_DIR: user_input.get(CONF_DOWNLOAD_DIR, ''),
+                CONF_ENCASHMENT_REPORTED_AS_PAID_AFTER_DEADLINE: user_input[
+                    CONF_ENCASHMENT_REPORTED_AS_PAID_AFTER_DEADLINE
+                ]
             }
 
             return self.async_create_entry(
diff --git a/custom_components/dijnet/const.py b/custom_components/dijnet/const.py
@@ -4,5 +4,6 @@
 DOMAIN = 'dijnet'
 
 CONF_DOWNLOAD_DIR = 'download_dir'
+CONF_ENCASHMENT_REPORTED_AS_PAID_AFTER_DEADLINE = 'encashment_reported_as_paid_after_deadline'
 
-DATA_CONTROLLER = 'controller'
+DATA_CONTROLLER = 'controller'
diff --git a/custom_components/dijnet/controller.py b/custom_components/dijnet/controller.py
@@ -7,7 +7,7 @@
 import re
 from datetime import datetime, timedelta
 from os import makedirs, path
-from typing import Any, Dict, List
+from typing import Any, Dict, List, Optional
 
 import yaml
 from homeassistant.helpers.typing import HomeAssistantType
@@ -298,7 +298,13 @@ class DijnetController:
     Responsible for providing data from Dijnet website.
     '''
 
-    def __init__(self, username: str, password: str, download_dir: str = None):
+    def __init__(
+        self,
+        username: str,
+        password: str,
+        download_dir: str = None,
+        encashment_reported_as_paid_after_deadline: bool = False
+    ):
         '''
         Initialize a new instance of DijnetController class.
 
@@ -311,10 +317,15 @@ def __init__(self, username: str, password: str, download_dir: str = None):
         download_dir: str
             Optional download directory. If set then the invoice
             files are downloaded to that location.
+        encashment_reported_as_paid_after_deadline: bool
+            The value indicates whether the encashment
+            should be reported as paid after deadline
         '''
         self._username = username
         self._password = password
         self._download_dir = download_dir
+        self._encashment_reported_as_paid_after_deadline = \
+            encashment_reported_as_paid_after_deadline
         self._registry: Dict[str, str] = None
         self._unpaid_invoices: List[Invoice] = []
         self._paid_invoices: List[Invoice] = []
@@ -376,7 +387,7 @@ async def update_registered_issuers(self):
             search_page = await session.get_invoice_search_page()
 
             providers_json = re.search(
-                r'var ropts = (.*);', search_page.decode("windows-1252")
+                r'var ropts = (.*);', search_page.decode("iso-8859-2")
             ).groups(1)[0]
 
             raw_providers: List[Any] = json.loads(providers_json)
@@ -391,7 +402,10 @@ async def update_registered_issuers(self):
                 issuer_id = row.children("td:nth-child(2)").text()
                 display_name = row.children("td:nth-child(3)").text()
                 providers = [
-                    raw_provider['szlaszolgnev'] for raw_provider in raw_providers if raw_provider['alias'] == display_name
+                    raw_provider['szlaszolgnev'] for
+                    raw_provider in
+                    raw_providers if
+                    raw_provider['alias'] == display_name
                 ]
                 issuer = InvoiceIssuer(issuer_id, issuer_name, display_name, providers)
                 issuers.append(issuer)
@@ -430,7 +444,12 @@ async def update_invoices(self):
             index = 0
             for row in invoices_pyquery.find('.szamla_table > tbody > tr').items():
                 invoice: Invoice = None
-                if self._is_invoice_paid(row):
+                is_paid: Optional[bool] = self._is_invoice_paid(row)
+                if is_paid is None:
+                    _LOGGER.error('Failed to determine invoice state. State column text: %s',
+                                  row.children('td:nth-child(8)').text())
+                    continue
+                elif self._is_invoice_paid(row):
                     await session.get_invoice_page(index)
                     invoice_history_page = await session.get_invoice_history_page()
                     invoice_history_page_response_pyquery = pq(invoice_history_page)
@@ -443,8 +462,22 @@ async def update_invoices(self):
                             invoice = self._create_invoice_from_row(row, paid_at)
                             possible_new_paid_invoices.append(invoice)
                         else:
-                            # not paid?
-                            invoice = self._create_invoice_from_row(row)
+                            # payment info not found, but invoice paid
+                            paid_at = datetime.strptime(row.children(
+                                'td:nth-child(6)').text(), DATE_FORMAT
+                            ).replace(tzinfo=None).date().isoformat()
+                            invoice = self._create_invoice_from_row(row, paid_at)
+                            possible_new_paid_invoices.append(invoice)
+
+                    if invoice is None:
+                        _LOGGER.warning(
+                            'History table rows not found. Setting paid_at value to deadline'
+                        )
+                        _LOGGER.debug(invoice_history_page.decode("iso-8859-2"))
+                        paid_at = datetime.strptime(row.children(
+                            'td:nth-child(6)').text(), DATE_FORMAT
+                        ).replace(tzinfo=None).date().isoformat()
+                        invoice = self._create_invoice_from_row(row, paid_at)
                 else:
                     invoice = self._create_invoice_from_row(row)
                     possible_new_unpaid_invoices.append(invoice)
@@ -576,8 +609,29 @@ def _create_invoice_from_row(self, row: PyQuery, paid_at: datetime = None) -> In
 
         return invoice
 
-    def _is_invoice_paid(self, row: PyQuery) -> bool:
-        return 'Rendezetlen' not in row.children('td:nth-child(8)').text()
+    def _is_invoice_paid(self, row: PyQuery) -> Optional[bool]:
+        paid: bool = 'Rendezett' in row.children('td:nth-child(8)').text()
+        if paid:
+            return True
+
+        paid = 'Fizetve' in row.children('td:nth-child(8)').text()
+        if paid:
+            return True
+
+        not_paid: bool = 'Rendezetlen' in row.children('td:nth-child(8)').text()
+        if not_paid:
+            return False
+
+        collection: bool = 'Csoportos beszedés' in row.children('td:nth-child(8)').text()
+        if collection:
+            if self._encashment_reported_as_paid_after_deadline:
+                deadline = datetime.strptime(row.children(
+                    'td:nth-child(6)').text(), DATE_FORMAT).replace(tzinfo=None).date()
+                return deadline < datetime.now().date()
+            else:
+                return False
+
+        return None
 
     def _initialize_registry_and_unpaid_invoices(self):
         paid_invoices = None
diff --git a/custom_components/dijnet/manifest.json b/custom_components/dijnet/manifest.json
@@ -6,7 +6,7 @@
   "issue_tracker": "https://github.com/laszlojakab/homeassistant-dijnet/issues",
   "dependencies": [],
   "config_flow": true,
-  "version": "0.4.3-beta",
+  "version": "0.5.2-beta",
   "codeowners": ["@laszlojakab"],
   "requirements": ["PyQuery==1.4.3"]
 }
diff --git a/custom_components/dijnet/strings.json b/custom_components/dijnet/strings.json
@@ -5,7 +5,8 @@
         "data": {
           "username": "Username",
           "password": "Password",
-          "download_dir": "Download directory"
+          "download_dir": "Download directory",
+          "encashment_reported_as_paid_after_deadline": "Encashment payments reported as paid after deadline"
         },
         "description": "Set username and password. Optionally set download directory where downloaded invoices should be stored.",
         "title": "Configure Dijnet integration."
diff --git a/custom_components/dijnet/translations/en.json b/custom_components/dijnet/translations/en.json
@@ -5,7 +5,8 @@
         "data": {
           "username": "Username",
           "password": "Password",
-          "download_dir": "Download directory"
+          "download_dir": "Download directory",
+          "encashment_reported_as_paid_after_deadline": "Encashment payments reported as paid after deadline"
         },
         "description": "Set username and password. Optionally set download directory where downloaded invoices should be stored.",
         "title": "Configure Dijnet integration."
@@ -23,7 +24,8 @@
       "init": {
         "data": {
           "password": "Password",
-          "download_dir": "Download directory"
+          "download_dir": "Download directory",
+          "encashment_reported_as_paid_after_deadline": "Encashment payments reported as paid after deadline"
         },
         "description": "Set password. Optionally set download directory where downloaded invoices should be stored. To set username remove the integration and readd.",
         "title": "Reconfigure Dijnet integration."
diff --git a/custom_components/dijnet/translations/hu.json b/custom_components/dijnet/translations/hu.json
@@ -5,7 +5,8 @@
         "data": {
           "username": "Felhasználó név",
           "password": "Jelszó",
-          "download_dir": "Letöltési könyvtár"
+          "download_dir": "Letöltési könyvtár",
+          "encashment_reported_as_paid_after_deadline": "Csoportos beszedéseket fizetettnek tekint számla lejártakor"
         },
         "description": "Állítsd be a Dijnet-es felhasználónevedet és jelszavadat. Ha szeretnéd, hogy a számlák letöltésre kerüljenek adj meg egy könyvtárnevet is a letöltés helyének!",
         "title": "Dijnet integráció beállítása."
@@ -23,7 +24,8 @@
       "init": {
         "data": {
           "password": "Jelszó",
-          "download_dir": "Letöltési könyvtár"
+          "download_dir": "Letöltési könyvtár",
+          "encashment_reported_as_paid_after_deadline": "Csoportos beszedéseket fizetettnek tekint számla lejártakor"
         },
         "description": "Állítsd be a Dijnet-es jelszavadat. Ha szeretnéd, hogy a számlák letöltésre kerüljenek adj meg egy könyvtárnevet is a letöltés helyének! Ha felhasználó nevet szeretnél váltani, akkor távolítsd el az integrációt, majd add hozzá újra!",
         "title": "Dijnet integráció beállítása."

Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@`
`6`	`6`	`"issue_tracker": "https://github.com/laszlojakab/homeassistant-dijnet/issues",`
`7`	`7`	`"dependencies": [],`
`8`	`8`	`"config_flow": true,`
`9`		`- "version": "0.4.3-beta",`
	`9`	`+ "version": "0.5.2-beta",`
`10`	`10`	`"codeowners": ["@laszlojakab"],`
`11`	`11`	`"requirements": ["PyQuery==1.4.3"]`
`12`	`12`	`}`