workarea-listrak 5.0.1

data/app/view_models/workarea/admin/listrak_configuration_view_model.rb

@@ -0,0 +1,17 @@
+module Workarea
+  module Admin
+    class ListrakConfigurationViewModel < ApplicationViewModel
+      def all_lists
+        @all_lists ||= Workarea::Listrak.email.lists.all
+      end
+
+      def event_options
+        events.map { |event| [event.name, event.id] }
+      end
+
+      def events
+        @events ||= Workarea::Listrak.email.events.all default_list_id
+      end
+    end
+  end
+end

data/app/views/workarea/admin/listrak/configurations/edit.html.haml

@@ -0,0 +1,28 @@
+- @page_title = t('workarea.admin.listrak_configuration.edit.title')
+
+.view
+  .view__header
+    .view__heading
+      = link_to "↑ #{t('workarea.admin.dashboards.settings.settings_dashboard')}", settings_dashboards_path
+      %h1= t('workarea.admin.listrak_configuration.edit.title')
+
+  .view__container
+    = form_tag listrak_configuration_path, method: :patch, data: { unsaved_changes: '' } do
+      .property
+        = label_tag 'default_list_id', t('workarea.admin.listrak_configuration.edit.default_list'), class: 'property__name'
+        = select_tag 'default_list_id', options_from_collection_for_select(@configuration.all_lists, 'id', 'name', @configuration.default_list_id)
+
+      .property
+        = label_tag 'external_event_ids[]', class: 'property__name' do
+          %span= t('workarea.admin.listrak_configuration.edit.external_events')
+
+          = link_to "#event_ids", data: { tooltip: '' } do
+            = inline_svg('workarea/admin/icons/help.svg', class: 'svg-icon svg-icon--small svg-icon--blue', title: t('workarea.admin.content.form.tooltip.title'))
+          #event_ids.tooltip-content= t('workarea.admin.listrak_configuration.edit.event_itds_tooltip')
+
+        = select_tag "external_event_ids[]", options_for_select(@configuration.event_options, @configuration.external_event_ids), multiple: true, data: { listrak_events_select: "" }
+
+
+      .workflow-bar
+        .grid.grid--auto.grid--right.grid--middle
+          .grid__cell= button_tag t('workarea.admin.listrak_configuration.edit.button'), value: 'save_settings', class: 'workflow-bar__button workflow-bar__button--update'

data/app/views/workarea/admin/listrak/events/index.json.jbuilder

@@ -0,0 +1,4 @@
+json.results @events do |event|
+  json.label event.name
+  json.value event.id
+end

data/app/views/workarea/admin/shared/_listrak_configuration_link.html.haml

@@ -0,0 +1 @@
+%li{ class: "primary-nav__item" }= link_to t('workarea.admin.shared.primary_nav.listrak_configuration_title'), edit_listrak_configuration_path, class: navigation_link_classes(edit_listrak_configuration_path)

data/app/views/workarea/storefront/checkouts/_listrak.html.haml

@@ -0,0 +1,2 @@
+- if Workarea.config.listrak[:merchant_id].present?
+  %img{ src: "https://fp.listrakbi.com/fp/#{Workarea.config.listrak[:merchant_id]}.jpg", height: "1", width: "1" }

data/app/workers/workarea/listrak/customer_exporter.rb

@@ -0,0 +1,22 @@
+module Workarea
+  module Listrak
+    class CustomerExporter
+      include Sidekiq::Worker
+      include Sidekiq::CallbacksWorker
+
+      sidekiq_options(
+        enqueue_on: {
+          Workarea::User => :save
+        }
+      )
+
+      def perform(user_id)
+        user = Workarea::User.find user_id
+
+        customer_form = Listrak::Models::CustomerForm.new user
+
+        Listrak.data.customers.import [customer_form]
+      end
+    end
+  end
+end

data/app/workers/workarea/listrak/order_exporter.rb

@@ -0,0 +1,22 @@
+module Workarea
+  module Listrak
+    class OrderExporter
+      include Sidekiq::Worker
+      include Sidekiq::CallbacksWorker
+
+      sidekiq_options(
+        enqueue_on: {
+          Workarea::Order => :place
+        }
+      )
+
+      def perform(order_id)
+        order = Workarea::Order.find order_id
+
+        order_form = Listrak::Models::OrderForm.new order
+
+        Listrak.data.orders.import [order_form]
+      end
+    end
+  end
+end

data/app/workers/workarea/listrak/product_exporter.rb

@@ -0,0 +1,50 @@
+module Workarea
+  module Listrak
+    class ProductExporter
+      include Sidekiq::Worker
+      include Sidekiq::CallbacksWorker
+
+      sidekiq_options(
+        enqueue_on: {
+          Catalog::Product => :save,
+          Shipping::Sku => :save,
+          Pricing::Sku => :save,
+          Pricing::Price => :save,
+          with: -> { ProductExporter.perform_with(self) }
+        }
+      )
+
+      def self.perform_with(model)
+        case model.class.name
+        when "Workarea::Pricing::Price"
+          [model.sku.class.name, model.sku.id]
+        else
+          [model.class.name, model.id]
+        end
+      end
+
+      def perform(class_name, id)
+        product, skus =
+          if class_name == "Workarea::Catalog::Product"
+            prod = Catalog::Product.find(id)
+            [prod, prod.skus]
+          else
+            [Catalog::Product.find_by_sku(id), [id]]
+          end
+
+        return unless product.present?
+
+        inventory = Inventory::Collection.new product.skus
+        pricing = Inventory::Collection.new product.skus
+
+        listrak_products = skus.map do |sku|
+          Listrak::Models::ProductForm.new product,
+            pricing_sku: pricing.for_sku(sku),
+            inventory_sku: inventory.for_sku(sku)
+        end
+
+        Workarea::Listrak.data.products.import(listrak_products)
+      end
+    end
+  end
+end

data/app/workers/workarea/listrak/subscribe_email_signup.rb

@@ -0,0 +1,34 @@
+module Workarea
+  module Listrak
+    class SubscribeEmailSignup
+      include Sidekiq::Worker
+      include Sidekiq::CallbacksWorker
+
+      sidekiq_options(
+        enqueue_on: {
+          Email::Signup => :create
+        },
+        queue: "low",
+        retry: true
+      )
+
+      def perform(id)
+        signup = Email::Signup.find id
+        list_id = Listrak.configuration.default_list_id
+        event_ids = Array.wrap(Listrak.configuration.external_event_ids).to_csv(row_sep: nil).presence
+
+        contact = Listrak::Models::ContactForm.new(
+          email: signup.email,
+          subscription_state: 'Subscribed'
+        )
+
+        options = {
+          overrideUnsubscribe: true,
+          eventIds: event_ids
+        }.compact
+
+        Listrak.email.contacts.upsert list_id, contact, options
+      end
+    end
+  end
+end

data/app/workers/workarea/listrak/unsubscribe_email_signup.rb

@@ -0,0 +1,27 @@
+module Workarea
+  module Listrak
+    class UnsubscribeEmailSignup
+      include Sidekiq::Worker
+      include Sidekiq::CallbacksWorker
+
+      sidekiq_options(
+        enqueue_on: {
+          Email::Signup => :destroy,
+          with: -> { [email] }
+        },
+        queue: "low",
+        retry: true
+      )
+
+      def perform(email)
+        contact = Listrak::Models::ContactForm.new(
+          email: email,
+          subscription_state: 'Unsubscribed'
+        )
+
+        list_id = Listrak.configuration.default_list_id
+        Listrak.email.contacts.upsert list_id, contact, overrideUnsubscribe: true
+      end
+    end
+  end
+end

data/bin/rails

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails gems
+# installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path("../..", __FILE__)
+ENGINE_PATH = File.expand_path("../../lib/workarea/listrak/engine", __FILE__)
+
+# Set up gems listed in the Gemfile.
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile", __FILE__)
+require "bundler/setup" if File.exist?(ENV["BUNDLE_GEMFILE"])
+
+require "action_controller/railtie"
+require "action_view/railtie"
+require "action_mailer/railtie"
+require "rails/test_unit/railtie"
+require "sprockets/railtie"
+
+require "rails/engine/commands"

data/bin/rake

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rake", "rake")

data/bin/rspec

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")

data/bin/rubocop

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rubocop' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rubocop", "rubocop")

data/config/initializers/append_points.rb

@@ -0,0 +1,28 @@
+# Analytics adapter for Listrak tag management
+Workarea::Plugin.append_javascripts(
+  "storefront.modules",
+  "workarea/storefront/listrak/adapters/listrak_adapter",
+  "workarea/storefront/listrak/modules/listrak"
+)
+
+# Pass configuration for the Listrak adapter to the client-side
+Workarea::Plugin.append_javascripts(
+  "storefront.config",
+  "workarea/storefront/listrak/listrak_config"
+)
+
+Workarea::Plugin.append_javascripts(
+  "admin.modules",
+  "workarea/admin/modules/listrak/list_events_select"
+)
+
+# Tracking pixel for checkout conversion tracking
+Workarea::Plugin.append_javascripts(
+  "storefront.checkout_confirmation",
+  "workarea/storefront/checkouts/listrak"
+)
+
+Workarea.append_partials(
+  "admin.settings_menu",
+  "workarea/admin/shared/listrak_configuration_link"
+)

data/config/initializers/configuration.rb

@@ -0,0 +1,8 @@
+Workarea.configure do |config|
+  config.listrak = ActiveSupport::Configurable::Configuration.new
+
+  config.listrak.analytics = {
+    merchant_id: nil,
+    email_capture_ids: nil
+  }
+end

data/config/locales/en.yml

@@ -0,0 +1,17 @@
+en:
+  workarea:
+    admin:
+      listrak_configuration:
+        edit:
+          flash_messages:
+            updated: Listrak configuration has been updated
+            save_error: There was a problem updating the configuration
+          title: Listrak Configuration
+          default_list: Default List
+          external_events: External Events
+          events_select_placeholder: Choose external events
+          event_itds_tooltip: External event ids to trigger when subscribing the customer
+          button: Save Listrak Configuration
+      shared:
+        primary_nav:
+          listrak_configuration_title: Listrak Configuration

data/config/routes.rb

@@ -0,0 +1,10 @@
+Workarea::Admin::Engine.routes.draw do
+  scope '(:locale)', constraints: Workarea::I18n.routes_constraint do
+    namespace :listrak do
+      resource :configuration, only: [:edit, :update]
+      resources :lists, only: [] do
+        resources :events, only: :index
+      end
+    end
+  end
+end

data/lib/generators/workarea/listrak/message/USAGE

@@ -0,0 +1,9 @@
+Description:
+    Generates the class that kicks off a new transactional email to
+    Listrak for delivery.
+
+Example:
+    rails generate workarea:listrak:message BackorderConfirmation
+
+    This will create:
+        app/messages/workarea/backorder_confirmation_message.rb

data/lib/generators/workarea/listrak/message/message_generator.rb

@@ -0,0 +1,15 @@
+module Workarea
+  module Listrak
+    # Generate new Message classes for your host app (or plugin).
+    class MessageGenerator < Rails::Generators::NamedBase
+      source_root File.expand_path("../templates", __FILE__)
+
+      def copy_agent
+        template(
+          "message.rb.erb",
+          "app/messages/workarea/#{file_name}_message.rb"
+        )
+      end
+    end
+  end
+end

data/lib/generators/workarea/listrak/message/templates/message.rb.erb

@@ -0,0 +1,24 @@
+module Workarea
+  class <%= class_name %>Message
+    include Listrak::TransactionalMessage
+
+    # message_id 45678
+    # message_attributes(
+    #   name: 12345
+    # )
+    #
+    # def initialize(order)
+    #   @order = order
+    # end
+    #
+    # def name
+    #   "#{@order.first_name} #{@order.last_name}"
+    # end
+
+    private
+
+      def email_address
+        # TODO
+      end
+  end
+end

data/lib/workarea/listrak/analytics.rb

@@ -0,0 +1,17 @@
+module Workarea
+  module Listrak
+    module Analytics
+      # Shorthand for analytics module specific configuration.
+      def self.config
+        Workarea.config.listrak.analytics
+      end
+
+      def self.javascript_config
+        {
+          merchantId: config[:merchant_id],
+          emailIds: config[:email_capture_ids]
+        }.compact.to_json
+      end
+    end
+  end
+end

data/lib/workarea/listrak/bogus_data_api/customers.rb

@@ -0,0 +1,9 @@
+module Workarea
+  module Listrak
+    class BogusDataApi::Customers
+      def import(_customers)
+        return "12345"
+      end
+    end
+  end
+end

data/lib/workarea/listrak/bogus_data_api/orders.rb

@@ -0,0 +1,9 @@
+module Workarea
+  module Listrak
+    class BogusDataApi::Orders
+      def import(_orders)
+        return "12345"
+      end
+    end
+  end
+end

data/lib/workarea/listrak/bogus_data_api/products.rb

@@ -0,0 +1,9 @@
+module Workarea
+  module Listrak
+    class BogusDataApi::Products
+      def import(_products)
+        return "12345"
+      end
+    end
+  end
+end

data/lib/workarea/listrak/bogus_data_api/proxy_client.rb

@@ -0,0 +1,29 @@
+module Workarea
+  module Listrak
+    class BogusDataApi
+      class ProxyClient
+        attr_reader :client_name, :client
+
+        def initialize(client_name, client)
+          @client_name = client_name
+          @client = client
+        end
+
+        def method_missing(method, *args)
+          if client.respond_to?(method)
+            if BogusDataApi.store_requests
+              BogusDataApi.requests[client_name][method] << args
+            end
+            client.send(method, *args)
+          else
+            super
+          end
+        end
+
+        def respond_to_missing?(method, include_all = false)
+          client.respond_to?(method) || super
+        end
+      end
+    end
+  end
+end

data/lib/workarea/listrak/bogus_data_api.rb

@@ -0,0 +1,46 @@
+module Workarea
+  module Listrak
+    # @!visibility private
+    class BogusDataApi
+      require 'workarea/listrak/bogus_data_api/proxy_client'
+      require 'workarea/listrak/bogus_data_api/products'
+      require 'workarea/listrak/bogus_data_api/customers'
+      require 'workarea/listrak/bogus_data_api/orders'
+
+      thread_cattr_accessor :requests, :store_requests
+
+      def self.reset_requests!
+        self.requests = Hash.new do |client_hash, client_class|
+          client_hash[client_class] = Hash.new do |method_hash, method_name|
+            method_hash[method_name] = []
+          end
+        end
+      end
+
+      def self.total_request_count
+        self.requests.sum do |client, method_calls|
+          method_calls.sum { |_method, calls| calls.size }
+        end
+      end
+
+      self.store_requests = false
+      self.reset_requests!
+
+      def method_missing(method)
+        client_class = client(method)
+
+        if client_class
+          ProxyClient.new(method, client_class.new)
+        else
+          super
+        end
+      end
+
+      private
+
+        def client(client_name)
+          BogusDataApi.const_get(client_name.to_s.camelize) rescue nil
+        end
+    end
+  end
+end

data/lib/workarea/listrak/bogus_email_api/contacts.rb

@@ -0,0 +1,8 @@
+module Workarea
+  module Listrak
+    class BogusEmailApi::Contacts
+      def upsert(_list_id, _contact_form, _options = {})
+      end
+    end
+  end
+end

data/lib/workarea/listrak/bogus_email_api/events.rb

@@ -0,0 +1,23 @@
+module Workarea
+  module Listrak
+    class BogusEmailApi::Events
+      def all(_list_id)
+        events = [
+          {
+            "eventId" => 12714,
+            "eventName" => "Test",
+            "eventGroupId" => 0,
+            "status" => "Active"
+          },
+          {
+            "eventId" => 12715,
+            "eventName" => "footer signup",
+            "eventGroupId" => 0,
+            "status" => "Active"
+          }
+        ]
+        events.map { |event| Listrak::Models::Event.new event }
+      end
+    end
+  end
+end

data/lib/workarea/listrak/bogus_email_api/lists.rb

@@ -0,0 +1,63 @@
+module Workarea
+  module Listrak
+    class BogusEmailApi::Lists
+      def all
+        lists = [
+          {
+            "listId" => 349956,
+            "listName" => "My First List",
+            "folderId" => 0,
+            "ipPoolId" => 11,
+            "bounceDomainAlias" => "",
+            "bounceHandling" => "Standard",
+            "bounceUnsubscribeCount" => 5,
+            "createDate" => "2015-08-31T16:02:41.65",
+            "enableBrowserLink" => false,
+            "enableDoubleOptIn" => false,
+            "enableDynamicContent" => false,
+            "enableGoogleAnalytics" => false,
+            "enableInternationalization" => false,
+            "enableListHygiene" => true,
+            "enableListRemovalHeader" => true,
+            "enableListRemovalLink" => true,
+            "enableListrakAnalytics" => false,
+            "enableSpamScorePersonalization" => false,
+            "enableToNamePersonalization" => false,
+            "fromEmail" => "",
+            "fromName" => "",
+            "googleTrackingDomains" => [],
+            "linkDomainAlias" => "",
+            "mediaDomainAlias" => ""
+          },
+          {
+            "listId" => 349984,
+            "listName" => "gem-testing",
+            "folderId" => 0,
+            "ipPoolId" => 11,
+            "bounceDomainAlias" => "",
+            "bounceHandling" => "Standard",
+            "bounceUnsubscribeCount" => 5,
+            "createDate" => "2015-09-02T14:42:38.91",
+            "enableBrowserLink" => false,
+            "enableDoubleOptIn" => false,
+            "enableDynamicContent" => false,
+            "enableGoogleAnalytics" => false,
+            "enableInternationalization" => false,
+            "enableListHygiene" => true,
+            "enableListRemovalHeader" => true,
+            "enableListRemovalLink" => true,
+            "enableListrakAnalytics" => false,
+            "enableSpamScorePersonalization" => false,
+            "enableToNamePersonalization" => false,
+            "fromEmail" => "mac@weblinc.com",
+            "fromName" => "WebLinc Developer",
+            "googleTrackingDomains" => [],
+            "linkDomainAlias" => "",
+            "mediaDomainAlias" => ""
+          }
+        ]
+        lists.map { |list| Listrak::Models::List.new list }
+      end
+    end
+  end
+end

data/lib/workarea/listrak/bogus_email_api/proxy_client.rb

@@ -0,0 +1,29 @@
+module Workarea
+  module Listrak
+    class BogusEmailApi
+      class ProxyClient
+        attr_reader :client_name, :client
+
+        def initialize(client_name, client)
+          @client_name = client_name
+          @client = client
+        end
+
+        def method_missing(method, *args)
+          if client.respond_to?(method)
+            if BogusEmailApi.store_requests
+              BogusEmailApi.requests[client_name][method] << args
+            end
+            client.send(method, *args)
+          else
+            super
+          end
+        end
+
+        def respond_to_missing?(method, include_all = false)
+          client.respond_to?(method) || super
+        end
+      end
+    end
+  end
+end