scim2-models 0.1.0__tar.gz

scim2_models-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

scim2_models-0.1.0/PKG-INFO

@@ -0,0 +1,69 @@
+Metadata-Version: 2.1
+Name: scim2-models
+Version: 0.1.0
+Summary: SCIM2 models serialization and validation with pydantic
+Home-page: https://github.com/yaal-coop/scim2-models
+License: Apache
+Keywords: scim,scim2,provisioning,pydantic
+Author: Yaal Coop
+Author-email: contact@yaal.coop
+Requires-Python: >=3.9,<4.0
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Web Environment
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: License :: Other/Proprietary License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Requires-Dist: pydantic[email] (>=2.7.0,<3.0.0)
+Project-URL: Documentation, https://scim2-models.readthedocs.io
+Project-URL: Repository, https://github.com/yaal-coop/scim2-models
+Description-Content-Type: text/markdown
+
+# scim2-models
+
+Pydantic models for SCIM2 schemas defined in [RFC7643](https://datatracker.ietf.org/doc/html/rfc7643.html) and [RFC7644](https://datatracker.ietf.org/doc/html/rfc7644.html).
+
+This library provides utilities to parse and produce SCIM2 payloads, and handle them with native Python objects.
+It can be use as a basis to build SCIM2 servers and clients.
+
+## Installation
+
+```shell
+pip install scim2-models
+```
+
+## Usage
+
+Check the [tutorial](https://scim2-models.readthedocs.io/en/latest/tutorial.html) and the [reference](https://scim2-models.readthedocs.io/en/latest/reference.html) for more details.
+
+```python
+from scim2_models import User
+import datetime
+
+payload = {
+    "schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"],
+    "id": "2819c223-7f76-453a-919d-413861904646",
+    "userName": "bjensen@example.com",
+    "meta": {
+        "resourceType": "User",
+        "created": "2010-01-23T04:56:22Z",
+        "lastModified": "2011-05-13T04:42:34Z",
+        "version": 'W\\/"3694e05e9dff590"',
+        "location": "https://example.com/v2/Users/2819c223-7f76-453a-919d-413861904646",
+    },
+}
+
+user = User.model_validate(payload)
+assert user.user_name == "bjensen@example.com"
+assert user.meta.created == datetime.datetime(
+    2010, 1, 23, 4, 56, 22, tzinfo=datetime.timezone.utc
+)
+```
+

scim2_models-0.1.0/README.md

@@ -0,0 +1,40 @@
+# scim2-models
+
+Pydantic models for SCIM2 schemas defined in [RFC7643](https://datatracker.ietf.org/doc/html/rfc7643.html) and [RFC7644](https://datatracker.ietf.org/doc/html/rfc7644.html).
+
+This library provides utilities to parse and produce SCIM2 payloads, and handle them with native Python objects.
+It can be use as a basis to build SCIM2 servers and clients.
+
+## Installation
+
+```shell
+pip install scim2-models
+```
+
+## Usage
+
+Check the [tutorial](https://scim2-models.readthedocs.io/en/latest/tutorial.html) and the [reference](https://scim2-models.readthedocs.io/en/latest/reference.html) for more details.
+
+```python
+from scim2_models import User
+import datetime
+
+payload = {
+    "schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"],
+    "id": "2819c223-7f76-453a-919d-413861904646",
+    "userName": "bjensen@example.com",
+    "meta": {
+        "resourceType": "User",
+        "created": "2010-01-23T04:56:22Z",
+        "lastModified": "2011-05-13T04:42:34Z",
+        "version": 'W\\/"3694e05e9dff590"',
+        "location": "https://example.com/v2/Users/2819c223-7f76-453a-919d-413861904646",
+    },
+}
+
+user = User.model_validate(payload)
+assert user.user_name == "bjensen@example.com"
+assert user.meta.created == datetime.datetime(
+    2010, 1, 23, 4, 56, 22, tzinfo=datetime.timezone.utc
+)
+```

scim2_models-0.1.0/pyproject.toml

@@ -0,0 +1,119 @@
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.poetry]
+name = "scim2-models"
+version = "0.1.0"
+description = "SCIM2 models serialization and validation with pydantic"
+authors = ["Yaal Coop <contact@yaal.coop>"]
+license = "Apache"
+readme = "README.md"
+keywords = ["scim", "scim2", "provisioning", "pydantic"]
+documentation = "https://scim2-models.readthedocs.io"
+repository = "https://github.com/yaal-coop/scim2-models"
+classifiers = [
+    "Intended Audience :: Developers",
+    "Development Status :: 3 - Alpha",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: Implementation :: CPython",
+    "License :: OSI Approved :: MIT License",
+    "Environment :: Web Environment",
+    "Programming Language :: Python",
+    "Operating System :: OS Independent",
+]
+
+[tool.poetry.dependencies]
+python = "^3.9"
+pydantic = {version = "^2.7.0", extras = ["email"]}
+
+[tool.poetry.group.dev.dependencies]
+pytest = "^8.2.1"
+pytest-coverage = "^0.0"
+
+[tool.poetry.group.doc]
+optional = true
+
+[tool.poetry.group.doc.dependencies]
+autodoc-pydantic = "^2.2.0"
+shibuya = "^2024.5.15"
+sphinx = "^7.3.7"
+myst-parser = "^3.0.1"
+
+[tool.coverage.run]
+source = [
+    "scim2_models",
+    "tests",
+]
+omit = [".tox/*"]
+branch = true
+
+[tool.coverage.report]
+exclude_lines = [
+    "@pytest.mark.skip",
+    "pragma: no cover",
+    "raise NotImplementedError",
+]
+
+[tool.ruff.lint]
+select = [
+    "E", # pycodestyle
+    "F", # pyflakes
+    "I", # isort
+    "UP", # pyupgrade
+]
+ignore = [
+    "E501", # line-too-long
+    "E722", # bare-except
+]
+
+[tool.ruff.lint.isort]
+force-single-line = true
+
+[too.ruff.format]
+docstring-code-format = true
+
+[tool.pytest.ini_options]
+addopts = "--doctest-modules --doctest-glob='*.rst'"
+doctest_optionflags= "ALLOW_UNICODE IGNORE_EXCEPTION_DETAIL ELLIPSIS"
+
+
+[tool.tox]
+legacy_tox_ini = """
+[tox]
+isolated_build = true
+skipsdist = true
+envlist =
+    style
+    py39
+    py310
+    py311
+    py312
+    doc
+    coverage
+
+[testenv]
+allowlist_externals = poetry
+commands =
+    poetry install
+    poetry run pytest --showlocals --full-trace {posargs}
+
+[testenv:style]
+commands =
+    pip install pre-commit
+    pre-commit run --all-files
+
+[testenv:doc]
+commands =
+    poetry install --with doc --without dev
+    poetry run sphinx-build --builder html doc build/sphinx/html
+
+[testenv:coverage]
+commands =
+    poetry install
+    poetry run pytest --cov --cov-fail-under=100 --cov-report term:skip-covered {posargs}
+    poetry run coverage html
+"""

scim2_models-0.1.0/scim2_models/__init__.py

@@ -0,0 +1,115 @@
+from .base import BaseModel
+from .base import ComplexAttribute
+from .base import Context
+from .base import Mutability
+from .base import Required
+from .base import Returned
+from .base import Uniqueness
+from .rfc7643.enterprise_user import EnterpriseUser
+from .rfc7643.enterprise_user import Manager
+from .rfc7643.group import Group
+from .rfc7643.group import GroupMember
+from .rfc7643.resource import AnyResource
+from .rfc7643.resource import Meta
+from .rfc7643.resource import Resource
+from .rfc7643.resource_type import ResourceType
+from .rfc7643.resource_type import SchemaExtension
+from .rfc7643.schema import Attribute
+from .rfc7643.schema import Schema
+from .rfc7643.service_provider import AuthenticationScheme
+from .rfc7643.service_provider import Bulk
+from .rfc7643.service_provider import ChangePassword
+from .rfc7643.service_provider import ETag
+from .rfc7643.service_provider import Filter
+from .rfc7643.service_provider import Patch
+from .rfc7643.service_provider import ServiceProviderConfiguration
+from .rfc7643.service_provider import Sort
+from .rfc7643.user import Address
+from .rfc7643.user import Email
+from .rfc7643.user import Entitlement
+from .rfc7643.user import Im
+from .rfc7643.user import Name
+from .rfc7643.user import PhoneNumber
+from .rfc7643.user import Photo
+from .rfc7643.user import Role
+from .rfc7643.user import User
+from .rfc7643.user import X509Certificate
+from .rfc7644.bulk import BulkOperation
+from .rfc7644.bulk import BulkRequest
+from .rfc7644.bulk import BulkResponse
+from .rfc7644.error import Error
+from .rfc7644.error import InvalidFilterError
+from .rfc7644.error import InvalidPathError
+from .rfc7644.error import InvalidSyntaxError
+from .rfc7644.error import InvalidValueError
+from .rfc7644.error import InvalidVersionError
+from .rfc7644.error import MutabilityError
+from .rfc7644.error import NoTargetError
+from .rfc7644.error import SensitiveError
+from .rfc7644.error import TooManyError
+from .rfc7644.error import UniquenessError
+from .rfc7644.list_response import ListResponse
+from .rfc7644.patch_op import Op
+from .rfc7644.patch_op import PatchOp
+from .rfc7644.patch_op import PatchOperation
+from .rfc7644.search_request import SearchRequest
+from .rfc7644.search_request import SortOrder
+
+__all__ = [
+    "Address",
+    "AnyResource",
+    "Attribute",
+    "AuthenticationScheme",
+    "BaseModel",
+    "Bulk",
+    "BulkOperation",
+    "BulkRequest",
+    "BulkResponse",
+    "ChangePassword",
+    "ComplexAttribute",
+    "Context",
+    "ETag",
+    "Email",
+    "EnterpriseUser",
+    "Entitlement",
+    "Error",
+    "Filter",
+    "Group",
+    "GroupMember",
+    "Im",
+    "InvalidFilterError",
+    "InvalidPathError",
+    "InvalidSyntaxError",
+    "InvalidValueError",
+    "InvalidVersionError",
+    "ListResponse",
+    "Manager",
+    "Meta",
+    "Mutability",
+    "MutabilityError",
+    "Name",
+    "NoTargetError",
+    "Op",
+    "Patch",
+    "PatchOp",
+    "PatchOperation",
+    "PhoneNumber",
+    "Photo",
+    "Required",
+    "Resource",
+    "ResourceType",
+    "Returned",
+    "Role",
+    "Schema",
+    "SchemaExtension",
+    "SearchRequest",
+    "SortOrder",
+    "SensitiveError",
+    "ServiceProviderConfiguration",
+    "Sort",
+    "TooManyError",
+    "Uniqueness",
+    "UniquenessError",
+    "User",
+    "X509Certificate",
+]

scim2_models-0.1.0/scim2_models/attributes.py

@@ -0,0 +1,89 @@
+from typing import List
+from typing import Optional
+from typing import Tuple
+from typing import Type
+
+
+def validate_model_attribute(model: Type, attribute_base: str) -> None:
+    """Validate that an attribute name or a sub-attribute path exist for a
+    given model."""
+
+    from scim2_models.base import BaseModel
+
+    attribute_name, *sub_attribute_blocks = attribute_base.split(".")
+    sub_attribute_base = ".".join(sub_attribute_blocks)
+
+    aliases = {field.alias for field in model.model_fields.values()}
+
+    if attribute_name not in aliases:
+        raise ValueError(
+            f"Model '{model.__name__}' has no attribute named '{attribute_name}'"
+        )
+
+    if sub_attribute_base:
+        attribute_type = model.get_field_root_type(attribute_name)
+
+        if not issubclass(attribute_type, BaseModel):
+            raise ValueError(
+                f"Attribute '{attribute_name}' is not a complex attribute, and cannot have a '{sub_attribute_base}' sub-attribute"
+            )
+
+        validate_model_attribute(attribute_type, sub_attribute_base)
+
+
+def extract_schema_and_attribut_base(attribute_urn: str) -> Tuple[str, str]:
+    """Extract the schema urn part and the attribute name part from attribute
+    name, as defined in :rfc:`RFC7644 §3.10 <7644#section-3.10>`."""
+
+    *urn_blocks, attribute_base = attribute_urn.split(":")
+    schema = ":".join(urn_blocks)
+    return schema, attribute_base
+
+
+def validate_attribute_urn(
+    attribute_name: str,
+    default_resource: Optional[Type] = None,
+    resource_types: Optional[List[Type]] = None,
+) -> str:
+    """Validate that an attribute urn is valid or not.
+
+    :parm attribute_name: The attribute urn to check.
+    :default_resource: The default resource if `attribute_name` is not an absolute urn.
+    :resource_types: The available resources in which to look for the attribute.
+    :return: The normalized attribute URN.
+    """
+
+    from scim2_models.rfc7643.resource import Resource
+
+    if not resource_types:
+        resource_types = []
+
+    if default_resource and default_resource not in resource_types:
+        resource_types.append(default_resource)
+
+    default_schema = (
+        default_resource.model_fields["schemas"].default[0]
+        if default_resource
+        else None
+    )
+
+    schema, attribute_base = extract_schema_and_attribut_base(attribute_name)
+    if not schema:
+        schema = default_schema
+
+    if not schema:
+        raise ValueError("No default schema and relative URN")
+
+    resource = Resource.get_by_schema(resource_types, schema)
+    if not resource:
+        raise ValueError(f"No resource matching schema '{schema}'")
+
+    validate_model_attribute(resource, attribute_base)
+
+    return f"{schema}:{attribute_base}"
+
+
+def contains_attribute_or_subattributes(attribute_urns: List[str], attribute_urn):
+    return attribute_urn in attribute_urns or any(
+        item.startswith(f"{attribute_urn}.") for item in attribute_urns
+    )