workarea-reviews 3.0.10

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,3 @@
+View this plugin's code of conduct here:
+
+<https://github.com/workarea-commerce/workarea/blob/master/CODE_OF_CONDUCT.md>

data/CONTRIBUTING.md

@@ -0,0 +1,3 @@
+View this plugin's contribution guidelines here:
+
+<https://github.com/workarea-commerce/workarea/blob/master/CONTRIBUTING.md>

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+git_source(:github) { |repo| "git@github.com:#{repo}.git" }
+
+gemspec
+
+gem 'workarea'

data/LICENSE

@@ -0,0 +1,52 @@
+WebLinc
+Business Source License
+
+Licensor: WebLinc Corporation, 22 S. 3rd Street, 2nd Floor, Philadelphia PA 19106
+
+Licensed Work: Workarea Commerce Platform
+               The Licensed Work is (c) 2019 WebLinc Corporation
+
+Additional Use Grant:
+                      You may make production use of the Licensed Work without an additional license agreement with WebLinc so long as you do not use the Licensed Work for a Commerce Service.
+
+                      A "Commerce Service" is a commercial offering that allows third parties (other than your employees and contractors) to access the functionality of the Licensed Work by creating or managing commerce functionality, the products, taxonomy, assets and/or content of which are controlled by such third parties. 
+
+                      For information about obtaining an additional license agreement with WebLinc, contact licensing@workarea.com.
+
+Change Date: 2019-08-20
+
+Change License: Version 2.0 or later of the GNU General Public License as published by the Free Software Foundation
+
+Terms
+
+The Licensor hereby grants you the right to copy, modify, create derivative works, redistribute, and make non-production use of the Licensed Work. The Licensor may make an Additional Use Grant, above, permitting limited production use.
+
+Effective on the Change Date, or the fourth anniversary of the first publicly available distribution of a specific version of the Licensed Work under this License, whichever comes first, the Licensor hereby grants you rights under the terms of the Change License, and the rights granted in the paragraph above terminate.
+
+If your use of the Licensed Work does not comply with the requirements currently in effect as described in this License, you must purchase a commercial license from the Licensor, its affiliated entities, or authorized resellers, or you must refrain from using the Licensed Work.
+
+All copies of the original and modified Licensed Work, and derivative works of the Licensed Work, are subject to this License. This License applies separately for each version of the Licensed Work and the Change Date may vary for each version of the Licensed Work released by Licensor.
+
+You must conspicuously display this License on each original or modified copy of the Licensed Work. If you receive the Licensed Work in original or modified form from a third party, the terms and conditions set forth in this License apply to your use of that work.
+
+Any use of the Licensed Work in violation of this License will automatically terminate your rights under this License for the current and all other versions of the Licensed Work.
+
+This License does not grant you any right in any trademark or logo of Licensor or its affiliates (provided that you may use a trademark or logo of Licensor as expressly required by this License). TO THE EXTENT PERMITTED BY APPLICABLE LAW, THE LICENSED WORK IS PROVIDED ON AN "AS IS" BASIS. LICENSOR HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS, EXPRESS OR IMPLIED, INCLUDING (WITHOUT LIMITATION) WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT, AND TITLE. MariaDB hereby grants you permission to use this License’s text to license your works and to refer to it using the trademark "Business Source License" as long as you comply with the Covenants of Licensor below.
+
+Covenants of Licensor
+In consideration of the right to use this License’s text and the "Business Source License" name and trademark, Licensor covenants to MariaDB, and to all other recipients of the licensed work to be provided by Licensor:
+
+To specify as the Change License the GPL Version 2.0 or any later version, or a license that is compatible with GPL Version 2.0 or a later version, where "compatible" means that software provided under the Change License can be included in a program with software provided under GPL Version 2.0 or a later version. Licensor may specify additional Change Licenses without limitation.
+
+To either: (a) specify an additional grant of rights to use that does not impose any additional restriction on the right granted in this License, as the Additional Use Grant; or (b) insert the text "None."
+
+To specify a Change Date.
+
+Not to modify this License in any other way.
+
+Notice
+The Business Source License (this document, or the "License") is not an Open Source license. However, the Licensed Work will eventually be made available under an Open Source License, as stated in this License.
+
+For more information on the use of the Business Source License generally, please visit the Adopting and Developing Business Source License FAQ.
+
+License text copyright (c) 2017 MariaDB Corporation Ab, All Rights Reserved. "Business Source License" is a trademark of MariaDB Corporation Ab.

data/README.md

@@ -0,0 +1,107 @@
+Workarea Reviews
+================================================================================
+
+A Workarea Commerce plugin that enables product reviews.
+
+
+Overview
+--------------------------------------------------------------------------------
+
+* Consumers can write product reviews in the Storefront
+* Admins can edit those reviews in the Admin, which includes approving them
+* Approved reviews are reflected in product summaries and displayed on product detail pages
+* Consumers can sort products by rating in the Storefront
+* Admins can list, show, edit, and delete reviews in the Admin
+* Admins can view and navigate to a product's reviews when administrating a product in the Admin
+* The Admin daily status report email includes a summary of reviews
+* The system emails consumers who place orders to request they write reviews
+* Developers can seed reviews for all products
+* Developers can preview review-related emails
+* Admins can view a reviews by product report
+* The system generates top rated and most reviewed product insights
+* The system generates most active reviewers insight
+
+Getting Started
+--------------------------------------------------------------------------------
+
+Add the gem to your application's Gemfile:
+
+```ruby
+# ...
+gem 'workarea-reviews'
+# ...
+```
+
+Update your application's bundle.
+
+```bash
+cd path/to/application
+bundle
+```
+
+Features
+--------------------------------------------------------------------------------
+
+
+### Writing Reviews
+
+* Reviews are written in the Storefront; users may be logged in or anonymous (requires reCAPTCHA)
+* Developers can set `Workarea.config.require_purchase_to_write_review` to `true` to require the reviewer to have a `total_spent` greater than zero for the review to be valid
+* The "write review" form is presented as a dialog, which closes after the review is submitted
+* The reviewer uses a rating star UI (with underlying values of 1 through 5) to select a rating
+* The reviewer may also provide a title and body, along with their first name, last name, and email
+* The reviewer receives an email to confirm the review was submitted and is awaiting admin approval
+
+
+### Displaying Reviews
+
+* In the Storefront, reviews are presented without pagination
+* Reviews can be sorted, which is handled client-side (values are oldest, newest, and highest)
+* Each review may include a title, a body, and the following metadata: author, date, verified
+* A review is considered verified if the reviewer was logged in and has the ID of the reviewed product in their order history
+
+
+### Administrating Reviews
+
+* Admins with marketing permission may access the reviews admin
+* The reviews admin is accessible from the Marketing section of the primary navigation and from the Marketing dashboard
+* Admins can also jump to the reviews admin by searching for "Product Reviews"
+* Products and reviews are cross referenced within the auxillary navigation of each
+* Admins can list, show, edit, and delete reviews, which includes approving them (Admins can edit a review before approving)
+
+
+### Requesting Reviews
+
+* For each order, the system will send up to _n_ review requests (Workarea.config.review_requests_per_order)
+* Each request is for a different order item (selected by most expensive)
+* Each request expires after a configurable duration (Workarea.config.review_request_ttl)
+* The first request is sent after a configurable duration has passed (Workarea.config.review_request_initial_delivery_delay)
+* Each consecutive request is sent at a configurable duration (Workarea.config.review_request_secondary_delivery_delay)
+
+reCAPTCHA Configuration
+--------------------------------------------------------------------------------
+
+Workarea Reviews utilizes [reCAPTCHA](https://github.com/ambethia/recaptcha) in the review form to prevent abuse. You'll need to configure each environment's secrets file to provide recaptcha keys. For testing and development, the plugin will use the [google provided](https://developers.google.com/recaptcha/docs/faq) testing keys if none are specified in your secrets.
+
+```yaml
+production:
+  recaptcha:
+    site_key: YOUR_SITE_KEY
+    secret_key: YOUR_SECRET_KEY
+```
+
+reCAPTCHA sends its HTTP requests through the proxy automatically if the
+`$HTTP_PROXY` environment variable is set. This is set for you in hosted
+environments.
+
+[Obtain your keys from the reCAPTCHA site](https://www.google.com/recaptcha/admin)
+
+Workarea Commerce Documentation
+--------------------------------------------------------------------------------
+
+See [https://developer.workarea.com](https://developer.workarea.com) for Workarea Commerce documentation.
+
+License
+--------------------------------------------------------------------------------
+
+Workarea Reviews is released under the [Business Software License](LICENSE)

data/Rakefile

@@ -0,0 +1,54 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+APP_RAKEFILE = File.expand_path('../test/dummy/Rakefile', __FILE__)
+load 'rails/tasks/engine.rake'
+load 'rails/tasks/statistics.rake'
+load 'workarea/changelog.rake'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test
+
+$LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
+require 'workarea/reviews/version'
+
+desc "Release version #{Workarea::Reviews::VERSION} of the gem"
+task :release do
+  host = "https://#{ENV['BUNDLE_GEMS__WEBLINC__COM']}@gems.weblinc.com"
+
+  #Rake::Task['workarea:changelog'].execute
+  #system 'git add CHANGELOG.md'
+  #system 'git commit -m "Update CHANGELOG"'
+  #system 'git push origin HEAD'
+
+  system "git tag -a v#{Workarea::Reviews::VERSION} -m 'Tagging #{Workarea::Reviews::VERSION}'"
+  system 'git push --tags'
+
+  system 'gem build workarea-reviews.gemspec'
+  system "gem push workarea-reviews-#{Workarea::Reviews::VERSION}.gem"
+  system "gem push workarea-reviews-#{Workarea::Reviews::VERSION}.gem --host #{host}"
+  system "rm workarea-reviews-#{Workarea::Reviews::VERSION}.gem"
+end
+
+desc 'Run the JavaScript tests'
+ENV['TEASPOON_RAILS_ENV'] = File.expand_path('../test/dummy/config/environment', __FILE__)
+task teaspoon: 'app:teaspoon'
+
+desc 'Start a server at http://localhost:3000/teaspoon for JavaScript tests'
+task :teaspoon_server do
+  Dir.chdir('test/dummy')
+  teaspoon_env = File.expand_path('../test/teaspoon_env.rb', __FILE__)
+  system "RAILS_ENV=test TEASPOON_ENV=#{teaspoon_env} rails s"
+end

data/app/assets/images/workarea/admin/icons/star.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><title>star</title><path d="M12 19.41l-7.33 3.84 1.43-8.13L.17 9.36l8.18-1.2L12 .75l3.65 7.41 8.19 1.2-5.94 5.76 1.42 8.13L12 19.41z"/></svg>

data/app/assets/images/workarea/storefront/icons/empty_star.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><title>empty_star</title><path d="M12 3l2.75 5.6.23.47.52.08 6.18.91-4.48 4.34-.38.37.09.52L18 21.42l-5.52-2.9-.48-.24-.46.24L6 21.42l1.08-6.13.09-.52-.37-.37-4.48-4.34 6.18-.91.5-.08.23-.47L12 3m0-2.25L8.35 8.16.17 9.36l5.93 5.76-1.43 8.13L12 19.41l7.32 3.84-1.42-8.13 5.94-5.76-8.19-1.2L12 .75z"/></svg>

data/app/assets/images/workarea/storefront/icons/half_star.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><title>half_star</title><path d="M12 19.41V.75L8.35 8.16.17 9.36l5.93 5.76-1.43 8.13L12 19.41z"/><path d="M12 3l2.75 5.6.23.47.52.08 6.18.91-4.48 4.34-.38.37.09.52L18 21.42l-5.52-2.9-.48-.24-.46.24L6 21.42l1.08-6.13.09-.52-.37-.37-4.48-4.34 6.18-.91.5-.08.23-.47L12 3m0-2.25L8.35 8.16.17 9.36l5.93 5.76-1.43 8.13L12 19.41l7.32 3.84-1.42-8.13 5.94-5.76-8.19-1.2L12 .75z"/></svg>

data/app/assets/images/workarea/storefront/icons/star.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><title>star</title><path d="M12 19.41l-7.33 3.84 1.43-8.13L.17 9.36l8.18-1.2L12 .75l3.65 7.41 8.19 1.2-5.94 5.76 1.42 8.13L12 19.41z"/></svg>

data/app/assets/javascripts/workarea/storefront/reviews/modules/product_review_ajax_submit.js

@@ -0,0 +1,39 @@
+/**
+ * @namespace WORKAREA.productReviewAjaxSubmit
+ */
+WORKAREA.registerModule('productReviewAjaxSubmit', (function () {
+    'use strict';
+
+    var submitForm = function ($form, event) {
+            if ($form.valid() === false) { return; }
+
+            event.preventDefault();
+
+            $.ajax({
+                url: $form.attr('action'),
+                type: $form.attr('method'),
+                data: $form.serialize()
+            }).done(_.partial(WORKAREA.dialog.closeClosest, $form));
+        },
+
+        formNotInDialog = function ($form) {
+            return _.isEmpty($form.closest('.ui-dialog'));
+        },
+
+        /**
+         * @method
+         * @name init
+         * @memberof WORKAREA.productReviewAjaxSubmit
+         */
+        init = function ($scope) {
+            var $form = $('[data-product-review-ajax-submit]', $scope);
+
+            if (formNotInDialog($form)) { return; }
+
+            $form.on('submit', _.partial(submitForm, $form));
+        };
+
+    return {
+        init: init
+    };
+}()));

data/app/assets/javascripts/workarea/storefront/reviews/modules/product_reviews_sort_menus.js

@@ -0,0 +1,82 @@
+/**
+ * @namespace WORKAREA.productReviewsSortMenus
+ */
+WORKAREA.registerModule('productReviewsSortMenus', (function () {
+    'use strict';
+
+    var insertSortSelectBox = function (index, section) {
+            $('.reviews__header', section).after(
+                JST['workarea/storefront/reviews/templates/sort_by_property']()
+            );
+        },
+
+        sortNewToOld = function ($reviews) {
+            return _.sortBy($reviews, function (review) {
+                return -($(review).data('productReviewSectionEntry').createdAt);
+            });
+        },
+
+        sortOldToNew = function ($reviews) {
+            return _.sortBy($reviews, function (review) {
+                return $(review).data('productReviewSectionEntry').createdAt;
+            });
+        },
+
+
+        sortHighToLow = function ($reviews) {
+            return _.sortBy($reviews, function (review) {
+                return -($(review).data('productReviewSectionEntry').rating);
+            });
+        },
+
+        sortLowToHigh = function ($reviews) {
+            return _.sortBy($reviews, function (review) {
+                return $(review).data('productReviewSectionEntry').rating;
+            });
+        },
+
+        handleSortSelectChange = function (event) {
+            var $reviews = $(
+                    '[data-product-review-section-entry]', event.delegateTarget
+                ),
+
+                action = $(event.currentTarget).val(),
+
+                actions = {
+                    oldest: function () {
+                        return sortOldToNew($reviews);
+                    },
+                    newest: function () {
+                        return sortNewToOld($reviews);
+                    },
+                    lowest: function () {
+                        return sortLowToHigh($reviews);
+                    },
+                    highest: function () {
+                        return sortHighToLow($reviews);
+                    }
+                };
+
+            $('.reviews__review-group', event.delegateTarget)
+            .html(actions[action]());
+        },
+
+        /**
+         * @method
+         * @name init
+         * @memberof WORKAREA.productReviewsSortMenus
+         */
+        init = function ($scope) {
+            $('.reviews', $scope)
+            .each(insertSortSelectBox)
+            .on(
+                'change',
+                '[data-product-reviews-sort-menu]',
+                handleSortSelectChange
+            );
+        };
+
+    return {
+        init: init
+    };
+}()));

data/app/assets/javascripts/workarea/storefront/reviews/modules/rating_buttons.js

@@ -0,0 +1,103 @@
+/**
+ * @namespace WORKAREA.ratingButtons
+ */
+WORKAREA.registerModule('ratingButtons', (function () {
+    'use strict';
+
+    var activateLabels = function (radioButton, originalIndex, $scope) {
+            var $allButtons = getAllRatingButtons($(document)),
+
+                updateState = function (index, button) {
+                    var $label = getAssociatedLabel(button, $scope);
+
+                    $label.removeClass('write-review__star--hovered write-review__star--active');
+
+                    if ($label.data('index') <= originalIndex) {
+                        $label.addClass('write-review__star--active');
+                    }
+                };
+
+            if ($(radioButton).is(':checked')) {
+                $allButtons.each(updateState);
+            }
+        },
+
+        getAllRatingButtons = function ($scope) {
+            return $('[data-rating-button]', $scope);
+        },
+
+        getAssociatedLabel = function (button, $scope) {
+            return $('label[for=' + $(button).attr('id') + ']', $scope);
+        },
+
+        removeHoverClass = function ($label) {
+            $label.removeClass('write-review__star--hovered');
+        },
+
+        addHoverClass = function ($label) {
+            $label.addClass('write-review__star--hovered');
+        },
+
+        removeHoverStateFromLabel = function ($scope) {
+            var $buttons = getAllRatingButtons($scope),
+
+                removeState = function (index, button) {
+                    var $label = getAssociatedLabel(button, $scope);
+
+                    removeHoverClass($label);
+                };
+
+            $buttons.each(removeState);
+        },
+
+        addHoverStateToLabels = function ($scope, originalIndex) {
+            var $buttons = getAllRatingButtons($scope),
+
+                addState = function (index, button) {
+                    var $label = getAssociatedLabel(button, $scope);
+
+                    if ($label.data('index') <= originalIndex) {
+                        addHoverClass($label);
+                    }
+                };
+
+            $buttons.each(addState);
+        },
+
+        setupLabels = function ($scope, index, button) {
+                var $label = getAssociatedLabel(button, $scope),
+                    labelTitle = $('.write-review__star-text', $label).text();
+
+                /**
+                 * 1. per http://www.workarea.com/labs/touching-on-html-labels/
+                 */
+
+                $label
+                .attr('title', labelTitle)
+                .data('index', index)
+                .on('click', $.noop) /* [1] */
+                .on('mouseenter', _.partial(addHoverStateToLabels, $scope, index))
+                .on('mouseleave', _.partial(removeHoverStateFromLabel, $scope));
+
+                activateLabels(button, index, $scope);
+
+                $(button)
+                .on('click', _.partial(activateLabels, button, index, $scope))
+                .on('focus', _.partial(addHoverClass, $label))
+                .on('blur', _.partial(removeHoverClass, $label));
+        },
+
+        /**
+         * @method
+         * @name init
+         * @memberof WORKAREA.ratingButtons
+         */
+        init = function ($scope) {
+            $('[data-rating-button]', $scope)
+            .each(_.partial(setupLabels, $scope));
+        };
+
+    return {
+        init: init
+    };
+}()));