Skip to content

Make skip unknown schemas optional #15

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rkaippully merged 4 commits into from
Oct 22, 2020
Merged

Make skip unknown schemas optional #15

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f292fcc
make skip unknown schemas optional, default to false
smithtim Oct 1, 2020
37123c5
check for nil schemas happens earlier
smithtim Oct 2, 2020
bb853ff
Merge branch 'master' into optional-skip-unknown
rkaippully Oct 3, 2020
f97b227
merge from master
smithtim Oct 16, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 21 additions & 18 deletions src/scim_patch/core.clj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,13 +24,13 @@
(update resource attr-key #(handle-attr-path-levels (:type schema') (or % {}) update-fn attrs))))))

(defn handle-attr-path
[schema resource uri attr subattr update-fn]
[schema resource uri attr subattr skip-unknown? update-fn]
(let [patching-schema (if (s/blank? uri)
(:id schema)
uri)
patchable-schemas (:schemas schema)]
(if (or (nil? patching-schema)
(nil? patchable-schemas)
(if (or (not skip-unknown?)
(nil? patching-schema)
(some #{patching-schema} patchable-schemas))
;; The schema is patchable
(as-> [attr] $
Expand All @@ -41,24 +41,24 @@
resource)))

(defn handle-operation
[schema resource {:keys [path value]} attr-path-fn value-path-fn]
[schema resource {:keys [path value]} skip-unknown? attr-path-fn value-path-fn]
(try
(if (s/blank? path)
;; no path, so handle each attribute separately
(reduce (fn [r [k v]]
(handle-operation schema r {:path (name k) :value v} attr-path-fn value-path-fn))
(handle-operation schema r {:path (name k) :value v} skip-unknown? attr-path-fn value-path-fn))
resource value)
;; path provided
(let [[_ xs] (paths/parse path)]
(case (first xs)
:attrPath
(let [[uri attr subattr] (paths/extract-attr-path xs)]
(handle-attr-path schema resource uri attr subattr
(handle-attr-path schema resource uri attr subattr skip-unknown?
(partial attr-path-fn value)))
:valuePath
(let [[_ attr-path value-filter subattr2] xs
[uri attr subattr] (paths/extract-attr-path attr-path)]
(handle-attr-path schema resource uri attr subattr
(handle-attr-path schema resource uri attr subattr skip-unknown?
(partial value-path-fn value value-filter subattr2))))))
(catch ExceptionInfo e
(throw (ex-info (.getMessage e)
Expand Down Expand Up @@ -100,7 +100,7 @@
old-val)))

(defn op-add
[schema resource opr]
[schema resource opr skip-unknown?]
(when-not (contains? opr :value)
(throw (ex-info "Invalid patch keys" {:status 400
:scimType :invalidSyntax})))
Expand All @@ -126,7 +126,7 @@
(catch ExceptionInfo e
(throw (ex-info (.getMessage e)
(assoc (ex-data e) :path (:path opr)))))))]
(handle-operation schema resource opr add-attr-path add-value-path)))
(handle-operation schema resource opr skip-unknown? add-attr-path add-value-path)))

(defn filter-and-remove
[schema value-filter subattr]
Expand All @@ -145,7 +145,7 @@
(conj acc old-val))))

(defn op-remove
[schema resource opr]
[schema resource opr skip-unknown?]
(when (s/blank? (:path opr))
(throw (ex-info "Missing path for remove operation"
{:status 400
Expand All @@ -166,7 +166,7 @@
(dissoc res attr-key)
(assoc res attr-key new-val))))]

(handle-operation schema resource opr remove-attr-path remove-value-path)))
(handle-operation schema resource opr skip-unknown? remove-attr-path remove-value-path)))

(defn value-for-replace
[schema value]
Expand Down Expand Up @@ -197,7 +197,7 @@
{:replaced? replaced? :value (conj value old-val)})))

(defn op-replace
[schema resource opr]
[schema resource opr skip-unknown?]
(when (not-any? #(contains? opr %) [:value :path])
(throw (ex-info "Invalid patch keys" {:status 400
:scimType :invalidSyntax})))
Expand All @@ -220,21 +220,24 @@
{:status 400
:scimType :noTarget}))))))]

(handle-operation schema resource opr replace-attr-path replace-value-path)))
(handle-operation schema resource opr skip-unknown? replace-attr-path replace-value-path)))

(defn patch
[schema resource op]
[schema resource op & {:keys [skip-unknown-schemas]}]
(if (and skip-unknown-schemas (not (:schemas schema)))
(throw (ex-info "Option 'skip-unknown-schemas' requires :schemas in schema"
{:status 400 :scimType :invalidSyntax})))
(cond
;; single patch operation
(map? op)
(case (:op op)
"add" (op-add schema resource op)
"remove" (op-remove schema resource op)
"replace" (op-replace schema resource op)
"add" (op-add schema resource op skip-unknown-schemas)
"remove" (op-remove schema resource op skip-unknown-schemas)
"replace" (op-replace schema resource op skip-unknown-schemas)
(throw (ex-info (str "Invalid operation") {:status 400
:scimType :invalidSyntax
:op (:op op)})))

;; sequence of operations
(sequential? op)
(reduce #(patch schema %1 %2) resource op)))
(reduce #(patch schema %1 %2 :skip-unknown-schemas skip-unknown-schemas) resource op)))
5 changes: 4 additions & 1 deletion test/scim_patch/core_test.clj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -764,6 +764,9 @@
(is (= {:status 400 :scimType :invalidPath
:path "urn:ietf:params:scim:schemas:core:2.0:Group:displayName"}
(get-ex-data (sut/patch schema user patch)))))
(testing "throws an exception if told to filter but not given a filter list"
(is (= {:status 400 :scimType :invalidSyntax}
(get-ex-data (sut/patch schema user patch :skip-unknown-schemas true)))))
(testing "ignores unknown schema if there is a schema filter"
(is (= (assoc user :userName "bar")
(sut/patch schema' user patch))))))
(sut/patch schema' user patch :skip-unknown-schemas true))))))