Assignment 3 (Project) in the course IMT2681-2018 (Cloud Technologies) at NTNU Gjøvik.

This application is a RESTful API that can querie other public APIs based on the parameter specified.
This API is used by dialogflow to post different messaged to a Slack webhook.

Connect a chat-board (Slack) with a Professional chat-bot (Dialogflow), and make an API that the chat-bot uses to get user replies based on our business logic. Statistics for the use of different features will be stored in a MongoDB database. The application will be deployed on Heroku, but it will be possible to use it locally on our own server as long as you have public IP-address. The local version will be deployed using docker.

The business logic in this project will be to get a parameter form the chat-bot. Use them to get some information form the internet (get data from online public API's). And reply back to the chat-bot.

We got the idea for this project form Christopher Frantz.

The Plan for the project was for the team members to have 2 tasks each. Set up 1 API request handler, and some other thing based on available time. It is up to each team member to find there own API request case to implement. The other thing to be done was originally related to the list of features we had to use (Heroku, Docker, Database, Cloud function, Openstack).

Total work all members: 115,5 hours
Total work Alexander Jakobsen: 37 hours
Total work Mats Ove Mandt Skjærstein: 27 hours
Total work Per-Kristian: 17 hours
Total work Martin: 19,5 hours
Total work Krisian Lund: 15 hours

For full log of all tasks and work time spent by each team member. Se the repo wiki "work log" sections.

What we succeeded at:

• Connect a chat-board(Slack) with a chat-bot(Dialogflow)
• Make an API that the chat-bot uses to get user replies
• Make 5 API request handlers
• Use a Database to store statistic and some image storage
• Use Docker to make a locally deplorably version of the app
• make a nicer website(using html and css) for testing API features without using slack

What we failed at

• Cloud functions

We dident find a good use for openstack, so we droped it.

We have used discord and in person meetings for group communication. All team members are able to push to github, and view the Heroku project page.

Code quality

• golinter .
• go fmt .
• gocyclo .
• gometalinter -- metalinter .
• go vet --all .

 Everything ok

Continuous integration:

Automatic deployment form github to heroku. If compile fails then we are notified by mail.

In order to run the tests locally you must provide the following environmental variables (reviews will be given our data).

export MONG_ADDRESS=
export MONG_DATABASE=
export MONGO_PASSWORD=
export MONGO_USER=
export MONGO_ADDRESS=

cd handlers/

go test . -v -cover

=== RUN   Test_GetChuckNorrisJoke
--- PASS: Test_GetChuckNorrisJoke (0.91s)
=== RUN   Test_FrontPage
--- PASS: Test_FrontPage (0.00s)
=== RUN   Test_statdb
--- PASS: Test_statdb (0.00s)
=== RUN   Test_statHandler
--- PASS: Test_statHandler (0.00s)
=== RUN   Test_addStatisticEntry
--- PASS: Test_addStatisticEntry (0.01s)
=== RUN   Test_wikeAPI
--- PASS: Test_wikeAPI (0.19s)
=== RUN   Test_GetRandomDadJoke
--- PASS: Test_GetRandomDadJoke (0.19s)
=== RUN   Test_db
--- PASS: Test_db (0.00s)
=== RUN   Test_addDog
--- PASS: Test_addDog (0.18s)
=== RUN   Test_showDog
--- PASS: Test_showDog (0.10s)
=== RUN   Test_adoptDog
--- PASS: Test_adoptDog (0.07s)
=== RUN   Test_DBConnect
--- PASS: Test_DBConnect (0.00s)
=== RUN   Test_GetFunnyCatGif
--- PASS: Test_GetFunnyCatGif (0.21s)
=== RUN   Test_GetFunnyDogGif
--- PASS: Test_GetFunnyDogGif (0.05s)
=== RUN   Test_GetHackerGif
--- PASS: Test_GetHackerGif (0.06s)
=== RUN   Test_GetTrendingGif
--- PASS: Test_GetTrendingGif (0.06s)
=== RUN   Test_log
--- PASS: Test_log (0.00s)
=== RUN   Test_checkLog
--- PASS: Test_checkLog (0.00s)
PASS
coverage: 61.0% of statements
ok      github.com/isberg1/IMT2681-Assignment-3/handlers        2.043s  coverage: 61.0% of statements

Log in to the Slack Channel you have been invited to and input on of the commands bellow

"joke"                         For a Chuch Norris Joke
"dad"                          For a dad Joke
"cat gif"                      For a cat git
"hacker gif"                   For a hacker gif
"trending gif"                 For a trending gif
"show dog"                     For a  dog image
"add dog"                      For add a dog image to database
"adopt"                        For remove oldest dog image from database
"how many"                     For count of dogs in database
"show all"                     For show all dog images in database
"search <what to search for>"  For Wikipedia search

Displays this README in html format.

Used by dialogflow to querie this API.
Different public APIs are queried based on the POST sent by dialogflow.

POST: /dialogflow - Returns a custum API responce based on a parameter "b" in post body

Correct json request:

"queryResult": {
    "queryText": "joke",
    "action": "actionAndParameters",
    "parameters": {
      "b": "joke"
    },
    "allRequiredParamsPresent": true,
    "fulfillmentMessages": [{
      "text": {
        "text": [""]
      }
    }],

Acceptable values for parameter b are:
"joke"          For a chuch Norris Joke
"dad"           For a dad Joke
"cat gif"       For a cat git
"hacker gif"    For a hacker gif
"trending gif"  For a trending gif
"show dog"      For a  dog image
"add dog"       For add a dog image to database
"adopt"         For remove oldest dog image from database
"how many"      For count of dogs in database
"show all"      For  show all dog images in database
"search" (queryText: must contain text to search form)  For Wikipedia search

Returns all logs of all events that has been logged since last build/restart (mainly errors).

GET: /log

Returns all API requests previously sent to this API (used for debugging and json data structure analyze).

GET: /oldPosts

Returns statistics for the different API usage.

GET: /statistics

A website where you can test some of the available APIs we have.
Link

• The app runs in Heroku at https://warm-meadow-53471.herokuapp.com/
• The database (MongoDB) is stored in mlab.com MongoLabs Sandbox.
• The app can run localy in a Docker container.

.env file must have

	MONGO_ADDRESS=<mongodb address:port>
	MONGO_USER=<username>
	MONGO_PASSWORD=<password>
	MONGO_DATABASE=<database name>

Run with: docker run --name app --rm --env-file ./.env -p 8080:8080 -d celebrian/api:latest

If you want to build it yourself use: docker build --rm -t <user>/<image>:<tag> . Then: `docker run --name --rm --env-file <path/to/env/file/> -p :8080 -d /:

Created by Alexander Jakobsen, Martin Brådalen, Mats Ove Mandt Skjærstein with help from Per-Kristian Kongelf Buer, Kristian lund