rack-linkeddata 2.0.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 09fce0e2585a150bd2ad4344612ca71216188d7e
-  data.tar.gz: 552a7b73cdb1c8546f248b711cb1ab375b9b529a
+SHA256:
+  metadata.gz: 966d05516d9e34419506a0fdaa47a04e61ba51b18630f98f2590fc7d82c1a00b
+  data.tar.gz: 2a616206491f89c318b16beb61a35688965958271dce37b5a0ce412a17568507
 SHA512:
-  metadata.gz: 2a4b51266cce02045005de02a975ce705c5fc33203f813e5afc6b10b68b00e4a5fa259aba9aa0868938d9c0db40cdb33aa114acb78461b0c3b60898169a905de
-  data.tar.gz: 1a3a2359a061e14cca2d0bc9c5fd253a8100cd72fd83a49ecbbc36d723cca90b36cca068df285cd1dd6a0fbb7e70858ebd189f19e436be4ff6e04a42f6326548
+  metadata.gz: 86a3666ae1e6e3e0ef7bc0bb730883ccce7063ebe1f7053eead450ad7498dff6aecf9cd2fdadd00f3da9ab5d3acef68696899feb045e8c139c8e1342fcd5e8bc
+  data.tar.gz: e98c08daae3e76e3b3c7c8037b718b5be537be1e1e74578d36f2addaa99d38ec1a1aeb1dcd94eb3c566823d700d13023aad107cd28613663ed263ae8f6c55d8c

data/AUTHORS

@@ -1 +1,2 @@
 * Arto Bendiken <arto.bendiken@gmail.com>
+* Gregg Kellogg <gregg@greggkellogg.net>

data/README.md

@@ -85,7 +85,7 @@ take care of serializing your response into whatever RDF format the HTTP
 client requested and understands.
 
 The middleware queries [RDF.rb][] for the MIME content types of known RDF
-serialization formats, so it will work with whatever serialization plugins
+serialization formats, so it will work with whatever serialization extensions
 that are currently available for RDF.rb. (At present, this includes support
 for N-Triples, N-Quads, Turtle, RDF/XML, RDF/JSON, JSON-LD, RDFa, TriG and TriX.)
 
@@ -98,8 +98,8 @@ for N-Triples, N-Quads, Turtle, RDF/XML, RDF/JSON, JSON-LD, RDFa, TriG and TriX.
 
 ## Dependencies
 
-* [Rack](http://rubygems.org/gems/rack) (~> 1.6)
-* [Linked Data](http://rubygems.org/gems/linkeddata) (~> 2.0)
+* [Rack](http://rubygems.org/gems/rack) (~> 2.0)
+* [Linked Data](http://rubygems.org/gems/linkeddata) (~> 3.1)
 
 ## Installation
 

data/VERSION

@@ -1 +1 @@
-2.0.0
+3.1.0

data/lib/rack/linkeddata.rb

@@ -9,18 +9,18 @@ module Rack
     ##
     # Registers all known RDF formats with Rack's MIME types registry.
     #
+    # @param [Boolean]        :overwrite (false)
     # @param  [Hash{Symbol => Object}] options
-    # @option options [Boolean]        :overwrite (false)
     # @return [void]
-    def self.register_mime_types!(options = {})
+    def self.register_mime_types!(overwrite: false, **options)
       if defined?(Rack::Mime::MIME_TYPES)
         RDF::Format.each do |format|
-          if !Rack::Mime::MIME_TYPES.has_key?(file_ext = ".#{format.to_sym}") || options[:overwrite]
+          if !Rack::Mime::MIME_TYPES.has_key?(file_ext = ".#{format.to_sym}") || overwrite
             Rack::Mime::MIME_TYPES.merge!(file_ext => format.content_type.first)
           end
         end
         RDF::Format.file_extensions.each do |file_ext, formats|
-          if !Rack::Mime::MIME_TYPES.has_key?(file_ext = ".#{file_ext}") || options[:overwrite]
+          if !Rack::Mime::MIME_TYPES.has_key?(file_ext = ".#{file_ext}") || overwrite
             Rack::Mime::MIME_TYPES.merge!(file_ext => formats.first.content_type.first)
           end
         end

data/lib/rack/linkeddata/conneg.rb

@@ -17,6 +17,7 @@ module Rack; module LinkedData
   #     use Rack::LinkedData::ContentNegotiation, :default => 'application/rdf+xml'
   #
   # @see http://www4.wiwiss.fu-berlin.de/bizer/pub/LinkedDataTutorial/
+  # @see https://www.rubydoc.info/github/rack/rack/master/file/SPEC
   class ContentNegotiation
     DEFAULT_CONTENT_TYPE = "application/n-triples" # N-Triples
     VARY = {'Vary' => 'Accept'}.freeze
@@ -31,9 +32,9 @@ module Rack; module LinkedData
     # @param  [#call]                  app
     # @param  [Hash{Symbol => Object}] options
     #   Other options passed to writer.
-    # @option options [String] :default (DEFAULT_CONTENT_TYPE) Specific content type
+    # @param [String] :default (DEFAULT_CONTENT_TYPE) Specific content type
     # @option options [RDF::Format, #to_sym] :format Specific RDF writer format to use
-    def initialize(app, options = {})
+    def initialize(app, options)
       @app, @options = app, options
       @options[:default] = (@options[:default] || DEFAULT_CONTENT_TYPE).to_s
     end
@@ -45,7 +46,7 @@ module Rack; module LinkedData
     # Inserts ordered content types into the environment as `ORDERED_CONTENT_TYPES` if an Accept header is present
     #
     # @param  [Hash{String => String}] env
-    # @return [Array(Integer, Hash, #each)]
+    # @return [Array(Integer, Hash, #each)] Status, Headers and Body
     # @see    http://rack.rubyforge.org/doc/SPEC.html
     def call(env)
       env['ORDERED_CONTENT_TYPES'] = parse_accept_header(env['HTTP_ACCEPT']) if env.has_key?('HTTP_ACCEPT')
@@ -63,28 +64,43 @@ module Rack; module LinkedData
     # Serializes an `RDF::Enumerable` response into a Rack protocol
     # response using HTTP content negotiation rules or a specified Content-Type.
     #
+    # Passes parameters from Accept header, and Link header to writer.
+    #
     # @param  [Hash{String => String}] env
     # @param  [Integer]                status
     # @param  [Hash{String => Object}] headers
     # @param  [RDF::Enumerable]        body
-    # @return [Array(Integer, Hash, #each)]
+    # @return [Array(Integer, Hash, #each)] Status, Headers and Body
     def serialize(env, status, headers, body)
-      begin
-        writer, content_type = find_writer(env, headers)
-        if writer
-          # FIXME: don't overwrite existing Vary headers
-          headers = headers.merge(VARY).merge('Content-Type' => content_type)
-          [status, headers, [writer.dump(body, nil, @options)]]
-        else
-          not_acceptable
+      result, content_type = nil, nil
+      find_writer(env, headers) do |writer, ct, accept_params = {}|
+        begin
+          # Passes content_type as writer option to allow parameters to be extracted.
+          writer_options = @options.merge(
+            accept_params: accept_params,
+            link: env['HTTP_LINK']
+          )
+          result, content_type = writer.dump(body, nil, **writer_options), ct.split(';').first
+          break
+        rescue RDF::WriterError
+          # Continue to next writer
+          ct
+        rescue
+          ct
         end
-      rescue RDF::WriterError => e
+      end
+
+      if result
+        headers = headers.merge(VARY).merge('Content-Type' => content_type)
+        [status, headers, [result]]
+      else
         not_acceptable
       end
     end
 
+    protected
     ##
-    # Returns an `RDF::Writer` class for the given `env`.
+    # Yields an `RDF::Writer` class for the given `env`.
     #
     # If options contain a `:format` key, it identifies the specific format to use;
     # otherwise, if the environment has an HTTP_ACCEPT header, use it to find a writer;
@@ -92,46 +108,56 @@ module Rack; module LinkedData
     #
     # @param  [Hash{String => String}] env
     # @param  [Hash{String => Object}] headers
-    # @return [Array(Class, String)]
+    # @yield |writer, content_type|
+    # @yield_param [RDF::Writer] writer
+    # @yield_param [String] content_type from accept media-range without parameters
+    # @yield_param [Hash{Symbol => String}] accept_params from accept media-range
     # @see    http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html
     def find_writer(env, headers)
       if @options[:format]
         format = @options[:format]
-        writer = RDF::Writer.for(format.to_sym) unless format.is_a?(RDF::Format)
-        return [writer, writer.format.content_type.first] if writer
+        writer = RDF::Writer.for(format.to_sym)
+        yield(writer, writer.format.content_type.first) if writer
       elsif env.has_key?('HTTP_ACCEPT')
         content_types = parse_accept_header(env['HTTP_ACCEPT'])
         content_types.each do |content_type|
-          writer, content_type = find_writer_for_content_type(content_type)
-          return [writer, content_type] if writer
+          find_writer_for_content_type(content_type) do |writer, ct, accept_params|
+            # Yields content type with parameters
+            yield(writer, ct, accept_params)
+          end
         end
-        return nil
       else
         # HTTP/1.1 §14.1: "If no Accept header field is present, then it is
         # assumed that the client accepts all media types"
-        find_writer_for_content_type(options[:default])
+        find_writer_for_content_type(options[:default]) do |writer, ct|
+          # Yields content type with parameters
+          yield(writer, ct)
+        end
       end
     end
 
     ##
-    # Returns an `RDF::Writer` class for the given `content_type`.
+    # Yields an `RDF::Writer` class for the given `content_type`.
+    #
+    # Calls `Writer#accept?(content_type)` for matched content type to allow writers to further discriminate on how if to accept content-type with specified parameters.
     #
     # @param  [String, #to_s] content_type
-    # @return [Array(Class, String)]
+    # @yield |writer, content_type|
+    # @yield_param [RDF::Writer] writer
+    # @yield_param [String] content_type (including media-type parameters)
     def find_writer_for_content_type(content_type)
-      writer = case content_type.to_s
-        when '*/*'
-          RDF::Writer.for(:content_type => (content_type = options[:default]))
-        when /^([^\/]+)\/\*$/
-          nil # TODO: match subtype wildcards
-        else
-          RDF::Writer.for(:content_type => content_type)
+      ct, *params = content_type.split(';').map(&:strip)
+      accept_params = params.inject({}) do |memo, pv|
+        p, v = pv.split('=').map(&:strip)
+        memo.merge(p.downcase.to_sym => v.sub(/^["']?([^"']*)["']?$/, '\1'))
+      end
+      formats = RDF::Format.each(content_type: ct, has_writer: true).to_a.reverse
+      formats.each do |format|
+        yield format.writer, (ct || format.content_type.first), accept_params if
+          format.writer.accept?(accept_params)
       end
-      writer ? [writer, content_type] : nil
     end
 
-    protected
-
     ##
     # Parses an HTTP `Accept` header, returning an array of MIME content
     # types ordered by the precedence rules defined in HTTP/1.1 §14.1.
@@ -141,14 +167,43 @@ module Rack; module LinkedData
     # @see    http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.1
     def parse_accept_header(header)
       entries = header.to_s.split(',')
-      entries.map { |e| accept_entry(e) }.sort_by(&:last).map(&:first)
+      entries = entries.map { |e| accept_entry(e) }.sort_by(&:last).map(&:first)
+      entries.map { |e| find_content_type_for_media_range(e) }.flatten
     end
 
+    # Returns pair of content_type (including non-'q' parameters)
+    # and array of quality, number of '*' in content-type, and number of non-'q' parameters
     def accept_entry(entry)
-      type, *options = entry.delete(' ').split(';')
+      type, *options = entry.split(';').map(&:strip)
       quality = 0 # we sort smallest first
       options.delete_if { |e| quality = 1 - e[2..-1].to_f if e.start_with? 'q=' }
-      [type, [quality, type.count('*'), 1 - options.size]]
+      [options.unshift(type).join(';'), [quality, type.count('*'), 1 - options.size]]
+    end
+
+    ##
+    # Returns a content type appropriate for the given `media_range`,
+    # returns `nil` if `media_range` contains a wildcard subtype
+    # that is not mapped.
+    #
+    # @param  [String, #to_s] media_range
+    # @return [String, nil]
+    def find_content_type_for_media_range(media_range)
+      case media_range.to_s
+      when '*/*'
+        options[:default]
+      when 'text/*'
+        'text/turtle'
+      when 'application/*'
+        'application/ld+json'
+      when 'application/json'
+        'application/ld+json'
+      when 'application/xml'
+        'application/rdf+xml'
+      when /^([^\/]+)\/\*$/
+        nil
+      else
+        media_range.to_s
+      end
     end
 
     ##
@@ -169,7 +224,7 @@ module Rack; module LinkedData
     # @return [Array(Integer, Hash, #each)]
     def http_error(code, message = nil, headers = {})
       message = http_status(code) + (message.nil? ? "\n" : " (#{message})\n")
-      [code, {'Content-Type' => "#{DEFAULT_CONTENT_TYPE}; charset=utf-8"}.merge(headers), [message]]
+      [code, {'Content-Type' => "text/plain"}.merge(headers), [message]]
     end
 
     ##

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: rack-linkeddata
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 3.1.0
 platform: ruby
 authors:
 - Arto Bendiken
+- Gregg Kellogg
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-10 00:00:00.000000000 Z
+date: 2019-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: linkeddata
@@ -16,70 +17,84 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: rdf
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: 0.9.20
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: 0.9.20
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '3.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '3.9'
 - !ruby/object:Gem::Dependency
   name: rack-test
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '1.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '1.1'
 description: Rack middleware for Linked Data content negotiation.
 email: public-rdf-ruby@w3.org
 executables: []
@@ -106,17 +121,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.0'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: datagraph
-rubygems_version: 2.4.8
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: Linked Data content negotiation for Rack applications.
 test_files: []
-has_rdoc: false