solidus_reviews 1.2.0 → 1.5.0

data/lib/controllers/spree/api/feedback_reviews_controller.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+module Spree
+  module Api
+    class FeedbackReviewsController < Spree::Api::BaseController
+      respond_to :json
+
+      before_action :load_review, only: [:create, :update, :destroy]
+      before_action :load_feedback_review, only: [:update, :destroy]
+      before_action :find_review_user
+      before_action :sanitize_rating, only: [:create, :update]
+      before_action :prevent_multiple_feedback_reviews, only: [:create]
+
+      def create
+        if @review.present?
+          @feedback_review = @review.feedback_reviews.new(feedback_review_params)
+          @feedback_review.user = @current_api_user
+          @feedback_review.locale = I18n.locale.to_s if Spree::Reviews::Config[:track_locale]
+        end
+
+        authorize! :create, @feedback_review
+        if @feedback_review.save
+          render json: @feedback_review, status: :created
+        else
+          invalid_resource!(@feedback_review)
+        end
+      end
+
+      def update
+        authorize! :update, @feedback_review
+
+        if @feedback_review.update(feedback_review_params)
+          render json: @feedback_review, status: :ok
+        else
+          invalid_resource!(@feedback_review)
+        end
+      end
+
+      def destroy
+        authorize! :destroy, @feedback_review
+
+        if @feedback_review.destroy
+          render json: @feedback_review, status: :ok
+        else
+          invalid_resource!(@feedback_review)
+        end
+      end
+
+      private
+
+      def permitted_feedback_review_attributes
+        [:rating, :comment]
+      end
+
+      def feedback_review_params
+        params.require(:feedback_review).permit(permitted_feedback_review_attributes)
+      end
+
+      # Finds user based on api_key or by user_id if api_key belongs to an admin.
+      def find_review_user
+        if params[:user_id] && @current_user_roles.include?('admin')
+          @current_api_user = Spree.user_class.find(params[:user_id])
+        end
+      end
+
+      # Loads any review that is shared between the user and product
+      def load_review
+        @review = Spree::Review.find(params[:review_id])
+      end
+
+      # Loads the feedback_review
+      def load_feedback_review
+        @feedback_review = Spree::FeedbackReview.find(params[:id])
+      end
+
+      # Ensures that a user can't leave multiple feedbacks on a single review
+      def prevent_multiple_feedback_reviews
+        @feedback_review = @review.feedback_reviews.find_by(user_id: @current_api_user)
+        if @feedback_review.present?
+          invalid_resource!(@feedback_review)
+        end
+      end
+
+      # Converts rating strings like "5 units" to "5"
+      # Operates on params
+      def sanitize_rating
+        params[:rating].to_s.sub!(/\s*[^0-9]*\z/, '') unless params[:feedback_review] && params[:feedback_review][:rating].blank?
+      end
+    end
+  end
+end

data/lib/controllers/spree/api/reviews_controller.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Spree
   module Api
     class ReviewsController < Spree::Api::BaseController
@@ -9,11 +11,11 @@ module Spree
       before_action :prevent_multiple_reviews, only: [:create]
 
       def index
-        if @product
-          @reviews = Spree::Review.default_approval_filter.where(product: @product)
-        else
-          @reviews = Spree::Review.where(user: @current_api_user)
-        end
+        @reviews = if @product
+                     Spree::Review.default_approval_filter.where(product: @product)
+                   else
+                     Spree::Review.where(user: @current_api_user)
+                   end
 
         respond_with(@reviews)
       end
@@ -34,7 +36,7 @@ module Spree
 
         authorize! :create, @review
         if @review.save
-          render json: @review, include: [:images, :feedback_reviews], status: 201
+          render json: @review, include: [:images, :feedback_reviews], status: :created
         else
           invalid_resource!(@review)
         end
@@ -46,7 +48,7 @@ module Spree
         attributes = review_params.merge(ip_address: request.remote_ip, approved: false)
 
         if @review.update(attributes)
-          render json: @review, include: [:images, :feedback_reviews], status: 200
+          render json: @review, include: [:images, :feedback_reviews], status: :ok
         else
           invalid_resource!(@review)
         end
@@ -56,7 +58,7 @@ module Spree
         authorize! :destroy, @review
 
         if @review.destroy
-          render json: @review, status: 200
+          render json: @review, status: :ok
         else
           invalid_resource!(@review)
         end
@@ -74,11 +76,11 @@ module Spree
 
       # Loads product from product id.
       def load_product
-        if params[:product_id]
-          @product = Spree::Product.friendly.find(params[:product_id])
-        else
-          @product = @review&.product
-        end
+        @product = if params[:product_id]
+                     Spree::Product.friendly.find(params[:product_id])
+                   else
+                     @review&.product
+                   end
       end
 
       # Finds user based on api_key or by user_id if api_key belongs to an admin.
@@ -104,7 +106,7 @@ module Spree
       # Converts rating strings like "5 units" to "5"
       # Operates on params
       def sanitize_rating
-        params[:rating].sub!(/\s*[^0-9]*\z/, '') unless params[:rating].blank?
+        params[:rating].sub!(/\s*[^0-9]*\z/, '') if params[:rating].present?
       end
     end
   end

data/lib/generators/solidus_reviews/install/install_generator.rb

@@ -6,24 +6,25 @@ module SolidusReviews
       class_option :auto_run_migrations, type: :boolean, default: false
 
       def add_javascripts
-        append_file "vendor/assets/javascripts/spree/frontend/all.js", "//= require spree/frontend/solidus_reviews\n"
-        append_file "vendor/assets/javascripts/spree/backend/all.js", "//= require spree/backend/solidus_reviews\n"
+        append_file 'vendor/assets/javascripts/spree/frontend/all.js', "//= require spree/frontend/solidus_reviews\n"
+        append_file 'vendor/assets/javascripts/spree/backend/all.js', "//= require spree/backend/solidus_reviews\n"
       end
 
       def add_stylesheets
-        inject_into_file "vendor/assets/stylesheets/spree/frontend/all.css", " *= require spree/frontend/solidus_reviews\n", before: /\*\//, verbose: true
+        inject_into_file 'vendor/assets/stylesheets/spree/frontend/all.css', " *= require spree/frontend/solidus_reviews\n", before: %r{\*/}, verbose: true # rubocop:disable Layout/LineLength
+        inject_into_file 'vendor/assets/stylesheets/spree/backend/all.css', " *= require spree/backend/solidus_reviews\n", before: %r{\*/}, verbose: true # rubocop:disable Layout/LineLength
       end
 
       def add_migrations
-        run 'bundle exec rake railties:install:migrations FROM=solidus_reviews'
+        run 'bin/rails railties:install:migrations FROM=solidus_reviews'
       end
 
       def run_migrations
-        run_migrations = options[:auto_run_migrations] || ['', 'y', 'Y'].include?(ask('Would you like to run the migrations now? [Y/n]'))
+        run_migrations = options[:auto_run_migrations] || ['', 'y', 'Y'].include?(ask('Would you like to run the migrations now? [Y/n]')) # rubocop:disable Layout/LineLength
         if run_migrations
-          run 'bundle exec rake db:migrate'
+          run 'bin/rails db:migrate'
         else
-          puts 'Skipping rake db:migrate, don\'t forget to run it!'
+          puts 'Skipping bin/rails db:migrate, don\'t forget to run it!' # rubocop:disable Rails/Output
         end
       end
     end

data/lib/solidus_reviews/engine.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'spree/core'
+
+module SolidusReviews
+  class Engine < Rails::Engine
+    include SolidusSupport::EngineExtensions
+
+    isolate_namespace Spree
+
+    engine_name 'solidus_reviews'
+
+    # use rspec for tests
+    config.generators do |g|
+      g.test_framework :rspec
+    end
+
+    config.to_prepare do
+      ::Spree::Ability.register_ability(::Spree::ReviewsAbility)
+    end
+
+    if SolidusSupport.api_available?
+      paths["app/controllers"] << "lib/controllers"
+    end
+  end
+end

data/lib/solidus_reviews/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module SolidusReviews
+  VERSION = '1.5.0'
+end

data/lib/solidus_reviews.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require 'solidus'
+require 'solidus_core'
 require 'solidus_support'
-require 'sass/rails'
 require 'deface'
-require 'spree_reviews/engine'
-require 'coffee_script'
+
+require 'solidus_reviews/version'
+require 'solidus_reviews/engine'

data/solidus_reviews.gemspec

@@ -1,37 +1,34 @@
 # frozen_string_literal: true
 
-Gem::Specification.new do |s|
-  s.platform    = Gem::Platform::RUBY
-  s.name        = 'solidus_reviews'
-  s.version     = '1.2.0'
-  s.summary     = 'Basic review and ratings facility for Solidus'
-  s.authors = ['Solidus Contrib']
-  s.description = s.summary
-  s.required_ruby_version = '>= 1.9.3'
-
-  s.homepage     = 'https://github.com/solidusio-contrib/solidus_reviews/'
-  s.license      = 'BSD-3'
-
-  s.files        = `git ls-files`.split("\n")
-  s.test_files   = `git ls-files -- spec/*`.split("\n")
-  s.require_path = 'lib'
-  s.requirements << 'none'
-
-  s.add_dependency 'deface', '~> 1'
-  s.add_dependency 'solidus', ['>= 1.4', '< 3']
-  s.add_dependency 'solidus_support', '~> 0.1'
-
-  s.add_development_dependency 'capybara'
-  s.add_development_dependency 'capybara-screenshot'
-  s.add_development_dependency 'coffee-rails'
-  s.add_development_dependency 'database_cleaner'
-  s.add_development_dependency 'ffaker'
-  s.add_development_dependency 'poltergeist'
-  s.add_development_dependency 'pry'
-  s.add_development_dependency 'rspec-rails', '~> 4.0.0.beta2'
-  s.add_development_dependency 'rubocop', '~> 0.53.0'
-  s.add_development_dependency 'sass-rails'
-  s.add_development_dependency 'selenium-webdriver'
-  s.add_development_dependency 'simplecov'
-  s.add_development_dependency 'sqlite3'
+require_relative 'lib/solidus_reviews/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'solidus_reviews'
+  spec.version = SolidusReviews::VERSION
+  spec.authors = ['Solidus Contrib']
+
+  spec.summary = 'Review and rating functionality for your Solidus store.'
+  spec.description = 'Review and rating functionality for your Solidus store.'
+  spec.homepage = 'https://github.com/solidusio-contrib/solidus_reviews'
+  spec.license = 'BSD-3-Clause'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/solidusio-contrib/solidus_reviews'
+
+  spec.required_ruby_version = Gem::Requirement.new('> 2.5')
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  files = Dir.chdir(__dir__) { `git ls-files -z`.split("\x0") }
+
+  spec.files = files.grep_v(%r{^(test|spec|features)/})
+  spec.test_files = files.grep(%r{^(test|spec|features)/})
+  spec.bindir = "exe"
+  spec.executables = files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'solidus_core', ['>= 2.0.0', '< 4']
+  spec.add_dependency 'solidus_support', '~> 0.5'
+
+  spec.add_development_dependency 'solidus_dev_support'
 end

data/spec/controllers/spree/admin/feedback_reviews_controller_spec.rb

@@ -10,7 +10,7 @@ describe Spree::Admin::FeedbackReviewsController do
     allow(controller).to receive(:spree_current_user).and_return(user)
   end
 
-  context '#index' do
+  describe '#index' do
     let!(:review) { create(:review) }
     let!(:other_review) { create(:review) }
 

data/spec/controllers/spree/admin/review_settings_controller_spec.rb

@@ -10,7 +10,7 @@ describe Spree::Admin::ReviewSettingsController do
     allow(controller).to receive(:spree_current_user).and_return(user)
   end
 
-  context '#update' do
+  describe '#update' do
     it 'redirects to edit-review-settings page' do
       put :update, params: { preferences: { preview_size: 4 } }
       expect(response).to redirect_to spree.edit_admin_review_settings_path
@@ -22,7 +22,6 @@ describe Spree::Admin::ReviewSettingsController do
             feedback_rating: false,
             require_login: true,
             track_locale: true' do
-
       it 'sets preferred_preview_size to 4' do
         put :update, params: { preferences: { preview_size: 4 } }
         expect(Spree::Reviews::Config.preferred_preview_size).to eq 4
@@ -50,8 +49,8 @@ describe Spree::Admin::ReviewSettingsController do
     end
   end
 
-  context '#edit' do
-    it 'should render the edit template' do
+  describe '#edit' do
+    it 'renders the edit template' do
       get :edit
       expect(response).to render_template(:edit)
     end

data/spec/controllers/spree/admin/reviews_controller_spec.rb

@@ -13,7 +13,7 @@ describe Spree::Admin::ReviewsController do
     allow(controller).to receive(:spree_current_user).and_return(user)
   end
 
-  context '#index' do
+  describe '#index' do
     it 'list reviews' do
       reviews = [
         create(:review, product: product),
@@ -24,7 +24,7 @@ describe Spree::Admin::ReviewsController do
     end
   end
 
-  context '#approve' do
+  describe '#approve' do
     it 'show notice message when approved' do
       review.update_attribute(:approved, true)
       get :approve, params: { id: review.id }
@@ -39,7 +39,7 @@ describe Spree::Admin::ReviewsController do
     end
   end
 
-  context '#edit' do
+  describe '#edit' do
     specify do
       get :edit, params: { id: review.id }
       expect(response.status).to eq(200)

data/spec/controllers/spree/api/feedback_reviews_controller_spec.rb

@@ -0,0 +1,136 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Spree::Api::FeedbackReviewsController, type: :controller do
+  render_views
+
+  let!(:user) { create(:user) }
+  let!(:review) { create(:review) }
+  let!(:feedback_review) { create(:feedback_review, review: review) }
+
+  before do
+    user.generate_spree_api_key!
+  end
+
+  describe '#create' do
+    subject do
+      params = { review_id: review.id, token: user.spree_api_key, format: 'json' }.merge(feedback_review_params)
+      post :create, params: params
+      JSON.parse(response.body)
+    end
+
+    let(:feedback_review_params) do
+      {
+        "feedback_review": {
+          "rating": "5",
+          "comment": "I agree with what you said"
+        }
+      }
+    end
+
+    context 'when user has already left feedback on a reviewed this product' do
+      before do
+        feedback_review.update(user_id: user.id)
+      end
+
+      it 'returns with a fail' do
+        expect(subject["error"]).not_to be_empty
+        expect(subject["error"]).to match(/invalid resource/i)
+      end
+    end
+
+    context 'when it is a users first feedback for a review' do
+      it 'returns success with feedback' do
+        expect(subject).not_to be_empty
+        expect(subject["review_id"]).to eq(review.id)
+        expect(subject["rating"]).to eq(5)
+        expect(subject["comment"]).to eq("I agree with what you said")
+      end
+
+      it 'updates the review' do
+        expect(review).to receive(:touch)
+        feedback = create(:feedback_review, review: review)
+        feedback.save!
+      end
+    end
+  end
+
+  describe '#update' do
+    subject do
+      put :update, params: params
+      JSON.parse(response.body)
+    end
+
+    before { feedback_review.update(user_id: user.id) }
+
+    let(:params) { { review_id: review.id, id: feedback_review.id, token: user.spree_api_key, format: 'json' }.merge(feedback_review_params) }
+
+    let(:feedback_review_params) do
+      {
+        "feedback_review": {
+          "rating": "1",
+          "comment": "Actually I don't agree"
+        }
+      }
+    end
+
+    context 'when a user updates their own feedback for a review' do
+      it 'successfully updates their feedback' do
+        original = feedback_review
+        expect(subject["id"]).to eq(original.id)
+        expect(subject["user_id"]).to eq(original.user_id)
+        expect(subject["review_id"]).to eq(original.review_id)
+        expect(subject["rating"]).to eq(1)
+        expect(subject["comment"]).to eq("Actually I don't agree")
+      end
+    end
+
+    context 'when a user updates another users review' do
+      let(:other_user) { create(:user) }
+      let(:params) { { review_id: review.id, id: feedback_review.id, token: other_user.spree_api_key, format: 'json' }.merge(feedback_review_params) }
+
+      before do
+        other_user.generate_spree_api_key!
+      end
+
+      it 'returns an error' do
+        expect(subject["error"]).not_to be_empty
+        expect(subject["error"]).to match(/not authorized/i)
+      end
+    end
+  end
+
+  describe '#destroy' do
+    subject do
+      delete :destroy, params: params
+      JSON.parse(response.body)
+    end
+
+    before { feedback_review.update(user_id: user.id) }
+
+    let(:params) { { review_id: review.id, id: feedback_review.id, token: user.spree_api_key, format: 'json' } }
+
+    context "when a user destroys their own feedback" do
+      it 'returns the deleted feedback' do
+        expect(subject["id"]).to eq(feedback_review.id)
+        expect(subject["review_id"]).to eq(review.id)
+        expect(Spree::FeedbackReview.find_by(id: feedback_review.id)).to be_falsey
+      end
+    end
+
+    context "when a user destroys another users feedback" do
+      let(:other_user) { create(:user) }
+      let(:params) { { review_id: review.id, id: feedback_review.id, token: other_user.spree_api_key, format: 'json' } }
+
+      before do
+        other_user.generate_spree_api_key!
+      end
+
+      it 'returns an error' do
+        expect(subject["error"]).not_to be_empty
+        expect(subject["error"]).to match(/not authorized/i)
+      end
+    end
+  end
+end

data/spec/controllers/spree/api/reviews_controller_spec.rb

@@ -24,7 +24,7 @@ describe Spree::Api::ReviewsController, type: :controller do
       end
 
       context 'there are no reviews for a product' do
-        it 'should return an empty array' do
+        it 'returns an empty array' do
           expect(Spree::Review.count).to be >= 0
           expect(subject["reviews"]).to be_empty
         end
@@ -53,7 +53,7 @@ describe Spree::Api::ReviewsController, type: :controller do
       end
 
       context 'there are no reviews for the user' do
-        it 'should return an empty array' do
+        it 'returns an empty array' do
           expect(Spree::Review.count).to be >= 0
           expect(subject["reviews"]).to be_empty
         end
@@ -81,7 +81,7 @@ describe Spree::Api::ReviewsController, type: :controller do
     context 'when it is the users review' do
       before { review.update(user_id: user.id) }
 
-      it 'should return the review' do
+      it 'returns the review' do
         expect(subject).not_to be_empty
         expect(subject["product_id"]).to eq(product.id)
         expect(subject["name"]).to eq(review[:name])
@@ -94,7 +94,7 @@ describe Spree::Api::ReviewsController, type: :controller do
     end
 
     context 'when it is not the users review' do
-      it 'should return with not authorized' do
+      it 'returns with not authorized' do
         expect(subject["error"]).not_to be_empty
         expect(subject["error"]).to match(/not authorized/i)
       end
@@ -102,7 +102,7 @@ describe Spree::Api::ReviewsController, type: :controller do
       context 'and it the review is approved' do
         before { review.update(approved: true) }
 
-        it 'should return the review' do
+        it 'returns the review' do
           expect(subject).not_to be_empty
           expect(subject["product_id"]).to eq(product.id)
           expect(subject["name"]).to eq(review[:name])
@@ -116,6 +116,12 @@ describe Spree::Api::ReviewsController, type: :controller do
   end
 
   describe '#create' do
+    subject do
+      params = { product_id: product.id, token: user.spree_api_key, format: 'json' }.merge(review_params)
+      post :create, params: params
+      JSON.parse(response.body)
+    end
+
     let(:review_params) do
       {
         "user_id": user.id,
@@ -126,25 +132,19 @@ describe Spree::Api::ReviewsController, type: :controller do
       }
     end
 
-    subject do
-      params = { product_id: product.id, token: user.spree_api_key, format: 'json' }.merge(review_params)
-      post :create, params: params
-      JSON.parse(response.body)
-    end
-
     context 'when user has already reviewed this product' do
       before do
         review.update(user_id: user.id)
       end
 
-      it 'should return with a fail' do
+      it 'returns with a fail' do
         expect(subject["error"]).not_to be_empty
         expect(subject["error"]).to match(/invalid resource/i)
       end
     end
 
     context 'when it is a users first review for the product' do
-      it 'should return success with review' do
+      it 'returns success with review' do
         expect(subject).not_to be_empty
         expect(subject["product_id"]).to eq(product.id)
         expect(subject["name"]).to eq(review_params[:name])
@@ -157,7 +157,13 @@ describe Spree::Api::ReviewsController, type: :controller do
   end
 
   describe '#update' do
+    subject do
+      put :update, params: params
+      JSON.parse(response.body)
+    end
+
     before { review.update(approved: true, user_id: user.id) }
+
     let(:params) { { product_id: product.id, id: review.id, token: user.spree_api_key, format: 'json' }.merge(review_params) }
 
     let(:review_params) do
@@ -169,13 +175,8 @@ describe Spree::Api::ReviewsController, type: :controller do
       }
     end
 
-    subject do
-      put :update, params: params
-      JSON.parse(response.body)
-    end
-
     context 'when a user updates their own review' do
-      it 'should successfully update the review and set approved back to false' do
+      it 'successfullies update the review and set approved back to false' do
         original = review
         expect(original.approved?).to be true
         expect(subject["id"]).to eq(original.id)
@@ -195,7 +196,7 @@ describe Spree::Api::ReviewsController, type: :controller do
         other_user.generate_spree_api_key!
       end
 
-      it 'should return an error' do
+      it 'returns an error' do
         expect(subject["error"]).not_to be_empty
         expect(subject["error"]).to match(/not authorized/i)
       end
@@ -203,16 +204,17 @@ describe Spree::Api::ReviewsController, type: :controller do
   end
 
   describe '#destroy' do
-    before { review.update(approved: true, user_id: user.id) }
-    let(:params) { { product_id: product.id, id: review.id, token: user.spree_api_key, format: 'json' } }
-
     subject do
       delete :destroy, params: params
       JSON.parse(response.body)
     end
 
+    before { review.update(approved: true, user_id: user.id) }
+
+    let(:params) { { product_id: product.id, id: review.id, token: user.spree_api_key, format: 'json' } }
+
     context "when a user destroys their own review" do
-      it 'should return the deleted review' do
+      it 'returns the deleted review' do
         expect(subject["id"]).to eq(review.id)
         expect(subject["product_id"]).to eq(product.id)
         expect(Spree::Review.find_by(id: review.id)).to be_falsey
@@ -227,7 +229,7 @@ describe Spree::Api::ReviewsController, type: :controller do
         other_user.generate_spree_api_key!
       end
 
-      it 'should return an error' do
+      it 'returns an error' do
         expect(subject["error"]).not_to be_empty
         expect(subject["error"]).to match(/not authorized/i)
       end