sinatra-xsendfile 0.3.0 → 0.4.0

data/README.md

@@ -2,30 +2,50 @@
 
 `sinatra-xsendfile` extension provides `x_send_file` helper method for sending files faster
 
+
 ##XSendFile
 * in [lighttpd](http://redmine.lighttpd.net/projects/1/wiki/X-LIGHTTPD-send-file);
 * in [apache](http://tn123.ath.cx/mod_xsendfile/);
 * in [nginx](http://wiki.nginx.org/NginxXSendfile).
 
 
+##Installation
+
+If you use [bundler](http://gembundler.com/), simply specify
+`sinatra-xsendfile` as a dependency in a Gemfile in your project's root:
+
+    gem 'sinatra-xsendfile'
+
+and run `bundle install`.
+
+Otherwise install the gem as usual:
+
+    [sudo] gem install sinatra-xsendfile
+
+
 ##Example
     require 'rubygems'
     require 'sinatra'
-    require 'sinatra-xsendfile'
+    require 'sinatra/xsendfile'
 
     configure :production do
-      Sinatra::Xsendfile.replace_send_file! #replaces sinatra's send_file with x_send_file
-      set :xsf_header, 'X-Accel-Redirect' #setting default(X-SendFile) header (nginx)
+      Sinatra::Xsendfile.replace_send_file! # replace Sinatra's send_file with x_send_file
+      set :xsf_header, 'X-Accel-Redirect' # set x_send_file header (default: X-SendFile)
     end
 
     get '/' do
       x_send_file(__FILE__)
     end
 
-    get '/nginx' do
-      x_send_file(__FILE__, :header => 'X-LIGHTTPD-send-file')
+    get '/lighttpd' do
+      x_send_file(__FILE__, :header => 'X-LIGHTTPD-send-file') # custom header
     end
 
     get '/sendfile' do
-      send_file(__FILE__) #will work as x_send_file in production
+      send_file(__FILE__) # will work as x_send_file in production (see configure block)
     end
+
+*Note* that if your application subclasses `Sinatra::Base` (modular app),
+you have to register the extension in your subclass:
+
+    helpers Sinatra::Xsendfile

data/Rakefile

@@ -1,6 +1,5 @@
 require 'rubygems'
 require 'rake/testtask'
-require 'rake/gempackagetask'
 
 task :default => :test
 

data/lib/{sinatra-xsendfile → sinatra/xsendfile}/version.rb

@@ -1,5 +1,5 @@
 module Sinatra
   module Xsendfile
-    VERSION = "0.3.0"
+    VERSION = "0.4.0"
   end
 end

data/lib/{sinatra-xsendfile.rb → sinatra/xsendfile.rb}

@@ -13,7 +13,15 @@ module Sinatra
 
       header_key = opts[:header] || (settings.respond_to?(:xsf_header) && settings.xsf_header) ||
                                     'X-SendFile'
-      path = File.expand_path(path).gsub(settings.public, '') if header_key == 'X-Accel-Redirect'
+
+      if header_key == 'X-Accel-Redirect'
+        public_folder = if settings.respond_to?(:public_folder)
+          settings.public_folder
+        else
+          settings.public
+        end
+        path = File.expand_path(path).gsub(public_folder, '')
+      end
 
       response[header_key] = path
 
@@ -29,4 +37,4 @@ module Sinatra
   end
 
   helpers Xsendfile
-end
+end

data/test/sinatra_app.rb

@@ -1,6 +1,6 @@
 require 'rubygems'
 require 'sinatra'
-require 'lib/sinatra-xsendfile'
+require 'lib/sinatra/xsendfile'
 
 
 set :xsf_header, 'x-test-send-file'

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: sinatra-xsendfile
 version: !ruby/object:Gem::Version 
-  hash: 19
   prerelease: false
   segments: 
   - 0
-  - 3
+  - 4
   - 0
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors: 
 - Vasily Polovnyov
@@ -22,11 +21,9 @@ dependencies:
   name: sinatra
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 57
         segments: 
         - 0
         - 9
@@ -38,11 +35,9 @@ dependencies:
   name: rack-test
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 19
         segments: 
         - 0
         - 3
@@ -63,8 +58,8 @@ files:
 - LICENSE
 - README.md
 - Rakefile
-- lib/sinatra-xsendfile/version.rb
-- lib/sinatra-xsendfile.rb
+- lib/sinatra/xsendfile/version.rb
+- lib/sinatra/xsendfile.rb
 - test/sinatra_app.rb
 - test/sinatra_xsendfile_test.rb
 has_rdoc: true
@@ -77,27 +72,23 @@ rdoc_options: []
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: X-SendFile helper for Sinatra