workarea-reviews 3.1.0

data/app/queries/workarea/reports/reviews_by_product.rb

@@ -0,0 +1,86 @@
+module Workarea
+  module Reports
+    class ReviewsByProduct
+      include Report
+
+      self.reporting_class = Review
+      self.sort_fields = %w(reviews verified average_rating weighted_average_rating)
+
+      def aggregation
+        [filter_results, project_used_fields, group_by_product, project_averages]
+      end
+
+      def filter_results
+        {
+          '$match' => {
+            'created_at' => { '$gte' => starts_at, '$lte' => ends_at },
+            **approval_query
+          }
+        }
+      end
+
+      def project_used_fields
+        {
+          '$project' => {
+            'product_id' => 1,
+            'rating' => 1,
+            'verified' => 1
+          }
+        }
+      end
+
+      def group_by_product
+        {
+          '$group' => {
+            '_id' => '$product_id',
+            'reviews' => { '$sum' => 1 },
+            'verified' => { '$sum' => { '$cond' => { 'if' => '$verified', 'then' => 1, 'else' => 0 } } },
+            'rating_tally' => { '$sum' => '$rating' },
+            'rated_5' => { '$sum' => { '$cond' => { 'if' => { '$eq' => ['$rating', 5] }, 'then' => 1, 'else' => 0 } } },
+            'rated_4' => { '$sum' => { '$cond' => { 'if' => { '$eq' => ['$rating', 4] }, 'then' => 1, 'else' => 0 } } },
+            'rated_3' => { '$sum' => { '$cond' => { 'if' => { '$eq' => ['$rating', 3] }, 'then' => 1, 'else' => 0 } } },
+            'rated_2' => { '$sum' => { '$cond' => { 'if' => { '$eq' => ['$rating', 2] }, 'then' => 1, 'else' => 0 } } },
+            'rated_1' => { '$sum' => { '$cond' => { 'if' => { '$eq' => ['$rating', 1] }, 'then' => 1, 'else' => 0 } } }
+          }
+        }
+      end
+
+      def project_averages
+        {
+          '$project' => {
+            'product_id' => 1,
+            'reviews' => 1,
+            'verified' => 1,
+            'average_rating' => { '$divide' => ['$rating_tally', '$reviews'] },
+            'weighted_average_rating' => {
+              '$divide' => [
+                {
+                  '$sum' => [
+                    { '$multiply' => [{ '$sum' => [2, '$rated_5'] }, 5] },
+                    { '$multiply' => [{ '$sum' => [2, '$rated_4'] }, 4] },
+                    { '$multiply' => [{ '$sum' => [2, '$rated_3'] }, 3] },
+                    { '$multiply' => [{ '$sum' => [2, '$rated_2'] }, 2] },
+                    { '$multiply' => [{ '$sum' => [2, '$rated_1'] }, 1] }
+                  ]
+                },
+                { '$sum' => [10, '$rated_5', '$rated_4', '$rated_3', '$rated_2', '$rated_1'] }
+              ]
+            }
+          }
+        }
+      end
+
+      private
+
+      def approval_query
+        if params[:results_filter] == 'approved'
+          { approved: true }
+        elsif params[:results_filter] == 'unapproved'
+          { approved: false }
+        else
+          {}
+        end
+      end
+    end
+  end
+end

data/app/queries/workarea/reports/reviews_by_user.rb

@@ -0,0 +1,71 @@
+module Workarea
+  module Reports
+    class ReviewsByUser
+      include Report
+
+      self.reporting_class = Review
+      self.sort_fields = %w(reviews verified average_rating activity_score)
+
+      def aggregation
+        [filter_results, project_used_fields, group_by_email, project_fields]
+      end
+
+      def filter_results
+        {
+          '$match' => {
+            'created_at' => { '$gte' => starts_at, '$lte' => ends_at },
+            **approval_query
+          }
+        }
+      end
+
+      def project_used_fields
+        {
+          '$project' => {
+            'email' => 1,
+            'user_id' => 1,
+            'rating' => 1,
+            'verified' => 1
+          }
+        }
+      end
+
+      def group_by_email
+        {
+          '$group' => {
+            '_id' => '$email',
+            'user_id' => { '$max' => '$user_id' },
+            'reviews' => { '$sum' => 1 },
+            'verified' => { '$sum' => { '$cond' => { 'if' => '$verified', 'then' => 1, 'else' => 0 } } },
+            'rating_tally' => { '$sum' => '$rating' }
+          }
+        }
+      end
+
+      def project_fields
+        {
+          '$project' => {
+            'email' => 1,
+            'user_id' => 1,
+            'reviews' => 1,
+            'verified' => 1,
+            'average_rating' => { '$divide' => ['$rating_tally', '$reviews'] },
+            'activity_score' => { '$sum' => ['$reviews', { '$multiply' => ['$verified', 0.75] }] }
+          }
+        }
+      end
+
+      private
+
+      def approval_query
+        if params[:results_filter] == 'approved'
+          { approved: true }
+        elsif params[:results_filter] == 'unapproved'
+          { approved: false }
+        else
+          {}
+        end
+      end
+    end
+  end
+end

data/app/queries/workarea/review_request_params.rb

@@ -0,0 +1,47 @@
+module Workarea
+  class ReviewRequestParams
+    attr_reader :request, :params
+
+    def initialize(request, params)
+      @request = request
+      @params = params
+    end
+
+    def to_h
+      params.merge(
+        product_id: @request.product_id,
+        user_id: @request.user_id,
+        email: @request.email,
+        user_info: user_info,
+        first_name: first_name,
+        last_name: last_name,
+        verified: true
+      )
+    end
+
+    private
+
+    def user_info
+      return user.public_info if user&.public_info.present?
+
+      [first_name.first, last_name.first].join
+    end
+
+    def first_name
+      user&.first_name || billing_address.first_name
+    end
+
+    def last_name
+      user&.last_name || billing_address.last_name
+    end
+
+    def user
+      return nil unless @request.user_id.present?
+      @user ||= User.find(@request.user_id)
+    end
+
+    def billing_address
+      @billing_address ||= Payment.find(@request.order_id).address
+    end
+  end
+end

data/app/queries/workarea/review_summary.rb

@@ -0,0 +1,11 @@
+module Workarea
+  class ReviewSummary
+    def pending_reviews_count
+      @pending_reviews_count ||= Review.pending.count
+    end
+
+    def recent_reviews_count
+      @recent_reviews_count ||= Review.where(:created_at.gte => 1.day.ago).count
+    end
+  end
+end

data/app/queries/workarea/search/admin_reviews.rb

@@ -0,0 +1,40 @@
+module Workarea
+  module Search
+    class AdminReviews
+      include Query
+      include AdminIndexSearch
+      include AdminSorting
+      include Pagination
+
+      document Search::Admin
+
+      def initialize(params = {})
+        super(params.merge(type: 'review'))
+      end
+
+      def fields
+        super + %w(review_text)
+      end
+
+      def facets
+        super + [
+          TermsFacet.new(self, 'state'),
+          TermsFacet.new(self, 'rating'),
+          TermsFacet.new(self, 'verification')
+        ]
+      end
+
+      def sort
+        result = super || []
+
+        if params[:sort] == Sort.highest_rating.to_s
+          result.prepend(Sort.highest_rating.field => Sort.highest_rating.direction)
+        elsif params[:sort] == Sort.lowest_rating.to_s
+          result.prepend(Sort.lowest_rating.field => Sort.lowest_rating.direction)
+        end
+
+        result
+      end
+    end
+  end
+end

data/app/queries/workarea/search/category_browse.decorator

@@ -0,0 +1,9 @@
+module Workarea
+  decorate Search::CategoryBrowse, with: :reviews do
+    class_methods do
+      def available_sorts
+        super.tap { |sorts|  sorts << Sort.top_rated }
+      end
+    end
+  end
+end

data/app/queries/workarea/search/product_search.decorator

@@ -0,0 +1,9 @@
+module Workarea
+  decorate Search::ProductSearch, with: :reviews do
+    class_methods do
+      def available_sorts
+        super.tap { |sorts|  sorts << Sort.top_rated }
+      end
+    end
+  end
+end

data/app/seeds/workarea/review_seeds.rb

@@ -0,0 +1,49 @@
+module Workarea
+  class ReviewSeeds
+    def perform
+      puts 'Adding reviews...'
+
+      Sidekiq::Callbacks.disable do
+        create_reviews_for_catalog
+        create_review_request_email_content
+      end
+    end
+
+    private
+
+    def create_reviews_for_catalog
+      Workarea::Catalog::Product.all.each_by(100) do |product|
+        reviews = Array.new(rand(10)) { create_review(product) }
+        next unless reviews.size > 0
+
+        Workarea::Review.collection.insert_many(reviews.map(&:as_document))
+        UpdateProductReviewData.perform_async(product.id)
+      end
+    end
+
+    def create_review(product)
+      Workarea::Review.new(
+        product_id: product.id,
+        user_id: BSON::ObjectId.new,
+        rating: rand(5) + 1,
+        title: Faker::Lorem.sentence,
+        body: Faker::Lorem.paragraph,
+        approved: [true, false].sample,
+        user_info: Faker::Internet.user_name,
+        verified: [true, false].sample,
+        created_at: rand(45).days.ago,
+        updated_at: Time.current
+      )
+    end
+
+    def create_review_request_email_content
+      Content::Email.create!(
+        type: 'review_request',
+        content: <<~HTML
+          <h1>Let us know what you think!</h1>
+          <p>Your feedback is important to us.</p>
+        HTML
+      )
+    end
+  end
+end

data/app/services/workarea/create_review.rb

@@ -0,0 +1,99 @@
+module Workarea
+  class CreateReview
+    include ActiveModel::Validations
+
+    validate :valid_review
+    validates :first_name, :last_name, presence: true
+
+    attr_reader :review, :user, :params
+
+    def self.for(product: nil, user: nil, params: {})
+      review = Review.new(
+        product_id: product.try(:id),
+        user_id: user.try(:id)
+      )
+
+      new(review, user: user, params: params)
+    end
+
+    def initialize(review, user: nil, params: {})
+      @review = review
+      @user = user
+      @params = params
+    end
+
+    def save
+      update_user_attributes
+      update_attributes
+
+      return false unless valid?
+      review.save.tap { |result| update_review_requests if result }
+    end
+
+    def verified?
+      user_order_ids_with_product.any?
+    end
+
+    private
+
+    def user_order_ids_with_product
+      return [] unless user.present?
+
+      @user_users_with_product ||=
+        Order.placed
+             .where(user_id: user.id.to_s)
+             .where('items.product_id' => review.product_id)
+             .pluck(:id)
+    end
+
+    def update_user_attributes
+      return if !user.present? || user.public_info.present?
+      user.update_attributes(params.slice(:first_name, :last_name))
+    end
+
+    def update_attributes
+      review.assign_attributes(
+        params
+          .slice(:rating, :body, :title)
+          .merge(
+            user_info: user_info,
+            first_name: first_name,
+            last_name: last_name,
+            email: email,
+            verified: verified?
+          )
+      )
+    end
+
+    def update_review_requests
+      return unless user_order_ids_with_product.any?
+      Review::Request.cancel_for_orders!(user_order_ids_with_product)
+    end
+
+    def user_info
+      return user.public_info if user&.public_info.present?
+
+      "#{first_name&.first} #{last_name&.first}".strip
+    end
+
+    def first_name
+      params[:first_name].presence || user&.first_name
+    end
+
+    def last_name
+      params[:last_name].presence || user&.last_name
+    end
+
+    def email
+      params[:email].presence || user&.email
+    end
+
+    def valid_review
+      unless review.valid?
+        review.errors.each do |attr, error|
+          errors.add(attr, error)
+        end
+      end
+    end
+  end
+end

data/app/view_models/workarea/admin/dashboards/reports_view_model.decorator

@@ -0,0 +1,11 @@
+module Workarea
+  decorate Admin::Dashboards::ReportsViewModel, with: :reviews do
+    def reviews_by_product
+      @reviews_by_product ||=
+        Admin::Reports::ReviewsByProductViewModel.wrap(
+          Workarea::Reports::ReviewsByProduct.new(options),
+          options
+        )
+    end
+  end
+end

data/app/view_models/workarea/admin/product_view_model.decorator

@@ -0,0 +1,7 @@
+module Workarea
+  decorate Admin::ProductViewModel, with: :reviews do
+    def pending_reviews_count
+      Review.pending.where(product_id: model.id).count
+    end
+  end
+end