hubssolib 2.0.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9309369683fa647e559c4a87d5569e215d25f472b2acdb6869b538807a42ecf2
-  data.tar.gz: 6b4ffb49a16835ceac8436c6ebd5d9270fe9ea1af2d9c1de07616e2b38f5cd5e
+  metadata.gz: f418c1a21497375e396be12fd95387b6a436ed42c8145dc681ee041eded447a3
+  data.tar.gz: 06d7868acf059c7c9df758d960b508e6e063fb0f1b012ff520a549772079a486
 SHA512:
-  metadata.gz: 8b4d75adcceea21ca4b95b49410a20667b7a1088e7f0bcf63e267699a779ba8e1ececcf2a5d5894274f7f12fe47eb4694bc948df912d625c86aece3dfc6551a7
-  data.tar.gz: 7c6aea5a1261203b6c74872620cbb7195e53cb9b545df6dea252bb0c4dce7c25260891d0ee7ceca8b1a85da29fb8669a7fb8346202f972d3263e199efd1df26c
+  metadata.gz: fa015b2a0853402ee85b23c788bfd52a15cbda02c000ad0c6f6eba882e664393fe7927119f2b53c2f396d9b8f6d9337b85bdfa5fe50866e07a9fe7942b8700cf
+  data.tar.gz: 006b768e21fe802806c946062b0e74be65cad124833f861455f09f684887c09104f281450b08295bf9c17f472e1839c291b6f6422212cbf9717d03d8925ba3c6

data/CHANGELOG.md

@@ -1,4 +1,35 @@
-## Version 1 -> Version 2.0.0, 19-Apr-2020
+## 3.0.0, 28-Jan-2025
+
+* The Hub "login indication" URL approach is now dropped, so layout templates **must be updated.**
+
+In Hub v1 and v2, login indication was done via an image that was served by the Hub application itself, wrapped in a link that visited a "conditional login" endpoint which stored the return-to URL, ensured HTTPS was in use and visited either the log in, or log out page as required. In client applications it looked a bit like this:
+
+```html
+  <a class="img" href="<%= ENV['HUB_PATH_PREFIX'] %>/account/login_conditional">
+    <img src="<%= ENV['HUB_PATH_PREFIX'] %>/account/login_indication" alt="Account" height="22" width="90" />
+  </a>
+```
+
+This dates back to a time when CSS support was not that widespread and RISC OS Open needed the web site to work well on web browsers available at the time. Things have improved enormously since then, so now a cleaner, pure CSS solution is used. This has the enormous advantage of requiring no image fetch request-response into the Hub application. Just use:
+
+```ruby
+<%= hubssolib_account_link() %>
+```
+
+...in place of the markup above.
+
+
+
+## 2.1.0, 01-Jul-2022
+
+* Use `HUB_QUIET_SERVER=yes ...` to quieten `$stdout` output from Hub server.
+* Test coverage fixed (overlooked in v2.0.0 release).
+* Maintenance `bundle update`.
+* A few minor tidy-ups in the implementation.
+
+
+
+## Version 1.0.0 -> Version 2.0.0, 19-Apr-2020
 
 The public interface to applications is generally unchanged, but the cookie storage mechanism has been improved and is not compatible with v1 of Hub. You will need to use the newer Hub application, server and gem, but hopefully will find you don't need to change anything with your integrated applications.
 

data/Gemfile

@@ -1,3 +1,3 @@
-source :rubygems
+source 'https://rubygems.org'
 
 gemspec # See hubssolib.gemspec

data/Gemfile.lock

@@ -1,41 +1,69 @@
 PATH
   remote: .
   specs:
-    hubssolib (2.0.0)
+    hubssolib (3.0.0)
+      base64 (~> 0.2)
+      drb (~> 2.2)
 
 GEM
-  remote: http://rubygems.org/
+  remote: https://rubygems.org/
   specs:
-    diff-lcs (1.5.0)
-    docile (1.4.0)
-    rspec (3.11.0)
-      rspec-core (~> 3.11.0)
-      rspec-expectations (~> 3.11.0)
-      rspec-mocks (~> 3.11.0)
-    rspec-core (3.11.0)
-      rspec-support (~> 3.11.0)
-    rspec-expectations (3.11.0)
+    base64 (0.2.0)
+    date (3.4.1)
+    debug (1.10.0)
+      irb (~> 1.10)
+      reline (>= 0.3.8)
+    diff-lcs (1.5.1)
+    docile (1.4.1)
+    doggo (1.4.0)
+      rspec-core (~> 3.13)
+    drb (2.2.1)
+    io-console (0.8.0)
+    irb (1.15.1)
+      pp (>= 0.6.0)
+      rdoc (>= 4.0.0)
+      reline (>= 0.4.2)
+    pp (0.6.2)
+      prettyprint
+    prettyprint (0.2.0)
+    psych (5.2.3)
+      date
+      stringio
+    rdoc (6.11.0)
+      psych (>= 4.0.0)
+    reline (0.6.0)
+      io-console (~> 0.5)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.2)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.3)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-mocks (3.11.1)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-support (3.11.0)
-    simplecov (0.21.2)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.2)
+    simplecov (0.22.0)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
       simplecov_json_formatter (~> 0.1)
-    simplecov-html (0.12.3)
+    simplecov-html (0.13.1)
     simplecov_json_formatter (0.1.4)
+    stringio (3.1.2)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  debug (~> 1.1)
+  doggo (~> 1.4)
   hubssolib!
-  rspec (~> 3.8)
-  rspec-mocks (~> 3.8)
-  simplecov (~> 0.16)
+  rspec (~> 3.13)
+  rspec-mocks (~> 3.13)
+  simplecov (~> 0.22)
 
 BUNDLED WITH
-   2.3.17
+   2.6.2

data/README.md

@@ -24,28 +24,10 @@ The latest version of the Hub gem source code is available at:
 
 ### The Hub library gem
 
-First of all, download and unpack the Hub gem sources. Change into the source directory (usually, `rails/gems/hubssolib`) and build with:
-
-```sh
-gem build hubssolib.gemspec
-```
-
-Install the Hub gem using the `gem` command in the usual fashion. For example, for version 1.0.0 of the library, issue the following command:
-
-```sh
-gem install hubssolib-1.0.0.gem
-```
-
-If you run multiple gem repositories you can instruct `gem` to install into a specific location using the `--install-dir` command line switch:
-
-```sh
-gem install hubssolib-1.0.0.gem --install-dir=/home/username/gems
-```
-
 Include in a project by adding this to your `Gemfile`:
 
 ```ruby
-gem 'hubssolib', '~> 1.0.0', :require => 'hub_sso_lib'
+gem 'hubssolib', '~> 3.0', require: 'hub_sso_lib'
 ```
 
 ### The DRb server
@@ -55,7 +37,7 @@ The Hub DRb server consists of a small wrapper Ruby script which does most of it
 ```sh
 HUB_CONNECTION_URI="drbunix:/home/username/sockets/.hub_drb"
 export HUB_CONNECTION_URI
-ruby /home/username/hub/hub_sso_server.rb &
+ruby /home/username/hubssolib/hub_sso_server.rb &
 ```
 
 The default is to use a file `.hub_drb` in the root of the current user's home directory. If you specify a custom URI, note that it _MUST_ start with `drbunix:`; the hub server must not be run on an IP port for security reasons.

data/hubssolib.gemspec

@@ -4,11 +4,10 @@ spec = Gem::Specification.new do |s|
   s.platform = Gem::Platform::RUBY
   s.name     = 'hubssolib'
 
-  s.version  = '2.0.0'
+  s.version  = '3.0.0'
   s.author   = 'Andrew Hodgkinson and others'
   s.email    = 'ahodgkin@rowing.org.uk'
-  s.homepage = 'http://hub.pond.org.uk/'
-  s.date     = File.ctime('VERSION')
+  s.homepage = 'http://pond.org.uk/'
   s.summary  = 'Cross-application single sign-on support library.'
   s.license  = 'MIT'
 
@@ -23,9 +22,14 @@ spec = Gem::Specification.new do |s|
   EOF
 
   s.files = FileList['lib/**/*.rb', '[A-Z]*'].to_a
-  s.required_ruby_version = '>= 2.5.9' # Not tested on earlier versions
+  s.required_ruby_version = '>= 3.0.0' # Not tested on earlier versions
 
-  s.add_development_dependency 'simplecov',   '~> 0.16'
-  s.add_development_dependency 'rspec',       '~> 3.8'
-  s.add_development_dependency 'rspec-mocks', '~> 3.8'
+  s.add_dependency 'drb',    '~> 2.2'
+  s.add_dependency 'base64', '~> 0.2'
+
+  s.add_development_dependency 'debug',       '~> 1.1'
+  s.add_development_dependency 'simplecov',   '~> 0.22'
+  s.add_development_dependency 'doggo',       '~> 1.4'
+  s.add_development_dependency 'rspec',       '~> 3.13'
+  s.add_development_dependency 'rspec-mocks', '~> 3.13'
 end

data/lib/hub_sso_lib.rb

@@ -75,7 +75,7 @@ module HubSsoLib
     def self.deserialise_object(data)
       Marshal.load(Base64.strict_decode64(data)) rescue nil
     end
-  end # Crypto class
+  end # Serialiser class
 
   #######################################################################
   # Class:   Roles                                                      #
@@ -409,9 +409,10 @@ module HubSsoLib
 
   class SessionFactory
     def initialize
-      puts "Session factory: Awaken"
-
+      @hub_be_quiet = ! ENV['HUB_QUIET_SERVER'].nil?
       @hub_sessions = {}
+
+      puts "Session factory: Awaken" unless @hub_be_quiet
     end
 
     # Get a session using a given key (a UUID). Generates a new session if
@@ -426,7 +427,7 @@ module HubSsoLib
     # The returned object is proxied via DRb - it is shared between processes.
     #
     # +key+::       Session key; lazy-initialises a new session under this key
-    #               if none is found, then immeediately rotates it.
+    #               if none is found, then immediately rotates it.
     #
     # +remote_ip+:: Request's remote IP address. If there is an existing
     #               session which matches this, it's returned. If there is an
@@ -434,23 +435,25 @@ module HubSsoLib
     #               invalid and discarded.
     #
     def get_hub_session_proxy(key, remote_ip)
-      retrieve_existing = @hub_sessions.has_key?(key)
-      message           = retrieve_existing ? 'Retrieving' : 'Created'
-      new_key           = SecureRandom.uuid
+      hub_session = @hub_sessions[key]
+      message     = hub_session.nil? ? 'Created' : 'Retrieving'
+      new_key     = SecureRandom.uuid
 
-      puts "#{message} session for key #{key} and rotating to #{new_key}"
+      unless @hub_be_quiet
+        puts "#{ message } session for key #{ key } and rotating to #{ new_key }"
+      end
 
-      if retrieve_existing
-        hub_session = @hub_sessions[key]
-        if remote_ip != hub_session.session_ip
-          puts "WARNING: IP address changed from #{hub_session.session_ip} to #{remote_ip} -> discarding session"
-          hub_session = @hub_sessions[key] = HubSsoLib::Session.new
+      unless hub_session.nil? || hub_session.session_ip == remote_ip
+        unless @hub_be_quiet
+          puts "WARNING: IP address changed from #{ hub_session.session_ip } to #{ remote_ip } -> discarding session"
         end
 
-      else
-        hub_session            = @hub_sessions[key] = HubSsoLib::Session.new
-        hub_session.session_ip = remote_ip
+        hub_session = nil
+      end
 
+      if hub_session.nil?
+        hub_session            = HubSsoLib::Session.new
+        hub_session.session_ip = remote_ip
       end
 
       @hub_sessions.delete(key)
@@ -483,7 +486,7 @@ module HubSsoLib
 
   module Server
     def hubssolib_launch_server
-      puts "Server: Starting at #{ HUB_CONNECTION_URI }"
+      puts "Server: Starting at #{ HUB_CONNECTION_URI }" unless ENV['HUB_QUIET_SERVER'].nil?
 
       @@hub_session_factory = HubSsoLib::SessionFactory.new
       DRb.start_service(HUB_CONNECTION_URI, @@hub_session_factory, { :safe_level => 1 })
@@ -515,6 +518,27 @@ module HubSsoLib
       !!self.hubssolib_current_user
     end
 
+    # Returns markup for a link that leads to Hub's conditional login endpoint,
+    # inline-styled as a red "Log in" or green "Account" button. This can be
+    # used in page templates to avoid needing any additional images or other
+    # such resources and using pure HTML + CSS for the login indication.
+    #
+    def hubssolib_account_link
+      logged_in = self.hubssolib_logged_in?()
+
+      text, klass, style = if logged_in
+        ['Account', 'hubssolib_logged_in',  'border: 1px solid #050; color: #050; background: #efe;']
+      else
+        ['Log in',  'hubssolib_logged_out', 'border: 1px solid #500; color: #500; background: #fee;']
+      end
+
+      style << ' display: block; width: 88px; height; 20px;'
+      style << ' text-align: center; line-height: 20px;'
+      style << ' font: sans-serif; font-size: 10pt'
+
+      "<a href=\"#{HUB_PATH_PREFIX}/account/login_conditional\" class=\"#{klass}\" style=\"#{style}\">#{text}</a>".html_safe()
+    end
+
     # Check if the user is authorized to perform the current action. If calling
     # from a helper, pass the action name and class name; otherwise by default,
     # the current action name and 'self.class' will be used.
@@ -819,7 +843,7 @@ module HubSsoLib
       keys = ordered_keys | hash.keys
 
       keys.each do | key |
-        compiled_data[ 'hub' ][ key ] = hash[ key ] if hash.has_key?( key )
+        compiled_data['hub'][key] = hash[key] if hash.key?(key)
       end
 
       if defined?( flash )
@@ -827,7 +851,7 @@ module HubSsoLib
         keys = ordered_keys | hash.keys
 
         keys.each do | key |
-          compiled_data[ 'standard' ][ key ] = hash[ key ] if hash.has_key?( key )
+          compiled_data['standard'][key] = hash[key] if hash.key?(key)
         end
       end
 
@@ -852,6 +876,7 @@ module HubSsoLib
                 :hubssolib_current_user,
                 :hubssolib_unique_name,
                 :hubssolib_logged_in?,
+                :hubssolib_account_link,
                 :hubssolib_authorized?,
                 :hubssolib_privileged?,
                 :hubssolib_flash_data

metadata

@@ -1,57 +1,112 @@
 --- !ruby/object:Gem::Specification
 name: hubssolib
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Andrew Hodgkinson and others
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-06-30 00:00:00.000000000 Z
+date: 2025-01-28 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: drb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: base64
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: debug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.16'
+        version: '0.22'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.22'
+- !ruby/object:Gem::Dependency
+  name: doggo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.16'
+        version: '1.4'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.8'
+        version: '3.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.8'
+        version: '3.13'
 - !ruby/object:Gem::Dependency
   name: rspec-mocks
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.8'
+        version: '3.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.8'
+        version: '3.13'
 description: |2
       The Hub SSO Library supports single sign-on across multiple Rails
       applications on the same host. The Hub application provides account
@@ -69,14 +124,12 @@ files:
 - Gemfile
 - Gemfile.lock
 - README.md
-- VERSION
 - hubssolib.gemspec
 - lib/hub_sso_lib.rb
-homepage: http://hub.pond.org.uk/
+homepage: http://pond.org.uk/
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -84,15 +137,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.9
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Cross-application single sign-on support library.
 test_files: []

data/VERSION

@@ -1 +0,0 @@
-2.0.0 (19-Apr-2020)