Added functionality to search in ReST.

Details:
    - Factored out common code into search.py
    - Added functionality
        - Search using query
        - Search using report id
        - Flushed out query priorities

Author: pykler

Diff for: mainapp/search.py

@@ -0,0 +1,49 @@
+'''
+module containing search funcions and exceptions for fixmystreet.ca
+'''
+
+from mainapp.models import GoogleAddressLookup, Ward
+
+class SearchException(Exception):
+    pass
+
+class SearchAddressException(SearchException):
+    pass
+
+class SearchAddressDisambiguateError(SearchAddressException):
+    pass
+
+class SearchAddressNotSupported(SearchException):
+    pass
+
+def search_address(address, match_index=-1, disambiguate=[]):
+    '''
+    Tries to parse `address` returning a single point, if the address is
+    ambigous `match_index` will be used to pick out the correct address. if
+    `match_index` is -1 or not 0 <= `match_index` < len(possible_addresses) the
+    disambiguate list is populated with possible addresses and a
+    `SearchAddressDisambiguateError` is raised.
+    '''
+    address_lookup = GoogleAddressLookup( address )
+
+    if not address_lookup.resolve():
+        raise SearchAddressException("Sorry, we couldn\'t retreive the coordinates of that location, please use the Back button on your browser and try something more specific or include the city name at the end of your search.")
+
+    if not address_lookup.exists():
+        raise SearchAddressException("Sorry, we couldn\'t find the address you entered.  Please try again with another intersection, address or postal code, or add the name of the city to the end of the search.")
+
+    if address_lookup.matches_multiple() and match_index == -1:
+        disambiguate += address_lookup.get_match_options()
+        raise SearchAddressDisambiguateError('Cannot pinpoint given address')
+
+    point_str = "POINT(" + address_lookup.lon(match_index) + " " + address_lookup.lat(match_index) + ")"
+    return point_str
+
+def search_wards(point_str):
+    '''
+    returns a list of wards that contain `point_str`
+    '''
+    wards = Ward.objects.filter(geom__contains=point_str)
+    if (len(wards) == 0):
+        raise SearchAddressNotSupported("Sorry, we don't yet have that area in our database.  Please have your area councillor contact fixmystreet.ca.")
+    return wards

Diff for: mainapp/views/main.py

@@ -1,6 +1,7 @@
 from django.shortcuts import render_to_response, get_object_or_404
 from django.http import HttpResponseRedirect
-from mainapp.models import Report, ReportUpdate, Ward, FixMyStreetMap, ReportCountQuery, City, FaqEntry, GoogleAddressLookup
+from mainapp.models import Report, ReportUpdate, Ward, FixMyStreetMap, ReportCountQuery, City, FaqEntry
+from mainapp import search
 from django.template import Context, RequestContext
 from django.contrib.gis.measure import D 
 from django.contrib.gis.geos import *
@@ -36,34 +37,32 @@ def search_address(request):
 #        return HttpResponseRedirect("/search?q=" + address )
 
     address = request.GET["q"] 
-    address_lookup = GoogleAddressLookup( address )
-
-    if not address_lookup.resolve():
-        return index(request, _("Sorry, we couldn\'t retreive the coordinates of that location, please use the Back button on your browser and try something more specific or include the city name at the end of your search."))
-    
-    if not address_lookup.exists():
-        return index( request, _("Sorry, we couldn\'t find the address you entered.  Please try again with another intersection, address or postal code, or add the name of the city to the end of the search."))
-
-    if address_lookup.matches_multiple() and not request.GET.has_key("index"):
-        addrs = address_lookup.get_match_options() 
+
+    match_index = -1
+    if request.GET.has_key("index"):
+        match_index = int(request.GET["index"] or 0)
+
+    addrs = []
+    try:
+        point_str = search.search_address(address, match_index, addrs)
+    except search.SearchAddressDisambiguateError, e:
+        # addrs = address_lookup.get_match_options() 
         addr_list = "" 
         for i in range(0,len(addrs)):
             link = "/search?q=" + urlquote(address) + "&index=" + str(i)
             addr_list += "<li><a href='%s'>%s</a></li>" % ( link, addrs[i] )
             addr_list += "</ul>"
         return index(request,disambiguate = addr_list )
-    
-    # otherwise, we have a specific match
-    match_index = 0
-    if request.GET.has_key("index"):
-        match_index = int(request.GET["index"])
-            
-    point_str = "POINT(" + address_lookup.lon(match_index) + " " + address_lookup.lat(match_index) + ")"
-    pnt = fromstr(point_str, srid=4326)    
-    wards = Ward.objects.filter(geom__contains=point_str)
-    if (len(wards) == 0):
-        return( index(request, _("Sorry, we don't yet have that area in our database.  Please have your area councillor contact fixmystreet.ca.")))
-    
+    except search.SearchAddressException, e:
+        return index(request, _(str(e)))
+
+    pnt = fromstr(point_str, srid=4326)
+
+    try:
+        wards = search.search_wards(point_str)
+    except search.SearchAddressNotSupported, e:
+        return( index(request, _(str(e))))
+
     reports = Report.objects.filter(is_confirmed = True,point__distance_lte=(pnt,D(km=4))).distance(pnt).order_by('distance')
     gmap = FixMyStreetMap(pnt,True,reports)
 

Diff for: mainapp/views/rest.py

@@ -5,8 +5,12 @@
 from django.forms.util import ErrorDict
 
 from mainapp.models import Report
+from mainapp import search
 
 
+class InputValidationException(Exception):
+    pass
+
 class RestCollection(Collection):
     ''' Subclasses Collection to provide multiple responders '''
     def __init__(self, queryset, responders=None, **kwargs):
@@ -33,24 +37,56 @@ def __call__(self, request, format, *args, **kwargs):
         for rest resources, such that it would match one of the keys
         in self.responders
         '''
+        error_code = 400
+        errors = ErrorDict({'info': ["An error has occured"]})
         if format in self.responders:
             self.responder = self.responders[format]
-            return Collection.__call__(self, request, *args, **kwargs)
-        errors = ErrorDict(
-            {'info': ['Requested content type "%s" not available!' %format]})
-        # Using the last used responder to reutrn a 415
-        return self.responder.error(request, 415, errors)
+            try:
+                return Collection.__call__(self, request, *args, **kwargs)
+            except InputValidationException, e:
+                errors = ErrorDict({'info': [str(e)]})
+                error_code = 412
+        else:
+            error_code = 415
+            errors = ErrorDict(
+                {'info': ['Requested content type "%s" not available!' %format]})
+        # Using the last used responder to return error
+        return self.responder.error(request, error_code, errors)
 
 
 class ReportRest(RestCollection):
 
     def read(self, request):
-        lon = request.GET["lon"]
-        lat = request.GET["lat"]
-        radius = float(request.GET.get('r', 4))
-        point_str = "POINT(%s %s)" %(lon, lat)
-        pnt = fromstr(point_str, srid=4326)
-        reports = Report.objects.filter(is_confirmed = True,point__distance_lte=(pnt,D(km=radius))).distance(pnt).order_by('distance')
+        ids = request.GET.getlist("id")
+        if ids:
+            try:
+                ids = [int(id) for id in ids]
+            except (TypeError, ValueError), e:
+                raise InputValidationException(str(e))
+            reports = Report.objects.filter(id__in = ids)
+            # process ids right now
+        else:
+            lon = request.GET.get("lon")
+            lat = request.GET.get("lat")
+            address = request.GET.get("q")
+            if lat and lon:
+                point_str = "POINT(%s %s)" %(lon, lat)
+            elif address:
+                addrs = []
+                match_index = int(request.GET.get('index', -1))
+                try:
+                    point_str = search.search_address(address, match_index, addrs)
+                except search.SearchAddressDisambiguateError, e:
+                    return self.responder.error(request, 412, ErrorDict({
+                        'info': [str(e)],
+                        'possible_addresses': addrs }))
+            else:
+                raise InputValidationException('Must supply either a `q`, `lat` `lon`, or a report `id`')
+
+            radius = float(request.GET.get('r', 4))
+            pnt = fromstr(point_str, srid=4326)
+            reports = Report.objects.filter(is_confirmed = True,point__distance_lte=(pnt,D(km=radius))).distance(pnt).order_by('distance')
+
         return self.responder.list(request, reports)
 
 reports_rest = ReportRest(