Include coverage for Parse Server Example (#386)

* new: coverage example

* update error code

* include prettier

* add watch

* Update README.md

* Update ci.yml

* Revert "Update ci.yml"

This reverts commit fd797ea.

* Update main.js

* Update main.js

* Update package.json

* Update README.md

* Update README.md

* Update README.md

* Update README.md

restructured README

* Update README.md

added ToC heading

Co-authored-by: Manuel Trezza <[email protected]>

Author: dblythy

.gitignore

@@ -12,6 +12,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

.nycrc

@@ -0,0 +1,10 @@
+{
+  "reporter": [
+    "lcov",
+    "text-summary"
+  ],
+  "exclude": [
+    "**/spec/**"
+  ]
+}
+

.prettierrc

@@ -0,0 +1,5 @@
+semi: true
+trailingComma: "es5"
+singleQuote: true
+arrowParens: "avoid"
+printWidth: 100

README.md

@@ -1,16 +1,33 @@
-# parse-server-example
+# parse-server-example <!-- omit in toc -->
 
 [![Join The Conversation](https://img.shields.io/discourse/https/community.parseplatform.org/topics.svg)](https://community.parseplatform.org/c/parse-server)
 [![Backers on Open Collective](https://opencollective.com/parse-server/tiers/backers/badge.svg)][open-collective-link]
 [![Sponsors on Open Collective](https://opencollective.com/parse-server/tiers/sponsors/badge.svg)][open-collective-link]
 [![License][license-svg]][license-link]
 [![Twitter Follow](https://img.shields.io/twitter/follow/ParsePlatform.svg?label=Follow%20us%20on%20Twitter&style=social)](https://twitter.com/intent/follow?screen_name=ParsePlatform)
 
-Example project using the [parse-server](https://github.com/ParsePlatform/parse-server) module on Express.
-
-Read the full Parse Server guide here: https://github.com/ParsePlatform/parse-server/wiki/Parse-Server-Guide
-
-### For Local Development
+Example project using the [parse-server](https://github.com/ParsePlatform/parse-server) module on Express. Read the full [Parse Server Guide](https://docs.parseplatform.org/parse-server/guide/) for more information.
+
+# Table of Contents <!-- omit in toc -->
+
+- [Local Development](#local-development)
+  - [Helpful Scripts](#helpful-scripts)
+- [Remote Deployment](#remote-deployment)
+  - [Heroku](#heroku)
+  - [AWS Elastic Beanstalk](#aws-elastic-beanstalk)
+  - [Microsoft Azure App Service](#microsoft-azure-app-service)
+  - [Google App Engine](#google-app-engine)
+  - [Scalingo](#scalingo)
+  - [OpenShift Online (Next Gen)](#openshift-online-next-gen)
+- [Using Parse Server](#using-parse-server)
+  - [Health Check](#health-check)
+  - [APIs and SDKs](#apis-and-sdks)
+    - [REST API](#rest-api)
+    - [JavaScript](#javascript)
+    - [Android](#android)
+    - [iOS / tvOS / iPadOS / macOS (Swift)](#ios--tvos--ipados--macos-swift)
+
+# Local Development
 
 * Make sure you have at least Node 4.3. `node --version`
 * Clone this repo and change directory to it.
@@ -22,44 +39,49 @@ Read the full Parse Server guide here: https://github.com/ParsePlatform/parse-se
 * You now have a database named "dev" that contains your Parse data
 * Install ngrok and you can test with devices
 
-### Getting Started With Heroku + mLab Development
+## Helpful Scripts
+These scripts can help you to develop your app for Parse Server:
+
+* `npm run watch` will start your Parse Server and restart if you make any changes.
+* `npm run lint` will check the linting of your cloud code, tests and `index.js`, as defined in `.eslintrc.json`.
+* `npm run lint-fix` will attempt fix the linting of your cloud code, tests and `index.js`.
+* `npm run prettier` will help improve the formatting and layout of your cloud code, tests and `index.js`, as defined in `.prettierrc`.
+* `npm run test` will run any tests that are written in `/spec`.
+* `npm run coverage` will run tests and check coverage. Output is available in the `/coverage` folder.
 
-#### With the Heroku Button
+# Remote Deployment
+
+## Heroku
 
 [![Deploy](https://www.herokucdn.com/deploy/button.png)](https://heroku.com/deploy)
 
-#### Without It
+Alternatively, to deploy manually:
 
 * Clone the repo and change directory to it
 * Log in with the [Heroku Toolbelt](https://toolbelt.heroku.com/) and create an app: `heroku create`
 * Use the [mLab addon](https://elements.heroku.com/addons/mongolab): `heroku addons:create mongolab:sandbox --app YourAppName`
 * By default it will use a path of /parse for the API routes.  To change this, or use older client SDKs, run `heroku config:set PARSE_MOUNT=/1`
 * Deploy it with: `git push heroku master`
 
-### Getting Started With AWS Elastic Beanstalk
-
-#### With the Deploy to AWS Button
+## AWS Elastic Beanstalk
 
 <a title="Deploy to AWS" href="https://console.aws.amazon.com/elasticbeanstalk/home?region=us-west-2#/newApplication?applicationName=ParseServer&solutionStackName=Node.js&tierName=WebServer&sourceBundleUrl=https://s3.amazonaws.com/elasticbeanstalk-samples-us-east-1/eb-parse-server-sample/parse-server-example.zip" target="_blank"><img src="http://d0.awsstatic.com/product-marketing/Elastic%20Beanstalk/deploy-to-aws.png" height="40"></a>
 
-#### Without It
+Alternatively, deploy your local changes manually:
 
 * Clone the repo and change directory to it
 * Log in with the [AWS Elastic Beanstalk CLI](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/eb-cli3-install.html), select a region, and create an app: `eb init`
 * Create an environment and pass in MongoDB URI, App ID, and Master Key: `eb create --envvars DATABASE_URI=<replace with URI>,APP_ID=<replace with Parse app ID>,MASTER_KEY=<replace with Parse master key>`
 
-### Getting Started With Microsoft Azure App Service
-
-#### With the Deploy to Azure Button
+## Microsoft Azure App Service
 
 [![Deploy to Azure](http://azuredeploy.net/deploybutton.png)](https://portal.azure.com/#create/Microsoft.ParseServer)
 
 Detailed information is available here:
 * [Parse Server with Azure Managed Services](https://azure.microsoft.com/en-us/marketplace/partners/microsoft/parseserver/)
 * [Parse Server Azure Blog Post](https://azure.microsoft.com/en-us/blog/announcing-the-publication-of-parse-server-with-azure-managed-services/)
 
-
-### Getting Started With Google App Engine
+## Google App Engine
 
 1. Clone the repo and change directory to it 
 1. Create a project in the [Google Cloud Platform Console](https://console.cloud.google.com/).
@@ -75,13 +97,11 @@ Detailed information is available here:
 A detailed tutorial is available here:
 [Running Parse server on Google App Engine](https://cloud.google.com/nodejs/resources/frameworks/parse-server)
 
-### Getting Started With Scalingo
-
-#### With the Scalingo button
+## Scalingo
 
 [![Deploy to Scalingo](https://cdn.scalingo.com/deploy/button.svg)](https://my.scalingo.com/deploy)
 
-#### Without it
+Alternatively, to deploy manually:
 
 * Clone the repo and change directory to it
 * Log in with the [Scalingo CLI](http://cli.scalingo.com/) and create an app: `scalingo create my-parse`
@@ -90,7 +110,7 @@ A detailed tutorial is available here:
 * By default it will use a path of /parse for the API routes. To change this, or use older client SDKs, run `scalingo env-set PARSE_MOUNT=/1`
 * Deploy it with: `git push scalingo master`
 
-### Getting Started With OpenShift Online (Next Gen)
+## OpenShift Online (Next Gen)
 
 1. Register for a free [OpenShift Online (Next Gen) account](http://www.openshift.com/devpreview/register.html)
 1. Create a project in the [OpenShift Online Console](https://console.preview.openshift.com/console/).
@@ -106,70 +126,84 @@ A detailed tutorial is available here:
 A detailed tutorial is available here:
 [Running Parse Server on OpenShift Online (Next Gen)](https://blog.openshift.com/parse-server/)
 
-# Using it
+# Using Parse Server
+
+## Health Check
+
+You can use the `/health` endpoint to verify that Parse Server is up and running. For example, for local deployment, enter this URL in your browser:
 
-Before using it, you can access a test page to verify if the basic setup is working fine [http://localhost:1337/test](http://localhost:1337/test).
-Then you can use the REST API, the JavaScript SDK, and any of our open-source SDKs:
+> [http://localhost:1337/parse/health](http://localhost:1337/parse/health)
 
-Example request to a server running locally:
+If you deployed Parse Server remotely, change the URL accordingly.
 
-```curl
+## APIs and SDKs
+
+Use the REST API, GraphQL API or any of the Parse SDKs to see Parse Server in action. Parse Server comes with a variety of SDKs to cover most common ecosystems and languages, such as JavaScript, Swift, ObjectiveC and Android just to name a few.
+
+The following shows example requests when interacting with a local deployment of Parse Server. If you deployed Parse Server remotely, change the URL accordingly.
+
+### REST API
+
+Save object:
+```sh
 curl -X POST \
-  -H "X-Parse-Application-Id: myAppId" \
+  -H "X-Parse-Application-Id: YOUR_APP_ID" \
   -H "Content-Type: application/json" \
-  -d '{"score":1337,"playerName":"Sean Plott","cheatMode":false}' \
+  -d '{"score":1337}' \
   http://localhost:1337/parse/classes/GameScore
-  
+```
+
+Call Cloud Code function:
+```sh
 curl -X POST \
-  -H "X-Parse-Application-Id: myAppId" \
+  -H "X-Parse-Application-Id: YOUR_APP_ID" \
   -H "Content-Type: application/json" \
-  -d '{}' \
+  -d "{}" \
   http://localhost:1337/parse/functions/hello
 ```
 
-Example using it via JavaScript:
+### JavaScript
 
-```javascript
-Parse.initialize('myAppId','unused');
-Parse.serverURL = 'https://whatever.herokuapp.com';
+```js
+// Initialize SDK
+Parse.initialize("YOUR_APP_ID", "unused");
+Parse.serverURL = 'http://localhost:1337/parse';
 
+// Save object
 const obj = new Parse.Object('GameScore');
 obj.set('score',1337);
 await obj.save();
-console.log(obj.toJSON());
 
+// Query object
 const query = new Parse.Query('GameScore');
 const objAgain = await query.get(obj.id);
-console.log(objAgain.toJSON());
 ```
 
-Example using it on Android:
+### Android
 ```java
-//in your application class
-
+// Initialize SDK in the application class
 Parse.initialize(new Parse.Configuration.Builder(getApplicationContext())
-  .applicationId("myAppId")
-  .server("http://myServerUrl/parse/")   // '/' important after 'parse'
+  .applicationId("YOUR_APP_ID")
+  .server("http://localhost:1337/parse/")   // '/' important after 'parse'
   .build());
 
-ParseObject testObject = new ParseObject("TestObject");
-testObject.put("foo", "bar");
-testObject.saveInBackground();
+// Save object
+ParseObject obj = new ParseObject("TestObject");
+obj.put("foo", "bar");
+obj.saveInBackground();
 ```
-Example using it on iOS (Swift):
-```swift
-//in your AppDelegate
 
-Parse.initializeWithConfiguration(ParseClientConfiguration(block: { (configuration: ParseMutableClientConfiguration) -> Void in
-  configuration.server = "https://<# Your Server URL #>/parse/" // '/' important after 'parse'
-  configuration.applicationId = "<# Your APP_ID #>"
+### iOS / tvOS / iPadOS / macOS (Swift)
+```swift
+// Initialize SDK in AppDelegate
+Parse.initializeWithConfiguration(ParseClientConfiguration(block: {
+  (configuration: ParseMutableClientConfiguration) -> Void in
+    configuration.server = "http://localhost:1337/parse/" // '/' important after 'parse'
+    configuration.applicationId = "YOUR_APP_ID"
 }))
 ```
 You can change the server URL in all of the open-source SDKs, but we're releasing new builds which provide initialization time configuration of this property.
 
------
-As of April 5, 2017, Parse, LLC has transferred this code to the parse-community organization, and will no longer be contributing to or distributing this code.
-
 [license-svg]: https://img.shields.io/badge/license-BSD-lightgrey.svg
 [license-link]: LICENSE
 [open-collective-link]: https://opencollective.com/parse-server

cloud/functions.js

@@ -0,0 +1,14 @@
+Parse.Cloud.define('hello', req => {
+  req.log.info(req);
+  return 'Hi';
+});
+
+Parse.Cloud.define('asyncFunction', async req => {
+  await new Promise(resolve => setTimeout(resolve, 1000));
+  req.log.info(req);
+  return 'Hi async';
+});
+
+Parse.Cloud.beforeSave('Test', () => {
+  throw new Parse.Error(9001, 'Saving test objects is not available.');
+});

cloud/main.js

@@ -1,14 +1,2 @@
-Parse.Cloud.define('hello', (req) => {
-  req.log.info(req)
-  return 'Hi';
-});
-
-Parse.Cloud.define('asyncFunction', async (req) => {
-  await new Promise((resolve) => setTimeout(resolve,1000));
-  req.log.info(req)
-  return 'Hi async';
-});
-
-Parse.Cloud.beforeSave('Test', () => {
-  throw new Parse.Error(212,'Saving test objects is not available.')
-});
+// It is best practise to organize your cloud functions group into their own file. You can then import them in your main.js.
+require('./functions.js');

index.js

@@ -17,10 +17,10 @@ const config = {
   cloud: process.env.CLOUD_CODE_MAIN || __dirname + '/cloud/main.js',
   appId: process.env.APP_ID || 'myAppId',
   masterKey: process.env.MASTER_KEY || '', //Add your master key here. Keep it secret!
-  serverURL: process.env.SERVER_URL || 'http://localhost:1337/parse',  // Don't forget to change to https if needed
+  serverURL: process.env.SERVER_URL || 'http://localhost:1337/parse', // Don't forget to change to https if needed
   liveQuery: {
-    classNames: ["Posts", "Comments"] // List of classes to support for query subscriptions
-  }
+    classNames: ['Posts', 'Comments'], // List of classes to support for query subscriptions
+  },
 };
 // Client-keys like the javascript key or the .NET key are not necessary with parse-server
 // If you wish you require them, you can set them as options in the initialization above:
@@ -39,20 +39,20 @@ if (!test) {
 }
 
 // Parse Server plays nicely with the rest of your web routes
-app.get('/', function(req, res) {
+app.get('/', function (req, res) {
   res.status(200).send('I dream of being a website.  Please star the parse-server repo on GitHub!');
 });
 
 // There will be a test page available on the /test path of your server url
 // Remove this before launching your app
-app.get('/test', function(req, res) {
+app.get('/test', function (req, res) {
   res.sendFile(path.join(__dirname, '/public/test.html'));
 });
 
 const port = process.env.PORT || 1337;
 if (!test) {
   const httpServer = require('http').createServer(app);
-  httpServer.listen(port, function() {
+  httpServer.listen(port, function () {
     console.log('parse-server-example running on port ' + port + '.');
   });
   // This will enable the Live Query real-time server
@@ -61,5 +61,5 @@ if (!test) {
 
 module.exports = {
   app,
-  config
+  config,
 };

package.json

@@ -16,22 +16,28 @@
   },
   "scripts": {
     "start": "node index.js",
-    "lint": "eslint --cache ./cloud && eslint --cache index.js",
-    "lint-fix": "eslint --cache --fix ./cloud && eslint --cache --fix index.js",
-    "test": "jasmine"
+    "lint": "eslint --cache ./cloud && eslint --cache index.js && eslint --cache ./spec",
+    "lint-fix": "eslint --cache --fix ./cloud && eslint --cache --fix index.js && eslint --cache  --fix./spec",
+    "test": "jasmine",
+    "coverage": "nyc jasmine",
+    "prettier": "prettier --write '{cloud,spec}/{**/*,*}.js' 'index.js'",
+    "watch": "babel-watch index.js"
   },
   "engines": {
     "node": ">=4.3"
   },
   "devDependencies": {
-    "eslint": "^7.17.0",
-    "eslint-config-standard": "^16.0.2",
-    "eslint-plugin-import": "^2.22.1",
-    "eslint-plugin-node": "^11.1.0",
-    "eslint-plugin-promise": "^4.2.1",
-    "babel-eslint": "^10.1.0",
-    "jasmine": "^3.6.3",
-    "mongodb-runner": "^4.8.0",
-    "bluebird": "^3.7.2"
+    "babel-eslint": "10.1.0",
+    "babel-watch": "7.4.0",
+    "bluebird": "3.7.2",
+    "eslint": "7.19.0",
+    "eslint-config-standard": "16.0.2",
+    "eslint-plugin-import": "2.22.1",
+    "eslint-plugin-node": "11.1.0",
+    "eslint-plugin-promise": "4.2.1",
+    "jasmine": "3.6.4",
+    "mongodb-runner": "4.8.1",
+    "nyc": "15.1.0",
+    "prettier": "2.2.1"
   }
 }