jsapi 1.4 → 2.0

data/lib/jsapi/status/code.rb

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+
+module Jsapi
+  module Status
+    # Represents a status code.
+    class Code < Base
+      class << self
+        # Transforms +value+ to an instance of this class.
+        #
+        # Raises an +ArgumentError+ if +value+ could not be transformed.
+        def from(value)
+          return value if value.nil? || value.is_a?(Code)
+
+          code = status_code(value.to_sym) if value.respond_to?(:to_sym)
+          code ||= value.to_i
+          return new(code) if (100..599).cover?(code)
+
+          raise ArgumentError, "invalid status code: #{value.inspect}"
+        end
+
+        def status_code(symbol)
+          symbol_to_code[symbol]
+        end
+
+        private
+
+        def symbol_to_code
+          @symbol_to_code ||= {
+            # Informational
+            100 => :continue,
+            101 => :switching_protocols,
+            102 => :processing,
+            103 => :early_hints,
+
+            # Success
+            200 => :ok,
+            201 => :created,
+            202 => :accepted,
+            203 => :non_authoritative_information,
+            204 => :no_content,
+            205 => :reset_content,
+            206 => :partial_content,
+            207 => :multi_status,
+            208 => :already_reported,
+            226 => :im_used,
+
+            # Redirection
+            300 => :multiple_choices,
+            301 => :moved_permanently,
+            302 => :found,
+            303 => :see_other,
+            304 => :not_modified,
+            307 => :temporary_redirect,
+            308 => :permanent_redirect,
+
+            # Client error
+            400 => :bad_request,
+            401 => :unauthorized,
+            402 => :payment_required,
+            403 => :forbidden,
+            404 => :not_found,
+            405 => :method_not_allowed,
+            406 => :not_acceptable,
+            407 => :proxy_authentication_required,
+            408 => :request_timeout,
+            409 => :conflict,
+            410 => :gone,
+            411 => :length_required,
+            412 => :precondition_failed,
+            413 => :content_too_large,
+            414 => :uri_too_long,
+            415 => :unsupported_media_type,
+            416 => :range_not_satisfiable,
+            417 => :expectation_failed,
+            421 => :misdirected_request,
+            422 => :unprocessable_content,
+            423 => :locked,
+            424 => :failed_dependency,
+            425 => :too_early,
+            426 => :upgrade_required,
+            428 => :precondition_required,
+            429 => :too_many_requests,
+            431 => :request_header_fields_too_large,
+            451 => :unavailable_for_legal_reasons,
+
+            # Server error
+            500 => :internal_server_error,
+            501 => :not_implemented,
+            502 => :bad_gateway,
+            503 => :service_unavailable,
+            504 => :gateway_timeout,
+            505 => :http_version_not_supported,
+            506 => :variant_also_negotiates,
+            507 => :insufficient_storage,
+            508 => :loop_detected,
+            511 => :network_authentication_required
+          }.invert
+        end
+      end
+
+      delegate :to_i, to: :value
+
+      def initialize(value) # :nodoc:
+        super(value, priority: 1)
+      end
+
+      # Returns true if and only if +status_code+ is equal to itself.
+      def match?(status_code)
+        status_code == self
+      end
+    end
+  end
+end

data/lib/jsapi/status/default.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Jsapi
+  module Status
+    # The default status.
+    DEFAULT = Class.new(Base) do
+      def inspect
+        '#<Jsapi::Status::DEFAULT>'
+      end
+
+      def match?(_)
+        true
+      end
+    end.new('default', priority: 3)
+  end
+end

data/lib/jsapi/status/range.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Jsapi
+  module Status
+    # Represents a range of status codes.
+    class Range < Base
+      def initialize(hundreds) # :nodoc:
+        super("#{hundreds}XX", priority: 2)
+
+        range_begin = hundreds * 100
+        @range = (range_begin..(range_begin + 99))
+      end
+
+      # The range of informational status codes (1xx).
+      INFORMATIONAL = Range.new(1)
+
+      # The range of success status codes (2xx).
+      SUCCESS = Range.new(2)
+
+      # The range of redirection status codes (3xx).
+      REDIRECTION = Range.new(3)
+
+      # The range of client error status codes (4xx).
+      CLIENT_ERROR = Range.new(4)
+
+      # The range of server error status codes (5xx).
+      SERVER_ERROR = Range.new(5)
+
+      # Returns true if the range covers +status_code+.
+      def match?(status_code)
+        @range.cover?(status_code.value) if status_code
+      end
+    end
+  end
+end

data/lib/jsapi/status.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative 'status/base'
+require_relative 'status/code'
+require_relative 'status/default'
+require_relative 'status/range'
+
+module Jsapi
+  # Provides classes to deal with response status codes.
+  module Status
+    class << self
+      # Transforms +value+ to an instance of Base.
+      #
+      # Raises an +ArgumentError+ if +value+ could not be transformed.
+      def from(value)
+        return value if value.is_a?(Base)
+
+        case value&.to_s
+        when nil, 'default'
+          DEFAULT
+        when '1XX', '1xx'
+          Range::INFORMATIONAL
+        when '2XX', '2xx'
+          Range::SUCCESS
+        when '3XX', '3xx'
+          Range::REDIRECTION
+        when '4XX', '4xx'
+          Range::CLIENT_ERROR
+        when '5XX', '5xx'
+          Range::SERVER_ERROR
+        else
+          Code.from(value)
+        end
+      end
+    end
+  end
+end

data/lib/jsapi/version.rb

@@ -5,6 +5,6 @@ module Jsapi
     # NOTE: See https://bundler.io/guides/creating_gem.html
 
     # The current GEM version.
-    VERSION = '1.4'
+    VERSION = '2.0'
   end
 end

data/lib/jsapi.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
-require 'jsapi/invalid_value_helper'
-require 'jsapi/invalid_value_error'
-require 'jsapi/invalid_argument_error'
+require 'jsapi/messages'
 require 'jsapi/configuration'
+require 'jsapi/media'
+require 'jsapi/status'
 require 'jsapi/model'
 require 'jsapi/meta'
 require 'jsapi/dsl'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jsapi
 version: !ruby/object:Gem::Version
-  version: '1.4'
+  version: '2.0'
 platform: ruby
 authors:
 - Denis Göller
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-11-15 00:00:00.000000000 Z
+date: 2026-01-18 00:00:00.000000000 Z
 dependencies: []
 description:
 email: denis@dmgoeller.de
@@ -19,18 +19,28 @@ files:
 - lib/jsapi.rb
 - lib/jsapi/configuration.rb
 - lib/jsapi/controller.rb
+- lib/jsapi/controller/actions.rb
+- lib/jsapi/controller/actions/class_methods.rb
+- lib/jsapi/controller/authentication.rb
+- lib/jsapi/controller/authentication/class_methods.rb
+- lib/jsapi/controller/authentication/credentials.rb
+- lib/jsapi/controller/authentication/credentials/api_key.rb
+- lib/jsapi/controller/authentication/credentials/http.rb
+- lib/jsapi/controller/authentication/credentials/http/base.rb
+- lib/jsapi/controller/authentication/credentials/http/basic.rb
+- lib/jsapi/controller/authentication/credentials/http/bearer.rb
 - lib/jsapi/controller/base.rb
 - lib/jsapi/controller/error.rb
 - lib/jsapi/controller/methods.rb
+- lib/jsapi/controller/methods/callbacks.rb
+- lib/jsapi/controller/methods/callbacks/callback.rb
+- lib/jsapi/controller/methods/callbacks/class_methods.rb
 - lib/jsapi/controller/parameters.rb
-- lib/jsapi/controller/parameters_invalid.rb
 - lib/jsapi/controller/response.rb
 - lib/jsapi/dsl.rb
 - lib/jsapi/dsl/base.rb
-- lib/jsapi/dsl/callback.rb
 - lib/jsapi/dsl/class_methods.rb
 - lib/jsapi/dsl/definitions.rb
-- lib/jsapi/dsl/error.rb
 - lib/jsapi/dsl/examples.rb
 - lib/jsapi/dsl/operation.rb
 - lib/jsapi/dsl/parameter.rb
@@ -38,9 +48,7 @@ files:
 - lib/jsapi/dsl/request_body.rb
 - lib/jsapi/dsl/response.rb
 - lib/jsapi/dsl/schema.rb
-- lib/jsapi/invalid_argument_error.rb
-- lib/jsapi/invalid_value_error.rb
-- lib/jsapi/invalid_value_helper.rb
+- lib/jsapi/dsl/shared_operation_methods.rb
 - lib/jsapi/json.rb
 - lib/jsapi/json/array.rb
 - lib/jsapi/json/boolean.rb
@@ -50,6 +58,11 @@ files:
 - lib/jsapi/json/object.rb
 - lib/jsapi/json/string.rb
 - lib/jsapi/json/value.rb
+- lib/jsapi/media.rb
+- lib/jsapi/media/range.rb
+- lib/jsapi/media/type.rb
+- lib/jsapi/media/type_and_subtype.rb
+- lib/jsapi/messages.rb
 - lib/jsapi/meta.rb
 - lib/jsapi/meta/callable.rb
 - lib/jsapi/meta/callable/symbol_evaluator.rb
@@ -58,6 +71,7 @@ files:
 - lib/jsapi/meta/callback/base.rb
 - lib/jsapi/meta/callback/reference.rb
 - lib/jsapi/meta/contact.rb
+- lib/jsapi/meta/content.rb
 - lib/jsapi/meta/defaults.rb
 - lib/jsapi/meta/definitions.rb
 - lib/jsapi/meta/example.rb
@@ -75,9 +89,13 @@ files:
 - lib/jsapi/meta/link/reference.rb
 - lib/jsapi/meta/model.rb
 - lib/jsapi/meta/model/attributes.rb
+- lib/jsapi/meta/model/attributes/class_methods.rb
+- lib/jsapi/meta/model/attributes/frozen_error.rb
+- lib/jsapi/meta/model/attributes/type_caster.rb
 - lib/jsapi/meta/model/base.rb
 - lib/jsapi/meta/model/reference.rb
-- lib/jsapi/meta/model/type_caster.rb
+- lib/jsapi/meta/model/wrappable.rb
+- lib/jsapi/meta/model/wrapper.rb
 - lib/jsapi/meta/oauth_flow.rb
 - lib/jsapi/meta/openapi.rb
 - lib/jsapi/meta/openapi/extensions.rb
@@ -87,6 +105,7 @@ files:
 - lib/jsapi/meta/parameter.rb
 - lib/jsapi/meta/parameter/base.rb
 - lib/jsapi/meta/parameter/reference.rb
+- lib/jsapi/meta/parameter/wrapper.rb
 - lib/jsapi/meta/path.rb
 - lib/jsapi/meta/pathname.rb
 - lib/jsapi/meta/property.rb
@@ -94,10 +113,12 @@ files:
 - lib/jsapi/meta/request_body.rb
 - lib/jsapi/meta/request_body/base.rb
 - lib/jsapi/meta/request_body/reference.rb
+- lib/jsapi/meta/request_body/wrapper.rb
 - lib/jsapi/meta/rescue_handler.rb
 - lib/jsapi/meta/response.rb
 - lib/jsapi/meta/response/base.rb
 - lib/jsapi/meta/response/reference.rb
+- lib/jsapi/meta/response/wrapper.rb
 - lib/jsapi/meta/schema.rb
 - lib/jsapi/meta/schema/additional_properties.rb
 - lib/jsapi/meta/schema/array.rb
@@ -105,7 +126,6 @@ files:
 - lib/jsapi/meta/schema/boolean.rb
 - lib/jsapi/meta/schema/boundary.rb
 - lib/jsapi/meta/schema/conversion.rb
-- lib/jsapi/meta/schema/delegator.rb
 - lib/jsapi/meta/schema/discriminator.rb
 - lib/jsapi/meta/schema/integer.rb
 - lib/jsapi/meta/schema/number.rb
@@ -124,6 +144,7 @@ files:
 - lib/jsapi/meta/schema/validation/minimum.rb
 - lib/jsapi/meta/schema/validation/multiple_of.rb
 - lib/jsapi/meta/schema/validation/pattern.rb
+- lib/jsapi/meta/schema/wrapper.rb
 - lib/jsapi/meta/security_requirement.rb
 - lib/jsapi/meta/security_scheme.rb
 - lib/jsapi/meta/security_scheme/api_key.rb
@@ -144,6 +165,11 @@ files:
 - lib/jsapi/model/errors.rb
 - lib/jsapi/model/nestable.rb
 - lib/jsapi/model/nested_error.rb
+- lib/jsapi/status.rb
+- lib/jsapi/status/base.rb
+- lib/jsapi/status/code.rb
+- lib/jsapi/status/default.rb
+- lib/jsapi/status/range.rb
 - lib/jsapi/version.rb
 homepage: https://github.com/dmgoeller/jsapi
 licenses:

data/lib/jsapi/controller/parameters_invalid.rb

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-
-module Jsapi
-  module Controller
-    # Raised by Methods#api_operation! when the request parameters are invalid.
-    class ParametersInvalid < StandardError
-
-      # The parameters.
-      attr_reader :params
-
-      def initialize(params)
-        @params = params
-        super('')
-      end
-
-      # Returns the errors encountered.
-      def errors
-        @params.errors.errors
-      end
-
-      # Overrides <code>Exception#message</code> to lazily generate the error message.
-      def message
-        "#{@params.errors.full_messages.map { |m| m.delete_suffix('.') }.join('. ')}."
-      end
-    end
-  end
-end

data/lib/jsapi/dsl/callback.rb

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-module Jsapi
-  module DSL
-    # Used to specify an OpenAPI callback object.
-    class Callback < Base
-
-      # Adds a callback operation.
-      #
-      #   operation '{$request.query.foo}' do
-      #     parameter 'bar', type: 'string'
-      #   end
-      def operation(expression, **keywords, &block)
-        define('operation', expression.inspect) do
-          operation_model = @meta_model.add_operation(expression, keywords)
-          Operation.new(operation_model, &block) if block
-        end
-      end
-    end
-  end
-end

data/lib/jsapi/dsl/error.rb

@@ -1,36 +0,0 @@
-# frozen_string_literal: true
-
-module Jsapi
-  module DSL
-    # Raised when an error occurred while defining an API component.
-    class Error < StandardError
-
-      # Creates a new error. +origin+ is the innermost position at where the error occurred.
-      def initialize(error_or_message, origin = nil)
-        @path = Array(origin)
-        super(
-          if error_or_message.respond_to?(:message)
-            error_or_message.message
-          else
-            error_or_message
-          end
-        )
-      end
-
-      # Overrides <code>StandardError#message</code> to append the whole path of the position
-      # at where the error occurred, for example: <code>{message} (at foo / bar)</code>.
-      def message
-        message = super
-        return message if @path.empty?
-
-        "#{message} (at #{@path.join(' / ')})"
-      end
-
-      # Prepends +origin+ to the path at where the error occurred.
-      def prepend_origin(origin)
-        @path.prepend(origin) if origin.present?
-        self
-      end
-    end
-  end
-end

data/lib/jsapi/invalid_argument_error.rb

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-module Jsapi
-  # Raised when an argument isn't contained in the list of valid values.
-  class InvalidArgumentError < ArgumentError
-    include InvalidValueHelper
-
-    def initialize(name, value, valid_values: [])
-      super(build_message(name, value, valid_values))
-    end
-  end
-end

data/lib/jsapi/invalid_value_error.rb

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-module Jsapi
-  # Raised when a value isn't contained in the list of valid values.
-  class InvalidValueError < RuntimeError
-    include InvalidValueHelper
-
-    def initialize(name, value, valid_values: [])
-      super(build_message(name, value, valid_values))
-    end
-  end
-end

data/lib/jsapi/invalid_value_helper.rb

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-module Jsapi
-  module InvalidValueHelper # :nodoc:
-    def build_message(name, value, valid_values)
-      case valid_values.count
-      when 0
-        "#{name} must not be #{value.inspect}"
-      when 1
-        "#{name} must be #{valid_values.first.inspect}, is #{value.inspect}"
-      else
-        "#{name} must be one of #{valid_values[0..-2].map(&:inspect).join(', ')} " \
-        "or #{valid_values.last.inspect}, is #{value.inspect}"
-      end
-    end
-  end
-end

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

@@ -1,50 +0,0 @@
-# frozen_string_literal: true
-
-module Jsapi
-  module Meta
-    module Model
-      class TypeCaster
-        STRING_CASTER = ->(arg) { arg&.to_s } # :nodoc:
-
-        SYMBOL_CASTER = ->(arg) { # :nodoc:
-          return if arg.nil?
-
-          arg = arg.to_s unless arg.respond_to?(:to_sym)
-          arg.to_sym
-        }
-
-        # Creates a new type caster for +klass+.
-        def initialize(klass = nil, name: 'value', values: nil)
-          klass = Object if klass.nil?
-          @caster =
-            case klass.name
-            when 'String'
-              STRING_CASTER
-            when 'Symbol'
-              SYMBOL_CASTER
-            else
-              ->(arg) {
-                return arg if arg.is_a?(klass)
-                return klass.from(arg) if klass.respond_to?(:from)
-                return klass.new if arg.nil?
-
-                klass.new(arg)
-              }
-            end
-          @values = values
-          @name = name
-        end
-
-        # Casts +value+.
-        #
-        # Raises an InvalidArgumentError if the (casted) value is invalid.
-        def cast(value)
-          casted_value = @caster.call(value)
-          return casted_value unless @values&.exclude?(casted_value)
-
-          raise InvalidArgumentError.new(@name, casted_value, valid_values: @values)
-        end
-      end
-    end
-  end
-end

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

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-module Jsapi
-  module Meta
-    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
-
-        def initialize(schema, existence)
-          @schema = schema
-          @existence = existence
-        end
-
-        def inspect # :nodoc:
-          "#<#{self.class.name} " \
-          "schema: #{@schema.inspect}, " \
-          "existence: #{@existence.inspect}>"
-        end
-      end
-    end
-  end
-end