ducimusipsa 1.0.0

package/packages/arcgis-rest-sharing/test/group-sharing.test.ts

@@ -0,0 +1,566 @@
+/* Copyright (c) 2018 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import * as fetchMock from "fetch-mock";
+import { shareItemWithGroup, unshareItemWithGroup } from "../src/index";
+import { MOCK_USER_SESSION } from "./mocks/sharing";
+
+import {
+  AnonUserResponse,
+  GroupNonMemberUserResponse,
+  GroupMemberUserResponse,
+  GroupAdminUserResponse,
+  OrgAdminUserResponse
+} from "../../arcgis-rest-users/test/mocks/user";
+
+import { SearchResponse } from "../../arcgis-rest-items/test/mocks/search";
+
+const SharingResponse = {
+  notSharedWith: [] as any,
+  itemId: "n3v"
+};
+
+const FailedSharingResponse = {
+  notSharedWith: ["t6b"],
+  itemId: "n3v"
+};
+
+const UnsharingResponse = {
+  notUnsharedFrom: [] as any,
+  itemId: "a5b"
+};
+
+const CachedSharingResponse = {
+  notSharedWith: [] as any,
+  itemId: "a5b",
+  shortcut: true
+};
+
+const CachedUnsharingResponse = {
+  notUnsharedFrom: [] as any,
+  itemId: "n3v",
+  shortcut: true
+};
+
+const NoResultsSearchResponse = {
+  query: "",
+  total: 0,
+  start: 0,
+  num: 0,
+  nextStart: 0,
+  results: [] as any
+};
+
+export const GroupOwnerResponse = {
+  id: "tb6",
+  title: "fake group",
+  userMembership: {
+    memberType: "owner"
+  }
+};
+
+export const GroupMemberResponse = {
+  id: "tb6",
+  title: "fake group",
+  userMembership: {
+    memberType: "member"
+  }
+};
+
+export const GroupAdminResponse = {
+  id: "tb6",
+  title: "fake group",
+  userMembership: {
+    memberType: "admin"
+  }
+};
+
+export const GroupNoAccessResponse = {
+  error: {
+    code: 400,
+    messageCode: "COM_0003",
+    message: "Group does not exist or is inaccessible.",
+    details: [] as any[]
+  }
+};
+
+describe("shareItemWithGroup() ::", () => {
+  // make sure session doesnt cache metadata
+  beforeEach(function() {
+    MOCK_USER_SESSION._user = null;
+  });
+
+  afterEach(fetchMock.restore);
+
+  it("should share an item with a group by owner", done => {
+    // this is used when isOrgAdmin is called...
+    fetchMock.once(
+      "https://myorg.maps.arcgis.com/sharing/rest/community/users/jsmith?f=json&token=fake-token",
+      GroupMemberUserResponse
+    );
+    // this is called when we try to determine if the item is already in the group
+    fetchMock.once(
+      "https://myorg.maps.arcgis.com/sharing/rest/search",
+      SearchResponse
+    );
+
+    // called when we determine if the user is a member of the group
+    fetchMock.get(
+      "https://myorg.maps.arcgis.com/sharing/rest/community/groups/t6b?f=json&token=fake-token",
+      GroupOwnerResponse
+    );
+
+    // the actual sharing request
+    fetchMock.once(
+      "https://myorg.maps.arcgis.com/sharing/rest/content/users/jsmith/items/n3v/share",
+      SharingResponse
+    );
+
+    shareItemWithGroup({
+      authentication: MOCK_USER_SESSION,
+      id: "n3v",
+      groupId: "t6b"
+    })
+      .then(response => {
+        expect(fetchMock.done()).toBeTruthy(
+          "All fetchMocks should have been called"
+        );
+        const [url, options]: [string, RequestInit] = fetchMock.lastCall(
+          "https://myorg.maps.arcgis.com/sharing/rest/content/users/jsmith/items/n3v/share"
+        );
+        expect(url).toBe(
+          "https://myorg.maps.arcgis.com/sharing/rest/content/users/jsmith/items/n3v/share"
+        );
+        expect(options.method).toBe("POST");
+        expect(response).toEqual(SharingResponse);
+        expect(options.body).toContain("f=json");
+        expect(options.body).toContain("groups=t6b");
+        done();
+      })
+      .catch(e => {
+        expect(fetchMock.done()).toBeTruthy(
+          "All fetchMocks should have been called"
+        );
+        fail(e);
+      });
+  });
+
+  it("should fail to share an item with a group if the request is made by a non-org admin and non-group member", done => {
+    fetchMock.once(
+      "https://myorg.maps.arcgis.com/sharing/rest/community/users/jsmith?f=json&token=fake-token",
+      GroupNonMemberUserResponse
+    );
+
+    fetchMock.once(
+      "https://myorg.maps.arcgis.com/sharing/rest/search",
+      SearchResponse
+    );
+
+    shareItemWithGroup({
+      authentication: MOCK_USER_SESSION,
+      id: "n3v",
+      groupId: "t6b"
+    }).catch(e => {
+      expect(fetchMock.done()).toBeTruthy(
+        "All fetchMocks should have been called"
+      );
+      expect(e.message).toBe(
+        "This item can not be shared by jsmith as they are not a member of the specified group t6b."
+      );
+      done();
+    });
+  });
+
+  it("should share an item with a group by org administrator", done => {
+    fetchMock.once(
+      "https://myorg.maps.arcgis.com/sharing/rest/community/users/jsmith?f=json&token=fake-token",
+      OrgAdminUserResponse
+    );
+
+    fetchMock.once(
+      "https://myorg.maps.arcgis.com/sharing/rest/search",
+      NoResultsSearchResponse
+    );
+
+    // called when we determine if the user is a member of the group
+    fetchMock.get(
+      "https://myorg.maps.arcgis.com/sharing/rest/community/groups/t6b?f=json&token=fake-token",
+      GroupOwnerResponse
+    );
+
+    fetchMock.once(
+      "https://myorg.maps.arcgis.com/sharing/rest/content/users/casey/items/n3v/share",
+      SharingResponse
+    );
+
+    shareItemWithGroup({
+      authentication: MOCK_USER_SESSION,
+      id: "n3v",
+      groupId: "t6b",
+      owner: "casey"
+    })
+      .then(response => {
+        expect(fetchMock.done()).toBeTruthy(
+          "All fetchMocks should have been called"
+        );
+        const [url, options]: [string, RequestInit] = fetchMock.lastCall(
+          "https://myorg.maps.arcgis.com/sharing/rest/content/users/casey/items/n3v/share"
+        );
+        expect(url).toBe(
+          "https://myorg.maps.arcgis.com/sharing/rest/content/users/casey/items/n3v/share"
+        );
+        expect(options.method).toBe("POST");
+        expect(response).toEqual(SharingResponse);
+        expect(options.body).toContain("f=json");
+        expect(options.body).toContain("groups=t6b");
+        done();
+      })
+      .catch(e => {
+        fail(e);
+      });
+  });
+
+  it("should share an item with a group by group owner/admin", done => {
+    fetchMock.once(
+      "https://myorg.maps.arcgis.com/sharing/rest/community/users/jsmith?f=json&token=fake-token",
+      GroupAdminUserResponse
+    );
+
+    fetchMock.once(
+      "https://myorg.maps.arcgis.com/sharing/rest/search",
+      SearchResponse
+    );
+
+    // called when we determine if the user is a member of the group
+    fetchMock.get(
+      "https://myorg.maps.arcgis.com/sharing/rest/community/groups/t6b?f=json&token=fake-token",
+      GroupOwnerResponse
+    );
+
+    fetchMock.once(
+      "https://myorg.maps.arcgis.com/sharing/rest/content/items/n3v/share",
+      SharingResponse
+    );
+
+    shareItemWithGroup({
+      authentication: MOCK_USER_SESSION,
+      id: "n3v",
+      groupId: "t6b",
+      owner: "otherguy"
+    })
+      .then(response => {
+        expect(fetchMock.done()).toBeTruthy(
+          "All fetchMocks should have been called"
+        );
+        const [url, options]: [string, RequestInit] = fetchMock.lastCall(
+          "https://myorg.maps.arcgis.com/sharing/rest/content/items/n3v/share"
+        );
+        expect(url).toBe(
+          "https://myorg.maps.arcgis.com/sharing/rest/content/items/n3v/share"
+        );
+        expect(options.method).toBe("POST");
+        expect(response).toEqual(SharingResponse);
+        expect(options.body).toContain("f=json");
+        expect(options.body).toContain("groups=t6b");
+        done();
+      })
+      .catch(e => {
+        expect(fetchMock.done()).toBeTruthy(
+          "All fetchMocks should have been called"
+        );
+        fail(e);
+      });
+  });
+
+  it("should mock the response if an item was previously shared with a group", done => {
+    fetchMock.once(
+      "https://myorg.maps.arcgis.com/sharing/rest/community/users/jsmith?f=json&token=fake-token",
+      GroupAdminUserResponse
+    );
+
+    fetchMock.once(
+      "https://myorg.maps.arcgis.com/sharing/rest/search",
+      SearchResponse
+    );
+
+    shareItemWithGroup({
+      authentication: MOCK_USER_SESSION,
+      id: "a5b",
+      groupId: "t6b"
+    })
+      .then(response => {
+        // no web request to share at all
+        expect(response).toEqual(CachedSharingResponse);
+        done();
+      })
+      .catch(e => {
+        expect(fetchMock.done()).toBeTruthy(
+          "All fetchMocks should have been called"
+        );
+        fail(e);
+      });
+  });
+
+  it("should throw if the person trying to share doesnt own the item, is not an admin or member of said group", done => {
+    fetchMock.once(
+      "https://myorg.maps.arcgis.com/sharing/rest/community/users/jsmith?f=json&token=fake-token",
+      GroupMemberUserResponse
+    );
+
+    fetchMock.once(
+      "https://myorg.maps.arcgis.com/sharing/rest/search",
+      SearchResponse
+    );
+
+    // called when we determine if the user is a member of the group
+    fetchMock.get(
+      "https://myorg.maps.arcgis.com/sharing/rest/community/groups/t6b?f=json&token=fake-token",
+      GroupMemberResponse
+    );
+
+    shareItemWithGroup({
+      authentication: MOCK_USER_SESSION,
+      id: "n3v",
+      groupId: "t6b",
+      owner: "casey"
+    }).catch(e => {
+      expect(fetchMock.done()).toBeTruthy(
+        "All fetchMocks should have been called"
+      );
+      expect(e.message).toContain(
+        "This item can not be shared by jsmith as they are neither the owner, a groupAdmin of t6b, nor an org_admin."
+      );
+      done();
+    });
+  });
+
+  it("should throw if the response from the server is fishy", done => {
+    fetchMock.once(
+      "https://myorg.maps.arcgis.com/sharing/rest/community/users/jsmith?f=json&token=fake-token",
+      GroupMemberUserResponse
+    );
+
+    fetchMock.once(
+      "https://myorg.maps.arcgis.com/sharing/rest/search",
+      SearchResponse
+    );
+
+    fetchMock.once(
+      "https://myorg.maps.arcgis.com/sharing/rest/content/users/jsmith/items/n3v/share",
+      FailedSharingResponse
+    );
+
+    fetchMock.get(
+      "https://myorg.maps.arcgis.com/sharing/rest/community/groups/t6b?f=json&token=fake-token",
+      GroupMemberResponse
+    );
+
+    shareItemWithGroup({
+      authentication: MOCK_USER_SESSION,
+      id: "n3v",
+      groupId: "t6b"
+    }).catch(e => {
+      expect(fetchMock.done()).toBeTruthy(
+        "All fetchMocks should have been called"
+      );
+      expect(e.message).toBe("Item n3v could not be shared to group t6b.");
+      done();
+    });
+  });
+});
+
+describe("unshareItemWithGroup() ::", () => {
+  // make sure session doesnt cache metadata
+  beforeEach(function() {
+    MOCK_USER_SESSION._user = null;
+  });
+
+  afterEach(fetchMock.restore);
+
+  it("should unshare an item with a group by owner", done => {
+    fetchMock.once(
+      "https://myorg.maps.arcgis.com/sharing/rest/community/users/jsmith?f=json&token=fake-token",
+      GroupMemberUserResponse
+    );
+
+    fetchMock.once(
+      "https://myorg.maps.arcgis.com/sharing/rest/search",
+      SearchResponse
+    );
+
+    fetchMock.once(
+      "https://myorg.maps.arcgis.com/sharing/rest/content/users/jsmith/items/a5b/unshare",
+      UnsharingResponse
+    );
+
+    fetchMock.get(
+      "https://myorg.maps.arcgis.com/sharing/rest/community/groups/t6b?f=json&token=fake-token",
+      GroupOwnerResponse
+    );
+
+    unshareItemWithGroup({
+      authentication: MOCK_USER_SESSION,
+      id: "a5b",
+      groupId: "t6b"
+    })
+      .then(response => {
+        const [url, options]: [string, RequestInit] = fetchMock.lastCall(
+          "https://myorg.maps.arcgis.com/sharing/rest/content/users/jsmith/items/a5b/unshare"
+        );
+        expect(url).toBe(
+          "https://myorg.maps.arcgis.com/sharing/rest/content/users/jsmith/items/a5b/unshare"
+        );
+        expect(options.method).toBe("POST");
+        expect(response).toEqual(UnsharingResponse);
+        expect(options.body).toContain("f=json");
+        expect(options.body).toContain("groups=t6b");
+        done();
+      })
+      .catch(e => {
+        expect(fetchMock.done()).toBeTruthy(
+          "All fetchMocks should have been called"
+        );
+        fail(e);
+      });
+  });
+
+  it("should unshare an item with a group by org administrator", done => {
+    fetchMock.once(
+      "https://myorg.maps.arcgis.com/sharing/rest/community/users/jsmith?f=json&token=fake-token",
+      OrgAdminUserResponse
+    );
+
+    fetchMock.once(
+      "https://myorg.maps.arcgis.com/sharing/rest/search",
+      SearchResponse
+    );
+
+    fetchMock.once(
+      "https://myorg.maps.arcgis.com/sharing/rest/content/users/casey/items/a5b/unshare",
+      UnsharingResponse
+    );
+
+    fetchMock.get(
+      "https://myorg.maps.arcgis.com/sharing/rest/community/groups/t6b?f=json&token=fake-token",
+      GroupOwnerResponse
+    );
+
+    unshareItemWithGroup({
+      authentication: MOCK_USER_SESSION,
+      id: "a5b",
+      groupId: "t6b",
+      owner: "casey"
+    })
+      .then(response => {
+        const [url, options]: [string, RequestInit] = fetchMock.lastCall(
+          "https://myorg.maps.arcgis.com/sharing/rest/content/users/casey/items/a5b/unshare"
+        );
+        expect(url).toBe(
+          "https://myorg.maps.arcgis.com/sharing/rest/content/users/casey/items/a5b/unshare"
+        );
+        expect(options.method).toBe("POST");
+        expect(response).toEqual(UnsharingResponse);
+        expect(options.body).toContain("f=json");
+        expect(options.body).toContain("groups=t6b");
+        done();
+      })
+      .catch(e => {
+        fail(e);
+      });
+  });
+
+  it("should unshare an item with a group by group admin", done => {
+    fetchMock.once(
+      "https://myorg.maps.arcgis.com/sharing/rest/community/users/jsmith?f=json&token=fake-token",
+      GroupAdminUserResponse
+    );
+
+    fetchMock.once(
+      "https://myorg.maps.arcgis.com/sharing/rest/search",
+      SearchResponse
+    );
+
+    fetchMock.once(
+      "https://myorg.maps.arcgis.com/sharing/rest/content/items/a5b/unshare",
+      UnsharingResponse
+    );
+
+    fetchMock.get(
+      "https://myorg.maps.arcgis.com/sharing/rest/community/groups/t6b?f=json&token=fake-token",
+      GroupAdminResponse
+    );
+
+    unshareItemWithGroup({
+      authentication: MOCK_USER_SESSION,
+      id: "a5b",
+      groupId: "t6b",
+      owner: "otherguy"
+    })
+      .then(response => {
+        const [url, options]: [string, RequestInit] = fetchMock.lastCall(
+          "https://myorg.maps.arcgis.com/sharing/rest/content/items/a5b/unshare"
+        );
+        expect(url).toBe(
+          "https://myorg.maps.arcgis.com/sharing/rest/content/items/a5b/unshare"
+        );
+        expect(options.method).toBe("POST");
+        expect(response).toEqual(UnsharingResponse);
+        expect(options.body).toContain("f=json");
+        expect(options.body).toContain("groups=t6b");
+        done();
+      })
+      .catch(e => {
+        fail(e);
+      });
+  });
+
+  it("should shortcircuit share if an item was previously unshared with a group", done => {
+    fetchMock.once(
+      "https://myorg.maps.arcgis.com/sharing/rest/community/users/jsmith?f=json&token=fake-token",
+      GroupMemberUserResponse
+    );
+
+    fetchMock.once(
+      "https://myorg.maps.arcgis.com/sharing/rest/search",
+      SearchResponse
+    );
+
+    unshareItemWithGroup({
+      authentication: MOCK_USER_SESSION,
+      id: "n3v",
+      groupId: "t6b"
+    })
+      .then(response => {
+        // no web request to unshare at all
+        expect(response).toEqual(CachedUnsharingResponse);
+        done();
+      })
+      .catch(e => {
+        fail(e);
+      });
+  });
+
+  it("should throw if the person trying to unshare doesnt own the item, is not an admin or member of said group", done => {
+    fetchMock.once(
+      "https://myorg.maps.arcgis.com/sharing/rest/community/users/jsmith?f=json&token=fake-token",
+      AnonUserResponse
+    );
+
+    fetchMock.once(
+      "https://myorg.maps.arcgis.com/sharing/rest/search",
+      SearchResponse
+    );
+
+    unshareItemWithGroup({
+      authentication: MOCK_USER_SESSION,
+      id: "a5b",
+      groupId: "t6b",
+      owner: "jones"
+    }).catch(e => {
+      expect(e.message).toContain(
+        "This item can not be unshared by jsmith as they are not a member of the specified group t6b."
+      );
+      done();
+    });
+  });
+});

package/packages/arcgis-rest-sharing/test/helpers.test.ts

@@ -0,0 +1,55 @@
+/* Copyright (c) 2018 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import * as fetchMock from "fetch-mock";
+import { getUserMembership } from "../src/helpers";
+import { MOCK_USER_SESSION } from "./mocks/sharing";
+import {
+  GroupOwnerResponse,
+  GroupNoAccessResponse
+} from "./group-sharing.test";
+
+describe("sharing helpers ::", () => {
+  afterEach(fetchMock.restore);
+  describe("getUserMembership ::", () => {
+    it("should return nonmember if group could not be fetched", done => {
+      fetchMock.once(
+        "https://myorg.maps.arcgis.com/sharing/rest/community/groups/tb6?f=json&token=fake-token",
+        GroupNoAccessResponse
+      );
+      getUserMembership({
+        id: "ignoreme",
+        groupId: "tb6",
+        authentication: MOCK_USER_SESSION
+      })
+        .then(result => {
+          expect(fetchMock.done()).toBeTruthy();
+          expect(result).toBe("nonmember", "should return nonmember");
+          done();
+        })
+        .catch(e => {
+          fail(e);
+        });
+    });
+
+    it("should request the group and return the member type", done => {
+      fetchMock.once(
+        "https://myorg.maps.arcgis.com/sharing/rest/community/groups/tb6?f=json&token=fake-token",
+        GroupOwnerResponse
+      );
+      getUserMembership({
+        id: "ignoreme",
+        groupId: "tb6",
+        authentication: MOCK_USER_SESSION
+      })
+        .then(result => {
+          expect(fetchMock.done()).toBeTruthy();
+          expect(result).toBe("owner", "should return owner");
+          done();
+        })
+        .catch(e => {
+          fail(e);
+        });
+    });
+  });
+});

package/packages/arcgis-rest-sharing/test/mocks/sharing.ts

@@ -0,0 +1,18 @@
+/* Copyright (c) 2018 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import { UserSession } from "@esri/arcgis-rest-auth";
+import { TOMORROW } from "@esri/arcgis-rest-auth/test/utils";
+
+export const MOCK_USER_SESSION = new UserSession({
+  clientId: "clientId",
+  redirectUri: "https://example-app.com/redirect-uri",
+  token: "fake-token",
+  tokenExpires: TOMORROW,
+  refreshToken: "refreshToken",
+  refreshTokenExpires: TOMORROW,
+  refreshTokenTTL: 1440,
+  username: "jsmith",
+  password: "123456",
+  portal: "https://myorg.maps.arcgis.com/sharing/rest"
+});

package/packages/arcgis-rest-sharing/tsconfig.json

@@ -0,0 +1,6 @@
+{
+    "extends": "../../tsconfig.json",
+    "include": [
+        "src/**/*.ts"
+    ]
+}