json-schema-oas 0.1.0

data/json-schema-oas.gemspec

@@ -0,0 +1,31 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'json-schema-oas/schema/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'json-schema-oas'
+  spec.version       = JSON::Oas::Schema::VERSION
+  spec.authors       = ['Guillaume Dt']
+  spec.email         = ['Deuteu@users.noreply.github.com']
+  spec.license       = 'Apache-2.0'
+
+  spec.summary       = 'Ruby JSON Schema Validator with OAS helper'
+  spec.homepage      = 'https://github.com/Deuteu/json-schema-oas'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'json-schema', '~> 2.8', '>= 2.8.1'
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.65'
+  spec.add_development_dependency 'simplecov', '~> 0.16'
+end

data/lib/json-schema-oas.rb

@@ -0,0 +1,5 @@
+require 'json-schema-oas/schema/version'
+require 'json-schema-oas/error'
+require 'json-schema-oas/version'
+require 'json-schema-oas/fragment'
+require 'json-schema-oas/validator'

data/lib/json-schema-oas/error.rb

@@ -0,0 +1,9 @@
+module JSON
+  module Oas
+    # Error raised in JSON::Oas
+    class Error < ::StandardError
+      INVALID_SCHEMA_ERROR = 'Invalid schema'.freeze
+      UNKNOWN_VERSION_ERROR = 'Unknown version'.freeze
+    end
+  end
+end

data/lib/json-schema-oas/fragment.rb

@@ -0,0 +1,57 @@
+module JSON
+  module Oas
+    # This is a workaround for json-schema's fragment validation
+    # which does not allow to contain forward slashes
+    # due to an attempt split('/')
+    class Fragment < Array
+      class << self
+        def response_schema_for(version, path_or_name, method = nil, code = nil)
+          case version
+          when Version::OAS2
+            raise ArgumentError unless method && code
+
+            new(['#', 'paths', path_or_name, method.to_s, 'responses', code.to_s, 'schema'])
+          when Version::OAS3
+            v3_response_schema_for(path_or_name, method, code)
+          else
+            raise Error, Error::UNKNOWN_VERSION_ERROR
+          end
+        end
+
+        def schema_for(version, name)
+          case version
+          when Version::OAS2
+            new(['#', 'definitions', name.to_s])
+          when Version::OAS3
+            new(['#', 'components', 'schemas', name.to_s])
+          else
+            raise Error, Error::UNKNOWN_VERSION_ERROR
+          end
+        end
+
+        private
+
+        # @path_or_name String To avoid https://github.com/ruby-json-schema/json-schema/issues/229
+        def v3_response_schema_for(path_or_name, method = nil, code = nil)
+          unless method && code
+            raise ArgumentError unless path_or_name
+
+            return new(['#', 'components', 'responses', path_or_name, 'content', 'application/json', 'schema'])
+          end
+
+          v3_paths_response_schema_for(path_or_name, method, code)
+        end
+
+        def v3_paths_response_schema_for(path, method, code)
+          raise ArgumentError unless method && code && path
+
+          new(['#', 'paths', path, method.to_s, 'responses', code.to_s, 'content', 'application/json', 'schema'])
+        end
+      end
+
+      def split(_options = nil)
+        dup
+      end
+    end
+  end
+end

data/lib/json-schema-oas/schema/version.rb

@@ -0,0 +1,7 @@
+module JSON
+  module Oas
+    class Schema
+      VERSION = '0.1.0'.freeze
+    end
+  end
+end

data/lib/json-schema-oas/validator.rb

@@ -0,0 +1,65 @@
+require 'json-schema'
+
+module JSON
+  module Oas
+    OAS2_SCHEMA_PATH = File.expand_path('../../data/specifications/oas2.json', __dir__)
+    OAS3_SCHEMA_PATH = File.expand_path('../../data/specifications/oas3.json', __dir__)
+
+    # Validator to validate data against a OpenAPI schema
+    class Validator < JSON::Validator
+      class << self
+        def valid_schema?(schema, version)
+          specs = case version
+                  when Version::OAS2
+                    OAS2_SCHEMA_PATH
+                  when Version::OAS3
+                    OAS3_SCHEMA_PATH
+                  else
+                    raise Error, Error::UNKNOWN_VERSION_ERROR
+                  end
+          JSON::Validator.fully_validate(specs, schema).empty?
+        end
+
+        def compute_fragment(version, opts)
+          options = Hash(opts)
+          return options if options[:fragment]
+
+          if options[:with_schema]
+            options[:fragment] = Fragment.schema_for(version, options[:with_schema].to_s)
+          elsif options[:with_response]
+            options[:fragment] = Fragment.response_schema_for(version, *Array(options[:with_response]))
+          end
+
+          options
+        end
+      end
+
+      private
+
+      def initialize(schema_data, data, opts = {})
+        @original_schema = schema_data.dup
+
+        @oas_version = opts[:oas_version] || Oas::Version::DEFAULT_VERSION
+        raise Error, Error::UNKNOWN_VERSION_ERROR unless Oas::Version::VERSIONS.include?(@oas_version)
+
+        options = self.class.compute_fragment(@oas_version, opts)
+
+        super(schema_data, data, options)
+
+        validate_schema!
+      end
+
+      def initialize_schema(schema)
+        schema = super(schema)
+        @original_schema = schema.dup
+        schema
+      end
+
+      def validate_schema!
+        return true if self.class.valid_schema?(@original_schema.schema, @oas_version)
+
+        raise Error, Error::INVALID_SCHEMA_ERROR
+      end
+    end
+  end
+end

data/lib/json-schema-oas/version.rb

@@ -0,0 +1,11 @@
+module JSON
+  module Oas
+    class Version
+      OAS2 = '2.0'.freeze
+      OAS3 = '3.0'.freeze
+
+      DEFAULT_VERSION = OAS3
+      VERSIONS = [OAS2, OAS3].freeze
+    end
+  end
+end

metadata

@@ -0,0 +1,162 @@
+--- !ruby/object:Gem::Specification
+name: json-schema-oas
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Guillaume Dt
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-03-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json-schema
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.8.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.65'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.65'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+description: 
+email:
+- Deuteu@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- data/example/error.json
+- data/example/invalid/error.json
+- data/example/invalid/pet.json
+- data/example/pet.json
+- data/schema/invalid/empty.yml
+- data/schema/invalid/petstore.oas2.yml
+- data/schema/invalid/petstore.oas3.yml
+- data/schema/petstore.oas2.yml
+- data/schema/petstore.oas3.yml
+- data/specifications/oas2.json
+- data/specifications/oas3.json
+- json-schema-oas.gemspec
+- lib/json-schema-oas.rb
+- lib/json-schema-oas/error.rb
+- lib/json-schema-oas/fragment.rb
+- lib/json-schema-oas/schema/version.rb
+- lib/json-schema-oas/validator.rb
+- lib/json-schema-oas/version.rb
+homepage: https://github.com/Deuteu/json-schema-oas
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Ruby JSON Schema Validator with OAS helper
+test_files: []