solidus_marketplace 0.1.0

data/app/models/spree/shipment_decorator.rb

@@ -0,0 +1,40 @@
+Spree::Shipment.class_eval do
+  # 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
+
+  self.whitelisted_ransackable_attributes = ["number", "state"]
+
+  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: '5401c76850108aba74c87a87ff634379bdc844ce' 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/marketplace.rb

@@ -0,0 +1,47 @@
+module Spree
+  module Stock
+    module Splitter
+      class Marketplace < Spree::Stock::Splitter::Base
+
+        def split(packages)
+          begin
+          split_packages = []
+          packages.each do |package|
+            # Package fulfilled items together.
+            fulfilled = package.contents.select { |content|
+              begin
+              content.variant.suppliers.count == 0
+              rescue => e
+              end
+            }
+            split_packages << build_package(fulfilled)
+            # Determine which supplier to package shipped items.
+            supplier_contents = package.contents.select { |content| content.variant.suppliers.count > 0 }
+            supplier_contents.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 = available_supplier.stock_locations_with_available_stock_items(variant).first
+              # 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
+          rescue => e
+          end
+          return_next split_packages
+        end
+
+      end
+    end
+  end
+end

data/app/models/spree/stock_location_decorator.rb

@@ -0,0 +1,23 @@
+Spree::StockLocation.class_eval do
+
+  belongs_to :supplier, class_name: 'Spree::Supplier'
+
+  scope :by_supplier, -> (supplier_id) { where(supplier_id: supplier_id) }
+
+  # Wrapper for creating a new stock item respecting the backorderable config and supplier
+  durably_decorate :propagate_variant, mode: 'soft', sha: '68fd322da48facbdbf567a2391c2495d04c3c8bc' do |variant|
+    if self.supplier_id.blank? || variant.suppliers.pluck(:id).include?(self.supplier_id)
+      self.stock_items.create!(variant: variant, backorderable: self.backorderable_default)
+    end
+  end
+
+  def unpropagate_variant(variant)
+    stock_items = self.stock_items.where(variant: variant)
+    stock_items.map(&:destroy)
+  end
+
+  def available?(variant)
+    stock_item(variant).try(:available?)
+  end
+
+end

data/app/models/spree/supplier.rb

@@ -0,0 +1,120 @@
+class Spree::Supplier < Spree::Base
+  extend FriendlyId
+  # include ActiveModel::ForbiddenAttributesProtection
+  friendly_id :name, use: :slugged
+
+  attr_accessor :password, :password_confirmation
+
+  #==========================================
+  # Associations
+
+  belongs_to :address, class_name: 'Spree::Address'
+  accepts_nested_attributes_for :address
+
+  if defined?(Ckeditor::Asset)
+    has_many :ckeditor_pictures
+    has_many :ckeditor_attachment_files
+  end
+  has_many   :supplier_variants
+  has_many   :variants, through: :supplier_variants
+  has_many   :products, through: :variants
+
+  has_many   :stock_locations
+  has_many   :shipments, through: :stock_locations
+
+  has_many   :users, class_name: Spree.user_class.to_s
+
+  #==========================================
+  # Validations
+
+  validates :commission_flat_rate,   presence: true
+  validates :commission_percentage,  presence: true
+  validates :email,                  presence: true, email: true, uniqueness: true
+  validates :name,                   presence: true, uniqueness: true
+  validates :url,                    format: { with: URI::regexp(%w(http https)), allow_blank: true }
+
+  #==========================================
+  # Callbacks
+
+  after_create :assign_user
+  after_create :create_stock_location
+  after_create :send_welcome, if: -> { SolidusMarketplace::Config[:send_supplier_email] }
+  before_create :set_commission
+  before_validation :check_url
+
+  #==========================================
+  # Instance Methods
+  scope :active, -> { where(active: true) }
+
+  def deleted?
+    deleted_at.present?
+  end
+
+  def user_ids_string
+    user_ids.join(',')
+  end
+
+  def user_ids_string=(s)
+    self.user_ids = s.to_s.split(',').map(&:strip)
+  end
+
+  # Retreive the stock locations that has available
+  # stock items of the given variant
+  def stock_locations_with_available_stock_items(variant)
+    stock_locations.select { |sl| sl.available?(variant) }
+  end
+
+  #==========================================
+  # Protected Methods
+
+  protected
+
+    def assign_user
+      if self.users.empty?
+        if user = Spree.user_class.find_by_email(self.email)
+          self.users << user
+          self.save
+        end
+      end
+    end
+
+    def check_url
+      unless self.url.blank? or self.url =~ URI::regexp(%w(http https))
+        self.url = "http://#{self.url}"
+      end
+    end
+
+    def create_stock_location
+      if self.stock_locations.empty?
+        location = self.stock_locations.build(
+          active: true,
+          country_id: self.address.try(:country_id),
+          name: self.name,
+          state_id: self.address.try(:state_id)
+        )
+        # It's important location is always created.  Some apps add validations that shouldn't break this.
+        location.save validate: false
+      end
+    end
+
+    def send_welcome
+      begin
+        Spree::SupplierMailer.welcome(self.id).deliver_later!
+        # Specs raise error for not being able to set default_url_options[:host]
+      rescue => ex #Errno::ECONNREFUSED => ex
+        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
+
+    def set_commission
+      unless changes.has_key?(:commission_flat_rate)
+        self.commission_flat_rate = SolidusMarketplace::Config[:default_commission_flat_rate]
+      end
+      unless changes.has_key?(:commission_percentage)
+        self.commission_percentage = SolidusMarketplace::Config[:default_commission_percentage]
+      end
+    end
+
+end

data/app/models/spree/supplier_ability.rb

@@ -0,0 +1,35 @@
+module Spree
+  class SupplierAbility
+    include CanCan::Ability
+
+    def initialize(user)
+      user ||= Spree.user_class.new
+
+      if user.supplier_admin?
+        can [:admin, :update, :read, :display, :stock],             Spree::Product, suppliers: { id: user.supplier_id }
+        can [:admin, :create],                              Spree::Product
+				can [:admin, :create, :update, :destroy, :display], Spree::Variant, suppliers: { id: user.supplier_id }
+
+        can [:admin, :display, :index], Spree::Shipment, order: { state: 'complete' },
+                                                 stock_location: { supplier_id: user.supplier_id }
+
+        can [:admin, :display], Spree::ReturnAuthorization, stock_location: { supplier_id: user.supplier_id }
+        can [:admin, :display], Spree::CustomerReturn,      stock_location: { supplier_id: user.supplier_id }
+
+        #FIXME: come back to these when we work on shipping-related issues
+        # can [:admin, :manage, :read, :ready, :ship], Spree::Shipment, order: { state: 'complete' }, stock_location: { supplier_id: user.supplier_id }
+        # can [:admin, :create, :update], :stock_items
+        can [:admin, :index, :create, :edit, :read, :update],  Spree::StockItem,     stock_location: { supplier_id: user.supplier_id }
+        can [:admin, :manage, :create],        Spree::StockLocation, supplier_id: user.supplier_id
+        can [:admin, :manage, :create],        Spree::StockMovement, stock_item: { stock_location: { supplier_id: user.supplier_id } }
+
+        can [:admin, :create, :read, :update, :display], Spree::Supplier, id: user.supplier_id
+        cannot [:create],                                Spree::Supplier
+
+        can [:admin, :manage],       Spree::User,  supplier_id: user.supplier_id
+        can [:admin, :index, :edit], Spree::Order, stock_locations: { supplier_id: user.supplier_id }
+      end
+
+    end
+  end
+end

data/app/models/spree/supplier_variant.rb

@@ -0,0 +1,6 @@
+module Spree
+  class SupplierVariant < Spree::Base
+    belongs_to :supplier
+    belongs_to :variant
+  end
+end

data/app/models/spree/user_decorator.rb

@@ -0,0 +1,23 @@
+Spree.user_class.class_eval do
+
+  belongs_to :supplier, class_name: 'Spree::Supplier'
+
+  has_many :variants, through: :supplier
+
+  def supplier?
+    supplier.present?
+  end
+
+  def supplier_admin?
+    spree_roles.map(&:name).include?("supplier_admin")
+  end
+
+  def market_maker?
+    has_admin_role?
+  end
+
+  def has_admin_role?
+    spree_roles.map(&:name).include?("admin")
+  end
+
+end

data/app/models/spree/variant_decorator.rb

@@ -0,0 +1,24 @@
+module Spree
+  Variant.class_eval do
+
+    has_many :supplier_variants
+    has_many :suppliers, through: :supplier_variants
+
+    before_create :populate_for_suppliers
+
+    private
+
+    durably_decorate :create_stock_items, mode: 'soft', sha: '98704433ac5c66ba46e02699f3cf03d13d4f1281' do
+      StockLocation.all.each do |stock_location|
+        if stock_location.supplier_id.blank? || self.suppliers.pluck(:id).include?(stock_location.supplier_id)
+          stock_location.propagate_variant(self) if stock_location.propagate_all_variants?
+        end
+      end
+    end
+
+    def populate_for_suppliers
+      self.suppliers = self.product.suppliers
+    end
+
+  end
+end

data/app/overrides/spree/admin/menus.rb

@@ -0,0 +1,15 @@
+Deface::Override.new(
+  virtual_path: "spree/admin/shared/_menu",
+  name: "marketplace_menus",
+  insert_bottom: '[data-hook="admin_tabs"]',
+  partial: "spree/admin/shared/marketplace_tabs"
+)
+
+
+Deface::Override.new(
+  virtual_path: "spree/admin/shared/_configuration_menu",
+  name: "marketplace_admin_configurations_menu",
+  insert_bottom: "[data-hook='admin_configurations_sidebar_menu']",
+  disabled: false,
+  partial: "spree/admin/shared/marketplace_settings"
+)

data/app/overrides/spree/admin/products/_form/converted_admin_product_form_right.html.erb.deface

@@ -0,0 +1,5 @@
+<!-- insert_bottom "[data-hook='admin_product_form_right'], #admin_product_form_right[data-hook]" -->
+
+<% if can? :manage, Spree::Supplier %>
+  <!-- TODO allow assignment to variants -->
+<% end %>

data/app/overrides/spree/admin/products/edit/override_rows.html.erb.deface

@@ -0,0 +1,22 @@
+<!-- replace_contents '[data-hook="admin_products_index_rows"]' -->
+
+<%# Changed classes to new like https://github.com/spree/spree/blob/master/backend/app/views/spree/admin/stock_locations/_form.html.erb %>
+<td class="sku"><%= product.sku rescue '' %></td>
+<td class="image"><%= mini_image product, class: "thumbnail" %></td>
+<td>
+  <% if try_spree_current_user && try_spree_current_user.supplier? %>
+    <%= link_to product.try(:name), spree.admin_product_stock_path(product)%>
+  <% else %>
+    <%= link_to product.try(:name), edit_admin_product_path(product) %>
+  <% end %>
+</td>
+<td><%= product.display_price.to_html rescue '' %></td>
+<td class="actions" data-hook="admin_products_index_row_actions">
+  <% if try_spree_current_user && try_spree_current_user.supplier? %>
+    <%= link_to 'Stock Management', spree.admin_product_stock_path(product), title:'Stock Management', class: 'btn btn-default btn-sm with-tip without-textdecor' if can?(:stock, product) && !product.deleted? %>
+  <% else %>
+    <%= link_to_edit product, :no_text => true, :class => 'edit' if can?(:edit, product) && !product.deleted? %>
+  <% end %>
+  <%= link_to_clone product, :no_text => true, :class => 'clone' if can?(:clone, product) %>
+  <%= link_to_delete product, :no_text => true if can?(:delete, product) && !product.deleted? %>
+</td>

data/app/overrides/spree/admin/stock_locations/_form/add_supplier.html.erb.deface

@@ -0,0 +1,12 @@
+<!-- insert_after "[data-hook=admin_stock_locations_form_fields]" -->
+
+<%# Remove extra div and change classes %>
+<% if spree_current_user.admin? %>
+    <div class='form-group'>
+      <%= f.field_container :supplier do %>
+        <%= f.label :supplier_id, Spree.t(:supplier) %>
+        <%= f.collection_select(:supplier_id, Spree::Supplier.all, :id, :name, { :include_blank => 'None' }, { :class => 'select2' }) %>
+        <%= f.error_message_on :supplier %>
+      <% end %>
+    </div>
+<% end %>

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

@@ -0,0 +1,21 @@
+<% content_for :page_title do %>
+    <%= Spree.t("marketplace_settings") %>
+<% end %>
+
+<%= form_tag(spree.admin_marketplace_settings_path, :method => :put) do %>
+    <fieldset class="general no-border-top">
+      <% %w( default_commission_flat_rate default_commission_percentage automatically_deliver_orders_to_supplier send_supplier_email).each do |key|
+        type = SolidusMarketplace::Config.preference_type(key) %>
+          <div class="field col-md-6">
+            <%= label_tag(key, Spree.t(key) + ': ') + tag(:br) if type != :boolean %>
+            <%= preference_field_tag(key, SolidusMarketplace::Config[key], :type => type ,:class => 'form-control')%>
+            <%= label_tag(key, Spree.t(key)) + tag(:br) if type == :boolean %>
+          </div>
+      <% end %>
+      <div class="form-buttons" data-hook="buttons">
+        <%= button Spree.t(:update), 'update' %>
+        <span class="or"><%= Spree.t(:or) %></span>
+        <%= button_link_to Spree.t(:cancel), spree.edit_admin_marketplace_settings_url, :icon => 'cancel' %>
+      </div>
+    </fieldset>
+<% end %>

data/app/views/spree/admin/orders/index.html.erb

@@ -0,0 +1,187 @@
+<% admin_layout "full-width" %>
+
+<% admin_breadcrumb(plural_resource_name(Spree::Order)) %>
+
+
+<% content_for :page_actions do %>
+  <li>
+    <%= button_link_to Spree.t(:new_order), new_admin_order_url, id: 'admin_new_order' %>
+  </li>
+<% end if can? :create, Spree::Order %>
+
+<% content_for :table_filter_title do %>
+  <%= Spree.t(:search) %>
+<% end %>
+
+<% content_for :table_filter do %>
+  <div data-hook="admin_orders_index_search">
+    <%= search_form_for [:admin, @search] do |f| %>
+      <div class="row">
+        <div class="field-block col-12 col-md-6 col-lg-4 col-xl-3">
+          <div class="date-range-filter field">
+            <%= label_tag :q_created_at_gt, Spree.t(:date_range) %>
+            <div class="date-range-fields input-group">
+              <%= f.text_field :created_at_gt, class: 'datepicker form-control datepicker-from', value: params[:q][:created_at_gt], placeholder: Spree.t(:start) %>
+
+              <span class="range-divider input-group-addon">
+                <i class="fa fa-arrow-right"></i>
+              </span>
+
+              <%= f.text_field :created_at_lt, class: 'datepicker form-control datepicker-to', value: params[:q][:created_at_lt], placeholder: Spree.t(:stop) %>
+            </div>
+          </div>
+
+          <div class="field">
+            <%= label_tag :q_state_eq, Spree.t(:status) %>
+            <%= f.select :state_eq, Spree::Order.state_machines[:state].states.collect {|s| [Spree.t("order_state.#{s.name}"), s.value]}, {include_blank: true}, class: 'custom-select fullwidth' %>
+          </div>
+
+          <div class="field">
+            <%= label_tag nil, Spree.t(:promotion) %>
+            <%= f.text_field :order_promotions_promotion_code_value_cont, size: 25 %>
+          </div>
+
+          <div class="field">
+            <%= label_tag nil, Spree.t(:shipment_number) %>
+            <%= f.text_field :shipments_number_cont %>
+          </div>
+
+        </div>
+
+        <div class="col-12 col-md-6 col-lg-4 col-xl-6">
+          <div class="row">
+            <div class="col-12 col-xl-6">
+              <div class="field">
+                <%= label_tag :q_number_cont, Spree.t(:order_number, number: '') %>
+                <%= f.text_field :number_cont %>
+              </div>
+
+              <div class="field">
+                <%= label_tag :q_email_cont, Spree.t(:email) %>
+                <%= f.text_field :email_cont %>
+              </div>
+            </div>
+
+            <div class="col-12 col-xl-6">
+              <div class="field">
+                <%= label_tag :q_bill_address_firstname_start, Spree.t(:first_name_begins_with) %>
+                <%= f.text_field :bill_address_firstname_start, size: 25 %>
+              </div>
+              <div class="field">
+                <%= label_tag :q_bill_address_lastname_start, Spree.t(:last_name_begins_with) %>
+                <%= f.text_field :bill_address_lastname_start, size: 25%>
+              </div>
+            </div>
+
+            <div class="col-12 col-xl-6">
+              <div class="field" data-hook="sku-select">
+                <%= label_tag :q_line_items_variant_id_in, Spree.t(:variant) %>
+                <%= f.text_field :line_items_variant_id_in, class: "variant_autocomplete fullwidth" %>
+              </div>
+            </div>
+          </div>
+        </div>
+
+        <div class="col-12 col-md-6 col-lg-4 col-xl-3">
+          <% if Spree::Store.count > 1 %>
+            <div class="field">
+              <%= label_tag :q_store_id_eq, Spree.t(:store) %>
+              <%= f.select :store_id_eq, Spree::Store.all.map { |s| [s.name, s.id] }, { include_blank: true }, { class: "custom-select fullwidth" } %>
+            </div>
+          <% end %>
+
+          <div class="field checkbox">
+            <label>
+              <%= f.check_box :completed_at_not_null, {checked: @show_only_completed}, '1', '0' %>
+              <%= Spree.t(:show_only_complete_orders) %>
+            </label>
+          </div>
+        </div>
+
+      </div>
+
+      <div class="clearfix"></div>
+
+      <div class="actions filter-actions">
+        <div data-hook="admin_orders_index_search_buttons">
+          <%= button Spree.t(:filter_results) %>
+        </div>
+      </div>
+    <% end %>
+  </div>
+<% end %>
+
+<%= paginate @orders, theme: "solidus_admin" %>
+
+<% if @orders.any? %>
+  <table class="index" id="listing_orders" data-hook>
+    <colgroup>
+       <col style="width: 13%;">
+       <col style="width: 10%;">
+       <col style="width: 10%;">
+       <col style="width: 12%;">
+       <% if Spree::Order.checkout_step_names.include?(:delivery) %>
+         <col style="width: 12%;">
+       <% end %>
+       <col style="width: 25%;">
+       <col style="width: 10%;">
+       <col style="width: 8%;">
+    </colgroup>
+    <thead>
+      <tr data-hook="admin_orders_index_headers">
+        <% if @show_only_completed %>
+          <th><%= sort_link @search, :completed_at %></th>
+        <% else %>
+          <th><%= sort_link @search, :created_at %></th>
+        <% end %>
+        <th><%= sort_link @search, :number %></th>
+        <th><%= sort_link @search, :state %></th>
+        <th><%= sort_link @search, :payment_state %></th>
+        <% if Spree::Order.checkout_step_names.include?(:delivery) %>
+          <th><%= sort_link @search, :shipment_state %></th>
+        <% end %>
+        <th><%= sort_link @search, :email %></th>
+        <th><%= sort_link @search, :total %></th>
+        <th data-hook="admin_orders_index_header_actions" class="actions"></th>
+      </tr>
+    </thead>
+    <tbody>
+    <% @orders.each do |order| %>
+      <tr data-hook="admin_orders_index_rows" class="state-<%= order.state.downcase %> <%= cycle('odd', 'even') %>">
+        <td class="align-center"><%= l (@show_only_completed ? order.completed_at : order.created_at).to_date %></td>
+        <td class="align-center"><%= link_to order.number, edit_admin_order_path(order) %></td>
+        <td class="align-center"><span class="state <%= order.state.downcase %>"><%= Spree.t("order_state.#{order.state.downcase}") %></span></td>
+        <td class="align-center"><span class="state <%= order.payment_state %>"><%= link_to Spree.t("payment_states.#{order.payment_state}"), admin_order_payments_path(order) if order.payment_state %></span></td>
+          <% if Spree::Order.checkout_step_names.include?(:delivery) %>
+            <td class="align-center"><span class="state <%= order.shipment_state %>"><%= Spree.t("shipment_states.#{order.shipment_state}") if order.shipment_state %></span></td>
+          <% end %>
+        <td>
+          <% if order.user %>
+            <%= link_to order.email, edit_admin_user_path(order.user) %>
+          <% else %>
+            <%= mail_to order.email %>
+          <% end %>
+        </td>
+        <td class="align-center">
+          <% if try_spree_current_user.supplier? %>
+            <%= order.supplier_total(try_spree_current_user).to_html %>
+          <% else %>
+            <%= order.display_total.to_html %>
+          <% end %>
+        </td>
+        <td class='actions align-center' data-hook="admin_orders_index_row_actions">
+          <%= link_to_edit_url edit_admin_order_path(order), title: "admin_edit_#{dom_id(order)}", no_text: true %>
+        </td>
+      </tr>
+    <% end %>
+    </tbody>
+  </table>
+<% else %>
+  <div class="col-9 no-objects-found">
+    <%= render 'spree/admin/shared/no_objects_found',
+                 resource: Spree::Order,
+                 new_resource_url: spree.new_admin_order_path %>
+  </div>
+<% end %>
+
+<%= paginate @orders, theme: "solidus_admin" %>