sinatra-security 0.1.0 → 0.1.1

data/README.markdown

@@ -0,0 +1,45 @@
+Sinatra Security
+================
+
+This gem just provides you with the standard authentication mechanisms you would expect from your typical app.
+
+How to use
+==========
+  
+    # in your terminal
+    [sudo] gem install sinatra-security
+
+    # in your sinatra app
+    require 'sinatra'
+    require 'sinatra/security'
+
+    get "/public" do
+      "Hello public world"
+    end
+
+    get "/private" do
+      login_required
+
+      "Hello private world"
+    end
+
+    get "/login" do
+      @user = User.new
+
+      haml :login
+    end
+
+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/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.1

data/examples/classic.rb

@@ -0,0 +1,46 @@
+require 'sinatra'
+require 'sinatra/security'
+
+class User
+  attr :id
+
+  def self.authenticate(user, pass)
+    User.new(42) if [ user, pass ] == [ 'quentin', 'test' ]  
+  end
+  
+  def self.[](id)
+    User.new(id)
+  end
+
+  def initialize(id = nil)
+    @id = id
+  end
+end
+
+use Rack::Session::Cookie
+
+get "/" do
+  haml :home
+end
+
+get "/public" do
+  "Hello public world"
+end
+
+get "/private" do
+  require_login
+
+  "Hello private world <a href='/logout'>Logout</a>"
+end
+
+get "/login" do
+  @user = User.new
+
+  haml :login
+end
+
+get "/logout" do
+  logout!
+
+  redirect '/'
+end

data/examples/views/home.haml

@@ -0,0 +1,4 @@
+%h1 Sinatra Classic Example
+
+%a(href='/public') Public View
+%a(href='/private') Private View

data/examples/views/login.haml

@@ -0,0 +1,10 @@
+%h1 Login
+
+- if error = session.delete(:error)
+  %p= error
+
+%form(action='/login' method='post')
+  %input(type='text' name='username')
+  %input(type='password' name='password')
+
+  %button(type='submit') Login

data/lib/sinatra/security/helpers.rb

@@ -37,6 +37,10 @@ module Sinatra
       def ensure_current_user(user)
         halt 404 unless user == current_user
       end
+
+      def logout!
+        session.delete(:user) 
+      end
     end
   end
 end

data/sinatra-security.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{sinatra-security}
-  s.version = "0.1.0"
+  s.version = "0.1.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Cyril David"]
@@ -14,15 +14,18 @@ Gem::Specification.new do |s|
   s.email = %q{cyx.ucron@gmail.com}
   s.extra_rdoc_files = [
     "LICENSE",
-     "README.rdoc"
+     "README.markdown"
   ]
   s.files = [
     ".document",
      ".gitignore",
      "LICENSE",
-     "README.rdoc",
+     "README.markdown",
      "Rakefile",
      "VERSION",
+     "examples/classic.rb",
+     "examples/views/home.haml",
+     "examples/views/login.haml",
      "lib/sinatra/security.rb",
      "lib/sinatra/security/helpers.rb",
      "sinatra-security.gemspec",
@@ -39,7 +42,8 @@ Gem::Specification.new do |s|
   s.test_files = [
     "test/helper.rb",
      "test/test_sinatra-security.rb",
-     "test/test_sinatra_security_helpers.rb"
+     "test/test_sinatra_security_helpers.rb",
+     "examples/classic.rb"
   ]
 
   if s.respond_to? :specification_version then

data/test/test_sinatra_security_helpers.rb

@@ -110,4 +110,13 @@ class TestSinatraSecurityHelpers < Test::Unit::TestCase
       end
     end
   end
+
+  describe "#logout" do
+    should "set the remove the session[:user]" do
+      @context.session[:user] = 1
+      @context.logout!
+
+      assert ! @context.session[:user]
+    end
+  end
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Cyril David
@@ -26,14 +26,17 @@ extensions: []
 
 extra_rdoc_files: 
 - LICENSE
-- README.rdoc
+- README.markdown
 files: 
 - .document
 - .gitignore
 - LICENSE
-- README.rdoc
+- README.markdown
 - Rakefile
 - VERSION
+- examples/classic.rb
+- examples/views/home.haml
+- examples/views/login.haml
 - lib/sinatra/security.rb
 - lib/sinatra/security/helpers.rb
 - sinatra-security.gemspec
@@ -75,3 +78,4 @@ test_files:
 - test/helper.rb
 - test/test_sinatra-security.rb
 - test/test_sinatra_security_helpers.rb
+- examples/classic.rb

data/README.rdoc

@@ -1,17 +0,0 @@
-= 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.