csh-ldap 2.5.3__tar.gz → 2.5.4.dev4__tar.gz

{csh_ldap-2.5.3 → csh_ldap-2.5.4.dev4}/AUTHORS

@@ -8,6 +8,10 @@ Liam Middlebrook <liammiddlebrook@gmail.com>
 Marc Billow <mbillow@me.com>
 Max Meinhold <mxmeinhold@gmail.com>
 Michael Francis <mikefrancis95@gmail.com>
+Noah Hanford (spaced) <spaced@csh.rit.edu>
+Noah Hanford <bigspaceships56@gmail.com>
+Noah Hanford <spaced@csh.rit.edu>
 Tyler Allen <tyler@tallen.me>
 William Stevens <contact@wastevensv.com>
 dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
+tyler <137842227+goosenotduck@users.noreply.github.com>

{csh_ldap-2.5.3 → csh_ldap-2.5.4.dev4}/ChangeLog

@@ -1,6 +1,10 @@
 CHANGES
 =======
 
+* bump: 2.5.4
+* feat: added methods to get member data while combining groups (#44)
+* Fix subgroups (#43)
+
 2.5.3
 -----
 

{csh_ldap-2.5.3 → csh_ldap-2.5.4.dev4}/PKG-INFO

@@ -1,10 +1,10 @@
 Metadata-Version: 2.4
-Name: csh_ldap
-Version: 2.5.3
+Name: csh-ldap
+Version: 2.5.4.dev4
 Summary: CSH LDAP ORM
-Home-page: https://github.com/ComputerScienceHouse/csh_ldap
-Author: Liam Middlebrook
-Author-email: liammiddlebrook@gmail.com
+Home-page: https://github.com/ComputerScienceHouse/csh-ldap
+Author: CSH RTP
+Author-email: rtp@csh.rit.edu
 License: MIT
 Classifier: Natural Language :: English
 Classifier: Operating System :: POSIX :: Linux
@@ -21,7 +21,7 @@ Dynamic: license-file
 Dynamic: requires-dist
 Dynamic: summary
 
-# csh_ldap
+# csh-ldap
 
 [![PyPI version](https://badge.fury.io/py/csh_ldap.svg)](https://badge.fury.io/py/csh_ldap)
 [![Build Status](https://travis-ci.org/liam-middlebrook/csh_ldap.svg?branch=master)](https://travis-ci.org/liam-middlebrook/csh_ldap)
@@ -31,13 +31,13 @@ Python 3 ORM for CSH LDAP
 
 ## Installation
 
-`pip install csh_ldap`
+`pip install csh-ldap`
 
 
 ## Usage
 
 ```
-import csh_ldap
+import csh-ldap
 
 # Create an unbatched instance
 instance = csh_ldap.CSHLDAP(bind_dn, bind_pw)
@@ -63,6 +63,38 @@ liam = instance.get_member_slackuid(slack_uid)
 # Get group by cn
 rtp = instance.get_group('rtp')
 
+# get group member uids 
+rtp = instance.get_group('rtp').get_member_uids()
+# returns ['spaced', ...]
+
+# get group member uids (other way)
+rtp = instance.get_group_member_uids(groups=["rtp"])
+
+# get uids of members in two (or more) groups and not in groups
+fancy = instance.get_group_member_uids(groups=["rtp", "onfloor"], excluded=["eboard-opcomm"])
+
+# get uuids of members in two (or more) groups and not in groups
+# that's right! ipaUniqueId
+fancy = instance.get_group_member_uuids(groups=["rtp", "onfloor"], excluded=["eboard-opcomm"])
+
+# get other miscellaneous attributes of members in group
+# look how rich drink admins are (admin abuse!!!)
+admin_abuse = instance.get_group_member_attributes(group=["drink"], attributes=["uid", "drinkBalance"])
+# returns dicts for each member
+"""
+I wonder what happened here
+[
+{
+    'uid': 'cole',
+    'drinkBalance': '996246'
+},
+{
+    'uid': 'zxcv',
+    'drinkBalance': '3847173'
+}
+]
+"""
+
 # Get cn of member
 print(liam.cn)
 

{csh_ldap-2.5.3 → csh_ldap-2.5.4.dev4}/README.md

@@ -1,4 +1,4 @@
-# csh_ldap
+# csh-ldap
 
 [![PyPI version](https://badge.fury.io/py/csh_ldap.svg)](https://badge.fury.io/py/csh_ldap)
 [![Build Status](https://travis-ci.org/liam-middlebrook/csh_ldap.svg?branch=master)](https://travis-ci.org/liam-middlebrook/csh_ldap)
@@ -8,13 +8,13 @@ Python 3 ORM for CSH LDAP
 
 ## Installation
 
-`pip install csh_ldap`
+`pip install csh-ldap`
 
 
 ## Usage
 
 ```
-import csh_ldap
+import csh-ldap
 
 # Create an unbatched instance
 instance = csh_ldap.CSHLDAP(bind_dn, bind_pw)
@@ -40,6 +40,38 @@ liam = instance.get_member_slackuid(slack_uid)
 # Get group by cn
 rtp = instance.get_group('rtp')
 
+# get group member uids 
+rtp = instance.get_group('rtp').get_member_uids()
+# returns ['spaced', ...]
+
+# get group member uids (other way)
+rtp = instance.get_group_member_uids(groups=["rtp"])
+
+# get uids of members in two (or more) groups and not in groups
+fancy = instance.get_group_member_uids(groups=["rtp", "onfloor"], excluded=["eboard-opcomm"])
+
+# get uuids of members in two (or more) groups and not in groups
+# that's right! ipaUniqueId
+fancy = instance.get_group_member_uuids(groups=["rtp", "onfloor"], excluded=["eboard-opcomm"])
+
+# get other miscellaneous attributes of members in group
+# look how rich drink admins are (admin abuse!!!)
+admin_abuse = instance.get_group_member_attributes(group=["drink"], attributes=["uid", "drinkBalance"])
+# returns dicts for each member
+"""
+I wonder what happened here
+[
+{
+    'uid': 'cole',
+    'drinkBalance': '996246'
+},
+{
+    'uid': 'zxcv',
+    'drinkBalance': '3847173'
+}
+]
+"""
+
 # Get cn of member
 print(liam.cn)
 

{csh_ldap-2.5.3/csh_ldap → csh_ldap-2.5.4.dev4/csh-ldap}/__init__.py

@@ -149,6 +149,113 @@ class CSHLDAP:
                           True)
                 for dn in ret]
 
+    def get_query_for_groups(self, groups = None, excluded_groups = None):
+        """Returns the ldap query string to get members in groups but not in others
+
+        Argumenets:
+        groups -- the groups members must be a member of
+        excluded_groups -- the groups members cannot be a part of
+        """
+
+        group_dns = [f"(memberOf=cn={group},cn=groups,cn=accounts,dc=csh,dc=rit,dc=edu)" for group in groups]
+        excluded_group_dns = [
+            f"(memberOf=cn={group},cn=groups,cn=accounts,dc=csh,dc=rit,dc=edu)"
+            for group in excluded_groups
+        ]
+
+        query = ""
+
+        for group in group_dns:
+            if query == "":
+                query = group
+                continue
+
+            query = f"(&{query}{group})"
+
+        for group in excluded_group_dns:
+            group = f"(!{group})"
+            if query == "":
+                query = group
+                continue
+
+            query = f"(&{query}{group})"
+
+        return query
+
+    def get_group_member_attributes(self, groups = None, excluded_groups = None, attributes = None):
+        """Returns a list of dicts containing all the attributes requested in the groups listed in groups, 
+            but not in exlcuded_groups
+
+        Arguements:
+        groups -- the groups members must be a member of
+        excluded_groups -- the groups members cannot be a part of
+        attributues -- the ldap attributes to return, defaults to uid
+        """
+
+        # I HATE PYTHON
+        if attributes is None:
+            attributes = ['uid']
+
+        query_result = self.__con__.search_s(
+            "dc=csh,dc=rit,dc=edu",
+            ldap.SCOPE_SUBTREE,
+            self.get_query_for_groups(groups=groups, excluded_groups=excluded_groups),
+            attributes)
+
+        # the rest of this could be one giant list compression but I don't hate you that much so I chose not to
+
+        # filter out subgroups, probably the second check all we need
+        # but if we used just the second one but the first one was empty that would probably be confusing?
+        byte_result = [member[1] for member in query_result if not member[1] == {} and "cn=users" in member[0]]
+
+        result = []
+
+        for byte_member in byte_result:
+            # decoding the byte strings
+            result.append({key: value[0].decode('utf-8') for (key, value) in byte_member.items()})
+
+        return result
+
+    def get_group_member_uids(self, groups = None, excluded_groups = None):
+        """Get a list of member uids in a group
+
+        Arguements:
+        groups -- the groups members must be a member of
+        excluded_groups -- the groups members cannot be a part of
+        """
+
+        query_result = self.__con__.search_s(
+            "dc=csh,dc=rit,dc=edu",
+            ldap.SCOPE_SUBTREE,
+            self.get_query_for_groups(groups=groups, excluded_groups=excluded_groups),
+            ['uid'])
+
+        return [
+            member[1]['uid'][0].decode('utf-8')
+            for member in query_result
+            if not member[1] == {} and "cn=users" in member[0]
+        ]
+
+    def get_group_member_uuids(self, groups = None, excluded_groups = None):
+        """Get a list of member uuids in a group (ipaUniqueId)
+
+        Arguements:
+        groups -- the groups members must be a member of
+        excluded_groups -- the groups members cannot be a part of
+        """
+
+        query_result = self.__con__.search_s(
+            "dc=csh,dc=rit,dc=edu",
+            ldap.SCOPE_SUBTREE,
+            self.get_query_for_groups(groups=groups, excluded_groups=excluded_groups),
+            ['ipaUniqueId'])
+
+        return [
+            member[1]['ipaUniqueId'][0].decode('utf-8')
+            for member in query_result
+            if not member[1] == {} and "cn=users" in member[0]
+        ]
+
     def enqueue_mod(self, dn, mod):
         """Enqueue a LDAP modification.
 

{csh_ldap-2.5.3/csh_ldap → csh_ldap-2.5.4.dev4/csh-ldap}/group.py

@@ -30,8 +30,9 @@ class CSHGroup:
             raise KeyError("Invalid Search Name")
 
     @reconnect_on_fail
-    def get_members(self):
-        """Return all members in the group as CSHMember objects"""
+    def get_member_uids(self):
+        """Return the uids of all members in the group"""
+
         res = self.__con__.search_s(
             self.__ldap_base_dn__,
             ldap.SCOPE_SUBTREE,
@@ -40,6 +41,9 @@ class CSHGroup:
 
         ret = []
         for val in res:
+            if 'uid' not in val[1]:
+                continue
+
             val = val[1]['uid'][0]
             try:
                 ret.append(val.decode('utf-8'))
@@ -48,10 +52,19 @@ class CSHGroup:
             except KeyError:
                 continue
 
+        return ret
+
+
+    @reconnect_on_fail
+    def get_members(self):
+        """Return all members in the group as CSHMember objects"""
+
+        uids = self.get_member_uids()
+
         return [CSHMember(self.__lib__,
                           result,
                           uid=True)
-                for result in ret]
+                for result in uids]
 
     @reconnect_on_fail
     def check_member(self, member, dn=False):

{csh_ldap-2.5.3/csh_ldap → csh_ldap-2.5.4.dev4/csh-ldap}/member.py

@@ -139,7 +139,7 @@ class CSHMember:
         if value is None:
             mod = (ldap_mod, key, None)
         else:
-            mod = (ldap_mod, key, value.encode('ascii'))
+            mod = (ldap_mod, key, value.encode('utf-8'))
 
         if self.__lib__.__batch_mods__:
             self.__lib__.enqueue_mod(self.__dn__, mod)

{csh_ldap-2.5.3 → csh_ldap-2.5.4.dev4}/csh_ldap.egg-info/PKG-INFO

@@ -1,10 +1,10 @@
 Metadata-Version: 2.4
-Name: csh_ldap
-Version: 2.5.3
+Name: csh-ldap
+Version: 2.5.4.dev4
 Summary: CSH LDAP ORM
-Home-page: https://github.com/ComputerScienceHouse/csh_ldap
-Author: Liam Middlebrook
-Author-email: liammiddlebrook@gmail.com
+Home-page: https://github.com/ComputerScienceHouse/csh-ldap
+Author: CSH RTP
+Author-email: rtp@csh.rit.edu
 License: MIT
 Classifier: Natural Language :: English
 Classifier: Operating System :: POSIX :: Linux
@@ -21,7 +21,7 @@ Dynamic: license-file
 Dynamic: requires-dist
 Dynamic: summary
 
-# csh_ldap
+# csh-ldap
 
 [![PyPI version](https://badge.fury.io/py/csh_ldap.svg)](https://badge.fury.io/py/csh_ldap)
 [![Build Status](https://travis-ci.org/liam-middlebrook/csh_ldap.svg?branch=master)](https://travis-ci.org/liam-middlebrook/csh_ldap)
@@ -31,13 +31,13 @@ Python 3 ORM for CSH LDAP
 
 ## Installation
 
-`pip install csh_ldap`
+`pip install csh-ldap`
 
 
 ## Usage
 
 ```
-import csh_ldap
+import csh-ldap
 
 # Create an unbatched instance
 instance = csh_ldap.CSHLDAP(bind_dn, bind_pw)
@@ -63,6 +63,38 @@ liam = instance.get_member_slackuid(slack_uid)
 # Get group by cn
 rtp = instance.get_group('rtp')
 
+# get group member uids 
+rtp = instance.get_group('rtp').get_member_uids()
+# returns ['spaced', ...]
+
+# get group member uids (other way)
+rtp = instance.get_group_member_uids(groups=["rtp"])
+
+# get uids of members in two (or more) groups and not in groups
+fancy = instance.get_group_member_uids(groups=["rtp", "onfloor"], excluded=["eboard-opcomm"])
+
+# get uuids of members in two (or more) groups and not in groups
+# that's right! ipaUniqueId
+fancy = instance.get_group_member_uuids(groups=["rtp", "onfloor"], excluded=["eboard-opcomm"])
+
+# get other miscellaneous attributes of members in group
+# look how rich drink admins are (admin abuse!!!)
+admin_abuse = instance.get_group_member_attributes(group=["drink"], attributes=["uid", "drinkBalance"])
+# returns dicts for each member
+"""
+I wonder what happened here
+[
+{
+    'uid': 'cole',
+    'drinkBalance': '996246'
+},
+{
+    'uid': 'zxcv',
+    'drinkBalance': '3847173'
+}
+]
+"""
+
 # Get cn of member
 print(liam.cn)
 

{csh_ldap-2.5.3 → csh_ldap-2.5.4.dev4}/csh_ldap.egg-info/SOURCES.txt

@@ -8,10 +8,10 @@ requirements.txt
 setup.cfg
 setup.py
 .github/workflows/python.yaml
-csh_ldap/__init__.py
-csh_ldap/group.py
-csh_ldap/member.py
-csh_ldap/utility.py
+csh-ldap/__init__.py
+csh-ldap/group.py
+csh-ldap/member.py
+csh-ldap/utility.py
 csh_ldap.egg-info/PKG-INFO
 csh_ldap.egg-info/SOURCES.txt
 csh_ldap.egg-info/dependency_links.txt

csh_ldap-2.5.4.dev4/csh_ldap.egg-info/pbr.json

@@ -0,0 +1 @@
+{"git_version": "506d989", "is_release": false}

csh_ldap-2.5.4.dev4/csh_ldap.egg-info/top_level.txt

@@ -0,0 +1 @@
+csh-ldap

{csh_ldap-2.5.3 → csh_ldap-2.5.4.dev4}/setup.cfg

@@ -1,13 +1,13 @@
 [metadata]
-name = csh_ldap
-author = Liam Middlebrook
-author_email = liammiddlebrook@gmail.com
-url = https://github.com/ComputerScienceHouse/csh_ldap
+name = csh-ldap
+author = CSH RTP
+author_email = rtp@csh.rit.edu
+url = https://github.com/ComputerScienceHouse/csh-ldap
 description = CSH LDAP ORM
 long_description = file: README.md
 long_description_content_type = text/markdown
 license = MIT
-version = 2.5.3
+version = 2.5.4
 classifier = 
 	Natural Language :: English
 	Operating System :: POSIX :: Linux

csh_ldap-2.5.3/csh_ldap.egg-info/pbr.json

@@ -1 +0,0 @@
-{"git_version": "1bfdfae", "is_release": false}

csh_ldap-2.5.3/csh_ldap.egg-info/top_level.txt

@@ -1 +0,0 @@
-csh_ldap