multitenant-pg 0.1.0

data/.gitignore

@@ -0,0 +1,10 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+.DS_Store
+
+# test files
+spec/*.log
+spec/*.sqlite3
+

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--format documentation
+--backtrace

data/.rvmrc

@@ -0,0 +1 @@
+rvm use ree-1.8.7-2011.03@multitenant --create

data/.travis.yml

@@ -0,0 +1,5 @@
+before_script:
+  - "psql -c 'create database myapp_test;' -U postgres"
+rvm:
+  - 1.8.7
+  - 1.9.2

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Fabio Kuhn
+
+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.rdoc

@@ -0,0 +1,57 @@
+= Multitenant
+
+Build a Rails multitenancy application with PostgreSQL schemas.
+
+== Example usage
+
+  class Tenant < ActiveRecord::Base
+    set_table_name 'public.tenants'
+    validates_presence_of :schema_name
+    validates_uniqueness_of :schema_name
+
+    after_create :setup_schema
+
+    private
+      def setup_schema
+        unless Multitenant::SchemaUtils.schema_exists?(schema_name)
+          Multitenant::SchemaUtils.create_schema(schema_name)
+          Multitenant::SchemaUtils.load_schema_into_schema(schema_name)
+        end
+      end
+  end
+
+  Multitenant.with_tenant current_tenant do
+    # queries within this block are automatically
+    # scoped to the current tenant
+    User.all
+
+    # new objects created within this block are automatically
+    # assigned to the current tenant
+    User.create :name => 'Bob'
+  end
+
+== Features
+
+* Rails 3 compatible
+* Restrict database queries to only lookup objects for the current tenant
+* Utility tools for creating, migrating and accessing schemas
+
+== Contributing
+
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Credits
+
+Ryan Sonnek for building the multitenant gem and Guy Naor for inspiration.
+
+== Copyright
+
+Copyright (c) 2011 Fabio Kuhn. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new('spec')
+task :default => :spec

data/lib/multitenant-pg.rb

@@ -0,0 +1,2 @@
+require 'multitenant'
+require 'multitenant/version'

data/lib/multitenant.rb

@@ -0,0 +1,22 @@
+require 'multitenant/schema_utils'
+
+# Multitenant: making cross tenant data leaks a thing of the past...since 2011
+module Multitenant
+  class << self
+    attr_accessor :current_tenant
+
+    # execute a block scoped to the current tenant
+    # unsets the current tenant after execution
+    def with_tenant(tenant = nil, &block)
+      previous_tenant = Multitenant.current_tenant
+      Multitenant.current_tenant = tenant if tenant
+
+      SchemaUtils.with_schema(Multitenant.current_tenant.schema_name) do
+        yield
+      end
+
+    ensure
+      Multitenant.current_tenant = previous_tenant
+    end
+  end
+end

data/lib/multitenant/schema_utils.rb

@@ -0,0 +1,85 @@
+require 'active_record'
+
+module Multitenant
+  module SchemaUtils
+    class << self
+      def with_schema(schema_name)
+        old_search_path = connection.schema_search_path
+        add_schema_to_path(schema_name)
+        connection.schema_search_path = schema_name
+        result = yield
+
+        connection.schema_search_path = old_search_path
+        reset_search_path
+        result
+      end
+
+      def add_schema_to_path(schema_name)
+        connection.execute "SET search_path TO #{schema_name}"
+      end
+
+      def reset_search_path
+        connection.execute "SET search_path TO #{connection.schema_search_path}"
+        ActiveRecord::Base.connection.reset!
+      end
+
+      def current_search_path
+        connection.select_value "SHOW search_path"
+      end
+
+      def create_schema(schema_name)
+        raise "#{schema_name} already exists" if schema_exists?(schema_name)
+
+        ActiveRecord::Base.logger.info "Create #{schema_name}"
+        connection.execute "CREATE SCHEMA #{schema_name}"
+      end
+
+      def drop_schema(schema_name)
+        raise "#{schema_name} does not exists" unless schema_exists?(schema_name)
+
+        ActiveRecord::Base.logger.info "Drop schema #{schema_name}"
+        connection.execute "DROP SCHEMA #{schema_name} CASCADE"
+      end
+
+      def migrate_schema(schema_name, version = nil)
+        with_schema(schema_name) do
+          ActiveRecord::Migrator.migrate(ActiveRecord::Migrator.migrations_paths, version ? version.to_i : nil)
+        end
+      end
+
+      def load_schema_into_schema(schema_name)
+        ActiveRecord::Base.logger.info "Enter schema #{schema_name}."
+        with_schema(schema_name) do
+          file = "#{Rails.root}/db/schema.rb"
+          if File.exists?(file)
+            ActiveRecord::Base.logger.info "Load the schema #{file}"
+            load(file)
+          else
+            raise "#{file} desn't exist yet. It's possible that you just ran a migration!"
+          end
+        end
+      end
+
+      def schema_exists?(schema_name)
+        all_schemas.include?(schema_name)
+      end
+
+      def all_schemas
+        connection.select_values("SELECT * FROM pg_namespace WHERE nspname != 'information_schema' AND nspname NOT LIKE 'pg%'")
+      end
+
+      def with_all_schemas
+        all_schemas.each do |schema_name|
+          with_schema(schema_name) do
+            yield
+          end
+        end
+      end
+
+      protected
+      def connection
+        ActiveRecord::Base.connection
+      end
+    end
+  end
+end

data/lib/multitenant/version.rb

@@ -0,0 +1,3 @@
+module Multitenant
+  VERSION = "0.1.0"
+end

data/multitenant-pg.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "multitenant/version"
+
+Gem::Specification.new do |s|
+  s.name        = "multitenant-pg"
+  s.version     = Multitenant::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Fabio Kuhn"]
+  s.email       = ["mordaroso@gmail.com"]
+  s.homepage    = "http://github.com/mordaroso/multitenant-pg"
+  s.summary     = %q{scope database queries to current tenant}
+  s.description = %q{Rails multitenancy with PostgreSQL schemas.}
+
+  s.add_dependency(%q<activerecord>, ['>= 3.1'])
+  s.add_development_dependency(%q<pg>, ["~> 0.11.0"])
+  s.add_development_dependency(%q<rspec>, ['~> 2.7.0'])
+  s.add_development_dependency(%q<rspec-core>, ['~> 2.7.0'])
+  s.add_development_dependency(%q<rspec-mocks>, ['~> 2.7.0'])
+  s.add_development_dependency(%q<database_cleaner>, ['>= 0.5.0'])
+
+  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/spec/database.yml

@@ -0,0 +1,7 @@
+test:
+  adapter: postgresql
+  host: localhost
+  encoding: utf8
+  template: template0
+  schema: public
+  database: multitenant_test

data/spec/fixtures/db/schema.rb

@@ -0,0 +1,19 @@
+ActiveRecord::Schema.define(:version => 1) do
+  create_table :companies, :force => true do |t|
+    t.column :name, :string
+  end
+
+  create_table :users, :force => true do |t|
+    t.column :name, :string
+    t.column :company_id, :integer
+  end
+
+  create_table :tenants, :force => true do |t|
+    t.column :name, :string
+    t.column :schema_name, :string
+  end
+
+  create_table :items, :force => true do |t|
+    t.column :name, :string
+  end
+end

data/spec/fixtures/schema.rb

@@ -0,0 +1,19 @@
+ActiveRecord::Schema.define(:version => 1) do
+  create_table :companies, :force => true do |t|
+    t.column :name, :string
+  end
+
+  create_table :users, :force => true do |t|
+    t.column :name, :string
+    t.column :company_id, :integer
+  end
+
+  create_table :tenants, :force => true do |t|
+    t.column :name, :string
+    t.column :schema_name, :string
+  end
+
+  create_table :items, :force => true do |t|
+    t.column :name, :string
+  end
+end

data/spec/multitenant_spec.rb

@@ -0,0 +1,134 @@
+require 'spec_helper'
+
+class Company < ActiveRecord::Base
+  has_many :users
+end
+
+class User < ActiveRecord::Base
+  belongs_to :company
+end
+
+class Tenant < ActiveRecord::Base
+  set_table_name 'public.tenants'
+
+  after_create :setup_schema
+
+  def setup_schema
+    unless Multitenant::SchemaUtils.schema_exists?(schema_name)
+      Multitenant::SchemaUtils.create_schema(schema_name)
+      Multitenant::SchemaUtils.load_schema_into_schema(schema_name)
+    end
+  end
+end
+
+module Rails
+end
+
+describe Multitenant do
+  before(:all) do
+    load File.join(File.dirname(__FILE__), '/fixtures/db/schema.rb')
+  end
+
+  before(:each) do
+    #ActiveRecord::Base.connection.schema_search_path = 'public'
+    Rails.stub(:root).and_return(File.join(File.dirname(__FILE__), 'fixtures'))
+
+    @tenant = Tenant.create(:name => 'foo', :schema_name => 'foo')
+    @tenant2 = Tenant.create(:name => 'bar', :schema_name => 'bar')
+  end
+
+  after do
+    Multitenant.current_tenant = nil;
+    Multitenant::SchemaUtils.with_all_schemas do
+      DatabaseCleaner.clean_with :truncation
+    end
+  end
+
+  describe 'Multitenant.current_tenant' do
+    before { Multitenant.current_tenant = :foo }
+    it { Multitenant.current_tenant == :foo }
+  end
+
+  describe 'Multitenant.with_tenant block' do
+    before do
+      @executed = false
+      Multitenant.with_tenant @tenant do
+        Multitenant.current_tenant.should == @tenant
+        @executed = true
+      end
+    end
+    it 'clears current_tenant after block runs' do
+      Multitenant.current_tenant.should == nil
+    end
+    it 'yields the block' do
+      @executed.should == true
+    end
+  end
+
+  describe 'Multitenant.with_tenant block with a previous tenant' do
+    before do
+      @previous = :whatever
+      Multitenant.current_tenant = @previous
+      @executed = false
+      Multitenant.with_tenant @tenant do
+        Multitenant.current_tenant.should == @tenant
+        Multitenant::SchemaUtils.current_search_path.should == @tenant.schema_name
+        @executed = true
+      end
+    end
+
+    it 'resets current_tenant after block runs' do
+      Multitenant.current_tenant.should == @previous
+      #ActiveRecord::Base.connection.schema_search_path.should == 'public'
+    end
+
+    it 'yields the block' do
+      @executed.should == true
+    end
+  end
+
+  describe 'Multitenant.with_tenant block that raises error' do
+    before do
+      @executed = false
+      expect {
+        Multitenant.with_tenant @tenant do
+          @executed = true
+          raise 'expected error'
+        end
+        }.to raise_error('expected error')
+      end
+
+      it 'clears current_tenant after block runs' do
+        Multitenant.current_tenant.should == nil
+      end
+
+      it 'yields the block' do
+        @executed.should == true
+      end
+    end
+
+    describe 'User.all when current_tenant is set' do
+      before do
+        Multitenant.with_tenant @tenant do
+          Multitenant::SchemaUtils.current_search_path.should == @tenant.schema_name
+          @company = Company.create!(:name => 'foo')
+          @user = @company.users.create! :name => 'bob'
+        end
+
+        Multitenant.with_tenant @tenant2 do
+          Multitenant::SchemaUtils.current_search_path.should == @tenant2.schema_name
+          company = Company.create!(:name => 'bar')
+          user = company.users.create! :name => 'frank'
+        end
+
+        Multitenant.with_tenant @tenant do
+          Multitenant::SchemaUtils.current_search_path.should == @tenant.schema_name
+          @users = User.all
+        end
+      end
+
+      it { @users.length.should == 1 }
+
+      it { @users.should == [@user] }
+    end
+  end

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'multitenant-pg'
+require 'active_record'
+require 'logger'
+require 'database_cleaner'
+
+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'] || 'test'])
+
+# 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|
+  config.mock_with :rspec
+end

metadata

@@ -0,0 +1,181 @@
+--- !ruby/object:Gem::Specification 
+name: multitenant-pg
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Fabio Kuhn
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-11-04 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 3
+        - 1
+        version: "3.1"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: pg
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 51
+        segments: 
+        - 0
+        - 11
+        - 0
+        version: 0.11.0
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 2
+        - 7
+        - 0
+        version: 2.7.0
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rspec-core
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 2
+        - 7
+        - 0
+        version: 2.7.0
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rspec-mocks
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 2
+        - 7
+        - 0
+        version: 2.7.0
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: database_cleaner
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 0
+        - 5
+        - 0
+        version: 0.5.0
+  type: :development
+  version_requirements: *id006
+description: Rails multitenancy with PostgreSQL schemas.
+email: 
+- mordaroso@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rspec
+- .rvmrc
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- lib/multitenant-pg.rb
+- lib/multitenant.rb
+- lib/multitenant/schema_utils.rb
+- lib/multitenant/version.rb
+- multitenant-pg.gemspec
+- spec/database.yml
+- spec/fixtures/db/schema.rb
+- spec/fixtures/schema.rb
+- spec/multitenant_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/mordaroso/multitenant-pg
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.8
+signing_key: 
+specification_version: 3
+summary: scope database queries to current tenant
+test_files: 
+- spec/database.yml
+- spec/fixtures/db/schema.rb
+- spec/fixtures/schema.rb
+- spec/multitenant_spec.rb
+- spec/spec_helper.rb