scimaenaga 0.4.1 → 0.6.2

data/spec/controllers/scim_rails/scim_users_controller_spec.rb

@@ -364,7 +364,7 @@ RSpec.describe ScimRails::ScimUsersController, type: :controller do
               value: "test@example.com"
             }
           ],
-          active: "false"
+          active: false
         }, as: :json
 
         expect(response.status).to eq 201
@@ -415,12 +415,18 @@ RSpec.describe ScimRails::ScimUsersController, type: :controller do
         expect(response.media_type).to eq "application/scim+json"
       end
 
-      it "is successful with with valid credentials" do
+      it "is successful with valid credentials" do
         put :put_update, params: put_params, as: :json
 
         expect(response.status).to eq 200
       end
 
+      it "successfully change user email" do
+        put :put_update, params: put_params(id: user.id), as: :json
+
+        expect(user.reload.email).to eq 'test@example.com'
+      end
+
       it "deprovisions an active record" do
         request.content_type = "application/scim+json"
         put :put_update, params: put_params(active: false), as: :json
@@ -506,17 +512,40 @@ RSpec.describe ScimRails::ScimUsersController, type: :controller do
       end
 
       it "returns scim+json content type" do
-        patch :patch_update, params: patch_params(id: 1), as: :json
+        patch :patch_update, params: patch_params(id: user.id), as: :json
 
         expect(response.media_type).to eq "application/scim+json"
       end
 
       it "is successful with valid credentials" do
-        patch :patch_update, params: patch_params(id: 1), as: :json
+        patch :patch_update, params: patch_params(id: user.id), as: :json
 
         expect(response.status).to eq 200
       end
 
+      it 'rollback all changes when contains any invalid operation' do
+        expect do
+          patch :patch_update, params: {
+            schemas: ["urn:ietf:params:scim:api:messages:2.0:PatchOp"],
+            id: user.id,
+            Operations: [
+              {
+                op: "Replace",
+                path: "emails[type eq \"work\"].value",
+                value: "change@example.com"
+              },
+              {
+                op: "Replace",
+                value: "hoge"
+              }
+            ]
+          },
+          as: :json
+        end.to_not change { user.reload.email }
+
+        expect(response.status).to eq 422
+      end
+
       it "returns :not_found for id that cannot be found" do
         get :patch_update, params: patch_params(id: "fake_id"), as: :json
 
@@ -537,7 +566,10 @@ RSpec.describe ScimRails::ScimUsersController, type: :controller do
         user = company.users.first
         expect(user.archived?).to eq false
 
-        patch :patch_update, params: patch_params(id: 1), as: :json
+        patch \
+          :patch_update,
+          params: patch_active_params(id: user.id, active: false),
+          as: :json
 
         expect(response.status).to eq 200
         expect(company.users.count).to eq 1
@@ -552,7 +584,7 @@ RSpec.describe ScimRails::ScimUsersController, type: :controller do
 
         patch \
           :patch_update,
-          params: patch_params(id: 1, active: true),
+          params: patch_active_params(id: 1, active: true),
           as: :json
 
         expect(response.status).to eq 200
@@ -561,17 +593,34 @@ RSpec.describe ScimRails::ScimUsersController, type: :controller do
         expect(user.archived?).to eq false
       end
 
+      it "successfully change user email" do
+        expect(company.users.count).to eq 1
+        user = company.users.first
+        user.update(email: 'test@example.com')
+        expect(user.reload.email).to eq 'test@example.com'
+
+        patch \
+          :patch_update,
+          params: patch_params(id: 1),
+          as: :json
+
+        expect(response.status).to eq 200
+        expect(company.users.count).to eq 1
+        user.reload
+        expect(user.email).to eq 'change@example.com'
+      end
+
       it "is case insensetive for op value" do
         # Note, this is for backward compatibility. op should always
         # be lower case and support for case insensitivity will be removed
         patch :patch_update, params: {
+          schemas: ["urn:ietf:params:scim:api:messages:2.0:PatchOp"],
           id: 1,
           Operations: [
-            {
+           {
               op: "Replace",
-              value: {
-                active: false
-              }
+              path: "emails[type eq \"work\"].value",
+              value: "test@example.com"
             }
           ]
         }, as: :json
@@ -579,45 +628,67 @@ RSpec.describe ScimRails::ScimUsersController, type: :controller do
         expect(response.status).to eq 200
       end
 
-      it "throws an error for non status updates" do
+      it "don't update if not included in mutable attributes" do
+        expect do
+          patch :patch_update, params: {
+            schemas: ["urn:ietf:params:scim:api:messages:2.0:PatchOp"],
+            id: user.id,
+            Operations: [
+              {
+                op: "Replace",
+                path: "emails[type eq \"work\"].value",
+                value: "change@example.com"
+              },
+              {
+                op: "Replace",
+                path: "country",
+                value: "Japan"
+              },
+            ]
+          }, as: :json
+        end.not_to change { user.reload.country }
+
+        expect(response.status).to eq 422
+      end
+
+      xit "returns 422 when value is not an object" do
         patch :patch_update, params: {
+          schemas: ["urn:ietf:params:scim:api:messages:2.0:PatchOp"],
           id: 1,
           Operations: [
             {
               op: "replace",
-              value: {
-                name: {
-                  givenName: "Francis"
-                }
-              }
+              path: "emails[type eq \"work\"].value",
+              value: "francis@example.com"
             }
           ]
-        }, as: :json
+        }
 
         expect(response.status).to eq 422
         response_body = JSON.parse(response.body)
         expect(response_body.dig("schemas", 0)).to eq "urn:ietf:params:scim:api:messages:2.0:Error"
       end
 
-      it "returns 422 when value is not an object" do
+      it "returns 422 when value is missing" do
         patch :patch_update, params: {
+          schemas: ["urn:ietf:params:scim:api:messages:2.0:PatchOp"],
           id: 1,
           Operations: [
             {
               op: "replace",
-              path: "displayName",
-              value: "Francis"
+              path: "emails[type eq \"work\"].value"
             }
           ]
-        }
+        }, as: :json
 
         expect(response.status).to eq 422
         response_body = JSON.parse(response.body)
         expect(response_body.dig("schemas", 0)).to eq "urn:ietf:params:scim:api:messages:2.0:Error"
       end
 
-      it "returns 422 when value is missing" do
+      it "returns 422 when path is missing" do
         patch :patch_update, params: {
+          schemas: ["urn:ietf:params:scim:api:messages:2.0:PatchOp"],
           id: 1,
           Operations: [
             {
@@ -633,6 +704,7 @@ RSpec.describe ScimRails::ScimUsersController, type: :controller do
 
       it "returns 422 operations key is missing" do
         patch :patch_update, params: {
+          schemas: ["urn:ietf:params:scim:api:messages:2.0:PatchOp"],
           id: 1,
           Foobars: [
             {
@@ -648,23 +720,37 @@ RSpec.describe ScimRails::ScimUsersController, type: :controller do
     end
   end
 
-  def patch_params(id:, active: false)
+  def patch_params(id:)
     {
+      schemas: ["urn:ietf:params:scim:api:messages:2.0:PatchOp"],
       id: id,
       Operations: [
         {
-          op: "replace",
-          value: {
-            active: active
-          }
+          op: "Replace",
+          path: "emails[type eq \"work\"].value",
+          value: "change@example.com"
         }
       ]
     }
   end
 
-  def put_params(active: true)
+  def patch_active_params(id:, active: false)
     {
-      id: 1,
+      schemas: ["urn:ietf:params:scim:api:messages:2.0:PatchOp"],
+      id: id,
+      Operations: [
+        {
+          op: "Replace",
+          path: "active",
+          value: active
+        }
+      ]
+    }
+  end
+
+  def put_params(id: 1, active: true)
+    {
+      id: id,
       userName: "test@example.com",
       name: {
         givenName: "Test",

data/spec/dummy/app/models/user.rb

@@ -15,6 +15,18 @@ class User < ApplicationRecord
       case_insensitive: true
     }
 
+  def active
+    return active?
+  end
+
+  def active=(active)
+    if active
+      self.archived_at = nil
+    else
+      self.archived_at ||= Time.now
+    end
+  end
+
   def active?
     archived_at.blank?
   end

data/spec/dummy/bin/setup

@@ -22,6 +22,8 @@ chdir APP_ROOT do
   # unless File.exist?('config/database.yml')
   #   cp 'config/database.yml.sample', 'config/database.yml'
   # end
+  puts "\n== Reset migration =="
+  system! 'bin/rails db:migrate:reset'
 
   puts "\n== Preparing database =="
   system! 'bin/rails db:setup'

data/spec/dummy/config/initializers/scim_rails_config.rb

@@ -12,13 +12,11 @@ ScimRails.configure do |config|
   config.signing_algorithm = "HS256"
   config.signing_secret = "2d6806dd11c2fece2e81b8ca76dcb0062f5b08e28e3264e8ba1c44bbd3578b70"
 
-  config.user_deprovision_method = :archive!
-  config.user_reprovision_method = :unarchive!
-
   config.mutable_user_attributes = [
     :first_name,
     :last_name,
-    :email
+    :email,
+    :active
   ]
 
   config.queryable_user_attributes = {
@@ -37,7 +35,8 @@ ScimRails.configure do |config|
       {
         value: :email
       }
-    ]
+    ],
+    active: :active
   }
 
   config.user_schema = {

data/spec/dummy/db/migrate/20220117095407_add_country_to_users.rb

@@ -0,0 +1,5 @@
+class AddCountryToUsers < ActiveRecord::Migration[6.1]
+  def change
+    add_column :users, :country, :string
+  end
+end

data/spec/dummy/db/schema.rb

@@ -10,7 +10,7 @@
 #
 # It's strongly recommended that you check this file into your version control system.
 
-ActiveRecord::Schema.define(version: 2021_04_23_075950) do
+ActiveRecord::Schema.define(version: 2022_01_17_095407) do
 
   create_table "companies", force: :cascade do |t|
     t.string "name", null: false
@@ -23,8 +23,8 @@ ActiveRecord::Schema.define(version: 2021_04_23_075950) do
   create_table "group_users", force: :cascade do |t|
     t.integer "group_id", null: false
     t.integer "user_id", null: false
-    t.datetime "created_at", precision: 6, null: false
-    t.datetime "updated_at", precision: 6, null: false
+    t.datetime "created_at", null: false
+    t.datetime "updated_at", null: false
     t.index ["group_id"], name: "index_group_users_on_group_id"
     t.index ["user_id"], name: "index_group_users_on_user_id"
   end
@@ -32,8 +32,8 @@ ActiveRecord::Schema.define(version: 2021_04_23_075950) do
   create_table "groups", force: :cascade do |t|
     t.string "name", null: false
     t.integer "company_id", null: false
-    t.datetime "created_at", precision: 6, null: false
-    t.datetime "updated_at", precision: 6, null: false
+    t.datetime "created_at", null: false
+    t.datetime "updated_at", null: false
     t.index ["company_id"], name: "index_groups_on_company_id"
   end
 
@@ -45,6 +45,7 @@ ActiveRecord::Schema.define(version: 2021_04_23_075950) do
     t.datetime "archived_at"
     t.datetime "created_at", null: false
     t.datetime "updated_at", null: false
+    t.string "country"
   end
 
   add_foreign_key "group_users", "groups"

data/spec/dummy/db/seeds.rb

@@ -4,6 +4,11 @@ company = Company.create(
   api_token: 1
 )
 
+group = Group.create(
+  company: company,
+  name: 'Test Group'
+)
+
 1.upto(1000) do |n|
   User.create(
     company: company,

data/spec/libraries/scim_patch_operation_spec.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+describe ScimPatchOperation do
+
+  let(:op) { 'Replace' }
+  let(:path) { 'userName' }
+  let(:value) { 'taro.suzuki' }
+  let(:mutable_attributes_schema) {
+    {
+      userName: :name,
+      displayName: :display_name,
+      emails: [
+        {
+          value: :email
+        }
+      ],
+      name: {
+        familyName: :family_name,
+        givenName: :given_name
+      },
+      active: :active
+    }
+  }
+  let(:operation) {
+    described_class.new(
+      op,
+      path,
+      value,
+      mutable_attributes_schema
+    )
+  }
+  describe '#initialize' do
+    context 'replace single attribute' do
+      it {
+        expect(operation.op).to eq :replace
+        expect(operation.path_scim).to eq path
+        expect(operation.path_sp).to eq :name
+        expect(operation.value).to eq value
+      }
+    end
+
+    context 'add single attribute' do
+      let(:op) { 'Add' }
+      it {
+        expect(operation.op).to eq :add
+        expect(operation.path_scim).to eq path
+        expect(operation.path_sp).to eq :name
+        expect(operation.value).to eq value
+      }
+    end
+
+    context 'remove single attribute' do
+      let(:op) { 'Remove' }
+      it {
+        expect(operation.op).to eq :remove
+        expect(operation.path_scim).to eq path
+        expect(operation.path_sp).to eq :name
+        expect(operation.value).to eq value
+      }
+    end
+
+    context 'replace email address' do
+      let(:path) { 'emails[type eq "work"].value' }
+      let(:value) { 'taro.suzuki@example.com' }
+      it {
+        expect(operation.op).to eq :replace
+        expect(operation.path_scim).to eq path
+        expect(operation.path_sp).to eq :email
+        expect(operation.value).to eq value
+      }
+    end
+
+    context 'replace name.familyName' do
+      let(:path) { 'name.familyName' }
+      let(:value) { 'Suzuki' }
+      it {
+        expect(operation.op).to eq :replace
+        expect(operation.path_scim).to eq path
+        expect(operation.path_sp).to eq :family_name
+        expect(operation.value).to eq value
+      }
+    end
+
+    context 'replace active' do
+      let(:path) { 'active' }
+      let(:value) { 'False' }
+
+      it 'convert string to bool' do
+        expect(operation.value).to eq false
+      end
+    end
+  end
+
+end

data/spec/libraries/scim_patch_spec.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe ScimPatch do
+
+  let(:params) {
+    {
+      'schemas' => ['urn:ietf:params:scim:api:messages:2.0:PatchOp'],
+      'Operations' => [
+        {
+          'op' => 'Replace',
+          'path' => 'userName',
+          'value' => 'taro.suzuki'
+        },
+        {
+          'op' =>  'Replace',
+          'path' => 'emails[type eq "work"].value',
+          'value' => 'taro.suzuki@example.com'
+        },
+        {
+          'op' => 'Replace',
+          'path' => 'name.familyName',
+          'value' => 'Suzuki'
+        },
+        {
+          'op' => 'Replace',
+          'path' => 'active',
+          'value' => 'False'
+        }
+      ]
+    }
+  }
+
+  let(:mutable_attributes_schema) {
+    {
+      userName: :name,
+      displayName: :display_name,
+      emails: [
+        {
+          value: :email
+        }
+      ],
+      name: {
+        familyName: :family_name,
+        givenName: :given_name
+      },
+      active: :active
+    }
+  }
+
+  let(:patch) { described_class.new(params, mutable_attributes_schema) }
+
+  describe '#initialize' do
+    it {
+      expect(patch.operations[0].op).to eq :replace
+      expect(patch.operations[0].path_scim).to eq 'userName'
+      expect(patch.operations[0].path_sp).to eq :name
+      expect(patch.operations[0].value).to eq 'taro.suzuki'
+
+      expect(patch.operations[1].op).to eq :replace
+      expect(patch.operations[1].path_scim).to eq 'emails[type eq "work"].value'
+      expect(patch.operations[1].path_sp).to eq :email
+      expect(patch.operations[1].value).to eq 'taro.suzuki@example.com'
+
+      expect(patch.operations[2].op).to eq :replace
+      expect(patch.operations[2].path_scim).to eq 'name.familyName'
+      expect(patch.operations[2].path_sp).to eq :family_name
+      expect(patch.operations[2].value).to eq 'Suzuki'
+
+      expect(patch.operations[3].op).to eq :replace
+      expect(patch.operations[3].path_scim).to eq 'active'
+      expect(patch.operations[3].path_sp).to eq :active
+      expect(patch.operations[3].value).to eq false
+    }
+  end
+
+  # describe '#update' do
+    # create user by factory bot
+    # patch.update(user)
+  # end
+
+end

data/spec/models/scim_query_parser_spec.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe ScimRails::ScimQueryParser do
+
+  let(:query_string) { 'userName eq "taro"' }
+  let(:queryable_attributes) {
+    {
+      userName: :name,
+      emails: [
+        {
+          value: :email
+        }
+      ]
+    }
+  }
+  let(:parser) { described_class.new(query_string, queryable_attributes) }
+
+  describe '#attribute' do
+    context 'userName' do
+      it { expect(parser.attribute).to eq :name }
+    end
+
+    context 'emails[type eq "work"].value' do
+      let(:query_string) { 'emails[type eq "work"].value eq "taro@example.com"' }
+      it { expect(parser.attribute).to eq :email }
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: scimaenaga
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.6.2
 platform: ruby
 authors:
 - Studist Corporation
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-11-22 00:00:00.000000000 Z
+date: 2022-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -149,6 +149,8 @@ files:
 - app/controllers/scim_rails/scim_groups_controller.rb
 - app/controllers/scim_rails/scim_users_controller.rb
 - app/helpers/scim_rails/application_helper.rb
+- app/libraries/scim_patch.rb
+- app/libraries/scim_patch_operation.rb
 - app/models/scim_rails/application_record.rb
 - app/models/scim_rails/authorize_api_request.rb
 - app/models/scim_rails/scim_count.rb
@@ -221,6 +223,7 @@ files:
 - spec/dummy/db/migrate/20181206184313_create_companies.rb
 - spec/dummy/db/migrate/20210423075859_create_groups.rb
 - spec/dummy/db/migrate/20210423075950_create_group_users.rb
+- spec/dummy/db/migrate/20220117095407_add_country_to_users.rb
 - spec/dummy/db/schema.rb
 - spec/dummy/db/seeds.rb
 - spec/dummy/public/404.html
@@ -233,11 +236,13 @@ files:
 - spec/factories/group.rb
 - spec/factories/user.rb
 - spec/lib/scim_rails/encoder_spec.rb
+- spec/libraries/scim_patch_operation_spec.rb
+- spec/libraries/scim_patch_spec.rb
+- spec/models/scim_query_parser_spec.rb
 - spec/spec_helper.rb
 - spec/support/auth_helper.rb
 - spec/support/factory_bot.rb
-- spec/support/scim_rails_config.rb
-homepage: https://github.com/StudistCorporation/scim_rails
+homepage: https://github.com/StudistCorporation/scimaenaga
 licenses:
 - MIT
 metadata: {}
@@ -269,6 +274,7 @@ test_files:
 - spec/dummy/db/migrate/20181206184304_create_users.rb
 - spec/dummy/db/migrate/20210423075950_create_group_users.rb
 - spec/dummy/db/migrate/20210423075859_create_groups.rb
+- spec/dummy/db/migrate/20220117095407_add_country_to_users.rb
 - spec/dummy/db/schema.rb
 - spec/dummy/db/seeds.rb
 - spec/dummy/config/spring.rb
@@ -326,14 +332,16 @@ test_files:
 - spec/dummy/public/apple-touch-icon.png
 - spec/dummy/public/422.html
 - spec/support/factory_bot.rb
-- spec/support/scim_rails_config.rb
 - spec/support/auth_helper.rb
 - spec/lib/scim_rails/encoder_spec.rb
 - spec/controllers/scim_rails/scim_users_controller_spec.rb
 - spec/controllers/scim_rails/scim_users_request_spec.rb
 - spec/controllers/scim_rails/scim_groups_request_spec.rb
 - spec/controllers/scim_rails/scim_groups_controller_spec.rb
+- spec/libraries/scim_patch_spec.rb
+- spec/libraries/scim_patch_operation_spec.rb
 - spec/factories/user.rb
 - spec/factories/group.rb
 - spec/factories/company.rb
 - spec/spec_helper.rb
+- spec/models/scim_query_parser_spec.rb