spree_klaviyo 1.0.0

data/config/i18n-tasks.yml

@@ -0,0 +1,173 @@
+# i18n-tasks finds and manages missing and unused translations: https://github.com/glebm/i18n-tasks
+
+# The "main" locale.
+base_locale: en
+## All available locales are inferred from the data by default. Alternatively, specify them explicitly:
+# locales: [es, fr]
+## Reporting locale, default: en. Available: en, ru.
+# internal_locale: en
+
+# Read and write translations.
+data:
+  ## Translations are read from the file system. Supported format: YAML, JSON.
+  ## Provide a custom adapter:
+  # adapter: I18n::Tasks::Data::FileSystem
+
+  # Locale files or `Dir.glob` patterns where translations are read from:
+  read:
+    ## Default:
+    - config/locales/%{locale}.yml
+    ## More files:
+    # - config/locales/**/*.%{locale}.yml
+
+  # Locale files to write new keys to, based on a list of key pattern => file rules. Matched from top to bottom:
+  # `i18n-tasks normalize -p` will force move the keys according to these rules
+  write:
+    ## For example, write devise and simple form keys to their respective files:
+    # - ['{devise, simple_form}.*', 'config/locales/\1.%{locale}.yml']
+    ## Catch-all default:
+    # - config/locales/%{locale}.yml
+
+  # External locale data (e.g. gems).
+  # This data is not considered unused and is never written to.
+  external:
+    ## Example (replace %#= with %=):
+    # - "<%#= %x[bundle info vagrant --path].chomp %>/templates/locales/%{locale}.yml"
+    - "<%= %x[bundle info spree_core --path].chomp %>/config/locales/%{locale}.yml"
+    - "<%= %x[bundle info spree_admin --path].chomp %>/config/locales/%{locale}.yml"
+  ## Specify the router (see Readme for details). Valid values: conservative_router, pattern_router, or a custom class.
+  # router: conservative_router
+
+  yaml:
+    write:
+      # do not wrap lines at 80 characters
+      line_width: -1
+
+  ## Pretty-print JSON:
+  # json:
+  #   write:
+  #     indent: '  '
+  #     space: ' '
+  #     object_nl: "\n"
+  #     array_nl: "\n"
+
+# Find translate calls
+search:
+  ## Paths or `Find.find` patterns to search in:
+  # paths:
+  #  - app/
+
+  ## Root directories for relative keys resolution.
+  # relative_roots:
+  #   - app/controllers
+  #   - app/helpers
+  #   - app/mailers
+  #   - app/presenters
+  #   - app/views
+
+  ## Directories where method names which should not be part of a relative key resolution.
+  # By default, if a relative translation is used inside a method, the name of the method will be considered part of the resolved key.
+  # Directories listed here will not consider the name of the method part of the resolved key
+  #
+  # relative_exclude_method_name_paths:
+  #  -
+
+  ## Files or `File.fnmatch` patterns to exclude from search. Some files are always excluded regardless of this setting:
+  ##   *.jpg *.jpeg *.png *.gif *.svg *.ico *.eot *.otf *.ttf *.woff *.woff2 *.pdf *.css *.sass *.scss *.less
+  ##   *.yml *.json *.zip *.tar.gz *.swf *.flv *.mp3 *.wav *.flac *.webm *.mp4 *.ogg *.opus *.webp *.map *.xlsx
+  exclude:
+    - app/assets/images
+    - app/assets/fonts
+    - app/assets/videos
+    - app/assets/builds
+
+  ## Alternatively, the only files or `File.fnmatch patterns` to search in `paths`:
+  ## If specified, this settings takes priority over `exclude`, but `exclude` still applies.
+  # only: ["*.rb", "*.html.slim"]
+
+  ## If `strict` is `false`, guess usages such as t("categories.#{category}.title"). The default is `true`.
+  strict: false
+
+  ## Allows adding ast_matchers for finding translations using the AST-scanners
+  ## The available matchers are:
+  ## - RailsModelMatcher
+  ##     Matches ActiveRecord translations like
+  ##     User.human_attribute_name(:email) and User.model_name.human
+  ## - DefaultI18nSubjectMatcher
+  ##     Matches ActionMailer's default_i18n_subject method
+  ##
+  ## To implement your own, please see `I18n::Tasks::Scanners::AstMatchers::BaseMatcher`.
+  # ast_matchers:
+  #   - 'I18n::Tasks::Scanners::AstMatchers::RailsModelMatcher'
+  #   - 'I18n::Tasks::Scanners::AstMatchers::DefaultI18nSubjectMatcher'
+
+  ## Multiple scanners can be used. Their results are merged.
+  ## The options specified above are passed down to each scanner. Per-scanner options can be specified as well.
+  ## See this example of a custom scanner: https://github.com/glebm/i18n-tasks/wiki/A-custom-scanner-example
+
+## Translation Services
+# translation:
+#   # Google Translate
+#   # Get an API key and set billing info at https://code.google.com/apis/console to use Google Translate
+#   google_translate_api_key: "AbC-dEf5"
+#   # DeepL Pro Translate
+#   # Get an API key and subscription at https://www.deepl.com/pro to use DeepL Pro
+#   deepl_api_key: "48E92789-57A3-466A-9959-1A1A1A1A1A1A"
+#   # deepl_host: "https://api.deepl.com"
+#   # deepl_version: "v2"
+#   # deepl_glossary_ids:
+#   #   - f28106eb-0e06-489e-82c6-8215d6f95089
+#   #   - 2c6415be-1852-4f54-9e1b-d800463496b4
+#   # add additional options to the DeepL.translate call: https://www.deepl.com/docs-api/translate-text/translate-text/
+#   deepl_options:
+#     formality: prefer_less
+#   # OpenAI
+#   openai_api_key: "sk-XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
+#   # openai_model: "gpt-3.5-turbo" # see https://platform.openai.com/docs/models
+#   # may contain `%{from}` and `%{to}`, which will be replaced by source and target locale codes, respectively (using `Kernel.format`)
+#   # openai_system_prompt: >-
+#   #   You are a professional translator that translates content from the %{from} locale
+#   #   to the %{to} locale in an i18n locale array.
+#   #
+#   #   The array has a structured format and contains multiple strings. Your task is to translate
+#   #   each of these strings and create a new array with the translated strings.
+#   #
+#   #   HTML markups (enclosed in < and > characters) must not be changed under any circumstance.
+#   #   Variables (starting with %%{ and ending with }) must not be changed under any circumstance.
+#   #
+#   #   Keep in mind the context of all the strings for a more accurate translation.
+
+## Do not consider these keys missing:
+# ignore_missing:
+# - 'errors.messages.{accepted,blank,invalid,too_short,too_long}'
+# - '{devise,simple_form}.*'
+
+## Consider these keys used:
+# ignore_unused:
+
+## Exclude these keys from the `i18n-tasks eq-base' report:
+# ignore_eq_base:
+#   all:
+#     - common.ok
+#   fr,es:
+#     - common.brand
+
+## Exclude these keys from the `i18n-tasks check-consistent-interpolations` report:
+# ignore_inconsistent_interpolations:
+# - 'activerecord.attributes.*'
+
+## Ignore these keys completely:
+# ignore:
+#  - kaminari.*
+
+## Sometimes, it isn't possible for i18n-tasks to match the key correctly,
+## e.g. in case of a relative key defined in a helper method.
+## In these cases you can use the built-in PatternMapper to map patterns to keys, e.g.:
+#
+# <%# I18n::Tasks.add_scanner 'I18n::Tasks::Scanners::PatternMapper',
+#       only: %w(*.html.haml *.html.slim),
+#       patterns: [['= title\b', '.page_title']] %>
+#
+# The PatternMapper can also match key literals via a special %{key} interpolation, e.g.:
+#
+<% I18n::Tasks.add_scanner 'I18n::Tasks::Scanners::PatternMapper', patterns: [['\bSpree\.t[( ]\s*%{key}', 'spree.%{key}']] %>

data/config/initializers/spree.rb

@@ -0,0 +1,4 @@
+Rails.application.config.after_initialize do
+  Rails.application.config.spree.integrations << Spree::Integrations::Klaviyo
+  Rails.application.config.spree.analytics_event_handlers << SpreeKlaviyo::AnalyticsEventHandler
+end

data/config/locales/en.yml

@@ -0,0 +1,11 @@
+---
+en:
+  spree:
+    admin:
+      integrations:
+        klaviyo:
+          default_newsletter_list_id: Newsletter List ID
+          description: Klaviyo is a powerful email marketing platform that helps businesses understand and analyze their website and app data.
+          klaviyo_private_api_key: Private API Key
+          klaviyo_public_api_key: Public API Key
+          not_found: Klaviyo not connected.

data/config/routes.rb

@@ -0,0 +1,3 @@
+Spree::Core::Engine.add_routes do
+  # Add your extension routes here
+end

data/lib/generators/spree_klaviyo/install/install_generator.rb

@@ -0,0 +1,20 @@
+module SpreeKlaviyo
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      class_option :migrate, type: :boolean, default: true
+
+      def add_migrations
+        run 'bundle exec rake railties:install:migrations FROM=spree_klaviyo'
+      end
+
+      def run_migrations
+        run_migrations = options[:migrate] || ['', 'y', 'Y'].include?(ask('Would you like to run the migrations now? [Y/n]'))
+        if run_migrations
+          run 'bin/rails db:migrate'
+        else
+          puts 'Skipping rails db:migrate, don\'t forget to run it!'
+        end
+      end
+    end
+  end
+end

data/lib/spree_klaviyo/configuration.rb

@@ -0,0 +1,8 @@
+module SpreeKlaviyo
+  class Configuration < Spree::Preferences::Configuration
+    preference :klaviyo_api_url, :string, default: 'https://a.klaviyo.com/api/'
+    preference :klaviyo_api_revision, :string, default: '2025-04-15'
+    preference :klaviyo_api_open_timeout, :integer, default: 10
+    preference :klaviyo_api_read_timeout, :integer, default: 10
+  end
+end

data/lib/spree_klaviyo/engine.rb

@@ -0,0 +1,28 @@
+module SpreeKlaviyo
+  class Engine < Rails::Engine
+    require 'spree/core'
+    isolate_namespace Spree
+    engine_name 'spree_klaviyo'
+
+    # use rspec for tests
+    config.generators do |g|
+      g.test_framework :rspec
+    end
+
+    initializer 'spree_klaviyo.environment', before: :load_config_initializers do |_app|
+      SpreeKlaviyo::Config = SpreeKlaviyo::Configuration.new
+    end
+
+    initializer 'spree_klaviyo.assets' do |app|
+      app.config.assets.precompile += %w[spree_klaviyo_manifest]
+    end
+
+    def self.activate
+      Dir.glob(File.join(File.dirname(__FILE__), '../../app/**/*_decorator*.rb')) do |c|
+        Rails.configuration.cache_classes ? require(c) : load(c)
+      end
+    end
+
+    config.to_prepare(&method(:activate).to_proc)
+  end
+end

data/lib/spree_klaviyo/factories.rb

@@ -0,0 +1,3 @@
+Dir["#{File.dirname(__FILE__)}/testing_support/factories/**"].each do |f|
+  load File.expand_path(f)
+end

data/lib/spree_klaviyo/testing_support/factories/klaviyo_integration.rb

@@ -0,0 +1,9 @@
+FactoryBot.define do
+  factory :klaviyo_integration, class: Spree::Integrations::Klaviyo do
+    active { true }
+    preferred_klaviyo_public_api_key { ENV.fetch("KLAVIYO_PUBLIC_API_KEY", "1234") }
+    preferred_klaviyo_private_api_key { ENV.fetch("KLAVIYO_PRIVATE_API_KEY", "1234567899") }
+    preferred_default_newsletter_list_id { ENV.fetch("KLAVIYO_DEFAULT_NEWSLETTER_LIST_ID", "1234") }
+    store { Spree::Store.default }
+  end
+end

data/lib/spree_klaviyo/version.rb

@@ -0,0 +1,7 @@
+module SpreeKlaviyo
+  VERSION = '1.0.0'.freeze
+
+  def gem_version
+    Gem::Version.new(VERSION)
+  end
+end

data/lib/spree_klaviyo.rb

@@ -0,0 +1,11 @@
+require 'spree_core'
+require 'spree_extension'
+require 'spree_klaviyo/engine'
+require 'spree_klaviyo/version'
+require 'spree_klaviyo/configuration'
+
+module SpreeKlaviyo
+  def self.queue
+    'spree_klaviyo'
+  end
+end

metadata

@@ -0,0 +1,234 @@
+--- !ruby/object:Gem::Specification
+name: spree_klaviyo
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Vendo Connect Inc.
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2025-05-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: spree
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.1.0.beta2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.1.0.beta2
+- !ruby/object:Gem::Dependency
+  name: spree_storefront
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.1.0.beta2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.1.0.beta2
+- !ruby/object:Gem::Dependency
+  name: spree_admin
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.1.0.beta2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.1.0.beta2
+- !ruby/object:Gem::Dependency
+  name: spree_extension
+  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: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: spree_dev_tools
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: i18n-tasks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description:
+email: hello@spreecommerce.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.md
+- README.md
+- Rakefile
+- app/assets/config/spree_klaviyo_manifest.js
+- app/assets/images/integration_icons/klaviyo-logo.png
+- app/clients/spree_klaviyo/klaviyo/client.rb
+- app/controllers/spree_klaviyo/addresses_controller_decorator.rb
+- app/controllers/spree_klaviyo/profile_controller_decorator.rb
+- app/controllers/spree_klaviyo/user_registrations_controller_decorator.rb
+- app/jobs/spree_klaviyo/base_job.rb
+- app/jobs/spree_klaviyo/create_back_in_stock_subscription_job.rb
+- app/jobs/spree_klaviyo/create_event_job.rb
+- app/jobs/spree_klaviyo/create_or_update_profile_job.rb
+- app/jobs/spree_klaviyo/fetch_profile_job.rb
+- app/jobs/spree_klaviyo/subscribe_job.rb
+- app/jobs/spree_klaviyo/unsubscribe_job.rb
+- app/models/concerns/spree_klaviyo/user_methods.rb
+- app/models/spree/integrations/klaviyo.rb
+- app/models/spree_klaviyo/analytics_event_handler.rb
+- app/models/spree_klaviyo/order_decorator.rb
+- app/models/spree_klaviyo/shipment_handler_decorator.rb
+- app/models/spree_klaviyo/user_decorator.rb
+- app/presenters/spree_klaviyo/address_presenter.rb
+- app/presenters/spree_klaviyo/back_in_stock_subscription_presenter.rb
+- app/presenters/spree_klaviyo/event_presenter.rb
+- app/presenters/spree_klaviyo/line_item_presenter.rb
+- app/presenters/spree_klaviyo/order_attributes_presenter.rb
+- app/presenters/spree_klaviyo/order_presenter.rb
+- app/presenters/spree_klaviyo/product_presenter.rb
+- app/presenters/spree_klaviyo/shipment_presenter.rb
+- app/presenters/spree_klaviyo/subscribe_presenter.rb
+- app/presenters/spree_klaviyo/taxon_presenter.rb
+- app/presenters/spree_klaviyo/user_presenter.rb
+- app/services/spree_klaviyo/base.rb
+- app/services/spree_klaviyo/create_event.rb
+- app/services/spree_klaviyo/create_or_update_profile.rb
+- app/services/spree_klaviyo/fetch_profile.rb
+- app/services/spree_klaviyo/subscribe.rb
+- app/services/spree_klaviyo/unsubscribe.rb
+- app/views/spree/admin/integrations/forms/_klaviyo.html.erb
+- config/i18n-tasks.yml
+- config/initializers/spree.rb
+- config/locales/en.yml
+- config/routes.rb
+- lib/generators/spree_klaviyo/install/install_generator.rb
+- lib/spree_klaviyo.rb
+- lib/spree_klaviyo/configuration.rb
+- lib/spree_klaviyo/engine.rb
+- lib/spree_klaviyo/factories.rb
+- lib/spree_klaviyo/testing_support/factories/klaviyo_integration.rb
+- lib/spree_klaviyo/version.rb
+homepage: https://github.com/spree/spree_klaviyo
+licenses:
+- AGPL-3.0-or-later
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements:
+- none
+rubygems_version: 3.5.3
+signing_key:
+specification_version: 4
+summary: Official Spree Commerce Klaviyo email marketing integration
+test_files: []