aboutsummaryrefslogtreecommitdiffstats
path: root/github3/models
diff options
context:
space:
mode:
Diffstat (limited to 'github3/models')
-rw-r--r--github3/models/__init__.py4
-rw-r--r--github3/models/base.py149
-rw-r--r--github3/models/gists.py49
-rw-r--r--github3/models/orgs.py28
-rw-r--r--github3/models/repos.py30
-rw-r--r--github3/models/user.py54
6 files changed, 314 insertions, 0 deletions
diff --git a/github3/models/__init__.py b/github3/models/__init__.py
new file mode 100644
index 0000000..6e4db1b
--- /dev/null
+++ b/github3/models/__init__.py
@@ -0,0 +1,4 @@
+from .user import AuthUser, User
+from .repos import Repo
+from .orgs import Org
+from .gists import Gist
diff --git a/github3/models/base.py b/github3/models/base.py
new file mode 100644
index 0000000..1b1ce89
--- /dev/null
+++ b/github3/models/base.py
@@ -0,0 +1,149 @@
+"""
+github3.models
+~~~~~~~~~~~~~~
+
+This module provides the Github3 object model.
+"""
+
+import json
+import inspect
+
+from github3.helpers import to_python, to_api, key_diff
+
+class BaseResource(object):
+ """A BaseResource object."""
+
+ _strs = []
+ _ints = []
+ _dates = []
+ _bools = []
+ _map = {}
+ _list_map = {}
+ _writeable = []
+ _cache = {}
+
+ def post_map(self):
+ try:
+ handler = self.handler()
+ methods = filter(lambda x: x[0].startswith('get') and callable(x),
+ inspect.getmembers(handler, inspect.ismethod))
+ for name, callback in methods:
+ setattr(self, method, callback)
+ except:
+ pass
+
+ 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,
+ list_map = cls._list_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 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)
+#
+#
diff --git a/github3/models/gists.py b/github3/models/gists.py
new file mode 100644
index 0000000..5ad61c3
--- /dev/null
+++ b/github3/models/gists.py
@@ -0,0 +1,49 @@
+#!/usr/bin/env python
+# -*- encoding: utf-8 -*-
+#
+# author: David Medina
+
+from .base import BaseResource
+from .user import User
+
+class File(BaseResource):
+ _strs = ['filename', 'raw_url', 'content', 'language', 'type']
+ _ints = ['size']
+
+ def __repr__(self):
+ return '<File gist> %s' % self.filename
+
+class GistFork(BaseResource):
+ _strs = ['url']
+ _dates = ['created_at']
+ _map = {'user': User}
+
+ def __repr__(self):
+ return '<Gist fork> %s>' % self.user.login
+
+class ChangeStatus(BaseResource):
+ _ints = ['deletions', 'additions', 'total']
+
+ def __repr__(self):
+ return '<Gist history> change_status>'
+
+class GistHistory(BaseResource):
+ _strs = ['url', 'version']
+ _map = {'user': User, 'change_status': ChangeStatus}
+ _dates = ['committed_at']
+
+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}
+ _list_map = {'files': File, 'forks': GistFork, 'history': GistHistory}
+
+ @property
+ def ri(self):
+ return ('users', self.user.login, self.id)
+
+ def __repr__(self):
+ return '<gist %s/%s>' % (self.user.login, self.description)
+
diff --git a/github3/models/orgs.py b/github3/models/orgs.py
new file mode 100644
index 0000000..1ce638e
--- /dev/null
+++ b/github3/models/orgs.py
@@ -0,0 +1,28 @@
+#!/usr/bin/env python
+# -*- encoding: utf-8 -*-
+#
+# author: David Medina
+
+from .base import BaseResource
+from .user import Plan
+
+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)
diff --git a/github3/models/repos.py b/github3/models/repos.py
new file mode 100644
index 0000000..8dbe970
--- /dev/null
+++ b/github3/models/repos.py
@@ -0,0 +1,30 @@
+#!/usr/bin/env python
+# -*- encoding: utf-8 -*-
+#
+# author: David Medina
+
+from .base import BaseResource
+from .user import User
+from .orgs import Org
+
+class Repo(BaseResource):
+ _strs = [
+ 'url', 'html_url', 'clone_url', 'git_url', 'ssh_url', 'svn_url',
+ 'name', 'description', 'homepage', 'language', 'master_branch']
+ _bools = ['private', 'fork', 'has_issues', 'has_wiki', 'has_downloads']
+ _ints = ['forks', 'watchers', 'size', 'open_issues']
+ _dates = ['pushed_at', 'created_at']
+ _map = {
+ 'owner': User,
+ 'organization': Org,
+ 'parent': 'self',
+ 'source': 'self',
+ }
+
+ @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
diff --git a/github3/models/user.py b/github3/models/user.py
new file mode 100644
index 0000000..d58d9b2
--- /dev/null
+++ b/github3/models/user.py
@@ -0,0 +1,54 @@
+#!/usr/bin/env python
+# -*- encoding: utf-8 -*-
+#
+# author: David Medina
+
+from .base import BaseResource
+
+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 User(BaseResource):
+ """Github User object model."""
+
+ _strs = [
+ 'login','avatar_url', 'url', 'name', 'company', 'blog', 'location',
+ 'email', 'bio', 'html_url', 'type']
+
+ _ints = ['id', 'public_repos', 'public_gists', 'followers', 'following']
+ _dates = ['created_at',]
+ _bools = ['hireable', ]
+
+ @property
+ def ri(self):
+ return ('users', self.login)
+
+ def __repr__(self):
+ return '<User {0}>'.format(self.login)
+
+ def handler(self):
+ return self._gh.user_handler(self.login, force=True)
+
+class AuthUser(User):
+ """Github Current User object model."""
+
+ _ints = [
+ 'id', 'public_repos', 'public_gists', 'followers', 'following',
+ 'total_private_repos', 'owned_private_repos', 'private_gists',
+ 'disk_usage', 'collaborators']
+ _map = {'plan': Plan}
+ _writeable = ['name', 'email', 'blog', 'company', 'location', 'hireable', 'bio']
+
+ @property
+ def ri(self):
+ return ('user',)
+
+ def __repr__(self):
+ return '<AuthUser {0}>'.format(self.login)
+
Copyright © 1996 – 2023 Jason A. Donenfeld. All Rights Reverse Engineered.