jsapi 2.1.2 → 3.0

data/lib/jsapi/{meta → definition}/request_body.rb

@@ -5,7 +5,7 @@ require_relative 'request_body/reference'
 require_relative 'request_body/wrapper'
 
 module Jsapi
-  module Meta
+  module Definition
     module RequestBody
       include Model::Wrappable
 

data/lib/jsapi/{meta → definition}/rescue_handler.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Jsapi
-  module Meta
+  module Definition
     # Specifies a rescue handler.
     class RescueHandler < Model::Base
       ##

data/lib/jsapi/{meta → definition}/response/base.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Jsapi
-  module Meta
+  module Definition
     module Response
       # Specifies a response.
       class Base < Model::Base
@@ -98,13 +98,13 @@ module Jsapi
         end
 
         # Returns a hash representing the \OpenAPI response object.
-        def to_openapi(version, definitions)
+        def to_openapi(version, api)
           version = OpenAPI::Version.from(version)
 
           with_openapi_extensions(
             if version == OpenAPI::V2_0
               media_type, content = contents.first
-              example = content&.example_data_value(definitions, locale: locale)
+              example = content&.example_data_value(api, locale: locale)
               {
                 description: description,
                 schema: content&.schema&.to_openapi(version),
@@ -131,7 +131,7 @@ module Jsapi
                       nth_media_type,
                       nth_content.to_openapi(
                         version,
-                        definitions,
+                        api,
                         locale: locale,
                         media_type: nth_media_type
                       )

data/lib/jsapi/{meta → definition}/response/reference.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Jsapi
-  module Meta
+  module Definition
     module Response
       # Refers a reusable response.
       class Reference < Model::Reference

data/lib/jsapi/{meta → definition}/response/wrapper.rb

@@ -1,26 +1,38 @@
 # frozen_string_literal: true
 
 module Jsapi
-  module Meta
+  module Definition
     module Response
       class Wrapper < Model::Wrapper
         # The locale of the wrapped response or reference.
         attr_reader :locale
 
-        def initialize(response, definitions)
-          @locale = response.resolve_lazily(definitions).locale
+        def initialize(response, api)
+          @locale = response.resolve_lazily(api).locale
           super
         end
 
+        def content?
+          contents.lazy.any?
+        end
+
         def contents
-          super.transform_values { |content| Content.wrap(content, definitions) }
+          super.transform_values { |content| Content.wrap(content, api) }
+        end
+
+        def content_for(*media_ranges)
+          media_type_and_content_for(*media_ranges)&.second
+        end
+
+        def header_for(name)
+          (@downcased_headers ||= headers.transform_keys(&:downcase))[name.to_s.downcase]
         end
 
         def media_type_and_content_for(*media_ranges)
           super&.then do |media_type_and_content|
             [
               media_type_and_content.first,
-              Content.wrap(media_type_and_content.second, definitions)
+              Content.wrap(media_type_and_content.second, api)
             ]
           end
         end

data/lib/jsapi/{meta → definition}/response.rb

@@ -5,7 +5,7 @@ require_relative 'response/reference'
 require_relative 'response/wrapper'
 
 module Jsapi
-  module Meta
+  module Definition
     module Response
       include Model::Wrappable
 

data/lib/jsapi/{meta → definition}/schema/additional_properties.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Jsapi
-  module Meta
+  module Definition
     module Schema
       class AdditionalProperties < Model::Base
         include Model::Wrappable
@@ -29,7 +29,7 @@ module Jsapi
 
         class Wrapper < Model::Wrapper
           def schema
-            @schema ||= Schema.wrap(super, definitions)
+            @schema ||= Schema.wrap(super, api)
           end
         end
       end

data/lib/jsapi/{meta → definition}/schema/array.rb

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
 module Jsapi
-  module Meta
+  module Definition
     module Schema
       class Array < Base
         class Wrapper < Schema::Wrapper
           def items
-            @items ||= Schema.wrap(super, definitions)
+            @items ||= Schema.wrap(super, api)
           end
 
           private

data/lib/jsapi/{meta → definition}/schema/base.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Jsapi
-  module Meta
+  module Definition
     module Schema
       TYPES = %w[array boolean integer number object string].freeze # :nodoc:
 

data/lib/jsapi/{meta → definition}/schema/boolean.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Jsapi
-  module Meta
+  module Definition
     module Schema
       class Boolean < Base
         class Wrapper < Schema::Wrapper

data/lib/jsapi/{meta → definition}/schema/boundary.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Jsapi
-  module Meta
+  module Definition
     module Schema
       class Boundary
         # Transforms +value+ to an instance of this class.

data/lib/jsapi/{meta → definition}/schema/conversion.rb

@@ -3,7 +3,7 @@
 require 'active_support/concern'
 
 module Jsapi
-  module Meta
+  module Definition
     module Schema
       module Conversion
         def self.included(base) # :nodoc:

data/lib/jsapi/{meta → definition}/schema/discriminator.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Jsapi
-  module Meta
+  module Definition
     module Schema
       class Discriminator < Model::Base
         include OpenAPI::Extensions

data/lib/jsapi/{meta → definition}/schema/integer.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Jsapi
-  module Meta
+  module Definition
     module Schema
       class Integer < Numeric
         class Wrapper < Schema::Wrapper

data/lib/jsapi/{meta → definition}/schema/number.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Jsapi
-  module Meta
+  module Definition
     module Schema
       class Number < Numeric
         class Wrapper < Schema::Wrapper

data/lib/jsapi/{meta → definition}/schema/numeric.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Jsapi
-  module Meta
+  module Definition
     module Schema
       class Numeric < Base
         include Conversion

data/lib/jsapi/{meta → definition}/schema/object.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Jsapi
-  module Meta
+  module Definition
     module Schema
       class Object < Base
         class Wrapper < Schema::Wrapper
@@ -33,12 +33,12 @@ module Jsapi
           end
 
           def additional_properties
-            AdditionalProperties.wrap(super, definitions)
+            AdditionalProperties.wrap(super, api)
           end
 
           def resolve_properties(context: nil)
-            super(definitions, context: context).transform_values do |property|
-              Property.wrap(property, definitions)
+            super(api, context: context).transform_values do |property|
+              Property.wrap(property, api)
             end
           end
 
@@ -52,7 +52,7 @@ module Jsapi
 
             discriminating_property = properties[discriminator.property_name]
             if discriminating_property.nil?
-              raise Messages.invalid_value(
+              raise Support::Messages.invalid_value(
                 name: 'discriminator property',
                 value: discriminator.property_name,
                 valid_values: properties.keys
@@ -70,10 +70,10 @@ module Jsapi
 
             schema_name = discriminator.mapping(discriminating_value) || discriminating_value
 
-            schema = definitions.find_schema(schema_name)
+            schema = api.find_schema(schema_name)
             if schema.nil?
               default_mapping = discriminator.default_mapping
-              schema = definitions.find_schema(default_mapping) unless default_mapping.nil?
+              schema = api.find_schema(default_mapping) unless default_mapping.nil?
 
               if schema.nil?
                 raise "inheriting schema couldn't be found: " \
@@ -82,7 +82,7 @@ module Jsapi
             end
 
             Wrapper
-              .new(schema.resolve(definitions), definitions)
+              .new(schema.resolve(api), api)
               .resolve_schema(object, context: context)
           end
 
@@ -168,8 +168,8 @@ module Jsapi
           end
         end
 
-        def resolve_properties(definitions, context: nil)
-          properties = merge_properties(definitions, [])
+        def resolve_properties(api, context: nil)
+          properties = merge_properties(api, [])
 
           case context
           when :response
@@ -206,15 +206,15 @@ module Jsapi
 
         protected
 
-        def merge_properties(definitions, path)
+        def merge_properties(api, path)
           return properties unless all_of_references.present?
 
           {}.tap do |properties|
             all_of_references.each do |reference|
-              schema = reference.resolve(definitions)
+              schema = reference.resolve(api)
               raise "circular reference: #{reference.ref}" if schema.in?(path)
 
-              properties.merge!(schema.merge_properties(definitions, path + [self]))
+              properties.merge!(schema.merge_properties(api, path + [self]))
             end
             properties.merge!(self.properties)
           end

data/lib/jsapi/{meta → definition}/schema/reference.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Jsapi
-  module Meta
+  module Definition
     module Schema
       # Refers a reusable schema.
       class Reference < Model::Reference

data/lib/jsapi/{meta → definition}/schema/string.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Jsapi
-  module Meta
+  module Definition
     module Schema
       class String < Base
         include Conversion

data/lib/jsapi/{meta → definition}/schema/validation/base.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Jsapi
-  module Meta
+  module Definition
     module Schema
       module Validation
         class Base

data/lib/jsapi/{meta → definition}/schema/validation/enum.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Jsapi
-  module Meta
+  module Definition
     module Schema
       module Validation
         class Enum < Base

data/lib/jsapi/{meta → definition}/schema/validation/max_items.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Jsapi
-  module Meta
+  module Definition
     module Schema
       module Validation
         class MaxItems < Base

data/lib/jsapi/{meta → definition}/schema/validation/max_length.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Jsapi
-  module Meta
+  module Definition
     module Schema
       module Validation
         class MaxLength < Base

data/lib/jsapi/{meta → definition}/schema/validation/maximum.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Jsapi
-  module Meta
+  module Definition
     module Schema
       module Validation
         class Maximum < Base

data/lib/jsapi/{meta → definition}/schema/validation/min_items.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Jsapi
-  module Meta
+  module Definition
     module Schema
       module Validation
         class MinItems < Base

data/lib/jsapi/{meta → definition}/schema/validation/min_length.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Jsapi
-  module Meta
+  module Definition
     module Schema
       module Validation
         class MinLength < Base

data/lib/jsapi/{meta → definition}/schema/validation/minimum.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Jsapi
-  module Meta
+  module Definition
     module Schema
       module Validation
         class Minimum < Base

data/lib/jsapi/{meta → definition}/schema/validation/multiple_of.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Jsapi
-  module Meta
+  module Definition
     module Schema
       module Validation
         class MultipleOf < Base

data/lib/jsapi/{meta → definition}/schema/validation/pattern.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Jsapi
-  module Meta
+  module Definition
     module Schema
       module Validation
         class Pattern < Base

data/lib/jsapi/{meta → definition}/schema/wrapper.rb

@@ -1,18 +1,32 @@
 # frozen_string_literal: true
 
 module Jsapi
-  module Meta
+  module Definition
     module Schema
+      # Raised when jsonifying an object fails.
+      class JsonifyError < RuntimeError
+        attr_reader :path # :nodoc:
+
+        def message
+          [@path&.delete_prefix('.'), super].compact.join(' ')
+        end
+
+        def prepend(origin) # :nodoc:
+          @path = "#{origin}#{@path}"
+          self
+        end
+      end
+
       class Wrapper < Model::Wrapper
         # The level of existence.
         attr_reader :existence
 
-        def initialize(schema, definitions)
+        def initialize(schema, api)
           @existence =
             [schema.existence].tap do |levels|
               s = schema
               while s.is_a?(Reference)
-                s = s.resolve(definitions, deep: false)
+                s = s.resolve(api, deep: false)
                 levels << s.existence
               end
             end.compact.max || Existence::ALLOW_OMITTED
@@ -23,7 +37,7 @@ module Jsapi
         def default_value(context: nil)
           return default unless default.nil?
 
-          definitions.default_value(type, context: context)
+          api.default_value(type, context: context)
         end
 
         # Generates a JSON value representing +value+.

data/lib/jsapi/{meta → definition}/schema.rb

@@ -18,7 +18,7 @@ require_relative 'schema/object'
 require_relative 'schema/string'
 
 module Jsapi
-  module Meta
+  module Definition
     module Schema
       class << self
         # Creates a new schema. The +:type+ keyword determines the type of the schema to be
@@ -52,7 +52,7 @@ module Jsapi
           when 'string'
             String
           else
-            raise ArgumentError, Messages.invalid_value(
+            raise ArgumentError, Support::Messages.invalid_value(
               name: 'type',
               value: type,
               valid_values: TYPES
@@ -61,13 +61,13 @@ module Jsapi
         end
 
         # Wraps +schema+.
-        def wrap(schema, definitions)
+        def wrap(schema, api)
           return if schema.nil?
           return schema if schema.is_a?(Wrapper)
 
-          "#{schema.resolve(definitions).class.name}::Wrapper"
+          "#{schema.resolve(api).class.name}::Wrapper"
             .constantize
-            .new(schema, definitions)
+            .new(schema, api)
         end
       end
     end

data/lib/jsapi/{meta → definition}/security_requirement.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Jsapi
-  module Meta
+  module Definition
     # Specifies a security requirement.
     class SecurityRequirement < Model::Base
       class Scheme < Model::Base

data/lib/jsapi/{meta → definition}/security_scheme/api_key.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Jsapi
-  module Meta
+  module Definition
     module SecurityScheme
       # Specifies a security scheme based on an API key.
       class APIKey < Base

data/lib/jsapi/{meta → definition}/security_scheme/base.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Jsapi
-  module Meta
+  module Definition
     module SecurityScheme
       class Base < Model::Base
         ##

data/lib/jsapi/{meta → definition}/security_scheme/http/basic.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Jsapi
-  module Meta
+  module Definition
     module SecurityScheme
       module HTTP
         # Specifies a security scheme based on \HTTP basic authentication.

data/lib/jsapi/{meta → definition}/security_scheme/http/bearer.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Jsapi
-  module Meta
+  module Definition
     module SecurityScheme
       module HTTP
         # Specifies a security scheme based on bearer authentication.

data/lib/jsapi/{meta → definition}/security_scheme/http/other.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Jsapi
-  module Meta
+  module Definition
     module SecurityScheme
       module HTTP
         # Specifies a security scheme based on any other \HTTP authentication than basic

data/lib/jsapi/{meta → definition}/security_scheme/http.rb

@@ -5,7 +5,7 @@ require_relative 'http/bearer'
 require_relative 'http/other'
 
 module Jsapi
-  module Meta
+  module Definition
     module SecurityScheme
       module HTTP
         class << self

data/lib/jsapi/{meta → definition}/security_scheme/mutual_tls.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Jsapi
-  module Meta
+  module Definition
     module SecurityScheme
       # Specifies a security scheme based on MutualTLS.
       class MutualTLS < Base

data/lib/jsapi/{meta → definition}/security_scheme/oauth2.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Jsapi
-  module Meta
+  module Definition
     module SecurityScheme
       # Specifies a security scheme based on \OAuth2.
       class OAuth2 < Base

data/lib/jsapi/{meta → definition}/security_scheme/open_id_connect.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Jsapi
-  module Meta
+  module Definition
     module SecurityScheme
       # Specifies a security scheme based on OpenID Connect.
       class OpenIDConnect < Base

data/lib/jsapi/{meta → definition}/security_scheme.rb

@@ -8,7 +8,7 @@ require_relative 'security_scheme/oauth2'
 require_relative 'security_scheme/open_id_connect'
 
 module Jsapi
-  module Meta
+  module Definition
     module SecurityScheme
       class << self
         # Creates a security scheme. The +:type+ keyword specifies the type