aboutsummaryrefslogtreecommitdiffstats
path: root/github3/handlers/base.py
blob: 565978f7627bd58f8c09ea962a626a005196745d (plain) (blame)
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
#!/usr/bin/env python
# -*- encoding: utf-8 -*-

from github3.core import Paginate
from github3.converters import Modelizer


class MimeTypeMixin(object):

    VERSION = 'beta'

    def __init__(self):
        self.mimetypes = set()

    def _parse_mime_type(self, type):
        return 'application/vnd.github.%s.%s+json' % (
            self.VERSION, type)

    def add_raw(self):
        self.mimetypes.add(self._parse_mime_type('raw'))
        return self

    def add_text(self):
        self.mimetypes.add(self._parse_mime_type('text'))
        return self

    def add_html(self):
        self.mimetypes.add(self._parse_mime_type('html'))
        return self

    def add_full(self):
        self.mimetypes.add(self._parse_mime_type('full'))
        return self

    def mime_header(self):
        if self.mimetypes:
            return {'Accept': ', '.join(self.mimetypes)}
        return None


class Handler(object):
    """ Handler base. Requests to API and modelize responses """

    def __init__(self, gh):
        self._gh = gh
        super(Handler, self).__init__()

    def _inject_handler(self, handler, prefix=''):
        import inspect
        for method, callback in inspect.getmembers(handler):
            if method.startswith(prefix) and inspect.ismethod(callback):
                setattr(self, method, callback)

    def _prefix_resource(self, resource):
        prefix = getattr(self, 'prefix', '')
        return '/'.join((prefix, str(resource))).strip('/')

    def _get_converter(self, kwargs={}):
        converter = kwargs.pop(
            'converter',  # 1. in kwargs
            getattr(self, 'converter',  # 2. in handler
            Modelizer))  # 3. Default

        return converter()

    def _put(self, resource, **kwargs):
        """ Put proxy request"""

        return self._bool(resource, method='put', **kwargs)

    def _delete(self, resource, **kwargs):
        """ Delete proxy request"""

        return self._bool(resource, method='delete', **kwargs)

    def _bool(self, resource, **kwargs):
        """ Handler request to boolean response """

        from github3.exceptions import NotFound
        resource = self._prefix_resource(resource)
        try:
            callback = getattr(self._gh, kwargs.get('method', ''),
                               self._gh.head)
            response = callback(resource, **kwargs)
        except NotFound:
            return False
        assert response.status_code == 204
        return True

    def _get_resources(self, resource, model=None, limit=None, **kwargs):
        """ Hander request to multiple resources """

        if limit:
            limit = abs(limit)
        resource = self._prefix_resource(resource)
        converter = self._get_converter(kwargs)
        counter = 1
        for page in Paginate(resource, self._gh.get, **kwargs):
            for raw_resource in page:
                counter += 1
                converter.inject(model)
                yield converter.loads(raw_resource)
                if limit and counter > limit:
                    break
            else:
                continue
            break

    def _get_resource(self, resource, model=None, **kwargs):
        """ Handler request to single resource """

        resource = self._prefix_resource(resource)
        converter = self._get_converter(kwargs)
        raw_resource = self._gh.get(resource, **kwargs)
        converter.inject(model)
        return converter.loads(raw_resource)

    def _post_resource(self, resource, data, model=None, **kwargs):
        """ Handler request to create a resource """

        resource = self._prefix_resource(resource)
        raw_resource = self._gh.post(resource, data=data)
        converter = self._get_converter(kwargs)
        converter.inject(model)
        return converter.loads(raw_resource)