Merge pull request #120 from OpenSemanticLab/login-mechanism

Rework of login mechanism to combat session timeout and stale session cookies

Result of review: All comments resolved

Unchanged: dotenv.load_dotenv() in calling script file because:

Placing the load_dotenv() function call in WtSite would not produce the same behavior:
load_dotenv() with no path does not strictly mean "use current working directory".
It calls find_dotenv() internally, which usually searches from the caller file location and then walks up parent directories.
If the call is inside an imported module, the lookup can start from that module’s directory, so it may load a different .env than the one in the process working directory.

Note to users: 
For deterministic behavior, pass an explicit path to load_dotenv(...).

Author: LukasGold

.gitignore

@@ -63,3 +63,6 @@ src/osw/model/*.json
 playground
 
 .env
+
+# Automatically added by osw.auth.CredentialManager.save_credentials_to_file:
+*/osw_files/*

examples/.env_example

@@ -0,0 +1,3 @@
+OSW_DOMAIN=wiki-dev.open-semantic-lab.org
+OSW_CRED_FILEPATH=/path/to/credentials/file
+OSW_DOWNLOAD_DIR=/path/to/download/directory

examples/controller_logic.py

@@ -2,7 +2,7 @@
 
 from typing_extensions import override
 
-from osw.controller.entity import Entity, Hardware
+from osw.controller.entity import Entity
 from osw.express import OswExpress
 
 # Create/update the password file under examples/accounts.pwd.yaml
@@ -18,7 +18,7 @@
 osw_obj.fetch_schema(
     fetchSchemaParam=OswExpress.FetchSchemaParam(schema_title="Category:Hardware")
 )
-
+from osw.model.entity import Hardware  # noqa: E402
 
 title = "Item:OSW7d7193567ea14e4e89b74de88983b718"
 # title = "Item:OSWe02213b6c4664d04834355dc8eb08b99"

examples/create_entity.py

@@ -3,7 +3,8 @@
 import osw.model.entity as model
 
 my_entity = model.Item(
-    label=[model.Label(text="MyItem")], statements=[model.Statement(predicate="IsA")]
+    label=[model.Label(text="MyItem")],
+    statements=[model.DataStatement(property="IsA", value="Category:Item")],
 )
 pprint(my_entity.dict())
 print(my_entity.json())

examples/device_inventory.py

@@ -26,7 +26,7 @@
     model, "Corporation"
 ):  # only load if not already loaded. note: does not detect updated schemas yet
     DEPENDENCIES = {
-        "MetaDeviceCategory": "Category:OSWd845b96813a344458f140e48c4d063fd",
+        "DeviceType": "Category:OSWd845b96813a344458f140e48c4d063fd",
         "Device(SubclassWithMetaModel)": "Category:OSW5bf1542d9cf847db83cbc73d579ba9d6",
         "Corporation": "Category:OSW5f4a3751d23e482d80fb0b72dcd6bc31",  #
     }
@@ -47,7 +47,7 @@
 )
 
 # Create a new device type with the new manufacturer as manufacturer
-new_category = model.MetaDeviceCategory(  # here used as a device type
+new_category = model.DeviceType(  # here used as a device type
     uuid=uuid.uuid5(
         uuid_namespace, "MyNewDeviceCategory"
     ),  # use a stable id from the source dataset / file
@@ -70,7 +70,7 @@
         namespace="Category",
         # meta_category_title= (
         # "Category:OSWd845b96813a344458f140e48c4d063fd")
-        # usage of MetaDeviceCategory not yet supported
+        # usage of DeviceType not yet supported
     )
 )
 

examples/generate_rdf.py

@@ -19,6 +19,7 @@
 # load dependencies
 DEPENDENCIES = {
     "Tool": "Category:OSWe427aafafbac4262955b9f690a83405d",
+    "Device": "Category:OSWf0fe562f422d49c6877490b3dfee2f3f",
 }
 osw_obj.install_dependencies(DEPENDENCIES, mode="append", policy="if-missing")
 

examples/get_page_content.py

@@ -4,9 +4,13 @@
 go to special pages -> Bot passwords ; follow the instructions)
 """
 
+import dotenv
+
 from osw.express import OswExpress
 from osw.params import GetPageParam
 
+dotenv.load_dotenv()
+
 osw = OswExpress(domain="demo.open-semantic-lab.org")
 
 # the page title of the page to downlaod

examples/inter_osw_copy_page.py

@@ -3,11 +3,11 @@
 
 from pathlib import Path
 
+from opensemantic.v1 import OswBaseModel
 from typing_extensions import List, Optional, Union
 
 from osw.auth import CredentialManager
 from osw.core import OSW
-from osw.model.static import OswBaseModel
 from osw.utils import util
 from osw.wtsite import SLOTS, WtPage, WtSite
 

examples/offline_content_package.py

@@ -1,13 +1,17 @@
 import os
 from pathlib import Path
 
+import dotenv
+
 from osw import wiki_tools
 from osw.auth import CredentialManager
 from osw.core import OSW
 from osw.model.page_package import PagePackage, PagePackageBundle, PagePackageConfig
 from osw.params import CreatePagePackageParam, PageDumpConfig
 from osw.wtsite import WtSite
 
+dotenv.load_dotenv()
+
 # Create/update the password file under examples/accounts.pwd.yaml
 pwd_file_path = os.path.join(
     os.path.dirname(os.path.abspath(__file__)), "accounts.pwd.yaml"