mirror of
https://github.com/status-im/PyGithub.git
synced 2026-08-31 19:01:15 +00:00
193 lines
8.4 KiB
Python
193 lines
8.4 KiB
Python
# -*- coding: utf-8 -*-
|
|
|
|
############################ Copyrights and license ############################
|
|
# #
|
|
# Copyright 2012 Vincent Jacques <vincent@vincent-jacques.net> #
|
|
# Copyright 2012 Zearin <zearin@gonk.net> #
|
|
# Copyright 2013 Vincent Jacques <vincent@vincent-jacques.net> #
|
|
# #
|
|
# This file is part of PyGithub. http://jacquev6.github.com/PyGithub/ #
|
|
# #
|
|
# PyGithub is free software: you can redistribute it and/or modify it under #
|
|
# the terms of the GNU Lesser General Public License as published by the Free #
|
|
# Software Foundation, either version 3 of the License, or (at your option) #
|
|
# any later version. #
|
|
# #
|
|
# PyGithub is distributed in the hope that it will be useful, but WITHOUT ANY #
|
|
# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS #
|
|
# FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more #
|
|
# details. #
|
|
# #
|
|
# You should have received a copy of the GNU Lesser General Public License #
|
|
# along with PyGithub. If not, see <http://www.gnu.org/licenses/>. #
|
|
# #
|
|
################################################################################
|
|
|
|
import github.GithubObject
|
|
|
|
import github.AuthorizationApplication
|
|
|
|
|
|
class Authorization(github.GithubObject.CompletableGithubObject):
|
|
"""
|
|
This class represents Authorizations as returned for example by http://developer.github.com/v3/todo
|
|
"""
|
|
|
|
@property
|
|
def app(self):
|
|
"""
|
|
:type: :class:`github.AuthorizationApplication.AuthorizationApplication`
|
|
"""
|
|
self._completeIfNotSet(self._app)
|
|
return self._NoneIfNotSet(self._app)
|
|
|
|
@property
|
|
def created_at(self):
|
|
"""
|
|
:type: datetime.datetime
|
|
"""
|
|
self._completeIfNotSet(self._created_at)
|
|
return self._NoneIfNotSet(self._created_at)
|
|
|
|
@property
|
|
def id(self):
|
|
"""
|
|
:type: integer
|
|
"""
|
|
self._completeIfNotSet(self._id)
|
|
return self._NoneIfNotSet(self._id)
|
|
|
|
@property
|
|
def note(self):
|
|
"""
|
|
:type: string
|
|
"""
|
|
self._completeIfNotSet(self._note)
|
|
return self._NoneIfNotSet(self._note)
|
|
|
|
@property
|
|
def note_url(self):
|
|
"""
|
|
:type: string
|
|
"""
|
|
self._completeIfNotSet(self._note_url)
|
|
return self._NoneIfNotSet(self._note_url)
|
|
|
|
@property
|
|
def scopes(self):
|
|
"""
|
|
:type: list of string
|
|
"""
|
|
self._completeIfNotSet(self._scopes)
|
|
return self._NoneIfNotSet(self._scopes)
|
|
|
|
@property
|
|
def token(self):
|
|
"""
|
|
:type: string
|
|
"""
|
|
self._completeIfNotSet(self._token)
|
|
return self._NoneIfNotSet(self._token)
|
|
|
|
@property
|
|
def updated_at(self):
|
|
"""
|
|
:type: datetime.datetime
|
|
"""
|
|
self._completeIfNotSet(self._updated_at)
|
|
return self._NoneIfNotSet(self._updated_at)
|
|
|
|
@property
|
|
def url(self):
|
|
"""
|
|
:type: string
|
|
"""
|
|
self._completeIfNotSet(self._url)
|
|
return self._NoneIfNotSet(self._url)
|
|
|
|
def delete(self):
|
|
"""
|
|
:calls: `DELETE /authorizations/:id <http://developer.github.com/v3/oauth>`_
|
|
:rtype: None
|
|
"""
|
|
headers, data = self._requester.requestJsonAndCheck(
|
|
"DELETE",
|
|
self.url,
|
|
None,
|
|
None
|
|
)
|
|
|
|
def edit(self, scopes=github.GithubObject.NotSet, add_scopes=github.GithubObject.NotSet, remove_scopes=github.GithubObject.NotSet, note=github.GithubObject.NotSet, note_url=github.GithubObject.NotSet):
|
|
"""
|
|
:calls: `PATCH /authorizations/:id <http://developer.github.com/v3/oauth>`_
|
|
:param scopes: list of string
|
|
:param add_scopes: list of string
|
|
:param remove_scopes: list of string
|
|
:param note: string
|
|
:param note_url: string
|
|
:rtype: None
|
|
"""
|
|
assert scopes is github.GithubObject.NotSet or all(isinstance(element, (str, unicode)) for element in scopes), scopes
|
|
assert add_scopes is github.GithubObject.NotSet or all(isinstance(element, (str, unicode)) for element in add_scopes), add_scopes
|
|
assert remove_scopes is github.GithubObject.NotSet or all(isinstance(element, (str, unicode)) for element in remove_scopes), remove_scopes
|
|
assert note is github.GithubObject.NotSet or isinstance(note, (str, unicode)), note
|
|
assert note_url is github.GithubObject.NotSet or isinstance(note_url, (str, unicode)), note_url
|
|
post_parameters = dict()
|
|
if scopes is not github.GithubObject.NotSet:
|
|
post_parameters["scopes"] = scopes
|
|
if add_scopes is not github.GithubObject.NotSet:
|
|
post_parameters["add_scopes"] = add_scopes
|
|
if remove_scopes is not github.GithubObject.NotSet:
|
|
post_parameters["remove_scopes"] = remove_scopes
|
|
if note is not github.GithubObject.NotSet:
|
|
post_parameters["note"] = note
|
|
if note_url is not github.GithubObject.NotSet:
|
|
post_parameters["note_url"] = note_url
|
|
headers, data = self._requester.requestJsonAndCheck(
|
|
"PATCH",
|
|
self.url,
|
|
None,
|
|
post_parameters
|
|
)
|
|
self._useAttributes(data)
|
|
|
|
def _initAttributes(self):
|
|
self._app = github.GithubObject.NotSet
|
|
self._created_at = github.GithubObject.NotSet
|
|
self._id = github.GithubObject.NotSet
|
|
self._note = github.GithubObject.NotSet
|
|
self._note_url = github.GithubObject.NotSet
|
|
self._scopes = github.GithubObject.NotSet
|
|
self._token = github.GithubObject.NotSet
|
|
self._updated_at = github.GithubObject.NotSet
|
|
self._url = github.GithubObject.NotSet
|
|
|
|
def _useAttributes(self, attributes):
|
|
if "app" in attributes: # pragma no branch
|
|
assert attributes["app"] is None or isinstance(attributes["app"], dict), attributes["app"]
|
|
self._app = None if attributes["app"] is None else github.AuthorizationApplication.AuthorizationApplication(self._requester, attributes["app"], completed=False)
|
|
if "created_at" in attributes: # pragma no branch
|
|
assert attributes["created_at"] is None or isinstance(attributes["created_at"], (str, unicode)), attributes["created_at"]
|
|
self._created_at = self._parseDatetime(attributes["created_at"])
|
|
if "id" in attributes: # pragma no branch
|
|
assert attributes["id"] is None or isinstance(attributes["id"], (int, long)), attributes["id"]
|
|
self._id = attributes["id"]
|
|
if "note" in attributes: # pragma no branch
|
|
assert attributes["note"] is None or isinstance(attributes["note"], (str, unicode)), attributes["note"]
|
|
self._note = attributes["note"]
|
|
if "note_url" in attributes: # pragma no branch
|
|
assert attributes["note_url"] is None or isinstance(attributes["note_url"], (str, unicode)), attributes["note_url"]
|
|
self._note_url = attributes["note_url"]
|
|
if "scopes" in attributes: # pragma no branch
|
|
assert attributes["scopes"] is None or all(isinstance(element, (str, unicode)) for element in attributes["scopes"]), attributes["scopes"]
|
|
self._scopes = attributes["scopes"]
|
|
if "token" in attributes: # pragma no branch
|
|
assert attributes["token"] is None or isinstance(attributes["token"], (str, unicode)), attributes["token"]
|
|
self._token = attributes["token"]
|
|
if "updated_at" in attributes: # pragma no branch
|
|
assert attributes["updated_at"] is None or isinstance(attributes["updated_at"], (str, unicode)), attributes["updated_at"]
|
|
self._updated_at = self._parseDatetime(attributes["updated_at"])
|
|
if "url" in attributes: # pragma no branch
|
|
assert attributes["url"] is None or isinstance(attributes["url"], (str, unicode)), attributes["url"]
|
|
self._url = attributes["url"]
|