etincidunt 1.0.0

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

@@ -0,0 +1,170 @@
+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: "user",
+        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: "user",
+        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/users.test.ts

@@ -0,0 +1,97 @@
+import { getUser } from "../src/index";
+
+import {
+  AnonUserResponse,
+  GroupMemberUserResponse,
+  GroupAdminUserResponse
+} from "./mocks/responses";
+
+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("getUser", () => {
+    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: "token",
+        expires: TOMORROW.getTime(),
+        username: " c@sey"
+      }
+    );
+
+    session.refreshSession();
+
+    it("should make a simple, unauthenticated request for information about a user", done => {
+      fetchMock.once("*", AnonUserResponse);
+
+      getUser("jsmith")
+        .then(response => {
+          expect(fetchMock.called()).toEqual(true);
+          const [url, options]: [string, RequestInit] = fetchMock.lastCall("*");
+          expect(url).toEqual(
+            "https://www.arcgis.com/sharing/rest/community/users/jsmith?f=json"
+          );
+          expect(options.method).toBe("GET");
+          done();
+        })
+        .catch(e => {
+          fail(e);
+        });
+    });
+
+    it("should make an authenticated request for information about a user", done => {
+      fetchMock.once("*", GroupMemberUserResponse);
+
+      getUser({ 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?f=json&token=token"
+          );
+          expect(options.method).toBe("GET");
+          done();
+        })
+        .catch(e => {
+          fail(e);
+        });
+    });
+
+    it("should make an authenticated request for information about a different user", done => {
+      fetchMock.once("*", GroupAdminUserResponse);
+
+      getUser({
+        username: "jsmith",
+        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/jsmith?f=json&token=token"
+          );
+          expect(options.method).toBe("GET");
+          done();
+        })
+        .catch(e => {
+          fail(e);
+        });
+    });
+  });
+});

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

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

package/support/FormData.d.ts

@@ -0,0 +1 @@
+declare module "isomorphic-form-data";

package/support/changelog.js

@@ -0,0 +1,388 @@
+const { spawn, exec, execSync } = require("child_process");
+const { inspect } = require("util");
+const { resolve } = require("path");
+const { writeFile } = require("fs");
+const { stripIndents } = require("common-tags");
+const { format } = require("date-fns");
+const parseChangelog = require("changelog-parser");
+const parseCommit = require("conventional-commits-parser").sync;
+const nunjucks = require("nunjucks");
+const _ = require("lodash");
+
+/**
+ * The purpose of this file is to parse all commits since the last release tag
+ * v*.*.* and update the contents of CHANGELOG.md to prepare for a new release.
+ */
+
+const repo = "https://github.com/Esri/arcgis-rest-js";
+
+function getTags() {
+  return new Promise((resolve, reject) => {
+    let tags = [];
+    const log = spawn("git", ["tag", "-l", "v*", "--sort", "v:refname"]);
+
+    log.stdout.on("data", data => {
+      tags = tags.concat(data.toString().split("\n"));
+    });
+
+    log.on("close", code => {
+      resolve(_.compact(tags));
+    });
+  });
+}
+
+function getFirstCommit() {
+  return new Promise((resolve, reject) => {
+    let commits = [];
+    const log = spawn("git", [
+      "rev-list",
+      "--max-parents=0",
+      "HEAD",
+      "--reverse"
+    ]);
+
+    log.stdout.on("data", data => {
+      commits = commits.concat(data.toString().split("\n"));
+    });
+
+    log.on("close", code => {
+      resolve(commits[0]);
+    });
+  });
+}
+
+function getCommitData(from, to) {
+  return new Promise((resolve, reject) => {
+    const hash = "%H";
+    const shortHash = "%h";
+    const authorName = "%an";
+    const authorEmail = "%ae";
+    const date = "%aI";
+    const subject = "%s";
+    const defaultFormat = {
+      hash,
+      shortHash,
+      date,
+      subject,
+      author: { name: authorName, email: authorEmail }
+    };
+
+    const cmd = `git log ${from}..${to} --pretty=format:'${JSON.stringify(
+      defaultFormat
+    )},'`;
+
+    exec(cmd, (err, stdout, stderr) => {
+      if (err) return reject(err);
+      if (stderr) return reject(stderr);
+      // order commits from most recent to least recent
+      const commits = JSON.parse("["+stdout.slice(0, -1).replace(/\\/g, "\\\\")+"]").reverse();
+      const today = new Date();
+      resolve({
+        previousVersion: /v\d\.\d\.\d/.test(from)
+          ? from.replace("v", "")
+          : from,
+        version: to === "HEAD" ? getPackageVersion() : to.replace("v", ""),
+        date: format(today, "MMMM Do YYYY"),
+        commits
+      });
+    });
+  });
+}
+
+function getPackageVersion() {
+  return require(resolve(process.cwd(), "./lerna.json")).version;
+}
+
+function pairReleases(releases) {
+  return Promise.all(
+    releases.reduce((pairs, release, idx, allReleases) => {
+      const nextRelease = allReleases[idx + 1];
+      if (nextRelease) {
+        pairs.push([release, nextRelease]);
+      }
+
+      return pairs;
+    }, [])
+  );
+}
+
+function processCommitMessages(releaseData) {
+  return releaseData.map(release => {
+    release.commits = _(release.commits)
+      .map(commit => {
+        const parsedCommit = parseCommit(
+          execSync(
+            `git log ${commit.hash} -n1 --pretty=format:'%B'`
+          ).toString(),
+          {
+            mergePattern: /^Merge pull request #(\d+) from (.*)$/,
+            mergeCorrespondence: ["id", "source"],
+            noteKeywords: [
+              "BREAKING CHANGE",
+              "ISSUES CLOSED",
+              "AFFECTS PACKAGES"
+            ]
+          }
+        );
+
+        if (!parsedCommit.type || !parsedCommit.scope) {
+          return;
+        }
+
+        Object.assign(commit, parsedCommit);
+
+        const breaking = commit.notes.findIndex(
+          n => n.title === "BREAKING CHANGE"
+        );
+
+        if (breaking >= 0) {
+          commit.breakingChanges = commit.notes[breaking].text;
+        }
+
+        const issues = commit.notes.findIndex(n => n.title === "ISSUES CLOSED");
+
+        if (issues >= 0) {
+          const issuesClosed = commit.notes[issues].text
+            .replace(/\n.*/gm, "")
+            .replace(/\s/g, "")
+            .split(",")
+            .map(i => i.replace("#", ""));
+
+          const issuesReferenced = commit.references.map(r => r.issue);
+
+          commit.relatedIssues = _.uniq(
+            issuesClosed.concat(issuesReferenced)
+          ).map(i => {
+            return {
+              issue: i,
+              url: `${repo}/issues/${i}`
+            };
+          });
+        }
+        return commit;
+      })
+      .compact()
+      .sortBy("type")
+      .value();
+
+    return release;
+  });
+}
+
+function getPackagesForCommit(commit) {
+  const idx = commit.notes.findIndex(note => note.title === "AFFECTS PACKAGES");
+  if (idx >= 0) {
+    const affectedPackages = commit.notes[idx].text.split("\n");
+    return affectedPackages;
+  }
+  return ["Other Changes"];
+}
+
+function findReleasedPackages(releases) {
+  return releases.map(release => {
+    release.packages = release.commits.reduce((packages, commit) => {
+      packages = packages.concat(getPackagesForCommit(commit));
+      return _(packages).compact().uniq().sortBy(p => p).value();
+    }, []);
+    return release;
+  });
+}
+
+function hasBreakingChanges(commit) {
+  return commit.notes.find(n => n.title === "BREAKING CHANGE");
+}
+
+function groupCommitsByPackage(releases) {
+  return releases.map(release => {
+    release.groups = release.packages.reduce((groups, package) => {
+      const commitsForPackage = release.commits.filter(commit => {
+        return getPackagesForCommit(commit).some(
+          commitPackage => commitPackage === package
+        );
+      });
+
+      const [breaking, nonBreaking] = _.partition(
+        commitsForPackage,
+        hasBreakingChanges
+      );
+
+      if (breaking.length === 0) {
+        groups[package] = Object.assign(
+          {},
+          _.groupBy(_.sortBy(nonBreaking, "type"), "type")
+        );
+      } else {
+        groups[package] = Object.assign(
+          { breaking },
+          _.groupBy(nonBreaking, "type")
+        );
+      }
+
+      return groups;
+    }, {});
+    delete release.commits;
+    return release;
+  });
+}
+
+function getTypeName(type) {
+  switch (type) {
+    case "feat":
+      return "New Features";
+    case "fix":
+      return "Bug Fixes";
+    case "docs":
+      return "Documentation";
+    case "style":
+      return "Code Style";
+    case "Refactor":
+      return "Refactoring";
+    case "perf":
+      return "Performance";
+    case "test":
+      return "Tests";
+    case "chore":
+      return "Chores";
+    case "revert":
+      return "Reverts";
+    case "breaking":
+      return "Breaking Changes";
+    case "WIP":
+      return "Work In Progress";
+    default:
+      return "Misc.";
+  }
+}
+
+const template = stripIndents`
+  {%- macro link(repo, shortHash, hash) -%}
+    [\`{{ shortHash }}\`]({{repo}}/commit/{{ hash }})
+  {%- endmacro %}
+
+  {%- macro relatedIssues(issues) -%}
+    {%- for i in issues -%}
+    {{" "}}[#{{i.issue}}]({{i.url}})
+    {%- endfor -%}
+  {%- endmacro %}
+
+  {%- for release in releases %}
+    ## [{{ release.version }}] - {{ release.date }}
+    {% for package, groups in release.groups %}
+      ### {{ package }}
+
+      {% for type, commits in groups -%}
+        * {{ getTypeName(type) }}
+        {% for c in commits -%}
+        {{"   "}}* **{{ c.scope }}**: {{ c.subject }} {{link(repo, c.shortHash, c.hash)}}{{relatedIssues(c.relatedIssues)}}
+        {% endfor %}
+      {%- endfor %}
+    {%- endfor %}
+  {%- endfor %}
+`;
+
+function buildMarkdown(releases) {
+  return nunjucks.renderString(template, { releases, getTypeName, repo });
+}
+
+logStep = v => {
+  console.log(inspect(v, { depth: 7 }));
+  return v;
+};
+
+const changeLogTemplate = stripIndents`
+  # {{title}}
+
+  {{description}}
+  {{newVersion}}
+
+  {%- for version in oldVersions %}
+  ## {{version.title}}
+
+  {{version.body}}
+  {% endfor %}
+  {% for link in links -%}
+  [{{link.ref}}]: {{link.href}} "{{link.title}}"
+  {% endfor -%}
+`;
+
+function getReleases() {
+  return Promise.all([
+    getTags(),
+    getFirstCommit()
+  ]).then(([releases, firstCommit]) => {
+    if (releases.length === 0) {
+      return [];
+    }
+
+    releases.unshift(firstCommit);
+    releases.push("HEAD");
+    return releases;
+  });
+}
+
+function getChangelogData() {
+  return new Promise((resolve, reject) => {
+    parseChangelog("CHANGELOG.md", function(error, changelog) {
+      if (error) {
+        reject(error);
+        return;
+      }
+
+      resolve(changelog);
+    });
+  });
+}
+
+function filterReleases(releases) {
+  return releases.slice(-2);
+}
+
+getReleases()
+  .then(releases => filterReleases(releases))
+  .then(releases => pairReleases(releases))
+  .then(pairs =>
+    Promise.all(pairs.map(([from, to]) => getCommitData(from, to)))
+  )
+  .then(releaseData => processCommitMessages(releaseData))
+  .then(releaseData => findReleasedPackages(releaseData))
+  .then(releaseData => groupCommitsByPackage(releaseData))
+  .then(releaseData => buildMarkdown(releaseData))
+  .then(newVersion => {
+    return Promise.all([
+      getReleases().then(pairReleases),
+      getChangelogData(),
+      Promise.resolve(newVersion)
+    ]);
+  })
+  .then(([pairs, changelog, newVersion]) => {
+    const links = pairs.map(([from, to]) => {
+      to = to === "HEAD" ? "v" + getPackageVersion() : to;
+      return {
+        ref: to.replace("v", ""),
+        title: to,
+        href: `${repo}/compare/${from}...${to}`
+      };
+    });
+
+    if (links.length) {
+      links.push({
+        ref: "HEAD",
+        title: "Unreleased Changes",
+        href: `${repo}/compare/${_.last(links).title}...HEAD`
+      });
+    }
+
+    const rendered = nunjucks.renderString(changeLogTemplate, {
+      title: changelog.title,
+      description: changelog.description,
+      oldVersions: changelog.versions,
+      newVersion: newVersion,
+      links,
+      repo
+    });
+
+    writeFile("CHANGELOG.md", rendered, function(e) {});
+  })
+  .catch(error => {
+    console.error(error.stack);
+  });

package/support/commit-template.txt

@@ -0,0 +1,19 @@
+# Replace `type` the type of chage you are making, `scope` with a single-word
+# general description of the files, classes or methods changed. Finally Replace
+# `message` with your normal commit message.
+type(scope): message
+
+# Add an additional description (otpional) below this line
+
+# If ou change will affect any Lerna packages uncomment the `AFFECTED PACKAGES:`
+# line below and list the packages, one per line, by package name.
+# AFFECTED PACKAGES:
+
+# If your commit makes any breaking changes, uncomment the `BREAKING CHANGES:`
+# line below and add a description of any breaking changes after it.
+# BREAKING CHANGES:
+
+# If your commit resolves, closes or references any issues uncomment the
+# `ISSUES CLOSED:` line below and add issue number one the same line comma
+# seperated like #31,#32
+# ISSUES CLOSED:

package/support/deploy-doc-site.js

@@ -0,0 +1,16 @@
+const ghpages = require("gh-pages");
+
+ghpages.publish(
+  "docs/build",
+  {
+    branch: "gh-pages",
+    repo: "https://github.com/Esri/arcgis-rest-js.git"
+  },
+  function(err) {
+    if (err) {
+      console.log("uh oh", err);
+    } else {
+      console.log("Deployed docs site!");
+    }
+  }
+);