openapi_parser 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1635ca728b8c31ce02b997acea2b7fb763b15558a785b17e95ca2ee47fe58232
-  data.tar.gz: ff8c1957b980f7f363f7e68e44098e862996c73d140b57a9e02d0b39c4527a77
+  metadata.gz: e0035d4ece30f151226f04a1462ae6cf4d54c36011b315810bd49588f66b0632
+  data.tar.gz: cae26e5b18e0ab71b2027d56a828cccd737126852b96c68facf88f8ba27db0ab
 SHA512:
-  metadata.gz: b39a5c07adaed7a98b0ed984767cf6bf0c92d6e8261f1cd94ddc4fe5598b0277c990b30901ed03eabbce638a434d2a8d78c9be18d1eaaac95805604929a57d8f
-  data.tar.gz: 2e99c3ae918a2f1c4bc07e66ec71dddf877dda8457ded288aa744449806c02eae38d82c6c47782503fa3bec91b18bb5757605febfdd591ada31d24ebe94524f1
+  metadata.gz: 0456ee6d9363ff05c1ef517cbc9aa8cfbcad55aa054e012009ec685a5b97c7779c897842918a868dae3acefa143bbfa7790fc7bb1ba370e04293fc7ead130ef4
+  data.tar.gz: d2855d0574bfdc5a769576ffa89af5d1006f960af4a4790e92edfbe5763eb3a954698f71522d599524b1b9d906f11632440167c4e37e524435804873aeede533

data/.rubocop.yml

@@ -1,10 +1,13 @@
 inherit_gem:
   fincop:
-    - 'config/rails.yml'
+    # - 'config/rails.yml'
     - 'config/rspec.yml'
     - 'config/rubocop.yml'
-    # If you are using Rails 4, activate this cop.
+     # If you are using Rails 4, activate this cop.
     # - 'config/disabled_for_rails_4.yml'
 
+inherit_from:
+  - '.rubocop_ignore.yml'
+
 AllCops:
   TargetRubyVersion: 2.5

data/.rubocop_ignore.yml

@@ -0,0 +1,6 @@
+Metrics/ParameterLists:
+  Exclude:
+    - lib/openapi_parser/concerns/parser.rb
+
+RSpec/FilePath:
+  Enabled: false

data/.travis.yml

@@ -1,7 +1,36 @@
----
-sudo: false
+env:
+  global:
+    - CC_TEST_REPORTER_ID=b49a1717b8ff0aef9eced41d0f87d350a88b46d55083ba2e3df8b6f441ae3fb7
+
 language: ruby
-cache: bundler
+
 rvm:
+  - 2.3.8
+  - 2.4.5
   - 2.5.3
-before_install: gem install bundler -v 1.16.6
+  - 2.6.0
+  - ruby-head
+
+cache: bundler
+
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+
+script: bundle exec rspec
+
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT
+
+notifications:
+  email: false
+
+sudo: false
+
+git:
+  depth: 10
+
+matrix:
+  allow_failures:
+    - rvm: ruby-head

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+## Unreleased
+
+## 0.1.6 (2018-12-29)
+* Support allOf definition (#11)
+* Support wildcard status code (#12)
+* Support wildcard content type (#13)
+
+## 0.1.5 (2018-12-23)
+* First release for production usage

data/README.md

@@ -1,8 +1,41 @@
 # OpenAPI Parser
+[![Build Status](https://travis-ci.org/ota42y/openapi_parser.svg?branch=master)](https://travis-ci.org/ota42y/openapi_parser)
+[![Gem Version](https://badge.fury.io/rb/openapi_parser.svg)](https://badge.fury.io/rb/openapi_parser)
+[![Yard Docs](https://img.shields.io/badge/yard-docs-blue.svg)](https://www.rubydoc.info/gems/openapi_parser)
+[![Maintainability](https://api.codeclimate.com/v1/badges/62bad4bcb3f691d46487/maintainability)](https://codeclimate.com/github/ota42y/openapi_parser/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/62bad4bcb3f691d46487/test_coverage)](https://codeclimate.com/github/ota42y/openapi_parser/test_coverage)
+[![Inch CI](https://inch-ci.org/github/ota42y/openapi_parser.svg?branch=master)](https://inch-ci.org/github/ota42y/openapi_parser)
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/openapi_parser`. To experiment with that code, run `bin/console` for an interactive prompt.
+This is OpenAPI3 parser and validator. 
 
-TODO: Delete this and the text above, and describe your gem
+## Usage
+
+```ruby
+root = OpenAPIParser.parse(YAML.load_file('open_api_3/schema.yml'))
+
+# request operation combine path parameters and OpenAPI3's Operation Object
+request_operation = root.request_operation(:post, '/validate')
+
+ret = request_operation.validate_request_body('application/json', {"integer" => 1})
+# => {"integer" => 1}
+
+# invalid parameter
+request_operation.validate_request_body('application/json', {"integer" => '1'})
+# => OpenAPIParser::ValidateError: 1 class is String but it's not valid integer in #/paths/~1validate/post/requestBody/content/application~1json/schema/properties/integer
+
+# path parameter
+request_operation = root.request_operation(:get, '/path_template_test/1')
+request_operation.path_params
+# => {"template_name"=>"1"}
+
+# coerce parameter
+root = OpenAPIParser.parse(YAML.load_file('open_api_3/schema.yml'), {coerce_value: true, datetime_coerce_class: DateTime}) 
+request_operation = root.request_operation(:get, '/string_params_coercer') 
+request_operation.validate_request_parameter({'integer_1' => '1', 'datetime_string' => '2016-04-01T16:00:00+09:00'})
+# => {"integer_1"=>1, "datetime_string"=>#<DateTime: 2016-04-01T16:00:00+09:00 ((2457480j,25200s,0n),+32400s,2299161j)>
+# convert number string to Integer and datetime string to DateTime class
+
+```
 
 ## Installation
 
@@ -20,9 +53,9 @@ Or install it yourself as:
 
     $ gem install openapi_parser
 
-## Usage
-
-TODO: Write usage instructions here
+## ToDo
+- correct schema checker
+- more detailed validator
 
 ## Development
 
@@ -32,7 +65,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/openapi_parser. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/ota42y/openapi_parser. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 

data/lib/openapi_parser/concern.rb

@@ -1,3 +1,4 @@
-require_relative 'concerns/parseable'
+require_relative 'concerns/parser'
 require_relative 'concerns/findable'
 require_relative 'concerns/expandable'
+require_relative 'concerns/media_type_selectable'

data/lib/openapi_parser/concerns/expandable.rb

@@ -1,25 +1,30 @@
 module OpenAPIParser::Expandable
+  # expand refs
+  # @param [OpenAPIParser::Schemas::Base] root
+  # @return nil
   def expand_reference(root)
-    expand_list_objects(root, self.class._openapi_attr_list_objects&.keys)
-    expand_objects(root, self.class._openapi_attr_objects&.keys)
-    expand_hash_objects(root, self.class._openapi_attr_hash_objects&.keys)
-    expand_hash_objects(root, self.class._openapi_attr_hash_body_objects&.keys)
+    expand_list_objects(root, self.class._openapi_attr_list_objects.keys)
+    expand_objects(root, self.class._openapi_attr_objects.keys)
+    expand_hash_objects(root, self.class._openapi_attr_hash_objects.keys)
+    expand_hash_objects(root, self.class._openapi_attr_hash_body_objects.keys)
+    nil
   end
 
   private
 
-  def expand_hash_objects(root, attribute_names)
-    return unless attribute_names
+    def expand_hash_objects(root, attribute_names)
+      return unless attribute_names
 
-    attribute_names.each do |name|
+      attribute_names.each { |name| expand_hash_attribute(root, name) }
+    end
+
+    def expand_hash_attribute(root, name)
       h = send(name)
-      next if h.nil?
+      return if h.nil?
 
       update_values = h.map do |k, v|
-        next [k, referenced_object(root, v)] if v.is_a?(OpenAPIParser::Schemas::Reference)
-        v.expand_reference(root) if v.is_a?(OpenAPIParser::Expandable)
-
-        nil
+        new_object = expand_object(root, v)
+        new_object.nil? ? nil : [k, new_object]
       end
 
       update_values.compact.each do |k, v|
@@ -27,50 +32,53 @@ module OpenAPIParser::Expandable
         h[k] = v
       end
     end
-  end
 
-  def expand_objects(root, attribute_names)
-    return unless attribute_names
+    def expand_objects(root, attribute_names)
+      return unless attribute_names
 
-    attribute_names.each do |name|
-      v = send(name)
-      next if v.nil?
+      attribute_names.each do |name|
+        v = send(name)
+        next if v.nil?
 
-      if v.is_a?(OpenAPIParser::Schemas::Reference)
-        obj = referenced_object(root, v)
-        _update_child_object(v, obj)
-        self.instance_variable_set("@#{name}", obj)
-      elsif v.is_a?(OpenAPIParser::Expandable)
-        v.expand_reference(root)
+        new_object = expand_object(root, v)
+        next if new_object.nil?
+
+        _update_child_object(v, new_object)
+        self.instance_variable_set("@#{name}", new_object)
       end
     end
-  end
 
-  def expand_list_objects(root, attribute_names)
-    return unless attribute_names
+    def expand_list_objects(root, attribute_names)
+      return unless attribute_names
+
+      attribute_names.each do |name|
+        l = send(name)
+        next if l.nil?
 
-    attribute_names.each do |name|
-      l = send(name)
-      next if l.nil?
+        l.each_with_index do |v, idx|
+          new_object = expand_object(root, v)
+          next if new_object.nil?
 
-      l.each_with_index do |v, idx|
-        if v.is_a?(OpenAPIParser::Schemas::Reference)
-          obj = referenced_object(root, v)
-          _update_child_object(v, obj)
-          l[idx] = obj
-        elsif v.is_a?(OpenAPIParser::Expandable)
-          v.expand_reference(root)
+          _update_child_object(v, new_object)
+          l[idx] = new_object
         end
       end
     end
-  end
 
+    def expand_object(root, object)
+      if object.kind_of?(OpenAPIParser::Schemas::Reference)
+        return referenced_object(root, object)
+      end
+
+      object.expand_reference(root) if object.kind_of?(OpenAPIParser::Expandable)
+      nil
+    end
 
-  # @param [OpenAPIParser::Schemas::OpenAPI] root
-  # @param [OpenAPIParser::Schemas::Reference] reference
-  def referenced_object(root, reference)
-    obj = root.find_object(reference.ref)
+    # @param [OpenAPIParser::Schemas::OpenAPI] root
+    # @param [OpenAPIParser::Schemas::Reference] reference
+    def referenced_object(root, reference)
+      obj = root.find_object(reference.ref)
 
-    obj.is_a?(OpenAPIParser::Schemas::Reference) ? referenced_object(root, obj) : obj
-  end
+      obj.kind_of?(OpenAPIParser::Schemas::Reference) ? referenced_object(root, obj) : obj
+    end
 end

data/lib/openapi_parser/concerns/media_type_selectable.rb

@@ -0,0 +1,26 @@
+module OpenAPIParser::MediaTypeSelectable
+  # select media type by content_type (consider wild card definition)
+  # @param [String] content_type
+  # @param [Hash{String => OpenAPIParser::Schemas::MediaType}] content
+  # @return [OpenAPIParser::Schemas::MediaType, nil]
+  def select_media_type(content_type, content)
+    return nil unless content_type
+
+    if (media_type = content[content_type])
+      return media_type
+    end
+
+    # application/json => [application, json]
+    splited = content_type.split('/')
+
+    if (media_type = content["#{splited.first}/*"])
+      return media_type
+    end
+
+    if (media_type = content['*/*'])
+      return media_type
+    end
+
+    nil
+  end
+end

data/lib/openapi_parser/concerns/parser.rb

@@ -0,0 +1,43 @@
+module OpenAPIParser::Parser
+end
+
+require_relative './parser/core'
+require_relative './schema_loader'
+
+module OpenAPIParser::Parser
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+  module ClassMethods
+    extend Forwardable
+
+    def_delegators :_parser_core, :_openapi_attr_values, :openapi_attr_value, :openapi_attr_values
+    def_delegators :_parser_core, :_openapi_attr_objects, :openapi_attr_objects, :openapi_attr_object
+    def_delegators :_parser_core, :_openapi_attr_list_objects, :openapi_attr_list_object
+    def_delegators :_parser_core, :_openapi_attr_hash_objects, :openapi_attr_hash_object
+    def_delegators :_parser_core, :_openapi_attr_hash_body_objects, :openapi_attr_hash_body_objects
+
+    def _parser_core
+      @_parser_core ||= OpenAPIParser::Parser::Core.new(self)
+    end
+  end
+
+  # @param [OpenAPIParser::Schemas::Base] old
+  # @param [OpenAPIParser::Schemas::Base] new
+  def _update_child_object(old, new)
+    _openapi_all_child_objects[old.object_reference] = new
+  end
+
+  # @return [Hash{String => OpenAPIParser::Schemas::Base}]
+  def _openapi_all_child_objects
+    @_openapi_all_child_objects ||= {}
+  end
+
+  # load data by schema definition in core and set children to _openapi_all_child_objects
+  # @return nil
+  def load_data
+    loader = ::OpenAPIParser::SchemaLoader.new(self, self.class._parser_core)
+    @_openapi_all_child_objects = loader.load_data
+    nil
+  end
+end

data/lib/openapi_parser/concerns/parser/core.rb

@@ -0,0 +1,21 @@
+require_relative './value'
+require_relative './object'
+require_relative './list'
+require_relative './hash'
+require_relative './hash_body'
+
+class OpenAPIParser::Parser::Core
+  include OpenAPIParser::Parser::Value
+  include OpenAPIParser::Parser::Object
+  include OpenAPIParser::Parser::List
+  include OpenAPIParser::Parser::Hash
+  include OpenAPIParser::Parser::HashBody
+
+  def initialize(target_klass)
+    @target_klass = target_klass
+  end
+
+  private
+
+    attr_reader :target_klass
+end

data/lib/openapi_parser/concerns/parser/hash.rb

@@ -0,0 +1,10 @@
+module OpenAPIParser::Parser::Hash
+  def _openapi_attr_hash_objects
+    @_openapi_attr_hash_objects ||= {}
+  end
+
+  def openapi_attr_hash_object(name, klass, options = {})
+    target_klass.send(:attr_reader, name)
+    _openapi_attr_hash_objects[name] = ::OpenAPIParser::SchemaLoader::HashObjectsLoader.new(name, options.merge(klass: klass))
+  end
+end

data/lib/openapi_parser/concerns/parser/hash_body.rb

@@ -0,0 +1,12 @@
+module OpenAPIParser::Parser::HashBody
+  def _openapi_attr_hash_body_objects
+    @_openapi_attr_hash_body_objects ||= {}
+  end
+
+  def openapi_attr_hash_body_objects(name, klass, options = {})
+    #options[:reject_keys] = options[:reject_keys] ? options[:reject_keys].map(&:to_s) : []
+
+    target_klass.send(:attr_reader, name)
+    _openapi_attr_hash_body_objects[name] = ::OpenAPIParser::SchemaLoader::HashBodyLoader.new(name, options.merge(klass: klass))
+  end
+end

data/lib/openapi_parser/concerns/parser/list.rb

@@ -0,0 +1,10 @@
+module OpenAPIParser::Parser::List
+  def _openapi_attr_list_objects
+    @_openapi_attr_list_objects ||= {}
+  end
+
+  def openapi_attr_list_object(name, klass, options = {})
+    target_klass.send(:attr_reader, name)
+    _openapi_attr_list_objects[name] = OpenAPIParser::SchemaLoader::ListLoader.new(name, options.merge(klass: klass))
+  end
+end

data/lib/openapi_parser/concerns/parser/object.rb

@@ -0,0 +1,14 @@
+module OpenAPIParser::Parser::Object
+  def _openapi_attr_objects
+    @_openapi_attr_objects ||= {}
+  end
+
+  def openapi_attr_objects(*names, klass)
+    names.each { |name| openapi_attr_object(name, klass) }
+  end
+
+  def openapi_attr_object(name, klass, options = {})
+    target_klass.send(:attr_reader, name)
+    _openapi_attr_objects[name] = OpenAPIParser::SchemaLoader::ObjectsLoader.new(name, options.merge(klass: klass))
+  end
+end

data/lib/openapi_parser/concerns/parser/value.rb

@@ -0,0 +1,14 @@
+module OpenAPIParser::Parser::Value
+  def _openapi_attr_values
+    @_openapi_attr_values ||= {}
+  end
+
+  def openapi_attr_values(*names)
+    names.each { |name| openapi_attr_value(name) }
+  end
+
+  def openapi_attr_value(name, options = {})
+    target_klass.send(:attr_reader, name)
+    _openapi_attr_values[name] = OpenAPIParser::SchemaLoader::ValuesLoader.new(name, options)
+  end
+end