bluefly / gov_compliance
Government compliance module for security policies and regulatory requirements
0.1.0
2025-07-27 17:47 UTC
Requires
- php: >=8.1
- drupal/core: ^10.3 || ^11
Requires (Dev)
- drupal/core-dev: ^10.3 || ^11
- phpspec/prophecy-phpunit: ^2.0
- phpunit/phpunit: ^10
Suggests
- drupal/admin_audit_trail: Enhanced audit logging (^1.0)
- drupal/captcha: Bot prevention (^2.0)
- drupal/encrypt: Field encryption support (^3.2)
- drupal/field_encrypt: Encrypt sensitive data fields (^3.2)
- drupal/flood_control: Brute force protection (^3.0)
- drupal/key: Key management for encryption (^1.20)
- drupal/password_policy: Password compliance enforcement (^4.0)
- drupal/seckit: Security hardening (^2.0)
- drupal/security_review: Automated security scanning (^3.0)
- drupal/tfa: Two-factor authentication (^1.11)
- firebase/php-jwt: JWT authentication support (^6.0)
This package is auto-updated.
Last update: 2025-08-04 12:27:21 UTC
README
Repository Information
- Type: Drupal Module (Git Submodule)
- GitLab URL: https://gitlab.bluefly.io/llm/gov_compliance
- Submodule Path: web/modules/custom/gov_compliance
- Local Path: /Users/flux423/Sites/LLM/llm-platform/web/modules/custom/gov_compliance
Integration Steps
Navigate to Individual Repository
# This module is a git submodule, work in its individual repo cd /path/to/individual/gov_compliance/repository
Copy OpenAPI Specification
cp openapi.yaml ./
Create Contract Testing Structure
mkdir -p tests/src/Functional mkdir -p tests/features
Add PHPUnit Configuration
<!-- phpunit.xml --> <testsuite name="gov_compliance API Contract Tests"> <directory>tests/src/Functional</directory> <file>tests/src/Functional/*ApiContractTest.php</file> </testsuite>
Configure JSON:API Entities
# JSON:API is built into Drupal 10 core, just needs configuration drush en rest restui serialization hal -y drush cr
Update GitLab CI
include: - component: gitlab.bluefly.io/llm/gitlab_components/components/ci-cd/drupal/template@latest - component: gitlab.bluefly.io/llm/gitlab_components/components/testing/comprehensive-testing@latest drupal_api_validation: extends: .drupal_base script: - drush en rest restui serialization hal -y - drush cr - vendor/bin/phpunit tests/src/Functional/*ApiContractTest.php
Commit Changes
git add . git commit -m "feat: implement API-first architecture for Drupal module - Add OpenAPI 3.1 specification with JSON:API endpoints - Implement PHPUnit contract tests - Configure REST and JSON:API endpoints - Enable API-first development workflow 🤖 Generated with API-First Transformation Co-Authored-By: Claude <noreply@anthropic.com>" git push origin main
JSON:API Endpoints
- Entities: /jsonapi/gov_compliance/gov_compliance
- Custom API: /api/v1/gov_compliance/*
- Health Check: /api/v1/gov_compliance/health
Production Deployment
- Main Platform: https://llm.llm.bluefly.io/api/v1/gov_compliance
- JSON:API: https://llm.llm.bluefly.io/jsonapi/gov_compliance
- Documentation: https://docs.llm.bluefly.io/api-docs/gov_compliance
Local Development
- Main Platform: https://llm.local.bluefly.io/api/v1/gov_compliance
- JSON:API: https://llm.local.bluefly.io/jsonapi/gov_compliance
- Port Access: http://llm.local.bluefly.io:33000/api/v1/gov_compliance