sinatra-simple-auth 0.1.0

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,34 @@
+##Sinatra SimpleAuth Extension
+
+Extends Sinatra with a extension methods and routes for dealing with a simple, single-password authorization
+
+##Installation
+
+    sudo gem install sinatra-simple-auth -s http://gemcutter.org/
+
+##Usage
+
+    require 'rubygems'
+    require 'sinatra'
+    require 'sinatra/simple_auth'
+
+    enable :sessions
+    set :password, 'my_cool_password' #define single password
+    set :home, '/secure/' #where user should be redirected after successful authorization
+
+    get '/a/?' do
+      erb :auth #page with logon form
+    end
+
+    get '/secure/' do
+      protected! #protected route, requires auth
+      erb :secure
+    end
+
+    get '/' do
+      if authorized? #helper method
+        "Hello, %username%"
+      else
+        "Not authorized"
+      end
+    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-simple-auth"
+    gemspec.version = "0.1.0"
+    gemspec.summary = gemspec.description = "super simple auth extension for Sinatra"
+    gemspec.email = "vasily@polovnyov.ru"
+    gemspec.homepage = "http://github.com/vast/sinatra-simple-auth"
+    gemspec.authors = ["Vasily Polovnyov"]
+
+    gemspec.add_dependency 'sinatra', '>=1.0.0'
+    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/simple_auth.rb

@@ -0,0 +1,70 @@
+require 'sinatra/base'
+
+module Sinatra
+  module SimpleAuth
+    module Helpers
+      def authorized?
+        session[:arni]
+      end
+
+      def auth!(password)
+        if password == options.password
+          session[:arni] = true
+          redirect_back_or_default(options.home)
+        end
+        redirect '/a'
+      end
+
+      def logout!
+        session.clear
+        redirect '/'
+      end
+
+      def protected!
+        unless authorized?
+          store_location
+          redirect '/a'
+        end
+      end
+
+      def store_location
+        session[:return_to] = request.fullpath if request.get?
+      end
+
+      protected
+      def redirect_back_or_default(default)
+        if session[:return_to] && session[:return_to] !=~ /^\/a\/?$/
+          back = session[:return_to].clone
+          session[:return_to] = nil
+          redirect back
+        end
+        redirect default
+      end
+
+    end
+
+    def self.registered(app)
+      app.helpers SimpleAuth::Helpers
+
+      app.set :password, 'password'
+      app.set :home, '/'
+
+      ['/a/?', '/login/?', '/signin/?'].each do |r|
+        app.post r do
+          auth!(params[:password])
+        end
+      end
+
+      app.delete '/a/?' do
+        logout!
+      end
+
+      app.get '/logout/?' do
+        logout!
+      end
+    end
+
+  end
+
+  register SimpleAuth
+end

data/test/sinatra_app.rb

@@ -0,0 +1,24 @@
+require 'rubygems'
+require 'sinatra'
+require 'lib/sinatra/simple_auth'
+
+
+set :password, 'hello'
+set :home, '/secret/'
+
+get '/' do
+  "hello, i'm root"
+end
+
+get '/public' do
+  if authorized?
+    "hello, %username%"
+  else
+    "Please login"
+  end  
+end
+
+get '/pvt' do
+  protected!
+  "private area"
+end

data/test/sinatra_simple_auth_test.rb

@@ -0,0 +1,56 @@
+require 'sinatra_app'
+require 'test/unit'
+require 'rack/test'
+begin; require 'turn'; rescue LoadError; end
+
+set :environment, :test
+enable :sessions
+
+class SinatraSimpleAuthTest < Test::Unit::TestCase
+  include Rack::Test::Methods
+
+  def app
+    Sinatra::Application
+  end
+
+  def test_it_should_login_and_redirect
+    post '/a', {:password => app.password}
+    assert_redirect app.home
+  end
+
+  def test_it_should_fail_login_and_redirect
+    post '/a', {:password => 'some fake data'}
+    assert_redirect '/a'
+  end
+
+  def test_it_should_login_and_redirect_back
+    get '/pvt'
+    assert_redirect '/a'
+    login!
+    assert_redirect '/pvt'
+  end
+
+  def test_it_should_logout
+    login!
+    delete '/a'
+    assert_redirect '/'
+  end
+
+  def test_authorized_helper_should_work
+    get '/public'
+    assert last_response.body.include?("Please login")
+    login!
+    get '/public'
+    assert last_response.body.include?("%username%")
+  end
+
+  protected
+  def login!
+    post '/a', {:password => app.password}
+  end
+
+  def assert_redirect(path)
+    assert last_response.redirect?
+    assert_equal last_response.headers['Location'], path
+  end
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification 
+name: sinatra-simple-auth
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Vasily Polovnyov
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-24 00:00:00 +03:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: sinatra
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rack
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 9
+        - 1
+        version: 0.9.1
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rack-test
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 3
+        - 0
+        version: 0.3.0
+  type: :development
+  version_requirements: *id003
+description: super simple auth extension for Sinatra
+email: vasily@polovnyov.ru
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- LICENSE
+- README.md
+- Rakefile
+- lib/sinatra/simple_auth.rb
+- test/sinatra_app.rb
+- test/sinatra_simple_auth_test.rb
+has_rdoc: true
+homepage: http://github.com/vast/sinatra-simple-auth
+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: super simple auth extension for Sinatra
+test_files: 
+- test/sinatra_simple_auth_test.rb
+- test/sinatra_app.rb