workarea-reviews 3.1.0

data/test/models/workarea/insights/top_rated_products_test.rb

@@ -0,0 +1,49 @@
+require 'test_helper'
+
+module Workarea
+  module Insights
+    class TopRatedProductsTest < TestCase
+      setup :add_data, :time_travel
+
+      def add_data
+        create_review(product_id: 'foo', rating: 3, created_at: Time.zone.local(2018, 10, 27))
+        create_review(product_id: 'foo', rating: 3, created_at: Time.zone.local(2018, 10, 28))
+        create_review(product_id: 'foo', rating: 3, created_at: Time.zone.local(2018, 10, 28))
+        create_review(product_id: 'foo', rating: 5, created_at: Time.zone.local(2018, 10, 29))
+        create_review(product_id: 'foo', rating: 3, created_at: Time.zone.local(2018, 10, 29))
+        create_review(product_id: 'foo', rating: 2, created_at: Time.zone.local(2018, 10, 29))
+
+        create_review(product_id: 'bar', rating: 3, created_at: Time.zone.local(2018, 10, 27))
+        create_review(product_id: 'bar', rating: 4, created_at: Time.zone.local(2018, 10, 27))
+        create_review(product_id: 'bar', rating: 5, created_at: Time.zone.local(2018, 10, 27))
+        create_review(product_id: 'bar', rating: 5, created_at: Time.zone.local(2018, 10, 28))
+        create_review(product_id: 'bar', rating: 5, created_at: Time.zone.local(2018, 10, 28))
+        create_review(product_id: 'bar', rating: 5, created_at: Time.zone.local(2018, 10, 28))
+        create_review(product_id: 'bar', rating: 4, created_at: Time.zone.local(2018, 10, 28))
+        create_review(product_id: 'bar', rating: 4, created_at: Time.zone.local(2018, 10, 29))
+        create_review(product_id: 'bar', rating: 4, created_at: Time.zone.local(2018, 10, 29))
+        create_review(product_id: 'bar', rating: 5, created_at: Time.zone.local(2018, 10, 29))
+        create_review(product_id: 'bar', rating: 5, created_at: Time.zone.local(2018, 10, 29))
+        create_review(product_id: 'bar', rating: 3, created_at: Time.zone.local(2018, 10, 29))
+      end
+
+      def time_travel
+        travel_to Time.zone.local(2018, 11, 1)
+      end
+
+      def test_generate_monthly!
+        TopRatedProducts.generate_monthly!
+        assert_equal(1, TopRatedProducts.count)
+
+        rated_products = TopRatedProducts.first
+        assert_equal(2, rated_products.results.size)
+        assert_equal('bar', rated_products.results.first['product_id'])
+        assert_equal(4.33, rated_products.results.first['average_rating'].round(2))
+        assert_equal(3.73, rated_products.results.first['weighted_average_rating'].round(2))
+        assert_equal('foo', rated_products.results.second['product_id'])
+        assert_equal(3.17, rated_products.results.second['average_rating'].round(2))
+        assert_equal(3.06, rated_products.results.second['weighted_average_rating'].round(2))
+      end
+    end
+  end
+end

data/test/models/workarea/review/request_test.rb

@@ -0,0 +1,18 @@
+require 'test_helper'
+
+module Workarea
+  class Review
+    class RequestTest < TestCase
+      def test_cancel_for_orders!
+        requests = Array.new(3) { create_review_request }
+
+        request = requests.first
+        Review::Request.cancel_for_orders!(request.order_id)
+        assert(request.reload.canceled?)
+
+        Review::Request.cancel_for_orders!(requests.map(&:order_id))
+        assert(requests.each(&:reload).all?(&:canceled?))
+      end
+    end
+  end
+end

data/test/models/workarea/review_test.rb

@@ -0,0 +1,105 @@
+require 'test_helper'
+
+module Workarea
+  class ReviewTest < Workarea::TestCase
+    def product_id
+      'PROD1'
+    end
+
+    def approved
+      @approved ||= create_review(
+        product_id: product_id,
+        rating: 4,
+        approved: true
+      )
+    end
+
+    def unapproved
+      @unapproved ||= create_review(
+        product_id: product_id,
+        rating: 4,
+        approved: false
+      )
+    end
+
+    def test_find_for_product_returns_approved_reviews
+      assert([approved], Review.find_for_product(product_id))
+    end
+
+    def test_find_for_product_returns_unapproved_when_arg_is_true
+      assert([unapproved, approved], Review.find_for_product(product_id, true))
+    end
+
+    def test_find_aggregates_returns_a_hash_data_with_one_product_id
+      approved
+      assert_equal(
+        { count:   1, average: 4 },
+        Review.find_aggregates(product_id)
+      )
+    end
+
+    def test_find_aggregates_returns_a_hash_with_multiple_product_ids
+      approved
+      product_id_2 = 'PROD2'
+      create_review(product_id: product_id_2, rating: 3, approved: true)
+
+      assert_equal(
+        {
+          product_id   => { count: 1, average: 4 },
+          product_id_2 => { count: 1, average: 3 }
+        },
+        Review.find_aggregates(product_id, product_id_2)
+      )
+    end
+
+    def test_find_single_aggregates_returns_a_hash_with_zeros_if_no_data
+      assert_equal(
+        { count: 0, average: 0 },
+        Review.find_single_aggregates('does-not-compute')
+      )
+    end
+
+    def test_find_single_aggregates_returns_a_review_data
+      create_review(product_id: product_id, rating: 1)
+      create_review(product_id: product_id, rating: 2)
+      create_review(product_id: product_id, rating: 3)
+      create_review(product_id: product_id, rating: 4)
+      create_review(product_id: product_id, rating: 5, approved: false)
+
+      assert_equal(
+        { count: 4, average: 2.5 },
+        Review.find_single_aggregates(product_id)
+      )
+    end
+
+    def test_ensure_title
+      review = Review.new(
+        product_id: '123',
+        user_info: 'MD',
+        rating: 3,
+        body: %(
+          Lorem ipsum dolor sit amet, consectetur adipiscing elit.
+          Nam in ex viverra, pretium tellus quis, bibendum nisi.
+          Praesent luctus viverra.
+        ).strip
+      )
+
+      review.save!
+      assert(review.title.present?)
+      assert_equal(review.body.truncate(50), review.title)
+    end
+
+    def test_find_sorting_score
+      create_review(product_id: 'foo', rating: 4, approved: true)
+      create_review(product_id: 'foo', rating: 5, approved: true)
+      create_review(product_id: 'foo', rating: 5, approved: true)
+      assert_equal(3.38, Review.find_sorting_score('foo').round(2))
+
+      create_review(product_id: 'foo', rating: 1, approved: false)
+      assert_equal(3.38, Review.find_sorting_score('foo').round(2))
+
+      create_review(product_id: 'foo', rating: 1, approved: true)
+      assert_equal(3.21, Review.find_sorting_score('foo').round(2))
+    end
+  end
+end

data/test/models/workarea/search/storefront/product_test.decorator

@@ -0,0 +1,14 @@
+require 'test_helper'
+
+module Workarea
+  decorate Search::Storefront::ProductTest, with: :reviews do
+    def test_rating_gets_sorting_score_from_reviews_service
+      product = Catalog::Product.new
+      Review.stubs(:find_sorting_score).returns(5)
+      assert_equal(
+        5,
+        Search::Storefront::Product.new(product).sorts[:rating]
+      )
+    end
+  end
+end

data/test/queries/workarea/reports/reviews_by_product_test.rb

@@ -0,0 +1,104 @@
+require 'test_helper'
+
+module Workarea
+  module Reports
+    class ReviewsByProductTest < TestCase
+      setup :add_data, :time_travel
+
+      def add_data
+        create_review(product_id: 'foo', rating: 4, created_at: Time.zone.local(2018, 10, 27), approved: true, verified: true)
+        create_review(product_id: 'foo', rating: 3, created_at: Time.zone.local(2018, 10, 28), approved: true, verified: true)
+        create_review(product_id: 'foo', rating: 4, created_at: Time.zone.local(2018, 10, 28), approved: true)
+        create_review(product_id: 'foo', rating: 4, created_at: Time.zone.local(2018, 10, 29), approved: true)
+        create_review(product_id: 'foo', rating: 3, created_at: Time.zone.local(2018, 10, 29), approved: false)
+        create_review(product_id: 'foo', rating: 2, created_at: Time.zone.local(2018, 10, 29), approved: false)
+
+        create_review(product_id: 'bar', rating: 3, created_at: Time.zone.local(2018, 10, 27), approved: true, verified: true)
+        create_review(product_id: 'bar', rating: 4, created_at: Time.zone.local(2018, 10, 28), approved: true)
+        create_review(product_id: 'bar', rating: 5, created_at: Time.zone.local(2018, 10, 28), approved: false)
+        create_review(product_id: 'bar', rating: 5, created_at: Time.zone.local(2018, 10, 29), approved: false)
+        create_review(product_id: 'bar', rating: 3, created_at: Time.zone.local(2018, 10, 29), approved: false)
+      end
+
+      def time_travel
+        travel_to Time.zone.local(2018, 10, 30)
+      end
+
+      def test_grouping_and_summing
+        report = ReviewsByProduct.new
+        assert_equal(2, report.results.length)
+
+        foo = report.results.detect { |r| r['_id'] == 'foo' }
+        assert_equal(6, foo['reviews'])
+        assert_equal(2, foo['verified'])
+        assert_equal(3.33, foo['average_rating'].round(2))
+        assert_equal(3.13, foo['weighted_average_rating'].round(2))
+
+        bar = report.results.detect { |r| r['_id'] == 'bar' }
+        assert_equal(5, bar['reviews'])
+        assert_equal(1, bar['verified'])
+        assert_equal(4, bar['average_rating'])
+        assert_equal(3.33, bar['weighted_average_rating'].round(2))
+      end
+
+      def test_date_ranges
+        report = ReviewsByProduct.new
+        foo = report.results.detect { |r| r['_id'] == 'foo' }
+        assert_equal(6, foo['reviews'])
+
+        report = ReviewsByProduct.new(starts_at: '2018-10-28', ends_at: '2018-10-28')
+        foo = report.results.detect { |r| r['_id'] == 'foo' }
+        assert_equal(2, foo['reviews'])
+
+        report = ReviewsByProduct.new(starts_at: '2018-10-28', ends_at: '2018-10-29')
+        foo = report.results.detect { |r| r['_id'] == 'foo' }
+        assert_equal(5, foo['reviews'])
+
+        report = ReviewsByProduct.new(starts_at: '2018-10-28')
+        foo = report.results.detect { |r| r['_id'] == 'foo' }
+        assert_equal(5, foo['reviews'])
+
+        report = ReviewsByProduct.new(ends_at: '2018-10-28')
+        foo = report.results.detect { |r| r['_id'] == 'foo' }
+        assert_equal(3, foo['reviews'])
+      end
+
+      def test_sorting
+        report = ReviewsByProduct.new(sort_by: 'average_rating', sort_direction: 'asc')
+        assert_equal('foo', report.results.first['_id'])
+
+        report = ReviewsByProduct.new(sort_by: 'average_rating', sort_direction: 'desc')
+        assert_equal('bar', report.results.first['_id'])
+
+        report = ReviewsByProduct.new(sort_by: 'reviews', sort_direction: 'desc')
+        assert_equal('foo', report.results.first['_id'])
+      end
+
+      def test_filtering
+        report = ReviewsByProduct.new(results_filter: 'unapproved')
+
+        foo = report.results.detect { |r| r['_id'] == 'foo' }
+        assert_equal(2, foo['reviews'])
+        assert_equal(2.5, foo['average_rating'].round(2))
+        assert_equal(2.92, foo['weighted_average_rating'].round(2))
+
+        bar = report.results.detect { |r| r['_id'] == 'bar' }
+        assert_equal(3, bar['reviews'])
+        assert_equal(4.33, bar['average_rating'].round(2))
+        assert_equal(3.31, bar['weighted_average_rating'].round(2))
+
+        report = ReviewsByProduct.new(results_filter: 'approved')
+
+        foo = report.results.detect { |r| r['_id'] == 'foo' }
+        assert_equal(4, foo['reviews'])
+        assert_equal(3.75, foo['average_rating'].round(2))
+        assert_equal(3.21, foo['weighted_average_rating'].round(2))
+
+        bar = report.results.detect { |r| r['_id'] == 'bar' }
+        assert_equal(2, bar['reviews'])
+        assert_equal(3.5, bar['average_rating'])
+        assert_equal(3.08, bar['weighted_average_rating'].round(2))
+      end
+    end
+  end
+end

data/test/queries/workarea/reports/reviews_by_user_test.rb

@@ -0,0 +1,102 @@
+require 'test_helper'
+
+module Workarea
+  module Reports
+    class ReviewsByUserTest < TestCase
+      setup :add_data, :time_travel
+
+      def add_data
+        create_review(email: 'foo@workarea.com', user_id: nil, rating: 4, created_at: Time.zone.local(2018, 10, 27), approved: true, verified: true)
+        create_review(email: 'foo@workarea.com', user_id: '123', rating: 3, created_at: Time.zone.local(2018, 10, 28), approved: true, verified: true)
+        create_review(email: 'foo@workarea.com', user_id: '123', rating: 4, created_at: Time.zone.local(2018, 10, 28), approved: true)
+        create_review(email: 'foo@workarea.com', user_id: nil, rating: 4, created_at: Time.zone.local(2018, 10, 29), approved: true)
+        create_review(email: 'foo@workarea.com', user_id: nil, rating: 3, created_at: Time.zone.local(2018, 10, 29), approved: false)
+        create_review(email: 'foo@workarea.com', user_id: nil, rating: 2, created_at: Time.zone.local(2018, 10, 29), approved: false)
+
+        create_review(email: 'bar@workarea.com', user_id: nil, rating: 3, created_at: Time.zone.local(2018, 10, 27), approved: true, verified: true)
+        create_review(email: 'bar@workarea.com', user_id: '456', rating: 4, created_at: Time.zone.local(2018, 10, 28), approved: true)
+        create_review(email: 'bar@workarea.com', user_id: nil, rating: 5, created_at: Time.zone.local(2018, 10, 28), approved: false)
+        create_review(email: 'bar@workarea.com', user_id: nil, rating: 5, created_at: Time.zone.local(2018, 10, 29), approved: false)
+        create_review(email: 'bar@workarea.com', user_id: nil, rating: 3, created_at: Time.zone.local(2018, 10, 29), approved: false)
+      end
+
+      def time_travel
+        travel_to Time.zone.local(2018, 10, 30)
+      end
+
+      def test_grouping_and_summing
+        report = ReviewsByUser.new
+        assert_equal(2, report.results.length)
+
+        foo = report.results.detect { |r| r['_id'] == 'foo@workarea.com' }
+        assert_equal(6, foo['reviews'])
+        assert_equal(2, foo['verified'])
+        assert_equal(3.33, foo['average_rating'].round(2))
+        assert_equal('123', foo['user_id'])
+        assert_equal(7.5, foo['activity_score'])
+
+        bar = report.results.detect { |r| r['_id'] == 'bar@workarea.com' }
+        assert_equal(5, bar['reviews'])
+        assert_equal(1, bar['verified'])
+        assert_equal(4, bar['average_rating'])
+        assert_equal('456', bar['user_id'])
+        assert_equal(5.75, bar['activity_score'])
+      end
+
+      def test_date_ranges
+        report = ReviewsByUser.new
+        foo = report.results.detect { |r| r['_id'] == 'foo@workarea.com' }
+        assert_equal(6, foo['reviews'])
+
+        report = ReviewsByUser.new(starts_at: '2018-10-28', ends_at: '2018-10-28')
+        foo = report.results.detect { |r| r['_id'] == 'foo@workarea.com' }
+        assert_equal(2, foo['reviews'])
+
+        report = ReviewsByUser.new(starts_at: '2018-10-28', ends_at: '2018-10-29')
+        foo = report.results.detect { |r| r['_id'] == 'foo@workarea.com' }
+        assert_equal(5, foo['reviews'])
+
+        report = ReviewsByUser.new(starts_at: '2018-10-28')
+        foo = report.results.detect { |r| r['_id'] == 'foo@workarea.com' }
+        assert_equal(5, foo['reviews'])
+
+        report = ReviewsByUser.new(ends_at: '2018-10-28')
+        foo = report.results.detect { |r| r['_id'] == 'foo@workarea.com' }
+        assert_equal(3, foo['reviews'])
+      end
+
+      def test_sorting
+        report = ReviewsByUser.new(sort_by: 'average_rating', sort_direction: 'asc')
+        assert_equal('foo@workarea.com', report.results.first['_id'])
+
+        report = ReviewsByUser.new(sort_by: 'average_rating', sort_direction: 'desc')
+        assert_equal('bar@workarea.com', report.results.first['_id'])
+
+        report = ReviewsByUser.new(sort_by: 'reviews', sort_direction: 'desc')
+        assert_equal('foo@workarea.com', report.results.first['_id'])
+      end
+
+      def test_filtering
+        report = ReviewsByUser.new(results_filter: 'unapproved')
+
+        foo = report.results.detect { |r| r['_id'] == 'foo@workarea.com' }
+        assert_equal(2, foo['reviews'])
+        assert_equal(2.5, foo['average_rating'].round(2))
+
+        bar = report.results.detect { |r| r['_id'] == 'bar@workarea.com' }
+        assert_equal(3, bar['reviews'])
+        assert_equal(4.33, bar['average_rating'].round(2))
+
+        report = ReviewsByUser.new(results_filter: 'approved')
+
+        foo = report.results.detect { |r| r['_id'] == 'foo@workarea.com' }
+        assert_equal(4, foo['reviews'])
+        assert_equal(3.75, foo['average_rating'].round(2))
+
+        bar = report.results.detect { |r| r['_id'] == 'bar@workarea.com' }
+        assert_equal(2, bar['reviews'])
+        assert_equal(3.5, bar['average_rating'])
+      end
+    end
+  end
+end

data/test/queries/workarea/review_request_params_test.rb

@@ -0,0 +1,64 @@
+require 'test_helper'
+
+module Workarea
+  class ReviewRequestParamsTest < TestCase
+    def product
+      @product ||= create_product
+    end
+
+    def order
+      @order ||=
+        create_placed_order.tap { |o| o.update_attributes(user_id: user.id) }
+    end
+
+    def user
+      @user ||= create_user(first_name: 'Robert', last_name: 'Clams')
+    end
+
+    def test_to_h
+      params = { rating: 3, body: 'foo bar' }
+      request = create_review_request(
+        product_id: product.id,
+        order_id: order.id,
+        email: order.email,
+        user_id: user.id
+      )
+
+      assert_equal(
+        {
+          rating: 3,
+          body: 'foo bar',
+          product_id: product.id.to_s,
+          user_id: user.id.to_s,
+          email: order.email,
+          user_info: 'RC',
+          first_name: 'Robert',
+          last_name: 'Clams',
+          verified: true
+        },
+        ReviewRequestParams.new(request, params).to_h
+      )
+
+      request = create_review_request(
+        product_id: product.id,
+        order_id: order.id,
+        email: order.email,
+      )
+
+      assert_equal(
+        {
+          rating: 3,
+          body: 'foo bar',
+          product_id: product.id.to_s,
+          user_id: nil,
+          email: order.email,
+          user_info: 'BC',
+          first_name: 'Ben',
+          last_name: 'Crouse',
+          verified: true
+        },
+        ReviewRequestParams.new(request, params).to_h
+      )
+    end
+  end
+end