media_types-serialization 0.8.1 → 1.0.1

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

@@ -0,0 +1,168 @@
+# frozen_string_literal: true
+
+require 'erb'
+require 'base64'
+require 'active_support'
+
+module MediaTypes
+  module Serialization
+    module Serializers
+      module CommonCSS
+
+        mattr_accessor :logo_data, :logo_media_type, :logo_width, :background, :custom_css
+
+        self.background = 'linear-gradient(245deg, rgba(255,89,89,1) 0%, rgba(255,164,113,1) 100%)'
+        self.logo_media_type = 'image/svg+xml'
+        self.logo_width = 8
+        self.logo_data = <<-HERE
+							<svg version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" viewBox="0 0 114 93">
+                <title>Delft Solutions</title>
+
+                <filter id="dropshadow">
+                  <feGaussianBlur in="SourceAlpha" stdDeviation="1"></feGaussianBlur> <!-- stdDeviation is how much to blur -->
+                  <feOffset dx="2" dy="1" result="offsetblur"></feOffset> <!-- how much to offset -->
+                  <feComponentTransfer>
+                    <feFuncA type="linear" slope="0.5"></feFuncA> <!-- slope is the opacity of the shadow -->
+                  </feComponentTransfer>
+                  <feMerge>
+                    <feMergeNode></feMergeNode> <!-- this contains the offset blurred image -->
+                    <feMergeNode in="SourceGraphic"></feMergeNode> <!-- this contains the element that the filter is applied to -->
+                  </feMerge>
+                </filter>
+
+                <g stroke="none" stroke-width="1" fill="none" fill-rule="evenodd">
+                    <g fill="#FFFFFF" fill-rule="nonzero">
+
+                      <path d="M81.5784638,1.07718279e-13 C82.7664738,1.07718279e-13 83.8032488,0.734079641 84.4157016,1.75205281 L109.531129,43.5095713 C110.813908,45.6417099 110.657922,48.2974919 109.15835,50.2831454 L80.6973102,87.9923196 C80.0557678,88.7870619 79.0855103,89.3973447 78.0602378,89.3973447 L42.8594985,89.3973447 L14.6289023,43.5796094 L38.1043811,13.5281311 L47.8307983,13.5281311 L25.7347121,43.6175319 L48.0361926,79.9158441 L75.0253918,79.9158441 L101.326814,46.2820182 L73.5454136,1.07718279e-13 L81.5784638,1.07718279e-13 Z M68.8174965,0.000338312914 L96.4191607,45.9808751 L73.2382461,75.6684695 L61.4283598,75.6684695 L84.975762,45.385564 L63.4142078,9.46643441 L36.1380842,9.46643441 L9.60299852,43.3032035 L35.9112712,85.3931029 L38.1241857,89.3191214 L29.1498474,89.3973434 C27.9592604,89.4075947 26.8506993,88.7919375 26.2302294,87.7757572 L0.893096605,46.2796422 C-0.418595034,44.1314075 -0.274907213,41.3978442 1.25477457,39.3989643 L30.388821,1.32865425 L30.4563519,1.24328222 C31.0981823,0.458113729 32.0600455,0.000338312914 33.0779839,0.000338312914 L68.8174965,0.000338312914 Z" id="logo-mark-colour"></path>
+                    </g>
+                </g>
+            </svg>
+        HERE
+
+        def self.logo_url
+          "data:#{logo_media_type};base64,#{Base64.encode64(logo_data).tr("\n", '')}"
+        end
+
+        def self.css
+          template = ERB.new <<-TEMPLATE
+          html {
+            min-height: 100%;
+            background: <%= background %>;
+          }
+
+          body {
+            color: #fff;
+            margin-left: 10em;
+            margin-right: 10em;
+            margin-top: 1em;
+
+            font-family: -apple-system, ".SFNSText-Regular", "San Francisco", "Roboto", "Segoe UI", "Helvetica Neue", "Lucida Grande", sans-serif;
+						font-size: 16px;
+						line-height: 1.6;
+						-webkit-font-feature-settings: "kern","liga","clig","calt";
+						font-feature-settings: "kern","liga","clig","calt";
+						-webkit-font-smoothing: antialiased;
+						-moz-osx-font-smoothing: grayscale
+          }
+
+          header {
+            display: inline-block;
+          }
+
+          a:link {
+            color: #293590;
+          }
+          a:visited {
+            color: #080F43;
+          }
+          a:hover {
+            color: #5E7EFF;
+          }
+          
+          #logo {
+            width: <%= logo_width %>em;
+            height: 6em;
+						background-repeat: no-repeat;
+						background-position-x: right;
+						background-position-y: center;
+            background-image: url(<%= logo_url %>);
+            float: left;
+            margin-right: 0.75em;
+          }
+
+          header h1 {
+            clear: right;
+            text-overflow: ellipsis;
+            white-space: nowrap;
+            overflow: hidden;
+          }
+
+          #content {
+            margin-top: 1em;
+            padding-left: 3em;
+            padding-right: 3em;
+            padding-bottom: 3em;
+            color: #060B34;
+            background-color: #fff;
+            border-radius: 1em;
+            border: 1px solid #E0E1E4;
+          }
+
+          nav h2 {
+            font-size: 1em;
+            line-height: 1.25em;
+            margin-bottom: 0;
+          }
+          nav .label {
+            float: left;
+          }
+
+          nav ul {
+            clear: right;
+            display: inline-block;
+            margin: 0;
+            padding: 0;
+          }
+          nav li {
+            float: left;
+            list-style: none;
+            margin-right: 0.3em;
+          }
+          nav li a.active {
+            font-weight: bold;
+          }
+          nav li a.active:link, nav li a.active:visited {
+            color: #060B34;
+          }
+          nav li + li:before {
+            content: "|";
+            margin-right: 0.3em;
+          }
+
+          nav #representations {
+            margin-left: -2em;
+            margin-right: -2em;
+            margin-bottom: 2em;
+          }
+          nav hr {
+            border: none;
+            border-top: solid 1px #E0E1E4;
+          }
+
+          nav #links {
+            display: inline-block;
+            margin-bottom: 1em;
+          }
+          nav #links ul {
+            float: left;
+          }
+
+          TEMPLATE
+          template = ERB.new custom_css unless custom_css.nil?
+
+          template.result(binding())
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,80 @@
+
+# frozen_string_literal: true
+
+require 'media_types/serialization/base'
+
+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
+        end
+        def self.to_output_identifiers(serializers)
+          serializers.flat_map do |s|
+            s[:serializer].outputs_for(views: [s[:view]]).registrations.keys
+          end
+        end
+
+        output version: 1 do |input, version, context|
+          request_path = context.request.original_fullpath.split('?')[0]
+
+          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.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
+            end
+          end
+
+          input_definitions = input[:actions][:input] || {}
+          output_definitions = input[:actions][:output] || {}
+          viewer_definitions = input[:api_viewer] || {}
+
+          result = {}
+          global_in = input_definitions['all_actions'] || []
+          global_out = output_definitions['all_actions'] || []
+          global_viewer = viewer_definitions['all_actions'] || false
+
+          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('&')
+
+          methods_available.each do |method, action|
+            has_viewer = viewer_definitions[action] || global_viewer
+            input_serializers = global_in + (input_definitions[action] || [])
+            output_serializers = global_out + (output_definitions[action] || [])
+            result[method] = {
+              input: to_input_identifiers(input_serializers),
+              output: to_output_identifiers(output_serializers),
+            }
+
+            result[method].delete(:input) if method == 'GET'
+            result[method][:api_viewer] = viewer_uri.to_s if has_viewer
+          end
+
+          result
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+require 'media_types/serialization/base'
+
+module MediaTypes
+  module Serialization
+    module Serializers
+      # The serializer used when no serializer has been configured.
+      class FallbackNotAcceptableSerializer < MediaTypes::Serialization::Base
+        unvalidated 'text/html'
+
+        output_raw do |obj, version, context|
+
+          available_types = []
+          begin
+            original_uri = URI.parse(context.request.original_url)
+            stripped_original = original_uri.dup
+            query_parts = stripped_original.query&.split('&') || []
+            query_parts = query_parts.select { |q| !q.start_with? 'api_viewer=' }
+
+            available_types = obj[:registrations].registrations.keys.map do |identifier|
+              stripped_original.query = (query_parts + ["api_viewer=#{identifier}"]).join('&')
+              {
+                identifier: identifier,
+                url: stripped_original.to_s,
+              }
+            end
+          rescue URI::InvalidURIError
+            available_types = obj[:registrations].registrations.keys.map do |identifier|
+              {
+                identifier: identifier,
+                url: context.request.original_url,
+              }
+            end
+          end
+
+          input = OpenStruct.new(
+            media_types: available_types,
+            has_viewer: obj[:has_viewer],
+            css: CommonCSS.css,
+            acceptable_types: obj[:request].headers["Accept"] || "<none>",
+          )
+
+          template = ERB.new <<-TEMPLATE
+            <html lang="en">
+              <head>
+                <title>Unable to provide requested media types</title>
+                <style>
+                  <%= css.split("\n").join("\n      ") %>
+                </style>
+              </head>
+              <body>
+                <header>
+                  <div id="logo"></div>
+                  <h1>Not acceptable</h1>
+                </header>
+                <section id="content">
+                  <nav>
+                    <section id="representations">
+                      <h2>Please choose one of the following types:</h2>
+                      <p>This endpoint tried really hard to show you the information you requested. Unfortunately you specified in your <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept">Accept header</a> that you only wanted to see the following types: <code><%= CGI::escapeHTML(acceptable_types) %></code>.
+                      <p>Please add one of the following types to your Accept header to see the content or error message:
+                      <hr>
+                    </section>
+                  </nav>
+                  <main>
+                    <% media_types.each do |m| %>
+                    <li>
+                      <a href="<%= m[:url] %>">
+                        <%= CGI::escapeHTML(m[:identifier]) %>
+                      </a>
+                    </li>
+                    <% end %>
+                  </main>
+                </section>
+                <!-- API viewer made with ❤ by: https://delftsolutions.com -->
+              </body>
+            </html>
+          TEMPLATE
+          template.result(input.instance_eval { binding })
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require 'media_types/serialization/base'
+
+module MediaTypes
+  module Serialization
+    module Serializers
+      # The serializer used when no serializer has been configured.
+      class FallbackUnsupportedMediaTypeSerializer < MediaTypes::Serialization::Base
+        unvalidated 'text/html'
+
+        output_raw do |obj, version, context|
+
+          available_types = obj[:registrations].registrations.keys
+
+          input = OpenStruct.new(
+            media_types: available_types,
+            css: CommonCSS.css
+          )
+
+          template = ERB.new <<-TEMPLATE
+            <html lang="en">
+              <head>
+                <title>Unsupported Media Type</title>
+                <style>
+                  <%= css.split("\n").join("\n      ") %>
+                </style>
+              </head>
+              <body>
+                <header>
+                  <div id="logo"></div>
+                  <h1>Unsupported Media Type</h1>
+                </header>
+                <section id="content">
+                  <nav>
+                    <section id="representations">
+                      <h2>Please use one of the following <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Type">Content-Types</a> when making your request:</h2>
+                      <hr>
+                    </section>
+                  </nav>
+                  <main>
+                    <% media_types.each do |m| %>
+                    <li>
+                      <%= CGI::escapeHTML(m) %>
+                    </li>
+                    <% end %>
+                  </main>
+                </section>
+                <!-- API viewer made with ❤ by: https://delftsolutions.com -->
+              </body>
+            </html>
+          TEMPLATE
+          template.result(input.instance_eval { binding })
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+require 'media_types/serialization/base'
+require 'erb'
+require 'cgi'
+
+module MediaTypes
+  module Serialization
+    module Serializers
+      class InputValidationErrorSerializer < MediaTypes::Serialization::Base
+        unvalidated 'text/html'
+
+        def self.escape_text(text)
+          text.split("\n").
+            map { |l| CGI::escapeHTML(l).gsub(/ (?= )/, '&nbsp;') }.
+            map { |l| (l.gsub(/\bhttps?:\/\/[-A-Z0-9+&@#\/%?=~_|!:,.;{}]*[-A-Z0-9+@#\/%=}~_|](?![a-z]*;)/i) do |m|
+              converted = m
+              invalid = false
+              begin
+                converted = viewerify(m, context.request.host)
+              rescue URI::InvalidURIError
+                invalid = true
+              end
+              style = ''
+              style = ' style="color: red"' if invalid
+              "<a#{style} href=\"#{converted}\">#{m}</a>"
+            end) }.
+            join("<br>\n")
+        end
+
+        output_raw do |obj, version, context|
+          input_identifier = obj[:identifier]
+          original_input = obj[:input]
+          error = obj[:error]
+
+          escaped_error = escape_text(error.message)
+          escaped_input = escape_text(original_input)
+
+          input = OpenStruct.new(
+            original_identifier: input_identifier,
+            escaped_error: escaped_error,
+            escaped_input: escaped_input,
+            css: CommonCSS.css,
+          )
+
+          template = ERB.new <<-TEMPLATE
+            <html lang="en">
+              <head>
+                <title>Invalid input detected</title>
+                <style>
+                  <%= css.split("\n").join("\n      ") %>
+                </style>
+              </head>
+              <body>
+                <header>
+                  <div id="logo"></div>
+                  <h1>Invalid input detected</h1>
+                </header>
+                <section id="content">
+                  <nav>
+                    <section id="representations">
+                      <h2>While trying to process the <%= CGI::escapeHTML(original_identifier) %> input you sent; I encountered the following error:</h2>
+                      <hr>
+                    </section>
+                  </nav>
+                  <main>
+                    <section id="error">
+                      <code id="error">
+                        <%= escaped_error %>
+                      </code>
+                    </section>
+                    <section id="input">
+                      <h2>Original input:</h2>
+                      <code id="input">
+                        <%= escaped_input %>
+                      </code>
+                    </section>
+                  </main>
+                </section>
+                <!-- API viewer made with ❤ by: https://delftsolutions.com -->
+              </body>
+            </html>
+          TEMPLATE
+          template.result(input.instance_eval { binding })
+        end
+      end
+    end
+  end
+end