oas_core 0.0.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3f0fe9c1e805e658bef1a7f547438bbde3433d48a29166c2cdd9c8072788ce09
-  data.tar.gz: 3d0b42e3da71913efc5ef6cd4a4ec959741dfbe511494a41376205600626e583
+  metadata.gz: '092cef0cfe920698acf4b55412febd5e0ac30f31ed14e0b77169847c6bcfe1bd'
+  data.tar.gz: 6c2bfbbe7d7b513c7f1f2223a1064c716fd74780515e45d10e11e662ae6bc07d
 SHA512:
-  metadata.gz: f6d05861cc537f02d7839189cdbef925e3b6211d07379165ad0a681dd98a4c91e838e93d66eec28281935c6f87c1cec8b0af19af3112c2443855e2c5de7b7acf
-  data.tar.gz: 1771cc1d85c3dcaf6b45af50f9c12dd5c8bcb7bd0b8d682f259cd6ba4fd442b85ba069628501902e22d16b48cdf54a4057b239fda8047adbc12163d91b464017
+  metadata.gz: 568ea83f14c6e19523e2eb8aa70d3b8533f18200824c2e18cbe7e0c858c50f8a987110ece244f107c907d68f2324ae2d4473ae1bd6641122cdc3044c60130b05
+  data.tar.gz: dc35e960540a2a532bb4374662c8b977ead04128425abced1ec22cce64090470fbc5adf8ae41d2d0dd95bbd34bb20ed603c8661faf51e06572fec30a32faaf01

data/README.md

@@ -7,43 +7,7 @@
 
 # 📃Open API Specification For Rails
 
-OasCore is a Rails engine for generating **automatic interactive documentation for your Rails APIs**. It generates an **OAS 3.1** document and displays it using **[RapiDoc](https://rapidocweb.com)**.
-
-### 🚀 Demo App
-
-Explore the interactive documentation live:
-
-🔗 **[Open Demo App](https://paso.fly.dev/api/docs)**  
-👤 **Username**: `oasrails`  
-🔑 **Password**: `oasrails`
-
-🎬 A Demo Installation/Usage Video:
-<https://vimeo.com/1013687332>
-🎬
-
-![Screenshot](https://a-chacon.com/assets/images/oas_core_ui.png)
-
-## Related Projects
-
-- **[ApiPie](https://github.com/Apipie/apipie-rails)**: Doesn't support OAS 3.1, requires learning a DSL, lacks a nice UI
-- **[swagger_yard-rails](https://github.com/livingsocial/swagger_yard-rails)**: Seems abandoned, but serves as inspiration
-- **[Rswag](https://github.com/rswag/rswag)**: Not automatic, depends on RSpec; Many developers now use Minitest as it's the default test framework
-- **[grape-swagger](https://github.com/ruby-grape/grape-swagger)**: Requires Grape
-- **[rspec_api_documentation](https://github.com/zipmark/rspec_api_documentation)**: Requires RSpec and a command to generate the docs
-
-## What Sets OasCore Apart?
-
-- **Dynamic**: No command required to generate docs
-- **Simple**: Complement default documentation with a few comments; no need to learn a complex DSL
-- **Pure Ruby on Rails APIs**: No additional frameworks needed (e.g., Grape, RSpec)
-
-## 📽️ Motivation
-
-After experiencing the interactive documentation in Python's fast-api framework, I sought similar functionality in Ruby on Rails. Unable to find a suitable solution, I [asked on Stack Overflow](https://stackoverflow.com/questions/71947018/is-there-a-way-to-generate-an-interactive-documentation-for-rails-apis) years ago. Now, with some free time while freelancing as an API developer, I decided to build my own tool.
-
-**Note: This is not yet a production-ready solution. The code may be rough and behave unexpectedly, but I am actively working on improving it. If you like the idea, please consider contributing to its development.**
-
-The goal is to minimize the effort required to create comprehensive documentation. By following REST principles in Rails, we believe this is achievable. You can enhance the documentation using [Yard](https://yardoc.org/) tags.
+Generates OpenAPI Specification (OAS) documents by analyzing and extracting routes from Rails applications.
 
 ## Documentation
 

data/lib/oas_core/builders/request_body_builder.rb

@@ -10,9 +10,6 @@ module OasCore
 
       def from_oas_route(oas_route)
         tag_request_body = oas_route.tags(:request_body).first
-        # TODO: This is for frameowkr specific.
-        # if tag_request_body.nil? && OasCore.config.autodiscover_request_body
-        #   detect_request_body(oas_route) if %w[create update].include? oas_route.method_name
         return self if tag_request_body.nil?
 
         from_tags(tag: tag_request_body, examples_tags: oas_route.tags(:request_body_example))

data/lib/oas_core/builders/responses_builder.rb

@@ -27,18 +27,6 @@ module OasCore
         self
       end
 
-      # def add_autodiscovered_responses(oas_route)
-      #   return self if !OasCore.config.autodiscover_responses || oas_route.tags(:response).any?
-      #
-      #   new_responses = Extractors::RenderResponseExtractor.extract_responses_from_source(@specification, source: oas_route.source_string)
-      #
-      #   new_responses.each do |new_response|
-      #     @responses.add_response(new_response) if @responses.responses[new_response.code].blank?
-      #   end
-      #
-      #   self
-      # end
-
       def add_default_responses(oas_route, security)
         return self unless OasCore.config.set_default_responses
 

data/lib/oas_core/configuration.rb

@@ -3,33 +3,24 @@
 module OasCore
   class Configuration
     attr_accessor :info,
-                  :layout,
                   :default_tags_from,
-                  :autodiscover_request_body,
-                  :autodiscover_responses,
                   :api_path,
-                  :ignored_actions,
                   :security_schemas,
                   :authenticate_all_routes_by_default,
                   :set_default_responses,
                   :possible_default_responses,
                   :http_verbs,
-                  :use_model_names,
-                  :rapidoc_theme
+                  :use_model_names
 
-    attr_reader :servers, :tags, :security_schema, :include_mode, :response_body_of_default
+    attr_reader :servers, :tags, :security_schema, :response_body_of_default
 
     def initialize
       @info = Spec::Info.new
-      @layout = false
       @servers = default_servers
       @tags = []
       @swagger_version = '3.1.0'
       @default_tags_from = :namespace
-      @autodiscover_request_body = true
-      @autodiscover_responses = true
       @api_path = '/'
-      @ignored_actions = []
       @authenticate_all_routes_by_default = true
       @security_schema = nil
       @security_schemas = {}
@@ -38,9 +29,8 @@ module OasCore
                                        unprocessable_entity]
       @http_verbs = %i[get post put patch delete]
       @response_body_of_default = 'Hash{ status: !Integer, error: String }'
+      # TODO: What does this config??
       @use_model_names = false
-      @rapidoc_theme = :rails
-      @include_mode = :all
 
       @possible_default_responses.each do |response|
         method_name = "response_body_of_#{response}="
@@ -85,13 +75,6 @@ module OasCore
       []
     end
 
-    def include_mode=(value)
-      valid_modes = %i[all with_tags explicit]
-      raise ArgumentError, "include_mode must be one of #{valid_modes}" unless valid_modes.include?(value)
-
-      @include_mode = value
-    end
-
     def response_body_of_default=(value)
       raise ArgumentError, 'response_body_of_default must be a String With a valid object' unless value.is_a?(String)
 

data/lib/oas_core/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module OasCore
-  VERSION = '0.0.1'
+  VERSION = '0.2.0'
 end

data/lib/oas_core.rb

@@ -57,9 +57,10 @@ module OasCore
   end
 
   class << self
-    def configure
-      OasCore.configure_yard!
-      yield config
+    def config=(config)
+      raise 'Configuration must be an OasCore::Configuration or its subclass' unless config.is_a?(OasCore::Configuration)
+
+      @config = config
     end
 
     def config

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: oas_core
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.2.0
 platform: ruby
 authors:
 - a-chacon
@@ -38,11 +38,8 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.9'
 description: OasCore simplifies API documentation by automatically generating OpenAPI
-  Specification (OAS 3.1) documents from your Rails application routes. It eliminates
-  the need for manual documentation, ensuring accuracy and consistency. The gem integrates
-  seamlessly with Rails, providing a hassle-free way to create interactive API documentation.
-  Ideal for developers and teams aiming to maintain up-to-date API specs with minimal
-  effort.
+  Specification (OAS 3.1) documents from your Ruby application routes. It eliminates
+  the need for manual documentation, ensuring accuracy and consistency.
 email:
 - andres.ch@protonmail.com
 executables: []