shopping_mall 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 80758149dcc1e0346c9e1abfe3517d3b98eb1ed5
+  data.tar.gz: 56a568442842bf76231302dba3fd02ab72e40306
+SHA512:
+  metadata.gz: 1cf4fb7093cfe5c15b5b311c886d482b3df460f0c6ee2fe623b8e6d5757d40cece08ed884882daada120a791f941daea9727f28b36e1efa12ea3e8fe21a2d521
+  data.tar.gz: 6f85554940b37823252822bce83fa503857f77c21fa24565011f3bbc56a3658b38b708545b5c9ece813c13860bc4efd181f5472d84c731b607176f4b698253dd

data/.gitignore

@@ -0,0 +1,27 @@
+*.gem
+.DS_Store
+*.rbc
+.bundle
+.config
+.yardoc
+.ruby-version
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+spec/dummy/*
+db/*.sqlite3
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+rspec.log

data/.rspec

@@ -0,0 +1 @@
+--color -d

data/.travis.yml

@@ -0,0 +1,7 @@
+before_script:
+  - "bundle exec rake test_app"
+script:
+  - "bundle exec rspec spec"
+rvm:
+  - 2.0.0
+language: ruby

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gem 'spree', github: 'spree/spree', branch: 'master'
+gem 'spree_auth_devise', github: 'spree/spree_auth_devise', branch: 'master'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 ground(ctrl)
+
+MIT License
+
+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,94 @@
+# Shopping Mall
+
+Multi-tenancy for Spree 2.3+ using Apartment! This is very alpha. Pull requests are welcomed.
+
+[![Build Status](https://travis-ci.org/groundctrl/shopping_mall.svg?branch=master)](https://travis-ci.org/groundctrl/shopping_mall)
+[![Code Climate](https://codeclimate.com/github/groundctrl/shopping_mall.png)](https://codeclimate.com/github/groundctrl/shopping_mall)
+
+## Installation
+
+#### Bleeding edge
+Add this line to your Spree application's Gemfile:
+
+    gem 'spree', github: 'groundctrl/shopping_mall'
+    
+
+#### Gem (Not ready yet.)
+Add this line to your Spree application's Gemfile:
+> NOTE: Gem is yet to be released (Spree 2.3 isn't out yet.)
+
+    gem 'shopping_mall' # Soon.
+
+
+#### Generators
+Run the bundle command to install it
+
+After installing ShoppingMall you'll need to run the generator:
+
+    rails generate shopping_mall:install
+
+Install adds a `shopping_mall.rb` initializer to your app, and adds the following to your `application.rb`:
+
+```ruby
+config.middleware.insert_before(
+  'ActiveRecord::ConnectionAdapters::ConnectionManagement',
+  'ShoppingMall::Escalator'
+)
+```
+See https://github.com/influitive/apartment/issues/134 for more information on this insert_before hack.
+
+## Config
+
+The following config options should be set up in the `shopping_mall.rb` initializer in your apps config:
+
+    config/initializers/shopping_mall.rb
+    
+#### Escalators
+
+Escalators are thinly wrapped Apartment::Elevators, the current escalators available are: `Subdomain`, `Domain`, and `FirstSubdomain`
+
+#### Excluding Models
+
+If you have some models that should always access the 'public' tenant, you can specify this by configuring Apartment using `ShoppingMall.configure`.  This will yield a config object for you.  You can set excluded models like so:
+
+```ruby
+config.excluded_models = ["Spree::User", ...] # these models will not be multi-tenanted, but remain in the global (public) namespace
+```
+
+Out of the box ShoppingMall has the following Spree models excluded
+
+```ruby
+[
+  'Spree::Country',
+  'Spree::Property',
+  'Spree::Prototype',
+  'Spree::Role',
+  'Spree::State',
+  'Spree::TaxRate',
+  'Spree::Tracker',
+  'Spree::User',
+  'Spree::Zone',
+  'Spree::ZoneMember'
+]
+```
+
+> NOTE: Rails will always access the 'public' tenant when accessing these models,  but note that tables will be created in all schemas.  This may not be ideal, but its done this way because otherwise rails wouldn't be able to properly generate the schema.rb file.
+
+
+## Testing
+
+Generate a dummy application
+
+    bundle exec rake test_app
+
+Running tests
+
+    bundle exec rake spec
+
+## Contributing
+
+1. Fork it ( https://github.com/groundctrl/apartment_spree/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,16 @@
+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'] = 'shopping_mall'
+  ENV['DB'] = 'postgres'
+  Rake::Task['common:test_app'].invoke 'Spree::User'
+end

data/app/models/spree/option_type_decorator.rb

@@ -0,0 +1,7 @@
+Spree::OptionType.class_eval do
+  has_many :option_types_prototypes,
+           class_name: 'Spree::OptionTypesPrototype'
+  has_many :prototypes,
+           through: :option_types_prototypes,
+           class_name: 'Spree::Prototype'
+end

data/app/models/spree/option_types_prototype.rb

@@ -0,0 +1,6 @@
+module Spree
+  class OptionTypesPrototype < ActiveRecord::Base
+    belongs_to :option_type, class_name: 'Spree::OptionType'
+    belongs_to :prototype, class_name: 'Spree::Prototype'
+  end
+end

data/app/models/spree/option_value_decorator.rb

@@ -0,0 +1,6 @@
+Spree::OptionValue.class_eval do
+  has_many :option_values_variants, class_name: 'Spree::OptionValuesVariant'
+  has_many :variants,
+           through: :option_values_variants,
+           class_name: 'Spree::Variant'
+end

data/app/models/spree/option_values_variant.rb

@@ -0,0 +1,6 @@
+module Spree
+  class OptionValuesVariant < ActiveRecord::Base
+    belongs_to :option_value, class_name: 'Spree::OptionValue'
+    belongs_to :variant, class_name: 'Spree::Variant'
+  end
+end

data/app/models/spree/order_decorator.rb

@@ -0,0 +1,6 @@
+Spree::Order.class_eval do
+  has_many :orders_promotions, class_name: 'Spree::OrdersPromotion'
+  has_many :promotions,
+           through: :orders_promotions,
+           class_name: 'Spree::Promotion'
+end

data/app/models/spree/orders_promotion.rb

@@ -0,0 +1,6 @@
+module Spree
+  class OrdersPromotion < ActiveRecord::Base
+    belongs_to :order, class_name: 'Spree::Order'
+    belongs_to :promotion, class_name: 'Spree::Promotion'
+  end
+end

data/app/models/spree/product_decorator.rb

@@ -0,0 +1,6 @@
+Spree::Product.class_eval do
+  has_many :products_promotion_rules, class_name: 'Spree::ProductsPromotionRule'
+  has_many :promotion_rules,
+           through: :products_promotion_rules,
+           class_name: 'Spree::PromotionRule'
+end

data/app/models/spree/products_promotion_rule.rb

@@ -0,0 +1,6 @@
+module Spree
+  class ProductsPromotionRule < ActiveRecord::Base
+    belongs_to :product, class_name: 'Spree::Product'
+    belongs_to :promotion_rule, class_name: 'Spree::PromotionRule'
+  end
+end

data/app/models/spree/promotion_decorator.rb

@@ -0,0 +1,4 @@
+Spree::Promotion.class_eval do
+  has_many :orders_promotions, class_name: 'Spree::OrdersPromotion'
+  has_many :orders, through: :orders_promotions, class_name: 'Spree::Order'
+end

data/app/models/spree/promotion_rule_decorator.rb

@@ -0,0 +1,6 @@
+Spree::PromotionRule.class_eval do
+  has_many :products_promotion_rules
+  has_many :promotion_rules,
+           through: :products_promotion_rules,
+           class_name: 'Spree::ProductsPromotionRules'
+end

data/app/models/spree/properties_prototype.rb

@@ -0,0 +1,6 @@
+module Spree
+  class PropertiesPrototype < ActiveRecord::Base
+    belongs_to :property, class_name: 'Spree::Property'
+    belongs_to :prototype, class_name: 'Spree::Prototype'
+  end
+end

data/app/models/spree/property_decorator.rb

@@ -0,0 +1,16 @@
+Spree::Property.class_eval do
+  has_many :properties_prototypes, class_name: 'Spree::PropertiesPrototype'
+  has_many :prototypes,
+           through: :properties_prototypes,
+           class_name: 'Spree::Prototype'
+
+  class << self
+    alias_method :old_find_all_by_prototype, :find_all_by_prototype
+  end
+
+  def self.find_all_by_prototype(prototype)
+    id = prototype
+    id = prototype.id if prototype.class == Spree::Prototype
+    Spree::PropertiesPrototype.where(prototype_id: id).map(&:property)
+  end
+end

data/app/models/spree/prototype_decorator.rb

@@ -0,0 +1,10 @@
+Spree::Prototype.class_eval do
+  has_many :properties_prototypes, class_name: 'Spree::PropertiesPrototype'
+  has_many :properties,
+           through: :properties_prototypes,
+           class_name: 'Spree::Property'
+  has_many :option_types_prototypes
+  has_many :option_types,
+           through: :option_types_prototypes,
+           class_name: 'Spree::OptionType'
+end

data/app/models/spree/role_decorator.rb

@@ -0,0 +1,4 @@
+Spree::Role.class_eval do
+  has_many :roles_users, class_name: 'Spree::RolesUser'
+  has_many :users, through: :roles_users, class_name: 'Spree::User'
+end

data/app/models/spree/roles_user.rb

@@ -0,0 +1,6 @@
+module Spree
+  class RolesUser < ActiveRecord::Base
+    belongs_to :role, class_name: 'Spree::Role', foreign_key: "user_id"
+    belongs_to :user, class_name: 'Spree::User'
+  end
+end

data/app/models/spree/shipping_method_decorator.rb

@@ -0,0 +1,4 @@
+Spree::ShippingMethod.class_eval do
+  has_many :shipping_methods_zones, class_name: 'Spree::ShippingMethodsZone'
+  has_many :zones, through: :shipping_methods_zones, class_name: 'Spree::Zone'
+end

data/app/models/spree/shipping_methods_zone.rb

@@ -0,0 +1,6 @@
+module Spree
+  class ShippingMethodsZone < ActiveRecord::Base
+    belongs_to :shipping_method, class_name: 'Spree::ShippingMethod'
+    belongs_to :zone, class_name: 'Spree::Zone'
+  end
+end

data/app/models/spree/user_decorator.rb

@@ -0,0 +1,4 @@
+Spree::User.class_eval do
+  has_many :roles_users, class_name: 'Spree::RolesUser'
+  has_many :roles, through: :roles_users, class_name: 'Spree::Role'
+end

data/app/models/spree/variant_decorator.rb

@@ -0,0 +1,6 @@
+Spree::Variant.class_eval do
+  has_many :option_values_variants, class_name: 'Spree::OptionValuesVariant'
+  has_many :option_values,
+           through: :option_values_variants,
+           class_name: 'Spree::OptionValue'
+end

data/app/models/spree/zone_decorator.rb

@@ -0,0 +1,32 @@
+Spree::Zone.class_eval do
+  has_many :shipping_methods_zones, class_name: 'Spree::ShippingMethodsZone'
+  has_many :shipping_methods,
+           through: :shipping_methods_zones,
+           class_name: 'Spree::ShippingMethod'
+
+  scope :order_by_members, -> { order(:zone_members_count, :created_at) }
+  scope :where_country_or_state, ->(address) {
+    where(Spree::ZoneMember.arel_where_country_or_state(address))
+  }
+  scope :matching_zones_for, ->(address) {
+    includes(:zone_members).
+      where_country_or_state(address).
+        order_by_members.
+          references(:zones)
+  }
+
+  class << self
+    alias_method :old_match, :match
+  end
+
+  def self.match(address)
+    return unless address && matches = matching_zones_for(address)
+
+    %w(state country).each do |zone_kind|
+      match = matches.detect { |zone| zone_kind == zone.kind }
+      return match if match
+    end
+
+    matches.first
+  end
+end

data/app/models/spree/zone_member_decorator.rb

@@ -0,0 +1,16 @@
+Spree::ZoneMember.class_eval do
+  %w(country state).each do |type|
+    define_singleton_method "arel_and_in_#{type}_id" do |type_id|
+      send(:"with_#{type}_id", type_id).where_values.reduce(:and)
+    end
+
+    scope :"with_#{type}_id", ->(type_id) {
+      where(zoneable_type: "Spree::#{type.capitalize}", zoneable_id: type_id)
+    }
+  end
+
+  def self.arel_where_country_or_state(address)
+    countries = arel_and_in_country_id address.country_id
+    countries.or(arel_and_in_state_id address.state_id)
+  end
+end

data/config/initializers/shopping_mall_initializer.rb

@@ -0,0 +1,3 @@
+ShoppingMall.configure do |config|
+  config.excluded_models = ShoppingMall::DEFAULT_SPREE_EXCLUSIONS
+end

data/db/migrate/20140611225105_hatbm_to_hmt.rb

@@ -0,0 +1,17 @@
+class HatbmToHmt < ActiveRecord::Migration
+  def change
+    tables_to_mutate.each { |tbl| add_column tbl, :id, :primary_key }
+  end
+
+  def tables_to_mutate
+    [
+      :spree_option_types_prototypes,
+      :spree_option_values_variants,
+      :spree_orders_promotions,
+      :spree_products_promotion_rules,
+      :spree_properties_prototypes,
+      :spree_roles_users,
+      :spree_shipping_methods_zones
+    ]
+  end
+end

data/lib/generators/shopping_mall/install_generator.rb

@@ -0,0 +1,41 @@
+require 'rails/generators/base'
+
+module ShoppingMall
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path('../../templates', __FILE__)
+
+      desc 'Creates initializer and inserts middleware'
+
+      def copy_initializer
+        template 'shopping_mall.rb', 'config/initializers/shopping_mall.rb'
+      end
+
+      def copy_middleware
+        application do
+          <<-STR
+
+    # Inserted with shopping_mall:install
+    config.middleware.insert_before(
+      'ActiveRecord::ConnectionAdapters::ConnectionManagement',
+      'ShoppingMall::Escalator'
+    )
+          STR
+        end
+      end
+
+      def add_migrations
+        run 'bundle exec rake railties:install:migrations FROM=shopping_mall'
+      end
+
+      def run_migrations
+        res = ask 'Would you like to run the migrations now? [Y/n]'
+        if ['', 'y'].include?(res.downcase)
+          run 'bundle exec rake db:migrate'
+        else
+          logger 'Skipping rake db:migrate, don\'t forget to run it!'
+        end
+      end
+    end
+  end
+end

data/lib/generators/templates/shopping_mall.rb

@@ -0,0 +1,20 @@
+ShoppingMall.configure do |config|
+  # Available escalators %w[Subdomain Domain FirstSubdomain]
+  config.escalator = 'Subdomain'
+  # By default ShoppingMall excludes the following Spree models
+  # [
+  #   'Spree::Country',
+  #   'Spree::Property',
+  #   'Spree::Prototype',
+  #   'Spree::Role',
+  #   'Spree::State',
+  #   'Spree::TaxRate',
+  #   'Spree::Tracker',
+  #   'Spree::User',
+  #   'Spree::Zone',
+  #   'Spree::ZoneMember'
+  #  ]
+  #
+  #  Feel free to exclude what you want!
+  #config.exluded_models = ['Some::AwesomeModel']
+end

data/lib/shopping_mall/engine.rb

@@ -0,0 +1,18 @@
+module ShoppingMall
+  class Engine < Rails::Engine
+    require 'spree/core'
+    isolate_namespace Spree
+    engine_name 'shopping_mall'
+
+    config.autoload_paths += Dir["#{config.root}/lib"]
+    config.generators { |gen| gen.test_framework :rspec }
+
+    def self.activate
+      Dir[File.join(__dir__, '../../app/**/*_decorator*.rb')].each do |klass|
+        Rails.application.config.cache_classes ? require(klass) : load(klass)
+      end
+    end
+
+    config.to_prepare(&method(:activate).to_proc)
+  end
+end

data/lib/shopping_mall/escalator.rb

@@ -0,0 +1,20 @@
+module ShoppingMall
+  class Escalator
+    attr_reader :app, :escalator
+
+    def initialize(app)
+      @app = app
+      @escalator = _escalator_factory app
+    end
+
+    def call(env)
+      escalator.call env
+    end
+
+    private
+
+    def _escalator_factory(app)
+      ShoppingMall.escalator_class.new app
+    end
+  end
+end

data/lib/shopping_mall/version.rb

@@ -0,0 +1,3 @@
+module ShoppingMall
+  VERSION = '0.0.1'
+end

data/lib/shopping_mall.rb

@@ -0,0 +1,50 @@
+require 'spree_core'
+require 'apartment'
+require 'apartment/elevators/domain'
+require 'apartment/elevators/first_subdomain'
+require 'apartment/elevators/subdomain'
+require 'shopping_mall/version'
+require 'shopping_mall/engine'
+require 'shopping_mall/escalator'
+
+module ShoppingMall
+
+  DEFAULT_SPREE_EXCLUSIONS = [
+    'Spree::Country',
+    'Spree::Property',
+    'Spree::Prototype',
+    'Spree::Role',
+    'Spree::State',
+    'Spree::TaxRate',
+    'Spree::Tracker',
+    'Spree::User',
+    'Spree::Zone',
+    'Spree::ZoneMember'
+  ]
+
+  ESCALATORS = %w(Domain FirstSubdomain Subdomain)
+
+  def self.configure
+    yield self if block_given?
+  end
+
+  def self.excluded_models
+    Apartment.excluded_models
+  end
+
+  def self.excluded_models=(models)
+    Apartment.configure { |config| config.excluded_models = models }
+  end
+
+  def self.escalator
+    @escalator ||= 'Subdomain'
+  end
+
+  def self.escalator=(escalator)
+    @escalator = escalator
+  end
+
+  def self.escalator_class
+    "Apartment::Elevators::#{escalator}".constantize
+  end
+end

data/lib/tasks/db.rake

@@ -0,0 +1,41 @@
+namespace :tenant do
+  desc "Bootstraps a new tenant."
+  task :bootstrap, [:db_name] => [:environment] do |t, args|
+    if args[:db_name].blank?
+      abort %q(You must supply db_name, with "rake tenant:bootstrap['the_db_name']")
+    end
+
+    db_name = args[:db_name].gsub('-','_')
+
+    puts "Creating database: #{db_name}"
+    ActiveRecord::Base.establish_connection
+    ActiveRecord::Base.connection.execute("DROP SCHEMA IF EXISTS #{db_name} CASCADE")
+    Apartment::Database.create db_name
+
+    ENV['RAILS_CACHE_ID'] = db_name
+    Apartment::Database.process(db_name) do
+      ENV['AUTO_ACCEPT'] = 'true'
+      ENV['SKIP_NAG'] = 'yes'
+      if Rails.env.production?
+        admin = Spree::User.find_or_create_by(email: email).tap do |user|
+          user.email = 'god@apartment.com'
+          user.login = user.email
+          user.password = 'elevateme'
+          user.password_confirmation = 'elevateme'
+        end
+
+        admin.roles << Spree::Role.find_or_create_by_name('admin')
+        admin.save
+      end
+
+      # Hack the current method so we're able to return a gateway without a RAILS_ENV
+      Spree::Gateway.class_eval do
+        def self.current
+          Spree::Gateway::Bogus.new
+        end
+      end
+
+      puts "Bootstrap completed successfully"
+    end
+  end
+end

data/shopping_mall.gemspec

@@ -0,0 +1,40 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'shopping_mall/version'
+
+Gem::Specification.new do |spec|
+  spec.platform      = Gem::Platform::RUBY
+  spec.name          = 'shopping_mall'
+  spec.version       = ShoppingMall::VERSION
+  spec.authors       = ['Vincent Franco', 'David Freerksen']
+  spec.summary       = 'Multi-tenancy for Spree >= 2.3'
+  spec.license       = 'MIT'
+  spec.description   = spec.summary
+  spec.required_ruby_version = '>= 1.9.3'
+
+  spec.homepage     = 'http://github.com/groundctrl/shopping_mall'
+  spec.files        = `git ls-files`.split("\n")
+  spec.test_files   = `git ls-files -- spec/*`.split("\n")
+  spec.require_path = 'lib'
+  spec.has_rdoc     = false
+  spec.requirements  << 'none'
+
+  spec.add_dependency 'spree_core', '~> 2.3.0.beta'
+  spec.add_dependency 'apartment', '~> 0.24'
+  spec.add_development_dependency 'ffaker', '~> 1.16'
+  spec.add_development_dependency 'capybara', '~> 2.2'
+  spec.add_development_dependency 'database_cleaner', '1.2'
+  spec.add_development_dependency 'poltergeist', '1.5'
+  spec.add_development_dependency 'rspec-rails', '~> 2.14'
+  spec.add_development_dependency 'factory_girl', '~> 4.4'
+  spec.add_development_dependency 'sqlite3', '~> 1.3'
+  spec.add_development_dependency 'simplecov', '~> 0.7'
+  spec.add_development_dependency 'coffee-rails', '~> 4.0'
+  spec.add_development_dependency 'sass-rails', '~> 4.0'
+  spec.add_development_dependency 'guard-rspec', '~> 4.2'
+  spec.add_development_dependency 'pry', '~> 0.9'
+  spec.add_development_dependency 'pg', '~> 0.11'
+  spec.add_development_dependency 'debugger', '~> 1.6'
+  spec.add_development_dependency 'shoulda-matchers', '~> 2.5'
+end