iframe-proxy | Sunbelt Computer Software

117 lines (86 loc) · 3.28 KB
# -*- 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 = self._get_attribute(hook, 'url')
        #: datetime object representing when this hook was last updated.
        self.updated_at = self._strptime_attribute(hook, 'updated_at')
        #: datetime object representing the date the hook was created.
        self.created_at = self._strptime_attribute(hook, 'created_at')
        #: The name of the hook.
        self.name = self._get_attribute(hook, 'name')
        #: Events which trigger the hook.
        self.events = self._get_attribute(hook, 'events')
        #: Whether or not this Hook is marked as active on GitHub
        self.active = self._get_attribute(hook, 'active')
        #: Dictionary containing the configuration for the Hook.
        self.config = self._get_attribute(hook, 'config')
        #: Unique id of the hook.
        self.id = self._get_attribute(hook, '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
        :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 removed 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)
Sunbelt Computer Software

PL/B Language Development and Support

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Sunbelt Computer Software

PL/B Language Development and Support

FilesExpand file tree

hook.py

Latest commit

History

hook.py

File metadata and controls
