acts_as_tenant 0.2

data/.gitignore

@@ -0,0 +1,6 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+spec/*.sqlite3
+spec/*.log

data/.rvmrc

@@ -0,0 +1 @@
+rvm 1.9.2@rails31

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in acts_as_tenant.gemspec
+gemspec

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 [name of plugin creator]
+
+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,117 @@
+Acts As Tenant
+==============
+
+note: acts_as_tenant was introduced in this [blog post](http://www.rollcallapp.com/blog/add).
+
+This gem was born out of our own need for a fail-safe and out-of-the-way manner to add multi-tenancy to our Rails app through a shared database strategy, that integrates (near) seamless with Rails.
+
+acts_as_tenant adds the ability to scope models to a tenant. Tenants are represented by a tenant model, such as `Account`. acts_as_tenant 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.
+
+In addition, acts_as_tenant:
+
+* sets the current tenant using the subdomain or allows you to pass in the current tenant yourself
+* protects against various types of nastiness directed at circumventing the tenant scoping
+* adds a method to validate uniqueness to a tenant, validates_uniqueness_to_tenant
+* sets up a helper method containing the current tenant
+
+Installation
+------------
+acts_as_tenant will only work on Rails 3.1 and up. This is due to changes made to the handling of default_scope, an essential pillar of the gem.
+
+To use it, add it to your Gemfile:
+  
+    gem 'acts_as_tenant'
+  
+Getting started
+===============
+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 using the subdomain to lookup the current tenant and (2) by passing in the current tenant yourself.
+
+**Use the subdomain to lookup the current tenant**
+
+    class ApplicationController < ActionController::Base
+      set_current_tenant_by_subdomain(:account, :subdomain)
+    end
+This tells acts_as_tenant to use the current subdomain to identify the current tenant. In addition, it tells acts_as_tenant that tenants are represented by the Account model and this model has a column named 'subdomain' which can be used to lookup the Account using the actual subdomain. If ommitted, the parameters will default to the values used above.
+
+**OR Pass in the current tenant yourself**
+
+    class ApplicationController < ActionController::Base
+      current_account = Account.find_the_current_account
+      set_current_tenant_to(current_account)
+    end
+This allows you to pass in the current tenant yourself.
+
+**note:** If the current tenant is not set by either of these methods, Acts_as_tenant will be unable to apply the proper scope to your models. So make sure you use one of the two methods to tell acts_as_tenant about the current tenant.
+  
+Scoping your models
+-------------------
+    class Addaccounttousers < ActiveRecord::Migration
+      def up
+        add_column :users, :account_id, :integer
+      end
+  
+    class User < ActiveRecord::Base
+      acts_as_tenant(:account)
+    end
+  
+acts_as_tenant requires each scoped model to have a column in its schema linking it to a tenant. Adding acts_as_tenant to your model declaration will scope that model to the current tenant **BUT ONLY if a current tenant has been set**.
+
+Some examples to illustrate this behavior:
+
+    # This manually sets the current tenant for testing purposes. In your app this is handled by the gem.
+    acts_as_tenant.current_tenant = Account.find(3)   
+    
+    # All searches are scoped by the tenant, the following searches will only return objects 
+    # where account_id == 3
+    Project.all =>  # all projects with account_id => 3
+    Project.tasks.all #  => all tasks with account_id => 3
+     
+    # New objects are scoped to the current tenant
+    @project = Project.new(:name => 'big project')    # => <#Project id: nil, name: 'big project', :account_id: 3>
+    
+    # It will not allow the creation of objects outside the current_tenant scope
+    @project.account_id = 2
+    @project.save                                     # => false
+      
+    # It will not allow association with objects outside the current tenant scope
+    # Assuming the Project with ID: 2 does not belong to Account with ID: 3
+    @task = Task.new  # => <#Task id: nil, name: bil, project_id: nil, :account_id: 3>
+
+Acts_as_tenant uses Rails' default_scope method to scope models. Rails 3.1 changed the way default_scope works in a good way. A user defined default_scope should integrate seamlessly with the one added by acts_as_tenant.
+
+**Validating attribute uniqueness**
+If you need to validate for uniqueness, chances are that you want to scope this validation to a tenant. You can do so by using:
+
+    validates_uniqueness_to_tenant :name, :email
+
+All options available to Rails' own @validates_uniqueness_of@ are also available to this method.
+
+To Do
+-----
+* Change the tests to Test::Unit so I can easily add some controller tests.
+
+Bug reports & suggested improvements
+------------------------------------
+If you have found a bug or want to suggest an improvement, please use our issue tracked at:
+
+[github.com/ErwinM/acts_as_tenant/issues](http://github.com/ErwinM/acts_as_tenant/issues)
+
+If you want to contribute, fork the project, code your improvements and make a pull request on [Github](http://github.com/ErwinM/acts_as_tenant/). When doing so, please don't forget to add tests. If your contribution is fixing a bug it would be perfect if you could also submit a failing test, illustrating the issue.
+
+Author & Credits
+----------------
+acts_as_tenant is written by Erwin Matthijssen.  
+Erwin is currently busy developing [Roll Call](http://www.rollcallapp.com/ "Roll Call App").
+
+This gem was inspired by Ryan Sonnek's [Multitenant](https://github.com/wireframe/multitenant) gem and its use of default_scope.
+
+License
+-------
+Copyright (c) 2011 Erwin Matthijssen, released under the MIT license

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/acts_as_tenant.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "acts_as_tenant/version"
+
+Gem::Specification.new do |s|
+  s.name        = "acts_as_tenant"
+  s.version     = ActsAsTenant::VERSION
+  s.authors     = ["Erwin Matthijssen"]
+  s.email       = ["erwin.matthijssen@gmail.com"]
+  s.homepage    = "http://www.rollcallapp.com/blog"
+  s.summary     = %q{Add multi-tenancy to Rails applications using a shared db strategy}
+  s.description = %q{Integrates multi-tenancy into a Rails application in a convenient and out-of-your way manner}
+
+  s.rubyforge_project = "acts_as_tenant"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/lib/acts_as_tenant.rb

@@ -0,0 +1,22 @@
+#RAILS_3 = ::ActiveRecord::VERSION::MAJOR >= 3
+
+require "active_record"
+require "action_controller"
+require "active_model"
+
+#$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require "acts_as_tenant"
+require "acts_as_tenant/version"
+require "acts_as_tenant/controller_extensions.rb"
+require "acts_as_tenant/model_extensions.rb"
+
+#$LOAD_PATH.shift
+
+if defined?(ActiveRecord::Base)
+  ActiveRecord::Base.send(:include, ActsAsTenant::ModelExtensions)
+  ActionController::Base.extend ActsAsTenant::ControllerExtensions
+end
+
+ 
+  

data/lib/acts_as_tenant/controller_extensions.rb

@@ -0,0 +1,52 @@
+module ActsAsTenant
+  module ControllerExtensions
+    
+    # this method allows setting the current_tenant by reading the subdomain and looking
+    # it up in the tenant-model passed to the method (defaults to Account). The method will 
+    # look for the subdomain in a column referenced by the second argument (defaults to subdomain).
+    def set_current_tenant_by_subdomain(tenant = :account, column = :subdomain )
+      self.class_eval do
+        cattr_accessor :tenant_class, :tenant_column
+        attr_accessor :current_tenant
+      end
+
+      self.tenant_class = tenant.to_s.capitalize.constantize
+      self.tenant_column = column.to_sym
+
+      self.class_eval do
+        before_filter :find_tenant_by_subdomain
+
+        helper_method :current_tenant
+        
+        private
+          def find_tenant_by_subdomain
+            ActsAsTenant.current_tenant = tenant_class.where(tenant_column => request.subdomains.first).first
+            @current_tenant_instance = ActsAsTenant.current_tenant
+          end
+          
+          # helper method to have the current_tenant available in the controller  
+          def current_tenant
+            ActsAsTenant.current_tenant
+          end
+      end
+    end
+    
+    # this method allows manual setting of the current_tenant by passing in a tenant object
+    # 
+    def set_current_tenant_to(current_tenant_object)
+      self.class_eval do
+        cattr_accessor :tenant_class
+        attr_accessor :current_tenant
+        before_filter lambda { @current_tenant_instance = ActsAsTenant.current_tenant = current_tenant_object }
+        
+        helper_method :current_tenant
+        
+        private
+          # helper method to have the current_tenant available in the controller  
+          def current_tenant
+            ActsAsTenant.current_tenant
+          end
+      end
+    end
+  end
+end

data/lib/acts_as_tenant/model_extensions.rb

@@ -0,0 +1,89 @@
+# ActsAsTenant
+
+
+module ActsAsTenant
+  
+  class << self
+    cattr_accessor :tenant_class
+    attr_accessor :current_tenant
+  end
+  
+  module ModelExtensions
+    extend ActiveSupport::Concern
+  
+    # Alias the v_uniqueness_of method so we can scope it to the current tenant when relevant
+  
+    module ClassMethods
+    
+      def acts_as_tenant(association = :account)
+        
+        # Method that enables checking if a class is scoped by tenant
+        def self.is_scoped_by_tenant?
+          true
+        end
+        
+        ActsAsTenant.tenant_class ||= association
+        
+        # Setup the association between the class and the tenant class
+        belongs_to association
+      
+        # get the tenant model and its foreign key
+        reflection = reflect_on_association association
+        
+        # As the "foreign_key" method changed name in 3.1 we check for backward compatibility 
+        if reflection.respond_to?(:foreign_key)
+          fkey = reflection.foreign_key
+        else
+          fkey = reflection.association_foreign_key
+        end
+    
+        # set the current_tenant on newly created objects
+        before_validation Proc.new {|m|
+          return unless ActsAsTenant.current_tenant
+          m.send "#{association}=".to_sym, ActsAsTenant.current_tenant
+        }, :on => :create
+    
+        # set the default_scope to scope to current tenant
+        default_scope lambda {
+          where({fkey => ActsAsTenant.current_tenant.id}) if ActsAsTenant.current_tenant
+        }
+    
+        # Rewrite accessors to make tenant foreign_key/association immutable
+        define_method "#{fkey}=" do |integer|  
+          if new_record?
+            write_attribute(fkey, integer)  
+          else
+            raise "#{fkey} is immutable!"
+          end  
+        end
+      
+        define_method "#{association}=" do |model|  
+          if new_record?
+            write_attribute(association, model)  
+          else
+            raise "#{association} is immutable!"
+          end  
+        end
+      
+        # add validation of associations against tenant scope
+        # we can't do this for polymorphic associations so we 
+        # exempt them
+        reflect_on_all_associations.each do |a|
+          unless a == reflection || a.macro == :has_many || a.options[:polymorphic]
+            validates_each a.foreign_key.to_sym do |record, attr, value|
+              record.errors.add attr, "is invalid" unless a.name.to_s.classify.constantize.where(:id => value).present?
+            end
+          end
+        end 
+      end
+      
+      def validates_uniqueness_to_tenant(fields, args ={})
+        raise "ActsAsTenant::validates_uniqueness_to_tenant: no current tenant" unless respond_to?(:is_scoped_by_tenant?)
+        tenant_id = lambda { "#{ActsAsTenant.tenant_class.to_s.downcase}_id"}.call
+        args[:scope].nil? ? args[:scope] = tenant_id : args[:scope] << tenant_id
+        validates_uniqueness_of(fields, args)
+      end
+      
+    end
+  end
+end

data/lib/acts_as_tenant/version.rb

@@ -0,0 +1,3 @@
+module ActsAsTenant
+  VERSION = "0.2"
+end

data/rails/init.rb

@@ -0,0 +1,2 @@
+ActiveRecord::Base.send(:include, ActsAsTenant::ModelExtensions)
+ActionController::Base.extend ActsAsTenant::ControllerExtensions

data/spec/database.yml

@@ -0,0 +1,3 @@
+sqlite:
+  adapter: sqlite3
+  database: spec/actsastenant.sqlite3

data/spec/model_extensions_spec.rb

@@ -0,0 +1,178 @@
+require 'spec_helper'
+
+# Setup the db
+ActiveRecord::Schema.define(:version => 1) do
+  create_table :accounts, :force => true do |t|
+    t.column :name, :string
+  end
+
+  create_table :projects, :force => true do |t|
+    t.column :name, :string
+    t.column :account_id, :integer
+  end
+  
+  create_table :tasks, :force => true do |t|
+    t.column :name, :string
+    t.column :account_id, :integer
+    t.column :project_id, :integer
+    t.column :completed, :boolean
+  end
+  
+  create_table :countries, :force => true do |t|
+    t.column :name, :string
+  end
+  
+  create_table :cities, :force => true do |t|
+    t.column :name, :string
+  end
+  
+end
+
+# Setup the models
+class Account < ActiveRecord::Base
+  has_many :projects
+end
+
+class Project < ActiveRecord::Base
+  has_many :tasks
+  acts_as_tenant :account
+  
+  validates_uniqueness_to_tenant :name
+end
+
+class Task < ActiveRecord::Base
+  belongs_to :project
+  default_scope :conditions => { :completed => nil }, :order => "name"
+  
+  acts_as_tenant :account
+  validates_uniqueness_of :name
+end
+
+
+class City < ActiveRecord::Base
+  validates_uniqueness_of :name
+end
+
+
+# Start testing!
+describe ActsAsTenant do
+  after { ActsAsTenant.current_tenant = nil }
+
+  describe 'Setting the current tenant' do
+    before { ActsAsTenant.current_tenant = :foo }
+    it { ActsAsTenant.current_tenant == :foo }
+  end
+  
+  describe 'is_scoped_as_tenant should return the correct value' do
+    it {Project.respond_to?(:is_scoped_by_tenant?).should == true}
+  end
+  
+  describe 'Project.all should be scoped to the current tenant if set' do
+    before do
+      @account1 = Account.create!(:name => 'foo')
+      @account2 = Account.create!(:name => 'bar')
+
+      @project1 = @account1.projects.create!(:name => 'foobar')
+      @project2 = @account2.projects.create!(:name => 'baz')
+      
+      ActsAsTenant.current_tenant= @account1
+      @projects = Project.all
+    end
+    
+    it { @projects.length.should == 1 }
+    it { @projects.should == [@project1] }
+  end
+  
+  describe 'Associations should be correctly scoped by current tenant' do
+    before do
+      @account = Account.create!(:name => 'foo')
+      @project = @account.projects.create!(:name => 'foobar', :account_id => @account.id )
+      # the next line would normally be nearly impossible: a task assigned to a tenant project, 
+      # but the task has no tenant assigned
+      @task1 = Task.create!(:name => 'no_tenant', :project => @project) 
+      
+      ActsAsTenant.current_tenant = @account
+      @task2 = @project.tasks.create!(:name => 'baz')
+      @tasks = @project.tasks
+    end
+    
+    it 'should correctly set the tenant on the task created with current_tenant set' do
+      @task2.account.should == @account
+    end
+    
+    it 'should filter out the non-tenant task from the project' do
+      @tasks.length.should == 1
+    end
+  end
+  
+  describe 'When dealing with a user defined default_scope' do
+    before do
+      @account = Account.create!(:name => 'foo')
+      @project1 = Project.create!(:name => 'inaccessible')
+      @task1 = Task.create!(:name => 'no_tenant', :project => @project1)
+      
+      ActsAsTenant.current_tenant = @account
+      @project2 = Project.create!(:name => 'accessible')
+      @task2 = @project2.tasks.create!(:name => 'bar')
+      @task3 = @project2.tasks.create!(:name => 'baz')
+      @task4 = @project2.tasks.create!(:name => 'foo')
+      @task5 = @project2.tasks.create!(:name => 'foobar', :completed => true )
+      
+      @tasks= Task.all
+    end
+    
+    it 'should apply both the tenant scope and the user defined default_scope, including :order' do
+      @tasks.length.should == 3 
+      @tasks.should == [@task2, @task3, @task4] 
+    end
+  end
+  
+  describe 'tenant_id should be immutable' do
+    before do
+      @account = Account.create!(:name => 'foo')
+      @project = @account.projects.create!(:name => 'bar')
+    end
+    
+    it { lambda {@project.account_id = @account.id + 1}.should raise_error }
+  end
+    
+  describe 'Associations can only be made with in-scope objects' do
+    before do
+      @account = Account.create!(:name => 'foo')
+      @project1 = Project.create!(:name => 'inaccessible_project', :account_id => @account.id + 1)
+      
+      ActsAsTenant.current_tenant = @account
+      @project2 = Project.create!(:name => 'accessible_project')
+      @task = @project2.tasks.create!(:name => 'bar')
+    end
+  
+    it { @task.update_attributes(:project_id => @project1.id).should == false }
+  end
+  
+  describe 'When using validates_uniqueness_to_tenant in a aat model' do
+    before do
+      @account = Account.create!(:name => 'foo')
+      ActsAsTenant.current_tenant = @account
+      @project1 = Project.create!(:name => 'bar')
+    end
+    
+    it 'should not be possible to create a duplicate within the same tenant' do
+      @project2 = Project.create(:name => 'bar').valid?.should == false
+    end
+    
+    it 'should be possible to create a duplicate outside the tenant scope' do
+      @account = Account.create!(:name => 'baz')
+      ActsAsTenant.current_tenant = @account
+      @project2 = Project.create(:name => 'bar').valid?.should == true
+    end
+  end
+  
+  describe 'When using validates_uniqueness_of in a NON-aat model' do
+    before do
+      @city1 = City.create!(:name => 'foo')
+    end
+    it 'should not be possible to create duplicates' do
+      @city2 = City.create(:name => 'foo').valid?.should == false
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,41 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'active_record'
+require 'action_controller'
+require 'logger'
+require 'database_cleaner'
+
+require 'acts_as_tenant/model_extensions'
+require 'acts_as_tenant/controller_extensions'
+
+ActiveRecord::Base.send(:include, ActsAsTenant::ModelExtensions)
+ActionController::Base.extend ActsAsTenant::ControllerExtensions
+
+config = YAML::load(IO.read(File.join(File.dirname(__FILE__), 'database.yml')))
+ActiveRecord::Base.logger = Logger.new(File.join(File.dirname(__FILE__), "debug.log"))
+ActiveRecord::Base.establish_connection(config[ENV['DB'] || 'sqlite'])
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+#Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+#RSpec.configure do |config|
+#end
+
+Spec::Runner.configure do |config|
+
+  config.before(:suite) do
+    DatabaseCleaner.strategy = :transaction
+    DatabaseCleaner.clean_with(:truncation)
+  end
+
+  config.before(:each) do
+    DatabaseCleaner.start
+  end
+
+  config.after(:each) do
+    DatabaseCleaner.clean
+  end
+
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: acts_as_tenant
+version: !ruby/object:Gem::Version
+  version: '0.2'
+  prerelease: 
+platform: ruby
+authors:
+- Erwin Matthijssen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-10-03 00:00:00.000000000Z
+dependencies: []
+description: Integrates multi-tenancy into a Rails application in a convenient and
+  out-of-your way manner
+email:
+- erwin.matthijssen@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- Gemfile
+- MIT-LICENSE
+- README.md
+- Rakefile
+- acts_as_tenant.gemspec
+- lib/acts_as_tenant.rb
+- lib/acts_as_tenant/controller_extensions.rb
+- lib/acts_as_tenant/model_extensions.rb
+- lib/acts_as_tenant/version.rb
+- rails/init.rb
+- spec/database.yml
+- spec/model_extensions_spec.rb
+- spec/spec_helper.rb
+homepage: http://www.rollcallapp.com/blog
+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: acts_as_tenant
+rubygems_version: 1.8.6
+signing_key: 
+specification_version: 3
+summary: Add multi-tenancy to Rails applications using a shared db strategy
+test_files:
+- spec/database.yml
+- spec/model_extensions_spec.rb
+- spec/spec_helper.rb