workarea-core 3.4.45 → 3.5.0.beta.1

data/app/models/workarea/metrics/sku_by_day.rb

@@ -11,9 +11,12 @@ module Workarea
       field :discounts, type: Float, default: 0.0
       field :tax, type: Float, default: 0.0
       field :revenue, type: Float, default: 0.0
+      field :units_canceled, type: Integer, default: 0
+      field :refund, type: Float, default: 0.0
 
       index(reporting_on: 1, orders: 1)
       index(reporting_on: 1, units_sold: 1)
+      index(reporting_on: 1, units_canceled: 1)
     end
   end
 end

data/app/models/workarea/metrics/tender_by_day.rb

@@ -0,0 +1,11 @@
+module Workarea
+  module Metrics
+    class TenderByDay
+      include ByDay
+
+      field :tender, type: String
+      field :orders, type: Integer, default: 0
+      field :revenue, type: Float, default: 0.0
+    end
+  end
+end

data/app/models/workarea/metrics/update_user_aggregations.rb

@@ -0,0 +1,77 @@
+module Workarea
+  module Metrics
+    module UpdateUserAggregations
+      extend self
+
+      def update!
+        update_calculated_fields!
+        update_percentiles!
+      end
+
+      def update_calculated_fields!
+        User.collection.aggregate([
+          {
+            '$addFields' => {
+              'frequency' => {
+                '$cond' => [
+                  { '$eq' => ['$orders', 0] },
+                  nil,
+                  {
+                    '$divide' => [
+                      '$orders',
+                      { '$subtract' => [Time.current, '$first_order_at'] }
+                    ]
+                  }
+                ]
+              },
+              'average_order_value' => {
+                '$cond' => [
+                  { '$eq' => ['$orders', 0] },
+                  nil,
+                  { '$divide' => ['$revenue', '$orders'] }
+                ]
+              }
+            }
+          },
+          { '$out' => User.collection.name }
+        ]).first
+      end
+
+      def update_percentiles!
+        User.collection.aggregate([
+          {
+            '$addFields' => {
+              'orders_percentile' => update_percentiles_expression(:orders),
+              'frequency_percentile' => update_percentiles_expression(:frequency),
+              'revenue_percentile' => update_percentiles_expression(:revenue),
+              'average_order_value_percentile' => update_percentiles_expression(:average_order_value)
+            }
+          },
+          { '$out' => User.collection.name }
+        ]).first
+      end
+
+      def update_percentiles_expression(field)
+        percentiles = CalculatePercentiles.new(User.collection, field)
+
+        {
+          '$cond' => [
+            { '$eq' => ['$orders', 0] },
+            nil,
+            {
+              '$switch' => {
+                'branches' => 99.downto(1).map do |percentile|
+                  {
+                    'case' => {  '$gte' => ["$#{field}", percentiles[percentile.to_s]] },
+                    'then' => percentile + 1
+                  }
+                end,
+                'default' => 1
+              }
+            }
+          ]
+        }
+      end
+    end
+  end
+end

data/app/models/workarea/metrics/user.rb

@@ -2,6 +2,8 @@ module Workarea
   module Metrics
     class User
       include Mongoid::Document
+      include Mongoid::Document::Taggable
+      include Mongoid::Timestamps
 
       store_in client: :metrics
 
@@ -12,12 +14,15 @@ module Workarea
       field :orders, type: Integer, default: 0
       field :revenue, type: Float, default: 0.0
       field :discounts, type: Float, default: 0.0
-      field :frequency, type: Float, default: 0.0
-      field :average_order_value, type: Float, default: 0.0
-      field :orders_percentile, type: Integer, default: 10
-      field :revenue_percentile, type: Integer, default: 10
-      field :frequency_percentile, type: Integer, default: 10
-      field :average_order_value_percentile, type: Integer, default: 10
+      field :frequency, type: Float
+      field :average_order_value, type: Float
+      field :orders_percentile, type: Integer
+      field :revenue_percentile, type: Integer
+      field :frequency_percentile, type: Integer
+      field :average_order_value_percentile, type: Integer
+      field :cancellations, type: Integer, default: 0
+      field :refund, type: Float, default: 0.0
+      field :admin, type: Boolean, default: false
 
       index(first_order_at: 1)
       index(last_order_at: 1)
@@ -25,6 +30,7 @@ module Workarea
       index(revenue: 1)
       index(frequency: 1)
       index(average_order_value: 1)
+      index(updated_at: 1)
 
       scope :with_purchases, -> { where(:orders.gt => 0, :revenue.gt => 0) }
       scope :ordered_since, ->(time) { where(:last_order_at.gte => time) }
@@ -34,21 +40,54 @@ module Workarea
       scope :by_average_order_value_percentile, ->(range) { where(average_order_value_percentile: range) }
       scope :full_price, -> { where(discounts: 0) }
 
+      embeds_one :viewed, class_name: 'Workarea::Metrics::Affinity', inverse_of: :user, autobuild: true
+      embeds_one :purchased, class_name: 'Workarea::Metrics::Affinity', inverse_of: :user, autobuild: true
+
       class << self
         def save_order(email:, revenue:, discounts: 0, at: Time.current)
           revenue_in_default_currency = revenue.to_m.exchange_to(Money.default_currency).to_f
           discounts_in_default_currency = discounts.to_m.exchange_to(Money.default_currency).to_f
 
+          metrics = find_or_create_by(id: email)
+          first_order_at = [at, metrics.first_order_at].compact.min
+          last_order_at = [at, metrics.last_order_at].compact.max
+
+          metrics.update!(first_order_at: first_order_at, last_order_at: last_order_at)
+          metrics.inc(
+            orders: 1,
+            revenue: revenue_in_default_currency,
+            discounts: discounts_in_default_currency
+          )
+        end
+
+        def save_cancellation(email:, refund:, at: Time.current)
+          refund_in_default_currency = refund.to_m.exchange_to(Money.default_currency).to_f
+
           collection.update_one(
             { _id: email },
             {
-              '$set' => { last_order_at: at.utc },
-              '$setOnInsert' => { first_order_at: at.utc },
               '$inc' => {
-                orders: 1,
-                revenue: revenue_in_default_currency,
-                discounts: discounts_in_default_currency
+                cancellations: 1,
+                refund: refund_in_default_currency,
+                revenue: refund_in_default_currency
               }
+            }
+          )
+        end
+
+        def save_affinity(id:, action:, **data)
+          return if data.blank? || data.values.all?(&:blank?)
+
+          collection.update_one(
+            { _id: id },
+            {
+              '$set' => { updated_at: Time.current.utc },
+              '$push' => data.each_with_object({}) do |(field, values), update|
+                update["#{action}.#{field}"] = {
+                  '$each' => Array.wrap(values),
+                  '$slice' => Workarea.config.max_affinity_items
+                }
+              end
             },
             upsert: true
           )
@@ -61,60 +100,6 @@ module Workarea
             .by_revenue_percentile(81..100)
             .order_by(revenue: :desc, orders: :desc, last_order_at: :desc, id: :asc)
         end
-
-        def update_aggregations!
-          update_calculated_fields!
-          update_percentiles!
-        end
-
-        def update_calculated_fields!
-          collection.aggregate([
-            {
-              '$addFields' => {
-                'frequency' => {
-                  '$divide' => [
-                    '$orders',
-                    { '$subtract' => [Time.current.utc, '$first_order_at'] }
-                  ]
-                },
-                'average_order_value' => {
-                  '$divide' => ['$revenue', '$orders']
-                }
-              }
-            },
-            { '$out' => collection.name }
-          ]).first
-        end
-
-        def update_percentiles!
-          collection.aggregate([
-            {
-              '$addFields' => {
-                'orders_percentile' => update_percentiles_expression(:orders),
-                'frequency_percentile' => update_percentiles_expression(:frequency),
-                'revenue_percentile' => update_percentiles_expression(:revenue),
-                'average_order_value_percentile' => update_percentiles_expression(:average_order_value)
-              }
-            },
-            { '$out' => collection.name }
-          ]).first
-        end
-
-        def update_percentiles_expression(field)
-          percentiles = CalculatePercentiles.new(collection, field)
-
-          {
-            '$switch' => {
-              'branches' => 99.downto(1).map do |percentile|
-                {
-                  'case' => {  '$gte' => ["$#{field}", percentiles[percentile.to_s]] },
-                  'then' => percentile + 1
-                }
-              end,
-              'default' => 1
-            }
-          }
-        end
       end
 
       # Use calculated value for real-time display, the aggregated value used
@@ -125,28 +110,29 @@ module Workarea
       end
 
       def merge!(other)
-        # To recalculate average_order_value
-        self.orders += other.orders
-        self.revenue += other.revenue
-
-        update = {
-          '$set' => {
-            average_order_value: average_order_value,
-            updated_at: Time.current.utc
-          },
-          '$inc' => {
-            orders: other.orders,
-            revenue: other.revenue,
-            discounts: other.discounts
-          }
-        }
-
-        update['$min'] = { first_order_at: other.first_order_at.utc } if other.first_order_at.present?
-        update['$max'] = { last_order_at: other.last_order_at.utc } if other.last_order_at.present?
-
-        self.class.collection.update_one({ _id: id }, update, upsert: true)
-        other.delete
-        reload
+        %w(orders revenue discounts cancellations refund).each do |field|
+          self.send("#{field}=", send(field) + other.send(field))
+        end
+
+        self.first_order_at = [first_order_at, other.first_order_at].compact.min
+        self.last_order_at = [last_order_at, other.last_order_at].compact.max
+        self.average_order_value = average_order_value
+        save!
+
+        self.class.save_affinity(
+          id: id,
+          action: 'viewed',
+          product_ids: other.viewed.product_ids,
+          category_ids: other.viewed.category_ids,
+          search_ids: other.viewed.search_ids
+        )
+        self.class.save_affinity(
+          id: id,
+          action: 'purchased',
+          product_ids: other.purchased.product_ids,
+          category_ids: other.purchased.category_ids,
+          search_ids: other.purchased.search_ids
+        )
       end
     end
   end

data/app/models/workarea/navigation/breadcrumbs.rb

@@ -13,7 +13,16 @@ module Workarea
 
       def initialize(navigable, last: nil)
         @navigable = navigable
-        @last = Taxon.new(name: last) if last.present?
+        @last = if last.class.include?(Navigable)
+                  Taxon.new(
+                    name: last.name,
+                    navigable: last,
+                    navigable_slug: last.slug,
+                    parent: breadcrumb_taxons.last
+                  )
+                elsif last.present?
+                  Taxon.new(name: last, parent: breadcrumb_taxons.last)
+                end
       end
 
       def to_global_id

data/app/models/workarea/order/fraud_decision.rb

@@ -0,0 +1,18 @@
+module Workarea
+  class Order
+    class FraudDecision
+      include ApplicationDocument
+
+      embedded_in :order, class_name: 'Workarea::Order'
+
+      field :decision, type: Symbol, default: :no_decision
+      field :analyzer, type: String
+      field :message, type: String
+      field :response, type: String
+
+      def declined?
+        decision == :declined
+      end
+    end
+  end
+end

data/app/models/workarea/order/item.rb

@@ -13,6 +13,7 @@ module Workarea
     field :total_value, type: Money, default: 0
     field :total_price, type: Money, default: 0
     field :via, type: String
+    field :requires_shipping, type: Boolean, default: true
 
     scope :by_newest, -> { desc(:created_at) }
 
@@ -36,6 +37,10 @@ module Workarea
     def digital?
       !!product_attributes['digital']
     end
+    Workarea.deprecation.deprecate_methods(
+      Order::Item,
+      digital?: 'use `!item.requires_shipping?` to determine if this item is shipped.'
+    )
 
     # Adds a price adjustment to the item. Does not persist.
     #

data/app/models/workarea/order/queries.rb

@@ -94,6 +94,7 @@ module Workarea
           Order.where(
             placed_at: nil,
             reminded_at: nil,
+            fraud_suspected_at: nil,
             :checkout_started_at.lte => Workarea.config.order_active_period.ago,
             :email.exists => true,
             :email.ne => '',

data/app/models/workarea/order/status.rb

@@ -8,7 +8,8 @@ module Workarea
           !order.canceled? &&
             !order.placed? &&
             !order.checking_out? &&
-            !order.abandoned?
+            !order.abandoned? &&
+            !order.fraud_suspected?
         end
       end
 
@@ -43,6 +44,14 @@ module Workarea
           order.abandoned?
         end
       end
+
+      class SuspectedFraud
+        include StatusCalculator::Status
+
+        def in_status?
+          order.fraud_suspected?
+        end
+      end
     end
   end
 end

data/app/models/workarea/order.rb

@@ -22,16 +22,21 @@ module Workarea
     field :tax_total, type: Money, default: 0
     field :total_value, type: Money, default: 0
     field :total_price, type: Money, default: 0
-    field :user_activity_id, type: String
     field :checkout_by_id, type: String
     field :pricing_cache_key, type: String
     field :source, type: String
     field :metrics_saved_at, type: Time
     field :user_agent, type: String
+    field :segment_ids, type: Array, default: []
+    field :fraud_suspected_at, type: Time
+    field :fraud_decided_at, type: Time
 
     # @deprecated as of v3.2, locks are handled via Workarea::Lock
     field :lock_expires_at, type: Time
 
+    # @deprecated as of v3.5, the email address will be the ID for {Metrics}
+    field :user_activity_id, type: String
+
     index({ user_id: 1 })
     index({ placed_at: 1, created_at: 1 })
     index({ created_at: 1 })
@@ -44,7 +49,8 @@ module Workarea
         reminded_at: 1,
         checkout_started_at: 1,
         email: 1,
-        "items[0]._id": 1
+        "items[0]._id": 1,
+        fraud_suspected_at: 1
       },
       {
         name: 'abandoned_order_email_index',
@@ -65,8 +71,13 @@ module Workarea
     embeds_one :traffic_referrer,
       class_name: 'Workarea::TrafficReferrer'
 
+    embeds_one :fraud_decision,
+      class_name: 'Workarea::Order::FraudDecision'
+
     validates :email, presence: { on: :purchasable }, email: true
 
+    validate :item_count_limit
+
     define_model_callbacks :place
 
     # The user-friendly name for the order
@@ -115,7 +126,8 @@ module Workarea
           :checkout_by_id,
           :source,
           :traffic_referrer,
-          :user_agent
+          :user_agent,
+          :segment_ids
         )
       )
     end
@@ -176,7 +188,7 @@ module Workarea
     # @return [Boolean]
     #
     def requires_shipping?
-      items.present? && items.any? { |i| !i.digital? }
+      items.present? && items.any?(&:requires_shipping?)
     end
 
     # Whether this order can be purchased, which is defined here as the order
@@ -331,5 +343,36 @@ module Workarea
     def metrics_saved!
       set(metrics_saved_at: Time.current)
     end
+
+    # Whether this order is suspected of fraud.
+    #
+    # @return [Boolean]
+    #
+    def fraud_suspected?
+      !!fraud_suspected_at
+    end
+
+    # Sets the fraud descision for the order..
+    #
+    # @param [Workarea::Order::FraudDecision] decision
+    # @return [Boolean]
+    #
+    def set_fraud_decision!(decision)
+      update!(
+        fraud_decision: decision,
+        fraud_decided_at: Time.current,
+        fraud_suspected_at: decision.declined? ? Time.current : nil
+      )
+    end
+
+    private
+
+    def item_count_limit
+      limit = Workarea.config.item_count_limit
+
+      if items.size > limit
+        errors.add(:base, I18n.t('workarea.order.errors.count_limit', size: limit))
+      end
+    end
   end
 end

data/app/models/workarea/payment/credit_card.rb

@@ -17,6 +17,7 @@ module Workarea
         validate :valid_number
         validate :cvv_presence
         validate :not_expired
+        validate :issuer_accepted
 
         validates :first_name, presence: true
         validates :last_name, presence: true
@@ -85,6 +86,17 @@ module Workarea
         end
       end
 
+      def issuer_accepted
+        unless Workarea.config.credit_card_issuers.value?(issuer)
+          message = I18n.t(
+            'workarea.errors.messages.invalid_credit_card_issuer',
+            value: issuer,
+            issuers: Workarea.config.credit_card_issuers.values.to_sentence
+          )
+          errors.add(:base, message)
+        end
+      end
+
       def number_presence
         if !tokenized? && number.blank?
           errors.add(:number, I18n.t('errors.messages.blank'))

data/app/models/workarea/payment.rb

@@ -65,7 +65,7 @@ module Workarea
     end
 
     def tenders
-      Workarea.config.tender_types.map do |type|
+      Workarea.config.tender_types.flat_map do |type|
         send(type)
       end.compact
     end
@@ -80,7 +80,12 @@ module Workarea
       build_credit_card unless credit_card
       credit_card.saved_card_id = nil
       credit_card.attributes = attrs.slice(
-        *Workarea.config.credit_card_attributes
+        :month,
+        :year,
+        :saved_card_id,
+        :number,
+        :cvv,
+        :amount
       )
       save
     end

data/app/models/workarea/pricing/cache_key.rb

@@ -1,13 +1,14 @@
 module Workarea
   module Pricing
     class CacheKey
-      attr_reader :shippings
+      attr_reader :shippings, :payment
       attr_accessor :order
       delegate :pricing, :discounts, to: :@request
 
-      def initialize(order, shippings, request)
+      def initialize(order, shippings, payment, request)
         @order = order
         @shippings = shippings
+        @payment = payment
         @request = request
       end
 
@@ -17,8 +18,9 @@ module Workarea
           discount_key,
           order_key,
           shipping_service_key,
+          payment_key,
           tax_key
-        ]
+        ].compact
       end
 
       def to_s
@@ -43,6 +45,10 @@ module Workarea
         shippings.map(&:cache_key).join
       end
 
+      def payment_key
+        payment&.cache_key
+      end
+
       def tax_key
         Workarea::Tax::Category.all.map(&:cache_key).join
       end

data/app/models/workarea/pricing/calculator.rb

@@ -11,11 +11,15 @@ module Workarea
         def shippings
           @persisted_shippings
         end
+
+        def payment
+          @persisted_payment
+        end
       end
 
       included do
         attr_reader :request
-        delegate :order, :shippings, :pricing, :discounts, to: :request
+        delegate :order, :shippings, :payment, :pricing, :discounts, to: :request
       end
 
       module ClassMethods

data/app/models/workarea/pricing/calculators/tax_calculator.rb

@@ -5,6 +5,11 @@ module Workarea
         include Calculator
 
         def adjust
+          adjust_shipped_items_tax
+          adjust_not_shipped_items_tax
+        end
+
+        def adjust_shipped_items_tax
           shippings.each do |tmp_shipping|
             next unless tmp_shipping.address.present?
 
@@ -13,15 +18,37 @@ module Workarea
           end
         end
 
-        # If doing split shipping (different items go to different shipping
-        # addresses), decorate this method to return the proper price
-        # adjustments that match the shipping. (This will have to be added to
-        # the UI and saved, probably on the Shipping object)
+        def adjust_not_shipped_items_tax
+          return unless payment&.address.present?
+
+          ItemTaxApplier.new(
+            payment.address,
+            not_shipped_items_price_adjustments
+          ).apply
+        end
+
+        def shipped_items_price_adjustments
+          PriceAdjustmentSet.new(
+            order.items.select(&:requires_shipping?).flat_map(&:price_adjustments)
+          )
+        end
+
+        def not_shipped_items_price_adjustments
+          PriceAdjustmentSet.new(
+            order.items.reject(&:requires_shipping?).flat_map(&:price_adjustments)
+          )
+        end
+
+        # @deprecated As of v3.5, this class supports applying tax directly to
+        # items when they do not require shipping. As a result tax calculation
+        # is split on this distinction and this method is no longer sufficient.
+        # Instead modify the appropriate method to change the set of price
+        # adjustments to consider for tax calculation.
         #
         # @return [PriceAdjustmentSet]
         #
         def price_adjustments_for(shipping)
-          order.price_adjustments
+          shipped_items_price_adjustments
         end
       end
     end