media_types-serialization 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f9ac4527fa2f01520dee6fa7601c02c4741a0482649074a8c7f15ff363913007
-  data.tar.gz: 5785242ebf17f3160b57cc27a663bbb714d03b2f3676ba1a0c383f4901877fa1
+  metadata.gz: 7d19f8ce2e2010426e6fe53e7a0113c3ccc2fd38c7446a96a1310dcf8fea6440
+  data.tar.gz: ad053ac0885c6ac7349f1efe530253089e93e1da26547af82bd990a98215120e
 SHA512:
-  metadata.gz: 428943fe7256e3804639fe282c35b5e6cd41f22864dd98c98b0f28865671341b802968c554139540a03efdbeadbc7f91abf13c8c8768ece34f3f4c435fe07706
-  data.tar.gz: 141c0324e99ef1770f21874e75c983b191e5959961d52d98e5acb83ad3217b717334342f9ba60dce0323b5c6f95e5cf5865d30bb8055bc81f792dfcac251f434
+  metadata.gz: df08264d2b33ebcf0c556d4a3a4b51b6695763ae5d932424140f805b42d4eccabccf6002e2529d7b62107cfe186ae338f5ccba32ffbc5d3a5eabe47318f534f9
+  data.tar.gz: acce1b9414c5c9d478113b4597441ea08f9936ed0cdfc2dcacded8abc055fde2a8ea6a43655db27c74757ea41d16c5319be176702b42701dd5902d98cf862cf7

data/.github/workflows/ci.yml

@@ -17,7 +17,7 @@ jobs:
 
     strategy:
       matrix:
-        ruby-version: ["3.1", "3.0", "2.7"]
+        ruby-version: ["3.2", "3.1", "3.0"]
 
     steps:
       - uses: actions/checkout@v1

data/.github/workflows/publish-bookworm.yml

@@ -9,14 +9,15 @@ jobs:
     container:
       image: debian:bookworm
     steps:
-      - uses: actions/checkout@v3
-        name: Check out repository
       - name: Install repo
         run: apt-get update && DEBIAN_FRONTEND=noninteractive apt-get --yes install wget && wget -O key.deb https://deb1.ws.maxmaton.nl/key.deb && DEBIAN_FRONTEND=noninteractive apt-get --yes install ./key.deb && echo "deb [signed-by=/usr/share/keyrings/maxmaton.gpg] http://deb.maxmaton.nl/debian bookworm main non-free" > /etc/apt/sources.list.d/maxmaton.list
       - name: Install dependencies
-        run: apt-get update && DEBIAN_FRONTEND=noninteractive apt-get --yes install build-essential gem scrypt sshpass gem2deb ruby-actionpack ruby-activesupport ruby-media-types
+        run: apt-get update && DEBIAN_FRONTEND=noninteractive apt-get --yes install git build-essential gem scrypt sshpass gem2deb ruby-actionpack ruby-activesupport ruby-media-types
+      - uses: actions/checkout@v3
+        name: Check out repository
       - name: Build gem
         run: |
+          git config --global --add safe.directory "$(pwd)"
           sed -i -re "s/VERSION\s+=\s+'([0-9]+.[0-9]+.[0-9]+)'/VERSION = '\1.bookworm'/g" lib/media_types/serialization/version.rb
           gem build media_types-serialization.gemspec
       - name: Build deb

data/.github/workflows/publish-sid.yml

@@ -9,14 +9,15 @@ jobs:
     container:
       image: debian:sid
     steps:
-      - uses: actions/checkout@v3
-        name: Check out repository
       - name: Install repo
         run: apt-get update && DEBIAN_FRONTEND=noninteractive apt-get --yes install wget && wget -O key.deb https://deb1.ws.maxmaton.nl/key.deb && DEBIAN_FRONTEND=noninteractive apt-get --yes install ./key.deb && echo "deb [signed-by=/usr/share/keyrings/maxmaton.gpg] http://deb.maxmaton.nl/debian sid main non-free" > /etc/apt/sources.list.d/maxmaton.list
       - name: Install dependencies
-        run: apt-get update && DEBIAN_FRONTEND=noninteractive apt-get --yes install build-essential gem scrypt sshpass gem2deb ruby-actionpack ruby-activesupport ruby-media-types
+        run: apt-get update && DEBIAN_FRONTEND=noninteractive apt-get --yes install git build-essential gem scrypt sshpass gem2deb ruby-actionpack ruby-activesupport ruby-media-types
+      - uses: actions/checkout@v3
+        name: Check out repository
       - name: Build gem
         run: |
+          git config --global --add safe.directory "$(pwd)"
           sed -i -re "s/VERSION\s+=\s+'([0-9]+.[0-9]+.[0-9]+)'/VERSION = '\1.sid'/g" lib/media_types/serialization/version.rb
           gem build media_types-serialization.gemspec
       - name: Build deb

data/CHANGELOG.md

@@ -1,5 +1,22 @@
 # Changelog
 
+## 2.1.0
+
+- ✨ Add `varies_on_header` serializer dsl function.
+- 🐛 Fix [crash in input validation error serializer](https://github.com/XPBytes/media_types-serialization/issues/260)
+- 🐛 Fix [endpoint description having media types multiple times](https://github.com/XPBytes/media_types-serialization/issues/184)
+- 🐛 Fix problem serializer not Varying on Accept-Language
+
+## 2.0.4
+
+- ✨ Add more loose tests
+- 🐛 Fix `locals` passing for HTML serialization
+- 🐛 Fix for status passing in rack-like environments
+
+## 2.0.3
+
+- 🐛 Fix debian packages not containing files
+
 ## 2.0.0
 
 - ✨ Add support for loose input validation

data/Gemfile.lock

@@ -0,0 +1,176 @@
+PATH
+  remote: .
+  specs:
+    media_types-serialization (2.1.0)
+      actionpack (>= 6.0.0)
+      activesupport (>= 6.0.0)
+      media_types (>= 2.2.3, < 3.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (6.1.7.8)
+      actionpack (= 6.1.7.8)
+      activesupport (= 6.1.7.8)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailbox (6.1.7.8)
+      actionpack (= 6.1.7.8)
+      activejob (= 6.1.7.8)
+      activerecord (= 6.1.7.8)
+      activestorage (= 6.1.7.8)
+      activesupport (= 6.1.7.8)
+      mail (>= 2.7.1)
+    actionmailer (6.1.7.8)
+      actionpack (= 6.1.7.8)
+      actionview (= 6.1.7.8)
+      activejob (= 6.1.7.8)
+      activesupport (= 6.1.7.8)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (6.1.7.8)
+      actionview (= 6.1.7.8)
+      activesupport (= 6.1.7.8)
+      rack (~> 2.0, >= 2.0.9)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actiontext (6.1.7.8)
+      actionpack (= 6.1.7.8)
+      activerecord (= 6.1.7.8)
+      activestorage (= 6.1.7.8)
+      activesupport (= 6.1.7.8)
+      nokogiri (>= 1.8.5)
+    actionview (6.1.7.8)
+      activesupport (= 6.1.7.8)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activejob (6.1.7.8)
+      activesupport (= 6.1.7.8)
+      globalid (>= 0.3.6)
+    activemodel (6.1.7.8)
+      activesupport (= 6.1.7.8)
+    activerecord (6.1.7.8)
+      activemodel (= 6.1.7.8)
+      activesupport (= 6.1.7.8)
+    activestorage (6.1.7.8)
+      actionpack (= 6.1.7.8)
+      activejob (= 6.1.7.8)
+      activerecord (= 6.1.7.8)
+      activesupport (= 6.1.7.8)
+      marcel (~> 1.0)
+      mini_mime (>= 1.1.0)
+    activesupport (6.1.7.8)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    awesome_print (1.9.2)
+    bigdecimal (3.1.8)
+    builder (3.3.0)
+    concurrent-ruby (1.3.4)
+    crass (1.0.6)
+    date (3.3.4)
+    erubi (1.13.0)
+    globalid (1.2.1)
+      activesupport (>= 6.1)
+    i18n (1.14.5)
+      concurrent-ruby (~> 1.0)
+    loofah (2.22.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.12.0)
+    mail (2.8.1)
+      mini_mime (>= 0.1.1)
+      net-imap
+      net-pop
+      net-smtp
+    marcel (1.0.4)
+    media_types (2.3.3.bookworm)
+    method_source (1.1.0)
+    mini_mime (1.1.5)
+    minitest (5.25.1)
+    net-imap (0.4.14)
+      date
+      net-protocol
+    net-pop (0.1.2)
+      net-protocol
+    net-protocol (0.2.2)
+      timeout
+    net-smtp (0.5.0)
+      net-protocol
+    nio4r (2.7.3)
+    nokogiri (1.16.7-x64-mingw32)
+      racc (~> 1.4)
+    nokogiri (1.16.7-x86_64-linux)
+      racc (~> 1.4)
+    oj (3.16.7)
+      bigdecimal (>= 3.0)
+      ostruct (>= 0.2)
+    ostruct (0.6.0)
+    racc (1.8.1)
+    rack (2.2.9)
+    rack-test (2.1.0)
+      rack (>= 1.3)
+    rails (6.1.7.8)
+      actioncable (= 6.1.7.8)
+      actionmailbox (= 6.1.7.8)
+      actionmailer (= 6.1.7.8)
+      actionpack (= 6.1.7.8)
+      actiontext (= 6.1.7.8)
+      actionview (= 6.1.7.8)
+      activejob (= 6.1.7.8)
+      activemodel (= 6.1.7.8)
+      activerecord (= 6.1.7.8)
+      activestorage (= 6.1.7.8)
+      activesupport (= 6.1.7.8)
+      bundler (>= 1.15.0)
+      railties (= 6.1.7.8)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.2.0)
+      activesupport (>= 5.0.0)
+      minitest
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.6.0)
+      loofah (~> 2.21)
+      nokogiri (~> 1.14)
+    railties (6.1.7.8)
+      actionpack (= 6.1.7.8)
+      activesupport (= 6.1.7.8)
+      method_source
+      rake (>= 12.2)
+      thor (~> 1.0)
+    rake (13.2.1)
+    sprockets (4.2.1)
+      concurrent-ruby (~> 1.0)
+      rack (>= 2.2.4, < 4)
+    sprockets-rails (3.5.2)
+      actionpack (>= 6.1)
+      activesupport (>= 6.1)
+      sprockets (>= 3.0.0)
+    thor (1.3.1)
+    timeout (0.4.1)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    websocket-driver (0.7.6)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    zeitwerk (2.6.17)
+
+PLATFORMS
+  x64-mingw32
+  x86_64-linux
+
+DEPENDENCIES
+  awesome_print
+  bundler
+  media_types-serialization!
+  minitest (~> 5.0)
+  oj
+  rails (~> 6.0)
+  rake (~> 13.0)
+
+BUNDLED WITH
+   2.3.15

data/README.md

@@ -897,6 +897,16 @@ This redirects the user to the specified url when this serializer is rendered. T
 
 Replaces the render at the end of `render_media` and substitutes it with the contents of the block.
 
+#### `varies_on_header(header)`
+
+Indicates to clients that they can receive a different response if the indicated header has a different value. This is done using the [Vary header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Vary). When your responses are internationalized you can use the following example:
+
+```ruby
+varies_on_header 'Accept-Language'
+```
+
+The Vary header is set at two moments during execution. The first moment the header is modified is during the `freeze_io!` handler. The second moment is when `render_media` is called. If you want to modify the Vary header that is returned when the content negotiation fails you need to make sure to run your callback before the `freeze_io!` callback has been run.
+
 ### Controller definition
 
 These functions are available during the controller definition if you add `include MediaTypes::Serialization`.

data/lib/media_types/serialization/fake_validator.rb

@@ -39,7 +39,7 @@ class FakeValidator
     true
   end
 
-  def validate!(_)
+  def validate!(*)
     true
   end
 

data/lib/media_types/serialization/serialization_dsl.rb

@@ -114,6 +114,10 @@ module MediaTypes
         context.serialization_dsl_result
       end
 
+      def varies_on_header(header)
+        @serialization_vary.push(header) unless @serialization_vary.include? header
+      end
+
       def redirect_to(url, context, **options)
         suppress_render do |result|
           context.redirect_to(

data/lib/media_types/serialization/serializers/endpoint_description_serializer.rb

@@ -1,4 +1,3 @@
-
 # frozen_string_literal: true
 
 require 'media_types/serialization/base'
@@ -7,41 +6,43 @@ module MediaTypes
   module Serialization
     module Serializers
       class EndpointDescriptionSerializer < MediaTypes::Serialization::Base
-
         unvalidated 'application/vnd.delftsolutions.endpoint_description'
 
         disable_wildcards
 
         def self.to_input_identifiers(serializers)
-          serializers.flat_map do |s|
-            s[:serializer].inputs_for(views: [s[:view]]).registrations.keys
-          end
+          serializers
+            .flat_map do |s|
+              s[:serializer].inputs_for(views: [s[:view]]).registrations.keys
+            end
+            .uniq
         end
+
         def self.to_output_identifiers(serializers)
-          serializers.flat_map do |s|
-            s[:serializer].outputs_for(views: [s[:view]]).registrations.keys
-          end
+          serializers
+            .flat_map do |s|
+              s[:serializer].outputs_for(views: [s[:view]]).registrations.keys
+            end
+            .uniq
         end
 
-        output version: 1 do |input, version, context|
+        output version: 1 do |input, _version, context|
           request_path = context.request.original_fullpath.split('?')[0]
 
-          path_prefix = ENV.fetch('RAILS_RELATIVE_URL_ROOT') { '' }
+          path_prefix = ENV.fetch('RAILS_RELATIVE_URL_ROOT', '')
           request_path = request_path.sub(path_prefix, '')
 
           my_controller = Rails.application.routes.recognize_path request_path
 
           methods_available = {}
-          methods = ['GET', 'POST', 'PUT', 'PATCH', 'DELETE']
+          methods = %w[GET POST PUT PATCH DELETE]
           methods.each do |m|
-            begin
-              found_controller = Rails.application.routes.recognize_path request_path, method: m
-              if found_controller[:controller] == my_controller[:controller]
-                methods_available[m] = found_controller[:action]
-              end
-            rescue ActionController::RoutingError
-              # not available
+            found_controller = Rails.application.routes.recognize_path request_path, method: m
+            if found_controller[:controller] == my_controller[:controller]
+              methods_available[m] = found_controller[:action]
             end
+          rescue ActionController::RoutingError
+            # not available
           end
 
           input_definitions = input[:actions][:input] || {}
@@ -55,8 +56,8 @@ module MediaTypes
 
           viewer_uri = URI.parse(context.request.original_url)
           query_parts = viewer_uri.query&.split('&') || []
-          query_parts = query_parts.select { |q| !q.start_with? 'api_viewer=' }
-          viewer_uri.query = (query_parts + ["api_viewer=last"]).join('&')
+          query_parts = query_parts.reject { |q| q.start_with? 'api_viewer=' }
+          viewer_uri.query = (query_parts + ['api_viewer=last']).join('&')
 
           methods_available.each do |method, action|
             has_viewer = viewer_definitions[action] || global_viewer
@@ -73,7 +74,6 @@ module MediaTypes
 
           result
         end
-
       end
     end
   end

data/lib/media_types/serialization/serializers/input_validation_error_serializer.rb

@@ -10,8 +10,8 @@ module MediaTypes
       class InputValidationErrorSerializer < MediaTypes::Serialization::Base
         unvalidated 'text/html'
 
-        def self.escape_text(text)
-          text
+        def self.escape_text(text, context)
+          result = text
             .split("\n")
             .map { |l| CGI.escapeHTML(l).gsub(/ (?= )/, '&nbsp;') }
             .map do |l|
@@ -19,7 +19,7 @@ module MediaTypes
                 converted = m
                 invalid = false
                 begin
-                  converted = viewerify(m, context.request.host)
+                  converted = ApiViewer.viewerify(m, context.request.host)
                 rescue URI::InvalidURIError
                   invalid = true
                 end
@@ -29,6 +29,8 @@ module MediaTypes
               end
             end
             .join("<br>\n")
+          result.html_safe
+          result
         end
 
         output_raw do |obj, version, context|
@@ -36,8 +38,8 @@ module MediaTypes
           original_input = obj[:input]
           error = obj[:error]
 
-          escaped_error = escape_text(error.message)
-          escaped_input = escape_text(original_input)
+          escaped_error = escape_text(error.message, context)
+          escaped_input = escape_text(original_input, context)
 
           input = OpenStruct.new(
             original_identifier: input_identifier,

data/lib/media_types/serialization/serializers/problem_serializer.rb

@@ -8,13 +8,13 @@ module MediaTypes
   module Serialization
     module Serializers
       class ProblemSerializer < MediaTypes::Serialization::Base
-
         unvalidated 'application/vnd.delftsolutions.problem'
         disable_wildcards
 
         output do |problem, _, context|
           raise 'No translations defined, add at least one title' unless problem.translations.keys.any?
 
+          varies_on_header 'Accept-Language'
           accept_language_header = Utils::AcceptLanguageHeader.new(
             context.request.get_header(HEADER_ACCEPT_LANGUAGE) || ''
           )

data/lib/media_types/serialization/version.rb

@@ -2,6 +2,6 @@
 
 module MediaTypes
   module Serialization
-    VERSION = '2.0.0'
+    VERSION = '2.1.0'
   end
 end

data/lib/media_types/serialization.rb

@@ -201,7 +201,7 @@ module MediaTypes
             options[:template] = view unless view.nil?
             options[:formats] = formats unless formats.nil?
             options[:variants] = variants unless variants.nil?
-            options[:locals] = victim if victim.is_a?(Hash)
+            options[:locals] = victim if victim.is_a?(::Hash)
             options[:assigns] = { media: victim }
 
             controller.render_to_string(**options)
@@ -448,7 +448,7 @@ module MediaTypes
         end
 
         return @serialization_override_accept if registration.has? @serialization_override_accept
-        
+
         # Always render problems in api viewer if we can't show chosen override
         return 'application/problem+json' if registration.has? 'application/problem+json'
 
@@ -541,10 +541,14 @@ module MediaTypes
             self
           )
         rescue InputValidationFailedError => e
-          serializers = @serialization_input_validation_failed_serializer || [
-            MediaTypes::Serialization::Serializers::ProblemSerializer,
-            MediaTypes::Serialization::Serializers::InputValidationErrorSerializer
-          ]
+          serializers = if defined?(@serialization_input_validation_failed_serializer)
+            @serialization_input_validation_failed_serializer
+          else
+            [
+              MediaTypes::Serialization::Serializers::ProblemSerializer,
+              MediaTypes::Serialization::Serializers::InputValidationErrorSerializer
+            ]
+          end
           registrations = SerializationRegistration.new(:output)
           serializers.each do |s|
             registrations = registrations.merge(s.outputs_for(views: [nil, :html]))
@@ -671,6 +675,9 @@ module MediaTypes
       end
 
       if context.serialization_custom_render.nil?
+        status = options.delete(:status)
+        response.status = status if status
+
         render body: result, **options
 
         response.content_type = registrations.identifier_for(identifier)

data/media_types-serialization.gemspec

@@ -37,7 +37,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'actionpack', '>= 6.0.0'
   spec.add_dependency 'activesupport', '>= 6.0.0'
-  spec.add_dependency 'media_types', '>= 2.2.0', '< 3.0.0'
+  spec.add_dependency 'media_types', '>= 2.2.3', '< 3.0.0'
 
   spec.add_development_dependency 'awesome_print'
   spec.add_development_dependency 'bundler'

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: media_types-serialization
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Derk-Jan Karrenbeld
 - Max Maton
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-08-11 00:00:00.000000000 Z
+date: 2025-05-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -45,7 +45,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.2.0
+        version: 2.2.3
     - - "<"
       - !ruby/object:Gem::Version
         version: 3.0.0
@@ -55,7 +55,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.2.0
+        version: 2.2.3
     - - "<"
       - !ruby/object:Gem::Version
         version: 3.0.0
@@ -143,7 +143,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - derk-jan@xpbytes.com
 - max@delftsolutions.nl
@@ -168,6 +168,7 @@ files:
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -199,7 +200,7 @@ metadata:
   homepage_uri: https://github.com/XPBytes/media_types-serialization
   source_code_uri: https://github.com/XPBytes/media_types-serialization
   changelog_uri: https://github.com/XPBytes/media_types-serialization/blob/master/CHANGELOG.md
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -214,8 +215,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.5
-signing_key: 
+rubygems_version: 3.3.15
+signing_key:
 specification_version: 4
 summary: Add media types supported serialization using your favourite serializer
 test_files: []