rc/0.6.0

.travis.yml

@@ -24,5 +24,4 @@ deploy:
   run:
     - "sleep 15"
     - "python manage.py migrate --noinput"
-    - "python manage.py update_index"
     - "python manage.py sync_permissions"

Dockerfile

@@ -45,7 +45,12 @@ ENV PATH /src/node_modules/.bin:/node/node_modules/.bin:$PATH
 # Set pip cache folder, as it is breaking pip when it is on a shared volume
 ENV XDG_CACHE_HOME /tmp/.cache
 
-EXPOSE 8070
+# Gather static
+RUN ./manage.py collectstatic --noinput
 
 USER mitodl
-CMD uwsgi uwsgi.ini
+
+# Set and expose port for uwsgi config
+EXPOSE 8070
+ENV PORT 8070
+CMD if [ -n "$WORKER" ]; then celery -A lore worker; else uwsgi uwsgi.ini; fi

RELEASE.rst

@@ -1,13 +1,54 @@
 Release Notes
 -------------
 
+Version 0.6.0
+=============
+
+- Modified learningresource panel to include multi select.
+- Fixed export button not appearing in certain situations.
+- Added test for StaticAsset.loader.
+- Added export functionality for learning resources.
+- Added select2-bootstrap-theme bower component.
+- Added Select2 to the JS libraries.
+- Created ICheckbox React component.
+- Made XML preview box for a LearningResource should be read only.
+- Pinned all versions.
+- Avoided hitting the database for the search page.
+- Added field to Vocabulary to define if it can contain multiple terms.
+- Incremented xbundle version.
+- Added test for ManageTaxonomies.loader.
+- Changed vocabularies listing page to match the design.
+- Fixed broken links in the footer.
+- Removed console.error statement.
+- Fixed bug where export checkboxes were not updated in sync with
+  export count.
+- Fix test failures due to pylint dependency chain.
+- Created StatusBox component to hold messages and errors.
+- Added shopping cart for export.
+- Changed response vocabulary name to match input and avoid key collision.
+- Added docker support for running worker or Web process by environment.
+- Extended tests for manage_taxonomies.jsx file.
+- Added description path to listing page.
+- Removed export view which isn't used anymore.
+- Refactored code for reloading module into a function.
+- Refactored permission check for listing view.
+- Updated Haystack to 2.4.0 - Removed automatic index update from deployment.
+- Fixed preview link not showing up in list view.
+- Grouped REST tests by common endpoint.
+- Changed vocabulary term indexing from string to integer.
+- Implemented preview link for learning resource panel.
+- Added sorting to search results.
+- Implemented learning resource panel updating on every panel open.
+- Used different haystack index for tests to prevent conflict with
+  web application.
+
 Version 0.5.0
 =============
 
 - Fixed display of vocabulary terms containing spaces.
 - Fixed comparison of FileFields to strings.
 - Fixed typo in search hint
-- Added bootstrap style to vocabularly learning type checkboxes Closes #337
+- Added bootstrap style to vocabulary learning type checkboxes Closes #337
 - Changed search box description
 - Fixed mutating of this.state which is forbidden
 - Added static file parsing to HTML elements.
@@ -132,7 +173,7 @@ Version 0.1.0
 - Added rest app with support for RESTful API
 - Added initial authorization support
 - Added login requirement for taxonomy app
-- Switched to using django storage for course uploads
+- Switched to using Django storage for course uploads
 - Switched to using Haystack/ElasticSearch for listing page
 - Protected course imports
 - Protected export view

apiary.apib

@@ -1,5 +1,5 @@
 FORMAT: 1A
-HOST: http://lore.odl.mit.edu/
+HOST: http://lore.odl.mit.edu/api/v1/
 
 # LORE
 
@@ -21,7 +21,7 @@ URL Structure is `https://{domain}/api/v1/{resource}/{resource_id}/`
 
 *Example: `http://lore.odl.mit.edu/api/v1/repositories/physics-1/` will return a JSON representation of the repository with name "physics-1".*
 
-*Example: `http://lore.odl.mit.edu/api/v1/repositories/physics-1/learningresources/1007/` will return a JSON representation
+*Example: `http://lore.odl.mit.edu/api/v1/repositories/physics-1/learning_resources/1007/` will return a JSON representation
 of the learning resource with ID=1007.*
 
 
@@ -134,15 +134,16 @@ Create a repository by providing its JSON representation.
             "create_date": "2015-06-22"
         }
 
-## Group Learningresources
+## Group LearningResources
 
-## Learningresource Collection [/repositories/{repo_slug}/learning_resources/{?type_name}]
+## LearningResource Collection [/repositories/{repo_slug}/learning_resources/{?type_name}]
 
 + Parameters
     + repo_slug: `physics-1` (string, required) - slug for the repository
     + type_name: `chapter` (string, optional) - type of learning resource
+    + ids: `1,9` (string, optional) - comma separated list of LearningResource ids. Will filter out LearningResources not in this list.
 
-### List Learningresources [GET]
+### List LearningResources [GET]
 
 + Response 200 (application/json)
 
@@ -168,19 +169,20 @@ Create a repository by providing its JSON representation.
                     "xa_nr_attempts": 0,
                     "xa_avg_grade": 0.0,
                     "xa_histogram_grade": 0.0,
-                    "terms": []
+                    "terms": [],
+                    "preview_url": "https://www.example.com/courses..."
                 },
                 ...
             ]
         }
 
-## Learningresource  [/repositories/{repo_slug}/learning_resources/{learningresource_id}/]
+## LearningResource  [/repositories/{repo_slug}/learning_resources/{learningresource_id}/]
 
 + Parameters
     + repo_slug: `physics-1` (string, required) - slug for the repository
-    + learningresource_id: `8` (number, required) - ID of the Learningresource
+    + learningresource_id: `8` (number, required) - ID of the LearningResource
 
-### View a Learningresource [GET]
+### View a LearningResource [GET]
 
 + Response 200 (application/json)
 
@@ -199,10 +201,11 @@ Create a repository by providing its JSON representation.
             "xa_nr_attempts": 0,
             "xa_avg_grade": 0.0,
             "xa_histogram_grade": 0.0,
-            "terms": []
+            "terms": [],
+            "preview_url": "https://www.example.com/courses..."
         }
 
-### Partially Update a Learningresource [PATCH]
+### Partially Update a LearningResource [PATCH]
 
 + Request (application/json)
 
@@ -227,10 +230,11 @@ Create a repository by providing its JSON representation.
             "xa_nr_attempts": 0,
             "xa_avg_grade": 0.0,
             "xa_histogram_grade": 0.0,
-            "terms": []
+            "terms": [],
+            "preview_url": "https://www.example.com/courses..."
         }
 
-### Update a Learningresource [PUT]
+### Update a LearningResource [PUT]
 
 + Request (application/json)
 
@@ -256,18 +260,84 @@ Create a repository by providing its JSON representation.
             "xa_nr_attempts": 0,
             "xa_avg_grade": 0.0,
             "xa_histogram_grade": 0.0,
-            "terms": []
+            "terms": [],
+            "preview_url": "https://www.example.com/courses..."
+        }
+
+## Group LearningResourceExports
+
+List of LearningResources to be exported. This is stored per user and is deleted on logout.
+
+## LearningResourceExport Collection [/repositories/{repo_slug}/learning_resource_exports/{username}/]
+
++ Parameters
+    + repo_slug: `physics-1` (string, required) - slug for the repository
+    + username: `sarah` (string, required) - owner of exports (must be logged in user)
+
+### List LearningResourceExports [GET]
+
++ Response 200 (application/json)
+
+    + Body
+
+        {
+            "count": 1,
+            "next": null,
+            "previous": null,
+            "results": [
+                {
+                    "id": 13
+                }
+            ]
+        }
+
+### Delete LearningResourceExports [DELETE]
+
+Clears the export list for this repository.
+
++ Response 204 (application/json)
+
+### Add a LearningResource ID to Export list [POST]
+
++ Request (application/json)
+
+        {
+            "id": 15
+        }
+
++ Response 201 (application/json)
+
+        {
+            "id": 15
         }
 
-## Group Staticassets
+## LearningResourceExport [/repositories/{repo_slug}/learning_resource_exports/{username}/]
+
++ Parameters
+    + repo_slug: `physics-1` (string, required) - slug for the repository
+    + username: `sarah` (string, required) - owner of exports (must be logged in user)
+
+### View a LearningResourceExport [GET]
+
++ Response 200 (application/json)
+
+        {
+            "id": 13
+        }
+
+### Delete an ID from the LearningResource export list [DELETE]
+
++ Response 204 (application/json)
+
+## Group StaticAssets
 
-## Staticassets Collection [/repositories/{repo_slug}/learning_resources/{learningresource_id}/static_assets/]
+## StaticAssets Collection [/repositories/{repo_slug}/learning_resources/{learningresource_id}/static_assets/]
 
 + Parameters
     + repo_slug: `physics-1` (string, required) - slug for the repository
-    + learningresource_id: `1` (number, required) - ID of the Learningresource
+    + learningresource_id: `1` (number, required) - ID of the LearningResource
 
-### List All Staticassets [GET]
+### List All StaticAssets [GET]
 
 + Response 200 (application/json)
 
@@ -283,14 +353,14 @@ Create a repository by providing its JSON representation.
             ]
         }
 
-## Staticasset [/repositories/{repo_slug}/learning_resources/{learningresource_id}/static_assets/{static_asset_id}/]
+## StaticAsset [/repositories/{repo_slug}/learning_resources/{learningresource_id}/static_assets/{static_asset_id}/]
 
 + Parameters
     + repo_slug: `physics-1` (string, required) - slug for the repository
-    + learningresource_id: `1` (number, required) - ID of the Learningresource
-    + static_asset_id: `1` (number, required) - ID of the Staticasset
+    + learningresource_id: `1` (number, required) - ID of the LearningResource
+    + static_asset_id: `1` (number, required) - ID of the StaticAsset
 
-### View a Staticasset [GET]
+### View a StaticAsset [GET]
 
 + Response 200 (application/json)
 

bower.json

@@ -15,6 +15,8 @@
     "modernizr": "~2.8.3",
     "retina.js": "~1.3.0",
     "react": "0.13.3",
-    "react-addons": "0.1.2"
+    "react-addons": "0.1.2",
+    "select2": "~4.0.0",
+    "select2-bootstrap-theme": "~0.1.0-beta.4"
   }
 }

docker-compose.yml

@@ -33,6 +33,7 @@ web:
     LORE_ADMIN_EMAIL:
     LORE_CAS_URL:
     CELERY_ALWAYS_EAGER: False
+    CELERY_RESULT_BACKEND: redis://redis:6379/4
     BROKER_URL: redis://redis:6379/4
     HAYSTACK_URL: elastic:9200
   ports:

exporter/api.py

@@ -0,0 +1,84 @@
+"""
+Functions for exporting learning resources
+"""
+
+from __future__ import unicode_literals
+
+from tempfile import mkdtemp, mkstemp
+import tarfile
+import os
+from shutil import rmtree
+
+from django.utils.text import slugify
+from django.core.files.storage import default_storage
+from lore.settings import EXPORT_PATH_PREFIX
+
+
+def export_resources_to_directory(learning_resources):
+    """
+    Create files of LearningResource and StaticAsset contents inside directory.
+
+    Args:
+        learning_resources (list of learningresources.models.LearningResource):
+            LearningResources to export in tarball
+    Returns:
+        unicode: Newly created temp directory with files inside of it.
+    """
+    def sanitize(title):
+        """Sanitize title for use in filename."""
+        # Limit filename to 200 characters since limit is 256
+        # and we have a number and extension too.
+        return slugify(title)[:200]
+
+    tempdir = mkdtemp()
+    try:
+        for learning_resource in learning_resources:
+            filename = "{id}_{title}.xml".format(
+                id=learning_resource.id,
+                title=sanitize(learning_resource.title),
+            )
+            with open(os.path.join(tempdir, filename), 'w') as f:
+                f.write(learning_resource.content_xml)
+    except:
+        # Clean up temporary directory since we can't return it anymore.
+        rmtree(tempdir)
+        raise
+    return tempdir
+
+
+def export_resources_to_tarball(learning_resources, username):
+    """
+    Create tarball and put LearningResource and StaticAsset contents in it.
+
+    Args:
+        learning_resources (list of learningresources.models.LearningResource):
+            LearningResources to export in tarball
+        username (unicode): Name of user
+    Returns:
+        unicode: path of tarball within django-storage
+    """
+    handle, tempfilepath = mkstemp()
+    os.close(handle)
+    try:
+        archive = tarfile.open(tempfilepath, mode='w:gz')
+
+        tempdir = export_resources_to_directory(learning_resources)
+        try:
+            for name in os.listdir(tempdir):
+                abs_path = os.path.join(tempdir, name)
+                if os.path.isfile(abs_path):
+                    archive.add(abs_path, arcname=name)
+
+            archive.close()
+            output_path = '{prefix}{username}_exports.tar.gz'.format(
+                prefix=EXPORT_PATH_PREFIX,
+                username=username
+            )
+
+            # Remove any old paths.
+            default_storage.delete(output_path)
+            return default_storage.save(output_path, open(tempfilepath, 'rb'))
+        finally:
+            rmtree(tempdir)
+    finally:
+        os.remove(tempfilepath)