Merge lp:~cjohnston/ubuntu-ci-services-itself/people-write-api into lp:ubuntu-ci-services-itself

[Chris Johnston]

Add a write API for adding people, update docs with API examples

- Made changes to ci_utils.tastypie.test to use assertHttpCreated/assertHttpAccepted instead of assertEqual and a status_code
- Added a delete helper to ci_utils.tastypie.test
- Added write API to people app
- Updated docs to include API calls

RTD can be viewed at: http://162.213.34.2/rtd/components/ticket-system.html

[Andy Doan (doanac)]

review: Approve

[Francis Ginther (fginther)]

Approve.

review: Approve

=== modified file 'ci-utils/ci_utils/tastypie/test.py'
--- ci-utils/ci_utils/tastypie/test.py	2013-12-10 18:29:34 +0000
+++ ci-utils/ci_utils/tastypie/test.py	2013-12-12 16:53:25 +0000
@@ -52,7 +52,7 @@
         resource = self._resource(resource)
         resp = self.client.post(
             resource, data=params, authentication=self.auth)
-        self.assertEqual(201, resp.status_code)
+        self.assertHttpCreated(resp)
         return resp['location']
 
     def patch(self, resource, params):
@@ -60,7 +60,7 @@
         resource = self._resource(resource)
         resp = self.client.patch(
             resource, data=params, authentication=self.auth)
-        self.assertEqual(202, resp.status_code)
+        self.assertHttpAccepted(resp)
 
     def getResource(self, resource, params={}):
         '''Grab a single resource and return it as a dict.'''
@@ -74,3 +74,9 @@
         '''Create a resource, get it, and return the dict.'''
         loc = self.post(resource, params)
         return self.getResource(loc)
+
+    def delete(self, resource):
+        '''Delete an existing resource.'''
+        resource = self._resource(resource)
+        resp = self.client.delete(resource, authentication=self.auth)
+        return resp

=== modified file 'docs/components/ticket-system.rst'
--- docs/components/ticket-system.rst	2013-12-09 21:45:15 +0000
+++ docs/components/ticket-system.rst	2013-12-12 16:53:25 +0000
@@ -138,7 +138,7 @@
 List all open tickets.
 
 
-te_ticket
+create_ticket
 ~~~~~~~~~~~~~
 
 Create a ticket from one or more source package uploads.
@@ -169,12 +169,55 @@
 add_person
 ~~~~~~~~~~
 
-Add a person to the database.
+Add a person (or a team) to the database.
+
+*person*
+
+::
+
+ curl --dump-header - -H "Content-Type: application/json" -X POST --data '{"name": "Chris Johnston", "email": "[e-mail]", "is_team": "False"}' http://localhost:8000/api/v1/person/
+
+
+*team*
+
+::
+
+ curl --dump-header - -H "Content-Type: application/json" -X POST --data '{"name": "Canonical CI Engineering", "email": "[e-mail]", "is_team": "True"}' http://localhost:8000/api/v1/person/
+
 
 get_person
 ~~~~~~~~~~
 
-Return a person from the database, given it's nickname/email.
+*Return all persons*
+
+::
+
+ curl http://localhost:8000/api/v1/person/
+
+*search by name*
+
+::
+
+ curl --dump-header - http://localhost:8000/api/v1/person/?name__exact=Chris%20Johnston
+ curl --dump-header - http://localhost:8000/api/v1/person/?name__iexact=chris%20johnston
+ curl --dump-header - http://localhost:8000/api/v1/person/?name__startswith=Chris
+ curl --dump-header - http://localhost:8000/api/v1/person/?name__istartswith=chris
+
+*search by email*
+
+::
+
+ curl --dump-header - http://localhost:8000/api/v1/person/?email__exact=[e-mail]
+ curl --dump-header - http://localhost:8000/api/v1/person/?email__iexact=[e-mail]
+ curl --dump-header - http://localhost:8000/api/v1/person/?email__startswith=chris
+ curl --dump-header - http://localhost:8000/api/v1/person/?email__istartswith=Chris
+
+*show/don't show teams*
+
+::
+
+ curl --dump-header - http://localhost:8000/api/v1/person/?is_team=True
+ curl --dump-header - http://localhost:8000/api/v1/person/?is_team=False
 
 Models
 ******

=== modified file 'ticket_system/people/api.py'
--- ticket_system/people/api.py	2013-12-10 20:32:31 +0000
+++ ticket_system/people/api.py	2013-12-12 16:53:25 +0000
@@ -13,6 +13,7 @@
 # You should have received a copy of the GNU Affero General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
+from tastypie.authorization import Authorization
 from tastypie.resources import ModelResource
 from tastypie.constants import ALL
 from people.models import Person
@@ -21,9 +22,10 @@
 class PersonResource(ModelResource):
     class Meta:
         queryset = Person.objects.all()
-        allowed_methods = ['get']
+        allowed_methods = ['get', 'post', 'patch']
+        authorization = Authorization()
         filtering = {
-            "name": ('exact', 'startswith'),
-            "email": ('exact', 'startswith'),
+            "name": ('exact', 'iexact', 'startswith', 'istartswith'),
+            "email": ('exact', 'iexact', 'startswith', 'istartswith'),
             "is_team": ALL,
         }

=== modified file 'ticket_system/people/tests.py'
--- ticket_system/people/tests.py	2013-12-11 19:05:24 +0000
+++ ticket_system/people/tests.py	2013-12-12 16:53:25 +0000
@@ -18,8 +18,8 @@
 from people.models import Person
 
 
-def create_person(name="Chris Johnston",
-                  email="[e-mail]", is_team=False):
+def create_person(name="Johnny Test",
+                  email="[e-mail]", is_team=False):
     person = Person()
     person.name = name
     person.email = email
@@ -37,9 +37,9 @@
         only_person_in_database = people_in_database[0]
         self.assertEquals(only_person_in_database, person)
 
-        self.assertEquals(only_person_in_database.name, "Chris Johnston")
+        self.assertEquals(only_person_in_database.name, "Johnny Test")
         self.assertEquals(only_person_in_database.email,
-                          "[e-mail]")
+                          "[e-mail]")
 
 
 class PersonResourceTest(TastypieTestCase):
@@ -47,16 +47,25 @@
     def setUp(self):
         super(PersonResourceTest, self).setUp('/api/v1')
         create_person()
-        self.person_1 = Person.objects.get(name='Chris Johnston')
+        self.person_1 = Person.objects.get(name='Johnny Test')
         self.detail_url = 'person/{0}/'.format(self.person_1.pk)
+        self.post_person_data = {
+            'name': 'Judy Test',
+            'email': '[e-mail]',
+        }
+        self.post_team_data = {
+            'name': 'CI Test Team',
+            'email': '[e-mail]',
+            'is_team': 'True',
+        }
 
     def test_get_person_list_json(self):
         obj = self.getResource('person/')
         self.assertEqual(obj['objects'][0], {
-            u'email': u'[e-mail]',
+            u'email': u'[e-mail]',
             u'id': self.person_1.pk,
             u'is_team': False,
-            u'name': u'Chris Johnston',
+            u'name': u'Johnny Test',
             u'resource_uri': u'/api/v1/person/{0}/'.format(self.person_1.pk)
         })
 
@@ -65,4 +74,40 @@
 
         self.assertKeys(obj,
                         ['email', 'id', 'is_team', 'name', 'resource_uri'])
-        self.assertEqual(obj['name'], 'Chris Johnston')
+        self.assertEqual(obj['name'], 'Johnny Test')
+
+    def test_post_person_list(self):
+        # Check how many are there first.
+        self.assertEqual(Person.objects.count(), 1)
+        self.post(resource='person/', params=self.post_person_data)
+        # Verify a new one has been added.
+        self.assertEqual(Person.objects.count(), 2)
+
+    def test_post_team_list(self):
+        # Check how many are there first.
+        self.assertEqual(Person.objects.filter(is_team=True).count(), 0)
+        self.post(resource='person/', params=self.post_team_data)
+        # Verify a new one has been added.
+        self.assertEqual(Person.objects.filter(is_team=True).count(), 1)
+
+    def test_put_detail(self):
+        # Grab the current data & modify it slightly.
+        original_data = self.getResource(self.detail_url)
+        new_data = original_data.copy()
+        new_data['email'] = '[e-mail]'
+
+        self.assertEqual(Person.objects.count(), 1)
+        self.patch(resource=self.detail_url, params=new_data)
+        # Make sure the count hasn't changed & we did an update.
+        self.assertEqual(Person.objects.count(), 1)
+        # Check for updated data.
+        self.assertEqual(Person.objects.get(pk=self.person_1.pk).name,
+                         'Johnny Test')
+        self.assertEqual(Person.objects.get(pk=self.person_1.pk).email,
+                         '[e-mail]')
+        self.assertEqual(Person.objects.get(pk=self.person_1.pk).is_team,
+                         False)
+
+    def test_delete_person_not_allowed(self):
+        resp = self.delete(resource=self.detail_url)
+        self.assertHttpMethodNotAllowed(resp)