Release of 1.0.0rc1

Author: zulquer

.coveragerc

@@ -0,0 +1,6 @@
+[run]
+source =
+    src
+    tests
+omit =
+  env/

.env.example

@@ -0,0 +1 @@
+API_KEY=

.github/workflows/code-quality.yaml

@@ -0,0 +1,67 @@
+name: Code quality checks
+
+on:
+  pull_request:
+    branches:
+      - master
+  push:
+    branches:
+      - master
+
+jobs:
+  code-quality:
+    name: Code quality checks
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: [ '3.8', '3.9', '3.10', '3.11', '3.12', '3.13']
+    steps:
+      - name: Checkout master repository
+        uses: actions/checkout@v4
+        with:
+          path: ./multisafepay-python
+
+      - name: Clone MultiSafepay docker python
+        uses: actions/checkout@v4
+        with:
+          repository: MultiSafepay/docker-python
+          token: ${{ secrets.GLOBAL_GITHUB_TOKEN }}
+          path: ./docker-python
+          submodules: 'false'
+
+      - name: Setup submodule
+        run: |
+          rm -rf ./docker-python/packages-source/multisafepay/multisafepay-python
+          mv ./multisafepay-python ./docker-python/packages-source/multisafepay/multisafepay-python
+
+      - name: Copy environment file
+        run: cp .env.example .env
+        working-directory: ./docker-python
+
+      - name: Replace environment variable
+        run: sed -i "s/^PYTHON_VERSION=.*/PYTHON_VERSION=${{ matrix.python-version }}/" .env
+        working-directory: ./docker-python
+
+      - name: Setup containers and application
+        run: bin/setup
+        working-directory: ./docker-python
+
+      - name: Run linting
+        run: bin/lint
+        working-directory: ./docker-python
+
+      - name: Static type checker
+        run: bin/static-type-check
+        working-directory: ./docker-python
+
+      - name: Run tests
+        run: bin/test-report
+        working-directory: ./docker-python
+
+      - name: Upload coverage file to Codecov
+        uses: codecov/codecov-action@v5
+        with:
+          fail_ci_if_error: true
+          files: ./docker-python/packages-source/multisafepay/multisafepay-python/coverage.xml
+          token: ${{ secrets.CODECOV_TOKEN }}
+          verbose: true

.gitignore

@@ -0,0 +1,132 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# Mac files
+.DS_Store

.pre-commit-config.yaml

@@ -0,0 +1,38 @@
+repos:
+-   repo: local
+    hooks:
+
+    -   id: format-check
+        name: Format code check
+        entry: docker compose exec -T app make format-check
+        language: system
+        always_run: true
+        pass_filenames: false
+
+    -   id: lint
+        name: Run all linters
+        entry: docker compose exec -T app make lint
+        language: system
+        always_run: true
+        pass_filenames: false
+
+    -   id: static-type-check
+        name: Static type checker
+        entry: docker compose exec -T app make static-type-check
+        language: system
+        always_run: true
+        pass_filenames: false
+
+    -   id: test
+        name: Run tests
+        entry: docker compose exec -T app make test
+        language: system
+        always_run: true
+        pass_filenames: false
+
+    - id: test-e2e
+      name: Run tests e2e
+      entry: docker compose exec -T app make test-e2e
+      language: system
+      always_run: true
+      pass_filenames: false

CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# 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 someone listed as a [project maintainer](README.md#maintainers).
+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 [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

CONTRIBUTING.md

@@ -0,0 +1,56 @@
+# Contributing Guidelines
+
+🎉 First off, thanks for taking the time to contribute! 🎉
+
+The following is a set of guidelines for contributing to this repository.
+
+Before contributing, we encourage you to also read our [LICENSE](LICENSE) and [README](README.md) files, also found in this repository. If you have any questions not answered by the content of this repository, please don't hesitate to post in the discussions thread.
+
+## How Can I Contribute?
+
+### Report a bug
+
+If you think you have found a bug in this tool, we'd love your help identifying and fixing it. To do so, please follow these guidelines:
+
+1. **Search the issue list:** Check to see if anyone has reported a similar issue. If so, comment on that issue with additional details or context.
+1. **Use the issue template** If no one else has reported it yet, please submit a new issue and select the `Bug Report` template. This is populated with the following sections:
+    - **Overview:** Succinctly describe the behavior you observed after following the steps and point out what exactly is the problem with that behavior
+    - **Steps to Reproduce:** Describe the exact steps which reproduce the problem in as many details as possible. For example, start by explaining how you got to the page where you encountered the bug.
+    - **Expected Behavior:** Explain which behavior you expected to see instead, why, and how the behavior you saw failed to meet that expectation.
+    - **Screenshots:** Include screenshots and animated GIFs if possible, which show you following the described steps and clearly demonstrate the problem.
+    - **Your Environment:** List the technical details about your computer and/or development environment.
+1. **Check the Bug Tracker:** Check the status of your bug by referencing the Bug Tracker project board on the project tab.
+
+### Request new functionality
+
+If you don't have specific language or code to submit but would like to suggest a change, request a feature,
+or have something addressed, we'd love to get your feedback. To request new functionality, please follow these guidelines:
+
+1. **Search the issue list:** Check the list of existing issues to see if anyone has requested a similar feature or functionality. If so, feel free to comment on that issue with more context or details.
+1. **Use the issue template** If no one else has requested something similar, please submit a new issue and select the `Feature Request` template. This is populated with the following sections:
+    - **Feature Overview:** Brief description of the feature you want added to this tool. Along with some details about how it should function and whether it's related to a specific problem you're encountering.
+    - **Alternatives Considered:** What other options might exist to achieve the same functionality with the existing tool. Why aren't those workarounds sufficient.
+    - **Additional Context:** Anything else we should know about this request?
+1. **Check the Feature Roadmap:** Check the status of your request by referencing the Feature Roadmap project board on the project tab.
+
+> **NOTE:** Not all feature requests will be implemented. The project maintainers will review each feature request and consider scoping it into the roadmap or explaining why the feature won't be implemented.
+
+### Contribute to the codebase
+
+If you've implemented a new feature, fixed a bug, or made some documentation clearer, we'd love to consider your contribution to this tool. In order to submit a contribution, please follow these steps:
+
+1. **Fork the repo:** Create a copy of this repo where you can make your proposed changes by [following the Github forking methodology](https://docs.github.com/en/github/getting-started-with-github/quickstart/fork-a-repo).
+1. **Find or create an issue:** Before proposing a change, make sure there is a corresponding issue (i.e. Bug Fix, Task, Feature Request) that describes the contribution you'll be making. If there isn't an existing issue, create a new one by selecting and filling out a template from the issue tab.
+1. **Create a feature branch:** Create a feature branch on your forked repository with a descriptive name, ideally one that references the issue number that your contribution is related to (e.g., `issue-10-unit-testing`).
+1. **Make changes and test them:** Add your code or documentation and commit those changes to the feature branch. If your contribution includes code, make sure you've written tests for it and that all of the tests are passing.
+1. **Submit a pull request** When you're ready to make your contribution, [submit a pull request against the upstream repo.](https://docs.github.com/en/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork) and fill out the PR template sections so that project maintainers can begin to review your contributions.
+1. **Fix requested changes:** As maintainers review your proposed contribution, they may request specific changes. If so, simply add and commit those changes to the feature branch directly and they'll automatically show up on the PR.
+1. **Celebrate:** Once all of the requested changes are made, your commits will be merged into the `main` branch. Time to give yourself a hand because you just added to this project!!!
+
+
+## Resources
+
+To learn more about contributing best practices or how to use GitHub for code collaboration, don't hesitate to check these resources out:
+
+- [GitHub Tutorials](https://lab.github.com/)
+- [How to contribute to open source software](https://opensource.guide/how-to-contribute/)