powerhome-scimitar 1.0.0

data/spec/apps/dummy/app/models/mock_group.rb

@@ -0,0 +1,83 @@
+class MockGroup < ActiveRecord::Base
+
+  # ===========================================================================
+  # TEST ATTRIBUTES - see db/migrate/20210308020313_create_mock_groups.rb etc.
+  # ===========================================================================
+
+  READWRITE_ATTRS = %w{
+    id
+    scim_uid
+    display_name
+    scim_users_and_groups
+  }
+
+  has_and_belongs_to_many :mock_users
+
+  has_many :child_mock_groups, class_name: 'MockGroup', foreign_key: 'parent_id'
+
+  # ===========================================================================
+  # SCIM ADAPTER ACCESSORS
+  #
+  # Groups in SCIM can contain users or other groups. That's why the :find_with
+  # key in the Hash returned by ::scim_attributes_map has to check the type of
+  # thing it needs to find. Since the mappings only support a single read/write
+  # accessor, we need custom accessors to do what SCIM is expecting by turning
+  # the Rails associations to/from mixed, flat arrays of mock users and groups.
+  # ===========================================================================
+
+  def scim_users_and_groups
+    self.mock_users.to_a + self.child_mock_groups.to_a
+  end
+
+  def scim_users_and_groups=(mixed_array)
+    self.mock_users        = mixed_array.select { |item| item.is_a?(MockUser)  }
+    self.child_mock_groups = mixed_array.select { |item| item.is_a?(MockGroup) }
+  end
+
+  # ===========================================================================
+  # SCIM MIXIN AND REQUIRED METHODS
+  # ===========================================================================
+
+  def self.scim_resource_type
+    return Scimitar::Resources::Group
+  end
+
+  def self.scim_attributes_map
+    return {
+      id:          :id,
+      externalId:  :scim_uid,
+      displayName: :display_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' # Some online examples omit 'type' and believe 'User' will be assumed
+
+          case type.downcase
+            when 'user'
+              MockUser.find_by_primary_key(id)
+            when 'group'
+              MockGroup.find_by_id(id)
+            else
+              raise Scimitar::InvalidSyntaxError.new("Unrecognised type #{type.inspect}")
+          end
+        }
+      ]
+    }
+  end
+
+  def self.scim_mutable_attributes
+    return nil
+  end
+
+  def self.scim_queryable_attributes
+    return {
+      displayName: :display_name
+    }
+  end
+
+  include Scimitar::Resources::Mixin
+end

data/spec/apps/dummy/app/models/mock_user.rb

@@ -0,0 +1,132 @@
+class MockUser < ActiveRecord::Base
+
+  self.primary_key = :primary_key
+
+  # ===========================================================================
+  # TEST ATTRIBUTES - see db/migrate/20210304014602_create_mock_users.rb etc.
+  # ===========================================================================
+
+  READWRITE_ATTRS = %w{
+    primary_key
+    scim_uid
+    username
+    password
+    first_name
+    last_name
+    work_email_address
+    home_email_address
+    work_phone_number
+    organization
+    department
+    mock_groups
+  }
+
+  has_and_belongs_to_many :mock_groups
+
+  # A fixed value read-only attribute, in essence.
+  #
+  def is_active
+    true
+  end
+
+  # A test hook to force validation failures.
+  #
+  INVALID_USERNAME = 'invalid username'
+  validates :username, uniqueness: true, exclusion: { in: [INVALID_USERNAME] }
+
+  # ===========================================================================
+  # SCIM MIXIN AND REQUIRED METHODS
+  # ===========================================================================
+
+  def self.scim_resource_type
+    return Scimitar::Resources::User
+  end
+
+  def self.scim_attributes_map
+    return {
+      id:         :primary_key,
+      externalId: :scim_uid,
+      userName:   :username,
+      password:   :password,
+      name:       {
+        givenName:  :first_name,
+        familyName: :last_name
+      },
+      emails: [
+        {
+          match: 'type',
+          with:  'work',
+          using: {
+            value:   :work_email_address,
+            primary: true
+          }
+        },
+        {
+          match: 'type',
+          with:  'home',
+          using: {
+            value:   :home_email_address,
+            primary: false
+          }
+        },
+      ],
+      phoneNumbers: [
+        {
+          match: 'type',
+          with:  'work',
+          using: {
+            value:   :work_phone_number,
+            primary: false
+          }
+        },
+      ],
+      groups: [ # NB read-only, so no :find_with key
+        {
+          list:  :mock_groups,
+          using: {
+            value:   :id,
+            display: :display_name
+          }
+        }
+      ],
+      active: :is_active,
+
+      # Custom extension schema - see configuration in
+      # "spec/apps/dummy/config/initializers/scimitar.rb".
+      #
+      organization: :organization,
+      department:   :department,
+      userGroups: [
+        {
+          list:      :mock_groups,
+          find_with: ->(value) { MockGroup.find(value["value"]) },
+          using: {
+            value:   :id,
+            display: :display_name
+          }
+        }
+      ]
+    }
+  end
+
+  def self.scim_mutable_attributes
+    return nil
+  end
+
+  def self.scim_queryable_attributes
+    return {
+      'id'                => { column: :primary_key },
+      'externalId'        => { column: :scim_uid },
+      'meta.lastModified' => { column: :updated_at },
+      'name.givenName'    => { column: :first_name },
+      'name.familyName'   => { column: :last_name  },
+      'groups'            => { column: MockGroup.arel_table[:id] },
+      'groups.value'      => { column: MockGroup.arel_table[:id] },
+      'emails'            => { columns: [ :work_email_address, :home_email_address ] },
+      'emails.value'      => { columns: [ :work_email_address, :home_email_address ] },
+      'emails.type'       => { ignore: true } # We can't filter on that; it'll just search all e-mails
+    }
+  end
+
+  include Scimitar::Resources::Mixin
+end

data/spec/apps/dummy/config/application.rb

@@ -0,0 +1,18 @@
+require_relative 'boot'
+
+require 'rails'
+require 'active_model/railtie'
+require 'active_record/railtie'
+require 'action_controller/railtie'
+require 'action_view/railtie'
+
+Bundler.require(*Rails.groups)
+
+require 'scimitar'
+
+module Dummy
+  class Application < Rails::Application
+    config.load_defaults 7.0
+  end
+end
+

data/spec/apps/dummy/config/boot.rb

@@ -0,0 +1,2 @@
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../../Gemfile', __FILE__)
+require 'bundler/setup'

data/spec/apps/dummy/config/environment.rb

@@ -0,0 +1,2 @@
+require_relative 'application'
+Rails.application.initialize!

data/spec/apps/dummy/config/environments/test.rb

@@ -0,0 +1,38 @@
+require 'active_support/core_ext/integer/time'
+
+Rails.application.configure do
+  config.cache_classes = true
+  config.eager_load = false
+
+  # Configure public file server for tests with Cache-Control for performance.
+  config.public_file_server.enabled = true
+  config.public_file_server.headers = {
+    'Cache-Control' => "public, max-age=#{1.hour.to_i}"
+  }
+
+  # Show full error reports and disable caching.
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+  config.cache_store = :null_store
+
+  # Raise exceptions instead of rendering exception templates.
+  config.action_dispatch.show_exceptions = false
+
+  # Disable request forgery protection in test environment.
+  config.action_controller.allow_forgery_protection = false
+
+  # Print deprecation notices to the stderr.
+  config.active_support.deprecation = :stderr
+
+  # Raise exceptions for disallowed deprecations.
+  config.active_support.disallowed_deprecation = :raise
+
+  # Tell Active Support which deprecation messages to disallow.
+  config.active_support.disallowed_deprecation_warnings = []
+
+  # Raises error for missing translations.
+  config.i18n.raise_on_missing_translations = true
+
+  # Annotate rendered view with file names.
+  # config.action_view.annotate_rendered_view_with_filenames = true
+end

data/spec/apps/dummy/config/initializers/cookies_serializer.rb

@@ -0,0 +1,3 @@
+# Be sure to restart your server when you modify this file.
+
+Rails.application.config.action_dispatch.cookies_serializer = :json

data/spec/apps/dummy/config/initializers/scimitar.rb

@@ -0,0 +1,61 @@
+# Test app configuration.
+#
+# Note that as a result of https://github.com/RIPAGlobal/scimitar/issues/48,
+# tests include a custom extension of the core User schema. A shortcoming of
+# some of the code from which Scimitar was originally built is that those
+# extensions are done with class-level ivars, so it is largely impossible (or
+# at least, impractical in tests) to avoid polluting the core class itself
+# with the extension.
+#
+# All related schema tests are written with this in mind.
+#
+Rails.application.config.to_prepare do
+  Scimitar.engine_configuration = Scimitar::EngineConfiguration.new({
+
+    application_controller_mixin: Module.new do
+      def self.included(base)
+        base.class_eval do
+          def test_hook; end
+          before_action :test_hook
+        end
+      end
+
+      def scim_schemas_url(options)
+        super(test: 1, **options)
+      end
+
+      def scim_resource_type_url(options)
+        super(test: 1, **options)
+      end
+    end
+
+  })
+
+  module ScimSchemaExtensions
+    module User
+      class Enterprise < Scimitar::Schema::Base
+        def initialize(options = {})
+          super(
+            name:            'ExtendedUser',
+            description:     'Enterprise extension for a User',
+            id:              self.class.id,
+            scim_attributes: self.class.scim_attributes
+          )
+        end
+
+        def self.id
+          'urn:ietf:params:scim:schemas:extension:enterprise:2.0:User'
+        end
+
+        def self.scim_attributes
+          [
+            Scimitar::Schema::Attribute.new(name: 'organization', type: 'string'),
+            Scimitar::Schema::Attribute.new(name: 'department',   type: 'string')
+          ]
+        end
+      end
+    end
+  end
+
+  Scimitar::Resources::User.extend_schema ScimSchemaExtensions::User::Enterprise
+end

data/spec/apps/dummy/config/initializers/session_store.rb

@@ -0,0 +1,3 @@
+# Be sure to restart your server when you modify this file.
+
+Rails.application.config.session_store :cookie_store, key: '_dummy_session'

data/spec/apps/dummy/config/routes.rb

@@ -0,0 +1,45 @@
+# This test app mounts everything at the root level, but you'd usually be doing
+# more in your Rails app than just SCIM! Wrapping with 'namespace :foo do' is
+# strongly recommended to avoid routing namespace collisions. See README.md for
+# an example.
+#
+Rails.application.routes.draw do
+  mount Scimitar::Engine, at: '/'
+
+  get    'Users',      to: 'mock_users#index'
+  get    'Users/:id',  to: 'mock_users#show'
+  post   'Users',      to: 'mock_users#create'
+  put    'Users/:id',  to: 'mock_users#replace'
+  patch  'Users/:id',  to: 'mock_users#update'
+  delete 'Users/:id',  to: 'mock_users#destroy'
+
+  get    'Groups',     to: 'mock_groups#index'
+  get    'Groups/:id', to: 'mock_groups#show'
+  patch  'Groups/:id', to: 'mock_groups#update'
+
+  # For testing blocks passed to ActiveRecordBackedResourcesController#create,
+  # #update, #replace and #destroy.
+  #
+  post   'CustomCreateUsers',      to: 'custom_create_mock_users#create'
+  patch  'CustomUpdateUsers/:id',  to: 'custom_update_mock_users#update'
+  put    'CustomReplaceUsers/:id', to: 'custom_replace_mock_users#replace'
+  delete 'CustomDestroyUsers/:id', to: 'custom_destroy_mock_users#destroy'
+
+  # Needed because the auto-render of most of the above includes a 'url_for'
+  # call for a 'show' action, so we must include routes (implemented in the
+  # base class) for the "show" endpoint.
+  #
+  get  'CustomCreateUsers/:id',  to: 'custom_create_mock_users#show'
+  get  'CustomUpdateUsers/:id',  to: 'custom_update_mock_users#show'
+  get  'CustomReplaceUsers/:id', to: 'custom_replace_mock_users#show'
+
+  # For testing blocks passed to ActiveRecordBackedResourcesController#save!
+  #
+  post 'CustomSaveUsers',     to: 'custom_save_mock_users#create'
+  get  'CustomSaveUsers/:id', to: 'custom_save_mock_users#show'
+
+  # For testing environment inside Scimitar::ApplicationController subclasses.
+  #
+  get  'CustomRequestVerifiers', to: 'custom_request_verifiers#index'
+  post 'CustomRequestVerifiers', to: 'custom_request_verifiers#create'
+end

data/spec/apps/dummy/db/migrate/20210304014602_create_mock_users.rb

@@ -0,0 +1,24 @@
+class CreateMockUsers < ActiveRecord::Migration[6.1]
+  def change
+    create_table :mock_users, id: :uuid, primary_key: :primary_key do |t|
+      t.timestamps
+
+      # Support part of the core schema
+      #
+      t.text :scim_uid
+      t.text :username
+      t.text :password
+      t.text :first_name
+      t.text :last_name
+      t.text :work_email_address
+      t.text :home_email_address
+      t.text :work_phone_number
+
+      # Support the custom extension schema - see configuration in
+      # "spec/apps/dummy/config/initializers/scimitar.rb".
+      #
+      t.text :organization
+      t.text :department
+    end
+  end
+end

data/spec/apps/dummy/db/migrate/20210308020313_create_mock_groups.rb

@@ -0,0 +1,10 @@
+class CreateMockGroups < ActiveRecord::Migration[6.1]
+  def change
+    create_table :mock_groups do |t|
+      t.text :scim_uid
+      t.text :display_name
+
+      t.references :parent
+    end
+  end
+end

data/spec/apps/dummy/db/migrate/20210308044214_create_join_table_mock_groups_mock_users.rb

@@ -0,0 +1,13 @@
+class CreateJoinTableMockGroupsMockUsers < ActiveRecord::Migration[6.1]
+  def change
+    create_table :mock_groups_users, id: false do | t |
+      t.references :mock_group, foreign_key: true, type: :int8, index: true, null: false
+      t.references :mock_user,                     type: :uuid, index: true, null: false, primary_key: :primary_key
+
+      # The 'foreign_key:' option (used above) only works for 'id' column names
+      # but the test data has a column named 'primary_key' for 'mock_users'.
+      #
+      t.foreign_key :mock_users, primary_key: :primary_key
+    end
+  end
+end

data/spec/apps/dummy/db/schema.rb

@@ -0,0 +1,48 @@
+# This file is auto-generated from the current state of the database. Instead
+# of editing this file, please use the migrations feature of Active Record to
+# incrementally modify your database, and then regenerate this schema definition.
+#
+# This file is the source Rails uses to define your schema when running `bin/rails
+# db:schema:load`. When creating a new database, `bin/rails db:schema:load` tends to
+# be faster and is potentially less error prone than running all of your
+# migrations from scratch. Old migrations may fail to apply correctly if those
+# migrations use external dependencies or application code.
+#
+# It's strongly recommended that you check this file into your version control system.
+
+ActiveRecord::Schema[7.1].define(version: 2021_03_08_044214) do
+  # These are extensions that must be enabled in order to support this database
+  enable_extension "plpgsql"
+
+  create_table "mock_groups", force: :cascade do |t|
+    t.text "scim_uid"
+    t.text "display_name"
+    t.bigint "parent_id"
+    t.index ["parent_id"], name: "index_mock_groups_on_parent_id"
+  end
+
+  create_table "mock_groups_users", id: false, force: :cascade do |t|
+    t.bigint "mock_group_id", null: false
+    t.uuid "mock_user_id", null: false
+    t.index ["mock_group_id"], name: "index_mock_groups_users_on_mock_group_id"
+    t.index ["mock_user_id"], name: "index_mock_groups_users_on_mock_user_id"
+  end
+
+  create_table "mock_users", primary_key: "primary_key", id: :uuid, default: -> { "gen_random_uuid()" }, force: :cascade do |t|
+    t.datetime "created_at", null: false
+    t.datetime "updated_at", null: false
+    t.text "scim_uid"
+    t.text "username"
+    t.text "password"
+    t.text "first_name"
+    t.text "last_name"
+    t.text "work_email_address"
+    t.text "home_email_address"
+    t.text "work_phone_number"
+    t.text "organization"
+    t.text "department"
+  end
+
+  add_foreign_key "mock_groups_users", "mock_groups"
+  add_foreign_key "mock_groups_users", "mock_users", primary_key: "primary_key"
+end