atkhayar-dev-spree-multi-vendor 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f8d441270696f26a0ec197744282b7e53cb4a397a0286096865cdb40aaf53602
+  data.tar.gz: e5426a049d5bb36210ddaf1f805a8d665a702a495ff6d389234ff18079fc4e1a
+SHA512:
+  metadata.gz: ad638c991ec5c6d4a30b90ab19cb29122ffc85304e7be0a3c45e0f8e3640893a7490377518177175648d42890033c068f1d5656026be1477141280de9734ec7d
+  data.tar.gz: 4896ff5234fe10c63eaa544729bee2039feac8b04f0021fc9f912cd9a3db68f015c0da592bfca1cdcd0d1395580dc687c32988c4228587b047250e7c25aac889

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+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/LICENSE

@@ -0,0 +1,26 @@
+Copyright (c) 2017 Spark Solutions Sp. z o.o.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright notice,
+      this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright notice,
+      this list of conditions and the following disclaimer in the documentation
+      and/or other materials provided with the distribution.
+    * Neither the name Spree nor the names of its contributors may be used to
+      endorse or promote products derived from this software without specific
+      prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
+CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,181 @@
+# 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.
+
+## Developed by
+
+[![Vendo](https://assets-global.website-files.com/6230c485f2c32ea1b0daa438/623372f40a8c54ca9aea34e8_vendo%202.svg)](https://getvendo.com?utm_source=spree_multi_vendor_github)
+
+> All-in-one platform for all your Marketplace and B2B eCommerce needs. [Start your 30-day free trial](https://e98esoirr8c.typeform.com/contactvendo?typeform-source=spree_multi_vendor_github)
+
+## Open source vs Vendo
+
+If you need a product that has all of the features out of the box, such us supplier onboarding, Stripe connect payment splitting and payouts, and don't require any custom development - we recommend using [Vendo](http://getvendo.com?utm_source=spree_multi_vendor_github) which is also based on Spree.
+
+| feature | open source | [vendo] |
+|---|---|---|
+| basic vendorization | ✔️ | ✔️ |
+| supplier onboarding | | ✔️ |
+| supplier dashboard | | ✔️ |
+| supplier management | | ✔️ |
+| supplier product curation | | ✔️ |
+| automatic payment splitting | | ✔️ |
+| automatic payouts | | ✔️ |
+| Afterpay / klarna / apple pay | | ✔️ |
+| shopify / bigcommerce / woocommerce integration | | ✔️ |
+| USPS, UPS, FedEx, DHL, and more | | ✔️ |
+| bulk upload / import of products from CSV and XSLX | | ✔️ |
+| bulk export of orders, shipments and more | | ✔️ |
+
+## Installation
+
+1. Add this extension to your Gemfile with this line:
+    ```ruby
+    gem 'spree_multi_vendor'
+    ```
+
+2. Install the gem using Bundler:
+    ```ruby
+    bundle install
+    ```
+
+3. Copy & run migrations
+    ```ruby
+    bundle exec rails g spree_multi_vendor:install
+    ```
+
+4. Restart your server
+
+    If your server was running, restart it so that it can find the assets properly.
+
+5. Optionally you can also create sample Vendor by running:
+
+   ```bash
+   bundle exec rake spree_multi_vendor:sample:create
+   ```
+
+## Upgrading
+
+1. Fetch new database migrations:
+
+    ```bash
+    bundle exec rake railties:install:migrations FROM=spree_multi_vendor
+    ```
+
+2. Run migrations
+
+    ```bash
+    bundle exec rails db:migrate
+    ```
+
+## Configuration
+
+To change which models should be vendorized, in your Spree initializer (`config/initializers/spree.rb`) add:
+
+```ruby
+SpreeMultiVendor::Config[:vendorized_models] = %w[product variant stock_location shipping_method other_model]
+```
+
+This will lookup for `Spree::OtherModel` class. To add `vendor_id` column to that model run:
+
+```bash
+bundle exec rails g migration AddVendorToSpreeOtherModels vendor:references
+```
+
+## API endpoints
+
+Spree Multi Vendor adds new [API v2](https://api.spreecommerce.org/docs/api-v2/api/docs/v2/storefront/index.yaml) endpoints:
+
+1. `GET` Display Vendor information endpoint
+    
+     ```
+     /api/v2/storefront/vendors/<vendor_slug>
+     ```
+     
+     eg. `/api/v2/storefront/vendors/test-vendor`
+
+     you can also include Vendor image and/or Products in that call:
+
+     `/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):
+
+    ```
+    /api/v2/storefront/products?filter[vendor_ids]=1,2,3
+    ```
+
+2. `GET` Include Vendor information in Cart endpoint:
+
+    ```
+    /api/v2/storefront/cart?include=vendors,vendor_totals
+    ```
+
+## Email previews
+
+Spree offers emails preview generator for development purposes.
+To generate them, use command:
+
+`bundle exec rails g spree_multi_vendor:mailers_preview`
+
+After that, start rails server locally and go to:
+`localhost:3000/rails/mailers`
+
+(it requires seeded development database in order to work properly)
+
+## Testing
+
+First bundle your dependencies, then run `rake`. `rake` will default to building the dummy app if it does not exist, then it will run specs. The dummy app can be regenerated by using `rake test_app`.
+
+```shell
+bundle
+bundle exec rake
+```
+
+When testing your applications integration with this extension you may use it's factories.
+Simply add this require statement to your spec_helper:
+
+```ruby
+require 'spree_multi_vendor/factories'
+```
+
+## Contributing
+
+If you'd like to contribute, please take a look at the
+[instructions](CONTRIBUTING.md) for installing dependencies and crafting a good
+pull request.
+
+## License
+
+Spree Multi Vendor is copyright © 2017-2021
+[Spark Solutions Sp. z o.o.][spark]. It is free software,
+and may be redistributed under the terms specified in the
+[LICENCE](LICENSE) file.
+
+[LICENSE]: https://github.com/spark-solutions/spree_braintree_vzero/blob/master/LICENSE
+
+## About Vendo
+
+<a href="https://getvendo.com?utm_source=spree_multi_vendor_github">
+  <img src="https://uploads-ssl.webflow.com/6230c485f2c32ea1b0daa438/62386b96518cdcbe111f134a_OG%20Image%20(2).png" style="max-height:400px" />
+</a>
+
+> [Vendo][vendo] is a great fit for marketplaces of all sizes - either with own fulfillment and multiple warehouses or in a dropshipping model. Vendo **automates everything** from **vendor onboarding**, accepting buyer **payments in over 135 currencies**, to supplier **payouts in 50 countries**. 
+
+> Vendo ensures excellent buyer experience with smooth product discovery and search, a multitude of payment methods and optimal shipping cost calculation. Vendo keeps suppliers happy with easy onboarding, automated products sync using their preferred method and easy payouts.
+
+> [Start your 30-day free trial](https://e98esoirr8c.typeform.com/contactvendo?typeform-source=spree_multi_vendor_github)
+
+[vendo]:http://getvendo.com?utm_source=spree_multi_vendor_github

data/Rakefile

@@ -0,0 +1,21 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+require 'spree/testing_support/extension_rake'
+
+RSpec::Core::RakeTask.new
+
+task :default do
+  if Dir["spec/dummy"].empty?
+    Rake::Task[:test_app].invoke
+    Dir.chdir("../../")
+  end
+  Rake::Task[:spec].invoke
+end
+
+desc 'Generates a dummy app for testing'
+task :test_app do
+  ENV['LIB_NAME'] = 'spree_multi_vendor'
+  Rake::Task['extension:test_app'].invoke
+end

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

@@ -0,0 +1,34 @@
+module Spree
+  module Admin
+    class VendorSettingsController < Spree::Admin::BaseController
+      before_action :authorize
+      before_action :load_vendor
+
+      def update
+        if vendor_params[:image]
+          @vendor.create_image(attachment: vendor_params[:image])
+        end
+        if @vendor.update(vendor_params.except(:image))
+          redirect_to admin_vendor_settings_path
+        else
+          render :edit
+        end
+      end
+
+      private
+
+      def authorize
+        authorize! :manage, :vendor_settings
+      end
+
+      def load_vendor
+        @vendor = current_spree_vendor
+        raise ActiveRecord::RecordNotFound unless @vendor
+      end
+
+      def vendor_params
+        params.require(:vendor).permit(Spree::PermittedAttributes.vendor_attributes)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,68 @@
+module Spree
+  module Admin
+    class VendorsController < ResourceController
+
+      def create
+        if permitted_resource_params[:image]
+          @vendor.build_image(attachment: permitted_resource_params.delete(:image))
+        end
+        super
+      end
+
+      def update
+        if permitted_resource_params[:image]
+          @vendor.create_image(attachment: permitted_resource_params.delete(:image))
+        end
+        format_translations if defined? SpreeGlobalize
+        super
+      end
+
+      def update_positions
+        params[:positions].each do |id, position|
+          vendor = Spree::Vendor.find(id)
+          vendor.set_list_position(position)
+        end
+
+        respond_to do |format|
+          format.js { render plain: 'Ok' }
+        end
+      end
+
+      private
+
+      def find_resource
+        Vendor.with_deleted.friendly.find(params[:id])
+      end
+
+      def collection
+        params[:q] = {} if params[:q].blank?
+        vendors = super.order(priority: :asc)
+        @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|
+          translation = @vendor.translations.find_or_create_by(locale: data[:locale])
+          translation.name = data[:name]
+          translation.about_us = data[:about_us]
+          translation.contact_us = data[:contact_us]
+          translation.slug = data[:slug]
+          translation.save!
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,62 @@
+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
+          spree_authorize! :create, Spree::Vendor
+          @vendor = Spree::Vendor.new(vendor_params)
+          if @vendor.save
+            #render :show, status: 201
+          else
+            invalid_resource!(@vendor)
+          end
+          #render_order()
+        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/platform/vendors_controller.rb

@@ -0,0 +1,32 @@
+module Spree
+  module Api
+    module V2
+      module Platform
+        class VendorsController < ::Spree::Api::V2::Platform::ResourceController
+          private
+
+          def model_class
+            ::Spree::Vendor
+          end
+
+          def scope
+            ::Spree::Vendor.active
+          end
+
+          def resource_serializer
+            Spree::Api::V2::Platform::VendorSerializer
+          end
+
+          def collection_serializer
+            Spree::Api::V2::Platform::VendorSerializer
+          end
+
+          def spree_permitted_attributes
+            super + [:code]
+          end
+        end
+      end
+    end
+  end
+end
+  

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

@@ -0,0 +1,33 @@
+module Spree
+  module Api
+    module V2
+      module Storefront
+        class VendorsController < ::Spree::Api::V2::ResourceController
+          
+          private
+
+          def model_class
+            ::Spree::Vendor
+          end
+
+          def scope
+            ::Spree::Vendor.active
+          end
+
+          def resource
+            scope.find_by(slug: params[:id]) || scope.find(params[:id])
+          end
+
+          def resource_serializer
+            Spree::V2::Storefront::VendorSerializer
+          end
+
+          def collection_serializer
+            Spree::V2::Storefront::VendorSerializer
+          end
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,10 @@
+module SpreeMultiVendor::Spree::Admin::BaseControllerDecorator
+  Spree::Admin::BaseController.include(Spree::Admin::VendorHelper)
+
+  def self.prepended(base)
+    base.helper_method :current_spree_vendor
+    base.helper_method :vendor_state_options
+  end
+end
+
+Spree::Admin::BaseController.prepend SpreeMultiVendor::Spree::Admin::BaseControllerDecorator

data/app/controllers/spree_multi_vendor/spree/admin/products_controller_decorator.rb

@@ -0,0 +1,79 @@
+require 'typesense'
+
+module SpreeMultiVendor::Spree::Admin::ProductsControllerDecorator
+  def self.prepended(base)
+    base.before_action only: [:create, :update] do
+      set_vendor_id(:product)
+    end
+    # base.after_action :load_product_vendor
+    base.before_action :initiate_ts_client
+    base.after_action :create_ts_product, only: [:create]
+    base.after_action :update_ts_product, only: [:update]
+    base.after_action :delete_ts_product, only: [:destroy]
+  end
+
+  def initiate_ts_client
+    @typesense = Typesense::Client.new(
+      nodes: [
+        {
+          host: 'iraxmydlt35g8v6qp-1.a1.typesense.net',
+          port: 443,
+          protocol: 'https'
+        }
+      ],
+      api_key: 'P524ViQst3aE0xlpbVY7or8bCAWbVtqv',
+      num_retries: 10,
+      healthcheck_interval_seconds: 1,
+      retry_interval_seconds: 0.01,
+      connection_timeout_seconds: 10
+    )
+  end
+
+  def create_ts_product
+    if @product
+      puts @product.vendor_id
+      @product_vendor = Spree::Vendor.find_by(id: @product.vendor_id)
+      classifications = Spree::Classification.where(product_id: @product.id)
+      categories = []
+      if !classifications.empty?
+        classifications.each do |classification|
+          taxon = Spree::Taxon.find_by(id: classification.taxon_id)
+          categories.push(taxon.name)
+        end
+      end
+      document = {
+        'id' => @product.id.to_s,
+        'name' => @product.name,
+        'categories' => categories,
+        'tag' => [],
+        'store_id' => @product_vendor.code
+      }
+      document = @typesense.collections['dev-products'].documents.create(document)
+    end
+  end
+
+  def update_ts_product
+    if @product
+      classifications = Spree::Classification.where(product_id: @product.id)
+      categories = []
+      if !classifications.empty?
+        classifications.each do |classification|
+          taxon = Spree::Taxon.find_by(id: classification.taxon_id)
+          categories.push(taxon.name)
+        end
+      end
+      @typesense.collections['dev-products'].documents[@product.id.to_s].update(
+        'name' => @product.name,
+        'categories' => categories
+      )
+    end
+  end
+
+  def delete_ts_product
+    if @product
+      @typesense.collections['dev-products'].documents[@product.id.to_s].delete()
+    end
+  end
+end
+
+Spree::Admin::ProductsController.prepend SpreeMultiVendor::Spree::Admin::ProductsControllerDecorator

data/app/controllers/spree_multi_vendor/spree/admin/resource_controller_decorator.rb

@@ -0,0 +1,8 @@
+module SpreeMultiVendor::Spree::Admin::ResourceControllerDecorator
+  def set_vendor_id
+    return unless current_spree_vendor
+    params[resource.object_name.to_sym][:vendor_id] = current_spree_vendor.id
+  end
+end
+
+Spree::Admin::ResourceController.prepend SpreeMultiVendor::Spree::Admin::ResourceControllerDecorator

data/app/controllers/spree_multi_vendor/spree/admin/shipping_methods_controller_decorator.rb

@@ -0,0 +1,7 @@
+module SpreeMultiVendor::Spree::Admin::ShippingMethodsControllerDecorator
+  def self.prepended(base)
+    base.before_action :set_vendor_id, only: [:create, :update]
+  end
+end
+
+Spree::Admin::ShippingMethodsController.prepend SpreeMultiVendor::Spree::Admin::ShippingMethodsControllerDecorator

data/app/controllers/spree_multi_vendor/spree/admin/stock_locations_controller_decorator.rb

@@ -0,0 +1,7 @@
+module SpreeMultiVendor::Spree::Admin::StockLocationsControllerDecorator
+  def self.prepended(base)
+    base.before_action :set_vendor_id, only: [:create, :update]
+  end
+end
+
+Spree::Admin::StockLocationsController.prepend SpreeMultiVendor::Spree::Admin::StockLocationsControllerDecorator

data/app/controllers/spree_multi_vendor/spree/admin/users_controller_decorator.rb

@@ -0,0 +1,13 @@
+module SpreeMultiVendor::Spree::Admin::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::Admin::UsersController.prepend SpreeMultiVendor::Spree::Admin::UsersControllerDecorator

data/app/controllers/spree_multi_vendor/spree/admin/variants_controller_decorator.rb

@@ -0,0 +1,7 @@
+module SpreeMultiVendor::Spree::Admin::VariantsControllerDecorator
+  def self.prepended(base)
+    base.before_action :set_vendor_id, only: [:create, :update]
+  end
+end
+
+Spree::Admin::VariantsController.prepend SpreeMultiVendor::Spree::Admin::VariantsControllerDecorator

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

@@ -0,0 +1,17 @@
+module SpreeMultiVendor::Spree::Api::BaseControllerDecorator
+  Spree::Api::V2::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::V2::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::V2::Platform::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::V2::Platform::UsersController.prepend SpreeMultiVendor::Spree::Api::V1::UsersControllerDecorator