aboutsummaryrefslogtreecommitdiffstats
path: root/github3/api.py
blob: 0a6915ce0fed9cfd01bda4a9a6a5d2c45bd8f19a (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
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
# -*- coding: utf-8 -*-

"""
github3.api
~~~~~~~~~~~

This module provies the core GitHub3 API interface.
"""

import omnijson as json

from .models import *
from .helpers import is_collection, to_python, to_api, get_scope
from .config import settings


import requests

from decorator import decorator


class GithubCore(object):

    _rate_limit = None
    _rate_limit_remaining = None


    @staticmethod
    def _resource_serialize(o):
        """Returns JSON serialization of given object."""
        return json.dumps(o)


    @staticmethod
    def _resource_deserialize(s):
        """Returns dict deserialization of a given JSON string."""

        try:
            return json.loads(s)
        except ValueError:
            raise ResponseError('The API Response was not valid.')


    @staticmethod
    def _generate_url(endpoint):
        """Generates proper endpoint URL."""

        if is_collection(endpoint):
            resource = map(str, endpoint)
            resource = '/'.join(endpoint)
        else:
            resource = endpoint

        return (settings.base_url + resource)


    def _requests_pre_hook(*args, **kwargs):
        """Pre-processing for HTTP requests arguments."""

        return args, kwargs


    def _requests_post_hook(self, r):
        """Post-processing for HTTP response objects."""

        self._ratelimit = int(r.headers.get('x-ratelimit-limit', -1))
        self._ratelimit_remaining = int(r.headers.get('x-ratelimit-remaining', -1))

        return r


    def _http_resource(self, verb, endpoint, params=None, authed=True):

        url = self._generate_url(endpoint)

        if authed:
            args, kwargs = self._requests_pre_hook(verb, url, params=params)
        else:
            args = (verb, url)
            kwargs = {'params': params}

        r = requests.request(*args, **kwargs)
        r = self._requests_post_hook(r)

        print self._ratelimit_remaining

        r.raise_for_status()

        return r


    def _get_resource(self, resource, obj, authed=True, **kwargs):

        r = self._http_resource('GET', resource, params=kwargs, authed=authed)
        item = self._resource_deserialize(r.content)

        return obj.new_from_dict(item, gh=self)


    def _get_resources(self, resource, obj, authed=True, **kwargs):

        r = self._http_resource('GET', resource, params=kwargs, authed=authed)
        d_items = self._resource_deserialize(r.content)

        items = []

        for item in d_items:
            items.append(obj.new_from_dict(item, gh=self))

        return items


    def _to_map(self, obj, iterable):
        """Maps given dict iterable to a given Resource object."""

        a = list()

        for it in iterable:
            a.append(obj.new_from_dict(it, rdd=self))

        return a

    def _get_url(self, resource):

        if is_collection(resource):
            resource = map(str, resource)
            resource = '/'.join(resource)

        return resource



class Github(GithubCore):
    """docstring for Github"""

    def __init__(self):
        super(Github, self).__init__()
        self.is_authenticated = False


    def get_user(self, username):
        """Get a single user."""
        return self._get_resource(('users', username), User, authed=False)


    def get_me(self):
        """Get the authenticated user."""
        return self._get_resource(('user'), CurrentUser)

    # def get_repos(self, username):
        # """Get repos."""
         # return self._get_resource(('user', 'username', 'repos'), Repo)

    def get_repo(self, username, reponame):
        """Get the authenticated user."""
        return self._get_resource(('repos', username, reponame), Repo, authed=False)



class ResponseError(Exception):
    """The API Response was unexpected."""