Repository navigation
Expand file tree
/
Copy pathauths.py
More file actions
121 lines (94 loc) · 3.86 KB
/
Copy pathauths.py
File metadata and controls
121 lines (94 loc) · 3.86 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
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
# -*- coding: utf-8 -*-
"""
github3.auths
=============
This module contains the Authorization object.
"""
from __future__ import unicode_literals
from .decorators import requires_basic_auth
from .models import GitHubCore
class Authorization(GitHubCore):
"""The :class:`Authorization <Authorization>` object.
Two authorization instances can be checked like so::
a1 == a2
a1 != a2
And is equivalent to::
a1.id == a2.id
a1.id != a2.id
See also: http://developer.github.com/v3/oauth/#oauth-authorizations-api
"""
def _update_attributes(self, auth):
self._api = auth.get('url')
#: Details about the application (name, url)
self.app = auth.get('app', {})
#: Returns the Authorization token
self.token = auth.get('token', '')
#: App name
self.name = self.app.get('name', '')
#: URL about the note
self.note_url = auth.get('note_url') or ''
#: Note about the authorization
self.note = auth.get('note') or ''
#: List of scopes this applies to
self.scopes = auth.get('scopes', [])
#: Unique id of the authorization
self.id = auth.get('id', 0)
#: datetime object representing when the authorization was created.
self.created_at = self._strptime(auth.get('created_at'))
#: datetime object representing when the authorization was updated.
self.updated_at = self._strptime(auth.get('updated_at'))
def _repr(self):
return '<Authorization [{0}]>'.format(self.name)
def _update(self, scopes_data, note, note_url):
"""Helper for add_scopes, replace_scopes, remove_scopes."""
if note is not None:
scopes_data['note'] = note
if note_url is not None:
scopes_data['note_url'] = note_url
json = self._json(self._post(self._api, data=scopes_data), 200)
if json:
self._update_attributes(json)
return True
return False
@requires_basic_auth
def add_scopes(self, scopes, note=None, note_url=None):
"""Adds the scopes to this authorization.
.. versionadded:: 1.0
:param list scopes: Adds these scopes to the ones present on this
authorization
:param str note: (optional), Note about the authorization
:param str note_url: (optional), URL to link to when the user views
the authorization
:returns: True if successful, False otherwise
:rtype: bool
"""
return self._update({'add_scopes': scopes}, note, note_url)
@requires_basic_auth
def delete(self):
"""Delete this authorization."""
return self._boolean(self._delete(self._api), 204, 404)
@requires_basic_auth
def remove_scopes(self, scopes, note=None, note_url=None):
"""Remove the scopes from this authorization.
.. versionadded:: 1.0
:param list scopes: Remove these scopes from the ones present on this
authorization
:param str note: (optional), Note about the authorization
:param str note_url: (optional), URL to link to when the user views
the authorization
:returns: True if successful, False otherwise
:rtype: bool
"""
return self._update({'rm_scopes': scopes}, note, note_url)
@requires_basic_auth
def replace_scopes(self, scopes, note=None, note_url=None):
"""Replace the scopes on this authorization.
.. versionadded:: 1.0
:param list scopes: Use these scopes instead of the previous list
:param str note: (optional), Note about the authorization
:param str note_url: (optional), URL to link to when the user views
the authorization
:returns: True if successful, False otherwise
:rtype: bool
"""
return self._update({'scopes': scopes}, note, note_url)