Compare commits
1 Commits
documentat
...
dev-prodip
Author | SHA1 | Date | |
---|---|---|---|
2c6ab3d96d |
26
.drone.yml
26
.drone.yml
@ -30,32 +30,6 @@ steps:
|
|||||||
- docker push "$DOCKER_USERNAME/consumer_api"
|
- docker push "$DOCKER_USERNAME/consumer_api"
|
||||||
- docker push "$DOCKER_USERNAME/consumer_api:$DRONE_BUILD_NUMBER"
|
- docker push "$DOCKER_USERNAME/consumer_api:$DRONE_BUILD_NUMBER"
|
||||||
|
|
||||||
- name: make_docs
|
|
||||||
image: python:3.8
|
|
||||||
commands:
|
|
||||||
- pip3 install Sphinx sphinx_rtd_theme
|
|
||||||
- pip3 install -r requirements.txt
|
|
||||||
- cd docs
|
|
||||||
- make html
|
|
||||||
|
|
||||||
- name: build_docs
|
|
||||||
image: docker:stable-dind
|
|
||||||
volumes:
|
|
||||||
- name: dockersock
|
|
||||||
path: /var/run
|
|
||||||
environment:
|
|
||||||
DOCKER_USERNAME:
|
|
||||||
from_secret: DOCKER_USERNAME
|
|
||||||
DOCKER_PASSWORD:
|
|
||||||
from_secret: DOCKER_PASSWORD
|
|
||||||
commands:
|
|
||||||
- cd docs
|
|
||||||
- echo "$DOCKER_PASSWORD" | docker login -u "$DOCKER_USERNAME" --password-stdin
|
|
||||||
- docker build -t="$DOCKER_USERNAME/consumer-api-docs" .
|
|
||||||
- docker build -t="$DOCKER_USERNAME/consumer-api-docs:$DRONE_BUILD_NUMBER" .
|
|
||||||
- docker push "$DOCKER_USERNAME/consumer-api-docs"
|
|
||||||
- docker push "$DOCKER_USERNAME/consumer-api-docs:$DRONE_BUILD_NUMBER"
|
|
||||||
|
|
||||||
- name: slack
|
- name: slack
|
||||||
image: plugins/slack
|
image: plugins/slack
|
||||||
settings:
|
settings:
|
||||||
|
12
README.rst
12
README.rst
@ -1,12 +0,0 @@
|
|||||||
================
|
|
||||||
P2P Consumer API
|
|
||||||
================
|
|
||||||
|
|
||||||
Repository for the consumer's API
|
|
||||||
|
|
||||||
implemented interfaces / functionalities:
|
|
||||||
|
|
||||||
* consumer
|
|
||||||
* log
|
|
||||||
* sync
|
|
||||||
|
|
@ -8,8 +8,6 @@ from flask_classful import FlaskView
|
|||||||
class ConsumersView(FlaskView):
|
class ConsumersView(FlaskView):
|
||||||
|
|
||||||
def get(self):
|
def get(self):
|
||||||
# load the currently available consumer list from the redis database
|
|
||||||
consumer_list = json.loads((redis_client.get("consumer_list") or b"{}").decode('utf-8'))
|
consumer_list = json.loads((redis_client.get("consumer_list") or b"{}").decode('utf-8'))
|
||||||
|
current_app.logger.warning(jsonify([v['ip'] for k, v in consumer_list.items()]))
|
||||||
# jsonify and return the list of active consumers
|
|
||||||
return jsonify([v['ip'] for k, v in consumer_list.items()])
|
return jsonify([v['ip'] for k, v in consumer_list.items()])
|
||||||
|
@ -1,12 +1,31 @@
|
|||||||
from flask import request, current_app, Response
|
from flask import request, current_app, Response
|
||||||
from flask_classful import FlaskView
|
from flask_classful import FlaskView
|
||||||
|
from db import redis_client
|
||||||
|
|
||||||
|
|
||||||
class LogView(FlaskView):
|
class LogView(FlaskView):
|
||||||
|
|
||||||
def post(self):
|
def post(self):
|
||||||
# display received message
|
# Record the IP address of the producer
|
||||||
|
remote_uuid = request.json['uuid']
|
||||||
|
remote_ip = request.remote_addr
|
||||||
|
|
||||||
|
prod_key = f"producer_{remote_uuid}"
|
||||||
|
|
||||||
|
last_known_remote_ip = redis_client.get(prod_key)
|
||||||
|
if last_known_remote_ip:
|
||||||
|
last_known_remote_ip = last_known_remote_ip.decode('utf-8')
|
||||||
|
|
||||||
|
if not last_known_remote_ip:
|
||||||
|
current_app.logger.info(f"New producer {remote_uuid} at {remote_ip}")
|
||||||
|
elif last_known_remote_ip != remote_ip:
|
||||||
|
current_app.logger.info(f"IP address of producer {remote_uuid} have changed: {last_known_remote_ip} -> {remote_ip}")
|
||||||
|
|
||||||
|
# update expirity
|
||||||
|
redis_client.set(prod_key, remote_ip.encode('utf-8'))
|
||||||
|
redis_client.expire(prod_key, 240)
|
||||||
|
|
||||||
|
# print out message
|
||||||
current_app.logger.info(f"New message: {request.json['message']}")
|
current_app.logger.info(f"New message: {request.json['message']}")
|
||||||
|
|
||||||
# return HTTP 204 - No content message
|
return Response(status=204)
|
||||||
return Response(status = 204)
|
|
||||||
|
@ -1,7 +1,7 @@
|
|||||||
import json
|
import json
|
||||||
from flask import request, current_app, jsonify
|
from flask import request, current_app, jsonify
|
||||||
from flask_classful import FlaskView
|
from flask_classful import FlaskView
|
||||||
from db import redis_client
|
from db import redis_client # ez nagyon otvar
|
||||||
|
|
||||||
|
|
||||||
class SyncView(FlaskView):
|
class SyncView(FlaskView):
|
||||||
@ -10,25 +10,23 @@ class SyncView(FlaskView):
|
|||||||
remote_uuid = request.json['uuid']
|
remote_uuid = request.json['uuid']
|
||||||
remote_ip = request.remote_addr
|
remote_ip = request.remote_addr
|
||||||
|
|
||||||
# load the currently available consumer list from the redis database
|
|
||||||
consumer_list = json.loads((redis_client.get("consumer_list") or b"{}").decode('utf-8'))
|
consumer_list = json.loads((redis_client.get("consumer_list") or b"{}").decode('utf-8'))
|
||||||
|
|
||||||
|
# Log something about it
|
||||||
if remote_uuid not in consumer_list.keys():
|
if remote_uuid not in consumer_list.keys():
|
||||||
# display newly registered consumer
|
|
||||||
current_app.logger.info(f"New consumer registered (unknown UUID): {remote_uuid} at {remote_ip}")
|
current_app.logger.info(f"New consumer registered (unknown UUID): {remote_uuid} at {remote_ip}")
|
||||||
else:
|
else: # known
|
||||||
if consumer_list[remote_uuid]['ip'] != remote_ip:
|
if consumer_list[remote_uuid]['ip'] != remote_ip:
|
||||||
# log address changes
|
|
||||||
current_app.logger.info(f"Address of consumer {remote_uuid} changed to {remote_ip}")
|
current_app.logger.info(f"Address of consumer {remote_uuid} changed to {remote_ip}")
|
||||||
|
|
||||||
# update consumer list redis databasse
|
|
||||||
consumer_list.update(
|
consumer_list.update(
|
||||||
{remote_uuid: {"ip": remote_ip}}
|
{remote_uuid: {"ip": remote_ip}}
|
||||||
)
|
)
|
||||||
|
|
||||||
redis_client.set("consumer_list", json.dumps(consumer_list).encode('utf-8'))
|
redis_client.set("consumer_list", json.dumps(consumer_list).encode('utf-8'))
|
||||||
|
|
||||||
# return with the current UUID
|
|
||||||
response = {
|
response = {
|
||||||
"uuid": current_app.config['LOCAL_UUID']
|
"uuid": current_app.config['LOCAL_UUID']
|
||||||
}
|
}
|
||||||
|
|
||||||
return jsonify(response)
|
return jsonify(response)
|
||||||
|
@ -1,3 +0,0 @@
|
|||||||
FROM nginx:latest
|
|
||||||
|
|
||||||
COPY _build/html/ /usr/share/nginx/html
|
|
@ -1,20 +0,0 @@
|
|||||||
# Minimal makefile for Sphinx documentation
|
|
||||||
#
|
|
||||||
|
|
||||||
# You can set these variables from the command line, and also
|
|
||||||
# from the environment for the first two.
|
|
||||||
SPHINXOPTS ?=
|
|
||||||
SPHINXBUILD ?= sphinx-build
|
|
||||||
SOURCEDIR = .
|
|
||||||
BUILDDIR = _build
|
|
||||||
|
|
||||||
# Put it first so that "make" without argument is like "make help".
|
|
||||||
help:
|
|
||||||
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|
|
||||||
|
|
||||||
.PHONY: help Makefile
|
|
||||||
|
|
||||||
# Catch-all target: route all unknown targets to Sphinx using the new
|
|
||||||
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
|
|
||||||
%: Makefile
|
|
||||||
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|
|
55
docs/conf.py
55
docs/conf.py
@ -1,55 +0,0 @@
|
|||||||
# Configuration file for the Sphinx documentation builder.
|
|
||||||
#
|
|
||||||
# This file only contains a selection of the most common options. For a full
|
|
||||||
# list see the documentation:
|
|
||||||
# https://www.sphinx-doc.org/en/master/usage/configuration.html
|
|
||||||
|
|
||||||
# -- Path setup --------------------------------------------------------------
|
|
||||||
|
|
||||||
# If extensions (or modules to document with autodoc) are in another directory,
|
|
||||||
# add these directories to sys.path here. If the directory is relative to the
|
|
||||||
# documentation root, use os.path.abspath to make it absolute, like shown here.
|
|
||||||
#
|
|
||||||
# import os
|
|
||||||
# import sys
|
|
||||||
# sys.path.insert(0, os.path.abspath('.'))
|
|
||||||
|
|
||||||
|
|
||||||
# -- Project information -----------------------------------------------------
|
|
||||||
|
|
||||||
project = 'Consumer API'
|
|
||||||
copyright = '2020, GoldenPogacsa Inc.'
|
|
||||||
author = 'GoldenPogacsa Inc.'
|
|
||||||
|
|
||||||
# The full version, including alpha/beta/rc tags
|
|
||||||
release = '0.1.0'
|
|
||||||
|
|
||||||
|
|
||||||
# -- General configuration ---------------------------------------------------
|
|
||||||
|
|
||||||
# Add any Sphinx extension module names here, as strings. They can be
|
|
||||||
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
|
||||||
# ones.
|
|
||||||
extensions = [
|
|
||||||
]
|
|
||||||
|
|
||||||
# Add any paths that contain templates here, relative to this directory.
|
|
||||||
templates_path = []
|
|
||||||
|
|
||||||
# List of patterns, relative to source directory, that match files and
|
|
||||||
# directories to ignore when looking for source files.
|
|
||||||
# This pattern also affects html_static_path and html_extra_path.
|
|
||||||
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
|
|
||||||
|
|
||||||
|
|
||||||
# -- Options for HTML output -------------------------------------------------
|
|
||||||
|
|
||||||
# The theme to use for HTML and HTML Help pages. See the documentation for
|
|
||||||
# a list of builtin themes.
|
|
||||||
#
|
|
||||||
html_theme = 'sphinx_rtd_theme'
|
|
||||||
|
|
||||||
# Add any paths that contain custom static files (such as style sheets) here,
|
|
||||||
# relative to this directory. They are copied after the builtin static files,
|
|
||||||
# so a file named "default.css" will overwrite the builtin "default.css".
|
|
||||||
html_static_path = []
|
|
@ -1,23 +0,0 @@
|
|||||||
.. Consumer API documentation master file, created by
|
|
||||||
sphinx-quickstart on Wed Apr 8 21:31:18 2020.
|
|
||||||
You can adapt this file completely to your liking, but it should at least
|
|
||||||
contain the root `toctree` directive.
|
|
||||||
|
|
||||||
Welcome to Consumer API's documentation!
|
|
||||||
========================================
|
|
||||||
|
|
||||||
.. toctree::
|
|
||||||
:maxdepth: 2
|
|
||||||
:caption: Contents:
|
|
||||||
|
|
||||||
readme
|
|
||||||
source/modules
|
|
||||||
|
|
||||||
|
|
||||||
Indices and tables
|
|
||||||
==================
|
|
||||||
|
|
||||||
* :ref:`genindex`
|
|
||||||
* :ref:`modindex`
|
|
||||||
* :ref:`search`
|
|
||||||
* `Git repository <https://git.kmlabz.com/GoldenPogacsa/consumer-api>`_
|
|
@ -1,35 +0,0 @@
|
|||||||
@ECHO OFF
|
|
||||||
|
|
||||||
pushd %~dp0
|
|
||||||
|
|
||||||
REM Command file for Sphinx documentation
|
|
||||||
|
|
||||||
if "%SPHINXBUILD%" == "" (
|
|
||||||
set SPHINXBUILD=sphinx-build
|
|
||||||
)
|
|
||||||
set SOURCEDIR=.
|
|
||||||
set BUILDDIR=_build
|
|
||||||
|
|
||||||
if "%1" == "" goto help
|
|
||||||
|
|
||||||
%SPHINXBUILD% >NUL 2>NUL
|
|
||||||
if errorlevel 9009 (
|
|
||||||
echo.
|
|
||||||
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
|
|
||||||
echo.installed, then set the SPHINXBUILD environment variable to point
|
|
||||||
echo.to the full path of the 'sphinx-build' executable. Alternatively you
|
|
||||||
echo.may add the Sphinx directory to PATH.
|
|
||||||
echo.
|
|
||||||
echo.If you don't have Sphinx installed, grab it from
|
|
||||||
echo.http://sphinx-doc.org/
|
|
||||||
exit /b 1
|
|
||||||
)
|
|
||||||
|
|
||||||
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
|
|
||||||
goto end
|
|
||||||
|
|
||||||
:help
|
|
||||||
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
|
|
||||||
|
|
||||||
:end
|
|
||||||
popd
|
|
@ -1 +0,0 @@
|
|||||||
.. include:: ../README.rst
|
|
@ -1,7 +0,0 @@
|
|||||||
app module
|
|
||||||
==========
|
|
||||||
|
|
||||||
.. automodule:: app
|
|
||||||
:members:
|
|
||||||
:undoc-members:
|
|
||||||
:show-inheritance:
|
|
@ -1,7 +0,0 @@
|
|||||||
db module
|
|
||||||
=========
|
|
||||||
|
|
||||||
.. automodule:: db
|
|
||||||
:members:
|
|
||||||
:undoc-members:
|
|
||||||
:show-inheritance:
|
|
@ -1,9 +0,0 @@
|
|||||||
consumer_api
|
|
||||||
============
|
|
||||||
|
|
||||||
.. toctree::
|
|
||||||
:maxdepth: 4
|
|
||||||
|
|
||||||
app
|
|
||||||
db
|
|
||||||
views
|
|
@ -1,38 +0,0 @@
|
|||||||
views package
|
|
||||||
=============
|
|
||||||
|
|
||||||
Submodules
|
|
||||||
----------
|
|
||||||
|
|
||||||
views.consumers\_view module
|
|
||||||
----------------------------
|
|
||||||
|
|
||||||
.. automodule:: views.consumers_view
|
|
||||||
:members:
|
|
||||||
:undoc-members:
|
|
||||||
:show-inheritance:
|
|
||||||
|
|
||||||
views.log\_view module
|
|
||||||
----------------------
|
|
||||||
|
|
||||||
.. automodule:: views.log_view
|
|
||||||
:members:
|
|
||||||
:undoc-members:
|
|
||||||
:show-inheritance:
|
|
||||||
|
|
||||||
views.sync\_view module
|
|
||||||
-----------------------
|
|
||||||
|
|
||||||
.. automodule:: views.sync_view
|
|
||||||
:members:
|
|
||||||
:undoc-members:
|
|
||||||
:show-inheritance:
|
|
||||||
|
|
||||||
|
|
||||||
Module contents
|
|
||||||
---------------
|
|
||||||
|
|
||||||
.. automodule:: views
|
|
||||||
:members:
|
|
||||||
:undoc-members:
|
|
||||||
:show-inheritance:
|
|
Reference in New Issue
Block a user