workarea-reviews 3.1.0

data/config/initializers/assets.rb

@@ -0,0 +1 @@
+Rails.application.config.assets.precompile += %w( workarea/**/icons/*.svg )

data/config/initializers/configuration.rb

@@ -0,0 +1,31 @@
+Workarea.configure do |config|
+  config.seeds.insert('Workarea::InsightsSeeds', 'Workarea::ReviewSeeds')
+
+  config.jump_to_navigation.merge!('Product Reviews' => :reviews_path)
+
+  config.product_copy_default_attributes ||= {}
+  config.product_copy_default_attributes.merge!(
+    total_reviews: 0,
+    average_rating: nil
+  )
+
+  config.data_file_ignored_fields << %w(total_reviews average_rating)
+
+  config.insights_model_classes << 'Workarea::User'
+
+  # The amount of time before a Review::Request will auto expire
+  # and be removed from the collection
+  config.review_request_ttl = 6.months
+
+  # The maximum number of review requests to send for each order
+  # Each request will be for a different order item, selected by
+  # most expensive.
+  config.review_requests_per_order = 3
+
+  # The amount of time after an order is shipped before the first review
+  # requests will be sent.
+  config.review_request_initial_delivery_delay = 14.days
+
+  # The amount of time after the last request was sent to send another.
+  config.review_request_secondary_delivery_delay = 5.days
+end

data/config/initializers/rack_attack.rb

@@ -0,0 +1,11 @@
+class Rack::Attack
+  # Throttle POST requests to /reviews by email address
+  #
+  # Key: "rack::attack:#{Time.now.to_i/:period}:reviews/email:#{req.email}"
+  throttle('reviews/email', limit: 2, period: 2.minutes) do |req|
+    if req.path == '/reviews' && req.post?
+      # return the email if present, nil otherwise
+      req.params['email'].presence
+    end
+  end
+end

data/config/initializers/recaptcha.rb

@@ -0,0 +1,19 @@
+recaptcha =
+  if Rails.application.secrets.recaptcha.present?
+    Rails.application.secrets.recaptcha.symbolize_keys
+  elsif Rails.env.development? || Rails.env.test?
+    # These are keys provided by google for the purpose of testing.
+    # See https://developers.google.com/recaptcha/docs/faq
+    {
+      site_key: '6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI',
+      secret_key: '6LeIxAcTAAAAAGG-vFI1TnRWxMZNFuojJ4WifJWe'
+    }
+  end
+
+if recaptcha.present?
+  Recaptcha.configure do |config|
+    config.site_key = recaptcha[:site_key]
+    config.secret_key = recaptcha[:secret_key]
+    config.proxy = ENV.fetch('HTTP_PROXY', (recaptcha[:proxy] if recaptcha[:proxy].present?))
+  end
+end

data/config/initializers/scheduled_jobs.rb

@@ -0,0 +1,8 @@
+unless Workarea.config.skip_service_connections
+  Sidekiq::Cron::Job.create(
+    name: 'Workarea::SendReviewRequests',
+    klass: 'Workarea::SendReviewRequests',
+    cron: "0 0 * * * #{Time.zone.tzinfo.identifier}",
+    queue: 'low'
+  )
+end

data/config/locales/en.yml

@@ -0,0 +1,150 @@
+en:
+  workarea:
+    admin:
+      activities:
+        review: Review
+        review_create_html: Created a %{name}
+        review_destroy_html: Removed a %{name}
+        review_update_html: updated %{fields} on the %{name} review
+      catalog:
+        dashboard_link: Dashboard link
+      catalog_products:
+        reviews_link: All Reviews
+        pending: (%{pending} Pending)
+      dashboards:
+        marketing:
+          reviews: Product reviews
+      fields:
+        average_rating: Average Rating
+        body: Body
+        title: Title
+        rating: Rating
+        reviews: Reviews
+        approved: Approved
+        auto_approve: Approve All Reviews
+        verified: Verified Purchaser
+        verified_reviews: Verified
+        weighted_average_rating: Weighted Average Rating
+      insights:
+        most_active_reviewers:
+          info: Your customers that are submitting the most reviews.
+          reviews: Reviews
+          title: Most Active Reviewers
+          user: User
+          verified: Verified Reviews
+        most_reviewed_products:
+          title: Most Reviewed Products
+          info: Your products that have received the most reviews.
+          reviews:
+            one: '%{count} Review'
+            other: '%{count} Reviews'
+        top_rated_products:
+          title: Top Rated Products
+          info: Your products with the highest weighted average rating.
+          rating: '%{rating} Rating'
+      reports:
+        reference:
+          terms:
+            average_rating:
+              name: Average Rating
+              description: The sum of all review ratings divided by the total number of reviews.
+            reviews:
+              name: Reviews
+              description: The total number of reviews.
+            verified:
+              name: Verified
+              description: The total number of reviews made by customers who have purchased the product.
+            weighted_average_rating:
+              name: Weighted Average Rating
+              description: A base rating of 3.0, adjusted up or down by each review rating.
+        reviews_by_product:
+          filters:
+            all: All Reviews
+            approved: Approved Reviews
+            unapproved: Unapproved Reviews
+          results_filter: Results Filter
+          title: Reviews By Product
+      reviews:
+        approved: Approved
+        catalog_products_cards:
+          title: Reviews
+        edit:
+          review: Review
+          review_for_html: Review for %{product_link}
+          save_review: Save Review
+          title: Title
+          view_product: View Product
+          view_user: View User
+        flash_messages:
+          destroyed: Review has been removed.
+          updated: Review has been saved
+        index:
+          dashboard_link: Marketing dashboard
+          heading: Reviews
+          page_title: Reviews
+          review: Review
+          review_for: Review for %{product}
+        menu:
+          product_reviews:
+            one: Product Reviews (%{count})
+            other: Product Reviews (%{count})
+            zero: Product Reviews
+        pending: Pending
+        summary:
+          type: Review
+        unverified: Unverified
+        verified: Verified
+      status_report_mailer:
+        reviews:
+          pending_html: "%{count} awaiting approval."
+          review: review
+          recent_html: "%{count} submitted within the last day."
+          title: Reviews
+    sorts:
+      top_rated: Top Rated
+      highest_rating: Highest Rating
+      lowest_rating: Lowest Rating
+    storefront:
+      email:
+        review_request:
+          subject: Review your recent purchase of %{product}
+          link: Write a review
+          email_action:
+            name: Write Review
+            description: Please review your recent purchase
+      fields:
+        username: Username
+      review_requests:
+        flash_messages:
+          already_submitted: This review has already been submitted.
+      reviews:
+        flash_messages:
+          created: Your review has been submitted. Thanks!
+          failure: There was a problem saving your review.
+        heading: Reviews
+        out_of: out of
+        purchase_requirement: A purchase is required before you can post a review
+        rating: Rating
+        read_reviews: Read Reviews
+        review_for: Review for %{product}
+        review_title: Review Title
+        reviews:
+          one: "%{count} review"
+          other: "%{count} reviews"
+          zero: "%{count} reviews"
+        stars:
+          one: 1 star
+          other: "%{count} stars"
+        submit: Submit Review
+        submit_disabled: Submitting Review...
+        total_spent_validation: must make a purchase before creating a review
+        verified_purchaser: Verified Purchaser
+        write_a_review: Write a Review
+        write_a_review_title: Write a Review for "%{name}"
+        your_review: Your Review
+        notes:
+          display_name: Only the first letter of your name will be displayed.
+          email: Will only be used if we need to get in touch with you.
+      users:
+        first_name: First name
+        last_name: Last name

data/config/routes.rb

@@ -0,0 +1,25 @@
+Workarea::Admin::Engine.routes.draw do
+  scope '(:locale)', constraints: Workarea::I18n.routes_constraint do
+    resources :reviews, except: [:new, :create]
+    resources :catalog_products, only: [] do
+      member do
+        get :reviews
+      end
+    end
+
+    resource :report, only: [] do
+      get :reviews_by_product
+    end
+  end
+end
+
+Workarea::Storefront::Engine.routes.draw do
+  scope '(:locale)', constraints: Workarea::I18n.routes_constraint do
+    get 'reviews/:product_id/new' => 'reviews#new', as: :new_product_review
+    post 'reviews/:product_id' => 'reviews#create', as: :create_product_review
+
+    resources :review_requests, only: :show do
+      member { post :complete }
+    end
+  end
+end

data/lib/tasks/verify.rake

@@ -0,0 +1,16 @@
+namespace :workarea do
+  namespace :reviews do
+    desc 'Assign verified to each review based on whether the user has any orders with the product being reviewed'
+    task verify: :environment do
+      Workarea::Review.all.each_by(100) do |review|
+        user = Workarea::User.find(review.user_id) rescue nil
+
+        next unless user.present?
+
+        creator = Workarea::CreateReview.new(review, user: user)
+
+        review.update!(verified: creator.verified?)
+      end
+    end
+  end
+end

data/lib/workarea/mailer_previews/storefront/review_mailer_preview.rb

@@ -0,0 +1,10 @@
+module Workarea
+  module Storefront
+    class ReviewMailerPreview < ActionMailer::Preview
+      def review_request
+        request = Review::Request.ready_to_send.first || Review::Request.first
+        ReviewMailer.review_request(request.id.to_s)
+      end
+    end
+  end
+end

data/lib/workarea/reviews.rb

@@ -0,0 +1,13 @@
+require 'workarea'
+require 'workarea/storefront'
+require 'workarea/admin'
+
+require 'recaptcha/rails'
+
+module Workarea
+  module Reviews
+  end
+end
+
+require 'workarea/reviews/version'
+require 'workarea/reviews/engine'

data/lib/workarea/reviews/engine.rb

@@ -0,0 +1,16 @@
+module Workarea
+  module Reviews
+    class Engine < ::Rails::Engine
+      include Workarea::Plugin
+      isolate_namespace Workarea::Reviews
+
+      config.to_prepare do
+        Admin::ApplicationController.helper(Admin::ReviewsHelper)
+        Storefront::ApplicationController.helper(Storefront::ReviewsHelper)
+        Workarea::Storefront::ApplicationController.helper(
+          Workarea::Storefront::ReviewsSchemaOrgHelper
+        )
+      end
+    end
+  end
+end

data/lib/workarea/reviews/version.rb

@@ -0,0 +1,5 @@
+module Workarea
+  module Reviews
+    VERSION = '3.1.0'.freeze
+  end
+end

data/package.json

@@ -0,0 +1,9 @@
+{
+  "devDependencies": {
+    "eslint": "~5.16.0",
+    "eslint-config-recommended": "~4.0.0",
+    "stylelint": "~10.1.0",
+    "stylelint-config-recommended-scss": "~3.3.0",
+    "stylelint-scss": "~3.9.2"
+  }
+}

data/test/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require_relative 'config/application'
+
+Rails.application.load_tasks

data/test/dummy/app/assets/config/manifest.js

@@ -0,0 +1,4 @@
+
+//= link_tree ../images
+//= link_directory ../javascripts .js
+//= link_directory ../stylesheets .css

data/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file. JavaScript code in this file should be added after the last require_* statement.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery with: :exception
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/test/dummy/app/jobs/application_job.rb

@@ -0,0 +1,2 @@
+class ApplicationJob < ActiveJob::Base
+end

data/test/dummy/app/mailers/application_mailer.rb

@@ -0,0 +1,4 @@
+class ApplicationMailer < ActionMailer::Base
+  default from: 'from@example.com'
+  layout 'mailer'
+end

data/test/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Dummy</title>
+    <%= csrf_meta_tags %>
+
+    <%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track': 'reload' %>
+    <%= javascript_include_tag 'application', 'data-turbolinks-track': 'reload' %>
+  </head>
+
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/test/dummy/app/views/layouts/mailer.html.erb

@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    <style>
+      /* Email styles need to be inline */
+    </style>
+  </head>
+
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/test/dummy/app/views/layouts/mailer.text.erb

@@ -0,0 +1 @@
+<%= yield %>

data/test/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/test/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../config/application', __dir__)
+require_relative '../config/boot'
+require 'rails/commands'