rack-linkeddata 0.3.0 → 1.0.0

data/README

@@ -57,6 +57,13 @@ Examples
 
     use Rack::LinkedData::ContentNegotiation, :default => "text/turtle"
 
+Options are also passed to the writer, which can allow options to be shared among the application
+and different components.
+
+    shared_options = {:default => "text/turtle", :standard_prefixes => true, }
+    use Rack::LinkedData::ContentNegotiation, shared_options
+    run MyApplication, shared_options
+
 ### Testing Linked Data content negotiation using `rackup` and `curl`
 
     $ rackup doc/examples/hello.ru
@@ -81,7 +88,7 @@ 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
 that are currently available for RDF.rb. (At present, this includes support
-for N-Triples, Turtle, RDF/XML, RDF/JSON and TriX.)
+for N-Triples, N-Quads, Turtle, RDF/XML, RDF/JSON, JSON-LD, RDFa, TriG and TriX.)
 
 Documentation
 -------------
@@ -94,8 +101,8 @@ Documentation
 Dependencies
 ------------
 
-* [Rack](http://rubygems.org/gems/rack) (>= 1.0.0)
-* [Linked Data](http://rubygems.org/gems/linkeddata) (>= 0.3.0)
+* [Rack](http://rubygems.org/gems/rack) (>= 1.4.4)
+* [Linked Data](http://rubygems.org/gems/linkeddata) (>= 1.0)
 
 Installation
 ------------
@@ -110,12 +117,12 @@ Download
 
 To get a local working copy of the development repository, do:
 
-    % git clone git://github.com/datagraph/rack-linkeddata.git
+    % git clone git://github.com/ruby-rdf/rack-linkeddata.git
 
 Alternatively, download the latest development version as a tarball as
 follows:
 
-    % wget http://github.com/datagraph/rack-linkeddata/tarball/master
+    % wget http://github.com/ruby-rdf/rack-linkeddata/tarball/master
 
 References
 ----------
@@ -138,7 +145,7 @@ License
 This is free and unencumbered public domain software. For more information,
 see <http://unlicense.org/> or the accompanying {file:UNLICENSE} file.
 
-[Rack]:           http://rack.rubyforge.org/
-[RDF.rb]:         http://rdf.rubyforge.org/
+[Rack]:           http://rack.github.com/
+[RDF.rb]:         http://ruby-rdf.github.com/rdf/
 [Linked Data]:    http://linkeddata.org/
 [conneg]:         http://en.wikipedia.org/wiki/Content_negotiation

data/VERSION

@@ -1 +1 @@
-0.3.0
+1.0.0

data/lib/rack/linkeddata/conneg.rb

@@ -2,6 +2,20 @@ module Rack; module LinkedData
   ##
   # Rack middleware for Linked Data content negotiation.
   #
+  # Uses HTTP Content Negotiation to find an appropriate RDF
+  # format to serialize any result with a body being `RDF::Enumerable`.
+  #
+  # Override content negotiation by setting the :format option to
+  # {#initialize}.
+  #
+  # Add a :default option to set a content type to use when nothing else
+  # is found.
+  #
+  # @example
+  #     use Rack::LinkedData::ContentNegotation, :format => :ttl
+  #     use Rack::LinkedData::ContentNegotiation, :format => RDF::NTriples::Format
+  #     use Rack::LinkedData::ContentNegotiation, :default => 'application/rdf+xml'
+  #
   # @see http://www4.wiwiss.fu-berlin.de/bizer/pub/LinkedDataTutorial/
   class ContentNegotiation
     DEFAULT_CONTENT_TYPE = "text/plain" # N-Triples
@@ -16,9 +30,11 @@ module Rack; module LinkedData
     ##
     # @param  [#call]                  app
     # @param  [Hash{Symbol => Object}] options
-    # @option options [String] :default (DEFAULT_CONTENT_TYPE)
+    #   Other options passed to writer.
+    # @option options [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 = {})
-      @app, @options = app, options.to_hash.dup
+      @app, @options = app, options
       @options[:default] = (@options[:default] || DEFAULT_CONTENT_TYPE).to_s
     end
 
@@ -30,20 +46,18 @@ module Rack; module LinkedData
     # @see    http://rack.rubyforge.org/doc/SPEC.html
     def call(env)
       response = app.call(env)
-      case env['REQUEST_METHOD'].to_sym
-        when :GET, :HEAD
-          case response[2] # the body
-            when RDF::Enumerable
-              serialize(env, *response)
-            else response
-          end
+      body = response[2].respond_to?(:body) ? response[2].body : response[2]
+      case body
+        when RDF::Enumerable
+          response[2] = body  # Put it back in the response, it might have been a proxy
+          serialize(env, *response)
         else response
       end
     end
 
     ##
     # Serializes an `RDF::Enumerable` response into a Rack protocol
-    # response using HTTP content negotiation rules.
+    # response using HTTP content negotiation rules or a specified Content-Type.
     #
     # @param  [Hash{String => String}] env
     # @param  [Integer]                status
@@ -52,10 +66,11 @@ module Rack; module LinkedData
     # @return [Array(Integer, Hash, #each)]
     def serialize(env, status, headers, body)
       begin
-        writer, content_type = find_writer(env)
+        writer, content_type = find_writer(env, headers)
         if writer
-          headers = headers.merge(VARY).merge('Content-Type' => content_type) # FIXME: don't overwrite existing Vary headers
-          [status, headers, [writer.dump(body)]]
+          # 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
         end
@@ -67,21 +82,30 @@ module Rack; module LinkedData
     ##
     # Returns 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;
+    # otherwise, use the default content type
+    #
     # @param  [Hash{String => String}] env
+    # @param  [Hash{String => Object}] headers
     # @return [Array(Class, String)]
     # @see    http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html
-    def find_writer(env)
-      unless env.has_key?('HTTP_ACCEPT')
-        # 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])
-      else
+    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
+      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
         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])
       end
     end
 

data/lib/rack/linkeddata/version.rb

@@ -1,9 +1,7 @@
 module Rack; module LinkedData
   module VERSION
-    MAJOR = 0
-    MINOR = 3
-    TINY  = 0
-    EXTRA = nil
+    VERSION_FILE = ::File.expand_path("../../../../VERSION", __FILE__)
+    MAJOR, MINOR, TINY, EXTRA = ::File.read(VERSION_FILE).chomp.split(".")
 
     STRING = [MAJOR, MINOR, TINY, EXTRA].compact.join('.')
 

data/lib/rack/linkeddata.rb

@@ -14,9 +14,14 @@ module Rack
     # @return [void]
     def self.register_mime_types!(options = {})
       if defined?(Rack::Mime::MIME_TYPES)
-        RDF::Format.file_extensions.each do |file_ext, content_type|
+        RDF::Format.each do |format|
+          if !Rack::Mime::MIME_TYPES.has_key?(file_ext = ".#{format.to_sym}") || options[: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]
-            Rack::Mime::MIME_TYPES.merge!(file_ext => content_type.to_s)
+            Rack::Mime::MIME_TYPES.merge!(file_ext => formats.first.content_type.first)
           end
         end
       end

metadata

@@ -1,138 +1,134 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: rack-linkeddata
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 3
-  - 0
-  version: 0.3.0
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
 platform: ruby
-authors: 
-- Datagraph
+authors:
+- Arto Bendiken
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2010-12-28 00:00:00 +01:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: yard
+date: 2013-01-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: linkeddata
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
   prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        - 6
-        - 0
-        version: 0.6.0
-  type: :development
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: rspec
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.4.4
+  type: :runtime
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 2
-        - 1
-        - 0
-        version: 2.1.0
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.4.4
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.3
   type: :development
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: rack-test
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        - 5
-        - 6
-        version: 0.5.6
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.3
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.12.0
   type: :development
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: linkeddata
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        - 3
-        - 0
-        version: 0.3.0
-  type: :runtime
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
-  name: rack
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.12.0
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.6.2
+  type: :development
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 0
-        version: "1.0"
-  type: :runtime
-  version_requirements: *id005
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.6.2
 description: Rack middleware for Linked Data content negotiation.
-email: datagraph@googlegroups.com
+email: public-rdf-ruby@w3.org
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - AUTHORS
+- CREDITS
 - README
 - UNLICENSE
 - VERSION
 - lib/rack/linkeddata/conneg.rb
 - lib/rack/linkeddata/version.rb
 - lib/rack/linkeddata.rb
-has_rdoc: false
-homepage: http://github.com/datagraph
-licenses: 
+homepage: http://ruby-rdf.github.com/rack-linkeddata
+licenses:
 - Public Domain
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 1
-      - 8
-      - 1
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
       version: 1.8.1
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: datagraph
-rubygems_version: 1.3.6
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Linked Data content negotiation for Rack applications.
 test_files: []
-
+has_rdoc: false