rapitapir 2.0.0 → 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.
Files changed (63) hide show
  1. checksums.yaml +4 -4
  2. data/.rubocop_todo.yml +5 -0
  3. data/CHANGELOG.md +29 -1
  4. data/README.md +23 -4
  5. data/RUBY_WEEKLY_LAUNCH_POST.md +43 -62
  6. data/docs/adr/0001-base-class-strategy.md +33 -0
  7. data/docs/adr/0002-type-shortcut-and-type-system.md +30 -0
  8. data/docs/adr/0003-openapi-source-of-truth.md +32 -0
  9. data/docs/adr/0004-client-generation-typescript-first.md +34 -0
  10. data/docs/adr/0005-auth-architecture.md +32 -0
  11. data/docs/adr/0006-observability-defaults.md +30 -0
  12. data/docs/adr/0007-ai-scope-and-boundaries.md +30 -0
  13. data/docs/adr/README.md +46 -0
  14. data/docs/adr/template.md +24 -0
  15. data/docs/blueprint.md +92 -4
  16. data/docs/implementation-status.md +1 -1
  17. data/examples/auto_derivation_ruby_friendly.rb +44 -113
  18. data/examples/cli/user_api_endpoints.rb +63 -36
  19. data/examples/demo_api.rb +57 -18
  20. data/examples/enterprise_extension_demo.rb +13 -13
  21. data/examples/enterprise_rapitapir_api.rb +81 -93
  22. data/examples/nocodb/nocodb_scaffold/Gemfile +22 -0
  23. data/examples/nocodb/nocodb_scaffold/README.md +10 -0
  24. data/examples/nocodb/nocodb_scaffold/Rakefile +7 -0
  25. data/examples/nocodb/nocodb_scaffold/app/api/app.rb +1139 -0
  26. data/examples/nocodb/nocodb_scaffold/app/models/email_template.rb +6 -0
  27. data/examples/nocodb/nocodb_scaffold/app/models/faq.rb +6 -0
  28. data/examples/nocodb/nocodb_scaffold/app/models/feature.rb +6 -0
  29. data/examples/nocodb/nocodb_scaffold/app/models/idea.rb +6 -0
  30. data/examples/nocodb/nocodb_scaffold/app/models/itinerary_day.rb +6 -0
  31. data/examples/nocodb/nocodb_scaffold/app/models/route.rb +6 -0
  32. data/examples/nocodb/nocodb_scaffold/app/models/subscriber.rb +6 -0
  33. data/examples/nocodb/nocodb_scaffold/app/models/tour.rb +6 -0
  34. data/examples/nocodb/nocodb_scaffold/app/models/webhook.rb +6 -0
  35. data/examples/nocodb/nocodb_scaffold/app/models_loader.rb +3 -0
  36. data/examples/nocodb/nocodb_scaffold/config/database.yml +11 -0
  37. data/examples/nocodb/nocodb_scaffold/config.ru +9 -0
  38. data/examples/nocodb/nocodb_scaffold/db/migrate/20250808152012_create_features.rb +10 -0
  39. data/examples/nocodb/nocodb_scaffold/db/migrate/20250808152013_create_tours.rb +10 -0
  40. data/examples/nocodb/nocodb_scaffold/db/migrate/20250808152014_create_routes.rb +10 -0
  41. data/examples/nocodb/nocodb_scaffold/db/migrate/20250808152015_create_itinerary_days.rb +10 -0
  42. data/examples/nocodb/nocodb_scaffold/db/migrate/20250808152016_create_subscribers.rb +10 -0
  43. data/examples/nocodb/nocodb_scaffold/db/migrate/20250808152017_create_email_templates.rb +10 -0
  44. data/examples/nocodb/nocodb_scaffold/db/migrate/20250808152018_create_faqs.rb +10 -0
  45. data/examples/nocodb/nocodb_scaffold/db/migrate/20250808152019_create_webhooks.rb +10 -0
  46. data/examples/nocodb/nocodb_scaffold/db/migrate/20250808152020_create_ideas.rb +10 -0
  47. data/examples/nocodb/swagger.json +4378 -0
  48. data/examples/production_ready_example.rb +78 -58
  49. data/examples/simple_demo_api.rb +40 -7
  50. data/examples/user_api.rb +130 -132
  51. data/lib/rapitapir/auth/oauth2.rb +1 -1
  52. data/lib/rapitapir/cli/command.rb +30 -4
  53. data/lib/rapitapir/cli/scaffold_generator.rb +639 -0
  54. data/lib/rapitapir/cli/validator.rb +1 -1
  55. data/lib/rapitapir/core/enhanced_endpoint.rb +1 -1
  56. data/lib/rapitapir/dsl/enhanced_structures.rb +1 -1
  57. data/lib/rapitapir/openapi/schema_generator.rb +46 -2
  58. data/lib/rapitapir/server/enhanced_rack_adapter.rb +11 -8
  59. data/lib/rapitapir/server/middleware.rb +2 -2
  60. data/lib/rapitapir/types/auto_derivation.rb +2 -4
  61. data/lib/rapitapir/version.rb +1 -1
  62. data/rapitapir.gemspec +3 -2
  63. metadata +70 -8
@@ -13,6 +13,7 @@ module RapiTapir
13
13
  @endpoints = endpoints
14
14
  @info = default_info.merge(info)
15
15
  @servers = servers.empty? ? default_servers : servers
16
+ @components_schemas = {}
16
17
  end
17
18
 
18
19
  # Generate complete OpenAPI 3.0 specification
@@ -272,11 +273,23 @@ module RapiTapir
272
273
  end
273
274
 
274
275
  def generate_schema_components
275
- # For now, return empty. In the future, we can extract common schemas
276
- {}
276
+ # Collected during generation when encountering types with a component_name
277
+ @components_schemas
277
278
  end
278
279
 
279
280
  def type_to_schema(type)
281
+ # If the type carries a component name, register it and return a $ref
282
+ if type.respond_to?(:metadata)
283
+ name = type.metadata[:component_name]
284
+ if name && !name.to_s.empty?
285
+ add_component_schema(name, schema_payload_for(type))
286
+ return { '$ref' => "#/components/schemas/#{sanitize_component_name(name)}" }
287
+ end
288
+ end
289
+
290
+ # If the type knows how to render itself to JSON Schema, use that
291
+ return type.to_json_schema if type.respond_to?(:to_json_schema)
292
+
280
293
  case type
281
294
  when RapiTapir::Types::String, :string, String
282
295
  { type: 'string' }
@@ -291,6 +304,37 @@ module RapiTapir
291
304
  end
292
305
  end
293
306
 
307
+ def schema_payload_for(type)
308
+ if type.respond_to?(:to_json_schema)
309
+ type.to_json_schema
310
+ else
311
+ generate_complex_type_schema(type)
312
+ end
313
+ end
314
+
315
+ def add_component_schema(name, schema)
316
+ key = sanitize_component_name(name)
317
+ @components_schemas[key] ||= deep_stringify_keys(schema)
318
+ end
319
+
320
+ def sanitize_component_name(name)
321
+ key = name.to_s.strip
322
+ key = key.gsub(/[^A-Za-z0-9_.-]/, '_')
323
+ key = "Model_#{key}" if key.empty? || key =~ /^\d/
324
+ key
325
+ end
326
+
327
+ def deep_stringify_keys(obj)
328
+ case obj
329
+ when Array
330
+ obj.map { |v| deep_stringify_keys(v) }
331
+ when Hash
332
+ obj.each_with_object({}) { |(k, v), h| h[k.to_s] = deep_stringify_keys(v) }
333
+ else
334
+ obj
335
+ end
336
+ end
337
+
294
338
  def generate_complex_type_schema(type)
295
339
  case type
296
340
  when RapiTapir::Types::Array
@@ -203,7 +203,8 @@ module RapiTapir
203
203
  return nil if body.empty?
204
204
 
205
205
  content_type = request.content_type&.downcase
206
- format = input.options[:format] || detect_format_from_content_type(content_type)
206
+ # EnhancedInput exposes `format` directly; fall back to content-type detection
207
+ format = (input.respond_to?(:format) && input.format) || detect_format_from_content_type(content_type)
207
208
 
208
209
  case format
209
210
  when :json
@@ -260,7 +261,8 @@ module RapiTapir
260
261
  validate_response_result(result, output)
261
262
 
262
263
  serialized = output.serialize(result)
263
- content_type = determine_content_type(output)
264
+ # Prefer the explicit content type declared on the output
265
+ content_type = output.respond_to?(:content_type) && output.content_type ? output.content_type : determine_content_type(output)
264
266
 
265
267
  [status_code, { 'Content-Type' => content_type }, [serialized]]
266
268
  end
@@ -274,16 +276,17 @@ module RapiTapir
274
276
  end
275
277
 
276
278
  def build_default_response(result, status_code)
279
+ # For 204 No Content, return an empty body and no content-type header
280
+ return [204, {}, []] if status_code == 204
281
+
277
282
  [status_code, { 'Content-Type' => 'application/json' }, [JSON.generate(result)]]
278
283
  end
279
284
 
280
285
  def determine_content_type(output)
281
- case output.kind
282
- when :text
283
- 'text/plain'
284
- else # Default to JSON for :json and unknown formats
285
- 'application/json'
286
- end
286
+ # Fallback content-type resolution based on output kind
287
+ return 'text/plain' if output.kind == :text
288
+
289
+ 'application/json'
287
290
  end
288
291
 
289
292
  def determine_default_status(method)
@@ -39,8 +39,8 @@ module RapiTapir
39
39
 
40
40
  def default_logger
41
41
  require 'logger'
42
- Logger.new($stdout).tap do |logger|
43
- logger.level = Logger::INFO
42
+ ::Logger.new($stdout).tap do |logger|
43
+ logger.level = ::Logger::INFO
44
44
  logger.formatter = proc do |severity, datetime, _progname, msg|
45
45
  "[#{datetime.strftime('%Y-%m-%d %H:%M:%S')}] #{severity}: #{msg}\n"
46
46
  end
@@ -13,7 +13,7 @@ module RapiTapir
13
13
  # - Protocol Buffer message classes
14
14
  #
15
15
  # All methods support field filtering via only/except parameters.
16
- # rubocop:disable Metrics/ModuleLength
16
+ # rubocop:disable-next Metrics/ModuleLength
17
17
  module AutoDerivation
18
18
  class << self
19
19
  # Derive schema from a plain Hash with sample values
@@ -71,7 +71,7 @@ module RapiTapir
71
71
  # @param only [Array<Symbol>] Only include these fields
72
72
  # @param except [Array<Symbol>] Exclude these fields
73
73
  # @return [RapiTapir::Types::Hash]
74
- # rubocop:disable Style/OpenStructUse
74
+ # rubocop:disable-next Style/OpenStructUse
75
75
  def from_open_struct(open_struct, only: nil, except: nil)
76
76
  raise ArgumentError, "Expected OpenStruct, got #{open_struct.class}" unless open_struct.is_a?(OpenStruct)
77
77
 
@@ -87,7 +87,6 @@ module RapiTapir
87
87
 
88
88
  create_hash_type(schema_hash)
89
89
  end
90
- # rubocop:enable Style/OpenStructUse
91
90
 
92
91
  # Derive schema from Protobuf message class
93
92
  #
@@ -246,6 +245,5 @@ module RapiTapir
246
245
  end
247
246
  end
248
247
  end
249
- # rubocop:enable Metrics/ModuleLength
250
248
  end
251
249
  end
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module RapiTapir
4
- VERSION = '2.0.0'
4
+ VERSION = '2.1.0'
5
5
  end
data/rapitapir.gemspec CHANGED
@@ -17,7 +17,7 @@ Gem::Specification.new do |spec|
17
17
 
18
18
  spec.homepage = 'https://riccardomerolla.github.io/rapitapir/'
19
19
  spec.license = 'MIT'
20
- spec.required_ruby_version = '>= 3.1.0'
20
+ spec.required_ruby_version = '>= 3.3.0'
21
21
 
22
22
  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
23
23
  spec.metadata['homepage_uri'] = spec.homepage
@@ -40,9 +40,10 @@ Gem::Specification.new do |spec|
40
40
  spec.require_paths = ['lib']
41
41
 
42
42
  # Runtime dependencies
43
- spec.add_dependency 'json', '~> 2.0'
43
+ spec.add_dependency 'json', '>= 2.6', '< 4.0'
44
44
  spec.add_dependency 'rack', '>= 2.0', '< 4.0'
45
45
  spec.add_dependency 'webrick', '~> 1.7'
46
+ spec.add_dependency 'jwt', '>= 2.10', '< 4.0'
46
47
 
47
48
  # Optional framework dependencies
48
49
  spec.add_dependency 'sinatra', '>= 2.0', '< 5.0'
metadata CHANGED
@@ -1,29 +1,35 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: rapitapir
3
3
  version: !ruby/object:Gem::Version
4
- version: 2.0.0
4
+ version: 2.1.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Riccardo Merolla
8
8
  autorequire:
9
9
  bindir: exe
10
10
  cert_chain: []
11
- date: 2025-08-07 00:00:00.000000000 Z
11
+ date: 2026-11-22 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: json
15
15
  requirement: !ruby/object:Gem::Requirement
16
16
  requirements:
17
- - - "~>"
17
+ - - ">="
18
18
  - !ruby/object:Gem::Version
19
- version: '2.0'
19
+ version: '2.6'
20
+ - - "<"
21
+ - !ruby/object:Gem::Version
22
+ version: '4.0'
20
23
  type: :runtime
21
24
  prerelease: false
22
25
  version_requirements: !ruby/object:Gem::Requirement
23
26
  requirements:
24
- - - "~>"
27
+ - - ">="
25
28
  - !ruby/object:Gem::Version
26
- version: '2.0'
29
+ version: '2.6'
30
+ - - "<"
31
+ - !ruby/object:Gem::Version
32
+ version: '4.0'
27
33
  - !ruby/object:Gem::Dependency
28
34
  name: rack
29
35
  requirement: !ruby/object:Gem::Requirement
@@ -58,6 +64,26 @@ dependencies:
58
64
  - - "~>"
59
65
  - !ruby/object:Gem::Version
60
66
  version: '1.7'
67
+ - !ruby/object:Gem::Dependency
68
+ name: jwt
69
+ requirement: !ruby/object:Gem::Requirement
70
+ requirements:
71
+ - - ">="
72
+ - !ruby/object:Gem::Version
73
+ version: '2.10'
74
+ - - "<"
75
+ - !ruby/object:Gem::Version
76
+ version: '4.0'
77
+ type: :runtime
78
+ prerelease: false
79
+ version_requirements: !ruby/object:Gem::Requirement
80
+ requirements:
81
+ - - ">="
82
+ - !ruby/object:Gem::Version
83
+ version: '2.10'
84
+ - - "<"
85
+ - !ruby/object:Gem::Version
86
+ version: '4.0'
61
87
  - !ruby/object:Gem::Dependency
62
88
  name: sinatra
63
89
  requirement: !ruby/object:Gem::Requirement
@@ -243,6 +269,15 @@ files:
243
269
  - docs/SINATRA_EXTENSION.md
244
270
  - docs/STRICT_VALIDATION.md
245
271
  - docs/VALIDATION_IMPROVEMENTS.md
272
+ - docs/adr/0001-base-class-strategy.md
273
+ - docs/adr/0002-type-shortcut-and-type-system.md
274
+ - docs/adr/0003-openapi-source-of-truth.md
275
+ - docs/adr/0004-client-generation-typescript-first.md
276
+ - docs/adr/0005-auth-architecture.md
277
+ - docs/adr/0006-observability-defaults.md
278
+ - docs/adr/0007-ai-scope-and-boundaries.md
279
+ - docs/adr/README.md
280
+ - docs/adr/template.md
246
281
  - docs/ai-integration-plan.md
247
282
  - docs/archive/PHASE_1_2_COMPLETE.md
248
283
  - docs/archive/PHASE_1_3_COMPLETE.md
@@ -283,6 +318,32 @@ files:
283
318
  - examples/enterprise_rapitapir_api.rb
284
319
  - examples/getting_started_extension.rb
285
320
  - examples/hello_world.rb
321
+ - examples/nocodb/nocodb_scaffold/Gemfile
322
+ - examples/nocodb/nocodb_scaffold/README.md
323
+ - examples/nocodb/nocodb_scaffold/Rakefile
324
+ - examples/nocodb/nocodb_scaffold/app/api/app.rb
325
+ - examples/nocodb/nocodb_scaffold/app/models/email_template.rb
326
+ - examples/nocodb/nocodb_scaffold/app/models/faq.rb
327
+ - examples/nocodb/nocodb_scaffold/app/models/feature.rb
328
+ - examples/nocodb/nocodb_scaffold/app/models/idea.rb
329
+ - examples/nocodb/nocodb_scaffold/app/models/itinerary_day.rb
330
+ - examples/nocodb/nocodb_scaffold/app/models/route.rb
331
+ - examples/nocodb/nocodb_scaffold/app/models/subscriber.rb
332
+ - examples/nocodb/nocodb_scaffold/app/models/tour.rb
333
+ - examples/nocodb/nocodb_scaffold/app/models/webhook.rb
334
+ - examples/nocodb/nocodb_scaffold/app/models_loader.rb
335
+ - examples/nocodb/nocodb_scaffold/config.ru
336
+ - examples/nocodb/nocodb_scaffold/config/database.yml
337
+ - examples/nocodb/nocodb_scaffold/db/migrate/20250808152012_create_features.rb
338
+ - examples/nocodb/nocodb_scaffold/db/migrate/20250808152013_create_tours.rb
339
+ - examples/nocodb/nocodb_scaffold/db/migrate/20250808152014_create_routes.rb
340
+ - examples/nocodb/nocodb_scaffold/db/migrate/20250808152015_create_itinerary_days.rb
341
+ - examples/nocodb/nocodb_scaffold/db/migrate/20250808152016_create_subscribers.rb
342
+ - examples/nocodb/nocodb_scaffold/db/migrate/20250808152017_create_email_templates.rb
343
+ - examples/nocodb/nocodb_scaffold/db/migrate/20250808152018_create_faqs.rb
344
+ - examples/nocodb/nocodb_scaffold/db/migrate/20250808152019_create_webhooks.rb
345
+ - examples/nocodb/nocodb_scaffold/db/migrate/20250808152020_create_ideas.rb
346
+ - examples/nocodb/swagger.json
286
347
  - examples/oauth2/.env.example
287
348
  - examples/oauth2/README.md
288
349
  - examples/oauth2/generic_oauth2_api.rb
@@ -381,6 +442,7 @@ files:
381
442
  - lib/rapitapir/auth/schemes.rb
382
443
  - lib/rapitapir/cli/command.rb
383
444
  - lib/rapitapir/cli/mcp_export.rb
445
+ - lib/rapitapir/cli/scaffold_generator.rb
384
446
  - lib/rapitapir/cli/server.rb
385
447
  - lib/rapitapir/cli/validator.rb
386
448
  - lib/rapitapir/client/generator_base.rb
@@ -473,14 +535,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
473
535
  requirements:
474
536
  - - ">="
475
537
  - !ruby/object:Gem::Version
476
- version: 3.1.0
538
+ version: 3.3.0
477
539
  required_rubygems_version: !ruby/object:Gem::Requirement
478
540
  requirements:
479
541
  - - ">="
480
542
  - !ruby/object:Gem::Version
481
543
  version: '0'
482
544
  requirements: []
483
- rubygems_version: 3.4.19
545
+ rubygems_version: 3.5.22
484
546
  signing_key:
485
547
  specification_version: 4
486
548
  summary: Type-safe HTTP API development for Ruby