spree_multi_vendor 2.0.1 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2249038a9dae7dde5d3c7b0eb3833921f4bdd0144ab76fa5c7277e53ee4aadce
-  data.tar.gz: 555815de55c3298001c60c753b69974e1d524db73257a130a661279b4ec3e594
+  metadata.gz: fc35d0a2ae81399b7daa7f806f69725d71bfb5f7ea5b54ff0680d4b95e93e9e9
+  data.tar.gz: a19370e4fc2ae70fd6749ae829560d250ebb579844132d8fa9766043c0374c72
 SHA512:
-  metadata.gz: 6db7385cd15712b90faf63172eb6f2a05bebd0941f12ddd0faa55c53ce44ddca10c1527fb46ecbcd1524d9662e44359bdafb8eb26044012445d9b157552090ba
-  data.tar.gz: 48a0f9438bf8f7df0fc303760be106f23632b40e903f9cea0afc786ab523c181f52677817b0c633b800457a409569a331b9fc8aebfc997f71e53a955d990ff15
+  metadata.gz: 6d55aa0438bf0ef0005320b21b90417370b388502b0b6a8957e5f291b988dd0b8b6c486e3d785360cb4c853b36ce978e5b972dee0a609eb5867435cc40aa532b
+  data.tar.gz: fbb4c2094e074e06edee73ea7338ddcac6d6d800ab1810d3134efdcd5283c0d3976161f7aa9b5803e79ad58e3cc68e71b690aa48e6a4397243c838db3b63f085

data/.github/dependabot.yml

@@ -0,0 +1,7 @@
+version: 2
+updates:
+- package-ecosystem: bundler
+  directory: "/"
+  schedule:
+    interval: daily
+  open-pull-requests-limit: 10

data/.travis.yml

@@ -11,6 +11,7 @@ addons:
 services:
   - mysql
   - postgresql
+  - redis-server
 
 language: ruby
 
@@ -22,14 +23,6 @@ env:
   - DB=mysql
   - DB=postgres
 
-gemfile:
-  - gemfiles/spree_4_2.gemfile
-  - gemfiles/spree_master.gemfile
-
-jobs:
-  allow_failures:
-    - gemfile: gemfiles/spree_master.gemfile
-
 before_install:
   - mysql -u root -e "GRANT ALL ON *.* TO 'travis'@'%';"
 

data/Gemfile

@@ -1,7 +1,10 @@
 source 'https://rubygems.org'
 
-gem 'spree', github: 'spree/spree', branch: 'master'
-gem 'spree_auth_devise', github: 'spree/spree_auth_devise', branch: 'master'
+gem 'spree', github: 'spree/spree', branch: 'main'
+gem 'spree_backend', github: 'spree/spree_backend', branch: 'main'
+gem 'spree_frontend', github: 'spree/spree_legacy_frontend', branch: 'main'
+gem 'spree_emails', github: 'spree/spree', branch: 'main'
+gem 'spree_auth_devise', github: 'spree/spree_auth_devise', branch: 'main'
 gem 'rails-controller-testing'
 
 gemspec

data/README.md

@@ -1,6 +1,6 @@
 # Spree Multi Vendor
 
-[![Build Status](https://travis-ci.org/spree-contrib/spree_multi_vendor.svg?branch=master)](https://travis-ci.org/spree-contrib/spree_multi_vendor)
+[![Build Status](https://travis-ci.com/spree-contrib/spree_multi_vendor.svg?branch=master)](https://travis-ci.com/spree-contrib/spree_multi_vendor)
 
 This is a [spree multi vendor marketplace](https://spreecommerce.org/use-cases/multi-vendor-marketplace/) extension. It's a great starting point if you're building a marketplace on top of [Spree](https://spreecommerce.org). Our goal was flexibility to allow you to tweak it to your needs.
 
@@ -97,6 +97,17 @@ Spree Multi Vendor adds new [API v2](https://api.spreecommerce.org/docs/api-v2/a
 
      `/api/v2/storefront/vendors/test-vendor?include=image,products`
 
+2. `GET` Returns a list of Vendors
+    
+     ```
+     /api/v2/storefront/vendors
+     ```    
+
+     you can also include Vendor image and/or Products in that call:
+
+     `/api/v2/storefront/vendors?include=image,products`
+
+
 And modfies existing:
 
 1. `GET` Filtering Products by Vendor ID(s):

data/app/controllers/spree/admin/vendor_settings_controller.rb

@@ -5,7 +5,7 @@ module Spree
       before_action :load_vendor
 
       def update
-        if vendor_params[:image] && Spree.version.to_f >= 3.6
+        if vendor_params[:image]
           @vendor.create_image(attachment: vendor_params[:image])
         end
         if @vendor.update(vendor_params.except(:image))

data/app/controllers/spree/admin/vendors_controller.rb

@@ -3,14 +3,14 @@ module Spree
     class VendorsController < ResourceController
 
       def create
-        if permitted_resource_params[:image] && Spree.version.to_f >= 3.6
+        if permitted_resource_params[:image]
           @vendor.build_image(attachment: permitted_resource_params.delete(:image))
         end
         super
       end
 
       def update
-        if permitted_resource_params[:image] && Spree.version.to_f >= 3.6
+        if permitted_resource_params[:image]
           @vendor.create_image(attachment: permitted_resource_params.delete(:image))
         end
         format_translations if defined? SpreeGlobalize
@@ -40,10 +40,18 @@ module Spree
         @search = vendors.ransack(params[:q])
 
         @collection = @search.result.
+            includes(vendor_includes).
             page(params[:page]).
             per(params[:per_page])
       end
 
+      def vendor_includes
+        {
+          image: [],
+          products: []
+        }
+      end
+
       def format_translations
         return if params[:vendor][:translations_attributes].blank?
         params[:vendor][:translations_attributes].each do |_, data|

data/app/controllers/spree/api/v1/vendors_controller.rb

@@ -0,0 +1,61 @@
+module Spree
+  module Api
+    module V1
+      class VendorsController < Spree::Api::BaseController
+        def index
+          @vendors = if params[:ids].present?
+                       scope.where(id: params[:ids].split(','))
+                     else
+                       scope.load.ransack(
+                         params[:q]
+                       ).result
+                     end
+          respond_with(@vendors)
+        end
+
+        def show
+          @vendor = scope.find(params[:id])
+          authorize! :show, @vendor
+          respond_with(@vendor)
+        end
+
+        def create
+          authorize! :create, Spree::Vendor
+          @vendor = Spree::Vendor.new(vendor_params)
+          if @vendor.save
+            render :show, status: 201
+          else
+            invalid_resource!(@vendor)
+          end
+        end
+
+        def update
+          @vendor = scope.find(params[:id])
+          authorize! :update, @vendor
+          if @vendor.update(vendor_params)
+            render :show
+          else
+            invalid_resource!(@vendor)
+          end
+        end
+
+        def destroy
+          @vendor = scope.find(params[:id])
+          authorize! :destroy, @vendor
+          @vendor.destroy
+          render plain: nil, status: 204
+        end
+
+        private
+
+        def scope
+          Spree::Vendor.accessible_by(current_ability)
+        end
+
+        def vendor_params
+          params.require(:vendor).permit(Spree::PermittedAttributes.vendor_attributes)
+        end
+      end
+    end
+  end
+end

data/app/controllers/spree/api/v2/storefront/vendors_controller.rb

@@ -3,7 +3,7 @@ module Spree
     module V2
       module Storefront
         class VendorsController < ::Spree::Api::V2::ResourceController
-
+          
           private
 
           def model_class
@@ -21,6 +21,11 @@ module Spree
           def resource_serializer
             Spree::V2::Storefront::VendorSerializer
           end
+
+          def collection_serializer
+            Spree::V2::Storefront::VendorSerializer
+          end
+
         end
       end
     end

data/app/controllers/spree_multi_vendor/spree/api/base_controller_decorator.rb

@@ -0,0 +1,17 @@
+module SpreeMultiVendor::Spree::Api::BaseControllerDecorator
+  Spree::Api::BaseController.include(Spree::Api::VendorHelper)
+
+  def self.prepended(base)
+    base.helper_method :current_spree_vendor
+  end
+
+  private
+
+  def set_vendor_id(resource_name)
+    return unless current_spree_vendor
+
+    params[resource_name][:vendor_id] = current_spree_vendor.id
+  end
+end
+
+::Spree::Api::BaseController.prepend SpreeMultiVendor::Spree::Api::BaseControllerDecorator

data/app/controllers/spree_multi_vendor/spree/api/v1/products_controller_decorator.rb

@@ -0,0 +1,9 @@
+module SpreeMultiVendor::Spree::Api::V1::ProductsControllerDecorator
+  def self.prepended(base)
+    base.before_action only: [:create, :update] do
+      set_vendor_id(:product)
+    end
+  end
+end
+
+Spree::Api::V1::ProductsController.prepend SpreeMultiVendor::Spree::Api::V1::ProductsControllerDecorator

data/app/controllers/spree_multi_vendor/spree/api/v1/users_controller_decorator.rb

@@ -0,0 +1,13 @@
+module SpreeMultiVendor::Spree::Api::V1::UsersControllerDecorator
+  private
+
+  def user_params
+    params.require(:user).permit(permitted_user_attributes |
+                                 [spree_role_ids: [],
+                                  vendor_ids: [],
+                                  ship_address_attributes: permitted_address_attributes,
+                                  bill_address_attributes: permitted_address_attributes])
+  end
+end
+
+Spree::Api::V1::UsersController.prepend SpreeMultiVendor::Spree::Api::V1::UsersControllerDecorator

data/app/finders/spree_multi_vendor/products_finder_decorator.rb

@@ -1,6 +1,6 @@
 module SpreeMultiVendor
   module ProductsFinderDecorator
-    def initialize(scope:, params:, current_currency:)
+    def initialize(scope:, params:, current_currency: nil)
       super
 
       @vendors = params.dig(:filter, :vendor_ids)&.split(',')

data/app/helpers/spree/api/vendor_helper.rb

@@ -0,0 +1,11 @@
+module Spree
+  module Api
+    module VendorHelper
+      def current_spree_vendor
+        if current_api_user.vendors.any? && (!current_api_user.respond_to?(:has_spree_role?) || !current_api_user.has_spree_role?(:admin))
+          current_api_user.vendors.first
+        end
+      end
+    end
+  end
+end

data/app/helpers/spree_multi_vendor/spree/api/api_helpers_decorator.rb

@@ -0,0 +1,19 @@
+module SpreeMultiVendor
+  module Spree
+    module Api
+      module ApiHelpersDecorator
+        def self.prepended(base)
+          base::ATTRIBUTES.push(:vendor_attributes)
+
+          base.mattr_reader *base::ATTRIBUTES
+
+          base.user_attributes << :vendor_ids
+        end
+
+        @@vendor_attributes = [:id, :name, :slug, :state, :about_us, :contact_us]
+      end
+    end
+  end
+end
+
+::Spree::Api::ApiHelpers.prepend(SpreeMultiVendor::Spree::Api::ApiHelpersDecorator)

data/app/models/spree/vendor_ability.rb

@@ -36,8 +36,21 @@ class Spree::VendorAbility
 
   def apply_order_permissions
     cannot :create, Spree::Order
-    can [:admin, :index, :edit, :update, :cart], Spree::Order do |order|
-      (order.vendor_ids & @vendor_ids).any?
+
+    order_scope = if ::Spree::Order.reflect_on_association(:vendor)
+                    { vendor_id: @vendor_ids }
+                  elsif ::Spree::LineItem.reflect_on_association(:vendor)
+                    { line_items: { vendor_id: @vendor_ids } }
+                  elsif ::Spree::Product.reflect_on_association(:vendor)
+                    { line_items: { product: { vendor_id: @vendor_ids } } }
+                  elsif ::Spree::Variant.reflect_on_association(:vendor)
+                    { line_items: { variant: { vendor_id: @vendor_ids } } }
+                  end
+
+    if order_scope.present?
+      can %i[admin show index edit update cart], Spree::Order, order_scope.merge(state: 'complete')
+    else
+      cannot_display_model(Spree::Order)
     end
   end
 
@@ -51,9 +64,8 @@ class Spree::VendorAbility
   end
 
   def apply_option_type_permissions
-    cannot_display_model(Spree::OptionType)
-    can :manage, Spree::OptionType, vendor_id: @vendor_ids
-    can :create, Spree::OptionType
+    can :display, Spree::OptionType
+    can :display, Spree::OptionValue
   end
 
   def apply_price_permissions
@@ -61,8 +73,6 @@ class Spree::VendorAbility
   end
 
   def apply_product_option_type_permissions
-    can :display, Spree::OptionType
-    can :display, Spree::OptionValue
     can :manage,  Spree::ProductOptionType, product: { vendor_id: @vendor_ids }
     can :create,  Spree::ProductOptionType
     can :manage,  Spree::OptionValueVariant, variant: { vendor_id: @vendor_ids }
@@ -71,6 +81,9 @@ class Spree::VendorAbility
 
   def apply_product_permissions
     cannot_display_model(Spree::Product)
+
+    return unless Spree::Product.reflect_on_association(:vendor)
+
     can :manage, Spree::Product, vendor_id: @vendor_ids
     can :create, Spree::Product
   end
@@ -78,7 +91,7 @@ class Spree::VendorAbility
   def apply_properties_permissions
     can :display, Spree::Property
   end
-  
+
   def apply_product_properties_permissions
     can :manage,  Spree::ProductProperty, product: { vendor_id: @vendor_ids }
     can :create,  Spree::ProductProperty
@@ -116,12 +129,14 @@ class Spree::VendorAbility
   end
 
   def apply_variant_permissions
+    cannot_display_model(Spree::Variant)
     can :manage, Spree::Variant, vendor_id: @vendor_ids
     can :create, Spree::Variant
   end
 
   def apply_vendor_permissions
-    can [:admin, :update], Spree::Vendor, id: @vendor_ids
+    can :manage, Spree::Vendor, id: @vendor_ids
+    cannot :create, Spree::Vendor
   end
 
   def apply_vendor_settings_permissions

data/app/models/spree/vendor_user.rb

@@ -1,7 +1,7 @@
 module Spree
   class VendorUser < Spree::Base
     belongs_to :vendor, class_name: 'Spree::Vendor', required: Spree.version.to_f >= 3.5
-    belongs_to :user, class_name: Spree.user_class.name, required: Spree.version.to_f >= 3.5
+    belongs_to :user, class_name: Spree.user_class.name, required: Spree.version.to_f >= 3.5, touch: true
 
     validates :vendor_id, uniqueness: { scope: :user_id }
 

data/app/models/spree_multi_vendor/configuration.rb

@@ -1,5 +1,5 @@
 module SpreeMultiVendor
-  class Configuration < Spree::Preferences::Configuration
+  class Configuration < ::Spree::Preferences::Configuration
     DEFAULT_VENDORIZED_MODELS ||= %w[product variant stock_location shipping_method].freeze
 
    # Some example preferences are shown below, for more information visit:

data/app/models/spree_multi_vendor/spree/order_decorator.rb

@@ -22,7 +22,9 @@ module SpreeMultiVendor::Spree::OrderDecorator
   end
 
   def vendor_subtotal(vendor)
-    vendor_line_items(vendor).sum(&:total)
+    vendor_pre_tax_item_amount(vendor) +
+      vendor_pre_tax_ship_amount(vendor) +
+      vendor_additional_tax_total(vendor)
   end
 
   def vendor_promo_total(vendor)
@@ -66,7 +68,7 @@ module SpreeMultiVendor::Spree::OrderDecorator
   end
 
   # money methods
-  METHOD_NAMES = %w[
+  METHOD_NAMES ||= %w[
     total ship_total subtotal included_tax_total additional_tax_total promo_total
     pre_tax_item_amount pre_tax_ship_amount pre_tax_total commission
   ].freeze
@@ -102,4 +104,4 @@ module SpreeMultiVendor::Spree::OrderDecorator
   end
 end
 
-Spree::Order.prepend SpreeMultiVendor::Spree::OrderDecorator
+Spree::Order.prepend SpreeMultiVendor::Spree::OrderDecorator unless Spree::Order.included_modules.include?(SpreeMultiVendor::Spree::OrderDecorator)

data/app/overrides/spree/admin/shared/_main_menu.rb

@@ -2,7 +2,7 @@ Deface::Override.new(
   virtual_path: 'spree/admin/shared/_main_menu',
   name: 'Display configuration tab for vendors',
   replace: 'erb[silent]:contains("current_store")',
-  text: '<% if can?(:admin, current_store) || current_spree_user.vendors.any? %>'
+  text: '<% if can?(:admin, current_store) || current_spree_user&.vendors&.any? %>'
 )
 Deface::Override.new(
   virtual_path:  'spree/admin/shared/_main_menu',

data/app/serializers/spree/v2/storefront/vendor_order_totals_serializer.rb

@@ -4,6 +4,8 @@ module Spree
       class VendorOrderTotalsSerializer < BaseSerializer
         set_type :vendor_totals
 
+        cache_options store: nil
+
         attributes :name, :subtotal, :ship_total, :total, :display_subtotal,
                    :display_ship_total, :display_total, :promo_total,
                    :display_promo_total, :included_tax_total,

data/app/views/spree/admin/vendor_settings/edit.html.erb

@@ -4,7 +4,7 @@
 
 <%= form_for [:admin, @vendor], url: admin_vendor_settings_url do |f| %>
   <fieldset>
-    <%= render partial: 'spree/shared/error_messages', locals: { target: @vendor } %>
+    <%= render partial: 'spree/admin/shared/error_messages', locals: { target: @vendor } %>
     <div class="form-group">
       <%= f.field_container :name do %>
         <%= f.label :name %>

data/app/views/spree/admin/vendors/_form.html.erb

@@ -1,4 +1,4 @@
-<%= render partial: 'spree/shared/error_messages', locals: { target: @vendor } %>
+<%= render partial: 'spree/admin/shared/error_messages', locals: { target: @vendor } %>
 <div class="form-group">
   <%= f.field_container :name do %>
     <%= f.label :name %>

data/app/views/spree/api/v1/vendors/index.rabl

@@ -0,0 +1,3 @@
+collection @vendors
+
+extends 'spree/api/v1/vendors/show'

data/app/views/spree/api/v1/vendors/show.rabl

@@ -0,0 +1,2 @@
+object @vendor
+attributes *vendor_attributes

data/config/initializers/spree_permitted_attributes.rb

@@ -6,5 +6,7 @@ module Spree
 
     @@vendor_attributes = [:name, :about_us, :contact_us, :notification_email]
     @@vendor_attributes << :image if Spree.version.to_f >= 3.6
+
+    @@product_attributes << :vendor_id if SpreeMultiVendor::Config[:vendorized_models].include?('product')
   end
 end

data/config/locales/es.yml

@@ -7,9 +7,11 @@ es:
     attributes:
       spree/vendor:
         about_us: Acerca de
+        commission_rate: Porcentaje Comisión
         contact_us: Contáctanos
         image: Imagen
         name: Nombre
+        notification_email: Email notificación pedido
         state: estado
         created_at: creado en
         priority: prioridad
@@ -21,6 +23,7 @@ es:
     order_mailer:
       vendor_notification_email:
         dear_vendor: Estimado vendedor,
+        order_summary: Resumen del pedido
         subject: Notificación de vendedor
         thanks: Gracias
     vendor: Vendedor

data/config/routes.rb

@@ -12,8 +12,11 @@ Spree::Core::Engine.routes.draw do
   namespace :api, defaults: { format: 'json' } do
     namespace :v2 do
       namespace :storefront do
-        resources :vendors, only: [:show]
+        resources :vendors, only: [:show,:index]
       end
     end
+    namespace :v1 do
+      resources :vendors
+    end
   end
 end

data/db/migrate/20210728120649_change_vendorized_models_vendor_id_type.rb

@@ -0,0 +1,10 @@
+class ChangeVendorizedModelsVendorIdType < ActiveRecord::Migration[4.2]
+  def change
+    SpreeMultiVendor.vendorized_models.each do |klass|
+      change_column klass.table_name, :vendor_id, :bigint
+    rescue
+      message = "Could not change vendor_id column for spree_#{klass}"
+      Rails.logger.error message
+    end
+  end
+end

data/db/migrate/20210728120910_change_vendor_id_and_user_id_type_for_spree_vendor_users.rb

@@ -0,0 +1,8 @@
+class ChangeVendorIdAndUserIdTypeForSpreeVendorUsers < ActiveRecord::Migration[4.2]
+  def change
+    change_table(:spree_vendor_users) do |t|
+      t.change :vendor_id, :bigint
+      t.change :user_id, :bigint
+    end
+  end
+end

data/db/migrate/20210728121024_change_vendor_id_and_order_id_type_for_spree_order_commissions.rb

@@ -0,0 +1,8 @@
+class ChangeVendorIdAndOrderIdTypeForSpreeOrderCommissions < ActiveRecord::Migration[4.2]
+  def change
+    change_table(:spree_order_commissions) do |t|
+      t.change :vendor_id, :bigint
+      t.change :order_id, :bigint
+    end
+  end
+end

data/lib/spree_multi_vendor/factories.rb

@@ -1,4 +1,4 @@
-FactoryGirl.define do
+FactoryBot.define do
   GEM_ROOT = File.dirname(File.dirname(File.dirname(__FILE__)))
 
   Dir[File.join(GEM_ROOT, 'spec', 'factories', '**', '*.rb')].each do |factory|

data/lib/spree_multi_vendor/version.rb

@@ -1,5 +1,5 @@
 module SpreeMultiVendor
-  VERSION = '2.0.1'
+  VERSION = '2.3.0'
 
   module_function
 

data/lib/spree_multi_vendor.rb

@@ -1,4 +1,5 @@
 require 'spree_core'
+require 'spree_backend'
 require 'spree_multi_vendor/engine'
 require 'spree_multi_vendor/version'
 require 'spree_extension'
@@ -8,7 +9,7 @@ module SpreeMultiVendor
   # TODO: this should be moved into preferences
   def self.vendorized_models
     SpreeMultiVendor::Config[:vendorized_models].map(&:classify).map do |class_name|
-      "Spree::#{class_name}".safe_constantize
+      "::Spree::#{class_name}".safe_constantize
     end.compact.uniq
   end
 end

data/spec/factories/spree/vendor_factory.rb

@@ -9,6 +9,12 @@ FactoryBot.define do
       state { :active }
     end
 
+    factory :active_vendor_list do
+      name { "#{FFaker::Company.name} #{FFaker::Company.suffix }" }
+      state { :active }
+    end
+
+
     factory :pending_vendor do
       name { 'Pending vendor' }
       state { :pending }