nulogy_sso 2.1.3 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ad56727743b843b7b225c6aaf8858c97c62c20dc974e3c776b9fc0fb155bc52f
-  data.tar.gz: c53a714607c173e9c1e5b96b9c1a2cedfb268b7c4483487f5fd32cfa306e0f10
+  metadata.gz: 74e239b1c685ec0b9fc96d1d56575e4a1fb9b699e4745a4f532230791be36607
+  data.tar.gz: 629ac3914d88f3ab4ae01c7bad14ce6241fc1e9274b20ba070a1a0edee247d2c
 SHA512:
-  metadata.gz: 150658c3b533bc60ebf25ff6660a93389b08b495b17d4efb8e5d6c682a377775fc09c76db34bc65522496002b0f739c1d39bddb6d00ac91c605ff3ffaf817f65
-  data.tar.gz: 8f091e0a1cd0c7aa4bc5f4c327bf72637a729ca53e073710bd414aa082a7cbc7dcdd46e17cf16c3fde207dc5558f6e741e4ce4cbefd9cee560f1d3fe8dd2a20d
+  metadata.gz: 7e8cccb0d3ef757470e78453648b820ec292f9da3b46c9fb16179dd904aa8a669887dceb01371459c2993dcacebb8e294a19e3a5093e0e947d807c45be40d056
+  data.tar.gz: 6f770201a5c6847a1fd52967fb33b988745b3b5984ce19e4c01e5b0bfd19824429e3024beda0d1f403cbaae6bd9ec97b9e88ff19f151c10774692a41a9881dc8

data/README.md

@@ -2,9 +2,15 @@
 
 [![Gem](https://img.shields.io/gem/v/nulogy_sso?label=nulogy_sso)](https://rubygems.org/gems/nulogy_sso "View this project in Rubygems")
 
+> **NOTE:** The default branch for this repository was changed to `main`. Please read [this Github blog post](https://github.blog/changelog/2020-10-01-the-default-branch-for-newly-created-repositories-is-now-main/) for more information.
+
 ## Auth0
 For more information on Auth0 see the [Auth0 documentation](https://auth0.com/docs/flows/concepts/auth-code#how-it-works).
 
+### Authentication Flow
+
+The Auth0 docs can be confusing, so we provide [a more detailed picture of the Authentication Flow](https://drive.google.com/file/d/1fbPZR6FmfetRzyQZVz16Hs2rqepY4XJZ/view?usp=sharing) implemented by this gem.
+
 ## Installation
 
 This gem is a Rails Engine. It follows best practices [documented here](https://guides.rubyonrails.org/engines.html).
@@ -111,18 +117,26 @@ docker-compose up -d
 
 Tests must be run manually before submitting a PR. This can be done using `rspec spec`.
 
-There are multiple helpers made available via the `NulogySSO::TestUtilities` module. These are helpful for doing things such as grabbing test JWT values and interacting with a [Mockserver](https://github.com/jamesdbloom/mockserver) mock of the Auth0 API.
+Please consult [this documentation](docs/Testing.md) for advice on how to implement tests on an application using nulogy_sso.
 
-It is a common use case for a Rails app to switch from Devise-powered authentication to Auth0. This would also require updates to test helper code, similar to [functionality that Devise provides out of the box](https://github.com/heartcombo/devise/wiki/How-To:-Test-controllers-with-Rails-(and-RSpec)). [See this example](https://github.com/nulogy/Common-Platform-Interface/blob/f9444ded80d6012b9659942481fa2e6b880b54ee/spec/support/controller_integration_spec_macros.rb) of how a test helper could be written for an app using a feature flag (e.g. environment variable) to switch between Devise and NulogySSO authentication.
-
-###
+### Deployment
 
 1. Ensure that all tests are passing on the project
 1. Increment the library version in [version.rb](./lib/nulogy_sso/version.rb), adhering to semver principles
 1. Add a entry to [the Changelog](./CHANGELOG.md). Move all entries in the _Unreleased_ section into the new version's section. Now is also a good chance to add in any addition bullet points that may have been forgotten in the _Unreleased_ section. Append today's date to the new version.
-1. Run these commands to complete the deployment. Rubygem push rights on this gem is required.
+1. Run these commands to complete the deployment. Rubygem push rights on this gem is required. Obviously, replace `X.Y.Z` with the version being deployed.
     ```sh
-   gem build 
+    # Commit changes to the files listed above
+    git commit -m "Cuts version X.Y.Z"
+    git push
+
+    # Push the gem to Rubygems
+    gem build nulogy_sso.gemspec
+    gem push nulogy_sso-X.Y.Z.gem
+
+    # Cut a release on GitHub
+    git tag vX.Y.Z
+    git push --tags
     ```
 
 ### Contributing

data/lib/nulogy_sso/engine.rb

@@ -9,20 +9,24 @@ module NulogySSO
   class Engine < ::Rails::Engine
     isolate_namespace NulogySSO
 
+    VERIFY_CONFIG = ENV["ASSETS_PRECOMPILE"].blank?
+
     # Load all gems in the gemspec, as opposed to explicit require calls
     Bundler.require(*Rails.groups)
 
     config.after_initialize do
-      if NulogySSO.sso_config.blank?
-        raise "Missing sso_config config object. Consider using config_for() to load a YAML config file."
-      end
+      if VERIFY_CONFIG
+        if NulogySSO.sso_config.blank?
+          raise "Missing sso_config config object. Consider using config_for() to load a YAML config file."
+        end
 
-      if NulogySSO.find_user_by_email.blank?
-        raise "Missing find_user_by_email config lambda."
-      end
+        if NulogySSO.find_user_by_email.blank?
+          raise "Missing find_user_by_email config lambda."
+        end
 
-      if NulogySSO.handle_sso_error.blank?
-        raise "Missing handle_sso_error config lambda."
+        if NulogySSO.handle_sso_error.blank?
+          raise "Missing handle_sso_error config lambda."
+        end
       end
     end
   end

data/lib/nulogy_sso/test_utilities/auth0_mock.rb

@@ -7,9 +7,15 @@ module NulogySSO
 
     # This provides a simple mock implementation of Auth0 endpoints, via mockserver
     class Auth0Mock
-      def initialize(engine_path: "/nulogy_sso")
+      def initialize(
+        engine_path: "/nulogy_sso",
+        mockserver_host: ENV.fetch("NULOGY_SSO_MOCKSERVER_HOST"),
+        mockserver_port: ENV.fetch("NULOGY_SSO_MOCKSERVER_PORT")
+      )
         @jwt_test_helper = NulogySSO::TestUtilities::JwtTestHelper.new
         @engine_path = engine_path
+        @mockserver_host = mockserver_host
+        @mockserver_port = mockserver_port
       end
 
       def setup_jwks
@@ -80,7 +86,7 @@ module NulogySSO
       end
 
       def mockserver_url(path = "")
-        "http://#{ENV.fetch("NULOGY_SSO_MOCKSERVER_HOST")}:#{ENV.fetch("NULOGY_SSO_MOCKSERVER_PORT")}/mockserver/#{path}"
+        "http://#{@mockserver_host}:#{@mockserver_port}/mockserver/#{path}"
       end
 
       def signed_jwt_response(email, overrides = {})

data/lib/nulogy_sso/version.rb

@@ -1,3 +1,3 @@
 module NulogySSO
-  VERSION = "2.1.3"
+  VERSION = "2.4.0"
 end

data/spec/dummy/log/development.log

@@ -0,0 +1,21 @@
+   (1.8ms)  SELECT sqlite_version(*)
+   (0.1ms)  SELECT sqlite_version(*)
+   (0.1ms)  SELECT sqlite_version(*)
+   (0.1ms)  DROP TABLE IF EXISTS "users"
+   (9.2ms)  CREATE TABLE "users" ("id" integer PRIMARY KEY AUTOINCREMENT NOT NULL, "email" varchar, "active" boolean DEFAULT 0 NOT NULL, "created_at" datetime NOT NULL, "updated_at" datetime NOT NULL)
+   (1.2ms)  CREATE TABLE "schema_migrations" ("version" varchar NOT NULL PRIMARY KEY)
+   (0.1ms)  SELECT "schema_migrations"."version" FROM "schema_migrations" ORDER BY "schema_migrations"."version" ASC
+   (16.6ms)  INSERT INTO "schema_migrations" (version) VALUES (20190912211120)
+   (1.1ms)  CREATE TABLE "ar_internal_metadata" ("key" varchar NOT NULL PRIMARY KEY, "value" varchar, "created_at" datetime(6) NOT NULL, "updated_at" datetime(6) NOT NULL)
+  ActiveRecord::InternalMetadata Load (0.2ms)  SELECT "ar_internal_metadata".* FROM "ar_internal_metadata" WHERE "ar_internal_metadata"."key" = ? LIMIT ?  [["key", "environment"], ["LIMIT", 1]]
+   (0.0ms)  begin transaction
+  ActiveRecord::InternalMetadata Create (0.4ms)  INSERT INTO "ar_internal_metadata" ("key", "value", "created_at", "updated_at") VALUES (?, ?, ?, ?)  [["key", "environment"], ["value", "development"], ["created_at", "2021-04-08 21:50:30.614672"], ["updated_at", "2021-04-08 21:50:30.614672"]]
+   (0.7ms)  commit transaction
+  ActiveRecord::InternalMetadata Load (0.1ms)  SELECT "ar_internal_metadata".* FROM "ar_internal_metadata" WHERE "ar_internal_metadata"."key" = ? LIMIT ?  [["key", "environment"], ["LIMIT", 1]]
+   (0.0ms)  begin transaction
+  ActiveRecord::InternalMetadata Update (0.4ms)  UPDATE "ar_internal_metadata" SET "value" = ?, "updated_at" = ? WHERE "ar_internal_metadata"."key" = ?  [["value", "test"], ["updated_at", "2021-04-08 21:50:30.620037"], ["key", "environment"]]
+   (0.7ms)  commit transaction
+  ActiveRecord::InternalMetadata Load (0.1ms)  SELECT "ar_internal_metadata".* FROM "ar_internal_metadata" WHERE "ar_internal_metadata"."key" = ? LIMIT ?  [["key", "schema_sha1"], ["LIMIT", 1]]
+   (0.0ms)  begin transaction
+  ActiveRecord::InternalMetadata Create (0.6ms)  INSERT INTO "ar_internal_metadata" ("key", "value", "created_at", "updated_at") VALUES (?, ?, ?, ?)  [["key", "schema_sha1"], ["value", "2b01fa59c4c74162736a2cb624389712cfa71fdb"], ["created_at", "2021-04-08 21:50:30.625088"], ["updated_at", "2021-04-08 21:50:30.625088"]]
+   (0.8ms)  commit transaction