Giter VIP home page Giter VIP logo

gob-stuf's Introduction

GOB-StUF

GOB StUF provides for StUF access

It serves as a proxy and transparantly forwards requests to a StUF server

Requirements

* docker-compose >= 1.17
* docker ce >= 18.03
* python >= 3.6

Notes

  • Both a certificate and a VPN are required to access the underlying StUF service.

  • SoapUI can be used to test the StUF service.

StUF endpoint

The service definition that is exposed is:

http://localhost:<<GOB_STUF_PORT>><<ROUTE_NETLOC>>?wsdl

eg:

http://localhost:8165/SomePath/MijnService?wsdl

The StUF endpoint is reported at startup of the service.

REST endpoints

This service also exposes REST endpoints that in the background perform StUF requests to obtain the requested data.

See REST endpoints for a more detailed explanation.

Installation

Local

Create a virtual environment:

virtualenv env
source venv/bin/activate
pip install -r src/requirements.txt

Or activate the previously created virtual environment

source venv/bin/activate

Set the environment variables (see also next paragraph)

export $(cat .env | xargs)

Start the StUF service

cd src
python -m gobstuf

The service is default exposed at:

The IP address of the server is also reported at stdout on startup the API

Environment

The StUF service needs to be configured using environment variables:

  • ROUTE_SCHEME
    The scheme of the proxied path, default https
  • ROUTE_NETLOC The domain of the proxied path
  • ROUTE_PATH The path that is proxied by the StUF service
  • PKCS12_FILENAME
    The file where the certificate is stored
  • PKCS12_PASSWORD The password for the certificate file
  • GOB_STUF_PORT The port at which the service listens for requests, default 8165

The environment variables should be stored in a .env file (included in .gitignore)

An example can be found in .env.example. The example connects to a public number conversion soap service

The variables can be set using:

export $(cat .env | xargs)

Tests

cd src
sh test.sh

Docker

docker-compose build
docker-compose up

The API is exposed at the same address as for the local installation.

Tests

docker-compose -f src/.jenkins/test/docker-compose.yml build
docker-compose -f src/.jenkins/test/docker-compose.yml run --rm test

gob-stuf's People

Contributors

jkoetsier avatar vegter avatar jasper-jager avatar roel-devries avatar onnologchies avatar kelpas avatar koenw avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.