workarea-reviews 3.0.10

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

metadata

@@ -0,0 +1,241 @@
+--- !ruby/object:Gem::Specification
+name: workarea-reviews
+version: !ruby/object:Gem::Version
+  version: 3.0.10
+platform: ruby
+authors:
+- Ben Crouse
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-10-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: workarea
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.x
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.x
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.x
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.x
+- !ruby/object:Gem::Dependency
+  name: recaptcha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.3.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.3.1
+description: Plugin for product reviews on the Workarea ecommerce platform
+email:
+- bcrouse@workarea.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".eslintignore"
+- ".eslintrc"
+- ".github/ISSUE_TEMPLATE/bug_report.md"
+- ".github/ISSUE_TEMPLATE/documentation-request.md"
+- ".github/ISSUE_TEMPLATE/feature_request.md"
+- ".gitignore"
+- ".scss-lint.yml"
+- ".yardopts"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- app/assets/images/workarea/admin/icons/star.svg
+- app/assets/images/workarea/storefront/icons/empty_star.svg
+- app/assets/images/workarea/storefront/icons/half_star.svg
+- app/assets/images/workarea/storefront/icons/star.svg
+- app/assets/javascripts/workarea/storefront/reviews/modules/product_review_ajax_submit.js
+- app/assets/javascripts/workarea/storefront/reviews/modules/product_reviews_sort_menus.js
+- app/assets/javascripts/workarea/storefront/reviews/modules/rating_buttons.js
+- app/assets/javascripts/workarea/storefront/reviews/templates/sort_by_property.jst.ejs
+- app/assets/stylesheets/workarea/storefront/reviews/components/_rating.scss
+- app/assets/stylesheets/workarea/storefront/reviews/components/_reviews.scss
+- app/assets/stylesheets/workarea/storefront/reviews/components/_reviews_aggregate.scss
+- app/assets/stylesheets/workarea/storefront/reviews/components/_write_review.scss
+- app/controllers/workarea/admin/catalog_products_controller.decorator
+- app/controllers/workarea/admin/import_reviews_controller.rb
+- app/controllers/workarea/admin/reviews_controller.rb
+- app/controllers/workarea/storefront/review_requests_controller.rb
+- app/controllers/workarea/storefront/reviews_controller.rb
+- app/helpers/workarea/admin/reviews_helper.rb
+- app/helpers/workarea/storefront/reviews_helper.rb
+- app/mailers/workarea/admin/status_report_mailer.decorator
+- app/mailers/workarea/storefront/review_mailer.rb
+- app/models/workarea/catalog/product.decorator
+- app/models/workarea/fulfillment.decorator
+- app/models/workarea/review.rb
+- app/models/workarea/review/request.rb
+- app/models/workarea/search/admin/review.rb
+- app/models/workarea/search/storefront/product.decorator
+- app/models/workarea/sort.decorator
+- app/queries/workarea/review_request_params.rb
+- app/queries/workarea/review_summary.rb
+- app/queries/workarea/search/admin_reviews.rb
+- app/queries/workarea/search/category_browse.decorator
+- app/queries/workarea/search/product_search.decorator
+- app/seeds/review_seeds.rb
+- app/services/workarea/create_review.rb
+- app/view_models/workarea/admin/product_view_model.decorator
+- app/view_models/workarea/admin/review_view_model.rb
+- app/view_models/workarea/admin/reviews_search_view_model.rb
+- app/view_models/workarea/storefront/product_view_model.decorator
+- app/view_models/workarea/storefront/review_view_model.rb
+- app/views/workarea/admin/activities/_review_create.html.haml
+- app/views/workarea/admin/activities/_review_destroy.html.haml
+- app/views/workarea/admin/activities/_review_update.html.haml
+- app/views/workarea/admin/reviews/_aux_navigation.html.haml
+- app/views/workarea/admin/reviews/_catalog_products_aux_link.html.haml
+- app/views/workarea/admin/reviews/_dashboard_navigation.html.haml
+- app/views/workarea/admin/reviews/_menu.html.haml
+- app/views/workarea/admin/reviews/_summary.html.haml
+- app/views/workarea/admin/reviews/edit.html.haml
+- app/views/workarea/admin/reviews/index.html.haml
+- app/views/workarea/admin/status_report_mailer/_reviews.html.haml
+- app/views/workarea/storefront/products/_rating.html.haml
+- app/views/workarea/storefront/products/_reviews.html.haml
+- app/views/workarea/storefront/products/_reviews_aggregate.html.haml
+- app/views/workarea/storefront/products/_reviews_summary.html.haml
+- app/views/workarea/storefront/review_mailer/review_request.html.haml
+- app/views/workarea/storefront/review_requests/show.html.haml
+- app/views/workarea/storefront/reviews/new.html.haml
+- app/views/workarea/storefront/style_guides/_reviews_product_summary_docs.html.haml
+- app/views/workarea/storefront/style_guides/components/_reviews.html.haml
+- app/workers/workarea/create_review_requests.rb
+- app/workers/workarea/schedule_review_requests.rb
+- app/workers/workarea/send_review_requests.rb
+- app/workers/workarea/update_product_review_data.rb
+- bin/rails
+- config/initializers/append_points.rb
+- config/initializers/assets.rb
+- config/initializers/configuration.rb
+- config/initializers/rack_attack.rb
+- config/initializers/recaptcha.rb
+- config/initializers/scheduled_jobs.rb
+- config/locales/en.yml
+- config/routes.rb
+- lib/tasks/verify.rake
+- lib/workarea/mailer_previews/storefront/review_mailer_preview.rb
+- lib/workarea/reviews.rb
+- lib/workarea/reviews/engine.rb
+- lib/workarea/reviews/version.rb
+- test/dummy/Rakefile
+- test/dummy/app/assets/config/manifest.js
+- test/dummy/app/assets/images/.keep
+- test/dummy/app/assets/javascripts/application.js
+- test/dummy/app/assets/stylesheets/application.css
+- test/dummy/app/controllers/application_controller.rb
+- test/dummy/app/controllers/concerns/.keep
+- test/dummy/app/helpers/application_helper.rb
+- test/dummy/app/jobs/application_job.rb
+- test/dummy/app/mailers/application_mailer.rb
+- test/dummy/app/models/concerns/.keep
+- test/dummy/app/views/layouts/application.html.erb
+- test/dummy/app/views/layouts/mailer.html.erb
+- test/dummy/app/views/layouts/mailer.text.erb
+- test/dummy/bin/bundle
+- test/dummy/bin/rails
+- test/dummy/bin/rake
+- test/dummy/bin/setup
+- test/dummy/bin/update
+- test/dummy/config.ru
+- test/dummy/config/application.rb
+- test/dummy/config/boot.rb
+- test/dummy/config/cable.yml
+- test/dummy/config/environment.rb
+- test/dummy/config/environments/development.rb
+- test/dummy/config/environments/production.rb
+- test/dummy/config/environments/test.rb
+- test/dummy/config/initializers/application_controller_renderer.rb
+- test/dummy/config/initializers/assets.rb
+- test/dummy/config/initializers/backtrace_silencers.rb
+- test/dummy/config/initializers/cookies_serializer.rb
+- test/dummy/config/initializers/filter_parameter_logging.rb
+- test/dummy/config/initializers/inflections.rb
+- test/dummy/config/initializers/mime_types.rb
+- test/dummy/config/initializers/new_framework_defaults.rb
+- test/dummy/config/initializers/session_store.rb
+- test/dummy/config/initializers/workarea.rb
+- test/dummy/config/initializers/wrap_parameters.rb
+- test/dummy/config/locales/en.yml
+- test/dummy/config/puma.rb
+- test/dummy/config/routes.rb
+- test/dummy/config/secrets.yml
+- test/dummy/config/spring.rb
+- test/dummy/db/seeds.rb
+- test/dummy/lib/assets/.keep
+- test/dummy/log/.keep
+- test/factories/reviews.rb
+- test/fixtures/reviews.csv
+- test/helpers/workarea/admin/reviews_helper_test.rb
+- test/helpers/workarea/storefront/reviews_helper_test.rb
+- test/integration/workarea/admin/reviews_integration_test.rb
+- test/integration/workarea/storefront/review_requests_integration_test.rb
+- test/integration/workarea/storefront/reviews_integration_test.rb
+- test/javascripts/fixtures/product_review_ajax_submit.html.haml
+- test/javascripts/product_review_ajax_submit_spec.js
+- test/javascripts/spec_helper.js
+- test/models/workarea/review/request_test.rb
+- test/models/workarea/review_test.rb
+- test/models/workarea/search/storefront/product_test.decorator
+- test/queries/workarea/review_request_params_test.rb
+- test/services/workarea/create_review_test.rb
+- test/system/workarea/admin/review_system_test.rb
+- test/system/workarea/storefront/review_request_system_test.rb
+- test/system/workarea/storefront/review_system_test.rb
+- test/teaspoon_env.rb
+- test/test_helper.rb
+- test/workers/workarea/create_review_requests_test.rb
+- test/workers/workarea/schedule_review_requests_test.rb
+- test/workers/workarea/send_review_requests_test.rb
+- workarea-reviews.gemspec
+homepage: https://github.com/workarea-commerce/workarea-reviews
+licenses:
+- Business Software License
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: Reviews plugin for the Workarea ecommerce platform
+test_files: []