open_api_2_json_schema 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fb64e501ef7cce37f6a1cd60f7ce61b7fff4688800699281dad4202cace7a9d9
+  data.tar.gz: c8ac0fa10f9eacfd26e8e862ad56fb4b09e64998965fdd3dcbfd8711a95ef8df
+SHA512:
+  metadata.gz: 0d15e51a8346868a3941eaff9f6741c33490cf155f47f8459ae8c46967d9222d86d643b0ea62943042dd16ff64653a1950c7c6816782acc62ac2f968f2ce1bc8
+  data.tar.gz: 18e5244cbeebc8591542eea1a0bd85cc5e7bd9721ff798890f3506c87398775f0ac471087b931cfb31b48b68ad09d450d4b731df7b2f02090256ae746e29a1d4

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2022-03-26
+
+- Initial release

data/Gemfile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in open_api_2_json_schema.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "rubocop", "~> 1.21"
+gem 'super_diff'
+gem 'byebug'

data/Gemfile.lock

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 hieuk09
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,49 @@
+# OpenApi2JsonSchema
+
+This is a simplified ruby port of [Javascript library
+openapi-schema-to-json-schema](https://github.com/openapi-contrib/openapi-schema-to-json-schema)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'open_api_2_json_schema'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install open_api_2_json_schema
+
+## Usage
+
+```ruby
+# if you want to convert from file
+OpenApi2JsonSchema.convert_from_file("path/to/open_api.yml")
+
+# if you want to convert from stringify hash
+schema = {
+  'type' => 'string',
+  'format' => 'date-time',
+  'nullable' => true
+}
+OpenApi2JsonSchema.convert(schema)
+```
+
+## 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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/hieuk09/open_api_2_json_schema.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "open_api_2_json_schema"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/open_api_2_json_schema/version.rb

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

data/lib/open_api_2_json_schema.rb

@@ -0,0 +1,150 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'yaml'
+require_relative "open_api_2_json_schema/version"
+
+module OpenApi2JsonSchema
+  module_function
+
+  STRUCTS = ['allOf', 'anyOf', 'oneOf', 'not', 'items', 'additionalProperties']
+  NOT_SUPPORTED = [
+    'nullable', 'discriminator', '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)
+      new("Type #{type} is not a valid type")
+    end
+  end
+
+  def convert_from_file(path)
+    data = File.read(path)
+    convert(YAML.load(data))
+  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
+        json_schema[struct] = data.map do |item|
+          convert_schema(item)
+        end
+      when Hash
+        json_schema[struct] = convert_schema(data)
+      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
+  end
+end

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification
+name: open_api_2_json_schema
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- hieuk09
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-03-26 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. '
+email:
+- hieuk09@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/open_api_2_json_schema.rb
+- lib/open_api_2_json_schema/version.rb
+homepage: https://github.com/hieuk09/open_api_2_json_schema
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/hieuk09/open_api_2_json_schema
+  source_code_uri: https://github.com/hieuk09/open_api_2_json_schema
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.32
+signing_key:
+specification_version: 4
+summary: OpenAPI v3.0 schema to JSON Schema draft 4 converter
+test_files: []