yts - npm Package Compare versions

Comparing version 1.0.0 to 2.0.0

package.json

 {
   "name": "yts",
-  "version": "1.0.0",
-  "description": "a simple wrapper for the yts.re API",
-  "main": "lib/yts.js",
+  "version": "2.0.0",
+  "description": "Node.js promise-based library for interacting with the YTS YIFY movies API.",
+  "main": "src/index.js",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "test": "jest",
+    "lint": "eslint **/*.js",
+    "lint:fix": "eslint --fix **/*.js"
   },
-  "author": "Toota Toota",
-  "license": "MIT",
-  "dependencies": {
-    "request": "^2.53.0"
-  },
-  "directories": {
-    "example": "example"
-  },
-  "devDependencies": {},
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/toota-toota/yts.git"
-  },
   "keywords": [
-    "yts",
-    "yts.re",
-    "torrents",
     "movies",
     "torrent",
-    "rest",
-    "api",
-    "wrapper"
+    "YIFY",
+    "YTS"
   ],
-  "bugs": {
-    "url": "https://github.com/toota-toota/yts/issues"
+  "author": "Travis Horn (https://travishorn.com)",
+  "license": "MIT",
+  "devDependencies": {
+    "eslint": "^7.17.0",
+    "eslint-config-prettier": "^7.1.0",
+    "eslint-plugin-prettier": "^3.3.1",
+    "jest": "^26.6.3",
+    "prettier": "^2.2.1"
   },
-  "homepage": "https://github.com/toota-toota/yts"
+  "dependencies": {
+    "axios": "^0.21.1"
+  }
 }

README.md

@@ -1,33 +0,193 @@
-#yts
-A node wrapper module for the [yts.re](http://yts.re) [API]
+# YTS
 
-##Installing
-```javascript
-npm install yts
+Node.js promise-based library for interacting with the YTS YIFY movies API.
+
+## Installation
+
+Install via npm.
+
 ```
+npm i yts
+```
 
--------
+Require yts in your project.
 
+```
+const yts = require("yts");
+```
+
+## Usage
+
+### List movies
+
+List the 20 most recently added movies.
+
+```
+const main = async () => {
+  const res = await yts.listMovies();
+}
+```
+
+The result will look like this:
+
+```
+{
+  "movie_count": 25489,
+  "limit": 20,
+  "page_number": 1,
+  "movies": [
+    {
+      "id": 00000,
+      "url": "yts.mx URL",
+      "imdb_code": "tt0000000",
+      "title": "Movie Title",
+      "title_english": "Movie Title in English",
+      "title_long": "Movie Title (2021)",
+      "slug": "movie-title-2021",
+      "year": 2021,
+      "rating": 0,
+      "runtime": 0,
+      "genres": [
+        "Array of genre strings"
+      ],
+      "summary": "Movie summary",
+      "description_full": "Movie description",
+      "synopsis": "Movie synopsis",
+      "yt_trailer_code": "YouTube video ID for trailer",
+      "language": "en",
+      "mpa_rating": "",
+      "background_image": "yts.mx URL for background image JPG",
+      "background_image_original": "yts.mx URL for background image JPG",
+      "small_cover_image": "yts.mx URL for cover image JPG",
+      "medium_cover_image": "yts.mx URL for cover image JPG",
+      "large_cover_image": "yts.mx URL for cover image JPG",
+      "state": "ok",
+      "torrents": [
+        {
+          "url": "yts.mx torrent URL",
+          "hash": "torrent hash",
+          "quality": "720p",
+          "type": "web",
+          "seeds": 0,
+          "peers": 0,
+          "size": "1.00 MB",
+          "size_bytes": 1000000,
+          "date_uploaded": "2021-01-14 13:29:52",
+          "date_uploaded_unix": 1610627392,
+          "magnet_url: "magnet:url for torrent"
+        },{
+          // Possibly more torrent files for various qualities
+        }
+      ],
+      "date_uploaded": "2021-01-14 13:29:52",
+      "date_uploaded_unix": 1610627392
+    },
+    {
+      // More movies
+    }
+  ]
+}
+```
+
+#### Narrow the list with parameters
+
+```
+const main = async () => {
+  const res = await yts.listMovies({ limit: 10, query_term: "Avengers" });
+}
+```
+
+There are other parameters to use with `listMovies()`. Full documentation can be found at https://yts.mx/api#list_movies
+
+### Get movie details
+
+First get the movie's YTS ID. You might get this from `listMovies()`. Then call `movieDetails()`.
+
+```
+const main = async () => {
+  const res = await yts.movieDetails({ movie_id: 0000 });
+}
+```
+
+The result will look like this:
+
+```
+{
+  "movie": {
+    "id": 0000,
+    "url": "yts.mx URL",
+    "imdb_code": "tt0000000",
+    "title": "Movie Title",
+    "title_english": "Movie Title in English",
+    "title_long": "Movie Title (2021)",
+    "slug": "movie-title-2021",
+    "year": 2021,
+    "rating": 0,
+    "runtime": 0,
+    "genres": [
+      "Array of genre strings"
+    ],
+    "download_count": 0,
+    "like_count": 0,
+    "description_intro": "First part of description",
+    "description_full": "Full description of movie",
+    "yt_trailer_code": "YouTube video ID for trailer",
+    "language": "en",
+    "mpa_rating": "",
+    "background_image": "yts.mx JPG URL",
+    "background_image_original": "yts.mx JPG URL",
+    "small_cover_image": "yts.mx JPG URL",
+    "medium_cover_image": "yts.mx JPG URL",
+    "large_cover_image": "yts.mx JPG URL",
+    "torrents": [
+      {
+        "url": "yts.mx torrent URL",
+          "hash": "torrent hash",
+          "quality": "720p",
+          "type": "web",
+          "seeds": 0,
+          "peers": 0,
+          "size": "1.00 MB",
+          "size_bytes": 1000000,
+          "date_uploaded": "2021-01-14 13:29:52",
+          "date_uploaded_unix": 1610627392,
+          "magnet_url: "magnet:url for torrent"
+      },
+      {
+        // Possibly more torrent files for various qualities
+      },
+    ],
+    "date_uploaded": "2021-01-14 13:29:52",
+    "date_uploaded_unix": 1610627392
+  }
+}
+```
+
+## Tests
+
+Full tests are available for this library and the YTS API.
+
+```
+npm test
+```
+
+Note that this will invoke quite a few simultaneous HTTP requests to the YTS API.
+
+## To Do
+
+- Comments, parental guides, reviews, upcoming movie list, and user details: These features are described in the YTS API documentation. However, they either return 404s or messages stating that they will be reublished soon.
+- Getting a user key (logging a user in), registering user, issuing forgot password email, resetting a password: These features require an application key which is only provided by contacting them
+- Getting a user profile: requires a user key which is only available by using the API to get a user key (see bullet point above)
+- Editing user settings, liking a movie, adding/getting/deleting bookmarks, making/liking/reporting/deleting comments, and making requests: These features require an application key and a user key
+
 ## License
 
-(The MIT License)
+The MIT License
 
-Copyright (c) by Toota Toota <dontbother@interwebz>
+Copyright 2021 Travis Horn
 
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

New alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

No bug tracker

Maintenance

Package does not have a linked bug tracker in package.json.

Found 1 instance in 1 package

No repository

Supply chain risk

Package does not have a linked source code repository. Without this field, a package will have no reference to the location of the source code use to generate the package.

Found 1 instance in 1 package

No website

Quality

Package does not have a website.

Found 1 instance in 1 package

Fixed alerts

No tests

Quality

Package does not have any tests. This is a strong signal of a poorly maintained or low quality package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

22827

increased by348.82%

Number of package files

14

increased by133.33%

Lines of code

407

increased by917.5%

Number of lines in readme file

194

increased by487.88%

Worsened metrics

Dev dependency count

5

increased byInfinity%

Number of low maintenance alerts

1

increased byInfinity%

Number of low supply chain risk alerts

1

increased byInfinity%

Number of medium supply chain risk alerts

2

increased byInfinity%

Dependency changes

• + Addedaxios@^0.21.1

• + Addedaxios@0.21.4(transitive)

• + Addedfollow-redirects@1.15.6(transitive)

• - Removedrequest@^2.53.0

• - Removedajv@6.12.6(transitive)

• - Removedasn1@0.2.6(transitive)

• - Removedassert-plus@1.0.0(transitive)

• - Removedasynckit@0.4.0(transitive)

• - Removedaws-sign2@0.7.0(transitive)

• - Removedaws4@1.12.0(transitive)

• - Removedbcrypt-pbkdf@1.0.2(transitive)

• - Removedcaseless@0.12.0(transitive)

• - Removedcombined-stream@1.0.8(transitive)

• - Removedcore-util-is@1.0.2(transitive)

• - Removeddashdash@1.14.1(transitive)

• - Removeddelayed-stream@1.0.0(transitive)

• - Removedecc-jsbn@0.1.2(transitive)

• - Removedextend@3.0.2(transitive)

• - Removedextsprintf@1.3.0(transitive)

• - Removedfast-deep-equal@3.1.3(transitive)

• - Removedfast-json-stable-stringify@2.1.0(transitive)

• - Removedforever-agent@0.6.1(transitive)

• - Removedform-data@2.3.3(transitive)

• - Removedgetpass@0.1.7(transitive)

• - Removedhar-schema@2.0.0(transitive)

• - Removedhar-validator@5.1.5(transitive)

• - Removedhttp-signature@1.2.0(transitive)

• - Removedis-typedarray@1.0.0(transitive)

• - Removedisstream@0.1.2(transitive)

• - Removedjsbn@0.1.1(transitive)

• - Removedjson-schema@0.4.0(transitive)

• - Removedjson-schema-traverse@0.4.1(transitive)

• - Removedjson-stringify-safe@5.0.1(transitive)

• - Removedjsprim@1.4.2(transitive)

• - Removedmime-db@1.52.0(transitive)

• - Removedmime-types@2.1.35(transitive)

• - Removedoauth-sign@0.9.0(transitive)

• - Removedperformance-now@2.1.0(transitive)

• - Removedpsl@1.9.0(transitive)

• - Removedpunycode@2.3.1(transitive)

• - Removedqs@6.5.3(transitive)

• - Removedrequest@2.88.2(transitive)

• - Removedsafe-buffer@5.2.1(transitive)

• - Removedsafer-buffer@2.1.2(transitive)

• - Removedsshpk@1.18.0(transitive)

• - Removedtough-cookie@2.5.0(transitive)

• - Removedtunnel-agent@0.6.0(transitive)

• - Removedtweetnacl@0.14.5(transitive)

• - Removeduri-js@4.4.1(transitive)

• - Removeduuid@3.4.0(transitive)

• - Removedverror@1.10.0(transitive)