etincidunt 1.0.0

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

@@ -0,0 +1,436 @@
+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/responses";
+
+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
+};
+
+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 => {
+    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",
+      SharingResponse
+    );
+
+    shareItemWithGroup({
+      authentication: MOCK_USER_SESSION,
+      id: "n3v",
+      groupId: "t6b"
+    })
+      .then(response => {
+        const [url, options]: [string, RequestInit] = fetchMock.lastCall(
+          "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 => {
+        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(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
+    );
+
+    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 => {
+        const [url, options]: [string, RequestInit] = fetchMock.lastCall(
+          "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
+    );
+
+    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 => {
+        const [url, options]: [string, RequestInit] = fetchMock.lastCall(
+          "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 => {
+        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 => {
+        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
+    );
+
+    shareItemWithGroup({
+      authentication: MOCK_USER_SESSION,
+      id: "n3v",
+      groupId: "t6b",
+      owner: "casey"
+    }).catch(e => {
+      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
+    );
+
+    shareItemWithGroup({
+      authentication: MOCK_USER_SESSION,
+      id: "n3v",
+      groupId: "t6b"
+    }).catch(e => {
+      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
+    );
+
+    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(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 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
+    );
+
+    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(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
+    );
+
+    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(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/mocks/sharing.ts

@@ -0,0 +1,15 @@
+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"
+    ]
+}

package/packages/arcgis-rest-users/README.md

@@ -0,0 +1,71 @@
+[![npm version][npm-img]][npm-url]
+[![build status][travis-img]][travis-url]
+[![apache licensed](https://img.shields.io/badge/license-Apache-green.svg?style=flat-square)](https://raw.githubusercontent.com/Esri/arcgis-rest-js/master/LICENSE)
+
+[npm-img]: https://img.shields.io/npm/v/@esri/arcgis-rest-users.svg?style=flat-square
+[npm-url]: https://www.npmjs.com/package/@esri/arcgis-rest-users
+[travis-img]: https://img.shields.io/travis/Esri/arcgis-rest-js/master.svg?style=flat-square
+[travis-url]: https://travis-ci.org/Esri/arcgis-rest-js
+
+# @esri/arcgis-rest-users
+
+> A module for working with users in the ArcGIS REST API that runs in Node.js and modern browsers.
+
+### Example
+
+```bash
+npm install @esri/arcgis-rest-users
+```
+
+```js
+import { getUser } from '@esri/arcgis-rest-groups';
+
+getUser("jsmith")
+    .then(response => {
+        /*
+        {
+            firstName: "John",
+            lastName: "Smith",
+            tags: ["GIS Analyst", "City of Redlands"],
+            thumbnail: "myProfile.jpg",
+            created: 1258501046000,
+            modified: 1290625562000,
+             d eetc.
+        };
+        */
+    });
+```
+
+### Issues
+
+If something isn't working the way you expected, please take a look at [previously logged issues](https://github.com/Esri/arcgis-rest-js/issues) first.  Have you found a new bug?  Want to request a new feature?  We'd [**love**](https://github.com/Esri/arcgis-rest-js/issues/new) to hear from you.
+
+If you're looking for help you can also post issues on [GIS Stackexchange](http://gis.stackexchange.com/questions/ask?tags=esri-oss).
+
+### Versioning
+
+For transparency into the release cycle and in striving to maintain backward compatibility, @esri/arcgis-rest-js is maintained under Semantic Versioning guidelines and will adhere to these rules whenever possible.
+
+For more information on SemVer, please visit <http://semver.org/>.
+
+### Contributing
+
+Esri welcomes contributions from anyone and everyone. Please see our [guidelines for contributing](CONTRIBUTING.md).
+
+### License
+
+Copyright 2018 Esri
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+> http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+A copy of the license is available in the repository's [LICENSE](../../LICENSE) file.

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

@@ -0,0 +1,11 @@
+{
+	"requires": true,
+	"lockfileVersion": 1,
+	"dependencies": {
+		"tslib": {
+			"version": "1.9.0",
+			"resolved": "https://registry.npmjs.org/tslib/-/tslib-1.9.0.tgz",
+			"integrity": "sha512-f/qGG2tUkrISBlQZEjEqoZ3B2+npJjIf04H1wuAv9iA8i04Icp+61KRXxFdha22670NJopsZCIjhC3SnjPRKrQ=="
+		}
+	}
+}

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

@@ -0,0 +1,51 @@
+{
+  "name": "@esri/arcgis-rest-users",
+  "version": "1.6.0",
+  "description": "Portal user helpers for @esri/arcgis-rest-request",
+  "main": "dist/node/index.js",
+  "browser": "dist/umd/users.umd.js",
+  "module": "dist/esm/index.js",
+  "js:next": "dist/esm/index.js",
+  "types": "dist/esm/index.d.ts",
+  "license": "Apache-2.0",
+  "files": [
+    "dist/**"
+  ],
+  "dependencies": {
+    "tslib": "^1.7.1"
+  },
+  "peerDependencies": {
+    "@esri/arcgis-rest-auth": "^1.5.1",
+    "@esri/arcgis-rest-common-types": "^1.5.1",
+    "@esri/arcgis-rest-request": "^1.5.1"
+  },
+  "devDependencies": {
+    "@esri/arcgis-rest-auth": "^1.6.0",
+    "@esri/arcgis-rest-common-types": "^1.6.0",
+    "@esri/arcgis-rest-request": "^1.6.0"
+  },
+  "scripts": {
+    "prepare": "npm run build",
+    "build": "npm run build:node && npm run build:umd && npm run build:esm",
+    "build:esm": "tsc -p ./tsconfig.json --module es2015 --outDir ./dist/esm --declaration",
+    "build:umd": "rollup -c ../../umd-base-profile.js && rollup -c ../../umd-production-profile.js",
+    "build:node": "tsc -p ./tsconfig.json --module commonjs --outDir ./dist/node"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Esri/arcgis-rest-js.git"
+  },
+  "contributors": [
+    {
+      "name": "John Gravois",
+      "email": "john@esri.com"
+    }
+  ],
+  "bugs": {
+    "url": "https://github.com/Esri/arcgis-rest-js/issues"
+  },
+  "homepage": "https://github.com/Esri/arcgis-rest-js#readme"
+}

package/packages/arcgis-rest-users/src/index.ts

@@ -0,0 +1 @@
+export * from "./users";

package/packages/arcgis-rest-users/src/users.ts

@@ -0,0 +1,70 @@
+/* Copyright (c) 2018 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import {
+  request,
+  IRequestOptions,
+  getPortalUrl
+} from "@esri/arcgis-rest-request";
+
+import { IUser } from "@esri/arcgis-rest-common-types";
+import { UserSession, IUserRequestOptions } from "@esri/arcgis-rest-auth";
+
+export interface IGetUserRequestOptions extends IRequestOptions {
+  /**
+   * A session representing a logged in user.
+   */
+  authentication?: UserSession;
+  /**
+   * Supply a username if you'd like to fetch information about a different user than is being used to authenticate the request.
+   */
+  username?: string;
+}
+
+/**
+ * Get information about a user. This method has proven so generically useful that you can also call [`UserSession.getUser()`](../../auth/UserSession#getUser-summary).
+ *
+ * ```js
+ * import { getUser } from '@esri/arcgis-rest-users';
+ *
+ * getUser("jsmith")
+ *   .then(
+ *     results => {
+ *      // {
+ *      //   firstName: "John",
+ *      //   lastName: "Smith",
+ *      //   tags: ["GIS Analyst", "City of Redlands"],
+ *      //   created: 1258501046000
+ *      //   etc.
+ *      // };
+ *   })
+ * ```
+ *
+ * @param requestOptions - options to pass through in the request
+ * @returns A Promise that will resolve with metadata about the user
+ */
+export function getUser(
+  requestOptions?: string | IGetUserRequestOptions
+): Promise<IUser> {
+  let url;
+  let options = { httpMethod: "GET" } as IGetUserRequestOptions;
+
+  // if a username is passed, assume ArcGIS Online
+  if (typeof requestOptions === "string") {
+    url = `https://www.arcgis.com/sharing/rest/community/users/${requestOptions}`;
+  } else {
+    // if an authenticated session is passed, default to that user/portal unless another username is provided manually
+    const username =
+      requestOptions.username || requestOptions.authentication.username;
+    url = `${getPortalUrl(requestOptions)}/community/users/${encodeURIComponent(
+      username
+    )}`;
+    options = {
+      ...requestOptions,
+      ...options
+    };
+  }
+
+  // send the request
+  return request(url, options);
+}