aboutsummaryrefslogtreecommitdiffstats
path: root/github3/core.py
blob: d7237af0f9727998bdbea0851c4aa101eb75f682 (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
#!/usr/bin/env python
# -*- encoding: utf-8 -*-
#
# author: David Medina

class Paginate:
    """ Paginate resource iterator

    :param resource: URL resource
    :param requester: Bound method to request. See `GithubCore.get`
    :param kwargs: Args to request (params)
    """

    def __init__(self, resource, requester, **kwargs):
        self.resource = resource
        self.requester = requester
        self.kwargs = kwargs
        self.page = 1

    def _last_page(self, link):
        """ Get and cached last page from link header """
        if not getattr(self, 'last', False):
            from github3.packages.link_header import parse_link_value
            from urlparse import urlparse, parse_qs
            for link, rels in parse_link_value(link).items():
                if rels.get('rel') == 'last':
                    query = urlparse(link).query
                    self.last = int(parse_qs(query).get('page').pop())

        return self.last

    # TODO: reset iterators... multiple?
    def __iter__(self):
        return self

    def initial(self):
        """ First request. Force requester to paginate returning link header """
        link, content = self.requester(self.resource, paginate=True,
                                       page=1, **self.kwargs)
        self.last = self._last_page(link) if link else 1
        return content

    def next(self):
        if self.page == 1:
            content = self.initial()
            self.page += 1
            return content
        else:
            if self.page > self.last:
                raise StopIteration
            else:
                content = self.requester(self.resource, page=self.page,
                                         **self.kwargs)
                self.page += 1
                return content

class Converter(object):
    """ Abstract converter class """

    def loads(self):
        raise NotImplementedError("%s needs define '%s' method" %
            (self.__class__.__name__, 'loads'))

    def dumps(self):
        raise NotImplementedError("%s needs define '%s' method" %
            (self.__class__.__name__, 'dumps'))

    def inject(self):
        raise NotImplementedError("%s needs define '%s' method" %
            (self.__class__.__name__, 'inject'))