Merge lp:~mhall119/loco-team-portal/json-services into lp:loco-team-portal

[Michael Hall]

Provides read-only REST/JSON services for Django models used by LoCo Directory.

[Daniel Holbach (dholbach)]

Wow you put a lot of work into this.

 - It might be worth noting that parts of the code are from http://bitbucket.org/oct09/experimental/src/739a074f7ea2/utils.py for reference.
 - Is @author read or used by anything?
 - Would it be worth displaying just a list of team names and team ids for /services/teams? Why would anyone use /services/teams/<x>? :)
 - is /services/teams/1 usable enough? I thought people would be after /services/teams/ubuntu-fr?
 - what is "/services/comments/" about?

This needs a code review from a few more people. I'm not sure I can do the code fully justice. I feel slightly uneasy about relying on certain strings in field names like "__", "pk", etc, etc.

review: Needs Information

[Michael Hall (mhall119)]

I removed the functions in common.utils, which it turns out I didn't need because I'm not offering write capabilities (yet). That takes care of #1 above, as well as relying on "pk" and "__". I also removed the @author comments, those were just auto-generated by Eclipse when I created the new files.

/services/teams/1 might be usable to someone, but it cost me nothing to allow it, so I don't see any reason to take it out. Since this is an API, I don't think we really need a user-friendly URL scheme like /services/teams/ubuntu-fr, however you can use the LP name in a search: /services/teams/?lp_name=ubuntu-fl

/services/comments/ is the API for accessing comments on team events.

[lp:~mhall119/loco-team-portal/json-services]

143. By Daniel Holbach on 2010-06-03

update translations

144. By Daniel Holbach on 2010-06-03

released 0.2.9

145. By Michael Hall on 2010-06-03

Check that user is authenticated (not AnonymousUser) before checking for group membership. (LP: #589226)

146. By Michael Hall on 2010-06-03

Add break that will clear the floating property of elements after the Attending Team Events list

147. By Daniel Holbach on 2010-06-04

update translation template

148. By Daniel Holbach on 2010-06-04

released 0.2.10

149. By Thomas Bechtold on 2010-06-04

merged lp:~dholbach/loco-directory/579842

[Efrain Valles (effie-jayx)]

I agree with mhall119, urls don't need to be that friendly considering a ?lp_name can be used to fetch for a team with a LP name. I do beleive we should include some credits for the code borrowed.

review: Approve

[lp:~mhall119/loco-team-portal/json-services]

150. By Daniel Holbach on 2010-06-07

apply patch from Seung Soo, Ha

151. By Daniel Holbach on 2010-06-07

update template

152. By Michael Hall <mhall@mhall-laptop> on 2010-06-07

Merge with trunk and updated copyright information in services

[Michael Hall (mhall119)]

dholbach: Is there something you're waiting on for this branch to be merged?

[Dave Walker (davewalker)]

Looking at the diff, I have some concerns about the Licence. http://bitbucket.org/oct09/main/src/tip/COPYING allows derivation, but does insist that the licence text is provided aswell. I don't know if linking to their licence is enough. IANAL ofc.

[Daniel Holbach (dholbach)]

pyflakes output on the new code:
 - loco_directory/services/__init__.py:10: 'utils' imported but unused
 - (indent too much): loco_directory/services/views.py:34: invalid syntax

     ^
 - loco_directory/common/utils.py:3: 'django' imported but unused
 - loco_directory/common/utils.py:7: redefinition of unused 'django' from line 3
 - loco_directory/common/utils.py:11: redefinition of unused 'red' from line 9

pylint (services/__init__.py)
 - W: 15:model_service: Unused variable 'rem_url'
 - W: 26:model_entity: Unused variable 'rem_url'
 - W: 46:model_collection: Unused argument 'url'
 - W: 72:get_model_id: Unused argument 'request'
 - W: 87:decode: Unused argument 'url'
 - W: 87:decode: Unused argument 'klass'
 - W: 87:decode: Unused argument 'entity'
 - W:104:JSONEncoder.get_field_value: Redefining built-in 'object'

Questions:
 - Is decode() ever used?
 - Is there a reason why most of the code is in __init__.py?

[Daniel Holbach (dholbach)]

Thanks a lot for your work on this.

[lp:~mhall119/loco-team-portal/json-services]

153. By Michael Hall <mhall@mhall-laptop> on 2010-06-17

Removed unneeded imports

[Daniel Holbach (dholbach)]

Do you think you can at least fix these two?

loco_directory/services/views.py:34: invalid syntax

     ^

loco_directory/services/__init__.py:
W:103:JSONEncoder.get_field_value: Redefining built-in 'object'

[Efrain Valles (effie-jayx)]

I have checked dholbach's remarks and I back his request for information

Why is most code in __init__.py?

I can help with fixing the two issues if mhall ack's them

review: Needs Fixing

[lp:~mhall119/loco-team-portal/json-services]

154. By Michael Hall <mhall@mhall-laptop> on 2010-06-17

Fixed indentation and renamed variable 'object' to 'o'

[Michael Hall (mhall119)]

The code is in __init__.py because I wanted the functions in the services.* namespace.

[Daniel Holbach (dholbach)]

Approved.

review: Approve

=== added directory 'loco_directory/services'
=== added file 'loco_directory/services/__init__.py'
--- loco_directory/services/__init__.py	1970-01-01 00:00:00 +0000
+++ loco_directory/services/__init__.py	2010-06-17 11:55:43 +0000
@@ -0,0 +1,134 @@
+# Portions of this code comes from the Oct09 project
+# developed by the Moffitt Cancer Center.
+# License: http://bitbucket.org/oct09/main/src/tip/COPYING
+# Project: http://bitbucket.org/oct09/main/wiki/Home
+
+from django.db.models import Model
+from django.http import HttpResponse
+from django.forms.fields import EMPTY_VALUES
+from django.utils import simplejson
+import re
+import decimal
+
+def model_service(model, request, url, include=None, exclude=None):
+    (instance_id, rem_url) = get_model_id(request, url)
+
+    try:
+        if instance_id is not None and instance_id != '':
+            return model_entity(model, request, url, include, exclude)
+        else:
+            return model_collection(model, request, url, include, exclude)
+    except Exception, e:
+        return HttpResponse(encode_error(e))
+    
+def model_entity(model, request, url, include=None, exclude=None):
+    (entity_id, rem_url) = get_model_id(request, url)
+
+    try:
+        entity = model.objects.get(pk=entity_id)
+    except:
+        return HttpResponse(encode_error("Entity not found"))
+
+    
+    # Otherwise process the entity request
+    if request.method == "GET":
+        return HttpResponse(encode(entity, include, exclude), mimetype=get_mimetype())
+
+    elif request.method == "PUT":
+        return HttpResponse(encode_error("Write operations are not supported"))
+        
+    elif request.method == "DELETE":
+        return HttpResponse(encode_error("Write operations are not supported"))
+        
+    return HttpResponse(encode_error("%s Not Implemented"%request.method))
+
+def model_collection(model, request, url, include=None, exclude=None):
+    if request.method == "GET":
+        results = do_search(model, request.GET, include, exclude)
+
+        collection = list(results)
+        return HttpResponse(encode(collection, include, exclude), mimetype=get_mimetype())
+
+    elif request.method == "POST":
+        return HttpResponse(encode_error("Write operations are not supported"))
+
+    return HttpResponse(encode_error("%s Not Implemented"%request.method))
+
+def do_search(model, request, include=None, exclude=None):
+    search_fields = include
+    if search_fields is None:
+        search_fields = [f.name for f in model._meta.local_fields+model._meta.many_to_many if not f.name.endswith("_ptr")]
+    if exclude is not None:
+        search_fields = [f for f in search_fields if f not in exclude]
+    search_values = dict([(str(key), value) for (key, value) in request.items()])
+
+    results = model.objects.filter(**search_values)
+
+    if '_sortby' in request and request['_sortby'] not in EMPTY_VALUES:
+        results = results.order_by(request.get('_sortby'))
+    return results
+
+def get_model_id(request, url):
+    instance_id = None
+    rem_url = None
+    if url is not None and len(url) > 0:
+        m = re.match(r"^([^/]+)/?(.*)", url)
+    
+        if m is not None:
+            instance_id = m.group(1)
+            rem_url = m.group(2)
+    return (instance_id, rem_url)
+
+def encode(entity, include=None, exclude=None):
+    json = JSONEncoder(include, exclude)
+    return json.encode(entity)
+
+def decode(klass, entity, request, url=None):
+    return request.raw_post_data
+
+def get_mimetype():
+    return "application/json"
+
+def encode_error(error):
+    json = JSONEncoder()
+    return json.encode({'error': unicode(error)})
+
+class JSONEncoder(simplejson.JSONEncoder):
+
+    def __init__(self, include=None, exclude=None):
+        self.include = include
+        self.exclude = exclude
+        super(JSONEncoder, self).__init__()
+        
+    def get_field_value(self, o, field):
+        f = getattr(o, field)
+        try:
+            if isinstance(f, Model):
+                if hasattr(f, 'pk'):
+                    return self.default(f.pk)
+                else:
+                    return None
+            if isinstance(f, decimal.Decimal):
+                return o._meta.get_field_by_name(field)[0]._format(f)
+            else:
+                return self.default(f)
+        except Exception:
+            return None
+        
+    def default(self, o=None):
+    
+        if isinstance(o, Model):
+            model_fields = self.include
+            if model_fields is None:
+                model_fields = [f.name for f in o._meta.fields+o._meta.many_to_many if not f.name.endswith("_ptr")]
+            if self.exclude is not None:
+                model_fields = [f for f in model_fields if f not in self.exclude]
+            d = dict([(field, self.get_field_value(o, field)) for field in model_fields])
+            return d
+        elif o.__class__.__name__ == 'ManyRelatedManager' or o.__class__.__name__ == 'RelatedManager':
+            return [r.pk for r in o.all()]
+        elif isinstance(o, (int, long, float)):
+            return o
+        elif o is None:
+            return None
+        return str(o)

=== added file 'loco_directory/services/urls.py'
--- loco_directory/services/urls.py	1970-01-01 00:00:00 +0000
+++ loco_directory/services/urls.py	2010-06-17 11:55:43 +0000
@@ -0,0 +1,20 @@
+'''
+Created on Jun 2, 2010
+
+@author: mhall
+'''
+from django.conf.urls.defaults import *
+
+urlpatterns = patterns('',
+    #venues
+    url(r'^teams/(.*)$', 'services.views.team_service', name='team_service'),
+    url(r'^events/(.*)$', 'services.views.team_event_service', name='team_event_service'),
+    url(r'^global/(.*)$', 'services.views.global_event_service', name='global_event_service'),
+    url(r'^comments/(.*)$', 'services.views.event_comment_service', name='event_comment_service'),
+    url(r'^attendees/(.*)$', 'services.views.event_attendee_service', name='event_attendee_service'),
+    url(r'^venues/(.*)$', 'services.views.venue_service', name='venue_service'),
+    url(r'^users/(.*)$', 'services.views.user_service', name='user_service'),
+    url(r'^groups/(.*)$', 'services.views.group_service', name='group_service'),
+    url(r'^admins/(.*)$', 'services.views.admin_service', name='admin_service'),
+)
+

=== added file 'loco_directory/services/views.py'
--- loco_directory/services/views.py	1970-01-01 00:00:00 +0000
+++ loco_directory/services/views.py	2010-06-17 11:55:43 +0000
@@ -0,0 +1,34 @@
+from teams.models import Team
+from events.models import GlobalEvent, TeamEvent, TeamEventComment, Attendee, TeamAdministrator
+from venues.models import Venue
+from django.contrib.auth.models import User, Group
+
+from services import model_service
+
+def team_service(request, url):
+    return model_service(Team, request, url)
+
+def team_event_service(request, url):
+    return model_service(TeamEvent, request, url)
+
+def global_event_service(request, url):
+    return model_service(GlobalEvent, request, url)
+
+def event_attendee_service(request, url):
+    return model_service(Attendee, request, url)
+
+def event_comment_service(request, url):
+    return model_service(TeamEventComment, request, url)
+
+def venue_service(request, url):
+    return model_service(Venue, request, url)
+
+def user_service(request, url):
+    return model_service(User, request, url, include=['id', 'username', 'groups'])
+
+def group_service(request, url):
+    return model_service(Group, request, url, exclude=['permissions'])
+
+def admin_service(request, url):
+    return model_service(TeamAdministrator, request, url)
+

=== modified file 'loco_directory/urls.py'
--- loco_directory/urls.py	2009-12-22 23:09:58 +0000
+++ loco_directory/urls.py	2010-06-17 11:55:43 +0000
@@ -15,6 +15,7 @@
     url(r'^venues/', include('venues.urls')),
     url(r'^logout$', 'common.views.site_logout'),
     url(r'^jsi18n', 'django.views.i18n.javascript_catalog', name='jsi18n'),
+    url(r'^services/', include('services.urls')),
 )
 
 if settings.STATIC_SERVE: