Merge pull request #69 from solid-contrib/create-new-group

Create new group

Author: michielbdejong

contacts/CHANGELOG.md

@@ -4,6 +4,12 @@ All notable changes to this module will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## Unreleased
+
+### Added
+
+- [createNewGroup](https://solid-contrib.github.io/data-modules/contacts-rdflib-api/interfaces/ContactsModule.html#createNewGroup)
+
 ## 0.2.1
 
 ### Fixed

contacts/examples/create-new-group.mjs

@@ -0,0 +1,22 @@
+import {ContactsModuleRdfLib as ContactsModule} from '../dist/index.js';
+import { Fetcher, graph, UpdateManager } from "rdflib";
+import { faker } from "@faker-js/faker";
+
+const store = graph();
+const fetcher = new Fetcher(store);
+const updater = new UpdateManager(store);
+const contacts = new ContactsModule({ store, fetcher, updater });
+
+let addressBookUri =
+  "http://localhost:3000/alice/public-write/ab9694d6-120e-415d-a315-90cd84c2e062/index.ttl#this";
+
+const groupName = faker.company.name();
+
+const uri = await contacts.createNewGroup({
+  addressBookUri,
+  groupName,
+});
+console.log("created group:", groupName, "at", uri);
+
+const result = await contacts.readAddressBook(addressBookUri);
+console.log("the updated address book:", result);

contacts/jest.config.js

@@ -4,4 +4,6 @@ module.exports = {
   testEnvironment: "node",
   rootDir: "src",
   testPathIgnorePatterns: [".*\\.e2e\\.spec\\.ts"],
+  detectOpenHandles: true,
+  forceExit: true,
 };

contacts/jest.e2e.config.js

@@ -4,4 +4,6 @@ module.exports = {
   testEnvironment: "node",
   rootDir: "src/e2e-tests",
   testTimeout: 60000,
+  detectOpenHandles: true,
+  forceExit: true,
 };

contacts/package.json

@@ -6,9 +6,9 @@
   "scripts": {
     "build": "tsc",
     "build:doc": "typedoc src/index.ts --out ../gh-pages/contacts-rdflib-api",
-    "test": "jest --detectOpenHandles --forceExit",
+    "test": "jest",
     "lint": "eslint",
-    "test:e2e": "jest --config jest.e2e.config.js --detectOpenHandles --forceExit",
+    "test:e2e": "jest --config jest.e2e.config.js",
     "pod": "community-solid-server --config ./dev-server/config/config-mashlib.json --seedConfig ./dev-server/seed.json --rootFilePath ./dev-server/data",
     "pod:init": "cp -r ./dev-server/initial-data/* ./dev-server/data/",
     "pod:clean": "rm -rf ./dev-server/data"

contacts/src/e2e-tests/contacts.e2e.spec.ts

@@ -99,6 +99,26 @@ describe("contacts module", () => {
       ],
     });
   });
+
+  it("can create a new group within an existing address book", async () => {
+    const contacts = setupModule();
+
+    const addressBookUri =
+      "http://localhost:3456/4243dbb6-3126-4bf9-9ea7-45e35c3c8d9d/index.ttl#this";
+
+    const groupName = faker.company.name();
+    const uri = await contacts.createNewGroup({
+      addressBookUri,
+      groupName,
+    });
+
+    const result = await contacts.readAddressBook(addressBookUri);
+
+    expect(result.groups).toContainEqual({
+      uri,
+      name: groupName,
+    });
+  });
 });
 
 function setupModule() {

contacts/src/index.ts

@@ -34,6 +34,16 @@ export interface ContactsModule {
    * @return Contact name, email addresses and phone numbers
    */
   readContact(uri: string): Promise<FullContact>;
+
+  /**
+   * Creates a new group within a given address book
+   * @param command
+   * @return The URI of the newly created group
+   */
+  createNewGroup({
+    addressBookUri,
+    groupName,
+  }: CreateNewGroupCommand): Promise<string>;
 }
 
 /**
@@ -121,3 +131,17 @@ export interface PhoneNumber {
  * Partial group data listed when reading an address book
  */
 export interface Group {}
+
+/**
+ * Data needed to create a new group within an address book
+ */
+export interface CreateNewGroupCommand {
+  /**
+   * The URI of an existing address book the new group should be added to
+   */
+  addressBookUri: string;
+  /**
+   * The name of the group to create
+   */
+  groupName: string;
+}

contacts/src/rdflib/ContactsModuleRdfLib.spec.ts

@@ -1,12 +1,11 @@
 import { when } from "jest-when";
-import { createAddressBook } from "./createAddressBook";
+import { createAddressBook, createNewContact } from "./update-operations";
 import { ContactsModuleRdfLib } from "./ContactsModuleRdfLib";
 import { executeUpdate } from "./web-operations/executeUpdate";
 import { Fetcher, graph, UpdateManager } from "rdflib";
-import { createNewContact } from "./createNewContact";
 
-jest.mock("./createAddressBook");
-jest.mock("./createNewContact");
+jest.mock("./update-operations/createAddressBook");
+jest.mock("./update-operations/createNewContact");
 jest.mock("./web-operations/executeUpdate");
 jest.mock("./web-operations/fetchNode");
 

contacts/src/rdflib/ContactsModuleRdfLib.ts

@@ -4,14 +4,14 @@ import {
   ContactsModule,
   CreateAddressBookCommand,
   CreateNewContactCommand,
+  CreateNewGroupCommand,
   FullContact,
 } from "..";
-import { AddressBookQuery } from "./AddressBookQuery";
-import { createAddressBook } from "./createAddressBook";
+import { AddressBookQuery, ContactQuery } from "./queries";
+import { createAddressBook, createNewContact } from "./update-operations";
 import { executeUpdate } from "./web-operations/executeUpdate";
-import { createNewContact } from "./createNewContact";
 import { fetchNode } from "./web-operations/fetchNode";
-import { ContactQuery } from "./ContactQuery";
+import { createNewGroup } from "./update-operations/createNewGroup";
 
 interface ModuleConfig {
   store: IndexedFormula;
@@ -89,4 +89,14 @@ export class ContactsModuleRdfLib implements ContactsModule {
       phoneNumbers,
     };
   }
+
+  async createNewGroup({ addressBookUri, groupName }: CreateNewGroupCommand) {
+    const addressBookNode = sym(addressBookUri);
+    await this.fetchNode(addressBookNode);
+
+    const query = new AddressBookQuery(this.store, addressBookNode);
+    const operation = createNewGroup(query, groupName);
+    await executeUpdate(this.fetcher, this.updater, operation);
+    return operation.uri;
+  }
 }

contacts/src/rdflib/create-new-group.integration.spec.ts

@@ -0,0 +1,74 @@
+import { v4 as uuid } from "uuid";
+import { Fetcher, graph, UpdateManager } from "rdflib";
+import { ContactsModuleRdfLib } from "./ContactsModuleRdfLib";
+import {
+  mockNotFound,
+  mockTurtleResponse,
+} from "../test-support/mockResponses";
+import { expectPatchRequest } from "../test-support/expectRequests";
+
+jest.mock("uuid");
+
+describe("create new group", () => {
+  it("creates group resource", async () => {
+    const authenticatedFetch = jest.fn();
+
+    (uuid as jest.Mock).mockReturnValueOnce(
+      "b4e9fd85-3b38-4db7-8599-d0eda0b2ac74",
+    );
+
+    const store = graph();
+    const fetcher = new Fetcher(store, {
+      fetch: authenticatedFetch,
+    });
+    const updater = new UpdateManager(store);
+    const contacts = new ContactsModuleRdfLib({
+      store,
+      fetcher,
+      updater,
+    });
+
+    mockTurtleResponse(
+      authenticatedFetch,
+      "https://pod.test/alice/contacts/index.ttl",
+      `
+    @prefix vcard: <http://www.w3.org/2006/vcard/ns#>.
+    @prefix ab: <http://www.w3.org/ns/pim/ab#>.
+    @prefix dc: <http://purl.org/dc/elements/1.1/>.
+    @prefix xsd: <http://www.w3.org/2001/XMLSchema#>.
+  
+    <#this> a vcard:AddressBook;
+        dc:title "Alice's contacts";
+        vcard:nameEmailIndex <people.ttl>;
+        vcard:groupIndex <groups.ttl>.
+`,
+    );
+
+    mockTurtleResponse(
+      authenticatedFetch,
+      "https://pod.test/alice/contacts/groups.ttl",
+      "",
+    );
+
+    mockNotFound(
+      authenticatedFetch,
+      "https://pod.test/alice/contacts/Group/b4e9fd85-3b38-4db7-8599-d0eda0b2ac74/index.ttl",
+    );
+
+    const createdUri = await contacts.createNewGroup({
+      addressBookUri: "https://pod.test/alice/contacts/index.ttl#this",
+      groupName: "best friends",
+    });
+
+    expect(createdUri).toEqual(
+      "https://pod.test/alice/contacts/Group/b4e9fd85-3b38-4db7-8599-d0eda0b2ac74/index.ttl#this",
+    );
+    expectPatchRequest(
+      authenticatedFetch,
+      "https://pod.test/alice/contacts/Group/b4e9fd85-3b38-4db7-8599-d0eda0b2ac74/index.ttl",
+      `INSERT DATA { <https://pod.test/alice/contacts/Group/b4e9fd85-3b38-4db7-8599-d0eda0b2ac74/index.ttl#this> <http://www.w3.org/2006/vcard/ns#fn> "best friends" .
+<https://pod.test/alice/contacts/Group/b4e9fd85-3b38-4db7-8599-d0eda0b2ac74/index.ttl#this> <http://www.w3.org/1999/02/22-rdf-syntax-ns#type> <http://www.w3.org/2006/vcard/ns#Group> .
+ }`,
+    );
+  });
+});