FilesExpand file tree

 develop

/

auths.py

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

130 lines (94 loc) · 3.99 KB

 develop

/

auths.py

Copy path

Top

File metadata and controls

• Code
• Blame

130 lines (94 loc) · 3.99 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

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

122

123

124

125

126

127

128

129

130

# -*- 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 = self._get_attribute(auth, 'url')

#: Details about the application (name, url)

self.app = self._get_attribute(auth, 'app', {})

#: Returns the Authorization token

self.token = self._get_attribute(auth, 'token')

#: App name

self.name = self._get_attribute(self.app, 'name')

#: URL about the note

self.note_url = self._get_attribute(auth, 'note_url')

#: Note about the authorization

self.note = self._get_attribute(auth, 'note')

#: List of scopes this applies to

self.scopes = self._get_attribute(auth, 'scopes')

#: Unique id of the authorization

self.id = self._get_attribute(auth, 'id')

#: datetime object representing when the authorization was created.

self.created_at = self._strptime_attribute(auth, 'created_at')

#: datetime object representing when the authorization was updated.

self.updated_at = self._strptime_attribute(auth, '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)