perf(): improve high network db query

.env.docker_example → .env.example

@@ -2,32 +2,32 @@ NODE_ENV=development
 PORT=4040
 JWT_SECRET=insert-random-secret-string-here
 
-MONGO_HOST=mongodb://mongo/express-mongoose-es6-rest-api-development
-MONGO_HOST_TEST=mongodb://mongo/express-mongoose-es6-rest-api-development-test
+MONGO_HOST=mongodb://localhost/sedaily
+MONGO_HOST_TEST=mongodb://localhost/sedaily-test
 MONGO_PORT=27017
 
-RACCOON_REDIS_URL=redis
-RACCOON_REDIS_PORT=6379
-#RACCOON_REDIS_AUTH=
-
 DEBUG=express-mongoose-es6-rest-api:*
 
+EMAIL_FROM_ADDRESS=no-reply@example.com
+
 FACEBOOK_ID=insert-facebook-app-id-here
 FACEBOOK_SECRET=insert-facebook-app-secret-here
 
 AWS_ACCESS_KEY_ID=YOUR_AWS_KEY
 AWS_SECRET_ACCESS_KEY=YOUR_AWS_SECRET
-
+AWS_PROFILE_PIC_BUCKET_NAME=bucket-name
+AWS_TOPIC_BUCKET_NAME=YOUR_BUCKET_NAME
 
 STRIPE_PUBLIC_KEY=public_key
 STRIPE_SECRET_KEY=secret_key
 
-
-AD_FREE_URL=https://google.com/
-
 SEND_GRID_KEY=send_grid_key
 
 EVENTS_API_BASE_URL=http://localhost:3000/api/v1/
 
 MAILCHIMP_KEY=mailchimp_key
-MAILCHIMP_LIST_ID=mailchimp_list_id
+MAILCHIMP_LIST_ID=mailchimp_list_id
+
+# These are public testing keys - https://developers.google.com/recaptcha/docs/faq
+RECAPTCHA_SITE_KEY=6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI
+RECAPTCHA_SECRET_KEY=6LeIxAcTAAAAAGG-vFI1TnRWxMZNFuojJ4WifJWe

.eslintrc

@@ -30,7 +30,8 @@
     ],
     "no-underscore-dangle": [
       0
-    ]
+    ],
+    "arrow-body-style":"off"
   },
   "env": {
     "node": true,

.gitignore

@@ -54,5 +54,12 @@ node_modules
 *.swp
 *.swo
 
+# Database Migrations
+.migrate
+
 # Redis Database File
 *.rdb
+
+# CI builds
+devops/dump
+.vscode/settings.json

.travis.yml

@@ -1,16 +1,27 @@
 language: node_js
 node_js:
-  - "6.11"
+  - "10.19.0"
+sudo: required
 services:
   - mongodb
-  - redis-server
+  - docker
 cache:
   directories:
   - node_modules
 git:
   depth: 3
-script:
-  # - yarn test:check-coverage
-  - npm run test
-after_script:
-  # - yarn report-coverage
+stages:
+  - test
+  - name: docker
+    if: branch = master AND type = push
+jobs:
+  include:
+    - stage: test
+      script:
+        - npm run lint
+        - npm run test
+        - npm run build
+    - stage: docker
+      script:
+        - ./devops/build-api.sh
+        - cd devops; ./build-mongodb.sh

Dockerfile

@@ -1,5 +1,5 @@
 # take default image of node boron i.e  node 6.x
-FROM node:6.10.1
+FROM node:10.19.0
 
 MAINTAINER Kunal Kapadia <kunalkapadia12@gmail.com>
 

README.md

@@ -1,23 +1,42 @@
 [![logo](https://i.imgur.com/3OtP3p8.png)](https://softwareengineeringdaily.com/)
 
-[![Build Status](https://travis-ci.org/SoftwareEngineeringDaily/software-engineering-daily-api.svg?branch=travis-fix)](https://travis-ci.org/SoftwareEngineeringDaily/software-engineering-daily-api)
-
-# SEDaily-API
-
-The backend services and API for the Software Engineering Daily [Android](https://github.com/SoftwareEngineeringDaily/SEDaily-Android), [iOS](https://github.com/SoftwareEngineeringDaily/se-daily-iOS), and [web front end](https://github.com/SoftwareEngineeringDaily/sedaily-front-end).
-
-## Set up (local) 
-### *[More details here...](https://softwareengineeringdaily.github.io/Backend/gettingstarted/)
-  - Install and run a local redis client
-  - Install and run a local mongo client
-  - `cp .env.local_example .env`
-  - `npm install` or `yarn install`
-  - `npm start` or `yarn start`
-  - check package.json for other builds
-  - use curl or Postman to make requests
-  - view swagger api docs at HOST/api/docs
-
-## Using Docker
-  - `cp .env.docker_example .env`
-  - Run `docker-compose up`
-  - If dependencies are updated in package.json, run `docker-compose down` and then `docker-compose up --build`. This will remove the old container and rebuild the API image which installs the new dependencies.
+[![Build Status](https://travis-ci.org/SoftwareEngineeringDaily/software-engineering-daily-api.svg?branch=master)](https://travis-ci.org/SoftwareEngineeringDaily/software-engineering-daily-api)
+
+# Software Engineering Daily API
+
+The backend services and API for the Software Engineering Daily [Android](https://github.com/SoftwareEngineeringDaily/SEDaily-Android), [iOS](https://github.com/SoftwareEngineeringDaily/se-daily-iOS), and [front end](https://github.com/SoftwareEngineeringDaily/sedaily-front-end) clients.
+
+### Getting Started
+
+The [Software Daily](https://www.softwaredaily.com) API uses MongoDB as the data store. You'll need MongoDB running locally. This requires an OS-specific install of [Docker](https://docs.docker.com/install/) and [Docker Compose](https://docs.docker.com/compose/install/#prerequisites). During the CI process for the the API, the MongoDB image data is seeded from the [staging environment](https://sedaily-frontend-staging.herokuapp.com).
+
+```
+# clone the project
+git clone https://github.com/SoftwareEngineeringDaily/software-engineering-daily-api.git
+cd software-engineering-daily-api/
+
+# setup environment variables
+cp .env.example .env
+
+# run mondodb container
+docker-compose up -d
+
+# install dependencies
+npm install
+
+# serve with hot reload at localhost:4040
+npm start
+
+# test api
+curl localhost:4040/api/posts
+```
+
+View the swagger api docs at http://localhost:4040/api/docs
+
+### Contributing
+
+Fork the repository and create a branch off of `master`. When your feature is ready, submit a pull request for the `master` branch. Be sure to include a short description of the feature or pull request and reference any related issues. The project is hosted on Heroku so if you would like a review app created just request it in the PR.
+
+After the Travis-CI tests are successful and your pull request is approved, an admin will merge the PR. Any commits merged to `master` are deployed to the front end [staging environment](https://sedaily-frontend-staging.herokuapp.com). Once everything looks good an admin will promote staging to production and your feature will be live!
+
+We have an active Slack community that you can reach out to for more information or just to chat with anyone. Check out the [<img src="https://upload.wikimedia.org/wikipedia/commons/7/76/Slack_Icon.png" alt="Slack Channel" width="20px"/> SED app development](https://softwaredaily.slack.com/app_redirect?channel=sed_app_development) slack channel. Also see the [Open Source Guide](https://softwareengineeringdaily.github.io/).

app.json

@@ -1,8 +1,51 @@
 {
   "name": "software-engineering-daily-api",
+  "stack": "heroku-18",
   "scripts": {
   },
   "env": {
+    "JWT_SECRET": {
+      "required": true
+    },
+    "MONGO_HOST": {
+      "required": true
+    },
+    "MONGO_HOST_TEST": {
+      "required": true
+    },
+    "AWS_ACCESS_KEY_ID": {
+      "required": true
+    },
+    "AWS_SECRET_ACCESS_KEY": {
+      "required": true
+    },
+    "AWS_PROFILE_PIC_BUCKET_NAME": {
+      "required": true
+    },
+    "STRIPE_PUBLIC_KEY": {
+      "required": true
+    },
+    "STRIPE_SECRET_KEY": {
+      "required": true
+    },
+    "SEND_GRID_KEY": {
+      "required": true
+    },
+    "MAILCHIMP_KEY": {
+      "required": true
+    },
+    "MAILCHIMP_LIST_ID": {
+      "required": true
+    },
+    "RECAPTCHA_SITE_KEY": {
+      "required": true
+    },
+    "RECAPTCHA_SECRET_KEY": {
+      "required": true
+    },
+    "EMAIL_FROM_ADDRESS": {
+      "required": true
+    }
   },
   "formation": {
   },

config/config.js

@@ -9,9 +9,7 @@ const envVarsSchema = Joi.object({
     .allow(['development', 'production', 'test', 'provision'])
     .default('development'),
   BASE_URL: Joi.string()
-    // .allow(['https://www.softwaredaily.com', 'http://localhost:4040'])
     .default('https://www.softwaredaily.com'),
-  EVENTS_API_BASE_URL: Joi.string().required(),
   SEND_GRID_KEY: Joi.string().required(),
   PORT: Joi.number()
     .default(4040),
@@ -23,22 +21,26 @@ const envVarsSchema = Joi.object({
     }),
   JWT_SECRET: Joi.string().required()
     .description('JWT Secret required to sign'),
-  AD_FREE_URL: Joi.string().required()
-    .description('URL for ad free podcasts'),
   MONGO_HOST: Joi.string().required()
     .description('Mongo DB host url'),
   MONGO_HOST_TEST: Joi.string()
     .description('Mongo DB test host url'),
   MONGO_PORT: Joi.number()
     .default(27017),
-  FACEBOOK_ID: Joi.string().required()
-    .description('Facbook application id'),
-  FACEBOOK_SECRET: Joi.string().required()
-    .description('Facebook application secret'),
+  MONGO_COLLECTION_PREFIX: Joi.string().default('')
+    .description('Prefix used in all collection names'),
   MAILCHIMP_KEY: Joi.string().required()
     .description('Mailchimp API key'),
   MAILCHIMP_LIST_ID: Joi.string().required()
-    .description('Mailchimp list id')
+    .description('Mailchimp list id'),
+  RECAPTCHA_SITE_KEY: Joi.string().required()
+    .description('Recaptcha site key'),
+  RECAPTCHA_SECRET_KEY: Joi.string().required()
+    .description('Recaptcha secret key'),
+  AWS_PROFILE_PIC_BUCKET_NAME: Joi.string().required()
+    .description('S3 bucket for storing profile pictures'),
+  EMAIL_FROM_ADDRESS: Joi.string().required()
+    .description('Email address listed in FROM section of emails')
 }).unknown()
   .required();
 
@@ -51,23 +53,36 @@ const config = {
   env: envVars.NODE_ENV,
   port: envVars.PORT,
   baseUrl: envVars.BASE_URL,
+  serverUrl: envVars.SERVER_URL,
   sendGridKey: envVars.SEND_GRID_KEY,
   mongooseDebug: envVars.MONGOOSE_DEBUG,
-  adFreeURL: envVars.AD_FREE_URL,
   jwtSecret: envVars.JWT_SECRET,
-  eventStreamUrl: envVars.EVENTS_API_BASE_URL,
   mongo: {
     host: envVars.MONGO_HOST,
     test: envVars.MONGO_HOST_TEST,
-    port: envVars.MONGO_PORT
-  },
-  facebook: {
-    clientID: envVars.FACEBOOK_ID,
-    clientSecret: envVars.FACEBOOK_SECRET
+    port: envVars.MONGO_PORT,
+    collectionPrefix: envVars.MONGO_COLLECTION_PREFIX ? `${envVars.MONGO_COLLECTION_PREFIX}-` : ''
   },
   mailchimp: {
     mailchimpKey: envVars.MAILCHIMP_KEY,
     mailchimpList: envVars.MAILCHIMP_LIST_ID
+  },
+  recaptcha: {
+    siteKey: envVars.RECAPTCHA_SITE_KEY,
+    secretKey: envVars.RECAPTCHA_SECRET_KEY
+  },
+  aws: {
+    profilePicBucketName: envVars.AWS_PROFILE_PIC_BUCKET_NAME,
+    topicBucketName: envVars.AWS_TOPIC_BUCKET_NAME,
+  },
+  email: {
+    fromAddress: envVars.EMAIL_FROM_ADDRESS
+  },
+  cron: {
+    RSS: {
+      time: '0 15 9,10,11,12,14,16,19,21 * * *',
+      timeZone: null
+    }
   }
 };