Separate LDP and search APIs. Stub search endpoint.

lakesuperior/endpoints/ldp.py

@@ -0,0 +1,140 @@
+from flask import Blueprint, request
+
+from lakesuperior.ldp.ldpr import Ldpr, Ldpc, LdpNr, \
+        InvalidResourceError, ResourceNotExistsError
+
+
+# Blueprint for LDP REST API. This is what is usually found under `/rest/` in
+# standard fcrepo4. Here, it is under `/ldp` but initially `/rest` can be kept
+# for backward compatibility.
+
+ldp = Blueprint('ldp', __name__)
+
+accept_patch = (
+    'application/sparql-update',
+)
+accept_post = (
+    'application/ld+json',
+    'application/n-triples',
+    'application/rdf+xml',
+    'application/x-turtle',
+    'application/xhtml+xml',
+    'application/xml',
+    'text/html',
+    'text/n3',
+    'text/plain',
+    'text/rdf+n3',
+    'text/turtle',
+)
+#allow = (
+#    'COPY',
+#    'DELETE',
+#    'GET',
+#    'HEAD',
+#    'MOVE',
+#    'OPTIONS',
+#    'PATCH',
+#    'POST',
+#    'PUT',
+#)
+
+std_headers = {
+    'Accept-Patch' : ','.join(accept_patch),
+    'Accept-Post' : ','.join(accept_post),
+    #'Allow' : ','.join(allow),
+}
+
+
+## REST SERVICES ##
+
+@ldp.route('/<path:uuid>', methods=['GET'])
+@ldp.route('/', defaults={'uuid': None}, methods=['GET'],
+        strict_slashes=False)
+def get_resource(uuid):
+    '''
+    Retrieve RDF or binary content.
+    '''
+    headers = std_headers
+    # @TODO Add conditions for LDP-NR
+    rsrc = Ldpc(uuid)
+    try:
+        out = rsrc.get()
+    except ResourceNotExistsError:
+        return 'Resource #{} not found.'.format(rsrc.uuid), 404
+    else:
+        headers = rsrc.head()
+        return (out.graph.serialize(format='turtle'), headers)
+
+
+@ldp.route('/<path:parent>', methods=['POST'])
+@ldp.route('/', defaults={'parent': None}, methods=['POST'],
+        strict_slashes=False)
+def post_resource(parent):
+    '''
+    Add a new resource in a new URI.
+    '''
+    headers = std_headers
+    try:
+        slug = request.headers['Slug']
+    except KeyError:
+        slug = None
+
+    try:
+       rsrc = Ldpc.inst_for_post(parent, slug)
+    except ResourceNotExistsError as e:
+        return str(e), 404
+    except InvalidResourceError as e:
+        return str(e), 409
+
+    rsrc.post(request.get_data().decode('utf-8'))
+
+    headers.update({
+        'Location' : rsrc.uri,
+    })
+
+    return rsrc.uri, headers, 201
+
+
+@ldp.route('/<path:uuid>', methods=['PUT'])
+def put_resource(uuid):
+    '''
+    Add a new resource at a specified URI.
+    '''
+    headers = std_headers
+    rsrc = Ldpc(uuid)
+
+    rsrc.put(request.get_data().decode('utf-8'))
+    return '', 204, headers
+
+
+@ldp.route('/<path:uuid>', methods=['PATCH'])
+def patch_resource(uuid):
+    '''
+    Update an existing resource with a SPARQL-UPDATE payload.
+    '''
+    headers = std_headers
+    rsrc = Ldpc(uuid)
+
+    try:
+        rsrc.patch(request.get_data().decode('utf-8'))
+    except ResourceNotExistsError:
+        return 'Resource #{} not found.'.format(rsrc.uuid), 404
+
+    return '', 204, headers
+
+
+@ldp.route('/<path:uuid>', methods=['DELETE'])
+def delete_resource(uuid):
+    '''
+    Delete a resource.
+    '''
+    headers = std_headers
+    rsrc = Ldpc(uuid)
+
+    try:
+        rsrc.delete()
+    except ResourceNotExistsError:
+        return 'Resource #{} not found.'.format(rsrc.uuid), 404
+
+    return '', 204, headers
+

lakesuperior/endpoints/query.py

@@ -0,0 +1,33 @@
+from flask import Blueprint, request
+
+# Query endpoint. raw SPARQL queries exposing the underlying layout can be made
+# available. Also convenience methods that allow simple lookups based on simple
+# binary comparisons should be added. Binary lookups—maybe?
+# N.B All data sources are read-only for this endpoint.
+
+
+query = Blueprint('query', __name__)
+
+
+@query.route('/find', methods=['GET'])
+def find():
+    '''
+    Search by entering a search term and optional property and comparison term.
+    '''
+    valid_operands = ('=', '>', '<', '<>')
+
+    term = request.args.get('term')
+    prop = request.args.get('prop', default=1)
+    cmp = request.args.get('cmp', default='=')
+    # @TODO
+
+
+@query.route('/sparql', methods=['POST'])
+def sparql(q):
+    '''
+    Perform a direct SPARQL query on the underlying triplestore.
+
+    @param q SPARQL query string.
+    '''
+    # @TODO
+    pass

server.py

@@ -1,60 +1,25 @@
-import io
-import json
-import os.path
-import pickle
+from flask import Flask
 
-import arrow
-
-from hashlib import sha1
-from uuid import  uuid4
+from lakesuperior.config_parser import config
+from lakesuperior.endpoints.ldp import ldp
+from lakesuperior.endpoints.query import query
 
-from flask import Flask, request, url_for
 
-from lakesuperior.config_parser import config
-from lakesuperior.ldp.ldpr import Ldpr, Ldpc, LdpNr, \
-        InvalidResourceError, ResourceNotExistsError
+fcrepo = Flask(__name__)
+fcrepo.config.update(config['flask'])
 
-app = Flask(__name__)
-app.config.update(config['flask'])
 
-rest_accept_patch = (
-    'application/sparql-update',
-)
-rest_accept_post = (
-    'application/ld+json',
-    'application/n-triples',
-    'application/rdf+xml',
-    'application/x-turtle',
-    'application/xhtml+xml',
-    'application/xml',
-    'text/html',
-    'text/n3',
-    'text/plain',
-    'text/rdf+n3',
-    'text/turtle',
-)
-#rest_allow = (
-#    'COPY',
-#    'DELETE',
-#    'GET',
-#    'HEAD',
-#    'MOVE',
-#    'OPTIONS',
-#    'PATCH',
-#    'POST',
-#    'PUT',
-#)
+## Configure enpoint blueprints here. ##
 
-rest_std_headers = {
-    'Accept-Patch' : ','.join(rest_accept_patch),
-    'Accept-Post' : ','.join(rest_accept_post),
-    #'Allow' : ','.join(rest_allow),
-}
+fcrepo.register_blueprint(ldp, url_prefix='/ldp')
+# Legacy endpoint. @TODO Deprecate.
+fcrepo.register_blueprint(ldp, url_prefix='/rest')
+fcrepo.register_blueprint(query, url_prefix='/query')
 
 
 ## ROUTES ##
 
-@app.route('/', methods=['GET'])
+@fcrepo.route('/', methods=['GET'])
 def index():
     '''
     Homepage.
@@ -62,7 +27,7 @@ def index():
     return u'<h1>Hello. This is LAKEsuperior.</h1><p>Exciting, isn’t it?</p>'
 
 
-@app.route('/debug', methods=['GET'])
+@fcrepo.route('/debug', methods=['GET'])
 def debug():
     '''
     Debug page.
@@ -70,95 +35,3 @@ def debug():
     raise RuntimeError()
 
 
-## REST SERVICES ##
-
-@app.route('/rest/<path:uuid>', methods=['GET'])
-@app.route('/rest/', defaults={'uuid': None}, methods=['GET'],
-        strict_slashes=False)
-def get_resource(uuid):
-    '''
-    Retrieve RDF or binary content.
-    '''
-    headers = rest_std_headers
-    # @TODO Add conditions for LDP-NR
-    rsrc = Ldpc(uuid)
-    try:
-        out = rsrc.get()
-    except ResourceNotExistsError:
-        return 'Resource #{} not found.'.format(rsrc.uuid), 404
-    else:
-        headers = rsrc.head()
-        return (out.graph.serialize(format='turtle'), headers)
-
-
-@app.route('/rest/<path:parent>', methods=['POST'])
-@app.route('/rest/', defaults={'parent': None}, methods=['POST'],
-        strict_slashes=False)
-def post_resource(parent):
-    '''
-    Add a new resource in a new URI.
-    '''
-    headers = rest_std_headers
-    try:
-        slug = request.headers['Slug']
-    except KeyError:
-        slug = None
-
-    try:
-       rsrc = Ldpc.inst_for_post(parent, slug)
-    except ResourceNotExistsError as e:
-        return str(e), 404
-    except InvalidResourceError as e:
-        return str(e), 409
-
-    rsrc.post(request.get_data().decode('utf-8'))
-
-    headers.update({
-        'Location' : rsrc.uri,
-    })
-
-    return rsrc.uri, headers, 201
-
-
-@app.route('/rest/<path:uuid>', methods=['PUT'])
-def put_resource(uuid):
-    '''
-    Add a new resource at a specified URI.
-    '''
-    headers = rest_std_headers
-    rsrc = Ldpc(uuid)
-
-    rsrc.put(request.get_data().decode('utf-8'))
-    return '', 204, headers
-
-
-@app.route('/rest/<path:uuid>', methods=['PATCH'])
-def patch_resource(uuid):
-    '''
-    Update an existing resource with a SPARQL-UPDATE payload.
-    '''
-    headers = rest_std_headers
-    rsrc = Ldpc(uuid)
-
-    try:
-        rsrc.patch(request.get_data().decode('utf-8'))
-    except ResourceNotExistsError:
-        return 'Resource #{} not found.'.format(rsrc.uuid), 404
-
-    return '', 204, headers
-
-
-@app.route('/rest/<path:uuid>', methods=['DELETE'])
-def delete_resource(uuid):
-    '''
-    Delete a resource.
-    '''
-    headers = rest_std_headers
-    rsrc = Ldpc(uuid)
-
-    try:
-        rsrc.delete()
-    except ResourceNotExistsError:
-        return 'Resource #{} not found.'.format(rsrc.uuid), 404
-
-    return '', 204, headers