multiwoven-integrations 0.12.0 → 0.13.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 39b0d65bc581946d3576734695b267d4d9b32e8b973489d5d4d2cebfd0848443
-  data.tar.gz: 778a1d8f6d056e8769699c36849de4f96992a3e1646687d93fe8428c9e56f06f
+  metadata.gz: 2ec77e033727b0ee1dcffb68d822fc7881da80914ad9c783dbc429805d269067
+  data.tar.gz: 02b8d1a3bd999110e7a251281e414e57d4725c0d16e30947a2c299d2a0aae990
 SHA512:
-  metadata.gz: 44c7d134bdf48b7548658f91c4abbac9a7cd79caecdb1f75c628ef06cfc7e3562f6af62abfd2614661da4b90c3adf21b6c01b5514efda46ae88e46673e155386
-  data.tar.gz: fa3e918cc7b1aa524946bc59960638004a33b78baae8bc83cdf0abef6a0a90452211253d199637fc6d937c41b109871be6b70eb54b2d551946b65fc6222b4630
+  metadata.gz: 13e57b0868dca890856151bccca0950d46d92113dd4deca1ef4c474513954733ac23017aa13c34a2cb98345a51ed3b9eab93c2b56994c1dd05ae5467cfb0cc0f
+  data.tar.gz: 52e39eb65c1903c2ac9b5c237059b1f81e62d1f704737bcf96f3fbe03a1b148b1248eab662f53197395c2143b2f8328f8e5dcb8e6cc08c13c863bc5c1871b4bf

data/lib/multiwoven/integrations/destination/mailchimp/client.rb

@@ -0,0 +1,141 @@
+# frozen_string_literal: true
+
+module Multiwoven
+  module Integrations
+    module Destination
+      module Mailchimp
+        include Multiwoven::Integrations::Core
+
+        API_VERSION = "3.0"
+
+        class Client < DestinationConnector
+          prepend Multiwoven::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
+            failure_status(e)
+          end
+
+          def discover(_connection_config = nil)
+            catalog = build_catalog(load_catalog)
+            catalog.to_multiwoven_message
+          rescue StandardError => e
+            handle_exception(e, {
+                               context: "MAILCHIMP:DISCOVER:EXCEPTION",
+                               type: "error"
+                             })
+          end
+
+          def write(sync_config, records, _action = "create")
+            @sync_config = sync_config
+            initialize_client(sync_config.destination.connection_specification)
+            process_records(records, sync_config.stream)
+          rescue StandardError => e
+            handle_exception(e, {
+                               context: "MAILCHIMP: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 = MailchimpMarketing::Client.new
+            @client.set_config({
+                                 api_key: config[:api_key],
+                                 server: config[:api_key].split("-").last
+                               })
+            @list_id = config[:list_id]
+            @email_template_id = config[:email_template_id] || ""
+          end
+
+          def process_records(records, stream)
+            log_message_array = []
+            write_success = 0
+            write_failure = 0
+            properties = stream.json_schema[:properties]
+
+            records.each do |record_object|
+              record = extract_data(record_object, properties)
+              args = [stream.name, "Id", record]
+              begin
+                response = send_to_mailchimp(record, stream.name)
+                write_success += 1
+                log_message_array << log_request_response("info", args, response)
+              rescue StandardError => e
+                handle_exception(e, {
+                                   context: "MAILCHIMP: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
+            end
+            tracking_message(write_success, write_failure, log_message_array)
+          end
+
+          def send_to_mailchimp(record, stream_name)
+            case stream_name
+            when "Audience"
+              @client.lists.set_list_member(@list_id, Digest::MD5.hexdigest(record[:email].downcase), {
+                                              email_address: record[:email],
+                                              status_if_new: "subscribed",
+                                              merge_fields: {
+                                                FNAME: record[:first_name],
+                                                LNAME: record[:last_name]
+                                              }
+                                            })
+            when "Tags"
+              @client.lists.update_list_member_tags(@list_id, Digest::MD5.hexdigest(record[:email].downcase), {
+                                                      tags: record[:tags].map { |tag| { name: tag, status: "active" } }
+                                                    })
+            when "Campaigns"
+              campaign = @client.campaigns.create({
+                                                    type: "regular",
+                                                    recipients: { list_id: @list_id },
+                                                    settings: {
+                                                      subject_line: record[:subject],
+                                                      from_name: record[:from_name],
+                                                      reply_to: record[:reply_to]
+                                                    }
+                                                  })
+              if @email_template_id
+                @client.campaigns.set_content(campaign["id"], {
+                                                template: { id: @email_template_id }
+                                              })
+              else
+                @client.campaigns.set_content(campaign["id"], {
+                                                plain_text: record[:content]
+                                              })
+              end
+              @client.campaigns.send(campaign["id"])
+            else
+              raise "Unsupported stream type: #{stream_name}"
+            end
+          end
+
+          def authenticate_client
+            @client.lists.get_all_lists
+          end
+
+          def load_catalog
+            read_json(CATALOG_SPEC_PATH)
+          end
+
+          def log_debug(message)
+            Multiwoven::Integrations::Service.logger.debug(message)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/multiwoven/integrations/destination/mailchimp/config/catalog.json

@@ -0,0 +1,141 @@
+{
+  "request_rate_limit": 100000,
+  "request_rate_limit_unit": "day",
+  "request_rate_concurrency": 10,
+  "streams": [
+    {
+      "name": "Audience",
+      "action": "create",
+      "json_schema": {
+        "type": "object",
+        "additionalProperties": true,
+        "required": ["email"],
+        "properties": {
+          "email": {
+            "type": "string",
+            "format": "email"
+          },
+          "first_name": {
+            "type": "string"
+          },
+          "last_name": {
+            "type": "string"
+          },
+          "status": {
+            "type": "string",
+            "enum": ["subscribed", "unsubscribed", "cleaned", "pending"]
+          },
+          "tags": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            }
+          },
+          "merge_fields": {
+            "type": "object",
+            "additionalProperties": true,
+            "properties": {
+              "FNAME": {
+                "type": "string"
+              },
+              "LNAME": {
+                "type": "string"
+              }
+            }
+          },
+          "language": {
+            "type": "string"
+          },
+          "vip": {
+            "type": "boolean"
+          },
+          "timestamp_signup": {
+            "type": "string",
+            "format": "date-time"
+          },
+          "ip_signup": {
+            "type": "string",
+            "format": "ipv4"
+          },
+          "timestamp_opt": {
+            "type": "string",
+            "format": "date-time"
+          },
+          "ip_opt": {
+            "type": "string",
+            "format": "ipv4"
+          }
+        }
+      },
+      "supported_sync_modes": ["incremental"],
+      "source_defined_cursor": true,
+      "default_cursor_field": ["timestamp_opt"],
+      "source_defined_primary_key": [["email"]]
+    },
+    {
+      "name": "Tags",
+      "action": "create",
+      "json_schema": {
+        "type": "object",
+        "additionalProperties": true,
+        "required": ["email", "tags"],
+        "properties": {
+          "email": {
+            "type": "string",
+            "format": "email"
+          },
+          "tags": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            }
+          }
+        }
+      },
+      "supported_sync_modes": ["incremental"],
+      "source_defined_cursor": true,
+      "default_cursor_field": ["updated"]
+    },
+    {
+      "name": "Campaigns",
+      "action": "create",
+      "json_schema": {
+        "type": "object",
+        "additionalProperties": true,
+        "required": ["subject", "from_name", "reply_to", "recipients"],
+        "properties": {
+          "subject": {
+            "type": "string"
+          },
+          "from_name": {
+            "type": "string"
+          },
+          "reply_to": {
+            "type": "string",
+            "format": "email"
+          },
+          "recipients": {
+            "type": "object",
+            "properties": {
+              "list_id": {
+                "type": "string"
+              }
+            }
+          },
+          "template_id": {
+            "type": "string"
+          },
+          "content": {
+            "type": "string"
+          },
+          "send_time": {
+            "type": "string",
+            "format": "date-time"
+          }
+        }
+      },
+      "supported_sync_modes": ["full_refresh"],
+      "source_defined_cursor": false
+    }
+  ]
+}

data/lib/multiwoven/integrations/destination/mailchimp/config/meta.json

@@ -0,0 +1,15 @@
+{
+  "data": {
+    "name": "Mailchimp",
+    "title": "Mailchimp",
+    "connector_type": "destination",
+    "category": "Marketing Automation",
+    "documentation_url": "https://docs.multiwoven.com/destinations/crm/mailchimp",
+    "github_issue_label": "destination-mailchimp",
+    "icon": "icon.svg",
+    "license": "MIT",
+    "release_stage": "alpha",
+    "support_level": "community",
+    "tags": ["language:ruby", "multiwoven"]
+  }
+}

data/lib/multiwoven/integrations/destination/mailchimp/config/spec.json

@@ -0,0 +1,28 @@
+{
+  "documentation_url": "https://docs.multiwoven.com/integrations/destination/mailchimp",
+  "stream_type": "static",
+  "connection_specification": {
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "title": "Mailchimp",
+    "type": "object",
+    "required": ["api_key", "list_id"],
+    "properties": {
+      "api_key": {
+        "type": "string",
+        "multiwoven_secret": true,
+        "title": "API Key",
+        "order": 0
+      },
+      "list_id": {
+        "type": "string",
+        "title": "List Id",
+        "order": 1
+      },
+      "email_template_id": {
+        "type": "string",
+        "title": "Email Template Id",
+        "order": 2
+      }
+    }
+  }
+}

data/lib/multiwoven/integrations/destination/mailchimp/icon.svg

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="utf-8"?><!-- Uploaded to: SVG Repo, www.svgrepo.com, Generator: SVG Repo Mixer Tools -->
+<svg fill="#000000" width="800px" height="800px" viewBox="0 0 32 32" xmlns="http://www.w3.org/2000/svg">
+  <path d="M23.974 15.12c0.219-0.026 0.443-0.026 0.661 0 0.12-0.271 0.141-0.745 0.031-1.255-0.156-0.76-0.37-1.224-0.818-1.151-0.443 0.073-0.458 0.625-0.302 1.385 0.094 0.427 0.25 0.797 0.427 1.021zM20.161 15.724c0.318 0.141 0.51 0.234 0.589 0.151 0.047-0.052 0.036-0.146-0.042-0.271-0.156-0.255-0.479-0.516-0.823-0.661-0.719-0.302-1.547-0.203-2.177 0.26-0.214 0.156-0.411 0.375-0.385 0.505 0.010 0.042 0.042 0.073 0.115 0.083 0.177 0.021 0.786-0.286 1.495-0.333 0.495-0.031 0.911 0.125 1.229 0.266zM19.521 16.089c-0.417 0.068-0.641 0.203-0.786 0.328-0.13 0.109-0.203 0.234-0.203 0.318l0.031 0.078 0.068 0.026c0.094 0 0.302-0.089 0.302-0.089 0.427-0.156 0.885-0.208 1.333-0.135 0.208 0.021 0.307 0.036 0.354-0.036 0.010-0.021 0.026-0.063-0.016-0.13-0.094-0.161-0.516-0.427-1.083-0.359zM22.688 17.432c0.281 0.135 0.589 0.083 0.688-0.12 0.104-0.208-0.042-0.49-0.323-0.625-0.281-0.141-0.589-0.083-0.693 0.12-0.099 0.208 0.047 0.484 0.328 0.625zM24.495 15.849c-0.229-0.005-0.422 0.245-0.422 0.562-0.005 0.313 0.172 0.568 0.401 0.573s0.417-0.245 0.422-0.557c0.005-0.313-0.177-0.573-0.401-0.578zM9.156 21.505c-0.057-0.068-0.151-0.047-0.24-0.026-0.073 0.016-0.146 0.026-0.214 0.031-0.156 0-0.302-0.073-0.391-0.198-0.104-0.161-0.099-0.401 0.016-0.672l0.052-0.125c0.188-0.411 0.49-1.099 0.146-1.755-0.255-0.495-0.677-0.802-1.188-0.865-0.49-0.063-0.974 0.109-1.313 0.469-0.505 0.557-0.583 1.318-0.484 1.589 0.036 0.099 0.094 0.125 0.135 0.13 0.083 0.010 0.208-0.052 0.292-0.266l0.021-0.068c0.036-0.115 0.104-0.328 0.208-0.495 0.281-0.427 0.849-0.547 1.271-0.266 0.354 0.229 0.495 0.667 0.344 1.078-0.078 0.219-0.208 0.625-0.177 0.964 0.057 0.682 0.474 0.953 0.849 0.984 0.365 0.016 0.62-0.193 0.688-0.344 0.036-0.089 0.005-0.141-0.016-0.167zM30.255 20.26c-0.016-0.052-0.104-0.385-0.229-0.781l-0.255-0.682c0.5-0.75 0.51-1.422 0.443-1.802-0.073-0.469-0.266-0.87-0.661-1.281-0.391-0.417-1.198-0.844-2.333-1.161l-0.594-0.161c0-0.026-0.031-1.406-0.057-1.995-0.016-0.427-0.052-1.099-0.26-1.755-0.245-0.891-0.677-1.672-1.214-2.172 1.479-1.536 2.406-3.229 2.401-4.677-0.005-2.797-3.427-3.641-7.646-1.891l-0.896 0.38c-0.547-0.536-1.089-1.073-1.641-1.609-4.813-4.203-19.854 12.542-15.047 16.615l1.052 0.891c-0.281 0.76-0.38 1.578-0.292 2.391 0.115 1.12 0.688 2.193 1.625 3.021 0.885 0.786 2.052 1.286 3.188 1.286 1.87 4.318 6.146 6.969 11.156 7.12 5.38 0.156 9.896-2.37 11.786-6.911 0.125-0.318 0.651-1.755 0.651-3.021 0-1.276-0.719-1.802-1.177-1.802zM8.25 23.656c-0.161 0.031-0.333 0.042-0.5 0.036-1.62-0.042-3.375-1.505-3.552-3.245-0.193-1.922 0.786-3.396 2.521-3.745 0.24-0.052 0.484-0.068 0.729-0.057 0.974 0.057 2.406 0.802 2.729 2.922 0.292 1.88-0.167 3.792-1.927 4.094zM6.438 15.552c-1.078 0.208-2.031 0.823-2.615 1.667-0.349-0.286-0.995-0.849-1.109-1.068-0.927-1.771 1.016-5.203 2.37-7.146 3.354-4.792 8.609-8.422 11.042-7.766 0.396 0.115 1.703 1.635 1.703 1.635s-2.432 1.349-4.688 3.234c-3.036 2.344-5.328 5.745-6.703 9.443zM23.484 22.943c0.036-0.016 0.063-0.057 0.057-0.094-0.005-0.052-0.047-0.089-0.099-0.083 0 0-2.542 0.38-4.948-0.505 0.26-0.849 0.958-0.542 2.010-0.458 1.635 0.099 3.276-0.078 4.854-0.526 1.089-0.313 2.516-0.927 3.63-1.807 0.375 0.823 0.505 1.729 0.505 1.729s0.292-0.052 0.531 0.099c0.229 0.141 0.396 0.438 0.281 1.193-0.229 1.417-0.833 2.568-1.844 3.63-0.63 0.682-1.38 1.245-2.219 1.656-0.464 0.245-0.948 0.448-1.443 0.615-3.813 1.245-7.714-0.125-8.974-3.068-0.099-0.224-0.182-0.458-0.25-0.698-0.536-1.938-0.083-4.266 1.344-5.729 0.083-0.094 0.172-0.203 0.172-0.344 0-0.115-0.073-0.234-0.135-0.323-0.495-0.724-2.219-1.953-1.875-4.339 0.25-1.714 1.745-2.917 3.141-2.849l0.354 0.021c0.604 0.036 1.13 0.115 1.625 0.135 0.833 0.036 1.583-0.083 2.469-0.823 0.297-0.25 0.536-0.469 0.943-0.536 0.042-0.005 0.151-0.047 0.359-0.036 0.219 0.010 0.427 0.078 0.609 0.198 0.714 0.474 0.813 1.62 0.849 2.458 0.021 0.479 0.078 1.635 0.099 1.969 0.047 0.76 0.245 0.87 0.646 1 0.229 0.078 0.443 0.135 0.75 0.219 0.943 0.266 1.5 0.536 1.849 0.88 0.214 0.214 0.307 0.443 0.339 0.661 0.115 0.813-0.625 1.813-2.583 2.724-2.141 0.995-4.734 1.245-6.526 1.047l-0.63-0.073c-1.432-0.193-2.25 1.661-1.391 2.938 0.552 0.818 2.068 1.354 3.578 1.354 3.464 0 6.13-1.484 7.12-2.766l0.078-0.115c0.052-0.073 0.010-0.109-0.052-0.068-0.807 0.552-4.406 2.755-8.25 2.094 0 0-0.469-0.078-0.896-0.245-0.339-0.13-1.047-0.458-1.135-1.188 3.104 0.964 5.057 0.052 5.057 0.052zM18.568 22.359h0.005zM12.63 8.984c1.193-1.38 2.661-2.578 3.974-3.25 0.047-0.026 0.094 0.026 0.073 0.068-0.104 0.188-0.307 0.599-0.37 0.901-0.010 0.047 0.042 0.083 0.078 0.057 0.823-0.557 2.245-1.156 3.495-1.234 0.052 0 0.078 0.068 0.036 0.099-0.208 0.161-0.391 0.344-0.552 0.552-0.026 0.036 0 0.083 0.042 0.083 0.88 0.010 2.115 0.318 2.917 0.771 0.057 0.031 0.021 0.135-0.042 0.12-1.219-0.281-3.214-0.495-5.286 0.016-1.849 0.453-3.26 1.146-4.292 1.901-0.052 0.036-0.115-0.031-0.073-0.083z"/>
+</svg>

data/lib/multiwoven/integrations/rollout.rb

@@ -2,7 +2,7 @@
 
 module Multiwoven
   module Integrations
-    VERSION = "0.12.0"
+    VERSION = "0.13.1"
 
     ENABLED_SOURCES = %w[
       Snowflake
@@ -41,6 +41,7 @@ module Multiwoven
       Oracle
       MicrosoftExcel
       MicrosoftSql
+      Mailchimp
     ].freeze
   end
 end

data/lib/multiwoven/integrations.rb

@@ -36,6 +36,7 @@ require "aws-sdk-sagemaker"
 require "aws-sdk-sagemakerruntime"
 require "google/cloud/ai_platform/v1"
 require "grpc"
+require "MailchimpMarketing"
 
 # Service
 require_relative "integrations/config"
@@ -90,6 +91,7 @@ require_relative "integrations/destination/databricks_lakehouse/client"
 require_relative "integrations/destination/oracle_db/client"
 require_relative "integrations/destination/microsoft_excel/client"
 require_relative "integrations/destination/microsoft_sql/client"
+require_relative "integrations/destination/mailchimp/client"
 
 module Multiwoven
   module Integrations

data/multiwoven-integrations.gemspec

@@ -52,6 +52,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "grpc"
   spec.add_runtime_dependency "hubspot-api-client"
   spec.add_runtime_dependency "iterable-api-client"
+  spec.add_runtime_dependency "MailchimpMarketing"
   spec.add_runtime_dependency "net-sftp"
   spec.add_runtime_dependency "pg"
   spec.add_runtime_dependency "rake"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: multiwoven-integrations
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 0.13.1
 platform: ruby
 authors:
 - Subin T P
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-10-04 00:00:00.000000000 Z
+date: 2024-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -276,6 +276,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: MailchimpMarketing
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: net-sftp
   requirement: !ruby/object:Gem::Requirement
@@ -610,6 +624,11 @@ files:
 - lib/multiwoven/integrations/destination/klaviyo/config/meta.json
 - lib/multiwoven/integrations/destination/klaviyo/config/spec.json
 - lib/multiwoven/integrations/destination/klaviyo/icon.svg
+- lib/multiwoven/integrations/destination/mailchimp/client.rb
+- lib/multiwoven/integrations/destination/mailchimp/config/catalog.json
+- lib/multiwoven/integrations/destination/mailchimp/config/meta.json
+- lib/multiwoven/integrations/destination/mailchimp/config/spec.json
+- lib/multiwoven/integrations/destination/mailchimp/icon.svg
 - lib/multiwoven/integrations/destination/maria_db/client.rb
 - lib/multiwoven/integrations/destination/maria_db/config/meta.json
 - lib/multiwoven/integrations/destination/maria_db/config/spec.json