sinatra-xsendfile 0.1.1

data/LICENSE

@@ -0,0 +1,22 @@
+(The MIT License)
+
+Copyright (c) 2009 Vasily Polovnyov
+
+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.

data/README.md

@@ -0,0 +1,32 @@
+#Sinatra Extension: XSendFile
+
+`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).
+
+
+##Example
+    require 'rubygems'
+    require 'sinatra'
+    gem 'vast-sinatra-xsendfile'
+    require 'sinatra/x_send_file'
+
+    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)
+    end
+
+    get '/' do
+      x_send_file(__FILE__)
+    end
+
+    get '/nginx' do
+      x_send_file(__FILE__, :header => 'X-LIGHTTPD-send-file')
+    end
+
+    get '/sendfile' do
+      send_file(__FILE__) #will work as x_send_file in production
+    end

data/Rakefile

@@ -0,0 +1,34 @@
+require 'rubygems'
+require 'rake/testtask'
+require 'rake/gempackagetask'
+
+task :default => :test
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "sinatra-xsendfile"
+    gemspec.version = "0.1.1"
+    gemspec.summary = gemspec.description = "X-SendFile helpers for Sinatra"
+    gemspec.email = "vasily@polovnyov.ru"
+    gemspec.homepage = "http://github.com/vast/sinatra-xsendfile"
+    gemspec.authors = ["Vasily Polovnyov"]
+
+    gemspec.add_dependency 'sinatra', '>=0.9.1'
+    gemspec.add_dependency 'rack', '>=0.9.1'
+
+    gemspec.add_development_dependency 'rack-test', '>=0.3.0'
+
+    gemspec.test_files = Dir.glob('test/*')
+    gemspec.files = ["LICENSE", "README.md", "Rakefile"] + Dir.glob('lib/**/*') + gemspec.test_files
+
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install jeweler"
+end
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/*_test.rb']
+  t.verbose = true
+end

data/lib/sinatra/x_send_file.rb

@@ -0,0 +1,37 @@
+require 'sinatra/base'
+module Sinatra
+
+  module XSendFile
+    def x_send_file(path, opts = {})
+      stat = File.stat(path)
+
+      content_type media_type(opts[:type]) ||
+              media_type(File.extname(path)) ||
+              response['Content-Type'] ||
+              'application/octet-stream'
+
+      if opts[:disposition] == 'attachment' || opts[:filename]
+        attachment opts[:filename] || path
+      elsif opts[:disposition] == 'inline'
+        response['Content-Disposition'] = 'inline'
+      end
+
+      header_key = opts[:header] || (Sinatra::Application.respond_to?(:xsf_header) && Sinatra::Application.xsf_header) ||
+                                    'X-SendFile'
+      path = File.expand_path(path).gsub(Sinatra::Application.public, '') if header_key == 'X-Accel-Redirect'
+
+      response[header_key] = path
+
+      halt
+    rescue Errno::ENOENT
+      not_found
+    end
+
+    def self.replace_send_file!
+      Sinatra::Helpers.send(:alias_method, :old_send_file, :send_file)
+      Sinatra::Helpers.module_eval("def send_file(path, opts={}); x_send_file(path, opts); end;")
+    end
+  end
+
+  helpers XSendFile
+end

data/test/sinatra_app.rb

@@ -0,0 +1,28 @@
+require 'rubygems'
+require 'sinatra'
+require 'lib/sinatra/x_send_file'
+
+
+set :xsf_header, 'x-test-send-file'
+
+Sinatra::XSendFile.replace_send_file!
+
+get '/' do
+  x_send_file(__FILE__)
+end
+
+get '/nginx' do
+  x_send_file(__FILE__, :header => 'X-Accel-Redirect')
+end
+
+get '/lighty1.4' do
+  x_send_file(__FILE__, :header => 'X-LIGHTTPD-send-file')
+end
+
+get '/xsendfile' do
+  x_send_file(__FILE__, :header => 'X-SendFile')
+end
+
+get '/sendfile' do
+  send_file(__FILE__)
+end

data/test/sinatra_x_send_file_test.rb

@@ -0,0 +1,38 @@
+require 'sinatra_app'
+require 'test/unit'
+require 'rack/test'
+
+set :environment, :test
+
+class SinatraXSendFileTest < Test::Unit::TestCase
+  include Rack::Test::Methods
+
+  def app
+    Sinatra::Application
+  end
+
+  def test_x_send_file
+    get '/xsendfile'
+    assert_not_nil last_response.headers['X-SendFile']
+  end
+
+  def test_nginx_x_accel_redirect
+    get '/nginx'
+    assert_not_nil last_response.headers['X-Accel-Redirect']
+  end
+
+  def test_lighty1_4_send_file
+    get '/lighty1.4'
+    assert_not_nil last_response.headers['X-LIGHTTPD-send-file']
+  end
+
+  def test_header_global_override
+    get '/'
+    assert_not_nil last_response.headers['x-test-send-file']
+  end
+
+  def test_sendfile_overriding
+    get '/sendfile'
+    assert_not_nil last_response.headers['x-test-send-file']
+  end
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification 
+name: sinatra-xsendfile
+version: !ruby/object:Gem::Version 
+  version: 0.1.1
+platform: ruby
+authors: 
+- Vasily Polovnyov
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-11-18 00:00:00 +03:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: sinatra
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.9.1
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rack
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.9.1
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rack-test
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.3.0
+    version: 
+description: X-SendFile helpers for Sinatra
+email: vasily@polovnyov.ru
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- LICENSE
+- README.md
+- Rakefile
+- lib/sinatra/x_send_file.rb
+- test/sinatra_app.rb
+- test/sinatra_x_send_file_test.rb
+has_rdoc: true
+homepage: http://github.com/vast/sinatra-xsendfile
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: X-SendFile helpers for Sinatra
+test_files: 
+- test/sinatra_x_send_file_test.rb
+- test/sinatra_app.rb