Merge remote-tracking branch 'upstream/master'

Author: Chris Hooks

README.md

@@ -37,7 +37,7 @@ Make sure that your Python installation allows you to run `python` from the comm
 4. Click "Next," then "Finish."
 
 ### Running the tests
-It is possible to run all the tests in one go, or just run one part of the tests to verify a single part of TinCanPython. The tests are located in `TinCanPython/test`.
+It is possible to run all the tests in one go, or just run one part of the tests to verify a single part of TinCanPython. The tests are located in `test/`.
 
 #### All the tests:
 1. `cd` to the `test` directory.
@@ -53,17 +53,25 @@ It is possible to run all the tests in one go, or just run one part of the tests
 
     (or whatever test you want to run)
 
+#### A single test case of one of the tests:
+1. `cd` to the directory containing the test.
+2. Run
+
+        python -m unittest remote_lrs_test.RemoteLRSTest.test_retrieve_statement
+
+    Where "remote_lrs_test" is the test file, "RemoteLRSTest" is the class in that file, and "test_retrieve_statement" is the specific test case.
+
 ## API doc generation
-To automatically generate documentation, go to the `TinCanPython` folder and run the command
+To automatically generate documentation, at the root of the repository run,
 
     sphinx-apidoc -o ./docs/source/ tincan/
 
-Then from the `TinCanPython/docs` folder run
+Then from the `docs/` directory run,
 
     make html
 
-The docs will be put in `TinCanPython/docs/build/html/index.html`.
+The docs will be output to `docs/build/html/`.
 
-If you would like to change the names of each section, you can do so by modifying `TinCanPython/docs/source/tincan.rst`.
+If you would like to change the names of each section, you can do so by modifying `docs/source/tincan.rst`.
 
 ## Releasing

test/about_test.py

@@ -1,5 +1,3 @@
-#!/usr/bin/env python
-
 #    Copyright 2014 Rustici Software
 #
 #    Licensed under the Apache License, Version 2.0 (the "License");

test/activity_test.py

@@ -72,14 +72,14 @@ def test_FromJSONExceptionEmptyObject(self):
     def test_AsVersionEmpty(self):
         activity = Activity()
         activity2 = activity.as_version()
-        self.assertEqual(activity2, {})
+        self.assertEqual(activity2, {"objectType": "Activity"})
 
-    def test_asVersionNotEmpty(self):
+    def test_AsVersionNotEmpty(self):
         activity = Activity(id='test')
         activity2 = activity.as_version()
-        self.assertEqual(activity2, {'id': 'test'})
+        self.assertEqual(activity2, {'id': 'test', "objectType": "Activity"})
 
-    def test_asVersion(self):
+    def test_AsVersion(self):
         activity = Activity(id='test', definition=ActivityDefinition(), object_type='Activity')
         activity2 = activity.as_version()
         self.assertEqual(activity2, {'id': 'test', 'definition': {}, 'objectType': 'Activity'})

test/activitylist_test.py

@@ -35,19 +35,19 @@ def test_InitEmpty(self):
 
     def test_Init(self):
         alist = ActivityList(
-            [Activity(id='test1'), Activity(id='test2')]
+            [Activity(id='test1', object_type='Activity'), Activity(id='test2', object_type='Activity')]
         )
         self.listVerificationHelper(alist)
 
     def test_InitList(self):
-        a1 = Activity(id='test1')
-        a2 = Activity(id='test2')
+        a1 = Activity(id='test1', object_type='Activity')
+        a2 = Activity(id='test2', object_type='Activity')
         alist = ActivityList([a1, a2])
         self.listVerificationHelper(alist)
 
     def test_InitActivityList(self):
-        a1 = Activity(id='test1')
-        a2 = Activity(id='test2')
+        a1 = Activity(id='test1', object_type='Activity')
+        a2 = Activity(id='test2', object_type='Activity')
         arg = ActivityList([a1, a2])
         alist = ActivityList(arg)
         self.listVerificationHelper(alist)
@@ -83,23 +83,23 @@ def test_AsVersionEmpty(self):
         self.assertEqual(check, [])
 
     def test_AsVersionNotEmpty(self):
-        a1 = Activity(id='test1')
-        a2 = Activity(id='test2')
+        a1 = Activity(id='test1', object_type='Activity')
+        a2 = Activity(id='test2', object_type='Activity')
         alist = ActivityList([a1, a2])
         check = alist.as_version()
         self.assertEqual(check,
-            [{"id": "test1"}, {"id": "test2"}]
+            [{"id": "test1", "objectType": "Activity"}, {"id": "test2", "objectType": "Activity"}]
         )
 
     def test_ToJSONFromJSON(self):
-        json_str = '[{"id": "test1"}, {"id": "test2"}]'
+        json_str = '[{"id": "test1", "objectType": "Activity"}, {"id": "test2", "objectType": "Activity"}]'
         alist = ActivityList.from_json(json_str)
         self.listVerificationHelper(alist)
         self.assertEqual(alist.to_json(), json_str)
 
     def test_ToJSON(self):
         alist = ActivityList([{"id": "test1"}, {"id": "test2"}])
-        self.assertEqual(alist.to_json(), '[{"id": "test1"}, {"id": "test2"}]')
+        self.assertEqual(alist.to_json(), '[{"id": "test1", "objectType": "Activity"}, {"id": "test2", "objectType": "Activity"}]')
 
     def test_setItem(self):
         alist = ActivityList([Activity(), Activity()])
@@ -108,16 +108,16 @@ def test_setItem(self):
         self.listVerificationHelper(alist)
 
     def test_setItemException(self):
-        a1 = Activity(id='test1')
-        a2 = Activity(id='test2')
+        a1 = Activity(id='test1', object_type='Activity')
+        a2 = Activity(id='test2', object_type='Activity')
         alist = ActivityList([a1, a2])
         with self.assertRaises(TypeError):
             alist[0] = 'not Activity'
         self.listVerificationHelper(alist)
 
     def test_appendItem(self):
-        a1 = Activity(id='test1')
-        a2 = Activity(id='test2')
+        a1 = Activity(id='test1', object_type='Activity')
+        a2 = Activity(id='test2', object_type='Activity')
         alist = ActivityList()
         alist.append(a1)
         alist.append(a2)
@@ -136,8 +136,8 @@ def test_appendItemCoercion(self):
         self.listVerificationHelper(alist)
 
     def test_extend(self):
-        a1 = Activity(id='test1')
-        a2 = Activity(id='test2')
+        a1 = Activity(id='test1', object_type='Activity')
+        a2 = Activity(id='test2', object_type='Activity')
         arglist = ActivityList([a1, a2])
         alist = ActivityList([Activity(id='test3')])
         alist.extend(arglist)
@@ -147,24 +147,24 @@ def test_extend(self):
         self.assertEqual(alist[2].id, 'test2')
 
     def test_extendExceptionNotComponent(self):
-        a1 = Activity(id='test1')
+        a1 = Activity(id='test1', object_type='Activity')
         arglist = [a1, 'not Activity']
         alist = ActivityList([Activity()])
         with self.assertRaises(TypeError):
             alist.extend(arglist)
 
     def test_insert(self):
-        a1 = Activity(id='test1')
+        a1 = Activity(id='test1', object_type='Activity')
         a2 = Activity(id='test3')
         alist = ActivityList([a1, a2])
-        alist.insert(1, Activity(id='test2'))
+        alist.insert(1, Activity(id='test2', object_type='Activity'))
         self.assertEqual(len(alist), 3)
         self.assertEqual(alist[0].id, 'test1')
         self.assertEqual(alist[1].id, 'test2')
         self.assertEqual(alist[2].id, 'test3')
 
     def test_insertExceptionNotComponent(self):
-        a1 = Activity(id='test1')
+        a1 = Activity(id='test1', object_type='Activity')
         a2 = Activity(id='test3')
         alist = ActivityList([a1, a2])
         with self.assertRaises(TypeError):