jsapi 3.0 → 3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0ec240995632c56faf46229f425a0fb65a32da97f6aa0b68ee66327a6a17ca3b
-  data.tar.gz: 7c457efa33d29830814b66dc62ac001d813f042890b7e637e265567198251e01
+  metadata.gz: 3c5ea7fc42be26ca35561f17cb2503e54efd9e138abd0ec4f9b7594fb27390ca
+  data.tar.gz: 1248e0b2499dd3616e5e4130fae88f9d5be8bd6a07e921317e86397a92832f71
 SHA512:
-  metadata.gz: 9a7fc689d67fe755b7351a06730ff59b65212a5764e4eeab2d2b03748954e6c635a371bbdab0615542d07e0226c96c81453e0f246f99ef007f94f1b5c6210a54
-  data.tar.gz: 2cbe363c8e5915611b9c3e9a38c2448af1bc0ccb8353b99a6f0595c51a115dce93269b2832a1f18d915f11dd96855249261f7749ba2ca9175685deda51cacbe6
+  metadata.gz: 2f4af4e90d29a9b1df69ab71c5ad729eecd9d625286864c2dae078e2d6f6a43cab306fa9e999bccedeea82183bc8d5c3d4d6a977faf607fcb0236621eb3f19e2
+  data.tar.gz: 3b2467ea75b1c14bc99266977d7bff07ab74315178ea6d936795fc6fb1111a59d04bbd859b7ffb86bf478baca3d9e5eb4c4979f4b22c1e43f81bae5c981a36e1

data/lib/jsapi/controller/methods.rb

@@ -117,34 +117,77 @@ module Jsapi
           ) if [nil, :empty, :nil].exclude?(omit)
 
           operation = api.find_operation!(operation_name)
+          result = nil
           response_definition = nil
 
-          result = begin
-            # Authenticate request first if Authentication is included
-            if respond_to?(:_api_authenticated?, true)
-              raise Unauthorized unless _api_authenticated?(operation)
+          bypassed = catch :bypass do
+            if result.nil?
+              # Authenticate request first if Authentication is included
+              if respond_to?(:_api_authenticated?, true)
+                raise Unauthorized unless _api_authenticated?(operation)
 
-              _api_callback(:after_authentication, operation_name)
-            end
+                _api_callback(:after_authentication, operation_name)
+              end
 
-            status = Status::Code.from(status)
-            response_definition = operation.find_response_for!(status)
+              status = Status::Code.from(status)
+              response_definition = operation.find_response_for!(status)
 
-            api_params = _api_params(operation, strong: strong)
+              api_params = _api_params(operation, strong: strong)
 
-            if bang
-              raise ParametersInvalid.new(api_params) if api_params.invalid?
+              if bang
+                raise ParametersInvalid.new(api_params) if api_params.invalid?
 
-              _api_callback(:after_validation, operation_name, api_params)
+                _api_callback(:after_validation, operation_name, api_params)
+              end
+              result = block&.call(api_params)
+              break if performed?
             end
 
-            block&.call(api_params)
+            # Produce response
+            media_type, content_definition =
+              response_definition
+              .media_type_and_content_for(*_api_accept)
+
+            status_code = status&.to_i
+            head(status_code) && break unless content_definition
+
+            content_type = media_type.to_s
+            result = _api_before_rendering(operation_name, result, api_params)
+
+            if (json_media_type = media_type.json?) || media_type.sequential_json?
+              api_response = Response.new(
+                result,
+                content_definition,
+                omit: omit,
+                locale: response_definition.locale
+              )
+              if json_media_type
+                render(json: api_response, status: status_code, content_type: content_type)
+              else
+                self.content_type = content_type
+                response.status = status_code
+                begin
+                  response.stream.tap do |stream|
+                    api_response.write_seq_json_to(stream, media_type)
+                  ensure
+                    stream.close
+                  end
+                rescue StandardError => e
+                  throw :bypass, e
+                end
+              end
+            elsif media_type == Media::Type::TEXT_PLAIN
+              render(plain: result.to_s, status: status_code, content_type: content_type)
+            end
+            nil
           rescue StandardError => e
-            # Lookup a rescue handler
+            raise e if result.is_a?(Error)
+
+            # Get rescue handler for the error
             rescue_handler = api.rescue_handler_for(e)
             raise e if rescue_handler.nil?
 
-            # Replace the status code and response definition
+            # Set error status code and response definition
             status = rescue_handler.status_code
             response_definition = operation.find_response_for(status)
             raise e if response_definition.nil?
@@ -154,51 +197,10 @@ module Jsapi
               callback.respond_to?(:call) ? callback.call(e) : send(callback, e)
             end
 
-            Error.new(e, status: status)
-          end
-          # Return if response body has already been rendered
-          return if response_body
-
-          # Produce response
-          media_type, content_definition =
-            response_definition
-            .media_type_and_content_for(*_api_accept)
-
-          status = status&.to_i
-          return head(status) unless content_definition
-
-          result = _api_before_rendering(operation_name, result, api_params)
-
-          if media_type == Media::Type::TEXT_PLAIN
-            render(
-              plain: result.to_s,
-              status: status,
-              content_type: media_type.to_s
-            )
-          elsif media_type.json? || media_type.json_seq?
-            api_response = Response.new(
-              result,
-              content_definition,
-              omit: omit,
-              locale: response_definition.locale
-            )
-            if media_type.json?
-              render(
-                json: api_response,
-                status: status,
-                content_type: media_type.to_s
-              )
-            else
-              self.content_type = media_type.to_s
-              response.status = status
-
-              response.stream.tap do |stream|
-                api_response.write_json_seq_to(stream)
-              ensure
-                stream.close
-              end
-            end
+            result = Error.new(e, status: status)
+            retry
           end
+          raise bypassed if bypassed.is_a?(Exception)
         end
       end
 

data/lib/jsapi/controller/response.rb

@@ -41,8 +41,9 @@ module Jsapi
         as_json.to_json
       end
 
-      # Writes the response in \JSON sequence text format to +stream+.
-      def write_json_seq_to(stream)
+      # Writes the response as sequential \JSON to +stream+.
+      def write_seq_json_to(stream, media_type = nil)
+        record_separator = "\u001E" if media_type&.subtype == 'json-seq' # see RFC 7464
         schema = @content_definition.schema
         object = @object
         object = schema.default_value(context: :response) if object.nil?
@@ -56,7 +57,7 @@ module Jsapi
             end
 
           items.each_with_index do |item, index|
-            stream.write("\u001E") # Record separator (see RFC 7464)
+            stream.write(record_separator) if record_separator
             stream.write(
               item_schema.jsonify(
                 item,

data/lib/jsapi/definition/content.rb

@@ -51,8 +51,7 @@ module Jsapi
         example_builder = nil
 
         with_openapi_extensions(
-          **if media_type == Media::Type::APPLICATION_JSON_SEQ &&
-               schema.array? && version >= OpenAPI::V3_2
+          **if version >= OpenAPI::V3_2 && media_type&.sequential_json? && schema.array?
               { itemSchema: schema.items.to_openapi(version) }
             else
               { schema: schema.to_openapi(version) }

data/lib/jsapi/media/range.rb

@@ -18,7 +18,7 @@ module Jsapi
       class << self
         # Transforms +value+ to an instance of this class.
         #
-        # Raises an +ArgumentError+ when +value+ could not be transformed.
+        # Raises an +ArgumentError+ if +value+ can not be transformed to a Media::Range.
         def from(value)
           media_range = try_from(value)
           return media_range unless media_range.nil?

data/lib/jsapi/media/type.rb

@@ -12,16 +12,15 @@ module Jsapi
       # Media::Type for <code>"application/json"</code>.
       APPLICATION_JSON = Type.new('application', 'json')
 
-      # Media::Type for <code>"application/json-seq"</code>.
-      APPLICATION_JSON_SEQ = Type.new('application', 'json-seq')
-
       # Media::Type for <code>"text/plain"</code>.
       TEXT_PLAIN = Type.new('text', 'plain')
 
+      SEQ_JSON_SUBTYPE = /\A(jsonl|(|.+\+)json-seq|x-ndjson)\Z/.freeze # :nodoc:
+
       class << self
         # Transforms +value+ to an instance of this class.
         #
-        # Raises an ArgumentError when +value+ could not be transformed.
+        # Raises an ArgumentError if +value+ can not be transformed to a Media::Type.
         def from(value)
           media_type = try_from(value)
           return media_type unless media_type.nil?
@@ -31,7 +30,7 @@ module Jsapi
 
         # Tries to transform +value+ to an instance of this class.
         #
-        # Returns nil if +value+ could not be transformed.
+        # Returns nil if +value+ can not be transformed to a Media::Type.
         def try_from(value)
           return value if value.is_a?(Type)
 
@@ -59,16 +58,16 @@ module Jsapi
         subtype <=> other.subtype
       end
 
-      # Returns true if it represents a JSON media type as specified by
+      # Returns true if it represents a \JSON media type as specified by
       # https://mimesniff.spec.whatwg.org/#json-mime-type.
       def json?
         (type.in?(%w[application text]) && subtype == 'json') ||
           subtype.end_with?('+json')
       end
 
-      # Returns true if it is <code>"application/json-seq"</code>.
-      def json_seq?
-        type == 'application' && subtype == 'json-seq'
+      # Returns true if it represents a sequential \JSON media type.
+      def sequential_json?
+        type == 'application' && SEQ_JSON_SUBTYPE.match?(subtype)
       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 = '3.0'
+    VERSION = '3.1'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jsapi
 version: !ruby/object:Gem::Version
-  version: '3.0'
+  version: '3.1'
 platform: ruby
 authors:
 - Denis Göller
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-10-24 00:00:00.000000000 Z
+date: 2026-10-31 00:00:00.000000000 Z
 dependencies: []
 description:
 email: denis@dmgoeller.de