hubssolib 3.2.0 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c6df4bbfdb7389a9ae74fd974f9aec00f80caccf38a9702514bea230563c8abf
-  data.tar.gz: 6714640777624dc0a90744f125218375c42ff322401bcf65dc2d730df2de4a0c
+  metadata.gz: b434d369e25dc81a74c87385df70cade7dfd40c47abfae2c05732b471b6e1f5e
+  data.tar.gz: 41d2303f125f52a5f957f851f1a8d5ae7067ab8233fcfa5359640f88e3bceb06
 SHA512:
-  metadata.gz: 52375b875cda94de7b2823a1b718a5588f27c0c093d4f0010373670ffc4b54da4c5211e627719a56f10179cb3a91b86403a31f955b07348f7bfdaa25906de410
-  data.tar.gz: 5ef7b400a85299a3925994bba59d8c6ff1b1ded612541affd288413955eee935971e7d0bb8e61855fef42955baa3b6b2331333b720de82f1cdfcfff0f4a5eb94
+  metadata.gz: 7dc3e04c0b1e75eecf504c61d19834151179666b7e601d974cbf74509f1ab1197bbf74cf347c63b4e1aef61d744bceb96621b7fccb8017654f6d4266eea21246
+  data.tar.gz: ba3e8e1985dd91185c6049e25212dcade4dfe064faf31c4e1c1d013ac8851984f3b48ee47df5de16d097863ea36c9165c93790e05703f8fa640908e7260c3b4b

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## 3.3.0, 16-Feb-2025
+
+Sentry support, for use by the DRb server. If you use Sentry, define your account's `SENTRY_DSN` in the environment where the DRb server runs and exceptions will be reported.
+
+## 3.2.1, 16-Feb-2025
+
+The conditional login return-via-referrer mechanism never really worked, so instead have the login status indicator link generate a return-to URL in the query string instead and forward that, if present, in preference.
+
 ## 3.2.0, 15-Feb-2025
 
 Introduces the user change handler mechanism, a scheme whereby an external application tells Hub about a Rake task that the application has implemented, through which Hub can inform if of changes to a user's e-mail address or "real" name. See the gem's `README.md` for details, under "Applications with an existing user model".

data/README.md

@@ -166,7 +166,7 @@ To solve these problems, external applications integrated with Hub can participa
 ```ruby
 module Foo
   class Application < Rails::Application
-    require HubSsoLib::Core
+    include HubSsoLib::Core
 
     hubssolib_register_user_change_handler(
       app_name: Rails.application.name,
@@ -187,12 +187,19 @@ For example, `lib/tasks/hub.rake` might look like this:
 namespace :hub do
   desc 'Update a user with details sent from Hub'
   task :update_user, [:old_email, :old_name, :new_email, :new_name] => :environment do | t, args |
-    user = User.find_by_email_address(old_email)
-    user&.update!(email_address: new_email, display_name: new_name)
+    user = User.find_by_email_address(args[:old_email])
+
+    # ...or use "user&.update_columns" for speed and to bypass validations, as
+    # Hub's validations may not be as strict as yours but it doesn't matter if
+    # you're happy syncing Hub data in general.
+    #
+    user&.update!(email_address: args[:new_email], display_name: args[:new_name])
   end
 end
 ```
 
+The four arguments are guaranteed to be present and non-empty, with leading or trailing white space already stripped. You don't need to waste time checking for `nil` or blank values. The upper/lower case **is preserved**, as entered by the user, for all arguments - so e-mail addresses in particular might contain a mixture of upper and lower case letters. If this matters to your application, be sure to apply whatever normalisation you previously used when your user record was originally created with the old Hub-sourced e-mail and/or name.
+
 
 
 ## Hub library API

data/hubssolib.gemspec

@@ -4,7 +4,7 @@ spec = Gem::Specification.new do |s|
   s.platform = Gem::Platform::RUBY
   s.name     = 'hubssolib'
 
-  s.version  = '3.2.0'
+  s.version  = '3.3.0'
   s.author   = 'Andrew Hodgkinson and others'
   s.email    = 'ahodgkin@rowing.org.uk'
   s.homepage = 'http://pond.org.uk/'

data/lib/hub_sso_lib.rb

@@ -412,6 +412,10 @@ module HubSsoLib
       @session_user         = HubSsoLib::User.new
       @session_key_rotation = nil
       @session_ip           = nil
+
+    rescue => e
+      Sentry.capture_exception(e) if defined?(Sentry) && Sentry.respond_to?(:capture_exception)
+      raise
     end
   end # Session class
 
@@ -433,6 +437,10 @@ module HubSsoLib
       @hub_sessions = {}
 
       puts "Session factory: Awaken" unless @hub_be_quiet
+
+    rescue => e
+      Sentry.capture_exception(e) if defined?(Sentry) && Sentry.respond_to?(:capture_exception)
+      raise
     end
 
     # Get a session using a given key (a UUID). Generates a new session if
@@ -481,10 +489,18 @@ module HubSsoLib
 
       hub_session.session_key_rotation = new_key
       return hub_session
+
+    rescue => e
+      Sentry.capture_exception(e) if defined?(Sentry) && Sentry.respond_to?(:capture_exception)
+      raise
     end
 
     def enumerate_hub_sessions()
       @hub_sessions
+
+    rescue => e
+      Sentry.capture_exception(e) if defined?(Sentry) && Sentry.respond_to?(:capture_exception)
+      raise
     end
   end
 
@@ -511,6 +527,10 @@ module HubSsoLib
       @@hub_session_factory = HubSsoLib::SessionFactory.new
       DRb.start_service(HUB_CONNECTION_URI, @@hub_session_factory, { :safe_level => 1 })
       DRb.thread.join
+
+    rescue => e
+      Sentry.capture_exception(e) if defined?(Sentry) && Sentry.respond_to?(:capture_exception)
+      raise
     end
   end # Server module
 
@@ -555,6 +575,15 @@ module HubSsoLib
       noscript_img_src = "#{HUB_PATH_PREFIX}/account/login_indication.png"
       noscript_img_tag = helpers.image_tag(noscript_img_src, size: '90x22', border: '0', alt: 'Log in or out')
 
+      if self.respond_to?(:request)
+        return_to_url = self.request.try(:original_url)
+
+        if return_to_url.present?
+          return_query = URI.encode_www_form({ return_to_url: return_to_url.to_s })
+          ui_href << "?#{return_query}"
+        end
+      end
+
       logged_in_link   = helpers.link_to('Account',        ui_href, id: 'hubssolib_logged_in_link')
       logged_out_link  = helpers.link_to('Log in',         ui_href, id: 'hubssolib_logged_out_link')
       noscript_link    = helpers.link_to(noscript_img_tag, ui_href, id: 'hubssolib_login_noscript')

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: hubssolib
 version: !ruby/object:Gem::Version
-  version: 3.2.0
+  version: 3.3.0
 platform: ruby
 authors:
 - Andrew Hodgkinson and others
 bindir: bin
 cert_chain: []
-date: 2025-02-15 00:00:00.000000000 Z
+date: 2025-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: drb