🎉 New Source: 3PL Central (#7322)

* Add source-tplcentral

* Add source definition

* Add missing file

* Update catalog

* Update sample config

* Update formatting

* Update invalid config

* Fix primary key identifier

* Update naming

* Rename variable

* Parametrize page size

* Implement Items stream

* Update schemas

* Update response normalization

* Add arrow

* Implement items stream cursor

* Fix types

* Cleanup

* Add customers stream

* Fix items sort

* Add stock_details stream

* Add inventory stream

* Add orders stream

* Refactor streams to a separate file

* Update cursor handling

* Refactor request_params

* Simplify

* Update params generation

* Update response parse

* Refactor stream+slices

* Refactor parse_response

* Cleanup

* New order

* Fix style

* Refactor parse_reponse

* Fix cursor

* Don't fetch next page after the last

* Fix schema errors

* Flatten shared schemas

* Inline refs

* Fix handling None stream_state

* Update schemas

* Implement primary_key and cursor fields

* Fix style

* Fix style

* Fix schemas

* Fix deep_map

* Fix items schema

* Fix cursor formatting

* Update integration tests assets

* Update README.md

* Remove TODO.md

* Update spec.json

* Cleanup

* Add bootstrap.md

* Increase page sizes

* Increase state checkpoint interval

* Add documentation

* Update links to the documentation

* Add build status badge

* Implement test_source.py

* Improve code testability

* Add stream tests

* Implement test_incremental_streams

* Add requests-mock dependency

* Fix formatting

* Update author

* Run ./gradlew format

* Cleanup failed merge artifacts

* Update sample_state.json

* Add stream documentation urls

* Cleanup

* Preserve upstream naming

* Fix primary key

* Fix configured catalog

* Update schemas

* Update catalog.json

* Fix tests

* Add schema source files

* Split configured catalogs

* Cleanup

* Update documentationUrl

* Add new properties

* Run gradlew format

* Remove additionalProperties: false from the schemas

* Revert "Remove additionalProperties: false from the schemas"

This reverts commit d4e8fea.

airbyte-config/init/src/main/resources/config/STANDARD_SOURCE_DEFINITION/135819f4-2505-11ec-8381-2784537b7ff6.json

@@ -0,0 +1,7 @@
+{
+  "sourceDefinitionId": "135819f4-2505-11ec-8381-2784537b7ff6",
+  "name": "3PL Central",
+  "dockerRepository": "airbyte/source-tplcentral",
+  "dockerImageTag": "dev",
+  "documentationUrl": "https://docs.airbyte.io/integrations/sources/tplcentral"
+}

airbyte-config/init/src/main/resources/seed/source_definitions.yaml

@@ -458,6 +458,11 @@
   documentationUrl: https://docs.airbyte.io/integrations/sources/okta
   icon: okta.svg
   sourceType: api
+- sourceDefinitionId: 135819f4-2505-11ec-8381-2784537b7ff6
+  name: 3PL Central
+  dockerRepository: airbyte/source-tplcentral
+  dockerImageTag: dev
+  documentationUrl: https://docs.airbyte.io/integrations/sources/tplcentral
 - name: OneSignal
   sourceDefinitionId: bb6afd81-87d5-47e3-97c4-e2c2901b1cf8
   dockerRepository: airbyte/source-onesignal

airbyte-integrations/builds.md

@@ -4,6 +4,7 @@
 
 |name |status |
 | :--- | :--- |
+| 3PL Central  | [![source-amazon-seller-partner](https://img.shields.io/endpoint?url=https%3A%2F%2Fdnsgjos7lj2fu.cloudfront.net%2Ftests%2Fsummary%2Fsource-tplcentral%2Fbadge.json)](https://dnsgjos7lj2fu.cloudfront.net/tests/summary/source-tplcentral) |
 | Airtable  | [![source-airtable](https://img.shields.io/endpoint?url=https%3A%2F%2Fdnsgjos7lj2fu.cloudfront.net%2Ftests%2Fsummary%2Fsource-airtable%2Fbadge.json)](https://dnsgjos7lj2fu.cloudfront.net/tests/summary/source-airtable) |
 | Amazon Seller Partner  | [![source-amazon-seller-partner](https://img.shields.io/endpoint?url=https%3A%2F%2Fdnsgjos7lj2fu.cloudfront.net%2Ftests%2Fsummary%2Fsource-amazon-seller-partner%2Fbadge.json)](https://dnsgjos7lj2fu.cloudfront.net/tests/summary/source-amazon-seller-partner) |
 | Amplitude   | [![source-amplitude](https://img.shields.io/endpoint?url=https%3A%2F%2Fdnsgjos7lj2fu.cloudfront.net%2Ftests%2Fsummary%2Fsource-amplitude%2Fbadge.json)](https://dnsgjos7lj2fu.cloudfront.net/tests/summary/source-amplitude) |

airbyte-integrations/connectors/source-tplcentral/.dockerignore

@@ -0,0 +1,7 @@
+*
+!Dockerfile
+!Dockerfile.test
+!main.py
+!source_tplcentral
+!setup.py
+!secrets

airbyte-integrations/connectors/source-tplcentral/Dockerfile

@@ -0,0 +1,38 @@
+FROM python:3.7.11-alpine3.14 as base
+
+# build and load all requirements
+FROM base as builder
+WORKDIR /airbyte/integration_code
+
+# upgrade pip to the latest version
+RUN apk --no-cache upgrade \
+    && pip install --upgrade pip \
+    && apk --no-cache add tzdata build-base
+
+
+COPY setup.py ./
+# install necessary packages to a temporary folder
+RUN pip install --prefix=/install .
+
+# build a clean environment
+FROM base
+WORKDIR /airbyte/integration_code
+
+# copy all loaded and built libraries to a pure basic image
+COPY --from=builder /install /usr/local
+# add default timezone settings
+COPY --from=builder /usr/share/zoneinfo/Etc/UTC /etc/localtime
+RUN echo "Etc/UTC" > /etc/timezone
+
+# bash is installed for more convenient debugging.
+RUN apk --no-cache add bash
+
+# copy payload code only
+COPY main.py ./
+COPY source_tplcentral ./source_tplcentral
+
+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.name=airbyte/source-tplcentral

airbyte-integrations/connectors/source-tplcentral/README.md

@@ -0,0 +1,132 @@
+# 3PL Central Source
+
+This is the repository for the 3PL Central source connector, written in Python.
+For information about how to use this connector within Airbyte, see [the documentation](https://docs.airbyte.io/integrations/sources/tplcentral).
+
+## Local development
+
+### Prerequisites
+**To iterate on this connector, make sure to complete this prerequisites section.**
+
+#### Minimum Python version required `= 3.7.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.
+
+To build using Gradle, from the Airbyte repository root, run:
+```
+./gradlew :airbyte-integrations:connectors:source-tplcentral:build
+```
+
+#### Create credentials
+**If you are a community contributor**, follow the instructions in the [documentation](https://docs.airbyte.io/integrations/sources/tplcentral)
+to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `source_tplcentral/spec.json` 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 tplcentral 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
+First, make sure you build the latest Docker image:
+```
+docker build . -t airbyte/source-tplcentral:dev
+```
+
+You can also build the connector image via Gradle:
+```
+./gradlew :airbyte-integrations:connectors:source-tplcentral:airbyteDocker
+```
+When building via Gradle, the docker image name and tag, respectively, are the values of the `io.airbyte.name` and `io.airbyte.version` `LABEL`s in
+the Dockerfile.
+
+#### Run
+Then run any of the connector commands as follows:
+```
+docker run --rm airbyte/source-tplcentral:dev spec
+docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-tplcentral:dev check --config /secrets/config.json
+docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-tplcentral:dev discover --config /secrets/config.json
+docker run --rm -v $(pwd)/secrets:/secrets -v $(pwd)/integration_tests:/integration_tests airbyte/source-tplcentral: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 [Source Acceptance Tests](https://docs.airbyte.io/connector-development/testing-connectors/source-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
+```
+python -m pytest integration_tests -p integration_tests.acceptance
+```
+To run your integration tests with docker
+
+### Using gradle to run tests
+All commands should be run from airbyte project root.
+To run unit tests:
+```
+./gradlew :airbyte-integrations:connectors:source-tplcentral:unitTest
+```
+To run acceptance and custom integration tests:
+```
+./gradlew :airbyte-integrations:connectors:source-tplcentral:integrationTest
+```
+
+## Dependency Management
+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
+
+### Publishing a new version of the connector
+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 unit and integration tests.
+1. Bump the connector version in `Dockerfile` -- just increment the value of the `LABEL io.airbyte.version` appropriately (we use [SemVer](https://semver.org/)).
+1. Create a Pull Request.
+1. Pat yourself on the back for being an awesome contributor.
+1. Someone from Airbyte will take a look at your PR and iterate with you to merge it into master.

airbyte-integrations/connectors/source-tplcentral/acceptance-test-config.yml

@@ -0,0 +1,50 @@
+# See [Source Acceptance Tests](https://docs.airbyte.io/connector-development/testing-connectors/source-acceptance-tests-reference)
+# for more information about how to configure these tests
+connector_image: airbyte/source-tplcentral:dev
+tests:
+  spec:
+    - spec_path: "source_tplcentral/spec.json"
+  connection:
+    - config_path: "secrets/config.json"
+      status: "succeed"
+    - config_path: "integration_tests/invalid_config.json"
+      status: "failed"
+  discovery:
+    - config_path: "secrets/config.json"
+  basic_read:
+    - config_path: "secrets/config.json"
+      configured_catalog_path: "integration_tests/configured_catalog_stock_summaries.json"
+      empty_streams: []
+    - config_path: "secrets/config.json"
+      configured_catalog_path: "integration_tests/configured_catalog_customers.json"
+      empty_streams: []
+    - config_path: "secrets/config.json"
+      configured_catalog_path: "integration_tests/configured_catalog_items.json"
+      empty_streams: []
+    - config_path: "secrets/config.json"
+      configured_catalog_path: "integration_tests/configured_catalog_stock_details.json"
+      empty_streams: []
+    - config_path: "secrets/config.json"
+      configured_catalog_path: "integration_tests/configured_catalog_inventory.json"
+      empty_streams: []
+    - config_path: "secrets/config.json"
+      configured_catalog_path: "integration_tests/configured_catalog_orders.json"
+      empty_streams: []
+  incremental:
+    - config_path: "secrets/config.json"
+      configured_catalog_path: "integration_tests/configured_catalog_items.json"
+      future_state_path: "integration_tests/abnormal_state.json"
+    - config_path: "secrets/config.json"
+      configured_catalog_path: "integration_tests/configured_catalog_stock_details.json"
+      future_state_path: "integration_tests/abnormal_state.json"
+    - config_path: "secrets/config.json"
+      configured_catalog_path: "integration_tests/configured_catalog_inventory.json"
+      future_state_path: "integration_tests/abnormal_state.json"
+    - config_path: "secrets/config.json"
+      configured_catalog_path: "integration_tests/configured_catalog_orders.json"
+      future_state_path: "integration_tests/abnormal_state.json"
+  full_refresh:
+    - config_path: "secrets/config.json"
+      configured_catalog_path: "integration_tests/configured_catalog_stock_summaries.json"
+    - config_path: "secrets/config.json"
+      configured_catalog_path: "integration_tests/configured_catalog_customers.json"

airbyte-integrations/connectors/source-tplcentral/acceptance-test-docker.sh

@@ -0,0 +1,16 @@
+#!/usr/bin/env sh
+
+# Build latest connector image
+docker build . -t $(cat acceptance-test-config.yml | grep "connector_image" | head -n 1 | cut -d: -f2)
+
+# Pull latest acctest image
+docker pull airbyte/source-acceptance-test:latest
+
+# Run
+docker run --rm -it \
+    -v /var/run/docker.sock:/var/run/docker.sock \
+    -v /tmp:/tmp \
+    -v $(pwd):/test_input \
+    airbyte/source-acceptance-test \
+    --acceptance-test-config /test_input
+

airbyte-integrations/connectors/source-tplcentral/bootstrap.md

@@ -0,0 +1,17 @@
+3PL Central source is modeled after their API, each stream representing an API resource. Then, four simple transformations are applied for each stream:
+
+- Object keys are transformed from `TitleCase` to `snake_case`.
+- [HAL](https://stateless.group/hal_specification.html) `_link` keys are removed from all objects.
+- A `_cursor` field of date-time type is added for each incremental stream. The value of this field is a copy of an actual stream-specific and more or less deeply nested cursor field.
+- An `_id` or `_{name}_id` field of integer type is added for each stream. The value of this field is a copy of an actual stream-specific and more or less deeply nested ID. `_id` is a primary key of a stream and is used when the actual ID of the resource is located in a nested object. `_{name}_id` is used when a resource itself doesn't have an ID, but the ID of a depending object is used as a part of a combined primary key where `{name}` is a name of depending object.
+
+All schemas, field names, structure, and comments represent respective C# models described in the [API documentation (https://api.3plcentral.com/Rels/). Unfortunately, the documentation is somewhat outdated, and some endpoints return additional undocumented fields. These fields are added to the schemas to match actual data fields.
+
+The API authentication endpoint requires either user login ID or name or both. API credentials can be obtained using the service UI.
+
+Customer ID and Facility ID are used in URLs, be it path or query part.
+
+API docs:
+
+- https://api.3plcentral.com/Rels/
+- https://developer.3plcentral.com

airbyte-integrations/connectors/source-tplcentral/build.gradle

@@ -0,0 +1,14 @@
+plugins {
+    id 'airbyte-python'
+    id 'airbyte-docker'
+    id 'airbyte-source-acceptance-test'
+}
+
+airbytePython {
+    moduleDirectory 'source_tplcentral'
+}
+
+dependencies {
+    implementation files(project(':airbyte-integrations:bases:source-acceptance-test').airbyteDocker.outputs)
+    implementation files(project(':airbyte-integrations:bases:base-python').airbyteDocker.outputs)
+}

airbyte-integrations/connectors/source-tplcentral/integration_tests/abnormal_state.json

@@ -0,0 +1,14 @@
+{
+  "items": {
+    "_cursor": "2050-01-01T00:00:00+00:00"
+  },
+  "stock_details": {
+    "_cursor": "2050-01-01T00:00:00+00:00"
+  },
+  "inventory": {
+    "_cursor": "2050-01-01T00:00:00+00:00"
+  },
+  "orders": {
+    "_cursor": "2050-01-01T00:00:00+00:00"
+  }
+}

airbyte-integrations/connectors/source-tplcentral/integration_tests/acceptance.py

@@ -0,0 +1,14 @@
+#
+# Copyright (c) 2021 Airbyte, Inc., all rights reserved.
+#
+
+
+import pytest
+
+pytest_plugins = ("source_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."""
+    yield

airbyte-integrations/connectors/source-tplcentral/integration_tests/catalog.json

@@ -0,0 +1,48 @@
+{
+  "streams": [
+    {
+      "name": "stock_summaries",
+      "json_schema": {},
+      "supported_sync_modes": ["full_refresh"],
+      "source_defined_primary_key": [["facility_id"], ["_item_identifier_id"]]
+    },
+    {
+      "name": "customers",
+      "json_schema": {},
+      "supported_sync_modes": ["full_refresh"],
+      "source_defined_primary_key": [["_id"]]
+    },
+    {
+      "name": "items",
+      "json_schema": {},
+      "supported_sync_modes": ["full_refresh", "incremental"],
+      "source_defined_cursor": true,
+      "default_cursor_field": ["_cursor"],
+      "source_defined_primary_key": [["_id"]]
+    },
+    {
+      "name": "stock_details",
+      "json_schema": {},
+      "supported_sync_modes": ["full_refresh", "incremental"],
+      "source_defined_cursor": true,
+      "default_cursor_field": ["_cursor"],
+      "source_defined_primary_key": [["_id"]]
+    },
+    {
+      "name": "inventory",
+      "json_schema": {},
+      "supported_sync_modes": ["full_refresh", "incremental"],
+      "source_defined_cursor": true,
+      "default_cursor_field": ["_cursor"],
+      "source_defined_primary_key": [["_id"]]
+    },
+    {
+      "name": "orders",
+      "json_schema": {},
+      "supported_sync_modes": ["full_refresh", "incremental"],
+      "source_defined_cursor": true,
+      "default_cursor_field": ["_cursor"],
+      "source_defined_primary_key": [["_id"]]
+    }
+  ]
+}