Merge pull request #8 from camunda/create-zeebe-tutorial

draft zeebe api tutorial

Author: christinaausley

.env.example

@@ -30,6 +30,22 @@ OPTIMIZE_BASE_URL=fill-this-in
 ## This value will only change if you're not using SaaS.
 OPTIMIZE_AUDIENCE=optimize.camunda.io
 
+------------------------------------
+
+## Zeebe API tutorial
+
+## Capture these values from an API client created at the cluster level, with access to the Zeebe scope.
+### This value comes from the `ZEEBE_CLIENT_ID`.
+ZEEBE_CLIENT_ID=fill-this-in
+### This value comes from the `ZEEBE_CLIENT_SECRET`.
+ZEEBE_CLIENT_SECRET=fill-this-in
+### This value comes from the `ZEEBE_TOKEN_AUDIENCE`.
+ZEEBE_AUDIENCE=zeebe.camunda.io
+### This value comes from the `ZEEBE_REST_ADDRESS`.
+ZEEBE_BASE_URL=fill-this-in
+
+------------------------------------
+
 # Web Modeler API tutorial
 
 ## These values will only change if you're not using SaaS.
@@ -41,3 +57,4 @@ MODELER_CLIENT_ID=fill-this-in
 MODELER_CLIENT_SECRET=fill-this-in
 
 
+

cli.js

@@ -3,12 +3,13 @@ import "dotenv/config";
 
 import admin from "./administration.js";
 import optimize from "./optimize.js";
+import zeebe from "./zeebe.js";
 import modeler from "./modeler.js";
 
 // All API objects accessible to the CLI app are included here.
 //   The name of each property translates to an API object that can be called by the CLI.
 //   e.g. if we export a property named `admin`, you can run `npm run cli admin <action>`.
-const APIs = { admin, optimize, modeler };
+const APIs = { admin, optimize, zeebe, modeler };
 
 // Parse the arguments passed into the CLI, and direct a specific action to a specific API object.
 //   Example: `npm run cli administration list` will find the arguments `administration` and `list`,

completed/zeebe.js

@@ -0,0 +1,93 @@
+import axios from "axios";
+import { getAccessToken } from "../auth.js";
+
+const authorizationConfiguration = {
+  clientId: process.env.ZEEBE_CLIENT_ID,
+  clientSecret: process.env.ZEEBE_CLIENT_SECRET,
+  audience: process.env.ZEEBE_AUDIENCE
+};
+
+// An action that assigns a Zeebe user task.
+async function assignUser([userTaskKey, assignee]) {
+    // Every request needs an access token.
+    const accessToken = await getAccessToken(authorizationConfiguration);
+  
+    // These settings come from your .env file.
+    const zeebeApiUrl = process.env.ZEEBE_BASE_URL;
+  
+    // This is the API endpoint to assign a user task.
+    const url = `${zeebeApiUrl}/user-tasks/${userTaskKey}/assignment`;
+  
+    // Configure the API call.
+    const options = {
+      method: "POST",
+      url,
+      headers: {
+        Accept: "application/json",
+        Authorization: `Bearer ${accessToken}`
+      },
+      data: {
+        // The body contains information about the new assignment.
+        assignee: assignee
+      }
+    };
+  
+    try {
+      // Call the add endpoint.
+      const response = await axios(options);
+  
+      // Process the results from the API call.
+    if (response.status === 204) {
+      console.log(`User task assigned to ${assignee}.`);
+    } else {
+      // Emit an unexpected error message.
+      console.error("Unable to assign this user!");
+    }
+    } catch (error) {
+      // Emit an error from the server.
+      console.error(error.message);
+    }
+  }
+
+async function unassignUser([userTaskKey]) {
+  const accessToken = await getAccessToken(authorizationConfiguration);
+
+  const zeebeApiUrl = process.env.ZEEBE_BASE_URL;
+
+  const url = `${zeebeApiUrl}/user-tasks/${userTaskKey}/assignee`;
+
+  // Configure the API call.
+  const options = {
+    method: "DELETE",
+    url,
+    headers: {
+      Accept: "application/json",
+      Authorization: `Bearer ${accessToken}`
+    }
+  };
+
+  try {
+    // Call the delete endpoint.
+    const response = await axios(options);
+
+    // Process the results from the API call.
+    if (response.status === 204) {
+      console.log("User task has been unassigned!");
+    } else {
+      // Emit an unexpected error message.
+      console.error("Unable to unassign this user task!");
+    }
+  } catch (error) {
+    // Emit an error from the server.
+    console.error(error.message);
+  }
+}
+
+// These functions are aliased to specific command names for terseness.
+//   The name of each property translates to a method that can be called by the CLI.
+//   e.g. if we export a function named `assign`, you can run `npm run cli zeebe assign`.
+
+export default {
+  assign: assignUser,
+  unassign: unassignUser
+};

zeebe.js

@@ -0,0 +1,19 @@
+import axios from "axios";
+import { getAccessToken } from "./auth.js";
+
+async function assignUser([userTaskKey, assignee]) {
+    console.log(`User task assigned to ${assignee}.`);
+}
+
+async function unassignUser([userTaskKey]) {
+    console.log("User task has been unassigned!");
+}
+
+// These functions are aliased to specific command names for terseness.
+//   The name of each property translates to a method that can be called by the CLI.
+//   e.g. if we export a function named `assign`, you can run `npm run cli zeebe assign`.
+
+export default {
+    assign: assignUser,
+    unassign: unassignUser
+  };