jsapi 0.4.1 → 0.6.0

data/lib/jsapi/meta/openapi/security_scheme/base.rb

@@ -4,7 +4,7 @@ module Jsapi
   module Meta
     module OpenAPI
       module SecurityScheme
-        class Base < Meta::Base
+        class Base < Meta::Base::Model
           ##
           # :attr: description
           # The optional description of the security scheme.

data/lib/jsapi/meta/openapi/security_scheme.rb

@@ -40,7 +40,7 @@ module Jsapi
               raise InvalidArgumentError.new(
                 'type',
                 type,
-                %w[api_key basic http oauth2 open_id_connect]
+                valid_values: %w[api_key basic http oauth2 open_id_connect]
               )
             end
           end

data/lib/jsapi/meta/openapi/server.rb

@@ -4,7 +4,7 @@ module Jsapi
   module Meta
     module OpenAPI
       # Represents a server object.
-      class Server < Base
+      class Server < Meta::Base::Model
         include Extensions
 
         ##

data/lib/jsapi/meta/openapi/server_variable.rb

@@ -4,7 +4,7 @@ module Jsapi
   module Meta
     module OpenAPI
       # Represents a server variable object.
-      class ServerVariable < Base
+      class ServerVariable < Meta::Base::Model
         include Extensions
 
         ##

data/lib/jsapi/meta/openapi/tag.rb

@@ -4,7 +4,7 @@ module Jsapi
   module Meta
     module OpenAPI
       # Represents a tag object.
-      class Tag < Base
+      class Tag < Meta::Base::Model
         include Extensions
 
         ##

data/lib/jsapi/meta/operation.rb

@@ -2,7 +2,7 @@
 
 module Jsapi
   module Meta
-    class Operation < Base
+    class Operation < Base::Model
       include OpenAPI::Extensions
 
       ##
@@ -10,15 +10,6 @@ module Jsapi
       # The optional callbacks. Applies to \OpenAPI 3.0 and higher.
       attribute :callbacks, { String => OpenAPI::Callback }
 
-      ##
-      # :attr: consumed_mime_types
-      # The MIME types consumed by the operation. Applies to \OpenAPI 2.0 only.
-      attribute :consumed_mime_types, [String]
-
-      alias :consumes :consumed_mime_types
-      alias :consumes= :consumed_mime_types=
-      alias :add_consumes :add_consumed_mime_type
-
       ##
       # :attr: deprecated
       # Specifies whether or not the operation is deprecated.
@@ -51,8 +42,7 @@ module Jsapi
 
       ##
       # :attr: model
-      # The model class to access top-level parameters by. The default model class
-      # is Model::Base.
+      # The model class to access top-level parameters by. Model::Base by default.
       attribute :model, Class, default: Model::Base
 
       ##
@@ -70,15 +60,6 @@ module Jsapi
       # The relative path of the operation.
       attribute :path, String
 
-      ##
-      # :attr: consumed_mime_types
-      # The MIME types produced by the operation. Applies to \OpenAPI 2.0 only.
-      attribute :produced_mime_types, [String]
-
-      alias :produces :produced_mime_types
-      alias :produces= :produced_mime_types=
-      alias :add_produces :add_produced_mime_type
-
       ##
       # :attr: request_body
       # The request body of the operation.
@@ -120,7 +101,7 @@ module Jsapi
 
       ##
       # :attr: tags
-      # The tags. Tags are used to group operations in an \OpenAPI document.
+      # The tags used to group operations in an \OpenAPI document.
       attribute :tags, [String]
 
       def initialize(name = nil, keywords = {})
@@ -132,6 +113,18 @@ module Jsapi
         (@parameters ||= {})[name.to_s] = Parameter.new(name, keywords)
       end
 
+      # Returns the MIME type consumed by the operation.
+      def consumes(definitions)
+        request_body&.resolve(definitions)&.content_type
+      end
+
+      # Returns an array containing the MIME types produced by the operation.
+      def produces(definitions)
+        responses.values.filter_map do |response|
+          response.resolve(definitions).content_type
+        end.uniq.sort
+      end
+
       # Returns a hash representing the \OpenAPI operation object.
       def to_openapi(version, definitions)
         version = OpenAPI::Version.from(version)
@@ -146,8 +139,12 @@ module Jsapi
           security: security_requirements&.map(&:to_openapi)
         ).tap do |hash|
           if version.major == 2
-            hash[:consumes] = consumed_mime_types if consumed_mime_types
-            hash[:produces] = produced_mime_types if produced_mime_types
+            if (consumes = consumes(definitions)).present?
+              hash[:consumes] = [consumes]
+            end
+            if (produces = produces(definitions)).present?
+              hash[:produces] = produces
+            end
             hash[:schemes] = schemes if schemes
           elsif servers
             hash[:servers] = servers.map(&:to_openapi)

data/lib/jsapi/meta/parameter/model.rb

@@ -3,9 +3,11 @@
 module Jsapi
   module Meta
     module Parameter
-      class Model < Base
+      class Model < Base::Model
         include OpenAPI::Extensions
 
+        delegate_missing_to :schema
+
         ##
         # :attr: deprecated
         # Specifies whether or not the parameter is deprecated.
@@ -25,11 +27,12 @@ module Jsapi
         # :attr: in
         # The location of the parameter. Possible values are:
         #
+        # - <code>"header"</code>
         # - <code>"path"</code>
         # - <code>"query"</code>
         #
         # The default location is <code>"query"</code>.
-        attribute :in, String, values: %w[path query], default: 'query'
+        attribute :in, String, values: %w[header path query], default: 'query'
 
         ##
         # :attr_reader: name
@@ -41,8 +44,6 @@ module Jsapi
         # The Schema of the parameter.
         attribute :schema, writer: false
 
-        delegate_missing_to :schema
-
         # Creates a new parameter.
         #
         # Raises an +ArgumentError+ if +name+ is blank.
@@ -124,7 +125,7 @@ module Jsapi
         private
 
         def explode_object_parameter(name, schema, version, definitions, **options)
-          schema.resolve_properties(:read, definitions).values.flat_map do |property|
+          schema.resolve_properties(definitions, context: :request).values.flat_map do |property|
             property_schema = property.schema.resolve(definitions)
             parameter_name = "#{name}[#{property.name}]"
 

data/lib/jsapi/meta/parameter/reference.rb

@@ -3,7 +3,7 @@
 module Jsapi
   module Meta
     module Parameter
-      class Reference < BaseReference
+      class Reference < Base::Reference
         # Returns an array of hashes. Each element represents an \OpenAPI parameter object
         # if the type of the referred parameter is <code>"object"</code>. Otherwise the
         # array contains a single hash representing the \OpenAPI reference object.

data/lib/jsapi/meta/property.rb

@@ -2,7 +2,9 @@
 
 module Jsapi
   module Meta
-    class Property < Base
+    class Property < Base::Model
+      delegate_missing_to :schema
+
       ##
       # :attr_reader: name
       # The name of the property.
@@ -19,15 +21,13 @@ module Jsapi
 
       ##
       # :attr: source
-      # The alternative method to read a property value when serializing an object.
-      attribute :source, Symbol
+      # The alternative Callable used to read property values.
+      attribute :source, Callable
 
       ##
       # :attr: write_only
       attribute :write_only, values: [true, false]
 
-      delegate_missing_to :schema
-
       # Creates a new property.
       #
       # Raises an +ArgumentError+ if +name+ is blank.
@@ -43,6 +43,12 @@ module Jsapi
         @schema = Schema.new(keywords)
       end
 
+      # Returns the Callable used to read a property value. By default, a property value is
+      # read by calling the method whose name matches the property name.
+      def reader
+        source || (@reader ||= Callable.from(name.underscore.to_sym))
+      end
+
       # Returns true if the level of existence is greater than or equal to +ALLOW_NIL+,
       # false otherwise.
       def required?

data/lib/jsapi/meta/request_body/model.rb

@@ -3,9 +3,16 @@
 module Jsapi
   module Meta
     module RequestBody
-      class Model < Base
+      class Model < Base::Model
         include OpenAPI::Extensions
 
+        delegate_missing_to :schema
+
+        ##
+        # :attr: content_type
+        # The content type. <code>"application/json"</code> by default.
+        attribute :content_type, String, default: 'application/json'
+
         ##
         # :attr: description
         # The optional description of the request body.
@@ -21,11 +28,9 @@ module Jsapi
         # The Schema of the request body.
         attribute :schema, writer: false
 
-        delegate_missing_to :schema
-
         def initialize(keywords = {})
           keywords = keywords.dup
-          super(keywords.extract!(:description, :examples))
+          super(keywords.extract!(:content_type, :description, :examples))
 
           add_example(value: keywords.delete(:example)) if keywords.key?(:example)
           keywords[:ref] = keywords.delete(:schema) if keywords.key?(:schema)
@@ -54,7 +59,7 @@ module Jsapi
           with_openapi_extensions(
             description: description,
             content: {
-              'application/json' => {
+              content_type => {
                 schema: schema.to_openapi(version),
                 examples: examples&.transform_values(&:to_openapi)
               }.compact

data/lib/jsapi/meta/request_body/reference.rb

@@ -3,7 +3,7 @@
 module Jsapi
   module Meta
     module RequestBody
-      class Reference < BaseReference
+      class Reference < Base::Reference
         # Returns a hash representing the \OpenAPI reference object.
         def to_openapi(*)
           { '$ref': "#/components/requestBodies/#{ref}" }

data/lib/jsapi/meta/response/model.rb

@@ -3,9 +3,16 @@
 module Jsapi
   module Meta
     module Response
-      class Model < Base
+      class Model < Base::Model
         include OpenAPI::Extensions
 
+        delegate_missing_to :schema
+
+        ##
+        # :attr: content_type
+        # The content type. <code>"application/json"</code> by default.
+        attribute :content_type, String, default: 'application/json'
+
         ##
         # :attr: description
         # The optional description of the response.
@@ -36,11 +43,9 @@ module Jsapi
         # The Schema of the response.
         attribute :schema, writer: false
 
-        delegate_missing_to :schema
-
         def initialize(keywords = {})
           keywords = keywords.dup
-          super(keywords.extract!(:description, :examples, :locale))
+          super(keywords.extract!(:content_type, :description, :examples, :locale))
 
           add_example(value: keywords.delete(:example)) if keywords.key?(:example)
           keywords[:ref] = keywords.delete(:schema) if keywords.key?(:schema)
@@ -62,7 +67,7 @@ module Jsapi
                 end&.compact,
                 examples: (
                   if (example = examples&.values&.first).present?
-                    { 'application/json' => example.resolve(definitions).value }
+                    { content_type => example.resolve(definitions).value }
                   end
                 )
               }
@@ -70,7 +75,7 @@ module Jsapi
               {
                 description: description,
                 content: {
-                  'application/json' => {
+                  content_type => {
                     schema: schema.to_openapi(version),
                     examples: examples&.transform_values(&:to_openapi)
                   }.compact

data/lib/jsapi/meta/response/reference.rb

@@ -3,7 +3,7 @@
 module Jsapi
   module Meta
     module Response
-      class Reference < BaseReference
+      class Reference < Base::Reference
         # Returns a hash representing the \OpenAPI reference object.
         def to_openapi(version, *)
           version = OpenAPI::Version.from(version)

data/lib/jsapi/meta/schema/additional_properties.rb

@@ -3,19 +3,20 @@
 module Jsapi
   module Meta
     module Schema
-      class AdditionalProperties < Meta::Base
-        #
+      class AdditionalProperties < Meta::Base::Model
+        delegate_missing_to :schema
+
+        ##
         # :attr: schema
         # The Schema of additional properties.
         attribute :schema, Schema, writer: false
 
         ##
         # :attr: source
-        # The method to read additional properties when serializing an object.
-        # The default method is +additional_properties+.
-        attribute :source, Symbol, default: :additional_properties
-
-        delegate_missing_to :schema
+        # The Callable used to read additional properties. By default, additional properties
+        # are read by calling the +additional_properties+ method or retrieving the value
+        # assigned to the +:additional_properties+ key.
+        attribute :source, Callable, default: Callable.from(:additional_properties)
 
         def initialize(keywords = {})
           keywords = keywords.dup

data/lib/jsapi/meta/schema/base.rb

@@ -3,15 +3,9 @@
 module Jsapi
   module Meta
     module Schema
-      class Base < Meta::Base
+      class Base < Meta::Base::Model
         include OpenAPI::Extensions
 
-        TYPES = %w[array boolean integer number object string].freeze # :nodoc:
-
-        TYPES.each do |type|
-          define_method("#{type}?") { self.type == type }
-        end
-
         ##
         # :attr: default
         # The default value.
@@ -69,6 +63,13 @@ module Jsapi
           super(keywords)
         end
 
+        # Returns the default value within +context+.
+        def default_value(definitions = nil, context: nil)
+          return default unless default.nil?
+
+          definitions&.default_value(type, context: context)
+        end
+
         def enum=(value) # :nodoc:
           add_validation('enum', Validation::Enum.new(value))
           @enum = value
@@ -79,6 +80,11 @@ module Jsapi
           existence <= Existence::ALLOW_NIL
         end
 
+        # Returns true if and only if values can be omitted.
+        def omittable?
+          existence <= Existence::ALLOW_OMITTED
+        end
+
         # Returns a hash representing the \JSON \Schema object.
         def to_json_schema
           {

data/lib/jsapi/meta/schema/delegator.rb

@@ -5,11 +5,11 @@ module Jsapi
     module Schema
       # Used by Reference to delegate method calls to the referred schema.
       class Delegator
+        delegate_missing_to :@schema
+
         # The level of Existence.
         attr_reader :existence
 
-        delegate_missing_to :@schema
-
         def initialize(schema, existence)
           @schema = schema
           @existence = existence

data/lib/jsapi/meta/schema/discriminator.rb

@@ -3,23 +3,15 @@
 module Jsapi
   module Meta
     module Schema
-      class Discriminator < Meta::Base
+      class Discriminator < Meta::Base::Model
         ##
         # :attr: mappings
-        attribute :mappings, { String => String }
+        attribute :mappings, { Object => String }
 
         ##
         # :attr: property_name
         attribute :property_name, String
 
-        # Looks up the inherriting schema for +value+ in +definitions+.
-        def resolve(value, definitions)
-          schema = definitions.schema(mapping(value) || value)
-          raise "inherriting schema not found: #{value.inspect}" unless schema
-
-          schema.resolve(definitions)
-        end
-
         # Returns a hash representing the \OpenAPI discriminator object.
         def to_openapi(version)
           version = OpenAPI::Version.from(version)
@@ -27,7 +19,7 @@ module Jsapi
 
           {
             propertyName: property_name,
-            mapping: mappings
+            mapping: mappings&.transform_keys(&:to_s)
           }.compact
         end
       end

data/lib/jsapi/meta/schema/object.rb

@@ -36,19 +36,42 @@ module Jsapi
           (@properties ||= {})[name.to_s] = Property.new(name, **keywords)
         end
 
-        def resolve_properties(access, definitions)
+        def resolve_properties(definitions, context: nil)
           properties = merge_properties(definitions, [])
 
-          case access
-          when :read
+          case context
+          when :response
             properties.reject { |_k, v| v.write_only? }
-          when :write
+          when :request
             properties.reject { |_k, v| v.read_only? }
           else
             properties
           end
         end
 
+        # Resolves the schema within +context+.
+        #
+        # Raises a +RuntimeError+ when the schema couldn't be resolved.
+        def resolve_schema(object, definitions, context: nil)
+          return self if discriminator.nil?
+
+          properties = resolve_properties(definitions, context: context)
+
+          property = properties[discriminator.property_name]
+          raise InvalidValueError.new('discriminator property',
+                                      discriminator.property_name,
+                                      valid_values: properties.keys) if property.nil?
+
+          value = property.reader.call(object)
+          value = property.default_value(definitions, context: context) if value.nil?
+          raise "#{discriminator.property_name} can't be blank" if value.blank?
+
+          schema = definitions.schema(discriminator.mapping(value) || value)
+          raise "inheriting schema couldn't be found: #{value.inspect}" if schema.nil?
+
+          schema.resolve(definitions).resolve_schema(object, definitions, context: context)
+        end
+
         def to_json_schema # :nodoc:
           super.merge(
             allOf: all_of_references.map(&:to_json_schema).presence,

data/lib/jsapi/meta/schema/reference.rb

@@ -3,7 +3,7 @@
 module Jsapi
   module Meta
     module Schema
-      class Reference < BaseReference
+      class Reference < Base::Reference
         ##
         # :attr: existence
         # The level of Existence. The default level of existence is +ALLOW_OMITTED+.

data/lib/jsapi/meta/schema.rb

@@ -1,24 +1,31 @@
 # frozen_string_literal: true
 
+require_relative 'schema/additional_properties'
 require_relative 'schema/conversion'
 require_relative 'schema/boundary'
 require_relative 'schema/delegator'
+require_relative 'schema/discriminator'
 require_relative 'schema/reference'
+require_relative 'schema/validation'
+
 require_relative 'schema/base'
-require_relative 'schema/boolean'
 require_relative 'schema/array'
+require_relative 'schema/boolean'
 require_relative 'schema/numeric'
 require_relative 'schema/integer'
 require_relative 'schema/number'
-require_relative 'schema/additional_properties'
-require_relative 'schema/discriminator'
 require_relative 'schema/object'
 require_relative 'schema/string'
-require_relative 'schema/validation'
 
 module Jsapi
   module Meta
     module Schema
+      TYPES = %w[array boolean integer number object string].freeze # :nodoc:
+
+      TYPES.each do |type|
+        Base.define_method("#{type}?") { self.type == type }
+      end
+
       class << self
         # Creates a new schema model or reference. The +:type+ keyword determines
         # the type of the schema to be created. Possible types are:
@@ -51,7 +58,7 @@ module Jsapi
           when 'string'
             String
           else
-            raise InvalidArgumentError.new('type', type, Base::TYPES)
+            raise InvalidArgumentError.new('type', type, valid_values: TYPES)
           end.new(keywords.except(:type))
         end
       end

data/lib/jsapi/meta.rb

@@ -1,12 +1,11 @@
 # frozen_string_literal: true
 
-require_relative 'meta/invalid_argument_error'
 require_relative 'meta/reference_error'
-require_relative 'meta/attributes'
+require_relative 'meta/callable'
+require_relative 'meta/existence'
 require_relative 'meta/base'
-require_relative 'meta/base_reference'
+require_relative 'meta/defaults'
 require_relative 'meta/openapi'
-require_relative 'meta/existence'
 require_relative 'meta/property'
 require_relative 'meta/schema'
 require_relative 'meta/request_body'

data/lib/jsapi/model/attributes.rb

@@ -6,16 +6,22 @@ module Jsapi
       extend ActiveSupport::Concern
 
       included do
-        delegate :[], :attribute?, :attributes, to: :nested
+        delegate :[], :additional_attributes, :attribute?, :attributes, to: :nested
       end
 
       def method_missing(*args) # :nodoc:
-        name = args.first
-        attribute?(name) ? self[name] : super
+        name = args.first.to_s
+        _attr_readers.key?(name) ? _attr_readers[name] : super
       end
 
       def respond_to_missing?(param1, _param2) # :nodoc:
-        attribute?(param1) ? true : super
+        _attr_readers.key?(param1.to_s) ? true : super
+      end
+
+      private
+
+      def _attr_readers
+        @_attr_readers ||= attributes.transform_keys(&:underscore)
       end
     end
   end

data/lib/jsapi/model/base.rb

@@ -22,7 +22,7 @@ module Jsapi
       end
 
       def inspect # :nodoc:
-        "#<#{self.class.name} " \
+        "#<#{self.class.name}#{' ' if attributes.any?}" \
         "#{attributes.map { |k, v| "#{k}: #{v.inspect}" }.join(', ')}>"
       end