open_api_2_json_schema 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fb64e501ef7cce37f6a1cd60f7ce61b7fff4688800699281dad4202cace7a9d9
-  data.tar.gz: c8ac0fa10f9eacfd26e8e862ad56fb4b09e64998965fdd3dcbfd8711a95ef8df
+  metadata.gz: 8f25b393383b6694b23d0306c5a48f91762ba658afbd488c15fa16c40cbfa246
+  data.tar.gz: 5bc71e2ab8ff4019428686c39b17cc46f8ea5445d4d181af6fca65aa41b8cdd1
 SHA512:
-  metadata.gz: 0d15e51a8346868a3941eaff9f6741c33490cf155f47f8459ae8c46967d9222d86d643b0ea62943042dd16ff64653a1950c7c6816782acc62ac2f968f2ce1bc8
-  data.tar.gz: 18e5244cbeebc8591542eea1a0bd85cc5e7bd9721ff798890f3506c87398775f0ac471087b931cfb31b48b68ad09d450d4b731df7b2f02090256ae746e29a1d4
+  metadata.gz: 3263c6c3f5372ff6e6cc93a812ce429ce1ab03d64b1d7eb5cfb23e9291f48b162accca973247dfca2fbc1da1b851089d5a4b21d663cfd0a300fe4fb368f69c1c
+  data.tar.gz: 828d603767e21eab7b4197d4e3c8217b0cd816464e1726916c9e42571b09c0bcfdff8e1e3622f0f07928f74b67f6d54c87c752ec890dc0902119343181518ce8

data/.rspec

@@ -1,3 +1,3 @@
---format documentation
+--format progress
 --color
 --require spec_helper

data/CHANGELOG.md

@@ -1,4 +1,10 @@
-## [Unreleased]
+## [0.1.2] - 2022-10-19
+
+- Support `discriminator`
+
+## [0.1.1] - 2022-09-23
+
+- Support `$ref` and `allOf`
 
 ## [0.1.0] - 2022-03-26
 

data/README.md

@@ -34,6 +34,46 @@ 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/attribute_handlers/all_of.rb

@@ -0,0 +1,21 @@
+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

@@ -0,0 +1,18 @@
+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/open_api_2_json_schema/version.rb

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

data/lib/open_api_2_json_schema.rb

@@ -3,13 +3,15 @@
 require 'json'
 require 'yaml'
 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']
+  STRUCTS = ['allOf', 'anyOf', 'oneOf', 'not', 'items', 'additionalProperties', 'schema', 'discriminator']
   NOT_SUPPORTED = [
-    'nullable', 'discriminator', 'readOnly',
+    'nullable', 'readOnly',
     'writeOnly', 'xml', 'externalDocs',
     'example', 'deprecated'
   ]
@@ -47,14 +49,22 @@ module OpenApi2JsonSchema
   def convert_schema(schema)
     json_schema = schema.except(*NOT_SUPPORTED)
 
-    schema.slice(STRUCTS).each do |struct, data|
+    schema.slice(*STRUCTS).each do |struct, data|
       case data
       when Array
-        json_schema[struct] = data.map do |item|
-          convert_schema(item)
+        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
-        json_schema[struct] = convert_schema(data)
+        if struct == 'discriminator'
+          json_schema[struct] = AttributeHandlers::Discriminator.new.call(data)
+        else
+          json_schema[struct] = convert_schema(data)
+        end
       else
         # ignore
       end

data/lib/ref_schema_parser.rb

@@ -0,0 +1,35 @@
+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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: open_api_2_json_schema
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - hieuk09
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-03-26 00:00:00.000000000 Z
+date: 2022-10-19 00:00:00.000000000 Z
 dependencies: []
 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. '
@@ -22,14 +22,16 @@ files:
 - ".rubocop.yml"
 - CHANGELOG.md
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - 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/version.rb
+- lib/ref_schema_parser.rb
 homepage: https://github.com/hieuk09/open_api_2_json_schema
 licenses:
 - MIT
@@ -51,7 +53,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
+rubygems_version: 3.0.8
 signing_key:
 specification_version: 4
 summary: OpenAPI v3.0 schema to JSON Schema draft 4 converter

data/Gemfile.lock

@@ -1,66 +0,0 @@
-PATH
-  remote: .
-  specs:
-    open_api_2_json_schema (0.1.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    ast (2.4.2)
-    attr_extras (6.2.5)
-    byebug (11.1.3)
-    diff-lcs (1.5.0)
-    optimist (3.0.1)
-    parallel (1.22.1)
-    parser (3.1.1.0)
-      ast (~> 2.4.1)
-    patience_diff (1.2.0)
-      optimist (~> 3.0)
-    rainbow (3.1.1)
-    rake (13.0.6)
-    regexp_parser (2.2.1)
-    rexml (3.2.5)
-    rspec (3.11.0)
-      rspec-core (~> 3.11.0)
-      rspec-expectations (~> 3.11.0)
-      rspec-mocks (~> 3.11.0)
-    rspec-core (3.11.0)
-      rspec-support (~> 3.11.0)
-    rspec-expectations (3.11.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-mocks (3.11.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-support (3.11.0)
-    rubocop (1.26.1)
-      parallel (~> 1.10)
-      parser (>= 3.1.0.0)
-      rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.16.0, < 2.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.16.0)
-      parser (>= 3.1.1.0)
-    ruby-progressbar (1.11.0)
-    super_diff (0.8.0)
-      attr_extras (>= 6.2.4)
-      diff-lcs
-      patience_diff
-    unicode-display_width (2.1.0)
-
-PLATFORMS
-  x86_64-darwin-19
-
-DEPENDENCIES
-  byebug
-  open_api_2_json_schema!
-  rake (~> 13.0)
-  rspec (~> 3.0)
-  rubocop (~> 1.21)
-  super_diff
-
-BUNDLED WITH
-   2.2.32