yori 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f29b178020df0e824044f5e9eda902f67379c843
+  data.tar.gz: 18987a92df28fd7d5d95e1b95f91d31f6d97ac06
+SHA512:
+  metadata.gz: 94547a7548d63686ed2ab5121fab368b9deaae1839b0315d0879753e5114bd37b2d33999229e866fdbbdfcd937a486978c4332ced506df734f43a82317c4fad5
+  data.tar.gz: e14a4fb524e4745b39b35d747f9a7f5a4a794601e214483efa533c23bc580ec5c669cdd9c874dc5f92a7bbdff726f66747695ecd6e46847a4a82bc78e361d186

data/.editorconfig

@@ -0,0 +1,14 @@
+# EditorConfig
+root = true
+
+[{*.rb,*.ru,*.erb,*.slim,*.rake}]
+indent_size = 2
+indent_style = space
+trim_trailing_whitespace = true
+insert_final_newline  = true
+
+[{*.js,*.jsx,*.ts,*.tsx,*.css,*.scss}]
+indent_size = 4
+indent_style = space
+trim_trailing_whitespace = true
+insert_final_newline  = true

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,15 @@
+Metrics/LineLength:
+  Max: 200
+
+Style/StringLiterals:
+  Enabled: false
+
+Metrics/AbcSize:
+  Max: 20
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*.rb
+
+Metrics/MethodLength:
+  Max: 20

data/.ruby-version

@@ -0,0 +1 @@
+2.3.1

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 1.16.6

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 nakakuki.shingo@vareal.co.jp. 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 yori.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    yori (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  yori!
+
+BUNDLED WITH
+   1.16.6

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 nakakuki-shingo
+
+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,44 @@
+# Yori
+
+**Y**et another **O**penAPI **R**uby **I**mplementation.
+
+Inspired by [Swagger::Blocks](https://github.com/fotinakis/swagger-blocks). Supports only OpenAPI V3 or newer.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'yori'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install yori
+
+## Usage
+
+See also [Wiki](https://github.com/yiyenene/yori/wiki).
+Sorry, now under construction...
+
+## 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/yiyenene/yori. 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 Yori project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/yiyenene/yori/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

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

@@ -0,0 +1,16 @@
+require "yori/version"
+require 'yori/schema_validator'
+require "yori/schema_base"
+require "yori/schema/any"
+
+Dir[File.dirname(__FILE__) + '/yori/errors/*.rb'].each { |f| require f }
+
+# Yori: Yet another Openapi Ruby Implementation
+module Yori
+  class << self
+    def v3
+      require 'yori/schema/v3'
+      Yori::Schema::V3
+    end
+  end
+end

data/lib/yori/errors/field_must_not_be_specified_error.rb

@@ -0,0 +1,5 @@
+module Yori
+  module Errors
+    class FieldMustNotBeSpecifiedError < StandardError; end
+  end
+end

data/lib/yori/errors/invalid_schema_error.rb

@@ -0,0 +1,5 @@
+module Yori
+  module Errors
+    class InvalidSchemaError < StandardError; end
+  end
+end

data/lib/yori/errors/missing_required_field_error.rb

@@ -0,0 +1,5 @@
+module Yori
+  module Errors
+    class MissingRequiredFieldError < InvalidSchemaError; end
+  end
+end

data/lib/yori/errors/unknown_component_error.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Yori
+  module Errors
+    class UnknownComponentError < StandardError; end
+  end
+end

data/lib/yori/schema/any.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Yori
+  module Schema
+    # Any: supports any keyword as dsl.
+    class Any < Yori::SchemaBase
+      def respond_to_missing?(*)
+        true
+      end
+
+      def method_missing(name, *args, &block)
+        arg = args.first
+        if arg || block_given?
+          c = self.class.eval_input!(self.class, id, arg, &block)
+          self[name.to_s] = c
+          return self
+        end
+        super
+      end
+    end
+  end
+end

data/lib/yori/schema/v3.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Yori
+  module Schema
+    # OpenApi version 3.0.0
+    module V3
+      Dir[File.dirname(__FILE__) + '/v3/*.rb'].each { |f| require f }
+    end
+  end
+end

data/lib/yori/schema/v3/callback.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Yori
+  module Schema
+    module V3
+      # Callback
+      #   A map of possible out-of band callbacks related to the parent operation.
+      #   Each value in the map is a Path Item Object that describes a set of requests that may be initiated by the API provider and the expected responses.
+      #   The key value used to identify the callback object is an expression, evaluated at runtime, that identifies a URL to use for the callback operation.
+      class Callback < Yori::SchemaBase
+        # defined at PathItem to avoid circular reference.
+      end
+    end
+  end
+end

data/lib/yori/schema/v3/components.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+require 'yori/schema/v3/schema'
+require 'yori/schema/v3/response'
+require 'yori/schema/v3/parameter'
+require 'yori/schema/v3/example'
+require 'yori/schema/v3/request_body'
+require 'yori/schema/v3/header'
+require 'yori/schema/v3/security_scheme'
+require 'yori/schema/v3/link'
+require 'yori/schema/v3/callback'
+
+module Yori
+  module Schema
+    module V3
+      # Components
+      #   Holds a set of reusable objects for different aspects of the OAS.
+      #   All objects defined within the components object will have no effect on the API
+      #   unless they are explicitly referenced from properties outside the components object.
+      class Components < Yori::SchemaBase
+        # @!method schemas An object to hold reusable Schema Objects.
+        hash_field_block :schemas, :schema, Yori::Schema::V3::Schema
+        # @!method responses An object to hold reusable Response Objects.
+        hash_field_block :responses, :response, Yori::Schema::V3::Response
+        # @!method parameters An object to hold reusable Parameter Objects.
+        hash_field_block :parameters, :parameter, Yori::Schema::V3::Parameter
+        # @!method examples An object to hold reusable Example Objects.
+        hash_field_block :examples, :example, Yori::Schema::V3::Example
+        # @!method requestBodies An object to hold reusable Request Body Objects.
+        hash_field_block :requestBodies, :requestBody, Yori::Schema::V3::RequestBody
+        # @!method headers An object to hold reusable Header Objects.
+        hash_field_block :headers, :header, Yori::Schema::V3::Header
+        # @!method securitySchemes An object to hold reusable Security Scheme Objects.
+        hash_field_block :securitySchemes, :securityScheme, Yori::Schema::V3::SecurityScheme
+        # @!method links An object to hold reusable Link Objects.
+        hash_field_block :links, :link, Yori::Schema::V3::Link
+        # @!method callbacks An object to hold reusable Callback Objects.
+        hash_field_block :callbacks, :callback, Yori::Schema::V3::Callback
+
+        def merge_registered!
+          components ||= self.class.registered_components[id]
+          components.flat_map { |_component, procs| procs.values }
+                    .each do |block|
+                      instance_eval(&block)
+                    end
+        end
+
+        VALID_COMPONENTS = %w[schema response parameter example requestBody header securityScheme link callback].freeze
+
+        def check_and_send!(component, key, value, &block)
+          raise Yori::Errors::UnknownComponentError, "Unknown component: #{component}" unless VALID_COMPONENTS.include?(component.to_s)
+          send(component, key, value, &block)
+        end
+
+        class << self
+          def registered_components
+            @registered_components ||= {}
+          end
+
+          def register_component(id, component, key, value = nil, &block)
+            @registered_components ||= {}
+            @registered_components[id] ||= {}
+            @registered_components[id][component.to_s] ||= {}
+            @registered_components[id][component.to_s][key.to_s] = proc { check_and_send!(component, key, value, &block) }
+          end
+        end
+      end
+    end
+  end
+end