RubyGems - rack-cerberus - Versions diffs - 0.1.6 → 0.2.0 - Mend

rack-cerberus 0.1.6 → 0.2.0

Files changed (9) hide show

data/README.md ADDED Viewed

@@ -0,0 +1,81 @@
+>"For over a thousand generations the Jedi Knights were the guardians of peace and justice in the Old Republic. Before the dark times, before the Empire." -- Obi-Wan Kenoby
+Cerberus
+========
+Cerberus is a Rack middleware for form-based authentication. Its purpose is only
+to offer a nicer (or more actual) replacement for Basic HTTP authentication.
+Install with:
+    # sudo gem install rack-cerberus
+You can use it almost the same way you use `Rack::Auth::Basic`:
+    require 'cerberus'
+    use Rack::Session::Cookie, :secret => 'change_me'
+    use Cerberus do |login, pass|
+      pass=='secret'
+    end
+Like in that example, make sure you have a session, because Cerberus use it for
+persistent login.
+There is an optional hash you can add for customisation it. Options are:
+- `:company_name`
+- `:fg_color` (foreground color)
+- `:bg_color` (background color)
+- `:text_color`
+- `:icon_url` (for a company logo or any icon)
+- `:css_location`
+Which is used that way:
+    use Cerberus, {:company_name => 'Nintendo'} do |login, pass|
+      pass=='secret'
+    end
+The purpose of Cerberus is to be basic, which is why there are enough options to have
+a page fairly customized with colors and logo (`:icon_url`). The logo can even replace
+the company name if you leave `:company_name` blank. But should you be fussy, this is possible
+to have more control using an external CSS file with the option `:css_location`.
+Just like `Rack::Auth::Basic`, Cerberus yields login and pass, and delegate authentication
+to the block you send it which should return a boolean.
+If you want to see a concrete example, go into the Cerberus directory and run:
+    # rackup example.ru
+It's gonna start the example at http://localhost:9292
+Logout
+------
+Any request to `/logout` on the path where the middleware is mounted will log you out.
+In other words, if you put the middleware at `/admin`, query `/admin/logout` to be
+logged out. Pretty simple.
+Help
+----
+If you want to help me, don't hesitate to fork that project on Github or send patches.
+Changelog
+---------
+	0.0.1 Changed Everything somehow
+	0.1.0 Make it possible to authenticate through GET request (for restful APIs)
+	0.1.1 Documentation improvement
+	0.1.2 Raise message when using without session
+	0.1.3 Don't go to page /logout when signing in after a logout (redirect to / instead)
+	0.1.4 Fix /logout redirect so that it works with mapping
+	0.1.5 Fix CSS and Javascript for IE (Yes I'm too kind)
+	0.1.6 Send an Array instead of a string to Rack so that it works on Ruby 1.9
+	0.2.0 External CSS file + `:text_color` option + keep details after login failure
+Copyright
+---------
+(c) 2010-2011 Mickael Riga - see MIT_LICENCE for details

data/cerberus.gemspec CHANGED Viewed

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = 'rack-cerberus'
-  s.version = "0.1.6"
+  s.version = "0.2.0"
   s.platform = Gem::Platform::RUBY
   s.summary = "A Rack middleware for form-based authentication"
   s.description = "A Rack middleware for form-based authentication. Aim is a compromise between fonctionality, beauty and customization."

data/cerberus.rb CHANGED Viewed

@@ -1,14 +1,14 @@
 class Cerberus
-  class NoSessionError < RuntimeError
-  end
+  class NoSessionError < RuntimeError; end
   AUTH_PAGE = <<-PAGE
+  <!DOCTYPE html>
   <html><head>
     <title>%s Authentication</title>
     <meta http-equiv="content-type" content="text/html; charset=utf-8" />
     <style type='text/css'>
-    body { background-color: %s; font-family: sans-serif; text-align: center; }
+    body { background-color: %s; font-family: sans-serif; text-align: center; margin: 0px; }
     h1, p { color: %s; }
     .err {
       padding: 5px;
@@ -21,14 +21,18 @@ class Cerberus
     div {
       text-align: left;
       width: 400px;
-      margin: 30px auto;
+      margin: 0px auto;
       padding: 10px;
-      border-radius: 5px;
-      -moz-border-radius: 5px;
-      -webkit-border-radius: 5px;
+      -webkit-border-bottom-left-radius: 10px;
+      -moz-border-radius-bottomleft: 10px;
+      border-bottom-left-radius: 10px;
+      -webkit-border-bottom-right-radius: 10px;
+      -moz-border-radius-bottomright: 10px;
+      border-bottom-right-radius: 10px;
       background-color: %s; }
     input { width: 400px; font-size: 20px; }
     </style>
+    %s
   </head><body>
   <div>
     <h1>%s</h1>
@@ -36,8 +40,8 @@ class Cerberus
     %s
     <p>Please Sign In</p>
     <form action="%s" method="post" accept-charset="utf-8">
-    	<input type="text" name="cerberus_login" value="login" id='login'><br />
-    	<input type="password" name="cerberus_pass" value="pass" id='pass'>
+    	<input type="text" name="cerberus_login" value="%s" id='login'><br />
+    	<input type="password" name="cerberus_pass" value="%s" id='pass'>
     	<p><input type="submit" value="SIGN IN &rarr;"></p>
     </form>
     <script type="text/javascript" charset="utf-8">
@@ -60,7 +64,13 @@ PAGE
   def initialize(app, options={}, &block)
     @app = app
-    defaults = { :company_name => 'Cerberus', :bg_color => '#333', :fg_color => '#555', :icon_url => nil}
+    defaults = {
+      :company_name => 'Cerberus',
+      :bg_color => '#999',
+      :fg_color => '#CCC',
+      :text_color => '#FFF',
+      :icon_url => nil
+    }
     @options = defaults.merge(options)
     @block = block
   end
@@ -87,7 +97,14 @@ PAGE
     else
       env['rack.session'].delete('cerberus_user')
       icon = @options[:icon_url].nil? ? '' : "<img src='#{@options[:icon_url]}' /><br />"
-      [401, {'Content-Type' => 'text/html'}, [AUTH_PAGE % [@options[:company_name], @options[:bg_color], @options[:bg_color], @options[:fg_color], @options[:company_name], icon, err, env['REQUEST_URI']]]]
+      css = @options[:css_location].nil? ? '' : "<link href='#{@options[:css_location]}' rel='stylesheet' type='text/css'>"
+      [
+        401, {'Content-Type' => 'text/html'},
+        [AUTH_PAGE % [
+          @options[:company_name], @options[:bg_color], @options[:text_color], @options[:fg_color], css, @options[:company_name],
+          icon, err, env['REQUEST_URI'], req['cerberus_login']||'login', req['cerberus_pass']||'pass'
+        ]]
+      ]
     end
   end

data/example.css ADDED Viewed

	@@ -0,0 +1 @@
1	+ body { background-color: #CCC; }

data/example.ru CHANGED Viewed

@@ -1,5 +1,6 @@
 require ::File.dirname(__FILE__) + '/cerberus'
 use Rack::Session::Cookie, :secret => 'change_me'
+F = ::File
 map '/' do
   run lambda {|env|
@@ -13,15 +14,22 @@ map '/' do
       </body>
     </html>
     EOB
-    [200, {'Content-Type' => 'text/html'}, body]
+    [200, {'Content-Type' => 'text/html'}, [body]]
   }
 end
 map '/secret' do
-  use Cerberus, {:company_name => 'Nintendo'} do |login,pass|
+  use Cerberus, {:company_name => 'Nintendo', :fg_color => 'red', :css_location => '/css'} do |login,pass|
     [login,pass]==['mario','bros']
   end
   run lambda {|env|
-    [200, {'Content-Type' => 'text/plain'}, 'Welcome back Mario. Your Credit Card number is: 9292']
+    [200, {'Content-Type' => 'text/plain'}, ['Welcome back Mario. Your Credit Card number is: 9292']]
+  }
+end
+map '/css' do
+  run lambda {|env|
+    path = F.expand_path('./example.css')
+    [200, {'Content-Type' => 'text/css', "Last-Modified"  => F.mtime(path).httpdate, "Content-Length" => F.size?(path).to_s}, [F.read(path)]]
   }
 end

data/spec.rb CHANGED Viewed

@@ -11,6 +11,8 @@ describe 'cerberus' do
   secret_app = lambda {|env| [200, {'Content-Type'=>'text/plain'}, env['rack.session'].inspect] }
   app = Rack::Session::Cookie.new(Cerberus.new(secret_app, {}) {|login,pass| [login,pass]==['mario','bros']})
   req = Rack::MockRequest.new(app)
+  app_with_css = app = Rack::Session::Cookie.new(Cerberus.new(secret_app, {:css_location=>'/main.css'}) {|login,pass| [login,pass]==['mario','bros']})
+  req_with_css = Rack::MockRequest.new(app_with_css)
   cookie = ''
   should 'Raise if there is no session' do
@@ -19,12 +21,19 @@ describe 'cerberus' do
     lambda { no_session_req.get('/') }.should.raise(Cerberus::NoSessionError).message.should=='Cerberus cannot work without Session'
   end
-  should 'Stop request if you are not already logged in or currently successfully logging' do
+  should 'Stop request if you are not already logged in' do
     res = req.get('/')
     res.status.should==401
     res.body.class==String
-    res = req.post('/', :params => {'cerberus_login' => 'fake', 'cerberus_pass' => 'fake'})
+    res.body.should.match(/name="cerberus_login" value="login"/)
+    res.body.should.match(/name="cerberus_pass" value="pass"/)
+  end
+  should 'Stop request if you send wrong details and keep query values' do
+    res = req.post('/', :params => {'cerberus_login' => 'fake_login', 'cerberus_pass' => 'fake_pass'})
     res.status.should==401
+    res.body.should.match(/name="cerberus_login" value="fake_login"/)
+    res.body.should.match(/name="cerberus_pass" value="fake_pass"/)
   end
   should 'Give access with the appropriate login and pass' do
@@ -60,4 +69,9 @@ describe 'cerberus' do
     res['Location'].should=='/backend'
   end
+  should 'Use an external css file only if requested' do
+    req.get('/').body.should.not.match(/<link/)
+    req_with_css.get('/').body.should.match(/<link/)
+  end
 end

metadata CHANGED Viewed

@@ -2,12 +2,12 @@
 name: rack-cerberus
 version: !ruby/object:Gem::Version
   hash: 23
-  prerelease: false
+  prerelease:
   segments:
   - 0
-  - 1
-  - 6
-  version: 0.1.6
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors:
 - Mickael Riga
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
-date: 2011-02-16 00:00:00 +00:00
+date: 2011-07-07 00:00:00 +01:00
 default_executable:
 dependencies: []
@@ -30,10 +30,10 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - MIT_LICENCE
-- README.rdoc
-- Rakefile
+- README.md
 - cerberus.gemspec
 - cerberus.rb
+- example.css
 - example.ru
 - spec.rb
 has_rdoc: true
@@ -66,7 +66,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubyforge_project:
-rubygems_version: 1.3.7
+rubygems_version: 1.4.2
 signing_key:
 specification_version: 3
 summary: A Rack middleware for form-based authentication

data/README.rdoc DELETED Viewed

@@ -1,68 +0,0 @@
-"For over a thousand generations the Jedi Knights were the guardians of peace and justice in the Old Republic. Before the dark times, before the Empire." -- Obi-Wan Kenoby
-= Cerberus
-Cerberus is a Rack middleware for form-based authentication. Its purpose is only
-to offer a nicer (or more actual) replacement for Basic HTTP authentication.
-Install with:
-	# sudo gem install rack-cerberus
-You can use it almost the same way you use <tt>Rack::Auth::Basic</tt>:
-	require 'cerberus'
-	use Rack::Session::Cookie, :secret => 'change_me'
-	use Cerberus do |login, pass|
-		pass=='secret'
-	end
-Like in that example, make sure you have a session, because Cerberus use it for
-persistent login.
-There is an optional hash you can add for personalizing it. Options are:
-* <tt>:company_name</tt>
-* <tt>:fg_color</tt> (foreground color)
-* <tt>:bg_color</tt> (background color)
-* <tt>:icon_url</tt> (for a company logo or any icon)
-Which is used that way:
-	use Cerberus, {:company_name => 'Nintendo'} do |login, pass|
-		pass=='secret'
-	end
-Just like <tt>Rack::Auth::Basic</tt>, Cerberus yields login and pass, and delegate authentication
-to the block you send it which should return a boolean.
-If you want to see a concrete example, go into the Cerberus directory and run:
-	# rackup example.ru
-It's gonna start the example at http://localhost:9292
-=== Logout
-Any request to <tt>/logout</tt> on the path where the middleware is mounted will log you out.
-In other words, if you put the middleware at <tt>/admin</tt>, query <tt>/admin/logout</tt> to be
-logged out. Pretty simple.
-=== Help
-If you want to help me, don't hesitate to fork that project on Github or send patches.
-=== Changelog
-	0.0.1 Changed Everything somehow
-	0.1.0 Make it possible to authenticate through GET request (for restful APIs)
-	0.1.1 Documentation improvement
-	0.1.2 Raise message when using without session
-	0.1.3 Don't go to page /logout when signing in after a logout (redirect to / instead)
-	0.1.4 Fix /logout redirect so that it works with mapping
-	0.1.5 Fix CSS and Javascript for IE (Yes I'm too kind)
-	0.1.6 Send an Array instead of a string to Rack so that it works on Ruby 1.9
-=== Copyright
-(c) 2010-2011 Mickael Riga - see MIT_LICENCE for details

data/Rakefile DELETED Viewed

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