rapitapir 0.1.0

data/examples/observability/test_honeycomb_demo.rb

@@ -0,0 +1,354 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'net/http'
+require 'json'
+require 'uri'
+
+# Test script to generate sample data for Honeycomb.io observability demo
+class HoneycombDemoTester
+  def initialize(base_url = 'http://localhost:4567')
+    @base_url = base_url
+    @users = []
+  end
+
+  def run_comprehensive_test
+    puts "🍯 Starting comprehensive Honeycomb.io observability test"
+    puts "📊 This will generate various traces to demonstrate RapiTapir + Honeycomb integration"
+    puts ""
+
+    # Test health checks
+    test_health_checks
+
+    # Create sample users
+    create_sample_users
+
+    # Test different query patterns
+    test_user_queries
+
+    # Test analytics endpoints
+    test_analytics
+
+    # Test error scenarios
+    test_error_scenarios
+
+    # Test performance scenarios
+    test_performance_scenarios
+
+    puts ""
+    puts "✅ Comprehensive test completed!"
+    puts "🔍 Check your Honeycomb.io dashboard to see the traces"
+    puts "📈 Recommended queries to try in Honeycomb:"
+    puts "   - WHERE business.operation EXISTS"
+    puts "   - WHERE duration_ms > 50"
+    puts "   - GROUP BY business.operation"
+    puts "   - WHERE error.type EXISTS"
+    puts "   - WHERE db.operation = 'SELECT'"
+  end
+
+  private
+
+  def test_health_checks
+    puts "🏥 Testing health checks..."
+    
+    # Basic health check
+    make_request('GET', '/health')
+    
+    # Multiple health checks to show consistency
+    3.times { make_request('GET', '/health') }
+    
+    puts "   ✓ Health checks completed"
+  end
+
+  def create_sample_users
+    puts "👥 Creating sample users..."
+
+    sample_users = [
+      {
+        name: 'Alice Johnson',
+        email: 'alice.johnson@techcorp.com',
+        age: 28,
+        department: 'engineering'
+      },
+      {
+        name: 'Bob Smith',
+        email: 'bob.smith@techcorp.com',
+        age: 34,
+        department: 'sales'
+      },
+      {
+        name: 'Carol Wilson',
+        email: 'carol.wilson@techcorp.com',
+        age: 29,
+        department: 'marketing'
+      },
+      {
+        name: 'David Brown',
+        email: 'david.brown@techcorp.com',
+        age: 31,
+        department: 'engineering'
+      },
+      {
+        name: 'Eve Davis',
+        email: 'eve.davis@techcorp.com',
+        age: 27,
+        department: 'support'
+      },
+      {
+        name: 'Frank Miller',
+        email: 'frank.miller@techcorp.com',
+        age: 35,
+        department: 'sales'
+      },
+      {
+        name: 'Grace Lee',
+        email: 'grace.lee@techcorp.com',
+        age: 26,
+        department: 'engineering'
+      },
+      {
+        name: 'Henry Clark',
+        email: 'henry.clark@techcorp.com',
+        age: 33,
+        department: 'marketing'
+      }
+    ]
+
+    sample_users.each_with_index do |user_data, index|
+      puts "   Creating user #{index + 1}/#{sample_users.length}: #{user_data[:name]}"
+      response = make_request('POST', '/users', user_data)
+      
+      if response && response.code == '201'
+        user = JSON.parse(response.body)
+        @users << user
+        puts "     ✓ Created user with ID: #{user['id']}"
+      else
+        puts "     ❌ Failed to create user: #{user_data[:name]}"
+      end
+      
+      # Small delay to spread out the requests
+      sleep(0.1)
+    end
+    
+    puts "   ✓ Created #{@users.length} users"
+  end
+
+  def test_user_queries
+    puts "🔍 Testing user query patterns..."
+    
+    # Basic user listing
+    puts "   Testing pagination..."
+    make_request('GET', '/users')
+    make_request('GET', '/users?page=1&limit=3')
+    make_request('GET', '/users?page=2&limit=3')
+    
+    # Department filtering
+    puts "   Testing department filtering..."
+    %w[engineering sales marketing support].each do |dept|
+      make_request('GET', "/users?department=#{dept}")
+    end
+    
+    # Combined filtering and pagination
+    puts "   Testing combined filtering..."
+    make_request('GET', '/users?department=engineering&page=1&limit=2')
+    
+    # Individual user lookups
+    puts "   Testing individual user lookups..."
+    @users.first(3).each do |user|
+      make_request('GET', "/users/#{user['id']}")
+    end
+    
+    puts "   ✓ User query tests completed"
+  end
+
+  def test_analytics
+    puts "📊 Testing analytics endpoints..."
+    
+    # Department statistics
+    3.times do |i|
+      puts "   Running analytics query #{i + 1}/3..."
+      make_request('GET', '/analytics/department-stats')
+      sleep(0.2)
+    end
+    
+    puts "   ✓ Analytics tests completed"
+  end
+
+  def test_error_scenarios
+    puts "❌ Testing error scenarios..."
+    
+    # Invalid JSON
+    puts "   Testing invalid JSON..."
+    make_request('POST', '/users', '{"invalid": json}', content_type: 'application/json', raw: true)
+    
+    # Validation errors
+    puts "   Testing validation errors..."
+    
+    invalid_users = [
+      { name: '', email: 'invalid', age: 15, department: 'invalid' },  # Multiple validation errors
+      { name: 'John', email: 'not-an-email', age: 25, department: 'engineering' },  # Bad email
+      { name: 'Jane', email: 'jane@example.com', age: 16, department: 'engineering' },  # Too young
+      { name: 'Bob', email: 'bob@example.com', age: 30, department: 'nonexistent' }  # Invalid department
+    ]
+    
+    invalid_users.each_with_index do |user_data, index|
+      puts "   Testing validation error #{index + 1}/#{invalid_users.length}..."
+      make_request('POST', '/users', user_data)
+      sleep(0.1)
+    end
+    
+    # Not found errors
+    puts "   Testing not found errors..."
+    fake_uuid = '12345678-1234-1234-1234-123456789999'
+    make_request('GET', "/users/#{fake_uuid}")
+    make_request('PUT', "/users/#{fake_uuid}", { name: 'Updated Name' })
+    make_request('DELETE', "/users/#{fake_uuid}")
+    
+    puts "   ✓ Error scenario tests completed"
+  end
+
+  def test_performance_scenarios
+    puts "⚡ Testing performance scenarios..."
+    
+    # Concurrent requests simulation
+    puts "   Simulating concurrent user listing requests..."
+    threads = []
+    
+    5.times do |i|
+      threads << Thread.new do
+        make_request('GET', '/users', nil, thread_id: i)
+      end
+    end
+    
+    threads.each(&:join)
+    
+    # Update operations
+    puts "   Testing update operations..."
+    if @users.any?
+      user = @users.first
+      update_data = {
+        name: "#{user['name']} (Updated)",
+        age: user['age'] + 1
+      }
+      make_request('PUT', "/users/#{user['id']}", update_data)
+    end
+    
+    # Delete operations
+    puts "   Testing delete operations..."
+    if @users.length > 1
+      user_to_delete = @users.last
+      make_request('DELETE', "/users/#{user_to_delete['id']}")
+    end
+    
+    puts "   ✓ Performance scenario tests completed"
+  end
+
+  def make_request(method, path, body = nil, content_type: 'application/json', raw: false, thread_id: nil)
+    uri = URI("#{@base_url}#{path}")
+    
+    http = Net::HTTP.new(uri.host, uri.port)
+    
+    request = case method.upcase
+              when 'GET'
+                Net::HTTP::Get.new(uri)
+              when 'POST'
+                Net::HTTP::Post.new(uri)
+              when 'PUT'
+                Net::HTTP::Put.new(uri)
+              when 'DELETE'
+                Net::HTTP::Delete.new(uri)
+              else
+                raise "Unsupported method: #{method}"
+              end
+    
+    if body
+      if raw
+        request.body = body
+      else
+        request.body = body.to_json
+      end
+      request['Content-Type'] = content_type
+    end
+    
+    # Add custom headers for tracing
+    request['X-Test-Scenario'] = 'honeycomb-demo'
+    request['X-Thread-Id'] = thread_id.to_s if thread_id
+    
+    begin
+      response = http.request(request)
+      
+      status_symbol = case response.code.to_i
+                      when 200..299
+                        '✓'
+                      when 400..499
+                        '⚠'
+                      else
+                        '❌'
+                      end
+      
+      thread_info = thread_id ? " [T#{thread_id}]" : ""
+      puts "     #{status_symbol} #{method.upcase} #{path} → #{response.code}#{thread_info}"
+      
+      response
+    rescue StandardError => e
+      puts "     ❌ #{method.upcase} #{path} → Error: #{e.message}"
+      nil
+    end
+  end
+end
+
+# Run the test if this file is executed directly
+if __FILE__ == $PROGRAM_NAME
+  if ARGV.include?('--help') || ARGV.include?('-h')
+    puts "Honeycomb.io Observability Demo Test Script"
+    puts ""
+    puts "Usage: ruby test_honeycomb_demo.rb [URL]"
+    puts ""
+    puts "Arguments:"
+    puts "  URL    Base URL of the API server (default: http://localhost:4567)"
+    puts ""
+    puts "Examples:"
+    puts "  ruby test_honeycomb_demo.rb"
+    puts "  ruby test_honeycomb_demo.rb http://localhost:4567"
+    puts ""
+    puts "This script will:"
+    puts "  1. Test health check endpoints"
+    puts "  2. Create sample users with various departments"
+    puts "  3. Test different query patterns (pagination, filtering)"
+    puts "  4. Test analytics endpoints"
+    puts "  5. Generate error scenarios for testing"
+    puts "  6. Simulate performance scenarios"
+    puts ""
+    puts "All requests will generate traces in Honeycomb.io for analysis."
+    puts ""
+    puts "⚠️  Make sure to start the server first:"
+    puts "    ruby honeycomb_working_example.rb"
+    exit 0
+  end
+
+  base_url = ARGV[0] || 'http://localhost:4567'
+  
+  puts "🎯 Target URL: #{base_url}"
+  puts ""
+  
+  # Check if server is running
+  begin
+    uri = URI("#{base_url}/health")
+    response = Net::HTTP.get_response(uri)
+    if response.code != '200'
+      puts "❌ Server not responding correctly at #{base_url}"
+      puts "   Make sure the Honeycomb demo server is running:"
+      puts "   ruby examples/observability/honeycomb_working_example.rb"
+      exit 1
+    end
+  rescue StandardError => e
+    puts "❌ Cannot connect to server at #{base_url}"
+    puts "   Error: #{e.message}"
+    puts "   Make sure the Honeycomb demo server is running:"
+    puts "   ruby examples/observability/honeycomb_working_example.rb"
+    exit 1
+  end
+  
+  tester = HoneycombDemoTester.new(base_url)
+  tester.run_comprehensive_test
+end

data/examples/observability/test_live_honeycomb.rb

@@ -0,0 +1,111 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# Quick test to verify Honeycomb integration is working
+require 'net/http'
+require 'json'
+require 'uri'
+
+puts "🍯 Testing Honeycomb.io Integration"
+puts "=================================="
+
+# Start server in background
+puts "📡 Starting server..."
+server_pid = spawn("bundle exec ruby honeycomb_working_example.rb", 
+                   out: "/dev/null", err: "/dev/null")
+
+# Wait for server to start
+sleep(3)
+puts "✅ Server started (PID: #{server_pid})"
+
+begin
+  base_url = 'http://localhost:4567'
+  
+  # Test health endpoint
+  puts "\n🏥 Testing health endpoint..."
+  uri = URI("#{base_url}/health")
+  response = Net::HTTP.get_response(uri)
+  
+  if response.code == '200'
+    puts "✅ Health check successful (#{response.code})"
+    health_data = JSON.parse(response.body)
+    puts "   Status: #{health_data['status']}"
+    puts "   Service: #{health_data['service']}"
+  else
+    puts "❌ Health check failed (#{response.code})"
+  end
+  
+  # Test user creation (will generate traces)
+  puts "\n👤 Testing user creation..."
+  uri = URI("#{base_url}/users")
+  http = Net::HTTP.new(uri.host, uri.port)
+  
+  request = Net::HTTP::Post.new(uri)
+  request['Content-Type'] = 'application/json'
+  request.body = {
+    name: 'Test User for Honeycomb',
+    email: 'test@honeycomb-demo.com',
+    age: 30,
+    department: 'engineering'
+  }.to_json
+  
+  response = http.request(request)
+  
+  if response.code == '201'
+    puts "✅ User creation successful (#{response.code})"
+    user_data = JSON.parse(response.body)
+    puts "   Created user: #{user_data['name']} (ID: #{user_data['id']})"
+    
+    # Test getting the user back
+    puts "\n🔍 Testing user retrieval..."
+    get_uri = URI("#{base_url}/users/#{user_data['id']}")
+    get_response = Net::HTTP.get_response(get_uri)
+    
+    if get_response.code == '200'
+      puts "✅ User retrieval successful (#{get_response.code})"
+    else
+      puts "❌ User retrieval failed (#{get_response.code})"
+    end
+  else
+    puts "❌ User creation failed (#{response.code})"
+    puts "   Response: #{response.body}"
+  end
+  
+  # Test analytics endpoint (complex operation)
+  puts "\n📊 Testing analytics endpoint..."
+  analytics_uri = URI("#{base_url}/analytics/department-stats")
+  analytics_response = Net::HTTP.get_response(analytics_uri)
+  
+  if analytics_response.code == '200'
+    puts "✅ Analytics successful (#{analytics_response.code})"
+    analytics_data = JSON.parse(analytics_response.body)
+    puts "   Total users: #{analytics_data['total_users']}"
+  else
+    puts "❌ Analytics failed (#{analytics_response.code})"
+  end
+  
+  puts "\n🎉 Test completed successfully!"
+  puts ""
+  puts "📊 Traces should now be visible in your Honeycomb dashboard:"
+  puts "   1. Go to https://ui.honeycomb.io/"
+  puts "   2. Look for dataset: 'rapitapir-demo'"
+  puts "   3. You should see traces for:"
+  puts "      - GET /health"
+  puts "      - POST /users" 
+  puts "      - GET /users/:id"
+  puts "      - GET /analytics/department-stats"
+  puts ""
+  puts "🔍 Try these queries in Honeycomb:"
+  puts "   - WHERE business.operation EXISTS"
+  puts "   - WHERE http.method = 'POST'"
+  puts "   - WHERE db.operation EXISTS"
+  puts "   - GROUP BY business.operation"
+
+rescue StandardError => e
+  puts "❌ Error during testing: #{e.message}"
+ensure
+  puts "\n🛑 Stopping server..."
+  Process.kill('TERM', server_pid) if server_pid
+  sleep(1)
+  puts "✅ Server stopped"
+end

data/examples/observability/test_validation.rb

@@ -0,0 +1,78 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# Test script to validate Honeycomb.io observability example
+require 'bundler/setup'
+
+# Add local lib to load path for RapiTapir
+$LOAD_PATH.unshift(File.expand_path('../../lib', __dir__))
+
+# Set mock environment variables
+ENV['OTEL_EXPORTER_OTLP_HEADERS'] = 'x-honeycomb-team=test-key'
+ENV['OTEL_SERVICE_NAME'] = 'rapitapir-demo'
+ENV['OTEL_EXPORTER_OTLP_ENDPOINT'] = 'https://api.honeycomb.io'
+
+# Override $PROGRAM_NAME to avoid server startup
+original_program_name = $PROGRAM_NAME
+$PROGRAM_NAME = 'test_validation'
+
+begin
+  puts "🧪 Testing Honeycomb.io observability example..."
+  
+  # Test individual gem loading
+  puts "   Loading OpenTelemetry SDK..."
+  require 'opentelemetry/sdk'
+  
+  puts "   Loading OpenTelemetry OTLP exporter..."
+  require 'opentelemetry/exporter/otlp'
+  
+  puts "   Loading OpenTelemetry instrumentation..."
+  require 'opentelemetry/instrumentation/all'
+  
+  puts "   Loading OpenTelemetry baggage processor..."
+  require 'opentelemetry/processor/baggage/baggage_span_processor'
+  
+  puts "   Loading Sinatra..."
+  require 'sinatra/base'
+  
+  puts "   Loading JSON..."
+  require 'json'
+  
+  # Now load the main example file
+  puts "   Loading honeycomb_example.rb..."
+  load File.join(__dir__, 'honeycomb_example.rb')
+  
+  # Test that the class was defined
+  unless defined?(HoneycombDemoAPI)
+    raise "HoneycombDemoAPI class not defined"
+  end
+  
+  puts ""
+  puts "✅ Success! All components loaded correctly:"
+  puts "   ✓ OpenTelemetry SDK initialized"
+  puts "   ✓ OTLP exporter configured"
+  puts "   ✓ Automatic instrumentation enabled"
+  puts "   ✓ Baggage processor configured"
+  puts "   ✓ RapiTapir configuration loaded"
+  puts "   ✓ Sinatra app class defined: #{HoneycombDemoAPI.name}"
+  puts ""
+  puts "🚀 Ready to run the Honeycomb.io observability demo!"
+  puts "   Usage: ruby honeycomb_example.rb"
+  puts ""
+  puts "📋 Next steps:"
+  puts "   1. Get a Honeycomb.io API key from https://ui.honeycomb.io/account"
+  puts "   2. Copy .env.example to .env and add your API key"
+  puts "   3. Run: ruby honeycomb_example.rb"
+  puts "   4. Make requests to generate traces"
+  puts "   5. View traces in Honeycomb.io dashboard"
+  
+rescue LoadError => e
+  puts "❌ LoadError: #{e.message}"
+  puts "   Make sure all gems are installed: bundle install"
+rescue StandardError => e
+  puts "❌ Error: #{e.message}"
+  puts "   Backtrace:"
+  puts e.backtrace.first(5).map { |line| "     #{line}" }
+ensure
+  $PROGRAM_NAME = original_program_name
+end

data/examples/observability/test_working_validation.rb

@@ -0,0 +1,66 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# Test script for the working Honeycomb example
+require 'bundler/setup'
+
+# Set mock environment variables
+ENV['OTEL_EXPORTER_OTLP_HEADERS'] = 'x-honeycomb-team=test-key'
+ENV['OTEL_SERVICE_NAME'] = 'rapitapir-demo'
+ENV['OTEL_EXPORTER_OTLP_ENDPOINT'] = 'https://api.honeycomb.io'
+
+# Override $PROGRAM_NAME to avoid server startup
+original_program_name = $PROGRAM_NAME
+$PROGRAM_NAME = 'test_validation'
+
+begin
+  puts "🧪 Testing working Honeycomb.io observability example..."
+  
+  # Load the working example
+  puts "   Loading honeycomb_working_example.rb..."
+  load File.join(__dir__, 'honeycomb_working_example.rb')
+  
+  # Test that the class was defined
+  unless defined?(HoneycombDemoAPI)
+    raise "HoneycombDemoAPI class not defined"
+  end
+  
+  puts ""
+  puts "✅ Success! Working Honeycomb example loaded correctly:"
+  puts "   ✓ OpenTelemetry SDK initialized"
+  puts "   ✓ OTLP exporter configured for Honeycomb.io"
+  puts "   ✓ Automatic instrumentation enabled (Sinatra, Rack, HTTP)"
+  puts "   ✓ Baggage processor configured for context propagation"
+  puts "   ✓ Custom RapiTapir observability extension loaded"
+  puts "   ✓ Sinatra app class defined: #{HoneycombDemoAPI.name}"
+  puts ""
+  puts "🚀 Ready to run the Honeycomb.io observability demo!"
+  puts "   Usage: ruby honeycomb_working_example.rb"
+  puts ""
+  puts "📋 Next steps:"
+  puts "   1. Get a Honeycomb.io API key from https://ui.honeycomb.io/account"
+  puts "   2. Copy .env.example to .env and add your API key"
+  puts "   3. Load environment: source .env"
+  puts "   4. Run: ruby honeycomb_working_example.rb"
+  puts "   5. Make requests to generate traces"
+  puts "   6. View traces in Honeycomb.io dashboard"
+  puts ""
+  puts "🔧 Available endpoints:"
+  puts "   GET    /health                     - Health check with tracing"
+  puts "   GET    /users                      - List users with pagination"
+  puts "   POST   /users                      - Create user with validation"
+  puts "   GET    /users/:id                  - Get user by ID"
+  puts "   PUT    /users/:id                  - Update user"
+  puts "   DELETE /users/:id                  - Delete user"
+  puts "   GET    /analytics/department-stats - Complex analytics operation"
+  
+rescue LoadError => e
+  puts "❌ LoadError: #{e.message}"
+  puts "   Make sure all gems are installed: bundle install"
+rescue StandardError => e
+  puts "❌ Error: #{e.message}"
+  puts "   Backtrace:"
+  puts e.backtrace.first(5).map { |line| "     #{line}" }
+ensure
+  $PROGRAM_NAME = original_program_name
+end