Add several fixes

Author: wiresio

Diff for: README.md

@@ -11,13 +11,13 @@ It can also translate a Thing Description into an AID.
 To install the plugin, create a Python 3 [virtualenv](https://virtualenv.pypa.io/en/latest/user_guide.html).
 
 ```bash
-virtualenv env_name
+virtualenv domus
 ```
 
 Then activate the venv
 
 ```bash
-source env_name/bin/activate
+source domus/bin/activate
 ```
 
 Then install the [domus-tdd-api](https://github.com/eclipse-thingweb/domus-tdd-api).

Diff for: build/lib/domus_tdd_api_plugin_aid/__init__.py

@@ -0,0 +1,91 @@
+from flask import Blueprint, request, Response
+import json
+
+from tdd.common import (
+    delete_id,
+)
+from tdd.utils import (
+    POSSIBLE_MIMETYPES,
+    negociate_mime_type,
+    update_collection_etag,
+)
+from tdd.errors import WrongMimeType
+
+
+from domus_tdd_api_plugin_aid.aas import (
+    get_aas_description,
+    put_aas_json_in_sparql,
+    put_aas_rdf_in_sparql,
+    validate_aas,
+)
+from domus_tdd_api_plugin_aid.aml import translate_aml_to_aas
+
+blueprint = Blueprint("domus_tdd_api_plugin_aid", __name__, url_prefix="/aas")
+
+
+@blueprint.route("/<id>", methods=["DELETE"])
+def delete_route_aas(id):
+    response = delete_id(id)
+    if response.status_code in [200, 204]:
+        update_collection_etag()
+    return response
+
+
+@blueprint.route("/<id>", methods=["GET"])
+def describe_aas(id):
+    mime_type_negociated = negociate_mime_type(
+        request, default_mimetype="application/aas+json"
+    )
+    description = get_aas_description(id, content_type=mime_type_negociated)
+    if mime_type_negociated == "application/aas+json":
+        description = json.dumps(description)
+    return Response(description, content_type=mime_type_negociated)
+
+
+@blueprint.route("/<id>", methods=["PUT"])
+def create_aas(id):
+    mimetype = request.content_type
+    if mimetype == "application/json":
+        mimetype = "application/aas+json"
+    if mimetype == "application/aas+json":
+        json_ld_content = request.get_data()
+        content = validate_aas(json_ld_content, uri=id)
+        updated, uri = put_aas_json_in_sparql(content, uri=id)
+    elif mimetype == "application/aml+xml":
+        aml_data = request.get_data()
+        uri, rdf_aas_data = translate_aml_to_aas(aml_data, uri=id)
+        updated, uri = put_aas_rdf_in_sparql(
+            rdf_aas_data, "application/n-triples", uri=uri
+        )
+    elif mimetype in POSSIBLE_MIMETYPES:
+        rdf_content = request.get_data()
+        updated, uri = put_aas_rdf_in_sparql(rdf_content, mimetype, uri=id)
+    else:
+        raise WrongMimeType(mimetype)
+
+    update_collection_etag()
+    return Response(status=201 if not updated else 204, headers={"Location": uri})
+
+
+@blueprint.route("", methods=["POST"])
+def create_anonymous_aas():
+    mimetype = request.content_type
+    if mimetype == "application/json":
+        mimetype = "application/aas+json"
+    if mimetype == "application/aas+json":
+        json_ld_content = request.get_data()
+        content = validate_aas(json_ld_content)
+        updated, uri = put_aas_json_in_sparql(content, delete_if_exists=False)
+    elif mimetype == "application/aml+xml":
+        aml_data = request.get_data()
+        uri, rdf_aas_data = translate_aml_to_aas(aml_data)
+        updated, uri = put_aas_rdf_in_sparql(
+            rdf_aas_data, "application/n-triples", uri=uri
+        )
+    elif mimetype in POSSIBLE_MIMETYPES:
+        content = request.get_data()
+        updated, uri = put_aas_rdf_in_sparql(content, mimetype, delete_if_exists=False)
+    else:
+        raise WrongMimeType(mimetype)
+    update_collection_etag()
+    return Response(status=201 if not updated else 204, headers={"Location": uri})

Diff for: build/lib/domus_tdd_api_plugin_aid/aas.py

@@ -0,0 +1,111 @@
+# -*- coding: utf-8 -*-
+from copy import copy
+import json
+from pathlib import Path
+import uuid
+
+
+from rdflib import Graph
+from rdflib.exceptions import ParserError
+
+from tdd.common import (
+    frame_nt_content,
+    get_id_description,
+    put_json_in_sparql,
+    put_rdf_in_sparql,
+)
+from tdd.context import convert_context_to_array, get_context
+from tdd.errors import IDMismatchError, JSONDecodeError, RDFValidationError
+from tdd.utils import uri_to_base
+
+ONTOLOGY = {"prefix": "aas", "base": "https://admin-shell.io/aas/3/0/"}
+
+DATA_DIR = Path(__file__).parent / "data"
+
+with open(DATA_DIR / "context.v3.json") as fp:
+    CONTEXT = json.load(fp)
+
+
+def validate_aas(str_content, uri=None):
+    try:
+        json_content = json.loads(str_content)
+    except json.decoder.JSONDecodeError as exc:
+        raise JSONDecodeError(exc)
+
+    if uri is not None:
+        if "id" in json_content:
+            if uri != json_content["id"]:
+                raise IDMismatchError(json_content["id"], uri)
+        else:
+            json_content["id"] = uri
+    return json_content
+
+
+def frame_aas_nt_content(uri, nt_content, original_context):
+    context = copy(original_context)
+    context.append({"@base": uri_to_base(uri)})
+    context.append(CONTEXT)
+
+    frame = {
+        "@context": context,
+        "id": uri,
+    }
+
+    str_json_framed = frame_nt_content(uri, nt_content, frame).decode("utf-8")
+
+    result = json.loads(str_json_framed)
+    try:
+        del result["@context"]
+        del result["@id"]
+    except KeyError:
+        pass
+    return result
+
+
+def get_aas_description(uri, content_type="application/aas+json"):
+    if not content_type.endswith("json"):
+        return get_id_description(uri, content_type, ONTOLOGY)
+    content = get_id_description(uri, "application/n-triples", ONTOLOGY)
+    original_context = get_context(uri, ONTOLOGY)
+    jsonld_response = frame_aas_nt_content(uri, content, original_context)
+    return jsonld_response
+
+
+def put_aas_rdf_in_sparql(rdf_content, mimetype, uri=None, delete_if_exists=True):
+    g = Graph()
+    try:
+        g.parse(data=rdf_content, format=mimetype)
+    except (SyntaxError, ParserError):
+        raise RDFValidationError(f"The RDF triples are not well formatted ({mimetype})")
+
+    put_rdf_in_sparql(
+        g,
+        uri,
+        [CONTEXT],
+        delete_if_exists,
+        ONTOLOGY,
+    )
+
+    return (False, uri)  # For now, updated = False
+
+
+def put_aas_json_in_sparql(content, uri=None, delete_if_exists=True):
+    """
+    returns:
+    - boolean True if the TD inserted already existed
+    - uri of the TD
+    """
+    content = copy(content)
+    convert_context_to_array(content)
+    if "id" not in content and "identification" not in content:
+        content["id"] = f"urn:uuid:{uuid.uuid4()}"
+
+    original_context = copy(content["@context"])
+
+    uri = uri if uri is not None else content["id"]
+
+    content["@context"].append(CONTEXT)
+    content["@context"].append({"@base": uri_to_base(uri)})
+    put_json_in_sparql(content, uri, original_context, delete_if_exists, ONTOLOGY)
+
+    return (False, uri)  # For now, updated = False