outhad-integrations 0.32.0

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

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+module Outhad
+  module Integrations
+    module Destination
+      module Http
+        include Outhad::Integrations::Core
+        class Client < DestinationConnector
+          MAX_CHUNK_SIZE = 10
+          def check_connection(connection_config)
+            connection_config = connection_config.with_indifferent_access
+            destination_url = connection_config[:destination_url]
+            headers = connection_config[:headers]
+            request = Outhad::Integrations::Core::HttpClient.request(
+              destination_url,
+              HTTP_POST,
+              payload: {},
+              headers: headers
+            )
+            if success?(request)
+              success_status
+            else
+              failure_status(nil)
+            end
+          rescue StandardError => e
+            handle_exception(e, {
+                               context: "HTTP:CHECK_CONNECTION:EXCEPTION",
+                               type: "error"
+                             })
+            failure_status(e)
+          end
+
+          def discover(_connection_config = nil)
+            catalog_json = read_json(CATALOG_SPEC_PATH)
+            catalog = build_catalog(catalog_json)
+            catalog.to_outhad_message
+          rescue StandardError => e
+            handle_exception(e, {
+                               context: "HTTP:DISCOVER:EXCEPTION",
+                               type: "error"
+                             })
+          end
+
+          def write(sync_config, records, _action = "create")
+            connection_config = sync_config.destination.connection_specification.with_indifferent_access
+            url = connection_config[:destination_url]
+            headers = connection_config[:headers]
+            log_message_array = []
+            write_success = 0
+            write_failure = 0
+            records.each_slice(MAX_CHUNK_SIZE) do |chunk|
+              payload = create_payload(chunk)
+              args = [sync_config.stream.request_method, url, payload]
+              response = Outhad::Integrations::Core::HttpClient.request(
+                url,
+                sync_config.stream.request_method,
+                payload: payload,
+                headers: headers
+              )
+              if success?(response)
+                write_success += chunk.size
+              else
+                write_failure += chunk.size
+              end
+              log_message_array << log_request_response("info", args, response)
+            rescue StandardError => e
+              handle_exception(e, {
+                                 context: "HTTP:RECORD:WRITE:EXCEPTION",
+                                 type: "error",
+                                 sync_id: sync_config.sync_id,
+                                 sync_run_id: sync_config.sync_run_id
+                               })
+              write_failure += chunk.size
+              log_message_array << log_request_response("error", args, e.message)
+            end
+            tracking_message(write_success, write_failure, log_message_array)
+          rescue StandardError => e
+            handle_exception(e, {
+                               context: "HTTP:RECORD:WRITE:EXCEPTION",
+                               type: "error",
+                               sync_id: sync_config.sync_id,
+                               sync_run_id: sync_config.sync_run_id
+                             })
+          end
+
+          private
+
+          def create_payload(records)
+            {
+              "records" => records.map do |record|
+                {
+                  "fields" => record
+                }
+              end
+            }
+          end
+
+          def extract_body(response)
+            response_body = response.body
+            JSON.parse(response_body) if response_body
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+{
+  "request_rate_limit": 600,
+  "request_rate_limit_unit": "minute",
+  "request_rate_concurrency": 10,
+  "schema_mode": "schemaless",
+  "streams": [
+    {
+      "name": "http",
+      "batch_support": false,
+      "action": "create",
+      "method": "POST",
+      "json_schema": {},
+      "supported_sync_modes": ["incremental"]
+    }
+  ]
+}

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

@@ -0,0 +1,15 @@
+{
+  "data": {
+    "name": "Http",
+    "title": "http",
+    "connector_type": "destination",
+    "category": "HTTP",
+    "documentation_url": "https://docs.squared.ai/guides/destinations/retl-destinations/http/http",
+    "github_issue_label": "destination-http",
+    "icon": "icon.svg",
+    "license": "MIT",
+    "release_stage": "alpha",
+    "support_level": "community",
+    "tags": ["language:ruby", "outhad"]
+  }
+}

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

@@ -0,0 +1,24 @@
+{
+  "documentation_url": "https://docs.squared.ai/guides/destinations/retl-destinations/http/http",
+  "stream_type": "static",
+  "connection_specification": {
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "title": "Http",
+    "type": "object",
+    "required": ["destination_url"],
+    "properties": {
+      "destination_url": {
+        "type": "string",
+        "title": "Destination url",
+        "order": 0
+      },
+      "headers": {
+        "title": "Http Headers",
+        "order": 1,
+        "additionalProperties": {
+          "type": "string"
+        }
+      }
+    }
+  }
+}

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

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="utf-8"?>
+
+<svg width="800px" height="800px" viewBox="0 0 16 16" xmlns="http://www.w3.org/2000/svg" fill="none">
+
+
+
+
+
+

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

@@ -0,0 +1,122 @@
+# frozen_string_literal: true
+
+require "stringio"
+
+module Outhad
+  module Integrations
+    module Destination
+      module Hubspot
+        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: "HUBSPOT:CRM: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: "HUBSPOT:CRM:DISCOVER:EXCEPTION",
+                               type: "error"
+                             })
+          end
+
+          def write(sync_config, records, action = "create")
+            @action = sync_config.stream.action || action
+            @sync_config = sync_config
+            initialize_client(sync_config.destination.connection_specification)
+            process_records(records, sync_config.stream)
+          rescue StandardError => e
+            handle_exception(e, {
+                               context: "HUBSPOT:CRM:WRITE:EXCEPTION",
+                               type: "error",
+                               sync_id: @sync_config.sync_id,
+                               sync_run_id: @sync_config.sync_run_id
+                             })
+          end
+
+          private
+
+          def initialize_client(config)
+            config = config.with_indifferent_access
+            @client = ::Hubspot::Client.new(access_token: config[:access_token])
+          end
+
+          def process_records(records, stream)
+            log_message_array = []
+            write_success = 0
+            write_failure = 0
+            properties = stream.json_schema.with_indifferent_access[:properties]
+            records.each do |record_object|
+              record = extract_data(record_object, properties)
+              request, response = *send_data_to_hubspot(stream.name, record)
+              write_success += 1
+              log_message_array << log_request_response("info", request, response)
+            rescue StandardError => e
+              handle_exception(e, {
+                                 context: "HUBSPOT:CRM: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", request, e.message)
+            end
+            tracking_message(write_success, write_failure, log_message_array)
+          end
+
+          def send_data_to_hubspot(stream_name, record = {})
+            args = build_args(@action, stream_name, record)
+            hubspot_stream = @client.crm.send(stream_name)
+            hubspot_data = { simple_public_object_input_for_create: args }
+            response = hubspot_stream.basic_api.send(@action, hubspot_data)
+            [args, response]
+          end
+
+          def build_args(action, stream_name, record)
+            case action
+            when :upsert
+              [stream_name, record[:external_key], record]
+            when :destroy
+              [stream_name, record[:id]]
+            else
+              record
+            end
+          end
+
+          def authenticate_client
+            @client.crm.contacts.basic_api.get_page
+          end
+
+          def success_status
+            ConnectionStatus.new(status: ConnectionStatusType["succeeded"]).to_outhad_message
+          end
+
+          def failure_status(error)
+            ConnectionStatus.new(status: ConnectionStatusType["failed"], message: error.message).to_outhad_message
+          end
+
+          def load_catalog
+            read_json(CATALOG_SPEC_PATH)
+          end
+
+          def log_debug(message)
+            Outhad::Integrations::Service.logger.debug(message)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,351 @@
+{
+  "request_rate_limit": 600,
+  "request_rate_limit_unit": "minute",
+  "request_rate_concurrency": 10,
+  "streams": [
+    {
+      "name": "contacts",
+      "action": "create",
+      "json_schema": {
+        "$schema": "http://json-schema.org/draft-07/schema#",
+        "title": "HubSpot CRM",
+        "type": "object",
+        "required": ["email"],
+        "properties": {
+          "properties": {
+            "type": "object",
+            "properties": {
+              "email": {
+                "type": "string",
+                "format": "email",
+                "description": "The contact's email address."
+              },
+              "firstname": {
+                "type": "string",
+                "description": "The contact's first name."
+              },
+              "lastname": {
+                "type": "string",
+                "description": "The contact's last name."
+              },
+              "phone": {
+                "type": "string",
+                "description": "The contact's phone number."
+              },
+              "company": {
+                "type": "string",
+                "description": "The contact's company name."
+              },
+              "website": {
+                "type": "string",
+                "format": "uri",
+                "description": "The contact's website URL."
+              },
+              "lifecyclestage": {
+                "type": "string",
+                "description": "The contact's lifecycle stage."
+              }
+            },
+            "additionalProperties": {
+              "type": ["string", "number", "boolean"],
+              "description": "Allows for additional custom properties with basic data types."
+            }
+          },
+          "associations": {
+            "type": "array",
+            "description": "An array of associated objects for the contact.",
+            "items": {
+              "type": "object",
+              "properties": {
+                "to": {
+                  "type": "object",
+                  "required": ["id"],
+                  "properties": {
+                    "id": {
+                      "type": "integer",
+                      "description": "The unique identifier of the associated object."
+                    }
+                  }
+                },
+                "types": {
+                  "type": "array",
+                  "items": {
+                    "type": "object",
+                    "required": ["associationCategory", "associationTypeId"],
+                    "properties": {
+                      "associationCategory": {
+                        "type": "string",
+                        "description": "The category of the association.",
+                        "enum": [
+                          "HUBSPOT_DEFINED",
+                          "USER_DEFINED",
+                          "INTEGRATOR_DEFINED"
+                        ]
+                      },
+                      "associationTypeId": {
+                        "type": "integer",
+                        "description": "The unique identifier of the association type."
+                      }
+                    }
+                  }
+                }
+              }
+            }
+          }
+        }
+      },
+      "supported_sync_modes": ["incremental"],
+      "source_defined_cursor": true,
+      "default_cursor_field": ["updated"]
+    },
+    {
+      "name": "companies",
+      "action": "create",
+      "json_schema": {
+        "$schema": "http://json-schema.org/draft-07/schema#",
+        "type": "object",
+        "properties": {
+          "inputs": {
+            "type": "array",
+            "items": {
+              "type": "object",
+              "properties": {
+                "associations": {
+                  "type": "array",
+                  "items": {
+                    "type": "object",
+                    "properties": {
+                      "types": {
+                        "type": "array",
+                        "items": {
+                          "type": "object",
+                          "properties": {
+                            "associationCategory": {
+                              "type": "string",
+                              "enum": [
+                                "HUBSPOT_DEFINED",
+                                "USER_DEFINED",
+                                "INTEGRATOR_DEFINED"
+                              ]
+                            },
+                            "associationTypeId": {
+                              "type": "integer"
+                            }
+                          }
+                        }
+                      },
+                      "to": {
+                        "type": "object",
+                        "properties": {
+                          "id": {
+                            "type": "string"
+                          }
+                        }
+                      }
+                    }
+                  }
+                },
+                "properties": {
+                  "type": "object",
+                  "properties": {
+                    "city": {
+                      "type": "string"
+                    },
+                    "name": {
+                      "type": "string"
+                    },
+                    "phone": {
+                      "type": "string"
+                    },
+                    "state": {
+                      "type": "string"
+                    },
+                    "domain": {
+                      "type": "string"
+                    },
+                    "industry": {
+                      "type": "string"
+                    }
+                  },
+                  "required": ["name", "domain"]
+                }
+              },
+              "required": ["properties"]
+            }
+          }
+        },
+        "required": ["inputs"]
+      },
+      "supported_sync_modes": [ "incremental"],
+      "source_defined_cursor": true,
+      "default_cursor_field": ["updated"]
+    },
+    {
+      "name": "deals",
+      "action": "create",
+      "json_schema": {
+        "$schema": "http://json-schema.org/draft-07/schema#",
+        "type": "object",
+        "properties": {
+          "properties": {
+            "type": "object",
+            "properties": {
+              "amount": {
+                "type": "string",
+                "pattern": "^[0-9]+(\\.[0-9]{1,2})?$"
+              },
+              "closedate": {
+                "type": "string",
+                "format": "date-time"
+              },
+              "dealname": {
+                "type": "string"
+              },
+              "pipeline": {
+                "type": "string"
+              },
+              "dealstage": {
+                "type": "string",
+                "enum": [
+                  "appointmentscheduled",
+                  "qualifiedtobuy",
+                  "presentationscheduled",
+                  "decisionmakerboughtin",
+                  "contractsent",
+                  "closedwon",
+                  "closedlost"
+                ]
+              },
+              "hubspot_owner_id": {
+                "type": "string",
+                "pattern": "^[0-9]+$"
+              }
+            },
+            "required": ["dealname", "pipeline", "dealstage"]
+          },
+          "associations": {
+            "type": "array",
+            "items": {
+              "type": "object",
+              "properties": {
+                "to": {
+                  "type": "object",
+                  "properties": {
+                    "id": {
+                      "type": "integer"
+                    }
+                  },
+                  "required": ["id"]
+                },
+                "types": {
+                  "type": "array",
+                  "items": {
+                    "type": "object",
+                    "properties": {
+                      "associationCategory": {
+                        "type": "string",
+                        "enum": [
+                          "HUBSPOT_DEFINED",
+                          "USER_DEFINED",
+                          "INTEGRATOR_DEFINED"
+                        ]
+                      },
+                      "associationTypeId": {
+                        "type": "integer"
+                      }
+                    },
+                    "required": ["associationCategory", "associationTypeId"]
+                  }
+                }
+              },
+              "required": ["to", "types"]
+            }
+          }
+        },
+        "required": ["properties"]
+      },
+      "supported_sync_modes": ["incremental"],
+      "source_defined_cursor": true,
+      "default_cursor_field": ["updated"]
+    },
+    {
+      "name": "line_items",
+      "action": "create",
+      "json_schema": {
+        "$schema": "http://json-schema.org/draft-07/schema#",
+        "type": "object",
+        "properties": {
+          "properties": {
+            "type": "object",
+            "properties": {
+              "name": {
+                "type": "string"
+              },
+              "price": {
+                "type": "string",
+                "pattern": "^[0-9]+(\\.[0-9]{1,2})?$"
+              },
+              "quantity": {
+                "type": "string",
+                "pattern": "^[0-9]+$"
+              },
+              "hs_product_id": {
+                "type": "string",
+                "pattern": "^[0-9]+$"
+              },
+              "recurringbillingfrequency": {
+                "type": "string"
+              },
+              "hs_recurring_billing_period": {
+                "type": "string"
+              }
+            },
+            "required": ["name", "price"]
+          },
+          "associations": {
+            "type": "array",
+            "items": {
+              "type": "object",
+              "properties": {
+                "to": {
+                  "type": "object",
+                  "properties": {
+                    "id": {
+                      "type": "integer"
+                    }
+                  },
+                  "required": ["id"]
+                },
+                "types": {
+                  "type": "array",
+                  "items": {
+                    "type": "object",
+                    "properties": {
+                      "associationCategory": {
+                        "type": "string",
+                        "enum": [
+                          "HUBSPOT_DEFINED",
+                          "USER_DEFINED",
+                          "INTEGRATOR_DEFINED"
+                        ]
+                      },
+                      "associationTypeId": {
+                        "type": "integer"
+                      }
+                    },
+                    "required": ["associationCategory", "associationTypeId"]
+                  }
+                }
+              },
+              "required": ["to", "types"]
+            }
+          }
+        },
+        "required": ["properties", "associations"]
+      },
+      "supported_sync_modes": ["incremental"],
+      "source_defined_cursor": true,
+      "default_cursor_field": ["updated"]
+    }
+  ]
+}

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

@@ -0,0 +1,15 @@
+{
+  "data": {
+    "name": "Hubspot",
+    "title": "HubSpot CRM",
+    "connector_type": "destination",
+    "category": "CRM",
+    "documentation_url": "https://docs.squared.ai/guides/destinations/retl-destinations/crm/hubspot",
+    "github_issue_label": "destination-hubspot-crm",
+    "icon": "icon.svg",
+    "license": "MIT",
+    "release_stage": "alpha",
+    "support_level": "community",
+    "tags": ["language:ruby", "outhad"]
+  }
+}

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

@@ -0,0 +1,18 @@
+{
+  "documentation_url": "https://docs.squared.ai/guides/destinations/retl-destinations/crm/hubspot",
+  "stream_type": "static",
+  "connection_specification": {
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "title": "HubSpot CRM",
+    "type": "object",
+    "required": ["access_token"],
+    "properties": {
+      "access_token": {
+        "type": "string",
+        "outhad_secret": true,
+        "title": "Access Token",
+        "order": 0
+      }
+    }
+  }
+}