outhad-integrations 0.32.0

data/lib/outhad/integrations/destination/zendesk/client.rb

@@ -0,0 +1,132 @@
+# frozen_string_literal: true
+
+module Outhad
+  module Integrations
+    module Destination
+      module Zendesk
+        include Outhad::Integrations::Core
+        class Client < DestinationConnector
+          prepend Outhad::Integrations::Core::RateLimiter
+          def check_connection(connection_config)
+            connection_config = connection_config.with_indifferent_access
+            initialize_client(connection_config)
+            authenticate_client
+            success_status
+          rescue StandardError => e
+            handle_exception(e, {
+                               context: "ZENDESK:CHECK_CONNECTION:EXCEPTION",
+                               type: "error"
+                             })
+            failure_status(e)
+          end
+
+          def discover(_connection_config = nil)
+            catalog = build_catalog(load_catalog)
+            catalog.to_outhad_message
+          rescue StandardError => e
+            handle_exception(e, {
+                               context: "ZENDESK:DISCOVER:EXCEPTION",
+                               type: "error"
+                             })
+            failure_status(e)
+          end
+
+          def write(sync_config, records, action = "create")
+            @sync_config = sync_config
+            @action = sync_config.stream.action || action
+            initialize_client(sync_config.destination.connection_specification)
+            process_records(records, sync_config.stream)
+          rescue StandardError => e
+            handle_exception(e, {
+                               context: "ZENDESK:WRITE:EXCEPTION",
+                               type: "error",
+                               sync_id: @sync_config.sync_id,
+                               sync_run_id: @sync_config.sync_run_id
+                             })
+            failure_status(e)
+          end
+
+          private
+
+          def initialize_client(connection_config)
+            connection_config = connection_config.with_indifferent_access
+            @client = ZendeskAPI::Client.new do |config|
+              config.url = "#{connection_config[:subdomain]}.#{ZENDESK_URL_SUFFIX}"
+              config.username = connection_config[:username]
+              config.password = connection_config[:password]
+            end
+          end
+
+          def authenticate_client
+            @client.tickets.page(1).per_page(1).fetch
+          rescue ZendeskAPI::Error => e
+            raise StandardError, "Authentication failed: #{e.message}"
+          end
+
+          def process_records(records, stream)
+            log_message_array = []
+            write_success = 0
+            write_failure = 0
+
+            records.each do |record|
+              zendesk_data = prepare_record_data(record, stream.name)
+              plural_stream_name = pluralize_stream_name(stream.name.downcase)
+              args = [plural_stream_name, @action, zendesk_data]
+
+              if @action == "create"
+                response = @client.send(plural_stream_name).create!(zendesk_data)
+              else
+                existing_record = @client.send(plural_stream_name).find(id: record[:id])
+                response = existing_record.update!(zendesk_data)
+              end
+
+              write_success += 1
+              log_message_array << log_request_response("info", args, response)
+            rescue StandardError => e
+              handle_exception(e, {
+                                 context: "ZENDESK:WRITE:EXCEPTION",
+                                 type: "error",
+                                 sync_id: @sync_config.sync_id,
+                                 sync_run_id: @sync_config.sync_run_id
+                               })
+              write_failure += 1
+              log_message_array << log_request_response("error", args, e.message)
+            end
+            tracking_message(write_success, write_failure, log_message_array)
+          end
+
+          def pluralize_stream_name(name)
+            { "ticket" => "tickets", "user" => "users" }.fetch(name, name)
+          end
+
+          def prepare_record_data(record, type)
+            case type
+            when "Tickets"
+              {
+                subject: record[:subject],
+                comment: { body: record[:description] },
+                priority: record[:priority],
+                status: record[:status],
+                requester_id: record[:requester_id],
+                assignee_id: record[:assignee_id],
+                tags: record[:tags]
+              }
+            when "Users"
+              {
+                name: record[:name],
+                email: record[:email],
+                role: record[:role]
+              }
+            else
+              raise StandardError, "Unsupported record type: #{type}"
+            end
+          end
+
+          def load_catalog
+            read_json(CATALOG_SPEC_PATH)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/outhad/integrations/destination/zendesk/config/catalog.json

@@ -0,0 +1,110 @@
+{
+    "request_rate_limit": 700,
+    "request_rate_limit_unit": "minute",
+    "request_rate_concurrency": 10,
+    "streams": [
+        {
+            "name": "tickets",
+            "action": "create",
+            "json_schema": {
+                "type": "object",
+                "additionalProperties": true,
+                "properties": {
+                    "id": {
+                        "type": "integer"
+                    },
+                    "subject": {
+                        "type": "string"
+                    },
+                    "description": {
+                        "type": "string"
+                    },
+                    "status": {
+                        "type": "string"
+                    },
+                    "priority": {
+                        "type": "string"
+                    },
+                    "requester_id": {
+                        "type": "integer"
+                    },
+                    "assignee_id": {
+                        "type": "integer"
+                    },
+                    "tags": {
+                        "type": "array",
+                        "items": {
+                            "type": "string"
+                        }
+                    },
+                    "created_at": {
+                        "type": "string",
+                        "format": "date-time"
+                    },
+                    "updated_at": {
+                        "type": "string",
+                        "format": "date-time"
+                    }
+                }
+            },
+            "supported_sync_modes": [
+                "incremental"
+            ],
+            "source_defined_cursor": true,
+            "default_cursor_field": [
+                "updated_at"
+            ],
+            "source_defined_primary_key": [
+                [
+                    "id"
+                ]
+            ]
+        },
+        {
+            "name": "users",
+            "action": "create",
+            "json_schema": {
+                "type": "object",
+                "additionalProperties": true,
+                "properties": {
+                    "id": {
+                        "type": "integer"
+                    },
+                    "name": {
+                        "type": "string"
+                    },
+                    "email": {
+                        "type": "string"
+                    },
+                    "role": {
+                        "type": "string"
+                    },
+                    "last_login_at": {
+                        "type": "string",
+                        "format": "date-time"
+                    },
+                    "created_at": {
+                        "type": "string",
+                        "format": "date-time"
+                    },
+                    "updated_at": {
+                        "type": "string",
+                        "format": "date-time"
+                    }
+                }
+            },
+            "supported_sync_modes": [
+                "incremental"
+            ],
+            "source_defined_cursor": true,
+            "default_cursor_field": [
+                "updated_at"
+            ],
+            "source_defined_primary_key": [
+                [
+                    "id"
+                ]
+            ]
+        }
+    ]
+}

data/lib/outhad/integrations/destination/zendesk/config/meta.json

@@ -0,0 +1,18 @@
+{
+  "data": {
+    "name": "Zendesk",
+    "title": "Zendesk",
+    "connector_type": "destination",
+    "category": "Customer Support",
+    "documentation_url": "https://docs.squared.ai/guides/destinations/retl-destinations/customer-support/zendesk",
+    "github_issue_label": "destination-zendesk",
+    "icon": "icon.svg",
+    "license": "MIT",
+    "release_stage": "alpha",
+    "support_level": "community",
+    "tags": [
+      "language:ruby",
+      "outhad"
+    ]
+  }
+}

data/lib/outhad/integrations/destination/zendesk/config/spec.json

@@ -0,0 +1,32 @@
+{
+  "documentation_url": "https://docs.squared.ai/guides/destinations/retl-destinations/customer-support/zendesk",
+  "stream_type": "static",
+  "connection_specification": {
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "title": "Zendesk",
+    "type": "object",
+    "required": [
+      "username",
+      "password",
+      "subdomain"
+    ],
+    "properties": {
+      "username": {
+        "type": "string",
+        "title": "Username",
+        "order": 0
+      },
+      "password": {
+        "type": "string",
+        "title": "Password",
+        "order": 1,
+        "outhad_secret": true
+      },
+      "subdomain": {
+        "type": "string",
+        "title": "Zendesk Subdomain (include https://)",
+        "order": 2
+      }
+    }
+  }
+}

data/lib/outhad/integrations/destination/zendesk/icon.svg

@@ -0,0 +1,63 @@
+<?xml version="1.0" standalone="no"?>
+<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 20010904//EN"
+ "http://www.w3.org/TR/2001/REC-SVG-20010904/DTD/svg10.dtd">
+<svg version="1.0" xmlns="http://www.w3.org/2000/svg"
+ width="1280.000000pt" height="913.000000pt" viewBox="0 0 1280.000000 913.000000"
+ preserveAspectRatio="xMidYMid meet">
+
+<g transform="translate(0.000000,913.000000) scale(0.100000,-0.100000)"
+fill="#000000" stroke="none">
+<path d="M2836 9058 c30 -442 184 -789 483 -1089 777 -776 2073 -593 2604 368
+118 214 182 435 203 706 l7 87 -1651 0 -1651 0 5 -72z"/>
+<path d="M6670 7143 l0 -1988 24 25 c13 14 416 500 897 1080 480 580 1210
+1461 1621 1957 411 497 748 905 748 908 0 3 -740 5 -1645 5 l-1645 0 0 -1987z"/>
+<path d="M5913 7440 c-116 -140 -855 -1031 -1641 -1980 l-1429 -1725 1640 -3
+c902 -1 1642 -1 1644 1 2 2 2 894 1 1983 l-3 1979 -212 -255z"/>
+<path d="M8137 5359 c-804 -93 -1430 -760 -1459 -1554 l-3 -80 1643 -3 c1417
+-2 1643 0 1648 12 8 22 -14 228 -36 334 -114 549 -530 1024 -1055 1205 -245
+84 -500 114 -738 86z"/>
+<path d="M6927 2433 c-4 -3 -7 -222 -7 -485 l0 -478 -72 61 c-82 68 -201 131
+-298 156 -86 22 -270 22 -365 0 -312 -75 -535 -294 -621 -612 -25 -93 -30
+-292 -10 -399 60 -318 275 -561 580 -655 57 -18 93 -21 228 -21 145 0 167 2
+236 26 99 33 181 83 260 158 l62 59 0 -111 0 -112 175 0 175 0 0 1210 0 1210
+-168 0 c-93 0 -172 -3 -175 -7z m-383 -1088 c94 -25 166 -66 237 -135 210
+-206 212 -534 4 -746 -201 -205 -534 -205 -740 1 -287 287 -155 774 238 880
+69 18 189 19 261 0z"/>
+<path d="M11260 1230 l0 -1210 175 0 175 0 0 215 0 215 135 147 c75 82 139
+149 143 151 4 1 122 -162 262 -362 l255 -365 199 0 198 -1 -18 28 c-9 15 -150
+216 -312 447 -162 231 -303 432 -313 446 l-19 27 296 323 c163 178 308 336
+322 352 l26 27 -215 0 -214 0 -370 -407 -370 -406 -3 791 -2 792 -175 0 -175
+0 0 -1210z"/>
+<path d="M2388 1695 c-432 -82 -721 -456 -695 -899 22 -371 231 -644 582 -763
+75 -25 93 -27 303 -31 216 -4 225 -3 314 23 50 14 126 44 168 66 82 42 210
+141 210 162 -1 6 -50 63 -109 126 l-108 114 -54 -40 c-194 -146 -470 -176
+-677 -75 -106 51 -211 188 -229 297 l-6 35 647 0 646 0 0 93 c0 299 -120 583
+-308 732 -76 61 -198 120 -297 145 -107 27 -286 34 -387 15z m262 -325 c123
+-23 223 -95 278 -197 26 -51 62 -151 62 -175 0 -4 -205 -8 -454 -8 l-455 0 16
+53 c73 245 294 376 553 327z"/>
+<path d="M4375 1704 c-78 -12 -181 -38 -236 -60 -157 -64 -289 -184 -358 -326
+-77 -156 -75 -138 -79 -750 l-3 -548 180 0 181 0 0 489 c0 286 4 510 10 541
+15 80 55 159 107 212 141 143 433 153 584 20 44 -39 93 -130 108 -200 7 -35
+11 -227 11 -557 l0 -505 181 0 180 0 -4 553 c-3 493 -5 558 -21 612 -76 255
+-274 436 -546 500 -67 15 -242 27 -295 19z"/>
+<path d="M8370 1704 c-14 -2 -52 -9 -85 -15 -128 -23 -272 -94 -388 -193 -109
+-91 -206 -244 -253 -401 -25 -82 -28 -104 -27 -245 0 -184 17 -264 87 -405
+103 -208 278 -349 521 -420 81 -23 102 -25 295 -25 192 0 214 2 294 25 131 38
+247 101 338 183 21 19 38 39 38 46 -1 6 -49 62 -109 125 l-108 113 -48 -36
+c-238 -182 -604 -183 -790 -1 -55 53 -111 155 -122 218 l-6 37 647 0 646 0 0
+93 c0 448 -230 782 -604 877 -77 19 -272 34 -326 24z m200 -334 c123 -23 223
+-95 278 -197 26 -51 62 -151 62 -175 0 -4 -205 -8 -454 -8 l-455 0 16 53 c46
+157 147 266 288 310 89 28 177 34 265 17z"/>
+<path d="M10070 1695 c-365 -74 -562 -393 -420 -681 73 -149 225 -229 572
+-303 228 -49 314 -84 343 -141 47 -91 -25 -216 -145 -254 -172 -55 -370 -6
+-491 121 -31 32 -60 67 -67 78 -10 19 -18 16 -166 -60 -86 -44 -156 -84 -156
+-90 0 -22 108 -152 165 -198 75 -61 196 -121 299 -147 104 -26 394 -29 490 -4
+213 54 387 222 427 411 29 144 -12 296 -106 387 -93 91 -203 137 -477 202
+-232 54 -292 77 -340 124 -32 32 -38 44 -38 79 0 91 67 161 177 187 165 39
+323 -6 433 -122 l50 -53 145 80 c167 93 163 82 65 180 -145 146 -348 220 -594
+218 -55 0 -130 -7 -166 -14z"/>
+<path d="M22 1513 l3 -158 483 -5 483 -5 -496 -504 -495 -505 0 -158 0 -158
+735 0 735 0 0 155 0 155 -500 0 c-275 0 -500 3 -500 6 0 3 223 232 495 507
+l495 502 0 163 0 162 -720 0 -721 0 3 -157z"/>
+</g>
+</svg>

data/lib/outhad/integrations/protocol/protocol.json

@@ -0,0 +1,189 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Mutliwoven Protocol",
+  "type": "object",
+  "description": "Mutliwoven protocol schema",
+  "version": "1.0.0",
+  "definitions": {
+    "SyncMode": {
+      "type": "string",
+      "enum": [
+        "full_refresh",
+        "incremental"
+      ]
+    },
+    "SyncStatus": {
+      "type": "string",
+      "enum": [
+        "STARTED",
+        "RUNNING",
+        "COMPLETE",
+        "INCOMPLETE"
+      ]
+    },
+    "DestinationSyncMode": {
+      "type": "string",
+      "enum": [
+        "append",
+        "overwrite",
+        "append_dedup"
+      ]
+    },
+    "ProtocolModel": {
+      "type": "object",
+      "additionalProperties": true
+    },
+    "ConnectionStatus": {
+      "type": "object",
+      "properties": {
+        "status": {
+          "$ref": "#/definitions/Types/String.enum(SUCCEEDED,FAILED)"
+        },
+        "message": {
+          "type": "string"
+        }
+      },
+      "additionalProperties": true
+    },
+    "ConnectorSpecification": {
+      "type": "object",
+      "properties": {
+        "documentation_url": {
+          "type": "string"
+        },
+        "changelog_url": {
+          "type": "string"
+        },
+        "connection_specification": {
+          "type": "object"
+        },
+        "supports_normalization": {
+          "type": "boolean",
+          "default": false
+        },
+        "supports_dbt": {
+          "type": "boolean",
+          "default": false
+        },
+        "supported_destination_sync_modes": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/DestinationSyncMode"
+          }
+        }
+      },
+      "additionalProperties": true
+    },
+    "LogMessage": {
+      "type": "object",
+      "properties": {
+        "level": {
+          "$ref": "#/definitions/Types/String.enum(FATAL,ERROR,WARN,INFO,DEBUG,TRACE)"
+        },
+        "message": {
+          "type": "string"
+        },
+        "stack_trace": {
+          "type": "string"
+        }
+      },
+      "additionalProperties": true
+    },
+    "RecordMessage": {
+      "type": "object",
+      "properties": {
+        "stream": {
+          "type": "string"
+        },
+        "data": {
+          "type": "object"
+        },
+        "emitted_at": {
+          "type": "integer"
+        }
+      },
+      "additionalProperties": true
+    },
+    "Stream": {
+      "type": "object",
+      "properties": {
+        "name": {
+          "type": "string"
+        },
+        "json_schema": {
+          "type": "object"
+        },
+        "supported_sync_modes": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/SyncMode"
+          }
+        },
+        "source_defined_cursor": {
+          "type": "boolean"
+        },
+        "default_cursor_field": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "source_defined_primary_key": {
+          "type": "array",
+          "items": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            }
+          }
+        },
+        "namespace": {
+          "type": "string"
+        }
+      },
+      "additionalProperties": true
+    },
+    "Catalog": {
+      "type": "object",
+      "properties": {
+        "streams": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/Stream"
+          }
+        }
+      },
+      "additionalProperties": true
+    },
+    "SyncConfig": {
+      "type": "object",
+      "properties": {
+        "stream": {
+          "$ref": "#/definitions/Stream"
+        },
+        "sync_mode": {
+          "$ref": "#/definitions/SyncMode"
+        },
+        "cursor_field": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "destination_sync_mode": {
+          "$ref": "#/definitions/DestinationSyncMode"
+        },
+        "primary_key": {
+          "type": "array",
+          "items": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            }
+          }
+        }
+      },
+      "additionalProperties": true
+    }
+  }
+}