sinatra-simple-auth 0.1.1 → 0.5

data/.gitignore

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

data/Gemfile

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

data/README.md

@@ -1,34 +1,70 @@
-##Sinatra SimpleAuth Extension
+## Sinatra SimpleAuth Extension
 
-Extends Sinatra with a extension methods and routes for dealing with a simple, single-password authorization
+Sinatra extension with methods and routes for dealing with simple, single-password authorization
 
-##Installation
+## Installation
 
-    sudo gem install sinatra-simple-auth -s http://gemcutter.org/
+    sudo gem install sinatra-simple-auth
 
-##Usage
+Or via bundler:
 
+    gem 'sinatra-simple-auth'
+
+## Usage (classic style applications)
+
+    # classic_app.rb
     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
+    set :password, 'my_cool_password' # set the password
+    set :home, '/secure/' # where user should be redirected after successful authentication
 
-    get '/a/?' do
-      erb :auth #page with logon form
+    get '/login/?' do
+      erb :login # page with auth form
     end
 
     get '/secure/' do
-      protected! #protected route, requires auth
+      protected! # protected route, requires auth
       erb :secure
     end
 
     get '/' do
-      if authorized? #helper method
+      if authorized? # helper method
         "Hello, %username%"
       else
         "Not authorized"
       end
     end
+
+## Usage (modular style applications)
+
+    # modular_app.rb
+    require 'sinatra/base'
+    require 'sinatra/simple_auth'
+
+    class SinatraModularApp < Sinatra::Base
+      enable :sessions
+      register Sinatra::SimpleAuth
+
+      set :password, 'hello' # 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, %username%"
+        else
+          "Not authorized"
+        end
+      end
+    end

data/Rakefile

@@ -1,31 +1,9 @@
-require 'rubygems'
 require 'rake/testtask'
-require 'rake/gempackagetask'
+require 'bundler'
+Bundler::GemHelper.install_tasks
 
 task :default => :test
 
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gemspec|
-    gemspec.name = "sinatra-simple-auth"
-    gemspec.version = "0.1.1"
-    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_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']

data/lib/sinatra/simple_auth.rb

@@ -8,22 +8,22 @@ module Sinatra
       end
 
       def auth!(password)
-        if password == options.password
+        if password == settings.password
           session[:arni] = true
-          redirect_back_or_default(options.home)
+          redirect_back_or_default(settings.home)
         end
-        redirect '/a'
+        redirect to('/login')
       end
 
       def logout!
         session.clear
-        redirect '/'
+        redirect to('/')
       end
 
       def protected!
         unless authorized?
           store_location
-          redirect '/a'
+          redirect to('/login')
         end
       end
 
@@ -33,12 +33,10 @@ module Sinatra
 
       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
+        if session[:return_to] && session[:return_to] !=~ /^\/login\/?$/
+          redirect session.delete(:return_to)
         end
-        redirect default
+        redirect to(default)
       end
 
     end
@@ -49,13 +47,11 @@ module Sinatra
       app.set :password, 'password'
       app.set :home, '/'
 
-      ['/a/?', '/login/?', '/signin/?'].each do |r|
-        app.post r do
-          auth!(params[:password])
-        end
+      app.post '/login/?' do
+        auth!(params[:password])
       end
 
-      app.delete '/a/?' do
+      app.delete '/logout/?' do
         logout!
       end
 

data/sinatra-simple-auth.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "sinatra-simple-auth"
+  s.version     = '0.5'
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Vasily Polovnyov"]
+  s.email       = ["vasily@polovnyov.ru"]
+  s.homepage    = "http://github.com/vast/sinatra-simple-auth/"
+  s.summary     = %q{super simple auth extension for Sinatra}
+  s.description = %q[super simple 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('rack-test')
+  s.add_development_dependency('turn')
+end

data/test/sinatra_modular_app.rb

@@ -0,0 +1,27 @@
+require 'sinatra/base'
+require './lib/sinatra/simple_auth'
+
+class SinatraModularApp < Sinatra::Base
+  enable :sessions
+  register Sinatra::SimpleAuth
+  
+  set :password, 'hello'
+  set :home, '/'
+
+  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
+end

data/test/sinatra_simple_auth_test.rb

@@ -1,44 +1,49 @@
-require 'sinatra_app'
+require 'sinatra_modular_app'
 require 'test/unit'
 require 'rack/test'
-begin; require 'turn'; rescue LoadError; end
-
-set :environment, :test
-enable :sessions
+begin; require 'turn/autorun'; rescue LoadError; end
 
 class SinatraSimpleAuthTest < Test::Unit::TestCase
   include Rack::Test::Methods
 
   def app
-    Sinatra::Application
+    SinatraModularApp
   end
 
-  def test_it_should_login_and_redirect
-    post '/a', {:password => app.password}
-    assert_redirect app.home
+  def test_it_should_login_and_redirect_home
+    post '/login', :password => app.password
+    assert_redirected_to app.home
   end
 
-  def test_it_should_fail_login_and_redirect
-    post '/a', {:password => 'some fake data'}
-    assert_redirect '/a'
+  def test_it_should_fail_login_and_redirect_back_to_form
+    post '/login', :password => 'some fake data'
+    assert_redirected_to '/login'
   end
 
   def test_it_should_login_and_redirect_back
     get '/pvt'
-    assert_redirect '/a'
+    assert_redirected_to '/login'
+
+    login!
+    assert_redirected_to '/pvt'
+  end
+
+  def test_it_should_logout_via_delete
     login!
-    assert_redirect '/pvt'
+    delete '/logout'
+    assert_redirected_to '/'
   end
 
-  def test_it_should_logout
+  def test_it_should_logout_via_get
     login!
-    delete '/a'
-    assert_redirect '/'
+    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?("%username%")
@@ -46,11 +51,11 @@ class SinatraSimpleAuthTest < Test::Unit::TestCase
 
   protected
   def login!
-    post '/a', {:password => app.password}
+    post '/login', :password => app.password
   end
 
-  def assert_redirect(path)
+  def assert_redirected_to(path)
     assert last_response.redirect?
-    assert_equal last_response.headers['Location'], path
+    assert_equal path, last_response.headers['Location'].sub('http://example.org', '')
   end
 end

metadata

@@ -1,96 +1,110 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: sinatra-simple-auth
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 1
-  - 1
-  version: 0.1.1
+version: !ruby/object:Gem::Version
+  version: '0.5'
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Vasily Polovnyov
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2010-03-24 00:00:00 +03:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-10-12 00:00:00.000000000 Z
+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
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.1.0
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.1.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
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        - 3
-        - 0
-        version: 0.3.0
+  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
-  version_requirements: *id002
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: super simple auth extension for Sinatra
-email: vasily@polovnyov.ru
+email:
+- vasily@polovnyov.ru
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
-- LICENSE
-- README.md
-files: 
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
 - LICENSE
 - README.md
 - Rakefile
 - lib/sinatra/simple_auth.rb
-- test/sinatra_app.rb
+- sinatra-simple-auth.gemspec
+- test/sinatra_modular_app.rb
 - test/sinatra_simple_auth_test.rb
-has_rdoc: true
-homepage: http://github.com/vast/sinatra-simple-auth
+homepage: http://github.com/vast/sinatra-simple-auth/
 licenses: []
-
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
-require_paths: 
+rdoc_options: []
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
+      hash: 4494792989292088615
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
+      hash: 4494792989292088615
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: super simple auth extension for Sinatra
-test_files: 
+test_files:
+- test/sinatra_modular_app.rb
 - test/sinatra_simple_auth_test.rb
-- test/sinatra_app.rb

data/test/sinatra_app.rb

@@ -1,24 +0,0 @@
-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