Merge pull request #36 from xapijs/issue-34

fixed #34 - stringify actor query param
xapijs · Aug 5, 2020 · 90ac626 · 90ac626
2 parents e3b06ff + 215f024
commit 90ac626
Show file tree

Hide file tree

Showing 5 changed files with 44 additions and 21 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/src/XAPI.spec.ts b/src/XAPI.spec.ts
@@ -167,6 +167,14 @@ describe("statement resource", () => {
         });
     });
 
+    test("can query for statements using the actor property", () => {
+        return xapi.getStatements({
+            agent: testAgent
+        }).then((result) => {
+            return expect(result.statements).toBeTruthy();
+        });
+    });
+
     test("can query a single statement using the limit property", () => {
         return xapi.getStatements({
             limit: 1

diff --git a/src/XAPI.ts b/src/XAPI.ts
@@ -1,4 +1,4 @@
-import { Resource, GetStatementQuery, GetVoidedStatementQuery, GetStatementsQuery, StatementsResponse } from "./interfaces/XAPI";
+import { Resource, GetStatementQuery, GetVoidedStatementQuery, GetStatementsQuery, StatementsResponse, RequestParams } from "./interfaces/XAPI";
 import { Statement, Actor, Agent, Person } from "./interfaces/Statement";
 import { About } from "./interfaces/About/About";
 import { AttachmentUsages, Resources, Verbs } from "./constants";
@@ -37,7 +37,7 @@ export default class XAPI {
   // Agents Resource
   public getAgent(agent: Agent): Promise<Person> {
     return this.request(Resources.AGENTS, {
-      agent: JSON.stringify(agent)
+      agent: agent
     });
   }
 
@@ -93,7 +93,7 @@ export default class XAPI {
   // State Resource
   public createState(agent: Agent, activityId: string, stateId: string, state: {[key: string]: any}, registration?: string): Promise<void> {
     return this.request(Resources.STATE, {
-      agent: JSON.stringify(agent),
+      agent: agent,
       activityId: activityId,
       stateId: stateId,
       ...(registration ? {
@@ -107,7 +107,7 @@ export default class XAPI {
 
   public setState(agent: Agent, activityId: string, stateId: string, state: {[key: string]: any}, registration?: string): Promise<void> {
     return this.request(Resources.STATE, {
-      agent: JSON.stringify(agent),
+      agent: agent,
       activityId: activityId,
       stateId: stateId,
       ...(registration ? {
@@ -121,7 +121,7 @@ export default class XAPI {
 
   public getStates(agent: Agent, activityId: string, registration?: string): Promise<string[]> {
     return this.request(Resources.STATE, {
-      agent: JSON.stringify(agent),
+      agent: agent,
       activityId: activityId,
       ...(registration ? {
         registration
@@ -131,7 +131,7 @@ export default class XAPI {
 
   public getState(agent: Agent, activityId: string, stateId: string, registration?: string): Promise<{[key: string]: any}> {
     return this.request(Resources.STATE, {
-      agent: JSON.stringify(agent),
+      agent: agent,
       activityId: activityId,
       stateId: stateId,
       ...(registration ? {
@@ -142,7 +142,7 @@ export default class XAPI {
 
   public deleteState(agent: Agent, activityId: string, stateId: string, registration?: string): Promise<void> {
     return this.request(Resources.STATE, {
-      agent: JSON.stringify(agent),
+      agent: agent,
       activityId: activityId,
       stateId: stateId,
       ...(registration ? {
@@ -155,7 +155,7 @@ export default class XAPI {
 
   public deleteStates(agent: Agent, activityId: string, registration?: string): Promise<void> {
     return this.request(Resources.STATE, {
-      agent: JSON.stringify(agent),
+      agent: agent,
       activityId: activityId,
       ...(registration ? {
         registration
@@ -211,7 +211,7 @@ export default class XAPI {
   // Agent Profile Resource
   public createAgentProfile(agent: Agent, profileId: string, profile: {[key: string]: any}): Promise<void> {
     return this.request(Resources.AGENT_PROFILE, {
-      agent: JSON.stringify(agent),
+      agent: agent,
       profileId: profileId
     }, {
       method: "POST",
@@ -221,7 +221,7 @@ export default class XAPI {
 
   public setAgentProfile(agent: Agent, profileId: string, profile: {[key: string]: any}): Promise<void> {
     return this.request(Resources.AGENT_PROFILE, {
-      agent: JSON.stringify(agent),
+      agent: agent,
       profileId: profileId
     }, {
       method: "PUT",
@@ -231,29 +231,28 @@ export default class XAPI {
 
   public getAgentProfiles(agent: Agent): Promise<string[]> {
     return this.request(Resources.AGENT_PROFILE, {
-      agent: JSON.stringify(agent)
+      agent: agent
     });
   }
 
   public getAgentProfile(agent: Agent, profileId: string): Promise<{[key: string]: any}> {
     return this.request(Resources.AGENT_PROFILE, {
-      agent: JSON.stringify(agent),
+      agent: agent,
       profileId: profileId
     });
   }
 
   public deleteAgentProfile(agent: Agent, profileId: string): Promise<void> {
     return this.request(Resources.AGENT_PROFILE, {
-      agent: JSON.stringify(agent),
+      agent: agent,
       profileId: profileId
     }, {
       method: "DELETE"
     });
   }
 
-  private request(resource: Resource, params: {[key: string]: any} = {}, init?: RequestInit | undefined): Promise<any> {
-    const queryString: string = Object.keys(params).map(key => key + "=" + encodeURIComponent(params[key])).join("&");
-    const url: RequestInfo = `${this.endpoint}${resource}${queryString ? "?" + queryString : ""}`;
+  private request(resource: Resource, params: RequestParams = {}, init?: RequestInit | undefined): Promise<any> {
+    const url = this.generateURL(resource, params);
     return fetch(url, {
       headers: this.headers,
       ...init
@@ -273,11 +272,10 @@ export default class XAPI {
     });
   }
 
-  private requestXMLHTTPRequest(resource: Resource, params: {[key: string]: any} = {}, initExtras?: RequestInit | undefined): Promise<any> {
+  private requestXMLHTTPRequest(resource: Resource, params: RequestParams = {}, initExtras?: RequestInit | undefined): Promise<any> {
     return new Promise((resolve, reject) => {
       const xmlRequest = new XMLHttpRequest();
-      const queryString: string = Object.keys(params).map(key => key + "=" + encodeURIComponent(params[key])).join("&");
-      const url: RequestInfo = `${this.endpoint}${resource}${queryString ? "?" + queryString : ""}`;
+      const url = this.generateURL(resource, params);
       xmlRequest.open(initExtras?.method || "GET", url, true);
       const headers = {
         ...this.headers,
@@ -305,4 +303,14 @@ export default class XAPI {
       xmlRequest.send(initExtras?.body);
     });
   }
+
+  private generateURL(resource: Resource, params: {[key: string]: any}): string {
+    const queryString = Object.keys(params).map(key => {
+      let val = key === "agent" ? JSON.stringify(params[key]) : params[key];
+      val = encodeURIComponent(val);
+      return `${key}=${val}`;
+    }).join("&");
+    const url: RequestInfo = `${this.endpoint}${resource}${queryString ? "?" + queryString : ""}`;
+    return url;
+  }
 }
diff --git a/src/interfaces/XAPI/RequestParams.ts b/src/interfaces/XAPI/RequestParams.ts
@@ -0,0 +1,6 @@
+import { Agent } from "../Statement";
+
+export interface RequestParams {
+  [key: string]: any;
+  agent?: Agent;
+}
diff --git a/src/interfaces/XAPI/index.ts b/src/interfaces/XAPI/index.ts
@@ -1,4 +1,5 @@
-export * from "./Resource";
 export * from "./GetStatementQuery";
 export * from "./GetStatementsQuery";
+export * from "./RequestParams";
+export * from "./Resource";
 export * from "./StatementsResponse";