refactor: Remove overused "Simple" prefix

CommunitySolidServer · Sep 2, 2020 · a913a8e · a913a8e
1 parent 6b8d576
commit a913a8e
Show file tree

Hide file tree

Showing 46 changed files with 248 additions and 249 deletions.
diff --git a/config/presets/acl.json b/config/presets/acl.json
@@ -3,18 +3,18 @@
   "@graph": [
     {
       "@id": "urn:solid-server:default:AclManager",
-      "@type": "SimpleExtensionAclManager"
+      "@type": "UrlBasedAclManager"
     },
     {
       "@id": "urn:solid-server:default:AclAuthorizer",
-      "@type": "SimpleAclAuthorizer",
-      "SimpleAclAuthorizer:_aclManager": {
+      "@type": "WebAclAuthorizer",
+      "WebAclAuthorizer:_aclManager": {
         "@id": "urn:solid-server:default:AclManager"
       },
-      "SimpleAclAuthorizer:_containerManager": {
+      "WebAclAuthorizer:_containerManager": {
         "@id": "urn:solid-server:default:UrlContainerManager"
       },
-      "SimpleAclAuthorizer:_resourceStore": {
+      "WebAclAuthorizer:_resourceStore": {
         "@id": "urn:solid-server:default:ResourceStore_Patching"
       }
     }

diff --git a/config/presets/ldp.json b/config/presets/ldp.json
@@ -20,7 +20,7 @@
         "@id": "urn:solid-server:default:OperationHandler"
       },
       "AuthenticatedLdpHandler:_responseWriter": {
-        "@type": "SimpleResponseWriter"
+        "@type": "BasicResponseWriter"
       }
     }
   ]

diff --git a/config/presets/ldp/credentials-extractor.json b/config/presets/ldp/credentials-extractor.json
@@ -3,7 +3,7 @@
   "@graph": [
     {
       "@id": "urn:solid-server:default:CredentialsExtractor",
-      "@type": "SimpleCredentialsExtractor"
+      "@type": "UnsecureWebIdExtractor"
     }
   ]
 }
diff --git a/config/presets/ldp/operation-handler.json b/config/presets/ldp/operation-handler.json
@@ -6,32 +6,32 @@
       "@type": "CompositeAsyncHandler",
       "CompositeAsyncHandler:_handlers": [
         {
-          "@type": "SimpleDeleteOperationHandler",
-          "SimpleDeleteOperationHandler:_store": {
+          "@type": "DeleteOperationHandler",
+          "DeleteOperationHandler:_store": {
             "@id": "urn:solid-server:default:ResourceStore_Patching"
           }
         },
         {
-          "@type": "SimpleGetOperationHandler",
-          "SimpleGetOperationHandler:_store": {
+          "@type": "GetOperationHandler",
+          "GetOperationHandler:_store": {
             "@id": "urn:solid-server:default:ResourceStore_Patching"
           }
         },
         {
-          "@type": "SimplePatchOperationHandler",
-          "SimplePatchOperationHandler:_store": {
+          "@type": "PatchOperationHandler",
+          "PatchOperationHandler:_store": {
             "@id": "urn:solid-server:default:ResourceStore_Patching"
           }
         },
         {
-          "@type": "SimplePostOperationHandler",
-          "SimplePostOperationHandler:_store": {
+          "@type": "PostOperationHandler",
+          "PostOperationHandler:_store": {
             "@id": "urn:solid-server:default:ResourceStore_Patching"
           }
         },
         {
-          "@type": "SimplePutOperationHandler",
-          "SimplePutOperationHandler:_store": {
+          "@type": "PutOperationHandler",
+          "PutOperationHandler:_store": {
             "@id": "urn:solid-server:default:ResourceStore_Patching"
           }
         }

diff --git a/config/presets/ldp/request-parser.json b/config/presets/ldp/request-parser.json
@@ -3,21 +3,21 @@
   "@graph": [
     {
       "@id": "urn:solid-server:default:RequestParser",
-      "@type": "SimpleRequestParser",
-      "SimpleRequestParser:_targetExtractor": {
-        "@type": "SimpleTargetExtractor"
+      "@type": "BasicRequestParser",
+      "BasicRequestParser:_targetExtractor": {
+        "@type": "BasicTargetExtractor"
       },
-      "SimpleRequestParser:_preferenceParser": {
+      "BasicRequestParser:_preferenceParser": {
         "@type": "AcceptPreferenceParser"
       },
-      "SimpleRequestParser:_bodyParser": {
+      "BasicRequestParser:_bodyParser": {
         "@type": "CompositeAsyncHandler",
         "CompositeAsyncHandler:_handlers": [
           {
-            "@type": "SimpleSparqlUpdateBodyParser"
+            "@type": "SparqlUpdateBodyParser"
           },
           {
-            "@type": "SimpleBodyParser"
+            "@type": "RawBodyParser"
           }
         ]
       }

diff --git a/config/presets/storage.json b/config/presets/storage.json
@@ -3,8 +3,8 @@
   "@graph": [
     {
       "@id": "urn:solid-server:default:ResourceStore",
-      "@type": "SimpleResourceStore",
-      "SimpleResourceStore:_runtimeConfig": {
+      "@type": "InMemoryResourceStore",
+      "InMemoryResourceStore:_runtimeConfig": {
         "@id": "urn:solid-server:default:RuntimeConfig"
       }
     }

diff --git a/config/presets/storage_wrapper.json b/config/presets/storage_wrapper.json
@@ -14,11 +14,11 @@
       },
       "PatchingStore:_patcher": {
         "@id": "urn:solid-server:default:PatchHandler",
-        "@type": "SimpleSparqlUpdatePatchHandler",
-        "SimpleSparqlUpdatePatchHandler:_source": {
+        "@type": "SparqlUpdatePatchHandler",
+        "SparqlUpdatePatchHandler:_source": {
           "@id": "urn:solid-server:default:ResourceStore_Converting"
         },
-        "SimpleSparqlUpdatePatchHandler:_locker": {
+        "SparqlUpdatePatchHandler:_locker": {
           "@id": "urn:solid-server:default:ResourceLocker"
         }
       }

diff --git a/index.ts b/index.ts
@@ -1,14 +1,14 @@
 // Authentication
 export * from './src/authentication/Credentials';
 export * from './src/authentication/CredentialsExtractor';
-export * from './src/authentication/SimpleCredentialsExtractor';
+export * from './src/authentication/UnsecureWebIdExtractor';
 
 // Authorization
+export * from './src/authorization/AllowEverythingAuthorizer';
 export * from './src/authorization/AclManager';
 export * from './src/authorization/Authorizer';
-export * from './src/authorization/SimpleAclAuthorizer';
-export * from './src/authorization/SimpleAuthorizer';
-export * from './src/authorization/SimpleExtensionAclManager';
+export * from './src/authorization/UrlBasedAclManager';
+export * from './src/authorization/WebAclAuthorizer';
 
 // Init
 export * from './src/init/CliRunner';
@@ -17,28 +17,28 @@ export * from './src/init/Setup';
 
 // LDP/HTTP
 export * from './src/ldp/http/AcceptPreferenceParser';
+export * from './src/ldp/http/BasicRequestParser';
+export * from './src/ldp/http/BasicResponseWriter';
+export * from './src/ldp/http/BasicTargetExtractor';
 export * from './src/ldp/http/BodyParser';
 export * from './src/ldp/http/Patch';
 export * from './src/ldp/http/PreferenceParser';
+export * from './src/ldp/http/RawBodyParser';
 export * from './src/ldp/http/RequestParser';
 export * from './src/ldp/http/ResponseWriter';
-export * from './src/ldp/http/SimpleBodyParser';
-export * from './src/ldp/http/SimpleRequestParser';
-export * from './src/ldp/http/SimpleResponseWriter';
-export * from './src/ldp/http/SimpleSparqlUpdateBodyParser';
-export * from './src/ldp/http/SimpleTargetExtractor';
+export * from './src/ldp/http/SparqlUpdateBodyParser';
 export * from './src/ldp/http/SparqlUpdatePatch';
 export * from './src/ldp/http/TargetExtractor';
 
 // LDP/Operations
+export * from './src/ldp/operations/DeleteOperationHandler';
+export * from './src/ldp/operations/GetOperationHandler';
 export * from './src/ldp/operations/Operation';
 export * from './src/ldp/operations/OperationHandler';
+export * from './src/ldp/operations/PatchOperationHandler';
+export * from './src/ldp/operations/PostOperationHandler';
+export * from './src/ldp/operations/PutOperationHandler';
 export * from './src/ldp/operations/ResponseDescription';
-export * from './src/ldp/operations/SimpleDeleteOperationHandler';
-export * from './src/ldp/operations/SimpleGetOperationHandler';
-export * from './src/ldp/operations/SimplePatchOperationHandler';
-export * from './src/ldp/operations/SimplePostOperationHandler';
-export * from './src/ldp/operations/SimplePutOperationHandler';
 
 // LDP/Permissions
 export * from './src/ldp/permissions/PermissionSet';
@@ -75,12 +75,13 @@ export * from './src/storage/conversion/TypedRepresentationConverter';
 
 // Storage/Patch
 export * from './src/storage/patch/PatchHandler';
-export * from './src/storage/patch/SimpleSparqlUpdatePatchHandler';
+export * from './src/storage/patch/SparqlUpdatePatchHandler';
 
 // Storage
 export * from './src/storage/AtomicResourceStore';
 export * from './src/storage/Conditions';
 export * from './src/storage/ContainerManager';
+export * from './src/storage/InMemoryResourceStore';
 export * from './src/storage/Lock';
 export * from './src/storage/LockingResourceStore';
 export * from './src/storage/PassthroughStore';
@@ -90,7 +91,6 @@ export * from './src/storage/ResourceLocker';
 export * from './src/storage/ResourceMapper';
 export * from './src/storage/ResourceStore';
 export * from './src/storage/SingleThreadedResourceLocker';
-export * from './src/storage/SimpleResourceStore';
 export * from './src/storage/UrlContainerManager';
 
 // Util/Errors

diff --git a/...hentication/SimpleCredentialsExtractor.ts → src/authentication/UnsecureWebIdExtractor.ts b/...hentication/SimpleCredentialsExtractor.ts → src/authentication/UnsecureWebIdExtractor.ts
@@ -5,15 +5,12 @@ import { CredentialsExtractor } from './CredentialsExtractor';
 /**
  * Credentials extractor which simply interprets the contents of the Authorization header as a webID.
  */
-export class SimpleCredentialsExtractor extends CredentialsExtractor {
+export class UnsecureWebIdExtractor extends CredentialsExtractor {
   public async canHandle(): Promise<void> {
     // Supports all requests
   }
 
   public async handle(input: HttpRequest): Promise<Credentials> {
-    if (input.headers.authorization) {
-      return { webID: input.headers.authorization };
-    }
-    return {};
+    return { webID: input.headers.authorization };
   }
 }
diff --git a/src/authorization/AllowEverythingAuthorizer.ts b/src/authorization/AllowEverythingAuthorizer.ts
@@ -0,0 +1,14 @@
+import { Authorizer } from './Authorizer';
+
+/**
+ * Authorizer which allows all access independent of the identifier and requested permissions.
+ */
+export class AllowEverythingAuthorizer extends Authorizer {
+  public async canHandle(): Promise<void> {
+    // Can handle all requests
+  }
+
+  public async handle(): Promise<void> {
+    // Allows all actions
+  }
+}
diff --git a/src/authorization/SimpleAuthorizer.ts b/src/authorization/SimpleAuthorizer.ts
diff --git a/...uthorization/SimpleExtensionAclManager.ts → src/authorization/UrlBasedAclManager.ts b/...uthorization/SimpleExtensionAclManager.ts → src/authorization/UrlBasedAclManager.ts
@@ -15,7 +15,7 @@ import { AclManager } from './AclManager';
  * It is potentially possible that an agent wants to generate the acl file before generating the actual file.
  * (Unless this is not allowed by the spec, need to verify).
  */
-export class SimpleExtensionAclManager implements AclManager {
+export class UrlBasedAclManager implements AclManager {
   public async getAcl(id: ResourceIdentifier): Promise<ResourceIdentifier> {
     return await this.isAcl(id) ? id : { path: `${id.path}.acl` };
   }

diff --git a/src/authorization/SimpleAclAuthorizer.ts → src/authorization/WebAclAuthorizer.ts b/src/authorization/SimpleAclAuthorizer.ts → src/authorization/WebAclAuthorizer.ts
@@ -18,7 +18,7 @@ import { Authorizer, AuthorizerArgs } from './Authorizer';
  * `acl:mode`, `acl:agentClass`, `acl:agent`, `acl:default` and `acl:accessTo`.
  * Does not support `acl:agentGroup`, `acl:origin` and `acl:trustedApp` yet.
  */
-export class SimpleAclAuthorizer extends Authorizer {
+export class WebAclAuthorizer extends Authorizer {
   private readonly aclManager: AclManager;
   private readonly containerManager: ContainerManager;
   private readonly resourceStore: ResourceStore;

diff --git a/src/ldp/http/SimpleRequestParser.ts → src/ldp/http/BasicRequestParser.ts b/src/ldp/http/SimpleRequestParser.ts → src/ldp/http/BasicRequestParser.ts
@@ -6,7 +6,7 @@ import { RequestParser } from './RequestParser';
 import { TargetExtractor } from './TargetExtractor';
 
 /**
- * Input parsers required for a {@link SimpleRequestParser}.
+ * Input parsers required for a {@link BasicRequestParser}.
  */
 export interface SimpleRequestParserArgs {
   targetExtractor: TargetExtractor;
@@ -18,7 +18,7 @@ export interface SimpleRequestParserArgs {
  * Creates an {@link Operation} from an incoming {@link HttpRequest} by aggregating the results
  * of a {@link TargetExtractor}, {@link PreferenceParser}, and {@link BodyParser}.
  */
-export class SimpleRequestParser extends RequestParser {
+export class BasicRequestParser extends RequestParser {
   private readonly targetExtractor!: TargetExtractor;
   private readonly preferenceParser!: PreferenceParser;
   private readonly bodyParser!: BodyParser;

diff --git a/src/ldp/http/SimpleResponseWriter.ts → src/ldp/http/BasicResponseWriter.ts b/src/ldp/http/SimpleResponseWriter.ts → src/ldp/http/BasicResponseWriter.ts
@@ -7,8 +7,9 @@ import { ResponseWriter } from './ResponseWriter';
 
 /**
  * Writes to an {@link HttpResponse} based on the incoming {@link ResponseDescription} or error.
+ * Still needs a way to write correct status codes for successful operations.
  */
-export class SimpleResponseWriter extends ResponseWriter {
+export class BasicResponseWriter extends ResponseWriter {
   public async canHandle(input: { response: HttpResponse; result: ResponseDescription | Error }): Promise<void> {
     if (!(input.result instanceof Error)) {
       const dataType = input.result.body?.dataType;

diff --git a/src/ldp/http/SimpleTargetExtractor.ts → src/ldp/http/BasicTargetExtractor.ts b/src/ldp/http/SimpleTargetExtractor.ts → src/ldp/http/BasicTargetExtractor.ts
@@ -6,13 +6,17 @@ import { TargetExtractor } from './TargetExtractor';
 
 /**
  * Extracts an identifier from an incoming {@link HttpRequest}.
- * Simply takes the input URl without any parsing/cleaning.
+ * Uses URL library for basic parsing.
+ * TODO: input requires more extensive cleaning/parsing based on headers (see #22).
  */
-export class SimpleTargetExtractor extends TargetExtractor {
+export class BasicTargetExtractor extends TargetExtractor {
   public async canHandle(input: HttpRequest): Promise<void> {
     if (!input.url) {
       throw new Error('Missing URL.');
     }
+    if (!input.headers.host) {
+      throw new Error('Missing host.');
+    }
   }
 
   public async handle(input: HttpRequest): Promise<ResourceIdentifier> {

diff --git a/src/ldp/http/SimpleBodyParser.ts → src/ldp/http/RawBodyParser.ts b/src/ldp/http/SimpleBodyParser.ts → src/ldp/http/RawBodyParser.ts
@@ -8,11 +8,11 @@ import { BodyParser } from './BodyParser';
 /**
  * Converts incoming {@link HttpRequest} to a Representation without any further parsing.
  * Naively parses the mediatype from the content-type header.
- * Metadata is not generated (yet).
+ * Some other metadata is also generated, but this should probably be done in an external handler.
  */
-export class SimpleBodyParser extends BodyParser {
+export class RawBodyParser extends BodyParser {
   public async canHandle(): Promise<void> {
-    // Default BodyParser supports all content-types
+    // All content-types are supported
   }
 
   // Note that the only reason this is a union is in case the body is empty.

diff --git a/src/ldp/http/SimpleSparqlUpdateBodyParser.ts → src/ldp/http/SparqlUpdateBodyParser.ts b/src/ldp/http/SimpleSparqlUpdateBodyParser.ts → src/ldp/http/SparqlUpdateBodyParser.ts
@@ -11,9 +11,9 @@ import { SparqlUpdatePatch } from './SparqlUpdatePatch';
 /**
  * {@link BodyParser} that supports `application/sparql-update` content.
  * Will convert the incoming update string to algebra in a {@link SparqlUpdatePatch}.
- * Simple since metadata parsing is not yet implemented.
+ * Still needs access to a handler for parsing metadata.
  */
-export class SimpleSparqlUpdateBodyParser extends BodyParser {
+export class SparqlUpdateBodyParser extends BodyParser {
   public async canHandle(input: HttpRequest): Promise<void> {
     const contentType = input.headers['content-type'];
 

diff --git a/...perations/SimpleDeleteOperationHandler.ts → src/ldp/operations/DeleteOperationHandler.ts b/...perations/SimpleDeleteOperationHandler.ts → src/ldp/operations/DeleteOperationHandler.ts
@@ -8,7 +8,7 @@ import { ResponseDescription } from './ResponseDescription';
  * Handles DELETE {@link Operation}s.
  * Calls the deleteResource function from a {@link ResourceStore}.
  */
-export class SimpleDeleteOperationHandler extends OperationHandler {
+export class DeleteOperationHandler extends OperationHandler {
   private readonly store: ResourceStore;
 
   public constructor(store: ResourceStore) {

diff --git a/...p/operations/SimpleGetOperationHandler.ts → src/ldp/operations/GetOperationHandler.ts b/...p/operations/SimpleGetOperationHandler.ts → src/ldp/operations/GetOperationHandler.ts
@@ -8,7 +8,7 @@ import { ResponseDescription } from './ResponseDescription';
  * Handles GET {@link Operation}s.
  * Calls the getRepresentation function from a {@link ResourceStore}.
  */
-export class SimpleGetOperationHandler extends OperationHandler {
+export class GetOperationHandler extends OperationHandler {
   private readonly store: ResourceStore;
 
   public constructor(store: ResourceStore) {

diff --git a/...operations/SimplePatchOperationHandler.ts → src/ldp/operations/PatchOperationHandler.ts b/...operations/SimplePatchOperationHandler.ts → src/ldp/operations/PatchOperationHandler.ts
@@ -5,7 +5,7 @@ import { Operation } from './Operation';
 import { OperationHandler } from './OperationHandler';
 import { ResponseDescription } from './ResponseDescription';
 
-export class SimplePatchOperationHandler extends OperationHandler {
+export class PatchOperationHandler extends OperationHandler {
   private readonly store: ResourceStore;
 
   public constructor(store: ResourceStore) {