workarea-core 3.4.44 → 3.5.0.beta.1

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

data/app/middleware/workarea/query_cache_middleware.rb

@@ -0,0 +1,55 @@
+module Workarea
+  # Execute sidekiq jobs with query caches enabled. Each job can specify one or
+  # both query_caches to use via `query_cache`, `mongoid_query_cache`, or
+  # `elasticsearch_query_cache` options.
+  #
+  # @return [ Object ] The result of the call.
+  #
+  class QueryCacheMiddleware
+    def initialize(options = {})
+      @options = options
+    end
+
+    def call(worker, msg, queue)
+      cache_options = CacheOptions.new(worker.class.sidekiq_options)
+      return yield if cache_options.none?
+
+      if cache_options.all?
+        Mongoid::QueryCache.cache do
+          Elasticsearch::QueryCache.cache do
+            yield
+          end
+        end
+      elsif cache_options.mongoid?
+        Mongoid::QueryCache.cache { yield }
+      elsif cache_options.elasticsearch?
+        Elasticsearch::QueryCache.cache { yield }
+      end
+    ensure
+      Mongoid::QueryCache.clear_cache
+      Elasticsearch::QueryCache.clear_cache
+    end
+
+    class CacheOptions
+      def initialize(options)
+        @options = options
+      end
+
+      def none?
+        !mongoid? && !elasticsearch?
+      end
+
+      def all?
+        mongoid? && elasticsearch?
+      end
+
+      def mongoid?
+        !!(@options['mongoid_query_cache'] || @options['query_cache'])
+      end
+
+      def elasticsearch?
+        !!(@options['elasticsearch_query_cache'] || @options['query_cache'])
+      end
+    end
+  end
+end

data/app/middleware/workarea/release_server_middleware.rb

@@ -5,7 +5,7 @@ module Workarea
     end
 
     def call(worker, msg, queue)
-      Release.with_current(nil) { yield }
+      Release.without_current { yield }
     end
   end
 end

data/app/models/workarea/application_document.rb

@@ -14,7 +14,7 @@ module Workarea
     end
 
     def releasable?
-      false
+      is_a?(Releasable)
     end
 
     private

data/app/models/workarea/bulk_action/product_edit.rb

@@ -36,15 +36,15 @@ module Workarea
       end
 
       def apply_details!(product)
-        product.details = HashUpdate
-          .new(original: product.details, adds: add_details, removes: remove_details)
-          .result
+        HashUpdate
+          .new(adds: add_details, removes: remove_details)
+          .apply(product.details)
       end
 
       def apply_filters!(product)
-        product.filters = HashUpdate
-          .new(original: product.filters, adds: add_filters, removes: remove_filters)
-          .result
+        HashUpdate
+          .new(adds: add_filters, removes: remove_filters)
+          .apply(product.filters)
       end
 
       def apply_pricing!(product)

data/app/models/workarea/calculate_percent_change.rb

@@ -1,7 +1,7 @@
 module Workarea
   module CalculatePercentChange
     def calculate_percent_change(first, second)
-      return nil if first.zero?
+      return nil if first.blank? || first.zero?
       ((second.to_f - first) / first.to_f) * 100
     end
   end

data/app/models/workarea/catalog/category.rb

@@ -23,8 +23,6 @@ module Workarea
       validates :client_id, uniqueness: true, allow_blank: true
 
       scope :recent, ->(l = 5) { order_by([:created_at, :desc]).limit(l) }
-      scope :by_product, ->(id) { self.in(product_ids: id) }
-
       index({ client_id: 1 })
     end
   end

data/app/models/workarea/catalog/product.rb

@@ -12,7 +12,6 @@ module Workarea
       field :name, type: String, localize: true
       field :filters, type: Hash, default: {}, localize: true
       field :template, type: String, default: 'generic'
-      field :digital, type: Boolean, default: false
       field :customizations, type: String
       field :browser_title, type: String, localize: true
       field :meta_description, type: String, localize: true
@@ -21,6 +20,14 @@ module Workarea
       field :purchasable, type: Boolean, default: true
       field :default_category_id, type: String
 
+      # DEPRECATED. This field will be remove in v3.6 in favor of using
+      # Fulfillment::SKU to determine behavior in checkout for items not
+      # requiring phsyical fulfillment.
+      #
+      # TODO: remove in v3.6
+      #
+      field :digital, type: Boolean, default: false
+
       index({ 'variants.sku': 1 })
       index({ last_indexed_at: 1 })
       index({ 'images.option': 1 })
@@ -119,7 +126,17 @@ module Workarea
       end
 
       def active?
-        super && variants.active.any?
+        super && active_by_relations?
+      end
+
+      # This hook allows plugins extending this model a place to hook into
+      # #active? without overriding all the logic in that method's `super`. For
+      # example, package products.
+      #
+      # @return [Boolean]
+      #
+      def active_by_relations?
+        variants.active.any?
       end
 
       # Whether to allow purchasing on this product. This is always false if

data/app/models/workarea/checkout.rb

@@ -158,14 +158,10 @@ module Workarea
     # Used in auto completing an order for a logged in user.
     #
     # @param [Hash] parameters for updating
-    # @return [Boolean] whether the update was successful.
+    # @return [self]
     #
     def update(params = {})
-      return true if params.blank?
-
-      steps.reduce(true) do |result, step|
-        result &= step.new(self).update(params)
-      end
+      steps.each { |s| s.new(self).update(params) }
     end
 
     # Whether this checkout needs any further information
@@ -191,6 +187,9 @@ module Workarea
       return false unless shippable?
       return false unless payable?
 
+      fraud_analyzer.decide!
+      return false if fraud_analyzer.fraud_suspected?
+
       inventory.purchase
       return false unless inventory.captured?
 
@@ -221,6 +220,15 @@ module Workarea
       payment.valid? && payment_collection.valid?
     end
 
+    # Recalculate the amounts on tenders if payment is persisted.
+    #
+    # @return [Boolean, nil]
+    #
+    def adjust_tender_amounts!
+      return unless payment.persisted?
+      payment.adjust_tender_amounts(order.total_price)
+    end
+
     private
 
     def auto_complete
@@ -234,5 +242,9 @@ module Workarea
     def place_order_side_effects
       CreateFulfillment.new(order).perform
     end
+
+    def fraud_analyzer
+      @fraud_analyzer ||= Workarea.config.fraud_analyzer.constantize.new(self)
+    end
   end
 end

data/app/models/workarea/checkout/collect_payment.rb

@@ -33,7 +33,16 @@ module Workarea
       end
 
       def action
-        Workarea.config.auto_capture ? 'purchase!' : 'authorize!'
+        # TODO deprecated, remove in v3.6
+        return 'purchase!' if Workarea.config.auto_capture
+
+        if @order.items.all?(&:requires_shipping?)
+          Workarea.config.checkout_payment_action[:shipped]
+        elsif @order.items.any?(&:requires_shipping?)
+          Workarea.config.checkout_payment_action[:mixed]
+        else
+          Workarea.config.checkout_payment_action[:not_shipped]
+        end
       end
     end
   end

data/app/models/workarea/checkout/fraud/analyzer.rb

@@ -0,0 +1,44 @@
+module Workarea
+  class Checkout
+    module Fraud
+      class Analyzer
+        attr_reader :checkout
+
+        delegate :order, :user, :payment, :payment_profile, :shipping, :shippings,
+            to: :checkout, allow_nil: true
+        delegate :fraud_suspected?, to: :order
+
+        def initialize(checkout)
+          @checkout = checkout
+        end
+
+        def decide!
+          begin
+            decision = make_decision.tap { |r| r.analyzer = self.class.name }
+          rescue => e
+            decision = error_decision(e.message)
+          ensure
+            order.set_fraud_decision!(decision)
+          end
+        end
+
+        # Gets a decision about the fraudlence of a given checkout
+        #
+        # @param [Workarea::Checkout] checkout
+        #
+        # @return [Workarea::Order::FraudDecision]
+        #
+        def make_decision(checkout = nil)
+          raise(NotImplementedError, "#{self.class} must implement the #make_decision method")
+        end
+
+        def error_decision(message)
+          Workarea::Order::FraudDecision.new(
+            decision: :no_decision,
+            message: "An error occured during the fraud check: #{message}"
+          )
+        end
+      end
+    end
+  end
+end

data/app/models/workarea/checkout/fraud/no_decision_analyzer.rb

@@ -0,0 +1,14 @@
+module Workarea
+  class Checkout
+    module Fraud
+      class NoDecisionAnalyzer < Analyzer
+        def make_decision
+          Workarea::Order::FraudDecision.new(
+            decision: :no_decision,
+            message: I18n.t('workarea.storefront.fraud.default_message')
+          )
+        end
+      end
+    end
+  end
+end

data/app/models/workarea/checkout/fraud/test_analyzer.rb

@@ -0,0 +1,26 @@
+module Workarea
+  class Checkout
+    module Fraud
+      class TestAnalyzer < Analyzer
+        def make_decision
+          if order.email == "decline@workarea.com"
+            Workarea::Order::FraudDecision.new(
+              decision: :declined,
+              message: "Forced test fraud decline."
+            )
+          elsif order.email == "approved@workarea.com"
+            Workarea::Order::FraudDecision.new(
+              decision: :approved,
+              message: "Forced test fraud approval."
+            )
+          else
+            Workarea::Order::FraudDecision.new(
+              decision: :no_decision,
+              message: "Workarea default fraud check. Automatic no decision."
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/app/models/workarea/configuration/admin.rb

@@ -0,0 +1,25 @@
+module Workarea
+  module Configuration
+    class Admin
+      include ApplicationDocument
+      include ::Mongoid::Encrypted
+
+      delegate :definition, to: :class
+
+      def self.instance
+        first || create
+      end
+
+      def self.definition
+        Workarea.config.admin_definition
+      end
+
+      definition.fields.each do |f|
+        field f.key,
+          type: f.type_class,
+          default: f.default,
+          encrypted: f.encrypted?
+      end
+    end
+  end
+end

data/app/models/workarea/configuration/params.rb

@@ -0,0 +1,45 @@
+module Workarea
+  module Configuration
+    class Params
+      def initialize(params)
+        @params = params
+      end
+
+      def to_h
+        Admin.definition.fields.each_with_object({}) do |field, memo|
+          next unless @params.key?(field.key)
+          value = @params[field.key]
+
+          formatted_value =
+            if value.present? && respond_to?(field.type)
+              send(field.type, field, value)
+            else
+              value
+            end
+
+          memo[field.key] =
+            if formatted_value.blank? && !field.allow_blank?
+              field.default
+            else
+              formatted_value
+            end
+        end
+      end
+
+      def array(field, value)
+        Array.wrap(CSV.parse(value).first).map(&:strip)
+      end
+
+      def hash(field, value)
+        value.each_slice(2)
+             .to_h
+             .reject { |k, v| k.blank? || v.blank? }
+             .transform_values { |v| field.values_type_class.mongoize(v) }
+      end
+
+      def duration(field, value)
+        value.first.to_i.send(value.last.to_sym)
+      end
+    end
+  end
+end