Merge pull request #118 from Human-Connection/develop

[WIP] update with latest fixes and improvements

Author: appinteractive

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,20 @@
+---
+name: Bug report
+about: Create a report to help us improve
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Authenticate '...'
+2. Post following data to endpoint '...'
+3. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,17 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.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
@@ -121,3 +122,4 @@ lib/
 rethinkdb_data
 .env
 /config/local.json
+package-lock.json

.travis.yml

@@ -18,19 +18,23 @@ jobs:
       script: true
     - stage: Build and Test
       script:
-      - docker build -t humanconnection/api-feathers:alpha .
+      - docker build -t humanconnection/api-feathers .
     - script:
-      - cp ./config/local.example.json ./config/local.json
       - yarn install --frozen-lockfile --non-interactive
       - yarn add codacy-coverage
-      - rm -Rf tmp
-      - yarn eslint
-      - NODE_ENV=test istanbul cover ./node_modules/mocha/bin/_mocha -- test/ --timeout=10000 --exit
+      - yarn run eslint
+      - cp config/cucumber.json config/local.json
+      - yarn run test:coverage
       - cat ./coverage/lcov.info | codacy-coverage
-      - rm ./config/local.json
 
 after_success:
   - if [ $TRAVIS_BRANCH == "master" ] && [ $TRAVIS_EVENT_TYPE == "push" ]; then
     docker login -u "$DOCKER_USERNAME" -p "$DOCKER_PASSWORD";
+    docker tag humanconnection/api-feathers humanconnection/api-feathers:alpha;
     docker push humanconnection/api-feathers:alpha;
     fi
+  - if [ $TRAVIS_BRANCH == "develop" ] && [ $TRAVIS_EVENT_TYPE == "push" ]; then
+    docker login -u "$DOCKER_USERNAME" -p "$DOCKER_PASSWORD";
+    docker tag humanconnection/api-feathers humanconnection/api-feathers:edge;
+    docker push humanconnection/api-feathers:edge;
+    fi

LICENSE.md

@@ -5,7 +5,10 @@
 
 <p align="center">
   <a href="https://travis-ci.org/Human-Connection/API"><img src="https://img.shields.io/travis/Human-Connection/API/master.svg" alt="Build Status"></a>
-  <a href="https://creativecommons.org/licenses/by-nc-sa/4.0/"><img src="https://img.shields.io/badge/license-CC%20BY--NC--SA%204.0-green.svg" "Attribution-NonCommercial-ShareAlike 4.0 International (CC BY-NC-SA 4.0)" /></a>
+  <a href="https://github.com/Human-Connection/WebApp/blob/develop/LICENSE.md"><img src="https://img.shields.io/badge/license-MIT-green.svg" "MIT" /></a>
+  <a href="https://app.fossa.io/projects/git%2Bgithub.com%2FHuman-Connection%2FAPI?ref=badge_shield" alt="FOSSA Status"><img src="https://app.fossa.io/api/projects/git%2Bgithub.com%2FHuman-Connection%2FAPI.svg?type=shield"/></a>
+  <a href="https://discord.gg/NgVpvx9" alt="Discord Channel">
+<img src="https://img.shields.io/discord/443107904757694465.svg" alt="Discord" /></a>
 </p>
 
 # Human-Connection API
@@ -61,16 +64,18 @@ Getting up and running is as easy as 1, 2, 3, 4 ... 5.
    # start mongodb, feathers and seed database
    $ yarn dev
    $ yarn dev:win if you're on windows
+
    # start mongodb, feathers without seeding the database
    $ yarn dev:noseed
+   
    # start mongodb, feathers for production
    $ yarn start
    ```
 
    > ##### IMPORTANT for WIN users: 
    > - make sure you have mongo bin directory added to your PATH
    > - if you picked another data directory during mongodb setup make sure 
-   > to change package.json scripts section for key "dev-win" so it points to
+   > to change package.json scripts section for key "dev:win" so it points to
    > the proper path. Otherwise you will get missing data path errors from mongodb.
    
    If you did it right it will seed some fake data for you and downloads some images and avatar for faster development.
@@ -105,9 +110,6 @@ The seeder configuration has two properties:
 
 Simply run `yarn test` and all your tests in the `test/` directory will be run.
 
-> **Note:** 
-> *At the moment there are some issues with linting while testing, but you can run the tests also with mocha run*
-
 ## Scaffolding
 
 Feathers has a powerful command line interface. Here are a few things it can do:
@@ -129,6 +131,6 @@ The HC platform is documented in our [gitbook](https://www.gitbook.com/book/huma
 
 ## License 
 
-<a href="https://creativecommons.org/licenses/by-nc-sa/4.0/"><img src="https://mirrors.creativecommons.org/presskit/buttons/80x15/svg/by-nc-sa.svg"/></a>
+Copyright (c) 2018 [Human-Connection.org](https://human-connection.org)
 
-[Creative Commons (CC BY-NC-SA 4.0) License](https://creativecommons.org/licenses/by-nc-sa/4.0/) not for commercial use. 
+Licensed under the [MIT](https://github.com/Human-Connection/WebApp/blob/develop/LICENSE.md) license.

README.md

@@ -0,0 +1,20 @@
+{
+  "host": "localhost",
+  "port": 3030,
+  "baseURL": "http://localhost:3030",
+  "frontURL": "http://localhost:3000",
+  "smtpConfig": {
+    "host": "0.0.0.0",
+    "port": 1025,
+    "ignoreTLS": true
+  },
+  "thumbor": {
+    "url": "",
+    "key": ""
+  },
+  "seeder": {
+    "runOnInit": false,
+    "dropDatabase": false
+  },
+  "defaultEmail": "[email protected]"
+}

config/cucumber.json

@@ -14,7 +14,7 @@
   },
   "seeder": {
     "runOnInit": true,
-    "dropDatabase": true
+    "dropDatabase": false
   },
   "defaultEmail": "[email protected]"
 }

config/local.example.json

@@ -5,5 +5,10 @@
     "runOnInit": false,
     "dropDatabase": false
   },
+  "smtpConfig": {
+    "host": "0.0.0.0",
+    "port": 1025,
+    "ignoreTLS": true
+  },
   "mongodb": "mongodb://localhost:27017/hc_api_test"
 }

config/test.json

@@ -0,0 +1,42 @@
+Feature: Import a post from an organization and publish it in Human Connection
+  As a user of human connection
+  You would like to publish a post programmatically
+  In order to automate things
+
+
+  Background:
+    Given the Human Connection API is up and running
+    And there is a user in Human Connection with these credentials:
+      | email            | password |
+      | user@example.com |     1234 |
+
+  Scenario: Get a JWT token
+    When you send a POST request to "/authentication" with:
+    """
+    {
+      "email": "[email protected]",
+      "password": "1234",
+      "strategy": "local"
+    }
+    """
+    Then there is an access token in the response:
+    """
+    {
+      "accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6ImFjY2VzcyIsInR5cGUiOiJhY2Nlc3MifQ..."
+    }
+    """
+
+  Scenario: Publish a post
+    Given you are authenticated
+    When you send a POST request to "/contributions" with:
+    """
+    {
+      "title": "Cool title",
+      "content": "<p>A nice content</p>",
+      "contentExcerpt": "Nice",
+      "type": "post",
+      "language": "de",
+      "categoryIds": ["5ac7768f8d655d2ee6d48fe4"]
+    }
+    """
+    Then a new post is created