aboutsummaryrefslogtreecommitdiffstats
path: root/github3/api.py
blob: 3225e435c027098a9ab8ac5aaa4bf5b825a2d3f0 (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
# -*- coding: utf-8 -*-
"""
    github3.api
    ~~~~~~~~~~~

    This module implements the GitHub3 API wrapper objects.

    :copyright: (c) 2011 by Kenneth Reitz.
    :license: ISC, see LICENSE for more details.
"""

from . import models
from .packages.anyjson import deserialize

import requests




API_URL = 'https://api.github.com'
API_MIME = 'application/vnd.github.v3+json'




# =======
# Helpers
# =======

def _safe_response(r, error=None):

    try:
        r.raise_for_status()
        return r
    except requests.HTTPError:
        if (r.status_code == 404) or (r.status_code == 401):
            raise LoginFailed
        else:
            raise APIError(error) if error else APIError


def get(*path, **params):
    """
    Accepts optional error parameter, which will be passed in the event of a
    non-401 HTTP error.

    api.get('groups')
    api.get('groups', 'id')
    api.get('accounts', 'verify')
    """

    path = list(path)
    path.insert(0, '')

    url = '{0}{1}'.format(API_URL, '/'.join(map(str, path)))
    print url
    # params = kwargs.get('params', None)

    r = requests.get(url, params=params, auth=None)

    return _safe_response(r)


def post(params, *path):

    path += API_URL
    url =  '%s%s' % ('/'.join(map(str, path)), '.json')
    r = requests.post(url, params=params, auth=auth)
    return _safe_response(r)


# ==========
# Exceptions
# ==========

class LoginFailed(RuntimeError):
    """Login falied!"""

class APIError(RuntimeError):
    """There was a problem properly accessing the Convore API."""



def login(username, password):
    """Configured API Credentials"""
    global auth

    auth = (username, password)
    # print requests.auth_manager.__dict__

# ==========
# End Points
# ==========