feat: add torrent download from url (#102)

Author: scttcper

Diff for: package-lock.json

@@ -21,29 +21,29 @@
     "lint:fix": "eslint --fix --ext .js,.ts, .",
     "prepare": "npm run build",
     "build": "tsc -p tsconfig.build.json",
-    "build:docs": "typedoc --out docs --hideGenerator --target ES6 --mode file src && touch docs/.nojekyll",
+    "build:docs": "typedoc",
     "test": "jest --runInBand",
     "test:watch": "jest --watch --runInBand",
     "test:ci": "jest --runInBand --coverage --no-cache"
   },
   "dependencies": {
     "@ctrl/shared-torrent": "^3.0.4",
-    "@ctrl/url-join": "^1.0.2",
-    "form-data": "^3.0.0",
-    "got": "^11.8.1",
+    "@ctrl/url-join": "^1.0.4",
+    "form-data": "^4.0.0",
+    "got": "^11.8.2",
     "tough-cookie": "^4.0.0"
   },
   "devDependencies": {
-    "@babel/plugin-transform-modules-commonjs": "7.12.1",
-    "@babel/preset-typescript": "7.12.7",
-    "@ctrl/eslint-config": "1.2.8",
+    "@babel/plugin-transform-modules-commonjs": "7.13.8",
+    "@babel/preset-typescript": "7.13.0",
+    "@ctrl/eslint-config": "1.3.4",
     "@jest/globals": "26.6.2",
-    "@types/node": "14.14.13",
+    "@types/node": "14.14.41",
     "@types/tough-cookie": "4.0.0",
     "jest": "26.6.3",
-    "p-wait-for": "3.1.0",
-    "typedoc": "0.19.2",
-    "typescript": "4.1.3"
+    "p-wait-for": "3.2.0",
+    "typedoc": "0.20.35",
+    "typescript": "4.2.4"
   },
   "jest": {
     "testEnvironment": "node"

Diff for: package.json

@@ -1,3 +1,3 @@
 {
-  "extends": ["github>scttcper/renovate-config"]
+  "enabled": false
 }

Diff for: renovate.json

@@ -233,6 +233,22 @@ export class Deluge implements TorrentClient {
     return JSON.parse(res.body) as UploadResponse;
   }
 
+  /**
+   * Download a torrent from url, pass the result to {@link Deluge.addTorrent}
+   * @param url
+   * @param cookies
+   * @returns file path
+   */
+  async downloadFromUrl(url: string, cookies = ''): Promise<string> {
+    const res = await this.request<StringStatus>('web.download_torrent_from_url', [url, cookies]);
+
+    if (!res.body.result) {
+      throw new Error('Failed to download torrent');
+    }
+
+    return res.body.result;
+  }
+
   async addTorrent(
     torrent: string | Buffer,
     config: Partial<AddTorrentOptions> = {},

Diff for: src/index.ts

@@ -308,4 +308,21 @@ describe('Deluge', () => {
     expect(torrent.totalUploaded).toBeGreaterThanOrEqual(0);
     expect(torrent.uploadSpeed).toBeGreaterThanOrEqual(0);
   }, 15000);
+  it('should download from url', async () => {
+    const client = new Deluge({ baseUrl });
+    const result = await client.downloadFromUrl(
+      'https://releases.ubuntu.com/20.10/ubuntu-20.10-desktop-amd64.iso.torrent',
+    );
+    expect(result).toContain('/tmp/');
+    await client.addTorrent(torrentFile, { add_paused: true });
+    await pWaitFor(
+      async () => {
+        const r = await client.listTorrents();
+        return Object.keys(r.result.torrents).length === 1;
+      },
+      { timeout: 10000 },
+    );
+    const res = await client.listTorrents();
+    expect(Object.keys(res.result.torrents)).toHaveLength(1);
+  }, 15000);
 });

Diff for: test/index.spec.ts

@@ -0,0 +1,8 @@
+{
+  "entryPoints": ["src/index.ts"],
+  "tsconfig": "tsconfig.build.json",
+  "out": "docs",
+  "excludePrivate": true,
+  "excludeProtected": true,
+  "hideGenerator": true
+}