spree_klaviyo 1.0.0

data/app/presenters/spree_klaviyo/back_in_stock_subscription_presenter.rb

@@ -0,0 +1,39 @@
+module SpreeKlaviyo
+  class BackInStockSubscriptionPresenter
+    def initialize(email:, variant_id:)
+      @email = email
+      @variant_id = variant_id
+    end
+
+    def call
+      {
+        data: {
+          type: 'back-in-stock-subscription',
+          attributes: {
+            channels: %w[EMAIL],
+            profile: {
+              data: {
+                type: 'profile',
+                attributes: {
+                  email: email
+                }
+              }
+            }
+          },
+          relationships: {
+            variant: {
+              data: {
+                type: 'catalog-variant',
+                id: "$custom:::$default:::#{variant_id}"
+              }
+            }
+          }
+        }
+      }
+    end
+
+    private
+
+    attr_reader :email, :variant_id
+  end
+end

data/app/presenters/spree_klaviyo/event_presenter.rb

@@ -0,0 +1,97 @@
+module SpreeKlaviyo
+  class EventPresenter
+    def initialize(integration:, event:, resource:, email:, guest_id: nil)
+      @integration = integration
+      @store = integration.store
+      @resource = resource
+      @event = event
+      @email = email
+      @guest_id = guest_id
+    end
+
+    def call
+      {
+        data: {
+          type: 'event',
+          attributes: {
+            properties: properties,
+            metric: {
+              data: {
+                type: 'metric',
+                attributes: {
+                  name: @event
+                }
+              }
+            },
+            profile: @email.present? ? profile : guest_profile,
+            **top_level_attributes
+          }
+        }
+      }
+    end
+
+    private
+
+    def top_level_attributes
+      if @resource.is_a?(::Spree::Order)
+        OrderAttributesPresenter.new(event_name: @event, order: @resource).call
+      else
+        {}
+      end
+    end
+
+    def properties
+      if @resource.is_a? ::Spree::Order
+        OrderPresenter.new(order: @resource).call
+      elsif @resource.is_a? ::Spree::Shipment
+        ShipmentPresenter.new(shipment: @resource, store: @store).call
+      elsif @resource.is_a? ::Spree::Product
+        ProductPresenter.new(product: @resource, store: @store).call
+      elsif @resource.is_a? ::Spree::Taxon
+        TaxonPresenter.new(taxon: @resource).call
+      elsif @resource.is_a? String
+        {
+          query: @resource
+        }
+      else
+        {}
+      end
+    end
+
+    def profile
+      if @resource.is_a?(::Spree::Order) && events_that_update_profile.include?(@event)
+        UserPresenter.new(
+          email: @email,
+          address: @resource&.bill_address || @resource&.ship_address,
+          user: @resource&.user,
+          guest_id: @guest_id
+        ).call
+      else
+        {
+          data: {
+            type: 'profile',
+            attributes: {
+              anonymous_id: @guest_id,
+              email: @email
+            }
+          }
+        }
+      end
+    end
+
+    def guest_profile
+      {
+        data: {
+          type: 'profile',
+          attributes: {
+            anonymous_id: @guest_id
+          }
+        }
+      }
+    end
+
+    def events_that_update_profile
+      @events_that_update_profile ||= [::Spree::Analytics.events[:checkout_email_entered], ::Spree::Analytics.events[:order_completed]]
+    end
+  end
+end

data/app/presenters/spree_klaviyo/line_item_presenter.rb

@@ -0,0 +1,28 @@
+module SpreeKlaviyo
+  class LineItemPresenter < ProductPresenter
+    include ::Spree::BaseHelper
+    include ::Spree::ProductsHelper
+
+    def initialize(resource:, quantity:, total_price:, currency:, store:, position: nil)
+      @resource = resource
+      @position = position
+      @quantity = quantity
+      @total_price = total_price
+      super(product: resource&.product, store: store)
+    end
+
+    def call
+      return {} if @resource.nil?
+
+      super.merge({
+                    quantity: @quantity,
+                    item_price: @resource.price,
+                    row_total: @total_price
+                  })
+    end
+
+    private
+
+    attr_reader :resource, :quantity, :total_price, :currency, :position, :current_store, :feeable_item_ids
+  end
+end

data/app/presenters/spree_klaviyo/order_attributes_presenter.rb

@@ -0,0 +1,28 @@
+module SpreeKlaviyo
+  class OrderAttributesPresenter
+    def initialize(order:, event_name:)
+      @order = order
+      @event_name = event_name
+    end
+
+    def call
+      {
+        value: @order.total&.to_f,
+        time: time(@order)&.iso8601
+      }
+    end
+
+    private
+
+    def time(order)
+      case @event_name
+      when ::Spree::Analytics.events[:order_completed]
+        order.completed_at
+      when 'Order Cancelled'
+        order.canceled_at
+      else
+        order.updated_at
+      end
+    end
+  end
+end

data/app/presenters/spree_klaviyo/order_presenter.rb

@@ -0,0 +1,95 @@
+module SpreeKlaviyo
+  class OrderPresenter
+    include ::Spree::BaseHelper
+    include ::Spree::ImagesHelper
+
+    def initialize(order:)
+      @order = order
+      @current_store = order.store
+      @products = products(order)
+    end
+
+    def call
+      {
+        email: @order&.user&.email || @order.email,
+        customer_name: @order.name || ::Spree.t('customer'),
+        store_name: @current_store.name,
+        order_id: @order.number,
+        order_number: @order.number,
+        affiliation: @order.store.name,
+        value: subtotal,
+        subtotal: subtotal,
+        item_total: @order.item_total&.to_f,
+        total: @order.total.to_f,
+        revenue: @order.total&.to_f,
+        shipping: @order.shipments.sum(&:cost).to_f,
+        shipping_method: shipping_method_names,
+        tax: @order.additional_tax_total&.to_f,
+        included_tax: @order.included_tax_total&.to_f,
+        discount: @order.promo_total&.to_f,
+        items: products(@order),
+        coupon: @order.coupon_code.to_s,
+        currency: @order.currency,
+        completed_at: @order.completed_at&.iso8601.to_s,
+        checkout_url: ::Spree::Core::Engine.routes.url_helpers.checkout_url(host: @current_store.url_or_custom_domain, token: @order.token),
+        all_adjustments: all_adjustments,
+        bill_address: AddressPresenter.new(address: @order.bill_address).call,
+        ship_address: AddressPresenter.new(address: @order.ship_address).call
+      }.merge(try_shipped_shipments)
+    end
+
+    private
+
+    attr_reader :order, :current_store
+
+    def products(order)
+      @products ||= order.line_items.includes(variant: { product: :taxons }).map.with_index do |line_item, index|
+        LineItemPresenter.new(
+          resource: line_item,
+          quantity: line_item.quantity,
+          total_price: line_item.amount,
+          currency: order.currency,
+          position: index + 1,
+          store: order.store
+        ).call
+      end
+    end
+
+    def all_adjustments
+      @order.all_adjustments.promotion.eligible.group_by(&:label).map do |label, adjustments|
+        {
+          label: label,
+          amount: adjustments.sum(&:amount).to_f
+        }
+      end
+    end
+
+    def shipping_method_names
+      @shipping_method_names ||= @order.shipments.map { |shipment| shipping_method_name(shipment) }.compact.uniq.join(',')
+    end
+
+    def shipping_method_name(shipment)
+      shipment.shipping_method&.name.to_s
+    end
+
+    def try_shipped_shipments
+      return {} unless @order.fully_shipped? && @order.shipments.shipped.any?
+
+      {
+        shipped_shipments: @order.shipments.shipped.map do |shipment|
+          ShipmentPresenter.new(order: @order, shipment: shipment).call
+        end
+      }
+    end
+
+    def subtotal
+      @order.analytics_subtotal
+    end
+
+    def try_variants(variant)
+      {
+        variant_dict: ::Spree::Variants::OptionsPresenter.new(variant).to_hash
+      }
+    end
+  end
+end

data/app/presenters/spree_klaviyo/product_presenter.rb

@@ -0,0 +1,32 @@
+module SpreeKlaviyo
+  class ProductPresenter
+    include ::Spree::BaseHelper
+    include ::Spree::ImagesHelper
+    include Rails.application.routes.mounted_helpers
+
+    def initialize(product:, store:)
+      @product = product
+      @current_store = store
+      @current_currency = store.default_currency
+    end
+
+    def call
+      return {} if @product.nil?
+
+      {
+        name: @product.name,
+        price: @product.amount_in(current_currency)&.to_f,
+        brand: @product&.brand_name,
+        category: @product.main_taxon&.pretty_name,
+        currency: current_currency,
+        url: spree_storefront_resource_url(@product, store: @store),
+        image_url: @product.default_image.present? ? spree_image_url(@product.default_image, width: 1200, height: 1200) : '',
+        sku: @product.sku
+      }
+    end
+
+    private
+
+    attr_reader :current_store, :current_currency
+  end
+end

data/app/presenters/spree_klaviyo/shipment_presenter.rb

@@ -0,0 +1,53 @@
+module SpreeKlaviyo
+  class ShipmentPresenter < OrderPresenter
+    include ::Spree::BaseHelper
+    include ::Spree::ProductsHelper
+    include ::Spree::ImagesHelper
+    include Rails.application.routes.mounted_helpers
+
+    def initialize(shipment:, order: nil, store: nil)
+      @shipment = shipment
+      @order = order || shipment.order
+      @current_store = store || order.store || shipment.store
+    end
+
+    def call
+      {
+        customer_name: @order.name || ::Spree.t('customer'),
+        email: @order&.user&.email || @order.email,
+        order_number: @order.number,
+        shipping_method: shipping_method_name(@shipment),
+        tracking: @shipment&.tracking.to_s,
+        tracking_url: @shipment&.tracking_url,
+        store_name: @current_store.name,
+        cost: @shipment.final_price.to_f,
+        completed_at: @order.completed_at&.iso8601.to_s,
+        shipped_items: shipped_items,
+        bill_address: AddressPresenter.new(address: @order.bill_address).call,
+        ship_address: AddressPresenter.new(address: @order.ship_address).call
+      }
+    end
+
+    private
+
+    attr_reader :order, :shipment, :current_store
+
+    def shipped_items
+      @shipment.manifest.map do |shipped_item|
+        shipped_items_quantity = shipped_item.line_item.quantity
+        {
+          url: spree_storefront_resource_url(shipped_item.variant.product),
+          image_url: shipped_item.variant.default_image.present? ? spree_image_url(shipped_item.variant.default_image, width: 1200, height: 1200) : '',
+          name: shipped_item.variant.name,
+          variant: shipped_item.variant.options_text,
+          sku: shipped_item.variant.sku,
+          shipped_quantity: shipped_item.quantity,
+          total_quantity: shipped_items_quantity,
+          price: shipped_item.line_item.price.to_f,
+          total_price: shipped_item.line_item.amount.to_f,
+          brand: brand_name(shipped_item.variant.product)
+        }.merge(try_variants(shipped_item.variant))
+      end
+    end
+  end
+end

data/app/presenters/spree_klaviyo/subscribe_presenter.rb

@@ -0,0 +1,48 @@
+module SpreeKlaviyo
+  class SubscribePresenter
+    SUBSCRIBED = 'SUBSCRIBED'.freeze
+    UNSUBSCRIBED = 'UNSUBSCRIBED'.freeze
+
+    def initialize(email:, list_id:, type: 'profile-subscription-bulk-create-job', subscribed: true)
+      @email = email
+      @list_id = list_id
+      @type = type
+      @subscribed = subscribed
+    end
+
+    def call
+      {
+        data: {
+          type: @type,
+          attributes: {
+            profiles: {
+              data: [
+                {
+                  "type": 'profile',
+                  "attributes": {
+                    email: @email,
+                    "subscriptions": {
+                      "email": {
+                        "marketing": {
+                          "consent": @subscribed ? SUBSCRIBED : UNSUBSCRIBED
+                        }
+                      }
+                    }
+                  }
+                }
+              ]
+            }
+          },
+          relationships: {
+            list: {
+              data: {
+                type: 'list',
+                id: @list_id
+              }
+            }
+          }
+        }
+      }
+    end
+  end
+end

data/app/presenters/spree_klaviyo/taxon_presenter.rb

@@ -0,0 +1,19 @@
+module SpreeKlaviyo
+  class TaxonPresenter
+    include ::Spree::BaseHelper
+    include ::Spree::ImagesHelper
+    include Rails.application.routes.mounted_helpers
+
+    def initialize(taxon:)
+      @taxon = taxon
+    end
+
+    def call
+      {
+        name: @taxon.pretty_name,
+        image_url: @taxon.image.present? ? spree_image_url(@taxon.image, width: 1200, height: 1200) : '',
+        url: spree_storefront_resource_url(@taxon, store: @taxon.store)
+      }
+    end
+  end
+end

data/app/presenters/spree_klaviyo/user_presenter.rb

@@ -0,0 +1,39 @@
+module SpreeKlaviyo
+  class UserPresenter
+    def initialize(email:, address: nil, user: nil, guest_id: nil)
+      @email = email
+      @address = address
+      @user = user
+      @guest_id = guest_id
+    end
+
+    def call
+      {
+        data: {
+          type: 'profile',
+          attributes: {
+            anonymous_id: @guest_id,
+            email: @user.present? ? @user.email : @email,
+            first_name: @user&.first_name || @address&.first_name,
+            last_name: @user&.last_name || @address&.last_name,
+            external_id: @user&.id,
+            location: {
+              address1: @address&.address1,
+              address2: @address&.address2,
+              city: @address&.city,
+              country: @address&.country_name,
+              region: @address&.state_text,
+              zip: @address&.zipcode
+            }
+          }
+        }.merge(try_klaviyo_id)
+      }
+    end
+
+    private
+
+    def try_klaviyo_id
+      @user&.klaviyo_id.present? ? { id: @user.klaviyo_id } : {}
+    end
+  end
+end

data/app/services/spree_klaviyo/base.rb

@@ -0,0 +1,5 @@
+module SpreeKlaviyo
+  class Base
+    prepend ::Spree::ServiceModule::Base
+  end
+end

data/app/services/spree_klaviyo/create_event.rb

@@ -0,0 +1,16 @@
+module SpreeKlaviyo
+  class CreateEvent < Base
+    prepend ::Spree::ServiceModule::Base
+
+    def call(klaviyo_integration:, event:, resource:, email:, guest_id: nil)
+      return failure(false, ::Spree.t('admin.integrations.klaviyo.not_found')) unless klaviyo_integration
+
+      klaviyo_integration.create_event(
+        event: event,
+        resource: resource,
+        email: email,
+        guest_id: guest_id
+      )
+    end
+  end
+end

data/app/services/spree_klaviyo/create_or_update_profile.rb

@@ -0,0 +1,25 @@
+module SpreeKlaviyo
+  class CreateOrUpdateProfile < Base
+    prepend ::Spree::ServiceModule::Base
+
+    def call(klaviyo_integration:, user:, guest_id: nil)
+      return failure(false, ::Spree.t('admin.integrations.klaviyo.not_found')) unless klaviyo_integration
+
+      if user.klaviyo_id.blank?
+        fetch_profile_result = FetchProfile.call(klaviyo_integration: klaviyo_integration, user: user)
+
+        if fetch_profile_result.success?
+          return klaviyo_integration.update_profile(user, guest_id) if guest_id.present?
+
+          return fetch_profile_result
+        end
+
+        klaviyo_integration.create_profile(user).tap do |result|
+          user.update!(klaviyo_id: JSON.parse(result.value).dig('data', 'id')) if result.success?
+        end
+      end
+
+      klaviyo_integration.update_profile(user)
+    end
+  end
+end

data/app/services/spree_klaviyo/fetch_profile.rb

@@ -0,0 +1,15 @@
+module SpreeKlaviyo
+  class FetchProfile < Base
+    prepend ::Spree::ServiceModule::Base
+
+    def call(klaviyo_integration:, user:)
+      return failure(false, ::Spree.t('admin.integrations.klaviyo.not_found')) unless klaviyo_integration
+
+      return success(user.klaviyo_id) if user.klaviyo_id.present?
+
+      klaviyo_integration.fetch_profile(email: user.email).tap do |result|
+        user.update!(klaviyo_id: JSON.parse(result.value)['data'].first['id']) if result.success?
+      end
+    end
+  end
+end

data/app/services/spree_klaviyo/subscribe.rb

@@ -0,0 +1,13 @@
+module SpreeKlaviyo
+  class Subscribe < Base
+    prepend ::Spree::ServiceModule::Base
+
+    def call(klaviyo_integration:, email:, user: nil)
+      return failure(false, ::Spree.t('admin.integrations.klaviyo.not_found')) unless klaviyo_integration
+
+      klaviyo_integration.subscribe_user(email).tap do |result|
+        user.update(klaviyo_subscribed: true) if result.success? && user && !user.klaviyo_subscribed?
+      end
+    end
+  end
+end

data/app/services/spree_klaviyo/unsubscribe.rb

@@ -0,0 +1,13 @@
+module SpreeKlaviyo
+  class Unsubscribe < Base
+    prepend ::Spree::ServiceModule::Base
+
+    def call(klaviyo_integration:, email:, user: nil)
+      return failure(false, ::Spree.t('admin.integrations.klaviyo.not_found')) unless klaviyo_integration
+
+      klaviyo_integration.unsubscribe_user(email).tap do |result|
+        user.update(klaviyo_subscribed: false) if result.success? && user && user.klaviyo_subscribed?
+      end
+    end
+  end
+end

data/app/views/spree/admin/integrations/forms/_klaviyo.html.erb

@@ -0,0 +1,48 @@
+<div class="alert alert-info">
+  <div>
+    Having trouble? Follow <%= external_link_to " our setup guide", "https://spreecommerce.org/docs/integrations/marketing/klaviyo" %> for more information.
+  </div>
+</div>
+
+<div class="col-12 col-md-6 p-0">
+  <div class="card mb-4">
+    <div class="card-body">
+      <%= preference_field(
+        @integration,
+        form,
+        "klaviyo_public_api_key",
+        i18n_scope: "admin.integrations.klaviyo",
+      ) %>
+      <p class="mb-4 mt-n2">
+        <%= external_link_to "Where to find my API Key?",
+        "https://help.klaviyo.com/hc/en-us/articles/115005062267-How-to-Manage-Your-Account-s-API-Keys" %>
+      </p>
+
+      <%= preference_field(
+        @integration,
+        form,
+        "klaviyo_private_api_key",
+        i18n_scope: "admin.integrations.klaviyo",
+      ) %>
+      <p class="mb-4 mt-n2">
+        <%= external_link_to "Where to find my Private API key?",
+        "https://help.klaviyo.com/hc/en-us/articles/115005062267-How-to-Manage-Your-Account-s-API-Keys" %>
+      </p>
+
+      <%= preference_field(
+        @integration,
+        form,
+        "default_newsletter_list_id",
+        i18n_scope: "admin.integrations.klaviyo",
+      ) %>
+      <p class="mt-n2">
+        <%= external_link_to "Where to find list ID?",
+        "https://help.klaviyo.com/hc/en-us/articles/115005078647-How-to-find-a-list-ID" %>
+      </p>
+      <div class="alert alert-info mt-n2 mb-0">
+        This list will be used as the default newsletter list for your
+        customers signing up from storefront and checkout.
+      </div>
+    </div>
+  </div>
+</div>