✨Source Freshsales: Make Connector Compatible with Builder

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

@@ -1,117 +1,103 @@
 # Freshsales Source
 
-This is the repository for the Freshsales source connector, written in Python.
-For information about how to use this connector within Airbyte, see [the documentation](https://docs.airbyte.io/integrations/sources/freshsales).
+This is the repository for the Freshsales configuration based source connector.
+For information about how to use this connector within Airbyte, see [the documentation](https://docs.airbyte.com/integrations/sources/freshsales).
 
 ## Local development
 
 ### Prerequisites
 
-**To iterate on this connector, make sure to complete this prerequisites section.**
+* Python (`^3.9`)
+* Poetry (`^1.7`) - installation instructions [here](https://python-poetry.org/docs/#installation)
 
-#### Minimum Python version required `= 3.7.0`
 
-#### Build & Activate Virtual Environment and install dependencies
 
-From this connector directory, create a virtual environment:
+### Installing the connector
 
+From this connector directory, run:
+```bash
+poetry install --with dev
 ```
-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.
 
-#### Create credentials
+### Create credentials
 
-**If you are a community contributor**, follow the instructions in the [documentation](https://docs.airbyte.io/integrations/sources/freshsales)
-to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `source_freshsales/spec.json` file.
+**If you are a community contributor**, follow the instructions in the [documentation](https://docs.airbyte.com/integrations/sources/freshsales)
+to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `src/source_freshsales/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.
+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 freshsales 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
+poetry run source-freshsales spec
+poetry run source-freshsales check --config secrets/config.json
+poetry run source-freshsales discover --config secrets/config.json
+poetry run source-freshsales read --config secrets/config.json --catalog integration_tests/configured_catalog.json
 ```
 
-### Locally running the connector docker image
+### Running tests
 
-#### Build
+To run tests locally, from the connector directory run:
+
+```
+poetry run pytest tests
+```
 
-**Via [`airbyte-ci`](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/pipelines/README.md) (recommended):**
+### Building the docker image
 
+1. Install [`airbyte-ci`](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/pipelines/README.md)
+2. Run the following command to build the docker image:
 ```bash
 airbyte-ci connectors --name=source-freshsales build
 ```
 
-An image will be built with the tag `airbyte/source-freshsales:dev`.
+An image will be available on your host with the tag `airbyte/source-freshsales:dev`.
 
-**Via `docker build`:**
 
-```bash
-docker build -t airbyte/source-freshsales:dev .
-```
-
-#### Run
+### Running as a docker container
 
 Then run any of the connector commands as follows:
-
 ```
 docker run --rm airbyte/source-freshsales:dev spec
 docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-freshsales:dev check --config /secrets/config.json
 docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-freshsales:dev discover --config /secrets/config.json
 docker run --rm -v $(pwd)/secrets:/secrets -v $(pwd)/integration_tests:/integration_tests airbyte/source-freshsales:dev read --config /secrets/config.json --catalog /integration_tests/configured_catalog.json
 ```
 
-## Testing
+### Running our CI test suite
 
 You can run our full test suite locally using [`airbyte-ci`](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/pipelines/README.md):
-
 ```bash
 airbyte-ci connectors --name=source-freshsales test
 ```
 
 ### Customizing acceptance Tests
 
-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.
+Customize `acceptance-test-config.yml` file to configure acceptance 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.
 
-## Dependency Management
+### 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:
+All of your dependencies should be managed via Poetry. 
+To add a new dependency, run:
+```bash
+poetry add <package-name>
+```
 
-- required for your connector to work need to go to `MAIN_REQUIREMENTS` list.
-- required for the testing need to go to `TEST_REQUIREMENTS` list
+Please commit the changes to `pyproject.toml` and `poetry.lock` files.
 
-### Publishing a new version of the connector
+## 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 our test suite: `airbyte-ci connectors --name=source-freshsales test`
-2. Bump the connector version in `metadata.yaml`: increment the `dockerImageTag` value. Please follow [semantic versioning for connectors](https://docs.airbyte.com/contributing-to-airbyte/resources/pull-requests-handbook/#semantic-versioning-for-connectors).
+2. Bump the connector version (please follow [semantic versioning for connectors](https://docs.airbyte.com/contributing-to-airbyte/resources/pull-requests-handbook/#semantic-versioning-for-connectors)): 
+    - bump the `dockerImageTag` value in in `metadata.yaml`
+    - bump the `version` value in `pyproject.toml`
 3. Make sure the `metadata.yaml` content is up to date.
-4. Make the connector documentation and its changelog is up to date (`docs/integrations/sources/freshsales.md`).
+4. Make sure the connector documentation and its changelog is up to date (`docs/integrations/sources/freshsales.md`).
 5. Create a Pull Request: use [our PR naming conventions](https://docs.airbyte.com/contributing-to-airbyte/resources/pull-requests-handbook/#pull-request-title-convention).
 6. Pat yourself on the back for being an awesome contributor.
 7. Someone from Airbyte will take a look at your PR and iterate with you to merge it into master.
+8. Once your PR is merged, the new version of the connector will be automatically published to Docker Hub and our connector registry.

airbyte-integrations/connectors/source-freshsales/__init__.py

@@ -0,0 +1,3 @@
+#
+# Copyright (c) 2024 Airbyte, Inc., all rights reserved.
+#

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

@@ -20,6 +20,13 @@ acceptance_tests:
       - config_path: "secrets/config.json"
         expect_records:
           path: "integration_tests/expected_records.jsonl"
+        empty_streams:
+          - name: "sales_accounts_filter"
+            bypass_reason: "users are not expected to use this stream, it is used as a parent stream of other streams in this connector"
+          - name: "deals_filter"
+            bypass_reason: "users are not expected to use this stream, it is used as a parent stream of other streams in this connector"
+          - name: "contacts_filters"
+            bypass_reason: "users are not expected to use this stream, it is used as a parent stream of other streams in this connector"
   full_refresh:
     tests:
       - config_path: "secrets/config.json"

airbyte-integrations/connectors/source-freshsales/integration_tests/__init__.py

@@ -1,3 +1,3 @@
 #
-# Copyright (c) 2021 Airbyte, Inc., all rights reserved.
+# Copyright (c) 2024 Airbyte, Inc., all rights reserved.
 #

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

@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2023 Airbyte, Inc., all rights reserved.
+# Copyright (c) 2024 Airbyte, Inc., all rights reserved.
 #
 
 

airbyte-integrations/connectors/source-freshsales/integration_tests/integration_test.py

@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2023 Airbyte, Inc., all rights reserved.
+# Copyright (c) 2024 Airbyte, Inc., all rights reserved.
 #
 
 

airbyte-integrations/connectors/source-freshsales/main.py

@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2023 Airbyte, Inc., all rights reserved.
+# Copyright (c) 2024 Airbyte, Inc., all rights reserved.
 #
 
 from source_freshsales.run import run

airbyte-integrations/connectors/source-freshsales/metadata.yaml

@@ -5,32 +5,38 @@ data:
   allowedHosts:
     hosts:
       - "*.myfreshworks.com"
+  registries:
+    oss:
+      enabled: true
+    cloud:
+      enabled: true
+  remoteRegistries:
+    pypi:
+      enabled: true
+      packageName: airbyte-source-freshsales
+  connectorBuildOptions:
+    # Please update to the latest version of the connector base image.
+    # https://hub.docker.com/r/airbyte/python-connector-base
+    # Please use the full address with sha256 hash to guarantee build reproducibility.
+    baseImage: docker.io/airbyte/python-connector-base:1.2.0@sha256:c22a9d97464b69d6ef01898edf3f8612dc11614f05a84984451dde195f337db9
   connectorSubtype: api
   connectorType: source
   definitionId: eca08d79-7b92-4065-b7f3-79c14836ebe7
-  dockerImageTag: 1.0.0
-  releases:
-    breakingChanges:
-      1.0.0:
-        message: "This version migrates the Freshsales connector to our low-code framework for greater maintainability. It also introduces changes to data types across most streams. You will need to run a reset after upgrading to continue syncing data with the connector."
-        upgradeDeadline: "2023-11-29"
+  dockerImageTag: 1.0.1
   dockerRepository: airbyte/source-freshsales
-  documentationUrl: https://docs.airbyte.com/integrations/sources/freshsales
   githubIssueLabel: source-freshsales
   icon: freshsales.svg
   license: MIT
   name: Freshsales
-  remoteRegistries:
-    pypi:
-      enabled: true
-      packageName: airbyte-source-freshsales
-  registries:
-    cloud:
-      enabled: true
-    oss:
-      enabled: true
+  releaseDate: 2021-11-03
   releaseStage: beta
+  releases:
+    breakingChanges:
+      1.0.0:
+        message: "This version migrates the Freshsales connector to our low-code framework for greater maintainability. It also introduces changes to data types across most streams. You will need to run a reset after upgrading to continue syncing data with the connector."
+        upgradeDeadline: "2023-11-29"
   supportLevel: community
+  documentationUrl: https://docs.airbyte.com/integrations/sources/freshsales
   tags:
     - language:python
     - cdk:low-code