🎉New source connector: source-metabase

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

@@ -530,6 +530,14 @@
  icon: marketo.svg
  sourceType: api
  releaseStage: alpha
+- name: Metabase
+ sourceDefinitionId: c7cb421b-942e-4468-99ee-e369bcabaec5
+ dockerRepository: airbyte/source-metabase
+ dockerImageTag: 0.1.0
+ documentationUrl: https://docs.airbyte.io/integrations/sources/metabase
+ icon: metabase.svg
+ sourceType: api
+ releaseStage: alpha
 - name: Microsoft SQL Server (MSSQL)
  sourceDefinitionId: b5ea17b1-f170-46dc-bc31-cc744ca984c1
  dockerRepository: airbyte/source-mssql

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

@@ -4850,6 +4850,44 @@
  supportsNormalization: false
  supportsDBT: false
  supported_destination_sync_modes: []
+- dockerImage: "airbyte/source-metabase:0.1.0"
+ spec:
+ documentationUrl: "https://docs.airbyte.io/integrations/sources/metabase"
+ connectionSpecification:
+ $schema: "http://json-schema.org/draft-07/schema#"
+ title: "Metabase Source Spec"
+ type: "object"
+ required:
+ - "instance_api_url"
+ additionalProperties: true
+ properties:
+ instance_api_url:
+ type: "string"
+ title: "Metabase Instance API URL"
+ description: "URL to your metabase instance API"
+ examples:
+ - "http://localhost:3000/api/"
+ order: 0
+ username:
+ type: "string"
+ order: 1
+ password:
+ type: "string"
+ airbyte_secret: true
+ order: 2
+ session_token:
+ type: "string"
+ description: "To generate your session token, you need to run the following\
+ \ command: ``` curl -X POST \\\n -H \"Content-Type: application/json\"\
+ \ \\\n -d '{\"username\": \"person@metabase.com\", \"password\": \"fakepassword\"\
+ }' \\\n http://localhost:3000/api/session\n``` Then copy the value of\
+ \ the `id` field returned by a successful call to that API.\nNote that\
+ \ by default, sessions are good for 14 days and needs to be regenerated."
+ airbyte_secret: true
+ order: 3
+ supportsNormalization: false
+ supportsDBT: false
+ supported_destination_sync_modes: []
 - dockerImage: "airbyte/source-mssql:0.4.3"
  spec:
  documentationUrl: "https://docs.airbyte.io/integrations/destinations/mssql"

airbyte-integrations/builds.md

@@ -61,6 +61,7 @@
 | Lemlist | [![source-lemlist](https://img.shields.io/endpoint?url=https%3A%2F%2Fdnsgjos7lj2fu.cloudfront.net%2Ftests%2Fsummary%2Fsource-lemlist%2Fbadge.json)](https://dnsgjos7lj2fu.cloudfront.net/tests/summary/source-lemlist) |
 | Mailchimp | [![source-mailchimp](https://img.shields.io/endpoint?url=https%3A%2F%2Fdnsgjos7lj2fu.cloudfront.net%2Ftests%2Fsummary%2Fsource-mailchimp%2Fbadge.json)](https://dnsgjos7lj2fu.cloudfront.net/tests/summary/source-mailchimp) |
 | Marketo | [![source-marketo](https://img.shields.io/endpoint?url=https%3A%2F%2Fdnsgjos7lj2fu.cloudfront.net%2Ftests%2Fsummary%2Fsource-marketo%2Fbadge.json)](https://dnsgjos7lj2fu.cloudfront.net/tests/summary/source-marketo) |
+| Metabase | [![source-metabase](https://img.shields.io/endpoint?url=https%3A%2F%2Fdnsgjos7lj2fu.cloudfront.net%2Ftests%2Fsummary%2Fsource-metabase%2Fbadge.json)](https://dnsgjos7lj2fu.cloudfront.net/tests/summary/source-metabase) |
 | Microsoft SQL Server \(MSSQL\) | [![source-mssql](https://img.shields.io/endpoint?url=https%3A%2F%2Fdnsgjos7lj2fu.cloudfront.net%2Ftests%2Fsummary%2Fsource-mssql%2Fbadge.json)](https://dnsgjos7lj2fu.cloudfront.net/tests/summary/source-mssql) |
 | Microsoft Teams | [![source-microsoft-teams](https://img.shields.io/endpoint?url=https%3A%2F%2Fdnsgjos7lj2fu.cloudfront.net%2Ftests%2Fsummary%2Fsource-microsoft-teams%2Fbadge.json)](https://dnsgjos7lj2fu.cloudfront.net/tests/summary/source-microsoft-teams) |
 | Mixpanel | [![source-mixpanel](https://img.shields.io/endpoint?url=https%3A%2F%2Fdnsgjos7lj2fu.cloudfront.net%2Ftests%2Fsummary%2Fsource-mixpanel%2Fbadge.json)](https://dnsgjos7lj2fu.cloudfront.net/tests/summary/source-mixpanel) |

airbyte-integrations/connectors/source-metabase/Dockerfile

@@ -0,0 +1,16 @@
+FROM python:3.9-slim
+
+# Bash is installed for more convenient debugging.
+RUN apt-get update && apt-get install -y bash && rm -rf /var/lib/apt/lists/*
+
+WORKDIR /airbyte/integration_code
+COPY source_metabase ./source_metabase
+COPY main.py ./
+COPY setup.py ./
+RUN pip install .
+
+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-metabase

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

@@ -0,0 +1,129 @@
+# Metabase Source
+
+This is the repository for the Metabase source connector, written in Python.
+For information about how to use this connector within Airbyte, see [the documentation](https://docs.airbyte.io/integrations/sources/metabase).
+
+## 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
+```
+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-metabase:build
+```
+
+#### Create credentials
+**If you are a community contributor**, follow the instructions in the [documentation](https://docs.airbyte.io/integrations/sources/metabase)
+to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `source_metabase/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 `sample_files/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 metabase 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 sample_files/configured_catalog.json
+```
+
+### Unit Tests
+To run unit tests locally, from the connector directory run:
+```
+python -m pytest unit_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
+```
+
+### Using gradle to run tests
+All commands should be run from airbyte project root.
+To run unit tests:
+```
+./gradlew :airbyte-integrations:connectors:source-metabase:unitTest
+```
+
+To run acceptance and custom integration tests:
+```
+./gradlew :airbyte-integrations:connectors:source-metabase:integrationTest
+```
+
+#### Build
+To run your integration tests with docker localy
+
+First, make sure you build the latest Docker image:
+```
+docker build --no-cache . -t airbyte/source-metabase:dev
+```
+
+You can also build the connector image via Gradle:
+```
+./gradlew clean :airbyte-integrations:connectors:source-metabase: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-metabase:dev spec
+docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-metabase:dev check --config /secrets/config.json
+docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-metabase:dev discover --config /secrets/config.json
+docker run --rm -v $(pwd)/secrets:/secrets -v $(pwd)/sample_files:/sample_files airbyte/source-metabase:dev read --config /secrets/config.json --catalog /sample_files/configured_catalog.json
+```
+
+### Integration Tests
+1. From the airbyte project root, run `./gradlew :airbyte-integrations:connectors:source-metabase:integrationTest` to run the standard integration test suite.
+1. To run additional integration tests, place your integration tests in a new directory `integration_tests` and run them with `python -m pytest -s integration_tests`.
+ 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.
+
+## 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.
+
+### 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
+2. Bump the connector version in `Dockerfile` -- just increment the value of the `LABEL io.airbyte.version` appropriately (we use SemVer).
+3. Create a Pull Request
+4. Pat yourself on the back for being an awesome contributor
+5. Someone from Airbyte will take a look at your PR and iterate with you to merge it into master
+
+
+### additional connector/streams properties of note
+
+Some metabase streams are mutable, meaning that after an incremental update, new data items could appear *before* 
+the latest update date. To work around that, define the lookback_window_days to define a window in days to fetch results
+before the latest state date, in order to capture "delayed" data items.

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

@@ -0,0 +1,14 @@
+connector_image: airbyte/source-metabase:dev
+tests:
+ spec:
+ - spec_path: "source_metabase/spec.yaml"
+ 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.json"

airbyte-integrations/connectors/source-metabase/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
+