workarea-reviews 3.1.0

data/app/mailers/workarea/admin/status_report_mailer.decorator

@@ -0,0 +1,8 @@
+module Workarea
+  decorate Admin::StatusReportMailer, with: :reviews do
+    def report(*)
+      @reviews_summary = ReviewSummary.new
+      super
+    end
+  end
+end

data/app/mailers/workarea/storefront/review_mailer.rb

@@ -0,0 +1,23 @@
+module Workarea
+  module Storefront
+    class ReviewMailer < Storefront::ApplicationMailer
+      include TransactionalMailer
+
+      def review_request(request_id)
+        @request = Review::Request.find(request_id)
+        @content = Content::Email.find_content('review_request')
+        @product = Storefront::ProductViewModel.wrap(
+          Catalog::Product.find(@request.product_id)
+        )
+
+        mail(
+          to: @request.email,
+          subject: t(
+            'workarea.storefront.email.review_request.subject',
+            product: @product.name
+          )
+        )
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+module Workarea
+  decorate Catalog::Product, with: :reviews do
+    decorated do
+      # @!attribute total_reviews
+      #   @return [Integer] the total number of approved reviews
+      #
+      field :total_reviews, type: Integer, default: 0
+
+      # @!attribute average_rating
+      #   @return [Float] the average rating of approved reviews
+      #
+      field :average_rating,  type: Float
+    end
+  end
+end

data/app/models/workarea/fulfillment.decorator

@@ -0,0 +1,11 @@
+module Workarea
+  decorate Fulfillment, with: :reviews do
+    def ship_items(tracking_number, shipped_items)
+      super.tap do |result|
+        if result && Workarea.config.send_transactional_emails
+          ScheduleReviewRequests.perform_async(id, shipped_items)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+module Workarea
+  module Insights
+    class MostActiveReviewers < Base
+      class << self
+        def dashboards
+          %w(people marketing)
+        end
+
+        def generate_monthly!
+          results = generate_results
+          create!(results: results) if results.present?
+        end
+
+        def generate_results
+          report
+            .results
+            .select { |r| r['reviews'] > 0 }
+            .take(Workarea.config.insights_users_list_max_results)
+            .map { |result| result.merge(email: result['_id']) }
+        end
+
+        def report
+          Reports::ReviewsByUser.new(
+            starts_at: beginning_of_last_month,
+            ends_at: end_of_last_month,
+            sort_by: 'activity_score',
+            sort_direction: 'desc',
+            results_filter: 'approved'
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+module Workarea
+  module Insights
+    class MostReviewedProducts < Base
+      class << self
+        def dashboards
+          %w(marketing)
+        end
+
+        def generate_monthly!
+          results = generate_results
+          create!(results: results) if results.present?
+        end
+
+        def generate_results
+          report
+            .results
+            .select { |r| r['reviews'] > 0 }
+            .take(Workarea.config.insights_products_list_max_results)
+            .map { |result| result.merge(product_id: result['_id']) }
+        end
+
+        def report
+          Reports::ReviewsByProduct.new(
+            starts_at: beginning_of_last_month,
+            ends_at: end_of_last_month,
+            sort_by: 'reviews',
+            sort_direction: 'desc'
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+module Workarea
+  module Insights
+    class TopRatedProducts < Base
+      class << self
+        def dashboards
+          %w(marketing)
+        end
+
+        def generate_monthly!
+          results = generate_results
+          create!(results: results) if results.present?
+        end
+
+        def generate_results
+          report
+            .results
+            .select { |r| r['reviews'] > 0 }
+            .take(Workarea.config.insights_products_list_max_results)
+            .map { |result| result.merge(product_id: result['_id']) }
+        end
+
+        def report
+          Reports::ReviewsByProduct.new(
+            starts_at: beginning_of_last_month,
+            ends_at: end_of_last_month,
+            sort_by: 'weighted_average_rating',
+            sort_direction: 'desc'
+          )
+        end
+      end
+    end
+  end
+end

data/app/models/workarea/review.rb

@@ -0,0 +1,124 @@
+module Workarea
+  class Review
+    include ApplicationDocument
+
+    field :user_id, type: String
+    field :user_info, type: String
+    field :first_name, type: String
+    field :last_name, type: String
+    field :email, type: String
+    field :product_id, type: String
+    field :rating, type: Integer
+    field :title, type: String
+    field :body, type: String
+    field :approved, type: Boolean, default: false
+    field :verified, type: Boolean, default: false
+
+    index(product_id: 1, approved: 1)
+    index(approved: 1)
+    index(created_at: 1)
+
+    validates :product_id, presence: true
+    validates :user_info, presence: true
+    validates :body, presence: true
+    validates :rating, presence: true,
+      numericality: {
+        greater_than_or_equal_to: 1,
+        less_than_or_equal_to: 5,
+        only_integer: true
+      }
+
+    validate :user_must_have_spent_money_to_create_review
+
+    before_save :ensure_title
+
+    scope :by_product, ->(id) { where(product_id: id) }
+    scope :approved, -> { where(approved: true) }
+    scope :pending,  -> { where(approved: false) }
+
+    def self.sorts
+      [ Workarea::Sort.pending,
+        Workarea::Sort.newest,
+        Workarea::Sort.modified,
+        Workarea::Sort.title,
+        Workarea::Sort.rating ]
+    end
+
+    # Get {Mongoid::Criteria} for the reviews for a certain product.
+    # Optionally allow including unapproved reviews (for the admin).
+    #
+    # @param [String] product_id
+    # @param [optional, Boolean] allow_unapproved
+    # @return [Mongoid::Criteria]
+    #
+    def self.find_for_product(product_id, allow_unapproved = false)
+      criteria = by_product(product_id)
+      allow_unapproved ? criteria : criteria.approved
+    end
+
+    # Lookup aggregate stats on product reviews for a product.
+    #
+    # @param [String] product_id
+    # @return [Hash]
+    #
+    def self.find_single_aggregates(product_id)
+      stats = by_product(product_id).approved.aggregates(:rating)
+      { count: stats['count'] || 0, average: stats['avg'] || 0 }
+    end
+
+    # Lookup aggregate review stats on multiple products.
+    # Used for show stats on browse/detail.
+    #
+    # @param [Array<String>] product_ids
+    # @return [Hash] results Keys are product IDs, values are stats Hash
+    #
+    def self.find_aggregates(*product_ids)
+      product_ids = Array(product_ids).flatten
+
+      if product_ids.one?
+        find_single_aggregates(product_ids.first)
+      else
+        product_ids.inject({}) do |memo, product_id|
+          memo[product_id] = find_single_aggregates(product_id)
+          memo
+        end
+      end
+    end
+
+    # Find sort score for a product. Used in the search index for sorting by
+    # best reviewed.
+    #
+    # Balances a small number of ratings with the uncertainty of only having a few ratings.
+    # See: http://masanjin.net/blog/how-to-rank-products-based-on-user-input
+    #
+    # @param [String] product_id
+    # @return [Float]
+    #
+    def self.find_sorting_score(product_id)
+      reviews = find_for_product(product_id).to_a
+      count = (1..5).each_with_object({}) do |i, memo|
+        memo[i] = reviews.select { |r| r.rating == i }.length + 2
+      end
+
+      count.sum { |rating, count| rating * count }.to_f / count.values.sum
+    end
+
+    def anonymous?
+      !user_id.present?
+    end
+
+    def ensure_title
+      self.title = body.truncate(50) if title.blank?
+    end
+
+    def user_must_have_spent_money_to_create_review
+      if Workarea.config.require_purchase_to_post_review
+        user = User.find(user_id)
+        if user.total_spent.to_f.zero?
+          err_msg = I18n.t('workarea.storefront.reviews.total_spent_validation')
+          errors.add(:user, err_msg)
+        end
+      end
+    end
+  end
+end

data/app/models/workarea/review/request.rb

@@ -0,0 +1,62 @@
+module Workarea
+  class Review
+    class Request
+      include ApplicationDocument
+      include UrlToken
+
+      field :order_id, type: String
+      field :user_id, type: String
+      field :product_id, type: String
+
+      field :email, type: String
+
+      field :send_after, type: DateTime
+      field :sent_at, type: DateTime
+      field :completed_at, type: DateTime
+      field :canceled_at, type: DateTime
+
+      index(order_id: 1)
+      index(send_after: 1, sent_at: 1, canceled_at: 1)
+
+      index(
+        { created_at: 1 },
+        { expire_after_seconds: Workarea.config.review_request_ttl }
+      )
+
+      scope :by_order, ->(order_id) { where(order_id: order_id) }
+      scope :ready_to_send, ->(from = Time.current) do
+        where(:send_after.lte => from, :sent_at => nil, :canceled_at => nil)
+      end
+
+      def self.cancel_for_orders!(order_ids)
+        self.in(order_id: Array.wrap(order_ids))
+            .where(completed_at: nil)
+            .update_all(canceled_at: Time.current)
+      end
+
+      def scheduled?
+        send_after.present?
+      end
+
+      def sent?
+        sent_at.present?
+      end
+
+      def completed?
+        completed_at.present? || canceled?
+      end
+
+      def canceled?
+        canceled_at.present?
+      end
+
+      def complete!
+        update_attributes(completed_at: Time.current)
+      end
+
+      def send!
+        update_attributes(sent_at: Time.current)
+      end
+    end
+  end
+end

data/app/models/workarea/search/admin/review.rb

@@ -0,0 +1,72 @@
+module Workarea
+  module Search
+    class Admin
+      class Review < Search::Admin
+        def type
+          'review'
+        end
+
+        def status
+          'active'
+        end
+
+        def facets
+          super.merge(
+            state: state,
+            rating: model.rating,
+            verification: verification
+          )
+        end
+
+        def jump_to_text
+          nil
+        end
+
+        def name
+          nil
+        end
+
+        def jump_to_position
+          6
+        end
+
+        def search_text
+          [model.product_id, model.user_id]
+        end
+
+        def review_text
+          [model.title, model.body, product&.name].compact
+        end
+
+        def state
+          if model.approved?
+            I18n.t('workarea.admin.reviews.approved')
+          else
+            I18n.t('workarea.admin.reviews.pending')
+          end
+        end
+
+        def verification
+          if model.verified?
+            I18n.t('workarea.admin.reviews.verified')
+          else
+            I18n.t('workarea.admin.reviews.unverified')
+          end
+        end
+
+        def as_document
+          super.merge(
+            review_text: review_text,
+            rating: model.rating
+          )
+        end
+
+        private
+
+        def product
+          @product ||= Catalog::Product.find(model.product_id) rescue nil
+        end
+      end
+    end
+  end
+end

data/app/models/workarea/search/storefront/product.decorator

@@ -0,0 +1,9 @@
+module Workarea
+  decorate Search::Storefront::Product, with: :reviews do
+    def sorts
+      super.merge(
+        rating: Review.find_sorting_score(model.id)
+      )
+    end
+  end
+end

data/app/models/workarea/sort.decorator

@@ -0,0 +1,17 @@
+module Workarea
+  decorate Sort, with: :reviews do
+    class_methods do
+      def top_rated
+        new(I18n.t('workarea.sorts.top_rated'), :top_rated, :'sorts.rating', :desc)
+      end
+
+      def highest_rating
+        new(I18n.t('workarea.sorts.highest_rating'), :highest_rating, :rating, :desc)
+      end
+
+      def lowest_rating
+        new(I18n.t('workarea.sorts.lowest_rating'), :lowest_rating, :rating, :asc)
+      end
+    end
+  end
+end