concerto_cas_auth 0.0.8 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1569c23b511a337f0b556eee7f009205405dd2c3
-  data.tar.gz: 4839a47d022a456671285b7a5933853e27aea0e3
+  metadata.gz: 5e695601f3786266ae7914bcf7f82ed91595b508
+  data.tar.gz: 2ba282b068c16cf0354005e530db401c03f1a359
 SHA512:
-  metadata.gz: eb4b374283629f2b06d4148c0c7afb2b297e24239872c0e1e99e2697e1758a740f27ba358a94d81aebdc2e2ce8e380b68ef10471256a9060b00dba2be2c86aea
-  data.tar.gz: 4a7948fbc0470d4e16805e78ae66f83d01a0611b6da18f237c44be15285c8497d115a0d95a3a8c54c7efd4af45ab883054370942893c70ab411666ac85351b3e
+  metadata.gz: 79af688d03ce93a0dd6c4ffee8f3f49356cbe8d83a580030c91da5ee59b83f7cfbf3e1c259805db90de1e2dd12a29798344b80d15e339d1ccf52109a2a1d3c98
+  data.tar.gz: 4a9cdabdaf9653e18150fdce2fe8d2942a7066b57b6766dbfcf0338c69aced148ec2319d100383d377f27856c13a387a334718dbcfafed859a55ece7181d60ae

data/README.md

@@ -2,3 +2,26 @@ Concerto CAS Auth
 =====================
 
 Authenticate Concerto users through your own [CAS](http://en.wikipedia.org/wiki/Central_Authentication_Service) deployment. 
+
+Installing the plugin
+----------------------
+1. Log in using a system admin account in your Concerto deployment
+2. Click on the "plugins" button on the top navigation bar under the admin section.
+3. On the right side of the page, click on the "new plugin" button.
+4. With RubyGems selected as the source, add the gem concerto_cas_auth in the text field. 
+5. Click save, you will now stop your Concerto web server, run the ```bundle``` command, and start your web server again.
+6. Since the CAS plugin is not configured yet, you can log back into your Concerto accounts by visiting the ```your.concerto.url/users/sign_in``` route. 
+7. If the plugin was installed successfully, you will see a new CAS User Authentication settings tab under the "settings" page. This page can be found by clicking the "settings" button on the top navigation bar under the admin section.
+
+Configuring the plugin
+----------------------
+1. Log in using a system admin account in your Concerto deployment
+2. Click on the "settings" button on the top navigation bar under the admin section.
+3. Click on the "CAS User Authentication" tab.
+4. Configure the CAS URL to point towards your CAS deployment. For example, https://cas-auth.rpi.edu/cas. 
+5. The CAS uid key will be used as a unique identifier for each account. This will be returned by your CAS server upon authentication.
+6. The CAS email key is required and will be used to access the email address returned by your CAS server upon authentication.
+7. After saving these settings, you will need to restart your Concerto web server.
+8. Your log in links at the top of the page should now point to your CAS authentication. 
+
+note: This plugin is essentially a wrapper around [omniauth-cas](https://github.com/dlindahl/omniauth-cas) with added logic for creating Concerto user accounts with the returned CAS information. Feel free to follow the omniauth-cas link and see a more detailed description of the configuration items. 

data/app/controllers/concerto_cas_auth/application_controller.rb

@@ -11,7 +11,7 @@ module ConcertoCasAuth
       omniauth_keys = ConcertoCasAuth::Engine.config.omniauth_keys
 
       # Check if an identity records exists for the user attempting to sign in
-      if identity = ConcertoIdentity::Identity.find_by_user_id(
+      if identity = ConcertoIdentity::Identity.find_by_external_id(
                                             cas_hash[omniauth_keys[:uid_key]])
         # Return the matching user record
         return identity.user
@@ -22,14 +22,19 @@ module ConcertoCasAuth
         # Set user attributes
 
         # 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"]]
+        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"]]
+        if !cas_hash[omniauth_keys[:email_key]].nil?
+          user.email = cas_hash[omniauth_keys[:email_key]]
+        else
+          user.email = cas_hash[omniauth_keys[:uid_key]] + 
+                       "@" + omniauth_keys[:email_suffix].tr("@", "")
+        end
 
         # Set user admin flag to false
         user.is_admin = false

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

@@ -1 +1 @@
-<%= link_to 'Log in', 'auth/cas/' %>
+<%= link_to t('.sign_in'), root_url + 'auth/cas/' %>

data/config/initializers/omniauth.rb

@@ -1,42 +1,56 @@
-# 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")
+if ActiveRecord::Base.connection.table_exists? 'concerto_configs'
+  # 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")
 
-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)')
+  ConcertoConfig.make_concerto_config("cas_uid_key", "uid",
+    :value_type => "string",
+    :category => "CAS User Authentication",
+    :seq_no => 2,
+    :description => "CAS field name containing user login names")
 
-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)')
+  ConcertoConfig.make_concerto_config("cas_email_key", "email",
+    :value_type => "string",
+    :category => "CAS User Authentication",
+    :seq_no => 3,
+    :description => "CAS field name containing user email addresses")
 
-# 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],
-  :callback_url => "/auth/cas/callback"
-}
+  ConcertoConfig.make_concerto_config("cas_email_suffix", "@",
+    :value_type => "string",
+    :category => "CAS User Authentication",
+    :seq_no => 4,
+    :description => "Appends this suffix to a CAS returned user id. Leave blank if using email_key above")
 
-# configure omniauth-cas gem based on specified yml configs
-Rails.application.config.middleware.use OmniAuth::Builder do
-  provider :cas, omniauth_config
-end
+  ConcertoConfig.make_concerto_config("cas_first_name_key", "first_name",
+    :value_type => "string",
+    :category => "CAS User Authentication",
+    :seq_no => 5,
+    :description => "CAS field name containing first name")
+
+  # 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],
+    :first_name_key => ConcertoConfig[:cas_first_name_key],
+    :email_key => ConcertoConfig[:cas_email_key],
+    :email_suffix => ConcertoConfig[:cas_email_suffix],
+    :callback_url => "/auth/cas/callback"
+  }
+
+  # configure omniauth-cas gem based on specified yml configs
+  Rails.application.config.middleware.use OmniAuth::Builder do
+    provider :cas, omniauth_config
+  end
 
-# save omniauth configuration for later use in application
-#  to reference any unique identifiers for extra CAS options
-ConcertoCasAuth::Engine.configure do
-   config.omniauth_keys = omniauth_config
+  # save omniauth configuration for later use in application
+  #  to reference any unique identifiers for extra CAS options
+  ConcertoCasAuth::Engine.configure do
+     config.omniauth_keys = omniauth_config
+  end
 end

data/lib/concerto_cas_auth/engine.rb

@@ -20,6 +20,10 @@ module ConcertoCasAuth
         add_view_hook "ApplicationController", :signin_hook,
           :partial => "concerto_cas_auth/omniauth_cas/signin"
 
+        # Controller hook to supply a redirect route (example: non public Concerto instances)
+        add_controller_hook "ApplicationController", :auth_plugin, :before do
+          @auth_url = "/auth/cas"
+        end
       end
     end
 

data/lib/concerto_cas_auth/version.rb

@@ -1,3 +1,3 @@
 module ConcertoCasAuth
-  VERSION = "0.0.8"
+  VERSION = "0.0.9"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: concerto_cas_auth
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
 platform: ruby
 authors:
 - Gabe Perez
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-30 00:00:00.000000000 Z
+date: 2015-09-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -131,7 +131,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.2.3
 signing_key: 
 specification_version: 4
 summary: Provides user authentication using CAS