schemas endpoints

Author: myang0

app/controllers/concerns/scim_rails/response.rb

@@ -34,6 +34,13 @@ def json_scim_response(object:, status: :ok, counts: nil)
         content_type: CONTENT_TYPE
     end
 
+    def json_schema_response(object)
+      render \
+        json: object,
+        status: :ok,
+        content_type: CONTENT_TYPE
+    end
+
     def json_scim_group_response(object:, status: :ok, counts: nil)
       response = nil
       case params[:action]

app/controllers/scim_rails/scim_schema_controller.rb

@@ -0,0 +1,19 @@
+module ScimRails
+  class ScimSchemaController < ApplicationController
+    def get_schema
+      ScimRails.config.before_scim_response.call(request.params) unless ScimRails.config.before_scim_response.nil?
+
+      if request.params[:id] == "urn:ietf:params:scim:schemas:core:2.0:User"
+        object = ScimRails.config.retrievable_user_schema
+      elsif request.params[:id] == "urn:ietf:params:scim:schemas:core:2.0:Group"
+        object = ScimRails.config.retrievable_group_schema
+      else
+        object = {}
+      end
+
+      ScimRails.config.after_scim_response.call(object, “RETRIEVED”) unless ScimRails.config.after_scim_response.nil?
+      
+      json_schema_response(object)
+    end
+  end
+end

config/routes.rb

@@ -1,21 +1,24 @@
 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/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'
- 
-  get    'scim/v2/ResourceTypes/User',     action: :resource_user,  controller: 'scim_resource'
-  get    'scim/v2/ResourceTypes/Group',    action: :resource_group, controller: 'scim_resource'
+  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/ServiceProviderConfig',                               action: :configuration,  controller: 'scim_service'
+  get    'scim/v2/ServiceProviderConfigs',                              action: :configuration,  controller: 'scim_service'
+                              
+  get    'scim/v2/ResourceTypes/User',                                  action: :resource_user,  controller: 'scim_resource'
+  get    'scim/v2/ResourceTypes/Group',                                 action: :resource_group, controller: 'scim_resource'
+                             
+  get    'scim/v2/Schemas/:id',  action: :get_schema,    controller: 'scim_schema'
+  # get    'scim/v2/Schemas/urn:ietf:params:scim:schemas:core:2.0:Group', action: :group_schema,   controller: 'scim_schema'
 end

lib/scim_rails/config.rb

@@ -49,7 +49,9 @@ class Config
       :scim_attribute_type_mappings,
       :config_schema,
       :resource_user_schema,
-      :resource_group_schema
+      :resource_group_schema,
+      :retrievable_user_schema,
+      :retrievable_group_schema
 
     def initialize
       @basic_auth_model = "Company"

spec/controllers/scim_rails/scim_resource_controller_spec.rb

@@ -49,7 +49,7 @@
         expect(response.status).to eq(200)
       end
 
-      it "successfully returns the configuration of the app" do
+      it "successfully returns the resource schema of users" do
         get :resource_user
 
         expect(body.deep_symbolize_keys).to eq(ScimRails.config.resource_user_schema)
@@ -101,7 +101,7 @@
         expect(response.status).to eq(200)
       end
 
-      it "successfully returns the configuration of the app" do
+      it "successfully returns the resource schema of groups" do
         get :resource_group
 
         expect(body.deep_symbolize_keys).to eq(ScimRails.config.resource_group_schema)

spec/controllers/scim_rails/scim_schema_controller_spec.rb

@@ -0,0 +1,66 @@
+require 'spec_helper'
+
+module ScimRails
+  RSpec.describe ScimSchemaController, type: :controller do
+    include AuthHelper
+    routes { ScimRails::Engine.routes }
+
+    describe "get_schema" do
+      let(:company) { create(:company) }
+  
+      context "when unauthorized" do
+        it "returns scim+json content type" do
+          get :get_schema, params: { id: 1 }
+  
+          expect(response.content_type).to eq("application/scim+json")
+        end
+  
+        it "fails with no credentials" do
+          get :get_schema, params: { id: 1 }
+  
+          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 :get_schema, params: { id: 1 }
+  
+          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 :get_schema, params: { id: 1 }
+  
+          expect(response.content_type).to eq("application/scim+json")
+        end
+  
+        it "is successful with valid credentials" do
+          get :get_schema, params: { id: 1 }
+  
+          expect(response.status).to eq(200)
+        end
+  
+        it "successfully returns the user schema" do
+          get :get_schema, params: { id: "urn:ietf:params:scim:schemas:core:2.0:User" }
+  
+          expect(body.deep_symbolize_keys).to eq(ScimRails.config.retrievable_user_schema)
+        end
+
+        it "successfully returns the group schema" do
+          get :get_schema, params: { id: "urn:ietf:params:scim:schemas:core:2.0:Group" }
+  
+          expect(body.deep_symbolize_keys).to eq(ScimRails.config.retrievable_group_schema)
+        end
+      end
+    end
+  end
+end

spec/support/scim_rails_config.rb

@@ -168,4 +168,26 @@
     endpoint: "/Groups",
     schema: "urn:ietf:params:scim:schemas:core:2.0:Group"
   }
+
+  config.retrievable_user_schema = {
+    schemas: ["urn:ietf:params:scim:schemas:core:2.0:Schema"],
+    id: "urn:ietf:params:scim:schemas:core:2.0:User",
+    name: "User",
+    attributes: [
+      {
+
+      }
+    ]
+  }
+
+  config.retrievable_group_schema = {
+    schemas: ["urn:ietf:params:scim:schemas:core:2.0:Schema"],
+    id: "urn:ietf:params:scim:schemas:core:2.0:Group",
+    name: "Group",
+    attributes: [
+      {
+        
+      }
+    ]
+  }
 end