multitenancy 0.0.4 → 0.0.5

data/README.md

@@ -1,6 +1,9 @@
 # Multitenancy
 
-Multitenancy gem nicely plugs in to activerecord to provide multitenant support within a single schema. It allows multitenancy at two levels, tenant and sub-tenant. For instance you can have SAAS application where the primary tenant could be an organization and sub-tenant will be users in that organization. 
+Multitenancy gem nicely plugs in to activerecord to provide multitenant support within a shared schema as well dedicated schema. It allows multitenancy at two levels, tenant and sub-tenant. For instance you can have SAAS application where the primary tenant could be an organization and sub-tenant will be users in that organization.
+
+Shared Schema: All tennats will be part of the same instance. Additional columns (tenant_id and sub_tenant_id) will be added to your tables to support multitenancy
+Dedicated Schema: Every tenant will have its own instance of db
 
 ## Installation
 
@@ -17,14 +20,13 @@ Or install it yourself as:
     $ gem install multitenancy
 
 ## Usage
-
 This gem expects the tenant and sub-tenant values passed in the request header. But you can enhace this to support other logic as well.
 
 You use it in your padrino/sinatra application, add the below lines to the config.ru
     
     Multitenancy.init(:tenant_header => 'X_COMPANY_ID', :sub_tenant_header => 'X_USER_ID')
     Padrino.use Multitenancy::Filter
-    
+
 You can also outside of a filter or in a standalone application,
 
     tenant = Multitenancy::Tenant.new('flipkart', 'ganeshs')
@@ -33,6 +35,17 @@ You can also outside of a filter or in a standalone application,
     end
     
 Any active record query executed within the tenant block, will be tenant/sub-tenant scoped. New records will persist the tenant and sub-tenant ids, find queries will be scoped to teanant and sub-tenant ids. If the sub-tenant id is not specified, it will be de-scoped.
+
+### Shared Instance
+	You can pass on the db_type as shared while initializing multitenancy, which is by default set when db_type is not.
+	
+	Multitenancy.init(:tenant_header => 'X_COMPANY_ID', :sub_tenant_header => 'X_USER_ID', :db_type => :shared) 
+    
+### Dedicated Instance
+
+	Dedicated instance config takes in additional optional params, 
+	
+	Multitenancy.init(:tenant_header => 'X_COMPANY_ID', :sub_tenant_header => 'X_USER_ID', :db_type => :shared, :db_config_prefix => 'some_prefix_', :db_config_suffix => 'production')
     
 ## Contributing
 

data/Rakefile

@@ -1,2 +1,10 @@
 #!/usr/bin/env rake
-require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/**/*.rb']
+end
+
+desc "Run tests"
+task :default => :test

data/lib/multitenancy.rb

@@ -1,6 +1,7 @@
 require "active_record"
 require "active_model"
 require "multitenancy/version"
+require "multitenancy/active_record/switch_db"
 require "multitenancy/tenant"
 require "multitenancy/rack/filter"
 require "multitenancy/model_extensions"
@@ -12,6 +13,9 @@ module Multitenancy
   @@sub_tenant_header = 'X_SUB_TENANT_ID'
   @@append_headers_to_rest_calls = true
   @@logger = (logger rescue nil) || Logger.new(STDOUT)
+  @@db_config_prefix = ''
+  @@db_config_suffix = '_development'
+  @@db_type = :shared # or :dedicated
 
   class << self
     def init(config)
@@ -19,6 +23,13 @@ module Multitenancy
       @@sub_tenant_header = config[:sub_tenant_header]
       @@logger = config[:logger] if config[:logger]
       @@append_headers_to_rest_calls = config[:append_headers_to_rest_calls] unless config[:append_headers_to_rest_calls].nil?
+      @@db_config_prefix = config[:db_config_prefix] unless config[:db_config_prefix].nil?
+      @@db_config_suffix = config[:db_config_suffix] unless config[:db_config_suffix].nil?
+      @@db_type = (config[:db_type].nil? || ![:shared, :dedicated].include?(config[:db_type])) ? :shared : config[:db_type] 
+    end
+    
+    def db_type
+      @@db_type
     end
     
     def logger
@@ -45,7 +56,11 @@ module Multitenancy
       old_tenant = self.current_tenant
       self.current_tenant = tenant
       begin
-        return block.call
+        if db_type == :shared
+          return block.call
+        else
+          return ActiveRecord::Base.switch_db("#{@@db_config_prefix}#{tenant.tenant_id}#{@@db_config_suffix}".to_sym, &block)
+        end
       ensure
         self.current_tenant = old_tenant
       end

data/lib/multitenancy/active_record/switch_db.rb

@@ -0,0 +1,30 @@
+class ActiveRecord::Base
+  class << self
+   
+    @@connection_handlers ||= {}
+   
+    def connection_handler_with_multi_db_support(spec_symbol = nil)
+      return @@connection_handlers[spec_symbol] if spec_symbol
+      if Thread.current[:current_db]
+        @@connection_handlers[Thread.current[:current_db]] ||= ActiveRecord::ConnectionAdapters::ConnectionHandler.new
+      else
+        connection_handler_without_multi_db_support
+      end
+    end
+    
+    alias_method :connection_handler_without_multi_db_support, :connection_handler      
+    alias_method :connection_handler, :connection_handler_with_multi_db_support
+
+    def switch_db(db, &block)
+      Thread.current[:current_db] = db
+      unless ActiveRecord::Base.connection_handler.retrieve_connection_pool(ActiveRecord::Base)
+        ActiveRecord::Base.establish_connection(ActiveRecord::Base.configurations[db])
+      end
+      yield
+    ensure
+      ActiveRecord::Base.connection_handler.clear_active_connections! rescue puts "supressing error while clearing connections - #{$!.inspect}"
+      Thread.current[:current_db] = nil
+    end
+    
+  end
+end

data/lib/multitenancy/version.rb

@@ -1,3 +1,3 @@
 module Multitenancy
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/test/database.yml

@@ -1,3 +1,6 @@
-sqlite:
+db1:
   adapter: sqlite3
-  database: test/multitenancy.sqlite3
+  database: test/db1.sqlite3
+db2:
+  adapter: sqlite3
+  database: test/db2.sqlite3

data/test/test_config.rb

@@ -15,7 +15,9 @@ $:.unshift(ROOT + "/lib")
 
 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'])
+ActiveRecord::Base.configurations[:db1] = config[ENV['DB1'] || 'db1']
+ActiveRecord::Base.configurations[:db2] = config[ENV['DB2'] || 'db2']
+ActiveRecord::Base.establish_connection(ActiveRecord::Base.configurations[:db1])
 
 class ActiveSupport::TestCase
   

data/test/unit/multitenancy_test.rb

@@ -8,6 +8,23 @@ module Multitenancy
       assert_equal 'tenant_id', Multitenancy.tenant_header
     end
     
+    context "configure db type" do
+      should "default to shared" do
+        Multitenancy.init(:tenant_header => 'tenant_id', :sub_tenant_header => 'seller_id')
+        assert_equal :shared, Multitenancy.db_type
+      end
+      
+      should "set to shared on junk value" do
+        Multitenancy.init(:tenant_header => 'tenant_id', :sub_tenant_header => 'seller_id', :db_type => :junk)
+        assert_equal :shared, Multitenancy.db_type 
+      end
+      
+      should "set to dedicated" do
+        Multitenancy.init(:tenant_header => 'tenant_id', :sub_tenant_header => 'seller_id', :db_type => :dedicated)
+        assert_equal :dedicated, Multitenancy.db_type
+      end
+    end
+    
     should "return current tenant" do
       tenant = Tenant.new('tenant_id', 'seller_id')
       Multitenancy.current_tenant = tenant
@@ -16,6 +33,7 @@ module Multitenancy
     
     context "block within context" do
       setup do
+        Multitenancy.init(:tenant_header => 'tenant_id', :sub_tenant_header => 'seller_id')
         tenant = Tenant.new('tenant_id', 'seller_id')
         Multitenancy.current_tenant = tenant
       end
@@ -26,6 +44,40 @@ module Multitenancy
           assert_equal Multitenancy.current_tenant.sub_tenant_id, 'dummy_seller_id'
         end
       end
+      
+      context "for dedicated db" do
+        setup do
+          Multitenancy.init(:tenant_header => 'tenant_id', :sub_tenant_header => 'seller_id', :db_type => :dedicated)
+        end
+        
+        should "switch db" do
+          ActiveRecord::Base.expects(:switch_db).with(:db1_development)
+          Multitenancy.with_tenant(Tenant.new('db1')) do
+          end
+        end
+        
+        should "call block" do
+          test = false
+          ActiveRecord::Base.stubs(:establish_connection)
+          Multitenancy.with_tenant(Tenant.new('db1')) do
+            test = true
+          end
+          assert_true test
+        end
+        
+      end
+    end
+    
+    context "for dedicated type prefix and suffix" do
+      setup do
+        Multitenancy.init(:tenant_header => 'tenant_id', :sub_tenant_header => 'seller_id', :db_type => :dedicated, :db_config_prefix => 'db_', :db_config_suffix => '_suffix')
+      end
+    
+      should "be used to switch db" do
+        ActiveRecord::Base.expects(:switch_db).with(:db_db1_suffix)
+        Multitenancy.with_tenant(Tenant.new('db1')) do
+        end
+      end
     end
   end
 end

data/test/unit/rest_client_test.rb

@@ -2,22 +2,25 @@ require File.expand_path(File.dirname(__FILE__) + '/../test_config.rb')
 
 class RestClientTest < Test::Unit::TestCase
 
-  setup do
-    Multitenancy.init({:tenant_header => 'X_COMPANY_ID', :sub_tenant_header => 'X_USER_ID'})
-  end
-  
-  should "append tenant headers to rest calls within a tenant scope" do
-    RestClient::Request.any_instance.expects(:make_headers).with() {|headers| headers[Multitenancy.tenant_header] == 'Flipkart' && headers[Multitenancy.sub_tenant_header] == 'ganeshs'}
-    RestClient::Request.any_instance.expects(:execute)
-    Multitenancy.with_tenant(Multitenancy::Tenant.new('Flipkart', 'ganeshs')) do
+  context "tenant headers in rest calls" do
+    setup do
+      Multitenancy.init({:tenant_header => 'X_COMPANY_ID', :sub_tenant_header => 'X_USER_ID', :append_headers_to_rest_calls => true})
+    end
+    
+    should "not append tenant headers to rest calls outside of a tenant scope" do
+      Multitenancy.current_tenant = nil
+      RestClient::Request.any_instance.expects(:make_headers).with() {|headers| headers[Multitenancy.tenant_header].nil? && headers[Multitenancy.sub_tenant_header].nil?}
+      RestClient::Request.any_instance.expects(:execute)
       RestClient.get('http://some/resource')
     end
-  end
-  
-  should "not append tenant headers to rest calls outside of a tenant scope" do
-    RestClient::Request.any_instance.expects(:make_headers).with() {|headers| headers[Multitenancy.tenant_header].nil? && headers[Multitenancy.sub_tenant_header].nil? }
-    RestClient::Request.any_instance.expects(:execute)
-    RestClient.get('http://some/resource')
+    
+    should "append tenant headers to rest calls within a tenant scope" do
+      RestClient::Request.any_instance.expects(:make_headers).with() {|headers| headers[Multitenancy.tenant_header] == 'Flipkart' && headers[Multitenancy.sub_tenant_header] == 'ganeshs'}
+      RestClient::Request.any_instance.expects(:execute)
+      Multitenancy.with_tenant(Multitenancy::Tenant.new('Flipkart', 'ganeshs')) do
+        RestClient.get('http://some/resource')
+      end
+    end
   end
   
   context "no tenant headers in rest calls" do

data/test/unit/switch_db_test.rb

@@ -0,0 +1,41 @@
+require File.expand_path(File.dirname(__FILE__) + '/../test_config.rb')
+
+2.times do |i|
+  ActiveRecord::Base.establish_connection(ActiveRecord::Base.configurations["db#{i + 1}".to_sym])
+  ActiveRecord::Schema.define(:version => 1) do
+    create_table :dummy, :force => true do |t|
+      t.column :org_id, :string 
+      t.column :name, :string
+    end
+  end
+end
+
+class Dummy < ActiveRecord::Base
+end
+
+class SwitchDBTest < Test::Unit::TestCase
+  
+  should "set current db name on switch db" do
+    Dummy.switch_db(:db1) do
+      assert_equal(:db1, Thread.current[:current_db])
+    end
+    Dummy.switch_db(:db2) do
+      assert_equal(:db2, Thread.current[:current_db])
+    end
+  end
+  
+  should "reset current db after switch db is completed" do
+    Dummy.switch_db(:db1) do
+      assert_equal(:db1, Thread.current[:current_db])
+    end
+    assert_nil(Thread.current[:current_db])
+  end
+  
+  should "clear active connections after switch db block execution" do
+    ActiveRecord::ConnectionAdapters::ConnectionHandler.any_instance.expects(:clear_active_connections!)
+    Dummy.switch_db(:db1) do
+      assert_equal(:db1, Thread.current[:current_db])
+    end
+    assert_nil(Thread.current[:current_db])
+  end
+end

data/test/unit/tenant_test.rb

@@ -2,6 +2,10 @@ require File.expand_path(File.dirname(__FILE__) + '/../test_config.rb')
 
 module Multitenancy
   class TenantTest < Test::Unit::TestCase
+    
+    setup do
+      Multitenancy.init(:tenant_header => 'X_TENANT_ID', :sub_tenant_header => 'X_SUB_TENANT_ID')
+    end
   
     should "create tenant" do
       tenant = Tenant.new('tenant_id', 'seller_id')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: multitenancy
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-11 00:00:00.000000000Z
+date: 2013-02-05 00:00:00.000000000Z
 dependencies: []
 description: Support multitennacy with active record
 email:
@@ -24,6 +24,7 @@ files:
 - README.md
 - Rakefile
 - lib/multitenancy.rb
+- lib/multitenancy/active_record/switch_db.rb
 - lib/multitenancy/model_extensions.rb
 - lib/multitenancy/rack/filter.rb
 - lib/multitenancy/rest_client/rest_client.rb
@@ -31,12 +32,14 @@ files:
 - lib/multitenancy/version.rb
 - multitenancy.gemspec
 - test/database.yml
-- test/multitenancy.sqlite3
+- test/db1.sqlite3
+- test/db2.sqlite3
 - test/test_config.rb
 - test/unit/filter_test.rb
 - test/unit/model_extensions_test.rb
 - test/unit/multitenancy_test.rb
 - test/unit/rest_client_test.rb
+- test/unit/switch_db_test.rb
 - test/unit/tenant_test.rb
 homepage: https://github.com/Flipkart/multitenancy
 licenses: []
@@ -64,11 +67,13 @@ specification_version: 3
 summary: Support multitennacy with active record at tenant and sub-tenant level
 test_files:
 - test/database.yml
-- test/multitenancy.sqlite3
+- test/db1.sqlite3
+- test/db2.sqlite3
 - test/test_config.rb
 - test/unit/filter_test.rb
 - test/unit/model_extensions_test.rb
 - test/unit/multitenancy_test.rb
 - test/unit/rest_client_test.rb
+- test/unit/switch_db_test.rb
 - test/unit/tenant_test.rb
 has_rdoc: