workarea-reviews 3.0.8

data/test/system/workarea/admin/review_system_test.rb

@@ -0,0 +1,96 @@
+require 'test_helper'
+
+module Workarea
+  module Admin
+    class ReviewSystemTest < SystemTest
+      include Admin::IntegrationTest
+
+      setup :review
+
+      def review
+        @review ||= create_review(
+          product_id: product.id,
+          user_id: user.id,
+          rating: 3,
+          title: 'Integration Review',
+          approved: false
+        )
+      end
+
+      def user
+        @user ||= create_user
+      end
+
+      def product
+        @product ||= create_product
+      end
+
+      def test_managing_reviews
+        visit admin.reviews_path
+        click_link t('workarea.storefront.reviews.review_for', product: product.name)
+
+        click_button 'save_review'
+        assert(page.has_content?('Success'))
+
+        assert(page.has_current_path?(admin.reviews_path))
+
+        click_link t('workarea.storefront.reviews.review_for', product: product.name)
+        click_link t('workarea.admin.actions.delete')
+
+        assert(page.has_current_path?(admin.reviews_path))
+        refute(page.has_content?('Integration Review'))
+
+        visit admin.activity_path
+        assert(
+          page.has_content?(
+            t('workarea.admin.activities.review_destroy_html', name: 'Integration Review')
+          )
+        )
+      end
+
+      def test_sorting_by_rating
+        reviews = Array.new(3) do |i|
+          create_review(
+            rating: 5 - i,
+            product_id: create_product(name: "Test #{i}").id
+          )
+        end
+
+        visit admin.reviews_path
+        assert(page.has_ordered_text?('Test 2', 'Test 1', 'Test 0'))
+
+        select 'Highest Rating', from: :sort
+        assert(page.has_ordered_text?('Test 0', 'Test 1', 'Test 2'))
+
+        select 'Lowest Rating', from: :sort
+        assert(page.has_ordered_text?('Test 2', 'Test 1', 'Test 0'))
+      end
+
+      def test_importing_and_exporting
+        reviews = Array.new(2) { |i| create_review(product_id: create_product.id) }
+        file = create_tempfile(DataFile::Csv.new.serialize(reviews), extension: 'csv')
+
+        visit admin.reviews_path
+        click_link t('workarea.admin.shared.bulk_actions.import')
+        attach_file 'import[file]', file.path
+        click_button 'create_import'
+
+        assert_current_path(admin.reviews_path)
+        assert(page.has_content?('Success'))
+
+        click_button t('workarea.admin.shared.bulk_actions.export')
+
+        Workarea.config.data_file_formats[1..-1].each do |format|
+          click_link format.upcase
+          assert(page.has_content?(format.upcase))
+        end
+
+        fill_in 'export[emails_list]', with: 'bcrouse@weblinc.com'
+        click_button 'create_export'
+
+        assert_current_path(admin.reviews_path)
+        assert(page.has_content?('Success'))
+      end
+    end
+  end
+end

data/test/system/workarea/storefront/review_request_system_test.rb

@@ -0,0 +1,34 @@
+require 'test_helper'
+
+module Workarea
+  module Storefront
+    class ReviewRequestSystemTest < Workarea::SystemTest
+      def test_completing_a_review_request
+        order = create_placed_order
+        product = create_product
+        user = create_user(first_name: 'Bob', last_name: 'Clams')
+
+        review_request = create_review_request(
+          product_id: product.id,
+          order_id: order.id,
+          email: order.email,
+          user_id: user.id
+        )
+
+        visit storefront.review_request_path(review_request.token)
+
+        assert(page.has_content?(product.name))
+
+        within '#review_request_form' do
+          execute_script("$('#review_rating_4').trigger('click')")
+          fill_in 'review[title]', with: 'Pretty decent product'
+          fill_in 'review[body]', with: 'It works well.'
+          click_button 'submit_review'
+        end
+
+        assert_current_path(storefront.product_path(product))
+        assert(page.has_content?('Success'))
+      end
+    end
+  end
+end

data/test/system/workarea/storefront/review_system_test.rb

@@ -0,0 +1,113 @@
+require 'test_helper'
+
+module Workarea
+  module Storefront
+    class ReviewSystemTest < Workarea::SystemTest
+      def product
+        @product ||= create_product(name: 'Test')
+      end
+
+      def test_showing_reviews_on_browse_page
+        create_review(product_id: product.id, rating: 4)
+        category = create_category(product_ids: [product.id])
+
+        visit storefront.category_path(category)
+        assert_includes(page.html, '4.0 out of 5 stars')
+      end
+
+      def test_showing_reviews_on_search_results
+        create_product(name: 'Another Test')
+        create_review(product_id: product.id, rating: 4)
+
+        visit storefront.search_path(q: 'test')
+        assert_includes(page.html, '4.0 out of 5 stars')
+      end
+
+      def test_showing_reviews_on_a_product_detail_page
+        create_review(product_id: product.id, rating: 3)
+        create_review(
+          product_id: product.id,
+          rating: 3,
+          title: 'Integration Review First'
+        )
+        create_review(
+          product_id: product.id,
+          rating: 3,
+          title: 'Integration Review Second'
+        )
+
+        visit storefront.product_path(product)
+
+        assert_includes(page.html, '3.0')
+        assert(page.has_content?('(3)'))
+        assert(
+          page.has_ordered_text?(
+            'Integration Review Second',
+            'Integration Review First'
+          )
+        )
+      end
+
+      def test_showing_review_from_verified_purchaser
+        create_review(
+          product_id: product.id,
+          rating: 3,
+          title: 'Integration Review',
+          verified: true
+        )
+
+        visit storefront.product_path(product)
+        assert(page.has_content?('Integration Review'))
+        assert(page.has_content?(t('workarea.storefront.reviews.verified_purchaser')))
+      end
+
+      def test_writing_a_product_review
+        create_user(
+          email: 'test@workarea.com',
+          password: 'w3bl1nc',
+          name: 'Ben Crouse'
+        )
+
+        visit storefront.login_path
+
+        within '#login_form' do
+          fill_in 'email', with: 'test@workarea.com'
+          fill_in 'password', with: 'w3bl1nc'
+          click_button 'login'
+        end
+
+        visit storefront.product_path(product)
+        click_link 'Write a Review'
+
+        within '#review_form' do
+          # svg blocks input
+          execute_script("$('#review_rating_4').trigger('click')")
+          fill_in 'review[title]', with: 'Pretty decent product'
+          fill_in 'review[body]', with: 'It works well.'
+          click_button 'submit_review'
+        end
+
+        assert(page.has_content?('Success'))
+        assert_no_selector('#review_form')
+      end
+
+      def test_writing_a_product_review_as_a_guest
+        visit storefront.product_path(product)
+        click_link 'Write a Review'
+
+        within '#review_form' do
+          # svg blocks input
+          execute_script("$('#review_rating_4').trigger('click')")
+          fill_in 'review[title]', with: 'Pretty decent product'
+          fill_in 'review[body]', with: 'It works well.'
+          fill_in 'review[first_name]', with: 'Ben'
+          fill_in 'review[last_name]', with: 'Crouse'
+          click_button 'submit_review'
+        end
+
+        assert(page.has_content?('Success'))
+        assert_no_selector('#review_form')
+      end
+    end
+  end
+end

data/test/teaspoon_env.rb

@@ -0,0 +1,10 @@
+require 'workarea/testing/teaspoon'
+
+Teaspoon.configure do |config|
+  config.root = Workarea::Reviews::Engine.root
+  Workarea::Teaspoon.apply(config)
+
+  config.suite do |suite|
+    suite.stylesheets += ['workarea/storefront/application']
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,11 @@
+# Configure Rails Environment
+ENV['RAILS_ENV'] = 'test'
+
+require File.expand_path('../../test/dummy/config/environment.rb', __FILE__)
+require 'rails/test_help'
+require 'workarea/test_help'
+require 'factories/reviews'
+
+# Filter out Minitest backtrace while allowing backtrace from other libraries
+# to be shown.
+Minitest.backtrace_filter = Minitest::BacktraceFilter.new

data/test/workers/workarea/create_review_requests_test.rb

@@ -0,0 +1,38 @@
+require 'test_helper'
+
+module Workarea
+  class CreateReviewRequestsTest < TestCase
+    def test_perform
+      product_one = create_product(variants: [{ sku: 'SKU1', regular: 5.to_m }])
+      product_two = create_product(variants: [{ sku: 'SKU2', regular: 10.to_m }])
+      product_three = create_product(variants: [{ sku: 'SKU3', regular: 15.to_m }])
+      product_four = create_product(variants: [{ sku: 'SKU4', regular: 20.to_m }, { sku: 'SKU5', regular: 25.to_m }])
+
+      user = create_user(first_name: 'Robert', last_name: 'Clams')
+      order = create_order(
+        user_id: user.id,
+        email: user.email,
+        items: [
+          { product_id: product_one.id, sku: 'SKU1', quantity: 20 },
+          { product_id: product_two.id, sku: 'SKU2', quantity: 2 },
+          { product_id: product_three.id, sku: 'SKU3', quantity: 1 },
+          { product_id: product_four.id, sku: 'SKU4', quantity: 1 },
+          { product_id: product_four.id, sku: 'SKU5', quantity: 1 }
+        ]
+      )
+
+      Sidekiq::Callbacks.disable(CreateReviewRequests) do
+        complete_checkout(order)
+      end
+
+      assert_equal(0, Review::Request.count)
+      CreateReviewRequests.new.perform(order.id)
+      assert_equal(3, Review::Request.count)
+
+      requests = Review::Request.all
+      assert_includes(requests.map(&:product_id), product_four.id.to_s)
+      assert_includes(requests.map(&:product_id), product_three.id.to_s)
+      assert_includes(requests.map(&:product_id), product_two.id.to_s)
+    end
+  end
+end

data/test/workers/workarea/schedule_review_requests_test.rb

@@ -0,0 +1,115 @@
+require 'test_helper'
+
+module Workarea
+  class ScheduleReviewRequestsTest < TestCase
+    setup :order, :requests
+
+    def order
+      @order ||= create_order(
+        items: [
+          { product_id: 'PROD1', sku: 'SKU1', quantity: 1 },
+          { product_id: 'PROD2', sku: 'SKU2', quantity: 1 },
+          { product_id: 'PROD3', sku: 'SKU3', quantity: 1 }
+        ]
+      )
+    end
+
+    def requests
+      @requests ||= [
+        create_review_request(order_id: order.id, product_id: 'PROD1', send_after: nil),
+        create_review_request(order_id: order.id, product_id: 'PROD2', send_after: nil),
+        create_review_request(order_id: order.id, product_id: 'PROD3', send_after: nil)
+      ]
+    end
+
+    def test_perform
+      travel(3.days) do
+        ScheduleReviewRequests.new.perform(
+          order.id,
+          [
+            { 'id' => order.items.first.id.to_s },
+            { 'id' => order.items.second.id.to_s },
+            { 'id' => order.items.third.id.to_s }
+          ]
+        )
+
+        requests.map(&:reload)
+        assert(requests.all?(&:send_after))
+
+        sorted_requests = requests.sort_by(&:send_after)
+
+        assert_equal(
+          Time.current + Workarea.config.review_request_initial_delivery_delay,
+          sorted_requests.first.send_after
+        )
+
+        assert_equal(
+          sorted_requests.first.send_after + Workarea.config.review_request_secondary_delivery_delay,
+          sorted_requests.second.send_after
+        )
+
+        assert_equal(
+          sorted_requests.second.send_after + Workarea.config.review_request_secondary_delivery_delay,
+          sorted_requests.third.send_after
+        )
+      end
+    end
+
+    def test_perform_with_partial_shipments
+      travel_to(3.days.from_now.beginning_of_day) do
+        ScheduleReviewRequests.new.perform(
+          order.id,
+          [
+            { 'id' => order.items.first.id.to_s },
+            { 'id' => order.items.third.id.to_s }
+          ]
+        )
+
+        requests.map(&:reload)
+        assert_equal(2, requests.select(&:send_after).size)
+
+        sorted_requests = requests.select(&:send_after).sort_by(&:send_after)
+
+        assert_equal(
+          Time.current + Workarea.config.review_request_initial_delivery_delay,
+          sorted_requests.first.send_after
+        )
+
+        assert_equal(
+          sorted_requests.first.send_after + Workarea.config.review_request_secondary_delivery_delay,
+          sorted_requests.second.send_after
+        )
+      end
+
+      travel_to(5.days.from_now.beginning_of_day) do
+        ScheduleReviewRequests.new.perform(
+          order.id,
+          [
+            { 'id' => order.items.first.id.to_s },
+            { 'id' => order.items.second.id.to_s }
+          ]
+        )
+
+        requests.map(&:reload)
+        assert(requests.all?(&:send_after))
+
+        sorted_requests = requests.sort_by(&:send_after)
+
+        assert_equal(
+          2.days.ago + Workarea.config.review_request_initial_delivery_delay,
+          sorted_requests.first.send_after
+        )
+
+        assert_equal(
+          sorted_requests.first.send_after + Workarea.config.review_request_secondary_delivery_delay,
+          sorted_requests.second.send_after
+        )
+
+        assert_equal(
+          sorted_requests.second.send_after + Workarea.config.review_request_secondary_delivery_delay,
+          sorted_requests.third.send_after
+        )
+      end
+    end
+  end
+end

data/test/workers/workarea/send_review_requests_test.rb

@@ -0,0 +1,30 @@
+require 'test_helper'
+
+module Workarea
+  class SendReviewRequestsTest < TestCase
+    include TestCase::Mail
+
+    def test_perform
+      product = create_product(name: 'Foobar Product')
+
+      requests = Array.new(3) { create_review_request(product_id: product.id) }
+      create_review_request(product_id: product.id, send_after: 1.week.from_now)
+      create_review_request(product_id: product.id, send_after: Time.current, canceled_at: Time.current)
+
+      SendReviewRequests.new.perform
+
+      requests.each(&:reload)
+      assert(requests.all?(&:sent?))
+
+      assert_equal(3, ActionMailer::Base.deliveries.size)
+
+      email = ActionMailer::Base.deliveries.last
+      assert_includes(email.to, 'test@workarea.com')
+      assert_includes(email.subject, product.name)
+      assert_includes(
+        email.parts.second.body,
+        t('workarea.storefront.email.review_request.link')
+      )
+    end
+  end
+end

data/workarea-reviews.gemspec

@@ -0,0 +1,22 @@
+$:.push File.expand_path('../lib', __FILE__)
+
+require 'workarea/reviews/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'workarea-reviews'
+  s.version     = Workarea::Reviews::VERSION
+  s.authors     = ['Ben Crouse']
+  s.email       = ['bcrouse@workarea.com']
+  s.homepage    = 'https://github.com/workarea-commerce/workarea-reviews'
+  s.summary     = 'Reviews plugin for the Workarea ecommerce platform'
+  s.description = 'Plugin for product reviews on the Workarea ecommerce platform'
+
+  s.files = `git ls-files`.split("\n")
+
+  s.license = 'Business Software License'
+
+  s.required_ruby_version = '>= 2.3.0'
+
+  s.add_dependency 'workarea', '~> 3.x', '>= 3.3.x'
+  s.add_dependency 'recaptcha', '~> 4.3.1'
+end