aboutsummaryrefslogtreecommitdiffstats
path: root/github3/models/base.py
blob: 618e57fa38836d181a02214074fb506cd42b75a7 (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
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
"""
github3.models
~~~~~~~~~~~~~~

This module provides the Github3 object model.
"""

import json

from .helpers import to_python, to_api, key_diff


class BaseResource(object):
    """A BaseResource object."""

    _strs = []
    _ints = []
    _dates = []
    _bools = []
    _map = {}
    _writeable = []
    _cache = {}


    def __init__(self):
        self._bootstrap()
        super(BaseResource, self).__init__()


    def __dir__(self):
        return self.keys()

    def _bootstrap(self):
        """Bootstraps the model object based on configured values."""

        for attr in self.keys():
            setattr(self, attr, None)

    def keys(self):
        return self._strs + self._ints + self._dates + self._bools + self._map.keys()

    def dict(self):
        d = dict()
        for k in self.keys():
            d[k] = self.__dict__.get(k)

        return d

    @classmethod
    def new_from_dict(cls, d, gh=None):

        return to_python(
            obj=cls(), in_dict=d,
            str_keys = cls._strs,
            int_keys = cls._ints,
            date_keys = cls._dates,
            bool_keys = cls._bools,
            object_map = cls._map,
            _gh = gh
        )


    def update(self):
        deploy = key_diff(self._cache, self.dict(), pack=True)

        deploy = to_api(deploy, int_keys=self._ints, date_keys=self._dates, bool_keys=self._bools)
        deploy = json.dumps(deploy)

        r = self._gh._patch_resource(self.ri, deploy)
        return r


class Plan(BaseResource):
    """Github Plan object model."""

    _strs = ['name']
    _ints = ['space', 'collaborators', 'private_repos']

    def __repr__(self):
        return '<plan {0}>'.format(str(self.name))

class Org(BaseResource):
    """Github Organization object model."""

    _strs = [
        'login', 'url', 'avatar_url', 'name', 'company', 'blog', 'location', 'email'
        'html_url', 'type', 'billing_email']
    _ints = [
        'id', 'public_repos', 'public_gists', 'followers', 'following',
        'total_private_repos', 'owned_private_repos', 'private_gists', 'disk_usage',
        'collaborators']
    _dates = ['created_at']
    _map = {'plan': Plan}
    _writable = ['billing_email', 'blog', 'company', 'email', 'location', 'name']

    @property
    def ri(self):
        return ('orgs', self.login)

    def __repr__(self):
        return '<org {0}>'.format(self.login)

    def repos(self, limit=None):
         return self._gh._get_resources(('orgs', self.login, 'repos'), Repo, limit=limit)

    def members(self, limit=None):
        return self._gh._get_resources(('orgs', self.login, 'members'), User, limit=limit)

    def is_member(self, username):
        if isinstance(username, User):
            username = username.login

        r = self._gh._http_resource('GET', ('orgs', self.login, 'members', username), check_status=False)
        return (r.status_code == 204)

    def publicize_member(self, username):
        if isinstance(username, User):
            username = username.login

        r = self._gh._http_resource('PUT', ('orgs', self.login, 'public_members', username), check_status=False, data='')
        return (r.status_code == 204)

    def conceal_member(self, username):
        if isinstance(username, User):
            username = username.login

        r = self._gh._http_resource('DELETE', ('orgs', self.login, 'public_members', username), check_status=False)
        return (r.status_code == 204)

    def remove_member(self, username):
        if isinstance(username, User):
            username = username.login

        r = self._gh._http_resource('DELETE', ('orgs', self.login, 'members', username), check_status=False)
        return (r.status_code == 204)

    def public_members(self, limit=None):
        return self._gh._get_resources(('orgs', self.login, 'public_members'), User, limit=limit)

    def is_public_member(self, username):
        if isinstance(username, User):
            username = username.login

        r = self._gh._http_resource('GET', ('orgs', self.login, 'public_members', username), check_status=False)
        return (r.status_code == 204)


class Gist(BaseResource):
    _strs = ['url', 'description', 'html_url', 'git_pull_url', 'git_push_url']
    _ints = ['id', 'comments']
    _bools = ['public']
    _dates = ['created_at']
    _map = {'user': User} #TODO: file

    @property
    def ri(self):
        return ('users', self.user.login, self.id)

    def __repr__(self):
        return '<gist %s/%s>' % (self.user.login, self.description)

class Repo(BaseResource):
    _strs = [
        'url', 'html_url', 'clone_url', 'git_url', 'ssh_url', 'svn_url',
        'name', 'description', 'homepage', 'language', 'master_branch']
    _bools = ['private', 'fork']
    _ints = ['forks', 'watchers', 'size',]
    _dates = ['pushed_at', 'created_at']
    _map = {'owner': User}


    @property
    def ri(self):
        return ('repos', self.owner.login, self.name)

    def __repr__(self):
        return '<repo {0}/{1}>'.format(self.owner.login, self.name)
    # owner