port-ocean 0.17.6__py3-none-any.whl → 0.17.7__py3-none-any.whl

port_ocean/core/defaults/initialize.py

@@ -68,7 +68,7 @@ async def _initialize_required_integration_settings(
             )
             integration = await port_client.create_integration(
                 integration_config.integration.type,
-                integration_config.event_listener.to_request(),
+                integration_config.event_listener.get_changelog_destination_details(),
                 port_app_config=default_mapping,
             )
         elif not integration.get("config"):
@@ -77,7 +77,7 @@ async def _initialize_required_integration_settings(
             )
             integration = await port_client.patch_integration(
                 integration_config.integration.type,
-                integration_config.event_listener.to_request(),
+                integration_config.event_listener.get_changelog_destination_details(),
                 port_app_config=default_mapping,
             )
     except httpx.HTTPStatusError as err:
@@ -85,8 +85,10 @@ async def _initialize_required_integration_settings(
         raise err
 
     logger.info("Checking for diff in integration configuration")
-    changelog_destination = integration_config.event_listener.to_request().get(
-        "changelog_destination"
+    changelog_destination = (
+        integration_config.event_listener.get_changelog_destination_details().get(
+            "changelog_destination"
+        )
     )
     if (
         integration.get("changelogDestination") != changelog_destination

port_ocean/core/event_listener/base.py

@@ -78,8 +78,16 @@ class EventListenerSettings(BaseOceanModel, extra=Extra.allow):
     type: str
     should_resync: bool = True
 
-    def to_request(self) -> dict[str, Any]:
+    def get_changelog_destination_details(self) -> dict[str, Any]:
         """
-        Converts the Settings object to a dictionary representation (request format).
+        Returns the changelog destination configuration for the event listener.
+        By default, returns an empty dict. Only KAFKA and WEBHOOK event listeners need to override this
+        to provide their specific changelog destination details.
+
+        Returns:
+            dict[str, Any]: The changelog destination configuration. For example:
+                - KAFKA returns {"type": "KAFKA"}
+                - WEBHOOK returns {"type": "WEBHOOK", "url": "https://example.com/resync"}
+                - Other event listeners return {}
         """
-        return {"type": self.type}
+        return {}

port_ocean/core/event_listener/http.py

@@ -27,9 +27,17 @@ class HttpEventListenerSettings(EventListenerSettings):
     type: Literal["WEBHOOK"]
     app_host: AnyHttpUrl = Field(..., sensitive=True)
 
-    def to_request(self) -> dict[str, Any]:
+    def get_changelog_destination_details(self) -> dict[str, Any]:
+        """
+        Returns the changelog destination configuration for the webhook event listener.
+        For webhook event listeners, this specifies the URL where changelog events should be sent.
+
+        Returns:
+            dict[str, Any]: A dictionary with the webhook URL where changelog events should be sent,
+                           constructed by appending "/resync" to the app_host.
+        """
         return {
-            **super().to_request(),
+            "type": self.type,
             "url": self.app_host + "/resync",
         }
 

port_ocean/core/event_listener/kafka.py

@@ -46,6 +46,19 @@ class KafkaEventListenerSettings(EventListenerSettings):
     kafka_security_enabled: bool = True
     consumer_poll_timeout: int = 1
 
+    def get_changelog_destination_details(self) -> dict[str, Any]:
+        """
+        Returns the changelog destination configuration for the Kafka event listener.
+        For Kafka event listeners, this specifies that changelog events should be sent via Kafka.
+
+        Returns:
+            dict[str, Any]: A dictionary with type "KAFKA" to indicate that changelog events
+                           should be sent through the Kafka message bus.
+        """
+        return {
+            "type": self.type,
+        }
+
 
 class KafkaEventListener(BaseEventListener):
     """

port_ocean/core/event_listener/once.py

@@ -23,9 +23,6 @@ class OnceEventListenerSettings(EventListenerSettings):
 
     type: Literal["ONCE"]
 
-    def to_request(self) -> dict[str, Any]:
-        return {}
-
 
 class OnceEventListener(BaseEventListener):
     """

port_ocean/core/event_listener/polling.py

@@ -27,9 +27,6 @@ class PollingEventListenerSettings(EventListenerSettings):
     resync_on_start: bool = True
     interval: int = 60
 
-    def to_request(self) -> dict[str, Any]:
-        return {}
-
 
 class PollingEventListener(BaseEventListener):
     """

{port_ocean-0.17.6.dist-info → port_ocean-0.17.7.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: port-ocean
-Version: 0.17.6
+Version: 0.17.7
 Summary: Port Ocean is a CLI tool for managing your Port projects.
 Home-page: https://app.getport.io
 Keywords: ocean,port-ocean,port

{port_ocean-0.17.6.dist-info → port_ocean-0.17.7.dist-info}/RECORD

@@ -69,14 +69,14 @@ port_ocean/core/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 port_ocean/core/defaults/__init__.py,sha256=8qCZg8n06WAdMu9s_FiRtDYLGPGHbOuS60vapeUoAks,142
 port_ocean/core/defaults/clean.py,sha256=TOVe5b5FAjFspAkQuKA70k2BClCEFbrQ3xgiAoKXKYE,2427
 port_ocean/core/defaults/common.py,sha256=zJsj7jvlqIMLGXhdASUlbKS8GIAf-FDKKB0O7jB6nx0,4166
-port_ocean/core/defaults/initialize.py,sha256=eX5AMo3fug202lHvnwwGAuYlVbh3yDvUQaimTzre1do,8477
+port_ocean/core/defaults/initialize.py,sha256=PVR0awQc0eFKKD5wldMpqg5IKtfc8llreZ1FDN3cCIE,8570
 port_ocean/core/event_listener/__init__.py,sha256=T3E52MKs79fNEW381p7zU9F2vOMvIiiTYWlqRUqnsg0,1135
-port_ocean/core/event_listener/base.py,sha256=dZjz4y8PtiTJAU2fNbvUO7ibHY8mVIgwLUKC9_ydUJ4,2387
+port_ocean/core/event_listener/base.py,sha256=VdIdp7RLOSxH3ICyV-wCD3NiJoUzsh2KkJ0a9B29GeI,2847
 port_ocean/core/event_listener/factory.py,sha256=M4Qi05pI840sjDIbdjUEgYe9Gp5ckoCkX-KgLBxUpZg,4096
-port_ocean/core/event_listener/http.py,sha256=N8HrfFqR3KGKz96pWdp_pP-m30jGtcz_1CkijovkBN8,2565
-port_ocean/core/event_listener/kafka.py,sha256=ulidnp4sz-chXwHsbH9JayVjcxy_mG6ts_Im3YKmLpI,6983
-port_ocean/core/event_listener/once.py,sha256=iL3NkujZOw-7LpxT-EAUJUcAuiAZPm4ZzjHTSt9EdHs,5918
-port_ocean/core/event_listener/polling.py,sha256=d9E3oRLy-Ogb0oadZNxSDgSLIHe4z92uMVwztscZycg,3667
+port_ocean/core/event_listener/http.py,sha256=_hkQmi9nNh8YG6hbfLrhkATsmGVO8y3qBWvrBHX5Nhk,2992
+port_ocean/core/event_listener/kafka.py,sha256=pVQfGtElIJN2P5lPBrMxyl05B8c2Q2wp5WvA6Pqjnyc,7501
+port_ocean/core/event_listener/once.py,sha256=6DhxQLSz5hjEGhmgLU7aA2ZVRQw3tuwh8sh7N63gRdU,5855
+port_ocean/core/event_listener/polling.py,sha256=iZt59z4Dyus_wVvNfIPbq-G1CozAW9kfPU7uRDLPJVE,3604
 port_ocean/core/event_listener/webhooks_only.py,sha256=PTWnmbLtbJb3ySfotMpTWMYgDVy9zOSYIIGqNbWK0UU,1214
 port_ocean/core/handlers/__init__.py,sha256=d7ShmS90gLRzGKJA6oNy2Zs_dF2yjkmYZInRhBnO9Rw,572
 port_ocean/core/handlers/base.py,sha256=cTarblazu8yh8xz2FpB-dzDKuXxtoi143XJgPbV_DcM,157
@@ -157,8 +157,8 @@ port_ocean/utils/repeat.py,sha256=0EFWM9d8lLXAhZmAyczY20LAnijw6UbIECf5lpGbOas,32
 port_ocean/utils/signal.py,sha256=K-6kKFQTltcmKDhtyZAcn0IMa3sUpOHGOAUdWKgx0_E,1369
 port_ocean/utils/time.py,sha256=pufAOH5ZQI7gXvOvJoQXZXZJV-Dqktoj9Qp9eiRwmJ4,1939
 port_ocean/version.py,sha256=UsuJdvdQlazzKGD3Hd5-U7N69STh8Dq9ggJzQFnu9fU,177
-port_ocean-0.17.6.dist-info/LICENSE.md,sha256=WNHhf_5RCaeuKWyq_K39vmp9F28LxKsB4SpomwSZ2L0,11357
-port_ocean-0.17.6.dist-info/METADATA,sha256=TKcBAHIAELisX7FYMubFZq5aXplH-eCuMbH6q0r2kU4,6673
-port_ocean-0.17.6.dist-info/WHEEL,sha256=Nq82e9rUAnEjt98J6MlVmMCZb-t9cYE2Ir1kpBmnWfs,88
-port_ocean-0.17.6.dist-info/entry_points.txt,sha256=F_DNUmGZU2Kme-8NsWM5LLE8piGMafYZygRYhOVtcjA,54
-port_ocean-0.17.6.dist-info/RECORD,,
+port_ocean-0.17.7.dist-info/LICENSE.md,sha256=WNHhf_5RCaeuKWyq_K39vmp9F28LxKsB4SpomwSZ2L0,11357
+port_ocean-0.17.7.dist-info/METADATA,sha256=nwTcJ2J0x9KUU05CfuuvE8DtMN2DmX1JfQr7Y4_hzOE,6673
+port_ocean-0.17.7.dist-info/WHEEL,sha256=Nq82e9rUAnEjt98J6MlVmMCZb-t9cYE2Ir1kpBmnWfs,88
+port_ocean-0.17.7.dist-info/entry_points.txt,sha256=F_DNUmGZU2Kme-8NsWM5LLE8piGMafYZygRYhOVtcjA,54
+port_ocean-0.17.7.dist-info/RECORD,,