spree_drop_ship 3.1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b8ec93dffafe0fa3317797b375deb1a2ac1de64e
+  data.tar.gz: 5550de66c5fcaf3adc6994e9892ebf554b70c705
+SHA512:
+  metadata.gz: 22e0e8ff176b4c628b1db7ea4f92eb7af1425af8bde1548395c0ca16b797cebe52c808ed027ea5c265927bfd3234bb4de3bf75a7e321af4e695994e17cd1a7e2
+  data.tar.gz: 882264fb878a354f141fe3e78eca54e1e3300b2d560cc46d65952bd8adbfea993a6109a58d3614dbdc6525b5422db90842adcf2c2173205c0449e5897f08b659

data/.gitignore

@@ -0,0 +1,18 @@
+\#*
+*~
+.#*
+.bundle
+.DS_Store
+.idea
+.project
+.ruby-gemset
+.ruby-version
+.sass-cache
+coverage
+Gemfile.lock
+tmp
+nbproject
+pkg
+*.swp
+spec/dummy
+spec/vcr_cassettes

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+group :development, :test do
+  spree_branch = 'master'
+  gem 'spree',                  github: 'spree/spree', branch: spree_branch
+  gem 'spree_auth_devise',      github: 'spree/spree_auth_devise', branch: spree_branch
+end
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2016 Yad Faeq
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,116 @@
+# Spree Drop Ship
+
+
+* Notice: This [gem](https://github.com/spree-contrib/spree_drop_ship)'s skeleton was on Spree Contrib, and then I forked [this](https://github.com/mattfran/spree_drop_ship/tree/master). Credits to their work, though both were broken and left behind. This is a new version with few changes.
+
+*  current state :
+
+ 1. fixed the original issue #73 Ransack related `state_eq`
+ 2. Version Spree `3.1.0`
+ 3. also some smaller errors from the gem.
+
+
+
+
+What is drop shipping?
+
+"Drop shipping is a supply chain management technique in which the retailer does not keep goods in stock, but instead transfers customer orders
+and shipment details to either the manufacturer or a wholesaler, who then ships the goods directly to the customer." - [wikipedia](http://en.wikipedia.org/wiki/Drop_shipping)
+
+So the main goal with spree_drop_ship is to link products to suppliers and forward orders to the appropriate suppliers.
+
+Once an order is placed for a product that belongs to a supplier a shipment is created for the product's supplier.
+This shipment is then sent to the supplier (via Email by default). The supplier then follows a link to the shipment
+within the email where they are prompted to confirm the shipment.
+
+Spree Drop Ship used with [Spree Marketplace](https://github.com/jdutil/spree_marketplace) allows handling payments to your suppliers via ACH direct deposits.  
+This is still currently a work in progress, and any input is welcome.
+.
+
+
+Installation
+------------
+
+Here's how to install spree_drop_ship into your existing spree site AFTER you've installed Spree:
+
+Add the following to your Gemfile:
+
+    gem 'spree_drop_ship', github: '0bserver07/spree_drop_ship'
+
+Make your bundle happy:
+
+    bundle install
+
+Now run the generator:
+
+    rails g spree_drop_ship:install
+
+Then migrate your database if you did not run during installation generator:
+
+    bundle exec rake db:migrate
+
+And reboot your server:
+
+    rails s
+
+You should be up and running now!
+
+Sample Data
+-----------
+
+If you'd like to generate sample data, use the included rake tasks:
+
+```shell
+rake spree_sample:load               # Loads sample data into the store
+rake spree_sample:suppliers          # Create sample suppliers and randomly link to products
+rake spree_sample:drop_ship_orders   # Create sample drop ship orders
+```
+
+Demo
+----
+
+You can easily use the spec/dummy app as a demo of spree_drop_ship. Just `cd` to where you develop and run:
+
+```shell
+git clone git://github.com/spree-contrib/spree_drop_ship.git
+cd spree_drop_ship
+bundle install
+bundle exec rake test_app
+cd spec/dummy
+rake db:migrate db:seed spree_sample:load spree_sample:suppliers spree_sample:drop_ship_orders
+rails s
+```
+
+Testing
+-------
+
+* Needs To be updated
+
+Todo
+----
+
+- Stock Items should automatically be set to backorderable false if the variant doesnt belong to the stock locations supplier.
+- Must allow suppliers to edit their stock location addresses & require it.
+- Return Authorization UI
+- Better documentation
+- related products should only allow suppliers own products to be related
+
+Contributing
+------------
+
+In the spirit of [free software](http://www.fsf.org/licensing/essays/free-sw.html), **everyone** is encouraged to help improve this project.
+
+Here are some ways *you* can contribute:
+
+* by using prerelease versions
+* by reporting [bugs](https://github.com/spree-contrib/spree_drop_ship/issues)
+* by suggesting new features
+* by [translating to a new language](https://github.com/spree-contrib/spree_drop_ship/tree/master/config/locales)
+* by writing or editing documentation
+* by writing specifications
+* by writing code (*no patch is too small*: fix typos, add comments, clean up inconsistent whitespace)
+* by refactoring code
+* by resolving [issues](https://github.com/spree-contrib/spree_drop_ship/issues)
+* by reviewing patches
+
+

data/Rakefile

@@ -0,0 +1,15 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+require 'spree/testing_support/common_rake'
+
+RSpec::Core::RakeTask.new
+
+task :default => [:spec]
+
+desc 'Generates a dummy app for testing'
+task :test_app do
+  ENV['LIB_NAME'] = 'spree_drop_ship'
+  Rake::Task['common:test_app'].invoke 'Spree::User'
+end

data/Versionfile

@@ -0,0 +1,6 @@
+# This file is used to designate compatibilty with different versions of Spree
+# Please see http://spreecommerce.com/documentation/extensions.html#versionfile for details
+# '1.3.x' => { :ref => 'e5624f7' } # Not going to be maintained but most of the works there if your looking for a starting point to branch off of.
+
+'2.4.x' => { :branch => 'master' }
+'2.3.x' => { :branch => '2-3-stable' }

data/app/assets/javascripts/spree/backend/spree_drop_ship.js

@@ -0,0 +1,2 @@
+//= require spree/backend
+// Shipments AJAX API

data/app/assets/javascripts/spree/frontend/spree_drop_ship.js

@@ -0,0 +1 @@
+//= require spree/frontend

data/app/assets/stylesheets/spree/backend/spree_drop_ship.scss

@@ -0,0 +1,22 @@
+/*
+ *= require spree/backend
+*/
+
+.center {
+  text-align: center;
+}
+
+.state.delivered:before,
+.state.confirmed:before {
+  background-color: #ff9300;
+}
+
+.supplier-banks ol li {
+  margin-left: 20px;
+  margin-bottom: 5px;
+  text-align: left;
+}
+
+a .without-textdecor{
+  text-decoration: none;
+}

data/app/assets/stylesheets/spree/frontend/spree_drop_ship.css

@@ -0,0 +1,3 @@
+/*
+ *= require spree/frontend
+*/

data/app/controllers/ckeditor/attachment_files_controller_decorator.rb

@@ -0,0 +1,20 @@
+if defined?(Ckeditor::AttachmentFilesController)
+  Ckeditor::AttachmentFilesController.class_eval do
+
+    load_and_authorize_resource :class => 'Ckeditor::AttachmentFile'
+    after_filter :set_supplier, only: [:create]
+
+    def index
+    end
+
+    private
+
+    def set_supplier
+      if try_spree_current_user.supplier? and @attachment
+        @attachment.supplier = try_spree_current_user.supplier
+        @attachment.save
+      end
+    end
+
+  end
+end

data/app/controllers/ckeditor/pictures_controller_decorator.rb

@@ -0,0 +1,17 @@
+if defined?(Ckeditor::PicturesController)
+  Ckeditor::PicturesController.class_eval do
+    load_and_authorize_resource :class => 'Ckeditor::Picture'
+    after_filter :set_supplier, only: [:create]
+
+    def index
+    end
+
+    private
+    def set_supplier
+      if spree_current_user.supplier? and @picture
+        @picture.supplier = spree_current_user.supplier
+        @picture.save
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+class Spree::Admin::DropShipSettingsController < Spree::Admin::BaseController
+
+  def edit
+    @config = Spree::DropShipConfiguration.new
+  end
+
+  def update
+    config = Spree::DropShipConfiguration.new
+
+    params.each do |name, value|
+      next unless config.has_preference? name
+      config[name] = value
+    end
+
+    flash[:success] = Spree.t('admin.drop_ship_settings.update.success')
+    redirect_to spree.edit_admin_drop_ship_settings_path
+  end
+
+end

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

@@ -0,0 +1,19 @@
+Spree::Admin::ProductsController.class_eval do
+
+  before_filter :get_suppliers, only: [:edit, :update]
+  before_filter :supplier_collection, only: [:index]
+
+  private
+
+  def get_suppliers
+    @suppliers = Spree::Supplier.order(:name)
+  end
+
+  # Scopes the collection to the Supplier.
+  def supplier_collection
+    if try_spree_current_user && !try_spree_current_user.admin? && try_spree_current_user.supplier?
+      @collection = @collection.joins(:suppliers).where('spree_suppliers.id = ?', try_spree_current_user.supplier_id)
+    end
+  end
+
+end

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

@@ -0,0 +1,47 @@
+module Spree
+  module Admin
+    class ShipmentsController < Spree::Admin::ResourceController
+
+      def index
+        params[:q] ||= {}
+        # params[:q][:completed_at_null] ||= '1'
+        # @show_only_incomplete = params[:q][:completed_at_null].present?
+        # params[:q][:s] ||= @show_only_incomplete ? 'created_at desc' : 'completed_at desc'
+
+        # As date params are deleted if @show_only_incomplete, store
+        # the original date so we can restore them into the params
+        # after the search
+        created_at_gt = params[:q][:created_at_gt]
+        created_at_lt = params[:q][:created_at_lt]
+
+        if !params[:q][:created_at_gt].blank?
+          params[:q][:created_at_gt] = Time.zone.parse(params[:q][:created_at_gt]).beginning_of_day rescue ""
+        end
+
+        if !params[:q][:created_at_lt].blank?
+          params[:q][:created_at_lt] = Time.zone.parse(params[:q][:created_at_lt]).end_of_day rescue ""
+        end
+
+        @search = Spree::Shipment.accessible_by(current_ability, :index).ransack(params[:q])
+        @shipments = @search.result.
+          page(params[:page]).
+          per(params[:per_page] || Spree::Config[:orders_per_page])
+
+        # Restore dates
+        params[:q][:created_at_gt] = created_at_gt
+        params[:q][:created_at_lt] = created_at_lt
+      end
+
+      private
+
+      def find_resource
+        if parent_data.present?
+          parent.send(controller_name).find_by!(number: params[:id])
+        else
+          model_class.find_by!(number: params[:id])
+        end
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+Spree::Admin::StockLocationsController.class_eval do
+
+  create.after :set_supplier
+
+  private
+
+  def set_supplier
+    if try_spree_current_user.supplier?
+      @object.supplier = try_spree_current_user.supplier
+      @object.save
+    end
+  end
+
+end

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

@@ -0,0 +1,32 @@
+class Spree::Admin::SuppliersController < Spree::Admin::ResourceController
+
+  def edit
+    @object.address = Spree::Address.default unless @object.address.present?
+    respond_with(@object) do |format|
+      format.html { render :layout => !request.xhr? }
+      format.js   { render :layout => false }
+    end
+  end
+
+  def new
+    @object = Spree::Supplier.new(address_attributes: {country_id: Spree::Address.default.country_id})
+  end
+
+  private
+
+    def collection
+      params[:q] ||= {}
+      params[:q][:meta_sort] ||= "name.asc"
+      @search = Spree::Supplier.search(params[:q])
+      @collection = @search.result.page(params[:page]).per(Spree::Config[:orders_per_page])
+    end
+
+    def find_resource
+      Spree::Supplier.friendly.find(params[:id])
+    end
+
+    def location_after_save
+      spree.edit_admin_supplier_path(@object)
+    end
+
+end

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

@@ -0,0 +1,18 @@
+Spree::Api::V1::StockLocationsController.class_eval do
+
+  before_filter :supplier_locations, only: [:index]
+  before_filter :supplier_transfers, only: [:index]
+
+  private
+
+  def supplier_locations
+    params[:q] ||= {}
+    params[:q][:supplier_id_eq] = spree_current_user.supplier_id
+  end
+
+  def supplier_transfers
+    params[:q] ||= {}
+    params[:q][:supplier_id_eq] = spree_current_user.supplier_id
+  end
+
+end

data/app/controllers/spree/base_controller_decorator.rb

@@ -0,0 +1,23 @@
+Spree::BaseController.class_eval do
+
+  prepend_before_filter :redirect_supplier
+  # before_action :authorize_supplier
+
+  private
+
+  def authorize_supplier
+    if respond_to?(:model_class, true) && model_class
+      record = model_class
+    else
+      record = controller_name.to_sym
+    end
+    authorize! :supplier, record
+    authorize! :action, record
+  end
+
+  def redirect_supplier
+    if ['/admin', '/admin/authorization_failure'].include?(request.path) && try_spree_current_user.try(:supplier)
+      redirect_to '/admin/shipments' and return false
+    end
+  end
+  end

data/app/mailers/spree/drop_ship_order_mailer.rb

@@ -0,0 +1,13 @@
+module Spree
+  class DropShipOrderMailer < Spree::BaseMailer
+
+    default from: Spree::Store.current.mail_from_address
+
+    def supplier_order(shipment_id)
+      @shipment = Shipment.find shipment_id
+      @supplier = @shipment.supplier
+      mail to: @supplier.email, subject: Spree.t('drop_ship_order_mailer.supplier_order.subject', name: Spree::Store.current.name, number: @shipment.number)
+    end
+
+  end
+end

data/app/mailers/spree/supplier_mailer.rb

@@ -0,0 +1,12 @@
+module Spree
+  class SupplierMailer < Spree::BaseMailer
+
+    default from: Spree::Store.current.mail_from_address
+
+    def welcome(supplier_id)
+      @supplier = Supplier.find supplier_id
+      mail to: @supplier.email, subject: Spree.t('supplier_mailer.welcome.subject')
+    end
+
+  end
+end

data/app/models/ckeditor/asset_decorator.rb

@@ -0,0 +1,5 @@
+if defined?(Ckeditor)
+  Ckeditor::Asset.class_eval do
+    belongs_to :supplier, class_name: 'Spree::Supplier'
+  end
+end

data/app/models/spree/drop_ship_configuration.rb

@@ -0,0 +1,17 @@
+module Spree
+  class DropShipConfiguration < Preferences::Configuration
+
+    # Automatically deliver drop ship orders by default.
+    preference :automatically_deliver_orders_to_supplier, :boolean, default: true
+
+    # Default flat rate to charge suppliers per order for commission.
+    preference :default_commission_flat_rate, :float, default: 0.0
+
+    # Default percentage to charge suppliers per order for commission.
+    preference :default_commission_percentage, :float, default: 0.0
+
+    # Determines whether or not to email a new supplier their welcome email.
+    preference :send_supplier_email, :boolean, default: true
+
+  end
+end

data/app/models/spree/order_decorator.rb

@@ -0,0 +1,27 @@
+Spree::Order.class_eval do
+
+  has_many :stock_locations, through: :shipments
+  has_many :suppliers, through: :stock_locations
+
+  # Once order is finalized we want to notify the suppliers of their drop ship orders.
+  # Here we are handling notification by emailing the suppliers.
+  # If you want to customize this you could override it as a hook for notifying a supplier with a API request instead.
+  def finalize_with_drop_ship!
+    finalize_without_drop_ship!
+    shipments.each do |shipment|
+      if SpreeDropShip::Config[:send_supplier_email] && shipment.supplier.present?
+        begin
+          Spree::DropShipOrderMailer.supplier_order(shipment.id).deliver!
+        rescue => ex #Errno::ECONNREFUSED => ex
+          puts ex.message
+          puts ex.backtrace.join("\n")
+          Rails.logger.error ex.message
+          Rails.logger.error ex.backtrace.join("\n")
+          return true # always return true so that failed email doesn't crash app.
+        end
+      end
+    end
+  end
+  alias_method_chain :finalize!, :drop_ship
+
+end

data/app/models/spree/payment_decorator.rb

@@ -0,0 +1,7 @@
+module Spree
+  Payment.class_eval do
+
+    belongs_to :payable, polymorphic: true
+
+  end
+end

data/app/models/spree/product_decorator.rb

@@ -0,0 +1,32 @@
+Spree::Product.class_eval do
+
+  has_many :suppliers, through: :master
+
+  def add_supplier!(supplier_or_id)
+    supplier = supplier_or_id.is_a?(Spree::Supplier) ? supplier_or_id : Spree::Supplier.find(supplier_or_id)
+    populate_for_supplier! supplier if supplier
+  end
+
+  def add_suppliers!(supplier_ids)
+    Spree::Supplier.where(id: supplier_ids).each do |supplier|
+      populate_for_supplier! supplier
+    end
+  end
+
+  # Returns true if the product has a drop shipping supplier.
+  def supplier?
+    suppliers.present?
+  end
+
+  private
+
+  def populate_for_supplier!(supplier)
+    variants_including_master.each do |variant|
+      unless variant.suppliers.pluck(:id).include?(supplier.id)
+        variant.suppliers << supplier
+        supplier.stock_locations.each { |location| location.propagate_variant(variant) }
+      end
+    end
+  end
+
+end

data/app/models/spree/shipment_decorator.rb

@@ -0,0 +1,39 @@
+Spree::Shipment.class_eval do
+  self.whitelisted_ransackable_attributes = ['number', 'state']
+  # TODO here to fix cancan issue thinking its just Order
+  belongs_to :order, class_name: 'Spree::Order', touch: true, inverse_of: :shipments
+
+  has_many :payments, as: :payable
+
+  scope :by_supplier, -> (supplier_id) { joins(:stock_location).where(spree_stock_locations: { supplier_id: supplier_id }) }
+
+  delegate :supplier, to: :stock_location
+
+  def display_final_price_with_items
+    Spree::Money.new final_price_with_items
+  end
+
+  def final_price_with_items
+    self.item_cost + self.final_price
+  end
+
+  # TODO move commission to spree_marketplace?
+  def supplier_commission_total
+    ((self.final_price_with_items * self.supplier.commission_percentage / 100) + self.supplier.commission_flat_rate)
+  end
+
+  private
+
+  durably_decorate :after_ship, mode: 'soft', sha: 'e8eca7f8a50ad871f5753faae938d4d01c01593d' do
+    original_after_ship
+
+    if supplier.present?
+      update_commission
+    end
+  end
+
+  def update_commission
+    update_column :supplier_commission, self.supplier_commission_total
+  end
+
+end

data/app/models/spree/stock/splitter/drop_ship.rb

@@ -0,0 +1,42 @@
+module Spree
+  module Stock
+    module Splitter
+      class DropShip < Spree::Stock::Splitter::Base
+
+        def split(packages)
+          split_packages = []
+          packages.each do |package|
+            # Package fulfilled items together.
+            fulfilled = package.contents.select { |content| content.variant.suppliers.count == 0 }
+            split_packages << build_package(fulfilled)
+            # Determine which supplier to package drop shipped items.
+            drop_ship = package.contents.select { |content| content.variant.suppliers.count > 0 }
+            drop_ship.each do |content|
+              # Select the related variant
+              variant = content.variant
+              # Select suppliers ordering ascending according to cost.
+              suppliers = variant.supplier_variants.order("spree_supplier_variants.cost ASC").map(&:supplier)
+              # Select first supplier that has stock location with avialable stock item.
+              available_supplier = suppliers.detect do |supplier|
+                supplier.stock_locations_with_available_stock_items(variant).any?
+              end
+              # Select the first available stock location with in the available_supplier stock locations.
+              stock_location = nil
+              if available_supplier.present?
+                stock_location = available_supplier.stock_locations_with_available_stock_items(variant).first
+              end
+              # Add to any existing packages or create a new one.
+              if existing_package = split_packages.detect { |p| p.stock_location == stock_location }
+                existing_package.contents << content
+              else
+                split_packages << Spree::Stock::Package.new(stock_location, [content])
+              end
+            end
+          end
+          return_next split_packages
+        end
+
+      end
+    end
+  end
+end