roda 3.101.0 → 3.102.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a7b1458c27a93cf829302766fa6299abadc1b52a7cc45375c23e588d0a28bbf7
-  data.tar.gz: d9312bd50698b9eba385272903d3c12a04f5d699185f299b5ddc250fdcbac2ac
+  metadata.gz: f36503d930c18c02148a0da9c30d8f7166790402e04a4220e5a792dc2502779a
+  data.tar.gz: 533b40ec81263d73cbcf60d3a9807434ba0ca1a0d92ee1ca3fc59226edc80c96
 SHA512:
-  metadata.gz: 1483575934392739f5ee8c79cd74ca78f434ba9d798d9c2066f24f737f39fbfd0c0ad818acbd28b113ffaedf7751b3c45302ee17f8590c1dd47d6072de785453
-  data.tar.gz: 20f6bc4308bcebd17abc063c4303487d80fd2ac63a1a35b35b99ae0ed2a2a82cf2c5effb480464817a3c1fbed343006a74547743022b1b2e2717c16164f06740
+  metadata.gz: 0afa286317e707bd64e903fe6d5225d17a499606fdc71253769795818505793a0a12d42f8999c5eb8e678481da09d82aacb495b7a228ab47a6437b721807f57b
+  data.tar.gz: 14e94a735b1f88e45ff4c2c21b4c3acb7d96cf75f3435695b0c13a0f22471f6c619d3b0915b2794dff745ea88a333c0fd5e629c9566326f5e15d8b4cedd2be32

data/lib/roda/plugins/host_authorization.rb

@@ -5,7 +5,7 @@ class Roda
   module RodaPlugins
     # The host_authorization plugin allows configuring an authorized host or
     # an array of authorized hosts.  Then in the routing tree, you can check
-    # whether the request uses an authorized host via the +check_host_authorized!+
+    # whether the request uses an authorized host via the +check_host_authorization!+
     # method.
     # 
     # If the request doesn't match one of the authorized hosts, the
@@ -16,7 +16,7 @@ class Roda
     # By default, an empty response using status 403 will be returned for requests
     # with unauthorized hosts.
     #
-    # Because +check_host_authorized!+ is an instance method, you can easily choose
+    # Because +check_host_authorization!+ is an instance method, you can easily choose
     # to only check for authorization in certain routes, or to check it after
     # other processing.  For example, you could check for authorized hosts after
     # serving static files, since the serving of static files should not be
@@ -24,7 +24,7 @@ class Roda
     #
     # = Usage
     #
-    # In your routing tree, call the +check_host_authorized!+ method at the point you
+    # In your routing tree, call the +check_host_authorization!+ method at the point you
     # want to check for authorized hosts:
     #
     #   plugin :host_authorization, 'www.example.com'
@@ -32,7 +32,7 @@ class Roda
     #
     #   route do |r|
     #    r.public
-    #    check_host_authorized!
+    #    check_host_authorization!
     #
     #    # ...
     #   end
@@ -153,4 +153,3 @@ class Roda
     register_plugin(:host_authorization, HostAuthorization)
   end
 end
-

data/lib/roda/plugins/response_attachment.rb

@@ -0,0 +1,94 @@
+# frozen-string-literal: true
+
+require 'rack/mime'
+
+#
+class Roda
+  module RodaPlugins
+    # The attachment plugin adds a response.attachment method.
+    # When called with no filename, +attachment+ sets the Content-Disposition
+    # to attachment.  When called with a filename,+attachment+ sets the Content-Disposition
+    # to attachment with the appropriate filename parameter, and if the filename
+    # extension is recognized, this also sets the Content-Type to the appropriate
+    # MIME type if not already set.
+    #
+    #   # set Content-Disposition to 'attachment'
+    #   response.attachment
+    #
+    #   # set Content-Disposition to 'attachment; filename="a.csv"',
+    #   # also set Content-Type to 'text/csv'
+    #   response.attachment 'a.csv'
+    #
+    # == License
+    #
+    # The implementation was originally taken from Sinatra,
+    # which is also released under the MIT License:
+    #
+    # Copyright (c) 2007, 2008, 2009 Blake Mizerany
+    # Copyright (c) 2010, 2011, 2012, 2013, 2014 Konstantin Haase
+    # 
+    # 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.
+    module ResponseAttachment
+      UTF8_ENCODING = Encoding.find('UTF-8')
+      ISO88591_ENCODING = Encoding.find('ISO-8859-1')
+      BINARY_ENCODING = Encoding.find('BINARY')
+
+      module ResponseMethods
+        # Set the Content-Disposition to "attachment" with the specified filename,
+        # instructing the user agents to prompt to save.
+        def attachment(filename = nil, disposition='attachment')
+          if filename
+            param_filename = File.basename(filename)
+            encoding = param_filename.encoding
+
+            needs_encoding = param_filename.gsub!(/[^ 0-9a-zA-Z!\#$&\+\.\^_`\|~]+/, '-')
+            params = "; filename=#{param_filename.inspect}"
+
+            if needs_encoding && (encoding == UTF8_ENCODING || encoding == ISO88591_ENCODING)
+              # File name contains non attr-char characters from RFC 5987 Section 3.2.1
+
+              encoded_filename = File.basename(filename).force_encoding(BINARY_ENCODING)
+              # Similar regexp as above, but treat each byte separately, and encode
+              # space characters, since those aren't allowed in attr-char
+              encoded_filename.gsub!(/[^0-9a-zA-Z!\#$&\+\.\^_`\|~]/) do |c|
+                "%%%X" % c.ord
+              end
+
+              encoded_params = "; filename*=#{encoding.to_s}''#{encoded_filename}"
+            end
+
+            unless @headers[RodaResponseHeaders::CONTENT_TYPE]
+              ext = File.extname(filename)
+              if !ext.empty? && (content_type = Rack::Mime.mime_type(ext, nil))
+                @headers[RodaResponseHeaders::CONTENT_TYPE] = content_type
+              end
+            end
+          end
+
+          @headers[RodaResponseHeaders::CONTENT_DISPOSITION] = "#{disposition}#{params}#{encoded_params}"
+        end
+      end
+    end
+
+    register_plugin(:response_attachment, ResponseAttachment)
+  end
+end

data/lib/roda/plugins/send_file.rb

@@ -0,0 +1,127 @@
+# frozen-string-literal: true
+
+begin
+  require 'rack/files'
+rescue LoadError
+  require 'rack/file'
+end
+
+#
+class Roda
+  module RodaPlugins
+    # The send_file plugin adds a send_file method, used for
+    # returning the contents of a file as the body of a request.
+    # It also loads the response_attachment plugin to set the
+    # Content-Disposition and Content-Type based on the file's
+    # extension.
+    #
+    # senf_file will serve the file with the given path from the file system:
+    #
+    #   send_file 'path/to/file.txt'
+    #
+    # Options:
+    #
+    # :disposition :: Set the Content-Disposition to the given disposition.
+    # :filename :: Set the Content-Disposition to attachment (unless :disposition is set),
+    #              and set the filename parameter to the value.
+    # :last_modified :: Explicitly set the Last-Modified header to the given value, and
+    #                   return a not modified response if there has not been modified since
+    #                   the previous request.  This option requires the caching plugin.
+    # :status :: Override the status for the response.
+    # :type :: Set the Content-Type to use for this response.
+    #
+    # == License
+    #
+    # The implementation was originally taken from Sinatra,
+    # which is also released under the MIT License:
+    #
+    # Copyright (c) 2007, 2008, 2009 Blake Mizerany
+    # Copyright (c) 2010, 2011, 2012, 2013, 2014 Konstantin Haase
+    # 
+    # 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.
+    module SendFile
+      RACK_FILES = defined?(Rack::Files) ? Rack::Files : Rack::File
+
+      # Depend on the status_303 plugin.
+      def self.load_dependencies(app)
+        app.plugin :response_attachment
+      end
+
+      module InstanceMethods
+        # Use the contents of the file at +path+ as the response body.  See plugin documentation for options.
+        def send_file(path, opts = OPTS)
+          r = @_request
+          res = @_response
+          headers = res.headers
+          if (type = opts[:type]) || !headers[RodaResponseHeaders::CONTENT_TYPE]
+            type_str = type.to_s
+
+            if type_str.include?('/')
+              type = type_str
+            else
+              if type
+                type = ".#{type}" unless type_str.start_with?(".")
+              else
+                type = ::File.extname(path)
+              end
+
+              type &&= Rack::Mime.mime_type(type, nil)
+              type ||= 'application/octet-stream'
+            end
+            
+            headers[RodaResponseHeaders::CONTENT_TYPE] = type
+          end
+
+          disposition = opts[:disposition]
+          filename    = opts[:filename]
+          if disposition || filename
+            disposition ||= 'attachment'
+            filename = path if filename.nil?
+            res.attachment(filename, disposition)
+          end
+
+          if lm = opts[:last_modified]
+            r.last_modified(lm)
+          end
+
+          file = RACK_FILES.new nil
+          s, h, b = if Rack.release > '2'
+            file.serving(r, path)
+          else
+            file.path = path
+            file.serving(env)
+          end
+
+          res.status = opts[:status] || s
+          headers.delete(RodaResponseHeaders::CONTENT_LENGTH)
+          headers.replace(h.merge!(headers))
+          r.halt res.finish_with_body(b)
+        rescue Errno::ENOENT
+          response.status = 404
+          r.halt
+        end
+      end
+    end
+
+    register_plugin(:send_file, SendFile)
+  end
+end

data/lib/roda/plugins/sinatra_helpers.rb

@@ -1,12 +1,6 @@
 # frozen-string-literal: true
 
 require 'rack/mime'
-begin
-  require 'rack/files'
-rescue LoadError
-  require 'rack/file'
-end
-
 
 #
 class Roda
@@ -91,20 +85,7 @@ class Roda
     #
     # === send_file
     #
-    # This will serve the file with the given path from the file system:
-    #
-    #   send_file 'path/to/file.txt'
-    #
-    # Options:
-    #
-    # :disposition :: Set the Content-Disposition to the given disposition.
-    # :filename :: Set the Content-Disposition to attachment (unless :disposition is set),
-    #              and set the filename parameter to the value.
-    # :last_modified :: Explicitly set the Last-Modified header to the given value, and
-    #                   return a not modified response if there has not been modified since
-    #                   the previous request.  This option requires the caching plugin.
-    # :status :: Override the status for the response.
-    # :type :: Set the Content-Type to use for this response.
+    # See send_file plugin documentation for details.
     #
     # == Response Methods Added
     #
@@ -166,15 +147,7 @@ class Roda
     #
     # === attachment
     #
-    # When called with no filename, +attachment+ just sets the Content-Disposition
-    # to attachment.  When called with a filename, this sets the Content-Disposition
-    # to attachment with the appropriate filename parameter, and if the filename
-    # extension is recognized, this also sets the Content-Type to the appropriate
-    # MIME type if not already set.
-    #
-    #   attachment          # set Content-Disposition to 'attachment'
-    #   attachment 'a.csv'  # set Content-Disposition to 'attachment;filename="a.csv"',
-    #                       # also set Content-Type to 'text/csv'
+    # See response_attachment plugin for details.
     #
     # === status predicates
     #
@@ -219,15 +192,10 @@ class Roda
     # FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
     # OTHER DEALINGS IN THE SOFTWARE.
     module SinatraHelpers
-      UTF8_ENCODING = Encoding.find('UTF-8')
-      ISO88591_ENCODING = Encoding.find('ISO-8859-1')
-      BINARY_ENCODING = Encoding.find('BINARY')
-
-      RACK_FILES = defined?(Rack::Files) ? Rack::Files : Rack::File
-
       # Depend on the status_303 plugin.
       def self.load_dependencies(app, _opts = nil)
         app.plugin :status_303
+        app.plugin :send_file
       end
 
       # Add delegate methods to the route block scope
@@ -323,40 +291,9 @@ class Roda
           super(path, status)
         end
 
-        # Use the contents of the file at +path+ as the response body.  See plugin documentation for options.
+        # Backwards compatibility for callers of r.send_file.
         def send_file(path, opts = OPTS)
-          res = response
-          headers = res.headers
-          if opts[:type] || !headers[RodaResponseHeaders::CONTENT_TYPE]
-            res.content_type(opts[:type] || ::File.extname(path), :default => 'application/octet-stream')
-          end
-
-          disposition = opts[:disposition]
-          filename    = opts[:filename]
-          if disposition || filename
-            disposition ||= 'attachment'
-            filename = path if filename.nil?
-            res.attachment(filename, disposition)
-          end
-
-          if lm = opts[:last_modified]
-            last_modified(lm)
-          end
-
-          file = RACK_FILES.new nil
-          s, h, b = if Rack.release > '2'
-            file.serving(self, path)
-          else
-            file.path = path
-            file.serving(@env)
-          end
-
-          res.status = opts[:status] || s
-          headers.delete(RodaResponseHeaders::CONTENT_LENGTH)
-          headers.replace(h.merge!(headers))
-          halt res.finish_with_body(b)
-        rescue Errno::ENOENT
-          not_found
+          scope.send_file(path, opts)
         end
 
         # Generates the absolute URI for a given path in the app.
@@ -438,39 +375,6 @@ class Roda
           @headers[RodaResponseHeaders::CONTENT_TYPE] = mime_type
         end
 
-        # Set the Content-Disposition to "attachment" with the specified filename,
-        # instructing the user agents to prompt to save.
-        def attachment(filename = nil, disposition='attachment')
-          if filename
-            param_filename = File.basename(filename)
-            encoding = param_filename.encoding
-
-            needs_encoding = param_filename.gsub!(/[^ 0-9a-zA-Z!\#$&\+\.\^_`\|~]+/, '-')
-            params = "; filename=#{param_filename.inspect}"
-
-            if needs_encoding && (encoding == UTF8_ENCODING || encoding == ISO88591_ENCODING)
-              # File name contains non attr-char characters from RFC 5987 Section 3.2.1
-
-              encoded_filename = File.basename(filename).force_encoding(BINARY_ENCODING)
-              # Similar regexp as above, but treat each byte separately, and encode
-              # space characters, since those aren't allowed in attr-char
-              encoded_filename.gsub!(/[^0-9a-zA-Z!\#$&\+\.\^_`\|~]/) do |c|
-                "%%%X" % c.ord
-              end
-
-              encoded_params = "; filename*=#{encoding.to_s}''#{encoded_filename}"
-            end
-
-            unless @headers[RodaResponseHeaders::CONTENT_TYPE]
-              ext = File.extname(filename)
-              unless ext.empty?
-                content_type(ext)
-              end
-            end
-          end
-          @headers[RodaResponseHeaders::CONTENT_DISPOSITION] = "#{disposition}#{params}#{encoded_params}"
-        end
-
         # Whether or not the status is set to 1xx. Returns nil if status not yet set.
         def informational?
           @status.between?(100, 199) if @status
@@ -521,7 +425,7 @@ class Roda
         [:logger, :back].each do |meth|
           define_method(meth){@_request.public_send(meth)}
         end
-        [:redirect, :uri, :url, :to, :send_file, :error, :not_found].each do |meth|
+        [:redirect, :uri, :url, :to, :error, :not_found].each do |meth|
           define_method(meth){|*v, &block| @_request.public_send(meth, *v, &block)}
         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 = 101
+  RodaMinorVersion = 102
 
   # The patch version of Roda, updated only for bug fixes from the last
   # feature release.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: roda
 version: !ruby/object:Gem::Version
-  version: 3.101.0
+  version: 3.102.0
 platform: ruby
 authors:
 - Jeremy Evans
@@ -278,6 +278,7 @@ files:
 - lib/roda/plugins/render_locals.rb
 - lib/roda/plugins/request_aref.rb
 - lib/roda/plugins/request_headers.rb
+- lib/roda/plugins/response_attachment.rb
 - lib/roda/plugins/response_content_type.rb
 - lib/roda/plugins/response_request.rb
 - lib/roda/plugins/route_block_args.rb
@@ -286,6 +287,7 @@ files:
 - lib/roda/plugins/run_handler.rb
 - lib/roda/plugins/run_require_slash.rb
 - lib/roda/plugins/sec_fetch_site_csrf.rb
+- lib/roda/plugins/send_file.rb
 - lib/roda/plugins/sessions.rb
 - lib/roda/plugins/shared_vars.rb
 - lib/roda/plugins/sinatra_helpers.rb