Skip to content

feat: add checker for pin by id #19

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
musale wants to merge 9 commits into
base: main
Choose a base branch
from
Open

feat: add checker for pin by id #19

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
c2e3662
Update .gitignore to include .env and improve README formatting for c…
musale Aug 22, 2025
4741108
Enhance KRA PIN validation and telemetry handling; add tests for grac…
musale Aug 22, 2025
a90332c
feat: Introduce AsyncGavaConnect and CheckersClient for asynchronous …
musale Aug 22, 2025
1521bab
Update gavaconnect/checkers/_pin.py
musale Aug 25, 2025
0c6e4bd
Refactor code for improved readability and maintainability; update co…
musale Aug 25, 2025
5740f5b
Merge branch 'fix/auth-issues' of https://github.com/acoruss/gavaconn…
musale Aug 25, 2025
61de94f
chore: Add Makefile for test automation and update coverage reports; …
musale Aug 25, 2025
288010a
chore: Update Makefile to include additional tasks for coverage, lint…
musale Aug 25, 2025
d10923a
chore: Update bandit target in Makefile to scan the 'gavaconnect' dir…
musale Aug 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file modified .coverage
View file
Open in desktop
Binary file not shown.
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,4 @@ wheels/

# Virtual environments
.venv
.env
25 changes: 25 additions & 0 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
.PHONY: test build testcoverage dev-build ruff-check ruff-format mypy bandit

test:
uv run pytest -v --disable-warnings --maxfail=1

test-coverage:
uv run pytest --cov=src --cov-report=xml --disable-warnings --maxfail=1

build:
uv build

dev-build:
uv build --wheel

ruff-check:
uv run ruff check .

ruff-format:
uv run ruff format .

mypy:
uv run mypy .

bandit:
uv run bandit -r gavaconnect/
69 changes: 66 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,11 +40,74 @@ uv install

## Quick Start

### Basic SDK Usage

```python
import gavaconnect

# Create configuration
config = gavaconnect.SDKConfig(base_url="https://sbx.kra.go.ke")

# Work with errors and basic types
try:
# Your API calls here
pass
except gavaconnect.APIError as e:
print(f"API Error: {e.status} - {e.message}")
```

### PIN Validation (requires httpx and pydantic)

```python
from gavaconnect import main
from gavaconnect.facade_async import AsyncGavaConnect
from gavaconnect.config import SDKConfig

async def validate_pin():
config = SDKConfig(base_url="https://sbx.kra.go.ke")

async with AsyncGavaConnect(
config,
checkers_client_id="your_client_id",
checkers_client_secret="your_client_secret"
) as sdk:
result = await sdk.checkers.validate_pin(pin="A000000000B")
print(result.model_dump(by_alias=True))
# Output: {"PIN": "A000000000B", "TaxPayerName": "...", "status": "VALID", "valid": true}

# Run the async function
import asyncio
asyncio.run(validate_pin())
```

# Basic usage example
main()
### Advanced Usage

```python
from gavaconnect.resources.checkers import CheckersClient, PinCheckResult
from gavaconnect.auth import BasicTokenEndpointProvider, BasicPair, BearerAuthPolicy
from gavaconnect.http.transport import AsyncTransport

# Manual client setup for advanced use cases
async def advanced_usage():
config = SDKConfig(base_url="https://sbx.kra.go.ke")
transport = AsyncTransport(config)

# Setup authentication
provider = BasicTokenEndpointProvider(
token_url="https://sbx.kra.go.ke/v1/token/generate",
basic=BasicPair("client_id", "client_secret"),
method="GET"
)
auth = BearerAuthPolicy(provider)

# Create client
client = CheckersClient(transport, auth)

# Use different validation methods
result1 = await client.validate_pin(pin="A000000000B")
result2 = await client.validate_pin_get(pin="A000000000B", query_key="PIN")
result3 = await client.validate_pin_raw({"PIN": "A000000000B", "extra": "data"})

await transport.close()
```

## Development
Expand Down
190 changes: 155 additions & 35 deletions coverage.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<?xml version="1.0" ?>
<coverage version="7.10.4" timestamp="1755799158948" lines-valid="280" lines-covered="280" line-rate="1" branches-valid="44" branches-covered="44" branch-rate="1" complexity="0">
<coverage version="7.10.4" timestamp="1756124928264" lines-valid="367" lines-covered="367" line-rate="1" branches-valid="50" branches-covered="50" branch-rate="1" complexity="0">
<!-- Generated by coverage.py: https://coverage.readthedocs.io/en/7.10.4 -->
<!-- Based on https://raw.githubusercontent.com/cobertura/web/master/htdocs/xml/coverage-04.dtd -->
<sources>
Expand All @@ -15,7 +15,7 @@
<line number="4" hits="1"/>
<line number="5" hits="1"/>
<line number="6" hits="1"/>
<line number="8" hits="1"/>
<line number="12" hits="1"/>
</lines>
</class>
<class name="_version.py" filename="_version.py" complexity="0" line-rate="1" branch-rate="1">
Expand Down Expand Up @@ -64,6 +64,29 @@
<line number="41" hits="1"/>
</lines>
</class>
<class name="facade_async.py" filename="facade_async.py" complexity="0" line-rate="1" branch-rate="1">
<methods/>
<lines>
<line number="3" hits="1"/>
<line number="5" hits="1"/>
<line number="6" hits="1"/>
<line number="7" hits="1"/>
<line number="8" hits="1"/>
<line number="10" hits="1"/>
<line number="13" hits="1"/>
<line number="16" hits="1"/>
<line number="33" hits="1"/>
<line number="34" hits="1"/>
<line number="37" hits="1"/>
<line number="43" hits="1"/>
<line number="45" hits="1"/>
<line number="47" hits="1"/>
<line number="49" hits="1"/>
<line number="56" hits="1"/>
<line number="58" hits="1"/>
<line number="60" hits="1"/>
</lines>
</class>
</classes>
</package>
<package name="auth" line-rate="1" branch-rate="1" complexity="0">
Expand All @@ -74,7 +97,8 @@
<line number="3" hits="1"/>
<line number="4" hits="1"/>
<line number="5" hits="1"/>
<line number="7" hits="1"/>
<line number="6" hits="1"/>
<line number="8" hits="1"/>
</lines>
</class>
<class name="basic.py" filename="auth/basic.py" complexity="0" line-rate="1" branch-rate="1">
Expand Down Expand Up @@ -117,35 +141,76 @@
<line number="87" hits="1"/>
</lines>
</class>
<class name="credentials.py" filename="auth/credentials.py" complexity="0" line-rate="1" branch-rate="1">
<methods/>
<lines>
<line number="3" hits="1"/>
<line number="6" hits="1"/>
<line number="7" hits="1"/>
<line number="10" hits="1"/>
<line number="11" hits="1"/>
</lines>
</class>
<class name="providers.py" filename="auth/providers.py" complexity="0" line-rate="1" branch-rate="1">
<methods/>
<lines>
<line number="3" hits="1"/>
<line number="4" hits="1"/>
<line number="6" hits="1"/>
<line number="5" hits="1"/>
<line number="7" hits="1"/>
<line number="9" hits="1"/>
<line number="12" hits="1"/>
<line number="32" hits="1"/>
<line number="38" hits="1"/>
<line number="42" hits="1"/>
<line number="43" hits="1"/>
<line number="45" hits="1"/>
<line number="15" hits="1"/>
<line number="18" hits="1"/>
<line number="40" hits="1"/>
<line number="46" hits="1"/>
<line number="49" hits="1"/>
<line number="50" hits="1"/>
<line number="52" hits="1"/>
<line number="54" hits="1"/>
<line number="55" hits="1"/>
<line number="56" hits="1"/>
<line number="57" hits="1"/>
<line number="58" hits="1"/>
<line number="60" hits="1"/>
<line number="64" hits="1"/>
<line number="65" hits="1"/>
<line number="66" hits="1"/>
<line number="67" hits="1"/>
<line number="68" hits="1" branch="true" condition-coverage="100% (2/2)"/>
<line number="69" hits="1"/>
<line number="70" hits="1"/>
<line number="71" hits="1"/>
<line number="73" hits="1"/>
<line number="76" hits="1"/>
<line number="77" hits="1" branch="true" condition-coverage="100% (2/2)"/>
<line number="78" hits="1"/>
<line number="79" hits="1"/>
<line number="80" hits="1"/>
<line number="81" hits="1"/>
<line number="82" hits="1"/>
<line number="89" hits="1"/>
<line number="90" hits="1"/>
<line number="91" hits="1"/>
<line number="94" hits="1"/>
<line number="97" hits="1"/>
<line number="117" hits="1"/>
<line number="118" hits="1"/>
<line number="119" hits="1"/>
<line number="120" hits="1"/>
<line number="121" hits="1"/>
<line number="122" hits="1"/>
<line number="124" hits="1"/>
<line number="126" hits="1"/>
<line number="128" hits="1"/>
<line number="130" hits="1" branch="true" condition-coverage="100% (2/2)"/>
<line number="131" hits="1"/>
<line number="133" hits="1"/>
<line number="135" hits="1"/>
<line number="136" hits="1"/>
<line number="137" hits="1"/>
<line number="138" hits="1"/>
<line number="142" hits="1"/>
<line number="149" hits="1"/>
<line number="150" hits="1" branch="true" condition-coverage="100% (2/2)"/>
<line number="151" hits="1"/>
<line number="152" hits="1"/>
<line number="153" hits="1"/>
<line number="155" hits="1"/>
<line number="162" hits="1"/>
<line number="163" hits="1"/>
<line number="164" hits="1"/>
</lines>
</class>
</classes>
Expand All @@ -162,13 +227,21 @@
<class name="_pin.py" filename="checkers/_pin.py" complexity="0" line-rate="1" branch-rate="1">
<methods/>
<lines>
<line number="1" hits="1"/>
<line number="4" hits="1"/>
<line number="5" hits="1"/>
<line number="7" hits="1"/>
<line number="8" hits="1" branch="true" condition-coverage="100% (2/2)"/>
<line number="3" hits="1"/>
<line number="6" hits="1"/>
<line number="9" hits="1"/>
<line number="10" hits="1"/>
<line number="16" hits="1"/>
<line number="18" hits="1"/>
<line number="25" hits="1" branch="true" condition-coverage="100% (2/2)"/>
<line number="26" hits="1"/>
<line number="29" hits="1"/>
<line number="32" hits="1" branch="true" condition-coverage="100% (2/2)"/>
<line number="33" hits="1"/>
<line number="36" hits="1" branch="true" condition-coverage="100% (2/2)"/>
<line number="37" hits="1"/>
<line number="40" hits="1" branch="true" condition-coverage="100% (2/2)"/>
<line number="41" hits="1"/>
<line number="43" hits="1"/>
</lines>
</class>
</classes>
Expand Down Expand Up @@ -251,19 +324,13 @@
<methods/>
<lines>
<line number="3" hits="1"/>
<line number="4" hits="1"/>
<line number="6" hits="1"/>
<line number="9" hits="1"/>
<line number="5" hits="1"/>
<line number="16" hits="1"/>
<line number="19" hits="1"/>
<line number="22" hits="1"/>
<line number="30" hits="1"/>
<line number="31" hits="1" branch="true" condition-coverage="100% (2/2)"/>
<line number="32" hits="1"/>
<line number="33" hits="1"/>
<line number="34" hits="1" branch="true" condition-coverage="100% (2/2)"/>
<line number="35" hits="1"/>
<line number="23" hits="1"/>
<line number="24" hits="1"/>
<line number="36" hits="1"/>
<line number="44" hits="1"/>
<line number="45" hits="1"/>
</lines>
</class>
<class name="transport.py" filename="http/transport.py" complexity="0" line-rate="1" branch-rate="1">
Expand Down Expand Up @@ -385,5 +452,58 @@
</class>
</classes>
</package>
<package name="resources" line-rate="1" branch-rate="1" complexity="0">
<classes>
<class name="__init__.py" filename="resources/__init__.py" complexity="0" line-rate="1" branch-rate="1">
<methods/>
<lines>
<line number="6" hits="1"/>
</lines>
</class>
</classes>
</package>
<package name="resources.checkers" line-rate="1" branch-rate="1" complexity="0">
<classes>
<class name="__init__.py" filename="resources/checkers/__init__.py" complexity="0" line-rate="1" branch-rate="1">
<methods/>
<lines>
<line number="3" hits="1"/>
<line number="5" hits="1"/>
</lines>
</class>
<class name="_pin.py" filename="resources/checkers/_pin.py" complexity="0" line-rate="1" branch-rate="1">
<methods/>
<lines>
<line number="3" hits="1"/>
<line number="5" hits="1"/>
<line number="7" hits="1"/>
<line number="8" hits="1"/>
<line number="9" hits="1"/>
<line number="12" hits="1"/>
<line number="15" hits="1"/>
<line number="16" hits="1"/>
<line number="17" hits="1"/>
<line number="18" hits="1"/>
<line number="20" hits="1"/>
<line number="23" hits="1"/>
<line number="26" hits="1"/>
<line number="34" hits="1"/>
<line number="35" hits="1"/>
<line number="37" hits="1"/>
<line number="48" hits="1"/>
<line number="49" hits="1"/>
<line number="51" hits="1"/>
<line number="64" hits="1"/>
<line number="70" hits="1"/>
<line number="71" hits="1"/>
<line number="73" hits="1"/>
<line number="83" hits="1"/>
<line number="84" hits="1"/>
<line number="91" hits="1"/>
<line number="92" hits="1"/>
</lines>
</class>
</classes>
</package>
</packages>
</coverage>
4 changes: 4 additions & 0 deletions gavaconnect/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@
from .config import SDKConfig
from .errors import APIError, RateLimitError, SDKError, TransportError

# Note: AsyncGavaConnect and CheckersClient require httpx and pydantic
# Import them explicitly: from gavaconnect.facade_async import AsyncGavaConnect
# or from gavaconnect.resources.checkers import CheckersClient

__all__ = [
"__version__",
"SDKConfig",
Expand Down
Loading
Loading