geek-cafe-saas-sdk 0.6.0__tar.gz

geek_cafe_saas_sdk-0.6.0/.env.mock

@@ -0,0 +1,22 @@
+# let's make sure we don't hit any actual aws resources
+# when running moto mock tests
+AWS_ACCESS_KEY_ID="testing"
+AWS_SECRET_ACCESS_KEY="testing"
+AWS_SECURITY_TOKEN="testing"
+AWS_SESSION_TOKEN="testing"
+AWS_DEFAULT_REGION="us-east-1"
+AWS_REGION="us-east-1"
+# So far it looks like I need a profile or I get an error like the one below
+# "The config profile (<profile>) could not be found" 
+# "The config profile () could not be found" <- if using the default profile
+# AWS_PROFILE="default"
+# AWS_DEFAULT_PROFILE="default"
+# I don't want to use default profile, so I'm using a mock profile
+# However it must exist in ~/.aws/config or you'll get the same error above
+AWS_PROFILE="moto-mock-tests"
+AWS_DEFAULT_PROFILE="moto-mock-tests"
+
+COGNITO_USER_POOL="us-east-1_ABC123"
+COGNITO_CLIENT_ID="fake-client-id"
+DYNAMODB_TABLE_NAME="geek_cafe_main"
+AWS_REGION="us-east-1"

geek_cafe_saas_sdk-0.6.0/.gitignore

@@ -0,0 +1,151 @@
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+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/
+cover/
+reports/
+
+# 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
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .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
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# 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/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#.idea/
+
+# VS Code
+#.vscode/
+# Local configuration
+.pysetup.json
+
+activate.sh
+.pypirc
+.prompts
+.DS_Store
+.local

geek_cafe_saas_sdk-0.6.0/.windsurf/rules/cascade.yaml

@@ -0,0 +1,9 @@
+rules:
+  - name: Documentation Standards
+    path: docs/guidelines/DOCUMENTATION_STANDARDS.md
+    description: File naming and structure conventions
+  - name: Production Ready
+    path: docs/guidelines/PRODUCTION_READY.md
+    description: Production ready conventions
+  - name: Testing Standards
+    

geek_cafe_saas_sdk-0.6.0/ARCHITECTURE.md

@@ -0,0 +1,278 @@
+# Architecture Overview
+
+## Project Structure
+
+```
+geek-cafe-services/
+├── src/geek_cafe_saas_sdk/
+│   ├── core/                      # Foundational types and patterns
+│   │   ├── service_result.py      # Standardized service response wrapper
+│   │   ├── service_errors.py      # Common error types
+│   │   └── audit_mixin.py         # Audit trail functionality
+│   │
+│   ├── models/                    # DynamoDB models
+│   │   ├── base_model.py          # Base model with common patterns
+│   │   ├── event.py               # Event model
+│   │   ├── user.py                # User model
+│   │   ├── group.py               # Group model
+│   │   ├── message_thread.py      # Message thread model
+│   │   ├── vote.py                # Vote model
+│   │   └── website_analytics.py   # Analytics models
+│   │
+│   ├── services/                  # Business logic layer
+│   │   ├── database_service.py    # Base database service
+│   │   ├── event_service.py       # Event operations
+│   │   ├── user_service.py        # User operations
+│   │   ├── group_service.py       # Group operations
+│   │   ├── message_thread_service.py  # Message operations
+│   │   ├── vote_service.py        # Vote operations
+│   │   └── vote_tally_service.py  # Vote aggregation
+│   │
+│   ├── lambda_handlers/           # AWS Lambda handlers
+│   │   ├── _base/                 # Internal base handlers
+│   │   │   ├── base_handler.py
+│   │   │   ├── api_key_handler.py
+│   │   │   ├── public_handler.py
+│   │   │   └── service_pool.py
+│   │   ├── events/                # ✅ Complete CRUDL
+│   │   ├── users/                 # ✅ Complete CRUDL
+│   │   ├── groups/                # ✅ Complete CRUDL
+│   │   ├── messages/              # ✅ Complete CRUDL
+│   │   └── votes/                 # ✅ Complete CRUDL
+│   │
+│   ├── middleware/                # Cross-cutting concerns
+│   │   ├── auth.py                # Authentication middleware
+│   │   ├── cors.py                # CORS handling
+│   │   ├── error_handling.py      # Error middleware
+│   │   └── validation.py          # Request validation
+│   │
+│   └── utilities/                 # Helper utilities
+│       ├── response.py            # HTTP response builders
+│       ├── lambda_event_utility.py # Lambda event parsing
+│       ├── dynamodb_utils.py      # DynamoDB helpers
+│       ├── jwt_utility.py         # JWT handling
+│       └── custom_exceptions.py   # Custom exceptions
+│
+├── tests/                         # Test suite
+│   ├── common/                    # Shared test utilities
+│   ├── test_*_service.py          # Service tests
+│   ├── test_lambda_handlers/      # Handler integration tests
+│   └── test_*.py                  # Various test files
+│
+└── docs/                          # Documentation
+    ├── api/                       # API documentation
+    ├── guides/                    # Usage guides
+    └── services/                  # Service documentation
+```
+
+## Design Principles
+
+### 1. Multi-Tenant by Default
+Every resource is scoped by `tenant_id`, ensuring complete data isolation between customers.
+
+```python
+# All service methods require tenant_id
+result = event_service.create(
+    tenant_id="tenant-123",
+    user_id="user-456",
+    title="My Event"
+)
+```
+
+### 2. Consistent Service Pattern
+All services follow the same pattern:
+
+- **ServiceResult wrapper**: Consistent return type for success/error handling
+- **CRUD operations**: Create, Read, Update, Delete with soft deletes
+- **Access control**: Built-in tenant and user validation
+- **Error handling**: Standardized error responses
+
+```python
+# Every service method returns ServiceResult
+result: ServiceResult[Event] = service.create(...)
+
+if result.success:
+    event = result.data
+else:
+    error = result.error
+```
+
+### 3. Lambda Handler Infrastructure
+
+**Base Handlers** (`_base/`)
+- `BaseLambdaHandler`: Core handler functionality
+- `ApiKeyLambdaHandler`: Adds API key validation
+- `PublicLambdaHandler`: No authentication required
+- `ServicePool`: Connection pooling for warm starts
+
+**Resource Handlers** (events, users, groups, messages, votes)
+- Each resource has complete CRUDL operations
+- Consistent authentication via Cognito JWT
+- Service pooling for performance
+- Testability via service injection
+
+### 4. DynamoDB Optimization
+
+**Single Table Design**
+- One table for all resources
+- Efficient GSI indexes for common queries
+- Tenant-isolated partitions
+
+**Key Patterns**
+```python
+# Primary Key (PK/SK)
+PK: "TENANT#{tenant_id}"
+SK: "EVENT#{event_id}"
+
+# GSI for user queries
+GSI1PK: "USER#{user_id}"
+GSI1SK: "ts#{timestamp}"
+```
+
+### 5. Testing Strategy
+
+**Integration Tests**
+- Use `moto` for DynamoDB mocking
+- Service injection for handler testing
+- Complete end-to-end workflows
+
+**Test Fixtures**
+- `db_helpers.py`: DynamoDB setup helpers
+- `lambda_helpers.py`: Event builders and test utilities
+
+```python
+# Clean test pattern
+def test_create_event(integration_setup, helper):
+    db, event_service = integration_setup
+    
+    event = helper.build_proxy_event(body={"title": "Test"})
+    response = handler(event, None, injected_service=event_service)
+    
+    assert response['statusCode'] == 201
+```
+
+## Key Features
+
+### Service Pooling
+Reduces Lambda cold starts by 80-90% through connection reuse:
+
+```python
+# Module level - initialized once
+service_pool = ServicePool(EventService)
+
+def handler(event, context):
+    # Reuses service on warm invocations
+    service = service_pool.get()
+```
+
+### Authentication Flow
+1. API Gateway validates Cognito JWT
+2. Claims passed in `requestContext.authorizer.claims`
+3. Handler extracts `custom:user_id` and `custom:tenant_id`
+4. Service enforces tenant isolation
+
+### Error Handling
+Consistent error responses across all handlers:
+
+```python
+{
+  "statusCode": 400,
+  "body": {
+    "error": "Validation failed",
+    "errorCode": "VALIDATION_ERROR"
+  }
+}
+```
+
+### Soft Deletes
+Resources are marked as deleted, not physically removed:
+
+```python
+# Delete operation
+result = service.delete(resource_id, tenant_id, user_id)
+# Sets: deleted=True, deleted_at=timestamp
+```
+
+## Performance Optimizations
+
+1. **Service Pooling**: Reuse DB connections on warm starts
+2. **GSI Indexes**: Efficient queries without table scans  
+3. **Batch Operations**: Support for bulk reads/writes
+4. **Pagination**: Cursor-based pagination for large result sets
+
+## Security Features
+
+1. **Tenant Isolation**: Every query scoped by tenant_id
+2. **Soft Deletes**: Audit trail preservation
+3. **Access Control**: User-level permissions per operation
+4. **JWT Validation**: Via API Gateway authorizer
+
+## Extension Points
+
+### Adding New Resources
+
+1. **Create Model** in `models/`
+2. **Create Service** in `services/`
+3. **Create Lambda Handlers** in `lambda_handlers/`
+4. **Write Tests** following existing patterns
+
+### Custom Middleware
+
+Add to `middleware/` and apply to handlers:
+
+```python
+@custom_middleware
+@handle_cors
+@handle_errors
+def lambda_handler(event, context):
+    pass
+```
+
+### Custom Validators
+
+Extend validation in `utilities/` or add per-service validation.
+
+## Deployment
+
+### As a Library
+```bash
+pip install geek-cafe-services
+```
+
+### Lambda Deployment
+Each handler directory is deployment-ready:
+
+```bash
+# AWS SAM
+sam deploy --code-uri lambda_handlers/events/create
+
+# AWS CDK
+lambda.Function(this, 'EventCreate', {
+  code: lambda.Code.fromAsset('lambda_handlers/events/create'),
+  handler: 'app.handler'
+})
+```
+
+## Best Practices
+
+1. ✅ Always use `ServiceResult` for service responses
+2. ✅ Require `tenant_id` for all operations
+3. ✅ Use soft deletes, never hard deletes
+4. ✅ Pool services in Lambda handlers
+5. ✅ Inject services in tests
+6. ✅ Follow CRUDL pattern for consistency
+7. ✅ Document breaking changes until 1.0 GA
+
+## Version Information
+
+- **Current Version**: 0.3.0
+- **Python**: 3.13+
+- **Status**: Pre-1.0 (breaking changes possible)
+- **Test Coverage**: 83.7% (482 tests)
+
+## References
+
+- **Service Pattern**: `docs/services_pattern.md`
+- **Lambda Handlers**: `docs/api/lambda_handlers.md`
+- **Handler Structure**: `docs/guides/lambda_handler_structure.md`
+- **DynamoDB Models**: `docs/dynamodb_models.md`