ucb_rails_user 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 58c8b74546e69a79a150b113311da8005f519e6145abeef076b0da46e1e3a4a6
-  data.tar.gz: 935b9fbc803bccb0d7648f624dfa62ddbf6c9c3f8d1ccc38a3508fee1c1bd5b8
+SHA1:
+  metadata.gz: dc5620499c364c14d79ea1c8da21d420617fc235
+  data.tar.gz: b801bf9e74db566224e301efc79744ca0fc9b774
 SHA512:
-  metadata.gz: e21944de29b16bb076b4f2f7211ce36d2ef545a31d6b1a67a3d0f8d9382e30a12be096f9c1d4bd6ea0abc9384cb04bbfb08a71e0bb86c7b929132f0aa36432cb
-  data.tar.gz: 81b286a1577137c0638a993972d21700d02f0ede341a050437e656aa1febc0a1164508112c229ffc4ca77674eb3136893b94b8936f6cfcf43d86bbca2da0bece
+  metadata.gz: 493ed7ef342b66b11c8e36b23b4a7d1087defc96108059994678702d734a849308c19f8030e43f22eb28bd02387f70d5ff2dfce24e9dc7bcab2d587edc211f77
+  data.tar.gz: 70bf635518c74e56f5e8c3edb992a8328278232274315f5512fcb0838346160279322a5ee7c015dff3e5d4d4feb3d6367103cde3ee67cfdc85616106412c240b

data/README.md

@@ -8,7 +8,7 @@ A [Rails engine](http://guides.rubyonrails.org/engines.html) that provides authe
   * controller filters that block access to resources unless user is logged in
   * a default home page that reflects user's login status
   * admin screens for updating and deleting user records
-  
+
 This engine also includes the [Datatables](https://datatables.net/) JQuery plug-in, which is used in the user management screens. Host apps can make use of this as well.
 
 ## Prerequisites
@@ -128,6 +128,44 @@ skip_before_action :ensure_authenticated_user
 
 `UsersController` uses `ensure_admin_user` as a `before_filter`
 
+## Testing Support
+
+This engine comes with a few features to help with testing.
+
+The `UcbRailsUser::UserSessionManager::TestSessionManager` is a specialized session manager designed for test cases. It overrides the `login` method to lookup the given `uid` in the `users` table of the database. As long as the user record already exists, the `login` method will return successfully.
+
+There is also a `UcbRailsUser::SpecHelpers` module that provides some support methods. Specifically, the `login_user` method can be used in request or integration specs to perform the behind-the-scenes work needed to login a given user. This method is implemented according to the [omniauth gem documentation.](https://github.com/omniauth/omniauth/wiki/Integration-Testing)
+
+To add the testing support, add the following lines to your `spec_helper.rb` or `rails_helper.rb` file:
+
+```ruby
+# add this line
+require 'ucb_rails_user/spec_helpers'
+
+# then, somewhere in this block...
+RSpec.configure do |config|
+
+  ...
+
+  # ...add these lines
+  config.include UcbRailsUser::SpecHelpers
+  UcbRailsUser.config do |config|
+    config.user_session_manager = "UcbRailsUser::UserSessionManager::TestSessionManager"
+  end
+```
+
+Then, from within any request or integration spec, you should be able to do this:
+
+```ruby
+  it "should do some neato feature" do
+    user = create(:user) # assumes you've added FactoryBot or similiar
+    login_user(user)
+  end
+```
+
+and the user should now be logged in.
+
+
 ## Overriding Model And Controller Behavior
 
 The host app can add or override behavior of the `User` model and `UserController` as needed. We've followed the conventions suggested in the [Rails guide](http://guides.rubyonrails.org/engines.html#implementing-decorator-pattern-using-activesupport-concern) to make this as easy as possible.

data/app/models/ucb_rails_user/user_session_manager/test_session_manager.rb

@@ -0,0 +1,18 @@
+#
+# Session manager designed to be used in tests. This bypasses the usual LDAP lookup when
+# given a uid, and instead simply looks up the user in the current database.
+#
+# This assumes that the user already exists in the database, so your test scenario should
+# set that up before attempting a login
+#
+module UcbRailsUser
+  module UserSessionManager
+    class TestSessionManager < ActiveInUserTable
+
+      def login(uid)
+        User.find_by_ldap_uid(uid)
+      end
+
+    end
+  end
+end

data/lib/ucb_rails_user/spec_helpers.rb

@@ -0,0 +1,27 @@
+module UcbRailsUser
+  module SpecHelpers
+
+    def login_user(user)
+      OmniAuth.config.test_mode = true
+      auth_mock(user.ldap_uid)
+      get "/login"
+      follow_redirect!
+      follow_redirect!
+    end
+
+    def auth_mock(uid)
+      OmniAuth.config.mock_auth[:cas] = OmniAuth::AuthHash.new(
+        provider: "cas",
+        uid: uid,
+        user_info: {
+          name: "mockuser"
+        },
+        credentials: {
+          token: "mock_token",
+          secret: "mock_secret"
+        }
+      )
+    end
+
+  end
+end

data/lib/ucb_rails_user/version.rb

@@ -1,3 +1,3 @@
 module UcbRailsUser
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ucb_rails_user
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Steve Downey
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-11 00:00:00.000000000 Z
+date: 2018-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -225,6 +225,7 @@ files:
 - app/models/ucb_rails_user/user_session_manager/in_people_ou.rb
 - app/models/ucb_rails_user/user_session_manager/in_people_ou_add_to_users_table.rb
 - app/models/ucb_rails_user/user_session_manager/ldap_person_user_wrapper.rb
+- app/models/ucb_rails_user/user_session_manager/test_session_manager.rb
 - app/models/user.rb
 - app/views/ucb_rails_user/home/logged_in.html.haml
 - app/views/ucb_rails_user/home/not_logged_in.html.haml
@@ -248,6 +249,7 @@ files:
 - lib/templates/erb/scaffold/_form.html.erb
 - lib/ucb_rails_user.rb
 - lib/ucb_rails_user/engine.rb
+- lib/ucb_rails_user/spec_helpers.rb
 - lib/ucb_rails_user/version.rb
 homepage: https://github.com/ucb-ist-eas/ucb_rails_user
 licenses:
@@ -269,7 +271,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Rails engine for UCB user accounts