solidus_reviews 1.0.0 → 1.1.0

data/config/locales/tr.yml

@@ -14,6 +14,16 @@ tr:
       spree/review:
         one: bir yorum
         other: "%{count} yorumlar"
+    errors:
+      models:
+        spree/review:
+          attributes:
+            rating:
+              you_must_enter_value_for_rating: "Yorum yazmak için giriş yapmalısınız."
+        spree/feedback_review:
+          attributes:
+            rating:
+              you_must_enter_value_for_rating: "Yorum yazmak için giriş yapmalısınız."
   spree:
     approval_status: Onay Durumu
     approve: Onayla
@@ -40,16 +50,19 @@ tr:
     reviews: Yorumlar
     admin:
       tab:
+        reviews: Yorumlar
         review_management: Yorumlar
     review_successfully_submitted: Yorumunuz başarıyla iletildi
     spree_reviews:
       feedback_rating: Geribildirimi değerlendir
+      display_unapproved: Listelerde onaylanmayan yorumları göster
       include_unapproved: Listede ki onaylanmamış değerlendirmeleri dahil et
       manage_review_settings: Yorum ekranını kontrol edin
       preview_size: Yorum büyüklüğü
       require_login: Yorumları görebilmek için kullanıcı girişi
       review_settings: Yorum Ayarları
       show_email: e-posta adresini göster
+      show_verified_purchaser: Doğrulanmış alıcıyı göster
       track_locale: Kullanıcının yerel bilgilerini kaydet/takip et
     star:
       one: "1"
@@ -58,11 +71,10 @@ tr:
     submit_your_review: Gönder
     submitted_on: "Gönderilme Tarihi:"
     unapproved_reviews: Onaylanmamış
+    verified_purchaser: Doğrulanmış alıcı
     voice:
       one: "1 değerlendirme"
       other: "%{count} değerlendirme"
     was_this_review_helpful: "Bu yorum size yardımcı oldu mu?"
     write_your_own_review: Yorum Yap
-    you_must_enter_value_for_rating: "Yorum yazmak için giriş yapmalısınız."
     anonymous: anonim
-

data/config/locales/uk.yml

@@ -17,6 +17,16 @@ uk:
         few: '%{count} відгуки'
         many: '%{count} відгуків'
         other: '%{count} відгуків'
+    errors:
+      models:
+        spree/review:
+          attributes:
+            rating:
+              you_must_enter_value_for_rating: 'Потрібно вибрати оцінку.'
+        spree/feedback_review:
+          attributes:
+            rating:
+              you_must_enter_value_for_rating: 'Потрібно вибрати оцінку.'
   spree:
     approval_status: Підтвердження
     approve: Схвалити
@@ -44,16 +54,19 @@ uk:
     reviews: Відгуки
     admin:
       tab:
+        reviews: Відгуки
         review_management: Відгуки
     review_successfully_submitted: Відгук надіслано
     spree_reviews:
       feedback_rating: Оцінювати корисність
+      display_unapproved: Показувати в списках не схвалені відгуки
       include_unapproved: Показувати незатверджені відгуки
       manage_review_settings: Керувати відображенням відгуків
       preview_size: Розмір скороченої версії
       require_login: Тільки для зареєстрованих користувачів
       review_settings: Налаштування відгуків
       show_email: Показувати email
+      show_verified_purchaser: Показати підтвердженого покупця
       track_locale: Зберігати мову користувача
     star:
       one: '1'
@@ -64,6 +77,7 @@ uk:
     submit_your_review: Надіслати відгук
     submitted_on: Написано
     unapproved_reviews: Непідтверджений
+    verified_purchaser: Перевірений покупець
     voice:
       one: '1 голос'
       few: '%{count} голоси'
@@ -71,5 +85,4 @@ uk:
       other: '%{count} голосів'
     was_this_review_helpful: 'Цей відгук корисний для вас?'
     write_your_own_review: Напишіть свій відгук
-    you_must_enter_value_for_rating: 'Потрібно вибрати оцінку.'
     anonymous: Анонім

data/config/locales/zh-CN.yml

@@ -14,6 +14,16 @@ zh-CN:
       spree/review:
         one: 一个评论
         other: "%{count}个评论"
+    errors:
+      models:
+        spree/review:
+          attributes:
+            rating:
+              you_must_enter_value_for_rating: "您必需输入评级"
+        spree/feedback_review:
+          attributes:
+            rating:
+              you_must_enter_value_for_rating: "您必需输入评级"
   spree:
     approve: 核准
     approved_reviews: 核准
@@ -38,16 +48,19 @@ zh-CN:
     reviews: 评论
     admin:
       tab:
+        reviews: 评论
         review_management: 评论
     review_successfully_submitted: 已成功递交评论。
     spree_reviews:
       feedback_rating: 评级回馈
+      display_unapproved: 在列表中显示未经批准的评论
       include_unapproved: 包括未核准评论在列表中
       manage_review_settings: 控制评论的显示
       preview_size: 评论片段的大小
       require_login: 用者必需登入
       review_settings: 评论设定
       show_email: 显示电邮地址
+      show_verified_purchaser: 显示经过验证的购买者
       track_locale: 追踪用户地域
     star:
       one: "1"
@@ -56,10 +69,10 @@ zh-CN:
     submit_your_review: 递交你的评论
     submitted_on: 递交日期
     unapproved_reviews: 沒核准
+    verified_purchaser: 验证购买者
     voice:
       one: "1 聲音"
       other: "%{count} 聲音"
     was_this_review_helpful: "此评论对你是否有帮助？"
     write_your_own_review: 写下您的评论
-    you_must_enter_value_for_rating: "您必需输入评级"
     anonymous: 匿名者

data/config/locales/zh-TW.yml

@@ -14,6 +14,16 @@ zh-TW:
       spree/review:
         one: 一個評論
         other: '%{count}個評論'
+    errors:
+      models:
+        spree/review:
+          attributes:
+            rating:
+              you_must_enter_value_for_rating: 您必需輸入評級
+        spree/feedback_review:
+          attributes:
+            rating:
+              you_must_enter_value_for_rating: 您必需輸入評級
   spree:
     approve: 核準
     approved_reviews: 核準
@@ -38,16 +48,19 @@ zh-TW:
     reviews: 評論
     admin:
       tab:
+        reviews: 評論
         review_management: 評論
     review_successfully_submitted: 已成功遞交評論。
     spree_reviews:
       feedback_rating: 評級回饋
+      display_unapproved: 在列表中顯示未經批准的評論
       include_unapproved: 包括未核準評論在列表中
       manage_review_settings: 控制評論的顯示
       preview_size: 評論片段的大小
       require_login: 用者必需登入
       review_settings: 評論設定
       show_email: 顯示電郵地址
+      show_verified_purchaser: 顯示經過驗證的購買者
       track_locale: 追蹤用戶地域
     star:
       one: "1"
@@ -56,10 +69,10 @@ zh-TW:
     submit_your_review: 遞交你的評論
     submitted_on: 遞交日期
     unapproved_reviews: 沒核準
+    verified_purchaser: 驗證購買者
     voice:
       one: "1 聲音"
       other: "%{count} 聲音"
     was_this_review_helpful: 此評論對你是否有幫助？
     write_your_own_review: 寫下您的評論
-    you_must_enter_value_for_rating: 您必需輸入評級
     anonymous: 匿名者

data/config/routes.rb

@@ -1,10 +1,13 @@
-Spree::Core::Engine.add_routes do
+# frozen_string_literal: true
+
+Spree::Core::Engine.routes.draw do
   namespace :admin do
     resources :reviews, only: [:index, :destroy, :edit, :update] do
       member do
         get :approve
       end
       resources :feedback_reviews, only: [:index, :destroy]
+      resources :images, only: [:destroy]
     end
     resource :review_settings, only: [:edit, :update]
   end
@@ -14,4 +17,18 @@ Spree::Core::Engine.add_routes do
     end
   end
   post '/reviews/:review_id/feedback(.:format)' => 'feedback_reviews#create', as: :feedback_reviews
+
+  if SolidusSupport.api_available?
+    namespace :api, defaults: { format: 'json' } do
+      resources :reviews, only: [:show, :create, :update, :destroy]
+
+      resources :products do
+        resources :reviews, only: [:index]
+      end
+
+      resources :users do
+        resources :reviews, only: [:index]
+      end
+    end
+  end
 end

data/db/migrate/20081020220724_create_reviews.rb

@@ -1,4 +1,6 @@
-class CreateReviews < ActiveRecord::Migration
+# frozen_string_literal: true
+
+class CreateReviews < SolidusSupport::Migration[4.2]
   def self.up
     create_table :reviews do |t|
       t.integer :product_id
@@ -7,7 +9,7 @@ class CreateReviews < ActiveRecord::Migration
       t.integer :rating
       t.text    :title
       t.text    :review
-      t.boolean :approved, :default => false
+      t.boolean :approved, default: false
       t.timestamps
     end
   end

data/db/migrate/20101222083309_create_feedback_reviews.rb

@@ -1,9 +1,11 @@
-class CreateFeedbackReviews < ActiveRecord::Migration
+# frozen_string_literal: true
+
+class CreateFeedbackReviews < SolidusSupport::Migration[4.2]
   def self.up
     create_table :feedback_reviews do |t|
       t.integer :user_id
-      t.integer :review_id, :null => false
-      t.integer :rating,    :default => 0
+      t.integer :review_id, null: false
+      t.integer :rating,    default: 0
       t.text    :comment
       t.timestamps
     end

data/db/migrate/20110406083603_add_rating_to_products.rb

@@ -1,11 +1,13 @@
-class AddRatingToProducts < ActiveRecord::Migration
+# frozen_string_literal: true
+
+class AddRatingToProducts < SolidusSupport::Migration[4.2]
   def self.up
     if table_exists?('products')
-      add_column :products, :avg_rating, :decimal, :default => 0.0, :null => false, :precision => 7, :scale => 5
-      add_column :products, :reviews_count, :integer, :default => 0, :null => false
+      add_column :products, :avg_rating, :decimal, default: 0.0, null: false, precision: 7, scale: 5
+      add_column :products, :reviews_count, :integer, default: 0, null: false
     elsif table_exists?('spree_products')
-      add_column :spree_products, :avg_rating, :decimal, :default => 0.0, :null => false, :precision => 7, :scale => 5
-      add_column :spree_products, :reviews_count, :integer, :default => 0, :null => false
+      add_column :spree_products, :avg_rating, :decimal, default: 0.0, null: false, precision: 7, scale: 5
+      add_column :spree_products, :reviews_count, :integer, default: 0, null: false
     end
   end
 

data/db/migrate/20110606150524_add_user_to_reviews.rb

@@ -1,6 +1,8 @@
-class AddUserToReviews < ActiveRecord::Migration
+# frozen_string_literal: true
+
+class AddUserToReviews < SolidusSupport::Migration[4.2]
   def self.up
-    add_column :reviews, :user_id, :integer, :null => true
+    add_column :reviews, :user_id, :integer, null: true
   end
 
   def self.down

data/db/migrate/20110806093221_add_ip_address_to_reviews.rb

@@ -1,4 +1,6 @@
-class AddIpAddressToReviews < ActiveRecord::Migration
+# frozen_string_literal: true
+
+class AddIpAddressToReviews < SolidusSupport::Migration[4.2]
   def self.up
     add_column :reviews, :ip_address, :string
   end

data/db/migrate/20120110172331_namespace_tables.rb

@@ -1,4 +1,6 @@
-class NamespaceTables < ActiveRecord::Migration
+# frozen_string_literal: true
+
+class NamespaceTables < SolidusSupport::Migration[4.2]
   def change
     rename_table :reviews, :spree_reviews
     rename_table :feedback_reviews, :spree_feedback_reviews

data/db/migrate/20120123141326_recalculate_ratings.rb

@@ -1,17 +1,18 @@
-class RecalculateRatings < ActiveRecord::Migration
+# frozen_string_literal: true
+
+class RecalculateRatings < SolidusSupport::Migration[4.2]
   def up
     Spree::Product.reset_column_information
 
-    Spree::Product.update_all :reviews_count => 0
-    
+    Spree::Product.update_all reviews_count: 0
+
     Spree::Product.joins(:reviews).where("spree_reviews.id IS NOT NULL").find_each do |p|
-      Spree::Product.update_counters p.id, :reviews_count => p.reviews.approved.length
+      Spree::Product.update_counters p.id, reviews_count: p.reviews.approved.length
 
       # recalculate_product_rating exists on the review, not the product
       if p.reviews.approved.count > 0
         p.reviews.approved.first.recalculate_product_rating
       end
-
     end
   end
 

data/db/migrate/20120712182514_add_locale_to_reviews.rb

@@ -1,6 +1,8 @@
-class AddLocaleToReviews < ActiveRecord::Migration
+# frozen_string_literal: true
+
+class AddLocaleToReviews < SolidusSupport::Migration[4.2]
   def self.up
-    add_column :spree_reviews, :locale, :string, :default => 'en'
+    add_column :spree_reviews, :locale, :string, default: 'en'
   end
 
   def self.down

data/db/migrate/20120712182627_add_locale_to_feedback_reviews.rb

@@ -1,6 +1,8 @@
-class AddLocaleToFeedbackReviews < ActiveRecord::Migration
+# frozen_string_literal: true
+
+class AddLocaleToFeedbackReviews < SolidusSupport::Migration[4.2]
   def self.up
-    add_column :spree_feedback_reviews, :locale, :string, :default => 'en'
+    add_column :spree_feedback_reviews, :locale, :string, default: 'en'
   end
 
   def self.down

data/db/migrate/20140703200946_add_show_identifier_to_reviews.rb

@@ -1,4 +1,6 @@
-class AddShowIdentifierToReviews < ActiveRecord::Migration
+# frozen_string_literal: true
+
+class AddShowIdentifierToReviews < SolidusSupport::Migration[4.2]
   def change
     add_column :spree_reviews, :show_identifier, :boolean, default: true
     add_index :spree_reviews, :show_identifier

data/db/migrate/20190613165528_add_verified_purchaser_to_reviews.rb

@@ -0,0 +1,5 @@
+class AddVerifiedPurchaserToReviews < SolidusSupport::Migration[4.2]
+  def change
+    add_column :spree_reviews, :verified_purchaser, :boolean, default: false
+  end
+end

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

@@ -0,0 +1,111 @@
+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
+        if @product
+          @reviews = Spree::Review.default_approval_filter.where(product: @product)
+        else
+          @reviews = 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: 201
+        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: 200
+        else
+          invalid_resource!(@review)
+        end
+      end
+
+      def destroy
+        authorize! :destroy, @review
+
+        if @review.destroy
+          render json: @review, status: 200
+        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
+        if params[:product_id]
+          @product = Spree::Product.friendly.find(params[:product_id])
+        else
+          @product = @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/, '') unless params[:rating].blank?
+      end
+    end
+  end
+end