Commit9199f6a

committed

Merge pull requestsigmavirus24#33 from seveas/requires_basic_auth

Better error messages for authorization methods

2 parentsbfa988e +e3e6c38 commit9199f6aCopy full SHA for 9199f6a

File tree

+37

-4

lines changed

+37

-4

lines changed

Lines changed: 3 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -6,6 +6,7 @@`
`6`	`6`
`7`	`7`	`"""`
`8`	`8`
	`9`	`+fromgithub3.decoratorsimportrequires_basic_auth`
`9`	`10`	`fromgithub3.modelsimportGitHubCore`
`10`	`11`	`fromjsonimportdumps`
`11`	`12`
`@@ -44,10 +45,12 @@ def __repr__(self):`
`44`	`45`	`def_update_(self,auth):`
`45`	`46`	`self.__init__(auth,self._session)`
`46`	`47`
	`48`	`+@requires_basic_auth`
`47`	`49`	`defdelete(self):`
`48`	`50`	`"""delete this authorization"""`
`49`	`51`	`returnself._boolean(self._delete(self._api),204,404)`
`50`	`52`
	`53`	`+@requires_basic_auth`
`51`	`54`	`defupdate(self,scopes=[],add_scopes=[],rm_scopes=[],note='',`
`52`	`55`	`note_url=''):`
`53`	`56`	`"""Update this authorization.`

Lines changed: 30 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -50,3 +50,33 @@ def auth_wrapper(self, args, *kwargs):`
`50`	`50`	`r.raw=StringIO('{"message": "Requires authentication"}'.encode())`
`51`	`51`	`raiseGitHubError(r)`
`52`	`52`	`returnauth_wrapper`
	`53`	`+`
	`54`	`+defrequires_basic_auth(func):`
	`55`	`+"""Decorator to note which object methods require username/password`
	`56`	`+ authorization and won't work with token based authorization.`
	`57`	`+`
	`58`	`+ .. note::`
	`59`	`+ This decorator causes the wrapped methods to lose their proper`
	`60`	`+ signature. Please refer to the documentation for each of those.`
	`61`	`+ """`
	`62`	`+#note = """.. note::`
	`63`	`+#The signature of this function may not appear correctly in`
	`64`	`+#documentation. Please adhere to the defined parameters and their`
	`65`	`+#types.`
	`66`	`+#"""`
	`67`	`+## Append the above note to each function this is applied to`
	`68`	`+#func.__doc__ = '\n\n'.join([func.__doc__, note])`
	`69`	`+`
	`70`	`+@wraps(func)`
	`71`	`+defauth_wrapper(self,args,*kwargs):`
	`72`	`+ifhasattr(self,'_session')andself._session.auth:`
	`73`	`+returnfunc(self,args,*kwargs)`
	`74`	`+else:`
	`75`	`+fromgithub3.modelsimportGitHubError`
	`76`	`+# Mock a 401 response`
	`77`	`+r=Response()`
	`78`	`+r.status_code=401`
	`79`	`+r.encoding='utf-8'`
	`80`	`+r.raw=StringIO('{"message": "Requires username/password authentication"}'.encode())`
	`81`	`+raiseGitHubError(r)`
	`82`	`+returnauth_wrapper`

Lines changed: 4 additions & 4 deletions

Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,7 @@`
`17`	`17`	`fromgithub3.orgsimportOrganization`
`18`	`18`	`fromgithub3.reposimportRepository`
`19`	`19`	`fromgithub3.usersimportUser,Key`
`20`		`-fromgithub3.decoratorsimportrequires_auth`
	`20`	`+fromgithub3.decoratorsimportrequires_auth,requires_basic_auth`
`21`	`21`
`22`	`22`
`23`	`23`	`classGitHub(GitHubCore):`
`@@ -40,7 +40,7 @@ def _iter_follow(self, which, number):`
`40`	`40`	`url=self._build_url('user',which)`
`41`	`41`	`returnself._iter(number,url,User)`
`42`	`42`
`43`		`-@requires_auth`
	`43`	`+@requires_basic_auth`
`44`	`44`	`defauthorization(self,id_num):`
`45`	`45`	"""Get information about authorization ``id``.
`46`	`46`
`@@ -320,7 +320,7 @@ def issue(self, owner, repository, number):`
`320`	`320`	`returnrepo.issue(number)`
`321`	`321`	`returnNone`
`322`	`322`
`323`		`-@requires_auth`
	`323`	`+@requires_basic_auth`
`324`	`324`	`deflist_authorizations(self):`
`325`	`325`	`"""List authorizations for the authenticated user.`
`326`	`326`
`@@ -330,7 +330,7 @@ def list_authorizations(self):`
`330`	`330`	`json=self._json(self._get(url),200)`
`331`	`331`	`return [Authorization(a,self)forainjson]`
`332`	`332`
`333`		`-@requires_auth`
	`333`	`+@requires_basic_auth`
`334`	`334`	`defiter_authorizations(self,number=-1):`
`335`	`335`	`"""Iterate over authorizations for the authenticated user.`
`336`	`336`

Comments

(0)