media_types-serialization 0.8.0 → 1.1.0

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: media_types-serialization
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Derk-Jan Karrenbeld
-autorequire: 
+- Max Maton
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-10-29 00:00:00.000000000 Z
+date: 2021-06-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -44,62 +45,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.6.2
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.6.2
-- !ruby/object:Gem::Dependency
-  name: oj
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.5.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.5.0
-- !ruby/object:Gem::Dependency
-  name: http_headers-accept
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.2.2
+        version: 2.0.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 3.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.2
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 1.0.0
-- !ruby/object:Gem::Dependency
-  name: http_headers-link
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 1.0.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
+        version: 2.0.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: awesome_print
   requirement: !ruby/object:Gem::Requirement
@@ -118,16 +77,16 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -148,14 +107,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -170,9 +129,24 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
-description: 
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description:
 email:
 - derk-jan@xpbytes.com
+- max@delftsolutions.nl
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -188,7 +162,7 @@ files:
 - ".idea/modules.xml"
 - ".idea/runConfigurations/test.xml"
 - ".idea/vcs.xml"
-- ".travis.yml"
+- ".prettierrc"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -198,29 +172,24 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
-- lib/generators/media_types/serialization/api_viewer/api_viewer_generator.rb
-- lib/generators/media_types/serialization/api_viewer/templates/api_viewer.html.erb
-- lib/generators/media_types/serialization/api_viewer/templates/initializer.rb
-- lib/generators/media_types/serialization/api_viewer/templates/template_controller.rb
+- lib/media_types/problem.rb
 - lib/media_types/serialization.rb
 - lib/media_types/serialization/base.rb
 - lib/media_types/serialization/error.rb
-- lib/media_types/serialization/media_type/register.rb
-- lib/media_types/serialization/migrations_command.rb
-- lib/media_types/serialization/migrations_support.rb
-- lib/media_types/serialization/mime_type_support.rb
-- lib/media_types/serialization/no_content_type_given.rb
-- lib/media_types/serialization/no_media_type_serializers.rb
-- lib/media_types/serialization/no_serializer_for_content_type.rb
-- lib/media_types/serialization/renderer.rb
-- lib/media_types/serialization/renderer/register.rb
+- lib/media_types/serialization/fake_validator.rb
+- lib/media_types/serialization/serialization_dsl.rb
+- lib/media_types/serialization/serialization_registration.rb
+- lib/media_types/serialization/serializers/api_viewer.rb
+- lib/media_types/serialization/serializers/common_css.rb
+- lib/media_types/serialization/serializers/endpoint_description_serializer.rb
+- lib/media_types/serialization/serializers/fallback_not_acceptable_serializer.rb
+- lib/media_types/serialization/serializers/fallback_unsupported_media_type_serializer.rb
+- lib/media_types/serialization/serializers/input_validation_error_serializer.rb
+- lib/media_types/serialization/serializers/problem_serializer.rb
+- lib/media_types/serialization/utils/accept_header.rb
+- lib/media_types/serialization/utils/accept_language_header.rb
+- lib/media_types/serialization/utils/header_list.rb
 - lib/media_types/serialization/version.rb
-- lib/media_types/serialization/wrapper.rb
-- lib/media_types/serialization/wrapper/html_wrapper.rb
-- lib/media_types/serialization/wrapper/media_collection_wrapper.rb
-- lib/media_types/serialization/wrapper/media_index_wrapper.rb
-- lib/media_types/serialization/wrapper/media_object_wrapper.rb
-- lib/media_types/serialization/wrapper_support.rb
 - media_types-serialization.gemspec
 homepage: https://github.com/XPBytes/media_types-serialization
 licenses:
@@ -229,7 +198,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/CHANGELOG.md
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -244,8 +213,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 4
 summary: Add media types supported serialization using your favourite serializer
 test_files: []

data/.travis.yml

@@ -1,17 +0,0 @@
----
-sudo: false
-language: ruby
-cache: bundler
-rvm:
-  - 2.5
-  - 2.6
-  - ruby-head
-before_install:
-  - gem install bundler -v 2.0.1
-  - gem update --system
-  - gem --version
-matrix:
-  allow_failures:
-    - rvm: ruby-head
-install:
-  - bundle install --with development --jobs=3 --retry=3 --path=${BUNDLE_PATH:-vendor/bundle}

data/lib/generators/media_types/serialization/api_viewer/api_viewer_generator.rb

@@ -1,25 +0,0 @@
-require 'rails/generators/base'
-
-module MediaTypes
-  module Serialization
-    class ApiViewerGenerator < Rails::Generators::Base
-      source_root File.expand_path('templates', __dir__)
-
-      def copy_controllers
-        copy_file "template_controller.rb", "app/controllers/api/template_controller.rb"
-      end
-
-      def copy_views
-        copy_file "api_viewer.html.erb", "app/views/serializers/wrapper/html_wrapper.html.erb"
-      end
-
-      def copy_initializer
-        copy_file "initializer.rb", "config/initializers/media_types_serialization.rb"
-      end
-
-      def add_route
-        route "namespace :api do\n  match '/template', controller: :template, action: :create, via: %i[get post], as: :template\nend\n\n"
-      end
-    end
-  end
-end

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

@@ -1,98 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-  <head>
-    <title>API Viewer</title>
-    <%= csrf_meta_tags %>
-    <%= csp_meta_tag %>
-
-    <% # The following expects webpacker to be active, but you can replace these if you use the sprockets pipeline %>
-    <%= 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 %>
-    <%# link_to Rails.application.routes.url_helpers.root_path do %>
-      <%# render 'shared/logo', assigns: { width: 300, height: 63, style: "flex-shrink: 0; margin: 20px 0 40px" } %>
-    <%# end %>
-
-    <div class="h-auto w-100 mb-4">
-      <% links = @serializer.send(:header_links) %>
-      <% if links.present? %>
-        <nav class="card w-100 mb-4 card--inverse">
-          <div class="card-header">
-            <h5 class="card-title my-auto">HTTP Links</h5>
-          </div>
-          <ul class="list-group list-group-flush">
-            <% links.each do |key, link| %>
-              <% href = link && link[:href] || next %>
-              <li class="list-group-item">
-                <% if link[:templated] %>
-                  <%# You need to add this route to your routes file; Use the provided generator %>
-                  <%# rails g api_viewer %>
-                  <%= form_tag Rails.application.routes.url_helpers.api_template_path, { method: :get, class: 'link-template-form' } do %>
-                    <%= hidden_field_tag 'template[href]', href %>
-                    <button type="submit"><strong><%= key %></strong></button>
-                    <code><%= href.gsub(/:([a-z][^\/]*)|(?:{|%7B)([a-z][^\/{}]*)(%7D|})/) do |match|
-                      tag = match.tr(':{}', '').delete('%7B').delete('%7D')
-                      text_field_tag('template[%s]' % tag, nil, placeholder: tag)
-                    end.html_safe %></code>
-                  <% end %>
-                <% else %>
-                  <%= link_to href do %>
-                    <strong><%= key %></strong>
-                    <code><%= href %></code>
-                  <% end %>
-                <% end %>
-              </li>
-            <% end %>
-          </ul>
-        </nav>
-      <% end %>
-
-      <article class="card w-100 mb-4 card--inverse">
-        <div class="card-body">
-          <h5 class="card-title"><%= @mime_type %></h5>
-          <small class="card-subtitle mb-2 text-muted">Serialized by: <%= @serializer.class.name %></small>
-          <pre><code class="code" style="
-          white-space: pre-wrap;
-              white-space: -moz-pre-wrap;
-              white-space: -o-pre-wrap;
-              word-wrap: break-word;"><% code = JSON.pretty_generate(@serializer.to_hash).truncate(50_000)
-                .gsub('</h1>', "</h1>\n")
-                .gsub('</div>', "</div>\n")
-                .gsub('<', '&lt;')
-                .gsub('>', '&gt;')
-                .gsub('\n', "<br>")%>
-<%= code.gsub(/"href": "(http(?:s?:\/\/.*?))"/, &method(:replace_link)).html_safe %></code></pre>
-        </div>
-      </article>
-
-      <nav class="card w-100 mb-4 card--inverse">
-        <div class="card-header">
-          <h5 class="card-title my-auto">Endpoint representations</h5>
-        </div>
-        <ul class="list-group list-group-flush">
-          <% @representations.each do |representation| %>
-            <% mime_type = Mime::Type.lookup(representation) || next %>
-            <li class="list-group-item">
-              <%= link_to (@url_context + ".#{mime_type.symbol}").sub('/.', '.')  do %>
-                <strong><%= representation %></strong>
-                <code><%= mime_type.symbol %></code>
-              <% end %>
-            </li>
-          <% end %>
-        </ul>
-      </nav>
-    </div>
-  </body>
-</html>
-

data/lib/generators/media_types/serialization/api_viewer/templates/initializer.rb

@@ -1,33 +0,0 @@
-require 'media_types/serialization'
-
-# This registers the renderer as side-effect
-require 'media_types/serialization/renderer/register'
-
-# This registers the media type as side-effect
-require 'media_types/serialization/media_type/register'
-
-##
-# The following options are breaking and therefore disabled by default.
-#
-# When these are true, the +header_links+ and +extract_links+ methods is called
-# when dealing with a .collection or .index view, respectively. It allows you
-# to define +_links+ for the root level from your serializer.
-#
-#
-MediaTypes::Serialization.collect_links_for_collection = true
-MediaTypes::Serialization.collect_links_for_index = true
-
-##
-# The API Viewer template is provided if you used the generator. You can change
-# the view it renders by changing the path below.
-#
-#
-# ::MediaTypes::Serialization.api_viewer_layout = '/path/to/wrapper/layout'
-
-##
-# When .to_html is not provided by a serializer, it will fall back to render
-# the API Viewer, but this template can be changed by changing the path
-# below.
-#
-#
-# ::MediaTypes::Serialization.html_wrapper_layout = '/path/to/wrapper/layout'

data/lib/generators/media_types/serialization/api_viewer/templates/template_controller.rb

@@ -1,23 +0,0 @@
-module Api
-  class TemplateController < ApiController
-    def create
-      href = params[:template].delete(:href)
-      templated_values = params[:template].permit!.to_h
-
-      response["Location"] = templated_values.reduce(href) do |result, (key, value)|
-        result.sub!(%r{:#{key}|{#{key}}|%7B#{key}%7D}, value) || invalid_parameter(key, href)
-      end
-      head :temporary_redirect
-    end
-
-    private
-
-    def invalid_parameter(key, href)
-      raise ActionController::BadRequest, format(
-        'Received templated value for "%<key>s" which does not exist in templated link "%<href>s"',
-        key: key,
-        href: href.gsub('%7B', '{').gsub('%7D', '}')
-      )
-    end
-  end
-end

data/lib/media_types/serialization/media_type/register.rb

@@ -1,4 +0,0 @@
-require 'action_dispatch/http/mime_type'
-require 'media_types/serialization'
-
-Mime::Type.register(MediaTypes::Serialization::MEDIA_TYPE_API_VIEWER, :api_viewer)

data/lib/media_types/serialization/migrations_command.rb

@@ -1,38 +0,0 @@
-# frozen_string_literal: true
-#
-module MediaTypes
-  module Serialization
-    class MigrationsCommand
-      def initialize(serializer)
-        self.serializer = serializer
-        self.migrations = {}
-      end
-
-      def call(result, mime_type, view)
-        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)
-          next migrated unless matches_mime_type?(mime_type.version(version), mime_type)
-          break migrated
-        end
-      end
-
-      private
-
-      attr_accessor :serializer, :migrations
-
-      def version(version, &block)
-        migrations[version] = ->(result) { serializer.instance_exec(result, &block) }
-      end
-
-      def matches_current_mime_type?(view:, mime_type:)
-        serializer.class.current_mime_type(view: view) == mime_type.to_s
-      end
-
-      def matches_mime_type?(left, right)
-        left.to_s == right.to_s
-      end
-    end
-  end
-end