openapi_parser 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e01493b04243073a1fec0acaa56db780076e3c30f3a64534da419bd745408b87
-  data.tar.gz: 1e57cd341560e800018fa82bbc4801910bbdfdf4a580ccbdaaa63fa0fe442d4a
+  metadata.gz: 98afa3c7fb754859a594373659d18ebb81483581c948621d0ea050c360da38ec
+  data.tar.gz: 9cf7b695875b6ca55a89a3d5e1a288381d39e203c5fbb469beeb7465232ff0a5
 SHA512:
-  metadata.gz: 28182a2367a7ff7314f0c8b35c51d321ce7ce6e9238cd72c83bd57e3cb1970bc9000e19b6a725a47b14ed6262befff61dd325106f9a1389bd72ffa7de7230fe2
-  data.tar.gz: 0c5560de5b4579933d135d0046a3ae4aaa3e701d83779ff8efd0713023ad5f6d6f37b485f41fa9eb3c3ac5b26c1118afe724d2b9787440e1bfd229c6f0d823a9
+  metadata.gz: ddc32d47e0072b78f4790a6b6fa031eab103bb4665d5c0cfe4e7ac2ac9b2e04a048a82f4ddefd40fd112221e389cd86568ac67c3ca9db6f46ae4b9f8ece23c8a
+  data.tar.gz: bdd2fdeaec224eaecdde6088abc7eb69513a4ab9e2afffbf23a6a21f9e13a640bddaf6bd7fbbaab16dff588c021bc12296aefd01b1efcb28908f33f8b263f9ad

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## Unreleased
 
+## 0.10.0 (2020-04-01)
+* Support $ref to objects in other OpenAPI yaml files #66
+* Allow $ref for path item objects #71
+
 ## 0.9.0 (2020-03-22)
 * Added support for validating UUID formatted strings #67
 

data/lib/openapi_parser.rb

@@ -1,4 +1,9 @@
+require 'uri'
 require 'time'
+require 'json'
+require 'psych'
+require 'pathname'
+require 'open-uri'
 
 require 'openapi_parser/version'
 require 'openapi_parser/config'
@@ -13,14 +18,67 @@ require 'openapi_parser/reference_expander'
 
 module OpenAPIParser
   class << self
+    # Load schema yaml object. Uri is not set for returned schema.
     # @return [OpenAPIParser::Schemas::OpenAPI]
     def parse(schema, config = {})
-      c = Config.new(config)
-      root = Schemas::OpenAPI.new(schema, c)
+      load_hash(schema, config: Config.new(config), uri: nil, schema_registry: {})
+    end
+
+    # Load schema in specified filepath. If file path is relative, it is resolved using working directory.
+    # @return [OpenAPIParser::Schemas::OpenAPI]
+    def load(filepath, config = {})
+      path = Pathname.new(filepath)
+      path = Pathname.getwd + path if path.relative?
+      load_uri(URI.join("file:///",  path.to_s), config: Config.new(config), schema_registry: {})
+    end
 
-      OpenAPIParser::ReferenceExpander.expand(root) if c.expand_reference
+    # Load schema located by the passed uri. Uri must be absolute.
+    # @return [OpenAPIParser::Schemas::OpenAPI]
+    def load_uri(uri, config:, schema_registry:)
+      # Open-uri doesn't open file scheme uri, so we try to open file path directly
+      # File scheme uri which points to a remote file is not supported.
+      content = if uri.scheme == 'file'
+        open(uri.path, &:read)
+      else
+        uri.open(&:read)
+      end
 
-      root
+      extension = Pathname.new(uri.path).extname
+      load_hash(parse_file(content, extension), config: config, uri: uri, schema_registry: schema_registry)
     end
+
+    private
+
+      def parse_file(content, extension)
+        case extension.downcase
+        when '.yaml', '.yml'
+          parse_yaml(content)
+        when '.json'
+          parse_json(content)
+        else
+          # When extension is something we don't know, try to parse as json first. If it fails, parse as yaml
+          begin
+            parse_json(content)
+          rescue JSON::ParserError
+            parse_yaml(content)
+          end
+        end
+      end
+
+      def parse_yaml(content)
+        Psych.safe_load(content)
+      end
+
+      def parse_json(content)
+        JSON.parse(content)
+      end
+
+      def load_hash(hash, config:, uri:, schema_registry:)
+        root = Schemas::OpenAPI.new(hash, config, uri: uri, schema_registry: schema_registry)
+
+        OpenAPIParser::ReferenceExpander.expand(root) if config.expand_reference
+
+        root
+      end
   end
 end

data/lib/openapi_parser/concerns/findable.rb

@@ -1,9 +1,13 @@
+require 'uri'
+
 module OpenAPIParser::Findable
   # @param [String] reference
   # @return [OpenAPIParser::Findable]
   def find_object(reference)
-    return nil unless reference.start_with?(object_reference)
     return self if object_reference == reference
+    remote_reference = !reference.start_with?('#')
+    return find_remote_object(reference) if remote_reference
+    return nil unless reference.start_with?(object_reference)
 
     @find_object_cache = {} unless defined? @find_object_cache
     if (obj = @find_object_cache[reference])
@@ -30,4 +34,13 @@ module OpenAPIParser::Findable
 
     _openapi_all_child_objects.values.each(&:purge_object_cache)
   end
+
+  private
+
+    def find_remote_object(reference)
+      reference_uri = URI(reference)
+      fragment = reference_uri.fragment
+      reference_uri.fragment = nil
+      root.load_another_schema(reference_uri)&.find_object("##{fragment}")
+    end
 end

data/lib/openapi_parser/errors.rb

@@ -178,6 +178,17 @@ module OpenAPIParser
     end
   end
 
+  class InvalidUUIDFormat < OpenAPIError
+    def initialize(value, reference)
+      super(reference)
+      @value = value
+    end
+
+    def message
+      "#{@reference} Value: #{@value} is not conformant with UUID format"
+    end
+  end
+
   class NotExistStatusCodeDefinition < OpenAPIError
     def message
       "#{@reference} status code definition does not exist"

data/lib/openapi_parser/schema_validators/string_validator.rb

@@ -27,6 +27,9 @@ class OpenAPIParser::SchemaValidator
       value, err = validate_email_format(value, schema)
       return [nil, err] if err
 
+      value, err = validate_uuid_format(value, schema)
+      return [nil, err] if err
+
       [value, nil]
     end
 
@@ -75,5 +78,13 @@ class OpenAPIParser::SchemaValidator
 
         return [nil, OpenAPIParser::InvalidEmailFormat.new(value, schema.object_reference)]
       end
+
+      def validate_uuid_format(value, schema)
+        return [value, nil] unless schema.format == 'uuid'
+
+        return [value, nil] if value.match(/[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}/)
+
+        return [nil, OpenAPIParser::InvalidUUIDFormat.new(value, schema.object_reference)]
+      end
   end
 end

data/lib/openapi_parser/schemas/openapi.rb

@@ -5,11 +5,16 @@
 
 module OpenAPIParser::Schemas
   class OpenAPI < Base
-    def initialize(raw_schema, config)
+    def initialize(raw_schema, config, uri: nil, schema_registry: {})
       super('#', nil, self, raw_schema)
       @find_object_cache = {}
       @path_item_finder = OpenAPIParser::PathItemFinder.new(paths) if paths # invalid definition
       @config = config
+      @uri = uri
+      @schema_registry = schema_registry
+
+      # schema_registery is shared among schemas, and prevents a schema from being loaded multiple times
+      schema_registry[uri] = self if uri
     end
 
     # @!attribute [r] openapi
@@ -28,5 +33,27 @@ module OpenAPIParser::Schemas
     def request_operation(http_method, request_path)
       OpenAPIParser::RequestOperation.create(http_method, request_path, @path_item_finder, @config)
     end
+
+    # load another schema with shared config and schema_registry
+    # @return [OpenAPIParser::Schemas::OpenAPI]
+    def load_another_schema(uri)
+      resolved_uri = resolve_uri(uri)
+      return if resolved_uri.nil?
+
+      loaded = @schema_registry[resolved_uri]
+      return loaded if loaded
+
+      OpenAPIParser.load_uri(resolved_uri, config: @config, schema_registry: @schema_registry)
+    end
+
+    private
+
+      def resolve_uri(uri)
+        if uri.absolute?
+          uri
+        else
+          @uri&.merge(uri)
+        end
+      end
   end
 end

data/lib/openapi_parser/schemas/paths.rb

@@ -2,6 +2,6 @@ module OpenAPIParser::Schemas
   class Paths < Base
     # @!attribute [r] path
     #   @return [Hash{String => PathItem, Reference}, nil]
-    openapi_attr_hash_body_objects 'path', PathItem, reference: false, allow_data_type: false
+    openapi_attr_hash_body_objects 'path', PathItem, reference: true, allow_data_type: false
   end
 end

data/lib/openapi_parser/version.rb

@@ -1,3 +1,3 @@
 module OpenAPIParser
-  VERSION = '0.9.0'.freeze
+  VERSION = '0.10.0'.freeze
 end

data/openapi_parser.gemspec

@@ -24,9 +24,9 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'bundler', '>= 1.16'
   spec.add_development_dependency 'fincop'
-  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'pry', '~> 0.12.0'
   spec.add_development_dependency 'pry-byebug'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rake', '>= 12.3.3'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'rspec-parameterized'
   spec.add_development_dependency 'simplecov'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openapi_parser
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - ota42y
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-22 00:00:00.000000000 Z
+date: 2020-04-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -42,16 +42,16 @@ dependencies:
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.12.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.12.0
 - !ruby/object:Gem::Dependency
   name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
@@ -70,16 +70,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -222,7 +222,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: OpenAPI3 parser