From 922ff50e060a6de14485f47154da385312d6139a Mon Sep 17 00:00:00 2001 From: Peter Bouda Date: Tue, 22 Oct 2024 09:31:57 +0100 Subject: [PATCH] DEV: Move user and group class extensions to mixins --- lib/discourse_scim/group_mixin.rb | 62 ++++++++++++++ lib/discourse_scim/user_mixin.rb | 65 +++++++++++++++ plugin.rb | 130 ++++-------------------------- 3 files changed, 141 insertions(+), 116 deletions(-) create mode 100644 lib/discourse_scim/group_mixin.rb create mode 100644 lib/discourse_scim/user_mixin.rb diff --git a/lib/discourse_scim/group_mixin.rb b/lib/discourse_scim/group_mixin.rb new file mode 100644 index 0000000..9b3179a --- /dev/null +++ b/lib/discourse_scim/group_mixin.rb @@ -0,0 +1,62 @@ +# frozen_string_literal: true + +require "scimitar" + +module DiscourseScim::GroupMixin + module GroupClassMethods + def scim_resource_type + Scimitar::Resources::Group + end + + def scim_attributes_map + { + id: :id, + displayName: :name, + members: [ # NB read-write, though individual items' attributes are immutable + list: :scim_users_and_groups, # See adapter accessors, earlier in this file + using: { + value: :id + }, + find_with: -> (scim_list_entry) { + id = scim_list_entry['value'] + type = scim_list_entry['type' ] || 'User' + + case type.downcase + when 'user' + User.find_by_id(id) + when 'group' + Group.find_by_id(id) + else + # TODO: Decide what to do here, I added User to be able to use scim-tester + User.find_by_id(id) + # raise Scimitar::InvalidSyntaxError.new("Unrecognised type #{type.inspect}") + end + } + ] + } + end + + def scim_mutable_attributes + nil + end + + def scim_queryable_attributes + { + displayName: :name + } + end + end + + def scim_users_and_groups + self.users.to_a + self.associated_groups.to_a + end + + def scim_users_and_groups=(mixed_array) + self.users = mixed_array.select { |item| item.is_a?(User) } + self.associated_groups = mixed_array.select { |item| item.is_a?(Group) } + end + + def self.included(base) + base.extend GroupClassMethods + end +end \ No newline at end of file diff --git a/lib/discourse_scim/user_mixin.rb b/lib/discourse_scim/user_mixin.rb new file mode 100644 index 0000000..df2df4d --- /dev/null +++ b/lib/discourse_scim/user_mixin.rb @@ -0,0 +1,65 @@ +# frozen_string_literal: true + +require "scimitar" + +module DiscourseScim::UserMixin + module UserClassMethods + def scim_resource_type + Scimitar::Resources::User + end + + def scim_attributes_map + { + id: :id, + userName: :username, + displayName: :name, + emails: [ + { + match: "type", + with: "work", + using: { + value: :email, + primary: true + } + } + ], + groups: [ + { + list: :groups, + using: { + value: :id, + display: :name + } + } + ], + active: :active + } + end + + def scim_timestamps_map + { + created: :created_at, + lastModified: :updated_at + } + end + + def scim_mutable_attributes + nil + end + + def scim_queryable_attributes + { + displayName: { column: :name }, + userName: { column: :username }, + emails: { column: :emails }, + groups: { column: Group.arel_table[:id] }, + "groups.value" => { column: Group.arel_table[:id] } + + } + end + end + + def self.included(base) + base.extend UserClassMethods + end +end \ No newline at end of file diff --git a/plugin.rb b/plugin.rb index d2e3604..3de1d82 100644 --- a/plugin.rb +++ b/plugin.rb @@ -6,15 +6,15 @@ # authors: Peter Bouda # url: https://forge.libre.sh/libre.sh/discourse-scim -gem 'marcel', '1.0.0', {require: false } -gem 'activestorage', '7.1.4', {require: false } -gem 'actiontext', '7.1.4', {require: false } -gem 'actionmailbox', '7.1.4', {require: false } -gem 'websocket-extensions', '0.1.0', {require: false } -gem 'websocket-driver', '0.6.1', {require: false } -gem 'actioncable', '7.1.4', {require: false } -gem 'rails', '7.1.4', {require: false } -gem 'scimitar', '2.9.0', {require: false } +gem "marcel", "1.0.0", { require: false } +gem "activestorage", "7.1.4.1", { require: false } +gem "actiontext", "7.1.4.1", { require: false } +gem "actionmailbox", "7.1.4.1", { require: false } +gem "websocket-extensions", "0.1.0", { require: false } +gem "websocket-driver", "0.6.1", { require: false } +gem "actioncable", "7.1.4.1", { require: false } +gem "rails", "7.1.4.1", { require: false } +gem "scimitar", "2.9.0", { require: false } require "scimitar" @@ -36,120 +36,18 @@ module ::DiscourseScim PLUGIN_NAME = "scim" require_relative "lib/discourse_scim/engine" + require_relative "lib/discourse_scim/user_mixin" + require_relative "lib/discourse_scim/group_mixin" end after_initialize do - # TODO: Check how to avoid monkey patching here class ::User - def self.scim_resource_type - Scimitar::Resources::User - end - - def self.scim_attributes_map - { - id: :id, - userName: :username, - displayName: :name, - emails: [ - { - match: "type", - with: "work", - using: { - value: :email, - primary: true - } - } - ], - groups: [ - { - list: :groups, - using: { - value: :id, - display: :name - } - } - ], - active: :active - } - end - - def self.scim_timestamps_map - { - created: :created_at, - lastModified: :updated_at - } - end - - def self.scim_mutable_attributes - nil - end - - def self.scim_queryable_attributes - { - displayName: { column: :name }, - userName: { column: :username }, - emails: { column: :emails }, - groups: { column: Group.arel_table[:id] }, - "groups.value" => { column: Group.arel_table[:id] } - - } - end - + include DiscourseScim::UserMixin include Scimitar::Resources::Mixin end - + class ::Group - def scim_users_and_groups - self.users.to_a + self.associated_groups.to_a - end - - def scim_users_and_groups=(mixed_array) - self.users = mixed_array.select { |item| item.is_a?(User) } - self.associated_groups = mixed_array.select { |item| item.is_a?(Group) } - end - - def self.scim_resource_type - Scimitar::Resources::Group - end - - def self.scim_attributes_map - { - id: :id, - displayName: :name, - members: [ # NB read-write, though individual items' attributes are immutable - list: :scim_users_and_groups, # See adapter accessors, earlier in this file - using: { - value: :id - }, - find_with: -> (scim_list_entry) { - id = scim_list_entry['value'] - type = scim_list_entry['type' ] || 'User' - - case type.downcase - when 'user' - User.find_by_id(id) - when 'group' - Group.find_by_id(id) - else - # TODO: Decide what to do here, I added User to be able to use scim-tester - User.find_by_id(id) - # raise Scimitar::InvalidSyntaxError.new("Unrecognised type #{type.inspect}") - end - } - ] - } - end - - def self.scim_mutable_attributes - nil - end - - def self.scim_queryable_attributes - { - displayName: :name - } - end - + include DiscourseScim::GroupMixin include Scimitar::Resources::Mixin end end