mongoid-multitenancy 0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in mongoid-multitenancy.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,55 @@
+PATH
+  remote: .
+  specs:
+    mongoid-multitenancy (0.1)
+      mongoid (~> 3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (3.2.9)
+      activesupport (= 3.2.9)
+      builder (~> 3.0.0)
+    activesupport (3.2.9)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    builder (3.0.4)
+    database_cleaner (0.9.1)
+    diff-lcs (1.1.3)
+    i18n (0.6.1)
+    mongoid (3.0.14)
+      activemodel (~> 3.1)
+      moped (~> 1.1)
+      origin (~> 1.0)
+      tzinfo (~> 0.3.22)
+    mongoid-rspec (1.5.5)
+      mongoid (>= 3.0.1)
+      rake
+      rspec (>= 2.9)
+    moped (1.3.1)
+    multi_json (1.5.0)
+    origin (1.0.11)
+    rake (10.0.3)
+    redcarpet (2.2.2)
+    rspec (2.12.0)
+      rspec-core (~> 2.12.0)
+      rspec-expectations (~> 2.12.0)
+      rspec-mocks (~> 2.12.0)
+    rspec-core (2.12.1)
+    rspec-expectations (2.12.0)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.12.0)
+    tzinfo (0.3.35)
+    yard (0.8.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  database_cleaner (~> 0.9)
+  mongoid-multitenancy!
+  mongoid-rspec (~> 1.5)
+  rake (~> 10.0)
+  redcarpet (~> 2.2)
+  rspec (~> 2.12)
+  yard (~> 0.8)

data/LICENSE.TXT

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Perfect Memory
+
+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,156 @@
+# mongoid-multitenancy
+
+mongoid-multitenancy adds the ability to scope [Mongoid](https://github.com/mongoid/mongoid) models to a tenant in a **shared database strategy**. Tenants are represented by a tenant model, such as `Client`. mongoid-multitenancy will help you set the current tenant on each request and ensures all 'tenant models' are always properly scoped to the current tenant: when viewing, searching and creating.
+
+It is directly inspired by the [acts_as_tenant gem](https://github.com/ErwinM/acts_as_tenant) for Active Record.
+
+In addition, mongoid-multitenancy:
+
+* allows you to set the current tenant
+* redefines some mongoid functions like `index`, `validates_with` and `delete_all` to take in account the multitenancy
+* makes the tenant field immutable once it is persisted
+* is thread safe.
+
+Installation
+===============
+
+Add this line to your application's Gemfile:
+
+    gem 'mongoid_multitenancy'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mongoid_multitenancy
+
+Usage
+===============
+
+There are two steps in adding multi-tenancy to your app with acts_as_tenant:
+
+1. setting the current tenant and
+2. scoping your models.
+
+Setting the current tenant
+--------------------------
+There are two ways to set the current tenant: (1) by setting the current tenant manually, or (2) by setting the current tenant for a block.
+
+**Setting the current tenant in a controller, manually**
+
+    Mongoid::MultiTenancy.current_tenant = client_instance
+
+Setting the current_tenant yourself requires you to use a before_filter to set the Mongoid::MultiTenancy.current_tenant variable.
+
+**Setting the current tenant for a block**
+
+    Mongoid::MultiTenancy.with_tenant(client_instance) do
+      # Current tenant is set for all code in this block
+    end
+
+This approach is useful when running background processes for a specified tenant. For example, by putting this in your worker's run method,
+any code in this block will be scoped to the current tenant. All methods that set the current tenant are thread safe.
+
+**Note:** If the current tenant is not set by one of these methods, mongoid-multitenancy will apply a global scope to your models, not related to any tenant. So make sure you use one of the two methods to tell mongoid-multitenancy about the current tenant.
+
+Scoping your models
+-------------------
+    class Client
+      include Mongoid::Document
+
+      field :name, :type => String
+      validates_uniqueness_of :name
+    end
+
+    class Article
+      include Mongoid::Document
+      include Mongoid::Multitenancy::Document
+
+      tenant(:client)
+
+      field :title, :type => String
+    end
+
+Adding `tenant` to your model declaration will scope that model to the current tenant **BUT ONLY if a current tenant has been set**.
+The association passed to the `tenant` function must be valid.
+
+Some examples to illustrate this behavior:
+
+    # This manually sets the current tenant for testing purposes. In your app this is handled by the gem.
+    Mongoid::MultiTenancy.current_tenant = Client.find_by(:name => 'Perfect Memory') # => <#Client _id:50ca04b86c82bfc125000025, :name: "Perfect Memory">
+
+    # All searches are scoped by the tenant, the following searches will only return objects belonging to the current client.
+    Article.all # => all articles where client_id => 50ca04b86c82bfc125000025
+
+    # New objects are scoped to the current tenant
+    Article.new(:title => 'New blog') # => <#Article _id: nil, title: 'New blog', :client_id: 50ca04b86c82bfc125000025>
+
+    # It makes the tenant field immutable once it is persisted to avoid inconsistency
+    article.persited? # => true
+    article.client = another_client
+    article.valid? # => false
+
+Rails
+-------------------
+
+If you are using Rails, you may want to set the current tenant at each request.
+
+**Manually set the current tenant in ApplicationController using the host request**
+
+    class ApplicationController < ActionController::Base
+      before_filter :set_current_client
+
+      def set_current_client
+        current_client = Client.find_by_host(request.host)
+        Mongoid::MultiTenancy.current_tenant = current_client
+      end
+    end
+
+Setting the current_tenant yourself requires you to use a before_filter to set the Mongoid::MultiTenancy.current_tenant variable.
+
+Mongoid Uniqueness validators
+-------------------
+
+mongoid-multitenancy will automatically add the tenant foreign key in the scope list for each of uniqueness validators in order
+to avoid to redefine all your validators.
+
+    class Article
+      include Mongoid::Document
+      include Mongoid::Multitenancy::Document
+
+      tenant(:client)
+
+      field :slug
+
+      validates_uniqueness_of :slug # => :scope => client_id is added automatically
+    end
+
+Mongoid indexes
+-------------------
+
+mongoid-multitenancy will automatically add the tenant foreign key in all your mongoid indexes to avoid to redefine all your validators.
+
+    class Article
+      include Mongoid::Document
+      include Mongoid::Multitenancy::Document
+
+      tenant(:client)
+
+      field :title
+
+      index({ :title => 1 }) # => create an index with { :client_id => 1, :title => 1 }
+    end
+
+Author & Credits
+----------------
+mongoid-multitenancy is written by [Aymeric Brisse](https://github.com/abrisse/), from [Perfect Memory](http://www.perfect-memory.com).
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'yard'
+
+YARD::Rake::YardocTask.new
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/mongoid-multitenancy.rb

@@ -0,0 +1 @@
+require 'mongoid/multitenancy'

data/lib/mongoid/multitenancy.rb

@@ -0,0 +1,35 @@
+module Mongoid
+  module Multitenancy
+    require "mongoid"
+
+    require "mongoid/multitenancy/document"
+    require "mongoid/multitenancy/version"
+
+    class << self
+
+      # Set the current tenant. Make it Thread aware
+      def current_tenant=(tenant)
+        Thread.current[:current_tenant] = tenant
+      end
+
+      # Returns the current tenant
+      def current_tenant
+        Thread.current[:current_tenant]
+      end
+
+      # Affects a tenant temporary for a block execution
+      def with_tenant(tenant, &block)
+        if block.nil?
+          raise ArgumentError, "block required"
+        end
+
+        old_tenant = self.current_tenant
+        self.current_tenant = tenant
+
+        block.call
+
+        self.current_tenant = old_tenant
+      end
+    end
+  end
+end

data/lib/mongoid/multitenancy/document.rb

@@ -0,0 +1,64 @@
+module Mongoid
+  module Multitenancy
+    module Document
+      extend ActiveSupport::Concern
+
+      included do
+        private
+
+        # Check that the tenant foreign key field has not been changed once the object has been persisted
+        def check_tenant_immutability
+          self.errors.add(self.class.tenant_field, 'is immutable and cannot be updated' ) if changed.include?(self.class.tenant_field)
+        end
+      end
+
+      module ClassMethods
+        # Access to the tenant field
+        attr_reader :tenant_field
+
+        def tenant(association = :account)
+          # Setup the association between the class and the tenant class
+          # TODO: should index this association if no other indexes are defined => , index: true
+          belongs_to association
+
+          # Get the tenant model and its foreign key
+          fkey = reflect_on_association(association).foreign_key
+          @tenant_field = fkey
+
+          # Validates the presence of the association key
+          validates_presence_of fkey
+
+          # Set the current_tenant on newly created objects
+          after_initialize lambda { |m| m.send "#{association}=".to_sym, Multitenancy.current_tenant if Multitenancy.current_tenant ; true }
+
+          # Rewrite accessors to make tenant foreign_key/association immutable
+          validate :check_tenant_immutability, :unless => :new_record?
+
+          # Set the default_scope to scope to current tenant
+          default_scope lambda {
+            where(Multitenancy.current_tenant ? { self.tenant_field => Multitenancy.current_tenant.id } : nil)
+          }
+        end
+
+        # Redefine 'validates_with' to add the tenant scope when using a UniquenessValidator
+        def validates_with(*args, &block)
+          if args.first == Validations::UniquenessValidator
+            args.last[:scope] = Array(args.last[:scope]) << self.tenant_field
+          end
+          super(*args, &block)
+        end
+
+        # Redefine 'index' to include the tenant field in first position
+        def index(spec, options = nil)
+          spec = { self.tenant_field => 1 }.merge(spec)
+          super(spec, options)
+        end
+
+        # Redefine 'delete_all' to take in account the default scope
+        def delete_all(conditions = nil)
+          self.where(conditions).delete
+        end
+      end
+    end
+  end
+end

data/lib/mongoid/multitenancy/version.rb

@@ -0,0 +1,5 @@
+module Mongoid
+  module Multitenancy
+    VERSION = "0.1"
+  end
+end

data/mongoid-multitenancy.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/mongoid/multitenancy/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Aymeric Brisse"]
+  gem.email         = ["aymeric.brisse@mperfect-memory.com"]
+  gem.description   = %q{MultiTenancy with Mongoid}
+  gem.summary       = %q{Support of a multi-tenant database with Mongoid}
+  gem.homepage      = "https://github.com/PerfectMemory/mongoid-multitenancy"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "mongoid-multitenancy"
+  gem.require_paths = ["lib"]
+  gem.version       = Mongoid::Multitenancy::VERSION
+
+  gem.add_dependency('mongoid', '~> 3')
+
+  gem.add_development_dependency('rake', '~> 10.0')
+  gem.add_development_dependency('rspec', '~> 2.12')
+  gem.add_development_dependency('yard', '~> 0.8')
+  gem.add_development_dependency('mongoid-rspec', '~> 1.5')
+  gem.add_development_dependency('database_cleaner', '~> 0.9')
+  gem.add_development_dependency('redcarpet', '~> 2.2')
+end

data/spec/models/article.rb

@@ -0,0 +1,15 @@
+class Article
+  include Mongoid::Document
+  include Mongoid::Multitenancy::Document
+
+  tenant(:client)
+
+  field :slug, :type => String
+  field :title, :type => String
+
+  validates_uniqueness_of :slug
+  validates_presence_of :slug
+  validates_presence_of :title
+
+  index({ :title => 1 })
+end

data/spec/models/client.rb

@@ -0,0 +1,5 @@
+class Client
+  include Mongoid::Document
+
+  field :name, :type => String
+end

data/spec/mongoid-multitenancy_spec.rb

@@ -0,0 +1,109 @@
+require "spec_helper"
+
+describe Mongoid::Multitenancy do
+  let(:client) { Client.create!(:name => "client") }
+  let(:another_client) { Client.create!(:name => "another client") }
+
+  before { Mongoid::Multitenancy.current_tenant = client }
+  after { Mongoid::Multitenancy.current_tenant = nil }
+
+  describe ".with_tenant" do
+    it "should change temporary the current tenant within the block" do
+      Mongoid::Multitenancy.with_tenant(another_client) do
+        Mongoid::Multitenancy.current_tenant.should == another_client
+      end
+    end
+
+    it "should have restored the current tenant after the block" do
+      Mongoid::Multitenancy.with_tenant(another_client) do ; end
+      Mongoid::Multitenancy.current_tenant.should == client
+    end
+  end
+end
+
+describe Article do
+  it { should belong_to(:client) }
+  it { should validate_presence_of(:client_id) }
+  it { should validate_uniqueness_of(:slug).scoped_to(:client_id) }
+  it { should have_index_for(:client_id => 1, :title => 1) }
+
+  let(:client) { Client.create!(:name => "client") }
+  let(:another_client) { Client.create!(:name => "another client") }
+
+  describe ".initialize" do
+    before { Mongoid::Multitenancy.current_tenant = client }
+    after { Mongoid::Multitenancy.current_tenant = nil }
+
+    it "should set the client field" do
+      Article.new.client.should eq client
+    end
+  end
+
+  describe ".default_scope" do
+    before {
+      Mongoid::Multitenancy.with_tenant(client) { @articleX = Article.create!(:title => "title X", :slug => "article-x") }
+      Mongoid::Multitenancy.with_tenant(another_client) { @articleY = Article.create!(:title => "title Y", :slug => "article-y") }
+    }
+
+    context "with a current tenant" do
+      before { Mongoid::Multitenancy.current_tenant = another_client }
+      after { Mongoid::Multitenancy.current_tenant = nil }
+
+      it "should filter on the current tenant" do
+        Article.all.to_a.should == [@articleY]
+      end
+    end
+
+    context "without a current tenant" do
+      before { Mongoid::Multitenancy.current_tenant = nil }
+
+      it "should not filter on any tenant" do
+        Article.all.to_a.should == [@articleX, @articleY]
+      end
+    end
+  end
+
+  describe "#valid?" do
+    before { Mongoid::Multitenancy.current_tenant = client }
+    after { Mongoid::Multitenancy.current_tenant = nil }
+
+    let(:article) { Article.create!(:title => "title X", :slug => "article-x") }
+
+    context "when the tenant has not changed" do
+      it 'should be valid' do
+        article.title = "title X (2)"
+        article.should be_valid
+      end
+    end
+
+    context "when the tenant has changed" do
+      it 'should be invalid' do
+        article.title = "title X (2)"
+        article.client = another_client
+        article.should_not be_valid
+      end
+    end
+
+  end
+
+  describe "#delete_all" do
+    before {
+      Mongoid::Multitenancy.with_tenant(client) { @articleX = Article.create!(:title => "title X", :slug => "article-x") }
+      Mongoid::Multitenancy.with_tenant(another_client) { @articleY = Article.create!(:title => "title Y", :slug => "article-y") }
+    }
+
+    context "with a current tenant" do
+      it "should only delete the current tenant articles" do
+        Mongoid::Multitenancy.with_tenant(another_client) { Article.delete_all }
+        Article.all.to_a == [@articleX]
+      end
+    end
+
+    context "without a current tenant" do
+      it "should delete all the articles" do
+        Article.delete_all
+        Article.all.to_a.should be_empty
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,38 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
+MODELS = File.join(File.dirname(__FILE__), "models")
+
+require 'rubygems'
+require 'bundler/setup'
+
+require 'rspec'
+require 'mongoid'
+require 'mongoid-multitenancy'
+require 'database_cleaner'
+require 'mongoid-rspec'
+
+Dir["#{MODELS}/*.rb"].each { |f| require f }
+
+Mongoid.configure do |config|
+  config.connect_to "mongoid_multitenancy"
+end
+
+Mongoid.logger = Logger.new($stdout)
+
+DatabaseCleaner.orm = "mongoid"
+
+RSpec.configure do |config|
+  config.include Mongoid::Matchers
+
+  config.before(:all) do
+    DatabaseCleaner.strategy = :truncation
+  end
+
+  config.before(:each) do
+    DatabaseCleaner.start
+  end
+
+  config.after(:each) do
+    DatabaseCleaner.clean
+  end
+end

metadata

@@ -0,0 +1,178 @@
+--- !ruby/object:Gem::Specification
+name: mongoid-multitenancy
+version: !ruby/object:Gem::Version
+  version: '0.1'
+  prerelease: 
+platform: ruby
+authors:
+- Aymeric Brisse
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.12'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: mongoid-rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.2'
+description: MultiTenancy with Mongoid
+email:
+- aymeric.brisse@mperfect-memory.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE.TXT
+- README.md
+- Rakefile
+- lib/mongoid-multitenancy.rb
+- lib/mongoid/multitenancy.rb
+- lib/mongoid/multitenancy/document.rb
+- lib/mongoid/multitenancy/version.rb
+- mongoid-multitenancy.gemspec
+- spec/models/article.rb
+- spec/models/client.rb
+- spec/mongoid-multitenancy_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/PerfectMemory/mongoid-multitenancy
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Support of a multi-tenant database with Mongoid
+test_files:
+- spec/models/article.rb
+- spec/models/client.rb
+- spec/mongoid-multitenancy_spec.rb
+- spec/spec_helper.rb
+has_rdoc: