solidus_reviews 1.0.0 → 1.4.0

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

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+
+module Spree
+  module Api
+    class ReviewsController < Spree::Api::BaseController
+      respond_to :json
+
+      before_action :load_review, only: [:show, :update, :destroy]
+      before_action :load_product, :find_review_user
+      before_action :sanitize_rating, only: [:create, :update]
+      before_action :prevent_multiple_reviews, only: [:create]
+
+      def index
+        @reviews = if @product
+                     Spree::Review.default_approval_filter.where(product: @product)
+                   else
+                     Spree::Review.where(user: @current_api_user)
+                   end
+
+        respond_with(@reviews)
+      end
+
+      def show
+        authorize! :read, @review
+        render json: @review, include: [:images, :feedback_reviews]
+      end
+
+      def create
+        return not_found if @product.nil?
+
+        @review = Spree::Review.new(review_params)
+        @review.product = @product
+        @review.user = @current_api_user
+        @review.ip_address = request.remote_ip
+        @review.locale = I18n.locale.to_s if Spree::Reviews::Config[:track_locale]
+
+        authorize! :create, @review
+        if @review.save
+          render json: @review, include: [:images, :feedback_reviews], status: :created
+        else
+          invalid_resource!(@review)
+        end
+      end
+
+      def update
+        authorize! :update, @review
+
+        attributes = review_params.merge(ip_address: request.remote_ip, approved: false)
+
+        if @review.update(attributes)
+          render json: @review, include: [:images, :feedback_reviews], status: :ok
+        else
+          invalid_resource!(@review)
+        end
+      end
+
+      def destroy
+        authorize! :destroy, @review
+
+        if @review.destroy
+          render json: @review, status: :ok
+        else
+          invalid_resource!(@review)
+        end
+      end
+
+      private
+
+      def permitted_review_attributes
+        [:product_id, :rating, :title, :review, :name, :show_identifier]
+      end
+
+      def review_params
+        params.permit(permitted_review_attributes)
+      end
+
+      # Loads product from product id.
+      def load_product
+        @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.
+      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[:id])
+      end
+
+      # Ensures that a user can't create more than 1 review per product
+      def prevent_multiple_reviews
+        @review = @current_api_user.reviews.find_by(product: @product)
+        if @review.present?
+          invalid_resource!(@review)
+        end
+      end
+
+      # Converts rating strings like "5 units" to "5"
+      # Operates on params
+      def sanitize_rating
+        params[:rating].sub!(/\s*[^0-9]*\z/, '') if params[:rating].present?
+      end
+    end
+  end
+end

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

@@ -1,8 +1,9 @@
+# frozen_string_literal: true
+
 module SolidusReviews
   module Generators
     class InstallGenerator < Rails::Generators::Base
-
-      class_option :auto_run_migrations, :type => :boolean, :default => false
+      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"
@@ -10,7 +11,7 @@ module SolidusReviews
       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
       end
 
       def add_migrations
@@ -18,7 +19,7 @@ module SolidusReviews
       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]'))
         if run_migrations
           run 'bundle exec rake db:migrate'
         else

data/lib/solidus_reviews.rb

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

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/factories.rb

@@ -1,4 +1,6 @@
-require "factory_girl"
+# frozen_string_literal: true
+
+require "factory_bot"
 
 Dir["#{File.dirname(__FILE__)}/factories/**"].each do |f|
   require File.expand_path(f)

data/lib/solidus_reviews/factories/feedback_review_factory.rb

@@ -1,8 +1,9 @@
-FactoryGirl.define do
-  factory :feedback_review, :class => Spree::FeedbackReview do |f|
+# frozen_string_literal: true
+
+FactoryBot.define do
+  factory :feedback_review, class: Spree::FeedbackReview do |_f|
     user
     review
-    comment { generate(:random_description) }
-    rating  { rand(1..5) }
+    rating { rand(1..5) }
   end
-end
+end

data/lib/solidus_reviews/factories/review_factory.rb

@@ -1,20 +1,30 @@
-FactoryGirl.define do
-  factory :review, :class => Spree::Review do |f|
-    name   { generate(:random_email) }
-    title  { generate(:random_string) }
-    review { generate(:random_description) }
+# frozen_string_literal: true
+
+FactoryBot.define do
+  factory :review, class: Spree::Review do |_f|
+    sequence(:name) { |i| "User #{i}" }
+    title { FFaker::Book.title }
+    review { 'This product is ok!' }
     rating { rand(1..5) }
-    approved false
-    show_identifier true
+    approved { false }
+    show_identifier { true }
     user
     product
 
     trait :approved do
-      approved true
+      approved { true }
     end
 
     trait :hide_identifier do
-      show_identifier false
+      show_identifier { false }
+    end
+
+    trait :with_image do
+      images {
+        [
+          FactoryBot.create(:image)
+        ]
+      }
     end
   end
 end

data/lib/solidus_reviews/version.rb

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

data/solidus_reviews.gemspec

@@ -1,35 +1,35 @@
+# frozen_string_literal: true
+
+$:.push File.expand_path('lib', __dir__)
+require 'solidus_reviews/version'
+
 Gem::Specification.new do |s|
-  s.platform    = Gem::Platform::RUBY
-  s.name        = 'solidus_reviews'
-  s.version     = '1.0.0'
-  s.summary     = 'Basic review and ratings facility for Spree'
-  s.authors 	  = ['Paul Callaghan']
-  s.description = s.summary
-  s.required_ruby_version = '>= 1.9.3'
-
-  s.authors 	   = ['Paul Callaghan', 'Alex Blackie']
-  s.email        = 'paulcc.two@gmail.com'
-  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 'solidus', '~> 1.0'
+  s.name = 'solidus_reviews'
+  s.version = SolidusReviews::VERSION
+  s.summary = 'Review and rating functionality for your Solidus store.'
+  s.license = 'BSD-3-Clause'
+
+  s.author = 'Solidus Contrib'
+  s.homepage = 'https://github.com/solidusio-contrib/solidus_reviews'
+
+  if s.respond_to?(:metadata)
+    s.metadata["homepage_uri"] = s.homepage if s.homepage
+    s.metadata["source_code_uri"] = s.homepage if s.homepage
+  end
+
+  s.required_ruby_version = '~> 2.4'
+
+  s.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  s.test_files = Dir['spec/**/*']
+  s.bindir = "exe"
+  s.executables = s.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
   s.add_dependency 'deface', '~> 1.0'
-  s.add_dependency 'solidus_auth_devise', '~> 1.0'
-
-  s.add_development_dependency 'ffaker'
-  s.add_development_dependency 'capybara', '~> 2.7'
-  s.add_development_dependency 'database_cleaner', '1.2.0'
-  s.add_development_dependency 'poltergeist', '~> 1.10.0'
-  s.add_development_dependency 'rspec-rails', '~> 3'
-  s.add_development_dependency 'factory_girl', '~> 4.4'
-  s.add_development_dependency 'sqlite3'
-  s.add_development_dependency 'simplecov', '~> 0.7.1'
-  s.add_development_dependency 'coffee-rails', '~> 4.0.0'
-  s.add_development_dependency 'sass-rails', '~> 5.0'
-  s.add_development_dependency 'pry'
+  s.add_dependency 'solidus_core', ['>= 2.0.0', '< 3']
+  s.add_dependency 'solidus_support', '~> 0.4'
+
+  s.add_development_dependency 'solidus_dev_support'
 end

data/spec/controllers/{admin → spree/admin}/feedback_reviews_controller_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Spree::Admin::FeedbackReviewsController do
@@ -5,11 +7,11 @@ describe Spree::Admin::FeedbackReviewsController do
 
   before do
     user = create(:admin_user)
-    controller.stub(:try_spree_current_user => user)
+    allow(controller).to receive(:spree_current_user).and_return(user)
   end
 
-  context '#index' do
-    let!(:review) { create(:review)}
+  describe '#index' do
+    let!(:review) { create(:review) }
     let!(:other_review) { create(:review) }
 
     let!(:feedback_review_1) { create(:feedback_review, created_at: 10.days.ago, review: review) }
@@ -20,10 +22,10 @@ describe Spree::Admin::FeedbackReviewsController do
     let!(:other_feedback_review_2) { create(:feedback_review, created_at: 2.days.ago, review: other_review) }
 
     it 'looks up feedback reviews for the specified review and renders the template' do
-      spree_get :index, review_id: review.id
-      response.status.should eq(200)
-      response.should render_template(:index)
-      assigns(:collection).should eq([feedback_review_2, feedback_review_3, feedback_review_1])
+      get :index, params: { review_id: review.id }
+      expect(response.status).to eq(200)
+      expect(response).to render_template(:index)
+      expect(assigns(:collection)).to eq([feedback_review_2, feedback_review_3, feedback_review_1])
     end
   end
-end
+end

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

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Spree::Admin::ReviewSettingsController do
+  stub_authorization!
+
+  before do
+    user = create(:admin_user)
+    allow(controller).to receive(:spree_current_user).and_return(user)
+  end
+
+  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
+    end
+
+    context 'For parameters:
+            preview_size: 4,
+            show_email: false,
+            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
+      end
+
+      it 'sets preferred_show_email to false' do
+        put :update, params: { preferences: { show_email: false } }
+        expect(Spree::Reviews::Config.preferred_show_email).to be false
+      end
+
+      it 'sets preferred_feedback_rating to false' do
+        put :update, params: { preferences: { feedback_rating: false } }
+        expect(Spree::Reviews::Config.preferred_feedback_rating).to be false
+      end
+
+      it 'sets preferred_require_login to true' do
+        put :update, params: { preferences: { require_login: true } }
+        expect(Spree::Reviews::Config.preferred_require_login).to be true
+      end
+
+      it 'sets preferred_track_locale to true' do
+        put :update, params: { preferences: { track_locale: true } }
+        expect(Spree::Reviews::Config.preferred_track_locale).to be true
+      end
+    end
+  end
+
+  describe '#edit' do
+    it 'renders the edit template' do
+      get :edit
+      expect(response).to render_template(:edit)
+    end
+  end
+end

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

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Spree::Admin::ReviewsController do
+  stub_authorization!
+
+  let(:product) { create(:product) }
+  let(:review) { create(:review, approved: false) }
+
+  before do
+    user = create(:admin_user)
+    allow(controller).to receive(:spree_current_user).and_return(user)
+  end
+
+  describe '#index' do
+    it 'list reviews' do
+      reviews = [
+        create(:review, product: product),
+        create(:review, product: product)
+      ]
+      get :index, params: { product_id: product.slug }
+      expect(assigns[:reviews]).to match_array reviews
+    end
+  end
+
+  describe '#approve' do
+    it 'show notice message when approved' do
+      review.update_attribute(:approved, true)
+      get :approve, params: { id: review.id }
+      expect(response).to redirect_to spree.admin_reviews_path
+      expect(flash[:success]).to eq I18n.t('spree.info_approve_review')
+    end
+
+    it 'show error message when not approved' do
+      expect_any_instance_of(Spree::Review).to receive(:save).and_return(false)
+      get :approve, params: { id: review.id }
+      expect(flash[:error]).to eq I18n.t('spree.error_approve_review')
+    end
+  end
+
+  describe '#edit' do
+    specify do
+      get :edit, params: { id: review.id }
+      expect(response.status).to eq(200)
+    end
+
+    context 'when product is nil' do
+      before do
+        review.product = nil
+        review.save!
+      end
+
+      it 'flash error' do
+        get :edit, params: { id: review.id }
+        expect(flash[:error]).to eq I18n.t('spree.error_no_product')
+      end
+
+      it 'redirect to admin-reviews page' do
+        get :edit, params: { id: review.id }
+        expect(response).to redirect_to spree.admin_reviews_path
+      end
+    end
+  end
+end