oas_core 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9f1ed49861556546b0712b0bf9db58ba28ac53f70e5de3d2276ef45d706b0e34
-  data.tar.gz: dd3a8d125eb474036e48dc78722cf82ec3341760f903edf2ab4908eb011d6025
+  metadata.gz: f30441b4a84ba035b6731c1051d0a4572e9e60a45d806ec55b80ccc1e288735e
+  data.tar.gz: 41e0abe3e0533a72b5713e0d243ac35d3cd8a0a1f0427f7157aceda38c19f1f7
 SHA512:
-  metadata.gz: ee76879d24af4ffe84279586567edbffd20328aa3d742fc36be9f25a79e218fd0496c87b497a939a534f555dd1c0b285ad7e21e8f8058cd49a8df6f20763dd1f
-  data.tar.gz: ee8f32f1ab91af11aa5ccc56f60d63e32fa50d4e55a3211a7955ef3183df028533bc520038f23c889322742eb79d0de1db6ba7e5f3486d4802abd84a3a0d969b
+  metadata.gz: 8058d16bde405b7be785105bc065fe75e832639effb814109518351238adf1998cc28647017046cf9a41c6f01c95ec0f6e84f629e3e35035db6862559e202cff
+  data.tar.gz: 0740a659814ed9d2f6e2b0070e784924e0945c25316fad1ad9dea7f286dcebeb965e63ea20b5cbde5d94c3e49f8ced0c9f60662dd169ada03df562dabd335bc4

data/lib/oas_core/builders/content_builder.rb

@@ -7,6 +7,7 @@ module OasCore
         @context = context || :incoming
         @specification = specification
         @media_type = Spec::MediaType.new(specification)
+        @content_type = 'application/json'
       end
 
       def with_schema(schema)
@@ -21,6 +22,12 @@ module OasCore
         self
       end
 
+      def with_content_type(content_type)
+        @content_type = content_type if content_type && !content_type.empty?
+
+        self
+      end
+
       def with_examples_from_tags(tags)
         @media_type.examples = @media_type.examples.merge(tags.each_with_object({}).with_index(1) do |(example, result), _index|
           key = example.text.downcase.gsub(' ', '_')
@@ -36,7 +43,7 @@ module OasCore
 
       def build
         {
-          'application/json': @media_type
+          @content_type => @media_type
         }
       end
     end

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))
@@ -22,8 +19,7 @@ module OasCore
 
       def from_tags(tag:, examples_tags: [])
         @request_body.description = tag.text
-        @request_body.content = ContentBuilder.new(@specification,
-                                                   :incoming).with_schema(tag.schema).with_examples_from_tags(examples_tags).build
+        @request_body.content = ContentBuilder.new(@specification, :incoming).with_schema(tag.schema).with_examples_from_tags(examples_tags).with_content_type(tag.content_type).build
         @request_body.required = tag.required
 
         self

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/json_schema_generator.rb

@@ -116,6 +116,7 @@ module OasCore
     #
     # @param type [Symbol, String] The Ruby data type.
     # @return [Hash, String] The JSON schema type or a hash with additional format information.
+    # rubocop:disable Metrics/CyclomaticComplexity
     def self.ruby_type_to_json_schema_type(type)
       case type.to_s.downcase
       when 'string' then { type: 'string' }
@@ -127,8 +128,10 @@ module OasCore
       when 'nil' then { type: 'null' }
       when 'date' then { type: 'string', format: 'date' }
       when 'datetime' then { type: 'string', format: 'date-time' }
+      when 'file' then { type: 'string', format: 'binary' }
       else type.to_s.downcase
       end
     end
+    # rubocop:enable Metrics/CyclomaticComplexity
   end
 end

data/lib/oas_core/version.rb

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

data/lib/oas_core/yard/oas_core_factory.rb

@@ -8,8 +8,8 @@ module OasCore
       # @param text [String] The tag text to parse.
       # @return [RequestBodyTag] The parsed request body tag object.
       def parse_tag_with_request_body(tag_name, text)
-        description, klass, schema, required = extract_description_and_schema(text.squish)
-        RequestBodyTag.new(tag_name, description, klass, schema:, required:)
+        description, klass, schema, required, content_type = extract_description_and_schema(text.squish)
+        RequestBodyTag.new(tag_name, description, klass, schema:, required:, content_type:)
       end
 
       # Parses a tag that represents a request body example.
@@ -69,11 +69,13 @@ module OasCore
 
       # Specific method to extract description and schema for request body tags.
       # @param text [String] The text to parse.
-      # @return [Array] An array containing the description, class, schema, and required flag.
+      # @return [Array] An array containing the description, class, schema, required flag and content type.
       def extract_description_and_schema(text)
         description, type, = extract_description_type_and_content(text)
+        description, content_type = extract_text_and_parentheses_content(description)
+
         klass, schema, required = type_text_to_schema(type)
-        [description, klass, schema, required]
+        [description, klass, schema, required, content_type]
       end
 
       # Specific method to extract name, location, and schema for parameters.
@@ -122,7 +124,7 @@ module OasCore
       # @param input [String] The input text to parse.
       # @return [Array] An array containing the name and location.
       def extract_text_and_parentheses_content(input)
-        return unless input =~ /^(.+?)\(([^)]+)\)/
+        return input unless input =~ /^(.+?)\(([^)]+)\)/
 
         text = ::Regexp.last_match(1).strip
         parenthesis_content = ::Regexp.last_match(2).strip

data/lib/oas_core/yard/request_body_tag.rb

@@ -3,14 +3,15 @@
 module OasCore
   module YARD
     class RequestBodyTag < ::YARD::Tags::Tag
-      attr_accessor :klass, :schema, :required
+      attr_accessor :klass, :schema, :required, :content_type
 
-      def initialize(tag_name, text, klass, schema: {}, required: false)
+      def initialize(tag_name, text, klass, schema: {}, required: false, content_type: 'application/json')
         # initialize(tag_name, text, types = nil, name = nil)
         super(tag_name, text, nil, nil)
         @klass = klass
         @schema = schema
         @required = required
+        @content_type = content_type
       end
     end
   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.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - a-chacon