workarea-core 3.4.45 → 3.5.0.beta.1

data/app/models/workarea/data_file/import.rb

@@ -9,6 +9,7 @@ module Workarea
       field :error_message, type: String
       field :total, type: Integer, default: 0
       field :succeeded, type: Integer, default: 0
+      field :release_id, type: String
 
       # These scopes used for mailer previews only
       scope :successful, -> { where(file_errors: {}, error_type: nil, :succeeded.gt => 0) }
@@ -40,8 +41,10 @@ module Workarea
       def process!
         set(started_at: Time.current)
         assert_valid_file_type
-        run_callbacks(:process) { format.import! }
 
+        Workarea::Release.with_current(release_id) do
+          run_callbacks(:process) { format.import! }
+        end
       rescue Exception => e
         self.error_type = e.class
         self.error_message = e.message
@@ -63,6 +66,11 @@ module Workarea
         end
       end
 
+      def releasable?
+        return false unless model_type.present?
+        model_class.new.releasable?
+      end
+
       private
 
       def set_file_type

data/app/models/workarea/data_file/json.rb

@@ -45,31 +45,12 @@ module Workarea
 
         if id.present?
           result = model_class.find_or_initialize_by(id: id)
-          result.attributes = attributes_without_updated_at(attributes)
+          result.attributes = attributes
           result
         else
           model_class.new(attributes)
         end
       end
-
-      def attributes_without_updated_at(attrs)
-        return attrs unless attrs.respond_to?(:each_with_object)
-
-        attrs.each_with_object({}) do |(key, value), attributes|
-          next if key.to_s == 'updated_at'
-
-          attributes[key] = case value
-                            when Hash
-                              attributes_without_updated_at(value)
-                            when Array
-                              value.map do |item|
-                                attributes_without_updated_at(item)
-                              end
-                            else
-                              value
-                            end
-        end
-      end
     end
   end
 end

data/app/models/workarea/data_file/operation.rb

@@ -37,10 +37,6 @@ module Workarea
           Workarea.config.data_file_formats.first
       end
 
-      def mime_type
-        "#{MIME::Types.type_for(file_type).first.to_s}; charset=utf-8"
-      end
-
       def process!
         raise NotImplementedError
       end

data/app/models/workarea/data_file/tax_rates.rb

@@ -31,6 +31,9 @@ module Workarea
             country: row[:country] || 'US',
             postal_code: row[:zip_code],
             percentage: row[:estimated_combined_rate],
+            country_percentage: row[:federal_rate],
+            region_percentage: row[:state_rate],
+            postal_code_percentage: row[:county_rate],
             charge_on_shipping: row[:charge_on_shipping] !~ /false/i
           )
       end

data/app/models/workarea/featured_products.rb

@@ -6,9 +6,17 @@ module Workarea
       field :product_ids, type: Array, default: []
       before_validation :clean_product_ids
 
+      scope :by_product, ->(id) { self.in(product_ids: id) }
       index({ product_ids: 1 })
     end
 
+    def self.changesets(*product_ids)
+      Release::Changeset.any_of(
+        { 'changeset.product_ids' => { '$in' => product_ids } },
+        { 'original.product_ids' => { '$in' => product_ids } }
+      )
+    end
+
     def featured_products?
       product_ids.present?
     end

data/app/models/workarea/fulfillment/policies/base.rb

@@ -0,0 +1,21 @@
+module Workarea
+  class Fulfillment
+    module Policies
+      class Base
+        attr_reader :sku
+
+        def initialize(sku)
+          @sku = sku
+        end
+
+        def requires_shipping?
+          false
+        end
+
+        def process(order_item:, fulfillment: nil)
+          raise(NotImplementedError)
+        end
+      end
+    end
+  end
+end

data/app/models/workarea/fulfillment/policies/download.rb

@@ -0,0 +1,21 @@
+module Workarea
+  class Fulfillment
+    module Policies
+      class Download < Base
+        def process(order_item:, fulfillment: nil)
+          Fulfillment::Token.create!(
+            order_id: order_item.order.id,
+            order_item_id: order_item.id,
+            sku: sku.id
+          )
+
+          return unless fulfillment.present?
+          fulfillment.mark_item_shipped(
+            id: order_item.id.to_s,
+            quantity: order_item.quantity
+          )
+        end
+      end
+    end
+  end
+end

data/app/models/workarea/fulfillment/policies/ignore.rb

@@ -0,0 +1,11 @@
+module Workarea
+  class Fulfillment
+    module Policies
+      class Ignore < Base
+        def process(*args)
+          # no op
+        end
+      end
+    end
+  end
+end

data/app/models/workarea/fulfillment/policies/ship.rb

@@ -0,0 +1,15 @@
+module Workarea
+  class Fulfillment
+    module Policies
+      class Ship < Base
+        def requires_shipping?
+          true
+        end
+
+        def process(*args)
+          # no op
+        end
+      end
+    end
+  end
+end

data/app/models/workarea/fulfillment/sku.rb

@@ -0,0 +1,72 @@
+module Workarea
+  class Fulfillment
+    class Sku
+      class InvalidPolicy < RuntimeError; end
+
+      include ApplicationDocument
+      extend Dragonfly::Model
+
+      field :_id, type: String
+      field :policy, type: String,  default: -> { self.class.policies.first }
+
+      field :file_name, type: String
+      field :file_uid, type: String
+
+      dragonfly_accessor :file, app: :workarea
+      validates :file, presence: true, if: -> { download? }
+
+      delegate :requires_shipping?, to: :policy_object
+
+      def self.policies
+        Workarea.config.fulfillment_policies.map(&:demodulize).map(&:underscore)
+      end
+
+      def self.process!(id, **args)
+        find_or_initialize_by(id: id).process!(args)
+      end
+
+      def self.find_or_initialize_all(ids)
+        existing = self.in(id: ids).to_a
+        ids.map { |id| existing.detect { |sku| sku.id == id } || new(id: id) }
+      end
+
+      def name
+        I18n.t('workarea.fulfillment_sku.name', id: id)
+      end
+
+      def process!(**args)
+        policy_object.process(args)
+      end
+
+      def downloadable?
+        download? && file.present?
+      end
+
+      def method_missing(sym, *args, &block)
+        method = sym.to_s.chomp('?')
+        return super unless self.class.policies.include?(method)
+
+        method == policy
+      end
+
+      def respond_to_missing?(method_name, include_private = false)
+        self.class.policies.include?(method_name.to_s.chomp('?')) || super
+      end
+
+      private
+
+      def policy_object
+        @policy_object ||= policy_class.new(self)
+      end
+
+      def policy_class
+        "Workarea::Fulfillment::Policies::#{policy.classify}".constantize
+      rescue NameError
+        raise(
+          InvalidPolicy,
+          "Workarea::Fulfillment::Policies::#{policy.classify} must be a policy class"
+        )
+      end
+    end
+  end
+end

data/app/models/workarea/fulfillment/token.rb

@@ -0,0 +1,36 @@
+module Workarea
+  class Fulfillment
+    class Token
+      include ApplicationDocument
+
+      field :_id, type: String, default: -> { SecureRandom.base58(24) }
+      field :order_id, type: String
+      field :order_item_id, type: String
+      field :sku, type: String
+      field :enabled, type: Boolean, default: true
+      field :downloads, type: Integer, default: 0
+
+      index(order_id: 1, order_item_id: 1)
+      index(sku: 1)
+
+      scope :for_sku, ->(sku) { where(sku: sku) }
+      scope :by_order, ->(id) { where(order_id: id) }
+
+      def self.for_order_item(order_id, item_id)
+        where(order_id: order_id.to_s, order_item_id: item_id.to_s).first
+      end
+
+      def self.sorts
+        [Sort.newest, Sort.modified, Sort.downloads]
+      end
+
+      def disabled?
+        !enabled?
+      end
+
+      def from_user_order?
+        user_id.present? && order_id.present?
+      end
+    end
+  end
+end

data/app/models/workarea/inquiry.rb

@@ -15,8 +15,7 @@ module Workarea
     validate :subject_exists
 
     def full_subject
-      I18n.t('workarea.inquiry.subjects')[subject.optionize.to_sym].presence ||
-        Workarea.config.inquiry_subjects[subject]
+      Workarea.config.inquiry_subjects[subject]
     end
 
     private

data/app/models/workarea/insights/customer_acquisition.rb

@@ -37,8 +37,8 @@ module Workarea
           {
             '$match' => {
               'first_order_at' => {
-                '$gte' => beginning_of_last_month.utc,
-                '$lte' => end_of_last_month.utc
+                '$gte' => beginning_of_last_month,
+                '$lte' => end_of_last_month
               }
             }
           }
@@ -48,18 +48,14 @@ module Workarea
           {
             '$group' => {
               '_id' => {
-                'year' => { '$year' => first_order_at_in_time_zone },
-                'month' => { '$month' => first_order_at_in_time_zone },
-                'day' => { '$dayOfMonth' => first_order_at_in_time_zone }
+                'year' => { '$year' => '$first_order_at' },
+                'month' => { '$month' => '$first_order_at' },
+                'day' => { '$dayOfMonth' => '$first_order_at' }
               },
               'new_customers' => { '$sum' => 1 }
             }
           }
         end
-
-        def first_order_at_in_time_zone
-          { 'date' => '$first_order_at', 'timezone' => Time.zone.tzinfo.name }
-        end
       end
     end
   end

data/app/models/workarea/insights/trending_products.rb

@@ -22,8 +22,8 @@ module Workarea
           {
             '$match' => {
               'reporting_on' => {
-                '$gte' => beginning_of_last_month.utc,
-                '$lte' => end_of_last_month.utc
+                '$gte' => beginning_of_last_month,
+                '$lte' => end_of_last_month
               }
             }
           }

data/app/models/workarea/insights/trending_searches.rb

@@ -22,8 +22,8 @@ module Workarea
           {
             '$match' => {
               'reporting_on' => {
-                '$gte' => beginning_of_last_month.utc,
-                '$lte' => end_of_last_month.utc
+                '$gte' => beginning_of_last_month,
+                '$lte' => end_of_last_month
               }
             }
           }

data/app/models/workarea/inventory/collection.rb

@@ -14,6 +14,18 @@ module Workarea
         @records = records
       end
 
+      def self.statuses
+        Workarea.config.inventory_status_calculators.map do |klass|
+          klass.demodulize.underscore
+        end
+      end
+
+      statuses.each do |status_name|
+        define_method "#{status_name}?" do
+          status.to_s == status_name
+        end
+      end
+
       # The total number available to sell
       #
       # return [Integer]
@@ -22,6 +34,14 @@ module Workarea
         records.map(&:available_to_sell).sum
       end
 
+      # If the product has any puchasable inventory
+      #
+      # return [Boolean]
+      #
+      def purchasable?(quantity = 1)
+        quantity <= available_to_sell
+      end
+
       # Grab the specific {Sku} for a SKU.
       # Returns a new, unpersisted {Sku} if one does not exist.
       #
@@ -36,6 +56,16 @@ module Workarea
         records.map(&:policy)
       end
 
+      # Get the status of this collection of inventory skus.
+      #
+      # @return [Symbol]
+      #
+      def status
+        calculators = Workarea.config.inventory_status_calculators.map(&:constantize)
+        StatusCalculator.new(calculators, self).result
+      end
+
+
       def records
         @records ||=
           begin

data/app/models/workarea/inventory/collection_status.rb

@@ -0,0 +1,40 @@
+module Workarea
+  module Inventory
+    module CollectionStatus
+      class Backordered
+        include StatusCalculator::Status
+
+        def in_status?
+          model.any?(&:allow_backorder?) &&
+            model.sum(&:backordered).positive? &&
+            model.sum(&:available).zero?
+        end
+      end
+
+      class LowInventory
+        include StatusCalculator::Status
+
+        def in_status?
+          model.purchasable? &&
+            !model.purchasable?(Workarea.config.low_inventory_threshold)
+        end
+      end
+
+      class OutOfStock
+        include StatusCalculator::Status
+
+        def in_status?
+          !model.purchasable?
+        end
+      end
+
+      class Available
+        include StatusCalculator::Status
+
+        def in_status?
+          model.purchasable?
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+module Workarea
+  module Metrics
+    class Affinity
+      include ApplicationDocument
+
+      field :product_ids, type: Array, default: []
+      field :category_ids, type: Array, default: []
+      field :search_ids, type: Array, default: []
+
+      embedded_in :user, class_name: 'Workarea::Metrics::User'
+
+      def recent_product_ids(max: Workarea.config.affinity_default_recent_size, unique: false)
+        recent_ids(product_ids, max: max, unique: unique)
+      end
+
+      def recent_category_ids(max: Workarea.config.affinity_default_recent_size, unique: false)
+        recent_ids(category_ids, max: max, unique: unique)
+      end
+
+      def recent_search_ids(max: Workarea.config.affinity_default_recent_size, unique: false)
+        recent_ids(search_ids, max: max, unique: unique)
+      end
+
+      private
+
+      def recent_ids(ids, max:, unique:)
+        ids = ids.reverse
+        ids.uniq! if unique
+        ids.take(max)
+      end
+    end
+  end
+end

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

@@ -12,9 +12,13 @@ module Workarea
       field :discounts, type: Float, default: 0.0
       field :tax, type: Float, default: 0.0
       field :revenue, type: Float, default: 0.0
+      field :cancellations, type: Integer, default: 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/product_by_day.rb

@@ -12,9 +12,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)
       index(product_id: 1, reporting_on: 1)
       scope :by_product, ->(id) { where(product_id: id) }
     end

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

@@ -17,6 +17,8 @@ module Workarea
       field :average_discount, type: Float, default: 0.0
       field :discount_rate, type: Float, default: 0.0
       field :conversion_rate, type: Float, default: 0.0
+      field :units_canceled, type: Integer, default: 0
+      field :refund, type: Float, default: 0.0
 
       index(product_id: 1)
       index(views_percentile: 1, reporting_on: 1, conversion_rate: 1)

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

@@ -35,8 +35,8 @@ module Workarea
           {
             '$match' => {
               'reporting_on' => {
-                '$gte' => Time.current.last_week.utc,
-                '$lte' => Time.current.last_week.end_of_week.utc
+                '$gte' => Time.current.last_week,
+                '$lte' => Time.current.last_week.end_of_week
               }
             }
           }
@@ -54,7 +54,9 @@ module Workarea
               'discounts' => { '$sum' => '$discounts' },
               'tax' => { '$sum' => '$tax' },
               'revenue' => { '$sum' => '$revenue' },
-              'reporting_on' => { '$min' => '$reporting_on' }
+              'reporting_on' => { '$min' => '$reporting_on' },
+              'units_canceled' => { '$sum' => '$units_canceled' },
+              'refund' => { '$sum' => '$refund' }
             }
           }
         end
@@ -70,8 +72,8 @@ module Workarea
                     '$expr' => {
                       '$and' => [
                         { '$eq' => ['$product_id', '$$product_id'] },
-                        { '$gte' => ['$reporting_on', (Time.current.last_week - 1.week).utc] },
-                        { '$lte' => ['$reporting_on', (Time.current.last_week.end_of_week - 1.week).utc] }
+                        { '$gte' => ['$reporting_on', Time.current.last_week - 1.week] },
+                        { '$lte' => ['$reporting_on', Time.current.last_week.end_of_week - 1.week] }
                       ]
                     }
                   }
@@ -144,13 +146,7 @@ module Workarea
             '$addFields' => {
               '_id' => {
                 '$concat' => [
-                  {
-                    '$dateToString' => {
-                      'format' => '%Y%m%d',
-                      'date' => '$reporting_on',
-                      'timezone' => Time.zone.tzinfo.name
-                    }
-                  },
+                  { '$dateToString' => { 'format' => '%Y%m%d', 'date' => '$reporting_on' } },
                   '-',
                   '$product_id'
                 ]

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

@@ -13,8 +13,13 @@ module Workarea
       field :discounts, type: Float, default: 0.0
       field :tax, type: Float, default: 0.0
       field :revenue, type: Float, default: 0.0
+      field :cancellations, type: Integer, default: 0
+      field :units_canceled, type: Integer, default: 0
+      field :refund, type: Float, default: 0.0
+      field :sessions, type: Integer, default: 0
 
       index(reporting_on: 1, orders: 1)
+      index(reporting_on: 1, cancellations: 1)
     end
   end
 end

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

@@ -17,13 +17,11 @@ module Workarea
       field :revenue, type: Float, default: 0.0
 
       index(reporting_on: 1, total_results: 1)
-      index(query_id: 1)
-
       scope :by_query_id, ->(id) { where(query_id: id) }
 
       def self.save_search(query_string, total_results, at: Time.current)
         query_string = QueryString.new(query_string)
-        return if query_string.id.blank? || query_string.short?
+        return if query_string.id.blank? || query_string.short? || total_results.blank?
 
         inc(
           key: { query_id: query_string.id },

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

@@ -36,8 +36,8 @@ module Workarea
           {
             '$match' => {
               'reporting_on' => {
-                '$gte' => Time.current.last_week.utc,
-                '$lte' => Time.current.last_week.end_of_week.utc
+                '$gte' => Time.current.last_week,
+                '$lte' => Time.current.last_week.end_of_week
               }
             }
           }
@@ -77,8 +77,8 @@ module Workarea
                     '$expr' => {
                       '$and' => [
                         { '$eq' => ['$query_id', '$$query_id'] },
-                        { '$gte' => ['$reporting_on', (Time.current.last_week - 1.week).utc] },
-                        { '$lte' => ['$reporting_on', (Time.current.last_week.end_of_week - 1.week).utc] }
+                        { '$gte' => ['$reporting_on', Time.current.last_week - 1.week] },
+                        { '$lte' => ['$reporting_on', Time.current.last_week.end_of_week - 1.week] }
                       ]
                     }
                   }
@@ -151,13 +151,7 @@ module Workarea
             '$addFields' => {
               '_id' => {
                 '$concat' => [
-                  {
-                    '$dateToString' => {
-                      'format' => '%Y%m%d',
-                      'date' => '$reporting_on',
-                      'timezone' => Time.zone.tzinfo.name
-                    }
-                  },
+                  { '$dateToString' => { 'format' => '%Y%m%d', 'date' => '$reporting_on' } },
                   '-',
                   '$query_id'
                 ]

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

@@ -0,0 +1,31 @@
+module Workarea
+  module Metrics
+    class SegmentByDay
+      include ByDay
+
+      field :segment_id, type: String
+      field :orders, type: Integer, default: 0
+      field :returning_orders, type: Integer, default: 0
+      field :customers, type: Integer, default: 0
+      field :units_sold, type: Integer, default: 0
+      field :discounted_units_sold, type: Integer, default: 0
+      field :merchandise, type: Float, default: 0.0
+      field :shipping, type: Float, default: 0.0
+      field :discounts, type: Float, default: 0.0
+      field :tax, type: Float, default: 0.0
+      field :revenue, type: Float, default: 0.0
+      field :cancellations, type: Integer, default: 0
+      field :units_canceled, type: Integer, default: 0
+      field :refund, type: Float, default: 0.0
+      field :sessions, type: Integer, default: 0
+
+      index(segment_id: 1, reporting_on: 1)
+      scope :by_segment, ->(id) { where(segment_id: id) }
+
+      def average_order_value
+        return nil if orders.zero?
+        revenue / orders.to_f
+      end
+    end
+  end
+end