+ Main Contributor: Sebastian Steiner
+ external services
+ https://www.indico.io
- + `API KEY: G6T4/service-analysis/indico_api_key.txt`
-### fallback
-+ Full readme: [fallback](service-fallback/README.md)
+ + `API KEY: G6T4/service-analysis/analysis.env`: `INDICO_API_KEY`
+### failover
++ Full readme: [failover](service-failover/README.md)
+ Main Contributor: Jan Vales
### reporting
+ Full readme: [reporting](service-reporting/README.md)
+ external services
+ https://www.twitter.com
+ `API KEY: G6T4/service-twitter/src/main/resources/application.yml`
-### Web UI
+### website
++ Full readme: [website](service-website/README.md)
+ Main Contributors:
+ Michael Winsauer (UI)
+ Fabian Eichhorner (CSS)
ports:
- "8081:8081"
# restart: always
+ env_file:
+ - service-analysis/analysis.env
+
service-failover:
build: ./service-failover
ports:
- "8084:8084"
# restart: always
+ env_file:
+ - service-twitter/twitter.env
service-website:
build: ./service-website
FROM python:3.7-slim
-LABEL maintainer="Sebastian Steiner"
+LABEL maintainer="Sebastian Steiner <sebastian.steiner@tuwien.ac.at>"
WORKDIR /app
-COPY . /app/
+COPY *.py /app/
+COPY *.txt /app/
RUN pip install -r requirements.txt
# Sentiment Service
-
## API
-Provides a REST-API to get the average sentiment of a given list of texts
-The service uses the the sentiment analysis service indico.
+Provides a REST-API to get the average sentiment of a given list of texts.
+The service uses the sentiment analysis service indico.
`GET`: `/` Displays the expected input for a POST
## external services
This sentiment analysis service uses the online sentiment analysis indico (https://www.indico.io).
-The indico api key can be set in the file indico_api_key.txt. The current key does work, however excessive use of this service will require you to provide your own key, since the amount of requests for this key is limited.
+The indico api key can be set in the file `analysis.env`. The current key does work, however excessive use of this service will require you to provide your own key, since the amount of requests for this key is limited.
In case of an 503 error, you can use the `/offline_analysis`.
## run with docker
-- `docker build -t sentiment_analysis .`
-- `docker container run -d -p YOUR_PORT:8081 sentiment_analysis`
+- `docker image build -t service-analysis .`
+- `docker container run --env-file=analysis.env -d -p YOUR_PORT:8081 service-analysis:latest`
## run local
### requirements
- python 3.7
-- pip: indicoio
-- pip: flask
-- pip: flask_restful
-- pip: textblob
+- pip:
+ - indicoio
+ - flask
+ - flask_restful
+ - textblob
### commands
- `python3.7 sentiment_analysis.py` to start the service
+
+## examples
- positive online sentiment test example: `curl -v -H 'content-type: application/json' -X POST http://localhost:8081 -d '[{"text":"happy birthday, i love you"}]'`
- negative online sentiment test example: `curl -v -H 'content-type: application/json' -X POST http://localhost:8081 -d '[{"text":"i hate you, please die"}]'`
- positive offline sentiment test example: `curl -v -H 'content-type: application/json' -X POST http://localhost:8081/offline_analysis -d '[{"text":"happy birthday, i love you"}]'`
- negative offline sentiment test example: `curl -v -H 'content-type: application/json' -X POST http://localhost:8081/offline_analysis -d '[{"text":"i hate you, please die"}]'`
-- health check test example: `curl -v -X GET http://localhost:8081/health`
+- health check example: `curl -v -X GET http://localhost:8081/health`
+- invalid input example (error: 409): `curl -v -H 'content-type: application/json' -X POST http://localhost:8081 -d '[]'`
--- /dev/null
+INDICO_API_KEY=525f16078717a430f9dac17cdc9dbaa3
+++ /dev/null
-525f16078717a430f9dac17cdc9dbaa3
# -*- coding: utf-8 -*-
import json
import indicoio
+import os
from analysis import Analysis
from offline_analysis import Offline_Analysis
app = Flask(__name__)
api = Api(app)
-with open('indico_api_key.txt', 'r') as key:
- indicoio.config.api_key = key.read().replace('\n','')
+indicoio.config.api_key = os.environ['INDICO_API_KEY']
api.add_resource(Analysis, '/')
api.add_resource(Offline_Analysis, '/offline_analysis')
# Build runtime image
FROM microsoft/dotnet:2.2-aspnetcore-runtime
+LABEL maintainer="Fabian Eichhorner <fabian.eichhorner@tuwien.ac.at>"
WORKDIR /app
COPY --from=build-env /app/out .
EXPOSE 8083
ENV ASPNETCORE_URLS=http://+:8083
-# copy pdf library
-# COPY libwkhtmltox.* ./
-# install additional libaries
+# install pdf libaries
RUN apt-get update \
&& apt-get install -y --no-install-recommends \
zlib1g \
# PDF Service
+## API
Provides a REST-API to generate PDF reports for terms and their sentiment analysis results. The service uses an .NET Core wrapper for the wkhtmltopdf library to generate pdf out of html code.
`GET`: `/` Shows a demo page
```
- return: pdf file
+## API errors
+- `400`: request does not fulfil specification
+
### Term model
Term(string `Name`, double `Sentiment`)
## run with docker
-
-- `docker build -t service-reporting .`
-- `docker run -p YOUR_PORT:8083 service-reporting:latest`
+- `docker image build -t service-reporting .`
+- `docker container run -p YOUR_PORT:8083 service-reporting:latest`
## run local
### requirements
### commands
- `dotnet run`
-## Tests
+## examples
- successfull pdf as application/json: `curl -X POST http://localhost:8083/generatePDF -H 'Content-Type: application/json' -d '[ { "name": "A bad term", "sentiment": 0.1 }, { "name": "Another bad term", "sentiment": 0.3 }, { "name": "A neutral term", "sentiment": 0.5 }, { "name": "A good term", "sentiment": 0.65 }, { "name": "Another good term", "sentiment": 0.9 } ] ' -vs > test1.pdf`
- successfull pdf as application/base64: `curl -X POST http://localhost:8083/generatePDF -H 'Accept: application/base64' -H 'Content-Type: application/json' -d '[ { "name": "A bad term", "sentiment": 0.1 }, { "name": "Another bad term", "sentiment": 0.3 }, { "name": "A neutral term", "sentiment": 0.5 }, { "name": "A good term", "sentiment": 0.65 }, { "name": "Another good term", "sentiment": 0.9 } ] ' -vs | base64 -d > test2.pdf`
- invalid sentiment value: `curl -X POST http://localhost:8083/generatePDF -H 'Content-Type: application/json' -d '[ { "name": "Term with invalid sentiment value", "sentiment": 12 } ] ' -vs && echo`
-- invalid json structure: `curl -X POST http://localhost:8083/generatePDF -H 'Content-Type: application/json' -d '[ { "name1": "A term with invalid json format", "sentiment": 0.5 } ] ' -vs && echo`
\ No newline at end of file
+- invalid json structure: `curl -X POST http://localhost:8083/generatePDF -H 'Content-Type: application/json' -d '[ { "name1": "A term with invalid json format", "sentiment": 0.5 } ] ' -vs && echo`
README.md
*.iml
!/.mvn/wrapper/maven-wrapper.jar
+twitter.env
<component name="ProjectRunConfigurationManager">
<configuration default="false" name="TwitterServiceApplication" type="SpringBootApplicationConfigurationType" factoryName="Spring Boot">
<module name="service-twitter" />
+ <extension name="net.ashald.envfile">
+ <option name="IS_ENABLED" value="true" />
+ <option name="IS_SUBST" value="false" />
+ <option name="IS_PATH_MACRO_SUPPORTED" value="false" />
+ <option name="IS_IGNORE_MISSING_FILES" value="false" />
+ <ENTRIES>
+ <ENTRY IS_ENABLED="true" PARSER="runconfig" />
+ <ENTRY IS_ENABLED="true" PARSER="env" PATH="twitter.env" />
+ </ENTRIES>
+ </extension>
<option name="SPRING_BOOT_MAIN_CLASS" value="at.aic18.g6t4.servicetwitter.TwitterServiceApplication" />
<option name="ALTERNATIVE_JRE_PATH" />
<method v="2">
# Twitter Service
-
-
## API
+Provides a REST-API that mainly mirrors the search API from Twitter.
+The service uses the official Twitter API.
You can use the search under [http://localhost:8084/search/tweets.json?q=Google](http://localhost:8080/search/tweets.json?q=Google)
where `q` is your search string.
-It mainly mirrors the search API from Twitter. My implementation contains some basic fields with the same names as in
-the official API. If you need more, please let me know.
-
-
-### Example
-
-`curl -vs http://localhost:8084/search/tweets.json?q=Google `
-
-Pipe it into e.g. `jq` for a more readable output.
+`GET`: `/search/tweets.json?q=` returns tweets matching the given search term as a set of JSON objects
+- param: `q` search term
+example: `/search/tweets.json?q=example`
+`GET`: `/actuator/health` Returns HTTP Status 200 if service is running
+## API errors
+`TODO`
-## API Keys
-
-Unfortunately you have to provide your own API Keys, as sharing them is forbidden. In the worst case there would be five
-people using the same keys at the same time. This probably asks for a ban.
-
-I really don't want to risk it, as my application for a [Twitter Developer Platform](https://developer.twitter.com/)
-account was ridiculously complicated. You have to answer four questions, with at least 400 (?) words, and as detailed as
-possible. My application apparently wasn't detailed enough, so they asked me follow up questions. After two emails, one
-with ~1.200 words, they were finally satisfied.
-
+## external services
+This twitter service uses the online twitter api.
+Unfortunately you have to provide your own API Keys, as sharing them is forbidden. In the worst case there would be five people using the same keys at the same time. This probably asks for a ban.
+I really don't want to risk it, as my application for a [Twitter Developer Platform](https://developer.twitter.com/) account was ridiculously complicated. You have to answer four questions, with at least 400 (?) words, and as detailed as possible. My application apparently wasn't detailed enough, so they asked me follow up questions. After two emails, one with ~1.200 words, they were finally satisfied.
Furthermore people with an existing account, like I had, can't create new apps anymore, unless they apply again.
-
-So I would advise you to [apply for an account](https://developer.twitter.com/en/apply-for-access) yourself, or maybe
-ask someone else from the group if they have a spare key.
-
-The keys then go into `application.yml` below `oauth:`, i.e. `consumer-key`, `consumer-secret`, `access-token`,
-`access-token-secret`.
+So I would advise you to [apply for an account](https://developer.twitter.com/en/apply-for-access) yourself, or maybe ask someone else from the group if they have a spare key.
+The twitter api keys can be set in the file `twitter.env`.
+
+## run with docker
+- `docker image build -t service-twitter .`
+- `docker container run --env-file=twitter.env -d -p YOUR_PORT:8084 service-twitter:latest`
+
+## run local
+### requirements
+`TODO`
+### commands
+`TODO`
+
+## examples
+- API call example: `curl -vs http://localhost:8084/search/tweets.json?q=Google`
+ - Pipe it into e.g. `jq` for a more readable output.
+- health check test example: `curl -v -X GET http://localhost:8084/actuator/health`
twitter4j:
debug: false
oauth:
- consumer-key: "DnmBShVqvJ2xfnRjkAWtq644Z"
- consumer-secret: "YbP2oAdU9IyuYMAUxbyJn1NNKZ91jnOz1CpNKMSCjCR0Pu8JlJ"
- access-token: "2698046929-w0qbrGWkqKigFTkAaKCkFJc1XoixWG2FPTlU3i3"
- access-token-secret: "rx88CHkOLbXUuTHDHOdZLnnw5KDeMQkVD2ltlkqWqWmlP"
+ consumer-key: ${CONSUMER_KEY}
+ consumer-secret: ${CONSUMER_SECRET}
+ access-token: ${ACCESS_TOKEN}
+ access-token-secret: ${ACCESS_TOKEN_SECRET}
--- /dev/null
+CONSUMER_KEY=DnmBShVqvJ2xfnRjkAWtq644Z
+CONSUMER_SECRET=YbP2oAdU9IyuYMAUxbyJn1NNKZ91jnOz1CpNKMSCjCR0Pu8JlJ
+ACCESS_TOKEN=2698046929-w0qbrGWkqKigFTkAaKCkFJc1XoixWG2FPTlU3i3
+ACCESS_TOKEN_SECRET=rx88CHkOLbXUuTHDHOdZLnnw5KDeMQkVD2ltlkqWqWmlP
SomeNet / public repos / pub / jan / aic18.git / commitdiff