canvaslms-cli 1.1.0

package/lib/file-upload.js

@@ -0,0 +1,78 @@
+/**
+ * File upload utilities for Canvas
+ */
+
+const fs = require('fs');
+const axios = require('axios');
+const FormData = require('form-data');
+const { makeCanvasRequest } = require('./api-client');
+
+/**
+ * Upload single file to Canvas and return the file ID
+ */
+async function uploadSingleFileToCanvas(courseId, assignmentId, filePath) {
+  try {
+    // Check if file exists
+    if (!fs.existsSync(filePath)) {
+      throw new Error(`File not found: ${filePath}`);
+    }
+
+    const fileName = require('path').basename(filePath);
+    const fileContent = fs.readFileSync(filePath);
+    
+    // Step 1: Get upload URL from Canvas
+    const uploadParams = [
+      `name=${encodeURIComponent(fileName)}`,
+      `size=${fileContent.length}`,
+      'parent_folder_path=/assignments'
+    ];
+    
+    const uploadData = await makeCanvasRequest('post', `courses/${courseId}/assignments/${assignmentId}/submissions/self/files`, uploadParams);
+    
+    if (!uploadData.upload_url) {
+      throw new Error('Failed to get upload URL from Canvas');
+    }
+
+    // Step 2: Upload file to the provided URL
+    const form = new FormData();
+    
+    // Add all the required fields from Canvas response
+    Object.keys(uploadData.upload_params).forEach(key => {
+      form.append(key, uploadData.upload_params[key]);
+    });
+    
+    // Add the file
+    form.append('file', fileContent, fileName);
+
+    const uploadResponse = await axios.post(uploadData.upload_url, form, {
+      headers: form.getHeaders(),
+      maxRedirects: 0,
+      validateStatus: (status) => status < 400
+    });
+
+    // Return the file ID for later submission
+    return uploadData.id || uploadResponse.data.id;
+    
+  } catch (error) {
+    throw new Error(`Failed to upload file ${filePath}: ${error.message}`);
+  }
+}
+
+/**
+ * Submit assignment with uploaded files
+ */
+async function submitAssignmentWithFiles(courseId, assignmentId, fileIds) {
+  const submissionData = {
+    submission: {
+      submission_type: 'online_upload',
+      file_ids: fileIds
+    }
+  };
+
+  return await makeCanvasRequest('post', `courses/${courseId}/assignments/${assignmentId}/submissions`, [], JSON.stringify(submissionData));
+}
+
+module.exports = {
+  uploadSingleFileToCanvas,
+  submitAssignmentWithFiles
+};

package/lib/interactive.js

@@ -0,0 +1,31 @@
+/**
+ * Interactive prompt utilities
+ */
+
+const readline = require('readline');
+
+/**
+ * Create readline interface for user input
+ */
+function createReadlineInterface() {
+  return readline.createInterface({
+    input: process.stdin,
+    output: process.stdout
+  });
+}
+
+/**
+ * Prompt user for input
+ */
+function askQuestion(rl, question) {
+  return new Promise((resolve) => {
+    rl.question(question, (answer) => {
+      resolve(answer.trim());
+    });
+  });
+}
+
+module.exports = {
+  createReadlineInterface,
+  askQuestion
+};

package/package.json

@@ -0,0 +1,67 @@
+{
+  "name": "canvaslms-cli",
+  "version": "1.1.0",
+  "description": "A command line tool for interacting with Canvas LMS API",
+  "keywords": [
+    "canvas",
+    "cli",
+    "api",
+    "instructure",
+    "lms",
+    "education",
+    "canvas-lms"
+  ],
+  "homepage": "https://github.com/caphefalumi/Canvas-CLI#readme",
+  "bugs": {
+    "url": "https://github.com/caphefalumi/Canvas-CLI/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/caphefalumi/Canvas-CLI.git"
+  },
+  "license": "MIT",
+  "author": {
+    "name": "Your Name",
+    "email": "your.email@example.com"
+  },
+  "type": "commonjs",
+  "main": "src/index.js",
+  "bin": {
+    "canvas": "src/index.js"
+  },
+  "files": [
+    "src/",
+    "lib/",
+    "commands/",
+    "README.md",
+    "CHANGELOG.md"
+  ],
+  "scripts": {
+    "start": "node src/index.js",
+    "dev": "node src/index.js",
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "lint": "echo \"Add linting here\"",
+    "format": "echo \"Add formatting here\"",
+    "setup": "powershell -ExecutionPolicy Bypass -File setup.ps1",
+    "postinstall": "echo \"Canvas CLI installed successfully! Run 'canvas config' to get started.\""
+  },
+  "dependencies": {
+    "axios": "^1.6.0",
+    "commander": "^11.1.0",
+    "form-data": "^4.0.3"
+  },
+  "devDependencies": {
+    "eslint": "^8.0.0",
+    "prettier": "^3.0.0"
+  },
+  "engines": {
+    "node": ">=14.0.0",
+    "npm": ">=6.0.0"
+  },
+  "preferGlobal": true,
+  "os": [
+    "win32",
+    "darwin",
+    "linux"
+  ]
+}

package/src/index.js

@@ -0,0 +1,142 @@
+#!/usr/bin/env node
+
+/**
+ * Canvas CLI - A command line tool for interacting with Canvas API
+ * 
+ * @author Canvas CLI Team
+ * @version 1.0.0
+ */
+
+const { Command } = require('commander');
+
+// Import command handlers
+const { listCourses } = require('../commands/list');
+const { showConfig, setupConfig, editConfig, showConfigPath, deleteConfigFile } = require('../commands/config');
+const { listAssignments } = require('../commands/assignments');
+const { showGrades } = require('../commands/grades');
+const { showAnnouncements } = require('../commands/announcements');
+const { showProfile } = require('../commands/profile');
+const { submitAssignment } = require('../commands/submit');
+const { createQueryHandler } = require('../commands/api');
+const { requireConfig } = require('../lib/config-validator');
+
+const program = new Command();
+
+// Setup CLI program
+program
+  .name('canvas')
+  .description('Canvas API Command Line Tool')
+  .version('1.1.0');
+
+// Raw API commands
+function createQueryCommand(method) {
+  return program
+    .command(method)
+    .alias(method === 'query' ? 'q' : method.charAt(0))
+    .argument('<endpoint>', 'Canvas API endpoint to query')
+    .option('-q, --query <param>', 'Query parameter (can be used multiple times)', [])
+    .option('-d, --data <data>', 'Request body (JSON string or @filename)')
+    .description(`${method.toUpperCase()} request to Canvas API`)
+    .action(requireConfig(createQueryHandler(method)));
+}
+
+// Create raw API commands
+createQueryCommand('get');
+createQueryCommand('post');
+createQueryCommand('put');
+createQueryCommand('delete');
+createQueryCommand('query');
+
+// List command to show enrolled courses
+program
+  .command('list')
+  .alias('l')
+  .description('List starred courses (default) or all courses with -a')
+  .option('-a, --all', 'Show all enrolled courses instead of just starred ones')
+  .option('-v, --verbose', 'Show detailed course information')
+  .action(requireConfig(listCourses));
+
+// Config command with subcommands
+const configCommand = program
+  .command('config')
+  .description('Manage Canvas CLI configuration')
+  .action(showConfig); // Default action when no subcommand is provided
+
+configCommand
+  .command('show')
+  .alias('status')
+  .description('Show current configuration')
+  .action(showConfig);
+
+configCommand
+  .command('setup')
+  .alias('init')
+  .description('Interactive configuration setup')
+  .action(setupConfig);
+
+configCommand
+  .command('edit')
+  .alias('update')
+  .description('Edit existing configuration')
+  .action(editConfig);
+
+configCommand
+  .command('path')
+  .description('Show configuration file path')
+  .action(showConfigPath);
+
+configCommand
+  .command('delete')
+  .alias('remove')
+  .description('Delete configuration file')
+  .action(deleteConfigFile);
+
+// Assignments command to show assignments for a course
+program
+  .command('assignments')
+  .alias('assign')
+  .description('List assignments for a specific course')
+  .argument('<course-id>', 'Course ID to get assignments from')
+  .option('-v, --verbose', 'Show detailed assignment information')
+  .option('-s, --submitted', 'Only show submitted assignments')
+  .option('-p, --pending', 'Only show pending assignments')
+  .action(requireConfig(listAssignments));
+
+// Grades command to show grades
+program
+  .command('grades')
+  .alias('grade')
+  .description('Show grades for all courses or a specific course')
+  .argument('[course-id]', 'Optional course ID to get grades for specific course')
+  .option('-v, --verbose', 'Show detailed grade information')
+  .action(requireConfig(showGrades));
+
+// Announcements command
+program
+  .command('announcements')
+  .alias('announce')
+  .description('Show recent announcements')
+  .argument('[course-id]', 'Optional course ID to get announcements for specific course')
+  .option('-l, --limit <number>', 'Number of announcements to show', '5')
+  .action(requireConfig(showAnnouncements));
+
+// Profile command
+program
+  .command('profile')
+  .alias('me')
+  .description('Show current user profile information')
+  .option('-v, --verbose', 'Show detailed profile information')
+  .action(requireConfig(showProfile));
+
+// Submit command for interactive assignment submission
+program
+  .command('submit')
+  .alias('sub')
+  .description('Interactively submit one or multiple files to an assignment')
+  .option('-c, --course <course-id>', 'Skip course selection and use specific course ID')
+  .option('-a, --assignment <assignment-id>', 'Skip assignment selection and use specific assignment ID')
+  .option('-f, --file <file-path>', 'Skip file selection and use specific file path')
+  .action(requireConfig(submitAssignment));
+
+// Parse command line arguments
+program.parse();