RubyGems - media_types-serialization - Versions diffs - 0.8.0 → 1.1.0 - Mend

media_types-serialization 0.8.0 → 1.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (47) hide show

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

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+require 'erb'
+require 'media_types/serialization/base'
+require 'media_types/serialization/utils/accept_language_header'
+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?
+          accept_language_header = Utils::AcceptLanguageHeader.new(context.request.get_header(HEADER_ACCEPT_LANGUAGE) || '')
+          translation_entry = accept_language_header.map do |locale|
+            problem.translations.keys.find do |l|
+              l.start_with? locale.locale
+            end
+          end.compact.first || problem.translations.keys.first
+          translation = problem.translations[translation_entry]
+          title = translation[:title]
+          detail = translation[:detail] || problem.error.message
+          problem.custom_attributes.each do |key, value|
+            attribute key, value
+          end
+          attribute :type, problem.type
+          attribute :title, title unless title.nil?
+          attribute :detail, detail unless detail.nil?
+          attribute :instance, problem.instance unless problem.instance.nil?
+          emit
+        end
+        output_alias 'application/problem+json'
+        output_raw view: :html do |problem, _, context|
+          accept_language_header = Utils::AcceptLanguageHeader.new(context.request.get_header(HEADER_ACCEPT_LANGUAGE) || '')
+          translation_entry = accept_language_header.map do |locale|
+            problem.translations.keys.find do |l|
+              l.starts_with? locale.locale
+            end
+          end.compact.first || problem.translations.keys.first
+          translation = problem.translations[translation_entry]
+          title = translation[:title]
+          detail = translation[:detail] || problem.error.message
+          detail_lang = translation[:detail].nil? ? 'en' : translation_entry
+          input = OpenStruct.new(
+            title: title,
+            detail: detail,
+            help_url: problem.type,
+            css: CommonCSS.css,
+          )
+          template = ERB.new <<-TEMPLATE
+            <html lang="en">
+              <head>
+                <title>Error - <%= CGI::escapeHTML(title) %></title>
+                <style>
+                  <%= css.split("\n").join("\n      ") %>
+                </style>
+              </head>
+              <body>
+                <header>
+                  <div id="logo"></div>
+                  <h1>Error</h1>
+                </header>
+                <section id="content">
+                  <nav>
+                    <section id="description" lang="#{translation_entry}">
+                      <h2><a href="<%= help_url %>"><%= CGI::escapeHTML(title) %></a></h2>
+                    </section>
+                  </nav>
+                  <main lang="#{detail_lang}">
+                    <p><%= detail %>
+                  </main>
+                </section>
+                <!-- Made with ❤ by: https://delftsolutions.com -->
+              </body>
+            </html>
+          TEMPLATE
+          template.result(input.instance_eval { binding })
+        end
+        enable_wildcards
+        output_alias_optional 'text/html', view: :html
+      end
+    end
+  end
+end

data/lib/media_types/serialization/utils/accept_header.rb ADDED Viewed

@@ -0,0 +1,77 @@
+=begin
+The MIT License (MIT)
+Copyright (c) 2019 Derk-Jan Karrenbeld
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+=end
+require 'media_types/serialization/utils/header_list'
+module MediaTypes
+  module Serialization
+    module Utils
+      class AcceptHeader < DelegateClass(Array)
+        def initialize(value)
+          __setobj__ HeaderList.new(value, entry_klazz: AcceptHeader::Entry)
+        end
+        class Entry
+          def initialize(media_type, index:, parameters:)
+            self.media_type = media_type
+            self.parameters = parameters
+            self.index = index
+            freeze
+          end
+          attr_reader :media_type
+          # noinspection RubyInstanceMethodNamingConvention
+          def q
+            parameters.fetch(:q) { 1.0 }.to_f
+          end
+          def <=>(other)
+            quality = other.q <=> q
+            return quality unless quality.zero?
+            index <=> other.send(:index)
+          end
+          def [](parameter)
+            parameters.fetch(String(parameter).to_sym)
+          end
+          def to_header
+            to_s
+          end
+          def to_s
+            [media_type].concat(parameters.map { |k, v| "#{k}=#{v}" }).compact.reject(&:empty?).join('; ')
+          end
+          private
+          attr_writer :media_type
+          attr_accessor :parameters, :index
+        end
+      end
+    end
+  end
+end

data/lib/media_types/serialization/utils/accept_language_header.rb ADDED Viewed

@@ -0,0 +1,82 @@
+=begin
+The MIT License (MIT)
+Copyright (c) 2019 Derk-Jan Karrenbeld
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+=end
+require 'media_types/serialization/utils/header_list'
+module MediaTypes
+  module Serialization
+    module Utils
+      class AcceptLanguageHeader < DelegateClass(Array)
+        def initialize(value)
+          __setobj__ HeaderList.new(value, entry_klazz: Entry)
+        end
+        class Entry
+          DELIMITER = '-'
+          attr_reader :locale, :region, :language
+          def initialize(locale, index:, parameters:)
+            self.locale = locale
+            # TODO: support extlang correctly, maybe we don't even need this
+            self.language, self.region = locale.split(DELIMITER)
+            self.parameters = parameters
+            self.index = index
+            freeze
+          end
+          # noinspection RubyInstanceMethodNamingConvention
+          def q
+            parameters.fetch(:q) { 1.0 }.to_f
+          end
+          def <=>(other)
+            quality = other.q <=> q
+            return quality unless quality.zero?
+            index <=> other.send(:index)
+          end
+          def [](parameter)
+            parameters.fetch(String(parameter).to_sym)
+          end
+          def to_header
+            to_s
+          end
+          def to_s
+            [locale].concat(parameters.map { |k, v| "#{k}=#{v}" }).compact.reject(&:empty?).join('; ')
+          end
+          private
+          attr_writer :locale, :region, :language
+          attr_accessor :parameters, :index
+        end
+      end
+    end
+  end
+end

data/lib/media_types/serialization/utils/header_list.rb ADDED Viewed

@@ -0,0 +1,89 @@
+=begin
+The MIT License (MIT)
+Copyright (c) 2019 Derk-Jan Karrenbeld
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+=end
+module MediaTypes
+  module Serialization
+    module Utils
+      ##
+      # @example Accept values
+      #
+      #   class AcceptHeader < DelegateClass(Array)
+      #     def initialize(value)
+      #       super MediaTypes::Serialization::Utils::HeaderList.new(value, entry_klazz: AcceptHeader::Entry)
+      #     end
+      #
+      #     class Entry
+      #       def initialize(media_type, index: parameters:)
+      #         ...
+      #       end
+      #
+      #       def q
+      #         parameters.fetch(:q) { 1.0 }.to_f
+      #       end
+      #
+      #       def <=>(other)
+      #         quality = other.q <=> q
+      #         return quality unless quality.zero?
+      #         index <=> other.index
+      #       end
+      #     end
+      #   end
+      #
+      #   Accept.new(['*/*; q=0.1', 'application/json, text/html; q=0.8'])
+      #   # => List['application/json', 'text/html', '*/*']
+      #
+      module HeaderList
+        HEADER_DELIMITER    = ','
+        PARAMETER_DELIMITER = ';'
+        module_function
+        def parse(combined, entry_klazz:)
+          Array(combined).map { |line| line.split(HEADER_DELIMITER) }.flatten.each_with_index.map do |entry, index|
+            value, *parameters = entry.strip.split(PARAMETER_DELIMITER)
+            indexed_parameters = ::Hash[Array(parameters).map { |p| p.strip.split('=') }].transform_keys!(&:to_sym)
+            entry_klazz.new(value, index: index, parameters: indexed_parameters)
+          end
+        end
+        def new(combined, entry_klazz:)
+          result = parse(combined, entry_klazz: entry_klazz)
+          entry_klazz.instance_methods(false).include?(:<=>) ? result.sort! : result
+        end
+        def to_header(list)
+          # noinspection RubyBlockToMethodReference
+          list.map { |entry| stringify_entry(entry) }
+              .join("#{HEADER_DELIMITER} ")
+        end
+        def stringify_entry(entry)
+          return entry.to_header if entry.respond_to?(:to_header)
+          return entry.to_s if entry.respond_to?(:to_s)
+          entry.inspect
+        end
+      end
+    end
+  end
+end

data/lib/media_types/serialization/version.rb CHANGED Viewed

@@ -1,5 +1,5 @@
 module MediaTypes
   module Serialization
-    VERSION = '0.8.0'
+    VERSION = '1.1.0'.freeze
   end
 end

data/media_types-serialization.gemspec CHANGED Viewed

@@ -1,50 +1,48 @@
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'media_types/serialization/version'
-Gem::Specification.new do |spec|
-  spec.name          = 'media_types-serialization'
-  spec.version       = MediaTypes::Serialization::VERSION
-  spec.authors       = ['Derk-Jan Karrenbeld']
-  spec.email         = ['derk-jan@xpbytes.com']
-  spec.summary       = 'Add media types supported serialization using your favourite serializer'
-  spec.homepage      = 'https://github.com/XPBytes/media_types-serialization'
-  spec.license       = 'MIT'
-  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
-  # to allow pushing to a single host or delete this section to allow pushing to any host.
-  if spec.respond_to?(:metadata)
-    # spec.metadata['allowed_push_host'] = 'TODO: Set to 'http://mygemserver.com''
-    spec.metadata['homepage_uri'] = spec.homepage
-    spec.metadata['source_code_uri'] = spec.homepage
-    spec.metadata['changelog_uri'] = spec.homepage + '/CHANGELOG.md'
-  else
-    raise 'RubyGems 2.0 or newer is required to protect against ' \
-      'public gem pushes.'
-  end
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  end
-  spec.bindir        = 'exe'
-  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', '>= 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'
-  spec.add_development_dependency 'awesome_print'
-  spec.add_development_dependency 'bundler', '~> 2.0'
-  spec.add_development_dependency 'rails', '~> 5.2'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'minitest', '~> 5.0'
-end
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'media_types/serialization/version'
+Gem::Specification.new do |spec|
+  spec.name          = 'media_types-serialization'
+  spec.version       = MediaTypes::Serialization::VERSION
+  spec.authors       = ['Derk-Jan Karrenbeld', 'Max Maton']
+  spec.email         = ['derk-jan@xpbytes.com', 'max@delftsolutions.nl']
+  spec.summary       = 'Add media types supported serialization using your favourite serializer'
+  spec.homepage      = 'https://github.com/XPBytes/media_types-serialization'
+  spec.license       = 'MIT'
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    # spec.metadata['allowed_push_host'] = 'TODO: Set to 'http://mygemserver.com''
+    spec.metadata['homepage_uri'] = spec.homepage
+    spec.metadata['source_code_uri'] = spec.homepage
+    spec.metadata['changelog_uri'] = spec.homepage + '/CHANGELOG.md'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
+  end
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  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.0.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 'rake', '~> 13.0'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'oj'
+end