david / django-portablecontacts / changeset / c314c0dd2388

Up to file-list portablecontacts/tests.py:

@@ -465,11 +465,247 @@ XML representations::
        </entry>
       </response>
 Sorting
 -------
 Sorting allows requests to specify the order in which contacts are returned.
 sortBy, specifies the field name whose value SHALL be used to order the
 returned Contacts. The sort order is determine by the sortOrder parameter.
 If sortBy is a Singular Field, contacts are sorted according to that field's
 value; if it's a Plural Field, contacts are sorted by the Value
 (or Major Value, if it's a Complex Field) of the field marked with
 "primary": "true", if any, or else the first value in the list, if any,
 or else they are sorted last if the given contact has no data for the given
 field::
     >>> response = c.get("/portablecontacts/@me/@all/", {'sortBy': 'givenName'})
     >>> response.status_code
     >>> print response.content
+    {
      "itemsPerPage": 100,
      "startIndex": 0,
      "totalResults": 3,
      "entry": [
+      {
        "displayName": "Minimal Contact",
        "id": 1
       },
+      {
        "preferredUsername": "david",
        "displayName": "David Larlet",
        "id": 3,
        "name": {
         "givenName": "David",
         "familyName": "Larlet"
+       }
       },
+      {
        "relationships": [
         "friend"
        ],
        "organizations": [
+        {
          "name": "Burns Worldwide",
          "title": "Head Bee Guy"
+        }
        ],
        "phoneNumbers": [
+        {
          "type": "work",
          "value": "KLONDIKE5"
         },
+        {
          "type": "mobile",
          "value": "650-123-4567"
+        }
        ],
        "displayName": "Mork Hashimoto",
        "name": {
         "givenName": "Mork",
         "familyName": "Hashimoto"
        },
        "tags": [
         "plaxo guy"
        ],
        "emails": [
+        {
          "type": "work",
          "primary": true,
          "value": "mhashimoto-04@plaxo.com"
         },
+        {
          "type": "home",
          "value": "mhashimoto-04@plaxo.com"
+        }
        ],
        "photos": [
+        {
          "type": "thumbnail",
          "value": "http://sample.site.org/photos/12345.jpg"
+        }
        ],
        "ims": [
+        {
          "type": "aim",
          "value": "plaxodev8"
+        }
        ],
        "accounts": [
+        {
          "domain": "plaxo.com",
          "userid": "2706"
+        }
        ],
        "urls": [
+        {
          "type": "work",
          "value": "http://www.seeyellow.com"
         },
+        {
          "type": "home",
          "value": "http://www.angryalien.com"
+        }
        ],
        "id": 2,
        "addresses": [
+        {
          "locality": "Springfield",
          "country": "USA",
          "region": "VT",
          "formatted": "742 Evergreen Terrace\nSuite 123\nSpringfield VT 12345 USA",
          "streetAddress": "742 Evergreen Terrace\nSuite 123",
          "postalCode": "12345",
          "type": "home"
+        }
+       ]
+      }
+     ]
+    }
 sortOrder, the order in which the sortBy parameter is applied. Allowed values
 are ascending and descending. If a value for sortBy is provided and no
 sortOrder is specifies, the sortOrder SHALL default to ascending. Sort order
 is expected to be case-insensitive Unicode alphabetic sort order, with no
 specific locale implied::
     >>> response = c.get("/portablecontacts/@me/@all/", {'sortBy': 'givenName', 'sortOrder': 'descending'})
     >>> response.status_code
     >>> print response.content
+    {
      "itemsPerPage": 100,
      "startIndex": 0,
      "totalResults": 3,
      "entry": [
+      {
        "relationships": [
         "friend"
        ],
        "organizations": [
+        {
          "name": "Burns Worldwide",
          "title": "Head Bee Guy"
+        }
        ],
        "phoneNumbers": [
+        {
          "type": "work",
          "value": "KLONDIKE5"
         },
+        {
          "type": "mobile",
          "value": "650-123-4567"
+        }
        ],
        "displayName": "Mork Hashimoto",
        "name": {
         "givenName": "Mork",
         "familyName": "Hashimoto"
        },
        "tags": [
         "plaxo guy"
        ],
        "emails": [
+        {
          "type": "work",
          "primary": true,
          "value": "mhashimoto-04@plaxo.com"
         },
+        {
          "type": "home",
          "value": "mhashimoto-04@plaxo.com"
+        }
        ],
        "photos": [
+        {
          "type": "thumbnail",
          "value": "http://sample.site.org/photos/12345.jpg"
+        }
        ],
        "ims": [
+        {
          "type": "aim",
          "value": "plaxodev8"
+        }
        ],
        "accounts": [
+        {
          "domain": "plaxo.com",
          "userid": "2706"
+        }
        ],
        "urls": [
+        {
          "type": "work",
          "value": "http://www.seeyellow.com"
         },
+        {
          "type": "home",
          "value": "http://www.angryalien.com"
+        }
        ],
        "id": 2,
        "addresses": [
+        {
          "locality": "Springfield",
          "country": "USA",
          "region": "VT",
          "formatted": "742 Evergreen Terrace\nSuite 123\nSpringfield VT 12345 USA",
          "streetAddress": "742 Evergreen Terrace\nSuite 123",
          "postalCode": "12345",
          "type": "home"
+        }
+       ]
       },
+      {
        "preferredUsername": "david",
        "displayName": "David Larlet",
        "id": 3,
        "name": {
         "givenName": "David",
         "familyName": "Larlet"
+       }
       },
+      {
        "displayName": "Minimal Contact",
        "id": 1
+      }
+     ]
+    }
 Pagination
 ----------
 Just the first entry::
 The pagination parameters can be used together to "page through" a large
 number of results in manageable chunks.
 For instance, on an initial query, specifying startIndex=0&count=1 will return
 only the first result. The total number of possible results is indicated by
 the totalResults field of results, so the client knows how many "pages" of
 results exist::
     >>> response = c.get("/portablecontacts/@me/@all/", {'startIndex':0, 'count':1})
     >>> response.status_code
@@ -487,13 +723,29 @@ Just the first entry::
+     ]
+    }
-And now entries 2 and 3::
+A subsequent query of startIndex=2&count=1 will return the next next result,
 and so on::
-    >>> response = c.get("/portablecontacts/@me/@all/", {'startIndex':1, 'count':2})
+    >>> response = c.get("/portablecontacts/@me/@all/", {'startIndex':2, 'count':1})
     >>> response.status_code
     >>> print response.content
+    {
      "itemsPerPage": 1,
      "startIndex": 2,
      "totalResults": 3,
      "entry": [
+      {
        "preferredUsername": "david",
        "displayName": "David Larlet",
        "id": 3,
        "name": {
         "givenName": "David",
         "familyName": "Larlet"
+       }
+      }
+     ]
+    }
 """

Up to file-list portablecontacts/views.py:

@@ -15,6 +15,12 @@ def retrieve(request, id=None, format='j
         options = {'indent': True}
         if id is None:
             contacts = request.user.contact_set.all()
             # sorting
             sortBy = request.GET.get('sortBy', 'id')
             sortOrder = request.GET.get('sortOrder', 'ascending')
             contacts = contacts.order_by('%s%s' % (sortOrder=='descending' and '-' or '', sortBy))
             # pagination
             startIndex = int(request.GET.get('startIndex', 0))
             count = int(request.GET.get('count', 100))

commit 3:	c314c0dd2388
parent 2:	d759edee4b66
branch:	default

david / django-portablecontacts (http://portablecontacts.net/)