oas_core 0.0.1

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 (46) hide show
  1. checksums.yaml +7 -0
  2. data/LICENSE +674 -0
  3. data/README.md +70 -0
  4. data/Rakefile +12 -0
  5. data/lib/oas_core/builders/content_builder.rb +44 -0
  6. data/lib/oas_core/builders/operation_builder.rb +94 -0
  7. data/lib/oas_core/builders/parameter_builder.rb +31 -0
  8. data/lib/oas_core/builders/parameters_builder.rb +46 -0
  9. data/lib/oas_core/builders/path_item_builder.rb +26 -0
  10. data/lib/oas_core/builders/request_body_builder.rb +45 -0
  11. data/lib/oas_core/builders/response_builder.rb +42 -0
  12. data/lib/oas_core/builders/responses_builder.rb +92 -0
  13. data/lib/oas_core/builders/specification_builder.rb +24 -0
  14. data/lib/oas_core/configuration.rb +143 -0
  15. data/lib/oas_core/json_schema_generator.rb +134 -0
  16. data/lib/oas_core/oas_route.rb +24 -0
  17. data/lib/oas_core/spec/components.rb +99 -0
  18. data/lib/oas_core/spec/contact.rb +20 -0
  19. data/lib/oas_core/spec/hashable.rb +41 -0
  20. data/lib/oas_core/spec/info.rb +68 -0
  21. data/lib/oas_core/spec/license.rb +20 -0
  22. data/lib/oas_core/spec/media_type.rb +26 -0
  23. data/lib/oas_core/spec/operation.rb +28 -0
  24. data/lib/oas_core/spec/parameter.rb +39 -0
  25. data/lib/oas_core/spec/path_item.rb +27 -0
  26. data/lib/oas_core/spec/paths.rb +28 -0
  27. data/lib/oas_core/spec/reference.rb +18 -0
  28. data/lib/oas_core/spec/request_body.rb +23 -0
  29. data/lib/oas_core/spec/response.rb +22 -0
  30. data/lib/oas_core/spec/responses.rb +27 -0
  31. data/lib/oas_core/spec/server.rb +19 -0
  32. data/lib/oas_core/spec/specable.rb +56 -0
  33. data/lib/oas_core/spec/specification.rb +34 -0
  34. data/lib/oas_core/spec/tag.rb +20 -0
  35. data/lib/oas_core/string.rb +13 -0
  36. data/lib/oas_core/utils.rb +94 -0
  37. data/lib/oas_core/version.rb +5 -0
  38. data/lib/oas_core/yard/example_tag.rb +14 -0
  39. data/lib/oas_core/yard/oas_core_factory.rb +166 -0
  40. data/lib/oas_core/yard/parameter_tag.rb +16 -0
  41. data/lib/oas_core/yard/request_body_example_tag.rb +13 -0
  42. data/lib/oas_core/yard/request_body_tag.rb +17 -0
  43. data/lib/oas_core/yard/response_example_tag.rb +14 -0
  44. data/lib/oas_core/yard/response_tag.rb +15 -0
  45. data/lib/oas_core.rb +88 -0
  46. metadata +120 -0
metadata ADDED
@@ -0,0 +1,120 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: oas_core
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.0.1
5
+ platform: ruby
6
+ authors:
7
+ - a-chacon
8
+ bindir: bin
9
+ cert_chain: []
10
+ date: 1980-01-02 00:00:00.000000000 Z
11
+ dependencies:
12
+ - !ruby/object:Gem::Dependency
13
+ name: method_source
14
+ requirement: !ruby/object:Gem::Requirement
15
+ requirements:
16
+ - - "~>"
17
+ - !ruby/object:Gem::Version
18
+ version: '1.0'
19
+ type: :runtime
20
+ prerelease: false
21
+ version_requirements: !ruby/object:Gem::Requirement
22
+ requirements:
23
+ - - "~>"
24
+ - !ruby/object:Gem::Version
25
+ version: '1.0'
26
+ - !ruby/object:Gem::Dependency
27
+ name: yard
28
+ requirement: !ruby/object:Gem::Requirement
29
+ requirements:
30
+ - - "~>"
31
+ - !ruby/object:Gem::Version
32
+ version: '0.9'
33
+ type: :runtime
34
+ prerelease: false
35
+ version_requirements: !ruby/object:Gem::Requirement
36
+ requirements:
37
+ - - "~>"
38
+ - !ruby/object:Gem::Version
39
+ version: '0.9'
40
+ description: OasCore simplifies API documentation by automatically generating OpenAPI
41
+ Specification (OAS 3.1) documents from your Rails application routes. It eliminates
42
+ the need for manual documentation, ensuring accuracy and consistency. The gem integrates
43
+ seamlessly with Rails, providing a hassle-free way to create interactive API documentation.
44
+ Ideal for developers and teams aiming to maintain up-to-date API specs with minimal
45
+ effort.
46
+ email:
47
+ - andres.ch@protonmail.com
48
+ executables: []
49
+ extensions: []
50
+ extra_rdoc_files: []
51
+ files:
52
+ - LICENSE
53
+ - README.md
54
+ - Rakefile
55
+ - lib/oas_core.rb
56
+ - lib/oas_core/builders/content_builder.rb
57
+ - lib/oas_core/builders/operation_builder.rb
58
+ - lib/oas_core/builders/parameter_builder.rb
59
+ - lib/oas_core/builders/parameters_builder.rb
60
+ - lib/oas_core/builders/path_item_builder.rb
61
+ - lib/oas_core/builders/request_body_builder.rb
62
+ - lib/oas_core/builders/response_builder.rb
63
+ - lib/oas_core/builders/responses_builder.rb
64
+ - lib/oas_core/builders/specification_builder.rb
65
+ - lib/oas_core/configuration.rb
66
+ - lib/oas_core/json_schema_generator.rb
67
+ - lib/oas_core/oas_route.rb
68
+ - lib/oas_core/spec/components.rb
69
+ - lib/oas_core/spec/contact.rb
70
+ - lib/oas_core/spec/hashable.rb
71
+ - lib/oas_core/spec/info.rb
72
+ - lib/oas_core/spec/license.rb
73
+ - lib/oas_core/spec/media_type.rb
74
+ - lib/oas_core/spec/operation.rb
75
+ - lib/oas_core/spec/parameter.rb
76
+ - lib/oas_core/spec/path_item.rb
77
+ - lib/oas_core/spec/paths.rb
78
+ - lib/oas_core/spec/reference.rb
79
+ - lib/oas_core/spec/request_body.rb
80
+ - lib/oas_core/spec/response.rb
81
+ - lib/oas_core/spec/responses.rb
82
+ - lib/oas_core/spec/server.rb
83
+ - lib/oas_core/spec/specable.rb
84
+ - lib/oas_core/spec/specification.rb
85
+ - lib/oas_core/spec/tag.rb
86
+ - lib/oas_core/string.rb
87
+ - lib/oas_core/utils.rb
88
+ - lib/oas_core/version.rb
89
+ - lib/oas_core/yard/example_tag.rb
90
+ - lib/oas_core/yard/oas_core_factory.rb
91
+ - lib/oas_core/yard/parameter_tag.rb
92
+ - lib/oas_core/yard/request_body_example_tag.rb
93
+ - lib/oas_core/yard/request_body_tag.rb
94
+ - lib/oas_core/yard/response_example_tag.rb
95
+ - lib/oas_core/yard/response_tag.rb
96
+ homepage: https://github.com/a-chacon/oas_core
97
+ licenses:
98
+ - GPL-3.0-only
99
+ metadata:
100
+ homepage_uri: https://github.com/a-chacon/oas_core
101
+ rubygems_mfa_required: 'true'
102
+ rdoc_options: []
103
+ require_paths:
104
+ - lib
105
+ required_ruby_version: !ruby/object:Gem::Requirement
106
+ requirements:
107
+ - - ">="
108
+ - !ruby/object:Gem::Version
109
+ version: '3.1'
110
+ required_rubygems_version: !ruby/object:Gem::Requirement
111
+ requirements:
112
+ - - ">="
113
+ - !ruby/object:Gem::Version
114
+ version: '0'
115
+ requirements: []
116
+ rubygems_version: 3.6.7
117
+ specification_version: 4
118
+ summary: Generates OpenAPI Specification (OAS) documents by analyzing and extracting
119
+ routes from Rails applications.
120
+ test_files: []