etl-integrations 0.1.81

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6f6ac72a0e3d6f1c83a3edd5e2da1d4b3e5234ac75d222b8a3df8f37dab474c8
+  data.tar.gz: c56fc3a1ee95809f024cd13ac7afc7c29f977aee5bd7bde946b9c352a412efa1
+SHA512:
+  metadata.gz: 269de2999365a4e65f8491d888df9ee57136f7f2f065aaf600dd1ddc65900d048c181cdd419b0ebd3b756776230e7d44e9291aea74e5759b497041389ec0435e
+  data.tar.gz: 6dec0f83e2f321332eccb0efd61f8da7f735e26cdcc4c1d304d98bcc298d70231da194578fa523fdfd5c42d1ee90fbaf71f232011b3f0584b3269c2e1759f82a

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,34 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 300
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/ModuleLength:
+  Max: 500
+
+Metrics/BlockLength:
+  Max: 120
+
+Metrics/AbcSize:
+  Max: 30
+
+Metrics/MethodLength:
+  Max: 50
+
+Metrics/CyclomaticComplexity:
+  Max: 50

data/.ruby-version

@@ -0,0 +1 @@
+3.2.0

data/.vscode/settings.json

@@ -0,0 +1,5 @@
+{
+  "cSpell.words": [
+    "multiwoven"
+  ]
+}

data/CHANGELOG.md

@@ -0,0 +1,38 @@
+## [Unreleased]
+
+### [0.4.1](https://www.github.com/Multiwoven/multiwoven-integrations/compare/v0.4.0...v0.4.1) (2024-02-15)
+
+
+### Bug Fixes
+
+* Add batch params to stream ([#68](https://www.github.com/Multiwoven/multiwoven-integrations/issues/68)) ([080530f](https://www.github.com/Multiwoven/multiwoven-integrations/commit/080530f8280b467c8e40a3b6429f178ad18fa05e))
+
+## [0.4.0](https://www.github.com/Multiwoven/multiwoven-integrations/compare/v0.3.0...v0.4.0) (2024-02-14)
+
+
+### Features
+
+* Bump version to 1.21 ([#62](https://www.github.com/Multiwoven/multiwoven-integrations/issues/62)) ([7b1476d](https://www.github.com/Multiwoven/multiwoven-integrations/commit/7b1476d4b04a073ab060971019095d0a13ebd153))
+
+## [0.3.0](https://www.github.com/Multiwoven/multiwoven-integrations/compare/v0.2.0...v0.3.0) (2024-02-14)
+
+
+### Features
+
+* Publish gem to rubygems ([#60](https://www.github.com/Multiwoven/multiwoven-integrations/issues/60)) ([04cfbb6](https://www.github.com/Multiwoven/multiwoven-integrations/commit/04cfbb60c78bc90d886ce691d5094fed9c6f078f))
+
+## [0.2.0](https://www.github.com/Multiwoven/multiwoven-integrations/compare/v0.1.0...v0.2.0) (2024-02-14)
+
+
+### Features
+
+* Automate gem release ([#55](https://www.github.com/Multiwoven/multiwoven-integrations/issues/55)) ([1c3373b](https://www.github.com/Multiwoven/multiwoven-integrations/commit/1c3373bcedae60c6fb8171c54ce40de94f1537ce))
+
+
+### Bug Fixes
+
+* Klaviyo discover  ([#23](https://www.github.com/Multiwoven/multiwoven-integrations/issues/23)) ([7c43db6](https://www.github.com/Multiwoven/multiwoven-integrations/commit/7c43db6a369403748ed29085bb5254405ad1c95e))
+
+## [0.1.0] - 2023-12-01
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at subinthattaparambil@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Multiwoven
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,105 @@
+<div align="center">
+  <a href="https://multiwoven.com?utm_source=github" target="_blank">
+    <img src="https://res.cloudinary.com/dspflukeu/image/upload/v1706696350/Multiwoven/Logo_hrkaxj.png" alt="Multiwoven" width="240" />
+  </a>
+</div>
+<br />
+<p align="center">
+  <a href="http://badge.fury.io/rb/multiwoven-integrations">
+    <img src="https://badge.fury.io/rb/multiwoven-integrations.svg" alt="Gem Version">
+  </a>
+  <a href="https://github.com/Multiwoven/multiwoven-integrations/actions/workflows/ci.yml">
+    <img src="https://github.com/Multiwoven/multiwoven-integrations/actions/workflows/ci.yml/badge.svg" alt="CI">
+  </a>
+  <a href="https://codeclimate.com/repos/657d0a2a60265a2f2155ffca/maintainability">
+    <img src="https://api.codeclimate.com/v1/badges/d841270f1f7a966043c1/maintainability" alt="Maintainability">
+  </a>
+  <a href="https://codeclimate.com/repos/657d0a2a60265a2f2155ffca/test_coverage">
+    <img src="https://api.codeclimate.com/v1/badges/d841270f1f7a966043c1/test_coverage" alt="Test Coverage">
+  </a>
+</p>
+<h2 align="center">The open-source Reverse ETL platform for data teams</h2>
+
+<p align="center">
+  <br />
+  <a href="https://docs.multiwoven.com" rel="">
+    <strong>Explore the docs »</strong>
+  </a>
+  <br />
+  <br />
+  <a href="https://join.slack.com/t/multiwoven/shared_invite/zt-2bnjye26u-~lu_FFOMLpChOYxvovep7g">Slack</a>
+    ·
+    <a href="https://multiwoven.com">Website</a>
+    ·
+    <a href="https://github.com/Multiwoven/multiwoven-integrations/issues">Report Issues</a>
+    ·
+    <a href="https://github.com/orgs/Multiwoven/projects/4">Roadmap</a>
+</p>
+
+## Multiwoven Integrations
+
+Multiwoven integrations is the collection of connectors built on top of [Multiwoven protocol](https://docs.multiwoven.com/guides/architecture/multiwoven-protocol).
+
+Multiwoven protocol is an open source standard for moving data between data sources to any third-part destinations.
+Anyone can build a connetor with basic ruby knowledge using the protocol.
+
+### Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add multiwoven-integrations
+
+
+### Usage
+
+#### Source
+```
+source = Multiwoven::Integrations::Source::[CONNECTOR_NAME]::Client.new
+source.read(sync_config)
+```
+#### Destination
+
+```
+destination = Multiwoven::Integrations::Destination::[CONNECTOR_NAME]::Client.new
+destination.write(sync_config, records)
+```
+
+#### Supported methods 
+Please refer [Multiwoven Protocol](https://docs.multiwoven.com/guides/architecture/multiwoven-protocol) to understand more about the supported methods on source and destination
+
+## Development
+
+- **Install Dependencies**
+  - Command: `bin/setup`
+  - Description: After checking out the repo, run this command to install dependencies.
+
+- **Run Tests**
+  - Command: `rake spec`
+  - Description: Run this command to execute the tests.
+
+- **Interactive Prompt**
+  - Command: `bin/console`
+  - Description: For an interactive prompt that allows you to experiment, run this command.
+
+- **Install Gem Locally**
+  - Command: `bundle exec rake install`
+  - Description: To install this gem onto your local machine, run this command.
+
+- **Release New Version**
+  - Steps:
+    1. Update the version number in `rollout.rb`.
+    2. Command: `bundle exec rake release`
+    3. Description: This command will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on [GitHub](https://github.com/Multiwoven/multiwoven-integrations). This project aims to be a safe, welcoming space for collaboration.
+
+## Code of Conduct
+
+Contributors are expected to adhere to the project's [code of conduct](https://github.com/Multiwoven/multiwoven-integrations/blob/main/CODE_OF_CONDUCT.md)
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/multiwoven/integrations/config.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Multiwoven
+  module Integrations
+    class Config
+      attr_accessor :logger
+
+      def initialize(params = {})
+        @logger = params[:logger]
+      end
+    end
+  end
+end

data/lib/multiwoven/integrations/core/base_connector.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module Multiwoven
+  module Integrations::Core
+    class BaseConnector
+      include Integrations::Protocol
+      include Utils
+      include Constants
+
+      def connector_spec
+        @connector_spec ||= begin
+          spec_json = keys_to_symbols(read_json(CONNECTOR_SPEC_PATH)).to_json
+          # returns Protocol::ConnectorSpecification
+          ConnectorSpecification.from_json(spec_json)
+        end
+      end
+
+      def meta_data
+        client_meta_data = read_json(META_DATA_PATH).deep_symbolize_keys
+        icon_name = client_meta_data[:data][:icon]
+        icon_url = "https://raw.githubusercontent.com/Multiwoven/multiwoven/main/integrations#{relative_path}/#{icon_name}"
+        client_meta_data[:data][:icon] = icon_url
+        # returns hash
+        @meta_data ||= client_meta_data
+      end
+
+      def relative_path
+        path = Object.const_source_location(self.class.to_s)[0]
+        connector_folder = File.dirname(path)
+        marker = "/lib/multiwoven/integrations/"
+        parts = connector_folder.split(marker)
+
+        marker + parts.last if parts.length > 1
+      end
+
+      # Connection config is a hash
+      def check_connection(_connection_config)
+        raise "Not implemented"
+        # returns Protocol.ConnectionStatus
+      end
+
+      # Connection config is a hash
+      def discover(_connection_config)
+        raise "Not implemented"
+        # returns Protocol::Catalog
+      end
+
+      private
+
+      def read_json(file_path)
+        path = Object.const_source_location(self.class.to_s)[0]
+        connector_folder = File.dirname(path)
+        file_path = File.join(
+          "#{connector_folder}/",
+          file_path
+        )
+        file_contents = File.read(file_path)
+        JSON.parse(file_contents)
+      end
+
+      def success_status
+        ConnectionStatus.new(status: ConnectionStatusType["succeeded"]).to_multiwoven_message
+      end
+
+      def failure_status(error)
+        ConnectionStatus.new(status: ConnectionStatusType["failed"], message: error.message).to_multiwoven_message
+      end
+    end
+  end
+end

data/lib/multiwoven/integrations/core/constants.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Multiwoven
+  module Integrations::Core
+    module Constants
+      # CONFIG
+      META_DATA_PATH = "config/meta.json"
+      CONNECTOR_SPEC_PATH = "config/spec.json"
+      CATALOG_SPEC_PATH   = "config/catalog.json"
+      SNOWFLAKE_MAC_DRIVER_PATH = "/opt/snowflake/snowflakeodbc/lib/universal/libSnowflake.dylib"
+      DATABRICKS_MAC_DRIVER_PATH = "/Library/simba/spark/lib/libsparkodbc_sb64-universal.dylib"
+
+      SNOWFLAKE_DRIVER_PATH = ENV["SNOWFLAKE_DRIVER_PATH"] || SNOWFLAKE_MAC_DRIVER_PATH
+      DATABRICKS_DRIVER_PATH = ENV["DATABRICKS_DRIVER_PATH"] || DATABRICKS_MAC_DRIVER_PATH
+
+      JSON_SCHEMA_URL = "https://json-schema.org/draft-07/schema#"
+
+      # CONNECTORS
+      KLAVIYO_AUTH_ENDPOINT = "https://a.klaviyo.com/api/lists/"
+      KLAVIYO_AUTH_PAYLOAD = {
+        data: {
+          type: "list",
+          attributes: {
+            name: "THIS IS REQUIRED"
+          }
+        }
+      }.freeze
+
+      FACEBOOK_AUDIENCE_GET_ALL_ACCOUNTS = "https://graph.facebook.com/v18.0/me/adaccounts?fields=id,name"
+
+      AIRTABLE_URL_BASE = "https://api.airtable.com/v0/"
+      AIRTABLE_BASES_ENDPOINT = "https://api.airtable.com/v0/meta/bases"
+      AIRTABLE_GET_BASE_SCHEMA_ENDPOINT = "https://api.airtable.com/v0/meta/bases/{baseId}/tables"
+
+      # HTTP
+      HTTP_GET = "GET"
+      HTTP_POST = "POST"
+      HTTP_PUT = "PUT"
+      HTTP_DELETE = "DELETE"
+
+      # google sheets
+      GOOGLE_SHEETS_SCOPE = "https://www.googleapis.com/auth/drive"
+      GOOGLE_SPREADSHEET_ID_REGEX = %r{/d/([-\w]{20,})/}.freeze
+    end
+  end
+end

data/lib/multiwoven/integrations/core/destination_connector.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Multiwoven
+  module Integrations::Core
+    class DestinationConnector < BaseConnector
+      # Records are transformed json payload send it to the destination
+      # SyncConfig is the Protocol::SyncConfig object
+      def write(_sync_config, _records, _action = "insert")
+        raise "Not implemented"
+        # return Protocol::TrackingMessage
+      end
+    end
+  end
+end

data/lib/multiwoven/integrations/core/fullrefresher.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Multiwoven
+  module Integrations::Core
+    module Fullrefresher
+      def write(sync_config, records, action = "insert")
+        if sync_config && sync_config.sync_mode == "full_refresh" && !@full_refreshed
+          response = clear_all_records(sync_config)
+          return response unless response &&
+                                 response.control.status == Multiwoven::Integrations::Protocol::ConnectionStatusType["succeeded"]
+
+          @full_refreshed = true
+        end
+
+        super(sync_config, records, action)
+      end
+    end
+  end
+end

data/lib/multiwoven/integrations/core/http_client.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Multiwoven
+  module Integrations::Core
+    class HttpClient
+      class << self
+        def request(url, method, payload: nil, headers: {})
+          uri = URI(url)
+          http = Net::HTTP.new(uri.host, uri.port)
+          http.use_ssl = (uri.scheme == "https")
+          request = build_request(method, uri, payload, headers)
+          http.request(request)
+        end
+
+        private
+
+        def build_request(method, uri, payload, headers)
+          request_class = case method.upcase
+                          when Constants::HTTP_GET then Net::HTTP::Get
+                          when Constants::HTTP_POST then Net::HTTP::Post
+                          when Constants::HTTP_PUT then Net::HTTP::Put
+                          when Constants::HTTP_DELETE then Net::HTTP::Delete
+                          else raise ArgumentError, "Unsupported HTTP method: #{method}"
+                          end
+
+          request = request_class.new(uri)
+          headers.each { |key, value| request[key] = value }
+          request.body = payload.to_json if payload && %w[POST PUT].include?(method.upcase)
+          request
+        end
+      end
+    end
+  end
+end

data/lib/multiwoven/integrations/core/query_builder.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Multiwoven
+  module Integrations::Core
+    class QueryBuilder
+      def self.perform(action, table, record, primary_key = nil)
+        case action.downcase
+        when "insert"
+          columns = record.keys.join(", ")
+          values = record.values.map { |value| "'#{value}'" }.join(", ")
+          # TODO: support bulk insert
+          "INSERT INTO #{table} (#{columns}) VALUES (#{values});"
+        when "update"
+          # Ensure primary key is a string and exists within record for the WHERE clause
+          return "Primary key '#{primary_key}' not found in record." if record[primary_key].nil?
+
+          primary_key_value = record.delete(primary_key) # Remove and return the primary key value
+          set_clause = record.map { |key, value| "#{key} = '#{value}'" }.join(", ")
+          where_clause = "#{primary_key} = '#{primary_key_value}'"
+          "UPDATE #{table} SET #{set_clause} WHERE #{where_clause};"
+        else
+          "Invalid action specified."
+        end
+      end
+    end
+  end
+end

data/lib/multiwoven/integrations/core/rate_limiter.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Multiwoven
+  module Integrations::Core
+    module RateLimiter
+      def write(sync_config, records, action = "insert")
+        stream = sync_config.stream
+
+        @queue ||= Limiter::RateQueue.new(stream.request_rate_limit, interval: stream.rate_limit_unit_seconds) do
+          Integrations::Service.logger.info("Hit the limit for stream: #{stream.name}, waiting")
+        end
+
+        @queue.shift
+
+        super(sync_config, records, action)
+      end
+    end
+  end
+end

data/lib/multiwoven/integrations/core/source_connector.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Multiwoven
+  module Integrations::Core
+    class SourceConnector < BaseConnector
+      # accepts Protocol::SyncConfig
+      def read(_sync_config)
+        raise "Not implemented"
+        # setup sync configs
+        # call query(connection, query)
+        # Returns list of RecordMessage
+      end
+
+      private
+
+      # This needs to be implemented as private method
+      # In every source connector. This will be used for model preview
+      def query(connection, query)
+        # return list of RecordMessage
+      end
+
+      def batched_query(sql_query, limit, offset)
+        offset = offset.to_i
+        limit = limit.to_i
+        raise ArgumentError, "Offset and limit must be non-negative" if offset.negative? || limit.negative?
+
+        # Removing any trailing semicolons
+        sql_query.chomp!(";")
+
+        # Checking if the query already has a LIMIT clause
+        raise ArgumentError, "Query already contains a LIMIT clause" if sql_query.match?(/LIMIT \d+/i)
+
+        # Appending the LIMIT and OFFSET clauses to the SQL query
+        "#{sql_query} LIMIT #{limit} OFFSET #{offset}"
+      end
+    end
+  end
+end