media_types-serialization 1.0.2 → 1.3.0

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

@@ -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

@@ -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

@@ -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

@@ -1,5 +1,5 @@
 module MediaTypes
   module Serialization
-    VERSION = '1.0.2'.freeze
+    VERSION = '1.3.0'.freeze
   end
 end

data/media_types-serialization.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
 
     spec.metadata['homepage_uri'] = spec.homepage
     spec.metadata['source_code_uri'] = spec.homepage
-    spec.metadata['changelog_uri'] = spec.homepage + '/CHANGELOG.md'
+    spec.metadata['changelog_uri'] = spec.homepage + '/blob/master/CHANGELOG.md'
   else
     raise 'RubyGems 2.0 or newer is required to protect against ' \
       'public gem pushes.'
@@ -38,8 +38,6 @@ Gem::Specification.new do |spec|
   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_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'

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: media_types-serialization
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.3.0
 platform: ruby
 authors:
 - Derk-Jan Karrenbeld
 - Max Maton
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-04-17 00:00:00.000000000 Z
+date: 2021-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -59,40 +59,6 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: 3.0.0
-- !ruby/object:Gem::Dependency
-  name: http_headers-accept
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.2.2
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 1.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:
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: awesome_print
   requirement: !ruby/object:Gem::Requirement
@@ -177,7 +143,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - derk-jan@xpbytes.com
 - max@delftsolutions.nl
@@ -196,6 +162,7 @@ files:
 - ".idea/modules.xml"
 - ".idea/runConfigurations/test.xml"
 - ".idea/vcs.xml"
+- ".prettierrc"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -219,6 +186,9 @@ files:
 - 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
 - media_types-serialization.gemspec
 homepage: https://github.com/XPBytes/media_types-serialization
@@ -227,8 +197,8 @@ licenses:
 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: 
+  changelog_uri: https://github.com/XPBytes/media_types-serialization/blob/master/CHANGELOG.md
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -243,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: []