rack-ssl-enforcer 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Tobias Matthies
+
+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.rdoc

@@ -0,0 +1,31 @@
+= rack-ssl-enforcer
+
+Rack::SslEnforcer is a simple Rack middleware to enforce ssl connections
+
+== Installation
+
+  sudo gem install rack-ssl-enforcer -s http://gemcutter.org
+
+== Usage
+
+  require 'noie'
+  use Rack::SslEnforcer
+
+This will redirect all plain-text requests to SSL. Rack::SslEnforcer accepts two params, :redirect_to and :message
+You might need the :redirect_to option if the URL can't be determined (e.g. if using a proxy).
+
+  use Rack::SslEnforcer, :redirect_to => 'https://example.org', :message => 'R-R-R-Redirecting...'
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Tobias Matthies. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,52 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "rack-ssl-enforcer"
+    gem.summary = %Q{A simple Rack middleware to enforce SSL}
+    gem.email = "tm@mit2m.de"
+    gem.homepage = "http://github.com/tobmatth/rack-ssl-enforcer"
+    gem.authors = ["Tobias Matthies"]
+    gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "rack-ssl-enforcer #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/rack-ssl-enforcer.rb

@@ -0,0 +1,25 @@
+module Rack
+
+  class SslEnforcer
+
+    def initialize(app, options = {})
+      @app = app
+      @options = options
+    end
+ 
+    def call(env)
+      @options[:redirect_to] ||= Rack::Request.new(env).url
+      @options[:redirect_to].gsub!(/^http:/,'https:')
+      @options[:message] ||= "You are beeing redirected to #{@options[:redirect_to]}."
+      ssl_request?(env) ? @app.call(env) : [301, {'Location' => @options[:redirect_to]}, @options[:message]]
+    end
+    
+    
+    private
+      
+      def ssl_request?(env)
+        env['rack.url_scheme'] == 'https'
+      end
+ 
+  end
+end

data/rack-ssl-enforcer.gemspec

@@ -0,0 +1,53 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{rack-ssl-enforcer}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Tobias Matthies"]
+  s.date = %q{2010-03-17}
+  s.email = %q{tm@mit2m.de}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/rack-ssl-enforcer.rb",
+     "rack-ssl-enforcer.gemspec",
+     "test/helper.rb",
+     "test/test_rack-ssl-enforcer.rb"
+  ]
+  s.homepage = %q{http://github.com/tobmatth/rack-ssl-enforcer}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{A simple Rack middleware to enforce SSL}
+  s.test_files = [
+    "test/helper.rb",
+     "test/test_rack-ssl-enforcer.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    else
+      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+  end
+end
+

data/test/helper.rb

@@ -0,0 +1,11 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+require 'rack/mock'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rack-ssl-enforcer'
+
+class Test::Unit::TestCase
+end

data/test/test_rack-ssl-enforcer.rb

@@ -0,0 +1,63 @@
+require 'helper'
+
+class TestRackSslEnforcer < Test::Unit::TestCase
+
+  def dummy_app(env)
+    [ 200, {'Content-Type' => 'text/plain'}, 'Hello world!' ]
+  end
+
+  context 'Given an app' do
+    setup do
+      @app = method(:dummy_app)
+    end
+
+    context 'that has no :redirect_to set' do
+      setup do
+        @request  = Rack::MockRequest.new(Rack::SslEnforcer.new(@app))
+      end
+      
+      should 'respond with a ssl redirect to plain-text requests' do
+        response = @request.get('http://www.example.org/', {})
+        assert_equal 301, response.status
+        assert_equal response.location, 'https://www.example.org/'
+      end
+      
+      should 'respond not redirect ssl requests' do
+        response = @request.get('https://www.example.org/', {})
+        assert_equal 200, response.status
+        assert_equal response.body, 'Hello world!'
+      end
+    end
+    
+    context 'that has :redirect_to set' do
+      setup do
+        @request  = Rack::MockRequest.new(Rack::SslEnforcer.new(@app, :redirect_to => 'https://www.google.com/'))
+      end
+      
+      should 'respond with a ssl redirect to plain-text requests and redirect to :redirect_to' do
+        response = @request.get('http://www.example.org/', {})
+        assert_equal 301, response.status
+        assert_equal response.location, 'https://www.google.com/'
+      end
+      
+      should 'respond not redirect ssl requests' do
+        response = @request.get('https://www.example.org/', {})
+        assert_equal 200, response.status
+        assert_equal response.body, 'Hello world!'
+      end
+    end
+    
+    context 'that has :message set' do
+      setup do
+        @message = 'R-R-R-Redirect!'
+        @request  = Rack::MockRequest.new(Rack::SslEnforcer.new(@app, :message => @message))
+      end
+      
+      should 'output the given message when redirecting' do
+        response = @request.get('http://www.example.org/', {})
+        assert_equal 301, response.status
+        assert_equal response.body, @message
+      end
+    end
+
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification 
+name: rack-ssl-enforcer
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Tobias Matthies
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-17 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+description: 
+email: tm@mit2m.de
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/rack-ssl-enforcer.rb
+- rack-ssl-enforcer.gemspec
+- test/helper.rb
+- test/test_rack-ssl-enforcer.rb
+has_rdoc: true
+homepage: http://github.com/tobmatth/rack-ssl-enforcer
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: A simple Rack middleware to enforce SSL
+test_files: 
+- test/helper.rb
+- test/test_rack-ssl-enforcer.rb