yori 0.1.0

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'yori/schema/v3/server_variable'
+
+module Yori
+  module Schema
+    module V3
+      # Server: An object representing a Server.
+      # @url: REQUIRED. A URL to the target host.
+      #   This URL supports Server Variables and MAY be relative, to indicate that the host location is relative to the location where the OpenAPI document is being served.
+      #   Variable substitutions will be made when a variable is named in {brackets}.
+      # @description: An optional string describing the host designated by the URL. CommonMark syntax MAY be used for rich text representation.
+      # @variables: A map between a variable name and its value. The value is used for substitution in the server's URL template.
+      class Server < Yori::SchemaBase
+        fields :url, :description
+        hash_field_block :variables, :variable, Yori::Schema::V3::ServerVariable
+
+        def validate!
+          validate_require_fields!('url')
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Yori
+  module Schema
+    module V3
+      # ServerVariable: An object representing a Server Variable for server URL template substitution.
+      # @enum: An enumeration of string values to be used if the substitution options are from a limited set.
+      # @default: REQUIRED. The default value to use for substitution, and to send, if an alternate value is not supplied.
+      #   Unlike the Schema Object's default, this value MUST be provided by the consumer.
+      # @description: An optional description for the server variable. CommonMark syntax MAY be used for rich text representation.
+      class ServerVariable < Yori::SchemaBase
+        fields :enum, :default, :description
+
+        def validate!
+          validate_require_fields!('default')
+          validate_enum! if key?('enum')
+        end
+
+        def validate_enum!
+          validate_field_value_type!('enum', Array)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'yori/schema/v3/external_documentation'
+
+module Yori
+  module Schema
+    module V3
+      # Tag
+      #   Adds metadata to a single tag that is used by the Operation Object.
+      #   It is not mandatory to have a Tag Object per tag defined in the Operation Object instances.
+      class Tag < Yori::SchemaBase
+        # @!method name
+        #   REQUIRED. The name of the tag.
+        # @!method description
+        #   A short description for the tag.
+        #   CommonMark syntax MAY be used for rich text representation.
+        fields :name, :description
+        # @!method externalDocs
+        #   Additional external documentation for this tag.
+        field_block :externalDocs, Yori::Schema::V3::ExternalDocumentation
+
+        def validate!
+          validate_require_fields!('name')
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Yori
+  module Schema
+    module V3
+      # Xml
+      #   A metadata object that allows for more fine-tuned XML model definitions.
+      #   When using arrays, XML element names are not inferred (for singular/plural forms) and the name property SHOULD be used to add that information.
+      class XML < Yori::SchemaBase
+        # @!method name
+        #   Replaces the name of the element/attribute used for the described schema property.
+        #   When defined within items, it will affect the name of the individual XML elements within the list.
+        #   When defined alongside type being array (outside the items), it will affect the wrapping element and only if wrapped is true.
+        #   If wrapped is false, it will be ignored.
+        # @!method namespace
+        #   The URI of the namespace definition. Value MUST be in the form of an absolute URI.
+        # @!method prefix
+        #   The prefix to be used for the name.
+        # @!method attribute
+        #   Declares whether the property definition translates to an attribute instead of an element. Default value is false.
+        # @!method wrapped
+        #   MAY be used only for an array definition. Signifies whether the array is wrapped (for example, <books><book/><book/></books>) or unwrapped (<book/><book/>).
+        #   Default value is false. The definition takes effect only when defined alongside type being array (outside the items).
+        fields :name, :namespace, :prefix, :attribute, :wrapped
+      end
+    end
+  end
+end

data/lib/yori/schema_base.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+require 'forwardable'
+
+module Yori
+  # Yori::SchemaBase
+  class SchemaBase < Hash
+    extend Forwardable
+
+    def_delegators :validator,
+                   :validate_require_fields!,
+                   :validate_field_value_type!,
+                   :validate_limit_field_values!,
+                   :validate_mutually_exclusive_fields!
+
+    def validator
+      @validator ||= Yori::SchemaValidator.new(self)
+    end
+
+    def validate!; end
+
+    attr_accessor :id
+
+    def ref(value)
+      self['$ref'] = value
+    end
+
+    class << self
+      def eval_input!(klass, id, value = nil, &block)
+        return eval_class!(klass, id, &block) unless value
+
+        case value
+        when String, FalseClass
+          value # pass as a runtime expression
+        when Hash
+          eval_hash!(klass, id, value)
+        else
+          raise 'direct assignment value must be a Hash'
+        end
+      end
+
+      def eval_hash!(klass, id, value)
+        klass[value].tap do |c|
+          raise 'must inherit SchemaBase class' unless c.is_a?(SchemaBase)
+          c.id = id
+          c.validate!
+        end
+      end
+
+      def eval_class!(klass, id, &block)
+        klass.new.tap do |c|
+          raise 'must inherit SchemaBase class' unless c.is_a?(SchemaBase)
+          c.id = id
+          c.instance_eval(&block)
+          c.validate!
+        end
+      end
+
+      private
+
+      def fields(*names)
+        names.each do |name|
+          define_method(name) { |value| self[name.to_s] = value }
+        end
+      end
+
+      def field_block(name, schema_class)
+        define_method(name) do |value = nil, &block|
+          c = self.class.eval_input!(schema_class, id, value, &block)
+          self[name.to_s] = c
+        end
+      end
+
+      def array_field_block(name, item_name, schema_class)
+        define_method(item_name) do |value = nil, &block|
+          c = self.class.eval_input!(schema_class, id, value, &block)
+          self[name.to_s] ||= []
+          self[name.to_s] << c
+        end
+        define_method(name) do |&block|
+          self[name.to_s] = []
+          instance_eval(&block)
+        end
+      end
+
+      def hash_field(name, key_name)
+        define_method(key_name) do |key, value|
+          self[name.to_s] ||= {}
+          self[name.to_s][key.to_s] = value
+        end
+        define_method(name) do |&block|
+          self[name.to_s] = {}
+          instance_eval(&block)
+        end
+      end
+
+      def hash_field_block(name, key_name, schema_class)
+        define_method(key_name) do |key, value = nil, &block|
+          c = self.class.eval_input!(schema_class, id, value, &block)
+          self[name.to_s] ||= {}
+          self[name.to_s][key.to_s] = c
+        end
+        define_method(name) do |&block|
+          self[name.to_s] = {}
+          instance_eval(&block)
+        end
+      end
+    end
+  end
+end

data/lib/yori/schema_validator.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Yori
+  # SchemaValidator: Common validate methods of Schema.
+  class SchemaValidator
+    def initialize(schema)
+      @schema = schema
+    end
+
+    attr_reader :schema
+
+    def validate_require_fields!(*fields)
+      fields.each do |field|
+        next if schema.key?(field)
+        raise Yori::Errors::MissingRequiredFieldError, "#{field} of #{simple_class_name} is Required."
+      end
+    end
+
+    def validate_field_value_type!(field, klass)
+      value = schema[field]
+      return if value.nil? || value.is_a?(klass)
+      raise Yori::Errors::InvalidSchemaError, "value of #{field} is not #{klass}."
+    end
+
+    def validate_limit_field_values!(field, *values)
+      value = schema[field]
+      return if values.include?(value)
+      raise Yori::Errors::InvalidSchemaError, "Valid values of #{field} are #{values.join(', ')}."
+    end
+
+    def validate_mutually_exclusive_fields!(field1, field2)
+      return if schema.key?(field1) ^ schema.key?(field2)
+      raise Yori::Errors::InvalidSchemaError, "#{field1} and #{field2} are mutually exclusive."
+    end
+
+    def simple_class_name
+      schema.class.name.split('::').last
+    end
+  end
+end

data/lib/yori/version.rb

@@ -0,0 +1,3 @@
+module Yori
+  VERSION = "0.1.0"
+end

data/yori.gemspec

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "yori/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "yori"
+  spec.version       = Yori::VERSION
+  spec.authors       = ["nakakuki-shingo"]
+  spec.email         = ["nakakuki.shingo@vareal.co.jp"]
+
+  spec.summary       = "Yet another OpenAPI Ruby Implementation."
+  spec.homepage      = "https://github.com/yiyenene/yori"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+  #   spec.metadata["homepage_uri"] = spec.homepage
+  #   spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
+  #   spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against " \
+  #     "public gem pushes."
+  # end
+
+  # 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_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+
+  spec.required_ruby_version = ">= 2.3.1"
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: yori
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- nakakuki-shingo
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-02-21 00:00:00.000000000 Z
+dependencies:
+- !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'
+description: 
+email:
+- nakakuki.shingo@vareal.co.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/yori.rb
+- lib/yori/errors/field_must_not_be_specified_error.rb
+- lib/yori/errors/invalid_schema_error.rb
+- lib/yori/errors/missing_required_field_error.rb
+- lib/yori/errors/unknown_component_error.rb
+- lib/yori/schema/any.rb
+- lib/yori/schema/v3.rb
+- lib/yori/schema/v3/callback.rb
+- lib/yori/schema/v3/components.rb
+- lib/yori/schema/v3/composer.rb
+- lib/yori/schema/v3/contact.rb
+- lib/yori/schema/v3/discriminator.rb
+- lib/yori/schema/v3/encoding.rb
+- lib/yori/schema/v3/example.rb
+- lib/yori/schema/v3/external_documentation.rb
+- lib/yori/schema/v3/header.rb
+- lib/yori/schema/v3/info.rb
+- lib/yori/schema/v3/license.rb
+- lib/yori/schema/v3/link.rb
+- lib/yori/schema/v3/media_type.rb
+- lib/yori/schema/v3/oauth_flow.rb
+- lib/yori/schema/v3/oauth_flows.rb
+- lib/yori/schema/v3/openapi.rb
+- lib/yori/schema/v3/operation.rb
+- lib/yori/schema/v3/parameter.rb
+- lib/yori/schema/v3/path_item.rb
+- lib/yori/schema/v3/paths.rb
+- lib/yori/schema/v3/request_body.rb
+- lib/yori/schema/v3/response.rb
+- lib/yori/schema/v3/responses.rb
+- lib/yori/schema/v3/root.rb
+- lib/yori/schema/v3/schema.rb
+- lib/yori/schema/v3/security_requirement.rb
+- lib/yori/schema/v3/security_scheme.rb
+- lib/yori/schema/v3/server.rb
+- lib/yori/schema/v3/server_variable.rb
+- lib/yori/schema/v3/tag.rb
+- lib/yori/schema/v3/xml.rb
+- lib/yori/schema_base.rb
+- lib/yori/schema_validator.rb
+- lib/yori/version.rb
+- yori.gemspec
+homepage: https://github.com/yiyenene/yori
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.1
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Yet another OpenAPI Ruby Implementation.
+test_files: []