solidus_multi_domain 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 52d337168f77ee0a5c1645598299ae808ab415e4
+  data.tar.gz: 2bc617558995dfb85db2a816feb05e8be58efab9
+SHA512:
+  metadata.gz: 2d4b32d871c50b2e5a8b8abba49bd16103904da4037a7789d6b849720231712ecf151954d192aef5e3660223c67ba17be04912da400ede556457cbff5068b913
+  data.tar.gz: f491bf9f85566ac2f0b2be660e02cba7ba3654b78b0f3c768591a1d108a3886ed33ff26f4523b87cb8bfeb21dff72b124902428bc6931ed35c9ca6e81644f413

data/.gitignore

@@ -0,0 +1,33 @@
+\#*
+**/*.db
+*~
+.#*
+.DS_Store
+.dotest
+.idea
+.loadpath
+.project
+*.swp
+spec/dummy
+config/*-public.asc
+config/database.yml
+config/mongrel_cluster.yml
+db/*.sql
+db/*.sqlite3*
+db/schema.rb
+doc/**/*
+log/*.log
+public/assets
+public/images
+public/javascripts
+public/stylesheets
+tmp
+vendor/rails
+vendor/extensions/google_base
+public/google_base.xml
+public/template_google_base.xml
+coverage/*
+.bundle
+Gemfile.lock
+.ruby-version
+.ruby-gemset

data/.rspec

@@ -0,0 +1,4 @@
+--color
+--format
+progress
+--backtrace

data/.ruby-version

@@ -0,0 +1 @@
+2.1.6

data/Gemfile

@@ -0,0 +1,9 @@
+source "https://rubygems.org"
+
+gem "solidus", git: "git@github.com:solidusio/solidus.git", branch: "master"
+
+group :development, :test do
+  gem "pry-rails"
+end
+
+gemspec

data/README.md

@@ -0,0 +1,72 @@
+Multi Domain Store
+==================
+
+This extension allows a single Solidus instance to have several customer facing
+stores, with a single shared backend administration system (i.e. multi-store,
+single-vendor).
+
+Current features:
+------------------
+
+1. **Store** model which has the following attributes:
+
+    1.1 name - The display name for the store.
+
+    1.2 domains - a line separated list of fully qualified domain names used to
+    associate a customers session with a particular store (you can use
+    localhost and/or IP addresses too).
+
+    1.3 code - which is a abbreviated version of the store's name (used as the
+    layout directory name, and also helpful for separating partials by store).
+
+    1.4 default - one store should be marked a default as a fallback in case
+    the URL being used to access the site cannot be matched against any of the
+    configured stores.
+
+2. Stores and domains can be maintained via the configuration section of the
+   Admin interface
+
+2. Each store can have its own layout(s) - these layouts should be located in
+   your site's theme extension in the
+   app/views/spree/layouts/_store#code_/directory. So, if you have a store
+   with a code of "alpha" you should store its default layout in
+   app/views/spree/layouts/alpha/spree_application.html.erb
+
+3. Each product can be assigned to one or more stores.
+
+4. All orders are associated with the store / domain that they were placed on.
+
+5. Google analytics trackers can be associated with a store.
+
+Install Instructions
+--------------------
+
+Add to your Gemfile:
+
+```ruby
+gem "solidus_multi_domain"
+```
+
+Then run from the command line:
+
+```shell
+bundle install
+rails g spree_multi_domain:install
+```
+
+You should see 'Stores & Domains' in Configuration tab of Spree Admin.
+
+Features To-do
+--------------
+
+1. Taxonomies - associate stores with taxonomies.
+
+Testing
+-------
+
+Then just run the following to automatically build a dummy app if necessary and
+run the tests:
+
+```shell
+bundle exec rake
+```

data/Rakefile

@@ -0,0 +1,21 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+require 'spree/testing_support/common_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'] = 'solidus_multi_domain'
+  Rake::Task['common:test_app'].invoke
+end

data/app/controllers/concerns/spree_multi_domain/create_line_item_support.rb

@@ -0,0 +1,16 @@
+module SpreeMultiDomain::CreateLineItemSupport
+  extend ActiveSupport::Concern
+
+  included do
+    prepend(InstanceMethods)
+    rescue_from SpreeMultiDomain::LineItemDecorator::ProductDoesNotBelongToStoreError, with: :product_does_not_belong_to_store
+  end
+
+  module InstanceMethods
+    private
+
+    def product_does_not_belong_to_store
+      render json: { message: Spree.t('errors.products_from_different_stores_may_not_be_added_to_this_order') }, status: 422
+    end
+  end
+end

data/app/controllers/concerns/spree_multi_domain/show_product_support.rb

@@ -0,0 +1,17 @@
+module SpreeMultiDomain::ShowProductSupport
+  extend ActiveSupport::Concern
+
+  included do
+    prepend(InstanceMethods)
+    before_filter :can_show_product, :only => :show
+  end
+
+  module InstanceMethods
+    def can_show_product
+      @product ||= Spree::Product.friendly.find(params[:id])
+      if @product.stores.empty? || !@product.stores.include?(current_store)
+        raise ActiveRecord::RecordNotFound
+      end
+    end
+  end
+end

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

@@ -0,0 +1,12 @@
+Spree::Admin::ProductsController.class_eval do
+  update.before :set_stores
+
+  private
+  def set_stores
+    # Remove all store associations if store data is being passed and no stores are selected
+    if params[:update_store_ids] && !params[:product].key?(:store_ids)
+      @product.stores.clear
+    end
+  end
+
+end

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

@@ -0,0 +1,24 @@
+class Spree::Admin::StoresController < Spree::Admin::ResourceController
+
+  before_filter :load_payment_methods
+  before_filter :load_shipping_methods
+
+  def index
+    @stores = @stores.ransack({ name_or_domains_or_code_cont: params[:q] }).result if params[:q]
+    @stores = @stores.where(id: params[:ids].split(',')) if params[:ids]
+
+    respond_with(@stores) do |format|
+      format.html
+      format.json
+    end
+  end
+
+  private
+    def load_payment_methods
+      @payment_methods = Spree::PaymentMethod.all
+    end
+
+    def load_shipping_methods
+      @shipping_methods = Spree::ShippingMethod.all
+    end
+end

data/app/controllers/spree/api/line_items_controller_decorator.rb

@@ -0,0 +1 @@
+Spree::Api::LineItemsController.include SpreeMultiDomain::CreateLineItemSupport

data/app/controllers/spree/api/orders_controller_decorator.rb

@@ -0,0 +1,21 @@
+module SpreeMultiStore
+  module Api
+    module OrdersControllerDecorator
+      def self.included(base)
+        base.alias_method_chain :mine, :store_scope
+        base.alias_method_chain :find_current_api_user_orders, :store_scope
+      end
+
+      def mine_with_store_scope
+        mine_without_store_scope
+        @orders = @orders.where(store: current_store) if @orders
+      end
+
+      def find_current_api_user_orders_with_store_scope
+        find_current_api_user_orders_without_store_scope.where(store: current_store)
+      end
+    end
+  end
+end
+
+Spree::Api::OrdersController.include SpreeMultiStore::Api::OrdersControllerDecorator

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

@@ -0,0 +1 @@
+Spree::Api::ProductsController.include(SpreeMultiDomain::ShowProductSupport)

data/app/controllers/spree/api/shipments_controller_decorator.rb

@@ -0,0 +1,17 @@
+module SpreeMultiStore
+  module Api
+    module ShipmentsControllerDecorator
+      def self.included(base)
+        base.alias_method_chain :mine, :store_scope
+      end
+
+      def mine_with_store_scope
+        mine_without_store_scope
+        @shipments = @shipments.where(spree_orders: { store_id: current_store.id }) if @shipments
+      end
+    end
+  end
+end
+
+Spree::Api::ShipmentsController.include SpreeMultiStore::Api::ShipmentsControllerDecorator
+Spree::Api::ShipmentsController.include SpreeMultiDomain::CreateLineItemSupport

data/app/controllers/spree/home_controller_decorator.rb

@@ -0,0 +1,7 @@
+Spree::HomeController.class_eval do
+  def index
+    @searcher = build_searcher(params)
+    @products = @searcher.retrieve_products
+    @taxonomies = get_taxonomies
+  end
+end

data/app/controllers/spree/products_controller_decorator.rb

@@ -0,0 +1 @@
+Spree::ProductsController.include(SpreeMultiDomain::ShowProductSupport)

data/app/controllers/spree/taxons_controller_decorator.rb

@@ -0,0 +1,10 @@
+Spree::TaxonsController.class_eval do
+   def show
+    @taxon = Spree::Taxon.find_by_store_id_and_permalink!(current_store.id, params[:id])
+    return unless @taxon
+
+    @searcher = build_searcher(params.merge(:taxon => @taxon.id))
+    @products = @searcher.retrieve_products
+    @taxonomies = get_taxonomies
+  end
+end

data/app/helpers/spree/products_helper_decorator.rb

@@ -0,0 +1,11 @@
+module Spree
+  module Api
+    ProductsHelper.class_eval do
+      def get_taxonomies
+        @taxonomies ||= current_store.present? ? Spree::Taxonomy.where(["store_id = ?", current_store.id]) : Spree::Taxonomy
+        @taxonomies = @taxonomies.includes(:root => :children)
+        @taxonomies
+      end
+    end
+  end
+end

data/app/mailers/spree/carton_mailer_decorator.rb

@@ -0,0 +1,13 @@
+Spree::CartonMailer.class_eval do
+  def from_address_with_multidomain
+    order = @carton.orders.first
+
+    if order.store
+      order.store.mail_from_address
+    else
+      from_address_without_multidomain
+    end
+  end
+
+  alias_method_chain :from_address, :multidomain
+end

data/app/mailers/spree/order_mailer.rb

@@ -0,0 +1,35 @@
+module Spree
+  class OrderMailer < BaseMailer
+    def confirm_email(order, resend = false)
+      find_order(order)
+      subject = (resend ? "[#{Spree.t(:resend).upcase}] " : '')
+      subject += "#{Spree::Store.default.name} #{Spree.t('order_mailer.confirm_email.subject')} ##{@order.number}"
+      mail_params = {:to => @order.email, :subject => subject}
+      if @order.store.present? && @order.store.mail_from_address.present?
+        mail_params[:from] = @order.store.mail_from_address
+      else
+        mail_params[:from] = Spree::Store.default.mail_from_address
+      end
+      mail(mail_params)
+    end
+
+    def cancel_email(order, resend = false)
+      find_order(order)
+      subject = (resend ? "[#{Spree.t(:resend).upcase}] " : '')
+      subject += "#{Spree::Store.default.name} #{Spree.t('order_mailer.cancel_email.subject')} ##{@order.number}"
+      mail_params = {:to => @order.email, :subject => subject}
+      if @order.store.present? && @order.store.mail_from_address.present?
+        mail_params[:from] = @order.store.mail_from_address
+      else
+        mail_params[:from] = Spree::Store.default.mail_from_address
+      end
+      mail(mail_params)
+    end
+
+    private
+
+    def find_order(order)
+      @order = order.is_a?(Spree::Order) ? order : Spree::Order.find(order)
+    end
+  end
+end

data/app/models/spree/order_decorator.rb

@@ -0,0 +1,8 @@
+Spree::Order.class_eval do
+  belongs_to :store
+  scope :by_store, lambda { |store| where(:store_id => store.id) }
+
+  def available_payment_methods
+    @available_payment_methods ||= Spree::PaymentMethod.available(:front_end, store)
+  end
+end

data/app/models/spree/payment_method_decorator.rb

@@ -0,0 +1,13 @@
+Spree::PaymentMethod.class_eval do
+  has_many :store_payment_methods
+  has_many :stores, :through => :store_payment_methods
+
+  def self.available(display_on = 'both', store = nil)
+    result = all.select do |p|
+      p.active &&
+        (p.environment == Rails.env || p.environment.blank?) &&
+        (store.nil? || store.payment_methods.empty? || store.payment_methods.include?(p)) &&
+        (p.display_on == display_on.to_s || p.display_on.blank?)
+    end
+  end
+end

data/app/models/spree/product_decorator.rb

@@ -0,0 +1,4 @@
+Spree::Product.class_eval do
+  has_and_belongs_to_many :stores, :join_table => 'spree_products_stores'
+  scope :by_store, lambda { |store| joins(:stores).where("spree_products_stores.store_id = ?", store) }
+end

data/app/models/spree/promotion/rules/store.rb

@@ -0,0 +1,30 @@
+module Spree
+  class Promotion
+    module Rules
+      class Store < PromotionRule
+        has_and_belongs_to_many :stores, :class_name => 'Spree::Store', :join_table => 'spree_promotion_rules_stores', :foreign_key => 'promotion_rule_id'
+
+        def applicable?(promotable)
+          promotable.is_a?(Spree::Order)
+        end
+
+        def eligible?(order, options = {})
+          stores.none? or stores.include?(order.store)
+        end
+
+        def applicable?(promotable)
+          promotable.is_a?(Spree::Order)
+        end
+
+        def store_ids_string
+          store_ids.join(',')
+        end
+
+        def store_ids_string=(s)
+          self.store_ids = s.to_s.split(',').map(&:strip)
+        end
+
+      end
+    end
+  end
+end

data/app/models/spree/shipping_method_decorator.rb

@@ -0,0 +1,18 @@
+Spree::ShippingMethod.class_eval do
+  has_many :store_shipping_methods
+  has_many :stores, :through => :store_shipping_methods
+
+  # This adds store_match to the list of requirements.
+  # This will need to be fixed for Spree 2.0 when split shipments is added
+  def available_to_order?(order, display_on= nil)
+    available?(order, display_on) &&
+    within_zone?(order) &&
+    category_match?(order) &&
+    currency_match?(order) &&
+    store_match?(order)
+  end
+
+  def store_match?(order)
+    order.store.shipping_methods.empty? || stores.include?(order.store)
+  end
+end