spree_multi_vendor 2.0.1

checksums.yaml

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

data/.gitignore

@@ -0,0 +1,21 @@
+\#*
+*~
+.#*
+.DS_Store
+.idea
+.localeapp/locales
+.project
+coverage
+Gemfile.lock
+tmp
+nbproject
+pkg
+*.sw?
+spec/dummy
+.rvmrc
+.sass-cache
+public/spree
+.ruby-version
+.ruby-gemset
+gemfiles/*.gemfile.lock
+*.gem

data/.rspec

@@ -0,0 +1,3 @@
+--color
+-r spec_helper
+-f documentation

data/.travis.yml

@@ -0,0 +1,44 @@
+os: linux
+dist: bionic
+
+addons:
+  apt:
+    sources:
+      - google-chrome
+    packages:
+      - google-chrome-stable
+
+services:
+  - mysql
+  - postgresql
+
+language: ruby
+
+rvm:
+  - 2.7
+  - 3.0
+
+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'@'%';"
+
+before_script:
+  - CHROME_MAIN_VERSION=`google-chrome-stable --version | sed -E 's/(^Google Chrome |\.[0-9]+ )//g'`
+  - CHROMEDRIVER_VERSION=`curl -s "https://chromedriver.storage.googleapis.com/LATEST_RELEASE_$CHROME_MAIN_VERSION"`
+  - curl "https://chromedriver.storage.googleapis.com/${CHROMEDRIVER_VERSION}/chromedriver_linux64.zip" -O
+  - unzip chromedriver_linux64.zip -d ~/bin
+
+script:
+  - bundle exec rake test_app
+  - bundle exec rake spec

data/Appraisals

@@ -0,0 +1,11 @@
+appraise 'spree-4-2' do
+  gem 'spree', '~> 4.2.0.rc4'
+  gem 'spree_auth_devise', '~> 4.3'
+  gem 'rails-controller-testing'
+end
+
+appraise 'spree-master' do
+  gem 'spree', github: 'spree/spree', branch: 'master'
+  gem 'spree_auth_devise', github: 'spree/spree_auth_devise', branch: 'master'
+  gem 'rails-controller-testing'
+end

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gem 'spree', github: 'spree/spree', branch: 'master'
+gem 'spree_auth_devise', github: 'spree/spree_auth_devise', branch: 'master'
+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,166 @@
+# 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)
+
+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.
+
+Check out this extension [multi vendor marketplace demo](https://spreecommerce.org/launch-a-multi-vendor-marketplace-within-a-few-weeks-with-spree-commerce/) and launch your marketplace within weeks, not months.
+
+Developed and maintained by:
+
+[![Spark Solutions](http://sparksolutions.co/wp-content/uploads/2015/01/logo-ss-tr-221x100.png)][spark]
+
+## Features
+
+By default you can create and manage Vendors who can manage on their own:
+
+- [X] Orders
+- [X] Products
+- [X] Stock Locations
+- [X] Shipping Methods
+- [X] Vendor profile
+
+Also:
+- [X] Super Admins can assign Users to Vendors
+- [X] You can modify which permissions and models/resources Vendors can manage quite easily
+
+Contributions welcome! :)
+
+## 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`
+
+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 Spark Solutions
+
+[![Spark Solutions](http://sparksolutions.co/wp-content/uploads/2015/01/logo-ss-tr-221x100.png)][spark]
+
+Spree Vendors is maintained by [Spark Solutions Sp. z o.o.](http://sparksolutions.co?utm_source=github)
+
+We are passionate about open source software.
+We are [available for hire][spark].
+
+[spark]:http://sparksolutions.co?utm_source=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] && Spree.version.to_f >= 3.6
+          @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,60 @@
+module Spree
+  module Admin
+    class VendorsController < ResourceController
+
+      def create
+        if permitted_resource_params[:image] && Spree.version.to_f >= 3.6
+          @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
+          @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.
+            page(params[:page]).
+            per(params[:per_page])
+      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/v2/storefront/vendors_controller.rb

@@ -0,0 +1,28 @@
+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
+        end
+      end
+    end
+  end
+end