Allow activation fails

* Add option to add multiple plugins
* Improve UI hints for collapsed parameters
* Refactored plugins without requirements
* Hide evaluation tab for the moment. You can see it by adding "?evaluation" to
  the URL.

.gitlab-ci.yml

@@ -18,6 +18,8 @@ before_script:
   stage: test
   script:
     - make -e test-$PYTHON_VERSION
+  except:
+    - tags # Avoid unnecessary double testing
     
 test-3.5:
   <<: *test_definition

.makefiles/docker.mk

@@ -1,5 +1,14 @@
-IMAGENAME?=$(NAME)
+ifndef IMAGENAME
+	ifdef CI_REGISTRY_IMAGE
+		IMAGENAME=$(CI_REGISTRY_IMAGE)
+	else
+		IMAGENAME=$(NAME)
+	endif
+endif
+
 IMAGEWTAG?=$(IMAGENAME):$(VERSION)
+DOCKER_FLAGS?=$(-ti)
+DOCKER_CMD?=
 
 docker-login: ## Log in to the registry. It will only be used in the server, or when running a CI task locally (if CI_BUILD_TOKEN is set).
 ifeq ($(CI_BUILD_TOKEN),)
@@ -19,6 +28,19 @@ else
 	@docker logout
 endif
 
+docker-run: ## Build a generic docker image
+	docker run $(DOCKER_FLAGS) $(IMAGEWTAG) $(DOCKER_CMD)
+
+docker-build: ## Build a generic docker image
+	docker build . -t $(IMAGEWTAG)
+
+docker-push: docker-login ## Push a generic docker image
+	docker push $(IMAGEWTAG)
+
+docker-latest-push: docker-login ## Push the latest image
+	docker tag $(IMAGEWTAG) $(IMAGENAME)
+	docker push $(IMAGENAME)
+
 login:: docker-login
 
 clean:: docker-clean

.makefiles/git.mk

@@ -14,7 +14,7 @@ push-github: ## Push the code to github. You need to set up GITHUB_DEPLOY_KEY
 ifeq ($(GITHUB_DEPLOY_KEY),)
 else
 	$(eval KEY_FILE := "$(shell mktemp)")
-	@echo "$(GITHUB_DEPLOY_KEY)" > $(KEY_FILE)
+	@printf '%b' '$(GITHUB_DEPLOY_KEY)' > $(KEY_FILE)
 	@git remote rm github-deploy || true
 	git remote add github-deploy $(GITHUB_REPO)
 	-@GIT_SSH_COMMAND="ssh -i $(KEY_FILE)" git fetch github-deploy $(CI_COMMIT_REF_NAME)

.makefiles/k8s.mk

@@ -13,7 +13,7 @@
 KUBE_CA_TEMP=false
 ifndef KUBE_CA_PEM_FILE
 KUBE_CA_PEM_FILE:=$$PWD/.ca.crt
-CREATED:=$(shell echo -e "$(KUBE_CA_BUNDLE)" > $(KUBE_CA_PEM_FILE))
+CREATED:=$(shell printf '%b\n' '$(KUBE_CA_BUNDLE)' > $(KUBE_CA_PEM_FILE))
 endif 
 KUBE_TOKEN?=""
 KUBE_NAMESPACE?=$(NAME)

.makefiles/python.mk

@@ -26,6 +26,7 @@ Dockerfile-%: Dockerfile.template  ## Generate a specific dockerfile (e.g. Docke
 quick_build: $(addprefix build-, $(PYMAIN))
 
 build: $(addprefix build-, $(PYVERSIONS)) ## Build all images / python versions
+	docker tag $(IMAGEWTAG)-python$(PYMAIN) $(IMAGEWTAG)
 
 build-%: version Dockerfile-%  ## Build a specific version (e.g. build-2.7)
 	docker build -t '$(IMAGEWTAG)-python$*' -f Dockerfile-$* .;
@@ -75,7 +76,7 @@ pip_upload: pip_test  ## Upload package to pip
 
 push-latest: $(addprefix push-latest-,$(PYVERSIONS)) ## Push the "latest" tag to dockerhub
 	docker tag '$(IMAGEWTAG)-python$(PYMAIN)' '$(IMAGEWTAG)'
-	docker tag '$(IMAGEWTAG)-python$(PYMAIN)' '$(IMAGENAME)'
+	docker tag '$(IMAGEWTAG)-python$(PYMAIN)' '$(IMAGENAME):latest'
 	docker push '$(IMAGENAME):latest'
 	docker push '$(IMAGEWTAG)'
 

Dockerfile.template

@@ -6,8 +6,6 @@ RUN apt-get update && apt-get install -y \
 libblas-dev liblapack-dev liblapacke-dev gfortran \
  && rm -rf /var/lib/apt/lists/*
 
-RUN pip install --no-cache-dir --upgrade numpy scipy scikit-learn
-
 RUN mkdir /cache/ /senpy-plugins /data/
 
 VOLUME /data/

MANIFEST.in

@@ -1,5 +1,6 @@
 include requirements.txt
 include test-requirements.txt
+include extra-requirements.txt
 include README.rst
 include senpy/VERSION
 graft senpy/plugins

docker-compose.dev.yml

@@ -0,0 +1,10 @@
+version: '3'
+services:
+    senpy:
+        image: "${IMAGENAME-gsiupm/senpy}:${VERSION-latest}"
+        entrypoint: ["/bin/bash"]
+        working_dir: "/senpy-plugins"
+        ports:
+            - 5000:5000
+        volumes:
+            - ".:/usr/src/app/"

docker-compose.test.yml

@@ -0,0 +1,9 @@
+version: '3'
+services:
+    test:
+        image: "${IMAGENAME-gsiupm/senpy}:${VERSION-dev}"
+        entrypoint: ["py.test"]
+        volumes:
+            - ".:/usr/src/app/"
+        command:
+          []

docker-compose.yml

@@ -0,0 +1,11 @@
+version: '3'
+services:
+    senpy:
+        image: "${IMAGENAME-gsiupm/senpy}:${VERSION-dev}"
+        build:
+          context: .
+          dockerfile: Dockerfile${PYVERSION--2.7}
+        ports:
+            - 5001:5000
+        volumes:
+            - "./data:/data"

example-plugins/configurable_plugin.py

@@ -43,7 +43,6 @@ class Dictionary(plugins.SentimentPlugin):
 
 class EmojiOnly(Dictionary):
     '''Sentiment annotation with a basic lexicon of emojis'''
-    description = 'A plugin'
     dictionaries = [basic.emojis]
 
     test_cases = [{

requirements.txt

@@ -9,3 +9,6 @@ jsonref
 PyYAML
 rdflib
 rdflib-jsonld
+numpy
+scipy
+scikit-learn

senpy/__main__.py

@@ -105,6 +105,12 @@ def main():
         action='store_true',
         default=False,
         help='Output the senpy version and exit')
+    parser.add_argument(
+        '--allow-fail',
+        '--fail',
+        action='store_true',
+        default=False,
+        help='Do not exit if some plugins fail to activate')
     args = parser.parse_args()
     if args.version:
         print('Senpy version {}'.format(senpy.__version__))
@@ -128,9 +134,9 @@ def main():
     sp.install_deps()
     if args.only_install:
         return
-    sp.activate_all()
+    sp.activate_all(allow_fail=args.allow_fail)
     if args.only_test:
-        easy_test(sp.plugins())
+        easy_test(sp.plugins(), debug=args.debug)
         return
     print('Senpy version {}'.format(senpy.__version__))
     print('Server running on port %s:%d. Ctrl+C to quit' % (args.host,

senpy/api.py

@@ -147,7 +147,7 @@ def parse_params(indict, *specs):
         for param, options in iteritems(spec):
             for alias in options.get("aliases", []):
                 # Replace each alias with the correct name of the parameter
-                if alias in indict and alias is not param:
+                if alias in indict and alias != param:
                     outdict[param] = indict[alias]
                     del outdict[alias]
                     continue

senpy/blueprints.py

@@ -19,7 +19,7 @@ Blueprints for Senpy
 """
 from flask import (Blueprint, request, current_app, render_template, url_for,
                    jsonify)
-from .models import Error, Response, Help, Plugins, read_schema, Datasets
+from .models import Error, Response, Help, Plugins, read_schema, dump_schema, Datasets
 from . import api
 from .version import __version__
 from functools import wraps
@@ -47,7 +47,12 @@ def get_params(req):
 
 @demo_blueprint.route('/')
 def index():
-    return render_template("index.html", version=__version__)
+    ev = str(get_params(request).get('evaluation', False))
+    evaluation_enabled = ev.lower() not in ['false', 'no', 'none']
+
+    return render_template("index.html",
+                           evaluation=evaluation_enabled,
+                           version=__version__)
 
 
 @api_blueprint.route('/contexts/<entity>.jsonld')
@@ -67,9 +72,9 @@ def index():
 @api_blueprint.route('/schemas/<schema>')
 def schema(schema="definitions"):
     try:
-        return jsonify(read_schema(schema))
-    except Exception:  # Should be FileNotFoundError, but it's missing from py2
-        return Error(message="Schema not found", status=404).flask()
+        return dump_schema(read_schema(schema))
+    except Exception as ex:  # Should be FileNotFoundError, but it's missing from py2
+        return Error(message="Schema not found: {}".format(ex), status=404).flask()
 
 
 def basic_api(f):
@@ -133,6 +138,7 @@ def api_root():
     req = api.parse_call(request.parameters)
     return current_app.senpy.analyse(req)
 
+
 @api_blueprint.route('/evaluate/', methods=['POST', 'GET'])
 @basic_api
 def evaluate():
@@ -145,6 +151,7 @@ def evaluate():
         response = current_app.senpy.evaluate(params)
         return response
 
+
 @api_blueprint.route('/plugins/', methods=['POST', 'GET'])
 @basic_api
 def plugins():
@@ -163,10 +170,10 @@ def plugin(plugin=None):
     return sp.get_plugin(plugin)
 
 
-@api_blueprint.route('/datasets/', methods=['POST','GET'])
+@api_blueprint.route('/datasets/', methods=['POST', 'GET'])
 @basic_api
 def datasets():
     sp = current_app.senpy
     datasets = sp.datasets
-    dic = Datasets(datasets = list(datasets.values()))
-    return dic
+    dic = Datasets(datasets=list(datasets.values()))
+    return dic

senpy/extensions.py

@@ -318,10 +318,15 @@ class Senpy(object):
         else:
             self._default = self._plugins[value.lower()]
 
-    def activate_all(self, sync=True):
+    def activate_all(self, sync=True, allow_fail=False):
         ps = []
         for plug in self._plugins.keys():
-            ps.append(self.activate_plugin(plug, sync=sync))
+            try:
+                self.activate_plugin(plug, sync=sync)
+            except Exception as ex:
+                if not allow_fail:
+                    raise
+                logger.error('Could not activate {}: {}'.format(plug, ex))
         return ps
 
     def deactivate_all(self, sync=True):

senpy/models.py

@@ -51,6 +51,10 @@ def read_schema(schema_file, absolute=False):
         return jsonref.load(f, base_uri=schema_uri)
 
 
+def dump_schema(schema):
+    return jsonref.dumps(schema)
+
+
 def load_context(context):
     logging.debug('Loading context: {}'.format(context))
     if not context:
@@ -199,24 +203,27 @@ class BaseModel(with_metaclass(BaseMeta, CustomDict)):
                context_uri=None,
                prefix=None,
                expanded=False):
-        ser = self.serializable()
 
-        result = jsonld.compact(
-            ser,
-            self._context,
-            options={
-                'base': prefix,
-                'expandContext': self._context,
-                'senpy': prefix
-            })
-        if context_uri:
-            result['@context'] = context_uri
+        result = self.serializable()
+        if context_uri or with_context:
+            result['@context'] = context_uri or self._context
+
+        # result = jsonld.compact(result,
+        #                         self._context,
+        #                         options={
+        #                             'base': prefix,
+        #                             'expandContext': self._context,
+        #                             'senpy': prefix
+        #                         })
         if expanded:
             result = jsonld.expand(
                 result, options={'base': prefix,
                                  'expandContext': self._context})
         if not with_context:
-            del result['@context']
+            try:
+                del result['@context']
+            except KeyError:
+                pass
         return result
 
     def validate(self, obj=None):
@@ -319,7 +326,10 @@ def _add_class_from_schema(*args, **kwargs):
 
 
 for i in [
+        'aggregatedEvaluation',
         'analysis',
+        'dataset',
+        'datasets',
         'emotion',
         'emotionConversion',
         'emotionConversionPlugin',
@@ -327,19 +337,17 @@ for i in [
         'emotionModel',
         'emotionPlugin',
         'emotionSet',
+        'evaluation',
         'entity',
         'help',
+        'metric',
         'plugin',
         'plugins',
         'response',
         'results',
         'sentimentPlugin',
         'suggestion',
-        'aggregatedEvaluation',
-        'evaluation',
-        'metric',
-        'dataset',
-        'datasets',
+        'topic',
 
 ]:
     _add_class_from_schema(i)

senpy/plugins/__init__.py

@@ -18,8 +18,7 @@ import subprocess
 import importlib
 import yaml
 import threading
-
-import numpy as np
+import nltk
 
 from .. import models, utils
 from .. import api
@@ -49,11 +48,11 @@ class PluginMeta(models.BaseMeta):
         attrs['name'] = alias
         if 'description' not in attrs:
             doc = attrs.get('__doc__', None)
-            if not doc:
-                raise Exception(('Please, add a description or '
-                                 'documentation to class {}').format(name))
-            attrs['description'] = doc
-            attrs['name'] = alias
+            if doc:
+                attrs['description'] = doc
+            else:
+                logger.warn(('Plugin {} does not have a description. '
+                             'Please, add a short summary to help other developers').format(name))
         cls = super(PluginMeta, mcs).__new__(mcs, name, bases, attrs)
 
         if alias in mcs._classes:
@@ -96,7 +95,27 @@ class Plugin(with_metaclass(PluginMeta, models.Plugin)):
         self.id = 'plugins/{}_{}'.format(self['name'], self['version'])
         self.is_activated = False
         self._lock = threading.Lock()
-        self.data_folder = data_folder or os.getcwd()
+        self._directory = os.path.abspath(os.path.dirname(inspect.getfile(self.__class__)))
+
+        data_folder = data_folder or os.getcwd()
+        subdir = os.path.join(data_folder, self.name)
+
+        self._data_paths = [
+            data_folder,
+            subdir,
+            self._directory,
+            os.path.join(self._directory, 'data'),
+        ]
+
+        if os.path.exists(subdir):
+            data_folder = subdir
+        self.data_folder = data_folder
+
+        self._log = logging.getLogger('{}.{}'.format(__name__, self.name))
+
+    @property
+    def log(self):
+        return self._log
 
     def validate(self):
         missing = []
@@ -125,9 +144,9 @@ class Plugin(with_metaclass(PluginMeta, models.Plugin)):
         for case in test_cases:
             try:
                 self.test_case(case)
-                logger.debug('Test case passed:\n{}'.format(pprint.pformat(case)))
+                self.log.debug('Test case passed:\n{}'.format(pprint.pformat(case)))
             except Exception as ex:
-                logger.warn('Test case failed:\n{}'.format(pprint.pformat(case)))
+                self.log.warn('Test case failed:\n{}'.format(pprint.pformat(case)))
                 raise
 
     def test_case(self, case):
@@ -150,10 +169,22 @@ class Plugin(with_metaclass(PluginMeta, models.Plugin)):
             raise
         assert not should_fail
 
-    def open(self, fpath, *args, **kwargs):
-        if not os.path.isabs(fpath):
-            fpath = os.path.join(self.data_folder, fpath)
-        return open(fpath, *args, **kwargs)
+    def find_file(self, fname):
+        for p in self._data_paths:
+            alternative = os.path.join(p, fname)
+            if os.path.exists(alternative):
+                return alternative
+        raise IOError('File does not exist: {}'.format(fname))
+
+    def open(self, fpath, mode='r'):
+        if 'w' in mode:
+            # When writing, only use absolute paths or data_folder
+            if not os.path.isabs(fpath):
+                fpath = os.path.join(self.data_folder, fpath)
+        else:
+            fpath = self.find_file(fpath)
+
+        return open(fpath, mode=mode)
 
     def serve(self, debug=True, **kwargs):
         utils.easy(plugin_list=[self, ], plugin_folder=None, debug=debug, **kwargs)
@@ -188,7 +219,7 @@ class Analysis(Plugin):
 
     def analyse_entries(self, entries, parameters):
         for entry in entries:
-            logger.debug('Analysing entry with plugin {}: {}'.format(self, entry))
+            self.log.debug('Analysing entry with plugin {}: {}'.format(self, entry))
             results = self.analyse_entry(entry, parameters)
             if inspect.isgenerator(results):
                 for result in results:
@@ -291,7 +322,7 @@ class Box(AnalysisPlugin):
         return self
 
     def transform(self, X):
-        return np.array([self.predict_one(x) for x in X])
+        return [self.predict_one(x) for x in X]
 
     def predict(self, X):
         return self.transform(X)
@@ -377,7 +408,7 @@ class ShelfMixin(object):
                     with self.open(self.shelf_file, 'rb') as p:
                         self._sh = pickle.load(p)
                 except (IndexError, EOFError, pickle.UnpicklingError):
-                    logger.warning('{} has a corrupted shelf file!'.format(self.id))
+                    self.log.warning('Corrupted shelf file: {}'.format(self.shelf_file))
                     if not self.get('force_shelf', False):
                         raise
         return self._sh
@@ -404,32 +435,31 @@ class ShelfMixin(object):
         self._shelf_file = value
 
     def save(self):
-        logger.debug('saving pickle')
+        self.log.debug('Saving pickle')
         if hasattr(self, '_sh') and self._sh is not None:
             with self.open(self.shelf_file, 'wb') as f:
                 pickle.dump(self._sh, f)
 
 
-def pfilter(plugins, **kwargs):
+def pfilter(plugins, plugin_type=Analysis, **kwargs):
     """ Filter plugins by different criteria """
     if isinstance(plugins, models.Plugins):
         plugins = plugins.plugins
     elif isinstance(plugins, dict):
         plugins = plugins.values()
-    ptype = kwargs.pop('plugin_type', Plugin)
     logger.debug('#' * 100)
-    logger.debug('ptype {}'.format(ptype))
-    if ptype:
-        if isinstance(ptype, PluginMeta):
-            ptype = ptype.__name__
+    logger.debug('plugin_type {}'.format(plugin_type))
+    if plugin_type:
+        if isinstance(plugin_type, PluginMeta):
+            plugin_type = plugin_type.__name__
         try:
-            ptype = ptype[0].upper() + ptype[1:]
-            pclass = globals()[ptype]
+            plugin_type = plugin_type[0].upper() + plugin_type[1:]
+            pclass = globals()[plugin_type]
             logger.debug('Class: {}'.format(pclass))
             candidates = filter(lambda x: isinstance(x, pclass),
                                 plugins)
         except KeyError:
-            raise models.Error('{} is not a valid type'.format(ptype))
+            raise models.Error('{} is not a valid type'.format(plugin_type))
     else:
         candidates = plugins
 
@@ -464,6 +494,7 @@ def _log_subprocess_output(process):
 
 def install_deps(*plugins):
     installed = False
+    nltk_resources = set()
     for info in plugins:
         requirements = info.get('requirements', [])
         if requirements:
@@ -478,7 +509,10 @@ def install_deps(*plugins):
             exitcode = process.wait()
             installed = True
             if exitcode != 0:
-                raise models.Error("Dependencies not properly installed")
+                raise models.Error("Dependencies not properly installed: {}".format(pip_args))
+        nltk_resources |= set(info.get('nltk_resources', []))
+
+    installed |= nltk.download(list(nltk_resources))
     return installed
 
 
@@ -575,12 +609,14 @@ def _instances_in_module(module):
 def _from_module_name(module, root, info=None, install=True, **kwargs):
     try:
         module = load_module(module, root)
-    except ImportError:
+    except (ImportError, LookupError):
         if not install or not info:
             raise
         install_deps(info)
         module = load_module(module, root)
     for plugin in _from_loaded_module(module=module, root=root, info=info, **kwargs):
+        if install:
+            install_deps(plugin)
         yield plugin
 
 

senpy/plugins/misc/split.senpy

@@ -1,19 +0,0 @@
----
-name: split
-module: senpy.plugins.misc.split
-description: A sample plugin that chunks input text
-author: "@militarpancho"
-version: '0.2'
-url: "https://github.com/gsi-upm/senpy"
-requirements:
-    - nltk
-extra_params:
-  delimiter:
-    aliases:
-    - type
-    - t
-    required: false
-    default: sentence
-    options:
-    - sentence
-    - paragraph

senpy/plugins/misc/split_plugin.py

@@ -5,13 +5,27 @@ from nltk.tokenize.simple import LineTokenizer
 import nltk
 
 
-class SplitPlugin(AnalysisPlugin):
+class Split(AnalysisPlugin):
     '''description: A sample plugin that chunks input text'''
 
+    author = ["@militarpancho", '@balkian']
+    version = '0.2'
+    url = "https://github.com/gsi-upm/senpy"
+
+    extra_params = {
+        'delimiter': {
+            'aliases': ['type', 't'],
+            'required': False,
+            'default': 'sentence',
+            'options': ['sentence', 'paragraph']
+        },
+    }
+
     def activate(self):
         nltk.download('punkt')
 
     def analyse_entry(self, entry, params):
+        yield entry
         chunker_type = params["delimiter"]
         original_text = entry['nif:isString']
         if chunker_type == "sentence":

senpy/plugins/sentiment/sentiment140/sentiment140.senpy

@@ -1,22 +0,0 @@
----
-name: sentiment140
-module: sentiment140
-description: "Connects to the sentiment140 free API: http://sentiment140.com"
-author: "@balkian"
-version: '0.2'
-url: "https://github.com/gsi-upm/senpy-plugins-community"
-extra_params:
-  language:
-    "@id": lang_sentiment140
-    aliases:
-    - language
-    - l
-    required: false
-    options:
-    - es
-    - en
-    - auto
-    default: auto
-requirements: {}
-maxPolarityValue: 1
-minPolarityValue: 0

senpy/plugins/sentiment/sentiment140/sentiment140_plugin.py

@@ -5,8 +5,25 @@ from senpy.plugins import SentimentPlugin
 from senpy.models import Sentiment
 
 
-class Sentiment140Plugin(SentimentPlugin):
+class Sentiment140(SentimentPlugin):
     '''Connects to the sentiment140 free API: http://sentiment140.com'''
+
+    author = "@balkian"
+    version = '0.2'
+    url = "https://github.com/gsi-upm/senpy-plugins-community"
+    extra_params = {
+        'language': {
+            "@id": 'lang_sentiment140',
+            'aliases': ['language', 'l'],
+            'required': False,
+            'default': 'auto',
+            'options': ['es', 'en', 'auto']
+        }
+    }
+
+    maxPolarityValue = 1
+    minPolarityValue = 0
+
     def analyse_entry(self, entry, params):
         lang = params["language"]
         res = requests.post("http://www.sentiment140.com/api/bulkClassifyJson",
@@ -31,7 +48,6 @@ class Sentiment140Plugin(SentimentPlugin):
             marl__hasPolarity=polarity,
             marl__polarityValue=polarity_value)
         sentiment.prov__wasGeneratedBy = self.id
-        entry.sentiments = []
         entry.sentiments.append(sentiment)
         entry.language = lang
         yield entry
@@ -41,10 +57,10 @@ class Sentiment140Plugin(SentimentPlugin):
         To avoid calling the sentiment140 API, we will mock the results
         from requests.
         '''
-        from senpy.test import patch_requests
+        from senpy.testing import patch_requests
         expected = {"data": [{"polarity": 4}]}
         with patch_requests(expected) as (request, response):
-            super(Sentiment140Plugin, self).test(*args, **kwargs)
+            super(Sentiment140, self).test(*args, **kwargs)
             assert request.called
             assert response.json.called
 

senpy/schemas/context.jsonld

@@ -10,8 +10,10 @@
     "wna": "http://www.gsi.dit.upm.es/ontologies/wnaffect/ns#",
     "emoml": "http://www.gsi.dit.upm.es/ontologies/onyx/vocabularies/emotionml/ns#",
     "xsd": "http://www.w3.org/2001/XMLSchema#",
+    "fam": "http://vocab.fusepool.info/fam#",
     "topics": {
-      "@id": "dc:subject"
+      "@id": "nif:topic",
+      "@container": "@set"
     },
     "entities": {
       "@id": "me:hasEntities"

senpy/schemas/evaluation.json

@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-04/schema#",
-  "name": "Evalation",
+  "name": "Evaluation",
   "properties": {
     "@id": {
       "type": "string"

senpy/static/css/main.css

@@ -167,3 +167,36 @@ textarea{
     color: inherit;
     text-decoration: inherit;
 }
+
+.collapsed .collapseicon {
+    display: none !important;
+}
+
+.collapsed .expandicon {
+    display: inline-block !important;
+}
+
+.expandicon {
+    display: none !important;
+}
+
+.collapseicon {
+    display: inline-block !important;
+}
+
+.loader {
+    border: 6px solid #f3f3f3; /* Light grey */
+    border-top: 6px solid blue;
+    border-bottom: 6px solid blue;
+
+    border-radius: 50%;
+    width: 3em;
+    height: 3em;
+    animation: spin 2s linear infinite;
+
+}
+
+@keyframes spin {
+    0% { transform: rotate(0deg); }
+    100% { transform: rotate(360deg); }
+}

senpy/static/js/main.js

@@ -4,6 +4,7 @@ var plugins_params = default_params = {};
 var plugins = [];
 var defaultPlugin = {};
 var gplugins = {};
+var pipeline = [];
 
 function replaceURLWithHTMLLinks(text) {
     console.log('Text: ' + text);
@@ -30,7 +31,10 @@ function hashchanged(){
 
 
 function get_plugins(response){
-    plugins = response.plugins;
+    for(ix in response.plugins){
+        plug = response.plugins[ix];
+        plugins[plug.name] = plug;
+    }
 }
 
 function get_datasets(response){
@@ -83,10 +87,32 @@ function draw_plugins_selection(){
     html += "</optgroup>"
     // Two elements with plugin class
     // One from the evaluate tab and another one from the analyse tab
-    document.getElementsByClassName('plugin')[0].innerHTML = html;
-    document.getElementsByClassName('plugin')[1].innerHTML = html;
+    plugin_lists  = document.getElementsByClassName('plugin')
+    for (element in plugin_lists){
+        plugin_lists[element].innerHTML = html;
+    }
+    draw_plugin_pipeline();
 }
 
+function draw_plugin_pipeline(){
+    var pipeHTML = "";
+    console.log("Drawing pipeline: ", pipeline);
+    for (ix in pipeline){
+        plug = pipeline[ix];
+        pipeHTML += '<span onclick="remove_plugin_pipeline(\'' + plug + '\')" class="btn btn-primary"><span ><i class="fa fa-minus"></i></span> ' + plug + '</span> <i class="fa fa-arrow-right"></i> ';
+    }
+    console.log(pipeHTML);
+    $("#pipeline").html(pipeHTML);
+}
+
+
+function remove_plugin_pipeline(name){
+    console.log("Removing plugin: ", name);
+    var index = pipeline.indexOf(name);
+    pipeline.splice(index, 1);
+    draw_plugin_pipeline();
+
+}
 function draw_plugins_list(){
     var availablePlugins = document.getElementById('availablePlugins');
 
@@ -105,6 +131,13 @@ function draw_plugins_list(){
     }
 }
 
+function add_plugin_pipeline(){
+    var selected = get_selected_plugin();
+    pipeline.push(selected);
+    console.log("Adding ", selected);
+    draw_plugin_pipeline();
+}
+
 function draw_datasets(){
     html = "";
     repeated_html = "<input class=\"checks-datasets\" type=\"checkbox\" value=\"";
@@ -118,16 +151,20 @@ function draw_datasets(){
 $(document).ready(function() {
     var response = JSON.parse($.ajax({type: "GET", url: "/api/plugins/" , async: false}).responseText);
     defaultPlugin= JSON.parse($.ajax({type: "GET", url: "/api/plugins/default" , async: false}).responseText);
-    var response2 = JSON.parse($.ajax({type: "GET", url: "/api/datasets/" , async: false}).responseText);
 
     get_plugins(response);
     get_default_parameters();
-    get_datasets(response2);
 
     draw_plugins_list();
     draw_plugins_selection();
     draw_parameters();
-    draw_datasets();
+    draw_plugin_description();
+
+    if (evaluation_enabled) {
+        var response2 = JSON.parse($.ajax({type: "GET", url: "/api/datasets/" , async: false}).responseText);
+        get_datasets(response2);
+        draw_datasets();
+    }
 
     $(window).on('hashchange', hashchanged);
     hashchanged();
@@ -144,17 +181,34 @@ function get_default_parameters(){
 
 }
 
+function get_selected_plugin(){
+    return document.getElementsByClassName('plugin')[0].options[document.getElementsByClassName('plugin')[0].selectedIndex].value;
+}
+
 function draw_default_parameters(){
     var basic_params = document.getElementById("basic_params");
     basic_params.innerHTML = params_div(default_params);
 }
 
+function update_params(params, plug){
+    ep = plugins_params[plug];
+    for(k in ep){
+        params[k] = ep[k];
+    }
+    return params
+}
+
 function draw_extra_parameters(){
-    var plugin = document.getElementsByClassName('plugin')[0].options[document.getElementsByClassName('plugin')[0].selectedIndex].value;
+    var plugin = get_selected_plugin();
     get_parameters();
 
     var extra_params = document.getElementById("extra_params");
-    extra_params.innerHTML = params_div(plugins_params[plugin]);
+    var params = {};
+    for (sel in pipeline){
+        update_params(params, pipeline[sel]);
+    }
+    update_params(params, plugin);
+    extra_params.innerHTML = params_div(params);
 }
 
 function draw_parameters(){
@@ -261,6 +315,15 @@ function add_param(key, value){
     return "&"+key+"="+value;
 }
 
+function get_pipeline_arg(){
+    arg = "";
+    for (ix in pipeline){
+        arg = arg + pipeline[ix] + ",";
+    }
+    arg = arg + get_selected_plugin();
+    return arg;
+}
+
 
 function load_JSON(){
     url = "/api";
@@ -269,7 +332,9 @@ function load_JSON(){
     rawcontainer.innerHTML = '';
     container.innerHTML = '';
 
-    var plugin = document.getElementsByClassName("plugin")[0].options[document.getElementsByClassName("plugin")[0].selectedIndex].value;
+    var plugin = get_pipeline_arg();
+    $(".loading").addClass("loader");
+    $("#preview").hide();
 
     var input = encodeURIComponent(document.getElementById("input").value);
     url += "?algo="+plugin+"&i="+input
@@ -280,27 +345,27 @@ function load_JSON(){
         url += add_param(key, params[key]);
     }
 
-    var response =  $.ajax({type: "GET", url: url , async: false}).responseText;
-    rawcontainer.innerHTML = replaceURLWithHTMLLinks(response);
+    $.ajax({type: "GET", url: url}).always(function(response){
+        document.getElementById("results-div").style.display = 'block';
+        if(typeof response=="object") {
+            var options = {
+                mode: 'view'
+            };
+            var editor = new JSONEditor(container, options, response);
+            editor.expandAll();
+            $('#results-div a[href="#viewer"]').click();
+            response = JSON.stringify(response, null, 4);
+        } else {
+            console.log("Got turtle?");
+            $('#results-div a[href="#raw"]').click();
+        }
 
-    document.getElementById("input_request").innerHTML = "<a href='"+url+"'>"+url+"</a>"
-    document.getElementById("results-div").style.display = 'block';
-    try {
-        response = JSON.parse(response);
-        var options = {
-            mode: 'view'
-        };
-        var editor = new JSONEditor(container, options, response);
-        editor.expandAll();
-        // $('#results-div a[href="#viewer"]').tab('show');
-        $('#results-div a[href="#viewer"]').click();
-        // location.hash = 'raw';
-    }
-    catch(err){
-        console.log("Error decoding JSON (got turtle?)");
-        $('#results-div a[href="#raw"]').click();
-        // location.hash = 'raw';
-    }
+        rawcontainer.innerHTML = replaceURLWithHTMLLinks(response);
+        document.getElementById("input_request").innerHTML = "<a href='"+url+"'>"+url+"</a>"
+
+        $(".loading").removeClass("loader");
+        $("#preview").show();
+    });
 }
 
 function get_datasets_from_checkbox(){
@@ -347,40 +412,53 @@ function evaluate_JSON(){
 
     url += "?algo="+plugin+"&dataset="+datasets
 
-    var response =  $.ajax({type: "GET", url: url , async: false, dataType: 'json'}).responseText;
-    rawcontainer.innerHTML = replaceURLWithHTMLLinks(response);
+    $('#doevaluate').attr("disabled", true);
+    $.ajax({type: "GET", url: url, dataType: 'json'}).done(function(resp) {
+        $('#doevaluate').attr("disabled", false);
+        response = resp.responseText;  
+
+        rawcontainer.innerHTML = replaceURLWithHTMLLinks(response);
+
+        document.getElementById("input_request_eval").innerHTML = "<a href='"+url+"'>"+url+"</a>"
+        document.getElementById("evaluate-div").style.display = 'block';
+
+        try {
+            response = JSON.parse(response);
+            var options = {
+                mode: 'view'
+            };
+
+            //Control the single response results
+            if (!(Array.isArray(response.evaluations))){
+                response.evaluations = [response.evaluations]
+            }
+
+            new_tbody = create_body_metrics(response.evaluations)
+            table.replaceChild(new_tbody, table.lastElementChild)
+
+            var editor = new JSONEditor(container, options, response);
+            editor.expandAll();
+            // $('#results-div a[href="#viewer"]').tab('show');
+            $('#evaluate-div a[href="#evaluate-table"]').click();
+            // location.hash = 'raw';
 
-    document.getElementById("input_request_eval").innerHTML = "<a href='"+url+"'>"+url+"</a>"
-    document.getElementById("evaluate-div").style.display = 'block';
-    
-    try {
-        response = JSON.parse(response);
-        var options = {
-            mode: 'view'
-        };
 
-        //Control the single response results
-        if (!(Array.isArray(response.evaluations))){
-            response.evaluations = [response.evaluations]
         }
+        catch(err){
+            console.log("Error decoding JSON (got turtle?)");
+            $('#evaluate-div a[href="#evaluate-raw"]').click();
+            // location.hash = 'raw';
+        }
+    })
+}
 
-        new_tbody = create_body_metrics(response.evaluations)
-        table.replaceChild(new_tbody, table.lastElementChild)
+function draw_plugin_description(){
+    var plugin = plugins[get_selected_plugin()];
+    $("#plugdescription").text(plugin.description);
+    console.log(plugin);
+}
 
-        var editor = new JSONEditor(container, options, response);
-        editor.expandAll();
-        // $('#results-div a[href="#viewer"]').tab('show');
-        $('#evaluate-div a[href="#evaluate-table"]').click();
-        // location.hash = 'raw';
-        
-        
-    }
-    catch(err){
-        console.log("Error decoding JSON (got turtle?)");
-        $('#evaluate-div a[href="#evaluate-raw"]').click();
-        // location.hash = 'raw';
-    }
-
-    
-
-}
+function plugin_selected(){
+    draw_extra_parameters();
+    draw_plugin_description();
+}

senpy/templates/index.html

@@ -5,6 +5,9 @@
     <title>Playground {{version}}</title>
 
   </head>
+  <script>
+   this.evaluation_enabled = {% if evaluation %}true{%else %}false{%endif%};
+  </script>
   <script src="static/js/jquery-2.1.1.min.js" ></script>
   <!--<script src="jquery.autosize.min.js"></script>-->
   <link rel="stylesheet" href="static/css/bootstrap.min.css">
@@ -32,7 +35,9 @@
       <ul class="nav nav-tabs" role="tablist">
         <li role="presentation" ><a class="active" href="#about">About</a></li>
         <li role="presentation"class="active"><a class="active" href="#test">Test it</a></li>
+        {% if evaluation %}
         <li role="presentation"><a class="active" href="#evaluate">Evaluate Plugins</a></li>
+        {% endif %}
 
       </ul>
 
@@ -61,6 +66,14 @@
                     </ul>
 
                   </p>
+                  <p>Senpy is a research project. If you use it in your research, please cite:
+                  <pre>
+Senpy: A Pragmatic Linked Sentiment Analysis Framework.
+Sánchez-Rada, J. F., Iglesias, C. A., Corcuera, I., & Araque, Ó.
+In Data Science and Advanced Analytics (DSAA),
+2016 IEEE International Conference on (pp. 735-742). IEEE.
+                  </pre>
+                  </p>
                   
                 </div>
             <div class="col-lg-6 ">
@@ -70,8 +83,6 @@
                 </div>
                 <div class="panel-body"><ul id=availablePlugins></ul></div>
               </div>
-            </div>
-            <div class="col-lg-6 ">
               <a href="http://senpy.readthedocs.io">
               <div class="panel panel-default">
                 <div class="panel-heading"><i class="fa fa-book"></i> If you are new to senpy, you might want to read senpy's documentation</div>
@@ -82,9 +93,6 @@
                 <div class="panel-heading"><i class="fa fa-sign-in"></i> Feel free to follow us on GitHub</div>
               </div>
               </a>
-              <div class="panel panel-default">
-                <div class="panel-heading"><i class="fa fa-child"></i> Enjoy.</div>
-              </div>
             </div>     
           </div>
         </div>
@@ -96,17 +104,28 @@
 whilst this text makes me happy and surprised at the same time.
 I cannot believe it!</textarea>
                 </div>
-                <div>
-                    <label>Select the plugin:</label>
-                    <select id="plugins" name="plugins" class=plugin onchange="draw_extra_parameters()">
-                    </select>
-                </div>
                 <!-- PARAMETERS -->
                 <div class="panel-group" id="parameters">
                     <div class="panel panel-default">
-                        <a data-toggle="collapse" class="deco-none" href="#basic_params">
+                        <div class="panel-heading">
+                            <h4 class="panel-title">
+                                Select the plugin.
+                            </h4>
+                        </div>
+                        <div id="plugin_selection" class="panel-collapse panel-body">
+                            <span id="pipeline"></span>
+                            <select name="plugins" class="plugin" onchange="plugin_selected()">
+                            </select>
+                            <span onclick="add_plugin_pipeline()"><span class="btn"><i class="fa fa-plus" title="Add more plugins to the pipeline. Processing order is left to right. i.e. the results of the leftmost plugin will be used as input for the second leftmost, and so on."></i></span></span>
+                            <label class="help-block " id="plugdescription"></label>
+                        </div>
+                    </div>
+                    <div class="panel panel-default">
+                        <a data-toggle="collapse" class="deco-none collapsed" href="#basic_params">
                             <div class="panel-heading">
                                 <h4 class="panel-title">
+                                    <i class="fa fa-chevron-right pull-left expandicon"></i>
+                                    <i class="fa fa-chevron-down pull-left collapseicon"></i>
                                     Basic API parameters
                                 </h4>
                             </div>
@@ -118,6 +137,8 @@ I cannot believe it!</textarea>
                         <a data-toggle="collapse" class="deco-none" href="#extra_params">
                             <div class="panel-heading">
                                 <h4 class="panel-title">
+                                    <i class="fa fa-chevron-right pull-left expandicon"></i>
+                                    <i class="fa fa-chevron-down pull-left collapseicon"></i>
                                     Plugin extra parameters
                                 </h4>
                             </div>
@@ -129,6 +150,7 @@ I cannot believe it!</textarea>
                 <!-- END PARAMETERS -->
  
                 <a id="preview" class="btn btn-lg btn-primary" onclick="load_JSON()">Analyse!</a>
+                <div id="loading-results" class="loading"></div>
                 <!--<button id="visualise" name="type" type="button">Visualise!</button>-->
             </form>
           </div>
@@ -155,6 +177,8 @@ I cannot believe it!</textarea>
             </div>
         </div>
 
+        {% if evaluation %}
+
         <div class="tab-pane" id="evaluate">
           <div class="well">
             <form id="form" class="container" onsubmit="return getPlugins();" accept-charset="utf-8">
@@ -169,7 +193,7 @@ I cannot believe it!</textarea>
                     </select>
                 </div>
  
-                <a id="preview" class="btn btn-lg btn-primary" onclick="evaluate_JSON()">Evaluate Plugin!</a>
+                <a id="doevaluate" class="btn btn-lg btn-primary" onclick="evaluate_JSON()">Evaluate Plugin!</a>
                 <!--<button id="visualise" name="type" type="button">Visualise!</button>-->
             </form>
           </div>
@@ -216,6 +240,7 @@ I cannot believe it!</textarea>
                 </div>
               </div>
             </div>
+            {% endif %}
         </div>
 
         <a href="http://www.gsi.dit.upm.es" target="_blank"><img class="center-block" src="static/img/gsi.png"/>  </a> 

senpy/utils.py

@@ -1,6 +1,7 @@
 from . import models, __version__
 from collections import MutableMapping
 import pprint
+import pdb
 
 import logging
 logger = logging.getLogger(__name__)
@@ -32,8 +33,8 @@ def check_template(indict, template):
         if indict != template:
             raise models.Error(('Differences found.\n'
                                 '\tExpected: {}\n'
-                                '\tFound: {}').format(pprint.pformat(indict),
-                                                      pprint.pformat(template)))
+                                '\tFound: {}').format(pprint.pformat(template),
+                                                      pprint.pformat(indict)))
 
 
 def convert_dictionary(original, mappings):
@@ -67,18 +68,23 @@ def easy_load(app=None, plugin_list=None, plugin_folder=None, **kwargs):
     return sp, app
 
 
-def easy_test(plugin_list=None):
+def easy_test(plugin_list=None, debug=True):
     logger.setLevel(logging.DEBUG)
     logging.getLogger().setLevel(logging.INFO)
-    if not plugin_list:
-        import __main__
-        logger.info('Loading classes from {}'.format(__main__))
-        from . import plugins
-        plugin_list = plugins.from_module(__main__)
-    for plug in plugin_list:
-        plug.test()
-        logger.info('The tests for {} passed!'.format(plug.name))
-    logger.info('All tests passed!')
+    try:
+        if not plugin_list:
+            import __main__
+            logger.info('Loading classes from {}'.format(__main__))
+            from . import plugins
+            plugin_list = plugins.from_module(__main__)
+        for plug in plugin_list:
+            plug.test()
+            plug.log.info('My tests passed!')
+            logger.info('All tests passed!')
+    except Exception:
+        if not debug:
+            raise
+        pdb.post_mortem()
 
 
 def easy(host='0.0.0.0', port=5000, debug=True, **kwargs):

tests/test_api.py

@@ -32,7 +32,7 @@ class APITest(TestCase):
         query = {}
         plug_params = {
             'hello': {
-                'aliases': ['hello', 'hiya'],
+                'aliases': ['hiya', 'hello'],
                 'required': True
             }
         }
@@ -48,6 +48,26 @@ class APITest(TestCase):
         assert 'hello' in p
         assert p['hello'] == 'dlrow'
 
+    def test_parameters2(self):
+        in1 = {
+            'meaningcloud-key': 5
+        }
+        in2 = {
+            'apikey': 25
+        }
+        extra_params = {
+            "apikey": {
+                "aliases": [
+                    "apikey",
+                    "meaningcloud-key"
+                ],
+                "required": True
+            }
+        }
+        p1 = parse_params(in1, extra_params)
+        p2 = parse_params(in2, extra_params)
+        assert (p2['apikey'] / p1['apikey']) == 5
+
     def test_default(self):
         spec = {
             'hello': {

tests/test_blueprints.py

@@ -36,7 +36,7 @@ class BlueprintsTest(TestCase):
 
     def test_playground(self):
         resp = self.client.get("/")
-        assert "main.js" in resp.data.decode()
+        assert "main.js" in resp.get_data(as_text=True)
 
     def test_home(self):
         """

tests/test_client.py

@@ -1,6 +1,6 @@
 from unittest import TestCase
 
-from senpy.test import patch_requests
+from senpy.testing import patch_requests
 from senpy.client import Client
 from senpy.models import Results, Plugins, Error
 from senpy.plugins import AnalysisPlugin

tests/test_extensions.py

@@ -47,7 +47,7 @@ class ExtensionsTest(TestCase):
 
     def test_add_delete(self):
         '''Should be able to add and delete new plugins. '''
-        new = plugins.Plugin(name='new', description='new', version=0)
+        new = plugins.Analysis(name='new', description='new', version=0)
         self.senpy.add_plugin(new)
         assert new in self.senpy.plugins()
         self.senpy.delete_plugin(new)

tests/test_schemas.py

@@ -8,6 +8,8 @@ from fnmatch import fnmatch
 
 from jsonschema import RefResolver, Draft4Validator, ValidationError
 
+from senpy.models import read_schema
+
 root_path = path.join(path.dirname(path.realpath(__file__)), '..')
 schema_folder = path.join(root_path, 'senpy', 'schemas')
 examples_path = path.join(root_path, 'docs', 'examples')
@@ -15,7 +17,8 @@ bad_examples_path = path.join(root_path, 'docs', 'bad-examples')
 
 
 class JSONSchemaTests(unittest.TestCase):
-    pass
+    def test_definitions(self):
+        read_schema('definitions.json')
 
 
 def do_create_(jsfile, success):

tests/test_test.py

@@ -2,7 +2,7 @@ from unittest import TestCase
 
 import requests
 import json
-from senpy.test import patch_requests
+from senpy.testing import patch_requests
 from senpy.models import Results