Merge pull request #16 from dubisdev/dubisdev/issue13

tests: add tests
fix: Task default name
closes #13

Author: dubisdev

.gitignore

@@ -1,2 +1,3 @@
 /node_modules
-/dist
+/dist
+.env

.npmignore

@@ -2,6 +2,7 @@
 /src
 /.github
 .gitignore
+.env
 
 # Config files
 /node_modules

jest.config.mjs

@@ -1,7 +1,5 @@
-/*
- * For a detailed explanation regarding each configuration property, visit:
- * https://jestjs.io/docs/configuration
- */
+import dotenv from "dotenv";
+dotenv.config();
 
 export default {
 	extensionsToTreatAsEsm: [".ts"],
@@ -14,7 +12,7 @@ export default {
 	moduleNameMapper: {
 		"^(\\.{1,2}/.*)\\.js$": "$1",
 	},
-	
+
 	preset: "ts-jest/presets/js-with-ts-esm",
 	rootDir: "src",
 };

package.json

@@ -12,10 +12,11 @@
     "rest-client"
   ],
   "dependencies": {
-    "axios": "^0.23.0"
+    "axios": "^0.24.0"
   },
   "devDependencies": {
     "@types/jest": "^27.0.2",
+    "dotenv": "^10.0.0",
     "jest": "^27.3.0",
     "ts-jest": "^27.0.7",
     "typescript": "^4.4.4"

src/TDSClient.ts

@@ -1,7 +1,7 @@
 import task from "./submodules/task";
 import project from "./submodules/project";
 
-const TDSClientConstructor = (apiToken = ""): TDSClient => {
+const TDSClientConstructor: ClientConstructor = (apiToken): TDSClient => {
 	if (!apiToken) throw new Error("Missing api token");
 
 	const headers = { Authorization: `Bearer ${apiToken}` };

src/__tests__/projects.tests.ts

@@ -0,0 +1,86 @@
+import TDSClient, { Project } from "..";
+
+const myClient = TDSClient(process.env.TODOIST_TOKEN);
+
+const generalExpectedProject = Project({
+	name: "P1",
+});
+let generalExpectedProjectID: number;
+
+describe("Client-Side Project Creation", () => {
+	test("Create Empty Project", () => {
+		const emptyProject = Project();
+		expect(emptyProject).toMatchObject<ClientCreatedProject>({
+			name: "_No_Project_Name_Provided_",
+		});
+	});
+
+	test("Create Normal Project", () => {
+		expect(generalExpectedProject).toMatchObject<ClientCreatedProject>({
+			name: "P1",
+		});
+	});
+});
+
+describe("API Project Functions", () => {
+	// 1 active project now (Inbox)
+
+	test("Create A Project", async () => {
+		// creates the project in the server
+
+		let apiProject = await myClient.project.create(generalExpectedProject);
+
+		expect(apiProject.id).toBeTruthy();
+
+		generalExpectedProjectID = apiProject.id;
+	});
+
+	test("Get A Project", async () => {
+		let apiProject = await myClient.project.get(generalExpectedProjectID);
+
+		expect(apiProject.name).toBe(generalExpectedProject.name);
+	});
+
+	// 2 active projects now
+	test("Create Two Projects", async () => {
+		await myClient.project.create({ name: "P2" });
+		await myClient.project.create({ name: "P3" });
+	});
+
+	// 4 active projects now
+	test("Get All Active Projects JSON", async () => {
+		const responseProjects = await myClient.project.getAllJSON();
+		const firstProjectExists = responseProjects.some(
+			(projectObj) => projectObj.name === "P1"
+		);
+		const secondProjectExists = responseProjects.some(
+			(projectObj) => projectObj.name === "P2"
+		);
+		const thirdProjectExists = responseProjects.some(
+			(projectObj) => projectObj.name === "P3"
+		);
+
+		expect(responseProjects.length).toBe(4);
+		expect(typeof responseProjects[0]).toBe("object");
+
+		expect(firstProjectExists).toBe(true);
+		expect(secondProjectExists).toBe(true);
+		expect(thirdProjectExists).toBe(true);
+	});
+
+	test("Get All Active Project Names", async () => {
+		const responseProjects = await myClient.project.getAll();
+		const firstProjectExists = responseProjects.some((name) => name === "P1");
+		const secondProjectExists = responseProjects.some((name) => name === "P2");
+		const thirdProjectExists = responseProjects.some((name) => name === "P3");
+
+		expect(responseProjects.length).toBe(4);
+		expect(typeof responseProjects[0]).toBe("string");
+
+		expect(firstProjectExists).toBe(true);
+		expect(secondProjectExists).toBe(true);
+		expect(thirdProjectExists).toBe(true);
+	});
+
+	// 4 active projects now (3 + inbox)
+});

src/__tests__/task.tests.ts

@@ -0,0 +1,135 @@
+import TDSClient, { Task } from "..";
+
+const myClient = TDSClient(process.env.TODOIST_TOKEN);
+
+const generalExpectedTask = Task({
+	content: "Hello world",
+});
+let generalExpectedTaskID: number;
+
+describe("Client-Side Task Creation", () => {
+	test("Create Empty Task", () => {
+		const emptyTask = Task();
+		expect(emptyTask).toMatchObject<ClientCreatedTask>({
+			content: "_No_Task_Name_Provided_",
+		});
+	});
+
+	test("Create Normal Task", () => {
+		expect(generalExpectedTask).toMatchObject<ClientCreatedTask>({
+			content: "Hello world",
+		});
+	});
+});
+
+describe("API Tasks Functions", () => {
+	test("Create A Task", async () => {
+		// creates the task in the server
+
+		let apiTask = await myClient.task
+			.create(generalExpectedTask)
+			// @ts-ignore: Task.create should return APITaskObject
+			.then((res) => res.data as APITaskObject);
+
+		expect(apiTask.id).toBeTruthy();
+
+		//fix needed --> task.create should return an APITaskObject --> issue #15
+
+		/*
+        let apiTask = await myClient.task.create(generalExpectedTask);
+        expect(apiTask).toMatchObject<APITaskObject>({
+			...apiTask,
+			content: "Hello world",
+		});
+
+		save the task id for next tests
+		generalExpectedTaskID = apiTask.id;*/
+
+		//save the task id for next tests
+		generalExpectedTaskID = apiTask.id;
+	});
+
+	test("Get A Task", async () => {
+		let apiTask = await myClient.task.get(generalExpectedTaskID);
+
+		expect(apiTask.content).toBe(generalExpectedTask.content);
+	});
+
+	test("Close A Task", async () => {
+		let status = (await myClient.task.closeTask(generalExpectedTaskID)).status;
+
+		expect(status).toBe(204);
+	});
+
+	// no active tasks now
+	test("Create Two Tasks", async () => {
+		await myClient.task.create({ content: "First task" });
+		await myClient.task.create({ content: "Second task" });
+	});
+
+	test("Get All Active Tasks JSON", async () => {
+		const responseTasks = await myClient.task.getAllJSON();
+		const firstTaskExists = responseTasks.some(
+			(taskObj) => taskObj.content === "First task"
+		);
+		const secondTaskExists = responseTasks.some(
+			(taskObj) => taskObj.content === "Second task"
+		);
+
+		expect(responseTasks.length).toBe(2);
+
+		expect(firstTaskExists).toBe(true);
+		expect(secondTaskExists).toBe(true);
+	});
+
+	test("Get All Active Tasks Names", async () => {
+		const responseTasks = await myClient.task.getAll();
+		const firstTaskExists = responseTasks.some((name) => name === "First task");
+		const secondTaskExists = responseTasks.some(
+			(name) => name === "Second task"
+		);
+
+		expect(responseTasks.length).toBe(2);
+
+		expect(firstTaskExists).toBe(true);
+		expect(secondTaskExists).toBe(true);
+	});
+
+	test("Complete All Previous Tasks", async () => {
+		let allTasksJSON = await myClient.task.getAllJSON();
+
+		for (let i = 0; i < allTasksJSON.length; ++i) {
+			let status = (await myClient.task.closeTask(allTasksJSON[i].id)).status;
+			expect(status).toBe(204);
+		}
+	});
+
+	// no active tasks now
+	/* Not working now because of #19
+	test("Create Two Tasks For Today", async () => {
+		// create tasks in today inbox
+		const due_info = {
+			due_lang: "en",
+			due_string: "today",
+		};
+		await myClient.task.create({ content: "First task", ...due_info });
+		await myClient.task.create({ content: "Second task", ...due_info });
+
+		//get created tasks
+		let allTodayJSON = await myClient.task.getTodayJSON();
+		const firstTaskExists = allTodayJSON.some(
+			(taskObj) => taskObj.content === "First task"
+		);
+		const secondTaskExists = allTodayJSON.some(
+			(taskObj) => taskObj.content === "Second task"
+		);
+
+		console.log(allTodayJSON);
+
+		expect(allTodayJSON.length).toBe(2);
+		expect(typeof allTodayJSON[0]).toBe("object");
+		expect(firstTaskExists).toBe(true);
+		expect(secondTaskExists).toBe(true);
+	});
+	*/
+});

src/definitions/APIResponses.d.ts

@@ -36,3 +36,12 @@ declare interface APITaskObject {
 	parent_id: number;
 	url: string;
 }
+
+declare interface AxiosResponse<T = any, D = any> {
+	data: T;
+	status: number;
+	statusText: string;
+	headers: AxiosResponseHeaders;
+	config: AxiosRequestConfig<D>;
+	request?: any;
+}

src/definitions/Client.d.ts

@@ -3,3 +3,7 @@ declare interface TDSClient {
 	task: TaskModule;
 	project: ProjectModule;
 }
+
+declare interface ClientConstructor {
+	(apiToken?: string): TDSClient;
+}

src/definitions/Submodules.d.ts

@@ -11,7 +11,7 @@ declare interface TaskModule {
 	create: (
 		task?: UserCreatedTask | ClientCreatedTask
 	) => Promise<APITaskObject>;
-	closeTask: (id: number | string) => Promise<void>;
+	closeTask: (id: number | string) => Promise<AxiosResponse>;
 	getAll: () => Promise<string[]>;
 	getAllJSON: () => Promise<APITaskObject[]>;
 	getToday: () => Promise<string[]>;