🎉 Source SurveyMonkey: add survey_collectors and collectors stream (

airbytehq#23721)

* add survey_collectors stream

* add stream to docs

* add missing schema

* fix stream and add expected records

* remove unused file

* bump connector version

* fix unit test

* add doc url for surveycollectors

* update expected records

* auto-bump connector version

---------

Co-authored-by: sh4sh <6833405+sh4sh@users.noreply.github.com>
Co-authored-by: marcosmarxm <marcosmarxm@gmail.com>
Co-authored-by: Marcos Marx <marcosmarxm@users.noreply.github.com>
Co-authored-by: Octavia Squidington III <octavia-squidington-iii@users.noreply.github.com>

airbyte-config-oss/init-oss/src/main/resources/seed/oss_catalog.json

@@ -24906,7 +24906,7 @@
     "sourceDefinitionId": "badc5925-0485-42be-8caa-b34096cb71b5",
     "name": "SurveyMonkey",
     "dockerRepository": "airbyte/source-surveymonkey",
-    "dockerImageTag": "0.1.16",
+    "dockerImageTag": "0.2.0",
     "documentationUrl": "https://docs.airbyte.com/integrations/sources/surveymonkey",
     "icon": "surveymonkey.svg",
     "sourceType": "api",

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

@@ -2044,7 +2044,7 @@
 - name: SurveyMonkey
   sourceDefinitionId: badc5925-0485-42be-8caa-b34096cb71b5
   dockerRepository: airbyte/source-surveymonkey
-  dockerImageTag: 0.1.16
+  dockerImageTag: 0.2.0
   documentationUrl: https://docs.airbyte.com/integrations/sources/surveymonkey
   icon: surveymonkey.svg
   sourceType: api

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

@@ -15295,7 +15295,7 @@
     supportsNormalization: false
     supportsDBT: false
     supported_destination_sync_modes: []
-- dockerImage: "airbyte/source-surveymonkey:0.1.16"
+- dockerImage: "airbyte/source-surveymonkey:0.2.0"
   spec:
     documentationUrl: "https://docs.airbyte.com/integrations/sources/surveymonkey"
     connectionSpecification:

airbyte-integrations/connectors/source-surveymonkey/Dockerfile

@@ -12,5 +12,5 @@ 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.16
+LABEL io.airbyte.version=0.2.0
 LABEL io.airbyte.name=airbyte/source-surveymonkey

airbyte-integrations/connectors/source-surveymonkey/integration_tests/configured_catalog.json

@@ -47,6 +47,30 @@
       "sync_mode": "full_refresh",
       "cursor_field": [],
       "destination_sync_mode": "append"
+    },
+    {
+      "stream": {
+        "name": "survey_collectors",
+        "json_schema": {},
+        "supported_sync_modes": ["full_refresh"],
+        "source_defined_cursor": true,
+        "default_cursor_field": []
+      },
+      "sync_mode": "full_refresh",
+      "cursor_field": [],
+      "destination_sync_mode": "append"
+    },
+    {
+      "stream": {
+        "name": "collectors",
+        "json_schema": {},
+        "supported_sync_modes": ["full_refresh"],
+        "source_defined_cursor": true,
+        "default_cursor_field": []
+      },
+      "sync_mode": "full_refresh",
+      "cursor_field": [],
+      "destination_sync_mode": "append"
     }
   ]
 }

airbyte-integrations/connectors/source-surveymonkey/integration_tests/survey_collectors.json

@@ -0,0 +1,22 @@
+{
+  "streams": [
+    {
+      "stream": {
+        "name": "collectors",
+        "json_schema": {},
+        "supported_sync_modes": ["full_refresh"]
+      },
+      "sync_mode": "full_refresh",
+      "destination_sync_mode": "append"
+    },
+    {
+      "stream": {
+        "name": "survey_collectors",
+        "json_schema": {},
+        "supported_sync_modes": ["full_refresh"]
+      },
+      "sync_mode": "full_refresh",
+      "destination_sync_mode": "append"
+    }
+  ]
+}

airbyte-integrations/connectors/source-surveymonkey/source_surveymonkey/schemas/collectors.json

@@ -0,0 +1,87 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "additionalProperties": true,
+  "properties": {
+    "id": {
+      "type": ["string", "null"]
+    },
+    "status": {
+      "type": ["string", "null"]
+    },
+    "survey_id": {
+      "type": ["string", "null"]
+    },
+    "type": {
+      "type": ["string", "null"]
+    },
+    "name": {
+      "type": ["string", "null"]
+    },
+    "thank_you_message": {
+      "type": ["string", "null"]
+    },
+    "thank_you_page": {
+      "type": ["object", "null"],
+      "additionalProperties": true,
+      "properties": {
+        "is_enabled": {
+          "type": ["boolean", "null"]
+        },
+        "message": {
+          "type": ["string", "null"]
+        }
+      }
+    },
+    "disqualification_message": {
+      "type": ["string", "null"]
+    },
+    "disqualification_url": {
+      "type": ["string", "null"]
+    },
+    "close_date": {
+      "type": ["string", "null"],
+      "format": "date-time"
+    },
+    "closed_page_message": {
+      "type": ["string", "null"]
+    },
+    "redirect_url": {
+      "type": ["string", "null"]
+    },
+    "display_survey_results": {
+      "type": ["boolean", "null"]
+    },
+    "edit_response_type": {
+      "type": ["string", "null"]
+    },
+    "anonymous_type": {
+      "type": ["string", "null"]
+    },
+    "allow_multiple_responses": {
+      "type": ["boolean", "null"]
+    },
+    "date_modified": {
+      "type": ["string", "null"],
+      "format": "date-time"
+    },
+    "sender_email": {
+      "type": ["string", "null"]
+    },
+    "password_enabled": {
+      "type": ["boolean", "null"]
+    },
+    "response_limit": {
+      "type": ["number", "null"]
+    },
+    "redirect_type": {
+      "type": ["string", "null"]
+    },
+    "respondent_authentication": {
+      "type": ["boolean", "null"]
+    },
+    "href": {
+      "type": ["string", "null"]
+    }
+  }
+}

airbyte-integrations/connectors/source-surveymonkey/source_surveymonkey/schemas/survey_collectors.json

@@ -0,0 +1,19 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "additionalProperties": true,
+  "properties": {
+    "id": {
+      "type": ["string", "null"]
+    },
+    "name": {
+      "type": ["string", "null"]
+    },
+    "href": {
+      "type": ["string", "null"]
+    },
+    "survey_id": {
+      "type": ["string", "null"]
+    }
+  }
+}

airbyte-integrations/connectors/source-surveymonkey/source_surveymonkey/source.py

@@ -13,7 +13,7 @@
 from airbyte_cdk.sources.streams import Stream
 from airbyte_cdk.sources.streams.http.auth import TokenAuthenticator
 
-from .streams import SurveyPages, SurveyQuestions, SurveyResponses, Surveys
+from .streams import Collectors, SurveyCollectors, SurveyPages, SurveyQuestions, SurveyResponses, Surveys
 
 
 class SourceSurveymonkey(AbstractSource):
@@ -74,7 +74,14 @@ def streams(self, config: Mapping[str, Any]) -> List[Stream]:
         start_date = pendulum.parse(config["start_date"])
         survey_ids = config.get("survey_ids", [])
         args = {"authenticator": authenticator, "start_date": start_date, "survey_ids": survey_ids}
-        return [Surveys(**args), SurveyPages(**args), SurveyQuestions(**args), SurveyResponses(**args)]
+        return [
+            Collectors(**args),
+            Surveys(**args),
+            SurveyCollectors(**args),
+            SurveyPages(**args),
+            SurveyQuestions(**args),
+            SurveyResponses(**args),
+        ]
 
     @staticmethod
     def get_authenticator(config: Mapping[str, Any]):

airbyte-integrations/connectors/source-surveymonkey/source_surveymonkey/streams.py

@@ -262,3 +262,37 @@ def request_params(self, stream_state: Mapping[str, Any], stream_slice: Mapping[
             since_value = self._start_date
         params["start_modified_at"] = since_value.strftime("%Y-%m-%dT%H:%M:%S")
         return params
+
+
+class SurveyCollectors(SurveyIDSliceMixin, SurveymonkeyStream):
+    """
+    API Docs: https://www.surveymonkey.com/developer/api/v3/#api-endpoints-get-surveys-id-collectors
+    """
+
+    def path(self, stream_slice: Mapping[str, Any] = None, **kwargs) -> str:
+        return f"surveys/{ stream_slice['survey_id'] }/collectors"
+
+    def parse_response(self, response: requests.Response, stream_state: Mapping[str, Any], **kwargs) -> Iterable[Mapping]:
+        data = super().parse_response(response=response, stream_state=stream_state, **kwargs)
+        for record in data:
+            record["survey_id"] = kwargs.get("stream_slice", {}).get("survey_id")
+            yield record
+
+
+class Collectors(SurveymonkeyStream):
+    """
+    API Docs: https://www.surveymonkey.com/developer/api/v3/#api-endpoints-get-collectors-id-
+    """
+
+    data_field = None
+
+    def path(self, stream_slice: Mapping[str, Any] = None, **kwargs) -> str:
+        return f"collectors/{stream_slice['collector_id']}"
+
+    def stream_slices(self, stream_state: Mapping[str, Any] = None, **kwargs):
+
+        survey_collectors = SurveyCollectors(start_date=self._start_date, survey_ids=self._survey_ids, authenticator=self.authenticator)
+        survey_ids = survey_collectors.stream_slices(stream_state, **kwargs)
+        for slice in survey_ids:
+            for collector in survey_collectors.read_records(sync_mode=SyncMode.full_refresh, stream_state=stream_state, stream_slice=slice):
+                yield {"collector_id": collector["id"]}

airbyte-integrations/connectors/source-surveymonkey/unit_tests/test_source.py

@@ -15,7 +15,7 @@
 
 def test_source_streams():
     streams = SourceSurveymonkey().streams(config=new_source_config)
-    assert len(streams) == 4
+    assert len(streams) == 6
 
 
 def test_source_check_connection_old_config(requests_mock):

airbyte-integrations/connectors/source-surveymonkey/unit_tests/test_streams.py

@@ -8,7 +8,7 @@
 import pytest
 from airbyte_cdk.models import SyncMode
 from airbyte_cdk.sources.streams.http.auth import NoAuth
-from source_surveymonkey.streams import SurveyIds, SurveyPages, SurveyQuestions, SurveyResponses, Surveys
+from source_surveymonkey.streams import SurveyCollectors, SurveyIds, SurveyPages, SurveyQuestions, SurveyResponses, Surveys
 
 args_mock = {"authenticator": NoAuth(), "start_date": pendulum.parse("2000-01-01"), "survey_ids": []}
 
@@ -326,10 +326,31 @@ def test_survey_questions(requests_mock):
     ]
 
 
+def test_survey_collectors(requests_mock):
+    requests_mock.get("https://api.surveymonkey.com/v3/surveys/307785415/collectors", json={
+        "data": [{"name": "Teams Poll", "id": "1", "href": "https://api.surveymonkey.com/v3/collectors/1"}],
+        "per_page": 50,
+        "page": 1,
+        "total": 1,
+        "links": {
+            "self": "https://api.surveymonkey.com/v3/surveys/307785415/collectors?page=1&per_page=50"
+        }
+    })
+    args = {**args_mock, **{"survey_ids": ["307785415"]}}
+    records = SurveyCollectors(**args).read_records(sync_mode=SyncMode.full_refresh, stream_slice={"survey_id": "307785415"})
+    assert list(records) == [
+        {
+            "name": "Teams Poll",
+            "id": "1",
+            "href": "https://api.surveymonkey.com/v3/collectors/1",
+            "survey_id": "307785415"
+        }
+    ]
+
+
 def test_surveys_next_page_token():
     args = {**args_mock, **{"survey_ids": ["307785415"]}}
     stream = SurveyIds(**args)
-
     mockresponse = Mock()
     mockresponse.json.return_value = {
         "links": {

connectors.md

@@ -233,7 +233,7 @@
 | **Strava** | <img alt="Strava icon" src="https://raw.githubusercontent.com/airbytehq/airbyte /master/airbyte-config-oss/init-oss/src/main/resources/icons/strava.svg" height="30" height="30"/> | Source | airbyte/source-strava:0.1.4 | beta | [docs](https://docs.airbyte.com/integrations/sources/strava) | [connectors/source/strava](https://github.com/airbytehq/airbyte/issues?q=is:open+is:issue+label:connectors/source/strava) | [source-strava](https://github.com/airbytehq/airbyte/tree/master/airbyte-integrations/connectors/source-strava) | <small>`7a4327c4-315a-11ec-8d3d-0242ac130003`</small> |
 | **Stripe** | <img alt="Stripe icon" src="https://raw.githubusercontent.com/airbytehq/airbyte /master/airbyte-config-oss/init-oss/src/main/resources/icons/stripe.svg" height="30" height="30"/> | Source | airbyte/source-stripe:3.4.1 | generally_available | [docs](https://docs.airbyte.com/integrations/sources/stripe) | [connectors/source/stripe](https://github.com/airbytehq/airbyte/issues?q=is:open+is:issue+label:connectors/source/stripe) | [source-stripe](https://github.com/airbytehq/airbyte/tree/master/airbyte-integrations/connectors/source-stripe) | <small>`e094cb9a-26de-4645-8761-65c0c425d1de`</small> |
 | **SurveyCTO** | <img alt="SurveyCTO icon" src="https://raw.githubusercontent.com/airbytehq/airbyte /master/airbyte-config-oss/init-oss/src/main/resources/icons/surveycto.svg" height="30" height="30"/> | Source | airbyte/source-surveycto:0.1.1 | alpha | [docs](https://docs.airbyte.com/integrations/sources/surveycto) | [connectors/source/surveycto](https://github.com/airbytehq/airbyte/issues?q=is:open+is:issue+label:connectors/source/surveycto) | [source-surveycto](https://github.com/airbytehq/airbyte/tree/master/airbyte-integrations/connectors/source-surveycto) | <small>`dd4632f4-15e0-4649-9b71-41719fb1fdee`</small> |
-| **SurveyMonkey** | <img alt="SurveyMonkey icon" src="https://raw.githubusercontent.com/airbytehq/airbyte /master/airbyte-config-oss/init-oss/src/main/resources/icons/surveymonkey.svg" height="30" height="30"/> | Source | airbyte/source-surveymonkey:0.1.16 | generally_available | [docs](https://docs.airbyte.com/integrations/sources/surveymonkey) | [connectors/source/surveymonkey](https://github.com/airbytehq/airbyte/issues?q=is:open+is:issue+label:connectors/source/surveymonkey) | [source-surveymonkey](https://github.com/airbytehq/airbyte/tree/master/airbyte-integrations/connectors/source-surveymonkey) | <small>`badc5925-0485-42be-8caa-b34096cb71b5`</small> |
+| **SurveyMonkey** | <img alt="SurveyMonkey icon" src="https://raw.githubusercontent.com/airbytehq/airbyte /master/airbyte-config-oss/init-oss/src/main/resources/icons/surveymonkey.svg" height="30" height="30"/> | Source | airbyte/source-surveymonkey:0.2.0 | generally_available | [docs](https://docs.airbyte.com/integrations/sources/surveymonkey) | [connectors/source/surveymonkey](https://github.com/airbytehq/airbyte/issues?q=is:open+is:issue+label:connectors/source/surveymonkey) | [source-surveymonkey](https://github.com/airbytehq/airbyte/tree/master/airbyte-integrations/connectors/source-surveymonkey) | <small>`badc5925-0485-42be-8caa-b34096cb71b5`</small> |
 | **SurveySparrow** | <img alt="SurveySparrow icon" src="https://raw.githubusercontent.com/airbytehq/airbyte /master/airbyte-config-oss/init-oss/src/main/resources/icons/surveysparrow.svg" height="30" height="30"/> | Source | airbyte/source-survey-sparrow:0.2.0 | alpha | [docs](https://docs.airbyte.com/integrations/sources/survey-sparrow) | [connectors/source/survey-sparrow](https://github.com/airbytehq/airbyte/issues?q=is:open+is:issue+label:connectors/source/survey-sparrow) | [source-survey-sparrow](https://github.com/airbytehq/airbyte/tree/master/airbyte-integrations/connectors/source-survey-sparrow) | <small>`4a4d887b-0f2d-4b33-ab7f-9b01b9072804`</small> |
 | **TMDb** | <img alt="TMDb icon" src="https://raw.githubusercontent.com/airbytehq/airbyte /master/airbyte-config-oss/init-oss/src/main/resources/icons/tmdb.svg" height="30" height="30"/> | Source | airbyte/source-tmdb:0.1.0 | alpha | [docs](https://docs.airbyte.com/integrations/sources/tmdb) | [connectors/source/tmdb](https://github.com/airbytehq/airbyte/issues?q=is:open+is:issue+label:connectors/source/tmdb) | [source-tmdb](https://github.com/airbytehq/airbyte/tree/master/airbyte-integrations/connectors/source-tmdb) | <small>`6240848f-f795-45eb-8f5e-c7542822fc03`</small> |
 | **TPLcentral** | x | Source | airbyte/source-tplcentral:0.1.1 | alpha | [docs](https://docs.airbyte.com/integrations/sources/tplcentral) | [connectors/source/tplcentral](https://github.com/airbytehq/airbyte/issues?q=is:open+is:issue+label:connectors/source/tplcentral) | [source-tplcentral](https://github.com/airbytehq/airbyte/tree/master/airbyte-integrations/connectors/source-tplcentral) | <small>`f9b6c538-ee12-42fe-8d4b-0c10f5955417`</small> |

docs/integrations/sources/surveymonkey.md

@@ -51,6 +51,7 @@ Please read this [docs](https://developer.surveymonkey.com/api/v3/#getting-start
 * [SurveyPages](https://developer.surveymonkey.com/api/v3/#surveys-id-pages)
 * [SurveyQuestions](https://developer.surveymonkey.com/api/v3/#surveys-id-pages-id-questions)
 * [SurveyResponses](https://developer.surveymonkey.com/api/v3/#survey-responses) \(Incremental\)
+* [SurveyCollectors](https://developer.surveymonkey.com/api/v3/#api-endpoints-get-surveys-id-collectors)
 
 ### Performance considerations
 
@@ -65,6 +66,7 @@ To cover more data from this source we use caching.
 
 | Version | Date       | Pull Request                                             | Subject                                                                |
 |:--------| :--------- | :------------------------------------------------------- | :--------------------------------------------------------------------- |
+| 0.2.0   | 2023-04-18 | [23721](https://github.com/airbytehq/airbyte/pull/23721) |  Add `SurveyCollectors` and `Collectors` stream                                              |
 | 0.1.16  | 2023-04-13 | [25080](https://github.com/airbytehq/airbyte/pull/25080) |  Fix spec.json required fields and update schema for surveys and survey_responses                    |
 | 0.1.15  | 2023-02-11 | [22865](https://github.com/airbytehq/airbyte/pull/22865) | Specified date formatting in specification                                                     |
 | 0.1.14  | 2023-01-27 | [22024](https://github.com/airbytehq/airbyte/pull/22024) | Set `AvailabilityStrategy` for streams explicitly to `None`                                                     |