workarea-listrak 5.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2100d5e0ce9d7e3640ef0987da83414d700c9c3bcd166d59f5d7517d53d46f61
+  data.tar.gz: 628151e8705a7bd39a7c8365b5624701e38009aa70acf57c637b0db4d830e89a
+SHA512:
+  metadata.gz: 14769fb83d044f5cccfe0dfaccdcdcb51f3e2ba68df6738b2c0507ca1aaa67fb8e7b4669efa828d247ea8209cdb4c2dbdbb1e495f8249d38838bc2e362fe0ffd
+  data.tar.gz: 4d0141ffd9abfaa4facdc9594768c70424f5b4d0c6e5b1874b2ea40ba424706f65a1fc281e9ffc6d1c4529a27eefd6afb575bc36c2f08df94b3a920c86ae325a

data/.eslintrc.json

@@ -0,0 +1,36 @@
+{
+    "extends": "eslint:recommended",
+    "rules": {
+      "semi": ["error", "always"],
+      "eqeqeq": ["error", "always"]
+    },
+    "globals": {
+      "window": true,
+      "document": true,
+      "WORKAREA": true,
+      "$": true,
+      "jQuery": true,
+      "_": true,
+      "feature": true,
+      "JST": true,
+      "Turbolinks": true,
+      "I18n": true,
+      "Chart": true,
+      "Dropzone": true,
+      "strftime": true,
+      "Waypoint": true,
+      "wysihtml": true,
+      "LocalTime": true,
+      "describe": true,
+      "after": true,
+      "afterEach": true,
+      "before": true,
+      "beforeEach": true,
+      "it": true,
+      "expect": true,
+      "sinon": true,
+      "fixture": true,
+      "chai": true,
+      "_ltk": true
+    }
+}

data/.esvmrc

@@ -0,0 +1,5 @@
+{
+  "default": {
+    "version": "5.2"
+  }
+}

data/.gitignore

@@ -0,0 +1,32 @@
+*.gem
+*.rbc
+**/*/.DS_Store
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+Gemfile.lock
+test/dummy/tmp/export/*.csv
+.DS_Store
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+.byebug_history
+.envrc
+log
+tmp
+test/dummy/public/system/
+coverage

data/CHANGELOG.md

@@ -0,0 +1,322 @@
+Workarea Listrak 5.0.1 (2019-08-21)
+--------------------------------------------------------------------------------
+
+*   Open Source!
+
+
+
+Workarea Listrak 5.0.0 (2019-06-25)
+--------------------------------------------------------------------------------
+
+*   Listrak REST APIs
+
+    Replace the SOAP implementation with Lisrak's REST APIs
+
+    LISTRAK-52
+    Eric Pigeon
+
+
+
+Workarea Listrak 4.0.2 (2019-02-19)
+--------------------------------------------------------------------------------
+
+*   Perform the `_ltk` check when events are fired, instead of when the adapter is registered.
+
+    LISTRAK-59
+    Brian Berg
+
+*   Add condition to check the listrak SDK is available before running adapter callbacks
+
+    LISTRAK-57
+    Jake Beresford
+
+
+
+Workarea Listrak 4.0.1 (2018-01-11)
+--------------------------------------------------------------------------------
+
+*   Refactor Listrak SCA reporting
+
+    Our original implementation was not passing along configured
+    `email_capture_ids` to javascript, this updates that config markup to
+    match patterns present in other workarea plugins.
+
+    Listrak adapter was using route syntax from v2 when storefront was
+    called `store_front`.  Updating to the new v3 route resolves issues with
+    updating cart items analytics.
+
+    There was room for improvement with how our listrak module handled
+    adding SCA email address abandoner listener to every email field.
+    Before this plugin relied on host app to pass each field name in the
+    configuration, this update enchances that experience by also including a
+    search for _all_ email fields within a given `$scope`.
+
+    LISTRAK-47
+
+    Refactor JS
+
+    The mutation of the emailIds array made the updated JS hard to follow
+    and understand at what point what typeof `configIds`.
+
+    Names and var creation has been cleaned up to make the selector string
+    building more readable.
+
+    LISTRAK-47
+    Jordan Stewart
+
+
+Workarea Listrak 4.0.0 (2017-07-31)
+--------------------------------------------------------------------------------
+
+
+Workarea Listrak 4.0.0 (2017-07-31)
+--------------------------------------------------------------------------------
+
+
+Workarea Listrak 4.0.0 (2017-07-31)
+--------------------------------------------------------------------------------
+
+*   LISTRAK-45
+    Eric Pigeon
+
+*   Use different list ID in transactional email
+
+    Transactional emails always use a different List ID on Listrak than the
+    normal email subscribe list. This new configuration setting is available
+    in the `:listrak` secrets as `:transactional_list_id`.
+
+    LISTRAK-43
+    Tom Scott
+
+
+WebLinc Listrak 3.1.4.pre (2017-03-14)
+--------------------------------------------------------------------------------
+
+*   Fix regressions to older arity syntax
+
+    After the LISTRAK-42 fix was deployed as workarea-listrak v3.1.3, another
+    error popped up due to perform_api_call being called with the wrong
+    number of arguments.
+
+    Report: https://discourse.workarea.com/t/listrak-gem-contact-api-call-bug/680/3
+
+    LISTRAK-42
+    Tom Scott
+
+*   Write tagged log messages when making requests
+
+    When sending requests to Listrak's SOAP API, log all request/response
+    params so that we can easily debug the data in case of failure. This is
+    especially true for transactional messages. Also, make sure log messages
+    are tagged with "[LISTRAK]" so they can be easily found when grepping
+    through log history.
+
+    LISTRAK-41
+    Tom Scott
+
+*   Display price in fixed-point notation LISTRAK-40 SHADES-684
+    Tom Scott
+
+*   Use correct attribute for item price.
+
+    Price was not getting passed in AddItem() calls causing improper reports
+    on the Listrak admin side.
+
+    LISTRAK-40
+    SHADES-684
+    Tom Scott
+
+*   Merge branch 'bugfix/LISTRAK-39-dont-run-workers-except-in-production'
+
+    Added more docs.
+    Tom Scott
+
+*   Dont run workers except in production
+
+    all the environments were exporting to the same ftp with the same file
+    name, only enable the scheduled jobs when the environment is production.
+
+    LISTRAK-39
+    Eric Pigeon
+
+*   Fix typo in setting of Order.ItemTotal
+
+    The ItemTotal in this handler was being set to a blank value due to the
+    typo on the `payload.subtotal_price` key.
+
+    LISTRAK-37
+    Tom Scott
+
+*   Improve errors in Workarea::Listrak::Gateway
+
+    LISTRAK-34
+    Tom Scott
+
+*   Fix multiple email captures in Listrak
+
+    It seems that the CaptureEmail calls over each email_capture_id was
+    causing multiple requests to be sent to Listrak for each completed
+    field. This will prevent calls for nonexistent items by checking for
+    whether the field exists on the page prior to calling
+    `_ltk.SCA.CaptureEmail()` on it.
+
+    This fixes one of the tasks in SHADES-668 as well.
+
+    LISTRAK-36
+    Tom Scott
+
+*   Rename checkoutConfirmation to checkoutOrderPlaced
+
+    The JS code wasn't firing on confirmation because the analytics event
+    was misnamed, renamed it ot what's found in base so it will "Just Work".
+
+    This will also resolve SHADES-688 when it's deployed in **v3.0.1**.
+
+    LISTRAK-35
+    Tom Scott
+
+*   Add Jesse's changes for firing the ltk event.
+
+    LISTRAK-30
+    Tom Scott
+
+*   LISTRAK-30 Refactor Listrak JS code as an analytics adapter
+    Eric Pigeon
+
+*   Append sdk partial to storefront.javascript
+
+    This is apparently a more accurate place to be putting this code, in
+    addition, it places the code on the bottom of the page. Not really sure
+    how "breaking" of a change this is gonna be so hold off on merging
+    before we're sure.
+
+    LISTRAK-32
+    Tom Scott
+
+*   Hard-code WSDL URL
+
+    This URL never changes, there's no reason to supply it from secrets.
+
+    LISTRAK-31
+    Tom Scott
+
+*   Fix cart recreate tag
+
+    This is based on the implementation in Tahari, the cart recreate code
+    supplied by Listrak in their docs is apparently incorrect. Since the
+    `_ltk` object is already defined, we don't need to wait for any kind of
+    event. Instead, we should be calling Listrak SCA methods as soon as we
+    can.
+
+    LISTRAK-28
+    Tom Scott
+
+*   Use full url for product images
+
+    LISTRAK-25
+    Eric Pigeon
+
+*   Shedule product export nightly
+
+    LISTRAK-24
+    Eric Pigeon
+
+*   LISTRAK-123: Ensure product URL is fully-qualified
+
+    Had an issue with testing this one...had to hard-set the
+    `Workarea.config.domain`.
+    Tom Scott
+
+*   LISTRAK-20: Use absolute paths for CSVs
+
+    Can cause issues building files on the server, solved by always
+    prepending `Rails.root` in file_to_upload.
+    Tom Scott
+
+*   Fix ftp hash symbol access
+
+    fix trying to access hash from secrets as symbol keys
+    clean up decorator to follow convention
+    test decorated categorization method
+    fix dummy mongoid.yml to be mongoid 5 compliant
+    clean up gemspec authors
+
+    LISTRAK-19
+    Eric Pigeon
+
+*   Update item price method and ensure _ltk var exists
+
+    Running tests on this one uncovered an issue that would have caused the
+    cart summary view to error out. Updated the `item.unit_price` call to
+    `item.total_price` everywhere, since that field is defined on
+    Order::Item and OrderItemViewModel doesn't define a unit_price method.
+
+    LISTRAK-17
+    Tom Scott
+
+*   LISTRAK-17: Trigger cart updates when the cart summary view is rendered
+    bberg
+
+*   LISTRAK-16: Configuration refactor. Tom deflips table.
+    Mark Platt
+
+*   LISTRAK-16: Add secrets to an config in initializer. Update js to use config
+    Mark Platt
+
+*   Fix render_listrak_tracking_code overriding
+
+    This wasn't able to be overridden properly in the host app, and I had to
+    resort to a `nil?` check in order to allow it to be overridden. Not sure
+    of how the configuration hierarchy works in this case, but it's much
+    easier and clearer in the engine.rb to write it this way IMHO.
+
+    LISTRAK-13
+    Tom Scott
+
+*   v0.13.0: Render Listrak JS conditionally
+
+    Some clients wish to use Google Tag Manager in order to render
+    the Listrak JavaScript tracking code. While this was always
+    configurable, the setting has been renamed to
+    `listrak_render_tracking_code` in order to prevent naming conflicts and
+    be more descriptive of the domain in which it is active.
+
+    This is a major-version release in case anyone was already using the old,
+    badly-named config setting. Renamed it to be "namespaced" within
+    listrak, so it's easy to see where the setting is being used.
+
+    LISTRAK-11
+    Tom Scott
+
+*   Use configured merchant_id in Listrak JS tracker
+
+    Listrak needs to include a bit of JS on every page for tracking user
+    movements through the app. The merchant ID included in this tracking
+    code was hard-coded into the gem and the same for every user of the gem.
+    Refactored to use a secret from `config/secrets.yml` instead of the
+    hard-coded value. Users of the workarea-listrak gem will need to update
+    `config/secrets.yml` and insert a `:merchant_id:` into the `listrak:`
+    hash. This ID can be obtained from your client's Listrak account.
+
+    Releasing this as a minor version upgrade (v0.12.0) because it depends on
+    configuration in secrets.yml that wasn't there before, and will break
+    apps in production without a corresponding change to the encrypted data
+    bag for this app.
+
+    LISTRAK-10
+    Tom Scott
+
+*   Disable Listrak JS in testing.
+
+    When testing the application with Capybara, sometimes Listrak can fail
+    the build for random reasons. This definitely shouldn't block feature
+    testing an application, as this kind of integration can fail for a wide
+    variety of reasons, and we want our tests to depend on the network as
+    little as possible. This change surrounds the assignment of the JS
+    partial to the application layout with a conditional, that omits adding
+    the partial if we are currently in the test environment.
+
+    Example: https://bamboo.tools.workarea.com/browse/ESTUYO-DEV-172/log
+
+    LISTRAK-9
+    Tom Scott

data/Gemfile

@@ -0,0 +1,14 @@
+source "https://rubygems.org"
+source "https://gems.weblinc.com"
+
+gemspec
+
+group :development do
+  gem 'yard', source: 'https://rubygems.org'
+end
+
+gem 'byebug'
+
+group :test do
+  gem "simplecov", require: false
+end

data/README.md

@@ -0,0 +1,130 @@
+# Listrak
+
+Integrate the [Listrak][] ERP with the Workarea platform. This plugin
+currently implements the following Listrak features:
+
+- Page view tracking
+- Cart abandonment
+- Transactional email delivery
+- Automatically subscribing users to a distribution list
+
+## Installation
+
+Add the following to Gemfile:
+
+```ruby
+gem 'workarea-listrak', '~> 5.0'
+```
+
+### Secrets
+
+```yaml
+listrak:
+  data_api:
+    client_id:
+    client_secret:
+  email_api:
+    client_id:
+    client_secret:
+```
+
+### Configuration
+
+Most listrak configuration is set via the admin; you will need to set the
+`Default List` in the admin after installing the plugin.
+
+![lisrak admin](./readme/listrak-admin.png)
+
+```ruby
+Workarea.config do |config|
+  config.listrak.analytics = {
+    merchant_id: 'LISTRAK MERCHANT ID',
+    email_capture_ids: 'ID's OF EMAIL FIELDS USED FOR JAVASCRIPT ABANDONMENT'
+  }
+end
+```
+
+### Subscribing email addresses to a distribution list
+
+When customers sign up for the newsletter within the popup dialog or
+create a new user account, `Workarea::Listrak` will send the email and
+any other user-specific information to Listrak. This occurs immediately
+in a background job during creation of a `Email::Signup`.
+
+### Data Exporting
+
+The following will be sent to Listrak via API whenever they are created or saved:
+
+* Customers
+* Orders (on order place)
+* Products
+
+### Transactional Email Delivery
+
+This library is capable of replacing the internal application mailers
+with API calls to Listrak's email delivery service, passing it the data
+that it needs. To generate a new transactional message class, run:
+
+```bash
+$ bin/rails generate workarea:listrak:message OrderConfirmation
+```
+
+This will generate a class `app/messages/workarea/order_confirmation_message.rb`
+
+You will need to define the `message_id` and `messsage_attribute` as well as define the methods
+for these values. For example:
+
+```ruby
+module Workarea
+  module Listrak
+    class OrderConfirmationEmail
+      include Listrak::TransactionalMessage
+
+      attr_reader :order
+
+      message_id 11838256
+      message_attributes(
+        order_date: 2446175
+      )
+
+      def initialize(order)
+        @order = order
+      end
+
+      private
+
+        def email_address
+          order.email
+        end
+
+        def order_date
+          order.placed_at.to_s
+        end
+  end
+end
+```
+
+To send the message, call the `#deliver` method:
+
+```ruby
+OrderConfirmationMessage.new(order).deliver
+```
+
+### JavaScript Analytics Integration
+
+All of Listrak's JS code blocks respond to the `listrakAsyncListener`
+event, which is triggered after Listrak's external "SDK" code is loaded
+onto the page. Workarea's analytics adapter encapsulates this as a public
+method called `addListrakListener`.
+
+It's important that the init function from Storefront's **analytics.js**
+is called prior to the **listrak.js** init, so events can be registered
+before the SDK is loaded. This happens out-of-box, but is mentioned here
+if an implementation team creates their own **application.js.erb**
+manifest manually, or other modules that implement more Listrak features
+(like recommendations) are added to your application in the future.
+
+To reiterate, **listrak.js needs to be your last initialized JS
+module**.
+
+[Listrak]: http://listrak.com

data/Rakefile

@@ -0,0 +1,53 @@
+#!/usr/bin/env rake
+begin
+  require "bundler/setup"
+rescue LoadError
+  puts "You must `gem install bundler` and `bundle install` to run rake tasks"
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Tasker'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load "rails/tasks/engine.rake"
+load "rails/tasks/statistics.rake"
+load "workarea/changelog.rake"
+
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "lib"
+  t.libs << "test"
+  t.pattern = "test/**/*_test.rb"
+  t.verbose = false
+end
+
+task default: :test
+
+$LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
+require "workarea/listrak/version"
+
+desc "Release version #{Workarea::Listrak::VERSION} of the gem"
+task :release do
+  host = "https://#{ENV['BUNDLE_GEMS__WEBLINC__COM']}@gems.weblinc.com"
+
+  #Rake::Task['workarea:changelog'].execute
+  #system 'git add CHANGELOG.md'
+  #system 'git commit -m "Update CHANGELOG"'
+  #system 'git push origin HEAD'
+
+  system "git tag -a v#{Workarea::Listrak::VERSION} -m 'Tagging #{Workarea::Listrak::VERSION}'"
+  system "git push --tags"
+
+  system "gem build workarea-listrak.gemspec"
+  system "gem push workarea-listrak-#{Workarea::Listrak::VERSION}.gem"
+  system "gem push workarea-listrak-#{Workarea::Listrak::VERSION}.gem --host #{host}"
+  system "rm workarea-listrak-#{Workarea::Listrak::VERSION}.gem"
+end

data/app/assets/javascripts/workarea/admin/modules/listrak/list_events_select.js

@@ -0,0 +1,83 @@
+/**
+ * @namespace WORKAREA.listrakListEventsSelect
+ */
+
+WORKAREA.registerModule('listrakListEventsSelect', (function () {
+    'use strict';
+
+    var injectHiddenInput = function (index, select) {
+            // allows select[multiple=true] elements to post empty values
+            if ( ! $(select).is('[multiple]')) { return; }
+
+            $(select).before(function () {
+                return JST['workarea/core/templates/hidden_input']({
+                    name: select.name,
+                    value: ''
+                });
+            });
+        },
+
+        getConfig = function () {
+            var settings = _.assign({}, WORKAREA.config.remoteSelects, {
+                placeholder: I18n.t('workarea.admin.listrak_configuration.edit.events_select_placeholder'),
+                allowClear: true,
+                multiple: true,
+                width: false,
+                ajax: {
+                    url: function () {
+                        return WORKAREA.routes.admin.listrakListEventsPath({ list_id: listId(), format: "json" });
+                    },
+                    dataType: 'json',
+                    delay: 250,
+                    processResults: function (data) {
+                        return {
+                            results: _.map(data.results, function (item) {
+                                return {
+                                    id: item.value,
+                                    text: item.label
+                                };
+                            })
+                        };
+                    },
+                    cache: true,
+                    escapeMarkup: function (markup) {
+                        return markup;
+                    }
+                }
+            });
+
+            return settings;
+        },
+
+        listId = function () {
+            return $('#default_list_id').val();
+        },
+
+        initSelect2 = function (index, select) {
+            $(select)
+            .each(injectHiddenInput)
+            .select2(getConfig());
+        },
+
+        resetEventIds = function () {
+            $('[data-listrak-events-select]')
+            .val(null).trigger('change');
+        },
+
+        destroy = function (event) {
+            $('[data-listrak-events-select]', event.currentTarget)
+            .select2('destroy');
+        },
+
+        init = function ($scope) {
+            $('#default_list_id').on("change", resetEventIds);
+            $('[data-listrak-events-select]', $scope)
+                .each(initSelect2);
+        };
+
+    $(document).on('turbolinks:before-cache', destroy);
+
+    return {
+        init: init
+    };
+}()));