simple_auth 3.1.0 → 3.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ba465a655d4336e0e400a40306644584f5dc0e9fd1be216272d12f9326e01467
-  data.tar.gz: d92099b4d135f1e36c195996c14972ff6ad55e20c1d3e7d920909c3b525b11c5
+  metadata.gz: 4c6838ee76a4171f9949a217cb1071c3e419ff11b1c0bbf577ea05239ae2abb9
+  data.tar.gz: 84b753d0a73b218d694ec8cbce6159997a44d73c6c44f9b8338fdfbb67c8a734
 SHA512:
-  metadata.gz: cbe00d05c29d18d067f4decc46ab3cd1a70d72cb6e8e6bd42f16f9601b4dea552f5b6b2d6504632b4a49f01458f9e313bfa60ee65785d019c7aadb2bd86b66da
-  data.tar.gz: 71c868b0d198cf63139168545155eabe87f23cd4558f8f11e289a29917bca7fc196c6ce158a2da10c30d8922599889f9f8ed821e1872f5ea3d43c76d3fca2ba0
+  metadata.gz: 8f605bdc0caad8f2c605116a1e9c293dce9ff24fd45ef63abae8084b4cc7959d94a61691df43796fa14fb2e49efcddb519cf9f20ed3172511bc0062d3ed692f2
+  data.tar.gz: b40738c8f921ffd2bbd0a865948f816e6cf5ae125e7810a443d37a5925101bf4d03e3b55f35ca9ade4ce7003cddd1cd3fb576299ff0b8314a337e609d6b740e6

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+# v3.1.1
+
+- Catch exceptions related to record not found when session tries to load a
+  record from session. You can customize the recognized exceptions by adding the
+  error class to `SimpleAuth::Session.record_not_found_exceptions`.
+
 # v3.1.0
 
 - SimpleAuth now uses [GlobalID](https://github.com/rails/globalid) as the

data/README.md

@@ -95,6 +95,14 @@ session[:user_id]
 If you need to locate a record using such value, you can do it by calling
 `GlobalID::Locator.locate(session[:user_id])`
 
+Finally, only `ActiveRecord::RecordNotFound` errors are trapped by SimpleAuth
+(when ActiveRecord is available). If you locator raises a different exception,
+add the error class to the list of known exceptions.
+
+```ruby
+SimpleAuth::Session.record_not_found_exceptions << CustomNotFoundRecordError
+```
+
 ### Logging out users
 
 Logging out a user is just as simple; all you have to do is calling the regular

data/lib/simple_auth/railtie.rb

@@ -5,5 +5,12 @@ module SimpleAuth
     generators do
       require "simple_auth/generator"
     end
+
+    config.after_initialize do
+      ActiveSupport.on_load(:active_record) do
+        SimpleAuth::Session.record_not_found_exceptions <<
+          ActiveRecord::RecordNotFound
+      end
+    end
   end
 end

data/lib/simple_auth/session.rb

@@ -2,6 +2,10 @@
 
 module SimpleAuth
   class Session
+    def self.record_not_found_exceptions
+      @record_not_found_exceptions ||= []
+    end
+
     def self.create(**kwargs)
       new(**kwargs)
     end
@@ -21,6 +25,8 @@ module SimpleAuth
       return unless record_id_from_session
 
       @record ||= GlobalID::Locator.locate(record_id_from_session)
+    rescue *Session.record_not_found_exceptions
+      nil
     end
 
     def record_key

data/lib/simple_auth/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SimpleAuth
-  VERSION = "3.1.0"
+  VERSION = "3.1.1"
 end

data/test/unit/session_test.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+class SessionTest < Minitest::Test
+  test "returns nil for missing gid" do
+    User.delete_all
+    user = User.create!(password: "test", email: "john@example.com")
+    session_store = {}
+
+    SimpleAuth::Session.create(
+      scope: "user",
+      record: user,
+      session: session_store
+    )
+
+    user.destroy!
+
+    session = SimpleAuth::Session.create(
+      scope: "user",
+      session: session_store
+    )
+
+    assert_nil session.record
+  end
+
+  test "returns nil for missing gid (custom error)" do
+    not_found_error = Class.new(StandardError)
+    SimpleAuth::Session.record_not_found_exceptions << not_found_error
+
+    GlobalID::Locator.use :foo do |gid|
+      raise not_found_error, "record not found: #{gid}"
+    end
+
+    session = SimpleAuth::Session.create(
+      scope: "user",
+      session: {user_id: "gid://foo/User/1234"}
+    )
+
+    assert_nil session.record
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simple_auth
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.1.1
 platform: ruby
 authors:
 - Nando Vieira
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-08 00:00:00.000000000 Z
+date: 2020-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: globalid
@@ -207,6 +207,7 @@ files:
 - test/support/dummy/config/routes.rb
 - test/support/schema.rb
 - test/test_helper.rb
+- test/unit/session_test.rb
 homepage: http://rubygems.org/gems/simple_auth
 licenses: []
 metadata: {}
@@ -244,3 +245,4 @@ test_files:
 - test/support/dummy/config/routes.rb
 - test/support/schema.rb
 - test/test_helper.rb
+- test/unit/session_test.rb