oas_core 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '092cef0cfe920698acf4b55412febd5e0ac30f31ed14e0b77169847c6bcfe1bd'
-  data.tar.gz: 6c2bfbbe7d7b513c7f1f2223a1064c716fd74780515e45d10e11e662ae6bc07d
+  metadata.gz: 342155f509e56cc99810dd3883b97d5d274546e2592108c937c746d47daec610
+  data.tar.gz: c4dd49a6427f7e9189b626359af59c245828073a94bda3a04c5870493620ac5f
 SHA512:
-  metadata.gz: 568ea83f14c6e19523e2eb8aa70d3b8533f18200824c2e18cbe7e0c858c50f8a987110ece244f107c907d68f2324ae2d4473ae1bd6641122cdc3044c60130b05
-  data.tar.gz: dc35e960540a2a532bb4374662c8b977ead04128425abced1ec22cce64090470fbc5adf8ae41d2d0dd95bbd34bb20ed603c8661faf51e06572fec30a32faaf01
+  metadata.gz: '069f0e27323893c9195f244ed21739f8b4fe04e9a9e424aa9f3fe6b4b4f2cd45ee2bfb16882eb4196f2dcbdef8dca472a2979608c89f9a2ecadc5d987cc57d73'
+  data.tar.gz: 929d2ce828e2b9ae88473d6401d8b2f8d7c1199b3908ede351588c83b620c10f097012c19eb11a2dc076b65130e09def523c30a567d06423ccbd764bcc0a454b

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

@@ -35,7 +35,7 @@ module OasCore
       end
 
       def extract_operation_id(oas_route:)
-        "#{oas_route.method_name}#{oas_route.path.gsub('/', '_').gsub(/[{}]/, '')}"
+        "#{oas_route.verb}_#{oas_route.path.gsub('/', '_')}"
       end
 
       def extract_tags(oas_route:)

data/lib/oas_core/builders/parameters_builder.rb

@@ -10,13 +10,9 @@ module OasCore
 
       def from_oas_route(oas_route)
         parameters_from_tags(tags: oas_route.tags(:parameter))
+
         oas_route.path_params.try(:map) do |p|
-          unless @parameters.any? do |param|
-            param.name.to_s == p.to_s
-          end
-            @parameters << ParameterBuilder.new(@specification).from_path(oas_route.path,
-                                                                          p).build
-          end
+          @parameters << ParameterBuilder.new(@specification).from_path(oas_route.path, p).build unless @parameters.any? { |param| param.name.to_s == p.to_s }
         end
 
         self

data/lib/oas_core/builders/request_body_builder.rb

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

@@ -6,6 +6,16 @@ module OasCore
   # The JsonSchemaGenerator module provides methods to transform string representations
   # of data types into JSON schema formats.
   module JsonSchemaGenerator
+    @custom_type_parsers = {}
+
+    # Registers a custom type parser.
+    #
+    # @param type_matcher [Proc] A proc that matches the type string.
+    # @param parser [Proc] A proc that processes the type string.
+    def self.register_type_parser(type_matcher, parser)
+      @custom_type_parsers[type_matcher] = parser
+    end
+
     # Processes a string representing a data type and converts it into a JSON schema.
     #
     # @param str [String] The string representation of a data type.
@@ -22,6 +32,7 @@ module OasCore
     #
     # @param str [String] The string representation of a data type.
     # @return [Hash] A hash containing the type, whether it's required, and any additional properties.
+    # Registry for custom type parsers
     def self.parse_type(str)
       required = str.start_with?('!')
       type = str.sub(/^!/, '').strip
@@ -32,7 +43,12 @@ module OasCore
       when /^Array<(.+)>$/i
         { type: :array, required:, items: parse_type(::Regexp.last_match(1)) }
       else
-        { type: type.downcase.to_sym, required: }
+        custom_parser = @custom_type_parsers.find { |matcher, _| matcher.call(type) }
+        if custom_parser
+          custom_parser.last.call(type, required)
+        else
+          { type: type.downcase.to_sym, required: }
+        end
       end
     end
 
@@ -116,6 +132,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 +144,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/oas_route.rb

@@ -12,7 +12,7 @@ module OasCore
     end
 
     def path_params
-      @path.to_s.scan(/:(\w+)/).flatten.reject! { |e| e == 'format' }
+      @path.to_s.scan(/\{(\w+)\}/).flatten
     end
 
     def tags(name = nil)

data/lib/oas_core/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module OasCore
-  VERSION = '0.2.0'
+  VERSION = '0.4.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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: oas_core
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.0
 platform: ruby
 authors:
 - a-chacon