workarea-core 3.4.45 → 3.5.0.beta.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fa0ecabb9a16f7c58840b3d50dc6486c2f064c3d613c744607997105f26102fc
-  data.tar.gz: 4ec03996dd8e2bced8818056b06e3128c3b8fa6b079907e2b018e0504641e75b
+  metadata.gz: c6ddffdd6e59cf8d313af5d6e66ce27d527aba9a8d9f226697b8291b16263c00
+  data.tar.gz: 64a0dcf6ab8aee0fedd8a8f3e55c3ecfbcf552fc9b8e3418daa1cb5759c6dded
 SHA512:
-  metadata.gz: bee72675acacaffba697db529d9d9a0897603d9327e0d29044825f71c8f114617d056714ab8e83d40b03844d912d065e629a6de2227c4afcea486a1433b99b48
-  data.tar.gz: 49ad054e62f63e717f553ad1f75d28f6cb54d9a8e911989513eb4b2d63d7013e5d46e8762040696a20937f8082a570b394b729755f77a73c2d6584f12871ea0b
+  metadata.gz: 546e65d948e142a5ed31a3d57583690af677416a1ebb0368c6d0b7e36caaeb599ef80390fe9fa9c103ed0ac1747c97e5f05b0b07c05001c2da0655a396d178a2
+  data.tar.gz: c5aea33c89c5a53ab66133d6a9b9181bf4dda114ee1dcc55fcb4a934e58548b0e6b70993a027f2c9659846b0b866dbe12bb7d60c0263f687aa908ffc427542bb

data/LICENSE.txt

@@ -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/app/assets/javascripts/workarea/core/modules/duplicate_id.js

@@ -54,17 +54,13 @@ WORKAREA.registerModule('duplicateId', (function () {
             }).toArray();
         },
 
-        hasIdValue = function (_, element) {
-            return element.id !== '';
-        },
-
         /**
          * @method
          * @name init
          * @memberof WORKAREA.duplicateId
          */
         init = function () {
-            var $elements = $('[id]').filter(hasIdValue),
+            var $elements = $('[id]'),
                 ids = getIdValues($elements);
 
             if (_.isEmpty($elements) || noDuplicateIds(ids)) { return; }

data/app/assets/javascripts/workarea/core/modules/style_guide_autocomplete_fields.js

@@ -1,42 +1,9 @@
-/**
- * @namespace WORKAREA.styleGuideAutocompleteFields
- */
-WORKAREA.registerModule('styleGuideAutocompleteFields', (function () {
-    'use strict';
-
-    var AUTOCOMPLETE_DATA = [
-            'Small red sweater',
-            'Medium red sweater',
-            'Large red sweater',
-            'Small blue sweater',
-            'Medium blue sweater',
-            'Large blue sweater',
-            'Small green sweater',
-            'Medium green sweater',
-            'Large green sweater',
-            'Small white sweater',
-            'Medium white sweater',
-            'Large white sweater',
-            'Small black sweater',
-            'Medium black sweater',
-            'Large black sweater',
-            'Small yellow sweater',
-            'Medium yellow sweater',
-            'Large yellow sweater'
-        ],
-
-        /**
-         * @method
-         * @name init
-         * @memberof WORKAREA.styleGuideAutocompleteFields
-         */
-        init = function ($scope) {
-            $('[data-style-guide-autocomplete-field]', $scope).autocomplete({
-                source: AUTOCOMPLETE_DATA
-            });
-        };
-
-    return {
-        init: init
-    };
-}()));
+throw new Error(
+    'WORKAREA.styleGuideAutocompleteFields: The base Storefront engine no ' +
+    'no longer uses this file. If you are seeing this error in the ' +
+    'Storefront remove the path ' +
+    '`workarea/core/modules/style_guide_autocomplete_fields` from the ' +
+    'Storefront JavaScript application manifest. If you are seeing this ' +
+    'error in the Admin change the aforementioned path to ' +
+    '`workarea/core/modules/style_guide_autocomplete_fields`.'
+);

data/app/assets/javascripts/workarea/core/modules/url.js

@@ -59,6 +59,19 @@ WORKAREA.registerModule('url', (function () {
             return [url, queryString].join('?');
         },
 
+        /**
+         * @method
+         * @name addQuery
+         * @memberof WORKAREA.url
+         */
+        addToQuery = function (url, queryToAppend) {
+            if (_.includes(url, '?')) {
+                return [url, queryToAppend].join('&');
+            } else {
+                return addQuery(url, queryToAppend);
+            }
+        },
+
         /**
          * @method
          * @name removeQuery
@@ -114,6 +127,7 @@ WORKAREA.registerModule('url', (function () {
     return {
         parse: parse,
         addQuery: addQuery,
+        addToQuery: addToQuery,
         removeQuery: removeQuery,
         replaceQuery: replaceQuery,
         current: current,

data/app/controllers/workarea/application_controller.rb

@@ -1,6 +1,10 @@
 module Workarea
   class ApplicationController < ActionController::Base
     include I18n::DefaultUrlOptions
+    include HttpCaching
+    include CurrentTracking
+    include CurrentSegments
+
     protect_from_forgery
 
     before_action :set_locale
@@ -20,7 +24,7 @@ module Workarea
     end
 
     def current_location
-      @current_location ||= Geolocation.new(request.env, request.remote_ip)
+      current_visit.geolocation
     end
 
     def view_model_options

data/app/controllers/workarea/authentication.rb

@@ -12,33 +12,33 @@ module Workarea
 
     def current_user
       return @current_user if defined?(@current_user)
-      @current_user = User.find(cookies.signed[:user_id]) rescue nil
+      @current_user = User.find(session[:user_id]) rescue nil
     end
 
     def login(user)
       @current_user = user
+      session[:user_id] = user.id.to_s
       user.update_login!(request)
-      touch_auth_cookie
+      update_tracking!
       user
     end
 
     def logout
-      cookies.delete(:user_id)
+      reset_session
       cookies.delete(:cache)
-      cookies.delete(:completed_order)
       @current_user = nil
+      update_tracking!
     end
 
-    def touch_auth_cookie
-      return if current_user.blank?
-
-      cookies.signed[:user_id] = { value: current_user.id, expires: auth_expiry }
-
-      if current_user.admin?
-        cookies[:cache] = { value: 'false', expires: auth_expiry }
-      end
-    end
+    # TODO deprecated, remove in v3.6
+    def touch_auth_cookie; end
     alias_method :keep_auth_alive, :touch_auth_cookie
+    %w(keep_auth_alive touch_auth_cookie).each do |method|
+      Workarea.deprecation.deprecate_methods Authentication, method => <<~eos.squish
+        Session is handled with Rails sessions now, you won't need either of
+        these methods
+      eos
+    end
 
     def logged_in?
       current_user.present? && current_user.valid_logged_in_request?(request)
@@ -47,6 +47,7 @@ module Workarea
     def require_login(should_remember_location = true)
       return if logged_in?
 
+      logout if current_user.present? # reset everything if invalid logged in request
       flash[:info] = t('workarea.authentication.login')
       remember_location if request.get? && should_remember_location
       redirect_to storefront.login_path, turbolinks: false
@@ -62,9 +63,7 @@ module Workarea
     end
 
     def require_password_changes
-      return unless logged_in?
-
-      if current_user.force_password_change?
+      if current_user&.force_password_change?
         flash[:warning] = t('workarea.authentication.password_expired')
 
         if request.xhr?
@@ -103,15 +102,5 @@ module Workarea
       session.delete(:return_to)
       redirect_to remembered || default
     end
-
-    private
-
-    def auth_expiry
-      if current_user.admin?
-        Workarea.config.admin_session_timeout.from_now
-      else
-        Workarea.config.customer_session_timeout.from_now
-      end
-    end
   end
 end

data/app/controllers/workarea/authorization.rb

@@ -15,7 +15,7 @@ module Workarea
 
     def require_admin
       unless current_user.try(:admin?)
-        flash[:error] = 'You are not authorized to perform this action'
+        flash[:error] = t('workarea.admin.authorization.unauthorized_action')
         redirect_to storefront.root_path
         return false
       end
@@ -34,12 +34,12 @@ module Workarea
 
     def authorized?
       current_user.admin? && Array(required_permissions).all? do |area|
-        current_user.send("#{area}_access?")
+        current_user.try("#{area}_access?") || current_user.try("#{area}?")
       end
     end
 
     def unauthorized_user
-      flash[:error] = 'You are not authorized to access this area'
+      flash[:error] = t('workarea.admin.authorization.unauthorized_area')
       redirect_back fallback_location: root_path
     end
   end

data/app/controllers/workarea/current_referrer.rb

@@ -7,9 +7,8 @@ module Workarea
       return unless referrer.present?
 
       @current_referrer ||= TrafficReferrer.new(
-        RefererParser::Parser.new.parse(referrer).slice(:source, :medium, :uri)
+        Workarea.referrer_parser.parse(referrer).slice(:source, :medium, :uri)
       )
-    rescue RefererParser::InvalidUriError
     end
   end
 end

data/app/controllers/workarea/current_release.rb

@@ -50,7 +50,7 @@ module Workarea
     end
 
     def current_release_session
-      @current_release_session ||= ReleaseSession.new(cookies)
+      @current_release_session ||= ReleaseSession.new(session)
     end
   end
 end

data/app/controllers/workarea/current_segments.rb

@@ -0,0 +1,52 @@
+module Workarea
+  module CurrentSegments
+    extend ActiveSupport::Concern
+    include CurrentTracking
+
+    included do
+      delegate :override_segments, to: :current_visit
+      helper_method :current_segments, :override_segments
+
+      after_action :mark_segmented_content
+    end
+
+    def self.segmented_content?
+      !!Thread.current[:segmented_content]
+    end
+
+    def self.has_segmented_content!
+      Thread.current[:segmented_content] = true
+    end
+
+    def self.reset_segmented_content
+      Thread.current[:segmented_content] = nil
+    end
+
+    def override_segments=(segments)
+      if segments.blank?
+        session.delete(:segment_ids)
+        return
+      end
+
+      session[:segment_ids] = segments.map(&:id)
+      current_visit.override_segments = segments
+    end
+
+    def current_segments
+      Segment.current
+    end
+
+    def apply_segments
+      Segment.with_current(current_visit&.applied_segments) { yield }
+    end
+
+    def mark_segmented_content
+      if CurrentSegments.segmented_content?
+        response.set_header('X-Workarea-Segmented-Content', 'true')
+      end
+
+    ensure
+      CurrentSegments.reset_segmented_content
+    end
+  end
+end

data/app/controllers/workarea/current_tracking.rb

@@ -0,0 +1,45 @@
+module Workarea
+  module CurrentTracking
+    extend ActiveSupport::Concern
+    include HttpCaching
+
+    included do
+      before_action :ensure_current_metrics
+      helper_method :current_visit, :current_metrics
+
+      delegate :current_metrics_id, :current_metrics_id=, :browser,
+        to: :current_visit, allow_nil: true
+    end
+
+    def current_visit
+      request.env['workarea.visit']
+    end
+
+    def current_metrics
+      current_visit.metrics
+    end
+
+    def update_tracking!(email: current_user&.email)
+      if email.blank?
+        cookies.delete(:email)
+      elsif email != cookies.signed[:email]
+        Metrics::User.find_or_initialize_by(id: email).merge!(current_visit&.metrics)
+        cookies.permanent.signed[:email] = email
+      end
+
+      request.env['workarea.visit'] = Visit.new(request.env)
+    end
+
+    # This method is mostly for tests, but could surface in an implementation.
+    # Since Rails doesn't set and load a session until needed, an initial
+    # request won't have a session ID for `current_visit` to check when loading
+    # metrics. This ensures there will be one.
+    def ensure_current_metrics
+      return if current_metrics_id.present? || http_caching?
+
+      # This forces Rails to initialize the session, which provides an ID for metrics
+      session.delete(:foo)
+      self.current_metrics_id = session.id
+    end
+  end
+end

data/app/controllers/workarea/http_caching.rb

@@ -0,0 +1,30 @@
+module Workarea
+  module HttpCaching
+    extend ActiveSupport::Concern
+
+    included do
+      after_action :set_vary_headers
+      helper_method :http_caching?
+    end
+
+    def cache_page
+      unless current_user.try(:admin?)
+        expires_in Workarea.config.cache_expirations.http_cache, public: true if flash.blank?
+        request.session_options[:skip] = true
+        @http_caching = true
+      end
+    end
+
+    def http_caching?
+      !!@http_caching
+    end
+
+    private
+
+    def set_vary_headers
+      response.headers['X-Requested-With'] = request.headers['X-Requested-With'] || ''
+      response.headers['Vary'] = 'X-Requested-With, X-Workarea-Segments'
+      fresh_when(last_modified: Time.current)
+    end
+  end
+end

data/app/controllers/workarea/impersonation.rb

@@ -2,42 +2,31 @@ module Workarea
   module Impersonation
     extend ActiveSupport::Concern
     include Authorization
-    include AdminGuestBrowsing
 
     included do
       helper_method :impersonating?
+      helper_method :admin_browsing_as_guest?
       helper_method :current_admin
       helper_method :current_impersonation
-
-      prepend_before_action :check_impersonation_status
     end
 
     def impersonate_user(user)
-      session[:admin_id] = current_user.id
-
-      cookies.signed[:user_id] = {
-        value: user.id,
-        expires: Workarea.config.customer_session_timeout.from_now
-      }
+      session[:admin_id] = current_user.id.to_s
+      session[:user_id] = user.id.to_s
 
       user.mark_impersonated_by!(current_user)
       @current_user = user
     end
 
     def stop_impersonation
-      cookies.signed[:user_id] = {
-        value: current_admin.id,
-        expires: Workarea.config.admin_session_timeout.from_now
-      }
-
+      session[:user_id] = current_admin.id.to_s
       session.delete(:admin_id)
     end
 
     def impersonating?(user = nil)
       session[:admin_id].present? &&
-        cookies.signed[:user_id].present? &&
-        session[:admin_id] != cookies.signed[:user_id] &&
-        (user.blank? || user.id.to_s == cookies.signed[:user_id])
+        session[:admin_id] != session[:user_id] &&
+        (user.blank? || user.id.to_s == session[:user_id])
     end
 
     def current_admin
@@ -50,23 +39,21 @@ module Workarea
     end
 
     def current_impersonation
-      return @current_impersonation if defined?(@current_impersonation)
-      @current_impersonation = User.find(cookies.signed[:user_id]) rescue nil
+      @current_impersonation ||= User.find(session[:user_id])
     end
 
-    def touch_impersonation
-      cookies.signed[:user_id] = {
-        value: cookies.signed[:user_id],
-        expires: Workarea.config.customer_session_timeout.from_now
-      }
+    def admin_browse_as_guest
+      session[:admin_id] = current_user.id.to_s
+      session.delete(:user_id)
     end
 
-    def keep_auth_alive
-      if impersonating?
-        touch_impersonation
-      else
-        super
-      end
+    def admin_browsing_as_guest?
+      session[:admin_id].present? && session[:user_id].blank?
+    end
+
+    def stop_admin_guest_browsing
+      session[:user_id] = current_admin.id.to_s
+      session.delete(:admin_id)
     end
 
     #
@@ -74,20 +61,7 @@ module Workarea
     # validation.
     #
     def logged_in?
-      if impersonating?
-        current_user.present?
-      else
-        super
-      end
-    end
-
-    private
-
-    def check_impersonation_status
-      if !(impersonating? || admin_browsing_as_guest?) && session[:admin_id].present?
-        session.delete(:admin_id)
-        session.delete(:order_id)
-      end
+      super || (impersonating? && !admin_browsing_as_guest? && current_admin.present?)
     end
   end
 end

data/app/helpers/workarea/schema_org_helper.rb

@@ -0,0 +1,21 @@
+module Workarea
+  module SchemaOrgHelper
+    def render_schema_org(schema)
+      tag.script(schema.to_json.html_safe, type: 'application/ld+json')
+    end
+
+    def email_action_schema(target, name, description = nil)
+      {
+        '@context': 'http://schema.org',
+        '@type': 'EmailMessage',
+        'potentialAction': {
+          '@type': 'ViewAction',
+          'target': target,
+          'url': target,
+          'name': name
+        },
+        'description': description || name
+      }
+    end
+  end
+end

data/app/mailers/workarea/application_mailer.rb

@@ -4,13 +4,11 @@ module Workarea
 
     add_template_helper Workarea::PluginsHelper
     add_template_helper Workarea::ApplicationHelper
+    add_template_helper Workarea::SchemaOrgHelper
     default from: -> (*) { Workarea.config.email_from }
 
     def default_url_options(options = {})
-      # super isn't returning the configured options, so manually merge them in
-      super
-        .merge(Rails.application.config.action_mailer.default_url_options.to_h)
-        .merge(host: Workarea.config.host)
+      super.merge(host: Workarea.config.host)
     end
   end
 end

data/app/middleware/workarea/application_middleware.rb

@@ -0,0 +1,44 @@
+module Workarea
+  class ApplicationMiddleware
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      request = Rack::Request.new(env)
+      return @app.call(env) if request.path =~ /(jpe?g|png|ico|gif|css|js)$/
+
+      setup_environment(env, request)
+      set_segment_request_headers(env)
+      status, headers, body = @app.call(env)
+      set_segment_response_headers(env, headers)
+
+      [status, headers, body]
+    end
+
+    def setup_environment(env, request)
+      env['workarea.visit'] = Visit.new(env)
+      env['workarea.cache_varies'] = Cache::Varies.new(env['workarea.visit']).to_s
+      env['rack-cache.cache_key'] = Cache::RackCacheKey
+      env['rack-cache.force-pass'] = env['workarea.visit'].admin?
+    end
+
+    def set_segment_request_headers(env)
+      env['HTTP_X_WORKAREA_SEGMENTS'] = normalize_segment_ids(env['workarea.visit'])
+    end
+
+    def set_segment_response_headers(env, headers)
+      headers['X-Workarea-Segments'] = normalize_segment_ids(env['workarea.visit'])
+
+      if headers['X-Workarea-Segmented-Content'] == 'true'
+        headers['Cache-Control'] = 'private, no-cache, max-age=0'
+      end
+    end
+
+    private
+
+    def normalize_segment_ids(visit)
+      visit.applied_segments.map(&:id).sort.join(',')
+    end
+  end
+end