openapi_parser_firetail 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b580aba6c2c13cc921baea19d6404cefa07009d1167a1274735e6e836658d725
+  data.tar.gz: 9793c88ea20858b72b68918bb6b4a99b5f1ce6af3051db1cb1ca7d37b9265fb4
+SHA512:
+  metadata.gz: 964b669bc097f851d62669e45c637302a312562611b2f3475cb530d3a6b07cbab65fb182db7b9b42432dc43cb5b836f34d2b3e37966919acc449178df3dfb43f
+  data.tar.gz: d8df564537cc69f4fcee809e66889c201b8dab5942f312fbd1dd68e7dd379655350dce51286cf2c60868b4cdcb098f52614f9c036bf6c975937656a8eae1b65c

data/.github/workflows/ci.yaml

@@ -0,0 +1,25 @@
+name: ci
+on: [push]
+jobs:
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        os:
+          - ubuntu-latest
+          - macos-latest
+        ruby:
+          - "2.6"
+          - "2.7"
+          - "3.0"
+          - "3.1"
+          - "3.2"
+          - ruby-head
+    runs-on: ${{ matrix.os }}
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+    - run: bundle exec rake

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# RubyMine
+.idea
+
+# rspec failure tracking
+.rspec_status
+Gemfile.lock

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,13 @@
+inherit_gem:
+  fincop:
+    # - 'config/rails.yml'
+    - 'config/rspec.yml'
+    - 'config/rubocop.yml'
+     # 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/.ruby-version

@@ -0,0 +1 @@
+3.1.0

data/CHANGELOG.md

@@ -0,0 +1,132 @@
+## Unreleased
+
+## 1.0.0 (2021-02-03)
+### Added
+* Add date-time format validation #126
+
+## 1.0.0.beta1 (2021-12-15)
+### Added
+* Add strict_reference_validation config and implementation to address/implement #29 #123
+
+## 0.15.0 (2021-09-27)
+### Added
+* support: relative file path escape. #117
+
+## 0.14.1 (2021-07-9)
+### Fixed
+* Fix bug for using path parameter and coerce option #115
+
+## 0.14.0 (2021-05-24)
+
+### Added
+* Add basic polymorphism handling #103
+* Support empty schema as any type #109
+* Add date format validation for string #102
+
+### Fixed
+* Fix anyOf coercion to float and integer when value is a non-string type #110
+
+## 0.13.0 (2021-05-01)
+* Fix a problem with remote reference to path items which have path parameters #95
+* Support enum for booleans. #104
+
+## 0.12.1 (2020-08-27)
+* Use CGI.unescape (warning fix) #92
+
+## 0.12.0 (2020-08-26)
+* Find path by extracted params than path length #84
+* Unescape ref URI before lookup in OpenAPIParser::Findable #85
+* Improved path parameter matching code to allow file extensions, multiple parameters inside one path element, etc #90
+
+## 0.11.2 (2020-05-23)
+* Allow date and time content in YAML #81
+
+## 0.11.1 (2020-05-09)
+* fix too many warning
+
+## 0.11.0 (2020-05-09)
+* Add committee friendly interface to use remote references. #74
+* Prevent SystemStackError on recursive schema reference #76
+* support newest ruby versions #78
+
+## 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
+
+## 0.8.0 (2020-01-21)
+* Append the example to the Pattern validator error message #64
+
+## 0.7.0 (2020-01-15)
+* Avoid potential `.send(:exit)` #58
+* Improve PathItemFinder #44
+
+## 0.6.1 (2019-10-12)
+* Bugfix: validate non-nullable response header #54
+* Improve grammar in error messages #55
+* fix object validator in case of properties missing #56
+
+## 0.6.0 (2019-10-05)
+* add email format validation on string #51
+
+## 0.5.0 (2019-09-28)
+* Add max and min length validators for string. #45
+* Support for minItems and maxItems in array #49
+
+## 0.4.1 (2019-07-27)
+* release missed
+
+## 0.4.0 (2019-07-27)
+* Add minimum and maximum checks for `integer` and `number` data types (#43)
+
+## 0.3.1 (2019-06-04)
+* Add additionalProperties default value (#40)
+
+## 0.3.0 (2019-06-01)
+
+### features
+* Perform a strict check on object properties (#33)
+
+### Bugfix
+* Support discriminator without mapping (#35)
+* Fix upper case request param validation (#38)
+
+## 0.2.7 (2019-05-20)
+* Fix for release miss
+
+## 0.2.6 (2019-05-20)
+* Add support for discriminator (#32)
+
+## 0.2.5 (2019-04-12)
+* Support one of validator (#26)
+
+## 0.2.3 (2019-03-18)
+* validate_header_parameter support case incentive (#25)
+
+## 0.2.2 (2019-01-06)
+* bugfix for datetime validate (#20)
+
+## 0.2.1 (2019-01-03)
+* raise error when invalid datetime format (#19)
+
+## 0.2.0 (2019-01-02)
+* support header validate (#18)
+
+## 0.1.9 (2019-01-01)
+* add strict option (#17)
+
+## 0.1.8 (2018-12-31)
+* add select_media_type method(#16)
+
+## 0.1.7 (2018-12-30)
+* Float value validate bugfix (#15)
+
+## 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/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at ota42y@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in openapi_parser.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 ota42y
+
+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,112 @@
+# OpenAPI Parser
+[![ci](https://github.com/ota42y/openapi_parser/actions/workflows/ci.yaml/badge.svg)](https://github.com/ota42y/openapi_parser/actions/workflows/ci.yaml)
+[![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)
+[![Inch CI](https://inch-ci.org/github/ota42y/openapi_parser.svg?branch=master)](https://inch-ci.org/github/ota42y/openapi_parser)
+
+This is OpenAPI3 parser and validator. 
+
+## 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
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'openapi_parser'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install openapi_parser
+
+## Additional features
+OpenAPI Parser's validation based on [OpenAPI spec](https://github.com/OAI/OpenAPI-Specification)  
+But we support few useful features.
+
+### type validation
+We support additional type validation.
+
+|type|format|description|
+|---|---|---|
+|string|uuid|validate uuid string. But we don't check uuid layout|
+
+### Reference Validation on Schema Load
+Invalid references (missing definitions, typos, etc.) can cause validation to fail in runtime,
+and these errors can be difficult to debug (see: https://github.com/ota42y/openapi_parser/issues/29).
+
+Pass the `strict_reference_validation: true` option to detect invalid references.
+An `OpenAPIError::MissingReferenceError` exception will be raised when a reference cannot be resolved.
+
+If the `expand_reference` configuration is explicitly `false` (default is `true`), then
+this configuration has no effect.
+
+DEPRECATION NOTICE: To maintain compatibility with the previous behavior, this version sets `false` as a default.
+This behavior will be changed to `true` in a later version, so you should explicitly pass `strict_reference_validation: false`
+if you wish to keep the old behavior (and please let the maintainers know your use-case for this configuration!).
+
+```ruby
+yaml_file = YAML.load_file('open_api_3/schema_with_broken_references.yml')
+options = {
+  coerce_value: true,
+  datetime_coerce_class: DateTime,
+  # This defaults to false (for now) - passing `true` provides load-time validation of refs
+  strict_reference_validation: true
+}
+
+# Will raise with OpenAPIParser::MissingReferenceError
+OpenAPIParser.parse(yaml_file, options)
+```
+
+## ToDo
+- correct schema checker
+- more detailed validator
+
+## 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 tags, 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/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
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the OpenAPIParser project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/openapi_parser/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :steep do
+sh 'steep check'
+end
+
+task :default => [:steep, :spec]

data/Steepfile

@@ -0,0 +1,11 @@
+target :lib do
+  signature "sig"
+  #check "lib"
+
+  check "lib/openapi_parser.rb"
+  check "lib/openapi_parser/config.rb"
+  check "lib/openapi_parser/schema_validator/options.rb"
+  check "lib/openapi_parser/schema_validator/base.rb"
+
+  library 'uri', 'json', 'pathname'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "openapi_parser"
+
+# 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/openapi_parser/concern.rb

@@ -0,0 +1,5 @@
+require_relative 'concerns/parser'
+require_relative 'concerns/findable'
+require_relative 'concerns/expandable'
+require_relative 'concerns/media_type_selectable'
+require_relative 'concerns/parameter_validatable'

data/lib/openapi_parser/concerns/expandable.rb

@@ -0,0 +1,87 @@
+module OpenAPIParser::Expandable
+  # expand refs
+  # @param [OpenAPIParser::Schemas::Base] root
+  # @return nil
+  def expand_reference(root, validate_references)
+    expand_list_objects(root, self.class._openapi_attr_list_objects.keys, validate_references)
+    expand_objects(root, self.class._openapi_attr_objects.keys, validate_references)
+    expand_hash_objects(root, self.class._openapi_attr_hash_objects.keys, validate_references)
+    expand_hash_objects(root, self.class._openapi_attr_hash_body_objects.keys, validate_references)
+    nil
+  end
+
+  private
+
+    def expand_hash_objects(root, attribute_names, validate_references)
+      return unless attribute_names
+
+      attribute_names.each { |name| expand_hash_attribute(root, name, validate_references) }
+    end
+
+    def expand_hash_attribute(root, name, validate_references)
+      h = send(name)
+      return if h.nil?
+
+      update_values = h.map do |k, v|
+        new_object = expand_object(root, v, validate_references)
+        new_object.nil? ? nil : [k, new_object]
+      end
+
+      update_values.compact.each do |k, v|
+        _update_child_object(h[k], v)
+        h[k] = v
+      end
+    end
+
+    def expand_objects(root, attribute_names, validate_references)
+      return unless attribute_names
+
+      attribute_names.each do |name|
+        v = send(name)
+        next if v.nil?
+
+        new_object = expand_object(root, v, validate_references)
+        next if new_object.nil?
+
+        _update_child_object(v, new_object)
+        self.instance_variable_set("@#{name}", new_object)
+      end
+    end
+
+    def expand_list_objects(root, attribute_names, validate_references)
+      return unless attribute_names
+
+      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, validate_references)
+          next if new_object.nil?
+
+          _update_child_object(v, new_object)
+          l[idx] = new_object
+        end
+      end
+    end
+
+    def expand_object(root, object, validate_references)
+      if object.kind_of?(OpenAPIParser::Schemas::Reference)
+        ref_object = referenced_object(root, object)
+        raise OpenAPIParser::MissingReferenceError.new(object.ref) if ref_object.nil? && validate_references
+
+        return ref_object
+      end
+
+      object.expand_reference(root, validate_references) 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)
+
+      obj.kind_of?(OpenAPIParser::Schemas::Reference) ? referenced_object(root, obj) : obj
+    end
+end

data/lib/openapi_parser/concerns/findable.rb

@@ -0,0 +1,54 @@
+require 'cgi'
+require 'uri'
+
+module OpenAPIParser::Findable
+  # @param [String] reference
+  # @return [OpenAPIParser::Findable]
+  def find_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)
+
+    unescaped_reference = CGI.unescape(reference)
+
+    @find_object_cache = {} unless defined? @find_object_cache
+    if (obj = @find_object_cache[unescaped_reference])
+      return obj
+    end
+
+    if (child = _openapi_all_child_objects[unescaped_reference])
+      @find_object_cache[unescaped_reference] = child
+      return child
+    end
+
+    _openapi_all_child_objects.values.each do |c|
+      if (obj = c.find_object(unescaped_reference))
+        @find_object_cache[unescaped_reference] = obj
+        return obj
+      end
+    end
+
+    nil
+  end
+
+  def purge_object_cache
+    @purged = false unless defined? @purged
+
+    return if @purged
+
+    @find_object_cache = {}
+    @purged = true
+
+    _openapi_all_child_objects.values.each(&:purge_object_cache)
+  end
+
+  private
+
+    def find_remote_object(reference)
+      uri, fragment = reference.split("#", 2)
+      reference_uri = URI(uri)
+      reference_uri.fragment = nil
+      root.load_another_schema(reference_uri)&.find_object("##{fragment}")
+    end
+end

data/lib/openapi_parser/concerns/media_type_selectable.rb

@@ -0,0 +1,29 @@
+module OpenAPIParser::MediaTypeSelectable
+  private
+
+    # 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_from_content(content_type, content)
+      return nil unless content_type
+      return nil unless content
+
+      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