Merge branch 'split-packages' into development

Author: ubergesundheit

Diff for: .dockerignore

@@ -1,7 +1,5 @@
 node_modules
-mongo-data
 userimages
-osem-mongo
 docker-compose.yml
 Dockerfile
 .env*

Diff for: .eslintrc.js

@@ -152,6 +152,7 @@ module.exports = {
       'error',
       'never'
     ],
-    'no-warning-comments': 'error'
+    'no-warning-comments': 'error',
+    'prefer-promise-reject-errors': 'error'
   }
 };

Diff for: .gitignore

@@ -16,10 +16,9 @@ dump
 npm-debug.log
 node_modules
 
-config/index.js
-
 userimages
-mongo-data
 .env
 doc/
 revision
+
+dev_run_migration.sh

Diff for: utils/deploy-docs.sh renamed to .scripts/deploy-docs.sh

@@ -3,14 +3,11 @@
 set -euo pipefail
 IFS=$'\n\t'
 
-
 # move to the build dir..
-cd $TRAVIS_BUILD_DIR
+cd "$TRAVIS_BUILD_DIR"
 
 # install apidocs
-npm install -g [email protected]
-
-# deploy!
+npm install -g [email protected]
 
 # run apidoc
 apidoc -i . -f js -e node_modules
@@ -42,6 +39,5 @@ git config user.email "[email protected]"
 # commit
 git commit -m "apidoc build from ${TRAVIS_COMMIT} by Travis"
 
-# push to github!
+# push to github
 git push "https://${GITHUB_TOKEN}@github.com/${GITHUB_REPO}.git" gh-pages
-

Diff for: .scripts/npm_tag-container.sh

@@ -0,0 +1,25 @@
+#!/bin/bash
+
+set -euo pipefail
+IFS=$'\n\t'
+
+currentBranch=$(git branch | grep -e "^*" | cut -d' ' -f 2)
+
+if [ "$currentBranch" != "master" ]; then
+  echo "Tags for containers can only be made from 'master' branch"
+  exit 1
+fi
+
+# Extract latest git tag
+currentVersion=$(git tag -l --sort=-v:refname | head -n 1 | tr -d 'v')
+
+# Increment
+newVersion=$(($currentVersion+1))
+
+tagName="v$newVersion"
+
+# tag new version
+git tag "$tagName"
+
+echo "Creation of new tag for docker hub was successful. New tag is '$tagName'."
+echo "Please run 'git push origin master' to trigger the build on docker hub."

Diff for: .travis.yml

@@ -5,7 +5,7 @@ node_js:
   - "6"
 
 install: true
-script: ./utils/deploy-docs.sh
+script: ./api/.scripts/deploy-docs.sh
 
 env:
   global:

Diff for: CHANGELOG.md

@@ -0,0 +1,4 @@
+# openSenseMap API Changelog
+
+## Unreleased
+- Initial Release after splitting api and models

Diff for: Dockerfile

@@ -9,10 +9,10 @@ COPY yarn.lock /usr/src/app/
 
 # npm rebuild is required because the prebuilt binaries are not compatible with musl
 # remove when https://github.com/kelektiv/node.bcrypt.js/issues/528 is resolved
-RUN yarn install --pure-lockfile \
- && apk --no-cache --virtual .build add build-base python \
- && npm rebuild bcrypt --build-from-source \
- && apk del .build
+RUN yarn install --pure-lockfile --production \
+  && apk --no-cache --virtual .build add build-base python \
+  && npm rebuild bcrypt --build-from-source \
+  && apk del .build
 COPY . /usr/src/app
 
 # for git 2.1.4
@@ -21,4 +21,4 @@ RUN apk --no-cache --virtual .git add git \
   && rm -rf .git \
   && apk del .git
 
-CMD [ "npm", "start" ]
+CMD [ "yarn", "start" ]

Diff for: README.md

@@ -1,72 +1,85 @@
-openSenseMap-API
-================
+![openSenseMap API](https://raw.githubusercontent.com/sensebox/resources/master/images/openSenseMap_API_github.png)
 
-[![Join the chat at https://gitter.im/sensebox/openSenseMap-API](https://badges.gitter.im/sensebox/openSenseMap-API.svg)](https://gitter.im/sensebox/openSenseMap-API?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
-This is the back-end for [openSenseMap](https://opensensemap.org).
+[![sensebox/openSenseMap-API Build Status](https://travis-ci.org/sensebox/openSenseMap-API.svg?branch=master)](https://travis-ci.org/sensebox/openSenseMap-API)
 
-openSenseMap is part of the [senseBox](https://sensebox.de) project.
-To get more information about openSenseMap and senseBox visit the before mentioned links or have a look at this [video](https://www.youtube.com/watch?v=uTOWYa42_rI).
+This repository contains the Node.js package [@sensebox/opensensemap-api](https://www.npmjs.com/package/@sensebox/opensensemap-api), which is the HTTP REST API used by [https://opensensemap.org](https://opensensemap.org) running at [https://api.opensensemap.org](https://api.opensensemap.org). To get more information about openSenseMap and senseBox visit the before mentioned links or have a look at this [video](https://www.youtube.com/watch?v=uTOWYa42_rI), read the [API docs](https://docs.opensensemap.org) or the [openSenseMap](https://osem.books.sensebox.de/) chapter in our [books](https://books.sensebox.de/). openSenseMap is part of the [senseBox] project.
 
-Originally, this API has been built as part the bachelor thesis of @mpfeil at the ifgi (Institute for Geoinformatics, WWU Münster).
+Originally, this API has been built as part of the bachelor thesis of [@mpfeil](https://github.com/mpfeil) at the ifgi (Institute for Geoinformatics, WWU Münster) and is currently maintained by [@ubergesundheit](https://github.com/ubergesundheit).
 
-### Technologies
+## Configuration
+Configuration values reside in the `lib/config.js` file. Configuration can also be set through environment variables starting with `OSEM_`. Environment variables override values in `lib/config.js`.
 
-* [node.js]
-* [MongoDB]
-
-### Development
+## Development
+- Have [Node.js] v6, [yarn](https://yarnpkg.com/), [Docker](https://docs.docker.com/engine/installation/) and [docker-compose](https://docs.docker.com/compose/install/) installed
+- Start your development database (`docker-compose up -d db`)
+- Check out `development` branch (`git checkout development`)
+- Run `yarn install`
+- Create your own branch `git checkout -b my-awesome-branch`
+- Commit your changes to your branch and push it to your fork
+- Create a pull request against the `development` branch
 
-#### Node.js
-It is assumed that you have installed node.js Version 6 LTS. Install dependencies with [yarn](https://yarnpkg.com/)
+## Running Tests
+You can run the tests in containers using Docker and docker-compose.
 ```
+# Run this the first time or every time you change dependencies in package.json
 yarn install
-```
-
-There are several config keys in `config/index.js`. These can also be configured through environment keys. Just prefix your environment keys with `OSEM_` to be read by the api.
+./run-tests.sh build
 
-#### Database
-The API needs a running MongoDB instance with a `OSeM-api` database and credentials.
-
-The best way to run the database for development is to use the supplied `docker-compose.yml` and run
-```
-docker-compose up -d db
+./run-tests.sh
 ```
 
-### `require()` openSenseMap-API for other projects
+## Related projects
 
-You can require several parts of the API in other projects.
+### Services
+- [openSenseMap Frontend](https://github.com/sensebox/openSenseMap)
+- [ttn-osem-integration](https://github.com/sensebox/ttn-osem-integration)
+- [openSenseMap-MQTT-client](https://github.com/sensebox/openSenseMap-MQTT-client)
+- [sensebox-mailer](https://github.com/sensebox/sensebox-mailer)
 
-Install it as dependency
-```
-# for specific branch/commit/tag append #<branch/commit/tag>
-yarn add git://github.com/sensebox/openSenseMap-API.git
-```
+### Libraries
+- [sketch-templater](https://github.com/sensebox/node-sketch-templater)
+- [openSenseMap-API-models](https://github.com/sensebox/openSenseMap-API-models)
 
-This allows you to use parts like models and decoding in your own project. See `index.js`.
+### Deployment
+- [OSeM-compose](https://github.com/sensebox/OSeM-compose)
+- [openSenseMap-infrastructure](https://github.com/sensebox/openSenseMap-infrastructure)
 
-### Create the JSDoc pages
+## Technologies
 
-To create the documentation you need [apidocjs](http://apidocjs.com/) and run:
-```
-apidoc -e node_modules/
-```
+* [Node.js]
+* [MongoDB]
 
-### Running Tests
-You can run the tests in containers using docker and docker-compose.
-```
-# Only run this once or every time you change dependencies in package.json
-docker-compose -p osemapitest -f tests-docker-compose.yml build osem-api
+## Organization
 
-./run-tests.sh
-```
+### Branches
+- master (runs in production)
+  - Is used for container build tags
+- development (runs on testing server)
+  - Bleeding edge and possibly unstable development version
+- gh-pages
+  - Hosts API docs for [https://docs.opensensemap.org/](https://docs.opensensemap.org/)
+  - Is generated and pushed to github by Travis CI
+
+### Tags and Versions
+Git Tags are used for Docker hub builds (like `v1`). Version number is increased by one for each new version. Docker images are built automatically by the Docker hub for all tags starting with `v`
 
-### Running in Production
+#### Development container images
+Every commit on branch `development` will be built with the tag `development`.
 
-Look at the [OSeM-compose](https://github.com/sensebox/osem-compose) repository. It contains a deployment with docker compose.
+#### Versioned container images
+- Check out `master` branch
+- Go to root directory
+- Run tests
+- Optional: Build docker image locally
+- Commit everything needed for the container image
+- Run `npm run tag-container`
+- Run `git push origin master`
 
-### License
+## License
 
-[MIT](license.md) - Matthias Pfeil 2015 - 2017
+[MIT](license.md) - Matthias Pfeil 2015 - now
 
-[node.js]:http://nodejs.org/
+[Node.js]:http://nodejs.org/
 [MongoDB]:http://www.mongodb.com/
+[openSenseMap]:https://opensensemap.org/
+[senseBox]:https://sensebox.de/

Diff for: app.js

@@ -3,22 +3,24 @@
  * Booya!
  */
 
+/**
+ * define for Datetype parameters
+ * @apiDefine ISO8601Date A ISO8601 formatted timestamp. Will be parsed by MomentJS with enabled strict mode
+ */
+
 'use strict';
 
 const restify = require('restify'),
   { fullResponse, queryParser, jsonBodyParser, pre: { sanitizePath } } = restify.plugins,
-  utils = require('./lib/utils'),
-  db = require('./lib/db'),
-  { preRequest, preCors } = require('./lib/helpers/apiUtils'),
-  Box = require('./lib/models').Box,
+  config = require('./lib/config'),
+  { preRequest, preCors, Honeybadger, softwareRevision, postToSlack } = require('./lib/helpers/apiUtils'),
   routes = require('./lib/routes'),
   passport = require('passport'),
-  log = require('./lib/log');
-
-const { config, Honeybadger } = utils;
+  log = require('./lib/log'),
+  { db } = require('@sensebox/opensensemap-api-models');
 
 const server = restify.createServer({
-  name: `opensensemap-api (${utils.softwareRevision})`,
+  name: `opensensemap-api (${softwareRevision})`,
   log: log
 });
 
@@ -45,8 +47,7 @@ db.connect()
   .then(function () {
     server.listen(config.port, function () {
       log.info(`${server.name} listening at ${server.url}`);
-      utils.postToSlack(`openSenseMap API started. Revision: ${utils.softwareRevision}`);
-      Box.connectMQTTBoxes();
+      postToSlack(`openSenseMap API started. Revision: ${softwareRevision}`);
     });
   })
   .catch(function (err) {

Diff for: index.js

@@ -8,7 +8,6 @@ const isProdEnv = function isProdEnv () {
 // environment variables starting with `OSEM_` will override the values here.
 // Example: `OSEM_targetfolder` will override the setting for `targetFolder`
 const config = {
-  imageFolder: './userimages/', // absolute location of user images
   logFolder: './logs/', // absolute location of error log files
 
   // database configuration, will be concatenated to a mongo db connection string
@@ -22,7 +21,6 @@ const config = {
   api_base_domain: 'localhost', // the naked api domain. For example api.opensensemap.org
   api_protocol: (isProdEnv() ? 'https' : 'http'),
   api_url: '', // generated if not set from api_protocol and api_base_domain
-  api_measurements_post_domain: '', //just the naked ingress domain. For example ingress.opensensemap.org
 
   port: 8000, // port the api will bind to
 
@@ -31,39 +29,20 @@ const config = {
   userPath: '/users', // user methods
   statisticsPath: '/statistics', //statistics methods
 
-  mailer_url: '', // leave empty to not send emails. For example: https://mailer:3924/
-  mailer_cert: '',
-  mailer_key: '',
-  mailer_ca: '',
-  mailer_origin: '', // set to the address where your frontend runs. for example: https://opensensemap.org
-
   slack_url: '', // for slack integration
 
   honeybadger_apikey: '',
 
-  // TODO: add config key to osem-compose
   jwt_secret: 'OH GOD THIS IS SO INSECURE PLS CHANGE ME', // should be at least 32 characters
   jwt_algorithm: 'HS256',
-  jwt_validity_ms: 3600000, // 1 hour
   jwt_issuer: '', // usually the base url of the api. generated if not set from api_protocol and api_base_domain. for example https://api.opensensemap.org
 
-  refresh_token_secret: 'I ALSO WANT TO BE CHANGED',
-  refresh_token_algorithm: 'sha256',
-  refresh_token_validity_ms: 604800000, // 1 week
-
-  password_min_length: 8,
-  password_salt_factor: (isProdEnv() ? 13 : 1), // use at least 10, max 31 (because the lib only allows this much. maybe switch later)
-
   isProdEnv
 };
 
-let env_has_dbconnectionstring = false;
 for (const envKey in process.env) {
   if (envKey.indexOf('OSEM_') === 0) {
     const configKey = envKey.substring(5);
-    if (env_has_dbconnectionstring === false && configKey === 'dbconnectionstring') {
-      env_has_dbconnectionstring = true;
-    }
     if (config[configKey] && typeof config[configKey] === 'number') {
       config[configKey] = parseInt(process.env[envKey], 10);
     } else {
@@ -72,17 +51,10 @@ for (const envKey in process.env) {
   }
 }
 
-if (env_has_dbconnectionstring === false) {
-  config.dbconnectionstring = `mongodb://${config.dbuser}:${config.dbuserpass}@${config.dbhost}:${config.dbport}/${config.dbdb}?authSource=${config.dbauthsource}`;
-}
-
 // set composite config keys
 if (config.api_url === '') {
   config.api_url = `${config.api_protocol}://${config.api_base_domain}`;
 }
-if (config.jwt_issuer === '') {
-  config.jwt_issuer = `${config.api_protocol}://${config.api_base_domain}`;
-}
 
 // freeze config
 module.exports = Object.freeze(config);