rapitapir 0.1.2 → 2.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.rubocop.yml +7 -7
- data/.rubocop_todo.yml +88 -0
- data/CHANGELOG.md +29 -1
- data/README.md +1339 -236
- data/RUBY_WEEKLY_LAUNCH_POST.md +200 -0
- data/docs/RAILS_INTEGRATION_IMPLEMENTATION.md +209 -0
- data/docs/SINATRA_EXTENSION.md +399 -348
- data/docs/STRICT_VALIDATION.md +229 -0
- data/docs/VALIDATION_IMPROVEMENTS.md +218 -0
- data/docs/adr/0001-base-class-strategy.md +33 -0
- data/docs/adr/0002-type-shortcut-and-type-system.md +30 -0
- data/docs/adr/0003-openapi-source-of-truth.md +32 -0
- data/docs/adr/0004-client-generation-typescript-first.md +34 -0
- data/docs/adr/0005-auth-architecture.md +32 -0
- data/docs/adr/0006-observability-defaults.md +30 -0
- data/docs/adr/0007-ai-scope-and-boundaries.md +30 -0
- data/docs/adr/README.md +46 -0
- data/docs/adr/template.md +24 -0
- data/docs/ai-integration-plan.md +112 -0
- data/docs/auto-derivation.md +505 -92
- data/docs/blueprint.md +92 -4
- data/docs/endpoint-definition.md +536 -129
- data/docs/implementation-status.md +1 -1
- data/docs/n8n-integration.md +212 -0
- data/docs/observability.md +810 -500
- data/docs/using-mcp.md +93 -0
- data/examples/ai/knowledge_base_rag.rb +83 -0
- data/examples/ai/user_management_mcp.rb +92 -0
- data/examples/ai/user_validation_llm.rb +187 -0
- data/examples/auto_derivation_ruby_friendly.rb +44 -113
- data/examples/cli/user_api_endpoints.rb +63 -36
- data/examples/demo_api.rb +57 -18
- data/examples/enterprise_extension_demo.rb +13 -13
- data/examples/enterprise_rapitapir_api.rb +81 -93
- data/examples/nocodb/nocodb_scaffold/Gemfile +22 -0
- data/examples/nocodb/nocodb_scaffold/README.md +10 -0
- data/examples/nocodb/nocodb_scaffold/Rakefile +7 -0
- data/examples/nocodb/nocodb_scaffold/app/api/app.rb +1139 -0
- data/examples/nocodb/nocodb_scaffold/app/models/email_template.rb +6 -0
- data/examples/nocodb/nocodb_scaffold/app/models/faq.rb +6 -0
- data/examples/nocodb/nocodb_scaffold/app/models/feature.rb +6 -0
- data/examples/nocodb/nocodb_scaffold/app/models/idea.rb +6 -0
- data/examples/nocodb/nocodb_scaffold/app/models/itinerary_day.rb +6 -0
- data/examples/nocodb/nocodb_scaffold/app/models/route.rb +6 -0
- data/examples/nocodb/nocodb_scaffold/app/models/subscriber.rb +6 -0
- data/examples/nocodb/nocodb_scaffold/app/models/tour.rb +6 -0
- data/examples/nocodb/nocodb_scaffold/app/models/webhook.rb +6 -0
- data/examples/nocodb/nocodb_scaffold/app/models_loader.rb +3 -0
- data/examples/nocodb/nocodb_scaffold/config/database.yml +11 -0
- data/examples/nocodb/nocodb_scaffold/config.ru +9 -0
- data/examples/nocodb/nocodb_scaffold/db/migrate/20250808152012_create_features.rb +10 -0
- data/examples/nocodb/nocodb_scaffold/db/migrate/20250808152013_create_tours.rb +10 -0
- data/examples/nocodb/nocodb_scaffold/db/migrate/20250808152014_create_routes.rb +10 -0
- data/examples/nocodb/nocodb_scaffold/db/migrate/20250808152015_create_itinerary_days.rb +10 -0
- data/examples/nocodb/nocodb_scaffold/db/migrate/20250808152016_create_subscribers.rb +10 -0
- data/examples/nocodb/nocodb_scaffold/db/migrate/20250808152017_create_email_templates.rb +10 -0
- data/examples/nocodb/nocodb_scaffold/db/migrate/20250808152018_create_faqs.rb +10 -0
- data/examples/nocodb/nocodb_scaffold/db/migrate/20250808152019_create_webhooks.rb +10 -0
- data/examples/nocodb/nocodb_scaffold/db/migrate/20250808152020_create_ideas.rb +10 -0
- data/examples/nocodb/swagger.json +4378 -0
- data/examples/production_ready_example.rb +78 -58
- data/examples/rails/RAILS_8_GUIDE.md +165 -0
- data/examples/rails/RAILS_LOADING_FIX.rb +35 -0
- data/examples/rails/README.md +497 -0
- data/examples/rails/comprehensive_test.rb +91 -0
- data/examples/rails/config/routes.rb +48 -0
- data/examples/rails/debug_controller.rb +63 -0
- data/examples/rails/detailed_test.rb +46 -0
- data/examples/rails/enhanced_users_controller.rb +278 -0
- data/examples/rails/final_server_test.rb +50 -0
- data/examples/rails/hello_world_app.rb +116 -0
- data/examples/rails/hello_world_controller.rb +186 -0
- data/examples/rails/hello_world_routes.rb +28 -0
- data/examples/rails/rails8_minimal_demo.rb +132 -0
- data/examples/rails/rails8_simple_demo.rb +140 -0
- data/examples/rails/rails8_working_demo.rb +255 -0
- data/examples/rails/real_world_blog_api.rb +510 -0
- data/examples/rails/server_test.rb +46 -0
- data/examples/rails/test_direct_processing.rb +41 -0
- data/examples/rails/test_hello_world.rb +80 -0
- data/examples/rails/test_rails_integration.rb +54 -0
- data/examples/rails/traditional_app/Gemfile +37 -0
- data/examples/rails/traditional_app/README.md +265 -0
- data/examples/rails/traditional_app/app/controllers/api/v1/posts_controller.rb +254 -0
- data/examples/rails/traditional_app/app/controllers/api/v1/users_controller.rb +220 -0
- data/examples/rails/traditional_app/app/controllers/application_controller.rb +86 -0
- data/examples/rails/traditional_app/app/controllers/application_controller_simplified.rb +87 -0
- data/examples/rails/traditional_app/app/controllers/documentation_controller.rb +149 -0
- data/examples/rails/traditional_app/app/controllers/health_controller.rb +42 -0
- data/examples/rails/traditional_app/config/routes.rb +25 -0
- data/examples/rails/traditional_app/config/routes_best_practice.rb +25 -0
- data/examples/rails/traditional_app/config/routes_simplified.rb +36 -0
- data/examples/rails/traditional_app_runnable.rb +406 -0
- data/examples/rails/users_controller.rb +4 -1
- data/examples/serverless/Gemfile +43 -0
- data/examples/serverless/QUICKSTART.md +331 -0
- data/examples/serverless/README.md +520 -0
- data/examples/serverless/aws_lambda_example.rb +307 -0
- data/examples/serverless/aws_sam_template.yaml +215 -0
- data/examples/serverless/azure_functions_example.rb +407 -0
- data/examples/serverless/deploy.rb +204 -0
- data/examples/serverless/gcp_cloud_functions_example.rb +367 -0
- data/examples/serverless/gcp_function.yaml +23 -0
- data/examples/serverless/host.json +24 -0
- data/examples/serverless/package.json +32 -0
- data/examples/serverless/spec/aws_lambda_spec.rb +196 -0
- data/examples/serverless/spec/spec_helper.rb +89 -0
- data/examples/serverless/vercel.json +31 -0
- data/examples/serverless/vercel_example.rb +404 -0
- data/examples/simple_demo_api.rb +40 -7
- data/examples/strict_validation_examples.rb +104 -0
- data/examples/user_api.rb +130 -132
- data/examples/validation_error_examples.rb +173 -0
- data/lib/rapitapir/ai/llm_instruction.rb +456 -0
- data/lib/rapitapir/ai/mcp.rb +134 -0
- data/lib/rapitapir/ai/rag.rb +287 -0
- data/lib/rapitapir/ai/rag_middleware.rb +147 -0
- data/lib/rapitapir/auth/oauth2.rb +44 -58
- data/lib/rapitapir/cli/command.rb +392 -6
- data/lib/rapitapir/cli/mcp_export.rb +18 -0
- data/lib/rapitapir/cli/scaffold_generator.rb +639 -0
- data/lib/rapitapir/cli/validator.rb +3 -7
- data/lib/rapitapir/core/endpoint.rb +59 -6
- data/lib/rapitapir/core/enhanced_endpoint.rb +3 -7
- data/lib/rapitapir/dsl/enhanced_structures.rb +1 -1
- data/lib/rapitapir/dsl/fluent_endpoint_builder.rb +53 -0
- data/lib/rapitapir/endpoint_registry.rb +47 -0
- data/lib/rapitapir/observability/health_check.rb +4 -4
- data/lib/rapitapir/observability/logging.rb +10 -10
- data/lib/rapitapir/openapi/schema_generator.rb +46 -2
- data/lib/rapitapir/schema.rb +2 -2
- data/lib/rapitapir/server/enhanced_rack_adapter.rb +11 -8
- data/lib/rapitapir/server/middleware.rb +2 -2
- data/lib/rapitapir/server/rack_adapter.rb +1 -3
- data/lib/rapitapir/server/rails/configuration.rb +77 -0
- data/lib/rapitapir/server/rails/controller_base.rb +185 -0
- data/lib/rapitapir/server/rails/documentation_helpers.rb +76 -0
- data/lib/rapitapir/server/rails/resource_builder.rb +181 -0
- data/lib/rapitapir/server/rails/routes.rb +114 -0
- data/lib/rapitapir/server/rails_adapter.rb +10 -3
- data/lib/rapitapir/server/rails_adapter_class.rb +1 -3
- data/lib/rapitapir/server/rails_controller.rb +1 -3
- data/lib/rapitapir/server/rails_integration.rb +67 -0
- data/lib/rapitapir/server/rails_response_handler.rb +16 -3
- data/lib/rapitapir/server/sinatra_adapter.rb +29 -5
- data/lib/rapitapir/server/sinatra_integration.rb +4 -4
- data/lib/rapitapir/sinatra/extension.rb +2 -2
- data/lib/rapitapir/sinatra/oauth2_helpers.rb +34 -40
- data/lib/rapitapir/types/array.rb +4 -0
- data/lib/rapitapir/types/auto_derivation.rb +4 -20
- data/lib/rapitapir/types/datetime.rb +1 -3
- data/lib/rapitapir/types/float.rb +2 -6
- data/lib/rapitapir/types/hash.rb +40 -2
- data/lib/rapitapir/types/integer.rb +4 -12
- data/lib/rapitapir/types/object.rb +6 -2
- data/lib/rapitapir/types.rb +6 -2
- data/lib/rapitapir/version.rb +1 -1
- data/lib/rapitapir.rb +5 -3
- data/rapitapir.gemspec +3 -2
- metadata +142 -8
|
@@ -1,56 +1,83 @@
|
|
|
1
1
|
# frozen_string_literal: true
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
lib_path = File.expand_path('../lib', __dir__)
|
|
5
|
-
$LOAD_PATH.unshift(lib_path) unless $LOAD_PATH.include?(lib_path)
|
|
3
|
+
require_relative '../../lib/rapitapir'
|
|
6
4
|
|
|
7
|
-
|
|
5
|
+
USER_TYPE = RapiTapir::Types.hash({
|
|
6
|
+
'id' => RapiTapir::Types.integer,
|
|
7
|
+
'name' => RapiTapir::Types.string,
|
|
8
|
+
'email' => RapiTapir::Types.string
|
|
9
|
+
})
|
|
8
10
|
|
|
9
|
-
|
|
10
|
-
|
|
11
|
+
USER_FULL_TYPE = RapiTapir::Types.hash({
|
|
12
|
+
'id' => RapiTapir::Types.integer,
|
|
13
|
+
'name' => RapiTapir::Types.string,
|
|
14
|
+
'email' => RapiTapir::Types.string,
|
|
15
|
+
'created_at' => RapiTapir::Types.string
|
|
16
|
+
})
|
|
17
|
+
|
|
18
|
+
CREATE_USER_TYPE = RapiTapir::Types.hash({
|
|
19
|
+
'name' => RapiTapir::Types.string,
|
|
20
|
+
'email' => RapiTapir::Types.string,
|
|
21
|
+
'password' => RapiTapir::Types.string
|
|
22
|
+
})
|
|
23
|
+
|
|
24
|
+
ERROR_TYPE = RapiTapir::Types.hash({
|
|
25
|
+
'error' => RapiTapir::Types.string,
|
|
26
|
+
'message' => RapiTapir::Types.string
|
|
27
|
+
})
|
|
28
|
+
|
|
29
|
+
VALIDATION_ERROR_TYPE = RapiTapir::Types.hash({
|
|
30
|
+
'error' => RapiTapir::Types.string,
|
|
31
|
+
'validation_errors' => RapiTapir::Types.array(RapiTapir::Types.string)
|
|
32
|
+
})
|
|
11
33
|
|
|
12
34
|
# Define endpoints for CLI usage
|
|
13
|
-
[
|
|
35
|
+
user_api_endpoints = [
|
|
14
36
|
# Get all users
|
|
15
37
|
RapiTapir.get('/users')
|
|
16
|
-
.
|
|
38
|
+
.ok(RapiTapir::Types.array(USER_TYPE))
|
|
17
39
|
.summary('Get all users')
|
|
18
|
-
.description('Retrieve a list of all users')
|
|
40
|
+
.description('Retrieve a list of all users')
|
|
41
|
+
.build,
|
|
19
42
|
|
|
20
43
|
# Get user by ID
|
|
21
44
|
RapiTapir.get('/users/:id')
|
|
22
|
-
.
|
|
23
|
-
.
|
|
45
|
+
.path_param(:id, RapiTapir::Types.integer)
|
|
46
|
+
.ok(USER_FULL_TYPE)
|
|
47
|
+
.not_found(ERROR_TYPE)
|
|
24
48
|
.summary('Get user by ID')
|
|
25
|
-
.description('Retrieve a specific user by their ID')
|
|
49
|
+
.description('Retrieve a specific user by their ID')
|
|
50
|
+
.build,
|
|
26
51
|
|
|
27
|
-
# Create new user
|
|
52
|
+
# Create a new user
|
|
28
53
|
RapiTapir.post('/users')
|
|
29
|
-
.
|
|
30
|
-
.
|
|
31
|
-
.
|
|
32
|
-
.
|
|
54
|
+
.json_body(CREATE_USER_TYPE)
|
|
55
|
+
.created(USER_TYPE)
|
|
56
|
+
.bad_request(VALIDATION_ERROR_TYPE)
|
|
57
|
+
.summary('Create a new user')
|
|
58
|
+
.description('Create a new user account')
|
|
59
|
+
.build,
|
|
33
60
|
|
|
34
|
-
# Update user
|
|
61
|
+
# Update a user
|
|
35
62
|
RapiTapir.put('/users/:id')
|
|
36
|
-
.
|
|
37
|
-
.
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
63
|
+
.path_param(:id, RapiTapir::Types.integer)
|
|
64
|
+
.json_body(RapiTapir::Types.hash({
|
|
65
|
+
'name' => RapiTapir::Types.string,
|
|
66
|
+
'email' => RapiTapir::Types.string
|
|
67
|
+
}))
|
|
68
|
+
.ok(USER_FULL_TYPE)
|
|
69
|
+
.not_found(ERROR_TYPE)
|
|
70
|
+
.bad_request(VALIDATION_ERROR_TYPE)
|
|
71
|
+
.summary('Update a user')
|
|
72
|
+
.description('Update an existing user')
|
|
73
|
+
.build,
|
|
41
74
|
|
|
42
|
-
# Delete user
|
|
75
|
+
# Delete a user
|
|
43
76
|
RapiTapir.delete('/users/:id')
|
|
44
|
-
.
|
|
45
|
-
.
|
|
46
|
-
.
|
|
47
|
-
.
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
RapiTapir.get('/users/search')
|
|
51
|
-
.in(query(:q, :string))
|
|
52
|
-
.in(query(:limit, :integer, optional: true))
|
|
53
|
-
.out(json_body([{ id: :integer, name: :string, email: :string }]))
|
|
54
|
-
.summary('Search users')
|
|
55
|
-
.description('Search for users by name or email')
|
|
77
|
+
.path_param(:id, RapiTapir::Types.integer)
|
|
78
|
+
.no_content
|
|
79
|
+
.not_found(ERROR_TYPE)
|
|
80
|
+
.summary('Delete a user')
|
|
81
|
+
.description('Permanently delete a user account')
|
|
82
|
+
.build
|
|
56
83
|
]
|
data/examples/demo_api.rb
CHANGED
|
@@ -1,41 +1,80 @@
|
|
|
1
1
|
# frozen_string_literal: true
|
|
2
2
|
|
|
3
|
-
require_relative 'lib/rapitapir'
|
|
4
|
-
|
|
3
|
+
require_relative '../lib/rapitapir'
|
|
4
|
+
|
|
5
|
+
# Type definitions
|
|
6
|
+
USER_TYPE = RapiTapir::Types.hash({
|
|
7
|
+
'id' => RapiTapir::Types.integer,
|
|
8
|
+
'name' => RapiTapir::Types.string,
|
|
9
|
+
'email' => RapiTapir::Types.string
|
|
10
|
+
})
|
|
11
|
+
|
|
12
|
+
USER_FULL_TYPE = RapiTapir::Types.hash({
|
|
13
|
+
'id' => RapiTapir::Types.integer,
|
|
14
|
+
'name' => RapiTapir::Types.string,
|
|
15
|
+
'email' => RapiTapir::Types.string,
|
|
16
|
+
'created_at' => RapiTapir::Types.string
|
|
17
|
+
})
|
|
18
|
+
|
|
19
|
+
CREATE_USER_TYPE = RapiTapir::Types.hash({
|
|
20
|
+
'name' => RapiTapir::Types.string,
|
|
21
|
+
'email' => RapiTapir::Types.string,
|
|
22
|
+
'password' => RapiTapir::Types.string
|
|
23
|
+
})
|
|
24
|
+
|
|
25
|
+
ERROR_TYPE = RapiTapir::Types.hash({
|
|
26
|
+
'error' => RapiTapir::Types.string,
|
|
27
|
+
'message' => RapiTapir::Types.string
|
|
28
|
+
})
|
|
29
|
+
|
|
30
|
+
VALIDATION_ERROR_TYPE = RapiTapir::Types.hash({
|
|
31
|
+
'error' => RapiTapir::Types.string,
|
|
32
|
+
'validation_errors' => RapiTapir::Types.array(RapiTapir::Types.string)
|
|
33
|
+
})
|
|
5
34
|
|
|
6
35
|
# Sample API endpoints for demonstration
|
|
7
36
|
RapiTapir.get('/users')
|
|
8
|
-
.
|
|
37
|
+
.ok(RapiTapir::Types.array(USER_TYPE))
|
|
9
38
|
.summary('List all users')
|
|
10
39
|
.description('Retrieve a paginated list of all users in the system')
|
|
40
|
+
.build
|
|
11
41
|
|
|
12
42
|
RapiTapir.get('/users/:id')
|
|
13
|
-
.
|
|
14
|
-
.
|
|
15
|
-
.
|
|
43
|
+
.path_param(:id, RapiTapir::Types.integer)
|
|
44
|
+
.ok(USER_FULL_TYPE)
|
|
45
|
+
.not_found(ERROR_TYPE)
|
|
16
46
|
.summary('Get user by ID')
|
|
17
47
|
.description('Retrieve detailed information about a specific user')
|
|
48
|
+
.build
|
|
18
49
|
|
|
19
50
|
RapiTapir.post('/users')
|
|
20
|
-
.
|
|
21
|
-
.
|
|
22
|
-
.
|
|
23
|
-
.
|
|
51
|
+
.json_body(CREATE_USER_TYPE)
|
|
52
|
+
.created(USER_TYPE)
|
|
53
|
+
.bad_request(VALIDATION_ERROR_TYPE)
|
|
54
|
+
.unprocessable_entity(ERROR_TYPE)
|
|
24
55
|
.summary('Create new user')
|
|
25
56
|
.description('Create a new user account with the provided information')
|
|
57
|
+
.build
|
|
26
58
|
|
|
27
59
|
RapiTapir.put('/users/:id')
|
|
28
|
-
.
|
|
29
|
-
.
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
60
|
+
.path_param(:id, RapiTapir::Types.integer)
|
|
61
|
+
.json_body(RapiTapir::Types.hash({
|
|
62
|
+
'name' => RapiTapir::Types.string,
|
|
63
|
+
'email' => RapiTapir::Types.string
|
|
64
|
+
}))
|
|
65
|
+
.ok(USER_FULL_TYPE)
|
|
66
|
+
.not_found(ERROR_TYPE)
|
|
67
|
+
.bad_request(VALIDATION_ERROR_TYPE)
|
|
33
68
|
.summary('Update user')
|
|
34
69
|
.description('Update an existing user with new information')
|
|
70
|
+
.build
|
|
35
71
|
|
|
36
72
|
RapiTapir.delete('/users/:id')
|
|
37
|
-
.
|
|
38
|
-
.
|
|
39
|
-
.
|
|
73
|
+
.path_param(:id, RapiTapir::Types.integer)
|
|
74
|
+
.no_content
|
|
75
|
+
.not_found(ERROR_TYPE)
|
|
40
76
|
.summary('Delete user')
|
|
41
77
|
.description('Permanently delete a user account')
|
|
78
|
+
.build
|
|
79
|
+
|
|
80
|
+
puts "✅ Defined #{RapiTapir.endpoints.size} endpoints"
|
|
@@ -135,21 +135,21 @@ if SINATRA_AVAILABLE
|
|
|
135
135
|
server(url: 'https://api.example.com', description: 'Production server')
|
|
136
136
|
|
|
137
137
|
# Authentication configuration
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
138
|
+
add_auth_scheme(:bearer, RapiTapir::Auth.bearer_token(:bearer, {
|
|
139
|
+
realm: 'Enterprise Task Management API',
|
|
140
|
+
token_validator: proc do |token|
|
|
141
|
+
user = UserDatabase.find_by_token(token)
|
|
142
|
+
next nil unless user
|
|
143
|
+
|
|
144
|
+
{
|
|
145
|
+
user: user,
|
|
146
|
+
scopes: user[:scopes]
|
|
147
|
+
}
|
|
148
|
+
end
|
|
149
|
+
}))
|
|
150
150
|
|
|
151
151
|
# Middleware configuration based on environment
|
|
152
|
-
if development
|
|
152
|
+
if Sinatra::Base.environment == :development
|
|
153
153
|
development_defaults!
|
|
154
154
|
else
|
|
155
155
|
production_defaults!
|
|
@@ -13,6 +13,7 @@
|
|
|
13
13
|
|
|
14
14
|
require 'sinatra/base'
|
|
15
15
|
require 'json'
|
|
16
|
+
require 'rack'
|
|
16
17
|
require_relative '../lib/rapitapir'
|
|
17
18
|
require_relative '../lib/rapitapir/server/sinatra_adapter'
|
|
18
19
|
|
|
@@ -313,79 +314,43 @@ end
|
|
|
313
314
|
|
|
314
315
|
# Main Sinatra Application
|
|
315
316
|
class EnterpriseTaskAPI < Sinatra::Base
|
|
316
|
-
|
|
317
|
-
|
|
318
|
-
|
|
319
|
-
|
|
320
|
-
|
|
321
|
-
|
|
322
|
-
|
|
323
|
-
|
|
324
|
-
|
|
325
|
-
|
|
326
|
-
|
|
327
|
-
|
|
328
|
-
|
|
329
|
-
user
|
|
330
|
-
|
|
331
|
-
|
|
332
|
-
|
|
333
|
-
user: user,
|
|
334
|
-
scopes: user[:scopes]
|
|
335
|
-
}
|
|
336
|
-
end
|
|
337
|
-
})
|
|
338
|
-
|
|
339
|
-
auth_schemes = { bearer: bearer_auth }
|
|
340
|
-
|
|
341
|
-
# Setup middleware stack
|
|
342
|
-
use RapiTapir::Auth::Middleware::SecurityHeadersMiddleware
|
|
343
|
-
use RapiTapir::Auth::Middleware::CorsMiddleware, {
|
|
344
|
-
allowed_origins: ['http://localhost:3000', 'https://app.example.com'],
|
|
345
|
-
allowed_methods: %w[GET POST PUT DELETE PATCH OPTIONS],
|
|
346
|
-
allowed_headers: %w[Authorization Content-Type Accept],
|
|
347
|
-
allow_credentials: true
|
|
348
|
-
}
|
|
349
|
-
use RapiTapir::Auth::Middleware::RateLimitingMiddleware, {
|
|
350
|
-
requests_per_minute: 100,
|
|
351
|
-
requests_per_hour: 2000
|
|
352
|
-
}
|
|
353
|
-
use RapiTapir::Auth::Middleware::AuthenticationMiddleware, auth_schemes
|
|
354
|
-
|
|
355
|
-
# Setup RapiTapir adapter and register endpoints
|
|
356
|
-
setup_rapitapir_endpoints
|
|
357
|
-
end
|
|
358
|
-
|
|
359
|
-
# Helper methods
|
|
360
|
-
def json_response(status, data)
|
|
361
|
-
content_type :json
|
|
362
|
-
halt status, JSON.generate(data)
|
|
363
|
-
end
|
|
364
|
-
|
|
365
|
-
def require_scope(scope)
|
|
366
|
-
return if RapiTapir::Auth.has_scope?(scope)
|
|
367
|
-
|
|
368
|
-
json_response(403, { error: "#{scope.capitalize} permission required" })
|
|
369
|
-
end
|
|
370
|
-
|
|
371
|
-
def require_authenticated
|
|
372
|
-
return if RapiTapir::Auth.authenticated?
|
|
373
|
-
|
|
374
|
-
json_response(401, { error: 'Authentication required' })
|
|
375
|
-
end
|
|
376
|
-
|
|
377
|
-
def parse_json_body
|
|
378
|
-
if request.content_type&.include?('application/json') && request.body.read.length.positive?
|
|
379
|
-
request.body.rewind
|
|
380
|
-
JSON.parse(request.body.read, symbolize_names: true)
|
|
381
|
-
else
|
|
382
|
-
{}
|
|
383
|
-
end
|
|
384
|
-
rescue JSON::ParserError
|
|
385
|
-
json_response(400, { error: 'Invalid JSON' })
|
|
386
|
-
end
|
|
317
|
+
set :show_exceptions, false
|
|
318
|
+
set :raise_errors, false
|
|
319
|
+
set :dump_errors, false
|
|
320
|
+
|
|
321
|
+
# Setup authentication scheme
|
|
322
|
+
bearer_auth = RapiTapir::Auth.bearer_token(:bearer, {
|
|
323
|
+
realm: 'Enterprise Task Management API',
|
|
324
|
+
token_validator: proc do |token|
|
|
325
|
+
user = UserDatabase.find_by_token(token)
|
|
326
|
+
next nil unless user
|
|
327
|
+
|
|
328
|
+
{
|
|
329
|
+
user: user,
|
|
330
|
+
scopes: user[:scopes]
|
|
331
|
+
}
|
|
332
|
+
end
|
|
333
|
+
})
|
|
387
334
|
|
|
388
|
-
|
|
335
|
+
auth_schemes = { bearer: bearer_auth }
|
|
336
|
+
|
|
337
|
+
# Setup middleware stack
|
|
338
|
+
use RapiTapir::Auth::Middleware::SecurityHeadersMiddleware
|
|
339
|
+
use RapiTapir::Auth::Middleware::CorsMiddleware, {
|
|
340
|
+
allowed_origins: ['http://localhost:3000', 'https://app.example.com'],
|
|
341
|
+
allowed_methods: %w[GET POST PUT DELETE PATCH OPTIONS],
|
|
342
|
+
allowed_headers: %w[Authorization Content-Type Accept],
|
|
343
|
+
allow_credentials: true
|
|
344
|
+
}
|
|
345
|
+
use RapiTapir::Auth::Middleware::RateLimitingMiddleware, {
|
|
346
|
+
requests_per_minute: 100,
|
|
347
|
+
requests_per_hour: 2000
|
|
348
|
+
}
|
|
349
|
+
use RapiTapir::Auth::Middleware::AuthenticationMiddleware, auth_schemes
|
|
350
|
+
|
|
351
|
+
# --- helpers removed: see class-level json_response/enforce!/format_task ---
|
|
352
|
+
|
|
353
|
+
def self.format_task(task)
|
|
389
354
|
task_copy = task.dup
|
|
390
355
|
task_copy[:created_at] = task_copy[:created_at].iso8601 if task_copy[:created_at]
|
|
391
356
|
task_copy[:updated_at] = task_copy[:updated_at].iso8601 if task_copy[:updated_at]
|
|
@@ -394,16 +359,36 @@ class EnterpriseTaskAPI < Sinatra::Base
|
|
|
394
359
|
|
|
395
360
|
private
|
|
396
361
|
|
|
397
|
-
def setup_rapitapir_endpoints
|
|
362
|
+
def self.setup_rapitapir_endpoints
|
|
363
|
+
# Bind the adapter to the app class: route DSL (get/post/...) is a class
|
|
364
|
+
# method, and handlers instance_exec'd against the class can use the
|
|
365
|
+
# class-level helpers below (json_response, enforce!, format_task).
|
|
398
366
|
adapter = RapiTapir::Server::SinatraAdapter.new(self)
|
|
399
367
|
|
|
400
368
|
# Register all endpoints using the adapter
|
|
401
369
|
TaskAPI.endpoints.each do |endpoint|
|
|
402
370
|
adapter.register_endpoint(endpoint, get_endpoint_handler(endpoint))
|
|
403
371
|
end
|
|
372
|
+
|
|
373
|
+
adapter
|
|
374
|
+
end
|
|
375
|
+
|
|
376
|
+
# Helper methods (class-level; the adapter runs handlers in class context).
|
|
377
|
+
# Handlers return either a plain data hash (200 + JSON) or a
|
|
378
|
+
# [status, headers, body] triple, which the adapter translates directly.
|
|
379
|
+
def self.json_response(status, data)
|
|
380
|
+
[status, { 'Content-Type' => 'application/json' }, JSON.generate(data)]
|
|
404
381
|
end
|
|
405
382
|
|
|
406
|
-
|
|
383
|
+
# Returns nil when the scope is satisfied, otherwise a 401/403 response triple.
|
|
384
|
+
def self.enforce!(scope)
|
|
385
|
+
return json_response(401, { error: 'Authentication required' }) unless RapiTapir::Auth.authenticated?
|
|
386
|
+
return json_response(403, { error: "#{scope.capitalize} permission required" }) unless RapiTapir::Auth.scope?(scope)
|
|
387
|
+
|
|
388
|
+
nil
|
|
389
|
+
end
|
|
390
|
+
|
|
391
|
+
def self.get_endpoint_handler(endpoint)
|
|
407
392
|
case endpoint.path
|
|
408
393
|
when '/health'
|
|
409
394
|
proc do |_inputs|
|
|
@@ -420,8 +405,8 @@ class EnterpriseTaskAPI < Sinatra::Base
|
|
|
420
405
|
when '/api/v1/tasks'
|
|
421
406
|
if endpoint.method == :get
|
|
422
407
|
proc do |inputs|
|
|
423
|
-
|
|
424
|
-
|
|
408
|
+
guard = enforce!('read')
|
|
409
|
+
return guard if guard
|
|
425
410
|
|
|
426
411
|
tasks = TaskDatabase.all
|
|
427
412
|
|
|
@@ -440,8 +425,8 @@ class EnterpriseTaskAPI < Sinatra::Base
|
|
|
440
425
|
end
|
|
441
426
|
else # POST
|
|
442
427
|
proc do |inputs|
|
|
443
|
-
|
|
444
|
-
|
|
428
|
+
guard = enforce!('write')
|
|
429
|
+
return guard if guard
|
|
445
430
|
|
|
446
431
|
body = inputs[:body] || {}
|
|
447
432
|
|
|
@@ -463,11 +448,11 @@ class EnterpriseTaskAPI < Sinatra::Base
|
|
|
463
448
|
case endpoint.method
|
|
464
449
|
when :get
|
|
465
450
|
proc do |inputs|
|
|
466
|
-
|
|
467
|
-
|
|
451
|
+
guard = enforce!('read')
|
|
452
|
+
return guard if guard
|
|
468
453
|
|
|
469
454
|
task = TaskDatabase.find(inputs[:id])
|
|
470
|
-
|
|
455
|
+
return json_response(404, { error: 'Task not found' }) unless task
|
|
471
456
|
|
|
472
457
|
# Enrich with assignee details
|
|
473
458
|
assignee = UserDatabase.find_by_id(task[:assignee_id])
|
|
@@ -484,11 +469,11 @@ class EnterpriseTaskAPI < Sinatra::Base
|
|
|
484
469
|
end
|
|
485
470
|
when :put
|
|
486
471
|
proc do |inputs|
|
|
487
|
-
|
|
488
|
-
|
|
472
|
+
guard = enforce!('write')
|
|
473
|
+
return guard if guard
|
|
489
474
|
|
|
490
475
|
task = TaskDatabase.find(inputs[:id])
|
|
491
|
-
|
|
476
|
+
return json_response(404, { error: 'Task not found' }) unless task
|
|
492
477
|
|
|
493
478
|
body = inputs[:body] || {}
|
|
494
479
|
update_data = {}
|
|
@@ -505,21 +490,21 @@ class EnterpriseTaskAPI < Sinatra::Base
|
|
|
505
490
|
end
|
|
506
491
|
when :delete
|
|
507
492
|
proc do |inputs|
|
|
508
|
-
|
|
509
|
-
|
|
493
|
+
guard = enforce!('admin')
|
|
494
|
+
return guard if guard
|
|
510
495
|
|
|
511
496
|
task = TaskDatabase.find(inputs[:id])
|
|
512
|
-
|
|
497
|
+
return json_response(404, { error: 'Task not found' }) unless task
|
|
513
498
|
|
|
514
499
|
TaskDatabase.delete(inputs[:id])
|
|
515
|
-
|
|
516
|
-
nil # Return nothing for 204 No Content
|
|
500
|
+
[204, {}, '']
|
|
517
501
|
end
|
|
518
502
|
end
|
|
519
503
|
|
|
520
504
|
when '/api/v1/profile'
|
|
521
505
|
proc do |_inputs|
|
|
522
|
-
|
|
506
|
+
guard = enforce!('read')
|
|
507
|
+
return guard if guard
|
|
523
508
|
|
|
524
509
|
current_user = RapiTapir::Auth.current_user
|
|
525
510
|
|
|
@@ -539,15 +524,15 @@ class EnterpriseTaskAPI < Sinatra::Base
|
|
|
539
524
|
|
|
540
525
|
when '/api/v1/admin/users'
|
|
541
526
|
proc do |_inputs|
|
|
542
|
-
|
|
543
|
-
|
|
527
|
+
guard = enforce!('admin')
|
|
528
|
+
return guard if guard
|
|
544
529
|
|
|
545
530
|
UserDatabase.all_users
|
|
546
531
|
end
|
|
547
532
|
|
|
548
533
|
else
|
|
549
534
|
proc do |_inputs|
|
|
550
|
-
|
|
535
|
+
json_response(404, { error: 'Endpoint not implemented' })
|
|
551
536
|
end
|
|
552
537
|
end
|
|
553
538
|
end
|
|
@@ -656,6 +641,9 @@ class EnterpriseTaskAPI < Sinatra::Base
|
|
|
656
641
|
puts '🔧 Architecture: Routes handled by SinatraAdapter with automatic input/output validation'
|
|
657
642
|
puts ''
|
|
658
643
|
end
|
|
644
|
+
|
|
645
|
+
# Now that get_endpoint_handler is defined, wire up the adapter + routes
|
|
646
|
+
setup_rapitapir_endpoints
|
|
659
647
|
end
|
|
660
648
|
|
|
661
649
|
# Start the server if this file is run directly
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
source 'https://rubygems.org'
|
|
2
|
+
|
|
3
|
+
ruby '>= 3.2.0'
|
|
4
|
+
|
|
5
|
+
gem 'sinatra'
|
|
6
|
+
gem 'activerecord', require: 'active_record'
|
|
7
|
+
gem 'sinatra-activerecord'
|
|
8
|
+
gem 'sqlite3'
|
|
9
|
+
gem 'rackup'
|
|
10
|
+
gem 'rake'
|
|
11
|
+
|
|
12
|
+
# API layer
|
|
13
|
+
# If you're using this scaffold from inside the rapitapir repo, this local path works.
|
|
14
|
+
# Otherwise, replace with: gem 'rapitapir', '~> 2.0.1'
|
|
15
|
+
gem 'rapitapir', path: File.expand_path('../../..', __dir__)
|
|
16
|
+
|
|
17
|
+
group :development, :test do
|
|
18
|
+
gem 'rspec'
|
|
19
|
+
gem 'rack-test'
|
|
20
|
+
gem 'dotenv'
|
|
21
|
+
gem 'pry'
|
|
22
|
+
end
|