media_types-serialization 0.6.2 → 0.7.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e372ca567cb0169a0f1b497cb3f287f8ad8d83aa6416eb5c6cfcdfe6d6ca3774
-  data.tar.gz: ae99ee2759337f6f196014556e508859bc0fa942e16acd9b1b582a7637bd3938
+  metadata.gz: 9d865beb9427149817eab4cefff9778571c295259c1779351fd720d46276f312
+  data.tar.gz: c96c8372252d7f832028870ea74bfb1972a0f7c56325fa38492a81f21df17fab
 SHA512:
-  metadata.gz: ba7aa0f87e556d4304ec040b1f875749ddf2ec580467458d19058294b3ac54816b5d24d5915a64303b0d0a275b2bb6d24fa5e195958267753c93cb7e2de6542a
-  data.tar.gz: f0fbb8190ebbde45274b43336a631ac5c0f0ee38ff1f336c3a308efd75e35b927c754eebc49b019179b05076f293b03316895d2d1ac36b8ea5d4fc5b6f64dfe6
+  metadata.gz: 1204aaa35637f97fafca495a691d2f07524e2e85c7742ebcf94ae6869e38cea9b4a0fa152bca0274aa1db86a43dd377ef98b49036fedae4e2f1b964663e6c444
+  data.tar.gz: cca3b6cfe51cfa3a0785e3f1dbe3d13b5c442d845171408e2e735940eb22aba6bfdefb5769d791e2908878150cd790366f43fc24006d23fce072def4cf43254d

data/.idea/media_types-serialization.iml

@@ -43,13 +43,14 @@
     <orderEntry type="library" scope="PROVIDED" name="crass (v1.0.4, ruby-2.5.3-p105) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="erubi (v1.8.0, ruby-2.5.3-p105) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="globalid (v0.4.2, ruby-2.5.3-p105) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="http_headers-accept (v0.2.2, ruby-2.5.3-p105) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="http_headers-link (v0.2.1, ruby-2.5.3-p105) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="http_headers-utils (v0.2.0, ruby-2.5.3-p105) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="i18n (v1.6.0, ruby-2.5.3-p105) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="loofah (v2.2.3, ruby-2.5.3-p105) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="mail (v2.7.1, ruby-2.5.3-p105) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="marcel (v0.3.3, ruby-2.5.3-p105) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="media_types (v0.6.1, ruby-2.5.3-p105) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="media_types (v0.6.2, ruby-2.5.3-p105) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="method_source (v0.9.2, ruby-2.5.3-p105) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="mimemagic (v0.3.3, ruby-2.5.3-p105) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="mini_mime (v1.0.1, ruby-2.5.3-p105) [gem]" level="application" />

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Changelog
 
+## 0.7.0.beta1
+
+- 🐛 Fix non-serializer media types replacing known serializers
+- 🐛 Fix passed in media type for HTML as fallback (actual type instead of html)
+- 🐛 Fix passed in media type for API Viewer (actual type instead of API Viewer)
+- 🐛 Fix migrations failing on versioning text/html
+- 🐛 Fix HTML non-overwrite logic (first one wins, unless there is an override)
+- ✨ Add `api_viewer_media_type` param for api viewers to set the serialization type
+- ✨ Add api viewer links in the api viewer:
+  - For representations: use `.api_viewer` unless it's `.html`
+  - For body links: use .api_viewer unless it already has a `.format`
+  - For HTTP links: leave them alone
+  
 ## 0.6.2
 
 - 🐛 Update `http_headers-accept`: 0.2.1 → 0.2.2

data/Gemfile.lock

@@ -1,12 +1,12 @@
 PATH
   remote: .
   specs:
-    media_types-serialization (0.6.2)
+    media_types-serialization (0.7.0.beta1)
       actionpack (>= 4.0.0)
       activesupport (>= 4.0.0)
       http_headers-accept (>= 0.2.2, < 1.0.0)
       http_headers-link (< 1.0.0)
-      media_types (>= 0.6.0)
+      media_types (>= 0.6.2)
       oj (>= 3.5.0)
 
 GEM
@@ -75,7 +75,7 @@ GEM
       mini_mime (>= 0.1.1)
     marcel (0.3.3)
       mimemagic (~> 0.3.2)
-    media_types (0.6.1)
+    media_types (0.6.2)
     method_source (0.9.2)
     mimemagic (0.3.3)
     mini_mime (1.0.1)

data/lib/generators/media_types/serialization/api_viewer/templates/api_viewer.html.erb

@@ -9,7 +9,14 @@
     <%= stylesheet_pack_tag 'application', media: 'all', 'data-turbolinks-track': 'reload' %>
     <%= javascript_pack_tag 'application', 'data-turbolinks-track': 'reload' %>
   </head>
-
+<%
+def replace_link(full_match)
+  href = full_match[9...-1]
+  '"href": "%s"' % link_to(href.gsub('%7B', '{').gsub('%7D', '}'), href).html_safe
+rescue
+  full_match
+end
+%>
   <body class="container h-100" style="overflow: auto; justify-content: start">
 
     <%# Remove the # below to show a logo %>
@@ -65,10 +72,7 @@
                 .gsub('<', '&lt;')
                 .gsub('>', '&gt;')
                 .gsub('\n', "<br>")%>
-<%= code.gsub(/"href": "(http(?:s?:\/\/.*?))"/) { |full_match|
-  href = full_match[9...-1]
-  '"href": "' + link_to(href.gsub('%7B', '{').gsub('%7D', '}'), href).html_safe + '"' rescue full_match
-}.html_safe %></code></pre>
+<%= code.gsub(/"href": "(http(?:s?:\/\/.*?))"/, &method(:replace_link)).html_safe %></code></pre>
         </div>
       </article>
 

data/lib/media_types/serialization.rb

@@ -5,6 +5,7 @@ require 'action_controller/metal/mime_responds'
 require 'action_dispatch/http/mime_type'
 require 'active_support/concern'
 require 'active_support/core_ext/module/attribute_accessors'
+require 'active_support/core_ext/object/blank'
 
 require 'http_headers/accept'
 
@@ -15,6 +16,22 @@ require 'media_types/serialization/wrapper/html_wrapper'
 
 require 'awesome_print'
 
+require 'delegate'
+
+class MediaTypeApiViewer < SimpleDelegator
+  def initialize(inner_media)
+    super inner_media
+  end
+
+  def to_s
+    'application/vnd.xpbytes.api-viewer.v1'
+  end
+
+  def serialize_as
+    __getobj__
+  end
+end
+
 module MediaTypes
   module Serialization
 
@@ -34,6 +51,9 @@ module MediaTypes
       ##
       # Accept serialization using the passed in +serializer+ for the given +view+
       #
+      # By default will also accept the first call to this as HTML
+      # By default will also accept the first call to this as Api Viewer
+      #
       # @see #freeze_accepted_media!
       #
       # @param serializer the serializer to use for serialization. Needs to respond to #to_body, but may respond to
@@ -55,21 +75,34 @@ module MediaTypes
         accept_api_viewer(serializer, view: view, overwrite: false, **filter_opts) if accept_api_viewer
       end
 
+      ##
+      # Accept serialization using the passed in +serializer+ for the given +view+ as text/html
+      #
+      # Always overwrites the current acceptor of text/html. The last call to this, for the giben +filter_opts+ will win
+      # the serialization.
+      #
       def accept_html(serializer, view: [nil], overwrite: true, **filter_opts)
         before_action(**filter_opts) do
-          resolved_media_types(serializer, view: view) do |_, media_view, registered, register|
+          resolved_media_types(serializer, view: view) do |media_type, media_view, registered, register|
             break if registered.call(MEDIA_TYPE_HTML) && !overwrite
-            register.call(MEDIA_TYPE_HTML, wrap_html(serializer, media_view: media_view, media_type: MEDIA_TYPE_HTML))
+            register.call(MEDIA_TYPE_HTML, wrap_html(serializer, media_view: media_view, media_type: media_type))
           end
         end
       end
 
+      ##
+      # Same as +accept_html+ but then for Api Viewer
+      #
       def accept_api_viewer(serializer, view: [nil], overwrite: true, **filter_opts)
         before_action(**filter_opts) do
-          resolved_media_types(serializer, view: view) do |_, media_view, registered, register|
+          fixate_content_type = (params[:api_viewer_media_type] || '').gsub(' ', '+')
+          resolved_media_types(serializer, view: view) do |media_type, media_view, registered, register|
             break if registered.call(MEDIA_TYPE_API_VIEWER) && !overwrite
-            register.call(MEDIA_TYPE_API_VIEWER, wrap_html(serializer, media_view: media_view, media_type: MEDIA_TYPE_API_VIEWER))
-            break
+            if fixate_content_type == '' || fixate_content_type == media_type.to_s
+              wrapped_media_type = MediaTypeApiViewer.new(fixate_content_type.presence || media_type)
+              register.call(MEDIA_TYPE_API_VIEWER, wrap_html(serializer, media_view: media_view, media_type: wrapped_media_type))
+              break
+            end
           end
         end
       end
@@ -88,8 +121,10 @@ module MediaTypes
       #
       def accept_without_serialization(*mimes, **filter_opts)
         before_action(**filter_opts) do
-          self.serializers = Array(mimes).each_with_object(Hash(serializers)) do |mime, res|
-            res[(Mime::Type.lookup_by_extension(mime) || mime).to_s] = nil
+          self.serializers = Hash(serializers)
+          mimes.each do |mime|
+            media_type = Mime::Type.lookup_by_extension(mime) || mime
+            serializers[String(media_type)] = nil
           end
         end
       end
@@ -143,13 +178,21 @@ module MediaTypes
     def respond_to_accept(&block)
       respond_to do |format|
         serializers.each_key do |mime|
-          format.custom(mime, &block)
+          result = yield mime: mime, format: format
+          next unless result
+          format.custom(mime) do
+            result.call
+          end
         end
 
         format.any { raise_no_accept_serializer }
       end
     end
 
+    # def respond_to_viewer(&block)
+    #  TODO: special collector that matches on api_viewer_content_type matches too
+    # end
+
     def request_accept
       @request_accept ||= HttpHeaders::Accept.new(request.get_header(HEADER_ACCEPT) || '')
     end
@@ -168,11 +211,21 @@ module MediaTypes
       raise NoMediaTypeSerializers unless serializers
 
       # Rails negotiation
+      #
+      # The problem with rails negotiation is that it has its own logic for some of the handling that is not
+      # spec compliant. If there is an exact match, that's fine and we leave it like this;
+      #
       if serializers[request.format.to_s]
         return serializers[request.format.to_s]
       end
 
       # Ruby negotiation
+      #
+      # This is similar to the respond_to logic. It sorts the accept values and tries to match against each option.
+      # Currently does not allow for */* or type/*.
+      #
+      # respond_to_accept do ... end
+      #
       request.accepts.each do |mime_type|
         next unless serializers.key?(mime_type.to_s)
         # Override Rails selected format
@@ -186,7 +239,7 @@ module MediaTypes
     def resolved_media_types(serializer, view:)
       self.serializers = Hash(serializers)
 
-      registered = serializers.method(:key)
+      registered = serializers.method(:key?)
       register = serializers.method(:[]=)
 
       Array(view).each do |media_view|
@@ -208,16 +261,22 @@ module MediaTypes
 
     def wrap_html(serializer, media_view:, media_type:)
       lambda do |*args, **opts|
+        inner_media_type = media_type.try(:serialize_as) || media_type
+
         media_serializer = wrap_media(
           serializer,
           media_view: media_view,
-          media_type: media_type
+          media_type: inner_media_type
         ).call(*args, **opts)
 
+        override_mime_type = media_type.respond_to?(:serialize_as) ?
+          "#{media_type.to_s} (#{media_type.serialize_as})" :
+          media_type.to_s
+
         Wrapper::HtmlWrapper.new(
           media_serializer,
           view: media_view,
-          mime_type: media_type.to_s,
+          mime_type: override_mime_type,
           representations: serializers.keys,
           url_context: request.original_fullpath.chomp(".#{request.format.symbol}")
         )

data/lib/media_types/serialization/migrations_command.rb

@@ -9,7 +9,7 @@ module MediaTypes
       end
 
       def call(result, mime_type, view)
-        return result if matches_current_mime_type?(view: view, mime_type: mime_type)
+        return result if mime_type.is_a?(String) || matches_current_mime_type?(view: view, mime_type: mime_type)
 
         migrations.reduce(result) do |migrated, (version, migration)|
           migrated = migration.call(migrated)

data/lib/media_types/serialization/renderer.rb

@@ -24,8 +24,9 @@ module MediaTypes
       elsif Mime::Type.lookup(content_type) == Mime[:html] && obj.respond_to?(:to_html)
         obj.to_html
       elsif content_type === MEDIA_TYPE_API_VIEWER && obj.respond_to?(:to_api_viewer)
-        self.content_type = 'text/html'
-        obj.to_api_viewer
+        obj.to_api_viewer(content_type: options[:api_viewer_content_type]).tap do
+          self.content_type = 'text/html' # because the api viewer will not be seen as
+        end
       else
         obj.to_body(content_type: options.delete(:content_type) || content_type, **options)
       end

data/lib/media_types/serialization/version.rb

@@ -1,5 +1,5 @@
 module MediaTypes
   module Serialization
-    VERSION = '0.6.2'
+    VERSION = '0.7.0.beta1'
   end
 end

data/lib/media_types/serialization/wrapper/html_wrapper.rb

@@ -24,12 +24,13 @@ module MediaTypes
           to_api_viewer(layout: ::MediaTypes::Serialization.html_wrapper_layout)
         end
 
-        def to_api_viewer(layout: ::MediaTypes::Serialization.api_viewer_layout)
+        def to_api_viewer(content_type: nil, layout: ::MediaTypes::Serialization.api_viewer_layout)
           ActionController::Base.render(
             layout || 'serializers/wrapper/html_wrapper',
             assigns: {
               serializer: self,
               view: view,
+              content_type: content_type,
               **render_options
             }
           )

data/media_types-serialization.gemspec

@@ -37,7 +37,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'actionpack', '>= 4.0.0'
   spec.add_dependency 'activesupport', '>= 4.0.0'
-  spec.add_dependency 'media_types', '>= 0.6.0'
+  spec.add_dependency 'media_types', '>= 0.6.2'
   spec.add_dependency 'oj', '>= 3.5.0'
   spec.add_dependency 'http_headers-accept', '>= 0.2.2', '< 1.0.0'
   spec.add_dependency 'http_headers-link', '< 1.0.0'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: media_types-serialization
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.7.0.beta1
 platform: ruby
 authors:
 - Derk-Jan Karrenbeld
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-05-02 00:00:00.000000000 Z
+date: 2019-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: 0.6.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: 0.6.2
 - !ruby/object:Gem::Dependency
   name: oj
   requirement: !ruby/object:Gem::Requirement
@@ -239,9 +239,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.0.3
 signing_key: