Copy CKAN extension boiler-plate from core ckan template: paster --pl…

…ugin=ckan create -t ckanext ckanext-archiver

.coveragerc

@@ -0,0 +1,5 @@
+[report]
+omit =
+    */site-packages/*
+    */python?.?/*
+    ckan/*

.gitignore

@@ -1,8 +1,52 @@
-*.pyc
-*.egg-info
-build
-*.egg
-.DS_Store
-*.swp
+# archiver settings should not be checked in - only its template
 ckanext/archiver/settings.py
-*~
+
+.DS_Store
+# vim
+*.sw?
+# emacs
+*~
+
+.ropeproject
+node_modules
+bower_components
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+env/
+build/
+develop-eggs/
+dist/
+sdist/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.cache
+nosetests.xml
+coverage.xml
+
+# Sphinx documentation
+docs/_build/
+

.travis.yml

@@ -0,0 +1,10 @@
+language: python
+python:
+    - "2.7"
+env: PGVERSION=9.1
+install:
+    - bash bin/travis-build.bash
+    - pip install coveralls
+script: sh bin/travis-run.sh
+after_success:
+    - coveralls

LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Open Knowledge & Crown Copyright
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+

MANIFEST.in

@@ -0,0 +1,2 @@
+include README.rst
+recursive-include ckanext/archiver *.html *.json *.js *.less *.css

README.rst

@@ -1,10 +1,25 @@
-CKAN Archiver Extension
-=======================
+.. You should enable this project on travis-ci.org and coveralls.io to make
+   these badges work. The necessary Travis and Coverage config files have been
+   generated for you.
 
-**Status:** Production
+.. image:: https://travis-ci.org/datagovuk/ckanext-archiver.svg?branch=master
+    :target: https://travis-ci.org/datagovuk/ckanext-archiver
 
-**CKAN Version:** release-1.7.1-dgu
+.. image:: https://pypip.in/py_versions/ckanext-archiver/badge.svg
+    :target: https://pypi.python.org/pypi/ckanext-archiver/
+    :alt: Supported Python versions
 
+.. image:: https://pypip.in/status/ckanext-archiver/badge.svg
+    :target: https://pypi.python.org/pypi/ckanext-archiver/
+    :alt: Development Status
+
+.. image:: https://pypip.in/license/ckanext-archiver/badge.svg
+    :target: https://pypi.python.org/pypi/ckanext-archiver/
+    :alt: License
+
+=============
+ckanext-archiver
+=============
 
 Overview
 --------
@@ -25,21 +40,32 @@ This means that the 'bulk' queue can happily run slowly, chugging through the do
 Installation
 ------------
 
-Install the extension source as usual, e.g. (from an activated virtualenv)::
+To install ckanext-archiver:
+
+1. Activate your CKAN virtual environment, for example::
+
+     . /usr/lib/ckan/default/bin/activate
 
-    $ pip install -e git+http://github.com/datagovuk/ckanext-archiver.git#egg=ckanext-archiver
+2. Install the ckanext-archiver Python package into your virtual environment::
 
-Or (primarily for developers) download the source, then from the ckanext-archiver directory run::
+     pip install -e git+http://github.com/datagovuk/ckanext-archiver.git#egg=ckanext-archiver
 
-    $ pip install -e ./
+3. Now create the database tables::
 
-Whichever way you install the source, you now must create the database tables::
+     paster --plugin=ckanext-archiver archiver init --config=production.ini
 
-    $ paster --plugin=ckanext-archiver archiver init --config=ckan.ini
+4. Add ``archiver`` to the ``ckan.plugins`` setting in your CKAN
+   config file (by default the config file is located at
+   ``/etc/ckan/default/production.ini``).
 
+5. Restart CKAN. For example if you've deployed CKAN with Apache on Ubuntu::
 
-Configuration
--------------
+     sudo service apache2 reload
+
+
+
+Config settings
+---------------
 
 1.  Enabling Archiver to listen to resource changes
 
@@ -131,8 +157,6 @@ The Archiver can be used in two ways:
 Testing
 -------
 
-Tests should be run from the CKAN root directory (not the extension root).
-
-::
+To run the tests, from the CKAN root directory (not the extension root) do::
 
-    (pyenv)~/pyenv/src/ckan$ nosetests --ckan ../ckanext-archiver/tests/ --with-pylons=../ckanext-archiver/test.ini
+    (pyenv)~/pyenv/src/ckan$ nosetests --ckan ../ckanext-archiver/tests/ --with-pylons=../ckanext-archiver/test-core.ini

bin/travis-build.bash

@@ -0,0 +1,38 @@
+#!/bin/bash
+set -e
+
+echo "This is travis-build.bash..."
+
+echo "Installing the packages that CKAN requires..."
+sudo apt-get update -qq
+sudo apt-get install postgresql-$PGVERSION solr-jetty libcommons-fileupload-java:amd64=1.2.2-1
+
+echo "Installing CKAN and its Python dependencies..."
+git clone https://github.com/ckan/ckan
+cd ckan
+export latest_ckan_release_branch=`git branch --all | grep remotes/origin/release-v | sort -r | sed 's/remotes\/origin\///g' | head -n 1`
+echo "CKAN branch: $latest_ckan_release_branch"
+git checkout $latest_ckan_release_branch
+python setup.py develop
+pip install -r requirements.txt --allow-all-external
+pip install -r dev-requirements.txt --allow-all-external
+cd -
+
+echo "Creating the PostgreSQL user and database..."
+sudo -u postgres psql -c "CREATE USER ckan_default WITH PASSWORD 'pass';"
+sudo -u postgres psql -c 'CREATE DATABASE ckan_test WITH OWNER ckan_default;'
+
+echo "Initialising the database..."
+cd ckan
+paster db init -c test-core.ini
+cd -
+
+echo "Installing ckanext-ckanext-archiver and its requirements..."
+python setup.py develop
+pip install -r dev-requirements.txt
+
+echo "Moving test.ini into a subdir..."
+mkdir subdir
+mv test.ini subdir
+
+echo "travis-build.bash is done."

bin/travis-run.sh

@@ -0,0 +1,6 @@
+#!/bin/sh -e
+
+echo "NO_START=0\nJETTY_HOST=127.0.0.1\nJETTY_PORT=8983\nJAVA_HOME=$JAVA_HOME" | sudo tee /etc/default/jetty
+sudo cp ckan/ckan/config/solr/schema.xml /etc/solr/conf/schema.xml
+sudo service jetty restart
+nosetests --nologcapture --with-pylons=subdir/test.ini --with-coverage --cover-package=ckanext.archiver --cover-inclusive --cover-erase --cover-tests

ckanext/archiver/tasks.py

@@ -211,6 +211,8 @@ def _save(status_id, exception, resource, url_redirected_to=None,
     _save(Status.by_text('Archived successfully'), '', resource,
           download_result['url_redirected_to'], download_result, archive_result)
     # The return value is only used by tests. Serialized for Celery.
+    print download_result
+    print archive_result
     return json.dumps(dict(download_result, **archive_result))
 
 

setup.cfg

@@ -0,0 +1,21 @@
+[extract_messages]
+keywords = translate isPlural
+add_comments = TRANSLATORS:
+output_file = i18n/ckanext-archiver.pot
+width = 80
+
+[init_catalog]
+domain = ckanext-archiver
+input_file = i18n/ckanext-archiver.pot
+output_dir = i18n
+
+[update_catalog]
+domain = ckanext-archiver
+input_file = i18n/ckanext-archiver.pot
+output_dir = i18n
+previous = true
+
+[compile_catalog]
+domain = ckanext-archiver
+directory = i18n
+statistics = true