Skip to content

armgit / spree

Public Imported from GitHub
0

Open Source Platform for DTC, B2B Commerce, Marketplaces & Omnichannel. REST APIs, TypeScript SDKs, and production-ready Next.js storefront. Self-host it. Own your data. No vendor lock-in. Zero platform fees.

Use cancan authorization for user ability to manage wishlists and wished_variants.

Matthew Kennedy44271ca27c45
diff --git a/api/app/controllers/spree/api/v2/storefront/wishlists_controller.rb b/api/app/controllers/spree/api/v2/storefront/wishlists_controller.rb
index 3f6421b3f4..30c30ee4fa 100644
--- a/api/app/controllers/spree/api/v2/storefront/wishlists_controller.rb
+++ b/api/app/controllers/spree/api/v2/storefront/wishlists_controller.rb
@@ -3,39 +3,35 @@ module Spree
module V2
module Storefront
class WishlistsController < ::Spree::Api::V2::ResourceController
- include Spree::Api::V2::CollectionOptionsHelpers
-
before_action :require_spree_current_user, except: [:show]
- def index
- spree_authorize! :index, Spree::Wishlist
+ def show
+ @resource ||= current_store.wishlists.find_by!(token: params[:id])
- wishlists = spree_current_user.wishlists.for_store(current_store).page(params[:page]).per(params[:per_page])
+ raise ActiveRecord::RecordNotFound unless @resource.viewable?(spree_current_user)
- render_serialized_payload { serialize_collection(wishlists) }
+ render_serialized_payload { serialize_resource(@resource) }
end
def create
spree_authorize! :create, Spree::Wishlist
- wishlist = spree_current_user.wishlists.new(wishlist_attributes)
- ensure_current_store(wishlist)
+ @wishlist = spree_current_user.wishlists.new(wishlist_attributes)
- wishlist.save
+ ensure_current_store(@wishlist)
- if wishlist.persisted?
- render_serialized_payload(201) { serialize_resource(wishlist) }
+ @wishlist.save
+
+ if @wishlist.persisted?
+ render_serialized_payload(201) { serialize_resource(@wishlist) }
else
- render_error_payload(wishlist.errors.full_messages.to_sentence)
+ render_error_payload(@wishlist.errors.full_messages.to_sentence)
end
end
- def show
- render_serialized_payload { serialize_resource(resource) }
- end
-
def update
authorize! :update, resource
+
resource.update wishlist_attributes
if resource.errors.empty?
@@ -47,6 +43,7 @@ module Spree
def destroy
authorize! :destroy, resource
+
if resource.destroy
render_serialized_payload { serialize_resource(resource) }
else
@@ -57,38 +54,37 @@ module Spree
def default
spree_authorize! :create, Spree::Wishlist
- default_wishlist = spree_current_user.default_wishlist_for_store(current_store)
+ @default_wishlist = spree_current_user.default_wishlist_for_store(current_store)
- render_serialized_payload { serialize_resource(default_wishlist) }
+ render_serialized_payload { serialize_resource(@default_wishlist) }
end
def add_item
spree_authorize! :create, Spree::WishedVariant
- spree_authorize! :update, resource
- wished_variant = Spree::WishedVariant.new(params.permit(:quantity, :remark, :variant_id))
+ @wished_variant = Spree::WishedVariant.new(params.permit(:quantity, :variant_id))
if resource.include? params[:variant_id]
- wished_variant = resource.wished_variants.detect { |wv| wv.variant_id == params[:variant_id] }
+ @wished_variant = resource.wished_variants.detect { |wv| wv.variant_id == params[:variant_id] }
else
- wished_variant.wishlist = resource
- wished_variant.save
+ @wished_variant.wishlist = resource
+ @wished_variant.save
end
resource.reload
- if wished_variant.persisted?
- render_serialized_payload { serialize_wished_variant(wished_variant) }
+ if @wished_variant.persisted?
+ render_serialized_payload { serialize_wished_variant(@wished_variant) }
else
render_error_payload(resource.errors.full_messages.to_sentence)
end
end
def update_item_quantity
- return render_error_item_quantity unless params[:quantity].to_i > 0
-
spree_authorize! :update, wished_variant
+ return render_error_item_quantity unless params[:quantity].to_i > 0
+
wished_variant.update(params.permit(:quantity))
if wished_variant.errors.empty?
@@ -99,7 +95,7 @@ module Spree
end
def remove_item
- spree_authorize! :update, wished_variant
+ spree_authorize! :destroy, wished_variant
if wished_variant.destroy
render_serialized_payload { serialize_wished_variant(wished_variant) }
@@ -110,10 +106,16 @@ module Spree
private
+ def scope
+ super.where(user: spree_current_user)
+ end
+
def resource
- @resource ||= current_store.wishlists.find_by!(token: params[:id])
+ @resource ||= scope.find_by(token: params[:id])
+ end
- return @resource if @resource.can_be_read_by?(spree_current_user)
+ def model_class
+ Spree::Wishlist
end
def resource_serializer
@@ -121,7 +123,7 @@ module Spree
end
def collection_serializer
- ::Spree::V2::Storefront::WishlistSerializer
+ resource_serializer
end
def wishlist_attributes
@@ -137,7 +139,7 @@ module Spree
end
def serialize_wished_variant(wished_variant)
- wished_variant_serializer.new(
+ ::Spree::V2::Storefront::WishedVariantSerializer.new(
wished_variant,
params: serializer_params,
include: resource_includes,
@@ -145,10 +147,6 @@ module Spree
).serializable_hash
end
- def wished_variant_serializer
- ::Spree::V2::Storefront::WishedVariantSerializer
- end
-
def render_error_item_quantity
render json: { error: I18n.t('spree.api.v2.wishlist.wrong_quantity') }, status: 422
end
diff --git a/api/spec/serializers/spree/api/v2/storefront/wished_variant_serializer_spec.rb b/api/spec/serializers/spree/api/v2/storefront/wished_variant_serializer_spec.rb
index c0de10fd25..9823d6e386 100644
--- a/api/spec/serializers/spree/api/v2/storefront/wished_variant_serializer_spec.rb
+++ b/api/spec/serializers/spree/api/v2/storefront/wished_variant_serializer_spec.rb
@@ -4,7 +4,7 @@ describe Spree::V2::Storefront::WishedVariantSerializer do
subject { described_class.new(wished_variant, params: { currency: 'USD' }) }
let!(:wishlist) { create(:wishlist) }
- let!(:wished_variant) { create(:wished_variant, wishlist: wishlist, variant: create(:variant), quantity: 5 ) }
+ let!(:wished_variant) { create(:wished_variant, wishlist: wishlist, variant: create(:variant), quantity: 5) }
it { expect(subject.serializable_hash).to be_kind_of(Hash) }
diff --git a/api/spec/serializers/spree/api/v2/storefront/wishlist_serializer_spec.rb b/api/spec/serializers/spree/api/v2/storefront/wishlist_serializer_spec.rb
index e340ce1bba..50a5318222 100644
--- a/api/spec/serializers/spree/api/v2/storefront/wishlist_serializer_spec.rb
+++ b/api/spec/serializers/spree/api/v2/storefront/wishlist_serializer_spec.rb
@@ -4,7 +4,7 @@ describe Spree::V2::Storefront::WishlistSerializer do
subject { described_class.new(wishlist) }
let!(:wishlist) { create(:wishlist) }
- let!(:wished_variant) { create(:wished_variant, wishlist: wishlist, variant: create(:variant), quantity: 1 ) }
+ let!(:wished_variant) { create(:wished_variant, wishlist: wishlist, variant: create(:variant), quantity: 1) }
it { expect(subject.serializable_hash).to be_kind_of(Hash) }
@@ -22,7 +22,7 @@ describe Spree::V2::Storefront::WishlistSerializer do
},
relationships: {
user: {
- data:{
+ data: {
id: wishlist.user.id.to_s,
type: :user
}
diff --git a/core/app/models/concerns/spree/user_methods.rb b/core/app/models/concerns/spree/user_methods.rb
index 4a72b067b2..6ddbea920d 100644
--- a/core/app/models/concerns/spree/user_methods.rb
+++ b/core/app/models/concerns/spree/user_methods.rb
@@ -25,7 +25,7 @@ module Spree
belongs_to :ship_address, class_name: 'Spree::Address', optional: true
belongs_to :bill_address, class_name: 'Spree::Address', optional: true
- has_many :wishlists, class_name: 'Spree::Wishlist'
+ has_many :wishlists, class_name: 'Spree::Wishlist', foreign_key: :user_id
self.whitelisted_ransackable_associations = %w[bill_address ship_address addresses]
self.whitelisted_ransackable_attributes = %w[id email]
diff --git a/core/app/models/spree/ability.rb b/core/app/models/spree/ability.rb
index 02abdd74e3..3ccb0dba40 100644
--- a/core/app/models/spree/ability.rb
+++ b/core/app/models/spree/ability.rb
@@ -1,8 +1,9 @@
-# Implementation class for Cancan gem. Instead of overriding this class, consider adding new permissions
+# Implementation class for Cancan gem. Instead of overriding this class, consider adding new permissions
# using the special +register_ability+ method which allows extensions to add their own abilities.
#
-# See http://github.com/ryanb/cancan for more details on cancan.
+# See https://github.com/CanCanCommunity/cancancan for more details.
require 'cancan'
+
module Spree
class Ability
include CanCan::Ability
@@ -85,6 +86,10 @@ module Spree
can :read, ::Spree::Taxonomy
can :read, ::Spree::Variant
can :read, ::Spree::Zone
+ can :manage, ::Spree::Wishlist, user_id: user.id
+ can [:create, :update, :destroy], Spree::WishedVariant do |wished_variant|
+ wished_variant.wishlist.user == user
+ end
end
def protect_admin_role
diff --git a/core/app/models/spree/wishlist.rb b/core/app/models/spree/wishlist.rb
index d94236163b..1c8323654f 100644
--- a/core/app/models/spree/wishlist.rb
+++ b/core/app/models/spree/wishlist.rb
@@ -4,7 +4,7 @@ module Spree
has_secure_token
- belongs_to :user, class_name: Spree.user_class.to_s, touch: true
+ belongs_to :user, class_name: Spree.user_class.name, touch: true
belongs_to :store, class_name: 'Spree::Store'
has_many :wished_variants, class_name: 'Spree::WishedVariant', dependent: :destroy
@@ -24,7 +24,7 @@ module Spree
find_by(token: param)
end
- def can_be_read_by?(user)
+ def viewable?(user)
public? || user == self.user
end
diff --git a/core/spec/models/spree/wishlist_spec.rb b/core/spec/models/spree/wishlist_spec.rb
index b126a8f4d1..63b20b818e 100644
--- a/core/spec/models/spree/wishlist_spec.rb
+++ b/core/spec/models/spree/wishlist_spec.rb
@@ -87,17 +87,17 @@ describe Spree::Wishlist, type: :model do
end
end
- describe '.can_be_read_by?' do
+ describe '.viewable?' do
context 'when the wishlist is private' do
it 'is true when the user owns the wishlist' do
wishlist.is_private = true
- expect(wishlist.can_be_read_by?(user)).to be true
+ expect(wishlist.viewable?(user)).to be true
end
it 'is false when the user does not own the wishlist' do
wishlist.is_private = true
other_user = create(:user)
- expect(wishlist.can_be_read_by?(other_user)).to be false
+ expect(wishlist.viewable?(other_user)).to be false
end
end
@@ -105,7 +105,7 @@ describe Spree::Wishlist, type: :model do
it 'is true for any user' do
wishlist.is_private = false
other_user = create(:user)
- expect(wishlist.can_be_read_by?(other_user)).to be true
+ expect(wishlist.viewable?(other_user)).to be true
end
end
end