scimaenaga 0.7.0 → 0.9.1

data/spec/controllers/scimaenaga/scim_schemas_controller_spec.rb

@@ -0,0 +1,238 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Scimaenaga::ScimSchemasController, type: :controller do
+  include AuthHelper
+
+  routes { Scimaenaga::Engine.routes }
+
+  let(:schemas) do
+    [
+      {
+        schemas: ['urn:ietf:params:scim:schemas:core:2.0:Schema'],
+        id: 'urn:ietf:params:scim:schemas:core:2.0:User',
+        name: 'User',
+        description: 'User Account',
+        attributes: [
+          {
+            name: 'userName',
+            type: 'string',
+            multiValued: false,
+            description: 'Unique identifier for the User. REQUIRED.',
+            required: true,
+            caseExact: false,
+            mutability: 'readWrite',
+            returned: 'default',
+            uniqueness: 'server',
+          }
+        ],
+        meta: {
+          resourceType: 'Schema',
+          location:
+            '/v2/Schemas/urn:ietf:params:scim:schemas:core:2.0:User',
+        },
+      },
+      {
+        schemas: ['urn:ietf:params:scim:schemas:core:2.0:Schema'],
+        id: 'urn:ietf:params:scim:schemas:core:2.0:Group',
+        name: 'Group',
+        description: 'Group',
+        attributes: [
+          {
+            name: 'displayName',
+            type: 'string',
+            multiValued: false,
+            description: 'A human-readable name for the Group. REQUIRED.',
+            required: false,
+            caseExact: false,
+            mutability: 'readWrite',
+            returned: 'default',
+            uniqueness: 'none',
+          }
+        ],
+        meta: {
+          resourceType: 'Schema',
+          location: '/v2/Schemas/urn:ietf:params:scim:schemas:core:2.0:Group',
+        },
+      }
+    ]
+  end
+
+  let(:schemas_110) do
+    [
+      { id: 'dummy1' }, { id: 'dummy2' }, { id: 'dummy3' },
+      { id: 'dummy4' }, { id: 'dummy5' }, { id: 'dummy6' },
+      { id: 'dummy7' }, { id: 'dummy8' }, { id: 'dummy9' },
+      { id: 'dummy10' }, { id: 'dummy11' }, { id: 'dummy12' },
+      { id: 'dummy13' }, { id: 'dummy14' }, { id: 'dummy15' },
+      { id: 'dummy16' }, { id: 'dummy17' }, { id: 'dummy18' },
+      { id: 'dummy19' }, { id: 'dummy20' }, { id: 'dummy21' },
+      { id: 'dummy22' }, { id: 'dummy23' }, { id: 'dummy24' },
+      { id: 'dummy25' }, { id: 'dummy26' }, { id: 'dummy27' },
+      { id: 'dummy28' }, { id: 'dummy29' }, { id: 'dummy30' },
+      { id: 'dummy31' }, { id: 'dummy32' }, { id: 'dummy33' },
+      { id: 'dummy34' }, { id: 'dummy35' }, { id: 'dummy36' },
+      { id: 'dummy37' }, { id: 'dummy38' }, { id: 'dummy39' },
+      { id: 'dummy40' }, { id: 'dummy41' }, { id: 'dummy42' },
+      { id: 'dummy43' }, { id: 'dummy44' }, { id: 'dummy45' },
+      { id: 'dummy46' }, { id: 'dummy47' }, { id: 'dummy48' },
+      { id: 'dummy49' }, { id: 'dummy50' }, { id: 'dummy51' },
+      { id: 'dummy52' }, { id: 'dummy53' }, { id: 'dummy54' },
+      { id: 'dummy55' }, { id: 'dummy56' }, { id: 'dummy57' },
+      { id: 'dummy58' }, { id: 'dummy59' }, { id: 'dummy60' },
+      { id: 'dummy61' }, { id: 'dummy62' }, { id: 'dummy63' },
+      { id: 'dummy64' }, { id: 'dummy65' }, { id: 'dummy66' },
+      { id: 'dummy67' }, { id: 'dummy68' }, { id: 'dummy69' },
+      { id: 'dummy70' }, { id: 'dummy71' }, { id: 'dummy72' },
+      { id: 'dummy73' }, { id: 'dummy74' }, { id: 'dummy75' },
+      { id: 'dummy76' }, { id: 'dummy77' }, { id: 'dummy78' },
+      { id: 'dummy79' }, { id: 'dummy80' }, { id: 'dummy81' },
+      { id: 'dummy82' }, { id: 'dummy83' }, { id: 'dummy84' },
+      { id: 'dummy85' }, { id: 'dummy86' }, { id: 'dummy87' },
+      { id: 'dummy88' }, { id: 'dummy89' }, { id: 'dummy90' },
+      { id: 'dummy91' }, { id: 'dummy92' }, { id: 'dummy93' },
+      { id: 'dummy94' }, { id: 'dummy95' }, { id: 'dummy96' },
+      { id: 'dummy97' }, { id: 'dummy98' }, { id: 'dummy99' },
+      { id: 'dummy100' }, { id: 'dummy101' }, { id: 'dummy102' },
+      { id: 'dummy103' }, { id: 'dummy104' }, { id: 'dummy105' },
+      { id: 'dummy106' }, { id: 'dummy107' }, { id: 'dummy108' },
+      { id: 'dummy109' }, { id: 'dummy110' }
+    ]
+  end
+
+  describe 'index' do
+    let(:company) { create(:company) }
+
+    context 'when unauthorized' do
+      it 'returns scim+json content type' do
+        get :index, as: :json
+
+        expect(response.media_type).to eq 'application/scim+json'
+      end
+
+      it 'fails with no credentials' do
+        get :index, as: :json
+
+        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 :index, as: :json
+
+        expect(response.status).to eq 401
+      end
+    end
+
+    context 'when authorized' do
+      before :each do
+        http_login(company)
+      end
+
+      it 'returns scim+json content type' do
+        get :index, as: :json
+
+        expect(response.media_type).to eq 'application/scim+json'
+      end
+
+      it 'is successful with valid credentials' do
+        get :index, as: :json
+
+        expect(response.status).to eq 200
+      end
+
+      it 'returns all results' do
+        allow(Scimaenaga.config).to(receive(:schemas).and_return(schemas))
+        get :index, as: :json
+        response_body = JSON.parse(response.body)
+        expect(response_body.dig('schemas', 0)).to(
+          eq 'urn:ietf:params:scim:api:messages:2.0:ListResponse'
+        )
+        expect(response_body['totalResults']).to eq 2
+      end
+
+      it 'defaults to 100 results' do
+        allow(Scimaenaga.config).to(receive(:schemas).and_return(schemas_110))
+
+        get :index, as: :json
+        response_body = JSON.parse(response.body)
+        expect(response_body['totalResults']).to eq 110
+        expect(response_body['startIndex']).to eq 1
+        expect(response_body['Resources'].count).to eq 100
+      end
+
+      it 'paginates results' do
+        allow(Scimaenaga.config).to(receive(:schemas).and_return(schemas_110))
+        get :index, params: {
+          startIndex: 101,
+          count: 5,
+        }, as: :json
+        response_body = JSON.parse(response.body)
+        expect(response_body['totalResults']).to eq 110
+        expect(response_body['startIndex']).to eq 101
+        expect(response_body['Resources'].count).to eq 5
+        expect(response_body.dig('Resources', 0, 'id')).to eq 'dummy101'
+      end
+    end
+  end
+
+  describe 'show' do
+    let(:company) { create(:company) }
+
+    context 'when unauthorized' do
+      it 'returns scim+json content type' do
+        get :show, params: { id: 1 }, as: :json
+
+        expect(response.media_type).to eq 'application/scim+json'
+      end
+
+      it 'fails with no credentials' do
+        get :show, params: { id: 1 }, as: :json
+
+        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 :show, params: { id: 1 }, as: :json
+
+        expect(response.status).to eq 401
+      end
+    end
+
+    context 'when authorized' do
+      before :each do
+        http_login(company)
+      end
+
+      it 'returns scim+json content type' do
+        allow(Scimaenaga.config).to(receive(:schemas).and_return(schemas))
+        get :show, params: { id: 'urn:ietf:params:scim:schemas:core:2.0:User' }, as: :json
+
+        expect(response.media_type).to eq 'application/scim+json'
+      end
+
+      it 'is successful with valid credentials' do
+        allow(Scimaenaga.config).to(receive(:schemas).and_return(schemas))
+        get :show, params: { id: 'urn:ietf:params:scim:schemas:core:2.0:User' }, as: :json
+
+        response_body = JSON.parse(response.body)
+        expect(response.status).to eq 200
+        expect(response_body['name']).to eq 'User'
+      end
+
+      it 'returns :not_found for id that cannot be found' do
+        get :show, params: { id: 'fake_id' }, as: :json
+
+        expect(response.status).to eq 404
+      end
+    end
+  end
+end

data/spec/controllers/scimaenaga/scim_schemas_request_spec.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Scimaenaga::ScimSchemasController, type: :request do
+  let(:company) { create(:company) }
+  let(:credentials) do
+    Base64.encode64("#{company.subdomain}:#{company.api_token}")
+  end
+  let(:authorization) { "Basic #{credentials}" }
+
+  def get_request(content_type = 'application/scim+json')
+    get '/scim/v2/Schemas',
+        headers: {
+          Authorization: authorization,
+          'Content-Type': content_type,
+        }
+  end
+
+  context 'OAuth Bearer Authorization' do
+    context 'with valid token' do
+      let(:authorization) { "Bearer #{company.api_token}" }
+
+      it 'supports OAuth bearer authorization and succeeds' do
+        get_request
+        expect(response.status).to eq 200
+      end
+    end
+
+    context 'with invalid token' do
+      let(:authorization) { "Bearer #{SecureRandom.hex}" }
+
+      it 'The request fails' do
+        get_request
+        expect(response.status).to eq 401
+      end
+    end
+  end
+end

data/spec/controllers/{scim_rails → scimaenaga}/scim_users_controller_spec.rb

@@ -2,10 +2,10 @@
 
 require 'spec_helper'
 
-RSpec.describe ScimRails::ScimUsersController, type: :controller do
+RSpec.describe Scimaenaga::ScimUsersController, type: :controller do
   include AuthHelper
 
-  routes { ScimRails::Engine.routes }
+  routes { Scimaenaga::Engine.routes }
 
   describe 'index' do
     let(:company) { create(:company) }
@@ -85,7 +85,7 @@ RSpec.describe ScimRails::ScimUsersController, type: :controller do
       end
 
       it 'paginates results by configurable scim_users_list_order' do
-        allow(ScimRails.config).to receive(:scim_users_list_order).and_return({ created_at: :desc })
+        allow(Scimaenaga.config).to receive(:scim_users_list_order).and_return({ created_at: :desc })
 
         create_list(:user, 400, company: company)
         expect(company.users.first.id).to eq 1
@@ -334,7 +334,7 @@ RSpec.describe ScimRails::ScimUsersController, type: :controller do
       end
 
       it 'returns 409 if user already exists and config.scim_user_prevent_update_on_create is set to true' do
-        allow(ScimRails.config).to receive(:scim_user_prevent_update_on_create).and_return(true)
+        allow(Scimaenaga.config).to receive(:scim_user_prevent_update_on_create).and_return(true)
         create(:user, email: 'new@example.com', company: company)
 
         post :create, params: {
@@ -755,23 +755,23 @@ RSpec.describe ScimRails::ScimUsersController, type: :controller do
   describe 'destroy' do
     let(:company) { create(:company) }
 
-    context "when unauthorized" do
-      it "returns scim+json content type" do
+    context 'when unauthorized' do
+      it 'returns scim+json content type' do
         delete :destroy, params: { id: 1 }, as: :json
 
-        expect(response.media_type).to eq "application/scim+json"
+        expect(response.media_type).to eq 'application/scim+json'
       end
 
-      it "fails with no credentials" do
+      it 'fails with no credentials' do
         delete :destroy, params: { id: 1 }, as: :json
 
         expect(response.status).to eq 401
       end
 
-      it "fails with invalid credentials" do
-        request.env["HTTP_AUTHORIZATION"] =
+      it 'fails with invalid credentials' do
+        request.env['HTTP_AUTHORIZATION'] =
           ActionController::HttpAuthentication::Basic
-          .encode_credentials("unauthorized", "123456")
+          .encode_credentials('unauthorized', '123456')
 
         delete :destroy, params: { id: 1 }, as: :json
 
@@ -787,7 +787,6 @@ RSpec.describe ScimRails::ScimUsersController, type: :controller do
       end
 
       context 'when User destroy method is configured' do
-
         it 'is sucessful with valid credentials' do
           delete :destroy, params: { id: 1 }, as: :json
 
@@ -811,7 +810,7 @@ RSpec.describe ScimRails::ScimUsersController, type: :controller do
 
       context 'when User destroy method is not configured' do
         it 'does not delete User' do
-          allow(ScimRails.config).to(
+          allow(Scimaenaga.config).to(
             receive(:user_destroy_method).and_return(nil)
           )
 
@@ -825,7 +824,7 @@ RSpec.describe ScimRails::ScimUsersController, type: :controller do
 
       context 'when User destroy method is invalid' do
         it 'does not delete User' do
-          allow(ScimRails.config).to(
+          allow(Scimaenaga.config).to(
             receive(:user_destroy_method).and_return('destory!')
           )
 
@@ -840,7 +839,7 @@ RSpec.describe ScimRails::ScimUsersController, type: :controller do
       context 'when target User is not found' do
         it 'return 404 not found' do
           expect do
-            delete :destroy, params: { id: 999999 }, as: :json
+            delete :destroy, params: { id: 999_999 }, as: :json
           end.not_to change { company.users.reload.count }.from(1)
 
           expect(response.status).to eq 404

data/spec/controllers/{scim_rails → scimaenaga}/scim_users_request_spec.rb

@@ -1,51 +1,51 @@
 # frozen_string_literal: true
 
-require "spec_helper"
+require 'spec_helper'
 
-RSpec.describe ScimRails::ScimUsersController, type: :request do
+RSpec.describe Scimaenaga::ScimUsersController, type: :request do
   let(:company) { create(:company) }
   let(:credentials) do
     Base64.encode64("#{company.subdomain}:#{company.api_token}")
   end
   let(:authorization) { "Basic #{credentials}" }
 
-  def post_request(content_type = "application/scim+json")
+  def post_request(content_type = 'application/scim+json')
     # params need to be transformed into a string to test if they are being parsed by Rack
 
-    post "/scim/v2/Users",
+    post '/scim/v2/Users',
          params: {
            name: {
-             givenName: "New",
-             familyName: "User"
+             givenName: 'New',
+             familyName: 'User',
            },
            emails: [
              {
-               value: "new@example.com"
+               value: 'new@example.com',
              }
-           ]
+           ],
          }.to_json,
          headers: {
            Authorization: authorization,
-           'Content-Type': content_type
+           'Content-Type': content_type,
          }
   end
 
-  describe "Content-Type" do
-    it "accepts scim+json" do
+  describe 'Content-Type' do
+    it 'accepts scim+json' do
       expect(company.users.count).to eq 0
 
-      post_request("application/scim+json")
+      post_request('application/scim+json')
 
       expect(request.params).to include :name
       expect(response.status).to eq 201
-      expect(response.media_type).to eq "application/scim+json"
+      expect(response.media_type).to eq 'application/scim+json'
       expect(company.users.count).to eq 1
     end
 
-    it "can not parse unfamiliar content types" do
+    it 'can not parse unfamiliar content types' do
       expect(company.users.count).to eq 0
 
-      post_request("text/csv")
+      post_request('text/csv')
 
       expect(request.params).not_to include :name
       expect(response.status).to eq 422
@@ -53,21 +53,21 @@ RSpec.describe ScimRails::ScimUsersController, type: :request do
     end
   end
 
-  context "OAuth Bearer Authorization" do
-    context "with valid token" do
+  context 'OAuth Bearer Authorization' do
+    context 'with valid token' do
       let(:authorization) { "Bearer #{company.api_token}" }
 
-      it "supports OAuth bearer authorization and succeeds" do
+      it 'supports OAuth bearer authorization and succeeds' do
         expect { post_request }.to change(company.users, :count).from(0).to(1)
 
         expect(response.status).to eq 201
       end
     end
 
-    context "with invalid token" do
+    context 'with invalid token' do
       let(:authorization) { "Bearer #{SecureRandom.hex}" }
 
-      it "The request fails" do
+      it 'The request fails' do
         expect { post_request }.not_to change(company.users, :count)
 
         expect(response.status).to eq 401

data/spec/dummy/app/assets/config/manifest.js

@@ -2,4 +2,4 @@
 //= link_tree ../images
 //= link_directory ../javascripts .js
 //= link_directory ../stylesheets .css
-//= link scim_rails_manifest.js
+//= link scimaenaga_manifest.js

data/spec/dummy/config/application.rb

@@ -3,7 +3,7 @@ require_relative 'boot'
 require 'rails/all'
 
 Bundler.require(*Rails.groups)
-require "scim_rails"
+require 'scimaenaga'
 
 module Dummy
   class Application < Rails::Application
@@ -12,4 +12,3 @@ module Dummy
     # -- all .rb files in that directory are automatically loaded.
   end
 end
-

data/spec/dummy/config/initializers/{scim_rails_config.rb → scimaenaga_config.rb}

@@ -1,7 +1,7 @@
-ScimRails.configure do |config|
-  config.basic_auth_model = "Company"
-  config.scim_users_model = "User"
-  config.scim_groups_model = "Group"
+Scimaenaga.configure do |config|
+  config.basic_auth_model = 'Company'
+  config.scim_users_model = 'User'
+  config.scim_groups_model = 'Group'
 
   config.basic_auth_model_searchable_attribute = :subdomain
   config.basic_auth_model_authenticatable_attribute = :api_token
@@ -9,57 +9,57 @@ ScimRails.configure do |config|
   config.scim_users_list_order = :id
   config.scim_groups_scope = :groups
 
-  config.signing_algorithm = "HS256"
-  config.signing_secret = "2d6806dd11c2fece2e81b8ca76dcb0062f5b08e28e3264e8ba1c44bbd3578b70"
+  config.signing_algorithm = 'HS256'
+  config.signing_secret = '2d6806dd11c2fece2e81b8ca76dcb0062f5b08e28e3264e8ba1c44bbd3578b70'
 
   config.user_destroy_method = :destroy!
   config.group_destroy_method = :destroy!
 
-  config.mutable_user_attributes = [
-    :first_name,
-    :last_name,
-    :email,
-    :active
+  config.mutable_user_attributes = %i[
+    first_name
+    last_name
+    email
+    active
   ]
 
   config.queryable_user_attributes = {
     userName: :email,
     givenName: :first_name,
     familyName: :last_name,
-    email: :email
+    email: :email,
   }
 
   config.mutable_user_attributes_schema = {
     name: {
       givenName: :first_name,
-      familyName: :last_name
+      familyName: :last_name,
     },
     emails: [
       {
-        value: :email
+        value: :email,
       }
     ],
-    active: :active
+    active: :active,
   }
 
   config.user_schema = {
-    schemas: ["urn:ietf:params:scim:schemas:core:2.0:User"],
+    schemas: ['urn:ietf:params:scim:schemas:core:2.0:User'],
     id: :id,
     userName: :email,
     name: {
       givenName: :first_name,
-      familyName: :last_name
+      familyName: :last_name,
     },
     emails: [
       {
-        value: :email
-      },
+        value: :email,
+      }
     ],
-    active: :unarchived?
+    active: :unarchived?,
   }
 
   config.queryable_group_attributes = {
-    displayName: :name
+    displayName: :name,
   }
 
   config.mutable_group_attributes = [
@@ -67,21 +67,21 @@ ScimRails.configure do |config|
   ]
 
   config.mutable_group_attributes_schema = {
-    displayName: :name
+    displayName: :name,
   }
 
   config.group_member_relation_attribute = :user_ids
   config.group_member_relation_schema = { value: :user_ids }
 
   config.group_schema = {
-    schemas: ["urn:ietf:params:scim:schemas:core:2.0:Group"],
+    schemas: ['urn:ietf:params:scim:schemas:core:2.0:Group'],
     id: :id,
     displayName: :name,
-    members: :users
+    members: :users,
   }
 
   config.group_abbreviated_schema = {
     value: :id,
-    display: :name
+    display: :name,
   }
 end

data/spec/dummy/config/routes.rb

@@ -1,3 +1,3 @@
 Rails.application.routes.draw do
-  mount ScimRails::Engine => "/"
+  mount Scimaenaga::Engine => '/'
 end

data/spec/factories/company.rb

@@ -1,10 +1,10 @@
 FactoryBot.define do
   factory :company do
-    name { "Test Company" }
-    subdomain { "test" }
+    name { 'Test Company' }
+    subdomain { 'test' }
 
     after(:build) do |company|
-      company.api_token = ScimRails::Encoder.encode(company)
+      company.api_token = Scimaenaga::Encoder.encode(company)
     end
   end
 end