sinatra-single-user-auth 0.1

data/.gitignore

@@ -0,0 +1,7 @@
+.idea/*
+pkg/*
+Gemfile.lock
+.rbenv-version
+.bundle
+*.gem
+.DS_Store

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 1.9.3

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

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,91 @@
+## Sinatra Single User Simple Auth Extension
+
+[![Build Status](https://api.travis-ci.org/kingsleyh/sinatra-single-user-auth.png)](https://travis-ci.org/kingsleyh/sinatra-single-user-auth)
+
+Sinatra extension with methods and routes for dealing with simple, single user authorization (username and password)
+
+## Background
+
+This extension is based on the awesome [sinatra-simple-auth](https://github.com/vast/sinatra-simple-auth) gem by Vasily Polovnyov. I wanted
+the exact same functionality but I also wanted to be able to specify a username/email as well so I can do some custom atlassian crowd authentication.
+I thought someone else may find having a username handy as well so here it is. Massive thanks to Vasily as 99.9% of this plugin is his work - I
+just added the username field.
+
+## Installation
+
+```console
+gem install sinatra-single-user-auth
+```
+
+Or via bundler:
+
+```ruby
+gem 'sinatra-single-user-auth'
+```
+
+## Usage (classic style applications)
+
+You just need to make sure you pass the params username and password from the login form
+
+```ruby
+# classic_app.rb
+require 'rubygems'
+require 'sinatra'
+require 'sinatra/simple_auth'
+
+enable :sessions
+set :username, 'my_username' # set the username
+set :password, 'my_cool_password' # set the password
+set :home, '/secure/' # where user should be redirected after successful authentication
+
+get '/login/?' do
+  erb :login # page with auth form
+end
+
+get '/secure/' do
+  protected! # protected route, requires auth
+  erb :secure
+end
+
+get '/' do
+  if authorized? # helper method
+    "Hello, #{app.username}"
+  else
+    "Not authorized"
+  end
+end
+```
+
+## Usage (modular style applications)
+
+```ruby
+# modular_app.rb
+require 'sinatra/base'
+require 'sinatra/simple_auth'
+
+class SinatraModularApp < Sinatra::Base
+  enable :sessions
+  register Sinatra::SimpleAuth
+
+  set :username, 'my_username' # set the username
+  set :password, 'my_password' # set the password
+  set :home, '/' # where user should be redirected after successful authentication
+
+  get '/login/?' do
+    erb :login # page with auth form
+  end
+
+  get '/secure/' do
+    protected! # protected route, requires auth
+    erb :secure
+  end
+
+  get '/' do
+    if authorized? # helper method
+      "Hello, #{app.username}"
+    else
+      "Not authorized"
+    end
+  end
+end
+```

data/Rakefile

@@ -0,0 +1,11 @@
+require 'rake/testtask'
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+task :default => :test
+
+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,67 @@
+require 'sinatra/base'
+
+module Sinatra
+  module SimpleAuth
+    module Helpers
+      def authorized?
+        session[:arni]
+      end
+
+      def auth!(password,username)
+        if password == settings.password and username == settings.username
+          session[:arni] = true
+          redirect_back_or_default(settings.home)
+        end
+        redirect to('/login')
+      end
+
+      def logout!
+        session.clear
+        redirect to('/')
+      end
+
+      def protected!
+        unless authorized?
+          store_location
+          redirect to('/login')
+        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] !=~ /^\/login\/?$/
+          redirect session.delete(:return_to)
+        end
+        redirect to(default)
+      end
+
+    end
+
+    def self.registered(app)
+      app.helpers SimpleAuth::Helpers
+
+      app.set :username, 'username'
+      app.set :password, 'password'
+      app.set :home, '/'
+
+      app.post '/login/?' do
+        auth!(params[:password],params[:username])
+      end
+
+      app.delete '/logout/?' do
+        logout!
+      end
+
+      app.get '/logout/?' do
+        logout!
+      end
+    end
+
+  end
+
+  register SimpleAuth
+end

data/sinatra-single-user-auth.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "sinatra-single-user-auth"
+  s.version     = '0.1'
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Kingsley Hendrickse","Vasily Polovnyov"]
+  s.email       = ["kingsley@masterthought.net","vasily@polovnyov.ru"]
+  s.homepage    = "http://github.com/vast/sinatra-simple-auth/"
+  s.summary     = %q{super simple single user auth extension for Sinatra}
+  s.description = %q[super simple single user auth extension for Sinatra]
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  
+  s.add_dependency('sinatra', '>=1.1.0')
+  s.add_development_dependency('rake')
+  s.add_development_dependency('rack-test')
+  s.add_development_dependency('turn')
+  s.add_development_dependency('minitest-reporters')
+end

data/test/sinatra_modular_app.rb

@@ -0,0 +1,28 @@
+require 'sinatra/base'
+require File.dirname(__FILE__) + '/../lib/sinatra/simple_auth'
+
+class SinatraModularApp < Sinatra::Base
+  enable :sessions
+  register Sinatra::SimpleAuth
+
+  set :username, 'username'
+  set :password, 'password'
+  set :home, '/'
+
+  get '/' do
+    "hello, i'm root"
+  end
+
+  get '/public' do
+    if authorized?
+      "hello, #{settings.username}"
+    else
+      "Please login"
+    end  
+  end
+
+  get '/pvt' do
+    protected!
+    "private area"
+  end
+end

data/test/sinatra_simple_auth_test.rb

@@ -0,0 +1,71 @@
+require File.dirname(__FILE__) + '/sinatra_modular_app'
+require 'test/unit'
+require 'rack/test'
+begin; require 'turn/autorun'; rescue LoadError; end
+
+class SinatraSimpleAuthTest < Test::Unit::TestCase
+  include Rack::Test::Methods
+
+  def app
+    SinatraModularApp
+  end
+
+  def test_it_should_login_and_redirect_home
+    post '/login', :password => app.password, :username => app.username
+    assert_redirected_to app.home
+  end
+
+  def test_it_should_fail_login_with_incorrect_password_and_username_and_redirect_back_to_form
+    post '/login', :password => 'incorrect', :username => 'non existing'
+    assert_redirected_to '/login'
+  end
+
+  def test_it_should_fail_login_with_incorrect_password_and_redirect_back_to_form
+    post '/login', :password => 'incorrect', :username => app.username
+    assert_redirected_to '/login'
+  end
+
+  def test_it_should_fail_login_with_incorrect_username_and_redirect_back_to_form
+    post '/login', :password => app.password, :username => 'non existing'
+    assert_redirected_to '/login'
+  end
+
+  def test_it_should_login_and_redirect_back
+    get '/pvt'
+    assert_redirected_to '/login'
+
+    login!
+    assert_redirected_to '/pvt'
+  end
+
+  def test_it_should_logout_via_delete
+    login!
+    delete '/logout'
+    assert_redirected_to '/'
+  end
+
+  def test_it_should_logout_via_get
+    login!
+    get '/logout'
+    assert_redirected_to '/'
+  end
+
+  def test_authorized_helper_should_work
+    get '/public'
+    assert last_response.body.include?("Please login")
+
+    login!
+    get '/public'
+    assert last_response.body.include?(app.username)
+  end
+
+  protected
+  def login!
+    post '/login', :password => app.password, :username => app.username
+  end
+
+  def assert_redirected_to(path)
+    assert last_response.redirect?
+    assert_equal path, last_response.headers['Location'].sub('http://example.org', '')
+  end
+end

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification
+name: sinatra-single-user-auth
+version: !ruby/object:Gem::Version
+  version: '0.1'
+  prerelease: 
+platform: ruby
+authors:
+- Kingsley Hendrickse
+- Vasily Polovnyov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: turn
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: super simple single user auth extension for Sinatra
+email:
+- kingsley@masterthought.net
+- vasily@polovnyov.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/sinatra/simple_auth.rb
+- sinatra-single-user-auth.gemspec
+- test/sinatra_modular_app.rb
+- test/sinatra_simple_auth_test.rb
+homepage: http://github.com/vast/sinatra-simple-auth/
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: super simple single user auth extension for Sinatra
+test_files:
+- test/sinatra_modular_app.rb
+- test/sinatra_simple_auth_test.rb