mcommunity.py 16.7 KB
Newer Older
Rob Carleski's avatar
Rob Carleski committed
1
2
3
4
5
6
7
8
import requests
import json

from urllib.parse import quote
from requests.packages.urllib3.util.retry import Retry
from requests.adapters import HTTPAdapter


9
class Client:
Rob Carleski's avatar
Rob Carleski committed
10

11
12
13
14
15
16
17
18
19
20
21
22
23
    def __init__(self, config):
        """Initialize a new Mcommunity API Client

        Parameters
        ----------
        config : dict
            A dictionary of configuration options. Must contain,
            at minimum, 'client_id' and 'secret' keys.

        Returns
        -------
        None
        """
Rob Carleski's avatar
Rob Carleski committed
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615

        self.url_base = 'https://apigw.it.umich.edu/um'
        self.timeout = 10
        self.port = 80

        if isinstance(config, dict):
            self.__dict__.update(config)

        self.scope = 'iamgroups'
        self.token_url = self.url_base + '/inst/oauth2/token'
        self.call_url = self.url_base + '/iamGroups'

        self.session = requests.Session()
        retries = Retry(
            total=5,
            backoff_factor=0.2,
            status_forcelist=[500, 502, 503, 504]
        )
        self.session.mount('http://', HTTPAdapter(max_retries=retries))

        try:
            self._request_token()
        except KeyError:
            raise KeyError('Unable to get access token from API')

        self.headers = {
            'x-ibm-client-id': '{}'.format(self.client_id),
            'authorization': 'Bearer {}'.format(self.token),
            'accept': 'application/json'
        }

    def _request_token(self):
        data = {
            'grant_type': 'client_credentials',
            'scope': 'constituents'
        }

        headers = {
            'Content-type': 'application/x-www-form-urlencoded',
            'accept': 'application/json'
        }

        url_append = '?grant_type=client_credentials&scope={}'.format(
            self.scope
        )
        url = self.token_url + url_append

        r = self.session.post(
            url,
            data=json.dumps(data),
            headers=headers,
            auth=(self.client_id, self.secret),
            timeout=self.timeout
        )

        self.token = r.json()['access_token']

    def _validate_name(self, name):
        """Validate a given name against MCommunity standards

        Parameters
        ----------
        name : str
            The name to validate

        Returns
        -------
        boolean
            true or false, depending on validity status.
        """

        endpoint = self.call_url + '/isValidName/{}'.format(name)
        r = self.session.get(
            url=endpoint,
            headers=self.headers,
            timeout=self.timeout
        )

        if r.json()['valid']:
            return True
        else:
            raise ValueError(r.json()['error'][0]['message'])

    def _create_entity_ldap(self, name):
        """Create an LDAP string for a given object

        Parameters
        ---------
        name : str
            The name of the object

        Returns
        -------
        str
            An LDAP string representation of the object.
        """
        if '=' in name or '@' in name:
            return name

        endpoint = self.call_url + '/find/both/{}'.format(name)
        r = self.session.get(
            url=endpoint,
            headers=self.headers,
            timeout=self.timeout
        )
        if r.status_code == requests.codes.ok:
            data = r.json()
            if data[0]['person']:
                return 'uid={},ou=people,dc=umich,dc=edu'.format(
                    name
                )
            elif data[0]['group']:
                return data[0]['dn'].lower()
            else:
                raise ValueError('Entity found but unidentifiable.')

    def _apply_update(self, endpoint):
        """Generic update function

        Parameters
        ----------
        endpoint : str
            The API endpoint to POST data to

        Returns
        -------
        obj
            A Requests response object
        """
        endpoint = self.call_url + endpoint
        r = self.session.post(
            url=endpoint,
            data=json.dumps(self.group_data),
            headers=self.headers,
            timeout=self.timeout
        )

        if r.status_code == requests.codes.ok:
            if r.json()['status'] == 'success':
                return r
        else:
            raise Exception('{}: {}'.format(r.status_code, r.text))

    def fetch_group(self, name):
        """Fetch information for an mcommunity group

        Parameters
        ----------
        name : str
            The name of the mcommunity group to fetch data for

        Returns
        -------
        None
            Nothing returned; self.group_data is populated instead.
        """

        dn = self._create_entity_ldap(name)
        encoded_dn = quote(dn)
        endpoint = self.call_url + '/profile/dn/{}'.format(encoded_dn)
        r = self.session.get(
            url=endpoint,
            headers=self.headers,
            timeout=self.timeout
        )

        if r.status_code == requests.codes.ok:
            self.group_data = r.json()['group'][0]
        else:
            raise Exception('{}: {}'.format(r.status_code, r.text))

    def fetch_person(self, name):
        """Fetch information about a user from mcommunity

        Parameters
        ----------
        name : str
            The uniqname of the user to fetch data for

        Returns
        -------
        dict
            A dict of user information
        """
        endpoint = self.call_url + '/find/person/{}'.format(name)
        r = self.session.get(
            url=endpoint,
            headers=self.headers,
            timeout=self.timeout
        )

        if r.status_code == requests.codes.ok:
            return r.json()
        else:
            raise Exception('{}: {}'.format(r.status_code, r.text))

    def create_group(self, name):
        """Create a new mcommunity group

        Parameters
        ----------
        name : str
            The name of the mcommunity group to create

        Returns
        -------
        none
            Nothing returned. After creation, group is fetched.
        """

        if self._validate_name(name):
            endpoint = self.call_url + '/create'
            data = {
                'name': name
            }

            self.session.post(
                url=endpoint,
                data=json.dumps(data),
                headers=self.headers,
                timeout=self.timeout
            )

            self.fetch_group(name)

    def delete_group(self, name):
        """Delete an mcommunity group

        Parameters
        ----------
        name : str
            The name of the group to delete

        Returns
        -------
        dict
            A dict of response information from the server.
        """

        dn = self._create_entity_ldap(name)
        encoded_dn = quote(dn)
        endpoint = self.call_url + '/delete/{}'.format(encoded_dn)
        r = self.session.get(
            url=endpoint,
            headers=self.headers,
            timeout=self.timeout
        )
        if r.status_code == requests.codes.ok:
            return r.json()
        else:
            raise Exception('{}: {}'.format(r.status_code, r.text))

    def renew_group(self, name):
        """Renew an mcommunity group

        Parameters
        ----------
        name : str
            The name of the group to renew

        Returns
        -------
        dict
            A dict of response information from the server.
        """
        dn = self._create_entity_ldap(name)
        encoded_dn = quote(dn)
        endpoint = self.call_url + '/renew/{}'.format(encoded_dn)
        r = self.session.get(
            url=endpoint,
            headers=self.headers,
            timeout=self.timeout
        )

        if r.status_code == requests.codes.ok:
            return r.json()
        else:
            raise Exception('{}: {}'.format(r.status_code, r.text))

    # TODO: This endpoint appears to be broken right now.
    # We should come back to this, though.
    # Endpoint: /reserve/{dn}
    def reserve_group(self, name):
        pass

    def update_group_aliases(self, aliases):
        """Update mcommunity group aliases

        Parameters
        ----------
        aliases : str, list
            A single alias, or a list thereof.

        Returns
        -------
        dict
            A dict of response information from the server.
        """

        if not isinstance(aliases, list):
            aliases = [aliases]

        for alias in aliases:
            if self._validate_name(alias):
                if self.group_data['aliases']:
                    self.group_data['aliases'].append(alias)
                else:
                    self.group_data['aliases'] = [alias]
            else:
                print('{} is an invalid alias.'.format(alias))

        return self._apply_update('/update/aliases')

    def update_group_description(self, description):
        """Update mcommunity group description

        Parameters
        ----------
        description : str
            A description to apply to the group.

        Returns
        -------
        dict
            A dict of response information from the server.
        """
        self.group_data['description'] = str(description)
        return self._apply_update('/update/description')

    def update_group_notice(self, notice):
        """Update mcommunity group notice

        Parameters
        ----------
        notice : str
            A notice to apply to the group.

        Returns
        -------
        dict
            A dict of response information from the server.
        """
        self.group_data['notice'] = str(notice)
        return self._apply_update('/update/notice')

    def update_group_links(self, links):
        """Update mcommunity group external links

        Parameters
        ----------
        links : str, tuple, list
            A single HTTP link, a tuple of (name,uri), or a list of either.

        Returns
        -------
        dict
            A dict of response information from the server.
        """
        if not isinstance(links, list):
            links = [links]

        if not self.group_data['labeledUri']:
            self.group_data['labeledUri'] = []

        for link in links:
            if isinstance(link, tuple):
                self.group_data['labeledUri'].append({
                    'urlLabel': link[0],
                    'urlValue': link[1]
                })
            else:
                self.group_data['labeledUri'].append({'urlValue': link})

        return self._apply_update('/update/links')

    def add_group_members(self, members):
        """Add members to an mcommunity group.

        Parameters
        ----------
        members : str, list
            A single uniqname, group name, or external member address, or
            a list containing any combination thereof.

        Returns
        -------
        dict
            A dict of response information from the server.
        """
        if not isinstance(members, list):
            members = [members]
        members = [self._create_entity_ldap(x) for x in members]

        for member in members:
            if 'uid=' in member:
                if self.group_data['memberDn']:
                    self.group_data['memberDn'].append(member)
                else:
                    self.group_data['memberDn'] = [member]
            elif 'cn=' in member:
                if self.group_data['memberGroupDn']:
                    self.group_data['memberGroupDn'].append(member)
                else:
                    self.group_data['memberGroupDn'] = [member]
            elif '@' in member:
                if self.group_data['memberExternal']:
                    self.group_data['memberExternal'].append({'email': member})
                else:
                    self.group_data['memberExternal'] = [{'email': member}]

        return self.update_group_members()

    def remove_group_members(self, members):
        """Remove members fron an mcommunity group.

        Parameters
        ----------
        members : str, list
            A single uniqname, group name, or external member address, or
            a list containing any combination thereof.

        Returns
        -------
        dict
            A dict of response information from the server.
        """
        if not isinstance(members, list):
            members = [members]
        members = [self._create_entity_ldap(x) for x in members]

        for member in members:
            try:
                if 'uid=' in member:
                    self.group_data['memberDn'].remove(member)
                elif 'cn=' in member:
                    self.group_data['memberGroupDn'].remove(member)
                elif '@' in member:
                    purge_external = True
            except ValueError:
                print('Couldnt remove {}'.format(member))
                pass
            except AttributeError:
                pass

        if purge_external:
            for index, _ in enumerate(self.group_data['memberExternal']):
                if _['email'] in members:
                    del(self.group_data['memberExternal'][index])

        return self.update_group_members()

    def update_group_members(self):
        """Generic endpoint for updating members

        Parameters
        ----------
        none

        Returns
        -------
        dict
            A dict of response information from the server.
        """
        endpoints = [
            '/update/member',
            '/update/groupMember',
            '/update/externalMember'
        ]

        results = []

        for endpoint in endpoints:
            r = self._apply_update(endpoint)
            results.append(r)

        return results

    def update_group_moderators(self, moderators):
        """Update mcommunity group moderators

        Parameters
        ----------
        links : str, tuple, list
            A single email address, a tuple of (name,address), or
            a list of either.

        Returns
        -------
        dict
            A dict of response information from the server.
        """
        if not isinstance(moderators, list):
            moderators = [moderators]

        if not self.group_data['moderator']:
            self.group_data['moderator'] = []

        for moderator in moderators:
            if isinstance(moderator, tuple):
                self.group_data['moderator'].append({
                    'name': moderator[0],
                    'email': moderator[1]
                })
            else:
                self.group_data['moderator'].append({'email': moderator})

        return self._apply_update('/update/moderator')

    def add_group_owners(self, owners):
        """Add mcommunity group owners

        Parameters
        ----------
        links : str, list
            A single owner user or group, or a list of a combination
            of either

        Returns
        -------
        dict
            A dict of response information from the server.
        """
        if not isinstance(owners, list):
            owners = [owners]
        owners = [self._create_entity_ldap(x) for x in owners]
        self.group_data['ownerDn'] += owners

        return self.update_group_owners()

    def remove_group_owners(self, owners):
        """Remove mcommunity group owners

        Parameters
        ----------
        links : str, list
            A single owner user or group, or a list of a combination
            of either

        Returns
        -------
        dict
            A dict of response information from the server.
        """
        if not isinstance(owners, list):
            owners = [owners]
        owners = [self._create_entity_ldap(x) for x in owners]

        for owner in owners:
            try:
                self.group_data['ownerDn'].remove(owner)
            except ValueError:
                pass

        return self.update_group_owners()

    def update_group_owners(self):
        return self._apply_update('/update/owner')
        """Generic endpoint for updating owners

        Parameters
        ----------
        none

        Returns
        -------
        dict
            A dict of response information from the server.
        """

    def update_group_settings(self):
        """Generic endpoint for updating the following settings:
            - isprivate
            - isjoinable
            - IsSpamBlocked
            - IsEmailableByMembersOnly
            - IsEmailWarningSuspended

        Attributes are updated manually, and function is run. Example:
        conn = fetch_group('testgroup')
        conn.group_data['isprivate'] = True
        conn.update_group_settings()

        Parameters
        ----------
        none

        Returns
        -------
        dict
            A dict of response information from the server.
        """
        return self._apply_update('/update/settings')