apartment 0.1.3

data/.bundle/config

@@ -0,0 +1,2 @@
+--- 
+BUNDLE_DISABLE_SHARED_GEMS: "1"

data/.project

@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<projectDescription>
+	<name>apartment</name>
+	<comment></comment>
+	<projects>
+	</projects>
+	<buildSpec>
+	</buildSpec>
+	<natures>
+	</natures>
+</projectDescription>

data/Gemfile

@@ -0,0 +1,15 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+
+gem "activesupport", ">= 2.3.5"
+
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.1"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,22 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (3.0.3)
+    git (1.2.5)
+    jeweler (1.5.1)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.8.7)
+    rcov (0.9.9)
+    shoulda (2.11.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport (>= 2.3.5)
+  bundler (~> 1.0.0)
+  jeweler (~> 1.5.1)
+  rcov
+  shoulda

data/README.markdown

@@ -0,0 +1,95 @@
+# Apartment
+*Multitenancy for Rails 3*
+
+Apartment provides tools to help you deal with multiple databases in your Rails
+environment. If you need to have certain data sequestered based on account or company,
+but still allow some data to exist in a common database, Apartment can help.
+
+## Caveats
+
+Apartment was built to deal with a very particular use-case - the need to spin up 
+multiple databases within the same application instance on-demand while Rails is running.
+If your setup can accomodate creating new databases on deploy (by adding a new database to your
+database.yml), or doesn't need 100% database isolation, other solutions might be far simpler 
+for your use case.
+
+## Installation
+
+### Rails 3
+
+Add the following to your Gemfile:
+
+      gem 'apartment'
+
+That's all you need to set up the Apartment libraries. If you want to switch databases 
+on a per-user basis, look under "Usage - Switching databases per request", below.
+
+## Usage
+
+### Creating new Databases
+
+Before you can switch to a new apartment database, you will need to create it. Whenever
+you need to create a new database, you can run the following command:
+
+     Apartment::Database.create('database_name')
+
+Apartment will create a new database in the following format: "environment_database_name". 
+In the case of a sqlite database, this will be created in your 'db/migrate' foler. With
+other databases, the database will be created as a new DB within the system.
+
+When you create a new database, all migrations will be run against that database, so it will be 
+up to date when create returns.
+
+#### Notes on PostgreSQL
+
+PostgreSQL works slightly differently than other databases when creating a new DB. If you
+are using PostgreSQL, Apartment will set up a new **schema** and migrate into there. This
+provides better performance, and allows Apartment to work on systems like Heroku, which
+would not allow a full new database to be created.
+
+### Switching Databases
+
+To switch databases using Apartment, use the following command:
+
+     Apartment::Database.switch('database_name')
+
+When switch is called, all requests coming to ActiveRecord will be routed to the database 
+you specify (with the exception of excluded models, see below). To return to the 'root' 
+database, call switch with no arguments.
+
+### Switching Databases per request
+
+You can have Apartment route to the appropriate database per request by adding a warden task
+in application.rb. For instance, if you want to route to a particular database depending on
+user, and you have a database attribute on your user model, you could do the following:
+
+     Warden::Manager.on_request do |proxy|
+        if session[:user_id]
+          u = User.find(session[:user_id])
+          Apartment::Database.switch(u.database)
+        end
+     end
+
+### Excluding models
+
+If you have some models that should always access the 'root' database, you can specify this in 
+a configuration file. Apartment will look for a config file called 'apartment.yml' in the /config
+directory of your Rails application. To exclude certain models, do the following:
+
+    excluded_models: [User, Company] 
+
+### Managing Migrations
+
+Currently, you will need to migrate each database individually. I'll be working on code to 
+migrate all known databases soon. You can migrate any database up to the current version by
+calling:
+
+     Apartment::Database.migrate('database_name')
+
+## TODO
+
+* Migration support
+* Other rake task support
+* Cross-database associations
+
+## Contributing

data/Rakefile

@@ -0,0 +1,54 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "apartment"
+  gem.homepage = "http://github.com/ryanbrunner/apartment"
+  gem.license = "MIT"
+  gem.summary = %Q{A Ruby gem for managing multitenancy in Rails applications}
+  gem.description = %Q{Apartment allows Rails applications to deal with 
+		       multitenancy.}
+  gem.email = "ryan@ryanbrunner.com"
+  gem.authors = ["Ryan Brunner"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "apartment #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.3

data/apartment.gemspec

@@ -0,0 +1,68 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{apartment}
+  s.version = "0.1.3"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Ryan Brunner"]
+  s.date = %q{2011-03-04}
+  s.description = %q{Apartment allows Rails applications to deal with 
+		       multitenancy.}
+  s.email = %q{ryan@ryanbrunner.com}
+  s.extra_rdoc_files = [
+    "README.markdown"
+  ]
+  s.files = [
+    ".bundle/config",
+    ".project",
+    "Gemfile",
+    "Gemfile.lock",
+    "README.markdown",
+    "Rakefile",
+    "VERSION",
+    "apartment.gemspec",
+    "lib/apartment.rb",
+    "lib/apartment/associations/multi_tenant_association.rb",
+    "lib/apartment/config.rb",
+    "lib/apartment/config/default_config.yml",
+    "lib/apartment/database.rb",
+    "lib/apartment/railtie.rb",
+    "lib/tasks/multi_tenant_migrate.rake",
+    "pkg/apartment-0.1.3.gem"
+  ]
+  s.homepage = %q{http://github.com/ryanbrunner/apartment}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{A Ruby gem for managing multitenancy in Rails applications}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activesupport>, [">= 3.0.5"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.1"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+    else
+      s.add_dependency(%q<activesupport>, [">= 3.0.5"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.1"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<activesupport>, [">= 3.0.5"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.1"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+  end
+end
+

data/lib/apartment.rb

@@ -0,0 +1,11 @@
+
+module Apartment
+	require 'apartment/railtie'
+	require 'apartment/config'
+	require 'apartment/database'
+
+  def self.included(base)
+    base.extend Apartment::ClassMethods
+  end
+end
+

data/lib/apartment/config.rb

@@ -0,0 +1,10 @@
+module Apartment
+	config = {:excluded_models => ["User"],
+						:use_postgres_schemas => true
+					 }		
+	
+	if File.exists? "config/apartment.yml"
+  	config = config.merge YAML.load_file "config/apartment.yml" 
+		Config = OpenStruct.new(config)
+	end									
+end

data/lib/apartment/config/default_config.yml

@@ -0,0 +1,17 @@
+# Apartment configuration
+
+# Excluded models
+# Indicate which models should be excluded from multi-tenancy. If you have information
+# that does not vary between databases, or information that should be considered global,
+# specify it here. Any classes involved in determining which database to access MUST be
+# specified here
+
+excluded_models: [User]
+
+# Postgres integration mode
+# By default, apartment switches databases in Postgres by changing the schema search path
+# of the current environment database. If preferred, this can be turned off and Postgres will
+# look in different databases for multi-tenanted models.
+
+use_postgres_schemas: true
+

data/lib/apartment/database.rb

@@ -0,0 +1,80 @@
+
+module Apartment
+	class Database
+		def self.switch(database)
+			
+			config = get_default_database
+			
+			if database.nil?
+				ActiveRecord::Base.establish_connection(config)
+				return
+			end
+
+			switched_config = multi_tenantify(config, database)
+			
+			puts switched_config.to_yaml
+			
+			ActiveRecord::Base.establish_connection(switched_config)
+			
+			puts Apartment::Config.excluded_models
+			
+			Apartment::Config.excluded_models.each do |m|
+				klass = Kernel
+				m.split("::").each do |i|
+					klass = klass.const_get(i)
+				end
+				
+				raise "Excluded class #{klass} could not be found." if klass.nil?
+				
+				puts "Excluding class #{m}"
+				
+				klass.establish_connection(config)
+			end	
+		end
+		
+		def self.create(database)
+			config = get_default_database
+			
+			switched_config = multi_tenantify(config, database)
+			
+			ActiveRecord::Base.establish_connection(switched_config)
+			
+			if config["adapter"] == "postgresql"
+				ActiveRecord::Base.connection.execute('create table schema_migrations(version varchar(255))')
+			end
+			
+			migrate(database)
+		end
+		
+		def self.migrate(database)
+			
+			config = get_default_database
+			switched_config = multi_tenantify(config, database)
+			
+			ActiveRecord::Base.establish_connection(switched_config)
+			
+			
+			ActiveRecord::Migrator.migrate(File.join(Rails.root, 'db', 'migrate'))
+			
+			ActiveRecord::Base.establish_connection(config)
+		end
+		
+			protected
+				def self.get_default_database
+					Rails.configuration.database_configuration[Rails.env]
+				end
+				
+				def self.multi_tenantify(configuration, database)
+					new_config = configuration.clone
+					
+					if new_config['adapter'] == "postgresql"  
+						new_config['schema_search_path'] = database
+					else
+						new_config['database'] = new_config['database'].gsub(Rails.env.to_s, "#{database}_#{Rails.env}")
+					end
+					
+					new_config
+				end
+	end
+	
+end

data/lib/apartment/railtie.rb

@@ -0,0 +1,10 @@
+require 'apartment'
+require 'rails'
+
+module Apartment
+	class Railtie < Rails::Railtie
+		rake_tasks do
+			load 'tasks/multi_tenant_migrate.rake'
+		end
+	end
+end

data/lib/tasks/multi_tenant_migrate.rake

@@ -0,0 +1,14 @@
+namespace :apartment do
+	desc "Apply database changes to all multi-tenant databases"
+	task :migrate => :environment do |t, args|
+		
+		puts "[Migrating to default environment]"
+		ActiveRecord::Migrator.migrate(File.join(Rails.root, 'db', 'migrate'))
+		
+		Admin::Company.where("database is not null").select("distinct database").each do |u|
+			puts "[Migrating to #{u.database}]"
+			
+			Apartment::Database.migrate u.database 
+		end
+	end
+end

metadata

@@ -0,0 +1,153 @@
+--- !ruby/object:Gem::Specification 
+name: apartment
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 3
+  version: 0.1.3
+platform: ruby
+authors: 
+- Ryan Brunner
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-04-18 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 3
+        - 5
+        version: 2.3.5
+  type: :runtime
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 5
+        - 1
+        version: 1.5.1
+  type: :development
+  prerelease: false
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id005
+description: |-
+  Apartment allows Rails applications to deal with 
+  		       multitenancy.
+email: ryan@ryanbrunner.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.markdown
+files: 
+- .bundle/config
+- .project
+- Gemfile
+- Gemfile.lock
+- README.markdown
+- Rakefile
+- VERSION
+- apartment-0.1.3.gem
+- apartment.gemspec
+- lib/apartment.rb
+- lib/apartment/associations/multi_tenant_association.rb
+- lib/apartment/config.rb
+- lib/apartment/config/default_config.yml
+- lib/apartment/database.rb
+- lib/apartment/railtie.rb
+- lib/tasks/multi_tenant_migrate.rake
+- pkg/apartment-0.1.3.gem
+has_rdoc: true
+homepage: http://github.com/ryanbrunner/apartment
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: -190181027694817836
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A Ruby gem for managing multitenancy in Rails applications
+test_files: []
+