yori 0.1.0

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

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require 'yori/schema/v3/components'
+require 'yori/schema/v3/paths'
+
+module Yori
+  module Schema
+    module V3
+      # Provides register_component method
+      class Composer
+        def initialize(id)
+          @id = id
+        end
+
+        attr_reader :id
+
+        Yori::Schema::V3::Components::VALID_COMPONENTS.each do |component|
+          define_method(component) do |key, value = nil, &block|
+            Yori::Schema::V3::Components.register_component(id, component, key, value, &block)
+          end
+        end
+
+        def path(key, value = nil, &block)
+          Yori::Schema::V3::Paths.register_path(id, key, value, &block)
+        end
+
+        class << self
+          def register(id = '', &block)
+            composer = new(id)
+            composer.instance_eval(&block)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Yori
+  module Schema
+    module V3
+      # Contact: Contact information for the exposed API.
+      # @name: The identifying name of the contact person/organization.
+      # @url: The URL pointing to the contact information. MUST be in the format of a URL.
+      # @email: The email address of the contact person/organization. MUST be in the format of an email address.
+      class Contact < Yori::SchemaBase
+        fields :name, :url, :email
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Yori
+  module Schema
+    module V3
+      # Discriminator
+      #   When request bodies or response payloads may be one of a number of different schemas,
+      #   a discriminator object can be used to aid in serialization, deserialization, and validation.
+      #   The discriminator is a specific object in a schema which is used to inform the consumer of the specification of an alternative schema based on the value associated with it.
+      #   When using the discriminator, inline schemas will not be considered.
+      class Discriminator < Yori::SchemaBase
+        # @!method propertyName
+        #   REQUIRED. The name of the property in the payload that will hold the discriminator value.
+        fields :propertyName
+        # @!method mapping
+        #   An object to hold mappings between payload values and schema names or references.
+        hash_field :mapping, :map
+
+        def validate!
+          validate_require_fields!('propertyName')
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Yori
+  module Schema
+    module V3
+      # Encoding: A single encoding definition applied to a single schema property.
+      class Encoding < Yori::SchemaBase
+        # @!method contentType
+        #   The Content-Type for encoding a specific property.
+        #   Default value depends on the property type:
+        #   for string with format being binary - application/octet-stream;
+        #   for other primitive types - text/plain; for object - application/json;
+        #   for array - the default is defined based on the inner type.
+        #   The value can be a specific media type (e.g. application/json), a wildcard media type (e.g. image/*), or a comma-separated list of the two types.
+        # @!method style
+        #   Describes how a specific property value will be serialized depending on its type.
+        #   See Parameter Object for details on the style property. The behavior follows the same values as query parameters, including default values.
+        #   This property SHALL be ignored if the request body media type is not application/x-www-form-urlencoded.
+        # @!method explode
+        #   When this is true, property values of type array or object generate separate parameters for each value of the array, or key-value-pair of the map. For other types of properties this property has no effect.
+        #   When style is form, the default value is true. For all other styles, the default value is false.
+        #   This property SHALL be ignored if the request body media type is not application/x-www-form-urlencoded.
+        # @!method allowReserved
+        #   Determines whether the parameter value SHOULD allow reserved characters, as defined by RFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. The default value is false.
+        #   This property SHALL be ignored if the request body media type is not application/x-www-form-urlencoded.
+        fields :contentType, :style, :explode, :allowReserved
+
+        # headers are defined at yori/schema/v3/header.rb
+        # to avoid circular reference.
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Yori
+  module Schema
+    module V3
+      # Example:
+      # @summary: Short description for the example.
+      # @description: Long description for the example. CommonMark syntax MAY be used for rich text representation.
+      # @value: Embedded literal example. The value field and externalValue field are mutually exclusive. To represent examples of media types that cannot naturally represented in JSON or YAML, use a string value to contain the example, escaping where necessary.
+      # @externalValue: A URL that points to the literal example. This provides the capability to reference examples that cannot easily be included in JSON or YAML documents. The value field and externalValue field are mutually exclusive.
+      class Example < Yori::SchemaBase
+        fields :summary, :description, :value, :externalValue
+
+        def validate!
+          validate_mutually_exclusive_fields!('value', 'externalValue')
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Yori
+  module Schema
+    module V3
+      # ExternalDocumentation: Allows referencing an external resource for extended documentation.
+      # @description: A short description of the target documentation. CommonMark syntax MAY be used for rich text representation.
+      # @url: REQUIRED. The URL for the target documentation. Value MUST be in the format of a URL.
+      class ExternalDocumentation < Yori::SchemaBase
+        fields :description, :url
+
+        def validate!
+          validate_require_fields!('url')
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'yori/schema/v3/parameter'
+
+module Yori
+  module Schema
+    module V3
+      # Header: The Header Object follows the structure of the Parameter Object with the following changes:
+      # 1. name MUST NOT be specified, it is given in the corresponding headers map.
+      # 2. in MUST NOT be specified, it is implicitly in header.
+      # 3. All traits that are affected by the location MUST be applicable to a location of header (for example, style).
+      class Header < Yori::Schema::V3::Parameter
+        def validate!
+          %w[name in].each do |field|
+            raise Yori::Errors::FieldMustNotBeSpecifiedError, "#{field} of Header Object." if key?(field)
+          end
+          validate_schema_or_content!
+        end
+      end
+
+      # ref yori/schema/v3/encoding
+      # partial definition to avoid circular reference.
+      class Encoding < Yori::SchemaBase
+        # @!method headers
+        #   A map allowing additional information to be provided as headers, for example Content-Disposition.
+        #   Content-Type is described separately and SHALL be ignored in this section.
+        #   This property SHALL be ignored if the request body media type is not a multipart.
+        hash_field_block :headers, :header, Yori::Schema::V3::Header
+      end
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'yori/schema/v3/contact'
+require 'yori/schema/v3/license'
+
+module Yori
+  module Schema
+    module V3
+      # Info: The object provides metadata about the API. The metadata MAY be used by the clients if needed, and MAY be presented in editing or documentation generation tools for convenience.
+      # @title: REQUIRED. The title of the application.
+      # @description: A short description of the application. CommonMark syntax MAY be used for rich text representation.
+      # @termsOfService: A URL to the Terms of Service for the API. MUST be in the format of a URL.
+      # @contact: The contact information for the exposed API.
+      # @license: The license information for the exposed API.
+      # @version: REQUIRED. The version of the OpenAPI document (which is distinct from the OpenAPI Specification version or the API implementation version).
+      class Info < Yori::SchemaBase
+        fields :title, :description, :termsOfService, :version
+        field_block :contact, Yori::Schema::V3::Contact
+        field_block :license, Yori::Schema::V3::License
+
+        def validate!
+          validate_require_fields!('title', 'version')
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Yori
+  module Schema
+    module V3
+      # License: License information for the exposed API.
+      # @name: REQUIRED. The license name used for the API.
+      # @url: A URL to the license used for the API. MUST be in the format of a URL.
+      class License < Yori::SchemaBase
+        fields :name, :url
+
+        def validate!
+          validate_require_fields!('name')
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require 'yori/schema/v3/server'
+
+module Yori
+  module Schema
+    module V3
+      # Link:
+      #   The Link object represents a possible design-time link for a response.
+      #   The presence of a link does not guarantee the caller's ability to successfully invoke it,
+      #   rather it provides a known relationship and traversal mechanism between responses and other operations.
+      #   Unlike dynamic links (i.e. links provided in the response payload),
+      #   the OAS linking mechanism does not require link information in the runtime response.
+      #   For computing links, and providing instructions to execute them,
+      #   a runtime expression is used for accessing values in an operation and using them as parameters while invoking the linked operation.
+      class Link < Yori::SchemaBase
+        # @!method operationRef
+        #   A relative or absolute reference to an OAS operation.
+        #   This field is mutually exclusive of the operationId field, and MUST point to an Operation Object.
+        #   Relative operationRef values MAY be used to locate an existing Operation Object in the OpenAPI definition.
+        # @!method operationId
+        #   The name of an existing, resolvable OAS operation, as defined with a unique operationId.
+        #   This field is mutually exclusive of the operationRef field.
+        fields :operationRef, :operationId
+        # @!method parameters
+        #   A map representing parameters to pass to an operation as specified with operationId or identified via operationRef.
+        #   The key is the parameter name to be used, whereas the value can be a constant or an expression to be evaluated and passed to the linked operation.
+        #   The parameter name can be qualified using the parameter location [{in}.]{name} for operations that use the same parameter name in different locations (e.g. path.id).
+        hash_field_block :parameters, :parameter, Yori::Schema::Any
+        # @!method requestBody
+        #   A literal value or {expression} to use as a request body when calling the target operation.
+        field_block :requestBody, Yori::Schema::Any
+        # @!method description
+        #   A description of the link. CommonMark syntax MAY be used for rich text representation.
+        fields :description
+        # @!method server
+        #   A server object to be used by the target operation.
+        field_block :server, Yori::Schema::V3::Server
+
+        def validate!
+          validate_mutually_exclusive_fields!('operationId', 'operationRef')
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'yori/schema/v3/example'
+require 'yori/schema/v3/encoding'
+
+module Yori
+  module Schema
+    module V3
+      # MediaType: Each Media Type Object provides schema and examples for the media type identified by its key.
+      class MediaType < Yori::SchemaBase
+        # @!method schema
+        #   The schema defining the type used for the request body.
+        field_block :schema, Yori::Schema::V3::Schema
+
+        # @!method example_any
+        #   Example of the media type. The example object SHOULD be in the correct format as specified by the media type.
+        #   The example object is mutually exclusive of the examples object. Furthermore, if referencing a schema which contains an example,
+        #   the example value SHALL override the example provided by the schema.
+        def example_any(value)
+          self['example'] = value
+        end
+
+        # @!method examples
+        #   Examples of the media type. Each example object SHOULD match the media type and specified schema if present.
+        #   The examples object is mutually exclusive of the example object. Furthermore, if referencing a schema which contains an example,
+        #   the examples value SHALL override the example provided by the schema.
+        hash_field_block :examples, :example, Yori::Schema::V3::Example
+        # @!method encoding
+        #   A map between a property name and its encoding information. The key, being the property name, MUST exist in the schema as a property.
+        #   The encoding object SHALL only apply to requestBody objects when the media type is multipart or application/x-www-form-urlencoded.
+        hash_field_block :encoding, :property, Yori::Schema::V3::Encoding
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Yori
+  module Schema
+    module V3
+      # OAuthFlow: Configuration details for a supported OAuth Flow
+      class OAuthFlow < Yori::SchemaBase
+        # @!method authorizationUrl
+        #   REQUIRED. The authorization URL to be used for this flow. This MUST be in the form of a URL.
+        # @!method tokenUrl
+        #   REQUIRED. The token URL to be used for this flow. This MUST be in the form of a URL.
+        # @!method refreshUrl
+        #   The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL.
+        fields :authorizationUrl, :tokenUrl, :refreshUrl
+
+        # @!method scopes
+        #   REQUIRED. The available scopes for the OAuth2 security scheme.
+        #   A map between the scope name and a short description for it.
+        def scopes(&block)
+          self['scopes'] = {}
+          instance_eval(&block)
+        end
+
+        def scope(key, value)
+          self['scopes'] ||= {}
+          self['scopes'][key.to_s] = value.to_s
+        end
+
+        def validate!
+          validate_require_fields!('scopes')
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require 'yori/schema/v3/oauth_flow'
+
+module Yori
+  module Schema
+    module V3
+      # OAuthFlows: Allows configuration of the supported OAuth Flows.
+      class OAuthFlows < Yori::SchemaBase
+        # @!method implicit
+        #   Configuration for the OAuth Implicit flow
+        field_block :implicit, Yori::Schema::V3::OAuthFlow
+        # @!method password
+        #   Configuration for the OAuth Resource Owner Password flow
+        field_block :password, Yori::Schema::V3::OAuthFlow
+        # @!method clientCredentials
+        #   Configuration for the OAuth Client Credentials flow.
+        #   Previously called application in OpenAPI 2.0.
+        field_block :clientCredentials, Yori::Schema::V3::OAuthFlow
+        # @!method authorizationCode
+        #   Configuration for the OAuth Authorization Code flow.
+        #   Previously called accessCode in OpenAPI 2.0.
+        field_block :authorizationCode, Yori::Schema::V3::OAuthFlow
+
+        def validate!
+          %w[implicit clientCredentials authorizationCode].each do |field|
+            validate_flow!(field)
+          end
+        end
+
+        def validate_flow!(flow)
+          oauth_flow = self[flow]
+          oauth_flow&.validate_require_fields!(*required_flow_fields(flow))
+        end
+
+        def required_flow_fields(flow)
+          case flow
+          when 'implicit'
+            %w[authorizationUrl]
+          when 'clientCredentials'
+            %w[tokenUrl]
+          when 'authorizationCode'
+            %w[authorizationUrl tokenUrl]
+          else
+            []
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require 'yori/schema/v3/info'
+require 'yori/schema/v3/server'
+require 'yori/schema/v3/paths'
+require 'yori/schema/v3/components'
+require 'yori/schema/v3/security_requirement'
+require 'yori/schema/v3/tag'
+require 'yori/schema/v3/external_documentation'
+
+module Yori
+  module Schema
+    module V3
+      # OpenAPI
+      #   This is the root document object of the OpenAPI document.
+      class OpenAPI < Yori::SchemaBase
+        # @!method openapi
+        #   REQUIRED. This string MUST be the semantic version number of the OpenAPI Specification version that the OpenAPI document uses.
+        #   The openapi field SHOULD be used by tooling specifications and clients to interpret the OpenAPI document.
+        #   This is not related to the API info.version string.
+        fields :openapi
+        # @!method info
+        #   REQUIRED. Provides metadata about the API.
+        #   The metadata MAY be used by tooling as required.
+        field_block :info, Yori::Schema::V3::Info
+        # @!method servers
+        #   An array of Server Objects, which provide connectivity information to a target server.
+        #   If the servers property is not provided, or is an empty array, the default value would be a Server Object with a url value of /.
+        array_field_block :servers, :server, Yori::Schema::V3::Server
+        # @!method paths
+        #   REQUIRED. The available paths and operations for the API.
+        field_block :paths, Yori::Schema::V3::Paths
+
+        # @!method components
+        #   An element to hold various schemas for the specification.
+        field_block :components, Yori::Schema::V3::Components
+
+        # @!method security
+        #   A declaration of which security mechanisms can be used across the API.
+        #   The list of values includes alternative security requirement objects that can be used.
+        #   Only one of the security requirement objects need to be satisfied to authorize a request.
+        #   Individual operations can override this definition.
+        array_field_block :security, :requirement, Yori::Schema::V3::SecurityRequirement
+        # @!method tags
+        #   A list of tags used by the specification with additional metadata.
+        #   The order of the tags can be used to reflect on their order by the parsing tools.
+        #   Not all tags that are used by the Operation Object must be declared.
+        #   The tags that are not declared MAY be organized randomly or based on the tools' logic.
+        #   Each tag name in the list MUST be unique.
+        array_field_block :tags, :tag, Yori::Schema::V3::Tag
+        # @!method externalDocs
+        #   Additional external documentation.
+        field_block :externalDocs, Yori::Schema::V3::ExternalDocumentation
+
+        def validate!
+          validate_require_fields!('openapi', 'info', 'paths')
+        end
+      end
+    end
+  end
+end