Merge pull request #108 from popcorn-official/3.0.0

3.0.0

.babelrc

@@ -1,14 +1,49 @@
 {
-  "presets": [
-    "es2015"
-  ],
   "plugins": [
-    "transform-async-to-generator",
-    "transform-strict-mode", [
-      "transform-runtime", {
-        "polyfill": false,
-        "regenerator": true
-      }
-    ]
-  ]
+    "transform-class-properties",
+    "transform-export-extensions",
+    ["transform-object-rest-spread", {
+      "useBuiltIns": true
+    }],
+    "transform-strict-mode"
+  ],
+  "presets": ["flow"],
+  "env": {
+    "development": {
+      "presets": [
+        ["env", {
+          "targets": {
+            "node": "7.10.1"
+          }
+        }]
+      ]
+    },
+    "production": {
+      "plugins": [
+        "external-helpers",
+        "transform-class-properties"
+      ],
+      "presets": [
+        ["env", {
+          "targets": {
+            "node": "7.10.1"
+          },
+          "modules": false
+        }]
+      ]
+    },
+    "test": {
+      "plugins": [
+        "istanbul",
+        "transform-class-properties"
+      ],
+      "presets": [
+        ["env", {
+          "targets": {
+            "node": "7.10.1"
+          }
+        }]
+      ]
+    }
+  }
 }

.codeclimate.yml

@@ -0,0 +1,20 @@
+engines:
+  duplication:
+    enabled: true
+    config:
+      languages:
+       - javascript
+  eslint:
+    enabled: true
+  fixme:
+    enabled: true
+ratings:
+  paths:
+   - src/**.js
+   - test/**.js
+   - "**.js"
+exclude_paths:
+  - "build/**/*"
+  - "docs/**/*"
+  - "node_modules/**/*"
+  - "test/**/*"

.editorconfig

@@ -0,0 +1,15 @@
+root = true
+
+[*]
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+charset = utf-8
+
+[*.js]
+indent_style = space
+indent_size = 2
+
+[{package.json,*.yml,*.cjson}]
+indent_style = space
+indent_size = 2

.env.example

@@ -0,0 +1,44 @@
+# Example .env file. Please fill in the values.
+
+# API key for Fanart.
+FANART_KEY=
+
+# API key for Omdb.
+OMDB_KEY=
+
+# API key for Nyaa.
+NYAA_KEY=
+
+# API key for Tmdb.
+TMDB_KEY=
+
+# API key for Trakt.
+TRAKT_KEY=
+
+# API key for Tvdb.
+TVDB_KEY=
+
+# The base name of the MongoDB database.
+MONGO_DATABASE=
+
+# The URI to the MongoDB database.
+# Needs to be named like this because of GitLab CI.
+MONGO_URI=
+
+# The port of the MongoDB database.
+MONGO_PORT=
+
+# The username of the MongoDB database.
+MONGO_USER=
+
+# The password of the MongoDB database.
+MONGO_PASS=
+
+# The time between cronjobs.
+CRON_TIME=
+
+# The location of the temporary directory for the logs.
+TEMP_DIR=
+
+# The port the API wil be running on.
+PORT=

.esdoc.json

@@ -2,32 +2,51 @@
   "source": "./src",
   "destination": "./docs",
   "includes": [".js$"],
-  "excludes": ["(node_modules|build|docs|views|gulpfile*)"],
-  "access": ["public", "protected", "private"],
-  "autoPrivate": true,
-  "unexportIdentifier": false,
-  "undocumentIdentifier": true,
-  "builtinExternal": true,
-  "index": "./README.md",
+  "excludes": ["(node_modules|docs|coverage)"],
   "package": "./package.json",
-  "coverage": true,
-  "includeSource": true,
-  "test": {
-    "type": "mocha",
-    "source": "./test",
-    "includes": [".js$"]
-  },
-  "title": "Popcorn API",
   "plugins": [{
-    "name": "esdoc-es7-plugin"
-  }],
-  "manual": {
-    "changelog": ["./CHANGELOG.md"],
-    "example": ["./manual/example.md"],
-    "installation": ["./manual/installation.md"],
-    "overview": ["./manual/overview.md"],
-    "tutorial": ["./manual/tutorial.md"],
-    "usage": ["./manual/usage.md"]
-  },
-  "lint": true
+    "name": "esdoc-standard-plugin",
+    "option": {
+      "brand": {
+        "logo": "./logo.png",
+        "title": "popcorn-api",
+        "description": "Popcorn Time API is developed to make it easier for anyone to create their own version of Popcorn Time.",
+        "repository": "https://github.com/popcorn-official/popcorn-api",
+        "site": "https://popcorntime.sh",
+        "author": "https://twitter.com/popcorntimetv",
+        "image": "https://avatars2.githubusercontent.com/u/7267937"
+      },
+      "manual": {
+        "index": "./README.md",
+        "globalIndex": false,
+        "coverage": true,
+        "files": [
+          "./manual/overview.md",
+          "./manual/installation.md",
+          "./manual/usage.md",
+          "./manual/example.md",
+          "./manual/tutorial.md",
+          "./CHANGELOG.md",
+          "./CONTRIBUTING.md",
+          "./CODE_OF_CONDUCT.md"
+        ]
+      },
+      "test": {
+        "source": "./test/",
+        "interfaces": ["describe", "it", "context", "suite", "test"],
+        "includes": ["(spec|Spec|test|Test)\\.js$"],
+        "excludes": ["\\.config\\.js$"]
+      }
+    }
+  }, {
+    "name": "esdoc-ecmascript-proposal-plugin",
+    "option": {
+      "all": true
+    }
+  }, {
+    "name": "esdoc-flow-type-plugin",
+    "opton": {
+      "enable": true
+    }
+  }]
 }

.eslintrc.js

@@ -0,0 +1,6 @@
+module.exports = {
+  extends: 'vixo',
+  globals: {
+    logger: true
+  }
+}

.flowconfig

@@ -0,0 +1,22 @@
+[ignore]
+<PROJECT_ROOT>/build/.*
+<PROJECT_ROOT>/coverage/.*
+<PROJECT_ROOT>/docs/.*
+<PROJECT_ROOT>/flow-typed/.*
+<PROJECT_ROOT>/manual/.*
+<PROJECT_ROOT>/node_modules/.*
+<PROJECT_ROOT>/tmp/.*
+
+[include]
+./coverage.js
+./dredd.hooks.js/.*
+./src/.*
+./test/.*
+
+[libs]
+
+[options]
+experimental.const_params=true
+include_warnings=true
+munge_underscores=true
+suppress_comment= \\(.\\|\n\\)*\\flow-ignore

.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,17 @@
+## Expected Behavior
+
+
+## Actual Behavior
+
+
+## Steps to Reproduce the Problem
+
+  1.
+  1.
+  1.
+
+## Specifications
+
+  - Version:
+  - Platform:
+  - Subsystem:

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,7 @@
+Fixes #
+
+## Proposed Changes
+
+  -
+  -
+  -

.gitignore

@@ -14,6 +14,7 @@ lib-cov
 
 # Coverage directory used by tools like istanbul
 coverage
+.nyc_output
 
 # Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
 .grunt
@@ -28,8 +29,17 @@ build/Release
 # https://docs.npmjs.com/misc/faq#should-i-check-my-node-modules-folder-into-git
 node_modules
 
-# Generated files by popcorn-api.
+# Imported flow-typed
+flow-typed/npm/*
+
+# Temporary directory
 tmp
 
-# Transpiled ES5 code
+# Files generated by 'npm pack'
+*.tgz
+
+# Transpiled code
 build
+
+# dotevn
+.env

.nycrc

@@ -0,0 +1,10 @@
+{
+  "require": [
+    "babel-register"
+  ],
+  "include": [
+    "src"
+  ],
+  "sourceMap": false,
+  "instrument": false
+}