Merge pull request #3 from edmondatto/develop

Improve social sharing in CKAN

README.md

@@ -1,2 +1,25 @@
-# ckanext-social
-Improved social sharing in CKAN.
+# CKAN social
+An extension that improves social sharing in CKAN.
+
+With the extension installed and activated, when a user clicks the social share button, the page title is included in the text that pops up.
+
+Also, without the ckanext-social extension, CKAN doesn't include open graph tags in the head to facilitate the use of summary cards when sharing to social.
+The extension also add these and makes them relevant to the particular page being shared.
+
+# Installation
+
+Installing this extension in your CKAN instance is as easy as installing any other CKAN extension.
+
+Activate your virtual environment
+
+`. /usr/local/lib/ckan/default/bin/activate`
+## Install the extension
+```commandline
+$ git clone https://github.com/CodeForAfricaLabs/ckanext-social.git
+$ cd ckanext-social
+$ python setup.py develop
+```
+
+Modify your configuration file (generally in /etc/ckan/default/production.ini) and add social in the ckan.plugins property.
+
+`ckan.plugins = social <OTHER_PLUGINS>  `

ckanext-social/.coveragerc

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

ckanext-social/.gitignore

@@ -0,0 +1,42 @@
+.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/

ckanext-social/.travis.yml

@@ -0,0 +1,11 @@
+language: python
+sudo: required
+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

ckanext-social/MANIFEST.in

@@ -0,0 +1,4 @@
+include README.rst
+include LICENSE
+include requirements.txt
+recursive-include ckanext/social *.html *.json *.js *.less *.css *.mo

ckanext-social/README.rst

@@ -0,0 +1,166 @@
+.. 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.
+
+.. image:: https://travis-ci.org/edmondatto/ckanext-social.svg?branch=master
+    :target: https://travis-ci.org/edmondatto/ckanext-social
+
+.. image:: https://coveralls.io/repos/edmondatto/ckanext-social/badge.svg
+  :target: https://coveralls.io/r/edmondatto/ckanext-social
+
+.. image:: https://pypip.in/download/ckanext-social/badge.svg
+    :target: https://pypi.python.org/pypi//ckanext-social/
+    :alt: Downloads
+
+.. image:: https://pypip.in/version/ckanext-social/badge.svg
+    :target: https://pypi.python.org/pypi/ckanext-social/
+    :alt: Latest Version
+
+.. image:: https://pypip.in/py_versions/ckanext-social/badge.svg
+    :target: https://pypi.python.org/pypi/ckanext-social/
+    :alt: Supported Python versions
+
+.. image:: https://pypip.in/status/ckanext-social/badge.svg
+    :target: https://pypi.python.org/pypi/ckanext-social/
+    :alt: Development Status
+
+.. image:: https://pypip.in/license/ckanext-social/badge.svg
+    :target: https://pypi.python.org/pypi/ckanext-social/
+    :alt: License
+
+=============
+ckanext-social
+=============
+
+.. Put a description of your extension here:
+   What does it do? What features does it have?
+   Consider including some screenshots or embedding a video!
+
+
+------------
+Requirements
+------------
+
+For example, you might want to mention here which versions of CKAN this
+extension works with.
+
+
+------------
+Installation
+------------
+
+.. Add any additional install steps to the list below.
+   For example installing any non-Python dependencies or adding any required
+   config settings.
+
+To install ckanext-social:
+
+1. Activate your CKAN virtual environment, for example::
+
+     . /usr/lib/ckan/default/bin/activate
+
+2. Install the ckanext-social Python package into your virtual environment::
+
+     pip install ckanext-social
+
+3. Add ``social`` to the ``ckan.plugins`` setting in your CKAN
+   config file (by default the config file is located at
+   ``/etc/ckan/default/production.ini``).
+
+4. Restart CKAN. For example if you've deployed CKAN with Apache on Ubuntu::
+
+     sudo service apache2 reload
+
+
+---------------
+Config Settings
+---------------
+
+Document any optional config settings here. For example::
+
+    # The minimum number of hours to wait before re-checking a resource
+    # (optional, default: 24).
+    ckanext.social.some_setting = some_default_value
+
+
+------------------------
+Development Installation
+------------------------
+
+To install ckanext-social for development, activate your CKAN virtualenv and
+do::
+
+    git clone https://github.com/edmondatto/ckanext-social.git
+    cd ckanext-social
+    python setup.py develop
+    pip install -r dev-requirements.txt
+
+
+-----------------
+Running the Tests
+-----------------
+
+To run the tests, do::
+
+    nosetests --nologcapture --with-pylons=test.ini
+
+To run the tests and produce a coverage report, first make sure you have
+coverage installed in your virtualenv (``pip install coverage``) then run::
+
+    nosetests --nologcapture --with-pylons=test.ini --with-coverage --cover-package=ckanext.social --cover-inclusive --cover-erase --cover-tests
+
+
+---------------------------------
+Registering ckanext-social on PyPI
+---------------------------------
+
+ckanext-social should be availabe on PyPI as
+https://pypi.python.org/pypi/ckanext-social. If that link doesn't work, then
+you can register the project on PyPI for the first time by following these
+steps:
+
+1. Create a source distribution of the project::
+
+     python setup.py sdist
+
+2. Register the project::
+
+     python setup.py register
+
+3. Upload the source distribution to PyPI::
+
+     python setup.py sdist upload
+
+4. Tag the first release of the project on GitHub with the version number from
+   the ``setup.py`` file. For example if the version number in ``setup.py`` is
+   0.0.1 then do::
+
+       git tag 0.0.1
+       git push --tags
+
+
+----------------------------------------
+Releasing a New Version of ckanext-social
+----------------------------------------
+
+ckanext-social is availabe on PyPI as https://pypi.python.org/pypi/ckanext-social.
+To publish a new version to PyPI follow these steps:
+
+1. Update the version number in the ``setup.py`` file.
+   See `PEP 440 <http://legacy.python.org/dev/peps/pep-0440/#public-version-identifiers>`_
+   for how to choose version numbers.
+
+2. Create a source distribution of the new version::
+
+     python setup.py sdist
+
+3. Upload the source distribution to PyPI::
+
+     python setup.py sdist upload
+
+4. Tag the new release of the project on GitHub with the version number from
+   the ``setup.py`` file. For example if the version number in ``setup.py`` is
+   0.0.2 then do::
+
+       git tag 0.0.2
+       git push --tags

ckanext-social/bin/travis-build.bash

@@ -0,0 +1,43 @@
+#!/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 "SOLR config..."
+# Solr is multicore for tests on ckan master, but it's easier to run tests on
+# Travis single-core. See https://github.com/ckan/ckan/issues/2972
+sed -i -e 's/solr_url.*/solr_url = http:\/\/127.0.0.1:8983\/solr/' ckan/test-core.ini
+
+echo "Initialising the database..."
+cd ckan
+paster db init -c test-core.ini
+cd -
+
+echo "Installing ckanext-social 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."

ckanext-social/bin/travis-run.sh

@@ -0,0 +1,14 @@
+#!/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 --ckan \
+          --nologcapture \
+          --with-pylons=subdir/test.ini \
+          --with-coverage \
+          --cover-package=ckanext.social \
+          --cover-inclusive \
+          --cover-erase \
+          --cover-tests

ckanext-social/ckanext/__init__.py

@@ -0,0 +1,9 @@
+# encoding: utf-8
+
+# this is a namespace package
+try:
+    import pkg_resources
+    pkg_resources.declare_namespace(__name__)
+except ImportError:
+    import pkgutil
+    __path__ = pkgutil.extend_path(__path__, __name__)

ckanext-social/ckanext/social/helpers/helpers.py

@@ -0,0 +1,2 @@
+def generic_title():
+    return "this great resource"

ckanext-social/ckanext/social/plugin.py

@@ -0,0 +1,28 @@
+import ckan.plugins as plugins
+import ckan.plugins.toolkit as toolkit
+
+
+class SocialPlugin(plugins.SingletonPlugin):
+    plugins.implements(plugins.IConfigurer)
+    plugins.implements(plugins.ITemplateHelpers)
+
+    # IConfigurer
+
+    def update_config(self, config_):
+        toolkit.add_template_directory(config_, 'templates')
+        toolkit.add_public_directory(config_, 'public')
+        toolkit.add_resource('fanstatic', 'social')
+
+    def get_helpers(self):
+        """
+        All functions, not starting with __ in the ckanext.social.helpers
+        module will be loaded and made available as helpers to the
+        templates.
+        """
+        from ckanext.social.helpers import helpers
+        from inspect import getmembers, isfunction
+
+        helper_dict = {}
+
+        funcs = [o for o in getmembers(helpers, isfunction)]
+        return dict([(f[0],f[1],) for f in funcs if not f[0].startswith('__')])

ckanext-social/ckanext/social/templates/base.html

@@ -0,0 +1,27 @@
+{% ckan_extends %}
+
+{% block meta %}
+  {{ super() }}
+  {% set pkg = c.pkg_dict %}
+  {% set current_url = h.full_current_url() %}
+  {% set description = h.markdown_extract(pkg.notes, extract_length=200)|forceescape %}
+  <meta property="og:title" content="{{ h.dataset_display_name(pkg) }} - {{ g.site_title }}">
+  <meta property="og:description" content="{{ description|forceescape|trim }}">
+  <meta property="og:url" content="{{ current_url }}" />
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  <meta property="og:image" content="https://africaopendata.org/images/logos/open-africa.png" />
+  <meta property="fb:app_id" content="835169686614108" />
+
+  <meta name="twitter:card" content="summary_large_image"/>
+  <meta name="twitter:title" content="{{ h.dataset_display_name(pkg) }} - {{ g.site_title }}"/>
+  <meta name="twitter:description" content="{{ description|forceescape|trim }}"/>
+  <meta name="twitter:url" content="{{ current_url }}"/>
+  <meta name="twitter:image" content="https://africaopendata.org/images/logos/open-africa.png"/>
+
+{% endblock %}
+
+{% block styles %}
+  {{ super() }}
+  <link rel="stylesheet" href="/bootstrap-responsive.min.css" />
+  <link rel="stylesheet" href="/openafrica_theme.css" />
+{% endblock %}