oas_rails 0.2.3 → 0.4.0

data/lib/oas_rails/spec/media_type.rb

@@ -0,0 +1,84 @@
+module OasRails
+  module Spec
+    class MediaType
+      include Specable
+
+      attr_accessor :schema, :example, :examples, :encoding
+
+      @context = :incoming
+      @factory_examples = {}
+
+      # Initializes a new MediaType object.
+      #
+      # @param schema [Hash] the schema of the media type.
+      # @param kwargs [Hash] additional keyword arguments.
+      def initialize(specification)
+        @specification = specification
+        @schema = {}
+        @example =  {}
+        @examples = {}
+      end
+
+      def oas_fields
+        [:schema, :example, :examples, :encoding]
+      end
+
+      class << self
+        # Searches for examples in test files based on the provided class and test framework.
+        #
+        # @param klass [Class] the class to search examples for.
+        # @param utils [Module] a utility module that provides the `detect_test_framework` method. Defaults to `Utils`.
+        # @return [Hash] a hash containing examples data or an empty hash if no examples are found.
+        def search_for_examples_in_tests(klass, context: :incoming, utils: Utils)
+          @context = context
+          case utils.detect_test_framework
+          when :factory_bot
+            fetch_factory_bot_examples(klass:)
+          when :fixtures
+            fetch_fixture_examples(klass:)
+          else
+            {}
+          end
+        end
+
+        private
+
+        # Fetches examples from FactoryBot for the provided class.
+        #
+        # @param klass [Class] the class to fetch examples for.
+        # @return [Hash] a hash containing examples data or an empty hash if no examples are found.
+        def fetch_factory_bot_examples(klass:)
+          klass_sym = Utils.class_to_symbol(klass)
+
+          begin
+            @factory_examples[klass_sym] = FactoryBot.build_stubbed_list(klass_sym, 1) if @factory_examples[klass_sym].nil?
+
+            @factory_examples[klass_sym].each_with_index.to_h do |obj, index|
+              ["#{klass_sym}#{index + 1}", { value: { klass_sym => clean_example_object(obj: obj.as_json) } }]
+            end
+          rescue KeyError
+            {}
+          end
+        end
+
+        # Fetches examples from fixtures for the provided class.
+        #
+        # @param klass [Class] the class to fetch examples for.
+        # @return [Hash] a hash containing examples data or an empty hash if no examples are found.
+        def fetch_fixture_examples(klass:)
+          fixture_file = Rails.root.join('test', 'fixtures', "#{klass.to_s.pluralize.downcase}.yml")
+          begin
+            fixture_data = YAML.load_file(fixture_file).with_indifferent_access
+          rescue Errno::ENOENT
+            return {}
+          end
+          fixture_data.transform_values { |attributes| { value: { klass.to_s.downcase => clean_example_object(obj: attributes) } } }
+        end
+
+        def clean_example_object(obj:)
+          obj.reject { |key, _| OasRails.config.send("excluded_columns_#{@context}").include?(key.to_sym) }
+        end
+      end
+    end
+  end
+end

data/lib/oas_rails/spec/operation.rb

@@ -0,0 +1,25 @@
+module OasRails
+  module Spec
+    class Operation
+      include Specable
+
+      attr_accessor :specification, :tags, :summary, :description, :operation_id, :parameters, :request_body, :responses, :security
+
+      def initialize(specification)
+        @specification = specification
+        @summary = ""
+        @operation_id = ""
+        @tags = []
+        @description = @summary
+        @parameters = []
+        @request_body = {}
+        @responses =  Spec::Responses.new(specification)
+        @security = []
+      end
+
+      def oas_fields
+        [:tags, :summary, :description, :operation_id, :parameters, :request_body, :responses, :security]
+      end
+    end
+  end
+end

data/lib/oas_rails/spec/parameter.rb

@@ -0,0 +1,34 @@
+module OasRails
+  module Spec
+    class Parameter
+      include Specable
+      include Hashable
+
+      STYLE_DEFAULTS = { query: 'form', path: 'simple', header: 'simple', cookie: 'form' }.freeze
+
+      attr_accessor :name, :in, :style, :description, :required, :schema
+
+      def initialize(specification)
+        @specification = specification
+        @name = ""
+        @in = ""
+        @description = ""
+        @required = false
+        @style = ""
+        @schema = { type: 'string' }
+      end
+
+      def default_from_in
+        STYLE_DEFAULTS[@in.to_sym]
+      end
+
+      def required?
+        @in == 'path'
+      end
+
+      def oas_fields
+        [:name, :in, :description, :required, :schema, :style]
+      end
+    end
+  end
+end

data/lib/oas_rails/spec/path_item.rb

@@ -0,0 +1,33 @@
+module OasRails
+  module Spec
+    class PathItem
+      include Specable
+      attr_reader :get, :post, :put, :patch, :delete
+
+      def initialize(specification)
+        @specification = specification
+        @get = nil
+        @post = nil
+        @put = nil
+        @patch = nil
+        @delete = nil
+      end
+
+      def fill_from(path, route_extractor: Extractors::RouteExtractor)
+        route_extractor.host_routes_by_path(path).each do |oas_route|
+          add_operation(oas_route.verb.downcase, Spec::Operation.new(@specification).fill_from(oas_route))
+        end
+
+        self
+      end
+
+      def add_operation(http_method, operation)
+        instance_variable_set("@#{http_method}", operation)
+      end
+
+      def oas_fields
+        [:get, :post, :put, :patch, :delete]
+      end
+    end
+  end
+end

data/lib/oas_rails/spec/paths.rb

@@ -0,0 +1,26 @@
+module OasRails
+  module Spec
+    class Paths
+      include Specable
+
+      attr_accessor :path_items
+
+      def initialize(specification)
+        @specification = specification
+        @path_items = {}
+      end
+
+      def add_path(path)
+        @path_items[path] = Builders::PathItemBuilder.new(@specification).from_path(path).build
+      end
+
+      def to_spec
+        paths_hash = {}
+        @path_items.each do |path, path_object|
+          paths_hash[path] = path_object.to_spec
+        end
+        paths_hash
+      end
+    end
+  end
+end

data/lib/oas_rails/spec/reference.rb

@@ -0,0 +1,16 @@
+module OasRails
+  module Spec
+    class Reference
+      include Specable
+      attr_reader :ref
+
+      def initialize(ref)
+        @ref = ref
+      end
+
+      def to_spec
+        { '$ref' => @ref }
+      end
+    end
+  end
+end

data/lib/oas_rails/spec/request_body.rb

@@ -0,0 +1,21 @@
+module OasRails
+  module Spec
+    class RequestBody
+      include Specable
+      include Hashable
+
+      attr_accessor :description, :content, :required
+
+      def initialize(specification)
+        @specification = specification
+        @description = ""
+        @content = {} # a hash with media type objects
+        @required = false
+      end
+
+      def oas_fields
+        [:description, :content, :required]
+      end
+    end
+  end
+end

data/lib/oas_rails/spec/response.rb

@@ -0,0 +1,20 @@
+module OasRails
+  module Spec
+    class Response
+      include Specable
+      include Hashable
+
+      attr_accessor :code, :description, :content
+
+      def initialize(specification)
+        @specification = specification
+        @description = ""
+        @content = {} # Hash with {content: MediaType}
+      end
+
+      def oas_fields
+        [:description, :content]
+      end
+    end
+  end
+end

data/lib/oas_rails/spec/responses.rb

@@ -0,0 +1,25 @@
+module OasRails
+  module Spec
+    class Responses
+      include Specable
+      attr_accessor :responses
+
+      def initialize(specification)
+        @specification = specification
+        @responses = {}
+      end
+
+      def add_response(response)
+        @responses[response.code] = @specification.components.add_response(response)
+      end
+
+      def to_spec
+        spec = {}
+        @responses.each do |key, value|
+          spec[key] = value.to_spec
+        end
+        spec
+      end
+    end
+  end
+end

data/lib/oas_rails/spec/server.rb

@@ -0,0 +1,17 @@
+module OasRails
+  module Spec
+    class Server
+      include Specable
+      attr_accessor :url, :description
+
+      def initialize(url:, description:)
+        @url = url
+        @description = description
+      end
+
+      def oas_fields
+        [:url, :description]
+      end
+    end
+  end
+end

data/lib/oas_rails/spec/specable.rb

@@ -0,0 +1,51 @@
+module OasRails
+  module Spec
+    module Specable
+      def oas_fields
+        []
+      end
+
+      def to_spec
+        hash = {}
+        oas_fields.each do |var|
+          key = var.to_s
+
+          camel_case_key = key.camelize(:lower).to_sym
+          value = send(var)
+
+          processed_value = if value.respond_to?(:to_spec)
+                              value.to_spec
+                            elsif value.is_a?(Array) && value.all? { |elem| elem.respond_to?(:to_spec) }
+                              value.map(&:to_spec)
+                            # elsif value.is_a?(Hash)
+                            #   p "Here"
+                            #   p value
+                            #   hash = {}
+                            #   value.each do |key, object|
+                            #     hash[key] = object.to_spec
+                            #   end
+                            #   hash
+                            else
+                              value
+                            end
+
+          # hash[camel_case_key] = processed_value unless (processed_value.is_a?(Hash) || processed_value.is_a?(Array)) && processed_value.empty?
+          hash[camel_case_key] = processed_value unless processed_value.nil?
+        end
+        hash
+      end
+
+      def as_json
+        to_spec
+      end
+
+      private
+
+      def snake_to_camel(snake_str)
+        words = snake_str.to_s.split('_')
+        words[1..].map!(&:capitalize)
+        (words[0] + words[1..].join).to_sym
+      end
+    end
+  end
+end

data/lib/oas_rails/spec/specification.rb

@@ -0,0 +1,50 @@
+require 'json'
+
+module OasRails
+  module Spec
+    class Specification
+      include Specable
+      attr_accessor :components, :info, :openapi, :servers, :tags, :external_docs, :paths
+
+      # Initializes a new Specification object.
+      # Clears the cache if running in the development environment.
+      def initialize
+        clear_cache unless Rails.env.production?
+
+        @components = Components.new(self)
+        @info = OasRails.config.info
+        @openapi = '3.1.0'
+        @servers = OasRails.config.servers
+        @tags = OasRails.config.tags
+        @external_docs = {}
+        @paths = Spec::Paths.new(self)
+      end
+
+      def build(route_extractor: Extractors::RouteExtractor)
+        route_extractor.host_paths.each do |path|
+          @paths.add_path(path)
+        end
+      end
+
+      # Clears the cache for MethodSource and RouteExtractor.
+      #
+      # @return [void]
+      def clear_cache
+        MethodSource.clear_cache
+        Extractors::RouteExtractor.clear_cache
+      end
+
+      def oas_fields
+        [:openapi, :info, :servers, :paths, :components, :security, :tags, :external_docs]
+      end
+
+      # Create the Security Requirement Object.
+      # @see https://spec.openapis.org/oas/latest.html#security-requirement-object
+      def security
+        return [] unless OasRails.config.authenticate_all_routes_by_default
+
+        OasRails.config.security_schemas.map { |key, _| { key => [] } }
+      end
+    end
+  end
+end

data/lib/oas_rails/spec/tag.rb

@@ -0,0 +1,18 @@
+module OasRails
+  module Spec
+    class Tag
+      include Specable
+
+      attr_accessor :name, :description
+
+      def initialize(name:, description:)
+        @name = name.titleize
+        @description = description
+      end
+
+      def oas_fields
+        [:name, :description]
+      end
+    end
+  end
+end

data/lib/oas_rails/utils.rb

@@ -13,6 +13,14 @@ module OasRails
       'DateTime' => 'string'
     }.freeze
 
+    HTTP_STATUS_DEFINITIONS = {
+      404 => "The requested resource could not be found.",
+      401 => "You are not authorized to access this resource. You need to authenticate yourself first.",
+      403 => "You are not allowed to access this resource. You do not have the necessary permissions.",
+      500 => "An unexpected error occurred on the server. The server was unable to process the request.",
+      422 => "The server could not process the request due to semantic errors. Please check your input and try again."
+    }.freeze
+
     class << self
       # Method for detect test framework of the Rails App
       # It is used for generate examples in operations
@@ -61,6 +69,37 @@ module OasRails
       def ruby_type_to_json_type(ruby_type)
         TYPE_MAPPING.fetch(ruby_type, 'string')
       end
+
+      # Converts a status symbol or string to an integer.
+      #
+      # @param status [String, Symbol, nil] The status to convert.
+      # @return [Integer] The status code as an integer.
+      def status_to_integer(status)
+        return 200 if status.nil?
+
+        if status.to_s =~ /^\d+$/
+          status.to_i
+        else
+          status = "unprocessable_content" if status == "unprocessable_entity"
+          Rack::Utils::SYMBOL_TO_STATUS_CODE[status.to_sym]
+        end
+      end
+
+      # Converts a status code to its corresponding text description.
+      #
+      # @param status_code [Integer] The status code.
+      # @return [String] The text description of the status code.
+      def status_code_to_text(status_code)
+        Rack::Utils::HTTP_STATUS_CODES[status_code] || "Unknown Status Code"
+      end
+
+      def get_definition(status_code)
+        HTTP_STATUS_DEFINITIONS[status_code] || "Definition not found for status code #{status_code}"
+      end
+
+      def class_to_symbol(klass)
+        klass.name.underscore.to_sym
+      end
     end
   end
 end

data/lib/oas_rails/version.rb

@@ -1,3 +1,3 @@
 module OasRails
-  VERSION = "0.2.3"
+  VERSION = "0.4.0"
 end

data/lib/oas_rails.rb

@@ -6,35 +6,64 @@ module OasRails
   require "oas_rails/version"
   require "oas_rails/engine"
 
-  autoload :OasBase, "oas_rails/oas_base"
   autoload :Configuration, "oas_rails/configuration"
-  autoload :Specification, "oas_rails/specification"
-  autoload :RouteExtractor, "oas_rails/route_extractor"
   autoload :OasRoute, "oas_rails/oas_route"
-  autoload :Operation, "oas_rails/operation"
-  autoload :Info, "oas_rails/info"
-  autoload :Contact, "oas_rails/contact"
-  autoload :Paths, "oas_rails/paths"
-  autoload :PathItem, "oas_rails/path_item"
-  autoload :Parameter, "oas_rails/parameter"
-  autoload :Tag, "oas_rails/tag"
-  autoload :License, "oas_rails/license"
-  autoload :Server, "oas_rails/server"
-  autoload :RequestBody, "oas_rails/request_body"
-  autoload :MediaType, "oas_rails/media_type"
-  autoload :Response, "oas_rails/response"
-  autoload :Responses, "oas_rails/responses"
-
   autoload :Utils, "oas_rails/utils"
+  autoload :EsquemaBuilder, "oas_rails/esquema_builder"
+
+  module Builders
+    autoload :OperationBuilder, "oas_rails/builders/operation_builder"
+    autoload :PathItemBuilder, "oas_rails/builders/path_item_builder"
+    autoload :ResponseBuilder, "oas_rails/builders/response_builder"
+    autoload :ResponsesBuilder, "oas_rails/builders/responses_builder"
+    autoload :ContentBuilder, "oas_rails/builders/content_builder"
+    autoload :ParametersBuilder, "oas_rails/builders/parameters_builder"
+    autoload :ParameterBuilder, "oas_rails/builders/parameter_builder"
+    autoload :RequestBodyBuilder, "oas_rails/builders/request_body_builder"
+  end
+
+  # This module contains all the clases that represent a part of the OAS file.
+  module Spec
+    autoload :Hashable, "oas_rails/spec/hashable"
+    autoload :Specable, "oas_rails/spec/specable"
+    autoload :Components, "oas_rails/spec/components"
+    autoload :Parameter, "oas_rails/spec/parameter"
+    autoload :License, "oas_rails/spec/license"
+    autoload :Response, "oas_rails/spec/response"
+    autoload :PathItem, "oas_rails/spec/path_item"
+    autoload :Operation, "oas_rails/spec/operation"
+    autoload :RequestBody, "oas_rails/spec/request_body"
+    autoload :Responses, "oas_rails/spec/responses"
+    autoload :MediaType, "oas_rails/spec/media_type"
+    autoload :Paths, "oas_rails/spec/paths"
+    autoload :Contact, "oas_rails/spec/contact"
+    autoload :Info, "oas_rails/spec/info"
+    autoload :Server, "oas_rails/spec/server"
+    autoload :Tag, "oas_rails/spec/tag"
+    autoload :Specification, "oas_rails/spec/specification"
+    autoload :Reference, "oas_rails/spec/reference"
+  end
 
   module YARD
     autoload :OasYARDFactory, 'oas_rails/yard/oas_yard_factory'
   end
 
+  module Extractors
+    autoload :RenderResponseExtractor, 'oas_rails/extractors/render_response_extractor'
+    autoload :RouteExtractor, "oas_rails/extractors/route_extractor"
+    autoload :OasRouteExtractor, "oas_rails/extractors/oas_route_extractor"
+  end
+
   class << self
+    def build
+      oas = Spec::Specification.new
+      oas.build
+
+      oas.to_spec
+    end
+
     # Configurations for make the OasRails engine Work.
     def configure
-      OasRails.configure_esquema!
       OasRails.configure_yard!
       yield config
     end
@@ -59,13 +88,5 @@ module OasRails
         ::YARD::Tags::Library.define_tag(tag_name, method_name, handler)
       end
     end
-
-    def configure_esquema!
-      Esquema.configure do |config|
-        config.exclude_associations = true
-        config.exclude_foreign_keys = true
-        config.excluded_columns = %i[id created_at updated_at deleted_at]
-      end
-    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: oas_rails
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.4.0
 platform: ruby
 authors:
 - a-chacon
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-08-01 00:00:00.000000000 Z
+date: 2024-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: esquema
@@ -100,25 +100,39 @@ files:
 - lib/generators/oas_rails/config/config_generator.rb
 - lib/generators/oas_rails/config/templates/oas_rails_initializer.rb
 - lib/oas_rails.rb
+- lib/oas_rails/builders/content_builder.rb
+- lib/oas_rails/builders/operation_builder.rb
+- lib/oas_rails/builders/parameter_builder.rb
+- lib/oas_rails/builders/parameters_builder.rb
+- lib/oas_rails/builders/path_item_builder.rb
+- lib/oas_rails/builders/request_body_builder.rb
+- lib/oas_rails/builders/response_builder.rb
+- lib/oas_rails/builders/responses_builder.rb
 - lib/oas_rails/configuration.rb
-- lib/oas_rails/contact.rb
 - lib/oas_rails/engine.rb
-- lib/oas_rails/info.rb
-- lib/oas_rails/license.rb
-- lib/oas_rails/media_type.rb
-- lib/oas_rails/oas_base.rb
+- lib/oas_rails/esquema_builder.rb
+- lib/oas_rails/extractors/oas_route_extractor.rb
+- lib/oas_rails/extractors/render_response_extractor.rb
+- lib/oas_rails/extractors/route_extractor.rb
 - lib/oas_rails/oas_route.rb
-- lib/oas_rails/operation.rb
-- lib/oas_rails/parameter.rb
-- lib/oas_rails/path_item.rb
-- lib/oas_rails/paths.rb
-- lib/oas_rails/request_body.rb
-- lib/oas_rails/response.rb
-- lib/oas_rails/responses.rb
-- lib/oas_rails/route_extractor.rb
-- lib/oas_rails/server.rb
-- lib/oas_rails/specification.rb
-- lib/oas_rails/tag.rb
+- lib/oas_rails/spec/components.rb
+- lib/oas_rails/spec/contact.rb
+- lib/oas_rails/spec/hashable.rb
+- lib/oas_rails/spec/info.rb
+- lib/oas_rails/spec/license.rb
+- lib/oas_rails/spec/media_type.rb
+- lib/oas_rails/spec/operation.rb
+- lib/oas_rails/spec/parameter.rb
+- lib/oas_rails/spec/path_item.rb
+- lib/oas_rails/spec/paths.rb
+- lib/oas_rails/spec/reference.rb
+- lib/oas_rails/spec/request_body.rb
+- lib/oas_rails/spec/response.rb
+- lib/oas_rails/spec/responses.rb
+- lib/oas_rails/spec/server.rb
+- lib/oas_rails/spec/specable.rb
+- lib/oas_rails/spec/specification.rb
+- lib/oas_rails/spec/tag.rb
 - lib/oas_rails/utils.rb
 - lib/oas_rails/version.rb
 - lib/oas_rails/yard/oas_yard_factory.rb

data/lib/oas_rails/contact.rb

@@ -1,12 +0,0 @@
-module OasRails
-  class Contact < OasBase
-    attr_accessor :name, :url, :email
-
-    def initialize(**kwargs)
-      super()
-      @name = kwargs[:name] || ''
-      @url = kwargs[:url] || ''
-      @email = kwargs[:email] || ''
-    end
-  end
-end