workarea-reviews 3.0.8

data/app/views/workarea/storefront/review_requests/show.html.haml

@@ -0,0 +1,44 @@
+- @title = t('workarea.storefront.reviews.write_a_review_title', name: @product.browser_title)
+
+.write-review.view
+  %h1= t('workarea.storefront.reviews.write_a_review_title', name: @product.name)
+
+  .grid
+    .grid__cell.grid__cell--25
+      .product-summary{ itemscope: true, itemtype: 'http://schema.org/Product' }
+        = render 'workarea/storefront/products/summary', product: @product
+
+    .grid__cell.grid__cell--75
+      - unless request.get?
+        - if @review.errors.any?
+          - @review.errors.full_messages.each do |message|
+            = render_message 'error', message, data: { analytics: validation_error_analytics_data('review').to_json }
+
+      = form_tag complete_review_request_path(@request.token), method: 'post', id: 'review_request_form' do
+        .property
+          = label_tag 'review[rating]', nil, class: 'property__name' do
+            %span.property__text= t('workarea.storefront.reviews.rating')
+          %ul.write-review__ratings
+            - (1..5).each do |i|
+              %li.write-review__rating
+                = radio_button_tag 'review[rating]', i, (i == @review.rating || i == 5) ? true : false, class: 'write-review__rating-input', data: { rating_button: '' }
+                = label_tag "review[rating][#{i}]", nil, class: 'write-review__star' do
+                  = inline_svg 'workarea/storefront/icons/star.svg', class: 'write-review__star-icon', title: t('workarea.storefront.reviews.stars', count: i)
+
+        .property
+          = label_tag 'review[title]', nil, class: 'property__name' do
+            %span.property__text= t('workarea.storefront.reviews.review_title')
+            %span.property__requirement.property__requirement--optional= t('workarea.storefront.forms.optional')
+          .value= text_field_tag 'review[title]', @review.title, class: 'text-box'
+
+        .property
+          = label_tag 'review[body]', nil, class: 'property__name' do
+            %span.property__requirement.property__requirement--required= t('workarea.storefront.forms.required')
+            %span.property__text= t('workarea.storefront.reviews.your_review')
+          .value= text_area_tag 'review[body]', @review.body, class: 'text-box text-box--multi-line', required: true
+
+        .property= recaptcha_tags
+
+        .grid.grid--auto
+          %p.grid__cell= button_tag t('workarea.storefront.reviews.submit'), value: 'submit_review', class: 'button', data: { disable_with: loading_indicator(t('workarea.storefront.reviews.submit_disabled')) }
+          %p.grid__cell= link_to t('workarea.storefront.forms.cancel'), product_path(@product), class: 'text-button', data: { dialog_close_button: '' }

data/app/views/workarea/storefront/reviews/new.html.haml

@@ -0,0 +1,68 @@
+- @title = t('workarea.storefront.reviews.write_a_review_title', name: @product.browser_title)
+
+.write-review.view
+  %h1= t('workarea.storefront.reviews.write_a_review_title', name: @product.browser_title)
+
+  - unless request.get?
+    - if @create_review.errors.any?
+      - @create_review.errors.full_messages.each do |message|
+        = render_message 'error', message, data: { analytics: validation_error_analytics_data('review').to_json }
+
+  = form_tag create_product_review_path(@product), method: 'post', id: 'review_form', data: { product_review_ajax_submit: '' } do
+    = hidden_field_tag 'review[product_id]', @product.id
+
+    - if display_purchase_requirement_message
+      %span.write-review__purchase-requirement= t('workarea.storefront.reviews.purchase_requirement')
+
+    - if @review.requires_public_info?
+      .property
+        = label_tag 'review[first_name]', nil, class: 'property__name' do
+          %span.property__requirement.property__requirement--required= t('workarea.storefront.forms.required')
+          %span.property__text= t('workarea.storefront.users.first_name')
+        .value
+          = text_field_tag 'review[first_name]', @review.first_name, class: 'text-box', required: true
+          .value__note= t('workarea.storefront.reviews.notes.display_name')
+      .property
+        = label_tag 'review[last_name]', nil, class: 'property__name' do
+          %span.property__requirement.property__requirement--required= t('workarea.storefront.forms.required')
+          %span.property__text= t('workarea.storefront.users.last_name')
+        .value
+          = text_field_tag 'review[last_name]', @review.last_name, class: 'text-box', required: true
+          .value__note= t('workarea.storefront.reviews.notes.display_name')
+
+    - if @review.anonymous?
+      .property
+        = label_tag 'review[email]', nil, class: 'property__name' do
+          %span.property__text= t('workarea.storefront.users.email')
+          %span.property__requirement.property__requirement--optional= t('workarea.storefront.forms.optional')
+        .value
+          = email_field_tag 'review[email]', @review.email, class: 'text-box', autocapitalize: 'off', autocorrect: 'off', autocomplete: 'email'
+          .value__note= t('workarea.storefront.reviews.notes.email')
+
+    .property
+      = label_tag 'review[rating]', nil, class: 'property__name' do
+        %span.property__text= t('workarea.storefront.reviews.rating')
+      %ul.write-review__ratings
+        - (1..5).each do |i|
+          %li.write-review__rating
+            = radio_button_tag 'review[rating]', i, (i == @review.rating || i == 5) ? true : false, class: 'write-review__rating-input', data: { rating_button: '' }
+            = label_tag "review[rating][#{i}]", nil, class: 'write-review__star' do
+              = inline_svg 'workarea/storefront/icons/star.svg', class: 'write-review__star-icon', title: t('workarea.storefront.reviews.stars', count: i)
+
+    .property
+      = label_tag 'review[title]', nil, class: 'property__name' do
+        %span.property__text= t('workarea.storefront.reviews.review_title')
+        %span.property__requirement.property__requirement--optional= t('workarea.storefront.forms.optional')
+      .value= text_field_tag 'review[title]', @review.title, class: 'text-box'
+
+    .property
+      = label_tag 'review[body]', nil, class: 'property__name' do
+        %span.property__requirement.property__requirement--required= t('workarea.storefront.forms.required')
+        %span.property__text= t('workarea.storefront.reviews.your_review')
+      .value= text_area_tag 'review[body]', @review.body, class: 'text-box text-box--multi-line', required: true
+
+    .property= recaptcha_tags
+
+    .grid.grid--auto
+      %p.grid__cell= button_tag t('workarea.storefront.reviews.submit'), value: 'submit_review', class: 'button', data: { disable_with: loading_indicator(t('workarea.storefront.reviews.submit_disabled')) }
+      %p.grid__cell= link_to t('workarea.storefront.forms.cancel'), product_path(@product), class: 'text-button', data: { dialog_close_button: '' }

data/app/views/workarea/storefront/style_guides/_reviews_product_summary_docs.html.haml

@@ -0,0 +1,13 @@
+%p With reviews:
+.style-guide__example-block
+  .product-summary
+    %p.product-summary__media
+      = link_to('#', class: 'product-summary__media-link') do
+        = image_tag('workarea/storefront/style_guide_product.jpg', alt: 'Product Name', class: 'product-summary__media-image')
+    .product-summary__info
+      %p.product-summary__name= link_to('Product Name', '#')
+      .product-summary__price-group
+        %p.product-summary__price
+          %span= number_to_currency(109.99)
+      = rating_stars(3.5, aggregate: true)
+    %p.product-summary__quickview= link_to('Quick View', '#', class: 'button button--small', rel: 'nofollow', data: { dialog_button: '' })

data/app/views/workarea/storefront/style_guides/components/_reviews.html.haml

@@ -0,0 +1,17 @@
+#rating.style-guide__subsection
+
+  %h3= link_to_style_guide('components', 'rating')
+
+  %p Displays a graphical rating scale for a numerical rating (1.0 - 5.0). Use the <code>rating_stars(rating, options = {})</code> helper to generate the rating stars.
+
+  %h4 Options
+  %ul
+    %li
+      <code>aggregate</code> (default: false)
+      %ul
+        %li Passing <code>aggregate: true</code> will change schema.org rating type from `reviewRating` to `aggregateRating` (an average rating from multiple reviews). See <a href="https://schema.org/AggregateRating">https://schema.org/AggregateRating</a> for more info.
+
+  - [1.5, 2.0, 3.75, 4.1, 4.8].each do |rating|
+    %p Example: rating of #{rating}
+    .style-guide__example-block
+      = rating_stars(rating, aggregate: true)

data/app/workers/workarea/create_review_requests.rb

@@ -0,0 +1,33 @@
+module Workarea
+  class CreateReviewRequests
+    include Sidekiq::Worker
+    include Sidekiq::CallbacksWorker
+
+    sidekiq_options(
+      enqueue_on: {
+        Order => :place,
+        only_if: -> { Workarea.config.send_transactional_emails }
+      },
+      queue: 'low'
+    )
+
+    def perform(order_id)
+      order = Order.find(order_id)
+      product_ids = order.items
+                         .sort_by(&:original_unit_price)
+                         .reverse
+                         .map(&:product_id)
+                         .uniq
+                         .take(Workarea.config.review_requests_per_order)
+
+      product_ids.each do |product_id|
+        Review::Request.create(
+          email: order.email,
+          order_id: order.id,
+          user_id: order.user_id,
+          product_id: product_id
+        )
+      end
+    end
+  end
+end

data/app/workers/workarea/schedule_review_requests.rb

@@ -0,0 +1,44 @@
+module Workarea
+  class ScheduleReviewRequests
+    include Sidekiq::Worker
+
+    sidekiq_options queue: 'low'
+
+    def perform(order_id, shipped_items)
+      requests = Review::Request.by_order(order_id).to_a
+      return if requests.all?(&:send_after)
+
+      order = Order.find(order_id)
+      product_ids =
+        shipped_items.map do |item|
+          order_item = order.items.detect { |i| i.id.to_s == item['id'] }
+          order_item&.product_id
+        end
+        .compact
+
+      schedule_requests(
+        requests.select { |request| request.product_id.in?(product_ids) },
+        requests
+      )
+    end
+
+    def schedule_requests(affected_requests, all_requests)
+      affected_requests.each do |request|
+        next if request.send_after.present?
+
+        last_scheduled =
+          all_requests.select(&:send_after).sort_by(&:send_after).last
+
+        date_to_send =
+          if last_scheduled.present?
+            last_scheduled.send_after +
+              Workarea.config.review_request_secondary_delivery_delay
+          else
+            Workarea.config.review_request_initial_delivery_delay.from_now
+          end
+
+        request.update_attributes(send_after: date_to_send)
+      end
+    end
+  end
+end

data/app/workers/workarea/send_review_requests.rb

@@ -0,0 +1,12 @@
+module Workarea
+  class SendReviewRequests
+    include Sidekiq::Worker
+
+    def perform
+      Review::Request.ready_to_send.each do |request|
+        Storefront::ReviewMailer.review_request(request).deliver_now
+        request.send!
+      end
+    end
+  end
+end

data/app/workers/workarea/update_product_review_data.rb

@@ -0,0 +1,26 @@
+module Workarea
+  class UpdateProductReviewData
+    include Sidekiq::Worker
+    include Sidekiq::CallbacksWorker
+
+    sidekiq_options(
+      enqueue_on: {
+        Workarea::Review => [:save, :destroy],
+        with: -> { [product_id] }
+      },
+      unique: :until_and_while_executing
+    )
+
+    def perform(product_id)
+      product = Workarea::Catalog::Product.find(product_id)
+      review_data = Review.find_single_aggregates(product_id)
+
+      product.update_attributes!(
+        total_reviews: review_data[:count],
+        average_rating: review_data[:average]
+      )
+    rescue Mongoid::Errors::DocumentNotFound
+      # we're ok if the product doesn't exist
+    end
+  end
+end

data/bin/rails

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails gems
+# installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('../..', __FILE__)
+ENGINE_PATH = File.expand_path('../../lib/workarea/reviews/engine', __FILE__)
+
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+
+require 'action_controller/railtie'
+require 'action_view/railtie'
+require 'action_mailer/railtie'
+require 'rails/test_unit/railtie'
+require 'sprockets/railtie'
+
+require 'rails/engine/commands'

data/config/initializers/append_points.rb

@@ -0,0 +1,70 @@
+module Workarea
+  #
+  # Storefront
+  #
+  #
+
+  Plugin.append_stylesheets(
+    'storefront.components',
+    'workarea/storefront/reviews/components/rating',
+    'workarea/storefront/reviews/components/reviews',
+    'workarea/storefront/reviews/components/reviews_aggregate',
+    'workarea/storefront/reviews/components/write_review',
+  )
+
+  Plugin.append_javascripts(
+    'storefront.templates',
+    'workarea/storefront/reviews/templates/sort_by_property'
+  )
+
+  Plugin.append_javascripts(
+    'storefront.modules',
+    'workarea/storefront/reviews/modules/product_review_ajax_submit',
+    'workarea/storefront/reviews/modules/product_reviews_sort_menus',
+    'workarea/storefront/reviews/modules/rating_buttons',
+  )
+
+  Plugin.append_partials(
+    'storefront.style_guide_product_summary',
+    'workarea/storefront/style_guides/reviews_product_summary_docs'
+  )
+
+  Plugin.append_partials(
+    'storefront.product_details',
+    'workarea/storefront/products/reviews_aggregate'
+  )
+
+  Plugin.append_partials(
+    'storefront.product_show',
+    'workarea/storefront/products/reviews'
+  )
+
+  Plugin.append_partials(
+    'storefront.product_summary',
+    'workarea/storefront/products/reviews_summary'
+  )
+
+  #
+  # Admin
+  #
+  #
+  Plugin.append_partials(
+    'admin.marketing_menu',
+    'workarea/admin/reviews/menu'
+  )
+
+  Plugin.append_partials(
+    'admin.catalog_product_aux_navigation',
+    'workarea/admin/reviews/catalog_products_aux_link'
+  )
+
+  Plugin.append_partials(
+    'admin.status_report_mailer',
+    'workarea/admin/status_report_mailer/reviews'
+  )
+
+  Workarea.append_partials(
+    'admin.marketing_dashboard_navigation',
+    'workarea/admin/reviews/dashboard_navigation'
+  )
+end

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,29 @@
+Workarea.configure do |config|
+  config.seeds << '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)
+
+  # 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,6 @@
+Sidekiq::Cron::Job.create(
+  name: 'Workarea::SendReviewRequests',
+  klass: 'Workarea::SendReviewRequests',
+  cron: "0 0 * * * #{Time.zone.tzinfo.identifier}",
+  queue: 'low'
+)

data/config/locales/en.yml

@@ -0,0 +1,104 @@
+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:
+        body: Body
+        title: Title
+        rating: Rating
+        approved: Approved
+        auto_approve: Approve All Reviews
+        verified: Verified Purchaser
+      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
+      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,21 @@
+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
+  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/engine.rb

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

data/lib/workarea/reviews/version.rb

@@ -0,0 +1,5 @@
+module Workarea
+  module Reviews
+    VERSION = '3.0.8'.freeze
+  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/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 .