concerto_cas_auth 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fdead88154ae16c333b27754faaa318274680422
-  data.tar.gz: 6dec16c4284ee3337f7ab968024d22ee2e8bd133
+  metadata.gz: 3223823ecc987e6217fd13a7b210aacd55d25310
+  data.tar.gz: 5097fa47e1a5963a8e40416e7252de5f9ce8ea41
 SHA512:
-  metadata.gz: 2159ae71680cbef73cbdd6ab0440336ef941926b0250011e6f68baae7b62a8f487e87ecc19fc9ea978e71430e566997becf3338e4eb261cf63c2b8276ead64e0
-  data.tar.gz: 767ce53a20716e5327ebf329dff78f3fb14b0b2c755a0c3e21a66b799912d729d008347fb8b021773fd32033012920ed1d25f5e1fcfbf2de2114576428ccd470
+  metadata.gz: b433079684eedd9afdc49e3f7fe86d0a4ef6a4b45b608bf7c7146c5926c06a63b321db991fb7859b0606206ae6938d08782f022fe31010bbbe41e7044eedc657
+  data.tar.gz: dc6814cf3b059692f5c8d7bd70b1ff081c677de71bb4e695b667f8ed254fb1217bf24a24f9c6a291f0ace606b0263c08fb95abfa680dfa65683cdb92717a6984

data/README.md

@@ -1,2 +1,4 @@
-ConcertoCasAuth
-===============
+Concerto CAS Auth
+=====================
+
+Authenticate Concerto users through your own [CAS](http://en.wikipedia.org/wiki/Central_Authentication_Service) deployment. 

data/app/controllers/concerto_cas_auth/application_controller.rb

@@ -1,25 +1,42 @@
 module ConcertoCasAuth
   class ApplicationController < ::ApplicationController
 
+    # Used to map a user id with a corresponding authentication provider in the
+    #   database (in this case it's CAS)
     require 'concerto_identity'
 
+    # Find or create a new user based on values returned by the CAS callback
     def find_from_omniauth(cas_hash)
-      # Get any configuration options for customized CAS return value identifiers
+      # Get configuration options for customized CAS return value identifiers
       omniauth_keys = ConcertoCasAuth::Engine.config.omniauth_keys
 
-      if identity = ConcertoIdentity::Identity.find_by_user_id(cas_hash[omniauth_keys["uid_key"]])
-        # Check if user already exists
+      # Check if an identity records exists for the user attempting to sign in
+      if identity = ConcertoIdentity::Identity.find_by_user_id(
+                                            cas_hash[omniauth_keys["uid_key"]])
+        # Return the matching user record
         return identity.user
       else
         # Add a new user via omniauth cas details
         user = User.new
 
         # Set user attributes
-        user.is_admin = false
-        user.first_name = cas_hash[omniauth_keys["first_name_key"]]
+
+        # First name is required for user validation
+        if !cas_hash[omniauth_keys["first_name_key"]].nil?
+          user.first_name = cas_hash[omniauth_keys["first_name_key"]]
+        else 
+          user.first_name = cas_hash[omniauth_keys["uid_key"]]
+        end
+
+        # Email is required for user validation
         user.email = cas_hash[omniauth_keys["email_key"]]
-        user.password, user.password_confirmation = Devise.friendly_token.first(8)
 
+        # Set user admin flag to false
+        user.is_admin = false
+        # Set user password and confirmation to random tokens
+        user.password,user.password_confirmation=Devise.friendly_token.first(8)
+
+        # Check if this is our application's first user
         if !User.exists?
           # First user is an admin
           first_user_setup = true
@@ -37,13 +54,23 @@ module ConcertoCasAuth
 
           # Create Concerto Admin Group
           group = Group.where(:name => "Concerto Admins").first_or_create
-          membership = Membership.create(:user_id => user.id, :group_id => group.id, :level => Membership::LEVELS[:leader])
+          membership = Membership.create(:user_id => user.id, 
+            :group_id => group.id, 
+            :level => Membership::LEVELS[:leader])
         end
 
+        # Attempt to save our new user
         if user.save
-          ConcertoIdentity::Identity.create(provider: "cas", external_id: cash_hash[omniauth_keys["uid_key"]], user_id: user.id)
+          # Create a matching identity to track our new user for future 
+          #   sessions and return our new user record 
+          ConcertoIdentity::Identity.create(provider: "cas", 
+            external_id: cash_hash[omniauth_keys["uid_key"]], 
+            user_id: user.id)
           return user
         else
+          # User save failed, an error occurred 
+          flash.notice = "Failed to sign in with CAS. 
+            #{user.errors.full_messages.to_sentence}."
           return nil
         end
       end

data/app/controllers/concerto_cas_auth/omniauth_callback_controller.rb

@@ -8,7 +8,7 @@ module ConcertoCasAuth
       user = find_from_omniauth(cas_hash)
 
       if !user
-        flash.notice = "Failed to sign in with CAS"
+        # Redirect showing flash notice with errors
         redirect_to "/"
       elsif user.persisted?
         flash.notice = "Signed in through CAS"

data/app/views/concerto_cas_auth/omniauth_cas/_signin.html.erb

@@ -1 +1 @@
-<%= link_to 'Log in', 'auth/cas/' %>
+<%= link_to 'Log in', 'auth/cas/' %>

data/config/initializers/omniauth.rb

@@ -1,13 +1,33 @@
-# Initializer for omniauth-cas gem
+# Concerto Configs are created if they don't exist already
+#   these are used to initialize and configure omniauth-cas 
+ConcertoConfig.make_concerto_config("cas_url", "https://cas.example.org/cas", 
+  :value_type => "string", 
+  :value_default => "https://cas.example.org/cas", 
+  :category => 'CAS User Authentication', 
+  :seq_no => 1, 
+  :description =>"Defines the url of your CAS server")
 
-# get yml config from main Concerto application in config directory
-raw_config = YAML.load_file("#{Rails.root.to_s}/config/concerto_cas_auth.yml")
+ConcertoConfig.make_concerto_config("cas_uid_key", "user", 
+  :value_type => "string", 
+  :value_default => "user", 
+  :category => 'CAS User Authentication', 
+  :seq_no => 2, 
+  :description =>'The CAS field name containing user login names (uid, username,email,etc)')
 
-# read all available configuration options from yml file
-omniauth_config = {}
-raw_config.each do |key, value|
-  omniauth_config[key] = value
-end
+ConcertoConfig.make_concerto_config("cas_email_key", "email", 
+  :value_type => "string", 
+  :value_default => "email", 
+  :category => 'CAS User Authentication', 
+  :seq_no => 3, 
+  :description =>'The CAS field name containing user email addresses (email, uid,etc)')
+
+# Store omniauth config values from main application's ConcertoConfig
+omniauth_config = {
+  :host => URI.parse(ConcertoConfig[:cas_url]).host,
+  :url => ConcertoConfig[:cas_url],
+  :uid_key => ConcertoConfig[:cas_uid_key],
+  :email_key => ConcertoConfig[:cas_email_key]
+}
 
 # configure omniauth-cas gem based on specified yml configs
 Rails.application.config.middleware.use OmniAuth::Builder do
@@ -18,4 +38,4 @@ end
 #  to reference any unique identifiers for extra CAS options
 ConcertoCasAuth::Engine.configure do
    config.omniauth_keys = omniauth_config
-end
+end

data/config/routes.rb

@@ -4,4 +4,4 @@ end
 
 ConcertoCasAuth::Engine.routes.draw do
   get ":provider/callback", :to => "omniauth_callback#cas_auth"
-end
+end

data/lib/concerto_cas_auth.rb

@@ -1,4 +1,4 @@
 require "concerto_cas_auth/engine"
 
 module ConcertoCasAuth
-end
+end

data/lib/concerto_cas_auth/engine.rb

@@ -13,11 +13,15 @@ module ConcertoCasAuth
     def plugin_info(plugin_info_class)
       @plugin_info ||= plugin_info_class.new do
 
+        # Add our concerto_cas_auth route to the main application
         add_route("concerto_cas_auth", ConcertoCasAuth::Engine)
 
-        add_view_hook "ApplicationController", :signin_hook, :partial => "concerto_cas_auth/omniauth_cas/signin"
+        # View hook to override Devise sign in links in the main application
+        add_view_hook "ApplicationController", :signin_hook,
+          :partial => "concerto_cas_auth/omniauth_cas/signin"
 
       end
     end
+
   end
 end

data/lib/concerto_cas_auth/version.rb

@@ -1,3 +1,3 @@
 module ConcertoCasAuth
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/lib/tasks/concerto_cas_auth_tasks.rake

@@ -1,4 +0,0 @@
-# desc "Explaining what the task does"
-# task :concerto_cas_auth do
-#   # Task goes here
-# end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: concerto_cas_auth
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Gabe Perez
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-25 00:00:00.000000000 Z
+date: 2014-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -65,7 +65,6 @@ files:
 - app/controllers/concerto_cas_auth/omniauth_callback_controller.rb
 - app/helpers/concerto_cas_auth/application_helper.rb
 - app/views/concerto_cas_auth/omniauth_cas/_signin.html.erb
-- config/concerto_cas_auth.yml.sample
 - config/initializers/omniauth.rb
 - config/routes.rb
 - lib/concerto_cas_auth/engine.rb

data/config/concerto_cas_auth.yml.sample

@@ -1,39 +0,0 @@
-# ============================================================
-# THIS FILE GOES IN THE CONCERTO APPLICATION CONFIG/ DIRECTORY
-# ============================================================
-
-# Configuration options for omniauth-cas 
-#  visit https://github.com/dlindahl/omniauth-cas 
-#  for more details in README
-
-# ----------------
-# Required options
-# ----------------
-# host: 
-# url: 
-
-# -----------------------------------------------
-# Configurable options for values returned by CAS
-# -----------------------------------------------
-# uid_key:
-# name_key:
-# email_key:
-# first_name_key:
-# last_name_key:
-# location_key:
-# image_key:
-# phone_key:
-
-# --------------------------
-# Other configurable options
-# --------------------------
-# port:
-# ssl:
-# service_validate_url:
-# logout_url:
-# login_url:
-# uid_field:
-# ca_path:
-# disable_ssl_verification:
-# on_single_sign_out:
-