workarea-emarsys 1.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9bf08626204f88ffee6ab6fa870e77600c0665d21044100e4f32befe82768e40
+  data.tar.gz: 99229d93a96c5641bfcd0080255b018ce17b90b1b575e05e115f3f4223035bcf
+SHA512:
+  metadata.gz: 175be3626fc157fe1a93e88ea47f2d761b8ecd1bdbb585260e27045d6e1832ef7799a52415b0655b9a113ca0ce70508162a3e36ee56ed102a1f2e2afc51df651
+  data.tar.gz: 3bfcd9e665cf6d68f953e981ed59c9c9a157242fd06d493f58e965a7096eb954f5bcc169c962c79ee89cfe85e6dd08821341874f1d57df68c74fdd2011c21a03

data/.editorconfig

@@ -0,0 +1,20 @@
+# editorconfig.org
+root = true
+
+[*]
+charset = utf-8
+indent_style = space
+end_of_line = lf
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[{*.rb,*.haml,*.decorator,*.yml,*.yaml,*.jbuilder}]
+indent_size = 2
+indent_style = space
+
+[{*.js,*.jst,*.ejs,*.scss}]
+indent_size = 4
+
+[*.md]
+indent_size = 4
+trim_trailing_whitespace = false

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,37 @@
+---
+name: Bug report
+about: Create a report to help us improve Workarea
+title: ''
+labels: bug
+assignees: ''
+
+---
+
+⚠️**Before you create**⚠️
+Please verify the issue you're experiencing is not part of your Workarea project customizations. The best way to do this is with a [vanilla Workarea installation](https://developer.workarea.com/articles/create-a-new-host-application.html). This will help us spend time on fixes/improvements for the whole community. Thank you!
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Workarea Setup (please complete the following information):**
+ - Workarea Version: [e.g. v3.4.6]
+ - Plugins [e.g. workarea-blog, workarea-sitemaps]
+
+**Attachments**
+If applicable, add any attachments to help explain your problem, things like:
+- screenshots
+- Gemfile.lock
+- test cases
+
+**Additional context**
+Add any other context about the problem here.

data/.github/ISSUE_TEMPLATE/documentation-request.md

@@ -0,0 +1,17 @@
+---
+name: Documentation request
+about: Suggest documentation
+title: ''
+labels: documentation
+assignees: ''
+
+---
+
+**Is your documentation related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm confused by [...]
+
+**Describe the article you'd like**
+A clear and concise description of what would be in the documentation article.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

data/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for Workarea
+title: ''
+labels: enhancement
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

data/.gitignore

@@ -0,0 +1,22 @@
+.bundle/
+log/*.log
+pkg/
+test/dummy/db/*.sqlite3
+test/dummy/db/*.sqlite3-journal
+test/dummy/log/*.log
+test/dummy/tmp/
+.DS_Store
+.byebug_history
+.bundle/
+.sass-cache/
+Gemfile.lock
+pkg/
+test/dummy/tmp/
+test/dummy/public/
+log/*.log
+test/dummy/log/*.log
+test/dummy/db/*.sqlite3
+test/dummy/db/*.sqlite3-journal
+node_modules
+package.json
+yarn.lock

data/CHANGELOG.md

@@ -0,0 +1,28 @@
+Workarea Emarsys 1.0.2 (2019-08-22)
+--------------------------------------------------------------------------------
+
+*   Open Source!
+ 
+ 
+
+Workarea Emarsys 1.0.1 (2019-06-25)
+--------------------------------------------------------------------------------
+
+*   Update test to allow support for Workarea < v3.4
+
+    EMARSYS-11
+    Jake Beresford
+
+
+
+Workarea Emarsys 1.0.0 (2019-06-11)
+--------------------------------------------------------------------------------
+
+*   Workarea Emarsys
+
+    Emarsys marketing platform integration. Includes contact, order and product
+    syncing as well as a full Web Extend Integration.
+    Eric Pigeon
+
+
+

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,3 @@
+View this plugin's code of conduct here:
+
+<https://github.com/workarea-commerce/workarea/blob/master/CODE_OF_CONDUCT.md>

data/CONTRIBUTING.md

@@ -0,0 +1,3 @@
+View this plugin's contribution guidelines here:
+
+<https://github.com/workarea-commerce/workarea/blob/master/CONTRIBUTING.md>

data/Gemfile

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+git_source(:github) { |repo| "git@github.com:#{repo}.git" }
+
+gemspec
+
+gem 'workarea'
+gem 'workarea-ci'
+
+group :test do
+  gem 'simplecov', require: false
+  gem 'workarea-testing'
+end

data/LICENSE

@@ -0,0 +1,52 @@
+WebLinc
+Business Source License
+
+Licensor: WebLinc Corporation, 22 S. 3rd Street, 2nd Floor, Philadelphia PA 19106
+
+Licensed Work: Workarea Commerce Platform
+               The Licensed Work is (c) 2019 WebLinc Corporation
+
+Additional Use Grant:
+                      You may make production use of the Licensed Work without an additional license agreement with WebLinc so long as you do not use the Licensed Work for a Commerce Service.
+
+                      A "Commerce Service" is a commercial offering that allows third parties (other than your employees and contractors) to access the functionality of the Licensed Work by creating or managing commerce functionality, the products, taxonomy, assets and/or content of which are controlled by such third parties. 
+
+                      For information about obtaining an additional license agreement with WebLinc, contact licensing@workarea.com.
+
+Change Date: 2019-08-20
+
+Change License: Version 2.0 or later of the GNU General Public License as published by the Free Software Foundation
+
+Terms
+
+The Licensor hereby grants you the right to copy, modify, create derivative works, redistribute, and make non-production use of the Licensed Work. The Licensor may make an Additional Use Grant, above, permitting limited production use.
+
+Effective on the Change Date, or the fourth anniversary of the first publicly available distribution of a specific version of the Licensed Work under this License, whichever comes first, the Licensor hereby grants you rights under the terms of the Change License, and the rights granted in the paragraph above terminate.
+
+If your use of the Licensed Work does not comply with the requirements currently in effect as described in this License, you must purchase a commercial license from the Licensor, its affiliated entities, or authorized resellers, or you must refrain from using the Licensed Work.
+
+All copies of the original and modified Licensed Work, and derivative works of the Licensed Work, are subject to this License. This License applies separately for each version of the Licensed Work and the Change Date may vary for each version of the Licensed Work released by Licensor.
+
+You must conspicuously display this License on each original or modified copy of the Licensed Work. If you receive the Licensed Work in original or modified form from a third party, the terms and conditions set forth in this License apply to your use of that work.
+
+Any use of the Licensed Work in violation of this License will automatically terminate your rights under this License for the current and all other versions of the Licensed Work.
+
+This License does not grant you any right in any trademark or logo of Licensor or its affiliates (provided that you may use a trademark or logo of Licensor as expressly required by this License). TO THE EXTENT PERMITTED BY APPLICABLE LAW, THE LICENSED WORK IS PROVIDED ON AN "AS IS" BASIS. LICENSOR HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS, EXPRESS OR IMPLIED, INCLUDING (WITHOUT LIMITATION) WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT, AND TITLE. MariaDB hereby grants you permission to use this License’s text to license your works and to refer to it using the trademark "Business Source License" as long as you comply with the Covenants of Licensor below.
+
+Covenants of Licensor
+In consideration of the right to use this License’s text and the "Business Source License" name and trademark, Licensor covenants to MariaDB, and to all other recipients of the licensed work to be provided by Licensor:
+
+To specify as the Change License the GPL Version 2.0 or any later version, or a license that is compatible with GPL Version 2.0 or a later version, where "compatible" means that software provided under the Change License can be included in a program with software provided under GPL Version 2.0 or a later version. Licensor may specify additional Change Licenses without limitation.
+
+To either: (a) specify an additional grant of rights to use that does not impose any additional restriction on the right granted in this License, as the Additional Use Grant; or (b) insert the text "None."
+
+To specify a Change Date.
+
+Not to modify this License in any other way.
+
+Notice
+The Business Source License (this document, or the "License") is not an Open Source license. However, the Licensed Work will eventually be made available under an Open Source License, as stated in this License.
+
+For more information on the use of the Business Source License generally, please visit the Adopting and Developing Business Source License FAQ.
+
+License text copyright (c) 2017 MariaDB Corporation Ab, All Rights Reserved. "Business Source License" is a trademark of MariaDB Corporation Ab.

data/LICENSE.md

@@ -0,0 +1,3 @@
+View this plugin's license here: 
+
+<https://github.com/workarea-commerce/workarea/blob/master/LICENSE.md>

data/README.md

@@ -0,0 +1,93 @@
+Workarea Emarsys
+================================================================================
+
+Emarsys plugin for the Workarea platform.
+
+This integration supports the following:
+
+1. Contact syncronization
+2. Product files
+3. Order syncronization
+4. Full Web-Extend Analytics integration
+
+Configuration
+--------------------------------------------------------------------------------
+An administration panel in the Worakrea Admin has been provided to set some configuration values. Users must have permissions to **settings** to access this feature.
+
+The follow is accessible via the configuration panel:
+
+1. **Production:** A toggle switch to set the integration into production mode, defaults to false.
+2. **Customer ID:** The customer ID of account. Ask your Emarsys account manager for this value.
+3. **Merchant ID:** The merchant ID of the Emarsys account. This value is required for the Web Extend Analytics Integration
+
+
+The contact and sales data APIs require different access keys that require storage in the secrets file.
+
+Add the following to your secrets:
+
+    emarsys:
+      secret_key: YOUR_SECRET_KEY_HERE
+    emarsys_sales:
+      api_token: YOUR_TOKEN_HERE
+
+
+Data Exporting
+--------------------------------------------------------------------------------
+**Product Data**
+
+Emarsys supports the google product feed specification for product catalog. This integration includes the Workarea Google Product feed to support exporting products. The Google product feed will generate at 5:00 AM daily.
+
+You can access the Google product feed at: https://www.your_domain.com/google_feed
+
+**Order Files**
+
+Order files are exported every six hours. The default order fields are supported.
+
+More information about order files can be found here: https://help.emarsys.com/hc/en-us/articles/360003070654-Preparing-your-sales-data-file
+
+Getting Started
+--------------------------------------------------------------------------------
+
+This gem contains a rails engine that must be mounted onto a host Rails application.
+
+To access Workarea gems and source code, you must be an employee of WebLinc or a licensed retailer or partner.
+
+Workarea gems are hosted privately at https://gems.weblinc.com/.
+You must have individual or team credentials to install gems from this server. Add your gems server credentials to Bundler:
+
+    bundle config gems.weblinc.com my_username:my_password
+
+Or set the appropriate environment variable in a shell startup file:
+
+    export BUNDLE_GEMS__WEBLINC__COM='my_username:my_password'
+
+Then add the gem to your application's Gemfile specifying the source:
+
+    # ...
+    gem 'workarea-emarsys', source: 'https://gems.weblinc.com'
+    # ...
+
+Or use a source block:
+
+    # ...
+    source 'https://gems.weblinc.com' do
+      gem 'workarea-emarsys'
+    end
+    # ...
+
+Update your application's bundle.
+
+    cd path/to/application
+    bundle
+
+Workarea Platform Documentation
+--------------------------------------------------------------------------------
+
+See [http://developer.weblinc.com](http://developer.weblinc.com) for Workarea platform documentation.
+
+Copyright & Licensing
+--------------------------------------------------------------------------------
+
+Copyright WebLinc 2019. All rights reserved.
+
+For licensing, contact sales@workarea.com.

data/Rakefile

@@ -0,0 +1,60 @@
+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    = 'Emarsys'
+  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/emarsys/version'
+
+desc "Release version #{Workarea::Emarsys::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::Emarsys::VERSION} -m 'Tagging #{Workarea::Emarsys::VERSION}'"
+  system 'git push --tags'
+
+  system "gem build workarea-emarsys.gemspec"
+  system "gem push workarea-emarsys-#{Workarea::Emarsys::VERSION}.gem"
+  system "gem push workarea-emarsys-#{Workarea::Emarsys::VERSION}.gem --host #{host}"
+  system "rm workarea-emarsys-#{Workarea::Emarsys::VERSION}.gem"
+end
+
+desc 'Run the JavaScript tests'
+ENV['TEASPOON_RAILS_ENV'] = File.expand_path('../test/dummy/config/environment', __FILE__)
+task teaspoon: 'app:teaspoon'
+
+desc 'Start a server at http://localhost:3000/teaspoon for JavaScript tests'
+task :teaspoon_server do
+  Dir.chdir("test/dummy")
+  teaspoon_env = File.expand_path('../test/teaspoon_env.rb', __FILE__)
+  system "RAILS_ENV=test TEASPOON_ENV=#{teaspoon_env} rails s"
+end

data/app/assets/javascripts/workarea/storefront/emarsys/modules/web_extend_adapter.js

@@ -0,0 +1,128 @@
+/* eslint no-console: "off" */
+/* global console, ScarabQueue */
+
+/**
+ * @namespace WORKAREA.webExtendAdapter
+ */
+WORKAREA.analytics.registerAdapter('webExtendAdapter', function () {
+    'use strict';
+
+    var pushEmarsysEvent = function(event, payload) {
+            if (WORKAREA.environment.isTest || _.isUndefined(window.ScarabQueue)) {
+                console.log('Emarsys is not configured or is disabled in test');
+                return;
+            }
+
+            if (WORKAREA.analytics.debug) {
+                console.log("Sending event to Emarsys", event, payload);
+            }
+
+            if (event === 'go') {
+                ScarabQueue.push(['go']);
+            } else {
+                ScarabQueue.push([event, payload]);
+            }
+        },
+
+        reportCart = function (items) {
+            pushEmarsysEvent('cart', items);
+        },
+
+        /**
+         * Returns the email address from emarsys_email cookie set in
+         * email_signups_controller#create.
+         * @return String
+         */
+        emailFromCookie = function() {
+            var email = WORKAREA.cookie.read('emarsys_email');
+
+            if (_.isNull(email)) {
+                return('');
+            } else {
+                return(decodeURIComponent(email));
+            }
+        },
+
+        setEmail = function (currentUserEmail) {
+            var email = currentUserEmail || emailFromCookie();
+
+            if (_.isEmpty(email)) { return; }
+
+            pushEmarsysEvent('setEmail', email);
+        },
+
+        firedEventNames = function() {
+            return(
+                WORKAREA.analytics.events.map( function (event) {
+                    return event.name;
+                })
+            );
+        },
+
+        sendEmailFromUser = function() {
+            var firedEvents = firedEventNames(),
+                eventsWithEmailPayload = [
+                    'checkoutShippingView',
+                    'checkoutPaymentView',
+                    'checkoutOrderPlaced'
+                ];
+
+            return (_.isEmpty(_.intersection(firedEvents, eventsWithEmailPayload)));
+        },
+
+        sendGo = function() {
+            pushEmarsysEvent('go');
+        };
+
+    return {
+        'checkoutOrderPlaced': function (payload) {
+            var orderItems = _.map(payload.items, function (item) {
+                                return {
+                                    'item': item.id,
+                                    'price': item.price,
+                                    'quantity': item.quantity
+                                };
+                            });
+
+            setEmail(payload.emarsys_user_email);
+            pushEmarsysEvent(
+                'purchase',
+                {
+                    orderId: payload.id,
+                    items: orderItems
+                }
+            );
+        },
+
+        'productView': function (payload) {
+            pushEmarsysEvent('view', payload.id);
+        },
+
+        'categoryView': function (payload) {
+            if (_.isUndefined(payload.emarsys_category_path)) { return; }
+            pushEmarsysEvent('category', payload.emarsys_category_path);
+        },
+
+        'searchResultsView': function (payload) {
+            pushEmarsysEvent('searchTerm', payload.terms);
+        },
+
+        'checkoutShippingView': function (payload) {
+            setEmail(payload.emarsys_user_email);
+        },
+
+        'checkoutPaymentView': function (payload) {
+            setEmail(payload.emarsys_user_email);
+        },
+
+        'pageView': function() {
+            WORKAREA.currentUser.gettingUserData.done(function(user){
+                if (sendEmailFromUser()) {
+                    setEmail(user.email);
+                }
+                reportCart(user.emarsys_cart_items);
+                sendGo();
+            });
+        }
+    };
+});

data/app/controllers/workarea/admin/configurations_controller.rb

@@ -0,0 +1,33 @@
+module Workarea
+  module Admin
+    module Emarsys
+      class ConfigurationsController < Admin::ApplicationController
+        required_permissions :settings
+
+        def edit
+          @configuration = configuration
+        end
+
+        def update
+          if configuration.update_attributes(configuration_params)
+            redirect_to admin.edit_emarsys_configuration_path, flash: { success: t('workarea.admin.emarsys_configuration.edit.flash_messages.updated') }
+          else
+            flash[:error] = t('workarea.admin.emarsys_configuration.edit.flash_messages.save_error')
+            @configuration = configuration
+            render :edit, status: :unprocessable_entity
+          end
+        end
+
+        private
+          def configuration
+            model = Workarea::Emarsys::Configuration.current
+            Workarea::Admin::EmarsysConfigurationViewModel.new(model)
+          end
+
+          def configuration_params
+            params.permit(:production, :merchant_id, :customer_id)
+          end
+      end
+    end
+  end
+end

data/app/controllers/workarea/storefront/email_signups_controller.decorator

@@ -0,0 +1,16 @@
+module Workarea
+  decorate Storefront::EmailSignupsController, with: :emarsys do
+    def create
+      signup = Email.signup(params[:email])
+
+      if signup.try(:valid?)
+        cookies[:emarsys_email] = params[:email]
+        flash[:success] = t('workarea.storefront.flash_messages.email_signed_up')
+      else
+        flash[:error] = t('workarea.storefront.flash_messages.email_signup_error')
+      end
+
+      redirect_back fallback_location: root_path
+    end
+  end
+end

data/app/controllers/workarea/storefront/users/addresses_controller.decorator

@@ -0,0 +1,13 @@
+module Workarea
+  decorate Storefront::Users::AddressesController, with: :emarsys do
+    decorated do
+      after_action :save_emarsys_contact, only: [:create, :update]
+    end
+
+    private
+
+      def save_emarsys_contact
+        Emarsys::SaveUser.perform_async(current_user.id)
+      end
+  end
+end

data/app/helpers/workarea/storefront/emarsys_analytics_helper.rb

@@ -0,0 +1,13 @@
+module Workarea
+  module Storefront
+    module EmarsysAnalyticsHelper
+      def category_view_analytics_data(category)
+        super.merge(emarsys_category_path: category.google_name)
+      end
+
+      def order_analytics_data(order)
+        super.merge(emarsys_user_email: current_user&.email || order.email)
+      end
+    end
+  end
+end

data/app/lib/workarea/emarsys/bogus_gateway.rb

@@ -0,0 +1,36 @@
+module Workarea
+  module Emarsys
+    class BogusGateway
+
+      attr_reader :options
+
+      def initialize(options = {})
+        @options = options
+      end
+
+      def method_missing(method, *args)
+        response
+      end
+
+      private
+
+        def response
+          response = Faraday.new do |builder|
+            builder.adapter :test do |stub|
+              stub.get('/rest/bogus.json') { |env| [ 200, {}, response_body ] }
+            end
+          end
+          r = response.get('/rest/bogus.json')
+          Response.new(r)
+        end
+
+        def response_body
+          {
+            "data" => {
+              "ids" => ['123456']
+            }
+          }.to_json
+        end
+    end
+  end
+end