✨Source Klarna: Migrate Python CDK to Low-code CDK (#31003)

Co-authored-by: Marcos Marx <marcosmarxm@users.noreply.github.com> Co-authored-by: marcosmarxm <marcosmarxm@gmail.com>
airbytehq · Oct 23, 2023 · dcfa331 · dcfa331
1 parent 6ff299e
commit dcfa331
Show file tree

Hide file tree

Showing 16 changed files with 178 additions and 367 deletions.
diff --git a/airbyte-integrations/connectors/source-klarna/Dockerfile b/airbyte-integrations/connectors/source-klarna/Dockerfile
@@ -1,4 +1,4 @@
-FROM python:3.9.13-alpine3.15 as base
+FROM python:3.9.11-alpine3.15 as base
 
 # build and load all requirements
 FROM base as builder
@@ -34,5 +34,5 @@ COPY source_klarna ./source_klarna
 ENV AIRBYTE_ENTRYPOINT "python /airbyte/integration_code/main.py"
 ENTRYPOINT ["python", "/airbyte/integration_code/main.py"]
 
-LABEL io.airbyte.version=0.1.0
+LABEL io.airbyte.version=0.2.0
 LABEL io.airbyte.name=airbyte/source-klarna
diff --git a/airbyte-integrations/connectors/source-klarna/README.md b/airbyte-integrations/connectors/source-klarna/README.md
@@ -1,35 +1,10 @@
 # Klarna Source
 
-This is the repository for the Klarna source connector, written in Python.
-For information about how to use this connector within Airbyte, see [the documentation](https://docs.airbyte.io/integrations/sources/klarna).
+This is the repository for the Klarna configuration based source connector.
+For information about how to use this connector within Airbyte, see [the documentation](https://docs.airbyte.com/integrations/sources/klarna).
 
 ## Local development
 
-### Prerequisites
-**To iterate on this connector, make sure to complete this prerequisites section.**
-
-#### Minimum Python version required `= 3.9.0`
-
-#### Build & Activate Virtual Environment and install dependencies
-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.
-
 #### Building via Gradle
 You can also build the connector in Gradle. This is typically used in CI and not needed for your development workflow.
 
@@ -39,22 +14,14 @@ To build using Gradle, from the Airbyte repository root, run:
 ```
 
 #### Create credentials
-**If you are a community contributor**, follow the instructions in the [documentation](https://docs.airbyte.io/integrations/sources/klarna)
+**If you are a community contributor**, follow the instructions in the [documentation](https://docs.airbyte.com/integrations/sources/klarna)
 to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `source_klarna/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 klarna test creds`
 and place them into `secrets/config.json`.
 
-### Locally running the connector
-```
-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
-```
-
 ### Locally running the connector docker image
 
 #### Build
@@ -79,32 +46,15 @@ docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-klarna:dev discover --
 docker run --rm -v $(pwd)/secrets:/secrets -v $(pwd)/integration_tests:/integration_tests airbyte/source-klarna:dev read --config /secrets/config.json --catalog /integration_tests/configured_catalog.json
 ```
 ## Testing
-Make sure to familiarize yourself with [pytest test discovery](https://docs.pytest.org/en/latest/goodpractices.html#test-discovery) to know how your test files and methods should be named.
-First install test dependencies into your virtual environment:
-```
-pip install .[tests]
-```
-### Unit Tests
-To run unit tests locally, from the connector directory run:
-```
-python -m pytest unit_tests
-```
 
-### Integration Tests
-There are two types of integration tests: Acceptance Tests (Airbyte's test suite for all source connectors) and custom integration tests (which are specific to this connector).
-#### Custom Integration tests
-Place custom tests inside `integration_tests/` folder, then, from the connector root, run
-```
-python -m pytest integration_tests
-```
 #### Acceptance Tests
-Customize `acceptance-test-config.yml` file to configure tests. See [Connector Acceptance Tests](https://docs.airbyte.io/connector-development/testing-connectors/connector-acceptance-tests-reference) for more information.
+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.
-To run your integration tests with acceptance tests, from the connector root, run
+
+To run your integration tests with Docker, run:
 ```
-python -m pytest integration_tests -p integration_tests.acceptance
+./acceptance-test-docker.sh
 ```
-To run your integration tests with docker
 
 ### Using gradle to run tests
 All commands should be run from airbyte project root.

diff --git a/...tors/source-klarna/unit_tests/__init__.py → ...ions/connectors/source-klarna/__init__.py b/...tors/source-klarna/unit_tests/__init__.py → ...ions/connectors/source-klarna/__init__.py
diff --git a/airbyte-integrations/connectors/source-klarna/acceptance-test-docker.sh b/airbyte-integrations/connectors/source-klarna/acceptance-test-docker.sh
@@ -1,2 +1,3 @@
 #!/usr/bin/env sh
+
 source "$(git rev-parse --show-toplevel)/airbyte-integrations/bases/connector-acceptance-test/acceptance-test-docker.sh"
diff --git a/airbyte-integrations/connectors/source-klarna/integration_tests/acceptance.py b/airbyte-integrations/connectors/source-klarna/integration_tests/acceptance.py
@@ -11,4 +11,6 @@
 @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
diff --git a/airbyte-integrations/connectors/source-klarna/metadata.yaml b/airbyte-integrations/connectors/source-klarna/metadata.yaml
@@ -1,24 +1,31 @@
 data:
+  allowedHosts:
+    hosts:
+      - api.klarna.com
+      - api.playground.klarna.com
+      - api-${config.region}.klarna.com
+      - api-${config.region}.playground.klarna.com
+  registries:
+    oss:
+      enabled: true
+    cloud:
+      enabled: true
   connectorSubtype: api
   connectorType: source
   definitionId: 60c24725-00ae-490c-991d-55b78c3197e0
-  dockerImageTag: 0.1.0
+  dockerImageTag: 0.2.0
   dockerRepository: airbyte/source-klarna
   githubIssueLabel: source-klarna
   icon: klarna.svg
   license: MIT
   name: Klarna
-  registries:
-    cloud:
-      enabled: true
-    oss:
-      enabled: true
+  releaseDate: 2022-10-24
   releaseStage: alpha
+  supportLevel: community
   documentationUrl: https://docs.airbyte.com/integrations/sources/klarna
   tags:
-    - language:python
+    - language:low-code
   ab_internal:
     sl: 100
     ql: 100
-  supportLevel: community
 metadataSpecVersion: "1.0"
diff --git a/airbyte-integrations/connectors/source-klarna/setup.py b/airbyte-integrations/connectors/source-klarna/setup.py
@@ -5,13 +5,14 @@
 
 from setuptools import find_packages, setup
 
-MAIN_REQUIREMENTS = ["airbyte-cdk~=0.2", ""]
+MAIN_REQUIREMENTS = [
+    "airbyte-cdk~=0.1",
+]
 
 TEST_REQUIREMENTS = [
     "requests-mock~=1.9.3",
-    "pytest~=6.1",
+    "pytest~=6.2",
     "pytest-mock~=3.6.1",
-    "responses~=0.22.0",
 ]
 
 setup(

diff --git a/airbyte-integrations/connectors/source-klarna/source_klarna/manifest.yaml b/airbyte-integrations/connectors/source-klarna/source_klarna/manifest.yaml
@@ -0,0 +1,117 @@
+version: "0.29.0"
+
+type: DeclarativeSource
+check:
+  type: CheckStream
+  stream_names:
+    - payouts
+streams:
+  - type: DeclarativeStream
+    name: payouts
+    primary_key:
+      - payout_date
+    retriever:
+      type: SimpleRetriever
+      requester:
+        type: HttpRequester
+        url_base: https://api{{ '-' + config.region if config.region != 'eu' }}.{{ 'playground.' if config.playground }}klarna.com/
+        path: /settlements/v1/payouts
+        http_method: GET
+        request_parameters: {}
+        request_headers: {}
+        authenticator:
+          type: BasicHttpAuthenticator
+          username: "{{ config['username'] }}"
+          password: "{{ config['password'] }}"
+        request_body_json: {}
+      record_selector:
+        type: RecordSelector
+        extractor:
+          type: DpathExtractor
+          field_path:
+            - payouts
+      paginator:
+        type: DefaultPaginator
+        page_token_option:
+          type: RequestPath
+        page_size_option:
+          inject_into: request_parameter
+          type: RequestOption
+          field_name: size
+        pagination_strategy:
+          type: CursorPagination
+          page_size: 500
+          cursor_value: '{{ response.get("pagination", {}).get("next", {}) }}'
+          stop_condition: '{{ not response.get("pagination", {}).get("next", {}) }}'
+  - type: DeclarativeStream
+    name: transactions
+    retriever:
+      type: SimpleRetriever
+      requester:
+        type: HttpRequester
+        url_base: >-
+          https://api{{ '-'+config.region if config.region != 'eu' }}.{{
+          'playground.' if config.playground }}klarna.com/
+        path: /settlements/v1/transactions
+        http_method: GET
+        request_parameters: {}
+        request_headers: {}
+        authenticator:
+          type: BasicHttpAuthenticator
+          username: "{{ config['username'] }}"
+          password: "{{ config['password'] }}"
+        request_body_json: {}
+      record_selector:
+        type: RecordSelector
+        extractor:
+          type: DpathExtractor
+          field_path:
+            - transactions
+      paginator:
+        type: DefaultPaginator
+        page_token_option:
+          type: RequestPath
+        page_size_option:
+          inject_into: request_parameter
+          type: RequestOption
+          field_name: size
+        pagination_strategy:
+          type: CursorPagination
+          page_size: 500
+          cursor_value: '{{ response.get("pagination", {}).get("next", {}) }}'
+          stop_condition: '{{ not response.get("pagination", {}).get("next", {}) }}'
+spec:
+  documentation_url: https://docs.airbyte.com/integrations/sources/klarna
+  connection_specification:
+    $schema: http://json-schema.org/draft-07/schema#
+    title: Klarna Spec
+    type: object
+    required:
+      - region
+      - playground
+      - username
+      - password
+    additionalProperties: true
+    properties:
+      region:
+        title: Region
+        type: string
+        enum:
+          - eu
+          - us
+          - oc
+        description: Base url region (For playground eu https://docs.klarna.com/klarna-payments/api/payments-api/#tag/API-URLs). Supported 'eu', 'us', 'oc'
+      playground:
+        title: Playground
+        type: boolean
+        description: Propertie defining if connector is used against playground or production environment
+        default: false
+      username:
+        title: Username
+        type: string
+        description: Consists of your Merchant ID (eid) - a unique number that identifies your e-store, combined with a random string (https://developers.klarna.com/api/#authentication)
+      password:
+        title: Password
+        type: string
+        description: A string which is associated with your Merchant ID and is used to authorize use of Klarna's APIs (https://developers.klarna.com/api/#authentication)
+        airbyte_secret: true
diff --git a/airbyte-integrations/connectors/source-klarna/source_klarna/schemas/payouts.json b/airbyte-integrations/connectors/source-klarna/source_klarna/schemas/payouts.json
@@ -1,17 +1,10 @@
 {
+  "$schema": "https://json-schema.org/draft-07/schema#",
   "type": "object",
   "additionalProperties": true,
-  "required": [
-    "totals",
-    "payment_reference",
-    "payout_date",
-    "currency_code",
-    "merchant_settlement_type",
-    "merchant_id"
-  ],
   "properties": {
     "totals": {
-      "type": "object",
+      "type": ["null", "object"],
       "additionalProperties": true,
       "properties": {
         "commission_amount": {
@@ -130,6 +123,5 @@
       "example": "https://{settlements_api}/transactions?payment_reference=XISA93DJ",
       "type": "string"
     }
-  },
-  "$schema": "http://json-schema.org/schema#"
+  }
 }
diff --git a/airbyte-integrations/connectors/source-klarna/source_klarna/schemas/transactions.json b/airbyte-integrations/connectors/source-klarna/source_klarna/schemas/transactions.json
@@ -1,14 +1,28 @@
 {
+  "$schema": "https://json-schema.org/draft-07/schema#",
   "type": "object",
   "additionalProperties": true,
-  "required": ["capture_id", "sale_date", "capture_date", "order_id"],
   "properties": {
     "amount": {
       "description": "Total amount of the specific transaction, in minor units",
       "example": 2000,
       "type": "integer",
       "format": "int64"
     },
+    "merchant_id": {
+      "type": ["null", "string"]
+    },
+    "shipping_address_country": {
+      "type": ["null", "string"]
+    },
+    "consumer_vat": {
+      "type": ["null", "array"],
+      "items": {
+        "type": ["null", "object"],
+        "additionalProperties": true,
+        "properties": {}
+      }
+    },
     "capture_id": {
       "description": "The Klarna assigned id reference of a specific capture",
       "example": "33db6f16-9f43-43fa-a587-cc51411c98e4",
@@ -186,6 +200,5 @@
       "description": "ISO 4217 Currency Code of the country you are registered in.",
       "example": "EUR"
     }
-  },
-  "$schema": "http://json-schema.org/schema#"
+  }
 }