workarea-emarsys 1.0.2

data/app/workers/workarea/emarsys/save_email_signup.rb

@@ -0,0 +1,40 @@
+module Workarea
+  module Emarsys
+    class SaveEmailSignup
+      include Sidekiq::Worker
+      include Sidekiq::CallbacksWorker
+
+      sidekiq_options(
+        enqueue_on: { Workarea::Email::Signup => :create },
+        queue: 'low'
+      )
+
+      def perform(id)
+        email_signup = Workarea::Email::Signup.find(id)
+        email = email_signup.email
+
+        # Emarasys Key values are
+        # integer, value
+        # where integer corresponds to a field in their
+        # internal database
+        attrs = { contacts: [
+            "3" => email,
+            "31" => 1
+          ]
+        }
+        response = gateway.create_contact(attrs)
+
+        email_signup.update_attributes!(
+          emarsys_exported_at: Time.current,
+          emarsys_external_id: response.body["data"]["ids"].first
+        )
+      end
+
+      private
+
+        def gateway
+          Emarsys.gateway
+        end
+    end
+  end
+end

data/app/workers/workarea/emarsys/save_order.rb

@@ -0,0 +1,32 @@
+module Workarea
+  module Emarsys
+    class SaveOrderContact
+      include Sidekiq::Worker
+      include Sidekiq::CallbacksWorker
+
+      sidekiq_options(
+        enqueue_on: { Workarea::Order => [:place] },
+        unique: :until_executing
+      )
+
+      def perform(id)
+        return unless settings.customer_id.present?
+
+        order = Workarea::Order.find(id)
+        address = Workarea::Payment.find(order.id).address
+
+        attrs = Emarsys::Contact.new(order, address: address, contact_from: 'order').to_h
+        gateway.create_contact(attrs)
+      end
+
+      private
+        def settings
+          Workarea::Emarsys::Configuration.current
+        end
+
+        def gateway
+          Emarsys.gateway
+        end
+    end
+  end
+end

data/app/workers/workarea/emarsys/save_user.rb

@@ -0,0 +1,44 @@
+module Workarea
+  module Emarsys
+    class SaveUser
+      include Sidekiq::Worker
+      include Sidekiq::CallbacksWorker
+
+      sidekiq_options(
+        enqueue_on: { Workarea::User => :save },
+        queue: 'low'
+      )
+
+      def perform(id)
+        return unless settings.customer_id.present?
+
+        user = Workarea::User.find(id)
+
+        attrs = Emarsys::Contact.new(user, { address: address(user), contact_from: 'user' }).to_h
+
+        response = gateway.create_contact(attrs)
+
+        user.set(emarsys_exported_at: Time.current)
+        external_id = response.body["data"]["id"] || response.body["data"]["ids"].first
+        user.set(emarsys_external_id: external_id)
+      end
+
+      private
+
+        def gateway
+          Emarsys.gateway
+        end
+
+        def settings
+          Workarea::Emarsys::Configuration.current
+        end
+
+        def address(user)
+          return unless user.addresses.present?
+
+          return user.default_billing_address if user.default_billing_address.present?
+          user.addresses.sort_by { |a| a.created_at.to_i }.last
+        end
+    end
+  end
+end

data/app/workers/workarea/emarsys/sync_orders.rb

@@ -0,0 +1,50 @@
+module Workarea
+  module Emarsys
+    class SyncOrders
+      include Sidekiq::Worker
+
+      def perform
+        # get the orders based on the time span set in config
+        orders = Workarea::Order.emarsys_exportable
+
+        return if orders.empty?
+
+        Dir.mktmpdir do |dir|
+          file = "order_export.csv"
+          path = "#{dir}/#{file}"
+          File.new(path, 'w+')
+
+          CSV.open(path, "wb") do |csv|
+            csv << headers
+            orders.each do |order|
+              order.items.each do |item|
+                csv << order_line(item)
+              end
+            end
+          end
+          gateway.send_file(path)
+        end
+      end
+
+      private
+        def order_line(item)
+          [
+            item.order.id,
+            item.order.email,
+            item.product_id,
+            item.total_price.to_s,
+            item.quantity,
+            item.order.placed_at.utc.iso8601
+          ]
+        end
+
+        def headers
+          ["order", "email", "item", "price", "quantity", "timestamp"]
+        end
+
+        def gateway
+          Emarsys.sales_data_gateway
+        end
+    end
+  end
+end

data/bin/rails

@@ -0,0 +1,20 @@
+#!/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/emarsys/engine', __FILE__)
+APP_PATH = File.expand_path('../../test/dummy/config/application', __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 'teaspoon-mocha'
+
+require 'rails/engine/commands'

data/config/initializers/appends.rb

@@ -0,0 +1,19 @@
+Workarea.append_partials(
+  'storefront.document_head',
+  'workarea/storefront/emarsys_tracking'
+)
+
+Workarea.append_partials(
+  'storefront.current_user',
+  'workarea/storefront/emarsys/current_user_emarsys_cart'
+)
+
+Workarea.append_partials(
+  "admin.settings_menu",
+  "workarea/admin/shared/emarsys_configuration_link"
+)
+
+Workarea.append_javascripts(
+  'storefront.modules',
+  'workarea/storefront/emarsys/modules/web_extend_adapter'
+)

data/config/initializers/scheduled_jobs.rb

@@ -0,0 +1,6 @@
+Sidekiq::Cron::Job.create(
+  name: 'Workarea::Emarsys::SyncOrders',
+  klass: 'Workarea::Emarsys::SyncOrders',
+  cron: '0 */6 * * *',
+  queue: 'low'
+)

data/config/initializers/workarea.rb

@@ -0,0 +1,16 @@
+Workarea.configure do |config|
+  config.emarsys ||= ActiveSupport::Configurable::Configuration.new
+
+  config.emarsys.escher_key = 'suite_workarea_v1'
+  config.emarsys.scope = 'eu/workarea/ems_request'
+  config.emarsys.partner_scope = 'eu/suite/ems_request'
+
+  config.emarsys.export_interval = 1.day
+
+  # Merchant ID used for web extend JS
+  # this is required for the web extend javascript
+  config.emarsys.merchant_id = nil
+
+  config.emarsys.api_timeout = 3
+  config.emarsys.open_timeout = 3
+end

data/config/locales/en.yml

@@ -0,0 +1,28 @@
+---
+en:
+  workarea:
+    admin:
+      shared:
+        primary_nav:
+          emarsys_configuration_title: Emarsys Configuration
+      emarsys_configuration:
+        edit:
+          flash_messages:
+            updated: Emarsys configuration has been updated
+            save_error: There was a problem updating the configuration
+          title: Emarsys Configuration
+          button: Save Emarsys Configuration
+          production: Use Production API?
+          customer_id: Customer ID
+          merchant_id: Merchant ID
+          api_key: API Key
+          sales_api_key: Sales Data API Key
+          no_key: No API key configured. Contact your developer to add this secure value. Customers will not be sent until this value is set.
+          no_sales_key: No Sales API key configured. Contact your developer to add this secure value. Order files will not be sent until this value is set.
+          help:
+            api_key: API Key for customer synchronization. Can be found in the Emarsys adminstration system.
+            sales_api_key: API Key for order file synchronization. Can be found in the Emarsys adminstration system.
+            production: Use the Live/Production API endpoints. Turn this on when ready to go live with your integration.
+            customer_id: Emarsys customer ID. Required for using API endpoints. Contact your Emarays Support team to get this value.
+            merchant_id: Emarsys merchant ID. This value is required for the Web Extend data integration.
+

data/config/routes.rb

@@ -0,0 +1,7 @@
+Workarea::Admin::Engine.routes.draw do
+  scope '(:locale)', constraints: Workarea::I18n.routes_constraint do
+    namespace :emarsys do
+      resource :configuration, only: [:edit, :update]
+    end
+  end
+end

data/lib/workarea/emarsys/engine.rb

@@ -0,0 +1,12 @@
+module Workarea
+  module Emarsys
+    class Engine < ::Rails::Engine
+      include Workarea::Plugin
+      isolate_namespace Workarea::Emarsys
+
+      config.to_prepare do
+        Storefront::ApplicationController.helper(Storefront::EmarsysAnalyticsHelper)
+      end
+    end
+  end
+end

data/lib/workarea/emarsys/version.rb

@@ -0,0 +1,5 @@
+module Workarea
+  module Emarsys
+    VERSION = "1.0.2"
+  end
+end

data/lib/workarea/emarsys.rb

@@ -0,0 +1,59 @@
+require 'workarea'
+require 'workarea/storefront'
+require 'workarea/admin'
+require 'workarea/google_product_feed'
+
+require 'workarea/emarsys/engine'
+require 'workarea/emarsys/version'
+
+require 'escher'
+
+module Workarea
+  module Emarsys
+    def self.credentials
+      (Rails.application.secrets.emarsys || {}).deep_symbolize_keys
+    end
+
+    def self.sales_data_credentials
+      (Rails.application.secrets.emarsys_sales || {}).deep_symbolize_keys
+    end
+
+    def self.secret_key
+      credentials[:secret_key]
+    end
+
+    def self.api_token
+      sales_data_credentials[:api_token]
+    end
+
+    def self.customer_id
+      credentials[:customer_id]
+    end
+
+    def self.config
+      Workarea.config.emarsys
+    end
+
+    # Conditionally use the real gateway when secrets are present.
+    # Otherwise, use the bogus gateway.
+    #
+    # @return [Emarsys::Gateway]
+    def self.gateway
+      if credentials.present?
+        settings = Workarea::Emarsys::Configuration.current
+        Emarsys::Gateway.new(secret_key, settings.customer_id, { test: !settings.production? })
+      else
+        Emarsys::BogusGateway.new
+      end
+    end
+
+    def self.sales_data_gateway
+      if credentials.present?
+        settings = Workarea::Emarsys::Configuration.current
+        Emarsys::SalesDataGateway.new(api_token, { merchant_id: settings.merchant_id })
+      else
+        Emarsys::SalesDataBogusGateway.new
+      end
+    end
+  end
+end

data/test/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require_relative 'config/application'
+
+Rails.application.load_tasks

data/test/dummy/app/assets/config/manifest.js

@@ -0,0 +1,4 @@
+
+//= link_tree ../images
+//= link_directory ../javascripts .js
+//= link_directory ../stylesheets .css

data/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file. JavaScript code in this file should be added after the last require_* statement.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery with: :exception
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/test/dummy/app/jobs/application_job.rb

@@ -0,0 +1,2 @@
+class ApplicationJob < ActiveJob::Base
+end

data/test/dummy/app/mailers/application_mailer.rb

@@ -0,0 +1,4 @@
+class ApplicationMailer < ActionMailer::Base
+  default from: 'from@example.com'
+  layout 'mailer'
+end

data/test/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Dummy</title>
+    <%= csrf_meta_tags %>
+
+    <%= stylesheet_link_tag    'application', media: 'all' %>
+    <%= javascript_include_tag 'application' %>
+  </head>
+
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/test/dummy/app/views/layouts/mailer.html.erb

@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    <style>
+      /* Email styles need to be inline */
+    </style>
+  </head>
+
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/test/dummy/app/views/layouts/mailer.text.erb

@@ -0,0 +1 @@
+<%= yield %>

data/test/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/test/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../config/application', __dir__)
+require_relative '../config/boot'
+require 'rails/commands'

data/test/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/test/dummy/bin/setup

@@ -0,0 +1,30 @@
+#!/usr/bin/env ruby
+require 'pathname'
+require 'fileutils'
+include FileUtils
+
+# path to your application root.
+APP_ROOT = Pathname.new File.expand_path('../../', __FILE__)
+
+def system!(*args)
+  system(*args) || abort("\n== Command #{args} failed ==")
+end
+
+chdir APP_ROOT do
+  # This script is a starting point to setup your application.
+  # Add necessary setup steps to this file.
+
+  puts '== Installing dependencies =='
+  system! 'gem install bundler --conservative'
+  system('bundle check') || system!('bundle install')
+
+  # Install JavaScript dependencies if using Yarn
+  # system('bin/yarn')
+
+
+  puts "\n== Removing old logs and tempfiles =="
+  system! 'bin/rails log:clear tmp:clear'
+
+  puts "\n== Restarting application server =="
+  system! 'bin/rails restart'
+end

data/test/dummy/bin/update

@@ -0,0 +1,26 @@
+#!/usr/bin/env ruby
+require 'pathname'
+require 'fileutils'
+include FileUtils
+
+# path to your application root.
+APP_ROOT = Pathname.new File.expand_path('../../', __FILE__)
+
+def system!(*args)
+  system(*args) || abort("\n== Command #{args} failed ==")
+end
+
+chdir APP_ROOT do
+  # This script is a way to update your development environment automatically.
+  # Add necessary update steps to this file.
+
+  puts '== Installing dependencies =='
+  system! 'gem install bundler --conservative'
+  system('bundle check') || system!('bundle install')
+
+  puts "\n== Removing old logs and tempfiles =="
+  system! 'bin/rails log:clear tmp:clear'
+
+  puts "\n== Restarting application server =="
+  system! 'bin/rails restart'
+end

data/test/dummy/bin/yarn

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+VENDOR_PATH = File.expand_path('..', __dir__)
+Dir.chdir(VENDOR_PATH) do
+  begin
+    exec "yarnpkg #{ARGV.join(" ")}"
+  rescue Errno::ENOENT
+    $stderr.puts "Yarn executable was not detected in the system."
+    $stderr.puts "Download Yarn at https://yarnpkg.com/en/docs/install"
+    exit 1
+  end
+end

data/test/dummy/config/application.rb

@@ -0,0 +1,30 @@
+require_relative 'boot'
+
+# Pick the frameworks you want:
+# require "active_record/railtie"
+require "action_controller/railtie"
+require "action_view/railtie"
+require "action_mailer/railtie"
+require "active_job/railtie"
+# require "action_cable/engine"
+require "rails/test_unit/railtie"
+require "sprockets/railtie"
+
+# Workarea must be required before other gems to ensure control over Rails.env
+# for running tests
+require 'workarea/core'
+require 'workarea/admin'
+require 'workarea/storefront'
+Bundler.require(*Rails.groups)
+require "workarea/emarsys"
+
+module Dummy
+  class Application < Rails::Application
+    # Initialize configuration defaults for originally generated Rails version.
+    config.load_defaults 5.1
+
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+  end
+end

data/test/dummy/config/boot.rb

@@ -0,0 +1,5 @@
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../Gemfile', __dir__)
+
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../lib', __dir__)

data/test/dummy/config/cable.yml

@@ -0,0 +1,10 @@
+development:
+  adapter: async
+
+test:
+  adapter: async
+
+production:
+  adapter: redis
+  url: redis://localhost:6379/1
+  channel_prefix: dummy_production

data/test/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the Rails application.
+require_relative 'application'
+
+# Initialize the Rails application.
+Rails.application.initialize!

data/test/dummy/config/environments/development.rb

@@ -0,0 +1,51 @@
+Rails.application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # In the development environment your application's code is reloaded on
+  # every request. This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
+  config.cache_classes = false
+
+  # Do not eager load code on boot.
+  config.eager_load = false
+
+  # Show full error reports.
+  config.consider_all_requests_local = true
+
+  # Enable/disable caching. By default caching is disabled.
+  if Rails.root.join('tmp/caching-dev.txt').exist?
+    config.action_controller.perform_caching = true
+
+    config.cache_store = :memory_store
+    config.public_file_server.headers = {
+      'Cache-Control' => "public, max-age=#{2.days.seconds.to_i}"
+    }
+  else
+    config.action_controller.perform_caching = false
+
+    config.cache_store = :null_store
+  end
+
+  # Don't care if the mailer can't send.
+  config.action_mailer.raise_delivery_errors = false
+
+  config.action_mailer.perform_caching = false
+
+  # Print deprecation notices to the Rails logger.
+  config.active_support.deprecation = :log
+
+  # Debug mode disables concatenation and preprocessing of assets.
+  # This option may cause significant delays in view rendering with a large
+  # number of complex assets.
+  config.assets.debug = true
+
+  # Suppress logger output for asset requests.
+  config.assets.quiet = true
+
+  # Raises error for missing translations
+  # config.action_view.raise_on_missing_translations = true
+
+  # Use an evented file watcher to asynchronously detect changes in source code,
+  # routes, locales, etc. This feature depends on the listen gem.
+  # config.file_watcher = ActiveSupport::EventedFileUpdateChecker
+end