diff --git a/airbyte-config/init/src/main/resources/seed/source_definitions.yaml b/airbyte-config/init/src/main/resources/seed/source_definitions.yaml index b4849beffecc..37d226008ecd 100644 --- a/airbyte-config/init/src/main/resources/seed/source_definitions.yaml +++ b/airbyte-config/init/src/main/resources/seed/source_definitions.yaml @@ -480,6 +480,14 @@ icon: google-sheets.svg sourceType: file releaseStage: generally_available +- name: Google Webfonts + sourceDefinitionId: a68fbcde-b465-4ab3-b2a6-b0590a875835 + dockerRepository: airbyte/source-google-webfonts + dockerImageTag: 0.1.0 + documentationUrl: https://docs.airbyte.com/integrations/sources/google-webfonts + icon: googleworkpace.svg + sourceType: api + releaseStage: alpha - name: Google Workspace Admin Reports sourceDefinitionId: ed9dfefa-1bbc-419d-8c5e-4d78f0ef6734 dockerRepository: airbyte/source-google-workspace-admin-reports diff --git a/airbyte-config/init/src/main/resources/seed/source_specs.yaml b/airbyte-config/init/src/main/resources/seed/source_specs.yaml index a330eb401404..28e09f19d102 100644 --- a/airbyte-config/init/src/main/resources/seed/source_specs.yaml +++ b/airbyte-config/init/src/main/resources/seed/source_specs.yaml @@ -4763,6 +4763,34 @@ - - "client_secret" oauthFlowOutputParameters: - - "refresh_token" +- dockerImage: "airbyte/source-google-webfonts:0.1.0" + spec: + documentationUrl: "https://docs.airbyte.com/integrations/sources/google-webfonts" + connectionSpecification: + $schema: "http://json-schema.org/draft-07/schema#" + title: "Google Webfonts Spec" + type: "object" + required: + - "api_key" + additionalProperties: true + properties: + api_key: + type: "string" + description: "API key is required to access google apis, For getting your's\ + \ goto google console and generate api key for Webfonts" + airbyte_secret: true + sort: + type: "string" + description: "Optional, to find how to sort" + prettyPrint: + type: "string" + description: "Optional, boolean type" + alt: + type: "string" + description: "Optional, Available params- json, media, proto" + supportsNormalization: false + supportsDBT: false + supported_destination_sync_modes: [] - dockerImage: "airbyte/source-google-workspace-admin-reports:0.1.8" spec: documentationUrl: "https://docs.airbyte.com/integrations/sources/google-workspace-admin-reports" diff --git a/airbyte-integrations/connectors/source-google-webfonts/.dockerignore b/airbyte-integrations/connectors/source-google-webfonts/.dockerignore new file mode 100644 index 000000000000..b7c1ebe6c666 --- /dev/null +++ b/airbyte-integrations/connectors/source-google-webfonts/.dockerignore @@ -0,0 +1,6 @@ +* +!Dockerfile +!main.py +!source_google_webfonts +!setup.py +!secrets diff --git a/airbyte-integrations/connectors/source-google-webfonts/Dockerfile b/airbyte-integrations/connectors/source-google-webfonts/Dockerfile new file mode 100644 index 000000000000..56b13b3f8de2 --- /dev/null +++ b/airbyte-integrations/connectors/source-google-webfonts/Dockerfile @@ -0,0 +1,38 @@ +FROM python:3.9.11-alpine3.15 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_google_webfonts ./source_google_webfonts + +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-google-webfonts diff --git a/airbyte-integrations/connectors/source-google-webfonts/README.md b/airbyte-integrations/connectors/source-google-webfonts/README.md new file mode 100644 index 000000000000..f0e9d4f2ba72 --- /dev/null +++ b/airbyte-integrations/connectors/source-google-webfonts/README.md @@ -0,0 +1,103 @@ +# Google Webfonts Source + +This is the repository for the Google Webfonts configuration based source connector. +For information about how to use this connector within Airbyte, see [the documentation](https://docs.airbyte.io/integrations/sources/google-webfonts). + +## 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 +``` +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-google-webfonts:build +``` + +#### Create credentials +**If you are a community contributor**, follow the instructions in the [documentation](https://docs.airbyte.io/integrations/sources/google-webfonts) +to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `source_google_webfonts/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 google-webfonts test creds` +and place them into `secrets/config.json`. + +### Locally running the connector docker image + +#### Build +First, make sure you build the latest Docker image: +``` +docker build . -t airbyte/source-google-webfonts:dev +``` + +You can also build the connector image via Gradle: +``` +./gradlew :airbyte-integrations:connectors:source-google-webfonts: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-google-webfonts:dev spec +docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-google-webfonts:dev check --config /secrets/config.json +docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-google-webfonts:dev discover --config /secrets/config.json +docker run --rm -v $(pwd)/secrets:/secrets -v $(pwd)/integration_tests:/integration_tests airbyte/source-google-webfonts:dev read --config /secrets/config.json --catalog /integration_tests/configured_catalog.json +``` +## Testing + +#### 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 docker + +### Using gradle to run tests +All commands should be run from airbyte project root. +To run unit tests: +``` +./gradlew :airbyte-integrations:connectors:source-google-webfonts:unitTest +``` +To run acceptance and custom integration tests: +``` +./gradlew :airbyte-integrations:connectors:source-google-webfonts: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. diff --git a/airbyte-integrations/connectors/source-google-webfonts/__init__.py b/airbyte-integrations/connectors/source-google-webfonts/__init__.py new file mode 100644 index 000000000000..1100c1c58cf5 --- /dev/null +++ b/airbyte-integrations/connectors/source-google-webfonts/__init__.py @@ -0,0 +1,3 @@ +# +# Copyright (c) 2022 Airbyte, Inc., all rights reserved. +# diff --git a/airbyte-integrations/connectors/source-google-webfonts/acceptance-test-config.yml b/airbyte-integrations/connectors/source-google-webfonts/acceptance-test-config.yml new file mode 100644 index 000000000000..7e69e954eac4 --- /dev/null +++ b/airbyte-integrations/connectors/source-google-webfonts/acceptance-test-config.yml @@ -0,0 +1,20 @@ +# See [Source Acceptance Tests](https://docs.airbyte.com/connector-development/testing-connectors/source-acceptance-tests-reference) +# for more information about how to configure these tests +connector_image: airbyte/source-google-webfonts:dev +tests: + spec: + - spec_path: "source_google_webfonts/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" + empty_streams: [] + full_refresh: + - config_path: "secrets/config.json" + configured_catalog_path: "integration_tests/configured_catalog.json" diff --git a/airbyte-integrations/connectors/source-google-webfonts/acceptance-test-docker.sh b/airbyte-integrations/connectors/source-google-webfonts/acceptance-test-docker.sh new file mode 100644 index 000000000000..c51577d10690 --- /dev/null +++ b/airbyte-integrations/connectors/source-google-webfonts/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 + diff --git a/airbyte-integrations/connectors/source-google-webfonts/bootstrap.md b/airbyte-integrations/connectors/source-google-webfonts/bootstrap.md new file mode 100644 index 000000000000..10cfa3b880b5 --- /dev/null +++ b/airbyte-integrations/connectors/source-google-webfonts/bootstrap.md @@ -0,0 +1,38 @@ +# Google-webfonts + +The connector uses the v1 API documented here: https://developers.google.com/fonts/docs/developer_api . It is +straightforward HTTP REST API with API authentication. + +## API key + +Api key is mandate for this connector to work, It could be generated by a gmail account for free at https://console.cloud.google.com/apis/dashboard. +Just pass the generated API key and optional parameters for establishing the connection. Example:123 + +## Implementation details + +## Setup guide + +### Step 1: Set up Google-webfonts connection + +- Generate an API key (Example: 12345) +- Params (If specific info is needed) +- Available params + - sort: SORT_UNDEFINED, ALPHA, DATE, STYLE, TRENDING, POPULARITY + - alt: json, media or proto + - prettyPrint: boolean + +## Step 2: Generate schema for the endpoint + +### Custom schema is generated and tested with different IDs + +## Step 3: Spec, Secrets, and connector yaml files are configured with reference to the Airbyte documentation. + +## In a nutshell: + +1. Navigate to the Airbyte Open Source dashboard. +2. Set the name for your source. +3. Enter your `api_key`. +5. Enter your config params if needed. (Optional) +6. Click **Set up source**. + + * We use only GET methods, towards the webfonts endpoints which is straightforward \ No newline at end of file diff --git a/airbyte-integrations/connectors/source-google-webfonts/build.gradle b/airbyte-integrations/connectors/source-google-webfonts/build.gradle new file mode 100644 index 000000000000..8bf7fd748729 --- /dev/null +++ b/airbyte-integrations/connectors/source-google-webfonts/build.gradle @@ -0,0 +1,9 @@ +plugins { + id 'airbyte-python' + id 'airbyte-docker' + id 'airbyte-source-acceptance-test' +} + +airbytePython { + moduleDirectory 'source_google_webfonts' +} diff --git a/airbyte-integrations/connectors/source-google-webfonts/integration_tests/__init__.py b/airbyte-integrations/connectors/source-google-webfonts/integration_tests/__init__.py new file mode 100644 index 000000000000..1100c1c58cf5 --- /dev/null +++ b/airbyte-integrations/connectors/source-google-webfonts/integration_tests/__init__.py @@ -0,0 +1,3 @@ +# +# Copyright (c) 2022 Airbyte, Inc., all rights reserved. +# diff --git a/airbyte-integrations/connectors/source-google-webfonts/integration_tests/acceptance.py b/airbyte-integrations/connectors/source-google-webfonts/integration_tests/acceptance.py new file mode 100644 index 000000000000..1302b2f57e10 --- /dev/null +++ b/airbyte-integrations/connectors/source-google-webfonts/integration_tests/acceptance.py @@ -0,0 +1,16 @@ +# +# Copyright (c) 2022 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.""" + # TODO: setup test dependencies if needed. otherwise remove the TODO comments + yield + # TODO: clean up test dependencies diff --git a/airbyte-integrations/connectors/source-google-webfonts/integration_tests/catalog.json b/airbyte-integrations/connectors/source-google-webfonts/integration_tests/catalog.json new file mode 100644 index 000000000000..6799946a6851 --- /dev/null +++ b/airbyte-integrations/connectors/source-google-webfonts/integration_tests/catalog.json @@ -0,0 +1,39 @@ +{ + "streams": [ + { + "name": "TODO fix this file", + "supported_sync_modes": ["full_refresh", "incremental"], + "source_defined_cursor": true, + "default_cursor_field": "column1", + "json_schema": { + "$schema": "http://json-schema.org/draft-07/schema#", + "type": "object", + "properties": { + "column1": { + "type": "string" + }, + "column2": { + "type": "number" + } + } + } + }, + { + "name": "table1", + "supported_sync_modes": ["full_refresh", "incremental"], + "source_defined_cursor": false, + "json_schema": { + "$schema": "http://json-schema.org/draft-07/schema#", + "type": "object", + "properties": { + "column1": { + "type": "string" + }, + "column2": { + "type": "number" + } + } + } + } + ] +} diff --git a/airbyte-integrations/connectors/source-google-webfonts/integration_tests/configured_catalog.json b/airbyte-integrations/connectors/source-google-webfonts/integration_tests/configured_catalog.json new file mode 100644 index 000000000000..2875f8637421 --- /dev/null +++ b/airbyte-integrations/connectors/source-google-webfonts/integration_tests/configured_catalog.json @@ -0,0 +1,13 @@ +{ + "streams": [ + { + "stream": { + "name": "fonts", + "json_schema": {}, + "supported_sync_modes": ["full_refresh"] + }, + "sync_mode": "full_refresh", + "destination_sync_mode": "overwrite" + } + ] +} diff --git a/airbyte-integrations/connectors/source-google-webfonts/integration_tests/invalid_config.json b/airbyte-integrations/connectors/source-google-webfonts/integration_tests/invalid_config.json new file mode 100644 index 000000000000..316264c50d74 --- /dev/null +++ b/airbyte-integrations/connectors/source-google-webfonts/integration_tests/invalid_config.json @@ -0,0 +1,6 @@ +{ + "api_key": "", + "sort": "", + "prettyPrint": "", + "alt": "" +} diff --git a/airbyte-integrations/connectors/source-google-webfonts/integration_tests/sample_config.json b/airbyte-integrations/connectors/source-google-webfonts/integration_tests/sample_config.json new file mode 100644 index 000000000000..93b02698274d --- /dev/null +++ b/airbyte-integrations/connectors/source-google-webfonts/integration_tests/sample_config.json @@ -0,0 +1,6 @@ +{ + "api_key": "", + "sort": "SORT_UNDEFINED", + "prettyPrint": "true", + "alt": "json" +} diff --git a/airbyte-integrations/connectors/source-google-webfonts/main.py b/airbyte-integrations/connectors/source-google-webfonts/main.py new file mode 100644 index 000000000000..065faa3891bf --- /dev/null +++ b/airbyte-integrations/connectors/source-google-webfonts/main.py @@ -0,0 +1,13 @@ +# +# Copyright (c) 2022 Airbyte, Inc., all rights reserved. +# + + +import sys + +from airbyte_cdk.entrypoint import launch +from source_google_webfonts import SourceGoogleWebfonts + +if __name__ == "__main__": + source = SourceGoogleWebfonts() + launch(source, sys.argv[1:]) diff --git a/airbyte-integrations/connectors/source-google-webfonts/requirements.txt b/airbyte-integrations/connectors/source-google-webfonts/requirements.txt new file mode 100644 index 000000000000..0411042aa091 --- /dev/null +++ b/airbyte-integrations/connectors/source-google-webfonts/requirements.txt @@ -0,0 +1,2 @@ +-e ../../bases/source-acceptance-test +-e . diff --git a/airbyte-integrations/connectors/source-google-webfonts/setup.py b/airbyte-integrations/connectors/source-google-webfonts/setup.py new file mode 100644 index 000000000000..f290fc2148d4 --- /dev/null +++ b/airbyte-integrations/connectors/source-google-webfonts/setup.py @@ -0,0 +1,29 @@ +# +# Copyright (c) 2022 Airbyte, Inc., all rights reserved. +# + + +from setuptools import find_packages, setup + +MAIN_REQUIREMENTS = [ + "airbyte-cdk~=0.1", +] + +TEST_REQUIREMENTS = [ + "pytest~=6.1", + "pytest-mock~=3.6.1", + "source-acceptance-test", +] + +setup( + name="source_google_webfonts", + description="Source implementation for Google Webfonts.", + author="Airbyte", + author_email="contact@airbyte.io", + packages=find_packages(), + install_requires=MAIN_REQUIREMENTS, + package_data={"": ["*.json", "*.yaml", "schemas/*.json", "schemas/shared/*.json"]}, + extras_require={ + "tests": TEST_REQUIREMENTS, + }, +) diff --git a/airbyte-integrations/connectors/source-google-webfonts/source_google_webfonts/__init__.py b/airbyte-integrations/connectors/source-google-webfonts/source_google_webfonts/__init__.py new file mode 100644 index 000000000000..4045cfdf0228 --- /dev/null +++ b/airbyte-integrations/connectors/source-google-webfonts/source_google_webfonts/__init__.py @@ -0,0 +1,8 @@ +# +# Copyright (c) 2022 Airbyte, Inc., all rights reserved. +# + + +from .source import SourceGoogleWebfonts + +__all__ = ["SourceGoogleWebfonts"] diff --git a/airbyte-integrations/connectors/source-google-webfonts/source_google_webfonts/google_webfonts.yaml b/airbyte-integrations/connectors/source-google-webfonts/source_google_webfonts/google_webfonts.yaml new file mode 100644 index 000000000000..61310dc2ac11 --- /dev/null +++ b/airbyte-integrations/connectors/source-google-webfonts/source_google_webfonts/google_webfonts.yaml @@ -0,0 +1,38 @@ +version: "0.1.0" + +definitions: + selector: + extractor: + field_pointer: ["items"] + requester: + url_base: "https://webfonts.googleapis.com/v1" + http_method: "GET" + authenticator: + type: ApiKeyAuthenticator + header: "apikey" + api_token: "{{ config['api_key'] }}" + + retriever: + record_selector: + $ref: "*ref(definitions.selector)" + paginator: + type: NoPagination + requester: + $ref: "*ref(definitions.requester)" + + base_stream: + retriever: + $ref: "*ref(definitions.retriever)" + + fonts_stream: + $ref: "*ref(definitions.base_stream)" + $options: + name: "fonts" + path: "/webfonts?key={{ config['api_key'] }}&sort={{ config['sort'] or 'SORT_UNDEFINED'}}&prettyPrint={{ config['prettyPrint'] or 'true'}}&alt={{ config['alt'] or 'json'}}" + +streams: + - "*ref(definitions.fonts_stream)" + +check: + stream_names: + - "fonts" diff --git a/airbyte-integrations/connectors/source-google-webfonts/source_google_webfonts/schemas/fonts.json b/airbyte-integrations/connectors/source-google-webfonts/source_google_webfonts/schemas/fonts.json new file mode 100644 index 000000000000..9c62b02dc329 --- /dev/null +++ b/airbyte-integrations/connectors/source-google-webfonts/source_google_webfonts/schemas/fonts.json @@ -0,0 +1,111 @@ +{ + "definitions": {}, + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "https://example.com/object1666796406.json", + "title": "Root", + "type": "object", + "properties": { + "kind": { + "$id": "#root/kind", + "title": "Kind", + "type": "string", + "default": "", + "pattern": "^.*$" + }, + "items": { + "$id": "#root/items", + "title": "Items", + "type": "array", + "default": [], + "items": { + "$id": "#root/items/items", + "title": "Items", + "type": "object", + "properties": { + "family": { + "$id": "#root/items/items/family", + "title": "Family", + "type": "string", + "default": "", + "pattern": "^.*$" + }, + "variants": { + "$id": "#root/items/items/variants", + "title": "Variants", + "type": "array", + "default": [], + "items": { + "$id": "#root/items/items/variants/items", + "title": "Items", + "type": "string", + "default": "", + "pattern": "^.*$" + } + }, + "subsets": { + "$id": "#root/items/items/subsets", + "title": "Subsets", + "type": "array", + "default": [], + "items": { + "$id": "#root/items/items/subsets/items", + "title": "Items", + "type": "string", + "default": "", + "pattern": "^.*$" + } + }, + "version": { + "$id": "#root/items/items/version", + "title": "Version", + "type": "string", + "default": "", + "pattern": "^.*$" + }, + "lastModified": { + "$id": "#root/items/items/lastModified", + "title": "Lastmodified", + "type": "string", + "default": "", + "pattern": "^.*$" + }, + "files": { + "$id": "#root/items/items/files", + "title": "Files", + "type": "object", + "properties": { + "regular": { + "$id": "#root/items/items/files/regular", + "title": "Regular", + "type": "string", + "default": "", + "pattern": "^.*$" + }, + "italic": { + "$id": "#root/items/items/files/italic", + "title": "Italic", + "type": "string", + "default": "", + "pattern": "^.*$" + } + } + }, + "category": { + "$id": "#root/items/items/category", + "title": "Category", + "type": "string", + "default": "", + "pattern": "^.*$" + }, + "kind": { + "$id": "#root/items/items/kind", + "title": "Kind", + "type": "string", + "default": "", + "pattern": "^.*$" + } + } + } + } + } +} diff --git a/airbyte-integrations/connectors/source-google-webfonts/source_google_webfonts/source.py b/airbyte-integrations/connectors/source-google-webfonts/source_google_webfonts/source.py new file mode 100644 index 000000000000..353c6e585164 --- /dev/null +++ b/airbyte-integrations/connectors/source-google-webfonts/source_google_webfonts/source.py @@ -0,0 +1,18 @@ +# +# Copyright (c) 2022 Airbyte, Inc., all rights reserved. +# + +from airbyte_cdk.sources.declarative.yaml_declarative_source import YamlDeclarativeSource + +""" +This file provides the necessary constructs to interpret a provided declarative YAML configuration file into +source connector. + +WARNING: Do not modify this file. +""" + + +# Declarative Source +class SourceGoogleWebfonts(YamlDeclarativeSource): + def __init__(self): + super().__init__(**{"path_to_yaml": "google_webfonts.yaml"}) diff --git a/airbyte-integrations/connectors/source-google-webfonts/source_google_webfonts/spec.yaml b/airbyte-integrations/connectors/source-google-webfonts/source_google_webfonts/spec.yaml new file mode 100644 index 000000000000..ebc80b05ad5a --- /dev/null +++ b/airbyte-integrations/connectors/source-google-webfonts/source_google_webfonts/spec.yaml @@ -0,0 +1,22 @@ +documentationUrl: https://docs.airbyte.com/integrations/sources/google-webfonts +connectionSpecification: + $schema: http://json-schema.org/draft-07/schema# + title: Google Webfonts Spec + type: object + required: + - api_key + additionalProperties: true + properties: + api_key: + type: string + description: API key is required to access google apis, For getting your's goto google console and generate api key for Webfonts + airbyte_secret: true + sort: + type: string + description: Optional, to find how to sort + prettyPrint: + type: string + description: Optional, boolean type + alt: + type: string + description: Optional, Available params- json, media, proto diff --git a/docs/integrations/README.md b/docs/integrations/README.md index 1cff87839588..afaa4b6ecbec 100644 --- a/docs/integrations/README.md +++ b/docs/integrations/README.md @@ -77,6 +77,7 @@ For more information about the grading system, see [Product Release Stages](http | [Google Directory](sources/google-directory.md) | Alpha | Yes | | [Google Search Console](sources/google-search-console.md) | Generally Available | Yes | | [Google Sheets](sources/google-sheets.md) | Generally Available | Yes | +| [Google Webfonts](sources/google-webfonts.md) | Alpha | Yes | | [Google Workspace Admin Reports](sources/google-workspace-admin-reports.md) | Alpha | Yes | | [Greenhouse](sources/greenhouse.md) | Beta | Yes | | [Gutendex](sources/gutendex.md) | Alpha | No | diff --git a/docs/integrations/sources/google-webfonts.md b/docs/integrations/sources/google-webfonts.md new file mode 100644 index 000000000000..b3a5e69ab01e --- /dev/null +++ b/docs/integrations/sources/google-webfonts.md @@ -0,0 +1,68 @@ +# Google-webfonts + +This page contains the setup guide and reference information for the [Google-webfonts](https://developers.google.com/fonts/docs/developer_api) source connector. + +## Prerequisites + +Api key is mandate for this connector to work, It could be generated by a gmail account for free at https://console.cloud.google.com/apis/dashboard. +Just pass the generated API key and optional parameters for establishing the connection. Example:123 + +## Setup guide + +### Step 1: Set up Google-webfonts connection + +- Generate an API key (Example: 12345) +- Params (If specific info is needed) +- Available params + - sort: SORT_UNDEFINED, ALPHA, DATE, STYLE, TRENDING, POPULARITY + - alt: json, media or proto + - prettyPrint: boolean + +## Step 2: Set up the Google-webfonts connector in Airbyte + +### For Airbyte Cloud: + +1. [Log into your Airbyte Cloud](https://cloud.airbyte.io/workspaces) account. +2. In the left navigation bar, click **Sources**. In the top-right corner, click **+new source**. +3. On the Set up the source page, enter the name for the Google-webfonts connector and select **Google-webfonts** from the Source type dropdown. +4. Enter your `api_key`. +5. Enter the params configuration if needed. Supported params are: sort, alt, prettyPrint (Optional) +6. Click **Set up source**. + +### For Airbyte OSS: + +1. Navigate to the Airbyte Open Source dashboard. +2. Set the name for your source. +3. Enter your `api_key`. +5. Enter the params configuration if needed. Supported params are: sort, alt, prettyPrint (Optional) +6. Click **Set up source**. + +## Supported sync modes + +The Google-webfonts source connector supports the following [sync modes](https://docs.airbyte.com/cloud/core-concepts#connection-sync-modes): + +| Feature | Supported? | +| :---------------------------- | :--------- | +| Full Refresh Sync | Yes | +| Incremental Sync | No | +| Replicate Incremental Deletes | No | +| SSL connection | Yes | +| Namespaces | No | + +## Supported Streams + +- Webfonts (Single stream API) + +## API method example + +GET https://webfonts.googleapis.com/v1/webfonts?key=<1234567>&sort=SORT_UNDEFINED&prettyPrint=true&alt=json + +## Performance considerations + +Google Webfont's [API reference](https://developers.google.com/fonts/docs/developer_api) has v1 at present and v2 is at development. The connector as default uses v1. + +## Changelog + +| Version | Date | Pull Request | Subject | +| :------ | :--------- | :----------------------------------------------------- | :------------- | +| 0.1.0 | 2022-10-26 | [Init](https://github.com/airbytehq/airbyte/pull/18496)| Initial commit | \ No newline at end of file