rack-contrib 1.8.0 → 2.3.0

data/lib/rack/contrib/accept_format.rb

@@ -1,66 +0,0 @@
-module Rack
-  #
-  # CAUTION: THIS MIDDLEWARE IS DEPRECATED.  DO NOT USE IT.
-  #
-  # This middleware is slated for removal as of rack-contrib 2.0.0, because
-  # it is terribad.  Applications should *always* use the `Accept` header to
-  # detect response formats (when it is available), rather than ignoring
-  # that and instead examining the extension of the request.  We recommend
-  # using the `rack-accept` gem for handling the `Accept` family of entity
-  # request headers.
-  #
-  # A Rack middleware for automatically adding a <tt>format</tt> token at the end of the request path
-  # when there is none. It can detect formats passed in the HTTP_ACCEPT header to populate this token.
-  #
-  # e.g.:
-  #   GET /some/resource HTTP/1.1
-  #   Accept: application/json
-  # ->
-  #   GET /some/resource.json HTTP/1.1
-  #   Accept: application/json
-  #
-  # You can add custom types with this kind of function (taken from sinatra):
-  #   def mime(ext, type)
-  #     ext = ".#{ext}" unless ext.to_s[0] == ?.
-  #     Rack::Mime::MIME_TYPES[ext.to_s] = type
-  #   end
-  # and then:
-  #   mime :json, 'application/json'
-  #
-  # Note: it does not take into account multiple media types in the Accept header.
-  # The first media type takes precedence over all the others.
-  #
-  # MIT-License - Cyril Rohr
-  #
-  class AcceptFormat
-    def self.deprecation_acknowledged
-      @deprecation_acknowledged
-    end
-
-    def self.acknowledge_deprecation
-      @deprecation_acknowledged = true
-    end
-
-    def initialize(app, default_extention = '.html')
-      unless self.class.deprecation_acknowledged
-        warn "Rack::AcceptFormat is DEPRECATED and will be removed in rack-contrib 2.0.0"
-        warn "Please see this middleware's documentation for more info."
-      end
-      @ext = default_extention.to_s.strip
-      @ext = ".#{@ext}" unless @ext[0] == ?.
-      @app = app
-    end
-
-    def call(env)
-      req = Rack::Request.new(env)
-
-      if ::File.extname(req.path_info).empty?
-        accept = env['HTTP_ACCEPT'].to_s.scan(/[^;,\s]*\/[^;,\s]*/)[0].to_s
-        extension =  Rack::Mime::MIME_TYPES.invert[accept] || @ext
-        req.path_info = req.path_info.chomp('/') << "#{extension}"
-      end
-
-      @app.call(env)
-    end
-  end
-end

data/lib/rack/contrib/sendfile.rb

@@ -1,138 +0,0 @@
-require 'rack/file'
-
-warn "rack-contrib deprecation warning: the rack-contrib version of Rack::Sendfile is deprecated and will be removed in rack-contrib 2.0.  Please use the Rack::Sendfile from Rack 2.x instead."
-
-module Rack
-
-  #
-  # The Sendfile middleware intercepts responses whose body is being
-  # served from a file and replaces it with a server specific X-Sendfile
-  # header. The web server is then responsible for writing the file contents
-  # to the client. This can dramatically reduce the amount of work required
-  # by the Ruby backend and takes advantage of the web servers optimized file
-  # delivery code.
-  #
-  # In order to take advantage of this middleware, the response body must
-  # respond to +to_path+ and the request must include an X-Sendfile-Type
-  # header. Rack::File and other components implement +to_path+ so there's
-  # rarely anything you need to do in your application. The X-Sendfile-Type
-  # header is typically set in your web servers configuration. The following
-  # sections attempt to document
-  #
-  # === Nginx
-  #
-  # Nginx supports the X-Accel-Redirect header. This is similar to X-Sendfile
-  # but requires parts of the filesystem to be mapped into a private URL
-  # hierarachy.
-  #
-  # The following example shows the Nginx configuration required to create
-  # a private "/files/" area, enable X-Accel-Redirect, and pass the special
-  # X-Sendfile-Type and X-Accel-Mapping headers to the backend:
-  #
-  #   location /files/ {
-  #     internal;
-  #     alias /var/www/;
-  #   }
-  #
-  #   location / {
-  #     proxy_redirect     false;
-  #
-  #     proxy_set_header   Host                $host;
-  #     proxy_set_header   X-Real-IP           $remote_addr;
-  #     proxy_set_header   X-Forwarded-For     $proxy_add_x_forwarded_for;
-  #
-  #     proxy_set_header   X-Sendfile-Type     X-Accel-Redirect
-  #     proxy_set_header   X-Accel-Mapping     /files/=/var/www/;
-  #
-  #     proxy_pass         http://127.0.0.1:8080/;
-  #   }
-  #
-  # Note that the X-Sendfile-Type header must be set exactly as shown above. The
-  # X-Accel-Mapping header should specify the name of the private URL pattern,
-  # followed by an equals sign (=), followed by the location on the file system
-  # that it maps to. The middleware performs a simple substitution on the
-  # resulting path.
-  #
-  # See Also: http://wiki.codemongers.com/NginxXSendfile
-  #
-  # === lighttpd
-  #
-  # Lighttpd has supported some variation of the X-Sendfile header for some
-  # time, although only recent version support X-Sendfile in a reverse proxy
-  # configuration.
-  #
-  #   $HTTP["host"] == "example.com" {
-  #      proxy-core.protocol = "http"
-  #      proxy-core.balancer = "round-robin"
-  #      proxy-core.backends = (
-  #        "127.0.0.1:8000",
-  #        "127.0.0.1:8001",
-  #        ...
-  #      )
-  #
-  #      proxy-core.allow-x-sendfile = "enable"
-  #      proxy-core.rewrite-request = (
-  #        "X-Sendfile-Type" => (".*" => "X-Sendfile")
-  #      )
-  #    }
-  #
-  # See Also: http://redmine.lighttpd.net/wiki/lighttpd/Docs:ModProxyCore
-  #
-  # === Apache
-  #
-  # X-Sendfile is supported under Apache 2.x using a separate module:
-  #
-  # http://tn123.ath.cx/mod_xsendfile/
-  #
-  # Once the module is compiled and installed, you can enable it using
-  # XSendFile config directive:
-  #
-  #   RequestHeader Set X-Sendfile-Type X-Sendfile
-  #   ProxyPassReverse / http://localhost:8001/
-  #   XSendFile on
-
-  class Sendfile
-    def initialize(app, variation=nil)
-      @app = app
-      @variation = variation
-    end
-
-    def call(env)
-      status, headers, body = @app.call(env)
-      if body.respond_to?(:to_path)
-        case type = variation(env)
-        when 'X-Accel-Redirect'
-          path = ::File.expand_path(body.to_path)
-          if url = map_accel_path(env, path)
-            headers[type] = url
-            body = []
-          else
-            env['rack.errors'] << "X-Accel-Mapping header missing"
-          end
-        when 'X-Sendfile', 'X-Lighttpd-Send-File'
-          path = ::File.expand_path(body.to_path)
-          headers[type] = path
-          body = []
-        when '', nil
-        else
-          env['rack.errors'] << "Unknown x-sendfile variation: '#{variation}'.\n"
-        end
-      end
-      [status, headers, body]
-    end
-
-  private
-    def variation(env)
-      @variation ||
-        env['sendfile.type'] ||
-        env['HTTP_X_SENDFILE_TYPE']
-    end
-
-    def map_accel_path(env, file)
-      if mapping = env['HTTP_X_ACCEL_MAPPING']
-        internal, external = mapping.split('=', 2).map{ |p| p.strip }
-        file.sub(/^#{internal}/i, external)
-      end
-    end
-  end
-end