sinatra-security 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 Cyril David
+
+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,17 @@
+= sinatra-security
+
+Description goes here.
+
+== 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 Cyril David. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,52 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "sinatra-security"
+    gem.summary = %Q{Sinatra authentication extension}
+    gem.description = %Q{For use with Sinatra + Monk + OHM}
+    gem.email = "cyx.ucron@gmail.com"
+    gem.homepage = "http://github.com/cyx/sinatra-security"
+    gem.authors = ["Cyril David"]
+    # 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 = "sinatra-security #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

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

data/lib/sinatra/security.rb

@@ -0,0 +1,28 @@
+require 'sinatra/base'
+
+begin
+  require 'haml'
+rescue LoadError
+  raise "In order to use sinatra/security, make sure you have haml installed"
+end
+
+module Sinatra
+  module Security
+    autoload :Helpers, 'sinatra/security/helpers'
+    
+    def self.registered(app)
+      app.helpers Helpers
+
+      app.post '/login' do
+        if authenticate(params)
+          redirect_to_stored
+        else
+          session[:error] = "We are sorry: the information supplied is not valid."
+          haml :login
+        end
+      end
+    end
+  end
+
+  register Security
+end

data/lib/sinatra/security/helpers.rb

@@ -0,0 +1,42 @@
+module Sinatra
+  module Security
+    module Helpers
+      def redirect_to_stored
+        if return_to = session[:return_to]
+          session[:return_to] = nil
+          redirect return_to
+        else
+          redirect "/"
+        end
+      end
+
+      def authenticate(params)
+        if user = User.authenticate(params[:username], params[:password])
+          session[:user] = user.id
+        end
+      end
+
+      def require_login
+        if logged_in?
+          return true
+        else
+          session[:return_to] = request.fullpath
+          redirect "/login"
+          return false
+        end
+      end
+
+      def current_user
+        @current_user ||= User[session[:user]] if session[:user]
+      end
+
+      def logged_in?
+        !! current_user
+      end
+
+      def ensure_current_user(user)
+        halt 404 unless user == current_user
+      end
+    end
+  end
+end

data/sinatra-security.gemspec

@@ -0,0 +1,55 @@
+# 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{sinatra-security}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Cyril David"]
+  s.date = %q{2010-04-09}
+  s.description = %q{For use with Sinatra + Monk + OHM}
+  s.email = %q{cyx.ucron@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/sinatra/security.rb",
+     "lib/sinatra/security/helpers.rb",
+     "sinatra-security.gemspec",
+     "test/helper.rb",
+     "test/test_sinatra-security.rb",
+     "test/test_sinatra_security_helpers.rb",
+     "views/login.haml"
+  ]
+  s.homepage = %q{http://github.com/cyx/sinatra-security}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Sinatra authentication extension}
+  s.test_files = [
+    "test/helper.rb",
+     "test/test_sinatra-security.rb",
+     "test/test_sinatra_security_helpers.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
+    else
+    end
+  else
+  end
+end
+

data/test/helper.rb

@@ -0,0 +1,33 @@
+require 'rubygems'
+require 'test/unit'
+require 'contest'
+require 'rack/test'
+require 'mocha'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'sinatra/security'
+
+class Test::Unit::TestCase
+  include Rack::Test::Methods
+  
+  protected
+    def assert_redirected_to(path)
+      assert_equal 302, last_response.status
+      assert_equal path, last_response.headers['Location']
+    end
+
+    def session
+      last_request.env["rack.session"]  
+    end
+end
+
+# Test Fixtures appear here
+class User
+  attr :id
+
+  def initialize(id)
+    @id = id
+  end
+end
+

data/test/test_sinatra-security.rb

@@ -0,0 +1,94 @@
+require 'helper'
+
+class BasicApp < Sinatra::Base
+  use Rack::Session::Cookie
+
+  register Sinatra::Security
+
+  get '/public' do
+    "Hello Public World"
+  end
+
+  get '/private' do
+    require_login
+  end
+end
+
+class TestSinatraSecurity < Test::Unit::TestCase
+  def app
+    BasicApp.new
+  end
+
+  describe "accessing a public url" do
+    should "not redirect to login" do
+      get '/public'
+      assert_equal "Hello Public World", last_response.body      
+    end
+  end
+
+  describe "accessing a private url" do
+    setup do
+      get '/private'
+    end
+
+    should "redirect to /login" do
+      assert_redirected_to '/login'
+    end
+
+    should "store in the session the source" do
+      assert_equal "/private", session[:return_to]
+    end
+  end
+
+  describe "accessing a private url with query string params" do
+    setup do
+      get "/private?query=string&params=true"
+    end
+
+    should "also save the query string parameters" do
+      assert_equal "/private?query=string&params=true", session[:return_to] 
+    end
+  end
+
+  describe "accessing a private url with a method other than GET" do
+    [ :post, :delete, :put ].each do |method|
+      setup do
+        send method, "/private"
+      end
+
+      should "not save any return_to for #{method}" do
+        assert ! session[:return_to]
+      end
+    end
+  end
+
+  describe "being redirected and then logging in" do
+    setup do
+      get '/private'
+  
+      @user = User.new(1)
+      User.expects(:authenticate).with('quentin', 'test').returns(@user)
+
+      post '/login', username: 'quentin', password: 'test'
+    end
+
+    should "redirect to /private" do
+      assert_redirected_to '/private'      
+    end
+  end
+
+  describe "being redirected to login and failing authenticating" do
+    setup do
+      get '/private'
+  
+      User.expects(:authenticate).with('quentin', 'test').returns(nil)
+
+      post '/login', username: 'quentin', password: 'test'
+    end
+
+    should "redirect render /login" do
+      assert_match %r{<h1>Login Page</h1>}, last_response.body
+    end
+
+  end
+end

data/test/test_sinatra_security_helpers.rb

@@ -0,0 +1,113 @@
+require 'helper'
+
+class ExecutionContext < Struct.new(:session, :request)
+  def redirect(path)
+  end
+end
+
+class TestSinatraSecurityHelpers < Test::Unit::TestCase
+  setup do
+    @context = ExecutionContext.new({})
+    @context.extend Sinatra::Security::Helpers
+  end
+
+  should "respond to current_user" do
+    assert_respond_to @context, :current_user
+  end
+
+  should "respond to logged_in?" do
+    assert_respond_to @context, :logged_in?
+  end
+
+  should "respond_to ensure_current_user" do
+    assert_respond_to @context, :ensure_current_user
+  end
+
+  describe "when session[:user] is set to 1" do
+    setup do
+      @context.session[:user] = 1
+    end
+
+    should "try and find the the User by id 1" do
+      User.expects(:[]).with(1).returns(:user)
+      
+      @context.current_user
+    end
+
+    should "return the found user as the result" do
+      User.stubs(:[]).returns(:user)
+
+      assert_equal :user, @context.current_user
+    end
+  end
+
+  describe "when current_user is not nil" do
+    should "be logged_in?" do
+      @context.stubs(:current_user).returns(:user)
+
+      assert @context.logged_in?
+    end
+  end
+
+  describe "when current_user is nil" do
+    should "not be logged_in?" do
+      @context.stubs(:current_user).returns(nil)
+
+      assert ! @context.logged_in?
+    end
+  end
+  
+  describe "#ensure_current_user" do
+    context "when the current_user is not the same as the asserted user" do
+      should "halt 404" do
+        @context.expects(:halt).with(404)
+
+        @context.stubs(:current_user).returns(:user1)
+        @context.ensure_current_user(:user2)
+      end
+    end
+    
+    context "when the current_user is the same as the asserted user" do
+      should "not halt 404" do
+        @context.stubs(:halt).raises(RuntimeError)
+        @context.stubs(:current_user).returns(:user1)
+
+        assert_nothing_raised do
+          @context.ensure_current_user(:user1)
+        end
+      end
+    end
+  end
+  
+  describe "#require_login" do
+    context "when logged_in?" do
+      should "return true" do
+        @context.expects(:logged_in?).returns(true)
+        assert @context.require_login 
+      end
+    end
+
+    context "when not logged_in?" do
+      setup do
+        @context.stubs(:logged_in?).returns(false)
+        @context.request = stub("Request", :fullpath => "/some/fullpath/here")
+      end
+
+      should "set return_to of request.fullpath" do
+        @context.require_login
+
+        assert_equal "/some/fullpath/here", @context.session[:return_to]
+      end
+
+      should "redirect to /login" do
+        @context.expects(:redirect).with('/login')
+
+        @context.require_login
+      end
+
+      should "return false" do
+        assert ! @context.require_login
+      end
+    end
+  end
+end

data/views/login.haml

@@ -0,0 +1,2 @@
+%h1 Login Page
+

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification 
+name: sinatra-security
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Cyril David
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-09 00:00:00 +08:00
+default_executable: 
+dependencies: []
+
+description: For use with Sinatra + Monk + OHM
+email: cyx.ucron@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/sinatra/security.rb
+- lib/sinatra/security/helpers.rb
+- sinatra-security.gemspec
+- test/helper.rb
+- test/test_sinatra-security.rb
+- test/test_sinatra_security_helpers.rb
+- views/login.haml
+has_rdoc: true
+homepage: http://github.com/cyx/sinatra-security
+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: Sinatra authentication extension
+test_files: 
+- test/helper.rb
+- test/test_sinatra-security.rb
+- test/test_sinatra_security_helpers.rb