[#SST-15979] add the ServiceProviderConfig(s) endpoints

Author: myang0

app/controllers/concerns/scim_rails/response.rb

@@ -20,6 +20,8 @@ def json_scim_response(object:, status: :ok, counts: nil)
       when "delete"
         head status
         return
+      when "configuration"
+        response = ScimRails.config.config_schema
       end
 
       render \

app/controllers/scim_rails/scim_service_controller.rb

@@ -0,0 +1,11 @@
+module ScimRails
+  class ScimServiceController < ScimRails::ApplicationController
+    def configuration
+      ScimRails.config.before_scim_response.call(request.params) unless ScimRails.config.before_scim_response.nil?
+
+      ScimRails.config.after_scim_response.call(users, "RETRIEVED") unless ScimRails.config.after_scim_response.nil?
+
+      json_scim_response(object: nil)
+    end
+  end
+end

config/routes.rb

@@ -1,15 +1,18 @@
 ScimRails::Engine.routes.draw do
-  get     'scim/v2/Users',      action: :index,         controller: 'scim_users'
-  post    'scim/v2/Users',      action: :create,        controller: 'scim_users'
-  get     'scim/v2/Users/:id',  action: :show,          controller: 'scim_users'
-  put     'scim/v2/Users/:id',  action: :put_update,    controller: 'scim_users'
-  patch   'scim/v2/Users/:id',  action: :patch_update,  controller: 'scim_users'
-  delete  'scim/v2/Users/:id',  action: :delete,        controller: 'scim_users'
+  get     'scim/v2/Users',                 action: :index,         controller: 'scim_users'
+  post    'scim/v2/Users',                 action: :create,        controller: 'scim_users'
+  get     'scim/v2/Users/:id',             action: :show,          controller: 'scim_users'
+  put     'scim/v2/Users/:id',             action: :put_update,    controller: 'scim_users'
+  patch   'scim/v2/Users/:id',             action: :patch_update,  controller: 'scim_users'
+  delete  'scim/v2/Users/:id',             action: :delete,        controller: 'scim_users'
 
-  get    'scim/v2/Groups',      action: :index,         controller: 'scim_groups'
-  post   'scim/v2/Groups',      action: :create,        controller: 'scim_groups'
-  get    'scim/v2/Groups/:id',  action: :show,          controller: 'scim_groups'
-  put    'scim/v2/Groups/:id',  action: :put_update,    controller: 'scim_groups'
-  patch  'scim/v2/Groups/:id',  action: :patch_update,  controller: 'scim_groups'
-  delete 'scim/v2/Groups/:id',  action: :delete,        controller: 'scim_groups'
+  get    'scim/v2/Groups',                 action: :index,         controller: 'scim_groups'
+  post   'scim/v2/Groups',                 action: :create,        controller: 'scim_groups'
+  get    'scim/v2/Groups/:id',             action: :show,          controller: 'scim_groups'
+  put    'scim/v2/Groups/:id',             action: :put_update,    controller: 'scim_groups'
+  patch  'scim/v2/Groups/:id',             action: :patch_update,  controller: 'scim_groups'
+  delete 'scim/v2/Groups/:id',             action: :delete,        controller: 'scim_groups'
+
+  get    'scim/v2/ServiceProviderConfig',  action: :configuration, controller: 'scim_service'
+  get    'scim/v2/ServiceProviderConfigs', action: :configuration, controller: 'scim_service'
 end

lib/generators/scim_rails/templates/initializer.rb

@@ -150,4 +150,40 @@
   config.after_scim_response = lambda do |object, status|
     print "#{object} #{status}"
   end
+
+  config.config_schema = {
+    schemas: ["urn:ietf:params:scim:schemas:core:2.0:ServiceProviderConfig"],
+    patch: {
+      supported: true
+    },
+    bulk: {
+      supported: false,
+      maxOperations: 0,
+      maxPayloadSize: 0
+    },
+    filter: {
+      supported: true,
+    },
+    changePassword: {
+      supported: false
+    },
+    sort: {
+      supported: true
+    },
+    etag: {
+      supported: false
+    },
+    authenticationSchemes: [
+      {
+        type: "oauthbearertoken",
+        name: "Oauth Bearer Token",
+        description: "Authentication scheme using the OAuth Bearer Token Standard"
+      },
+      {
+        type: "httpbasic",
+        name: "HTTP Basic",
+        description: "Authentication scheme using the HTTP Basic Standard"
+      }
+    ]
+  }
 end

lib/scim_rails/config.rb

@@ -47,6 +47,7 @@ class Config
       :before_scim_response,
       :after_scim_response,
       :scim_attribute_type_mappings,
+      :config_schema
 
     def initialize
       @basic_auth_model = "Company"

spec/controllers/scim_rails/scim_service_controller_spec.rb

@@ -0,0 +1,59 @@
+require "spec_helper"
+
+RSpec.describe ScimRails::ScimServiceController, type: :controller do
+  include AuthHelper
+
+  routes { ScimRails::Engine.routes }
+
+  describe "configuration" do
+    let(:company) { create(:company) }
+
+    context "when unauthorized" do
+      it "returns scim+json content type" do
+        get :configuration
+
+        expect(response.content_type).to eq("application/scim+json")
+      end
+
+      it "fails with no credentials" do
+        get :configuration
+
+        expect(response.status).to eq(401)
+      end
+
+      it "fails with invalid credentials" do
+        request.env['HTTP_AUTHORIZATION'] = ActionController::HttpAuthentication::Basic.encode_credentials("unauthorized","123456")
+
+        get :configuration
+
+        expect(response.status).to eq(401)
+      end
+    end
+
+    context "when authorized" do
+      let(:body) { JSON.parse(response.body) }
+
+      before :each do
+        http_login(company)
+      end
+
+      it "returns scim+json content type" do
+        get :configuration
+
+        expect(response.content_type).to eq("application/scim+json")
+      end
+
+      it "is successful with valid credentials" do
+        get :configuration
+
+        expect(response.status).to eq(200)
+      end
+
+      it "successfully returns the configuration of the app" do
+        get :configuration
+
+        expect(body.deep_symbolize_keys).to eq(ScimRails.config.config_schema)
+      end
+    end
+  end
+end

spec/support/scim_rails_config.rb

@@ -117,4 +117,39 @@
     },
   }
 
+  config.config_schema = {
+    schemas: ["urn:ietf:params:scim:schemas:core:2.0:ServiceProviderConfig"],
+    patch: {
+      supported: true
+    },
+    bulk: {
+      supported: false,
+      maxOperations: 0,
+      maxPayloadSize: 0
+    },
+    filter: {
+      supported: true,
+    },
+    changePassword: {
+      supported: false
+    },
+    sort: {
+      supported: true
+    },
+    etag: {
+      supported: false
+    },
+    authenticationSchemes: [
+      {
+        type: "oauthbearertoken",
+        name: "Oauth Bearer Token",
+        description: "Authentication scheme using the OAuth Bearer Token Standard"
+      },
+      {
+        type: "httpbasic",
+        name: "HTTP Basic",
+        description: "Authentication scheme using the HTTP Basic Standard"
+      }
+    ]
+  }
 end