media_types-serialization 1.3.9 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 64e776b0385e75bc7accfd536320105d6f54724f5b85f10ce8396c412e3d42f4
-  data.tar.gz: fcac17f274d2f295d4ca57f20375caa7c54baf5cad1c8300a65416e5172bf2ae
+  metadata.gz: '096826bd7e4a4be4fcd147fec07f26d05aec0101b8651ae63ed376a7a2388077'
+  data.tar.gz: 2f783986be7ca3eff779e10a2ace5338d9ab7dbb755334ae79d01d7b422a77c9
 SHA512:
-  metadata.gz: 60a7cfd98fd87f4b5ca3facb3338518015abb4567b5ff35741a16e7b36bd4bb58a2262dd74c34c884d119d5844c2cf1034e2f4ac566dfee6205e2797ad730c4a
-  data.tar.gz: 1911cb60916f41d1ce594d7b98ed072cce91092bf6c00f60ae985fe50cc5380ef7367b0bff5a9d0f72f0f83a5b7a9072708ebccd81096c539a04c88603f0fc37
+  metadata.gz: f0b58cdb8eb8e4f8c0c8ad73cc607673768cba38399cf9c804db16a54198b3fe0799a18c641e7c05d10e03c2936fc96a416b80ff51ff4bd5e6d570b10a47e712
+  data.tar.gz: e82051321d55df89abe34c6d43e62a0158245c4fb9ae60060fc3e939df854626b3014285f2ac277f7632f6c3cd099ef349265bdfffbf7b7b226f76287bb53147

data/.github/workflows/ci.yml

@@ -17,12 +17,12 @@ jobs:
 
     strategy:
       matrix:
-        ruby-version: [2.7.x, 2.6.x, 2.5.x]
+        ruby-version: ["3.1", "3.0", "2.7"]
 
     steps:
       - uses: actions/checkout@v1
       - name: Set up Ruby ${{ matrix.ruby-version }}
-        uses: actions/setup-ruby@v1
+        uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby-version }}
       - name: Build and test with Rake

data/.gitignore

@@ -10,3 +10,5 @@
 .idea/workspace.xml
 .idea/usage.statistics.xml
 .idea/tasks.xml
+
+/media_types-serialization*.gem

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 1.4.0
+
+- ✨ Add support for redirecting in serializers
+
 ## 1.3.9
 
 - ✨ Make serializer look slightly better on mobile by zooming in initially

data/Gemfile.lock

@@ -1,128 +1,158 @@
 PATH
   remote: .
   specs:
-    media_types-serialization (1.3.9)
-      actionpack (>= 4.0.0)
-      activesupport (>= 4.0.0)
-      media_types (>= 2.1.1, < 3.0.0)
+    media_types-serialization (1.4.0)
+      actionpack (>= 6.0.0)
+      activesupport (>= 6.0.0)
+      media_types (>= 2.2.0, < 3.0.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actioncable (5.2.6)
-      actionpack (= 5.2.6)
+    actioncable (6.1.7.3)
+      actionpack (= 6.1.7.3)
+      activesupport (= 6.1.7.3)
       nio4r (~> 2.0)
       websocket-driver (>= 0.6.1)
-    actionmailer (5.2.6)
-      actionpack (= 5.2.6)
-      actionview (= 5.2.6)
-      activejob (= 5.2.6)
+    actionmailbox (6.1.7.3)
+      actionpack (= 6.1.7.3)
+      activejob (= 6.1.7.3)
+      activerecord (= 6.1.7.3)
+      activestorage (= 6.1.7.3)
+      activesupport (= 6.1.7.3)
+      mail (>= 2.7.1)
+    actionmailer (6.1.7.3)
+      actionpack (= 6.1.7.3)
+      actionview (= 6.1.7.3)
+      activejob (= 6.1.7.3)
+      activesupport (= 6.1.7.3)
       mail (~> 2.5, >= 2.5.4)
       rails-dom-testing (~> 2.0)
-    actionpack (5.2.6)
-      actionview (= 5.2.6)
-      activesupport (= 5.2.6)
-      rack (~> 2.0, >= 2.0.8)
+    actionpack (6.1.7.3)
+      actionview (= 6.1.7.3)
+      activesupport (= 6.1.7.3)
+      rack (~> 2.0, >= 2.0.9)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.0, >= 1.0.2)
-    actionview (5.2.6)
-      activesupport (= 5.2.6)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actiontext (6.1.7.3)
+      actionpack (= 6.1.7.3)
+      activerecord (= 6.1.7.3)
+      activestorage (= 6.1.7.3)
+      activesupport (= 6.1.7.3)
+      nokogiri (>= 1.8.5)
+    actionview (6.1.7.3)
+      activesupport (= 6.1.7.3)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.0, >= 1.0.3)
-    activejob (5.2.6)
-      activesupport (= 5.2.6)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activejob (6.1.7.3)
+      activesupport (= 6.1.7.3)
       globalid (>= 0.3.6)
-    activemodel (5.2.6)
-      activesupport (= 5.2.6)
-    activerecord (5.2.6)
-      activemodel (= 5.2.6)
-      activesupport (= 5.2.6)
-      arel (>= 9.0)
-    activestorage (5.2.6)
-      actionpack (= 5.2.6)
-      activerecord (= 5.2.6)
-      marcel (~> 1.0.0)
-    activesupport (5.2.6)
+    activemodel (6.1.7.3)
+      activesupport (= 6.1.7.3)
+    activerecord (6.1.7.3)
+      activemodel (= 6.1.7.3)
+      activesupport (= 6.1.7.3)
+    activestorage (6.1.7.3)
+      actionpack (= 6.1.7.3)
+      activejob (= 6.1.7.3)
+      activerecord (= 6.1.7.3)
+      activesupport (= 6.1.7.3)
+      marcel (~> 1.0)
+      mini_mime (>= 1.1.0)
+    activesupport (6.1.7.3)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-    arel (9.0.0)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
     awesome_print (1.9.2)
     builder (3.2.4)
-    concurrent-ruby (1.1.9)
+    concurrent-ruby (1.2.2)
     crass (1.0.6)
-    erubi (1.10.0)
-    globalid (0.5.2)
+    date (3.3.3)
+    erubi (1.12.0)
+    globalid (1.1.0)
       activesupport (>= 5.0)
-    i18n (1.8.10)
+    i18n (1.12.0)
       concurrent-ruby (~> 1.0)
-    loofah (2.12.0)
+    loofah (2.19.1)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
-    mail (2.7.1)
+    mail (2.8.1)
       mini_mime (>= 0.1.1)
-    marcel (1.0.1)
-    media_types (2.1.1)
+      net-imap
+      net-pop
+      net-smtp
+    marcel (1.0.2)
+    media_types (2.2.0)
     method_source (1.0.0)
-    mini_mime (1.1.0)
-    minitest (5.14.4)
+    mini_mime (1.1.2)
+    minitest (5.18.0)
+    net-imap (0.3.4)
+      date
+      net-protocol
+    net-pop (0.1.2)
+      net-protocol
+    net-protocol (0.2.1)
+      timeout
+    net-smtp (0.3.3)
+      net-protocol
     nio4r (2.5.8)
-    nokogiri (1.12.3-x64-mingw32)
+    nokogiri (1.14.2-x64-mingw32)
       racc (~> 1.4)
-    nokogiri (1.12.3-x86_64-linux)
-      racc (~> 1.4)
-    oj (3.13.4)
-    racc (1.5.2)
-    rack (2.2.3)
-    rack-test (1.1.0)
-      rack (>= 1.0, < 3)
-    rails (5.2.6)
-      actioncable (= 5.2.6)
-      actionmailer (= 5.2.6)
-      actionpack (= 5.2.6)
-      actionview (= 5.2.6)
-      activejob (= 5.2.6)
-      activemodel (= 5.2.6)
-      activerecord (= 5.2.6)
-      activestorage (= 5.2.6)
-      activesupport (= 5.2.6)
-      bundler (>= 1.3.0)
-      railties (= 5.2.6)
+    oj (3.14.2)
+    racc (1.6.2)
+    rack (2.2.6.4)
+    rack-test (2.1.0)
+      rack (>= 1.3)
+    rails (6.1.7.3)
+      actioncable (= 6.1.7.3)
+      actionmailbox (= 6.1.7.3)
+      actionmailer (= 6.1.7.3)
+      actionpack (= 6.1.7.3)
+      actiontext (= 6.1.7.3)
+      actionview (= 6.1.7.3)
+      activejob (= 6.1.7.3)
+      activemodel (= 6.1.7.3)
+      activerecord (= 6.1.7.3)
+      activestorage (= 6.1.7.3)
+      activesupport (= 6.1.7.3)
+      bundler (>= 1.15.0)
+      railties (= 6.1.7.3)
       sprockets-rails (>= 2.0.0)
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
-    rails-html-sanitizer (1.4.1)
-      loofah (~> 2.3)
-    railties (5.2.6)
-      actionpack (= 5.2.6)
-      activesupport (= 5.2.6)
+    rails-html-sanitizer (1.5.0)
+      loofah (~> 2.19, >= 2.19.1)
+    railties (6.1.7.3)
+      actionpack (= 6.1.7.3)
+      activesupport (= 6.1.7.3)
       method_source
-      rake (>= 0.8.7)
-      thor (>= 0.19.0, < 2.0)
+      rake (>= 12.2)
+      thor (~> 1.0)
     rake (13.0.6)
-    sprockets (4.0.2)
+    sprockets (4.2.0)
       concurrent-ruby (~> 1.0)
-      rack (> 1, < 3)
-    sprockets-rails (3.2.2)
-      actionpack (>= 4.0)
-      activesupport (>= 4.0)
+      rack (>= 2.2.4, < 4)
+    sprockets-rails (3.4.2)
+      actionpack (>= 5.2)
+      activesupport (>= 5.2)
       sprockets (>= 3.0.0)
-    thor (1.1.0)
-    thread_safe (0.3.6)
-    tzinfo (1.2.9)
-      thread_safe (~> 0.1)
+    thor (1.2.1)
+    timeout (0.3.2)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
     websocket-driver (0.7.5)
       websocket-extensions (>= 0.1.0)
     websocket-extensions (0.1.5)
+    zeitwerk (2.6.7)
 
 PLATFORMS
   x64-mingw32
-  x86_64-linux
 
 DEPENDENCIES
   awesome_print
@@ -130,8 +160,8 @@ DEPENDENCIES
   media_types-serialization!
   minitest (~> 5.0)
   oj
-  rails (~> 5.2)
+  rails (~> 6.0)
   rake (~> 13.0)
 
 BUNDLED WITH
-   2.2.17
+   2.1.4

data/README.md

@@ -887,7 +887,15 @@ Can be used to render a view.
 You can set local variables in the view by assigning a hash to the `assigns:` parameter.
 Returns a `string`
 
-> When possible, prefer `output_raw` with `context.class.render(params)`
+> When possible, prefer `output_raw` with context.render_to_string(params)`
+
+#### `redirect_to(url, context, **options)`
+
+This redirects the user to the specified url when this serializer is rendered. The output of the serializer is still shown in the API viewer.
+
+#### `suppress_render do |result|`
+
+Replaces the render at the end of `render_media` and substitutes it with the contents of the block.
 
 ### Controller definition
 
@@ -916,6 +924,11 @@ Outputs the specified description as help information.
 
 Accepts the same filters as `before_action`.
 
+#### `output_error(klazz, serializers = []) do`
+
+Wraps the controller method in a `rescue_from` and presents the users with a `text/html` or `application/problem+json` representation of the error.
+The `text/html` response can be overridden by supplying an additional serializer in the `serializers` array. It will use the nil view for the given serializers.
+
 #### `allow_input_serializer( serializer, views: nil, **filters )`
 
 Configure the controller to allow the client to send bodies with a `Content-Type` that can be deserialized using the specified serializer.

data/lib/media_types/serialization/serialization_dsl.rb

@@ -11,10 +11,11 @@ module MediaTypes
         @serialization_links = links
         @serialization_context = context
         @serialization_vary = vary
+        @serialization_custom_render = nil
         super(serializer)
       end
 
-      attr_accessor :serialization_dsl_result
+      attr_accessor :serialization_dsl_result, :serialization_custom_render
 
       def attribute(key, value = {}, &block)
         unless block.nil?
@@ -112,6 +113,23 @@ module MediaTypes
 
         context.serialization_dsl_result
       end
+
+      def redirect_to(url, context, **options)
+        suppress_render do |result|
+          context.redirect_to(
+            url,
+            **options
+          )
+        end
+
+        "Redirecting to: #{url}"
+      end
+
+      def suppress_render(&block)
+        @serialization_custom_render = block || lambda { |result| }
+
+        serialization_dsl_result
+      end
     end
   end
 end

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

@@ -32,6 +32,9 @@ module MediaTypes
             attribute key, value
           end
 
+          hidden do
+            link :type, href: problem.type
+          end
           attribute :type, problem.type
           attribute :title, title unless title.nil?
           attribute :detail, detail unless detail.nil?
@@ -51,6 +54,10 @@ module MediaTypes
             end
           end.compact.first || problem.translations.keys.first
           translation = problem.translations[translation_entry]
+          
+          hidden do
+            link :type, href: problem.type
+          end
 
           title = translation[:title]
           detail = translation[:detail] || problem.error.message

data/lib/media_types/serialization/version.rb

@@ -2,6 +2,6 @@
 
 module MediaTypes
   module Serialization
-    VERSION = '1.3.9'
+    VERSION = '1.4.0'
   end
 end

data/lib/media_types/serialization.rb

@@ -321,7 +321,7 @@ module MediaTypes
         end
       end
 
-      def output_error(klazz)
+      def output_error(klazz, serializers: [])
         rescue_from klazz do |error|
           problem = Problem.new(error)
           instance_exec { yield problem, error, self } if block_given?
@@ -331,7 +331,7 @@ module MediaTypes
 
           render_media(
             problem,
-            serializers: [registrations],
+            serializers: [registrations] + serializers.map { |s| s.outputs_for(views: [nil])},
             status: problem.response_status_code
           )
         end
@@ -663,9 +663,13 @@ module MediaTypes
         return
       end
 
-      render body: result, **options
+      if context.serialization_custom_render.nil?
+        render body: result, **options
 
-      response.content_type = registrations.identifier_for(identifier)
+        response.content_type = registrations.identifier_for(identifier)
+      else
+        context.serialization_custom_render.call(result)
+      end
     end
   end
 end

data/media_types-serialization.gemspec

@@ -35,13 +35,13 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'actionpack', '>= 4.0.0'
-  spec.add_dependency 'activesupport', '>= 4.0.0'
-  spec.add_dependency 'media_types', '>= 2.1.1', '< 3.0.0'
+  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_development_dependency 'awesome_print'
   spec.add_development_dependency 'bundler'
-  spec.add_development_dependency 'rails', '~> 5.2'
+  spec.add_development_dependency 'rails', '~> 6.0'
   spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'minitest', '~> 5.0'
   spec.add_development_dependency 'oj'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: media_types-serialization
 version: !ruby/object:Gem::Version
-  version: 1.3.9
+  version: 1.4.0
 platform: ruby
 authors:
 - Derk-Jan Karrenbeld
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-11-04 00:00:00.000000000 Z
+date: 2023-03-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -17,35 +17,35 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: 6.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: 6.0.0
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: 6.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: 6.0.0
 - !ruby/object:Gem::Dependency
   name: media_types
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.1.1
+        version: 2.2.0
     - - "<"
       - !ruby/object:Gem::Version
         version: 3.0.0
@@ -55,7 +55,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.1.1
+        version: 2.2.0
     - - "<"
       - !ruby/object:Gem::Version
         version: 3.0.0
@@ -93,14 +93,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '6.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement