Update Readme documentations.

Author: pwei1018

.sonarcloud.properties

@@ -0,0 +1,18 @@
+sonar.projectName=sbc-pay
+sonar.projectVersion=Autoscan
+
+# Path to sources
+sonar.sources=pay-api/src, bcol-api/src, report-api/src
+#sonar.exclusions=
+#sonar.inclusions=
+
+# Path to tests
+sonar.tests=pay-api/tests/unit, bcol-api/tests/unit, report-api/tests/unit,
+#sonar.test.exclusions=
+#sonar.test.inclusions=
+
+# Source encoding
+sonar.sourceEncoding=UTF-8
+
+# Exclusions for copy-paste detection
+#sonar.cpd.exclusions=

CODE_OF_CONDUCT.md

@@ -0,0 +1,78 @@
+
+
+## Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of
+experience, nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at SBC_ITOperationsSupport@gov.bc.ca.
+All complaints will be reviewed and investigated and will result in a response
+that is deemed necessary and appropriate to the circumstances. The project team
+is obligated to maintain confidentiality with regard to the reporter of an
+incident. Further details of specific enforcement policies may be posted
+separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.4, available at
+[http://contributor-covenant.org/version/1/4][version].
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

CONTRIBUTING.md

@@ -0,0 +1,19 @@
+
+## How to Contribute
+
+Government employees, public and members of the private sector are encouraged to
+contribute to the repository by **forking and submitting a pull request**.
+
+(If you are new to GitHub, you might start with a
+[basic tutorial](https://help.github.com/articles/set-up-git) and check out a
+more detailed guide to
+[pull requests](https://help.github.com/articles/using-pull-requests/).)
+
+Pull requests will be evaluated by the repository guardians on a schedule and if
+deemed beneficial will be committed to the master.
+
+All contributors retain the original copyright to their stuff, but by
+contributing to this project, you grant a world-wide, royalty-free, perpetual,
+irrevocable, non-exclusive, transferable license to all users **under the terms
+of the license under which this project is distributed.**
+

README.md

@@ -1,3 +1,49 @@
 [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](LICENSE)
 
-[![Bugs](https://sonarqube-l4ygcl-tools.pathfinder.gov.bc.ca/api/badges/measure?key=BCRegistriesPayment&metric=bugs&template=FLAT)](https://sonarqube-l4ygcl-tools.pathfinder.gov.bc.ca/dashboard?id=BCRegistriesPayment) [![Vulnerabilities](https://sonarqube-l4ygcl-tools.pathfinder.gov.bc.ca/api/badges/measure?key=BCRegistriesPayment&metric=vulnerabilities&template=FLAT)](https://sonarqube-l4ygcl-tools.pathfinder.gov.bc.ca/dashboard?id=BCRegistriesPayment) [![Code smells](https://sonarqube-l4ygcl-tools.pathfinder.gov.bc.ca/api/badges/measure?key=BCRegistriesPayment&metric=code_smells&template=FLAT)](https://sonarqube-l4ygcl-tools.pathfinder.gov.bc.ca/dashboard?id=BCRegistriesPayment) [![Coverage](https://sonarqube-l4ygcl-tools.pathfinder.gov.bc.ca/api/badges/measure?key=BCRegistriesPayment&metric=coverage&template=FLAT)](https://sonarqube-l4ygcl-tools.pathfinder.gov.bc.ca/dashboard?id=BCRegistriesPayment) [![Duplication](https://sonarqube-l4ygcl-tools.pathfinder.gov.bc.ca/api/badges/measure?key=BCRegistriesPayment&metric=duplicated_lines_density&template=FLAT)](https://sonarqube-l4ygcl-tools.pathfinder.gov.bc.ca/dashboard?id=BCRegistriesPayment) [![Lines of code](https://sonarqube-l4ygcl-tools.pathfinder.gov.bc.ca/api/badges/measure?key=BCRegistriesPayment&metric=lines&template=FLAT)](https://sonarqube-l4ygcl-tools.pathfinder.gov.bc.ca/dashboard?id=BCRegistriesPayment)
+# BC Registiries payment services
+
+BC Registries and Online Services is beginning a phased, multi-year modernization initiative to replace and improve the applications used for BC Online, the Corporate, Personal Property and Manufactured Homes Registries. Our vision is to develop a better service experience and make it easier for citizens and businesses to complete transactions and filings with the province of BC and across other jurisdictions, manage accounts and pay for services.
+
+The sbc-pay repo aims to create an common payment module for BC registries which can be utilised by different services.
+For more information on the API please refer to:
+
+[pay-api\Readme](pay-api/README.md)
+
+For more information on the web component refer to:
+
+[bcol-api\Readme](bcol-api/README.md)
+
+For more information on the Notify API component refer to:
+
+[report-api\Readme](report-api/README.md)
+
+## How to Contribute
+
+If you would like to contribute, please see our [contributing](CONTRIBUTING.md)
+guidelines. Please note that this project is released with a
+[Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this
+project you agree to abide by its terms.
+
+## License
+
+    Copyright 2019 Province of British Columbia
+
+    Licensed under the Apache License, Version 2.0 (the "License"); you may not
+    use this file except in compliance with the License. You may obtain a copy
+    of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+    WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+    License for the specific language governing permissions and limitations
+    under the License.
+
+# Testing Thanks
+
+Thanks to BrowserStack for Testing Tool support via OpenSource Licensing
+
+[![BrowserStack](browserstack-logo-white-small.png)](http://browserstack.com/)
+
+

bcol-api/README.md

@@ -1,77 +1,43 @@
+[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](../LICENSE)
+[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=bcgov_sbc-pay&metric=alert_status)](https://sonarcloud.io/code?id=bcgov_sbc-pay&selected=bcgov_sbc-pay%3Abcol-api)
+[![codecov](https://codecov.io/gh/bcgov/sbc-pay/branch/master/graph/badge.svg)](https://codecov.io/gh/bcgov/sbc-pay)
 
-[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](LICENSE)
+# BCOL API
 
-[![Bugs](https://sonarqube-l4ygcl-tools.pathfinder.gov.bc.ca/api/badges/measure?key=BCRegistriesPayment&metric=bugs&template=FLAT)](https://sonarqube-l4ygcl-tools.pathfinder.gov.bc.ca/dashboard?id=BCRegistriesPayment) [![Vulnerabilities](https://sonarqube-l4ygcl-tools.pathfinder.gov.bc.ca/api/badges/measure?key=BCRegistriesPayment&metric=vulnerabilities&template=FLAT)](https://sonarqube-l4ygcl-tools.pathfinder.gov.bc.ca/dashboard?id=BCRegistriesPayment) [![Code smells](https://sonarqube-l4ygcl-tools.pathfinder.gov.bc.ca/api/badges/measure?key=BCRegistriesPayment&metric=code_smells&template=FLAT)](https://sonarqube-l4ygcl-tools.pathfinder.gov.bc.ca/dashboard?id=BCRegistriesPayment) [![Coverage](https://sonarqube-l4ygcl-tools.pathfinder.gov.bc.ca/api/badges/measure?key=BCRegistriesPayment&metric=coverage&template=FLAT)](https://sonarqube-l4ygcl-tools.pathfinder.gov.bc.ca/dashboard?id=BCRegistriesPayment) [![Duplication](https://sonarqube-l4ygcl-tools.pathfinder.gov.bc.ca/api/badges/measure?key=BCRegistriesPayment&metric=duplicated_lines_density&template=FLAT)](https://sonarqube-l4ygcl-tools.pathfinder.gov.bc.ca/dashboard?id=BCRegistriesPayment) [![Lines of code](https://sonarqube-l4ygcl-tools.pathfinder.gov.bc.ca/api/badges/measure?key=BCRegistriesPayment&metric=lines&template=FLAT)](https://sonarqube-l4ygcl-tools.pathfinder.gov.bc.ca/dashboard?id=BCRegistriesPayment)
+BC Registries BCOL payment service.
 
-# BC Registries Payment System
 
-## Technology Stack Used
-* Python, Flask
-* Postgres -  SQLAlchemy, psycopg2-binary & alembic 
+## Development Environment
 
-## Third-Party Products/Libraries used and the the License they are covert by
+Follow the instructions of the [Development Readme](https://github.com/bcgov/entity/blob/master/docs/development.md)
+to setup your local development environment.
 
-## Project Status
+## Development Setup
 
-## Documentation
+1. Follow the [instructions](https://github.com/bcgov/entity/blob/master/docs/setup-forking-workflow.md) to checkout the project from GitHub.
+2. Open the bcol-api directory in VS Code to treat it as a project (or WSL projec). To prevent version clashes, set up a
+virtual environment to install the Python packages used by this project.
+3. Run `make setup` to set up the virtual environment and install libraries.
+4. Next run `pip install .` to set up the environment for running tests.
 
-GitHub Pages (https://guides.github.com/features/pages/) are a neat way to document you application/project.
+You also need to set up the variables used for environment-specific settings:
+1. Copy the [dotenv template file](./docs/dotenv_template) to somewhere above the source code and rename to `.env`. You will need to fill in missing values.
 
-## Security
+## Running BCOL-API
 
-Future - BCGov Keycloak
+1. Start the flask server with `(python -m flask run -p 5000)`
+2. View the [OpenAPI Docs](http://127.0.0.1:5000/api/v1).
 
-Current - JWT hack
+## Running Liniting
 
-## Files in this repository
+1. Run `make flake8` or `flake8 src/bcol_api tests`.
+2. Run `make pylint` or `pylint --rcfile=setup.cfg --disable=C0301,W0511 src/bcol_api test`
 
-```
-docs/           - Project Documentation
-└── images        
-└── icons         
+## Running Unit Tests
 
-openshift/      - OpenShift-specific files
-├── scripts     - helper scripts
-└── templates   - application templates
-```
+1. Tests are run from the Status bar at the bottom of the workbench in VS Code or `pytest` command.
+2. Next run `make coverage` to generate the coverage report, which appears in the *htmlcov* directory.
 
-## Deployment (Local Development)
+## Openshift Environment
 
-* Developer Workstation Requirements/Setup
-* Application Specific Setup
-
-## Deployment (OpenShift)
-
-See (openshift/Readme.md)
-
-## Getting Help or Reporting an Issue
-
-To report bugs/issues/feature requests, please file an [issue](../../issues).
-
-
-## Code standards 
-
-Refer [checklist](https://github.com/bcgov/sbc-auth/wiki/API-code-review-checklist)
-
-## How to Contribute
-
-If you would like to contribute, please see our [CONTRIBUTING](./CONTRIBUTING.md) guidelines.
-
-Please note that this project is released with a [Contributor Code of Conduct](./CODE_OF_CONDUCT.md). 
-By participating in this project you agree to abide by its terms.
-
-## License
-
-    Copyright 2018 Province of British Columbia
-
-    Licensed under the Apache License, Version 2.0 (the "License");
-    you may not use this file except in compliance with the License.
-    You may obtain a copy of the License at
-
-       http://www.apache.org/licenses/LICENSE-2.0
-
-    Unless required by applicable law or agreed to in writing, software
-    distributed under the License is distributed on an "AS IS" BASIS,
-    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-    See the License for the specific language governing permissions and
-    limitations under the License.
+View the [document](https://github.com/bcgov/sbc-auth/blob/development/docs/build-deploy.md).

bcol-api/docs/dotenv_template

@@ -0,0 +1,46 @@
+#
+# This file contains the environment-specific settings that are read by python-dotenv. Place it somewhere above your
+# source code and it will be used.
+#
+
+# ===== bcol-api ======================================================================================================
+
+# Flask settings
+PYTHONWARNINGS="once"
+FLASK_APP=wsgi.py
+FLASK_ENV="development"
+FLASK_DEBUG=True
+POD_TESTING=True
+SQLALCHEMY_ECHO=False
+
+# The sentry.io Data Source Name for the project. For local development this should always be blank, to prevent the
+# logging (and emailing) of errors. However it can be temporarily set when working with sentry itself.
+#
+SENTRY_DSN=
+
+# keycloak settings
+JWT_OIDC_ISSUER=
+JWT_OIDC_WELL_KNOWN_CONFIG=
+JWT_OIDC_ALGORITHMS=
+JWT_OIDC_AUDIENCE=
+JWT_OIDC_CLIENT_SECRET=
+JWT_OIDC_JWKS_CACHE_TIMEOUT=
+
+KEYCLOAK_ADMIN_CLIENTID='
+KEYCLOAK_ADMIN_SECRET=
+KEYCLOAK_AUTH_AUDIENCE=
+KEYCLOAK_AUTH_CLIENT_SECRET=
+KEYCLOAK_BASE_URL=
+KEYCLOAK_REALMNAME=
+
+#application settings
+BCOL_VERIFY_USER_WSDL_URL=
+BCOL_QUERY_PROFILE_WSDL_URL=
+BCOL_DEBIT_ACCOUNT_VERSION=
+BCOL_LINK_CODE=
+BCOL_LDAP_USER_DN_PATTERN=
+BCOL_LDAP_SERVER=
+BCOL_PAYMENTS_WSDL_URL=
+
+
+

browserstack-logo-white-small.png

@@ -0,0 +1,55 @@
+version: "3.1"
+
+services:
+  ####################### AUTH Database Definition #######################
+  paydb:
+    image: postgres:11
+    restart: always
+    environment:
+      POSTGRES_DB: postgres
+      POSTGRES_PASSWORD: postgres
+    ports:
+      - "54332:5432"
+    volumes:
+      - db-data:/var/lib/postgresql/data2
+
+  ####################### AUTH Unit Test Database Definition #######################
+  paydb-test:
+    image: postgres:11
+    restart: always
+    environment:
+      POSTGRES_DB: postgres
+      POSTGRES_PASSWORD: postgres
+    ports:
+      - "54333:5432"
+    volumes:
+      - db-data:/var/lib/postgresql/data3
+
+  #################### Jaeger Tracing Service Definition ####################
+  jaeger:
+    image: jaegertracing/all-in-one
+    restart: always
+    ports:
+      - "16686:16686"
+      - "5775:5775/udp"
+      - "6831:6831/udp"
+      - "6832:6832/udp"
+
+  #################### Nats Service Definition ####################
+    nats:
+        image: nats-streaming
+        restart: always
+        mem_limit: 512m
+        expose:
+          - 4222
+          - 8222
+        labels:
+          - entity.services=nats
+        ports:
+          - 4222:4222
+          - 8222:8222
+        tty: true
+
+volumes:
+  db-data:
+    driver: local