rack-cas-rails 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 94069c44e3881fdf468716d0cde889f52bb29dc0
+  data.tar.gz: a6561f72a97430cde57571c08a509241ba811150
+SHA512:
+  metadata.gz: f4c4d0cf508b1eccec73e857220e52345b654fd7521d70693503651abe422f40b37f8181aa2f9c354f7495f7a8884b66d7086f6e3c06ca9cb72adca196755473
+  data.tar.gz: 8aee86f4813563c42758a484fb173403b4d4fa09b42e4438cbaf42d7aed88a7ba631d9ec3b113db89e3b4cc14f635768ae2c49df06e67ff5023f97609090417e

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Nathan Brazil
+
+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,142 @@
+# rack-cas-rails
+
+While [rbCAS/CASinoApp](http://rbcas.com) and [biola/rack-cas](https://github.com/biola/rack-cas) are both great
+and wonderful, there is gap between them.  Namely, the bits needed to enable a Rails application to use rack-cas to integrate with
+CASinoApp for authentication are still missing.
+
+This gem aims to fill in this void.
+
+## Installation
+
+Add the following line to a Rails application's Gemfile:
+
+```ruby
+gem "rack-cas-rails"
+```
+
+Then open up your config/application.rb file, and add the following:
+
+## Requirements
+
+The rack-cas-rails gem relies on the following:
+
+  * A CAS-compliant server, such as [CASinoApp](http://rbcas.com)
+  * [rack-cas](https://github.com/biola/rack-cas)
+  * [rails](http://rubyonrails.org/)
+
+## Basic Usage
+
+The first thing you need to do is to make your Application class (file ```config/application.rb```) aware of the CAS-compliant
+server you are integrating with by pointing out its base URL, like so:
+
+```ruby
+module MyGreatApplication
+  class Application < Rails::Application
+    # ...
+    # URL of CAS server
+    config.rack_cas.server_url = "https://sso.example.org/"
+  end
+end
+```
+
+In the simplest scenario, you'll want your entire application protected by authentication.  That is, unless a user has authenticated,
+he can do nothing.  To do so, add the following ```before_action``` callback to your ApplicationController (file
+```app/controllers/application_ronctoller.rb```):
+
+```ruby
+class ApplicationController < ActionController::Base
+  # authenticate all actions for all controllers
+  before_action :authenticate!
+  # ...
+end
+```
+
+The ```authenticate!``` method will check to see if a browser session is authenticated.  If it is, controller execution will continue.
+Otherwise, it will render the ```public/401.html``` file as well as return a HTTP status of 401.
+
+So, now, create a ```pubilc/401.html``` file in your application.   You can simply copy an existing file, rename and change its
+contents.
+
+## Helper Methods
+
+The rack-cas-rails gem also augments the ApplicationHelper module with these methods:
+
+  * login_url
+  * logout_url
+
+When invoked, these helpers will renturn the CAS-integrated login in and log out URLs, respectively.
+
+## What Is Still Missing
+
+Even with the rack-cas and rack-cas-rails gems, the aforementioned basic authentication scheme is still incomplete.  Namely, for an
+authenticated session, which user does it belong to?
+
+Various Rails authentication gems makes the currently authenticated user available as an object via the ```current_user``` helper
+method.  The rack-cas-rails gem does not provide this functionality.  But you can look to gems such as
+[OmniAuth](https://github.com/intridea/omniauth), [Devise](https://github.com/plataformatec/devise), and so on
+to provide it.
+
+But, assuming your application has **users** table in its database containing user records which are uniquely identifiable by a username
+column, you can add the following code to your ApplictionController:
+
+```ruby
+class ApplicationController
+
+  # ...
+  
+  def current_user
+    authenciated? ? User.find_by_login(request.session["cas"]["user"]) : nil
+  end
+
+  helper_method :current_user
+
+end
+```
+
+Lastly, change your ```views/layouts/application.html.erb``` to be as follows:
+
+```erb
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Testapp420</title>
+  <%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track' => true %>
+  <%= javascript_include_tag 'application', 'data-turbolinks-track' => true %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+  <divi id="nav-header">
+    <% if authenticated? %>
+      <span>Logged in as <%= current_user.username %>.</span>
+      <span style="float:right"><%= link_to "Logout", logout_url %></span>
+    <% else %>
+      <span><%= link_to "Login", login_url %></span>
+    <% end %>
+  </div>
+  <hr />
+  <div>
+    <%= yield %>
+  </div>
+</body>
+</html>
+```
+
+## Summary
+
+To recap, you'll have integrated your Rails application with a CAS-compliant server by making these changes to your application:
+
+  1. Add config.rack_cas.server_url to config/application.rb
+  2. Add ```before_action :authenticate!``` to ApplicationController
+  3. Add ```current_user``` method to ApplictionController
+  4. Add simple navigational header to make use of ```current_user``` and the ```login_url```/```logout_url``` helpers
+
+As such, you can expect the following behavior:
+
+  * When you browse to any view within your application using a fresh session, you'll be re-directed to the sign-in page
+  * After you authenticate, you'll be re-directed back to the page you browsed to
+  * When you click the Logout link, your session will end, and the browser will be re-directed back to the login page
+
+## Credits
+
+A big *thank-you* goes out the teams and contributors behind [CASinoApp](http://rbcas.com) and
+[rack-cas](https://github.com/biola/rack-cas), without whom this gem will not be possible.

data/lib/rack-cas/rails/controllers.rb

@@ -0,0 +1,37 @@
+module RackCAS
+  module Rails
+
+    ##
+    # All actions in controllers derived from this controller require authentication.
+
+    class AuthenticatedController < ApplicationController
+      before_action :authenticate!
+    end
+    
+  end
+end
+
+##
+# Augment Rails' ApplicationController class with authentication related methods.
+
+class ApplicationController
+
+  ##
+  # When invoked, will force authenticate.  Most likely to be invoked as a before_action.
+
+  def authenticate!
+    authenticated? or render(:file => "public/401.html", :status => :unauthorized) # HTTP 401
+  end
+
+  ##
+  # Determines whether the current request belongs to a session that is authenticated or not.
+  # @return [Bool] True if current request belongs to an authenticated session, false otherwise.
+
+  def authenticated?
+    request.session["cas"] && request.session["cas"]["user"]
+  end
+
+  helper_method :authenticate!
+  helper_method :authenticated?
+
+end

data/lib/rack-cas/rails/helpers.rb

@@ -0,0 +1,36 @@
+module RackCAS
+  module Rails
+  end
+end
+
+##
+# Augment the ApplicationHelper module with these methods.
+
+module ApplicationHelper
+
+  ##
+  # Renders the CAS login URL with re-direct back to some URL.
+  # @param service_url [String] Optional url to redirect to after authentication.
+  # @return [String] The CAS login URL.
+
+  def login_url(service_url=request.url)
+    url = URI(Rails.application.config.rack_cas.server_url)
+    url.path = "/login"
+    url.query = "service=#{service_url || request.url}"
+    url.to_s
+  end
+
+  ##
+  # Renders the CAS logout URL with re-direct back to some URL (e.g. the root URL).  The logout path is "/logout",
+  # which is actually undocumented.  I had to find out by looking into the source code of the rack-cas gem.
+  # @param service_url [String] Optional url to redirect to after authentication.
+  # @return [String] The CAS logout URL.
+
+  def logout_url(service_url=request.url)
+    url = URI(request.url)
+    url.path = "/logout"
+    url.query = "service=#{service_url || request.url}"
+    url.to_s
+  end
+
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: rack-cas-rails
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Nathan Brazil
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack-cas
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+description: Provides the integration glue between a Rails application and biola/rack-cas
+  so that a CAS-compliant server (only tested with CASinoApp) can be used for authentication
+  by the application.
+email: nb@bitaxis.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/rack-cas/rails/controllers.rb
+- lib/rack-cas/rails/helpers.rb
+homepage: https://github.com/bitaxis/json_hash.git
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Enables a Rails application to use CAS-compliant server for authentication.
+test_files: []
+has_rdoc: