airbyte-source-microsoft-dataverse 0.1.2__py3-none-any.whl

airbyte_source_microsoft_dataverse-0.1.2.dist-info/METADATA

@@ -0,0 +1,99 @@
+Metadata-Version: 2.1
+Name: airbyte-source-microsoft-dataverse
+Version: 0.1.2
+Summary: Source implementation for Microsoft Dataverse.
+Author: Airbyte
+Author-email: contact@airbyte.io
+Description-Content-Type: text/markdown
+Requires-Dist: airbyte-cdk ~=0.2
+Provides-Extra: tests
+Requires-Dist: requests-mock ~=1.9.3 ; extra == 'tests'
+Requires-Dist: pytest ~=6.1 ; extra == 'tests'
+Requires-Dist: pytest-mock ~=3.6.1 ; extra == 'tests'
+
+# Microsoft Dataverse Source
+
+This is the repository for the Microsoft Dataverse source connector, written in Python.
+For information about how to use this connector within Airbyte, see [the documentation](https://docs.airbyte.io/integrations/sources/microsoft-dataverse).
+
+
+**To iterate on this connector, make sure to complete this prerequisites section.**
+
+
+From this connector directory, create a virtual environment:
+```
+python -m venv .venv
+```
+
+This will generate a virtualenv for this module in `.venv/`. Make sure this venv is active in your
+development environment of choice. To activate it from the terminal, run:
+```
+source .venv/bin/activate
+pip install -r requirements.txt
+pip install '.[tests]'
+```
+If you are in an IDE, follow your IDE's instructions to activate the virtualenv.
+
+Note that while we are installing dependencies from `requirements.txt`, you should only edit `setup.py` for your dependencies. `requirements.txt` is
+used for editable installs (`pip install -e`) to pull in Python dependencies from the monorepo and will call `setup.py`.
+If this is mumbo jumbo to you, don't worry about it, just put your deps in `setup.py` but install using `pip install -r requirements.txt` and everything
+should work as you expect.
+
+**If you are a community contributor**, follow the instructions in the [documentation](https://docs.airbyte.io/integrations/sources/microsoft-dataverse)
+to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `source_microsoft_dataverse/spec.yaml` file.
+Note that any directory named `secrets` is gitignored across the entire Airbyte repo, so there is no danger of accidentally checking in sensitive information.
+See `integration_tests/sample_config.json` for a sample config file.
+
+**If you are an Airbyte core member**, copy the credentials in Lastpass under the secret name `source microsoft-dataverse test creds`
+and place them into `secrets/config.json`.
+
+```
+python main.py spec
+python main.py check --config secrets/config.json
+python main.py discover --config secrets/config.json
+python main.py read --config secrets/config.json --catalog integration_tests/configured_catalog.json
+```
+
+
+
+**Via [`airbyte-ci`](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/pipelines/README.md) (recommended):**
+```bash
+airbyte-ci connectors --name=source-microsoft-dataverse build
+```
+
+An image will be built with the tag `airbyte/source-microsoft-dataverse:dev`.
+
+**Via `docker build`:**
+```bash
+docker build -t airbyte/source-microsoft-dataverse:dev .
+```
+
+Then run any of the connector commands as follows:
+```
+docker run --rm airbyte/source-microsoft-dataverse:dev spec
+docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-microsoft-dataverse:dev check --config /secrets/config.json
+docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-microsoft-dataverse:dev discover --config /secrets/config.json
+docker run --rm -v $(pwd)/secrets:/secrets -v $(pwd)/integration_tests:/integration_tests airbyte/source-microsoft-dataverse:dev read --config /secrets/config.json --catalog /integration_tests/configured_catalog.json
+```
+
+You can run our full test suite locally using [`airbyte-ci`](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/pipelines/README.md):
+```bash
+airbyte-ci connectors --name=source-microsoft-dataverse test
+```
+
+Customize `acceptance-test-config.yml` file to configure tests. See [Connector Acceptance Tests](https://docs.airbyte.com/connector-development/testing-connectors/connector-acceptance-tests-reference) for more information.
+If your connector requires to create or destroy resources for use during acceptance tests create fixtures for it and place them inside integration_tests/acceptance.py.
+
+All of your dependencies should go in `setup.py`, NOT `requirements.txt`. The requirements file is only used to connect internal Airbyte dependencies in the monorepo for local development.
+We split dependencies between two groups, dependencies that are:
+* required for your connector to work need to go to `MAIN_REQUIREMENTS` list.
+* required for the testing need to go to `TEST_REQUIREMENTS` list
+
+You've checked out the repo, implemented a million dollar feature, and you're ready to share your changes with the world. Now what?
+1. Make sure your changes are passing our test suite: `airbyte-ci connectors --name=source-microsoft-dataverse test`
+2. Bump the connector version in `metadata.yaml`: increment the `dockerImageTag` value. Please follow [semantic versioning for connectors](https://docs.airbyte.com/contributing-to-airbyte/resources/pull-requests-handbook/#semantic-versioning-for-connectors).
+3. Make sure the `metadata.yaml` content is up to date.
+4. Make the connector documentation and its changelog is up to date (`docs/integrations/sources/microsoft-dataverse.md`).
+5. Create a Pull Request: use [our PR naming conventions](https://docs.airbyte.com/contributing-to-airbyte/resources/pull-requests-handbook/#pull-request-title-convention).
+6. Pat yourself on the back for being an awesome contributor.
+7. Someone from Airbyte will take a look at your PR and iterate with you to merge it into master.

airbyte_source_microsoft_dataverse-0.1.2.dist-info/RECORD

@@ -0,0 +1,23 @@
+integration_tests/__init__.py,sha256=4Hw-PX1-VgESLF16cDdvuYCzGJtHntThLF4qIiULWeo,61
+integration_tests/abnormal_state.json,sha256=F6qYeCLpsXDWSWOK-t622dDz1MP7CPXE2Y-9SkoR-hk,82
+integration_tests/acceptance.py,sha256=8eU9iSDbmHyufPvAouJGhPMgPAFTCP8IKIKHLm7u5TE,435
+integration_tests/configured_catalog.json,sha256=rcfE_cGCXXSimwPslZwhSInofVYvIeIBVi_4wENH27I,347
+integration_tests/invalid_config.json,sha256=SudY8kGqvqyBULe1hYP46cIs8yKkLzTBEzVi_VNLvD8,161
+integration_tests/sample_config.json,sha256=uDZn5UrxyI_viuPhwIsldysAIOk5p4G0VF75hbsbEbs,154
+integration_tests/sample_state.json,sha256=DQ4W-RqAart9346ugzSN0d8hg87VK8Pi5BTaelkB9MI,82
+source_microsoft_dataverse/__init__.py,sha256=xy7FvZqZBBL0_I7mMd5ex5llLWTllG3HRt836ktTD7Q,148
+source_microsoft_dataverse/dataverse.py,sha256=HOQoA571fpy0Bxk4W9l3DttxX34sKkOjTWYeuwZ0uUA,2521
+source_microsoft_dataverse/run.py,sha256=hPGT5kR0LB6ZdKtLmwfLHymdF4EsDaFM2EC4J5ZAr3A,267
+source_microsoft_dataverse/source.py,sha256=7Z6f-FE9P2ycZlgdo5fVNYTlVKjKBiKqll3CMjp8IW4,4435
+source_microsoft_dataverse/spec.yaml,sha256=GmPlzh34HTII0aUW9XUbLxUk3VPEdvQ6E4iIKz4YMiA,1147
+source_microsoft_dataverse/streams.py,sha256=3PhAYr4kM2GjW4jPd-XGIwg0jqiECUyKUK9AJB9JQiw,6168
+unit_tests/__init__.py,sha256=4Hw-PX1-VgESLF16cDdvuYCzGJtHntThLF4qIiULWeo,61
+unit_tests/test_dataverse.py,sha256=yD1tuGjn_WcAFOcx-1Dp7SKTPfVQs_U0ANENd1fVyNE,525
+unit_tests/test_incremental_streams.py,sha256=gCr6fJb_b5U_iaQNRVGL0r5l0LM8GrKsIfj_Uz0pC90,3713
+unit_tests/test_source.py,sha256=yrVHvsNDgj5SPCG1T86j9Xa1Mb0HnIp-gG4xRGzY9wc,5019
+unit_tests/test_streams.py,sha256=jb4YG5e-V4KR2OZywE02KdRE92zQNENH5Q25zOUBsCs,3716
+airbyte_source_microsoft_dataverse-0.1.2.dist-info/METADATA,sha256=O2CwhyE4Q7pF6Gtv5oJz84cO8d9bNWoJKek5FMQijJA,5613
+airbyte_source_microsoft_dataverse-0.1.2.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
+airbyte_source_microsoft_dataverse-0.1.2.dist-info/entry_points.txt,sha256=uHN7NStTqslpZvvIOhjbOBOlLEmAQUFa6wj1zIxiazE,82
+airbyte_source_microsoft_dataverse-0.1.2.dist-info/top_level.txt,sha256=beuN6fxCEh7L4-h-9GvOc9cvtPyawVZBAhkxIAhs52c,56
+airbyte_source_microsoft_dataverse-0.1.2.dist-info/RECORD,,

airbyte_source_microsoft_dataverse-0.1.2.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: bdist_wheel (0.42.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

airbyte_source_microsoft_dataverse-0.1.2.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+source-microsoft-dataverse = source_microsoft_dataverse.run:run

airbyte_source_microsoft_dataverse-0.1.2.dist-info/top_level.txt

@@ -0,0 +1,3 @@
+integration_tests
+source_microsoft_dataverse
+unit_tests

integration_tests/__init__.py

@@ -0,0 +1,3 @@
+#
+# Copyright (c) 2023 Airbyte, Inc., all rights reserved.
+#

integration_tests/abnormal_state.json

@@ -0,0 +1,5 @@
+{
+  "<entity_name>": {
+    "$deltatoken": "12644418993!10/06/2050 20:06:12"
+  }
+}

integration_tests/acceptance.py

@@ -0,0 +1,16 @@
+#
+# Copyright (c) 2023 Airbyte, Inc., all rights reserved.
+#
+
+
+import pytest
+
+pytest_plugins = ("connector_acceptance_test.plugin",)
+
+
+@pytest.fixture(scope="session", autouse=True)
+def connector_setup():
+    """This fixture is a placeholder for external resources that acceptance test might require."""
+    # TODO: setup test dependencies if needed. otherwise remove the TODO comments
+    yield
+    # TODO: clean up test dependencies

integration_tests/configured_catalog.json

@@ -0,0 +1,15 @@
+{
+  "streams": [
+    {
+      "stream": {
+        "name": "<entity_name>",
+        "json_schema": {},
+        "supported_sync_modes": ["full_refresh", "incremental"]
+      },
+      "cursor_field": ["modifiedon"],
+      "primary_key": [["<entity_primary_key>"]],
+      "sync_mode": "incremental",
+      "destination_sync_mode": "append"
+    }
+  ]
+}

integration_tests/invalid_config.json

@@ -0,0 +1,7 @@
+{
+  "client_id": "<client_id>",
+  "tenant_id": "<tenant_id>",
+  "client_secret_value": "<invalid_client_secret>",
+  "url": "<url>",
+  "odata.maxpagesize": 100
+}

integration_tests/sample_config.json

@@ -0,0 +1,7 @@
+{
+  "url": "<url>",
+  "client_id": "<client_id>",
+  "tenant_id": "<tenant_id>",
+  "client_secret_value": "<client_secret>",
+  "odata_maxpagesize": 5000
+}

integration_tests/sample_state.json

@@ -0,0 +1,5 @@
+{
+  "<entity_name>": {
+    "$deltatoken": "12644418993!10/06/2022 20:06:12"
+  }
+}

source_microsoft_dataverse/__init__.py

@@ -0,0 +1,8 @@
+#
+# Copyright (c) 2023 Airbyte, Inc., all rights reserved.
+#
+
+
+from .source import SourceMicrosoftDataverse
+
+__all__ = ["SourceMicrosoftDataverse"]

source_microsoft_dataverse/dataverse.py

@@ -0,0 +1,80 @@
+#
+# Copyright (c) 2023 Airbyte, Inc., all rights reserved.
+#
+
+from enum import Enum
+from typing import Any, Mapping, MutableMapping, Optional
+
+import requests
+from airbyte_cdk.sources.streams.http.requests_native_auth.oauth import Oauth2Authenticator
+
+
+class MicrosoftOauth2Authenticator(Oauth2Authenticator):
+    def build_refresh_request_body(self) -> Mapping[str, Any]:
+        """
+        Returns the request body to set on the refresh request
+        """
+        payload: MutableMapping[str, Any] = {
+            "grant_type": "client_credentials",
+            "client_id": self.get_client_id(),
+            "client_secret": self.get_client_secret(),
+            "scope": self.get_scopes(),
+        }
+
+        return payload
+
+
+class AirbyteType(Enum):
+
+    String = {"type": ["null", "string"]}
+    Boolean = {"type": ["null", "boolean"]}
+    Timestamp = {"type": ["null", "string"], "format": "date-time", "airbyte_type": "timestamp_with_timezone"}
+    Integer = {"type": ["null", "integer"]}
+    Number = {"type": ["null", "number"]}
+
+
+class DataverseType(Enum):
+
+    String = AirbyteType.String
+    Uniqueidentifier = AirbyteType.String
+    DateTime = AirbyteType.Timestamp
+    Integer = AirbyteType.Integer
+    BigInt = AirbyteType.Integer
+    Money = AirbyteType.Number
+    Boolean = AirbyteType.Boolean
+    Double = AirbyteType.Number
+    Decimal = AirbyteType.Number
+    Status = AirbyteType.Integer
+    State = AirbyteType.Integer
+    Picklist = AirbyteType.Integer
+    Lookup = AirbyteType.String
+    Virtual = None
+
+
+def get_auth(config: Mapping[str, Any]) -> MicrosoftOauth2Authenticator:
+    return MicrosoftOauth2Authenticator(
+        token_refresh_endpoint=f'https://login.microsoftonline.com/{config["tenant_id"]}/oauth2/v2.0/token',
+        client_id=config["client_id"],
+        client_secret=config["client_secret_value"],
+        scopes=[f'{config["url"]}/.default'],
+        refresh_token="",
+    )
+
+
+def do_request(config: Mapping[str, Any], path: str):
+    auth = get_auth(config)
+    headers = auth.get_auth_header()
+    # Call a protected API with the access token.
+    return requests.get(
+        config["url"] + "/api/data/v9.2/" + path,
+        headers=headers,
+    )
+
+
+def convert_dataverse_type(dataverse_type: str) -> Optional[dict]:
+    if dataverse_type in DataverseType.__members__:
+        enum_type = DataverseType[dataverse_type]
+        if enum_type:
+            return enum_type.value if enum_type.value is None else enum_type.value.value
+
+    return AirbyteType.String.value

source_microsoft_dataverse/run.py

@@ -0,0 +1,14 @@
+#
+# Copyright (c) 2023 Airbyte, Inc., all rights reserved.
+#
+
+
+import sys
+
+from airbyte_cdk.entrypoint import launch
+from source_microsoft_dataverse import SourceMicrosoftDataverse
+
+
+def run():
+    source = SourceMicrosoftDataverse()
+    launch(source, sys.argv[1:])

source_microsoft_dataverse/source.py

@@ -0,0 +1,102 @@
+#
+# Copyright (c) 2023 Airbyte, Inc., all rights reserved.
+#
+
+import logging
+from typing import Any, Iterator, List, Mapping, MutableMapping, Tuple, Union
+
+from airbyte_cdk.models import AirbyteCatalog, AirbyteMessage, AirbyteStateMessage, AirbyteStream, ConfiguredAirbyteCatalog, SyncMode
+from airbyte_cdk.sources import AbstractSource
+from airbyte_cdk.sources.streams import Stream
+
+from .dataverse import convert_dataverse_type, do_request, get_auth
+from .streams import IncrementalMicrosoftDataverseStream, MicrosoftDataverseStream
+
+
+class SourceMicrosoftDataverse(AbstractSource):
+    def __init__(self):
+        self.catalogs = None
+
+    def discover(self, logger: logging.Logger, config: Mapping[str, Any]) -> AirbyteCatalog:
+        response = do_request(config, "EntityDefinitions?$expand=Attributes")
+        response_json = response.json()
+        streams = []
+        for entity in response_json["value"]:
+            schema = {"properties": {}}
+            for attribute in entity["Attributes"]:
+                dataverse_type = attribute["AttributeType"]
+                if dataverse_type == "Lookup":
+                    attribute["LogicalName"] = "_" + attribute["LogicalName"] + "_value"
+                attribute_type = convert_dataverse_type(dataverse_type)
+
+                if not attribute_type:
+                    continue
+
+                schema["properties"][attribute["LogicalName"]] = attribute_type
+
+            if entity["CanChangeTrackingBeEnabled"]["Value"] and entity["ChangeTrackingEnabled"]:
+                schema["properties"].update({"_ab_cdc_updated_at": {"type": "string"}, "_ab_cdc_deleted_at": {"type": ["null", "string"]}})
+                stream = AirbyteStream(
+                    name=entity["LogicalName"], json_schema=schema, supported_sync_modes=[SyncMode.full_refresh, SyncMode.incremental]
+                )
+                if "modifiedon" in schema["properties"]:
+                    stream.source_defined_cursor = True
+                    stream.default_cursor_field = ["modifiedon"]
+            else:
+                stream = AirbyteStream(name=entity["LogicalName"], json_schema=schema, supported_sync_modes=[SyncMode.full_refresh])
+
+            stream.source_defined_primary_key = [[entity["PrimaryIdAttribute"]]]
+            streams.append(stream)
+        return AirbyteCatalog(streams=streams)
+
+    def check_connection(self, logger, config) -> Tuple[bool, any]:
+        """
+        :param config:  the user-input config object conforming to the connector's spec.yaml
+        :param logger:  logger object
+        :return Tuple[bool, any]: (True, None) if the input config can be used to connect to the API successfully, (False, error) otherwise.
+        """
+        try:
+            response = do_request(config, "")
+            # Raises an exception for error codes (4xx or 5xx)
+            response.raise_for_status()
+            return True, None
+        except Exception as e:
+            return False, e
+
+    def read(
+        self,
+        logger: logging.Logger,
+        config: Mapping[str, Any],
+        catalog: ConfiguredAirbyteCatalog,
+        state: Union[List[AirbyteStateMessage], MutableMapping[str, Any]] = None,
+    ) -> Iterator[AirbyteMessage]:
+        self.catalogs = catalog
+        return super().read(logger, config, catalog, state)
+
+    def streams(self, config: Mapping[str, Any]) -> List[Stream]:
+        """
+        :param config: A Mapping of the user input configuration as defined in the connector spec.
+        """
+        auth = get_auth(config)
+
+        streams = []
+        for catalog in self.catalogs.streams:
+            response = do_request(config, f"EntityDefinitions(LogicalName='{catalog.stream.name}')")
+            response_json = response.json()
+
+            args = {
+                "url": config["url"],
+                "stream_name": catalog.stream.name,
+                "stream_path": response_json["EntitySetName"],
+                "primary_key": catalog.primary_key,
+                "schema": catalog.stream.json_schema,
+                "odata_maxpagesize": config["odata_maxpagesize"],
+                "authenticator": auth,
+            }
+
+            if catalog.sync_mode == SyncMode.incremental:
+                streams.append(IncrementalMicrosoftDataverseStream(**args, config_cursor_field=catalog.cursor_field))
+            else:
+                streams.append(MicrosoftDataverseStream(**args))
+
+        return streams

source_microsoft_dataverse/spec.yaml

@@ -0,0 +1,47 @@
+documentationUrl: https://docs.airbyte.io/integrations/sources/microsoft-dataverse
+connectionSpecification:
+  $schema: http://json-schema.org/draft-07/schema#
+  title: Microsoft Dataverse Spec
+  type: object
+  required:
+    - url
+    - tenant_id
+    - client_id
+    - client_secret_value
+  additionalProperties: true
+  properties:
+    url:
+      type: string
+      description: URL to Microsoft Dataverse API
+      title: URL
+      examples:
+        - https://<org-id>.crm.dynamics.com
+      order: 0
+
+    tenant_id:
+      type: string
+      description: Tenant Id of your Microsoft Dataverse Instance
+      title: Tenant Id
+      airbyte_secret: true
+      order: 1
+
+    client_id:
+      type: string
+      description: App Registration Client Id
+      title: Client Id
+      airbyte_secret: true
+      order: 2
+
+    client_secret_value:
+      type: string
+      description: App Registration Client Secret
+      title: Client Secret
+      airbyte_secret: true
+      order: 3
+
+    odata_maxpagesize:
+      type: integer
+      description: Max number of results per page. Default=5000
+      title: Max page size
+      default: 5000
+      order: 4

source_microsoft_dataverse/streams.py

@@ -0,0 +1,152 @@
+#
+# Copyright (c) 2023 Airbyte, Inc., all rights reserved.
+#
+
+from abc import ABC
+from datetime import datetime
+from typing import Any, Iterable, Mapping, MutableMapping, Optional
+from urllib import parse
+
+import requests
+from airbyte_cdk.sources.streams import IncrementalMixin
+from airbyte_cdk.sources.streams.http import HttpStream
+
+
+# Basic full refresh stream
+class MicrosoftDataverseStream(HttpStream, ABC):
+
+    # Base url will be set by init(), using information provided by the user through config input
+    url_base = ""
+    primary_key = ""
+
+    def __init__(self, url, stream_name, stream_path, schema, primary_key, odata_maxpagesize, **kwargs):
+        super().__init__(**kwargs)
+        self.url_base = url + "/api/data/v9.2/"
+        self.stream_name = stream_name
+        self.stream_path = stream_path
+        self.primary_key = primary_key
+        self.schema = schema
+        self.odata_maxpagesize = odata_maxpagesize
+
+    @property
+    def name(self) -> str:
+        """Source name"""
+        return self.stream_name
+
+    def get_json_schema(self) -> Mapping[str, Any]:
+        return self.schema
+
+    def next_page_token(self, response: requests.Response) -> Optional[Mapping[str, Any]]:
+        """
+        :param response: the most recent response from the API
+        :return If there is another page in the result, a mapping (e.g: dict) containing information needed to query the next page in the response.
+                If there are no more pages in the result, return None.
+        """
+
+        response_json = response.json()
+
+        if "@odata.nextLink" in response_json:
+            next_link = response_json["@odata.nextLink"]
+            next_link_params = dict(parse.parse_qsl(parse.urlsplit(next_link).query))
+            return next_link_params
+        else:
+            return None
+
+    def request_params(
+        self, stream_state: Mapping[str, Any], stream_slice: Mapping[str, any] = None, next_page_token: Mapping[str, Any] = None
+    ) -> MutableMapping[str, Any]:
+        """
+        :return a dict containing the parameters to be used in the request
+        """
+        request_params = super().request_params(stream_state)
+        # If there is not a nextLink(contains "next_page_token") in the response, means it is the last page.
+        # In this case, the deltatoken is passed instead.
+        if next_page_token is None:
+            request_params.update(stream_state)
+            return request_params
+        elif next_page_token is not None:
+            request_params.update(next_page_token)
+            return request_params
+
+    def parse_response(self, response: requests.Response, **kwargs) -> Iterable[Mapping]:
+        """
+        :return an iterable containing each record in the response
+        """
+        for result in response.json()["value"]:
+            yield result
+
+    def request_headers(
+        self, stream_state: Mapping[str, Any], stream_slice: Mapping[str, Any] = None, next_page_token: Mapping[str, Any] = None
+    ) -> Mapping[str, Any]:
+        return {
+            "Cache-Control": "no-cache",
+            "OData-Version": "4.0",
+            "Content-Type": "application/json",
+            "Prefer": "odata.maxpagesize=" + str(self.odata_maxpagesize),
+        }
+
+    def path(
+        self,
+        *,
+        stream_state: Mapping[str, Any] = None,
+        stream_slice: Mapping[str, Any] = None,
+        next_page_token: Mapping[str, Any] = None,
+    ) -> str:
+        return self.stream_path
+
+
+# Basic incremental stream
+class IncrementalMicrosoftDataverseStream(MicrosoftDataverseStream, IncrementalMixin, ABC):
+
+    delta_token_field = "$deltatoken"
+    state_checkpoint_interval = None  # For now we just use the change tracking as state, and it is only emitted on last page
+
+    def __init__(self, url, stream_name, stream_path, schema, primary_key, odata_maxpagesize, config_cursor_field, **kwargs):
+        super().__init__(url, stream_name, stream_path, schema, primary_key, odata_maxpagesize, **kwargs)
+        self._cursor_value = None
+        self.config_cursor_field = config_cursor_field
+
+    @property
+    def state(self) -> Mapping[str, Any]:
+        return {self.delta_token_field: str(self._cursor_value)}
+
+    @property
+    def cursor_field(self) -> str:
+        return self.config_cursor_field
+
+    # Sets the state got by state getter. "value" is the return of state getter -> dict
+    @state.setter
+    def state(self, value: Mapping[str, Any]):
+        self._cursor_value = value[self.delta_token_field]
+
+    def request_headers(
+        self, stream_state: Mapping[str, Any], stream_slice: Mapping[str, Any] = None, next_page_token: Mapping[str, Any] = None
+    ) -> Mapping[str, Any]:
+        """
+        Override to return any non-auth headers. Authentication headers will overwrite any overlapping headers returned from this method.
+        """
+        request_headers = super().request_headers(stream_state=stream_state)
+        request_headers.update(
+            {"Prefer": "odata.track-changes," + request_headers["Prefer"]}
+        )  # odata.track-changes -> Header that enables change tracking
+        return request_headers
+
+    def parse_response(self, response: requests.Response, **kwargs) -> Iterable[Mapping]:
+        response_json = response.json()
+        if "@odata.deltaLink" in response_json:
+            delta_link = response_json["@odata.deltaLink"]
+            delta_link_params = dict(parse.parse_qsl(parse.urlsplit(delta_link).query))
+            self._cursor_value = delta_link_params[self.delta_token_field]
+        for result in response_json["value"]:
+            if "@odata.context" in result and result["reason"] == "deleted":
+                result.update({self.primary_key[0][0]: result["id"]})
+                result.pop("@odata.context", None)
+                result.pop("id", None)
+                result.pop("reason", None)
+                now = datetime.now().isoformat()
+                result.update({self.cursor_field[0]: now})
+                result.update({"_ab_cdc_deleted_at": now})
+            else:
+                result.update({"_ab_cdc_updated_at": result[self.cursor_field[0]]})
+
+            yield result

unit_tests/__init__.py

@@ -0,0 +1,3 @@
+#
+# Copyright (c) 2023 Airbyte, Inc., all rights reserved.
+#

unit_tests/test_dataverse.py

@@ -0,0 +1,15 @@
+#
+# Copyright (c) 2023 Airbyte, Inc., all rights reserved.
+#
+
+import pytest
+from source_microsoft_dataverse.dataverse import AirbyteType, convert_dataverse_type
+
+
+@pytest.mark.parametrize(
+    "dataverse_type,expected_result",
+    [("String", AirbyteType.String.value), ("Integer", AirbyteType.Integer.value), ("Virtual", None), ("Random", AirbyteType.String.value)],
+)
+def test_convert_dataverse_type(dataverse_type, expected_result):
+    result = convert_dataverse_type(dataverse_type)
+    assert result == expected_result

unit_tests/test_incremental_streams.py

@@ -0,0 +1,101 @@
+#
+# Copyright (c) 2023 Airbyte, Inc., all rights reserved.
+#
+
+from unittest.mock import MagicMock
+
+from pytest import fixture
+from source_microsoft_dataverse.source import IncrementalMicrosoftDataverseStream
+
+
+@fixture
+def incremental_config():
+    return {
+        "url": "http://test-url",
+        "stream_name": "test_stream",
+        "stream_path": "test_path",
+        "primary_key": [["test_primary_key"]],
+        "schema": {},
+        "odata_maxpagesize": 100,
+        "config_cursor_field": ["test_cursor_field"],
+        "authenticator": MagicMock(),
+    }
+
+
+@fixture
+def incremental_response(incremental_config):
+    return {
+        "@odata.deltaLink": f"{incremental_config['url']}?$deltatoken=12644418993%2110%2F06%2F2022%2020%3A06%3A12",
+        "value": [
+            {"test_primary_key": "pk", "test_cursor_field": "test-date"},
+            {"id": "pk2", "@odata.context": "context", "reason": "deleted"},
+        ],
+    }
+
+
+def test_primary_key(incremental_config):
+    stream = IncrementalMicrosoftDataverseStream(**incremental_config)
+    expected_primary_key = [["test_primary_key"]]
+    assert stream.primary_key == expected_primary_key
+
+
+def test_stream_name(incremental_config):
+    stream = IncrementalMicrosoftDataverseStream(**incremental_config)
+    expected_stream_name = "test_stream"
+    assert stream.name == expected_stream_name
+
+
+def test_stream_path(incremental_config):
+    stream = IncrementalMicrosoftDataverseStream(**incremental_config)
+    expected_stream_path = "test_path"
+    assert stream.path() == expected_stream_path
+
+
+def test_cursor_field(incremental_config):
+    stream = IncrementalMicrosoftDataverseStream(**incremental_config)
+    expected_cursor_field = ["test_cursor_field"]
+    assert stream.cursor_field == expected_cursor_field
+
+
+def test_supports_incremental(incremental_config, mocker):
+    mocker.patch.object(IncrementalMicrosoftDataverseStream, "cursor_field", "dummy_field")
+    stream = IncrementalMicrosoftDataverseStream(**incremental_config)
+    assert stream.supports_incremental
+
+
+def test_source_defined_cursor(incremental_config):
+    stream = IncrementalMicrosoftDataverseStream(**incremental_config)
+    assert stream.source_defined_cursor
+
+
+def test_stream_checkpoint_interval(incremental_config):
+    stream = IncrementalMicrosoftDataverseStream(**incremental_config)
+    expected_checkpoint_interval = None
+    assert stream.state_checkpoint_interval == expected_checkpoint_interval
+
+
+def test_parse_request(incremental_config, incremental_response, mocker):
+    response_mock, datetime_mock = MagicMock(), MagicMock()
+    response_mock.json.return_value = incremental_response
+    datetime_mock.now.return_value.isoformat.return_value = "test-time"
+    mocker.patch("source_microsoft_dataverse.streams.datetime", datetime_mock)
+
+    stream = IncrementalMicrosoftDataverseStream(**incremental_config)
+
+    iterable = stream.parse_response(response_mock)
+    iterable_list = list(iterable)
+    assert len(iterable_list) == 2
+    assert stream.state[stream.delta_token_field] == "12644418993!10/06/2022 20:06:12"
+    assert iterable_list[0]["_ab_cdc_updated_at"] == "test-date"
+    assert iterable_list[1]["_ab_cdc_deleted_at"] == "test-time"
+    assert iterable_list[1][incremental_config["primary_key"][0][0]] == "pk2"
+    assert "id" not in iterable_list[1]
+    assert "reason" not in iterable_list[1]
+    assert "@odata.context" not in iterable_list[1]
+
+
+def test_request_headers(incremental_config):
+    stream = IncrementalMicrosoftDataverseStream(**incremental_config)
+    headers = stream.request_headers(stream_state={})
+    assert "Prefer" in headers
+    assert headers["Prefer"] == "odata.track-changes,odata.maxpagesize=100"

unit_tests/test_source.py

@@ -0,0 +1,148 @@
+#
+# Copyright (c) 2023 Airbyte, Inc., all rights reserved.
+#
+
+import json
+from unittest import mock
+from unittest.mock import MagicMock
+
+from airbyte_cdk.models import SyncMode
+from source_microsoft_dataverse.dataverse import AirbyteType
+from source_microsoft_dataverse.source import SourceMicrosoftDataverse
+from source_microsoft_dataverse.streams import IncrementalMicrosoftDataverseStream, MicrosoftDataverseStream
+
+
+@mock.patch("source_microsoft_dataverse.source.do_request")
+def test_check_connection(mock_request):
+    mock_request.return_value.raise_for_status = lambda: ()
+    source = SourceMicrosoftDataverse()
+    logger_mock, config_mock = MagicMock(), MagicMock()
+    assert source.check_connection(logger_mock, config_mock) == (True, None)
+
+
+@mock.patch("source_microsoft_dataverse.source.get_auth")
+@mock.patch("source_microsoft_dataverse.source.do_request")
+def test_streams_incremental(mock_get_auth, mock_request):
+    streams = MagicMock()
+    streams.sync_mode = SyncMode.incremental
+    streams.stream.name = "test"
+
+    catalog = MagicMock()
+
+    catalog.streams = [streams]
+
+    config_mock = MagicMock()
+    source = SourceMicrosoftDataverse()
+    source.catalogs = catalog
+
+    streams = source.streams(config_mock)
+
+    expected_streams_number = 1
+    assert len(streams) == expected_streams_number
+    assert isinstance(streams[0], IncrementalMicrosoftDataverseStream)
+    assert streams[0].name == "test"
+
+
+@mock.patch("source_microsoft_dataverse.source.get_auth")
+@mock.patch("source_microsoft_dataverse.source.do_request")
+def test_streams_full_refresh(mock_get_auth, mock_request):
+    streams = MagicMock()
+    streams.sync_mode = SyncMode.full_refresh
+    streams.stream.name = "test"
+
+    catalog = MagicMock()
+
+    catalog.streams = [streams]
+
+    config_mock = MagicMock()
+    source = SourceMicrosoftDataverse()
+    source.catalogs = catalog
+
+    streams = source.streams(config_mock)
+
+    expected_streams_number = 1
+    assert len(streams) == expected_streams_number
+    assert isinstance(streams[0], MicrosoftDataverseStream)
+    assert streams[0].name == "test"
+
+
+@mock.patch("source_microsoft_dataverse.source.do_request")
+def test_discover_incremental(mock_request):
+    result_json = json.loads(
+        """
+        {
+            "value": [
+                {
+                    "LogicalName": "stream",
+                    "PrimaryIdAttribute": "primary",
+                    "ChangeTrackingEnabled": true,
+                    "CanChangeTrackingBeEnabled": {
+                        "Value": true
+                    },
+                    "Attributes": [
+                        {
+                            "LogicalName": "test",
+                            "AttributeType": "String"
+                        },
+                        {
+                            "LogicalName": "modifiedon",
+                            "AttributeType": "DateTime"
+                        }
+                    ]
+                }
+            ]
+        }
+    """
+    )
+
+    mock_request.return_value.status.return_value = 200
+    mock_request.return_value.json.return_value = result_json
+
+    source = SourceMicrosoftDataverse()
+    logger_mock, config_mock = MagicMock(), MagicMock()
+
+    catalog = source.discover(logger_mock, config_mock)
+
+    assert not {"modifiedon"} ^ set(catalog.streams[0].default_cursor_field)
+    assert not {SyncMode.full_refresh, SyncMode.incremental} ^ set(catalog.streams[0].supported_sync_modes)
+    assert not {"primary"} ^ set(catalog.streams[0].source_defined_primary_key[0])
+    assert catalog.streams[0].json_schema["properties"]["test"] == AirbyteType.String.value
+
+
+@mock.patch("source_microsoft_dataverse.source.do_request")
+def test_discover_full_refresh(mock_request):
+    result_json = json.loads(
+        """
+        {
+            "value": [
+                {
+                    "LogicalName": "stream",
+                    "PrimaryIdAttribute": "primary",
+                    "ChangeTrackingEnabled": false,
+                    "CanChangeTrackingBeEnabled": {
+                        "Value": false
+                    },
+                    "Attributes": [
+                        {
+                            "LogicalName": "test",
+                            "AttributeType": "String"
+                        }
+                    ]
+                }
+            ]
+        }
+    """
+    )
+
+    mock_request.return_value.status.return_value = 200
+    mock_request.return_value.json.return_value = result_json
+
+    source = SourceMicrosoftDataverse()
+    logger_mock, config_mock = MagicMock(), MagicMock()
+
+    catalog = source.discover(logger_mock, config_mock)
+
+    assert catalog.streams[0].default_cursor_field is None or len(catalog.streams[0].default_cursor_field) == 0
+    assert not {SyncMode.full_refresh} ^ set(catalog.streams[0].supported_sync_modes)
+    assert not {"primary"} ^ set(catalog.streams[0].source_defined_primary_key[0])
+    assert catalog.streams[0].json_schema["properties"]["test"] == AirbyteType.String.value

unit_tests/test_streams.py

@@ -0,0 +1,107 @@
+#
+# Copyright (c) 2023 Airbyte, Inc., all rights reserved.
+#
+
+from http import HTTPStatus
+from unittest.mock import MagicMock
+
+import pytest
+from pytest import fixture
+from source_microsoft_dataverse.source import MicrosoftDataverseStream
+
+
+@fixture
+def incremental_config():
+    return {
+        "url": "http://test-url",
+        "stream_name": "test_stream",
+        "stream_path": "test_path",
+        "primary_key": [["test_primary_key"]],
+        "schema": {},
+        "odata_maxpagesize": 100,
+        "authenticator": MagicMock(),
+    }
+
+
+@pytest.mark.parametrize(
+    ("inputs", "expected_params"),
+    [
+        ({"stream_slice": None, "stream_state": {}, "next_page_token": None}, {}),
+        ({"stream_slice": None, "stream_state": {}, "next_page_token": {"$skiptoken": "skiptoken"}}, {"$skiptoken": "skiptoken"}),
+        ({"stream_slice": None, "stream_state": {"$deltatoken": "delta"}, "next_page_token": None}, {"$deltatoken": "delta"}),
+    ],
+)
+def test_request_params(inputs, expected_params, incremental_config):
+    stream = MicrosoftDataverseStream(**incremental_config)
+    assert stream.request_params(**inputs) == expected_params
+
+
+@pytest.mark.parametrize(
+    ("response_json", "next_page_token"),
+    [
+        (
+            {
+                "@odata.nextLink": "https://url?$skiptoken=oEBwdSP6uehIAxQOWq_3Ksh_TLol6KIm3stvdc6hGhZRi1hQ7Spe__dpvm3U4zReE4CYXC2zOtaKdi7KHlUtC2CbRiBIUwOxPKLa"
+            },
+            {"$skiptoken": "oEBwdSP6uehIAxQOWq_3Ksh_TLol6KIm3stvdc6hGhZRi1hQ7Spe__dpvm3U4zReE4CYXC2zOtaKdi7KHlUtC2CbRiBIUwOxPKLa"},
+        ),
+        ({"value": []}, None),
+    ],
+)
+def test_next_page_token(response_json, next_page_token, incremental_config):
+    stream = MicrosoftDataverseStream(**incremental_config)
+    response = MagicMock()
+    response.json.return_value = response_json
+    inputs = {"response": response}
+    expected_token = next_page_token
+    assert stream.next_page_token(**inputs) == expected_token
+
+
+def test_parse_response(incremental_config):
+    stream = MicrosoftDataverseStream(**incremental_config)
+    response = MagicMock()
+    response.json.return_value = {"value": [{"test-key": "test-value"}]}
+    inputs = {"response": response}
+    expected_parsed_object = {"test-key": "test-value"}
+    assert next(stream.parse_response(**inputs)) == expected_parsed_object
+
+
+def test_request_headers(incremental_config):
+    stream = MicrosoftDataverseStream(**incremental_config)
+    inputs = {"stream_slice": None, "stream_state": None, "next_page_token": None}
+    expected_headers = {
+        "Cache-Control": "no-cache",
+        "OData-Version": "4.0",
+        "Content-Type": "application/json",
+        "Prefer": "odata.maxpagesize=100",
+    }
+    assert stream.request_headers(**inputs) == expected_headers
+
+
+def test_http_method(incremental_config):
+    stream = MicrosoftDataverseStream(**incremental_config)
+    expected_method = "GET"
+    assert stream.http_method == expected_method
+
+
+@pytest.mark.parametrize(
+    ("http_status", "should_retry"),
+    [
+        (HTTPStatus.OK, False),
+        (HTTPStatus.BAD_REQUEST, False),
+        (HTTPStatus.TOO_MANY_REQUESTS, True),
+        (HTTPStatus.INTERNAL_SERVER_ERROR, True),
+    ],
+)
+def test_should_retry(incremental_config, http_status, should_retry):
+    response_mock = MagicMock()
+    response_mock.status_code = http_status
+    stream = MicrosoftDataverseStream(**incremental_config)
+    assert stream.should_retry(response_mock) == should_retry
+
+
+def test_backoff_time(incremental_config):
+    response_mock = MagicMock()
+    stream = MicrosoftDataverseStream(**incremental_config)
+    expected_backoff_time = None
+    assert stream.backoff_time(response_mock) == expected_backoff_time