gimacpay 0.1.0__tar.gz

gimacpay-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,76 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    name: Python ${{ matrix.python-version }} on ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest]
+        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
+        include:
+          # One run on Windows, because the package advertises OS independence
+          # and the development machine is Windows.
+          - os: windows-latest
+            python-version: "3.13"
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install the package and its development tools
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e ".[dev]"
+
+      - name: Lint
+        run: ruff check .
+
+      - name: Test
+        run: pytest -q
+
+      - name: Check the formatting of the public API
+        run: ruff format --check .
+
+  no-dependencies:
+    name: Prove there are no runtime dependencies
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+
+      - name: Install only the package, with no extras
+        run: pip install .
+
+      - name: Import with site-packages disabled
+        run: |
+          # -S removes site-packages from sys.path, so this import can only
+          # succeed through PYTHONPATH=src. If the package imported anything
+          # third-party, it would fail here -- that is the proof.
+          PYTHONPATH=src python -S -c "import gimacpay; print('gimacpay', gimacpay.__version__)"
+
+      - name: Assert the dependency list is empty
+        run: |
+          python - <<'PY'
+          import importlib.metadata as md
+          requires = md.requires("gimacpay") or []
+          runtime = [r for r in requires if "extra ==" not in r]
+          assert not runtime, f"runtime dependencies found: {runtime}"
+          print("no runtime dependencies declared")
+          PY

gimacpay-0.1.0/.github/workflows/release.yml

@@ -0,0 +1,113 @@
+name: Release
+
+on:
+  push:
+    tags: ["v*"]
+  workflow_dispatch:
+    inputs:
+      confirm:
+        description: 'Type "publish" to upload to PyPI'
+        required: true
+        default: "no"
+
+permissions:
+  contents: read
+
+jobs:
+  # ------------------------------------------------------------------ #
+  # 1. Build, and attach the artifacts to a GitHub Release on a tag push.
+  # ------------------------------------------------------------------ #
+  build:
+    name: Build and attach
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+
+      - name: Resolve the tag being released
+        id: ref
+        run: |
+          if [ "${{ github.event_name }}" = "workflow_dispatch" ]; then
+            tag=$(git tag -l 'v*' --sort=-v:refname | head -n1)
+            if [ -z "$tag" ]; then
+              echo "no v* tag found; tag a release before publishing" >&2
+              exit 1
+            fi
+            echo "manual dispatch: building $tag"
+            git checkout --detach "refs/tags/$tag"
+            echo "tag=$tag" >> "$GITHUB_OUTPUT"
+          else
+            echo "tag push: building ${{ github.ref_name }}"
+            echo "tag=${{ github.ref_name }}" >> "$GITHUB_OUTPUT"
+          fi
+
+      - name: Install the build tools
+        run: |
+          python -m pip install --upgrade pip build twine
+
+      - name: Build
+        run: python -m build
+
+      - name: Check the artifacts
+        run: |
+          twine check dist/*
+          python scripts/check_wheel.py dist
+
+      - name: Verify the tests pass on the tagged commit
+        run: |
+          pip install -e ".[dev]"
+          pytest -q
+
+      - name: Attach the artifacts to the GitHub Release
+        if: github.event_name == 'push'
+        uses: softprops/action-gh-release@v2
+        with:
+          files: |
+            dist/*.whl
+            dist/*.tar.gz
+          generate_release_notes: true
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  # ------------------------------------------------------------------ #
+  # 2. Publish to PyPI. Manual only, and only with an explicit confirmation.
+  #
+  # A tag push deliberately does NOT publish. PyPI is a one-way door: a
+  # released version can be yanked, never replaced. So the tag builds and
+  # attaches, and a human decides when the irreversible step happens.
+  #
+  # Uses trusted publishing over OIDC -- no API token is stored anywhere.
+  # Configure the publisher at https://pypi.org/manage/account/publishing/
+  # ------------------------------------------------------------------ #
+  publish:
+    name: Publish to PyPI
+    needs: build
+    runs-on: ubuntu-latest
+    if: >-
+      github.event_name == 'workflow_dispatch'
+      && github.event.inputs.confirm == 'publish'
+    environment:
+      name: pypi
+      url: https://pypi.org/p/gimacpay
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - name: List what is about to be published
+        run: ls -la dist/
+
+      - uses: pypa/gh-action-pypi-publish@release/v1

gimacpay-0.1.0/.gitignore

@@ -0,0 +1,47 @@
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+.Python
+build/
+dist/
+*.egg-info/
+*.egg
+.eggs/
+
+# Environnements virtuels
+.venv/
+venv/
+env/
+ENV/
+
+# Tests et couverture
+.pytest_cache/
+.coverage
+.coverage.*
+htmlcov/
+.tox/
+.nox/
+
+# Outils
+.ruff_cache/
+.mypy_cache/
+.dmypy.json
+
+# Éditeurs
+.vscode/
+.idea/
+*.swp
+*.swo
+
+# Système
+.DS_Store
+Thumbs.db
+
+# Secrets — ne jamais committer d'identifiants GIMACPay
+.env
+.env.*
+!.env.example
+*.pem
+*.key

gimacpay-0.1.0/CHANGELOG.md

@@ -0,0 +1,51 @@
+# Journal des modifications
+
+Le format suit [Keep a Changelog](https://keepachangelog.com/fr/1.1.0/).
+Le versionnage suit [SemVer](https://semver.org/lang/fr/).
+
+---
+
+## [Non publié]
+
+Rien pour l'instant.
+
+---
+
+## [0.1.0] — 2026-10-10
+
+Première version. Implémente la spécification *GIMACPay Swagger for payments issuers*
+version 1.8 (fichier `gimac-api-1.10.yaml`).
+
+### Ajouté
+
+- `GimacPayClient` : authentification OAuth 2.0 (flux password), cache du jeton avec marge
+  de sécurité de 60 s, rafraîchissement automatique sur un 401 puis nouvel essai unique.
+- Les trois points d'entrée de la spécification : `send_payment` (`/payment/send`),
+  `inquiry` (`/payment/inquiry`), `update_payment` (`/payment/update`).
+- `await_state` et `send_and_resolve` : suivent un paiement jusqu'à un état terminal en
+  interrogeant GIMACPay, sans jamais deviner.
+- Les 24 valeurs de `intent`, avec leurs champs requis dérivés des exemples travaillés de la
+  spécification.
+- Dix constructeurs de requêtes (`wallet_to_wallet`, `merchant_purchase`, `request_to_pay`,
+  `bill_inquiry`, `bill_payment`, `cash_in`, `cash_deposit`, `cash_out`, `mobile_reload`,
+  `account_inquiry`) plus `build` pour les huit transferts et tout ce qui viendra.
+- Modèles typés : `Payment`, `PaymentState`, `AccountInfo`, `CustomerData`, `Bill`.
+- `normalise_phone` et `validate_amount` : les deux pièges de terrain que la spécification
+  laisse ouverts.
+- Hiérarchie d'exceptions distinguant **rejet** (`PaymentRejected`) et **état inconnu**
+  (`PaymentStateUnknown`) — des classes sœurs, jamais liées par héritage.
+- Ligne de commande `gimacpay` : `intents`, `doctor`, `build`, `send` (avec `--confirm`
+  obligatoire).
+- **Zéro dépendance d'exécution.**
+
+### Notes
+
+- Aucune sandbox publique n'existe : le bloc `servers` de la spécification pointe sur
+  `localhost`. La bibliothèque a été développée et testée contre un serveur local qui
+  implémente le protocole documenté, **jamais contre une instance réelle de GIMACPAY**.
+- Deux incohérences de la spécification sont documentées et verrouillées par des tests :
+  `mobile_reload` est absent de l'énumération `Payment.intent` alors qu'il figure dans le
+  `oneOf` de `/payment/send`, et `wallet_to_account` y est listé deux fois.
+
+[Non publié]: https://github.com/bryand410/gimacpay/compare/v0.1.0...HEAD
+[0.1.0]: https://github.com/bryand410/gimacpay/releases/tag/v0.1.0

gimacpay-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,101 @@
+# Contribuer
+
+Merci. Ce dépôt implémente une spécification qui n'appartient pas à ses contributeurs, donc
+la première règle est simple : **la spécification est l'autorité.**
+
+## Avant de proposer quoi que ce soit
+
+```bash
+python -m venv .venv && . .venv/bin/activate     # Windows : .venv\Scripts\activate
+pip install -e ".[dev]"
+pytest
+ruff check .
+```
+
+Les deux doivent passer. La suite est rapide et n'a pas besoin de réseau : elle démarre un
+serveur HTTP local qui parle le protocole documenté.
+
+## Les règles du dépôt
+
+### 1. Zéro dépendance d'exécution
+
+Non négociable. Voir `SECURITY.md` pour le raisonnement. Une pull request qui ajoute une
+entrée à `[project].dependencies` sera refusée, même pour quelque chose d'aussi banal que
+`requests`. `urllib` fait le travail.
+
+Les dépendances de développement sont libres.
+
+### 2. Ne jamais deviner l'état d'un paiement
+
+C'est la règle centrale, tirée de la spécification :
+
+> Participants should not guess the state if it's not given by GIMACPay.
+
+Concrètement, dans le code :
+
+- Un code de réponse non documenté produit `PaymentStateUnknown`, **jamais**
+  `PaymentRejected`.
+- `PaymentStateUnknown` et `PaymentRejected` restent des classes **sœurs**. Ne les faites
+  jamais hériter l'une de l'autre.
+- Une erreur de transport ne doit pas être transformée en échec du paiement.
+- Un `200` ne signifie pas « accepté ». Vérifiez `payment.state`.
+
+Si votre changement touche à ça, ajoutez un test qui échoue sans lui.
+
+### 3. La spécification est la source, pas la mémoire
+
+Les tables de `intents.py` sont dérivées de `docs/reference/gimac-api-1.10.yaml`. Les tests
+comparent les deux. Si GIMAC publie une nouvelle version de la spécification :
+
+1. remplacez le fichier dans `docs/reference/` ;
+2. lancez `pytest` — les tests de version et d'énumération échoueront et vous diront quoi
+   mettre à jour ;
+3. mettez à jour `REQUIRED_FIELDS` à partir des nouveaux exemples.
+
+Ne devinez pas les champs requis. Ils viennent des exemples travaillés de la spécification,
+qui sont les seules charges utiles normatives qu'elle publie.
+
+### 4. La licence de la spécification
+
+`docs/reference/gimac-api-1.10.yaml` porte `license: Private`. Il est présent comme
+référence de développement et **exclu de tout artefact publié** (voir l'exclusion `sdist`
+dans `pyproject.toml`). Ne le déplacez pas dans `src/`, ne l'embarquez pas dans le paquet,
+ne le publiez pas ailleurs.
+
+### 5. Style
+
+`ruff` décide, pas vous et pas moi. `line-length = 100`, `target-version = "py39"`.
+
+Les docstrings expliquent **pourquoi**, pas **quoi**. Le code dit déjà ce qu'il fait. Une
+docstring qui paraphrase la signature est du bruit ; une docstring qui explique pourquoi le
+`except` est dans cet ordre vaut de l'or.
+
+Quand un comportement vient d'une bizarrerie de la spécification, citez la spécification.
+Les numéros de ligne bougent, les citations non.
+
+## Signaler une incohérence de la spécification
+
+Si vous en trouvez une :
+
+1. Ajoutez un test qui la verrouille, nommé d'après elle, avec un commentaire expliquant ce
+   qu'un participant en conclurait de travers.
+2. Signalez-la à GIMAC (`info@gimac-afr.org`) — c'est leur spécification.
+
+Deux exemples déjà traités dans `tests/test_intents.py` : `mobile_reload` absent de
+l'énumération `Payment.intent`, et `wallet_to_account` dupliqué.
+
+## Signaler une faille
+
+Pas d'issue publique. Voir `SECURITY.md`.
+
+## Commits
+
+Un changement par commit, un message qui dit *pourquoi*. « Corrige un bug » n'aide personne ;
+« Un 500 ne doit pas être rapporté comme un rejet » dit tout.
+
+## Publication
+
+Les publications se font depuis `main` via GitHub Actions, avec publication de confiance
+PyPI (OIDC) — aucun jeton d'API n'est stocké nulle part. Une publication est une porte à sens
+unique : une version publiée sur PyPI se *yank*, elle ne se remplace pas. Étiquetez, laissez
+la CI construire, vérifiez l'artefact, puis publiez.

gimacpay-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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.