open_api_2_json_schema 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8f25b393383b6694b23d0306c5a48f91762ba658afbd488c15fa16c40cbfa246
-  data.tar.gz: 5bc71e2ab8ff4019428686c39b17cc46f8ea5445d4d181af6fca65aa41b8cdd1
+  metadata.gz: b098b4e80aac6152b1a1623aa380b89b54e8c4a0c1e9c00c7e94f1f3063da1f8
+  data.tar.gz: bed62b780a77c06f4aa3d1576f57bff01926fd913b353b8a5c33cd41a3a971ff
 SHA512:
-  metadata.gz: 3263c6c3f5372ff6e6cc93a812ce429ce1ab03d64b1d7eb5cfb23e9291f48b162accca973247dfca2fbc1da1b851089d5a4b21d663cfd0a300fe4fb368f69c1c
-  data.tar.gz: 828d603767e21eab7b4197d4e3c8217b0cd816464e1726916c9e42571b09c0bcfdff8e1e3622f0f07928f74b67f6d54c87c752ec890dc0902119343181518ce8
+  metadata.gz: '03495227e0657a9d7fbb15827fd8cf6089f0d00ba6b3693de0544af09ce053239fe77c98712a34b5713511ce67fdeee580c96bb325c2ff7f53c4b55c98f79f31'
+  data.tar.gz: 3c8bcf6d521c462e49d6911f6a374e097140af0f6b6e969a4ceca1a5eae37df6fc20ce2806cac0da2e44fe331e7505a3730ff99fb73e2f960493defa41d41d51

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## [0.2.0] - 2022-12-21
+
+- Parsing & deferencing ref using `oas_parser`
+
 ## [0.1.2] - 2022-10-19
 
 - Support `discriminator`

data/README.md

@@ -34,46 +34,6 @@ schema = {
 OpenApi2JsonSchema.convert(schema)
 ```
 
-### Discriminator
-
-```yaml
-# Sample YAML file
-schema:
-  discriminator:
-    propertyName: key
-    mapping:
-      value1: 'path-to-file-2.yml'
-      value2: 'path-to-file-2.yml'
-  properties:
-    key:
-      type: string
-      enum:
-        - value1
-        - value2
-```
-
-```json
-"schema": {
-  "properties": {
-    "key": {
-      "type": "string",
-      "enum": ["value1", "value2"]
-    }
-  },
-  "discriminator": {
-    "propertyName": "name",
-    "mapping": {
-      "value1": {
-        "type": "object"
-      },
-      "value2": {
-        "type": "array"
-      }
-    }
-  }
-}
-```
-
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/open_api_2_json_schema/converter.rb

@@ -0,0 +1,121 @@
+module OpenApi2JsonSchema
+  class Converter
+    NOT_SUPPORTED = [
+      'nullable', 'readOnly',
+      'writeOnly', 'xml', 'externalDocs',
+      'example', 'deprecated'
+    ]
+    STRUCTS = ['allOf', 'anyOf', 'oneOf', 'not', 'items', 'additionalProperties', 'schema', 'discriminator']
+    VALID_TYPES = ['integer', 'number', 'string', 'boolean', 'object', 'array', 'null']
+    VALID_FORMATS = ['date-time', 'email', 'hostname', 'ipv4', 'ipv6', 'uri', 'uri-reference']
+
+    MIN_INT_32 = 0 - 2 ** 31
+    MAX_INT_32 = 2 ** 31 - 1
+    MIN_INT_64 = 0 - 2 ** 63
+    MAX_INT_64 = 2 ** 63 - 1
+    MIN_FLOAT = 0 - 2 ** 128
+    MAX_FLOAT = 2 ** 128 - 1
+    MAX_DOUBLE = 1.7976931348623157e+308
+    MIN_DOUBLE = 0 - MAX_DOUBLE
+    BYTE_PATTERN = '^[\\w\\d+\\/=]*$'
+
+    def convert(schema)
+      convert_schema(schema).tap do |json_schema|
+        json_schema['$schema'] = 'http://json-schema.org/draft-04/schema#'
+      end.to_json
+    end
+
+    private
+
+    def convert_schema(schema)
+      json_schema = schema.except(*NOT_SUPPORTED)
+
+      if schema.key?('properties')
+        new_properties = convert_properties(schema['properties'])
+
+        if schema['required'].is_a?(Array)
+          new_required = clean_required(schema['required'], schema['properties'])
+          json_schema['required'] = new_required if new_required.any?
+        end
+
+        json_schema['properties'] = new_properties if new_properties.any?
+      end
+
+      validate_type(schema['type'])
+
+      json_schema.merge!(convert_types(schema))
+      json_schema.merge!(convert_format(schema))
+
+      json_schema
+    end
+
+    def validate_type(type)
+      unless type.nil? || VALID_TYPES.include?(type)
+        raise InvalidTypeError.build(type)
+      end
+    end
+
+    def convert_properties(properties)
+      return {} unless properties.is_a?(Hash)
+
+      properties.reduce({}) do |result, (key, property)|
+        next result unless property.is_a?(Hash)
+
+        result.merge(key => convert_schema(property))
+      end
+    end
+
+    def convert_types(schema)
+      if schema['type'] && schema['nullable'] == true
+        type = [schema['type'], 'null']
+
+        if schema['enum'].is_a?(Array)
+          {
+            'type' => type,
+            'enum' => schema['enum'].append(nil)
+          }
+        else
+          { 'type' => type }
+        end
+      else
+        {}
+      end
+    end
+
+    def convert_format(schema)
+      case schema['format']
+      when 'int32'
+        {
+          'minimum' => [MIN_INT_32, schema['minimum'] || MIN_INT_32].max,
+          'maximum' => [MAX_INT_32, schema['maximum'] || MAX_INT_32].min
+        }
+      when 'int64'
+        {
+          'minimum' => [MIN_INT_64, schema['minimum'] || MIN_INT_64].max,
+          'maximum' => [MAX_INT_64, schema['maximum'] || MAX_INT_64].min
+        }
+      when 'float'
+        {
+          'minimum' => [MIN_FLOAT, schema['minimum'] || MIN_FLOAT].max,
+          'maximum' => [MAX_FLOAT, schema['maximum'] || MAX_FLOAT].min
+        }
+      when 'double'
+        {
+          'minimum' => [MIN_DOUBLE, schema['minimum'] || MIN_DOUBLE].max,
+          'maximum' => [MAX_DOUBLE, schema['maximum'] || MAX_DOUBLE].min
+        }
+      when 'byte'
+        { 'pattern' => BYTE_PATTERN }
+      else
+        {}
+      end
+    end
+
+    def clean_required(required, properties)
+      required ||= []
+      properties ||= {}
+
+      properties.slice(*required).keys
+    end
+  end
+end

data/lib/open_api_2_json_schema/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module OpenApi2JsonSchema
-  VERSION = "0.1.2"
+  VERSION = "0.2.0"
 end

data/lib/open_api_2_json_schema.rb

@@ -2,32 +2,13 @@
 
 require 'json'
 require 'yaml'
+require 'oas_parser'
+require_relative "open_api_2_json_schema/converter"
 require_relative "open_api_2_json_schema/version"
-require_relative 'attribute_handlers/all_of'
-require_relative 'attribute_handlers/discriminator'
 
 module OpenApi2JsonSchema
   module_function
 
-  STRUCTS = ['allOf', 'anyOf', 'oneOf', 'not', 'items', 'additionalProperties', 'schema', 'discriminator']
-  NOT_SUPPORTED = [
-    'nullable', 'readOnly',
-    'writeOnly', 'xml', 'externalDocs',
-    'example', 'deprecated'
-  ]
-  VALID_TYPES = ['integer', 'number', 'string', 'boolean', 'object', 'array', 'null']
-  VALID_FORMATS = ['date-time', 'email', 'hostname', 'ipv4', 'ipv6', 'uri', 'uri-reference']
-
-  MIN_INT_32 = 0 - 2 ** 31
-  MAX_INT_32 = 2 ** 31 - 1
-  MIN_INT_64 = 0 - 2 ** 63
-  MAX_INT_64 = 2 ** 63 - 1
-  MIN_FLOAT = 0 - 2 ** 128
-  MAX_FLOAT = 2 ** 128 - 1
-  MAX_DOUBLE = 1.7976931348623157e+308
-  MIN_DOUBLE = 0 - MAX_DOUBLE
-  BYTE_PATTERN = '^[\\w\\d+\\/=]*$'
-
   class Error < StandardError; end
   class InvalidTypeError < Error
     def self.build(type)
@@ -36,125 +17,10 @@ module OpenApi2JsonSchema
   end
 
   def convert_from_file(path)
-    data = File.read(path)
-    convert(YAML.load(data))
+    convert(OasParser::Definition.resolve(path).raw)
   end
 
   def convert(schema)
-    convert_schema(schema).tap do |json_schema|
-      json_schema['$schema'] = 'http://json-schema.org/draft-04/schema#'
-    end.to_json
-  end
-
-  def convert_schema(schema)
-    json_schema = schema.except(*NOT_SUPPORTED)
-
-    schema.slice(*STRUCTS).each do |struct, data|
-      case data
-      when Array
-        if struct == 'allOf'
-          json_schema[struct] = AttributeHandlers::AllOf.new.call(data)
-        else
-          json_schema[struct] = data.map do |item|
-            convert_schema(item)
-          end
-        end
-      when Hash
-        if struct == 'discriminator'
-          json_schema[struct] = AttributeHandlers::Discriminator.new.call(data)
-        else
-          json_schema[struct] = convert_schema(data)
-        end
-      else
-        # ignore
-      end
-    end
-
-    if schema.key?('properties')
-      new_properties = convert_properties(schema['properties'])
-
-      if schema['required'].is_a?(Array)
-        new_required = clean_required(schema['required'], schema['properties'])
-        json_schema['required'] = new_required if new_required.any?
-      end
-
-      json_schema['properties'] = new_properties if new_properties.any?
-    end
-
-    validate_type(schema['type'])
-
-    json_schema.merge!(convert_types(schema))
-    json_schema.merge!(convert_format(schema))
-
-    json_schema
-  end
-
-  def validate_type(type)
-    unless type.nil? || VALID_TYPES.include?(type)
-      raise InvalidTypeError.build(type)
-    end
-  end
-
-  def convert_properties(properties)
-    return {} unless properties.is_a?(Hash)
-
-    properties.reduce({}) do |result, (key, property)|
-      next result unless property.is_a?(Hash)
-
-      result.merge(key => convert_schema(property))
-    end
-  end
-
-  def convert_types(schema)
-    if schema['type'] && schema['nullable'] == true
-      type = [schema['type'], 'null']
-
-      if schema['enum'].is_a?(Array)
-        {
-          'type' => type,
-          'enum' => schema['enum'].append(nil)
-        }
-      else
-        { 'type' => type }
-      end
-    else
-      {}
-    end
-  end
-
-  def convert_format(schema)
-    case schema['format']
-    when 'int32'
-      {
-        'minimum' => [MIN_INT_32, schema['minimum'] || MIN_INT_32].max,
-        'maximum' => [MAX_INT_32, schema['maximum'] || MAX_INT_32].min
-      }
-    when 'int64'
-      {
-        'minimum' => [MIN_INT_64, schema['minimum'] || MIN_INT_64].max,
-        'maximum' => [MAX_INT_64, schema['maximum'] || MAX_INT_64].min
-      }
-    when 'float'
-      {
-        'minimum' => [MIN_FLOAT, schema['minimum'] || MIN_FLOAT].max,
-        'maximum' => [MAX_FLOAT, schema['maximum'] || MAX_FLOAT].min
-      }
-    when 'double'
-      {
-        'minimum' => [MIN_DOUBLE, schema['minimum'] || MIN_DOUBLE].max,
-        'maximum' => [MAX_DOUBLE, schema['maximum'] || MAX_DOUBLE].min
-      }
-    when 'byte'
-      { 'pattern' => BYTE_PATTERN }
-    else
-      {}
-    end
-  end
-
-  def clean_required(required, properties)
-    required ||= []
-    properties ||= {}
-
-    properties.slice(*required).keys
+    Converter.new.convert(schema)
   end
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: open_api_2_json_schema
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - hieuk09
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-10-19 00:00:00.000000000 Z
-dependencies: []
+date: 2022-12-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: oas_parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.25'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.25'
 description: 'Due to the OpenAPI v3.0 and JSON Schema discrepancy, you can use this
   JS library to convert OpenAPI Schema objects to proper JSON Schema. '
 email:
@@ -27,11 +41,9 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
-- lib/attribute_handlers/all_of.rb
-- lib/attribute_handlers/discriminator.rb
 - lib/open_api_2_json_schema.rb
+- lib/open_api_2_json_schema/converter.rb
 - lib/open_api_2_json_schema/version.rb
-- lib/ref_schema_parser.rb
 homepage: https://github.com/hieuk09/open_api_2_json_schema
 licenses:
 - MIT
@@ -46,14 +58,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: OpenAPI v3.0 schema to JSON Schema draft 4 converter

data/lib/attribute_handlers/all_of.rb

@@ -1,21 +0,0 @@
-require_relative '../ref_schema_parser'
-
-module OpenApi2JsonSchema
-  module AttributeHandlers
-    class AllOf
-      def call(all_of_schemas)
-        raise 'allOf schema must be an Array' unless all_of_schemas.is_a?(Array)
-
-        all_of_schemas.each_with_index.map do |schema, index|
-          raise "Invalid schema: allOf[#{index}]" unless schema.is_a?(Hash)
-
-          if schema['$ref']
-            OpenApi2JsonSchema::RefSchemaParser.new.call(schema['$ref'])
-          else
-            schema
-          end
-        end
-      end
-    end
-  end
-end

data/lib/attribute_handlers/discriminator.rb

@@ -1,18 +0,0 @@
-require_relative "../ref_schema_parser"
-
-module OpenApi2JsonSchema
-  module AttributeHandlers
-    class Discriminator
-      def call(discriminator_schema)
-        raise "discriminator schema must be a Hash" unless discriminator_schema.is_a?(Hash)
-
-        mapping = discriminator_schema.fetch("mapping")
-        mapping.each do |key, file_path|
-          mapping[key] = OpenApi2JsonSchema::RefSchemaParser.new.call(file_path)
-        end
-
-        discriminator_schema
-      end
-    end
-  end
-end

data/lib/ref_schema_parser.rb

@@ -1,35 +0,0 @@
-require 'yaml'
-
-module OpenApi2JsonSchema
-  class RefSchemaParser
-    def call(ref_path)
-      file_path, fragments = normalize_path(ref_path)
-      ref_schema = load_file(file_path)
-      fragment_schema = ref_schema
-
-      if fragments
-        fragments.split('/').each do |fragment|
-          if fragment && fragment != '' && fragment_schema[fragment]
-            fragment_schema = fragment_schema[fragment]
-          end
-        end
-      end
-
-      fragment_schema
-    end
-
-    private
-
-    def normalize_path(path)
-      temp_path = path.split('#')
-      raise 'Invalid reference path' if temp_path.size > 2
-
-      temp_path
-    end
-
-    def load_file(path)
-      data = File.read(path)
-      YAML.safe_load(data)
-    end
-  end
-end