multitenant 0.2.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,14 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+gemspec
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec", "~> 2.3.0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.2"
+  gem "rcov", ">= 0"
+  gem 'sqlite3', '~> 1.3.3'
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Ryan Sonnek
+
+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,46 @@
+= Multitenant
+
+When building multitenant applications, never let an unscoped Model.all accidentally leak data to an unintended audience.
+
+== Usage
+
+  class User < ActiveRecord::Base
+    belongs_to :company
+    belongs_to_tenant :company
+  end
+
+  Multitenant.with_tenant current_company do
+    # queries within this block are automatically
+    # scoped to the current company
+    User.all
+
+    # new objects created within this block are automatically
+    # assigned to the current company
+    User.create :name => 'Bob'
+  end
+
+== Features
+
+* Rails 3 compatible
+* Restrict database queries to only lookup objects for the current tenant
+* Auto assign newly created objects to the current tenant
+
+== 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
+
+Lars Klevan for inspiring this project.
+
+== Copyright
+
+Copyright (c) 2011 Ryan Sonnek. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,49 @@
+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 = "multitenant"
+  gem.homepage = "http://github.com/wireframe/multitenant"
+  gem.license = "MIT"
+  gem.summary = %Q{scope database queries to current tenant}
+  gem.description = %Q{never let an unscoped Model.all accidentally leak data to an unintended audience.}
+  gem.email = "ryan@codecrate.com"
+  gem.authors = ["Ryan Sonnek"]
+  gem.add_runtime_dependency "activerecord", "~> 3.0.3"
+  gem.add_runtime_dependency "activesupport", "~> 3.0.3"
+  gem.add_runtime_dependency 'dynamic_default_scoping', '~> 0.0.3'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "multitenant #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.2.0

data/lib/multitenant.rb

@@ -0,0 +1,37 @@
+require 'active_record'
+require 'active_support/all'
+require 'dynamic_default_scoping'
+
+# 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, &block)
+      Multitenant.current_tenant = tenant
+      yield
+    ensure
+      Multitenant.current_tenant = nil
+    end
+  end
+
+  module ActiveRecordExtensions
+    # configure the current model to automatically query and populate objects based on the current tenant
+    # see Multitenant#current_tenant
+    def belongs_to_tenant(association = :tenant)
+      include DynamicDefaultScoping
+      reflection = reflect_on_association association
+      before_validation Proc.new {|m|
+        return unless Multitenant.current_tenant
+        m.send "#{association}=".to_sym, Multitenant.current_tenant
+      }, :on => :create
+      default_scope :scoped_to_tenant, lambda {
+        return {} unless Multitenant.current_tenant
+        where({reflection.primary_key_name => Multitenant.current_tenant.id})
+      }
+    end
+  end
+end
+ActiveRecord::Base.extend Multitenant::ActiveRecordExtensions

data/multitenant.gemspec

@@ -0,0 +1,94 @@
+# 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{multitenant}
+  s.version = "0.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Ryan Sonnek"]
+  s.date = %q{2011-02-07}
+  s.description = %q{never let an unscoped Model.all accidentally leak data to an unintended audience.}
+  s.email = %q{ryan@codecrate.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "lib/multitenant.rb",
+    "multitenant.gemspec",
+    "spec/database.yml",
+    "spec/multitenant_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/wireframe/multitenant}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.5.0}
+  s.summary = %q{scope database queries to current tenant}
+  s.test_files = [
+    "spec/multitenant_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<multitenant>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_development_dependency(%q<sqlite3>, ["~> 1.3.3"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_development_dependency(%q<sqlite3>, ["~> 1.3.3"])
+      s.add_runtime_dependency(%q<activerecord>, ["~> 3.0.3"])
+      s.add_runtime_dependency(%q<activesupport>, ["~> 3.0.3"])
+      s.add_runtime_dependency(%q<dynamic_default_scoping>, ["~> 0.0.3"])
+    else
+      s.add_dependency(%q<multitenant>, [">= 0"])
+      s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<sqlite3>, ["~> 1.3.3"])
+      s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<sqlite3>, ["~> 1.3.3"])
+      s.add_dependency(%q<activerecord>, ["~> 3.0.3"])
+      s.add_dependency(%q<activesupport>, ["~> 3.0.3"])
+      s.add_dependency(%q<dynamic_default_scoping>, ["~> 0.0.3"])
+    end
+  else
+    s.add_dependency(%q<multitenant>, [">= 0"])
+    s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<sqlite3>, ["~> 1.3.3"])
+    s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<sqlite3>, ["~> 1.3.3"])
+    s.add_dependency(%q<activerecord>, ["~> 3.0.3"])
+    s.add_dependency(%q<activesupport>, ["~> 3.0.3"])
+    s.add_dependency(%q<dynamic_default_scoping>, ["~> 0.0.3"])
+  end
+end
+

data/spec/database.yml

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

data/spec/multitenant_spec.rb

@@ -0,0 +1,125 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+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
+  end
+
+  create_table :items, :force => true do |t|
+    t.column :name, :string
+    t.column :tenant_id, :integer
+  end
+end
+
+class Company < ActiveRecord::Base
+  has_many :users
+end
+class User < ActiveRecord::Base
+  belongs_to :company
+  belongs_to_tenant :company
+end
+
+class Tenant < ActiveRecord::Base
+  has_many :items
+end
+class Item < ActiveRecord::Base
+  belongs_to :tenant
+  belongs_to_tenant
+end
+
+describe Multitenant do
+  after { Multitenant.current_tenant = nil }
+
+  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 :foo do
+        Multitenant.current_tenant.should == :foo
+        @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 that raises error' do
+    before do
+      @executed = false
+      lambda {
+        Multitenant.with_tenant :foo do
+          @executed = true
+          raise 'expected error'
+        end
+      }.should 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
+      @company = Company.create!(:name => 'foo')
+      @company2 = Company.create!(:name => 'bar')
+
+      @user = @company.users.create! :name => 'bob'
+      @user2 = @company2.users.create! :name => 'tim'
+      Multitenant.with_tenant @company do
+        @users = User.all
+      end
+    end
+    it { @users.length.should == 1 }
+    it { @users.should == [@user] }
+  end
+
+  describe 'Item.all when current_tenant is set' do
+    before do
+      @tenant = Tenant.create!(:name => 'foo')
+      @tenant2 = Tenant.create!(:name => 'bar')
+
+      @item = @tenant.items.create! :name => 'baz'
+      @item2 = @tenant2.items.create! :name => 'booz'
+      Multitenant.with_tenant @tenant do
+        @items = Item.all
+      end
+    end
+    it { @items.length.should == 1 }
+    it { @items.should == [@item] }
+  end
+
+
+  describe 'creating new object when current_tenant is set' do
+    before do
+      @company = Company.create! :name => 'foo'
+      Multitenant.with_tenant @company do
+        @user = User.create! :name => 'jimmy'
+      end
+    end
+    it 'should auto_populate the company' do
+      @user.company_id.should == @company.id
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'multitenant'
+require 'active_record'
+require 'logger'
+
+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

metadata

@@ -0,0 +1,297 @@
+--- !ruby/object:Gem::Specification 
+name: multitenant
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: 
+  segments: 
+  - 0
+  - 2
+  - 0
+  version: 0.2.0
+platform: ruby
+authors: 
+- Ryan Sonnek
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-07 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: multitenant
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  prerelease: false
+  type: :runtime
+  requirement: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 2
+        - 3
+        - 0
+        version: 2.3.0
+  prerelease: false
+  type: :development
+  requirement: *id002
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  prerelease: false
+  type: :development
+  requirement: *id003
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 5
+        - 2
+        version: 1.5.2
+  prerelease: false
+  type: :development
+  requirement: *id004
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  prerelease: false
+  type: :development
+  requirement: *id005
+- !ruby/object:Gem::Dependency 
+  name: sqlite3
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 29
+        segments: 
+        - 1
+        - 3
+        - 3
+        version: 1.3.3
+  prerelease: false
+  type: :development
+  requirement: *id006
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  version_requirements: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 2
+        - 3
+        - 0
+        version: 2.3.0
+  prerelease: false
+  type: :development
+  requirement: *id007
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  version_requirements: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  prerelease: false
+  type: :development
+  requirement: *id008
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  version_requirements: &id009 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 5
+        - 2
+        version: 1.5.2
+  prerelease: false
+  type: :development
+  requirement: *id009
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  version_requirements: &id010 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  prerelease: false
+  type: :development
+  requirement: *id010
+- !ruby/object:Gem::Dependency 
+  name: sqlite3
+  version_requirements: &id011 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 29
+        segments: 
+        - 1
+        - 3
+        - 3
+        version: 1.3.3
+  prerelease: false
+  type: :development
+  requirement: *id011
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  version_requirements: &id012 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 3
+        - 0
+        - 3
+        version: 3.0.3
+  prerelease: false
+  type: :runtime
+  requirement: *id012
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  version_requirements: &id013 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 3
+        - 0
+        - 3
+        version: 3.0.3
+  prerelease: false
+  type: :runtime
+  requirement: *id013
+- !ruby/object:Gem::Dependency 
+  name: dynamic_default_scoping
+  version_requirements: &id014 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 25
+        segments: 
+        - 0
+        - 0
+        - 3
+        version: 0.0.3
+  prerelease: false
+  type: :runtime
+  requirement: *id014
+description: never let an unscoped Model.all accidentally leak data to an unintended audience.
+email: ryan@codecrate.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/multitenant.rb
+- multitenant.gemspec
+- spec/database.yml
+- spec/multitenant_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/wireframe/multitenant
+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: 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.5.0
+signing_key: 
+specification_version: 3
+summary: scope database queries to current tenant
+test_files: 
+- spec/multitenant_spec.rb
+- spec/spec_helper.rb