QueryWise 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 54b05c02cde4d1128bd14c5411cddd7f8914d9a0927b31f0e29fe8d79c5fc2c3
+  data.tar.gz: 397dbad0080d557015e899e7947ede50abd6838148d7310a271af8f9c88f846a
+SHA512:
+  metadata.gz: bae2762aa237b5aa1e6f3c15507375563af9d0dbfe0695bbada5fae4964b90b253d1fab7b6342645e71a7f43ff77cc78d39212b3cb14ba0432fcfd8f97f472a7
+  data.tar.gz: 872c2502a91532593df69231669e13af7276c41d4ffb72ee947cf9e9e0c15cb2bed5fac6c4cf1c2eaefaf47a195a22f65b9a17c1f5b9404600457eaf31446154

data/CHANGELOG.md

@@ -0,0 +1,45 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.1.0] - 2024-01-15
+
+### Added
+- Initial release of Query Optimizer Client gem
+- Basic API client for Rails Database Query Optimizer API
+- N+1 query detection integration
+- Slow query analysis integration
+- Missing index detection integration
+- Rails middleware for automatic query monitoring
+- CI/CD integration with threshold-based pass/fail
+- Comprehensive configuration options
+- Rake tasks for analysis and configuration checking
+- Rails generator for easy installation
+- Background job for asynchronous analysis
+- Error handling with specific exception classes
+- Rate limiting support with automatic retry
+- Comprehensive logging and debugging support
+
+### Features
+- **Client**: HTTP client with retry logic and error handling
+- **Configuration**: Flexible configuration via environment variables and initializers
+- **Middleware**: Automatic query collection and analysis
+- **Rake Tasks**: Command-line tools for analysis and CI integration
+- **Generator**: Rails generator for easy setup
+- **Jobs**: Background job for asynchronous processing
+- **Logging**: Detailed logging with configurable levels
+
+### Supported Ruby Versions
+- Ruby 3.0+
+- Rails 6.0+
+
+### API Endpoints Supported
+- `POST /analyze` - Query analysis with optimization suggestions
+- `POST /analyze_ci` - CI/CD integration with pass/fail scoring
+- `GET /health` - Health check
+- `POST /api_keys` - API key generation

data/CLOUD_RUN_README.md

@@ -0,0 +1,263 @@
+# ☁️ Google Cloud Run Deployment
+
+Deploy the Query Optimizer API to Google Cloud Run with automatic scaling and 2 million free requests per month!
+
+## 🚀 One-Command Deployment
+
+```bash
+# 1. Setup Google Cloud (one-time)
+./scripts/setup-gcp.sh
+
+# 2. Deploy to Cloud Run
+./scripts/deploy-cloudrun.sh
+
+# 3. Test your deployment
+./scripts/test-cloudrun.sh
+```
+
+**That's it!** Your API will be live at `https://query-optimizer-api-xxx-uc.a.run.app`
+
+## 💰 Free Tier Benefits
+
+Google Cloud Run free tier includes:
+- ✅ **2 million requests/month** (enough for 30,000+ daily user interactions)
+- ✅ **400,000 GB-seconds memory** 
+- ✅ **200,000 vCPU-seconds**
+- ✅ **Automatic scaling** (scales to zero when not used)
+- ✅ **Global CDN** and HTTPS included
+- ✅ **No server management** required
+
+## 📋 What You Get
+
+After deployment, you'll have:
+
+- 🌐 **Public API endpoint** with HTTPS
+- 🗄️ **Managed PostgreSQL database** (Cloud SQL)
+- 🔐 **Secure secrets management**
+- 📊 **Automatic monitoring and logging**
+- 🚀 **Auto-scaling** (0 to 10 instances)
+- 💳 **Cost-effective** (free tier covers most usage)
+
+## 🔧 Prerequisites
+
+1. **Google Cloud Account** (free tier available)
+2. **Google Cloud SDK** installed
+3. **Billing enabled** (required for Cloud Run, but free tier covers most usage)
+
+### Install Google Cloud SDK
+
+```bash
+# macOS
+brew install google-cloud-sdk
+
+# Linux
+curl https://sdk.cloud.google.com | bash
+
+# Windows
+# Download from: https://cloud.google.com/sdk/docs/install
+```
+
+## 📊 Usage Examples
+
+Once deployed, your API will be available at your Cloud Run URL:
+
+### Get API Key
+
+```bash
+# The deployment script automatically creates one, or create manually:
+curl -X POST https://your-service-url/api/v1/api_keys \
+  -H 'Content-Type: application/json' \
+  -d '{"app_name":"My Rails App"}'
+```
+
+### Analyze Queries
+
+```bash
+curl -X POST https://your-service-url/api/v1/analyze \
+  -H 'Content-Type: application/json' \
+  -H 'X-API-Key: your_api_key_here' \
+  -d '{
+    "queries": [
+      {
+        "sql": "SELECT * FROM users WHERE id = 1",
+        "duration_ms": 50
+      }
+    ]
+  }'
+```
+
+### CI Integration
+
+```bash
+curl -X POST https://your-service-url/api/v1/analyze_ci \
+  -H 'Content-Type: application/json' \
+  -H 'X-API-Key: your_api_key_here' \
+  -d '{
+    "queries": [{"sql": "SELECT 1", "duration_ms": 10}],
+    "threshold_score": 80
+  }'
+```
+
+## 🔍 Monitoring
+
+### View Logs
+
+```bash
+# Real-time logs
+gcloud run services logs read query-optimizer-api --region=us-central1 --follow
+
+# Recent errors
+gcloud run services logs read query-optimizer-api --region=us-central1 --filter="severity>=ERROR"
+```
+
+### Monitor Usage
+
+- **Service Dashboard**: https://console.cloud.google.com/run
+- **Billing Dashboard**: https://console.cloud.google.com/billing
+- **Logs**: https://console.cloud.google.com/logs
+
+## 🔧 Configuration
+
+### Environment Variables
+
+The deployment automatically configures:
+
+```bash
+RAILS_ENV=production
+DATABASE_URL=postgresql://...  # Managed Cloud SQL
+RAILS_MASTER_KEY=...          # Stored in Secret Manager
+```
+
+### Resource Limits
+
+```yaml
+Memory: 512Mi
+CPU: 1 vCPU
+Max Instances: 10
+Timeout: 300 seconds
+```
+
+### Custom Configuration
+
+Edit `cloudbuild.yaml` to customize:
+
+```yaml
+# Increase memory
+--memory=1Gi
+
+# Increase CPU
+--cpu=2
+
+# Change region
+--region=europe-west1
+
+# Set max instances
+--max-instances=20
+```
+
+## 💡 Cost Optimization
+
+### Monitor Costs
+
+```bash
+# Set up billing alerts
+gcloud billing budgets create \
+  --billing-account=YOUR_BILLING_ACCOUNT \
+  --display-name="Query Optimizer Budget" \
+  --budget-amount=10USD
+```
+
+### Optimize Usage
+
+1. **Batch requests** - Send multiple queries in one request
+2. **Cache results** - Cache analysis results for identical queries
+3. **Smart thresholds** - Only analyze requests with 5+ queries
+4. **Monitor usage** - Track request patterns and optimize
+
+## 🚀 Scaling
+
+### Automatic Scaling
+
+Cloud Run automatically scales based on:
+- **Request volume** - Scales up with more requests
+- **CPU usage** - Scales up when CPU is high
+- **Memory usage** - Scales up when memory is high
+- **Zero scaling** - Scales to zero when no requests
+
+### Manual Scaling
+
+```bash
+# Set minimum instances (reduces cold starts)
+gcloud run services update query-optimizer-api \
+  --region=us-central1 \
+  --min-instances=1
+
+# Set maximum instances
+gcloud run services update query-optimizer-api \
+  --region=us-central1 \
+  --max-instances=20
+```
+
+## 🔒 Security
+
+### Built-in Security
+
+- ✅ **HTTPS by default** - All traffic encrypted
+- ✅ **IAM integration** - Fine-grained access control
+- ✅ **Secret management** - Secure credential storage
+- ✅ **VPC support** - Network isolation available
+- ✅ **Container security** - Runs in secure sandbox
+
+### API Security
+
+- ✅ **API key authentication** - Secure access control
+- ✅ **Rate limiting** - Prevents abuse
+- ✅ **Input validation** - SQL injection protection
+- ✅ **CORS support** - Cross-origin request handling
+
+## 🐛 Troubleshooting
+
+### Common Issues
+
+**Deployment failed:**
+```bash
+# Check build logs
+gcloud builds list --limit=5
+gcloud builds log BUILD_ID
+```
+
+**Service not responding:**
+```bash
+# Check service status
+gcloud run services describe query-optimizer-api --region=us-central1
+
+# Check logs
+gcloud run services logs read query-optimizer-api --region=us-central1 --limit=50
+```
+
+**Database connection issues:**
+```bash
+# Check Cloud SQL instance
+gcloud sql instances describe query-optimizer-db
+
+# Test connection
+gcloud sql connect query-optimizer-db --user=rails
+```
+
+### Get Help
+
+- 📖 **Full Guide**: See `docs/CLOUD_RUN_GUIDE.md`
+- 🌐 **Google Cloud Docs**: https://cloud.google.com/run/docs
+- 💬 **Community**: https://stackoverflow.com/questions/tagged/google-cloud-run
+
+## 🎯 Next Steps
+
+1. **Deploy**: Run `./scripts/setup-gcp.sh` then `./scripts/deploy-cloudrun.sh`
+2. **Test**: Run `./scripts/test-cloudrun.sh` to verify everything works
+3. **Integrate**: Use the API URL in your Rails applications
+4. **Monitor**: Set up billing alerts and monitor usage
+5. **Scale**: Adjust resources as your usage grows
+
+---
+
+**Ready to go serverless?** Your Query Optimizer API will be running on Google Cloud Run in minutes! ☁️🚀

data/DOCKER_README.md

@@ -0,0 +1,327 @@
+# 🐳 Docker Deployment - Query Optimizer API
+
+Get the Query Optimizer API running with Docker in minutes!
+
+## 🚀 Quick Start
+
+### Option 1: Automated Setup (Recommended)
+
+```bash
+# Development environment with live reloading
+./scripts/docker-dev.sh
+
+# Production environment
+./scripts/docker-deploy.sh
+```
+
+### Option 2: Manual Setup
+
+```bash
+# 1. Start services
+docker-compose up --build -d
+
+# 2. Test the deployment
+./scripts/test-docker.sh
+```
+
+## 📋 What You Get
+
+- ✅ **Rails API** running on port 3000
+- ✅ **PostgreSQL** database with automatic setup
+- ✅ **Redis** for caching and rate limiting
+- ✅ **Health checks** and monitoring
+- ✅ **Automatic database migrations**
+- ✅ **Production-ready configuration**
+
+## 🛠️ Development vs Production
+
+### Development Mode
+```bash
+# Start development environment
+docker-compose -f docker-compose.dev.yml up --build
+
+# Features:
+# - Live code reloading
+# - Development gems included
+# - Detailed logging
+# - Easy debugging
+```
+
+### Production Mode
+```bash
+# Start production environment
+docker-compose up --build -d
+
+# Features:
+# - Optimized multi-stage build
+# - Minimal image size
+# - Security hardening
+# - Performance optimizations
+```
+
+## 🔧 Configuration
+
+### Environment Variables
+
+Create a `.env` file:
+
+```bash
+# Database
+DATABASE_URL=postgresql://postgres:password@db:5432/query_optimizer_production
+
+# Security
+RAILS_MASTER_KEY=your_master_key_here
+SECRET_KEY_BASE=your_secret_key_here
+
+# API Settings
+API_RATE_LIMIT=1000
+API_RATE_LIMIT_WINDOW=3600
+```
+
+### Custom Configuration
+
+Create `docker-compose.override.yml`:
+
+```yaml
+version: '3.8'
+services:
+  app:
+    ports:
+      - "8080:80"  # Custom port
+    environment:
+      - CUSTOM_SETTING=value
+```
+
+## 📊 Usage Examples
+
+### 1. Get API Key
+
+```bash
+# Create API key
+docker-compose exec app rails runner "
+  app = AppProfile.create!(name: 'My App')
+  puts 'API Key: ' + app.generate_api_key!
+"
+```
+
+### 2. Test the API
+
+```bash
+# Health check
+curl http://localhost:3000/api/v1/health
+
+# Analyze queries
+curl -X POST http://localhost:3000/api/v1/analyze \
+  -H 'Content-Type: application/json' \
+  -H 'X-API-Key: your_api_key_here' \
+  -d '{
+    "queries": [
+      {
+        "sql": "SELECT * FROM users WHERE id = 1",
+        "duration_ms": 50
+      }
+    ]
+  }'
+```
+
+### 3. CI Integration
+
+```bash
+# Test CI endpoint
+curl -X POST http://localhost:3000/api/v1/analyze_ci \
+  -H 'Content-Type: application/json' \
+  -H 'X-API-Key: your_api_key_here' \
+  -d '{
+    "queries": [{"sql": "SELECT 1", "duration_ms": 10}],
+    "threshold_score": 80
+  }'
+```
+
+## 🔍 Monitoring
+
+### Health Checks
+
+```bash
+# Check service status
+docker-compose ps
+
+# Check API health
+curl http://localhost:3000/api/v1/health
+
+# View logs
+docker-compose logs -f app
+```
+
+### Resource Usage
+
+```bash
+# Monitor resource usage
+docker stats
+
+# Check container details
+docker-compose exec app top
+```
+
+## 🚀 Deployment Options
+
+### 1. Railway
+
+```bash
+# Deploy to Railway
+railway login
+railway init
+railway up
+```
+
+### 2. Render
+
+```yaml
+# render.yaml
+services:
+  - type: web
+    name: query-optimizer-api
+    env: docker
+    dockerfilePath: ./Dockerfile
+```
+
+### 3. Google Cloud Run
+
+```bash
+# Build and deploy
+docker build -t gcr.io/project/query-optimizer-api .
+docker push gcr.io/project/query-optimizer-api
+gcloud run deploy --image gcr.io/project/query-optimizer-api
+```
+
+### 4. AWS ECS
+
+```bash
+# Push to ECR
+aws ecr get-login-password | docker login --username AWS --password-stdin
+docker build -t query-optimizer-api .
+docker tag query-optimizer-api:latest account.dkr.ecr.region.amazonaws.com/query-optimizer-api:latest
+docker push account.dkr.ecr.region.amazonaws.com/query-optimizer-api:latest
+```
+
+## 🛠️ Useful Commands
+
+### Development
+
+```bash
+# Rails console
+docker-compose -f docker-compose.dev.yml exec app rails console
+
+# Run tests
+docker-compose -f docker-compose.dev.yml exec app rspec
+
+# Generate migration
+docker-compose -f docker-compose.dev.yml exec app rails generate migration AddIndexToUsers
+
+# Run migration
+docker-compose -f docker-compose.dev.yml exec app rails db:migrate
+```
+
+### Production
+
+```bash
+# Scale application
+docker-compose up -d --scale app=3
+
+# Update application
+docker-compose pull
+docker-compose up -d
+
+# Backup database
+docker-compose exec db pg_dump -U postgres query_optimizer_production > backup.sql
+
+# View application logs
+docker-compose logs -f app
+```
+
+### Debugging
+
+```bash
+# Enter container
+docker-compose exec app bash
+
+# Check environment
+docker-compose exec app env
+
+# Debug database connection
+docker-compose exec app rails runner "puts ActiveRecord::Base.connection.execute('SELECT 1')"
+```
+
+## 🔒 Security
+
+### Production Security Checklist
+
+- ✅ **Non-root user**: Containers run as user 1000
+- ✅ **Secrets management**: Master key stored as Docker secret
+- ✅ **Health checks**: Automatic container health monitoring
+- ✅ **Resource limits**: Memory and CPU limits configured
+- ✅ **Network isolation**: Services communicate via internal network
+- ✅ **Minimal image**: Multi-stage build reduces attack surface
+
+### Security Best Practices
+
+```yaml
+# docker-compose.yml security example
+services:
+  app:
+    deploy:
+      resources:
+        limits:
+          memory: 512M
+          cpus: '0.5'
+    security_opt:
+      - no-new-privileges:true
+    read_only: true
+    tmpfs:
+      - /tmp
+      - /rails/tmp
+```
+
+## 🐛 Troubleshooting
+
+### Common Issues
+
+**Port already in use:**
+```bash
+# Find and kill process
+lsof -i :3000
+kill -9 <PID>
+```
+
+**Database connection failed:**
+```bash
+# Check database status
+docker-compose ps db
+docker-compose logs db
+
+# Restart database
+docker-compose restart db
+```
+
+**Permission denied:**
+```bash
+# Fix permissions
+sudo chown -R $USER:$USER .
+chmod +x scripts/*.sh
+```
+
+**Out of disk space:**
+```bash
+# Clean up Docker
+docker system prune -a
+docker volume prune
+```
+
+## 📞 Support
+
+- 📖 **Full Documentation**: See `docs/DOCKER_GUIDE.md`
+- 🐛 **Issues**: Report issues on GitHub
+- 💬 **Discussions**: Join our community discussions
+
+---
+
+**Ready to deploy?** Run `./scripts/docker-deploy.sh` and you'll have a production-ready Query Optimizer API running in minutes! 🚀

data/Dockerfile

@@ -0,0 +1,69 @@
+# syntax=docker/dockerfile:1
+# check=error=true
+
+# This Dockerfile is designed for production, not development. Use with Kamal or build'n'run by hand:
+# docker build -t query_optimizer_api .
+# docker run -d -p 80:80 -e RAILS_MASTER_KEY=<value from config/master.key> --name query_optimizer_api query_optimizer_api
+
+# For a containerized dev environment, see Dev Containers: https://guides.rubyonrails.org/getting_started_with_devcontainer.html
+
+# Make sure RUBY_VERSION matches the Ruby version in .ruby-version
+ARG RUBY_VERSION=3.2.2
+FROM docker.io/library/ruby:$RUBY_VERSION-slim AS base
+
+# Rails app lives here
+WORKDIR /rails
+
+# Install base packages
+RUN apt-get update -qq && \
+    apt-get install --no-install-recommends -y curl libjemalloc2 libvips postgresql-client && \
+    rm -rf /var/lib/apt/lists /var/cache/apt/archives
+
+# Set production environment
+ENV RAILS_ENV="production" \
+    BUNDLE_DEPLOYMENT="1" \
+    BUNDLE_PATH="/usr/local/bundle" \
+    BUNDLE_WITHOUT="development"
+
+# Throw-away build stage to reduce size of final image
+FROM base AS build
+
+# Install packages needed to build gems
+RUN apt-get update -qq && \
+    apt-get install --no-install-recommends -y build-essential git libpq-dev libyaml-dev pkg-config && \
+    rm -rf /var/lib/apt/lists /var/cache/apt/archives
+
+# Install application gems
+COPY Gemfile Gemfile.lock ./
+RUN bundle install && \
+    rm -rf ~/.bundle/ "${BUNDLE_PATH}"/ruby/*/cache "${BUNDLE_PATH}"/ruby/*/bundler/gems/*/.git && \
+    bundle exec bootsnap precompile --gemfile
+
+# Copy application code
+COPY . .
+
+# Precompile bootsnap code for faster boot times
+RUN bundle exec bootsnap precompile app/ lib/
+
+
+
+
+# Final stage for app image
+FROM base
+
+# Copy built artifacts: gems, application
+COPY --from=build "${BUNDLE_PATH}" "${BUNDLE_PATH}"
+COPY --from=build /rails /rails
+
+# Run and own only the runtime files as a non-root user for security
+RUN groupadd --system --gid 1000 rails && \
+    useradd rails --uid 1000 --gid 1000 --create-home --shell /bin/bash && \
+    chown -R rails:rails db log storage tmp
+USER 1000:1000
+
+# Entrypoint prepares the database.
+ENTRYPOINT ["/rails/bin/docker-entrypoint"]
+
+# Start server via Thruster by default, this can be overwritten at runtime
+EXPOSE 80
+CMD ["./bin/thrust", "./bin/rails", "server"]