shibbolite 0.0.1

data/spec/controllers/helpers_test_controller_spec.rb

@@ -0,0 +1,146 @@
+require 'spec_helper'
+
+# The HelpersTest controller is a dummy used to test
+# the Shibbolite::Helpers concern
+describe HelpersTestController do
+
+  # helper methods
+  #
+
+  describe '#current_user' do
+
+    context 'when session is loaded' do
+
+      let(:user) { FactoryGirl.build_stubbed(:user) }
+
+      before do
+        session[Shibbolite.pid] = 'someone'
+        allow(Shibbolite.user_class).to receive(:find_user).and_return(user)
+      end
+
+      it 'fetches the user from the db' do
+        get :_current_user
+        expect(assigns(:current_user)).to eq(user)
+      end
+    end
+
+    context 'when no session is loaded' do
+      it 'returns nil' do
+        get :_current_user
+        expect(assigns(:current_user)).to be_nil
+      end
+    end
+  end
+
+  describe '#logged_in?' do
+
+    context 'when session not loaded' do
+      it 'is false' do
+        session[Shibbolite.pid] = nil
+        get :_logged_in?
+        expect(assigns(:logged_in)).to be_false
+      end
+    end
+
+    context 'when session is loaded' do
+      it 'is true' do
+        session[Shibbolite.pid] = 'SSO authenticated'
+        get :_logged_in?
+        expect(assigns(:logged_in)).to be_true
+      end
+    end
+  end
+
+  describe '#anonymous_user?' do
+
+    context 'when session is not loaded' do
+      it 'is true' do
+        session[Shibbolite.pid] = nil
+        get :_anonymous_user?
+        expect(assigns(:anonymous)).to be_true
+      end
+    end
+
+    context 'when a session is loaded' do
+      it 'is false' do
+        session[Shibbolite.pid] = 'SSO authenticated'
+        get :_anonymous_user?
+        expect(assigns(:anonymous)).to be_false
+      end
+    end
+  end
+
+  describe '#guest_user?' do
+
+    context 'when a session is loaded and current_user is nil' do
+      it 'is true' do
+        session[Shibbolite.pid] = 'SSO authenticated'
+        allow(subject).to receive(:current_user).and_return(nil)
+        get :_guest_user?
+        expect(assigns(:guest)).to be_true
+      end
+    end
+
+    context 'with any other background' do
+      it 'is false' do
+        session[Shibbolite.pid] = nil
+        allow(subject).to receive(:current_user).and_return(nil)
+        get :_guest_user?
+        expect(assigns(:guest)).to be_false
+      end
+    end
+  end
+
+  describe '#registered_user?' do
+
+    context 'when the user exists in the database' do
+      it 'is true' do
+        allow(subject).to receive(:current_user).and_return('A valid user')
+        get :_registered_user?
+        expect(assigns(:registered)).to be_true
+      end
+    end
+
+    context 'when the user does not exist in the database' do
+      it 'is false' do
+        allow(subject).to receive(:current_user).and_return(nil)
+        get :_registered_user?
+        expect(assigns(:registered)).to be_false
+      end
+    end
+  end
+
+  describe '#user_in_group?' do
+
+    let(:user) { double(group: 'jedi') }
+
+    before { allow(subject).to receive(:current_user).and_return(user) }
+
+    it 'is true when user is in group' do
+      get :_user_in_group?, group: 'jedi'
+      expect(assigns(:result)).to be_true
+    end
+
+    it 'is false when user is not in group' do
+      get :_user_in_group?, group: 'sith'
+      expect(assigns(:result)).to be_false
+    end
+  end
+
+  describe '#user_id_match?' do
+
+    let(:user) { double(id: 17) }
+
+    before { allow(subject).to receive(:current_user).and_return(user) }
+
+    it 'is true when user has the id' do
+      get :_user_has_id?, id: '17'
+      expect(assigns(:result)).to be_true
+    end
+
+    it 'is false when user does not have the id' do
+      get :_user_has_id?, id: '23'
+      expect(assigns(:result)).to be_false
+    end
+  end
+end

data/spec/controllers/shibbolite/shibboleth_controller_spec.rb

@@ -0,0 +1,114 @@
+require 'spec_helper'
+
+module Shibbolite
+  describe ShibbolethController do
+
+    describe '#access_denied' do
+      before do
+        session[:requested_url] = '/Narnia'
+        get :access_denied
+      end
+
+      it 'assigns the requested url' do
+        expect(assigns(:requested_url)).to eq('/Narnia')
+      end
+
+      it 'renders' do
+        expect(response).to render_template :access_denied
+      end
+    end
+
+    describe '#login' do
+      context 'session loaded successfully' do
+        before do
+          allow(subject).to receive(:logged_in?).and_return true
+          session[:requested_url] = '/Hoth'
+        end
+
+        it 'redirects back to original action' do
+          get :login
+          expect(response).to redirect_to '/Hoth'
+        end
+      end
+
+      context 'no shibboleth session' do
+        it 'redirects to the SP for authentication' do
+          get :login
+          expect(response).to redirect_to subject.send(:sp_login_url)
+        end
+      end
+    end
+
+    describe '#logout' do
+      it 'deletes the session user id' do
+        session[Shibbolite.pid] = 'Han Solo'
+        get :logout
+        expect(session[Shibbolite.pid]).to be_nil
+      end
+
+      it 'redirects to the SP for logout' do
+        get :logout
+        expect(response).to redirect_to subject.send(:sp_logout_url)
+      end
+    end
+
+    describe '#logout_message' do
+      subject { get :logout_message }
+      it { should render_template :logout_message }
+    end
+
+    context 'methods that require the environment hash' do
+
+      let!(:environment) { FactoryGirl.build(:environment_hash).with_indifferent_access }
+      let(:attributes)   { FactoryGirl.build(:shibboleth_attributes).with_indifferent_access }
+      let!(:user)        { FactoryGirl.build_stubbed(:user) }
+
+      before do
+        allow(request).to receive(:env).and_return(environment)
+        allow(Shibbolite.user_class).to receive(:find_user).and_return(user)
+      end
+
+      describe '#load_session' do
+
+        before { allow(user).to receive(:update) }
+
+        context 'when user authenticated with sso' do
+
+          before { subject.send(:load_session) }
+
+          it 'sets user\'s primary key (primary_user_id) in session' do
+            expect(session[Shibbolite.pid]).to eq(environment[Shibbolite.pid])
+          end
+
+          it "updates the user's shibboleth attributes" do
+            expect(user).to have_received(:update).with(attributes)
+          end
+        end
+
+        context 'when user is not authenticated with sso' do
+
+          before do
+            environment[Shibbolite.pid] = nil
+            subject.send(:load_session)
+          end
+
+          it 'sets no session id' do
+            expect(session[Shibbolite.pid]).to be_nil
+          end
+
+          it 'does not update user attributes' do
+            expect(user).not_to have_received(:update)
+          end
+        end
+      end
+
+      describe '#get_attributes' do
+
+        it 'returns a hash of shibboleth attributes' do
+          attrs = subject.send(:get_attributes)
+          expect(attrs).to eq(attributes)
+        end
+      end
+    end
+  end
+end

data/spec/controllers/static_controller_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe StaticController do
+
+end

data/spec/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Dummy::Application.load_tasks

data/spec/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/spec/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/spec/dummy/app/assets/stylesheets/scaffold.css

@@ -0,0 +1,56 @@
+body { background-color: #fff; color: #333; }
+
+body, p, ol, ul, td {
+  font-family: verdana, arial, helvetica, sans-serif;
+  font-size:   13px;
+  line-height: 18px;
+}
+
+pre {
+  background-color: #eee;
+  padding: 10px;
+  font-size: 11px;
+}
+
+a { color: #000; }
+a:visited { color: #666; }
+a:hover { color: #fff; background-color:#000; }
+
+div.field, div.actions {
+  margin-bottom: 10px;
+}
+
+#notice {
+  color: green;
+}
+
+.field_with_errors {
+  padding: 2px;
+  background-color: red;
+  display: table;
+}
+
+#error_explanation {
+  width: 450px;
+  border: 2px solid red;
+  padding: 7px;
+  padding-bottom: 0;
+  margin-bottom: 20px;
+  background-color: #f0f0f0;
+}
+
+#error_explanation h2 {
+  text-align: left;
+  font-weight: bold;
+  padding: 5px 5px 5px 15px;
+  font-size: 12px;
+  margin: -7px;
+  margin-bottom: 0px;
+  background-color: #c00;
+  color: #fff;
+}
+
+#error_explanation ul li {
+  font-size: 12px;
+  list-style: square;
+}

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/spec/dummy/app/controllers/filters_test_controller.rb

@@ -0,0 +1,37 @@
+# a dummy controller for testing the Shibbolite::Filters concern
+
+class FiltersTestController < ApplicationController
+
+  include Shibbolite::Filters
+
+  before_action :require_login,               only: :_require_login
+  before_action :require_registered,          only: :_require_registered
+  before_action(only: :_require_group)        { |c| c.require_group params[:groups] }
+  before_action(only: :_require_id)           { |c| c.require_id params[:id].to_i }
+  before_action(only: :_require_group_or_id)  { |c| c.require_group_or_id params[:groups], params[:id].to_i }
+  before_action :use_attributes_if_available, only: :_use_attributes_if_available
+
+  def _require_login
+    render :dummy
+  end
+
+  def _require_registered
+    render :dummy
+  end
+
+  def _require_group
+    render :dummy
+  end
+
+  def _require_id
+    render :dummy
+  end
+
+  def _require_group_or_id
+    render :dummy
+  end
+
+  def _use_attributes_if_available
+    render :dummy
+  end
+end

data/spec/dummy/app/controllers/helpers_test_controller.rb

@@ -0,0 +1,44 @@
+# a dummy controller for testing the Shibbolite::Helpers concern
+# because real isolation testing was too much of a pain in the neck
+
+class HelpersTestController < ApplicationController
+
+  include Shibbolite::Helpers
+
+  # helpers
+
+  def _current_user
+    current_user
+    render :dummy
+  end
+
+  def _logged_in?
+    @logged_in = logged_in?
+    render :dummy
+  end
+
+  def _anonymous_user?
+    @anonymous = anonymous_user?
+    render :dummy
+  end
+
+  def _guest_user?
+    @guest = guest_user?
+    render :dummy
+  end
+
+  def _registered_user?
+    @registered = registered_user?
+    render :dummy
+  end
+
+  def _user_in_group?
+    @result = user_in_group?(params[:group].to_sym)
+    render :dummy
+  end
+
+  def _user_has_id?
+    @result = user_has_id?(params[:id].to_i)
+    render :dummy
+  end
+end

data/spec/dummy/app/controllers/static_controller.rb

@@ -0,0 +1,21 @@
+class StaticController < ApplicationController
+
+  include Shibbolite::Filters
+
+  before_action :use_attributes_if_available, only: :home
+  before_action(only: :user_resource)  { |c| c.require_group(:admin, :user) }
+  before_action(only: :admin_resource) { |c| c.require_group(:admin) }
+
+  def home
+  end
+
+  def user_resource
+    @user_data = 'Available to all users'
+    @admin_data = 'Available to admins' if user_in_group?(:admin)
+  end
+
+  def admin_resource
+    @admin_data = 'Available to admins'
+  end
+
+end

data/spec/dummy/app/models/user.rb

@@ -0,0 +1,3 @@
+class User < ActiveRecord::Base
+  include Shibbolite::User
+end

data/spec/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    "application", media: "all", "data-turbolinks-track" => true %>
+  <%= javascript_include_tag "application", "data-turbolinks-track" => true %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/spec/dummy/app/views/static/admin_resource.html.erb

@@ -0,0 +1,3 @@
+<h1>Admin Resource</h1>
+
+<%= @admin_data %>

data/spec/dummy/app/views/static/home.html.erb

@@ -0,0 +1,35 @@
+<h1>Home</h1>
+
+<h1>Testing helper methods</h1>
+
+<% if logged_in? %>
+  <p>User is logged in</p>
+<% end %>
+
+<% if anonymous_user? %>
+  <p>User is anonymous (not signed in to SSO)</p>
+<% end %>
+
+<% if guest_user? %>
+  <p>User is a guest (signed in to SSO but not registered)</p>
+<% end %>
+
+<% if registered_user? %>
+  <p>User is registered with application</p>
+<% end %>
+
+<% unless current_user.nil? %>
+  <p>User is in <%= current_user.group %> group</p>
+<% end %>
+
+<p>
+  <%= link_to 'Users only',  controller: :static, action: :user_resource %>
+  <%= link_to 'Admins only', controller: :static, action: :admin_resource %>
+</p>
+
+<p>
+  <%= link_to 'Login', shibbolite.login_path %>
+  <%= link_to 'Logout', shibbolite.logout_path %>
+</p>
+
+

data/spec/dummy/app/views/static/user_resource.html.erb

@@ -0,0 +1,5 @@
+<h1>User Resource</h1>
+
+<p><%= @user_data %></p>
+
+<p><%= @admin_data if user_in_group?(:admin) %></p>

data/spec/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/spec/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/spec/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/spec/dummy/config/application.rb

@@ -0,0 +1,17 @@
+require File.expand_path('../boot', __FILE__)
+
+# Pick the frameworks you want:
+require "active_record/railtie"
+require "action_controller/railtie"
+require "action_mailer/railtie"
+require "sprockets/railtie"
+
+Bundler.require(*Rails.groups)
+require "shibbolite"
+
+module Dummy
+  class Application < Rails::Application
+    I18n.config.enforce_available_locales = false
+  end
+end
+

data/spec/dummy/config/boot.rb

@@ -0,0 +1,5 @@
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
+
+require 'bundler/setup' if File.exists?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)

data/spec/dummy/config/database.yml

@@ -0,0 +1,25 @@
+# SQLite version 3.x
+#   gem install sqlite3
+#
+#   Ensure the SQLite 3 gem is defined in your Gemfile
+#   gem 'sqlite3'
+development:
+  adapter: sqlite3
+  database: db/development.sqlite3
+  pool: 5
+  timeout: 5000
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  adapter: sqlite3
+  database: db/test.sqlite3
+  pool: 5
+  timeout: 5000
+
+production:
+  adapter: sqlite3
+  database: db/production.sqlite3
+  pool: 5
+  timeout: 5000

data/spec/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the Rails application.
+require File.expand_path('../application', __FILE__)
+
+# Initialize the Rails application.
+Dummy::Application.initialize!

data/spec/dummy/config/environments/development.rb

@@ -0,0 +1,29 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # In the development environment your application's code is reloaded on
+  # every request. This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
+  config.cache_classes = false
+
+  # Do not eager load code on boot.
+  config.eager_load = false
+
+  # Show full error reports and disable caching.
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Don't care if the mailer can't send.
+  config.action_mailer.raise_delivery_errors = false
+
+  # Print deprecation notices to the Rails logger.
+  config.active_support.deprecation = :log
+
+  # Raise an error on page load if there are pending migrations
+  config.active_record.migration_error = :page_load
+
+  # Debug mode disables concatenation and preprocessing of assets.
+  # This option may cause significant delays in view rendering with a large
+  # number of complex assets.
+  config.assets.debug = true
+end