isoc-ams 0.0.1__py2.py3-none-any.whl → 0.0.2__py2.py3-none-any.whl

{isoc_ams-0.0.1.dist-info → isoc_ams-0.0.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: isoc-ams
-Version: 0.0.1
+Version: 0.0.2
 Summary: A Python 3 module to cope with ISOC-AMS.
 Author-email: Klaus Birkenbihl <klaus.birkenbihl@isoc.de>
 Maintainer: Klaus Birkenbihl
@@ -13,19 +13,19 @@ Project-URL: Home, https://github.com/birkenbihl/isoc-ams
 
 # isoc-ams
 
-A Python Interface to access the 'Advanced Members Administration System' (AMS) of the 'Internet Society' (ISOC). This especially usefulfor ISOC Chapter Admins who want to synchronize their Chapter Database with AMS (semi)automatically.
+A Python Interface to access the 'Advanced Members Administration System' (AMS) of the 'Internet Society' (ISOC). This especially useful for ISOC Chapter Admins who want to synchronize their Chapter Database with AMS (semi)automatically.
 
 After 10 years+  of sorrow, millions minutes of waiting for answers from the AMS web interface, tons of useless clicks, many (in fact) rejected requests to provide an API access: the author decided to build an API himself. Even if it might not be more than a demonstrator for the functionality needed. Anyhow (see below): for now it is running on a weekly basis doing a great job in avoiding manual work. 
 
 Unfortunately the constraints are severe:
-- access had to be through the web interface since this is the only interface provided. As a consequence it is slow, sometimes unreliable and hard to implement. At least there are working implementations of the "W3C webdriver" recommendtion. One of them is Selenium used for this project.
-- the existing web interface is far from being stable or guarateed. So changes to the web interface might spoil the whole project. There is great chance that few weeks from now a new "super dooper" AMS will be announced and as always after these announcements things will get worse.
+- access had to be through the web interface since this is the only interface provided. As a consequence it is slow, sometimes unreliable and hard to implement. At least there are working implementations of the "W3C web driver" recommendation. One of them is Selenium used for this project.
+- the existing web interface is far from being stable or guaranteed. So changes to the web interface might spoil the whole project. There is great chance that few weeks from now a new "super duper" AMS will be announced and as always after these announcements things will get worse.
 - tests are close to impossible. There is no such thing as a TEST AMS.
 
 Is there a possible good exit? Well, maybe some day soon - in 10 or 20 years if ISOC still exists - there will be an API provided by ISOC that makes this project obsolete. Or at least may be an all-mighty AI will step in. Let's dream on!
 
 ## Features
-ISOC maintains two main Lists that are relevant for the operation of this interface: 
+AMS maintains two main Lists that are relevant for the operation of this interface: 
 - a list of ISOC members registered as members of the Chapter
 - a list of ISOC members that applied for a Chapter membership.
   
@@ -66,11 +66,15 @@ So this happens if we call the module with:
 ```bash
 python -m isoc_ams
 ```
-
+Output:
 ```
 Username: xxx
 Password: 
 
+********************************************
+AMS 2025-07-03 10:49:05 START
+********************************************
+
 AMS 2025-07-03 10:49:07 logging in
 AMS 2025-07-03 10:49:11 log in started
 AMS 2025-07-03 10:49:20 now on community portal
@@ -127,12 +131,76 @@ PENDING APPLICATIONS
 2 ...
 ...
 ```
+As you can see: building the list is rather tedious: reading the Table scroll it to find the end ... and for the members list - in order to get the links for actions - we have to build 2 tables ...
+### Running with arguments
+Normally isoc_ams won't show any browser output - running headless. To do debugging it might useful to follow the activities in the browser. If you call isoc_ams with a -h option like 
+```bash
+python -m isoc_ams -h
+```
+the browser will open and you can follow all activities real time.
+
+An argument -i tells the module that there will be (or is) input available with actions to execute. An argument -d  tells isoc_ams to make a dry run where actions are computed but not executed.
+
+Again an example:
+```bash
+python -m isoc_ams -i -d
+```
+Output:
+```
+Username: xxx
+Username:klaus.birkenbihl@isoc.de
+Password: 
+
+********************************************
+AMS 2025-07-09 16:25:06 START DRYRUN
+********************************************
+
+AMS 2025-07-09 16:25:06 logging in
+AMS 2025-07-09 16:25:09 log in started
+AMS 2025-07-09 16:25:17 now on community portal
+AMS 2025-07-09 16:25:21 waiting for Chapter Leader portal
+AMS 2025-07-09 16:25:21 Chapter Leader portal OK
+
+
+AMS 2025-07-09 16:25:21 start build members list
+...
+AMS 2025-07-09 16:26:12 records collected / total 58  / 58
+AMS 2025-07-09 16:26:12 members list finished
+
+
+AMS 2025-07-09 16:26:12 start build pending applications
+...
+AMS 2025-07-09 16:26:25 records collected / total 9  / 9
+AMS 2025-07-09 16:26:25 pending application list finished
 
-Normally isoc_ams wont show any browser output - running headless. To do debugging it might useful to follow the activities in the browser. If you call isoc_ams with a -h option the browser will open.
+
+MEMBERS
+1 2217734 Johannes Piesepampel self@piesepampel.com
+...
+
+PENDING APPLICATIONS
+1 23232 Franz Piesepampel franz@piesepampel.com 2025-01-22
+2 22556 Abdul Piesepampel abdul@piesepampel.com 2025-03-21
+...
+READING COMMANDS:
+deny 23232 22556 123
+AMS 2025-07-09 18:17:51 Denied 2323284 Franz Piesepampel
+AMS 2025-07-09 18:17:51 Denied 2333463 Abdul Piesepampel
+*******************************************************************************
+AMS 2025-07-09 18:17:51 ISOC-ID 123 is not in pending applications list
+*******************************************************************************
+
+delete 2217734
+AMS 2025-07-09 18:18:29 Deleted 22842 Franz Piesepampel
+EOF of command input
+Deviations from expected results:
+Dryrun No results expected
+All results as expected
+```
 
 ## Using the API
 
-isoc_ams unleashes its full power when used as API to make things happen without human intervention. Check the file "isoc_de_ams_main.py" as an example for fully automatic synchronizing of local membership administration with AMS.
+isoc_ams unleashes its full power when used as API to make things happen without human intervention. Check the file "[isoc_de_ams_main.py](https://github.com/birkenbihl/isoc-ams/blob/main/isoc_de_ams_main.py)" as an example for fully automatic synchronizing of local membership administration with AMS.
 
 Here an excerpt of the output:
 ```
@@ -152,19 +220,26 @@ Members:
    ...
    for the following members a nagging mail will be sent to AMS-support (we are not authorized to fix it!):
    ...
-   the following members are in sync
+   the following locally registered members are in sync with AMS:
    ...
       
 AMS 2025-07-03 12:00:32 start delete ... from AMS Chapter members list
    ...
 
-Dear MAS-support team,
+Dear AMS-support team,
+
 this is an automatic, complimentary Message from the ISOC German Chapter
 Members Administration System (ISOC.DE MAS).
 
+Assuming you are interested in making ISOC AMS consistent, the purpose
+of this message is to help you with valid, up-to-date data.
+
 The following individuals are legally registered paying members
-of ISOC.DE - many of them for more than 25 years.
-...
+of ISOC.DE - many of them for more than 25 years. They all are
+also registered as ISOC (global) members. Unfortunately they are
+not registered with AMS as members of ISOC.DE. Even more we are
+not authorized to fix this. So we forward this data to your attention:
+
    Uwe Mayer, xxx@yyy.com (ISOC-ID=1234567)
    ...
    
@@ -180,7 +255,7 @@ not approved from pending applicants list
 not removed from pending applicants list
 ...
 ```
-See file isoc_ams.doc for doc on the API interface.
+See file [isoc_ams.doc](https://github.com/birkenbihl/isoc-ams/blob/main/isoc_ams.doc) for doc on the API interface.
 
 Have fun!
 

isoc_ams-0.0.2.dist-info/RECORD

@@ -0,0 +1,5 @@
+isoc_ams.py,sha256=pc1BLQcVs7fKDoy_FBuBe1hszEiaueGCOvPk76Qp4VI,33853
+isoc_ams-0.0.2.dist-info/licenses/LICENSE,sha256=BJcMew_kvBWHjs-_Hd_OMHnxOLmeczeT88V4gFCT21U,1067
+isoc_ams-0.0.2.dist-info/WHEEL,sha256=Dyt6SBfaasWElUrURkknVFAZDHSTwxg3PaTza7RSbkY,100
+isoc_ams-0.0.2.dist-info/METADATA,sha256=3IDSf6pRGsw255-F0W1VGXPcLLJFlCHxySAs7KVnsVE,10489
+isoc_ams-0.0.2.dist-info/RECORD,,

isoc_ams.py

@@ -67,8 +67,13 @@ _______
     # check if all went well
     print(difference_from_expected())
 
+Changelog
+_________
+Version 0.2
+Allow input if executed as module
+Add dryrun to ISOC_AMS class
 """
-__version__ = "0.0.1"
+__version__ = "0.0.2"
 
 from selenium import webdriver
 from selenium.webdriver.common.by import By
@@ -116,21 +121,29 @@ class ISOC_AMS:
         password: password for ISO.ORG login
         logfile: where to write ISOC_AMS log output
         headless: run without GUI
-
+        dryrun: only check input, no actions
     """
 
     def __init__(self,
                  user: str,
                  password: str,
                  logfile: io.StringIO | str = sys.stdout,
-                 headless: bool = True):
+                 headless: bool = True,
+                 dryrun:  bool = False,):
         if _dr == "firefox" and headless:
             _options.add_argument("--headless")
         elif _dr == "chrome" and headless:
             _options.add_argument("--headless=new")
         self._members_list: dict | None = None
         self._pending_applications_list: dict | None = None
-        self._ams = _ISOC_AMS(user, password, logfile)
+        self._dryrun = dryrun
+        self._ams = _ISOC_AMS(logfile)
+        if self._dryrun:
+            self._ams.strong_msg("START DRYRUN")
+        else:
+            self._ams.strong_msg("START")
+        self._ams.login((user, password))
+
 
     @property
     def members_list(self) -> dict:
@@ -193,10 +206,15 @@ class ISOC_AMS:
         deletes delete_list entries from AMS-list of Chapter members
         """
         if type(delete_list) in (str, int):
-            delete_list = str(delete_list),
-        for deletee in delete_list:
+            delete_list = [delete_list]
+        for deletee in map(str, delete_list):
             if deletee in self._members_list:
-                self._ams.delete(self._members_list[deletee])
+                deletee = str(deletee)
+                if not self._dryrun:
+                    self._ams.delete(self._members_list[deletee])
+                self._ams.log("Deleted", deletee,
+                              self._members_list[deletee]["first name"],
+                              self._members_list[deletee]["last name"])
                 del self._members_list[deletee]
             else:
                 self._ams.strong_msg("ISOC-ID", deletee,
@@ -214,14 +232,17 @@ class ISOC_AMS:
         approves pending members on approve_list as Chapter members
         """
         if type(approve_list) in (int, str):
-            approve_list = str(approve_list),
-        for approvee in approve_list:
+            approve_list = [approve_list]
+        for approvee in map(str, approve_list):
             if approvee in self._pending_applications_list:
-                self._ams.approve(self._pending_applications_list[approvee])
+                if not self._dryrun:
+                    self._ams.approve(self._pending_applications_list[approvee])
+                self._ams.log("Approved", approvee,
+                              self._pending_applications_list[approvee]["name"])
                 del self._pending_applications_list[approvee]
             else:
                 self._ams.strong_msg("ISOC-ID", approvee,
-                                     "is not in pending applications list" )
+                                     "is not in pending applications list")
 
     def deny_pending_applications(self,
                                   deny_list: list | dict | str | int,
@@ -238,15 +259,18 @@ class ISOC_AMS:
 
         """
         if type(deny_list) in (str, int):
-            deny_list = str(deny_list),
-        for denyee in deny_list:
+            deny_list = [deny_list],
+        for denyee in map(str, deny_list):
             if denyee in self._pending_applications_list:
-                self._ams.deny(self._pending_applications_list[denyee],
-                                  reason)
+                if not self._dryrun:
+                    self._ams.deny(self._pending_applications_list[denyee],
+                                   reason)
+                self._ams.log("Denied", denyee,
+                              self._pending_applications_list[denyee]["name"])
                 del self._pending_applications_list[denyee]
             else:
                 self._ams.strong_msg("ISOC-ID", denyee,
-                                     "is not in pending applications list" )
+                                     "is not in pending applications list")
 
     def difference_from_expected(self) -> dict:
         """Compare intended outcome of operations with real outcome.
@@ -267,38 +291,43 @@ class ISOC_AMS:
             }
 
         """
-        self._ams.log(date=False)
-        self._ams.log("collect differences from expected result after operations")
-
-        not_deleted = {}
-        not_approved = {}
-        not_removed_from_pending = {}
-        new_members_list = self._ams.build_members_list()
-        for nm in new_members_list:
-            if nm not in self._members_list:
-                not_deleted[nm] = new_members_list[nm]
-        for nm in self._members_list:
-            if nm not in new_members_list:
-                not_approved[nm] = self._members_list[nm]
-        new_pending_applications_list = self._ams.build_pending_applicants_list()
-        for np in new_pending_applications_list:
-            if np not in self._pending_applications_list:
-                not_removed_from_pending[np] = new_pending_applications_list[np]
-
-        return {"not deleted from members": not_deleted,
-                "not approved from pending applicants list": not_approved,
-                "not removed from pending applicants list": not_removed_from_pending}
+        if not self._dryrun:
+
+            self._ams.log(date=False)
+
+            self._ams.strong_msg("we have to read the AMS Database tables again :(")
+            self._ams.log("... to find deviations from expected result after actions")
+
+            not_deleted = {}
+            not_approved = {}
+            not_removed_from_pending = {}
+            new_members_list = self._ams.build_members_list()
+            for nm in new_members_list:
+                if nm not in self._members_list:
+                    not_deleted[nm] = new_members_list[nm]
+            for nm in self._members_list:
+                if nm not in new_members_list:
+                    not_approved[nm] = self._members_list[nm]
+            new_pending_applications_list = self._ams.build_pending_applicants_list()
+            for np in new_pending_applications_list:
+                if np not in self._pending_applications_list:
+                    not_removed_from_pending[np] = new_pending_applications_list[np]
+
+            return {"not deleted from members": not_deleted,
+                    "not approved from pending applicants list": not_approved,
+                    "not removed from pending applicants list": not_removed_from_pending}
+        else:
+            return {"Dryrun": "No results expected"}
 
 class _ISOC_AMS(Driver):
 
-    def __init__(self, user: str, password: str, logfile: str = sys.stdout):
+    def __init__(self, logfile: str = sys.stdout):
 
         super().__init__(_options)
         self.windows = {}
         self.logfile = logfile
         if type(self.logfile) is str:
             self.logfile = open(self.log, "a")
-        self.login(user, password)
 
     def __del__(self):
         self.quit()
@@ -364,7 +393,7 @@ class _ISOC_AMS(Driver):
 # setup session, init windows
 #
 
-    def login(self, user: str, password: str):
+    def login(self, credentials):
         # Sign on user and navigate to the Chapter leaders page,
 
         self.log(date=False)
@@ -383,7 +412,7 @@ class _ISOC_AMS(Driver):
             "document.getElementById('signInName').value='%s';"
             "document.getElementById('password').value='%s';"
             "arguments[0].click();"
-            % (user, password),
+            % credentials,
             elem)
 
         # self.set_window_size(1600, 300)
@@ -792,14 +821,22 @@ if __name__ == "__main__":
     from getpass import getpass
     headless = True
     if "-h" in sys.argv:
-        headless=False
+        headless = False
+    inp = False
+    if "-i" in sys.argv:
+        inp = True
+    dryrun = False
+    if "-d" in sys.argv:
+        dryrun = True
+
     print("Username", end=":")
     user_id = input()
     password = getpass()
     ams = ISOC_AMS(
         user_id,
         password,
-        headless=headless)
+        headless=headless,
+        dryrun=dryrun)
     members = ams.members_list
     pendings = ams.pending_applications_list
 
@@ -807,12 +844,46 @@ if __name__ == "__main__":
     i = 0
     for k, v in members.items():
         i += 1
-        print(i, k + ":", v["first name"], v["last name"], v["email"], v["action link"])
+        print(i, k,  v["first name"], v["last name"], v["email"])
 
     print("\nPENDING APPLICATIONS")
     i = 0
     for k, v in pendings.items():
         i += 1
         # print(i, k, v)
-        print(i, k, v["name"], v["email"], v["action link"],
-              v["date"].isoformat()[:19])
+        print(i, k, v["name"], v["email"], v["date"].isoformat()[:10])
+
+    if inp:
+        print('READING COMMANDS:')
+        import re
+        patt = re.compile(r'(approve|deny|delete):?\s*([\d, ]+)')
+        func = {"approve": ams.approve_pending_applications,
+                "deny": ams.deny_pending_applications,
+                "delete": ams.delete_members
+                }
+        splitter = re.compile(r'[\s,]+')
+        for rec in sys.stdin:
+            if m := patt.match(rec):
+                command = m.group(1)
+                keys = splitter.split(m.group(2))
+                func[command](keys)
+            else:
+                print(rec, "contains an error")
+        print("EOF of command input")
+
+        devs = 0
+        for data in ams.difference_from_expected().items():
+            print("Deviations from expected results:")
+            print(data[0], end=" ")
+            if type(data[1]) is str:
+                print(data[1])
+            else:
+                if data[1]:
+                    devs = 1
+                    for k, v in data[1].items():
+                        if "members" in data[0]:
+                            print("        ", v["first name"], v["last name"], v["email"], "("+k+")")
+                        else:
+                            print("        ", v["name"], v["email"], "("+k+")")
+            if devs == 0:
+                print("All results as expected")

isoc_ams-0.0.1.dist-info/RECORD

@@ -1,5 +0,0 @@
-isoc_ams.py,sha256=_856QxwvSovWra0iOyOafpYm6K_aVVg_D14X4drq62M,31231
-isoc_ams-0.0.1.dist-info/licenses/LICENSE,sha256=BJcMew_kvBWHjs-_Hd_OMHnxOLmeczeT88V4gFCT21U,1067
-isoc_ams-0.0.1.dist-info/WHEEL,sha256=Dyt6SBfaasWElUrURkknVFAZDHSTwxg3PaTza7RSbkY,100
-isoc_ams-0.0.1.dist-info/METADATA,sha256=nfcgOmUP9GbfkcXdb4UIJtqoYy-dRFkdT-PFxLOG8eQ,7746
-isoc_ams-0.0.1.dist-info/RECORD,,