FilesExpand file tree

 develop

/

hook.py

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

110 lines (86 loc) · 3.16 KB

 develop

/

hook.py

Copy path

Top

File metadata and controls

• Code
• Blame

110 lines (86 loc) · 3.16 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

# -*- coding: utf-8 -*-

"""

github3.repos.hook

==================

This module contains only the Hook object for GitHub's Hook API.

"""

from __future__ import unicode_literals

from json import dumps

from ..decorators import requires_auth

from ..models import GitHubCore

class Hook(GitHubCore):

"""The :class:`Hook <Hook>` object. This handles the information returned

by GitHub about hooks set on a repository.

Two hook instances can be checked like so::

h1 == h2

h1 != h2

And is equivalent to::

h1.id == h2.id

h1.id != h2.id

See also: http://developer.github.com/v3/repos/hooks/

"""

def _update_attributes(self, hook, session=None):

self._api = hook.get('url', '')

#: datetime object representing when this hook was last updated.

self.updated_at = self._strptime(hook.get('updated_at'))

#: datetime object representing the date the hook was created.

self.created_at = self._strptime(hook.get('created_at'))

#: The name of the hook.

self.name = hook.get('name')

#: Events which trigger the hook.

self.events = hook.get('events')

#: Whether or not this Hook is marked as active on GitHub

self.active = hook.get('active')

#: Dictionary containing the configuration for the Hook.

self.config = hook.get('config')

#: Unique id of the hook.

self.id = hook.get('id')

def _repr(self):

return '<Hook [{0}]>'.format(self.name)

@requires_auth

def delete(self):

"""Delete this hook.

:returns: bool

"""

return self._boolean(self._delete(self._api), 204, 404)

@requires_auth

def edit(self, config={}, events=[], add_events=[], rm_events=[],

active=True):

"""Edit this hook.

:param dict config: (optional), key-value pairs of settings for this

hook

:param list events: (optional), which events should this be triggered

for

:param list add_events: (optional), events to be added to the list of

events that this hook triggers for

:param list rm_events: (optional), events to be remvoed from the list

of events that this hook triggers for

:param bool active: (optional), should this event be active

:returns: bool

"""

data = {'config': config, 'active': active}

if events:

data['events'] = events

if add_events:

data['add_events'] = add_events

if rm_events:

data['remove_events'] = rm_events

json = self._json(self._patch(self._api, data=dumps(data)), 200)

if json:

self._update_attributes(json)

return True

return False

@requires_auth

def ping(self):

"""Ping this hook.

:returns: bool

"""

url = self._build_url('pings', base_url=self._api)

return self._boolean(self._post(url), 204, 404)

@requires_auth

def test(self):

"""Test this hook

:returns: bool

"""

url = self._build_url('tests', base_url=self._api)

return self._boolean(self._post(url), 204, 404)