ducimusipsa 1.0.0

package/packages/arcgis-rest-users/test/invitation.test.ts

@@ -0,0 +1,169 @@
+/* Copyright (c) 2018 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import {
+  getUserInvitations,
+  getUserInvitation,
+  acceptInvitation,
+  declineInvitation
+} from "../src/index";
+
+import {
+  UserInvitationsResponse,
+  UserInvitationResponse
+} from "./mocks/invitation";
+
+import { encodeParam } from "@esri/arcgis-rest-request";
+import { UserSession } from "@esri/arcgis-rest-auth";
+import * as fetchMock from "fetch-mock";
+
+const TOMORROW = (function() {
+  const now = new Date();
+  now.setDate(now.getDate() + 1);
+  return now;
+})();
+
+describe("invitations", () => {
+  afterEach(fetchMock.restore);
+
+  const session = new UserSession({
+    username: "c@sey",
+    password: "123456",
+    portal: "https://myorg.maps.arcgis.com/sharing/rest"
+  });
+
+  fetchMock.postOnce(
+    "https://myorg.maps.arcgis.com/sharing/rest/generateToken",
+    {
+      token: "fake-token",
+      expires: TOMORROW.getTime(),
+      username: "c@sey"
+    }
+  );
+
+  describe("getUserInvitations", () => {
+    session.refreshSession();
+
+    it("should make an authenticated request for user invitations", done => {
+      fetchMock.once("*", UserInvitationsResponse);
+
+      getUserInvitations({ authentication: session })
+        .then(response => {
+          expect(fetchMock.called()).toEqual(true);
+          const [url, options]: [string, RequestInit] = fetchMock.lastCall("*");
+          expect(url).toEqual(
+            "https://myorg.maps.arcgis.com/sharing/rest/community/users/c%40sey/invitations?f=json&token=fake-token"
+          );
+          expect(options.method).toBe("GET");
+          expect(response.userInvitations.length).toEqual(1);
+          done();
+        })
+        .catch(e => {
+          fail(e);
+        });
+    });
+  });
+
+  describe("getUserInvitation", () => {
+    fetchMock.postOnce(
+      "https://myorg.maps.arcgis.com/sharing/rest/generateToken",
+      {
+        token: "fake-token",
+        expires: TOMORROW.getTime(),
+        username: "c@sey"
+      }
+    );
+
+    session.refreshSession();
+
+    it("should make an authenticated request for a user invitation", done => {
+      fetchMock.once("*", UserInvitationResponse);
+
+      getUserInvitation({ invitationId: "3ef", authentication: session })
+        .then(response => {
+          expect(fetchMock.called()).toEqual(true);
+          const [url, options]: [string, RequestInit] = fetchMock.lastCall("*");
+          expect(url).toEqual(
+            "https://myorg.maps.arcgis.com/sharing/rest/community/users/c%40sey/invitations/3ef?f=json&token=fake-token"
+          );
+          expect(options.method).toBe("GET");
+          expect(response.id).toEqual("G45ad52e7560e470598815499003c13f6");
+          expect(response.id).toEqual("G45ad52e7560e470598815499003c13f6");
+          done();
+        })
+        .catch(e => {
+          fail(e);
+        });
+    });
+  });
+
+  describe("acceptInvitation", () => {
+    fetchMock.postOnce(
+      "https://myorg.maps.arcgis.com/sharing/rest/generateToken",
+      {
+        token: "fake-token",
+        expires: TOMORROW.getTime(),
+        username: "c@sey"
+      }
+    );
+
+    session.refreshSession();
+
+    it("should accept an invitation", done => {
+      fetchMock.once("*", { success: true });
+
+      acceptInvitation({ invitationId: "3ef", authentication: session })
+        .then(response => {
+          expect(fetchMock.called()).toEqual(true);
+          const [url, options]: [string, RequestInit] = fetchMock.lastCall("*");
+          expect(url).toEqual(
+            "https://myorg.maps.arcgis.com/sharing/rest/community/users/c%40sey/invitations/3ef/accept"
+          );
+          expect(options.method).toBe("POST");
+          expect(options.body).toContain(encodeParam("f", "json"));
+          expect(options.body).toContain(encodeParam("token", "fake-token"));
+          expect(response.success).toEqual(true);
+          // expect(response.notificationId).toBe("3ef");
+          done();
+        })
+        .catch(e => {
+          fail(e);
+        });
+    });
+  });
+
+  describe("declineInvitation", () => {
+    fetchMock.postOnce(
+      "https://myorg.maps.arcgis.com/sharing/rest/generateToken",
+      {
+        token: "fake-token",
+        expires: TOMORROW.getTime(),
+        username: "c@sey"
+      }
+    );
+
+    session.refreshSession();
+
+    it("should decline an invitation", done => {
+      fetchMock.once("*", { success: true });
+
+      declineInvitation({ invitationId: "3ef", authentication: session })
+        .then(response => {
+          expect(fetchMock.called()).toEqual(true);
+          const [url, options]: [string, RequestInit] = fetchMock.lastCall("*");
+          expect(url).toEqual(
+            "https://myorg.maps.arcgis.com/sharing/rest/community/users/c%40sey/invitations/3ef/decline"
+          );
+          expect(options.method).toBe("POST");
+          expect(options.body).toContain(encodeParam("f", "json"));
+          expect(options.body).toContain(encodeParam("token", "fake-token"));
+          expect(response.success).toEqual(true);
+          // expect(response.notificationId).toBe("3ef");
+          done();
+        })
+        .catch(e => {
+          fail(e);
+        });
+    });
+  });
+});

package/packages/arcgis-rest-users/test/mocks/invitation.ts

@@ -0,0 +1,70 @@
+import { IInvitation, IInvitationResult } from "../../src/invitation";
+
+export const UserInvitationsResponse: IInvitationResult = {
+  userInvitations: [
+    {
+      id: "G45ad52e7560e470598815499003c13f6",
+      targetType: "group",
+      targetId: "5d780fcf924e4e7ab1952a71472bc950",
+      received: 1538516323000,
+      accepted: false,
+      mustApprove: false,
+      email: null,
+      role: "group_member",
+      type: "user",
+      dateAccepted: -1,
+      expiration: 1539725923000,
+      created: 1538516323000,
+      username: "mjuniper_dcqa",
+      fromUsername: {
+        username: "dcadminqa"
+      },
+      groupId: "5d780fcf924e4e7ab1952a71472bc950"
+    }
+  ]
+};
+
+export const UserInvitationResponse: IInvitation = {
+  id: "G45ad52e7560e470598815499003c13f6",
+  targetType: "group",
+  targetId: "5d780fcf924e4e7ab1952a71472bc950",
+  received: 1538516323000,
+  accepted: false,
+  mustApprove: false,
+  email: null,
+  role: "group_member",
+  type: "user",
+  dateAccepted: -1,
+  expiration: 1539725923000,
+  created: 1538516323000,
+  username: "mjuniper_dcqa",
+  fromUsername: {
+    username: "dcadminqa",
+    fullname: "DcAdminQA QaExtDc"
+  },
+  group: {
+    id: "5d780fcf924e4e7ab1952a71472bc950",
+    title: "Jupe test group 2",
+    isInvitationOnly: true,
+    owner: "dcadminqa",
+    description: null,
+    snippet: null,
+    tags: ["hub"],
+    phone: null,
+    sortField: "title",
+    sortOrder: "asc",
+    isViewOnly: false,
+    thumbnail: null,
+    created: 1538516296000,
+    modified: 1538516296000,
+    access: "public",
+    capabilities: [],
+    isFav: false,
+    isReadOnly: false,
+    protected: false,
+    autoJoin: false,
+    notificationsEnabled: false,
+    provider: null,
+    providerGroupName: null
+  }
+};

package/packages/arcgis-rest-users/test/mocks/notification.ts

@@ -0,0 +1,34 @@
+import { INotificationResult } from "../../src/notification";
+
+export const UserNotificationsResponse: INotificationResult = {
+  notifications: [
+    {
+      id: "7eee83bb4bc94c1e82bb5b931ab9a818",
+      type: "message_received",
+      target: "c@sey",
+      targetType: "user",
+      received: 1534788621000,
+      data: {
+        fromUser: "adminuser",
+        subject: "this is the subject",
+        message: "this is the message"
+      }
+    },
+    {
+      id: "e8c18248ee2f4eb298d443026982b59c",
+      type: "group_join",
+      target: "c@sey",
+      targetType: "user",
+      received: 1534788353000,
+      data: {
+        groupId: "0c943127d4a545e6874e4ee4e1f88fa8",
+        groupTitle: "This is Jupe's Test Event"
+      }
+    }
+  ]
+};
+
+export const IDeleteSuccessResponse: any = {
+  success: true,
+  notificationId: "3ef"
+};

package/packages/arcgis-rest-users/test/mocks/user.ts

@@ -0,0 +1,173 @@
+/* Copyright (c) 2018 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import { IUser } from "@esri/arcgis-rest-common-types";
+
+export const AnonUserResponse: IUser = {
+  username: "jsmith",
+  fullName: "John Smith",
+  firstName: "John",
+  lastName: "Smith",
+  description: "Senior GIS Analyst for the city of Redlands.",
+  tags: ["GIS Analyst", "City of Redlands"],
+  culture: "en",
+  region: "US",
+  units: "metric",
+  thumbnail: "myProfile.jpg",
+  created: 1258501046000,
+  modified: 1290625562000,
+  provider: "arcgis"
+};
+
+export const GroupMemberUserResponse: IUser = {
+  ...AnonUserResponse,
+  availableCredits: 479.50998,
+  assignedCredits: 500.0,
+  preferredView: "Web",
+  email: "jsmith33@esri.com",
+  idpUsername: "null",
+  favGroupId: "829e32cca4dd475a8bb63bb56b16fe3e",
+  lastLogin: 1385766284000,
+  mfaEnabled: false,
+  access: "public",
+  storageUsage: 583650,
+  storageQuota: 2147483648,
+  orgId: "qWAReEOCnD7eTxOe",
+  role: "org_publisher",
+  privileges: [
+    "portal:admin:deleteItems",
+    "portal:admin:reassignItems",
+    "portal:admin:updateItems",
+    "portal:admin:viewItems",
+    "portal:admin:viewUsers",
+    "portal:user:createGroup",
+    "portal:user:createItem",
+    "portal:user:joinGroup",
+    "portal:user:shareToGroup",
+    "portal:user:shareToOrg"
+  ],
+  roleId: "RDnHQBSBbsJuIkUp",
+  level: "2",
+  disabled: false,
+  groups: [
+    {
+      id: "t6b",
+      title: "Street Maps",
+      isInvitationOnly: false,
+      owner: "whoknows",
+      description:
+        "The street map group provides street maps for the city of Redlands.",
+      snippet: "City of Redlands maps",
+      tags: ["Redlands", "street", "maps"],
+      phone: "http://www.esri.com",
+      thumbnail: "streets.jpg",
+      created: 1258501221000,
+      modified: 1272309404000,
+      access: "org",
+      userMembership: {
+        username: "jsmith",
+        memberType: "member",
+        applications: 0
+      },
+      protected: false,
+      isViewOnly: false,
+      isFav: false,
+      isOpenData: true,
+      autoJoin: false
+    }
+  ]
+};
+
+export const GroupNonMemberUserResponse: IUser = {
+  ...GroupMemberUserResponse,
+  groups: [
+    {
+      id: "abc",
+      title: "Street Maps",
+      isInvitationOnly: false,
+      owner: "whoknows",
+      description:
+        "The street map group provides street maps for the city of Redlands.",
+      snippet: "City of Redlands maps",
+      tags: ["Redlands", "street", "maps"],
+      phone: "http://www.esri.com",
+      thumbnail: "streets.jpg",
+      created: 1258501221000,
+      modified: 1272309404000,
+      access: "org",
+      userMembership: {
+        username: "jsmith",
+        memberType: "member",
+        applications: 0
+      },
+      protected: false,
+      isViewOnly: false,
+      isFav: false,
+      isOpenData: true,
+      autoJoin: false
+    }
+  ]
+};
+
+export const GroupAdminUserResponse = {
+  ...GroupMemberUserResponse,
+  groups: [
+    {
+      id: "t6b",
+      title: "Street Maps",
+      isInvitationOnly: false,
+      owner: "whoknows",
+      description:
+        "The street map group provides street maps for the city of Redlands.",
+      snippet: "City of Redlands maps",
+      tags: ["Redlands", "street", "maps"],
+      phone: "http://www.esri.com",
+      thumbnail: "streets.jpg",
+      created: 1258501221000,
+      modified: 1272309404000,
+      access: "org",
+      userMembership: {
+        username: "jsmith",
+        memberType: "admin",
+        applications: 0
+      },
+      protected: false,
+      isViewOnly: false,
+      isFav: false,
+      isOpenData: true,
+      autoJoin: false
+    }
+  ]
+};
+
+export const OrgAdminUserResponse = {
+  ...GroupAdminUserResponse,
+  role: "org_admin",
+  groups: [
+    {
+      id: "t6b",
+      title: "Street Maps",
+      isInvitationOnly: false,
+      owner: "whoknows",
+      description:
+        "The street map group provides street maps for the city of Redlands.",
+      snippet: "City of Redlands maps",
+      tags: ["Redlands", "street", "maps"],
+      phone: "http://www.esri.com",
+      thumbnail: "streets.jpg",
+      created: 1258501221000,
+      modified: 1272309404000,
+      access: "org",
+      userMembership: {
+        username: "jsmith",
+        memberType: "owner",
+        applications: 0
+      },
+      protected: false,
+      isViewOnly: false,
+      isFav: false,
+      isOpenData: true,
+      autoJoin: false
+    }
+  ]
+};

package/packages/arcgis-rest-users/test/notification.test.ts

@@ -0,0 +1,83 @@
+/* Copyright (c) 2018 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import { getUserNotifications, removeNotification } from "../src/index";
+
+import {
+  UserNotificationsResponse,
+  IDeleteSuccessResponse
+} from "./mocks/notification";
+
+import { encodeParam } from "@esri/arcgis-rest-request";
+import { UserSession } from "@esri/arcgis-rest-auth";
+import * as fetchMock from "fetch-mock";
+
+const TOMORROW = (function() {
+  const now = new Date();
+  now.setDate(now.getDate() + 1);
+  return now;
+})();
+
+describe("users", () => {
+  afterEach(fetchMock.restore);
+
+  describe("getUserNotifications", () => {
+    const session = new UserSession({
+      username: "c@sey",
+      password: "123456",
+      portal: "https://myorg.maps.arcgis.com/sharing/rest"
+    });
+
+    fetchMock.postOnce(
+      "https://myorg.maps.arcgis.com/sharing/rest/generateToken",
+      {
+        token: "fake-token",
+        expires: TOMORROW.getTime(),
+        username: "c@sey"
+      }
+    );
+
+    session.refreshSession();
+
+    it("should make an authenticated request for user notifications", done => {
+      fetchMock.once("*", UserNotificationsResponse);
+
+      getUserNotifications({ authentication: session })
+        .then(response => {
+          expect(fetchMock.called()).toEqual(true);
+          const [url, options]: [string, RequestInit] = fetchMock.lastCall("*");
+          expect(url).toEqual(
+            "https://myorg.maps.arcgis.com/sharing/rest/community/users/c%40sey/notifications?f=json&token=fake-token"
+          );
+          expect(options.method).toBe("GET");
+          expect(response.notifications.length).toEqual(2);
+          done();
+        })
+        .catch(e => {
+          fail(e);
+        });
+    });
+
+    it("should remove a notification", done => {
+      fetchMock.once("*", IDeleteSuccessResponse);
+
+      removeNotification({ id: "3ef", ...{ authentication: session } })
+        .then(response => {
+          expect(fetchMock.called()).toEqual(true);
+          const [url, options]: [string, RequestInit] = fetchMock.lastCall("*");
+          expect(url).toEqual(
+            "https://myorg.maps.arcgis.com/sharing/rest/community/users/c%40sey/notifications/3ef/delete"
+          );
+          expect(options.method).toBe("POST");
+          expect(options.body).toContain(encodeParam("f", "json"));
+          expect(options.body).toContain(encodeParam("token", "fake-token"));
+          expect(response.success).toEqual(true);
+          expect(response.notificationId).toBe("3ef");
+          done();
+        })
+        .catch(e => {
+          fail(e);
+        });
+    });
+  });
+});

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

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