airbyte_cdk.connector

  1#
  2# Copyright (c) 2023 Airbyte, Inc., all rights reserved.
  3#
  4
  5
  6import json
  7import logging
  8import os
  9import pkgutil
 10from abc import ABC, abstractmethod
 11from typing import Any, Generic, Mapping, Optional, Protocol, TypeVar
 12
 13import yaml
 14
 15from airbyte_cdk.models import (
 16    AirbyteConnectionStatus,
 17    ConnectorSpecification,
 18    ConnectorSpecificationSerializer,
 19)
 20
 21
 22def load_optional_package_file(package: str, filename: str) -> Optional[bytes]:
 23    """Gets a resource from a package, returning None if it does not exist"""
 24    try:
 25        return pkgutil.get_data(package, filename)
 26    except FileNotFoundError:
 27        return None
 28
 29
 30TConfig = TypeVar("TConfig", bound=Mapping[str, Any])
 31
 32
 33class BaseConnector(ABC, Generic[TConfig]):
 34    # configure whether the `check_config_against_spec_or_exit()` needs to be called
 35    check_config_against_spec: bool = True
 36
 37    @abstractmethod
 38    def configure(self, config: Mapping[str, Any], temp_dir: str) -> TConfig:
 39        """
 40        Persist config in temporary directory to run the Source job
 41        """
 42
 43    @staticmethod
 44    def read_config(config_path: str) -> Mapping[str, Any]:
 45        config = BaseConnector._read_json_file(config_path)
 46        if isinstance(config, Mapping):
 47            return config
 48        else:
 49            raise ValueError(
 50                f"The content of {config_path} is not an object and therefore is not a valid config. Please ensure the file represent a config."
 51            )
 52
 53    @staticmethod
 54    def _read_json_file(file_path: str) -> Any:
 55        with open(file_path, "r") as file:
 56            contents = file.read()
 57
 58        try:
 59            return json.loads(contents)
 60        except json.JSONDecodeError as error:
 61            raise ValueError(
 62                f"Could not read json file {file_path}: {error}. Please ensure that it is a valid JSON."
 63            )
 64
 65    @staticmethod
 66    def write_config(config: TConfig, config_path: str) -> None:
 67        with open(config_path, "w") as fh:
 68            fh.write(json.dumps(config))
 69
 70    def spec(self, logger: logging.Logger) -> ConnectorSpecification:
 71        """
 72        Returns the spec for this integration. The spec is a JSON-Schema object describing the required configurations (e.g: username and password)
 73        required to run this integration. By default, this will be loaded from a "spec.yaml" or a "spec.json" in the package root.
 74        """
 75
 76        package = self.__class__.__module__.split(".")[0]
 77
 78        yaml_spec = load_optional_package_file(package, "spec.yaml")
 79        json_spec = load_optional_package_file(package, "spec.json")
 80
 81        if yaml_spec and json_spec:
 82            raise RuntimeError(
 83                "Found multiple spec files in the package. Only one of spec.yaml or spec.json should be provided."
 84            )
 85
 86        if yaml_spec:
 87            spec_obj = yaml.load(yaml_spec, Loader=yaml.SafeLoader)
 88        elif json_spec:
 89            try:
 90                spec_obj = json.loads(json_spec)
 91            except json.JSONDecodeError as error:
 92                raise ValueError(
 93                    f"Could not read json spec file: {error}. Please ensure that it is a valid JSON."
 94                )
 95        else:
 96            raise FileNotFoundError("Unable to find spec.yaml or spec.json in the package.")
 97
 98        return ConnectorSpecificationSerializer.load(spec_obj)
 99
100    @abstractmethod
101    def check(self, logger: logging.Logger, config: TConfig) -> AirbyteConnectionStatus:
102        """
103        Tests if the input configuration can be used to successfully connect to the integration e.g: if a provided Stripe API token can be used to connect
104        to the Stripe API.
105        """
106
107
108class _WriteConfigProtocol(Protocol):
109    @staticmethod
110    def write_config(config: Mapping[str, Any], config_path: str) -> None: ...
111
112
113class DefaultConnectorMixin:
114    # can be overridden to change an input config
115    def configure(
116        self: _WriteConfigProtocol, config: Mapping[str, Any], temp_dir: str
117    ) -> Mapping[str, Any]:
118        config_path = os.path.join(temp_dir, "config.json")
119        self.write_config(config, config_path)
120        return config
121
122
123class Connector(DefaultConnectorMixin, BaseConnector[Mapping[str, Any]], ABC): ...