gatekeeper 0.1.1 → 0.1.2

data/README.rdoc

@@ -1,10 +1,77 @@
 = Gatekeeper
 
 Gatekeeper can connect any Rack-compatible application to a Hot Ink SSO server. It allows you to easily verify the identity of a user against Hot Ink's
-user information database. It makes some basic information about the user available to you application.
+user information database. It makes some basic information about the user available to your application.
 
 Gatekeeper is largely a rewrite of Hancock-Client (http://github.com/atmos/hancock-client). The functionality is different but the spirit is the same.
 
+== Installation
+
+This is the easy part.
+
+ gem install gatekeeper --source http://gemcutter.org
+
+== Using Gatekeeper
+
+Gatekeeper is implemented in Sinatra, but it can authenticate any Rack-based application. That could be Rails, Sinatra, Rack whatever. You'll be 
+surprised how easy it is.
+
+Simply add the following into your Rack stack, by simply placing it directly into your Sinatra app as middleware, or if you're building a Rack app,
+add it to your stack in <tt>config.ru</tt>:
+
+ use Rack::Session::Cookie
+ use Gatekeeper::Middleware do |sso|
+   sso.sso_url = "http://your_sso_server.net/sso"
+ end
+
+Be sure to use the session middleware when building a Rack app, or to <tt>enable :sessions</tt> when using Sinatra. Gatekeeper relies on sessions
+to store authentication information. Also be sure to include the correct SSO server URL.
+
+=== With Rails
+
+When using Gatekeeper with Rails, you should create a 'metal' Sinatra app to keep it in, then implement it as show above. It's pretty easy, just 
+run <tt>script/generate metal sso</tt>. Inside, you should have:
+
+ require(File.dirname(__FILE__) + "/../../config/environment") unless defined?(Rails)
+ require 'sinatra/base'
+ require 'logger'
+
+ class Sso < Sinatra::Base
+   use Gatekeeper::Middleware do |sso|
+     sso.sso_url = "http://your_sso_server.net/sso"
+   end
+ end
+
+When using Rails, you should be sure *not* to <tt>enable sessions</tt> in your Sinatra metal. Rails takes care of the session. If you re-enable, you'll overwrite what Rails
+has already found and your authentication will not work 
+
+=== In your app
+
+Gatekeeper puts the received user details in a hash accessible using session[:sso]. Things are a little more convenient using the helpers. To do
+that, simply include Gatekeeper::Helpers::Authentication in your app. You can then use the following methods:
+
+* current_user
+
+  Will return +nil+ or the current user's id, depending on whether or not the user is logged in.
+
+* is_admin?
+
+  Is this user a Hot Ink admin? You may have some tasks that only admin users can do.
+
+* is_manager_of?(hotink_account_id)
+
+  Will return true if the user is a manager of the account who's id you passed in.
+	
+Your app can use a simple +require_user+ method as a before filter to ensure that users are logged in, the most basic of which could look like this:
+
+ def require_user
+  unless current_user
+    redirect_to "/sso/login?return_to=#{request.request_uri}"
+    false # if you're using this as a Rails before filter, return false 
+  end
+ end
+
+
 == Note on Patches/Pull Requests
  
 * Fork the project.

data/Rakefile

@@ -10,6 +10,9 @@ begin
     gem.email = "chrisgdinn@gmail.com"
     gem.homepage = "http://github.com/chrisdinn/gatekeeper"
     gem.authors = ["Chris Dinn"]
+    gem.add_dependency 'ruby-openid', '>= 2.1.7'
+    gem.add_dependency 'rack-openid', '>= 0.2.1'
+    gem.add_dependency 'sinatra', '>= 0.9.2'
     gem.add_development_dependency "rspec", ">= 1.2.9"
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.1.2

data/gatekeeper.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{gatekeeper}
-  s.version = "0.1.1"
+  s.version = "0.1.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Chris Dinn"]
-  s.date = %q{2010-01-12}
+  s.date = %q{2010-01-14}
   s.description = %q{Connects any Rack-compatible app to a Hot Ink single sign on server.}
   s.email = %q{chrisgdinn@gmail.com}
   s.extra_rdoc_files = [
@@ -48,11 +48,20 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<ruby-openid>, [">= 2.1.7"])
+      s.add_runtime_dependency(%q<rack-openid>, [">= 0.2.1"])
+      s.add_runtime_dependency(%q<sinatra>, [">= 0.9.2"])
       s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
     else
+      s.add_dependency(%q<ruby-openid>, [">= 2.1.7"])
+      s.add_dependency(%q<rack-openid>, [">= 0.2.1"])
+      s.add_dependency(%q<sinatra>, [">= 0.9.2"])
       s.add_dependency(%q<rspec>, [">= 1.2.9"])
     end
   else
+    s.add_dependency(%q<ruby-openid>, [">= 2.1.7"])
+    s.add_dependency(%q<rack-openid>, [">= 0.2.1"])
+    s.add_dependency(%q<sinatra>, [">= 0.9.2"])
     s.add_dependency(%q<rspec>, [">= 1.2.9"])
   end
 end

data/lib/gatekeeper.rb

@@ -1,13 +1,7 @@
-gem 'sinatra', '~>0.9.2'
 require 'sinatra/base'
-
-gem 'ruby-openid', '>=2.1.6'
 require 'openid'
 require 'openid/store/filesystem'
-
-gem 'rack-openid', '>=0.2'
 require 'rack/openid'
-
 require 'tmpdir'
 
 require File.dirname(__FILE__)+'/gatekeeper/helpers/rack'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: gatekeeper
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors: 
 - Chris Dinn
@@ -9,9 +9,39 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-12 00:00:00 -05:00
+date: 2010-01-14 00:00:00 -05:00
 default_executable: 
 dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: ruby-openid
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.1.7
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rack-openid
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.2.1
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: sinatra
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.9.2
+    version: 
 - !ruby/object:Gem::Dependency 
   name: rspec
   type: :development