roda 3.35.0 → 3.36.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 370e18bb1d1cfb9fb8b0c10fda1a4f57161a39c6d733b628ddd60058d231f896
-  data.tar.gz: fe0c8ddb499cdbafb0f047d9445fca726f742e38674f90731f3421132c373365
+  metadata.gz: abd198c51a38d272c8601fb367c12b9ad244f8383bcfb2f0583e7c7e23744eca
+  data.tar.gz: 75cee1c957032abd4144f01fbd720794d2f66e7422514fa6e58b8bd5f8087b6e
 SHA512:
-  metadata.gz: 60db0b47d97ae40437e0396bc795ac360194bd88067e6611cf277888d054e3c41786eb062f4ab31d6683cb4755a3a27d148a576236c77a4d46db67fc2accc7e1
-  data.tar.gz: 44745afaa29ccee2d51a132f7b7be4da6818191814a9ff8a2afd52f34636789cb0e4d22eb63ade49ea0411470a73b05a1996c7bb70cc7edf04264fb2fddadb83
+  metadata.gz: e3b7fed2ed29b869b205114d3bf644bb81f1f8d3a267682976aa4eef019e9ca015ade6526d75a99d5f6f1128991f70ba692e1c527acdc62874fbd39e49c24dba
+  data.tar.gz: 341da7749e2432b1a3139f29b09f6a219480bb6984a74e121fc2b30bc4f7c4f7c6e51b1be01fb836ef85399cef1cfd15249495d335c80b44eed75a1a657960c7

data/CHANGELOG

@@ -1,3 +1,11 @@
+= 3.36.0 (2020-09-14)
+
+* Add multi_public plugin, for serving files from multiple public directories (jeremyevans)
+
+* Support report-to directive in the content_security_policy plugin (jeremyevans)
+
+* Add Vary response header when using type_routing plugin with Accept request header to prevent caching issues (jeremyevans)
+
 = 3.35.0 (2020-08-14)
 
 * Add r plugin for r method for accessing request, useful when r local variable is not in scope (jeremyevans)

data/doc/release_notes/3.36.0.txt

@@ -0,0 +1,17 @@
+= New Features
+
+* A multi_public plugin has been added, which allows serving static
+  files from multiple separate directories.  This is especially
+  useful when there are different access control requirements per
+  directory.
+  
+* The content_security_policy now supports a
+  content_security_policy.report_to method to set the
+  report-to directive.
+
+= Other Improvements
+
+* When using the type_routing plugin and performing type routing
+  using the Accept request header, the Vary response header will be
+  added or updated so that http caches do not cache a response for one
+  type and serve it for a different type.

data/lib/roda/plugins/content_security_policy.rb

@@ -56,6 +56,7 @@ class Roda
     # * media_src
     # * object_src
     # * plugin_types
+    # * report_to
     # * report_uri
     # * require_sri_for
     # * sandbox
@@ -123,6 +124,7 @@ class Roda
         media-src
         object-src
         plugin-types
+        report-to
         report-uri
         require-sri-for
         sandbox
@@ -145,9 +147,7 @@ class Roda
           # add_* method name adds to the setting value, or clears setting if no values
           # are given.
           define_method("add_#{meth}") do |*args|
-            if args.empty?
-              @opts[setting]
-            else
+            unless args.empty?
               @opts[setting] ||= EMPTY_ARRAY
               @opts[setting] += args
               @opts[setting].freeze

data/lib/roda/plugins/multi_public.rb

@@ -0,0 +1,87 @@
+# frozen-string-literal: true
+
+#
+class Roda
+  module RodaPlugins
+    # The multi_public plugin adds an +r.multi_public+ method that accepts an argument specifying
+    # a directory from which to serve static files.  It is similar to the public plugin, but
+    # allows for multiple separate directories.
+    #
+    # Here's an example of using the multi_public plugin to serve 3 different types of files
+    # from 3 different directories:
+    #
+    #   plugin :multi_public,
+    #     img:  'static/images',
+    #     font: 'assets/fonts',
+    #     form: 'static/forms/pdfs'
+    #
+    #   r.route do
+    #     r.on "images" do
+    #       r.multi_public(:img)
+    #     end
+    #
+    #     r.on "fonts" do
+    #       r.multi_public(:font)
+    #     end
+    #
+    #     r.on "forms" do
+    #       r.multi_public(:form)
+    #     end
+    #   end
+    #
+    # It is possible to simplify the routing tree for this using string keys and an array
+    # matcher:
+    # 
+    #   plugin :multi_public,
+    #     'images' => 'static/images',
+    #     'fonts'  => 'assets/fonts',
+    #     'forms'  => 'static/forms/pdfs'
+    #
+    #   r.route do
+    #     r.on %w"images fonts forms" do |dir|
+    #       r.multi_public(dir)
+    #     end
+    #   end
+    #
+    # You can provide custom headers and default mime type for each directory using an array
+    # of three elements as the value, with the first element being the path, the second
+    # being the custom headers, and the third being the default mime type:
+    #
+    #   plugin :multi_public,
+    #     'images' => ['static/images', {'Cache-Control'=>'max-age=86400'}, nil],
+    #     'fonts'  => ['assets/fonts', {'Cache-Control'=>'max-age=31536000'}, 'font/ttf'],
+    #     'forms'  => ['static/forms/pdfs', nil, 'application/pdf']
+    #
+    #   r.route do
+    #     r.on %w"images fonts forms" do |dir|
+    #       r.multi_public(dir)
+    #     end
+    #   end
+    module MultiPublic
+      def self.load_dependencies(app, _, opts=OPTS)
+        app.plugin(:public, opts)
+      end
+
+      # Use the given directories to setup servers.  Any opts are passed to the public plugin.
+      def self.configure(app, directories, _=OPTS)
+        roots = app.opts[:multi_public_servers] = (app.opts[:multi_public_servers] || {}).dup
+        directories.each do |key, path|
+          path, headers, mime = path
+          roots[key] = ::Rack::File.new(app.expand_path(path), headers||{}, mime||'text/plain')
+        end
+        roots.freeze
+      end
+
+      module RequestMethods
+        # Serve files from the directory corresponding to the given key if the file exists and
+        # this is a GET request.
+        def multi_public(key)
+          public_serve_with(roda_class.opts[:multi_public_servers].fetch(key))
+        end
+      end
+    end
+
+    register_plugin(:multi_public, MultiPublic)
+  end
+end
+

data/lib/roda/plugins/public.rb

@@ -60,21 +60,7 @@ class Roda
       module RequestMethods
         # Serve files from the public directory if the file exists and this is a GET request.
         def public
-          if is_get?
-            path = PARSER.unescape(real_remaining_path)
-            return if path.include?("\0")
-
-            roda_opts = roda_class.opts
-            server = roda_opts[:public_server]
-            path = ::File.join(server.root, *public_path_segments(path))
-
-            public_serve_compressed(server, path, '.br', 'br') if roda_opts[:public_brotli]
-            public_serve_compressed(server, path, '.gz', 'gzip') if roda_opts[:public_gzip]
-
-            if public_file_readable?(path)
-              halt public_serve(server, path)
-            end
-          end
+          public_serve_with(roda_class.opts[:public_server])
         end
 
         private
@@ -101,6 +87,22 @@ class Roda
           # :nocov:
         end
 
+        def public_serve_with(server)
+          return unless is_get?
+          path = PARSER.unescape(real_remaining_path)
+          return if path.include?("\0")
+
+          roda_opts = roda_class.opts
+          path = ::File.join(server.root, *public_path_segments(path))
+
+          public_serve_compressed(server, path, '.br', 'br') if roda_opts[:public_brotli]
+          public_serve_compressed(server, path, '.gz', 'gzip') if roda_opts[:public_gzip]
+
+          if public_file_readable?(path)
+            halt public_serve(server, path)
+          end
+        end
+
         def public_serve_compressed(server, path, suffix, encoding)
           if env['HTTP_ACCEPT_ENCODING'] =~ /\b#{encoding}\b/
             compressed_path = path + suffix

data/lib/roda/plugins/type_routing.rb

@@ -4,7 +4,7 @@
 class Roda
   module RodaPlugins
     # This plugin makes it easier to to respond to specific request data types. User agents can request
-    # specific data types by either supplying an appropriate +Accept+ header
+    # specific data types by either supplying an appropriate +Accept+ request header
     # or by appending it as file extension to the path.
     #
     # Example:
@@ -50,6 +50,10 @@ class Roda
     # Content-Type header will be set to Roda's default (which you can override via
     # the default_headers plugin).
     #
+    # If the type routing is based on the +Accept+ request header and not the file extension,
+    # then an appropriate +Vary+ header will be set or appended to, so that HTTP caches do
+    # not serve the same result for requests with different +Accept+ headers.
+    #
     # To match custom extensions, use the :types option:
     #
     #   plugin :type_routing, types: {
@@ -195,6 +199,7 @@ class Roda
           @env['HTTP_ACCEPT'].to_s.split(/\s*,\s*/).map do |part|
             mime, _= part.split(/\s*;\s*/, 2)
             if sym = mimes[mime]
+              response['Vary'] = (vary = response['Vary']) ? "#{vary}, Accept" : 'Accept'
               return sym
             end
           end

data/lib/roda/version.rb

@@ -4,7 +4,7 @@ class Roda
   RodaMajorVersion = 3
 
   # The minor version of Roda, updated for new feature releases of Roda.
-  RodaMinorVersion = 35
+  RodaMinorVersion = 36
 
   # The patch version of Roda, updated only for bug fixes from the last
   # feature release.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: roda
 version: !ruby/object:Gem::Version
-  version: 3.35.0
+  version: 3.36.0
 platform: ruby
 authors:
 - Jeremy Evans
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-14 00:00:00.000000000 Z
+date: 2020-09-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -211,6 +211,7 @@ extra_rdoc_files:
 - doc/release_notes/3.33.0.txt
 - doc/release_notes/3.34.0.txt
 - doc/release_notes/3.35.0.txt
+- doc/release_notes/3.36.0.txt
 files:
 - CHANGELOG
 - MIT-LICENSE
@@ -247,6 +248,7 @@ files:
 - doc/release_notes/3.33.0.txt
 - doc/release_notes/3.34.0.txt
 - doc/release_notes/3.35.0.txt
+- doc/release_notes/3.36.0.txt
 - doc/release_notes/3.4.0.txt
 - doc/release_notes/3.5.0.txt
 - doc/release_notes/3.6.0.txt
@@ -307,6 +309,7 @@ files:
 - lib/roda/plugins/middleware.rb
 - lib/roda/plugins/middleware_stack.rb
 - lib/roda/plugins/module_include.rb
+- lib/roda/plugins/multi_public.rb
 - lib/roda/plugins/multi_route.rb
 - lib/roda/plugins/multi_run.rb
 - lib/roda/plugins/multi_view.rb