update: added graphql endpoint

Author: jb-1980

.prettierrc

@@ -0,0 +1,7 @@
+{
+  "trailingComma": "es5",
+  "tabWidth": 2,
+  "semi": false,
+  "singleQuote": false,
+  "useTabs": false
+}

index.js

@@ -2,10 +2,13 @@ const { KhanOauth, KhanAPIWrapper } = require("./lib/api-base")
 const { KhanAPIWrapperV1Mixin } = require("./lib/api-v1")
 const { KhanAPIWrapperV2Mixin } = require("./lib/api-v2")
 const { KhanAPIWrapperInternalMixin } = require("./lib/api-internal")
+const { KhanAPIWrapperGraphQLMixin } = require("./lib/api-graphql")
 
 // combining all the methods across the different api versions.
-class _KhanAPIWrapper extends KhanAPIWrapperInternalMixin(
-  KhanAPIWrapperV2Mixin(KhanAPIWrapperV1Mixin(KhanAPIWrapper))
+class _KhanAPIWrapper extends KhanAPIWrapperGraphQLMixin(
+  KhanAPIWrapperInternalMixin(
+    KhanAPIWrapperV2Mixin(KhanAPIWrapperV1Mixin(KhanAPIWrapper))
+  )
 ) {}
 
 module.exports = { KhanOauth, KhanAPIWrapper: _KhanAPIWrapper }

lib/_tests_/api-graphql.test.js

@@ -0,0 +1,80 @@
+require("dotenv").config()
+const fs = require("fs")
+const { promisify } = require("util")
+const readAsync = promisify(fs.readFile)
+const writeAsync = promisify(fs.writeFile)
+const { KhanAPIWrapper, KhanOauth } = require("../../index")
+
+const {
+  KHAN_PASSWORD,
+  KHAN_IDENTIFIER,
+  KHAN_CONSUMER_SECRET,
+  KHAN_CONSUMER_KEY,
+  TEST_KHAN_COURSEID,
+} = process.env
+
+const fetchAccessToken = async () => {
+  const kauth = new KhanOauth(
+    KHAN_CONSUMER_KEY,
+    KHAN_CONSUMER_SECRET,
+    KHAN_IDENTIFIER,
+    KHAN_PASSWORD
+  )
+
+  const [token, secret] = await kauth.authorizeSelf()
+
+  return await writeAsync(
+    "tokens.json",
+    JSON.stringify({
+      token,
+      secret,
+      timestamp: new Date().getTime(),
+    }),
+    { encoding: "utf8" }
+  )
+    .then(() => [token, secret])
+    .catch(err => {
+      throw err
+    })
+}
+
+// Check if our cached token is valid. If so, return it, otherwise fetch a new one.
+const getAccessToken = async () => {
+  return await readAsync("tokens.json", { encoding: "utf8" })
+    .then(jsonString => JSON.parse(jsonString))
+    .then(({ token, secret, timestamp }) => {
+      const now = new Date().getTime()
+      if (now - timestamp > 24 * 3600 * 1000) {
+        return fetchAccessToken()
+      }
+
+      return [token, secret]
+    })
+    .catch(err => {
+      if (err.code === "ENOENT") {
+        // file not found, which should happen the first time
+        return fetchAccessToken()
+      }
+
+      throw err
+    })
+}
+
+jest.setTimeout(60000)
+
+test("graphql progressByStudent endpoint works", async () => {
+  const [token, secret] = await getAccessToken()
+  const kapi = new KhanAPIWrapper(
+    KHAN_CONSUMER_KEY,
+    KHAN_CONSUMER_SECRET,
+    token,
+    secret
+  )
+  const progressByStudent = await kapi.graphqlProgressByStudent(
+    TEST_KHAN_COURSEID
+  )
+
+  console.log({ progressByStudent })
+  expect(progressByStudent.errors).toBeNull()
+  expect(progressByStudent.data).toBeTruthy()
+})

lib/_tests_/api-internal.test.js

@@ -65,7 +65,7 @@ const getAccessToken = async () => {
 
 jest.setTimeout(60000)
 
-test("/api/internal/user/missions endpoint works", async () => {
+test.skip("/api/internal/user/missions endpoint works", async () => {
   const [token, secret] = await getAccessToken()
   const kapi = new KhanAPIWrapper(
     KHAN_CONSUMER_KEY,

lib/api-base.js

@@ -177,7 +177,7 @@ class KhanAPIWrapper {
 
       case "POST": {
         const config = { params: needsAuth ? oauth_params : params }
-        const res = await axios.post(url, data, config)
+        const res = await axios.post(url, data, config).then(res => res.data)
         return res
       }
 

lib/api-graphql.js

@@ -0,0 +1,83 @@
+const { KhanAPIWrapper } = require("./api-base")
+
+const KhanAPIWrapperGraphQLMixin = SuperClass =>
+  class extends SuperClass {
+    /* These are endpoints that go with /api/internal. They are currently
+     * undocumented, so any contributions and documentation are welcome.
+     */
+
+    async graphqlProgressByStudent(classId) {
+      const payload = {
+        query: `query ProgressByStudent($assignmentFilters: CoachAssignmentFilters, $contentKinds: [LearnableContentKind], $classId: String!, $pageSize: Int, $after: ID) {
+  coach {
+    id
+    studentList(id: $classId) {
+      id
+      cacheId
+      studentKaidsAndNicknames {
+        id
+        coachNickname
+        __typename
+      }
+      assignmentsPage(filters: $assignmentFilters, after: $after, pageSize: $pageSize) {
+        assignments(contentKinds: $contentKinds) {
+          id
+          dueDate
+          contents {
+            id
+            translatedTitle
+            kind
+            defaultUrlPath
+            __typename
+          }
+          itemCompletionStates {
+            completedOn
+            studentKaid
+            bestScore {
+              numAttempted
+              numCorrect
+              __typename
+            }
+            __typename
+          }
+          __typename
+        }
+        pageInfo {
+          nextCursor
+          __typename
+        }
+        __typename
+      }
+      __typename
+    }
+    __typename
+  }
+}
+`,
+        variables: {
+          classId,
+          assignmentFilters: {
+            dueAfter: null,
+            dueBefore: null,
+          },
+          contentKinds: null,
+          after: null,
+          pageSize: 1000,
+        },
+        operationName: "ProgressByStudent",
+      }
+
+      return await this.fetchResource(
+        "/api/internal/graphql",
+        true,
+        "POST",
+        null,
+        payload
+      )
+    }
+  }
+
+module.exports = {
+  KhanAPIWrapperGraphQLMixin,
+  KhanAPIWrapperGraphQL: KhanAPIWrapperGraphQLMixin(KhanAPIWrapper),
+}

lib/api-internal.js

@@ -6,6 +6,7 @@ const KhanAPIWrapperInternalMixin = SuperClass =>
      * undocumented, so any contributions and documentation are welcome.
      */
 
+    // endpoint no longer works ☹️
     async internalUserMissions() {
       ;`Retrieve data about the user missions
         `

package.json

@@ -9,7 +9,8 @@
   "private": false,
   "scripts": {
     "test": "jest",
-    "test-dev": "jest --watch"
+    "test-dev": "jest --watch",
+    "test-one": "jest ./examples/_tests_/api-graphql.test.js"
   },
   "dependencies": {
     "axios": "^0.19.0",